linux 下 采用CMake 方式开发php扩展（一）

一、准备工作

开发环境：ubuntu 14.0.4 + apache2 + php7.0.20
开源项目:libmf(做概率矩阵分解的一个很优秀的开源软件,内置sse ,avx,openMP等指令集优化,速度灰常快!)
地址:http://www.csie.ntu.edu.tw/~cjlin/libmf/
初步的想法是将libmf模块移植到php中,能够直接调用,也就是为php扩展一个新的模块.
首先下载libmf留后面备用,截止到2017/6/27 ,libmf的版本到了libmf-2.01,因此本次扩展所采用的正是libmf-2.01

二.配置相关环境

2.1 安装apache2

$ sudo apt-get install apache2

产生的启动和停止文件是：/etc/init.d/apache2 配置文件保存在：/etc/apache2
相关操作:

$ sudo apache2ctl -k start      //启动
$ sudo apache2ctl -k stop       //停止
$ sudo apache2ctl -k restart    //重新启动

2.2 编译安装php7

在安装php7之前 先安装一些依赖库

  sudo apt-get install autoconf
  sudo apt-get install libxml2-dev
  sudo apt-get install bzip2
  sudo apt-get install libcurl3-openssl-dev
  sudo apt-get install libcurl4-gnutls-dev
  sudo apt-get install libjpeg-dev
  sudo apt-get install libpng-dev
  sudo apt-get install libxpm-dev
  sudo apt-get install libfreetype6-dev
  sudo apt-get install libt1-dev
  sudo apt-get install libmcrypt-dev
  sudo apt-get install libmysql++-dev
  sudo apt-get install libxslt1-dev 
  sudo apt-get install libbz2-dev

如果在安装过程中出现 如下错误信息:
E: 无法修正错误，因为您要求某些软件包保持现状，就是它们破坏了软件包间的依赖关系。
解决方法:
更改软件源 :打开系统设置-> 软件和更新-> 在 下载自 的列表 选择 163 的镜像地址 而非 中国的服务器。
然后执行 sudo apt-get update即可 再安装相关依赖库。

sudo apt-get install apache2-dev

安装 apache2-dev,否则在配置php时无法指定--with-apxs2=/usr/bin/apxs来生成 libphp7.so

从官网下载 php-7.0.20.tar.gz
地址:http://www.php.net/

$ tar xzvf php-7.0.20.tar.gz              /解压到当前目录下
$ sudo cp php-7.0.20 /home/lw/桌面/php    /将php源码拷贝到桌面下的php目录下
$ cd /home/lw/桌面/php/php-7.0.20         /进入php源码目录下
$ ./buildconf --force                     /编译执行前检查相关依赖
$ ./configure --prefix=/usr/local/php-7.0.20 --with-config-file-path=/usr/local/php-7.0.20/etc/ --enable-fpm --with-fpm-user=www-data --with-fpm-group=www-data --with-mysql-sock --with-mysqli --with-pdo-mysql --with-iconv-dir --with-freetype-dir --with-jpeg-dir --with-png-dir --with-libxml-dir=/usr --disable-rpath --enable-bcmath --enable-shmop --enable-inline-optimization --with-curl --enable-mbregex --enable-mbstring --enable-ftp --with-gd --enable-gd-native-ttf --enable-soap --without-pear --with-gettext --disable-fileinfo --enable-maintainer-zts --disable-debug --enable-shared --enable-opcache --enable-pdo --with-iconv --with-mcrypt --with-mhash --with-openssl --enable-xml --with-xmlrpc --with-libxml-dir --enable-pcntl --enable-sysvmsg --enable-sysvsem --enable-sysvshm --with-zlib --enable-zip  --without-sqlite3 --without-pdo-sqlite --with-libdir=/lib/x86_64-linux-gnu --with-jpeg-dir=/usr/lib --with-apxs2=/usr/bin/apxs2 --enable-cgi  --enable-wddx --with-zlib-dir --with-bz2 --enable-session --enable-exif                /配置开启 php-fpm支持，--enable-fpm;开启多线程支持 --enable-maintainer-zts;开启线程安全以及其他模块 

如果没有找到/usr/bin/apxs2 ,执行 sudo find / -name apxs2或者sudo find / -name apxs去查找其路径, 路径可能会有些许差别.
上一步没有报错的话,执行:
$ sudo make

