PHP源码解析笔记1-源码中的常用代码

基于PHP源码分析的git仓库:深入理解PHP内核

常用代码

双井号(##)

在C语言的宏中，”##”被称为 连接符（concatenator），它是一种预处理运算符， 用来把两个语言符号(Token)组合成单个语言符号。 这里的语言符号不一定是宏的变量。并且双井号不能作为第一个或最后一个元素存在。示例如下：

#define ZEND_FN(name) zif_##name

宏ZEND_FN(name)中有一个”##”，它的作用一如之前所说，是一个连接符，将zif和宏的变量name的值连接起来。

总结：以这种连接的方式以基础，多次使用这种宏形式，可以将它当作一个代码生成器，这样可以在一定程度上减少代码密度， 我们也可以将它理解为一种代码重用的手段，间接地减少不小心所造成的错误。

单井号(#)

“#”是一种预处理运算符，它的功能是将其后面的宏参数进行 字符串化操作 ， 简单说就是在对它所引用的宏变量通过替换后在其左右各加上一个双引号， 用比较官方的话说就是将语言符号(Token)转化为字符串。

#define STR(x) #x

int main(int argc char** argv)
{
    printf("%s\n", STR(It's a long string)); // 输出 It's a long str
    return 0;
}

如前文所说，It’s a long string 是宏STR的参数，在展开后被包裹成一个字符串了。所以printf函数能直接输出这个字符串， 当然这个使用场景并不是很适合，因为这种用法并没有实际的意义，实际中在宏中可能会包裹其他的逻辑，比如对字符串进行封装等等。

关于宏定义中的do-while循环

PHP源码中大量使用了宏操作，比如PHP5.3新增加的垃圾收集机制中的一段代码：

#define ALLOC_ZVAL(z)                                   
do {                                                
    (z) = (zval*)emalloc(sizeof(zval_gc_info));     
    GC_ZVAL_INIT(z);                                
} while (0)

只执行一次的代码为什么要放在do-while语句里呢? 这种方式适用于宏定义中存在多语句的情况。

line 预处理

#line 838 "Zend/zend_language_scanner.c"

line预处理用于改变当前的行号（LINE）和文件名（FILE）。 如上所示代码，将当前的行号改变为838，文件名Zend/zend_language_scanner.c 它的作用体现在编译器的编写中，我们知道编译器对C 源码编译过程中会产生一些中间文件，通过这条指令， 可以保证文件名是固定的，不会被这些中间文件代替，有利于进行调试分析。

PHP中的全局变量宏(基于PHP7+)

在PHP代码中经常能看到一些类似PG()， EG()之类的函数，他们都是PHP中定义的宏，这系列宏主要的作用是解决线程安全所写的全局变量包裹宏， 如$PHP_SRC/main/php_globals.h文件中就包含了很多这类的宏。例如PG这个PHP的核心全局变量的宏。 如下所示代码为其定义。

#ifdef ZTS
# define PG(v) ZEND_TSRMG(core_globals_id, php_core_globals *, v)
extern PHPAPI int core_globals_id;
#else
# define PG(v) (core_globals.v)
extern ZEND_API struct _php_core_globals core_globals;
#endif

如上，ZTS是线程安全的标记，这个在以后的章节会详细介绍，这里就不再说明。下面简单说说，PHP运行时的一些全局参数， 这个全局变量为如下的一个结构体，各字段的意义如字段后的注释：

struct _php_core_globals {
    zend_bool implicit_flush;//是否要求PHP输出层在每个输出块之后自动刷新数据

    zend_long output_buffering;//输出缓冲区大小(字节)

    zend_bool enable_dl;  //是否允许使用dl()函数。dl()函数仅在将PHP作为apache模块安装时才有效。

    char *output_handler;//将所有脚本的输出重定向到一个输出处理函数。

    char *unserialize_callback_func; // 如果解序列化处理器需要实例化一个未定义的类，这里指定的回调函数将以该未定义类的名字作为参数被unserialize()调用，
    zend_long serialize_precision;//将浮点型和双精度型数据序列化存储时的精度(有效位数)。

    zend_long memory_limit;//一个脚本所能够申请到的最大内存字节数(可以使用K和M作为单位)。
    zend_long max_input_time; // 每个脚本解析输入数据(POST, GET, upload)的最大允许时间(秒)。

    zend_bool track_errors;//是否在变量$php_errormsg中保存最近一个错误或警告消息。
    zend_bool display_errors;//是否将错误信息作为输出的一部分显示。
    zend_bool display_startup_errors; //是否显示PHP启动时的错误。
    zend_bool log_errors;// 是否在日志文件里记录错误，具体在哪里记录取决于error_log指令
    zend_long      log_errors_max_len;//设置错误日志中附加的与错误信息相关联的错误源的最大长度。
    zend_bool ignore_repeated_errors; //   记录错误日志时是否忽略重复的错误信息。
    zend_bool ignore_repeated_source; //是否在忽略重复的错误信息时忽略重复的错误源。
    zend_bool report_memleaks;//是否报告内存泄漏。
    char *error_log;//将错误日志记录到哪个文件中。

    char *doc_root;//PHP的”根目录”。
    char *user_dir; //告诉php在使用 /~username 打开脚本时到哪个目录下去找
    char *include_path;//指定一组目录用于require(), include(), fopen_with_path()函数寻找文件。
    char *open_basedir;// 将PHP允许操作的所有文件(包括文件自身)都限制在此组目录列表下。
    char *extension_dir; //存放扩展库(模块)的目录，也就是PHP用来寻找动态扩展模块的目录。
    char *php_binary;//php二进制程序位置?
    char *sys_temp_dir;//系统临时文件夹?

    char *upload_tmp_dir;// 文件上传时存放文件的临时目录
    zend_long upload_max_filesize;// 允许上传的文件的最大尺寸。

    char *error_append_string;// 用于错误信息后输出的字符串
    char *error_prepend_string;//用于错误信息前输出的字符串

    char *auto_prepend_file;//指定在主文件之前自动解析的文件名。
    char *auto_append_file;//指定在主文件之后自动解析的文件名。

    char *input_encoding;//输入编码
    char *internal_encoding;//内部编码
    char *output_encoding;//输出编码

    arg_separators arg_separator; //PHP所产生的URL中用来分隔参数的分隔符。

    char *variables_order;// PHP注册 Environment, GET, POST, Cookie, Server 变量的顺序。

    HashTable rfc1867_protected_variables;//  RFC1867保护的变量名，在main/rfc1867.c文件中有用到此变量

    short connection_status; //  连接状态，有三个状态，正常，中断，超时
    short ignore_user_abort; //  是否即使在用户中止请求后也坚持完成整个请求。

    unsigned char header_is_being_sent;//  是否头信息正在发送

    zend_llist tick_functions; //  仅在main目录下的php_ticks.c文件中有用到，此处定义的函数在register_tick_function等函数中有用到。

    zval http_globals[6];// 存放GET、POST、SERVER等信息

    zend_bool expose_php; //  是否展示php的信息

    zend_bool register_argc_argv;//  是否声明$argv和$argc全局变量(包含用GET方法的信息)。
    zend_bool auto_globals_jit;//  是否仅在使用到$_SERVER和$_ENV变量时才创建(而不是在脚本一启动时就自动创建)。

    char *docref_root;// 如果打开了html_errors指令，PHP将会在出错信息上显示超连接
    char *docref_ext; //指定文件的扩展名(必须含有’.')。

    zend_bool html_errors;//是否在出错信息中使用HTML标记。
    zend_bool xmlrpc_errors;//是否在出错信息中使用xmlrpc标记。?

    zend_long xmlrpc_error_number;//是否在出错信息中xmlrpc标记的编号?

    zend_bool activated_auto_globals[8];//激活自动全局变量

    zend_bool modules_activated;//  是否已经激活模块
    zend_bool file_uploads;//是否允许HTTP文件上传。
    zend_bool during_request_startup; //是否在请求初始化过程中
    zend_bool allow_url_fopen;//是否允许打开远程文件
    zend_bool enable_post_data_reading;//是否能获取post数据
    zend_bool report_zend_debug; //  是否打开zend debug，仅在main/main.c文件中有使用。

    int last_error_type;//  最后的错误类型
    char *last_error_message;//  最后的错误信息
    char *last_error_file; //  最后的错误文件
    int  last_error_lineno;//  最后的错误行

    char *php_sys_temp_dir;//PHP对应的系统临时文件目录

    char *disable_functions; //该指令接受一个用逗号分隔的函数名列表，以禁用特定的函数。
    char *disable_classes;//该指令接受一个用逗号分隔的类名列表，以禁用特定的类。
    zend_bool allow_url_include;//是否允许include/require远程文件。
#ifdef PHP_WIN32
    zend_bool com_initialized;
#endif
    zend_long max_input_nesting_level;//最大的嵌套层数
    zend_long max_input_vars;//最大的输入变量数？
    zend_bool in_user_include; //是否在用户包含空间

    char *user_ini_filename;//  用户的ini文件名
    zend_long user_ini_cache_ttl;//  ini缓存过期限制

    char *request_order;//优先级比variables_order高，在request变量生成时用到，个人觉得是历史遗留问题

    zend_bool mail_x_header;//  仅在ext/standard/mail.c文件中使用，
    char *mail_log;//邮件日志

    zend_bool in_error_log;//

#ifdef PHP_WIN32
    zend_bool windows_show_crt_warning;
#endif
};

上面的字段很大一部分是与php.ini文件中的配置项对应的。 在PHP启动并读取php.ini文件时就会对这些字段进行赋值， 而用户空间的ini_get()及ini_set()函数操作的一些配置也是对这个全局变量进行操作的。

附：ticks的使用示例

<?php
/**
 * Created by sunny.
 * User: sunny
 * Have a nice day!
 * Date: 2017/2/15
 * Time: 14:30
 */
function profile()
{
    echo "profile function is called\n";
}

// Set up a tick handler
register_tick_function("profile");

// Initialize the function before the declare block
profile();

// Run a block of code, throw a tick every 2nd statement
declare(ticks=3) {
    for ($x = 0; $x < 10; ++$x) {
        echo "hello world\n";
    }
}

ticks主要用来按照规定的输出次数之后再次执行tick函数，示例输出如下：