PHP-7.1 原始碼學習：php-cli 啟動流程

xingpingz發表於2019-02-16
PHP原始碼

前言

php cli main 函式

configure & make 預設構建目標為 php-cli，相關程式碼在 sapi/cli 目錄下，php_cli.c 檔案中能夠找到 main（入口）函式，大概流程如下：

  • 命令列引數處理

  • cli_sapi_module 初始化

  • sapi_module->startup

  • do_cli or do_cli_server

  • 清理工作

sapi_module_struct

C 語言系統程式設計常用手法，通過 struct 中宣告 函式指標 型別的欄位來實現類似物件導向中抽象類的概念，在 main/SAPI.h 檔案中可以找到該結構體的定義，這裡只列出部分欄位（下同）：

struct _sapi_module_struct {
    char *name;
    char *pretty_name;

    int (*startup)(struct _sapi_module_struct *sapi_module);
    int (*shutdown)(struct _sapi_module_struct *sapi_module);
    ...
    char *ini_entries;
    const zend_function_entry *additional_functions;
    unsigned int (*input_filter_init)(void);
}

cli_sapi_module

cli_sapi_module 是一個靜態全域性變數，定義在 php_cli.c 中，你可以將它理解成是 sapi_module_struct “類” 的一個 “例項”，結構體中 “掛載” 了 cli 特定的實現函式：

/* {{{ sapi_module_struct cli_sapi_module
 */
static sapi_module_struct cli_sapi_module = {
    "cli",                            /* name */
    "Command Line Interface",        /* pretty name */

    ...
    php_cli_startup,                /* startup */
    php_module_shutdown_wrapper,    /* shutdown */
    ...

    STANDARD_SAPI_MODULE_PROPERTIES
};

do_cli

do_cli 函式定義在 php_cli.c 檔案中，大致流程如下：

  • 根據命令列選項 確定 behavior（直譯器行為）

  • 根據 behavior 執行相應的動作

通過執行 sapi/cli/php –help 可以檢視所有的 php-cli 命令列選項，我們通過幾個簡單的選項來分析直譯器執行流程

PHP_MODE_CLI_DIRECT

該模式下，php-cli 會執行解釋執行通過命令列引數傳遞的 code

case PHP_MODE_CLI_DIRECT:
    cli_register_file_handles();
    if (zend_eval_string_ex(exec_direct, NULL,   
        "Command line code", 1) == FAILURE) {
                exit_status=254;
    }
    break;

追蹤 zend_eval_string_ex 的函式呼叫，定位到 zend_execute_API.c 檔案中 zend_eval_stringl 函式，程式碼邏輯已經很清楚了：先呼叫 zend_compile_string 函式編譯程式碼生成位元組碼 new_op_array，再呼叫 zend_execute 函式執行生成的位元組碼

ZEND_API int zend_eval_stringl(char *str, size_t str_len, zval *retval_ptr,   
char *string_name) {
    ...
    original_compiler_options = CG(compiler_options);
    CG(compiler_options) = ZEND_COMPILE_DEFAULT_FOR_EVAL;
    new_op_array = zend_compile_string(&pv, string_name);
    CG(compiler_options) = original_compiler_options;

    if (new_op_array) {
        zend_try {
            ZVAL_UNDEF(&local_retval);
            zend_execute(new_op_array, &local_retval);
        } zend_catch {
            destroy_op_array(new_op_array);
            efree_size(new_op_array, sizeof(zend_op_array));
            zend_bailout();
        } zend_end_try();
        ...
    } else {
        retval = FAILURE;
    }
    zval_dtor(&pv);
    return retval;
}

zend_compile_string 屬於語法分析內容，參考 PHP-7.1 原始碼學習: 語法分析，這裡做個簡要介紹

compile_string

通過搜尋原始碼可以發現 zend_compile_string 最終呼叫 compile_string

zend_op_array *compile_string(zval *source_string, char *filename)
{
    zend_lex_state original_lex_state;
    zend_op_array *op_array = NULL;
    zval tmp;

    if (Z_STRLEN_P(source_string)==0) {
        return NULL;
    }

    ZVAL_DUP(&tmp, source_string);
    convert_to_string(&tmp);
    source_string = &tmp;

    zend_save_lexical_state(&original_lex_state);
    if (zend_prepare_string_for_scanning(source_string, filename) == SUCCESS) {
        BEGIN(ST_IN_SCRIPTING);
        op_array = zend_compile(ZEND_EVAL_CODE);
    }

    zend_restore_lexical_state(&original_lex_state);
    zval_dtor(&tmp);

    return op_array;
}

總結

相關文章