编译可能出现的错误:
sockets 模块一直make出错,这个错误真是无解,换了许多php版本都报错….最后无奈只好在./configure 中将 –enable-sockets 去掉 如果没报错,那么恭喜你~~
继续执行:

sudo make install

如果要重新编译的话,需先执行sudo make clean

如果这一步没有出现成功提示，或者有报错信息，请参考https://gist.github.com/m1st0/1c41b8d0eb42169ce71a 安装相应依赖包。

2.3 apache2 和php7 的连接

安装php之后，它会将libphp7.so安装到/usr/lib/apache2/modules中，并在/etc/apache2/mods-enabled文件夹中加入php7.load，为了使得apache2能够解析php文件，我们需要在这个php7.load文件尾加入一些信息。

$ sudo gedit /etc/apache2/mods-enabled/php7.load
加入信息如下:

LoadModule php7_module        /usr/lib/apache2/modules/libphp7.so

Addtype application/x-httpd-php .php
Addtype application/x-httpd-php-source .phps

编辑测试页面
$ gksudo gedit /var/www/html/test.php
向test.php 添加如下信息:

      echo phpinfo();
  ?>

重启apache2
$ sudo service apache2 restart

浏览器地址栏输:http://localhost/test.php 或http://127.0.1.1/test.php

注意: 如果在安装php 的过程中出现了错误,在重新编译安装之后,可能linux中的php路径会被去掉,使得apache不能解析php 这个时候需要手动向系统路径中添加php。

$ export PATH=$PATH:/usr/local/php-7.0.20/bin
然后 php -v查看是否生效,生效后在重启apache2 浏览器打开测试页面查看。

三. 为libmf编写cmake工程

这一部分内容为的是拿到.so文件，先看一下我们需要什么文件吧 。
$ cd /home/lw/桌面/phpmf
$ tree

   ├── CMakeLists.txt
   ├── mf
   │   ├── CMakeLists.txt
   │   ├── mf.cpp
   │   └── mf.h
   ├── mfTest
   │   ├── CMakeLists.txt
   │   └── mfTest.cpp
   └── php_mf
       ├── CMakeLists.txt
       ├── mfWarp.cpp
       ├── mfWarp.h
       ├── php_mf.c
       └── php_mf.h

说明：在这里 我首先从下载的 libmf-2.01 中取出 mf.h mf.cpp 文件放在mf文件夹内,这是整个软件的核心,mf.h定义了相应的数据结构以及函数声明,mf.cpp则是所对应的函数定义,源文件中还有my_train.cpp 和my_predict.cpp,这两个可为我们写自定义的功能函数提供参考,此外 我们还自己写了一个测试放在mftest目录下,而有关php扩展的内容放在了php_mf目录下。

下面我们按照目录顺序依次解析其内容

3.1 编辑phpmf/CMakeLists.txt

首先是phpmf 根目录下的 CMakeLists.txt

   # CMake 最低版本号要求
   cmake_minimum_required(VERSION 2.6)
   # 支持旧版本的 CMake
   if(WIN32)
     set(CMAKE_INSTALL_PREFIX "${CMAKE_BINARY_DIR}/install" CACHE PATH "Installation Directory")
   else()
     set(CMAKE_INSTALL_PREFIX "/usr/local/phpmf" CACHE PATH "Installation Directory")
   endif()

   macro(use_cxx11)
     if(CMAKE_VERSION VERSION_LESS "3.1")
       if(CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
         set(CMAKE_CXX_FLAGS "--std=gnu++11 ${CMAKE_CXX_FLAGS}")
       endif()
     else()
       set(CMAKE_CXX_STANDARD 11)
     endif()
   endmacro(use_cxx11)
   #设置配置类型
   if(CMAKE_CONFIGURATION_TYPES)
    set(CMAKE_CONFIGURATION_TYPES "Debug;Release" CACHE PATH "Configs" FORCE)
   endif()

   use_cxx11()

   project(phpmf)
   #设置执行文件输出目录(在根目录的bin下)
   set(EXECUTABLE_OUTPUT_PATH ${CMAKE_BINARY_DIR}/bin)
   #设置链接库输出目录
   set(LIBRARY_OUTPUT_PATH ${CMAKE_BINARY_DIR}/bin)
   #添加子目录
   add_subdirectory(mf)
   add_subdirectory(mfTest)
   add_subdirectory(php_mf)

3.2 编辑mf文件内容

1) mf/CMakeLists.txt

   #包含头文件
   include_directories(include)
   #获取源代码下的所有源文件和头文件
   file(GLOB mf_src "./*.cpp")
   file(GLOB mf_head "./*.h")

   if(WIN32)
       set(CMAKE_CXX_FLAGS "/W4 /nologo /O2 /EHsc /arch:AVX /openmp")
   else()
       set(CMAKE_CXX_FLAGS "-Wall -O3 -pthread -std=c++0x -march=native -mavx -fopenmp")
   endif()
   #开启sse avx omp
   add_definitions(-DUSESSE -DUSEAVX -DUSEOMP -D_CRT_SECURE_NO_DEPRECATE)

   add_library(mf SHARED ${mf_src} ${mf_head})

   if(WIN32)
       install(TARGETS mf
        RUNTIME DESTINATION ./)
   endif()

