代码改变世界

php内核分析（四）－do_cli

2016-11-25 11:47  轩脉刃  阅读(1470)  评论(0)  编辑  收藏  举报

这里阅读的php版本为PHP-7.1.0 RC3，阅读代码的平台为linux

＃ main

把剩下的代码增加了下注释全部贴出来了（这个是简化后的main函数，去掉了一些无关紧要的代码段）：

int main(int argc, char *argv[])
{
    ...
    sapi_module_struct *sapi_module = &cli_sapi_module;

    argv = save_ps_args(argc, argv); //这里获取一次当前执行进程的参数，环境变量等。为的是对特定平台，修正下argv变量以供后续使用。

    cli_sapi_module.additional_functions = additional_functions; // cli模式特有的函数

     ...


#ifdef ZTS
    tsrm_startup(1, 1, 0, NULL);
    (void)ts_resource(0);
    ZEND_TSRMLS_CACHE_UPDATE();
#endif

    zend_signal_startup();  // 设置信号，把一些需要反应的信号位设置为0

    // 获取参数，做一些对应的初始化行为，或者一些简单的操作，比如help
    while ((c = php_getopt(argc, argv, OPTIONS, &php_optarg, &php_optind, 0, 2))!=-1) {
        switch (c) { // 这里的c是代表返回的字符串的ascii码值
            case 'c':
                ...
            case 'n':
                ini_ignore = 1; // 不使用ini文件，通过代码或者其他指定ini值
                break;
            case 'd': { // 配置ini的key，val值在命令行中，下面的行为都是修改ini_entries这个变量
                ...
            }
            case 'h': /* help & quit */
            case '?':
                php_cli_usage(argv[0]);
                goto out;
            case 'i': case 'v': case 'm':
                sapi_module = &cli_sapi_module;
                goto exit_loop;
            case 'e': /* enable extended info output */
                use_extended_info = 1;
                break;
        }
    }
exit_loop:

    sapi_module->ini_defaults = sapi_cli_ini_defaults; // 设置初始化的ini值
    sapi_module->php_ini_path_override = ini_path_override; //设置重写后的ini_path地址，如果是php -c的话，这个就为非null
    sapi_module->phpinfo_as_text = 1; // 打开打印phpinfo的开关，需要的时候可以把phpinfo打印出来
    sapi_module->php_ini_ignore_cwd = 1; // 不在当前路径寻找php.ini
    sapi_startup(sapi_module); // sapi初始化行为，比如初始化全局变量SG
    sapi_started = 1; // 标记，表示已经调用了startup，关闭的时候需要调用shundown
    ...

    // 开始调用sapi的startup方法，对cli模式，实际上是调用php_cli_startup方法
    if (sapi_module->startup(sapi_module) == FAILURE) {
        exit_status = 1;
        goto out;
    }
    module_started = 1; // 标记位，标记已经调用了module的startup方法

    ...

    zend_first_try {
            exit_status = do_cli(argc, argv);  // 这个是实际上调用的内容
    } zend_end_try();
out:  // 这个代码段已经是要退出了
    if (ini_path_override) {
        free(ini_path_override);
    }
    if (ini_entries) {
        free(ini_entries);
    }
    if (module_started) {
        php_module_shutdown();
    }
    if (sapi_started) {
        sapi_shutdown();
    }
#ifdef ZTS
    tsrm_shutdown();
#endif

    cleanup_ps_args(argv);
    exit(exit_status);
}

其实看伪码很简单：

tsrm_startup(1, 1, 0, NULL);  // TSM启动
zend_signal_startup();  // 信号设置
sapi_startup(sapi_module);  // SAPI启动
sapi_module->startup(sapi_module); // 当前模块的startup
do_cli(argc, argv); // 做实际的行为
php_module_shutdown();  // 当前模块的shutdown
sapi_shutdown(); // SAPI关闭
tsrm_shutdown(); // TSM关闭

好了，其实看了一圈，里面最重的函数是do_cli了。

php参数

do_cli里面你会看到根据参数的不同，有很多分支，这里你就需要了解这些参数都是什么用的。

参数
作用
实例


do_cli

我们把do_cli函数的整个函数去掉多余代码，仅保留关键代码如下：

