這裡閱讀的php版本為PHP-7.1.0 RC3,閱讀程式碼的平臺為linux
首先是尋找php的入口,php有很多種模式,apache,php-fpm, cli模式,我要入手的話,只能先從最簡單的cli模型開始。
那麼,我需要先尋找
1 |
php -r 'echo 12;' |
這個命令是如何執行的。
首先還是尋找main入口,由於我們看的是命令列的php程式。所以,這個入口在sapi/cli/php_cli.c中。
首先是定義一系列的變數
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 |
int c; zend_file_handle file_handle; int behavior = PHP_MODE_STANDARD; char *reflection_what = NULL; volatile int request_started = 0; volatile int exit_status = 0; char *php_optarg = NULL, *orig_optarg = NULL; int php_optind = 1, orig_optind = 1; char *exec_direct=NULL, *exec_run=NULL, *exec_begin=NULL, *exec_end=NULL; char *arg_free=NULL, **arg_excp=&arg_free; char *script_file=NULL, *translated_path = NULL; int interactive=0; int lineno = 0; const char *param_error=NULL; int hide_argv = 0; |
然後是這個
sapi_module_struct *sapi_module = &cli_sapi_module;
這是一個sapi_module_struct結構,這個結構是sapi中最重要的資料結構。它的定義在main/SAPI.h中。
下面是增加了註釋的程式碼:
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 |
struct _sapi_module_struct { // SAPI模組結構 char *name; // 應用層名稱,比如cli,cgi等 char *pretty_name; // 應用層更易讀的名字,比如cli對應的就是Command Line Interface int (*startup)(struct _sapi_module_struct *sapi_module); // 當一個應用要呼叫php的時候,這個模組啟動的時候會呼叫的函式 int (*shutdown)(struct _sapi_module_struct *sapi_module); // 當一個應用要呼叫php的時候,這個模組結束的時候會呼叫的函式 int (*activate)(void); // 在處理每個request的時候,啟用需要呼叫的函式 int (*deactivate)(void); // 在處理完每個request的時候,收尾時候要呼叫的函式 size_t (*ub_write)(const char *str, size_t str_length); // 這個函式告訴php如何輸出資料 void (*flush)(void *server_context); // 提供給php的重新整理快取的函式指標 zend_stat_t *(*get_stat)(void); // 用來判斷要執行檔案的許可權,來判斷是否有執行許可權 char *(*getenv)(char *name, size_t name_len); // 獲取環境變數的方法 void (*sapi_error)(int type, const char *error_msg, ...) ZEND_ATTRIBUTE_FORMAT(printf, 2, 3); // 錯誤處理方法 int (*header_handler)(sapi_header_struct *sapi_header, sapi_header_op_enum op, sapi_headers_struct *sapi_headers); // 這個函式會在我們呼叫header()的時候被呼叫 int (*send_headers)(sapi_headers_struct *sapi_headers); // 傳送所有的header void (*send_header)(sapi_header_struct *sapi_header, void *server_context); // 單獨傳送某一個header size_t (*read_post)(char *buffer, size_t count_bytes); // 如何獲取HTTP POST中的資料 char *(*read_cookies)(void); // 如何獲取cookie中的資料 void (*register_server_variables)(zval *track_vars_array); // 這個函式可以給$_SERVER中獲取變數 void (*log_message)(char *message, int syslog_type_int); // 輸出錯誤資訊函式 double (*get_request_time)(void); // 獲取請求時間的函式 void (*terminate_process)(void); // TODO: 呼叫exit的時候呼叫的方法 char *php_ini_path_override; // PHP的ini檔案被複寫了所複寫的地址 void (*default_post_reader)(void); // 這裡和前面的read_post有個差別,read_post負責如何獲取POST資料,而這裡的函式負責如何解析POST資料 void (*treat_data)(int arg, char *str, zval *destArray); // 對資料進行處理,比如進行安全過濾等。 default_post_reader/tread_data/input_filter是三個能對輸入進行過濾和處理的函式 char *executable_location; // 執行的地理位置 int php_ini_ignore; // 是否不使用任何ini配置檔案,比如php -n 就將這個位置設定為1 int php_ini_ignore_cwd; // 不在當前路徑尋找php.ini int (*get_fd)(int *fd); // 獲取執行檔案的fd int (*force_http_10)(void); // 強制使用http1.0 int (*get_target_uid)(uid_t *); // 獲取執行程式的uid int (*get_target_gid)(gid_t *); // 獲取執行程式的gid unsigned int (*input_filter)(int arg, char *var, char **val, size_t val_len, size_t *new_val_len); // 對輸入進行過濾。比如將輸入引數填充到自動全域性變數$_GET, $_POST, $_COOKIE中 void (*ini_defaults)(HashTable *configuration_hash); // 預設的ini配置 int phpinfo_as_text; // 是否列印phpinfo資訊 char *ini_entries; // 有沒有附帶的ini配置,比如使用php -d date.timezone=America/Adak,可以在命令列中設定時區 const zend_function_entry *additional_functions; // 每個SAPI模組特有的一些函式註冊,比如cli的cli_get_process_title unsigned int (*input_filter_init)(void); // TODO: }; |
那麼我們看下cli的SAPI的module是什麼樣子的呢?
其中我把裡面原先有的STANDARD_SAPI_MODULE_PROPERTIES巨集給解出來展示如下:
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 |
static sapi_module_struct cli_sapi_module = { "cli", /* name */ "Command Line Interface", /* pretty name */ php_cli_startup, /* startup */ php_module_shutdown_wrapper, /* shutdown */ NULL, /* activate */ sapi_cli_deactivate, /* deactivate */ sapi_cli_ub_write, /* unbuffered write */ sapi_cli_flush, /* flush */ NULL, /* get uid */ NULL, /* getenv */ php_error, /* error handler */ sapi_cli_header_handler, /* header handler */ sapi_cli_send_headers, /* send headers handler */ sapi_cli_send_header, /* send header handler */ NULL, /* read POST data */ sapi_cli_read_cookies, /* read Cookies */ sapi_cli_register_variables, /* register server variables */ sapi_cli_log_message, /* Log message */ NULL, /* Get request time */ NULL, /* Child terminate */ NULL, /* php_ini_path_override */ NULL, /* default_post_reader */ NULL, /* treat_data */ NULL, /* executable_location */ 0, /* php_ini_ignore */ 0, /* php_ini_ignore_cwd */ NULL, /* get_fd */ NULL, /* force_http_10 */ NULL, /* get_target_uid */ NULL, /* get_target_gid */ NULL, /* input_filter */ NULL, /* ini_defaults */ 0, /* phpinfo_as_text; */ NULL, /* ini_entries; */ NULL, /* additional_functions */ NULL /* input_filter_init */ }; |
有幾個點可以總結:
cli模式是不需要傳送header的,所以對應header處理的三個函式
1 2 3 |
sapi_cli_header_handler sapi_cli_send_headers sapi_cli_send_header |
實際上都是空實現。
cookie也是同樣道理
1 |
sapi_cli_read_cookies |
其他的一些定義的函式,等到我們遇到的時候再分析吧。
main
回到main函式,根據上面的那個結構,我們就理解了
1 2 3 |
argv = save_ps_args(argc, argv); //這裡獲取一次當前執行程式的引數,環境變數等。為的是對特定平臺,修正下argv變數以供後續使用。 cli_sapi_module.additional_functions = additional_functions; // cli模式特有的函式 |
signal
1 2 3 4 5 6 |
#ifdef HAVE_SIGNAL_H #if defined(SIGPIPE) && defined(SIG_IGN) // 忽略SIGPIPE是為了如果php是socket的客戶端,那麼當服務端關閉的話,會返回一個PIPE的訊號,為的是當前的程式不會因為這個而結束 signal(SIGPIPE, SIG_IGN); #endif #endif |
參考
http://php.find-info.ru/php/016/ch23lev1sec1.html
http://foio.github.io/php-sapi/