2)mf/mf.cpp

(这里仅贴出增加的自定义功能函数mf_my_train())

/************************************************************************************************
    Function:     mf_my_train()
    Description:  对于指定的稀疏矩阵进行分解,返回分解后的P,Q矩阵,并保存在指定的路径下
    Input:        tr_path:需要进行矩阵分解的稀疏矩阵(绝对路径);model_path将模型保存到的路径
    Output:       保存模型到本地是否成功,1(打开本地路径失败,即保存失败);0(成功)
    Return:       返回的是状态值
    Others:
   ***********************************************************************************************/
   mf_int mf_my_train(
       char const * tr_path,
       char const * model_path)
   {
       mf_int status = -1;
       mf_problem tr;
       mf_model *model;

       tr = read_problem(tr_path);
       mf_parameter param = mf_get_default_param();
       param.nr_iters = 40;
       model = mf_train_with_validation(&tr, nullptr, param);
       //printf("train success\A3\A1");
       status = mf_save_model(model,model_path);

       return status;
    }

3) mf/mf.h

  因为我们要制作动态链接库,在windows下是dll,linux下是so,因此在文件头,添加了类似与在windows下生成dll的语句.凡是需要
 导出的函数都需要加上宏的标记 即MF_API。

#ifndef _LIBMF_H
    #define _LIBMF_H

    #include 

    #if (defined WIN32 || defined _WIN32)
    #if defined(MF_EXPORTS) || defined(mf_EXPORTS)
       #define MF_API __declspec(dllexport)
    #else 
       #define MF_API __declspec(dllimport)
    #endif 
    #elif defined __GNUC__ && __GNUC__ >= 4
       #define MF_API __attribute__ ((visibility ("default")))
    #else
       #define MF_API
    #endif

    #ifdef __cplusplus
    //extern "C"
    //{

    namespace mf
    {
    #endif

    typedef float mf_float;
    typedef double mf_double;
    typedef int mf_int;
    typedef long long mf_long;

    enum {P_L2_MFR=0, P_L1_MFR=1, P_KL_MFR=2, P_LR_MFC=5, P_L2_MFC=6, P_L1_MFC=7,
        P_ROW_BPR_MFOC=10, P_COL_BPR_MFOC=11};
    enum {RMSE=0, MAE=1, GKL=2, LOGLOSS=5, ACC=6, ROW_MPR=10, COL_MPR=11,
          ROW_AUC=12, COL_AUC=13};

    struct mf_node
    {
        mf_int u;
        mf_int v;
        mf_float r;
    };

    struct mf_problem
    {
        mf_int m;
        mf_int n;
        mf_long nnz;
        struct mf_node *R;
    };

    struct mf_parameter
    {
        mf_int fun;
        mf_int k;
        mf_int nr_threads;
        mf_int nr_bins;
        mf_int nr_iters;
        mf_float lambda_p1;
        mf_float lambda_p2;
        mf_float lambda_q1;
        mf_float lambda_q2;
        mf_float eta;
        bool do_nmf;
        bool quiet;
       bool copy_data;
    };

    MF_API struct mf_parameter mf_get_default_param();

    struct mf_model
    {
        mf_int fun;
        mf_int m;
        mf_int n;
        mf_int k;
        mf_float b;
        mf_float *P;
        mf_float *Q;
    };

    MF_API mf_problem read_problem(char const * path);

    MF_API mf_int mf_save_model(struct mf_model const *model, char const *path);

    MF_API struct mf_model* mf_load_model(char const *path);

    MF_API void mf_destroy_model(struct mf_model **model);

    MF_API struct mf_model* mf_train(
        struct mf_problem const *prob,
        struct mf_parameter param);

    MF_API mf_int mf_my_train(char const * tr_path, char const * model_path);

    MF_API struct mf_model* mf_train_on_disk(
        char const *tr_path,
        struct mf_parameter param);

    MF_API struct mf_model* mf_train_with_validation(
        struct mf_problem const *tr,
        struct mf_problem const *va,
        struct mf_parameter param);

    MF_API struct mf_model* mf_train_with_validation_on_disk(
        char const *tr_path,
        char const *va_path,
        struct mf_parameter param);

    MF_API mf_double mf_cross_validation(
        struct mf_problem const *prob,
        mf_int nr_folds,
        struct mf_parameter param);

    MF_API mf_double mf_cross_validation_on_disk(
        char const *prob,
        mf_int nr_folds,
        mf_parameter param);

    MF_API mf_float mf_predict(struct mf_model const *model, mf_int u, mf_int v);

    MF_API mf_double calc_rmse(mf_problem *prob, mf_model *model);

    MF_API mf_double calc_mae(mf_problem *prob, mf_model *model);

    MF_API mf_double calc_gkl(mf_problem *prob, mf_model *model);

    MF_API mf_double calc_logloss(mf_problem *prob, mf_model *model);

    MF_API mf_double calc_accuracy(mf_problem *prob, mf_model *model);

    MF_API mf_double calc_mpr(mf_problem *prob, mf_model *model, bool transpose);

    MF_API mf_double calc_auc(mf_problem *prob, mf_model *model, bool transpose);

    #ifdef __cplusplus
    } // namespace mf

    //} // extern "C"
    #endif

    #endif // _LIBMF_H