static int do_cli(int argc, char **argv)
{
    ...

    zend_try {

        // 这里处理了 i-输出phpinfo内容/ v-输出php版本 / m-输出扩展信息
        while ((c = php_getopt(argc, argv, OPTIONS, &php_optarg, &php_optind, 0, 2)) != -1) {
            switch (c) {

            case 'i': // 输出phpinfo内容
                ...
                php_print_info(0xFFFFFFFF);
                ...
                goto out;

            case 'v': // 输出php版本信息
                ...
                    get_zend_version()
                ...
                goto out;

            case 'm': // 列出所有模块
                ...
                print_extensions();
                ...
                goto out;

            default:
                break;
            }
        }

        ...

        // 下面的代码做了几个事情：
        // 1 根据参数设置了behavior参数
        // 2 有执行文件的就将文件存在script_file
        while ((c = php_getopt(argc, argv, OPTIONS, &php_optarg, &php_optind, 0, 2)) != -1) {
            switch (c) {

            case 'a': // php的交互模式
                ...
                interactive=1;
                ...
                break;

            case 'C': // 不要把cwd目录变成脚本所在的目录。这个默认就是cwd是当前执行路径，所以这里什么都不做。
                break;

            case 'F': // php -F <FILE> 进入交互模式，每执行一行就执行一次<FILE>文件
                ...
                behavior=PHP_MODE_PROCESS_STDIN;
                script_file = php_optarg;
                break;

            case 'f': // php -f <FILE> 解析并执行文件
                ...
                script_file = php_optarg;
                break;

            case 'l':  // 检查文件的语法是否有错误
                ...
                behavior=PHP_MODE_LINT;
                break;

            case 'q': // 安静模式，默认也是安静模式
                break;

            case 'r': // 从命令行直接执行脚本
                ...
                behavior=PHP_MODE_CLI_DIRECT;
                exec_direct=php_optarg;
                break;

            case 'R': // 每行输入的时候执行一次code脚本，比如 php -R 'echo 12;'
                ...
                behavior=PHP_MODE_PROCESS_STDIN;
                exec_run=php_optarg;
                break;

            case 'B': // 在每次输入开始之前执行一次code脚本
                ...
                behavior=PHP_MODE_PROCESS_STDIN;
                exec_begin=php_optarg;
                break;

            case 'E': // 在每次输入结束之后执行一次code脚本， 上面的 RBE可以参考一个例子：find conf.d | php -B '$l=0;' -R '$l += count(@file($argn));' -E 'echo "Total Lines: $l\n";'
                ...
                behavior=PHP_MODE_PROCESS_STDIN;
                exec_end=php_optarg;
                break;

            case 's': // 使用html高亮方式显示代码，这个或许在一些代码显示的时候需要用到
                ...
                behavior=PHP_MODE_HIGHLIGHT;
                break;

            case 'w':  // php <file> -w 能把<file>中的评论和多余的空格去掉
                ...
                behavior=PHP_MODE_STRIP;
                break;

            case 'z': // 加载外部扩展
                zend_load_extension(php_optarg);
                break;
            case 'H': // 隐藏所有参数
                hide_argv = 1;
                break;
            case 10: // 显示function定义
                behavior=PHP_MODE_REFLECTION_FUNCTION;
                reflection_what = php_optarg;
                break;
            case 11: // 显示class定义
                behavior=PHP_MODE_REFLECTION_CLASS;
                reflection_what = php_optarg;
                break;
            case 12: // 显示扩展定义，注意这里是php扩展
                behavior=PHP_MODE_REFLECTION_EXTENSION;
                reflection_what = php_optarg;
                break;
            case 13: // 显示zend扩展定义, 比如xdebug
                behavior=PHP_MODE_REFLECTION_ZEND_EXTENSION;
                reflection_what = php_optarg;
                break;
            case 14: // 显示扩展的对应配置
                behavior=PHP_MODE_REFLECTION_EXT_INFO;
                reflection_what = php_optarg;
                break;
            case 15: // 显示ini配置
                behavior = PHP_MODE_SHOW_INI_CONFIG;
                break;
            default:
                break;
            }
        }

        ...

        // 初始化request之后，执行了request_startup
        if (php_request_startup()==FAILURE) {
            ...
            goto err;
        }
        ...

        zend_is_auto_global_str(ZEND_STRL("_SERVER"));

        // 根据不同的行为做不同的具体操作，这个是核心方法
        switch (behavior) {
        case PHP_MODE_STANDARD:  // 标准，就是执行一个脚本文件
            ...
                php_execute_script(&file_handle);
            ...
            break;
        case PHP_MODE_LINT: // 只检查文件有没有语法错误
            exit_status = php_lint_script(&file_handle);
            ...
            break;
        case PHP_MODE_STRIP:
            ...
                zend_strip();
            ...
            break;
        case PHP_MODE_HIGHLIGHT:
            ...
            php_get_highlight_struct(&syntax_highlighter_ini);
            zend_highlight(&syntax_highlighter_ini);
            goto out;
            break;
        case PHP_MODE_CLI_DIRECT:
            ...
            if (zend_eval_string_ex(exec_direct, NULL, "Command line code", 1) == FAILURE) {
                exit_status=254;
            }
            break;

        case PHP_MODE_PROCESS_STDIN:
                ...
                zend_eval_string_ex(exec_end, NULL, "Command line end code", 1)
                ...
                break;
        case PHP_MODE_REFLECTION_FUNCTION:
        case PHP_MODE_REFLECTION_CLASS:
        case PHP_MODE_REFLECTION_EXTENSION:
        case PHP_MODE_REFLECTION_ZEND_EXTENSION:
            ...
            ZVAL_STRING(&arg, reflection_what);
            object_init_ex(&ref, pce);
            ...
            zend_call_method_with_1_params(&ref, pce, &pce->constructor, "__construct", NULL, &arg);
            ...
            break;
        case PHP_MODE_REFLECTION_EXT_INFO:
            ...
            if ((module = zend_hash_str_find_ptr(&module_registry, lcname, len)) == NULL) {
                ...
                    display_ini_entries(NULL);
                ...
            } 
            ...
            break;
        case PHP_MODE_SHOW_INI_CONFIG:
            ...
            break;
        }
    } zend_end_try();

out:
    ...
err:
    ...
}

整个200行的代码就很好理解了，整个是包在一个zend_try...zend_catch中的。做了几步：

  • 处理-i, -m, -v参数
  • 对其他的参数设置behavior，script_file等变量
  • 根据behavior做不同的行为

回到我们的初步计划，我们想要了解的事：

我们的根据-r的参数配置寻找。

它实际上时调用了

zend_eval_string_ex(exec_direct, NULL, "Command line code", 1)

这里的exec_direct是 echo 12字符串