www.adminn.cn
站长正能量分享网!

php中动态修改ini配置

AD:阿里云服务器企业会员更优惠 腾讯云香港,韩国免备案服务器1.8折优惠

上一篇文章我们阐述php.ini配置原理,本文我们来讲动态修改php配置,需要的朋友可以参考下

1,运行时改变配置

在前一篇中曾经谈到,ini_set函数可以在php执行的过程中,动态修改php的部分配置。注意,仅仅是部分,并非所有的配置都可以动态修改。关于ini配置的可修改性,参见:http://php.net/manual/zh/configuration.changes.modes.php

我们直接进入ini_set的实现,函数虽然有点长,但是逻辑很清晰:

  1. PHP_FUNCTION(ini_set
  2.     char *varname, *new_value; 
  3.     int varname_len, new_value_len; 
  4.     char *old_value; 
  5.     if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "ss", &varname, &varname_len, &new_value, &new_value_len) == FAILURE) { 
  6.         return
  7.     } 
  8.  
  9.     // 去EG(ini_directives)中获取配置的值 
  10.     old_value = zend_ini_string(varname, varname_len + 1, 0); 
  11.  
  12.     /* copy to return here, because alter might free it! */ 
  13.     if (old_value) { 
  14.         RETVAL_STRING(old_value, 1); 
  15.     } else { 
  16.         RETVAL_FALSE; 
  17.     } 
  18.  
  19.     // 如果开启了安全模式,那么如下这些ini配置可能涉及文件操作,需要要辅助检查uid 
  20. #define _CHECK_PATH(var, var_len, ini) php_ini_check_path(var, var_len, ini, sizeof(ini)) 
  21.     /* safe_mode & basedir check */ 
  22.     if (PG(safe_mode) || PG(open_basedir)) { 
  23.         if (_CHECK_PATH(varname, varname_len, "error_log") || 
  24.             _CHECK_PATH(varname, varname_len, "java.class.path") || 
  25.             _CHECK_PATH(varname, varname_len, "java.home") || 
  26.             _CHECK_PATH(varname, varname_len, "mail.log") || 
  27.             _CHECK_PATH(varname, varname_len, "java.library.path") || 
  28.             _CHECK_PATH(varname, varname_len, "vpopmail.directory")) { 
  29.             if (PG(safe_mode) && (!php_checkuid(new_value, NULL, CHECKUID_CHECK_FILE_AND_DIR))) { 
  30.                 zval_dtor(return_value); 
  31.                 RETURN_FALSE; 
  32.             } 
  33.             if (php_check_open_basedir(new_value TSRMLS_CC)) { 
  34.                 zval_dtor(return_value); 
  35.                 RETURN_FALSE; 
  36.             } 
  37.         } 
  38.     } 
  39.  
  40.     // 在安全模式下,如下这些ini受到保护,不会被动态修改 
  41.     if (PG(safe_mode)) { 
  42.         if (!strncmp("max_execution_time", varname, sizeof("max_execution_time")) || 
  43.             !strncmp("memory_limit", varname, sizeof("memory_limit")) || 
  44.             !strncmp("child_terminate", varname, sizeof("child_terminate")) 
  45.         ) { 
  46.             zval_dtor(return_value); 
  47.             RETURN_FALSE; 
  48.         } 
  49.     } 
  50.  
  51.     // 调用zend_alter_ini_entry_ex去动态修改ini配置 
  52.     if (zend_alter_ini_entry_ex(varname, varname_len + 1, new_value, new_value_len, PHP_INI_USER, PHP_INI_STAGE_RUNTIME, 0 TSRMLS_CC) == FAILURE) { 
  53.         zval_dtor(return_value); 
  54.         RETURN_FALSE; 
  55.     } 

可以看到,除了一些必要的验证工作,主要就是调用zend_alter_ini_entry_ex。