mf/mftest就不贴了吧..很简单的一个调用程序，详见博客底部链接~

3.2 编辑php_mf文件内容

此文件夹内容 (CMakelists文件除外)都是通过 开发php扩展获取,即在终端下输入:

    $ cd /home/lw/桌面/php/php-7.0.20/ext
    $ ./ext_skel --extname=php_libmf
    Creating directory php_libmf
    Creating basic files: config.m4 config.w32 .gitignore php_libmf.c php_php_libmf.h CREDITS EXPERIMENTAL tests/001.phpt php_libmf.php [done].

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

    1.  $ cd ..
    2.  $ vi ext/php_libmf/config.m4
    3.  $ ./buildconf
    4.  $ ./configure --[with|enable]-php_libmf
    5.  $ make
    6.  $ ./sapi/cli/php -f ext/php_libmf/php_libmf.php
    7.  $ vi ext/php_libmf/php_libmf.c
    8.  $ make

    Repeat steps 3-6 until you are satisfied with ext/php_libmf/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.

查看产生的文件(这里产生的是php_libmf.c而非.cpp,这是后来修改的)

    config.m4   config.w32  EXPERIMENTAL   php_libmf.cpp~  php_php_libmf.h   tests
    config.m4~  CREDITS     php_libmf.cpp  php_libmf.php   php_php_libmf.h~

php_libmf.cpp,php_php_libmf.h是我们要用的,为了方便更改名称:php_libmf.cpp->php_mf.c php_php_libmf.h->php_mf.h

1) mf/php_mf/CMakeLists.txt

这一部分的cmakelists的内容比较复杂, 大致可以分为三个部分 ：

