这篇文章想讨论一个什么话题？我们讨论一种方法——兼顾编译语言的性能，同时又能保留动态语言的灵活性。我们想实现一个插件式框架，框架结构实用Python来实现，插件使用c/c++来实现。这个框架可以实现插件的即插即用，插件的无损升级，插件的版本和依赖性管理，和灵活的扩展能力。
框架应用在哪呢？在《基于Elasticsearch的数据分析系统（3）》中介绍了数据采集service，这个service目前仅对接一个设备，未来会对接更多设备，接收处理不同的协议/格式，数据切分成消息后除了送入kafka，也可能变更或通过复制的方式发到其他系统，我们的框架要支持这些可变性。出于性能、资源节省等方面的考虑，我们没有选用Flume、Logstash等开源日志收集组件。在二进制数据处理方面我们希望用编译语言来快速处理。同理，系统中的数据预处理servcie，也有类似需求。
因为我们利用混合编程的优势来搭建框架，所以我们从混合编程介绍起。
1.混合编程的应用介绍
混合编程的应用其实并不少见。最典型的是一款大名鼎鼎的网络模拟软件NS2（Network Simulator），最新版本是NS3。从事网络研究、性能分析的人员对它可能都比较熟悉。
NS2使用C++和Otcl作为开发语言，NS3使用C++和python。之所以这样设计就是出于性能和易用性的考虑。使用c++来写网络组件，研究人员可以使用c++开发新的协议算法组件编译进NS中。然后使用解释型语言建模网络——创建网络组件及连接关系、网络配置、网络事件设置等。
NS的组件使用OOP(面向对象编程)技术来实现，组件的样例代码如下：
图1 Classifier的头文件
图2 tcp cubic算法实现
图1 中Classifier类是NS的地址分类器，负责将包转发给下一级节点，角色上相当于路由器。图2 是TCP cubic拥塞控制算法的实现，实际上就是从linux移植过来的，是一个c代码实现。这些内部组件，核心算法都是c/c++实现的，保证模拟时性能最优。
网络建模看上去是下面这个样子的：
图3 tcl定义的模拟脚本
图4 python定义的模拟脚本
可能有人觉得tcl、python的定义的模拟脚本看上去就像个配置文件，但跟配置文件不同的是，你可以在脚本中动态地修改模拟器内部状态。实际上，C/C++这部分就像一台车的引擎，它负载快。而动态语言这部分就像控制台，负载操作更方便、灵活。
2.C/C++与python混合编程
首先要说一下python只是一个语言规范，实际上python有很多实现：CPython是标准Python，是由C编写的，python脚本被编译成CPython字节码，然后由虚拟机解释执行，垃圾回收使用引用计数，我们谈与C/C++混合编程实际指的是基于CPython解释上的。除此之外，还有Jython、IronPython、PyPy、Pyston，Jython是Java编写的，使用JVM的垃圾回收，可以与Java混合编程，IronPython面向.NET平台... ... 具体介绍可以参见这篇文章：http://python.jobbole.com/82703/
python与C/C++混合编程的本质是python调用C/C++编译的动态链接库，关键就是把python中的数据类型转换成c/c++中的数据类型，给编译函数处理，然后返回参数再转换成python中的数据类型。但有几种方式：
1）python中使用ctypes moduel，将python类型转成c/c++类型
一段示例代码如下：
extern "C"
{
int addBuf(char* data, int num, char* outData);
}
int addBuf(char* data, int num, char* outData)
{
for (int i = 0; i < num; ++i)
{
outData[i] = data[i] + 3;
}
return num;
}
将上面的代码编译成so库，在python中的调用：
from ctypes import * # cdll, c_int
lib = cdll.LoadLibrary('libmathBuf.so')
callAddBuf = lib.addBuf
num = 4
numbytes = c_int(num)
data_in = (c_byte * num)()
for i in range(num):
data_in[i] = i
data_out = (c_byte * num)()
ret = lib.addBuf(data_in, numbytes, data_out) #调用so库中的函数
ctypes的更多说明参见https://docs.python.org/2/library/ctypes.html。使用ctypes可以在python与so之间通过指针传递更复杂的结构体等。
2）在C/C++程序中使用Python.h，写wrap包装接口
这种方式是在c/c++程序中处理入/出参数，先看一段例程（输入字符串，然后当做系统命令执行）：
Html 代码
01#include <Python.h>
02static PyObject* SpamError;
03static PyObject* spam_system(PyObject* self, PyObject* args)
04{
05 const char* command;
06 int sts;
07 if (!PyArg_ParseTuple(args, "s", &command)) //将args参数按照string类型处理，给command赋值
08 return NULL;
09 sts = system(command); //调用系统命令
10 if (sts < 0) {
11 PyErr_SetString(SpamError, "System command failed");
12 return NULL;
13 }
14 return PyLong_FromLong(sts); //将返回结果转换为PyObject类型
15}
16//方法表
17static PyMethodDef SpamMethods[] = {
18 {"system", spam_system, METH_VARARGS,
19 "Execute a shell command."},
20 {NULL, NULL, 0, NULL}
21};
22//模块初始化函数
23PyMODINIT_FUNC initspam(void)
24{
25 PyObject* m;
26 //m = PyModule_Create(&spammodule); // v3.4
27 m = Py_InitModule("spam", SpamMethods);
28 if (m == NULL)
29 return;
30 SpamError = PyErr_NewException("spam.error",NULL,NULL);
31 Py_INCREF(SpamError);
32 PyModule_AddObject(m,"error",SpamError);
33}
处理上所有的入参、出参都作为PyObject对象来处理，然后使用转换函数把python的数据类型转换成c/c++中的类型，返回参数按相同方式处理。比第一种方法多了初始化函数，这部分是把编译的so库当做python module所必需要做的。python中可以这样使用：
Html 代码
1imoprt spam
2spam.system("ls")
使用c/c++编写python扩展的介绍可以参见：http://docs.python.org/2.7/extending/extending.html
3）使用SWIG，来生成独立的wrap文件
这种方式并不能算是一种新方式，实际上是基于第二中方式的一种包装。SWIG是个帮助使用C或者C++编写的软件能与其它各种高级编程语言进行嵌入联接的开发工具。SWIG能应用于各种不同类型的语言包括常用脚本编译语言例如Perl, PHP, Python, Tcl, Ruby, PHP，C#,Java,R等。
操作上，是针对c/c++程序编写独立的接口声明文件（通常很简单），swig会分析c/c++源程序自动分析接口要如何包装。在指定目标语言后，swig会生成额外的包装源码文件。编译so库时，把包装文件一起编译、连接即可。看个例子：
Cpp 代码
1int system(const char* command)
2{
3 sts = system(command);
4 if (sts < 0) {
5 return NULL;
6 }
7 return sts;
8}
将c源码中去掉适配python的包装，仅定义system函数本身。然后编写接口声明文件spam.i：
Python 代码
1%module spam
2%{
3#include "spam.h"
4%}
5%include "spam.h"
6%include "typemaps.i"
7int system(const char* INPUT);
声明要创建一个叫spam的模块，对system做一个声明，主要是声明参数作为入参使用。然后执行：
Cpp 代码
#swig -c++ -python spam.i
swig会生成spam_wrap.cxx和spam.py两个文件。先看spam_wrap.cxx，这个生成的文件很长，但关键的就是对函数的包装：
包装函数传入的还是PyObejct对象，内部进行了类型转换，最终调了源码中的system函数。
生成的了另一个spam.py实际上是对so库又用python包装了一层（实际比较多余）：
这里使用_spam模块，这里实际上是把扩展命名为了_spam。关于swig在python上的应用可以参见：http://www.swig.org/Doc1.3/Python.html
下面就是编译和安装python 模块，Python提供了distutils module，可以很方便的编译安装python的module。像下面这样写一个安装脚本setup.py:
执行 python setup.py build，即可以完成编译，程序会创建一个build目录，下面有编译好的so库。so库放在当前目录下，其实Python就可以通过import来加载模块了。当然也可以用 python setup.py install 把模块安装到语言的扩展库——site-packages目录中。关于build python扩展，可以参考https://docs.python.org/2/extending/building.html#building
3. 混合编程的性能分析
混合编程的使用场景中，很重要一个就是性能攸关。那么这小节将通过几个小实验验证下混合编程的性能如何，或者说怎样写程序能发挥好混合编程的性能优势。
我们使用冒泡排序算法来验证性能。
1）实验一 使用冒泡程序验证python和c/c++程序的性能差距
python版冒泡程序：
Cpp 代码
01def bubble(arr,length):
02 j = length - 1
03 while j >= 0:
04 i = 0
05 while i < j:
06 if arr[i] > arr[i+1]:
07 tmp = arr[i+1]
08 arr[i+1] = arr[i]
09 arr[i] = tmp
10 i += 1
11 j -= 1
c语言版冒泡程序：
Python 代码
01void bubble(int* arr,int length){
02 int j = length - 1;
03 int i;
04 int tmp;
05 while(j >= 0){
06 i = 0;
07 while(i < j){
08 if(arr[i] > arr[i+1]){
09 tmp = arr[i+1];
10 arr[i+1] = arr[i];
11 arr[i] = tmp;
12 }
13 i += 1;
14 }
15 j -= 1;
16 }
17}
使用一个长度为100内容固定的数组，反复排序10000次（每次排序后，再把数组恢复成原始序列），记录执行时间：
在相同的机器上多次执行，Python版执行时间是10.3s左右，而c语言版本(未使用任何优化编译参数)执行时间只有0.29s左右。相比之下python的性能的确差很多（主要是python中list的操作跟c的数组相比，效率差非常多），但python中很多扩展都是c语言写的，目的就是为了提升效率，python用于数据分析的numpy库就拥有不错的性能。下个实验就验证，如果python使用c语言版本的冒泡排序扩展库，性能会提升多少。
2）实验二 Python使用c/c++扩展库，验证性能提升
我们还要验证上面三种混合方式，各自效率怎样。
1.使用ctypes module
这里直接使用c_int来定义了数组对象，这也节省了调用时数据类型转换的开销：
Python 代码
01import time
02from ctypes import *
03IntArray100 = c_int * 100
04arr = IntArray100(87,23,41, 3, 2, 9,10,23,0,21,5,15,93, 6,19,24,18,56,11,80,34, 5,98,33,11,25,99,44,33,78,
05 52,31,77, 5,22,47,87,67,46,83, 89,72,34,69, 4,67,97,83,23,47, 69, 8, 9,90,20,58,20,13,61,99,7,22,55,11,30,56,87,29,92,67,
06 99,16,14,51,66,88,24,31,23,42,76,37,82,10, 8, 9, 2,17,84,32,66,77,32,17, 5,68,86,22, 1, 0)
07... ...
08if __name__ == "__main__":
09 libbubble = CDLL('libbubble.so')
10 time1 = time.time()
11 for i in xrange(100000):
12 libbubble.initArr(arr1,arr,100)
13 libbubble.bubble(arr1,100)
14 time2 = time.time()
15 print time2 - time1
再次执行：
为了减少误差，把循环增加到10万次，结果c原生程序执行需要2.8s左右，使用优化参数编译后用时0.65s左右。python使用c扩展后（相同编译参数）执行仅需2.3s左右。
C 代码
>gcc -pthread -fno-strict-aliasing -g -O2 -DNDEBUG -g -fwrapv -O3 -Wall -Wstrict-prototypes -fPIC bubble1.c -o bubble.o
2.在c语言中使用PyObject处理入参
这种方式是在python中依然使用list装入待排序数列，在c函数中把list赋值给数组，再进行排序，排好序后，再对原始list赋值。循环排序10万次，执行用时1.0s左右。
3.使用swig来包装c方法
在接口文件中声明%array_class(int,intArray);然后在Python中使用initArray来作为数组，同样修改成10万次排序。python版本的程序(相同编译参数)执行仅需0.7s左右，比c原生程序慢大概7%。
【结论】
1.python 的list效率非常低，在高性能场景下避免对list大量循环、取值、赋值操作。如需要最好使用ctype中的数组，或者是用c语言来实现。
2.应该把耗时的cpu密集型的逻辑交给c/c++实现，python使用扩展即可。
4.插件式框架设计
基于以上探索，参考NS3的实现方式，以数据收集Service为例来分析。数据收集Service接收TCP/UDP的数据传输方式，应用层协议支持自定义，不同的外设完全可以定义自己的协议解析逻辑。我们定义每种解析为一个plugin，输入为应用层数据，输出为一个个Message。转换成Message之后要输入给后续Plugin处理（可能是kafka，可能是ZeroMQ，也可能直接对接数据预处理Service），我们之定义这些最近的接口，输入是一批Message，返回成功或失败。
这些Plugin都可以使用c/c++实现，因为这些数据处理使用指针会更快。
主Service其实仅仅是**端口，对于tcp连接，判断该使用什么plugin来处理，然后新建一个线程，把socket交给这个线程。框架的公共程序要对socket等资源维护起来，如支持线程池，资源回收，plugin热替换时，可以将资源移交给新处理线程，实现无损升级等。像这些操作并不是性能攸关的，就完全可以用python来实现。
以上可以应用OOA、OOD的方法进一步分析设计，然后使用c++来实现插件。使用swig来包装接口。使用时看起来像这个样子：
Python 代码
1import epsn
2import collector
3plug1 = epsn.EpsnPlugin()
4mainService = collector.CollectServer()
5mainService.addPlugin(plug1)
6mainService.run()
5.版本管理及依赖性管理
python有很成熟的包管理工具，可以方便地构建、安装、移除、升级、版本管理、依赖性管理。上文setup.py中的代码就使用distutils包，是python内置的包管理库，可以很方便地构建包。相对功能更强地有setpuptools支持依赖性的管理，具体参见http://setuptools.readthedocs.io/en/latest/setuptools.html#building-and-distributing-packages-with-setuptools。文章不再做更多介绍。
