一步步入門編寫PHP擴展

一、寫在最前

隨着互聯網飛速發展，lamp架構的流行，php支持的擴展也愈來愈多，這樣直接促進了php的發展。

  可是php也有腳本語言不可避免的問題，性能比例如C等編譯型語言相差甚多，因此在考慮性能問題的時候最好仍是經過php擴展來解決。

  那麼，怎麼去作一個php擴展呢。下面從一個例子開始（本文章須要C基礎）。

二、解決一個問題

在一個系統中，若是常常要求一個數組的平方和，咱們能夠這麼寫。

<?php

function array_square_sum($data){
    $sum = 0;
    foreach($data as $value){
        $sum += $value * $value;
    }
    return $sum;
}
  實際執行的時候，php zend引擎會把這段話翻譯成C語言，每次都須要進行內存分配。因此性能比較差。進而，基於性能上的考慮，咱們能夠編寫一個擴展來作這個事情。

三、編寫擴展

構建一個擴展，至少須要2個文件。一個是Configulator文件，它會告訴編譯器編譯這個擴展至少須要哪些依賴庫；第二個是實際執行的文件。

3.1 生成框架

聽起來很複雜，實際上有一個工具能夠幫咱們搞定一個擴展的框架。在php源代碼裏面有個工具ext_skel，他能夠幫咱們生成擴展框架。

liujun@ubuntu:~/test/php-5.5.8/ext$ ls ext_skel
ext_skel

如今咱們利用它生成擴展 array_square_sum。($表示提示符命令)

$ ./ext_skel --extname=array_square_sum
Creating directory array_square_sum
Creating basic files: config.m4 config.w32 .svnignore array_square_sum.c php_array_square_sum.h CREDITS EXPERIMENTAL tests/001.phpt array_square_sum.php [done].

To use your new extension, you will have to execute the following steps:

1. $ cd ..

2. $ vi ext/array_square_sum/config.m4

3. $ ./buildconf

4. $ ./configure --[with|enable]-array_square_sum

5. $ make

6. $ ./php -f ext/array_square_sum/array_square_sum.php

7. $ vi ext/array_square_sum/array_square_sum.c

8. $ make

Repeat steps 3-6 until you are satisfied with ext/array_square_sum/config.m4 and
step 6 confirms that your module is compiled into PHP. Then, start writing
code and repeat the last two steps as often as necessary.

執行命令以後，終端告訴咱們怎麼去生產新的擴展。查看一下文件內容，會發現多了幾個比較重要的文件config.m4, php_array_square_sum.h，array_square_sum.c，下面會一一敘述。

liujun@ubuntu:~/test/php-5.5.8/ext$ ll array_square_sum/
total 44
drwxr-xr-x 3 liujun liujun 4096 Jan 29 15:40 ./
drwxr-xr-x 80 liujun liujun 4096 Jan 29 15:40 ../
-rw-r--r-- 1 liujun liujun 5548 Jan 29 15:40 array_square_sum.c
-rw-r--r-- 1 liujun liujun 532 Jan 29 15:40 array_square_sum.php
-rw-r--r-- 1 liujun liujun 2354 Jan 29 15:40 config.m4
-rw-r--r-- 1 liujun liujun 366 Jan 29 15:40 config.w32
-rw-r--r-- 1 liujun liujun 16 Jan 29 15:40 CREDITS
-rw-r--r-- 1 liujun liujun 0 Jan 29 15:40 EXPERIMENTAL
-rw-r--r-- 1 liujun liujun 3112 Jan 29 15:40 php_array_square_sum.h
-rw-r--r-- 1 liujun liujun 16 Jan 29 15:40 .svnignore
drwxr-xr-x 2 liujun liujun 4096 Jan 29 15:40 tests/
3.2 配置文件config.m4
dnl PHP_ARG_WITH(array_square_sum, for array_square_sum support,
dnl Make sure that the comment is aligned:
dnl [ --with-array_square_sum Include array_square_sum support])

去掉dnl

PHP_ARG_WITH(array_square_sum, for array_square_sum support,
Make sure that the comment is aligned:
[ --with-array_square_sum Include array_square_sum support])

這是./configure時可以調用enable-sample選項的最低要求.PHP_ARG_ENABLE的第二個參數將在./configure處理過程當中到達這個擴展的配置文件時顯示. 第三個參數將在終端用戶執行./configure --help時顯示爲幫助信息