我们继续跟进到zend_alter_ini_entry_ex函数中:

  1. ZEND_API int zend_alter_ini_entry_ex(char *name, uint name_length, char *new_value, uint new_value_length, int modify_type, int stage, int force_change TSRMLS_DC) /* {{{ */ 
  2.     zend_ini_entry *ini_entry; 
  3.     char *duplicate; 
  4.     zend_bool modifiable; 
  5.     zend_bool modified; 
  6.     // 找出EG(ini_directives)中对应的ini_entry 
  7.     if (zend_hash_find(EG(ini_directives), name, name_length, (void **) &ini_entry) == FAILURE) { 
  8.         return FAILURE; 
  9.     } 
  10.  
  11.     // 是否被修改以及可修改性 
  12.     modifiable = ini_entry->modifiable; 
  13.     modified = ini_entry->modified; 
  14.  
  15.     if (stage == ZEND_INI_STAGE_ACTIVATE && modify_type == ZEND_INI_SYSTEM) { 
  16.         ini_entry->modifiable = ZEND_INI_SYSTEM; 
  17.     } 
  18.  
  19.     // 是否强制修改 
  20.     if (!force_change) { 
  21.         if (!(ini_entry->modifiable & modify_type)) { 
  22.             return FAILURE; 
  23.         } 
  24.     } 
  25.  
  26.     // EG(modified_ini_directives)用于存放被修改过的ini_entry 
  27.     // 主要用做恢复 
  28.     if (!EG(modified_ini_directives)) { 
  29.         ALLOC_HASHTABLE(EG(modified_ini_directives)); 
  30.         zend_hash_init(EG(modified_ini_directives), 8, NULL, NULL, 0); 
  31.     } 
  32.     
  33.     // 将ini_entry中的值,值的长度,可修改范围,保留到orig_xxx中去 
  34.     // 以便在请求结束的时候,可以对ini_entry做恢复 
  35.     if (!modified) { 
  36.         ini_entry->orig_value = ini_entry->value; 
  37.         ini_entry->orig_value_length = ini_entry->value_length; 
  38.         ini_entry->orig_modifiable = modifiable; 
  39.         ini_entry->modified = 1; 
  40.         zend_hash_add(EG(modified_ini_directives), name, name_length, &ini_entry, sizeof(zend_ini_entry*), NULL); 
  41.     } 
  42.  
  43.     duplicate = estrndup(new_value, new_value_length); 
  44.  
  45.     // 调用modify来更新XXX_G中对应的ini配置 
  46.     if (!ini_entry->on_modify || ini_entry->on_modify(ini_entry, duplicate, new_value_length, ini_entry->mh_arg1, ini_entry->mh_arg2, ini_entry->mh_arg3, stage TSRMLS_CC) == SUCCESS) { 
  47.         // 同上面,如果多次修改,则需要释放前一次修改的值 
  48.         if (modified && ini_entry->orig_value != ini_entry->value) { 
  49.             efree(ini_entry->value); 
  50.         } 
  51.         ini_entry->value = duplicate; 
  52.         ini_entry->value_length = new_value_length; 
  53.     } else { 
  54.         efree(duplicate); 
  55.         return FAILURE; 
  56.     } //www.adminn.cn 
  57.  
  58.     return SUCCESS; 

有3处逻辑需要我们仔细体会:

1)ini_entry中的modified字段用来表示该配置是否被动态修改过。一旦该ini配置发生修改,modified就会被置为1。上述代码中有一段很关键:

  1. // 如果多次调用ini_set,则orig_value等始终保持最原始的值 
  2. if (!modified) { 
  3.     ini_entry->orig_value = ini_entry->value; 
  4.     ini_entry->orig_value_length = ini_entry->value_length; 
  5.     ini_entry->orig_modifiable = modifiable; 
  6.     ini_entry->modified = 1; 
  7.     zend_hash_add(EG(modified_ini_directives), name, name_length, &ini_entry, sizeof(zend_ini_entry*), NULL); 

这段代码表示,不管我们先后在php代码中调用几次ini_set,只有第一次ini_set时才会进入这段逻辑,设置好orig_value。从第二次调用ini_set开始,便不会再次执行这段分支,因为此时的modified已经被置为1了。因此,ini_entry->orig_value始终保存的是第一次修改之前的配置值(即最原始的配置)。

2)为了能使ini_set修改的配置立即生效,需要on_modify回调函数。

如前一篇文中所述,调用on_modify是为了能够更新模块的全局变量。再次回忆下,首先,模块全局变量中的配置已经不是字符串类型了,该用bool用bool、该用int用int。其次,每一个ini_entry中都存储了该模块全局变量的地址以及对应的偏移量,使得on_modify可以很迅速的进行内存修改。此外不要忘记,on_modify调用完了之后,仍需进一步更新ini_entry->value,这样EG(ini_directives)中的配置值就是最新的了。

3)这里出现了一张新的hash表,EG(modified_ini_directives)。