• 寻找php相关头文件 如果不能有效定位php.ini.h的位置,会导致在后续cmake时出现找不到xxx.h的错误
• 判断编译平台 设置模块MF相关的参数
• 将所有源文件添加进动态库

    find_path(php_path NAMES php_ini.h)
    #set(php_path "/usr/local/php-7.0.20/include/php/main/")
    if(${php_path} STREQUAL php_path_NOTFOUND)
      message(FATAL_ERROR "cannot find the path contain the php_ini.h, please mannual set to the php_src/main")
    endif()

    include_directories(${php_path} ${php_path}/.. ${php_path}/../TSRM ${php_path}/../Zend)

    if(WIN32)
      add_definitions(-DZEND_WIN32 -DPHP_WIN32 -DPHP_EXTENSION -DZTS -DCOMPILE_DL_MF=1 -DHAVE_MF=1 -DZEND_DEBUG=$<CONFIG:DEBUG>)
    else()
      add_definitions(-DPHP_EXTENSION -DZTS -DCOMPILE_DL_MF=1 -DHAVE_MF=1 -DZEND_DEBUG=$<CONFIG:DEBUG>)
    endif()

    set( cur_files mfWarp.cpp php_mf.c mfWarp.h php_mf.h)
    add_library(php_mf SHARED ${cur_files})

    if(WIN32)
      set(mf_lib "${CMAKE_BINARY_DIR}/bin/Release/mf.lib")
      set(mf_lib_debug "${CMAKE_BINARY_DIR}/bin/Debug/mf.lib")
    else()
      set(mf_lib "${CMAKE_BINARY_DIR}/bin/libmf.so")
      set(mf_lib_debug "${CMAKE_BINARY_DIR}/bin/libmf.so")
    endif()


    if(WIN32)
        find_library(php_lib NAMES php)
        target_link_libraries(php_mf ${php_lib} $<$<CONFIG:Release>:${mf_lib}>$<$<CONFIG:Debug>:${mf_lib_debug}>)
    else()
        target_link_libraries(php_mf $<$<CONFIG:Release>:${mf_lib}>$<$<CONFIG:Debug>:${mf_lib_debug}>)
    endif()

    if(WIN32)
    install(TARGETS php_mf
        RUNTIME DESTINATION ext)
    #else()
        #install(TARGETS php_lib_mf
        #LIBRARY DESTINATION ./)
    endif()

2) mf/php_mf/mf_Warp.cpp

一个简单的转换函数, 定义在php调用的函数 ,在其内部 调用c++ 函数.

   #include "mfWarp.h"
   int php_mf_my_train(char * tr_path,char * model_path)
   {
    int result = mf::mf_my_train(tr_path, model_path);
    //printf("here %s", tr_path);
    return result;
   }

3) mf/php_mf/mf_Warp.h

   #pragma once
   #include 
   #include 
   #include "../mf/mf.h"

   extern "C" int php_mf_my_train(char * tr_path,char * model_path);

4) mf/php_mf/php_mf.c

完整的代码详见文件,这里仅给出需要修改的地方。

• 添加自定义php函数mf_my_train,获取参数，调用php_mf_my_train()，因为php是c写的，因此我们只能调用c代码，因此需要一个转换，php_mf_my_train则是以c的风格去调用我们已经在mf.cpp中声明为外部api的接口函数mf_my_train(),要特别注意的是PHP_FUNCTION(mf_my_train)中的mf_my_train与mf.cpp中的mf_my_train是完全不同的东西。

PHP_FUNCTION(mf_my_train)
    {
        char *tr_path = "";
        char *model_path = "";
        size_t tr_path_len, model_path_len;

        if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "ss", &tr_path, &tr_path_len, &model_path, &model_path_len) == FAILURE) {
            return;
        }
        int result = php_mf_my_train(tr_path, model_path);

        switch (result)
       {
        case 0:
            php_printf(" train successfully \n");
            break;
        case -1:
            php_printf(" train failed \n");
            break;
        default:
            break;
      }

      RETURN_LONG(result);
    }

代码的简要说明:
因为在mf_my_train(char * tr_path,char * model_path)中,要传入两个字符串类型,因此有"ss",s(string),i(int)…,ZEND_NUM_ARGS()用于获取参数数目，·TSRMLS_CC用于保证线程安全,然后后面类似于c中的scanf,要特别注意的是如果要传string类型的参数,后面一定要加上该字符串的长度。

• 添加php函数声明(第二行)

 const zend_function_entry mf_functions[] = {
    PHP_FE(mf_my_train, NULL)       /* For testing, remove later. */
    PHP_FE_END  /* Must be the last line in php_libmf_functions[] */

• 添加 extern int php_mf_my_train(char * tr_path,char * model_path); 提示该函数定义在别的源文件中

5) php_mf.h 不做修改

至此 所需要文件都配置完成! 读者可在右侧地址中获取整个工程文件~http://download.csdn.net/detail/orangesuan/9884327