3.3 頭文件

修改php_array_square_sum.h，把confirm_array_square_sum_compiled改爲confirm_array_square_sum,這個爲咱們之後實際調用的函數名字，固然你也能夠直接加入函數confirm_array_square_sum，而不刪除confirm_array_square_sum_compiled。

PHP_FUNCTION(confirm_array_square_sum_compiled);

該成

PHP_FUNCTION(array_square_sum);
3.3 源代碼

修改 array_square_sum.c，把confirm_array_square_sum_compiled改爲confirm_array_square_sum，這個是註冊這個擴展的函數，若是在3.2中直接加入了confirm_array_square_sum，在這一步也直接加入confirm_array_square_sum就能夠了。

const zend_function_entry array_square_sum_functions[] = {

PHP_FE(confirm_array_square_sum_compiled,   NULL)       /* For testing, remove later. */
PHP_FE_END  /* Must be the last line in array_square_sum_functions[] */

};

改爲

const zend_function_entry array_square_sum_functions[] = {

PHP_FE(array_square_sum,    NULL)       /* For testing, remove later. */
PHP_FE_END  /* Must be the last line in array_square_sum_functions[] */

};

而後最爲關鍵的一個步驟，重寫confirm_array_square_sum，這個時候只須要把confirm_array_square_sum_compiled重寫成confirm_array_square_sum(3.1中沒有刪除confirm_array_square_sum_compiled，就須要加入confirm_array_square_sum就行了)。

PHP_FUNCTION(confirm_array_square_sum_compiled)

重寫爲

PHP_FUNCTION(array_square_sum)
{

zval* array_data;
HashTable *ht_data;
int ret;
char* key;
uint index;
zval **pdata;
double sum = 0;

if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "a", &array_data) == FAILURE) {
    return;
}   

ht_data = Z_ARRVAL_P(array_data);
zend_hash_internal_pointer_reset(ht_data);
while ( HASH_KEY_NON_EXISTANT != (ret = zend_hash_get_current_key(ht_data, &key, &index, 0)) ) { 
    ret = zend_hash_get_current_data(ht_data, &pdata);

    if( Z_TYPE_P(*pdata) == IS_LONG){
        sum +=  Z_LVAL_P(*pdata) *  Z_LVAL_P(*pdata);
    }else {
        RETURN_FALSE;
    }   
    zend_hash_move_forward(ht_data);
}   
zend_hash_internal_pointer_end(Z_ARRVAL_P(array_data));
RETVAL_DOUBLE(sum);

}

php是一個弱類型語言，他的數據都存在結構體zval裏面(具體請看更加專業資料，如"php擴展開發.pdf")。

typedef union _zval {

long lval;
double dval;
struct {
    char *val;
    int len;
} str;
HashTable *ht;
zend_object_value obj;

} zval;

爲了得到函數傳遞的參數，可使用zend_parse_parameters()API函數。下面是該函數的原型：

zend_parse_parameters(int num_args TSRMLS_DC, char *type_spec, …);

zend_parse_parameters()函數的前幾個參數咱們直接用內核裏宏來生成即可以了，形式爲：ZEND_NUM_ARGS() TSRMLS_CC，注意二者之間有個空格，可是沒有逗號。從名字能夠看出，ZEND_NUM_ARGS()表明這參數的個數。後面緊跟着是常見的參數類型（和C語言的printf相似），後面就是常見的參數列表。
 下表列出了常見的參數類型。

參數類型 對象C類型 說明
l long 整數
b bool 布爾
s char* 字符串
d double 浮點數
a array(zval*) 數組
z zval* 不肯定性zval

此外數組是一個大型的hashtable來實現的，因此zend_hash_get_current_key能夠遍歷數組，使用宏Z_LVAL_P(zval*)得到實際的值。最終能夠將結果放入到sum裏面。RETVAL_DOUBLE(value)也是一個宏，返回結果爲double,值則爲value，具體能夠參見" php擴展開發.pdf".

  最終完成了這個主函數的開發。

3.4 生成configure文件

而後執行 ~/php/bin/phpize

/home/liujun/php/bin/phpize
Configuring for:
PHP Api Version: 20121113
Zend Module Api No: 20121212
Zend Extension Api No: 220121212

