linux下使用 boost.python 調用c++動態庫

    最近開始使用 robot framework 測試c++的動態庫，robot framework 是跑在 windows 上面，c++動態庫是跑在遠程linux主機上面。測試辦法是讓 robot framework 經過 SSHLIbrary 庫執行遠程機器上面的 python 腳本，python 腳本調用 C++ 動態庫。因此如今要解決的是如何讓python調用c++動態庫。

python調用c++動態庫的兩種辦法

    在上網查資料和諮詢同事以後，獲得兩種辦法：第一種將C++動態庫封裝成C接口，讓python調用C語言接口。因爲python只能調用C接口，沒法直接調用C++接口，因此須要一層封裝。封裝辦法：使用extern 「C」聲明方式，在C++的接口之上，封裝一層C語言接口。這種辦法通過嘗試，發現純C調用可行，可是python調用不可行，下面會具體講解緣由。第二種辦法是使用c++的boost庫，生成供python調用的接口，經測試可行，可是過程很曲折，下文會具體講解遇到的問題和解決辦法。

理解extern 「C」的本質

    在講述第一種辦法以前，先簡單介紹一下extern 「C」方式的做用。具體講解能夠參考這篇博客，講的很詳細，推薦閱讀。舉一個例子，在c語言中，有一個函數

int add(int a,int b);

若是使用gcc編譯器，那麼編譯生成的名字就叫 add，可是若是使用 g++編譯器，可能編譯生成的名字就叫相似於ABaddCD這樣的，這裏麪包含了函數名、入參個數、類型、返回值。因此，若是c++中還定義了一個重載的

float add(float a,float b);

可能編譯生成的名字就叫相似於 EFaddGH這樣的，一樣包含了函數名、入參、返回值等信息，因此c++能夠重載。試想一下，若是使用gcc編譯器，那麼都叫add，就沒法區分哪一個函數了，因此沒法重載。那麼，extern 「C」的做用，就是告訴g++編譯器，將 int add(int a,int b)編譯成 add，而不是編譯成 ABaddCD，由於 add 才能被 C 語言識別，ABaddCD沒法被C語言識別，C語言會認爲 add是'undefined symbol'。因此，從這裏咱們也能夠看出，extern 「C」只能用於 c++代碼，另外，對於存在重載的c++函數，須要寫兩個不同的函數分別調用，保證名字不重複。

python使用extern 「C」方式調用c++動態庫

    知道了extern 「C」的本質以後，咱們就按照這個方法進行封裝。我是直接拿着c++動態庫的源碼，在源碼之上封裝一層C接口，而後生成動態庫。假設將 add 函數封裝成 addc，C++動態庫叫作A，封裝一層C接口以後生成的動態庫叫作B。若是寫一個test.c的測試代碼，使用純C代碼檢驗動態庫B，調用addc函數，結果是可行的，成功的。可是使用python檢驗動態庫B，調用addc函數，發現會報這樣的錯誤：

AttributeError: B.so: undefined symbol: add

就是說依然不識別add函數。使用

nm B.so | grep add

可以獲得

addc 
ABaddCD

這樣的結果，第一個 addc 確定是能夠被 python 識別的，第二個 ABaddCD，是g++編譯生成的名字，沒法被python調用。我這只是舉一個本身的例子，我本身的C++動態庫的源碼可能寫的比較複雜，沒法被python 成功調用，網上還有不少例子，說的是能夠被成功調用。因此讀者能夠自行試驗，若是可以成功調用，天然是最好的。由於接下來要介紹的使用 boost.python的方式比較曲折。

python使用 boost.python 調用c++動態庫

   

解決c++動態庫依賴的其餘的第三方庫

    因爲個人動態庫依賴了其餘第三方的庫文件，好比openssl，uuid，libevent，pthread，因此，不論是使用哪一種辦法調用c++動態庫，都須要python加載這些動態庫，具體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)

有一些能夠默認加載，好比 libpthread.so，咱們不須要加載，其餘的則須要手動加載，像 libssl.so,libuuid.so，都在 /usr/lib64/目錄下，能夠不加路徑，可是libevent庫也是/usr/lib64目錄下,且在 /usr/lib/目錄下也有，又必須加路徑。因此，若是編譯不經過，就使用 whereis libevent.so 查看在哪一個目錄，而後加上絕對路徑。有時候加上絕對路徑依然不對，好比libpthread.so，加上絕對路徑以後仍是報錯

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

這意味着版本號不對，找到 libpthread.so 連接的版本號，加上 .0 版本號，則不會報錯。

   

c++代碼配置boost環境

        在c++動態庫所在的centos6.6機器上面，我參考： ubuntu下python調用C/C++方法之動態連接庫配置和試驗boost。參考：利用Boost.Python實現Python C/C++混合編程實現python定義c++的函數重載。配置環境時，我使用的命令是：yum install boost*， yum install python-devel，參考這兩篇文章實現boost，基本上都能經過，遇到的問題，裏面也有。另外我也遇到其餘問題，在Stack Overflow上面找到解決辦法，我下面就直接貼一下結果：

新建一個 test.cpp,在這個cpp裏面咱們要定義 python可用的函數。

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

// 須要包含boost的頭文件

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

//重載函數的實現，在個人 c++代碼中，LOGIN 函數、Synchronize_Request函數、Notify函數都有三個重載函數，下面我只用到了其中一個LOGIN函數，一個Synchronize_Request函數，2個Notify函數，好比下面的fun3和fun4，就是兩個不一樣的notify。

//只有存在重載的函數才須要像這樣定義 fun1，fun2，fun3，fun4，不存在重載的函數，能夠直接寫名字

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 函數重載舉例
int (*fun5)(int a,int b) = &add;

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

    //Initialize 函數沒有重載，直接使用便可，不須要像上面同樣定義出 fun1  
    def("Initialize",Initialize);
	//Uninitialize 函數沒有重載，直接使用便可  
    def("Uninitialize",Uninitialize);  
    def("LOGIN",fun1);  
    def("Synchronize_Request",fun2);  
    def("Notify",fun3);   
	def("Notify2",fun4);   
	def("add",fun5);   
	// python 能夠調用以上def定義的函數    
}

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腳本中則須要引入該動態庫

import libB

print libB.add(10,20)

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

補充：當採用boost.python的方式調用c++動態庫的時候，我沒法處理引用類型，好比 string& recv_answer 用來接收返回結果，被識別爲 string{lvalue},而個人python傳入的是 string 類型，沒法匹配。因此我就手動將 string& recv_answer的string類型的引用，改寫成 char * recv_answer_c 格式，就是改爲 C 語言的風格，而後用下面的方式傳入 recv_answer_c 這個參數用來接收結果。

#採用 bytes 的方式，爲變量預先分配空間，保證不會段錯誤
temp = bytearray(1000)
recv_answer_c= bytes(temp)