一次失敗的PHP擴展開發之旅
一次失敗的PHP擴展開發之旅
By warezhou 2014.11.19
緣起
經過不斷的持續叠代。我們部門的協程版網絡框架（CoSvrFrame）最終出爐了！這本來是件喜大普奔的事情。可是隨著新業務的不斷接入，非常多固有缺陷也逐漸浮出水面：
- 不支持“TCP連接池”
- 不支持“Dispatcher-Workers模型”
- 不支持“過載保護”
- 不支持“熱重新啟動”
- 不支持“64Bit”
- ... ...
對於資深後臺開發而言。上面羅列的問題大多數都難入法眼，之所以成為問題，非常有點“溫水煮青蛙”的味道：叠代過程缺乏宏觀視野，引入過多業務特性，導致總體架構不合理。近期的“協程版本號”最初也是我個人業余之作，只為了可以愉快地寫業務代碼，為了快點出活，底層直接復用原有
經過多番調研與討論。終於我們給出了例如以下前進方向：
- 引入公司內部開源的SPP3.0框架，吸收它的基礎周邊設施，進行業務二次開發
- 對於SPP進行擴展。支持PHP作為腳本語言進行嵌入式編程。同一時候以C擴展形式給PHP提供協程能力（從此PHPer也能夠愉快地書寫異步代碼了，媽媽再也不用操心我的callback了！
）
叨逼叨啰嗦了這麽久，以下能夠切入主題了：怎樣實現C++/PHP混合編程？
免責申明：因為本人屬於半路出家。接觸PHP擴展開發尚未足周，因此無法深入到WHY，僅能停留在HOW。僅作記錄之用，望高手見諒！
開場
嵌入式PHP
業內C++/PHP的結合。通常是出於“性能”考慮，在PHP代碼裏調用C/C++擴展，從而解決特定的性能瓶頸（如PB序列化等）。
作為C/C++開發出身。“開發效率”相對於“性能”的誘惑顯然更大，因此。我們的思路是：將PHP作為腳本語言。高速開發業務邏輯，插入到SPP框架執行。
1. 以RTLD_GLOBAL方式打開php動態庫
void *php_handler = dlopen("libphp5.so", RTLD_LAZY | RTLD_GLOBAL);
if (!php_handler) {
base->log_.LOG_P_PID(LOG_FATAL, "%s\n", dlerror());
return -1;
}
dlclose(php_handler);2. 通過php_embed_init進行初始化
php_embed_module.php_ini_path_override = "../php/php.ini"; php_embed_init(0, NULL);
3. 通過zend_eval_string引入PHP腳本
zend_first_try {
char exec_str[256];
snprintf(exec_str, sizeof(exec_str), "include ‘%s‘;", "../php/demo_handler.php");
if (int ret = zend_eval_string(exec_str, NULL, exec_str TSRMLS_CC)) {
base->log_.LOG_P_PID(LOG_FATAL, "zend_eval_string fail. ret=%d\n", ret);
return -1;
}
base->log_.LOG_P_PID(LOG_DEBUG, "zend_eval_string succ.\n");
} zend_catch {
base->log_.LOG_P_PID(LOG_FATAL, "zend_eval_string catch.\n");
} zend_end_try ();
4. 通過call_user_function回調PHP函數
zval z_funcname;
ZVAL_STRING(&z_funcname, "EchoDemo::init", 1);
zval *zp_svr;
MAKE_STD_ZVAL(zp_svr);
ZVAL_LONG(zp_svr, (long)base);
zval *zp_etc;
MAKE_STD_ZVAL(zp_etc);
ZVAL_STRING(zp_etc, etc, 1);
zval z_retval;
zval *z_params[] = {zp_svr, zp_etc};
int call_ret = call_user_function(CG(function_table), NULL, &z_funcname, &z_retval, sizeof(z_params) / sizeof(z_params[0]), z_params TSRM convert_to_long(&z_retval);
int func_ret = Z_LVAL_P(&z_retval);
zval_ptr_dtor(&zp_etc);
zval_dtor(&z_funcname);
zval_dtor(&z_retval);
if (call_ret < 0 || func_ret < 0) {
base->log_.LOG_P_PID(LOG_FATAL, "call_user_function fail. call_ret=%d func_ret=%d\n", call_ret, func_ret);
return -1;
}
5. 通過php_embed_shutdown進行清理
php_embed_shutdown(TSRMLS_C);
PHP擴展
網絡上關於PHP的C擴展開發文章能夠說已經到泛濫的地步了。有興趣的讀者能夠深入閱讀文末的附錄。
1. 下載php源代碼包，進行手動編譯。為了配合上述嵌入式使用，須要打開—enable-embed選項
./configure --enable-embed make make install（可選）
2. 進入php源代碼包的ext文件夾。借助ext_skel工具生成插件架子代碼
cd ext ./ext_skel --extname=demo
3. 編輯config.m4，打開PHP_ARG_WITH或者PHP_ARG_ENABLE選項（說實話差別仍沒搞清楚，求達人指點）。加入C++支持、依賴路徑等
PHP_ARG_ENABLE(demo, whether to enable demo support,
[ --enable-demo Enable demo support])
if test "$PHP_DEMO" != "no"; then
PHP_REQUIRE_CXX()
PHP_ADD_LIBRARY(stdc++, 1, EXTRA_LDFLAGS)
PHP_ADD_INCLUDE(/root/spp/module/include/)
PHP_ADD_INCLUDE(/root/spp/module/include/spp_incl/)
PHP_NEW_EXTENSION(demo, demo.cpp, $ext_shared)
fi
4. 編輯demo.cpp，加入擴展定義和實現（函數、類、變量 ...），這裏只給出函數定義演示樣例，類相關的有興趣的讀者自行依據附錄摸索。這裏給出的sendrecv函數定義比較有代表性，當中第3個參數rsp為引用參數，負責將接收到的數據返回給PHP調用方
ZEND_BEGIN_ARG_INFO_EX(arginfo_sendrecv, 0, 0, 7)
ZEND_ARG_INFO(0, req)
ZEND_ARG_INFO(0, req_len)
ZEND_ARG_INFO(1, rsp)
ZEND_ARG_INFO(0, rsp_len)
ZEND_ARG_INFO(0, ip)
ZEND_ARG_INFO(0, port)
ZEND_ARG_INFO(0, timeout)
ZEND_END_ARG_INFO()
PHP_FUNCTION(sendrecv)
{
char *req = NULL;
int req_str_len = 0;
long req_len = 0;
zval *rsp = NULL;
long rsp_len = 0;
char *ip = NULL;
int ip_str_len = 0;
long port = 0;
long timeout = 0;
if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "slzlsll", &req, &req_str_len,
&req_len, &rsp, &rsp_len, &ip, &ip_str_len, &port, &timeout) == FAILURE) {
return;
}
struct sockaddr_in addr;
memset(&addr, 0, sizeof(addr));
addr.sin_family = AF_INET;
addr.sin_addr.s_addr = inet_addr(std::string(ip, ip_str_len).c_str());
addr.sin_port = htons(port);
char *rsp_buf = (char *)emalloc(rsp_len);
int rsp_buf_len = rsp_len;
if (int ret = mt_udpsendrcv(&addr, req, req_len > req_str_len ? req_str_len : req_len, rsp_buf, rsp_buf_len, timeout)) {
efree(rsp_buf);
RETURN_LONG(ret);
}
zval_dtor(rsp);
ZVAL_STRINGL(rsp, rsp_buf, rsp_buf_len, 0);
RETURN_LONG(0);
}const zend_function_entry demo_functions[] = {
PHP_FE(sendrecv, arginfo_sendrecv)
PHP_FE_END /* Must be the last line in demo_functions[] */
};
5. 一切準備就緒，能夠編譯擴展了，我個人比較喜歡動態編譯（靜態編譯須要又一次編譯php源代碼。太耗時費力），生成的.so位於當前擴展的modules文件夾下
/usr/local/bin/phpize ./configure --with-php-config=/usr/local/bin/php-config make
6. 編輯php.ini文件，加入新的擴展，然後就能夠愉快地在PHP代碼中調用新擴展了
extension_dir="/somewhere/modules" extension="demo.so" extension="xxxx.so"
高潮
最終到了組裝成型的時刻了，通過telnet玩了幾把EchoDemo，看到一行一行的回顯，不禁心情大好。
<?php
class EchoDemo {
public static function init($server, $conf) {
log_debug($server, "init in php.\n");
return true;
}
public static function input($server, $req, $ext_info = array()) {
log_debug($server, "input in php.\n");
return strlen($req);
}
public static function route($server, $req, $ext_info = array()) {
log_debug($server, "route in php.\n");
return 1;
}
public static function process($server, $req, $ext_info = array()) {
log_debug($server, "process in php.\n");
$ret = sendrecv($req, strlen($req), $rsp, 65535, "127.0.0.1", 2345, 500);
if ($ret != 0) {
log_debug($server, "sendrecv fail. ret=$ret");
return false;
}
log_debug($server, "sendrecv finish. rsp=$rsp");
return true;
}
public static function fini($server) {
log_debug($server, "fini in php.\n");
}
}
?>
這裏最值得贊嘆的就是process函數對於sendrecv擴展調用，這裏背後通過協程事實上已經實現了一次異步網絡交互：既能像同步CGI般書寫邏輯代碼。又能無痛地享受異步的高並發。
願望是美好的。現實是殘酷的！
我這時突然心血來潮：來壓測一把性能吧，看看相比於原生C++代碼有多大的性能衰減。單次請求1KB，施以1w/s的壓力，壓了一會coredump了。
內存泄漏？協程棧溢出？...
期間各種折騰：GDB，改動協程棧大小。Google，咨詢PHPer ...
非常快到了晚上。該查的都查過了，該問的都問過了，實在沒轍了，停下來喝杯茶：“call_user_function可重入麽”？想到這一層，相信了解協程本質的兄弟又秒懂了：你妹的。人家實現Zend的時候怎麽知道調用線程還會玩協程進行用戶態調度啊，這個黑盒裏面一切皆有可能啊！全局變量、靜態變量 ...
好吧，去掉sendrecv這類基於協程的擴展，又一次壓測，單worker對於3w/s的echo還是輕松無壓力的。
結局
盡管這次最吸引人的一個Feature終於未能實現，只是我還是非常開心，由於再次印證了一個觀點：思考往往比蠻幹高效百倍，尤其在處理棘手問題時，無頭蒼蠅般亂闖亂撞往往費力不討好。此時。假設可以冷靜下來，盡力搜集現有知識儲備。說不定靈感就來光顧你了。
未來可能的方向：PHP從5.5版本號引入了yield。感覺假設挖掘出來Zend對於yield的支持細節。說不定有希望和我們的C框架非常好的融合。可是總認為是個填不平的大坑。假設拋開其他因素，或許我還是希望選擇Golang一類語言直接享受goroutine的優勢吧。哈哈！
附錄
PHP擴展開發及內核應用 http://www.walu.cc/phpbook/preface.md 編譯PHP擴展的兩種方式 http://521-wf.com/archives/227.html 怎樣使用C++開發PHP擴展（上） http://521-wf.com/archives/241.html 怎樣使用C++開發PHP擴展（下） http://521-wf.com/archives/245.html Wrapping C++ Classes in a PHP Extension http://devzone.zend.com/1435/wrapping-c-classes-in-a-php-extension/一次失敗的PHP擴展開發之旅