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)

本文來自雲棲社群合作伙伴“開源中國”

本文作者：問天小凱 

原文連結