能夠發現array_square_sum出現可執行腳本configure。

3.5 編譯

編譯的時候最好帶上php-config PATH，由於系統默認的php-config-path可能不是你目前使用的php路徑。

liujun@ubuntu:~/test/php-5.5.8/ext/array_square_sum$ ./configure --with-php-config=/home/liujun/php/bin/php-config

編譯若是成功，終端會有以下提示：

creating libtool
appending configuration tag "CXX" to libtool
configure: creating ./config.status
config.status: creating config.h
config.status: config.h is unchanged

查看array_square_sum目錄的module目錄，會發現裏面生成array_square_sum.so，這個就是咱們須要的擴展。

liujun@ubuntu:~/test/php-5.5.8/ext/array_square_sum$ ls modules/
array_square_sum.la array_square_sum.so
四、使用擴展
4.一、配置擴展

修改php的配置php.ini，加入一下配置內容。

[array_square_sum]
extension=array_square_sum.so
4.二、加入module

php的擴展通常在 $PHP_PATH/lib/php/extensions/no-debug-non-zts-yyyymmdd，若是找不到，請自行百度or Google. 裏面有不少.so文件。 

  把3.5生產的array_sum_square.so拷貝進去便可。

  若是使用fastcgi模式，須要重啓php，這樣咱們php就應該有擴展array_square_sum，具體能夠經過查看phpinfo(不會請自行百度orGoogle).

4.二、編寫代碼

既然說編寫擴展能夠提升運行效率，所以在這裏，咱們經過使用擴展和直接使用php代碼來進行對比，測試性能。屢次實驗能夠減小偏差，因此進行2000次對100000個數字求平方和。代碼以下:

<?php

$data = array();
$max_index = 100000;
$test_time = 2000;
for($i=0; $i<$max_index; $i++){
    $data[] = $i; 
}   

$php_test_time_start = time();
php_test($test_time, $data);
$php_test_time_stop = time();
echo "php test ext time is ". ($php_test_time_stop - $php_test_time_start). "\n";

$c_test_time_start = time();
c_test($test_time, $data);
$c_test_time_stop = time();
echo "php test time is ". ($c_test_time_stop - $c_test_time_start). "\n";

function php_test($test_time, $test_data){
    for($i=0; $i<$test_time; $i++){
        $sum = 0;
        foreach($test_data as $data){
            $sum += $data * $data;
        }   
    }   
}   

function c_test($test_time, $test_data){
    for($i=0; $i<$test_time; $i++){
        $sum = array_square_sum($test_data);
    }   
}
  測試結果以下：

liujun@ubuntu:~/php$ ~/php/bin/php test.php
php test ext time is 30
php test time is 2

能夠看到擴展要比直接使用php快15倍。隨着業務邏輯變得更加複雜，這個差別化會越大。

 那麼直接使用c語言來作這個事情呢。下面也給一個代碼來測試下（測試條件徹底一致）：

include<stdio.h>

include<sys/time.h>

include<unistd.h>

define TEST_TIME 2000

define MAX_INDEX 100000

int main()
{

int data[MAX_INDEX];
double sum = 0;

for(int i=0; i<MAX_INDEX; i++){
    data[i] = i;
}   

struct timeval start;
struct timeval end;

gettimeofday(&start,NULL);

for(int i=0; i<TEST_TIME; i++){
    for(int j=0; j<MAX_INDEX; j++){
        sum += data[j] * data[j];
    }   
}   
gettimeofday(&end,NULL);

double time=(end.tv_sec-start.tv_sec) + (end.tv_usec-start.tv_usec) * 1.0 /1000000;
printf("total time is %lf\n", time );
printf("sum time is %lf\n", sum);
return 0;

}

執行查看效果，能夠看出直接使用C的時間只有0.261746，是使用C擴展的13.09%，是直接使用php的0.87%。固然若是涉及到IO等複雜操做，C/C++會比php快上萬倍（測試過）。

liujun@ubuntu:~/php$ g++ test.cpp -O2 -o test
liujun@ubuntu:~/php$ ./test
total time is 0.261746
sum time is 36207007178615872.000000

所以，在實際對性能要求很是高的服務，如索引、分詞等，可使用C作一套底層服務，php去進行封裝調用。