linux中使用boost.python調(diào)用c++動(dòng)態(tài)庫(kù)的方法

前言

最近開始使用 robot framework 測(cè)試c++的動(dòng)態(tài)庫(kù)，robot framework 是跑在 windows 上面，c++動(dòng)態(tài)庫(kù)是跑在遠(yuǎn)程linux主機(jī)上面。測(cè)試辦法是讓 robot framework 通過 SSHLIbrary 庫(kù)執(zhí)行遠(yuǎn)程機(jī)器上面的 python 腳本，python 腳本調(diào)用 C++ 動(dòng)態(tài)庫(kù)。所以現(xiàn)在要解決的是如何讓python調(diào)用c++動(dòng)態(tài)庫(kù)。

python調(diào)用c++動(dòng)態(tài)庫(kù)的兩種辦法

在上網(wǎng)查資料和咨詢同事之后，得到兩種辦法：第一種將C++動(dòng)態(tài)庫(kù)封裝成C接口，讓python調(diào)用C語(yǔ)言接口。由于python只能調(diào)用C接口，無(wú)法直接調(diào)用C++接口，所以需要一層封裝。封裝辦法：使用extern “C”聲明方式，在C++的接口之上，封裝一層C語(yǔ)言接口。這種辦法經(jīng)過嘗試，發(fā)現(xiàn)純C調(diào)用可行，但是python調(diào)用不可行，下面會(huì)具體講解原因。第二種辦法是使用c++的boost庫(kù)，生成供python調(diào)用的接口，經(jīng)測(cè)試可行，但是過程很曲折，下文會(huì)具體講解遇到的問題和解決辦法。

理解extern “C”的本質(zhì)

在講述第一種辦法之前，先簡(jiǎn)單介紹一下extern “C”方式的作用。具體講解可以參考這篇博客，講的很詳細(xì)，推薦閱讀。舉一個(gè)例子，在c語(yǔ)言中，有一個(gè)函數(shù)

int add(int a,int b);

如果使用gcc編譯器，那么編譯生成的名字就叫 add，但是如果使用 g++編譯器，可能編譯生成的名字就叫類似于ABaddCD這樣的，這里面包含了函數(shù)名、入?yún)€(gè)數(shù)、類型、返回值。所以，如果c++中還定義了一個(gè)重載的

float add(float a,float b);

可能編譯生成的名字就叫類似于 EFaddGH這樣的，同樣包含了函數(shù)名、入?yún)?、返回值等信息，所以c++可以重載。試想一下，如果使用gcc編譯器，那么都叫add，就無(wú)法區(qū)分哪個(gè)函數(shù)了，所以無(wú)法重載。那么，extern “C”的作用，就是告訴g++編譯器，將 int add(int a,int b)編譯成 add，而不是編譯成 ABaddCD，因?yàn)?add 才能被 C 語(yǔ)言識(shí)別，ABaddCD無(wú)法被C語(yǔ)言識(shí)別，C語(yǔ)言會(huì)認(rèn)為 add是'undefined symbol'。所以，從這里我們也可以看出，extern “C”只能用于 c++代碼，另外，對(duì)于存在重載的c++函數(shù)，需要寫兩個(gè)不一樣的函數(shù)分別調(diào)用，保證名字不重復(fù)。

python使用extern “C”方式調(diào)用c++動(dòng)態(tài)庫(kù)

知道了extern “C”的本質(zhì)之后，我們就按照這個(gè)方法進(jìn)行封裝。我是直接拿著c++動(dòng)態(tài)庫(kù)的源碼，在源碼之上封裝一層C接口，然后生成動(dòng)態(tài)庫(kù)。假設(shè)將 add 函數(shù)封裝成 addc，C++動(dòng)態(tài)庫(kù)叫做A，封裝一層C接口之后生成的動(dòng)態(tài)庫(kù)叫做B。如果寫一個(gè)test.c的測(cè)試代碼，使用純C代碼檢驗(yàn)動(dòng)態(tài)庫(kù)B，調(diào)用addc函數(shù)，結(jié)果是可行的，成功的。但是使用python檢驗(yàn)動(dòng)態(tài)庫(kù)B，調(diào)用addc函數(shù)，發(fā)現(xiàn)會(huì)報(bào)這樣的錯(cuò)誤：

