為了幫助同學們學習PHP核心技術,小編整理了php核心分析之sapi_module_struct,希望對大家有所幫助!更多內容請關注應屆畢業生網!
這裡閱讀的php版本為PHP-7.1.0 RC3,閱讀程式碼的平臺為linux
首先是尋找php的入口,php有很多種模式,apache,php-fpm, cli模式,我要入手的話,只能先從最簡單的cli模型開始。
那麼,我需要先尋找
php -r 'echo 12;'
這個命令是如何執行的。
首先還是尋找main入口,由於我們看的是命令列的php程式。所以,這個入口在sapi/cli/php_cli.c中。
首先是定義一系列的變數
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中。
下面是增加了註釋的程式碼:
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; // 不在當前路徑尋找
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 zone=America/Adak,可以在命令列中設定時區
const zend_function_entry *additional_functions; // 每個SAPI模組特有的一些函式註冊,比如cli的cli_get_process_title
unsigned int (*input_filter_init)(void); // TODO:
};