EG(modified_ini_directives)只用于存放被动态修改过的ini配置,如果一个ini配置被动态修改过,那么它既存在于EG(ini_directives)中,又存在于EG(modified_ini_directives)中。既然每一个ini_entry都有modified字段做标记,那岂不是可以遍历EG(ini_directives)来获得所有被修改过的配置呢?

答案是肯定的。个人觉得,这里的EG(modified_ini_directives)主要还是为了提升性能,酱直接遍历EG(modified_ini_directives)就足够了。此外,把EG(modified_ini_directives)的初始化推迟到zend_alter_ini_entry_ex中,也可以看出php在细节上的性能优化点。

2,恢复配置

ini_set的作用时间和php.ini文件的作用时间是不一样的,一旦请求执行结束,则ini_set会失效。此外,当我们代码中调用了ini_restore函数,则之前通过ini_set设置的配置也会失效。

每一个php请求执行完毕之后,会触发php_request_shutdown,它和php_request_startup是两个相对应过程。如果php是挂接在apache/nginx下,则每处理完一个http请求,就会调用php_request_shutdown;如果php以CLI模式来运行,则脚本执行完毕之后,也会调用php_request_shutdown。

在php_request_shutdown中,我们可以看到针对ini的恢复处理:

/* 7. Shutdown scanner/executor/compiler and restore ini entries */

zend_deactivate(TSRMLS_C);

进入zend_deactivate,可以进一步看到调用了zend_ini_deactivate函数,由zend_ini_deactivate来负责将php的配置进行恢复。

代码如下:

  1. zend_try { 
  2.     zend_ini_deactivate(TSRMLS_C); 
  3. } zend_end_try(); 

具体来看看zend_ini_deactivate的实现:

  1. ZEND_API int zend_ini_deactivate(TSRMLS_D) /* {{{ */ 
  2.     if (EG(modified_ini_directives)) { 
  3.         // 遍历EG(modified_ini_directives)中这张表 
  4.         // 对每一个ini_entry调用zend_restore_ini_entry_wrapper 
  5.         zend_hash_apply(EG(modified_ini_directives), (apply_func_t) zend_restore_ini_entry_wrapper TSRMLS_CC); 
  6.         
  7.         // 回收操作 
  8.         zend_hash_destroy(EG(modified_ini_directives)); 
  9.         FREE_HASHTABLE(EG(modified_ini_directives)); 
  10.         EG(modified_ini_directives) = NULL; 
  11.     } 
  12.     return SUCCESS; 

从zend_hash_apply来看,真正恢复ini的任务最终落地到了zend_restore_ini_entry_wrapper回调函数。

代码如下:

  1. static int zend_restore_ini_entry_wrapper(zend_ini_entry **ini_entry TSRMLS_DC) 
  2.     // zend_restore_ini_entry_wrapper就是zend_restore_ini_entry_cb的封装 
  3.     zend_restore_ini_entry_cb(*ini_entry, ZEND_INI_STAGE_DEACTIVATE TSRMLS_CC); 
  4.     return 1; 
  5. static int zend_restore_ini_entry_cb(zend_ini_entry *ini_entry, int stage TSRMLS_DC) 
  6.     int result = FAILURE; 
  7.  
  8.     // 只看修改过的ini项 
  9.     if (ini_entry->modified) { 
  10.         if (ini_entry->on_modify) { 
  11.             // 使用orig_value,对XXX_G内的相关字段进行重新设置 
  12.             zend_try { 
  13.                 result = ini_entry->on_modify(ini_entry, ini_entry->orig_value, ini_entry->orig_value_length, ini_entry->mh_arg1, ini_entry->mh_arg2, ini_entry->mh_arg3, stage TSRMLS_CC); 
  14.             } zend_end_try(); 
  15.         } 
  16.         if (stage == ZEND_INI_STAGE_RUNTIME && result == FAILURE) { 
  17.             /* runtime failure is OK */ 
  18.             return 1; 
  19.         } 
  20.         if (ini_entry->value != ini_entry->orig_value) { 
  21.             efree(ini_entry->value); 
  22.         } 
  23.         
  24.         // ini_entry本身恢复到最原始的值 
  25.         ini_entry->value = ini_entry->orig_value; 
  26.         ini_entry->value_length = ini_entry->orig_value_length; 
  27.         ini_entry->modifiable = ini_entry->orig_modifiable; 
  28.         ini_entry->modified = 0; 
  29.         ini_entry->orig_value = NULL; 
  30.         ini_entry->orig_value_length = 0; 
  31.         ini_entry->orig_modifiable = 0; 
  32.     } 
  33.     return 0; 