AttributeError: B.so: undefined symbol: add

就是說(shuō)依然不識(shí)別add函數(shù)。使用

nm B.so | grep add 

能夠得到

addc
ABaddCD

這樣的結(jié)果，第一個(gè) addc 肯定是可以被 python 識(shí)別的，第二個(gè) ABaddCD，是g++編譯生成的名字，無(wú)法被python調(diào)用。我這只是舉一個(gè)自己的例子，我自己的C++動(dòng)態(tài)庫(kù)的源碼可能寫的比較復(fù)雜，無(wú)法被python 成功調(diào)用，網(wǎng)上還有很多例子，說(shuō)的是可以被成功調(diào)用。所以讀者可以自行試驗(yàn)，如果能夠成功調(diào)用，自然是最好的。因?yàn)榻酉聛?lái)要介紹的使用 boost.python的方式比較曲折。

python使用 boost.python 調(diào)用c++動(dòng)態(tài)庫(kù)

解決c++動(dòng)態(tài)庫(kù)依賴的其他的第三方庫(kù)

由于我的動(dòng)態(tài)庫(kù)依賴了其他第三方的庫(kù)文件，比如openssl，uuid，libevent，pthread，所以，不管是使用哪種辦法調(diào)用c++動(dòng)態(tài)庫(kù)，都需要python加載這些動(dòng)態(tài)庫(kù)，具體python代碼如下：

from ctypes import *
ctypes.CDLL("libssl.so", mode=ctypes.RTLD_GLOBAL) 
ctypes.CDLL("libcrypto.so", mode=ctypes.RTLD_GLOBAL) 
ctypes.CDLL("libuuid.so", mode=ctypes.RTLD_GLOBAL) 
ctypes.CDLL("/usr/lib64/libevent.so", mode=ctypes.RTLD_GLOBAL) 
#ctypes.CDLL("/usr/lib64/libpthread.so.0", mode=ctypes.RTLD_GLOBAL)

有一些可以默認(rèn)加載，比如 libpthread.so，我們不需要加載，其他的則需要手動(dòng)加載，像 libssl.so,libuuid.so，都在 /usr/lib64/目錄下，可以不加路徑，但是libevent庫(kù)也是/usr/lib64目錄下,且在 /usr/lib/目錄下也有，又必須加路徑。所以，如果編譯不通過，就使用 whereis libevent.so 查看在哪個(gè)目錄，然后加上絕對(duì)路徑。有時(shí)候加上絕對(duì)路徑依然不對(duì)，比如libpthread.so，加上絕對(duì)路徑之后還是報(bào)錯(cuò)

'OSError: /usr/lib64/libpthread.so: invalid ELF header'

這意味著版本號(hào)不對(duì)，找到 libpthread.so 鏈接的版本號(hào)，加上 .0 版本號(hào)，則不會(huì)報(bào)錯(cuò)。

c++代碼配置boost環(huán)境

在c++動(dòng)態(tài)庫(kù)所在的centos6.6機(jī)器上面，我參考： ubuntu下python調(diào)用C/C++方法之動(dòng)態(tài)鏈接庫(kù)配置和試驗(yàn)boost。參考：利用Boost.Python實(shí)現(xiàn)Python C/C++混合編程實(shí)現(xiàn)python定義c++的函數(shù)重載。配置環(huán)境時(shí)，我使用的命令是：yum install boost*， yum install python-devel，參考這兩篇文章實(shí)現(xiàn)boost，基本上都能通過，遇到的問題，里面也有。另外我也遇到其他問題，在Stack Overflow上面找到解決辦法，我下面就直接貼一下結(jié)果：

新建一個(gè) test.cpp,在這個(gè)cpp里面我們要定義 python可用的函數(shù)。

在 test.cpp 代碼中，包含以下代碼：

