php 擴(kuò)展加載

1 PHP_MINIT 宏

• 首先是宏展開(kāi)
  PHP_MINIT(moule) 等價(jià)于 zm_startup_moule

具體的宏替換如下

#define PHP_MINIT       ZEND_MODULE_STARTUP_N

#define ZEND_MODULE_STARTUP_N(module)       zm_startup_##module

2 ## 操作符

可以參考以下兩個(gè)鏈接

https://gcc.gnu.org/onlinedocs/cpp/Variadic-Macros.html#Variadic-Macros

https://www.cprogramming.com/reference/preprocessor/token-pasting-operator.html

在上面可以看到 zm_startup_##module，其中## 是一個(gè)連接符號(hào)
例子

#define type i##nt
type a; // same as int a; since i##nt pastes together to "int"

3 php main函數(shù)

main 函數(shù)

• php可以有多個(gè)運(yùn)行環(huán)境，我們現(xiàn)在以php-fpm 作為例子，他位于
  /sapi/fpm/fpm/fpm_main.c

• 其中main函數(shù)位于 1600 行左右

擴(kuò)展加載步驟

• 1 main 函數(shù)（c 語(yǔ)言都是以main 函數(shù)為開(kāi)頭）
• 2 調(diào)用 cgi_sapi_module的 startup 即 php_cgi_startup

    if (cgi_sapi_module.startup(&cgi_sapi_module)   == FAILURE) {`

其中 cgi_sapi_moule 是 一個(gè)靜態(tài)變量

//  /sapi/fpm/fpm/fpm_main.c   870 行
static sapi_module_struct cgi_sapi_module = {
    "fpm-fcgi",         /* name */
    php_cgi_startup,    /* startup */
    ...
};

• 3 然后 php_cgi_startup 調(diào)用 php_cgi_startup

static int php_cgi_startup(sapi_module_struct *sapi_module) /* {{{ */
{
    if (php_module_startup(sapi_module, &cgi_module_entry, 1) == FAILURE) {
        return FAILURE;
    }
    return SUCCESS;
}

其中 php_module_startup 在 /main/main.c 中

• 調(diào)用 zend_startup_modules

int php_module_startup(sapi_module_struct *sf, zend_module_entry *additional_modules, uint num_additional_modules)
{
    ...
    /* load and startup extensions compiled as shared objects (aka DLLs)
       as requested by php.ini entries
       these are loaded after initialization of internal extensions
       as extensions *might* rely on things from ext/standard
       which is always an internal extension and to be initialized
       ahead of all other internals
     */
    php_ini_register_extensions();
    zend_startup_modules();
    ...

其中 zend_startup_modules

ZEND_API int zend_startup_modules(void) /* {{{ */
{
    zend_hash_sort_ex(&module_registry, zend_sort_modules, NULL, 0);  // 對(duì)擴(kuò)展進(jìn)行排序
    zend_hash_apply(&module_registry, zend_startup_module_zval);      // 調(diào)用minit開(kāi)始函數(shù)
    return SUCCESS;
}

然后看 zend_hash_apply

/* This is used to recurse elements and selectively delete certain entries
 * from a hashtable. apply_func() receives the data and decides if the entry
 * should be deleted or recursion should be stopped. The following three
 * return codes are possible:
 * ZEND_HASH_APPLY_KEEP   - continue
 * ZEND_HASH_APPLY_STOP   - stop iteration
 * ZEND_HASH_APPLY_REMOVE - delete the element, combineable with the former
 */

ZEND_API void ZEND_FASTCALL zend_hash_apply(HashTable *ht, apply_func_t apply_func)
{
    uint32_t idx;
    Bucket *p;
    int result;

    IS_CONSISTENT(ht);

    HASH_PROTECT_RECURSION(ht);
    for (idx = 0; idx < ht->nNumUsed; idx++) {
        p = ht->arData + idx;
        if (UNEXPECTED(Z_TYPE(p->val) == IS_UNDEF)) continue;
        result = apply_func(&p->val);

        if (result & ZEND_HASH_APPLY_REMOVE) {
            HT_ASSERT(GC_REFCOUNT(ht) == 1);
            _zend_hash_del_el(ht, HT_IDX_TO_HASH(idx), p);
        }
        if (result & ZEND_HASH_APPLY_STOP) {
            break;
        }
    }
    HASH_UNPROTECT_RECURSION(ht);
}

函數(shù) zend_hash_apply(HashTable *ht, apply_func_t apply_func) 的第二個(gè)參數(shù)類(lèi)型是 apply_func_t 是一個(gè)函數(shù)指針

//    /Zend/zend_hash.h
typedef int (*apply_func_t)(zval *pDest);

• 回到 剛才的 zend_startup_modules ,
  在 zend_startup_modules 中調(diào)用了 zend_hash_apply
  這個(gè)函數(shù)會(huì)遍歷hashtable 里面的值并調(diào)用其中的初始化函數(shù)也就是調(diào)用PHP_MINIT(modules)，zend_hash_apply 第二個(gè)參數(shù)是 一個(gè)函數(shù)指針 ，這個(gè)函數(shù)是 zend_startup_module_zval

ZEND_API int zend_startup_modules(void) /* {{{ */
{
    zend_hash_sort_ex(&module_registry, zend_sort_modules, NULL, 0);  // 對(duì)擴(kuò)展進(jìn)行排序
    zend_hash_apply(&module_registry, zend_startup_module_zval);      // 調(diào)用minit開(kāi)始函數(shù)
    return SUCCESS;
}

核心函數(shù) zend_startup_module_zval

//  /Zend/zend_API.c
static int zend_startup_module_zval(zval *zv) /* {{{ */
{
    zend_module_entry *module = Z_PTR_P(zv);  // 獲得模塊實(shí)例

    return (zend_startup_module_ex(module) == SUCCESS) ? ZEND_HASH_APPLY_KEEP : ZEND_HASH_APPLY_REMOVE;    // 調(diào)用init 函數(shù)
}
/* }}} */

之后是 zend_startup_module_ex,其中重要的函數(shù)是 module_startup_func

//////////////////   加載擴(kuò)展
ZEND_API int zend_startup_module_ex(zend_module_entry *module) /* {{{ */
{
...

    if (module->module_startup_func) {
        EG(current_module) = module;   // execute_group 
        if (module->module_startup_func(module->type, module->module_number)==FAILURE) {  // 注冊(cè)失敗則打印
            zend_error_noreturn(E_CORE_ERROR,"Unable to start %s module", module->name);  
            EG(current_module) = NULL;  // 清空
            return FAILURE;
        }
        EG(current_module) = NULL;
    }
    return SUCCESS;
}
/* }}} */

然后我們先看一下變量module 的類(lèi)型zend_module_entry

typedef struct _zend_module_entry zend_module_entry;

然后 結(jié)構(gòu) _zend_module_entry 包含了擴(kuò)展的所有的回調(diào)，這里我們主要是要看
int (*module_startup_func)(INIT_FUNC_ARGS);

struct _zend_module_entry {
    ...
    const struct _zend_function_entry *functions;
    int (*module_startup_func)(INIT_FUNC_ARGS);
    int (*module_shutdown_func)(SHUTDOWN_FUNC_ARGS);
    int (*request_startup_func)(INIT_FUNC_ARGS);
    int (*request_shutdown_func)(SHUTDOWN_FUNC_ARGS);
    void (*info_func)(ZEND_MODULE_INFO_FUNC_ARGS);
    ...
};

而當(dāng)你寫(xiě)擴(kuò)展的時(shí)候會(huì)注冊(cè)一個(gè) zend_module_entry,例如bz2 擴(kuò)展的
PHP_MINIT(bz2),

zend_module_entry bz2_module_entry = {
    STANDARD_MODULE_HEADER,
    "bz2",
    bz2_functions,
    PHP_MINIT(bz2),
    PHP_MSHUTDOWN(bz2),
    NULL,
    NULL,
    PHP_MINFO(bz2),
    PHP_BZ2_VERSION,
    STANDARD_MODULE_PROPERTIES
};

這就是調(diào)用你之前寫(xiě)的擴(kuò)展的回調(diào)，ok 整篇文章完畢,有空我會(huì)補(bǔ)一個(gè)流程圖