逻辑都蛮清晰的,相信读者可以看明白。总结一下关于ini配置的恢复流程:

php_request_shutdown—>zend_deactivate—>zend_ini_deactivate—>zend_restore_ini_entry_wrapper—>zend_restore_ini_entry_cb

3,配置的销毁

在sapi生命周期结束的时候,比如apache关闭,cli程序执行完毕等等。一旦进入到这个阶段,之前所说的configuration_hash,EG(ini_directives)等都需要被销毁,其用到的内存空间需要被释放。

1,php会依次结束所有的模块,在每个模块的PHP_MSHUTDOWN_FUNCTION中调用UNREGISTER_INI_ENTRIES。UNREGISTER_INI_ENTRIES和REGISTER_INI_ENTRIES对应,但是UNREGISTER_INI_ENTRIES并不负责模块全局空间的释放,XXX_globals这块内存放在静态数据区上,无需人为回收。

UNREGISTER_INI_ENTRIES主要做的事情,是将某个模块的ini_entry配置从EG(ini_directives)表中删除。删除之后,ini_entry本身的空间会被回收,但是ini_entry->value不一定会被回收。

当所有模块的PHP_MSHUTDOWN_FUNCTION都调用UNREGISTER_INI_ENTRIES一遍之后,EG(ini_directives)中只剩下了Core模块的ini配置。此时,就需要手动调用UNREGISTER_INI_ENTRIES,来完成对Core模块配置的删除工作。代码如下:

  1. void php_module_shutdown(TSRMLS_D) 
  2.     … 
  3.     
  4.     // zend_shutdown会依次关闭除了Core之外的所有php模块 
  5.     // 关闭时会调用各个模块的PHP_MSHUTDOWN_FUNCTION 
  6.     zend_shutdown(TSRMLS_C); 
  7.     
  8.     … 
  9.     // 至此,EG(ini_directives)中只剩下了Core模块的配置 
  10.     // 这里手动清理一下 
  11.     UNREGISTER_INI_ENTRIES(); 
  12.     
  13.     // 回收configuration_hash 
  14.     php_shutdown_config(); 
  15.  
  16.     // 回收EG(ini_directives) 
  17.     zend_ini_shutdown(TSRMLS_C); 
  18.  
  19.     … 

当手动调用UNREGISTER_INI_ENTRIES完成之后,EG(ini_directives)已经不包含任何的元素,理论上讲,此时的EG(ini_directives)是一张空的hash表。

2,configuration_hash的回收发生在EG(ini_directives)之后,上面贴出的代码中有关于php_shutdown_config的函数调用。php_shutdown_config主要负责回收configuration_hash。代码如下:

  1. int php_shutdown_config(void) 
  2.     // 回收configuration_hash 
  3.     zend_hash_destroy(&configuration_hash); 
  4.     
  5.     … 
  6.     
  7.     return SUCCESS; 

注意zend_hash_destroy并不会释放configuration_hash本身的空间,同XXX_G访问的模块全局空间一样,configuration_hash也是一个全局变量,无需手动回收。

3,当php_shutdown_config完成时,只剩下EG(ini_directives)的自身空间还没被释放。因此最后一步调用zend_ini_shutdown。zend_ini_shutdown用于释放EG(ini_directives)。在前文已经提到,此时的EG(ini_directives)理论上是一张空的hash表,因此该HashTable本身所占用的空间需要被释放。代码如下:

  1. ZEND_API int zend_ini_shutdown(TSRMLS_D) 
  2.     // EG(ini_directives)是动态分配出的空间,需要回收 
  3.     zend_hash_destroy(EG(ini_directives)); 
  4.     free(EG(ini_directives)); 
  5.     return SUCCESS; 

模板优惠价: (点击购买)
版权声明:本文采用知识共享 署名4.0国际许可协议 [BY-NC-SA] 进行授权
文章名称:《php中动态修改ini配置》
文章链接:https://www.adminn.cn/news/31811.html
本站资源模板仅供个人学习交流,请于下载后24小时内删除,不允许用于商业用途,否则法律问题自行承担。2021.5月起,网站调整,暂不再分享免费模板。谢谢理解

Adminn.Cn 站长分享圈

帝国CMS精品模板腾讯云优惠券,代金券

2次开发,学习研究使用!扫码支付后联系QQ677123发货!

支付宝扫一扫打赏