// 需要包含boost的頭文件

#include <boost/python.hpp> 
#include <boost/python/module.hpp> 
#include <boost/python/def.hpp>

//重載函數(shù)的實(shí)現(xiàn)，在我的 c++代碼中，LOGIN 函數(shù)、Synchronize_Request函數(shù)、Notify函數(shù)都有三個(gè)重載函數(shù)，下面我只用到了其中一個(gè)LOGIN函數(shù)，一個(gè)Synchronize_Request函數(shù)，2個(gè)Notify函數(shù)，比如下面的fun3和fun4，就是兩個(gè)不同的notify。

//只有存在重載的函數(shù)才需要像這樣定義 fun1，fun2，fun3，fun4，不存在重載的函數(shù)，可以直接寫名字

int (*fun1)(const int server_type, const int request_no, std::string& login_result) = &LOGIN;

int (*fun2)(const int server_type, const int request_no,std::string& recv_answer) = &Synchronize_Request; 
int (*fun3)(const int server_type, unsigned int timeout_ms, unsigned int sesscare ) = &Notify;

int (*fun4)(void) = &Notify;

// add 函數(shù)重載舉例
int (*fun5)(int a,int b) = &add;

 
BOOST_PYTHON_MODULE( libB ) //python模塊,libB的名字要與 .so 的名字一致 
{ 
 using namespace boost::python;

 //Initialize 函數(shù)沒有重載，直接使用即可，不需要像上面一樣定義出 fun1 
 def("Initialize",Initialize);
 //Uninitialize 函數(shù)沒有重載，直接使用即可 
 def("Uninitialize",Uninitialize); 
 def("LOGIN",fun1); 
 def("Synchronize_Request",fun2); 
 def("Notify",fun3); 
 def("Notify2",fun4); 
 def("add",fun5); 
 // python 可以調(diào)用以上def定義的函數(shù) 
}

Makefile 使用的命令是：

%.o : %.cpp
 g++ -g -lssl -fPIC -levent -lcrypto -luuid -lpthread -lrt -lboost\_filesystem -lboost\_system -lboost_python -lpython -I/usr/include/python2.7 -o $@ -c $<

生成B.so的命令是：

g++ -shared -Wl,-soname,libB.so -o libB.so *.o -lpython -lboost_python

python腳本中則需要引入該動(dòng)態(tài)庫(kù)

import libB

print libB.add(10,20)

按照上面的命令進(jìn)行編寫、編譯，就能規(guī)避我踩過的坑。注意 -lpython 的位置，不要放在前面。 如果沒有實(shí)現(xiàn)重載的定義，而是直接使用 def("LOGIN",LOGIN); 則會(huì)報(bào)如下的錯(cuò)誤 error: no matching function for call to ‘def(const char [15], <unresolved overloaded function type>)' def("LOGIN",LOGIN); 綜上是我花了一整天時(shí)間研究的成果，如有錯(cuò)漏，還請(qǐng)讀者指出，謝謝。

補(bǔ)充：當(dāng)采用boost.python的方式調(diào)用c++動(dòng)態(tài)庫(kù)的時(shí)候，我無(wú)法處理引用類型，比如 string& recv_answer 用來(lái)接收返回結(jié)果，被識(shí)別為 string{lvalue},而我的python傳入的是 string 類型，無(wú)法匹配。所以我就手動(dòng)將 string& recv_answer的string類型的引用，改寫成 char * recv_answer_c 格式，就是改成 C 語(yǔ)言的風(fēng)格，然后用下面的方式傳入 recv_answer_c 這個(gè)參數(shù)用來(lái)接收結(jié)果。

#采用 bytes 的方式，為變量預(yù)先分配空間，保證不會(huì)段錯(cuò)誤
temp = bytearray(1000)
recv_answer_c= bytes(temp)

總結(jié)：

以上就是這篇文章的全部?jī)?nèi)容了，希望本文的內(nèi)容對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，如果有疑問大家可以留言交流，謝謝大家對(duì)腳本之家的支持。