朱德平的博客

记录学习和生活

0%

PHP源码中的一些宏定义

发表于 分类于 ，

在PHP的源码中经常会看到的一些很常见的宏，或者有些对于才开始接触源码的读者比较难懂的代码。 这些代码在PHP的源码中出现的频 率极高，基本在每个模块都会有他们的身影。本篇文章我们提取中间的一些进行说明。

1. “##” 和 “#”

宏是C/C++是非常强大，使用也很多的一个功能，有时用来实现类似函数内联的效果，或者将复杂的代码进行简单封装，提高可读性或可 移植性等。在PHP的宏定义中经常使用双井号。下面对 “##” 及 “#” 进行详细介绍。

- 双井号（##）

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

1
2
3
4
5
6
7
8
9
#define PHP_FUNCTION ZEND_FUNCTION
#define ZEND_FUNCTION(name) ZEND_NAMED_FUNCTION(ZEND_FN(name))
#define ZEND_FN(name) zif_##name
#define ZEND_NAMED_FUNCTION(name) void name(INTERNAL_FUNCTION_PARAMETERS)
#define INTERNAL_FUNCTION_PARAMETERS int ht, zval *return_value, zval **return_value_ptr, \ zval *this_ptr, int return_value_used TSRMLS_DC

PHP_FUNCTION(count);
// 预处理器处理以后， PHP_FUCNTION(count);就展开为如下代码
void zif_count(int ht, zval *return_value, zval **return_value_ptr, zval *this_ptr, int return_value_used TSRMLS_DC)

宏 ZEND_FN(name) 中有一个 ##，它的作用一如之前所说，是一个连接符，将 zif 和宏的变量 name 的值连接起来。以这种连接的方式为基 础，多次使用这种宏形式，可以将它当作一个代码生成器，这样可以在一定程度上减少代码密度，我们也可以将它理解为一种代码重用的手段，间接地减少不小心所造成的错误。

-单井号（#）

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

1
2
3
4
5
6
#define STR(x) #x

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

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

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

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

1
2
3
4
5
6
#define ALLOC_ZVAL(z)                           \
do {                                            \
    (z) = (zval*)emalloc(sizeof(zval_gc_info)); \
    GC_ZVAL_INIT(z);                            \
} while (0)

这段代码，在宏定义中使用了 do{ }while(0) 语句格式。如果我们搜索整个PHP的源码目录，会发现这样的语句还有很多。在其他使用 C/C++ 编写的程序中也会有很多这种编写宏的代码，多行宏的这种格式已经是一种公认的编写方式了。为什么在宏定义时需要使用 do-while 语句呢？我们知道 do-while 循环语句是先执行循环体再判断条件是否成立，所以说至少会执行一次。当使用 do{ }while(0) 时由于条件肯定为 false，代码也肯定只执行一次，肯定只执行一次的代码为什么要放在 do-while 语句里呢? 这种方式适用于宏定义中存在多语句的情况。如下所示代码:

1
2
3
4
5
6
#define TEST(a, b) a++;b++;

if (expr)
    TEST(a, b);
else
    do_else();

代码进行预处理后，会变成：

1
2
3
4
if (expr)
    a++;b++;
else
    do_else();

这样 if-else 的结构就被破坏了 if 后面有两个语句，这样是无法编译通过的，那为什么非要 do-while 而不是简单的用 {} 括起来呢。这样也能保证if后面只有一个语句。例如上面的例子，在调用宏 TEST 的时候后面加了一个分号，虽然这个分号可有可无，但是出于习惯我们一般都会写上。 那如果是把宏里的代码用 {} 括起来，加上最后的那个分号。还是不能通过编译。所以一般的多表达式宏定义中都采用 do-while(0) 的方式。

了解了 do-while 循环在宏中的作用，再来看 空操作 的定义。由于 PHP 需要考虑到平台的移植性和不同的系统配置，所以需要在某些时候 把一些宏的操作定义为空操作。例如在 sapi\thttpd\thttpd.c 文件中的 VEC_FREE():

1
2
3
4
5
#ifdef SERIALIZE_HEADERS
#   define VEC_FREE() smart_str_free(&vec_str)
#else
#   define VEC_FREE() do {} while (0)
#endif

这里涉及到条件编译，在定义了 SERIALIZE_HEADERS 宏的时候将 VEC_FREE() 定义为如上的内容，而没有定义时，不需要做任何操作，所以后面的宏将 VEC_FREE() 定义为一个空操作，不做任何操作，通常这样来保证一致性，或者充分利用系统提供的功能。有时也会使用如下的方式来定义“空操作”，这里的空操作和上面的还是不一样，例如很常见的 Debug 日志打印宏:

1
2
3
4
5
#ifdef DEBUG
#   define LOG_MSG printf
#else
#   define LOG_MSG(...)
#endif

在编译时如果定义了 DEBUG 则将 LOG_MSG 当做 printf 使用，而不需要调试，正式发布时则将 LOG_MSG() 宏定义为空，由于宏是在预编译阶段进行处理的，所以上面的宏相当于从代码中删除了。

上面提到了两种将宏定义为空的定义方式，看上去一样，实际上只要明白了宏都只是简单的代码替换就知道该如何选择了。

- #line 预处理

#line 838 "Zend/zend_language_scanner.c"

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

- PHP 中的全局变量宏

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

1
2
3
4
5
#ifdef ZTS // 编译时开启了线程安全则使用线程安全库
#   define PG(v) 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运行时的一些全局参数， 这个全局 变量为如下的一个结构体，各字段的意义如字段后的注释：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
struct _php_core_globals {
    zend_bool magic_quotes_gpc; //  是否对输入的GET/POST/Cookie数据使用自动字符串转义。
    zend_bool magic_quotes_runtime; //是否对运行时从外部资源产生的数据使用自动字符串转义
    zend_bool magic_quotes_sybase;  //   是否采用Sybase形式的自动字符串转义

    zend_bool safe_mode;    //  是否启用安全模式

    zend_bool allow_call_time_pass_reference;   //是否强迫在函数调用时按引用传递参数
    zend_bool implicit_flush;   //是否要求PHP输出层在每个输出块之后自动刷新数据

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

    char *safe_mode_include_dir;    //在安全模式下，该组目录和其子目录下的文件被包含时，将跳过UID/GID检查。
    zend_bool safe_mode_gid;    //在安全模式下，默认在访问文件时会做UID比较检查
    zend_bool sql_safe_mode;
    zend_bool enable_dl;    //是否允许使用dl()函数。dl()函数仅在将PHP作为apache模块安装时才有效。

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

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

    char *safe_mode_exec_dir;   //在安全模式下，只有该目录下的可执行程序才允许被执行系统程序的函数执行。

    long memory_limit;  //一个脚本所能够申请到的最大内存字节数(可以使用K和M作为单位)。
    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指令
    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 *upload_tmp_dir;   // 文件上传时存放文件的临时目录
    long upload_max_filesize;   // 允许上传的文件的最大尺寸。

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

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

    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_globals; //  是否将 E, G, P, C, S 变量注册为全局变量。
    zend_bool register_long_arrays; //   是否启用旧式的长式数组(HTTP_*_VARS)。
    zend_bool register_argc_argv;   //  是否声明$argv和$argc全局变量(包含用GET方法的信息)。
    zend_bool auto_globals_jit; //  是否仅在使用到$_SERVER和$_ENV变量时才创建(而不是在脚本一启动时就自动创建)。

    zend_bool y2k_compliance;   //是否强制打开2000年适应(可能在非Y2K适应的浏览器中导致问题)。

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

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

    long xmlrpc_error_number;

    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 always_populate_raw_post_data;    //是否总是生成$HTTP_RAW_POST_DATA变量(原始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 *disable_functions;    //该指令接受一个用逗号分隔的函数名列表，以禁用特定的函数。
    char *disable_classes;  //该指令接受一个用逗号分隔的类名列表，以禁用特定的类。
    zend_bool allow_url_include;    //是否允许include/require远程文件。
    zend_bool exit_on_timeout;  //  超时则退出
#ifdef PHP_WIN32
    zend_bool com_initialized;
#endif
    long max_input_nesting_level;   //最大的嵌套层数
    zend_bool in_user_include;  //是否在用户包含空间

    char *user_ini_filename;    //  用户的ini文件名
    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;
};

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

在 PHP 代码的其他地方也存在很多类似的宏，这些宏和 PG 宏一样，都是为了将线程安全进行封装，同时通过约定的 G 命名来表明这是全局的， 一般都是个缩写，因为这些全局变量在代码的各处都会使用到，这也算是减少了键盘输入。 我们都应该尽可能的懒不是么？

如果你阅读过一些 PHP 扩展话应该也见过类似的宏，这也算是一种代码规范，在编写扩展时全局变量最好也使用这种方式命名和包裹，因为我们不能对用户的 PHP 编译条件做任何假设。