PHP傳參原理深入解析

在寫php擴充時，似乎參數（即傳給zend_parse_parameters的變數）是不需要free的。 舉例：

PHP_FUNCTION(test)
{
 char* str;
 int str_len;
 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &str, &str_len) == FAILURE) {
 RETURN_FALSE;
 }
 // 不需要free(str)
}

運作正常： test("Hello World"); // 列印Hello World 這裡不用擔心test函數會發生記憶體洩露，php會自動幫我們回收這些用來保存參數的變數。

那php究竟是如何做到的呢？要解釋這個問題，還是要看php是怎麼傳遞參數的。

EG(argument_stack)簡介 簡單來講，在php中的EG中保存了一個專門用來存放參數的棧，名為argument_stack。每當發生函數呼叫時，php會將傳入的參數壓進EG(argument_stack)。一旦函數呼叫結束，則EG(argument_stack)被清理，並且等待下一次的函數呼叫。

關於EG(argument_stack)的struct結構、用途，php5.2和5.3實作有些差異。本文主要以5.2為例，5.3+的變化後面抽空再說。

上圖是5.2中argument_stack的大概示意圖，看起來簡單明了。其中，棧頂和棧底固定為NULL。函數接收的參數依照從左到右的順序，依序被壓入堆疊。請注意，最後會被額外壓入一個long型的值，表示棧裡的參數個數（上圖為10）。

那被壓入argument_stack的參數究竟是什麼呢？其實是一個個zval類型的指標。 它們指向的zva有可能是CV變量，有可能是is_ref=1的變量，還有可能是常數數字，或是常數字串。

EG(argument_stack)在php5.2中被具體實作為zend_ptr_stack類型:

typedef struct _zend_ptr_stack {
 int top; // 堆疊中目前元素的數量
 int max;的數量
 void **elements; // 棧底
 void **top_element; // 棧頂
} zend_ptr_stack;

複製程式碼

初始化argument_stack 初始化argument_stack的工作是發生在php處理特定的請求之前，更準確地說是處於php解釋器的啟動過程之中。

這2行分別代表著，初始化EG(argument_stack)，緊接著壓入一個NULL。由於EG是個全域變量，因此在實際呼叫zend_ptr_stack_init之前，EG(argument_stack)中的所有資料全部為0。

zend_ptr_stack_init實作很簡單。

ZEND_API void zend_ptr_stack_init(zend_ptr_stack *stack)
{
 stack->topp. sizeof(void *)*PTR_STACK_BLOCK_SIZE);
 stack->max = PTR_STACK_BLOCK_SIZE; // 堆疊的大小初始化成64
 stack->top = 0; // 目前元素個數為0
}
}

一旦argument_stack被初始化完，則立即會被壓入NULL。這裡無須深究，這個NULL其實沒有任何的意義。

NULL入棧之後，整個argument_stack的實際記憶體分佈如下：

參數入棧 在壓入第一個NULL之後，一旦再有參數入棧，則argument_stack會發生以下動作： stack->top++; *(stack->top_element++) = 參數;

用一段簡單的php程式碼來說明問題：

function foo( $str ){
 print_r(123);
}
foo("hello world");

上述程式碼在呼叫foo時，傳入了一個字串常數。因此，實際上被壓入堆疊的是一個指向儲存「hello world」的zval。用vld來查看編譯之後的opcode：

line # * op fetch ext return operands
--------------------- -------------------------------------------------- ----------
 3 0 > NOP
 6 1 SEND_VAL OP1[ IS_CONST (458754) 'hello world' ]
 2 DO_FCALL 1 OP1[ IS_CONST (458752) 'foo' ]
 15 3 > RETURN OP1[ IS_CONST (0) 1 ]

SEND_VALhello指令」壓入argument_stack。

int ZEND_SEND_VAL_SPEC_CONST_HANDLER(ZEND_OPCODE_HANDLER_ARGS)
{
 value = &opline->op1.u.constant;
 ALLOC_ZVAL(valptr);
 INIT_PZVAL_COPY(valptr, value);
 if (!0) { }
 // 入棧，valptr指向存放hello world的zval
 zend_ptr_stack_push(&EG(argument_stack), valptr);
 ……
 ……
 >}

參數個數 前文說到，其實並非把所有參數入棧就完事了。 php也會額外壓入一個數字，表示參數的個數，這個工作並非發生在SEND_XXX指令時。實際上，在真正執行函數之前，php會將參數個數入堆疊。

繼續沿用上面的例子，DO_FCALL 指令用來呼叫foo函數。在呼叫foo之前，php會自動填入argument_stack最後一塊。

{
 …extended_value）
 // 一個是標識棧頂的NULL
 zend_ptr_stack_2_push(&EG(argument_stack), (void *)(zend_uintptr_t));
 ……
 if (EX(function_state).function->type == ZEND_INTERNAL_FUNCTION) {
 ……
 }
 else if (EX(function_state).==function->type ==function-> == ZEND_USER_FUNCTION) {
 ……
 // 呼叫foo函數
 zend_execute(EG(active_op_array) TSRMLS_CC);
 }
 else { /* ZENDLS_CC);
 }
 else { /* ZEND_OVERP> }
 ……
 // 清理argument_stack
 zend_ptr_stack_clear_multiple(TSRMLS_C);
 ……
 ZEND_VM_NEXT_OPCODE();
 >

壓入參數個數和NULL之後，用於foo呼叫的整個argument_stack已然完成。
 取得參數
繼續跟進上面的例子。
深入foo函數，看看foo的opcode是什麼樣子的。

line # * op fetch ext return operands

--------------------- -------------------------------------------------- ---------- 3 0 > RECV OP1[ IS_CONST (0) 1 ]

4 1 SEND_VAL OP1[ IS_CONST (5) 123 ]

複製程式碼


第一條指令是RECV，從字面上理解便是用來取得堆疊中參數的。實際上，SEND_VAL和RECV有點對應的感覺。每次函數呼叫之前SEND_VAL，在函數內部進行RECV。為什麼不說是完全對應，實際上RECV指令並非一定需要。只有當使用者定義的函數被呼叫是，才會產生RECV。我們寫的擴充函數，php自帶的內建函數，都不會有RECV。 
需要額外指出的是，每次SEND_VAL和RECV 均只能處理一個參數。也就是說如果傳參的過程中有多個參數，那麼就會產生若干SEND_VAL以及若干RECV。這裡引出一個很有趣的議題，傳入參數和取得參數的順序是怎麼樣的呢？ 
答案是，SEND_VAL會將參數從左至右的進行壓棧，而RECV一樣的則由左至右取得參數。
 


static int ZEND_RECV_SPEC_HANDLER(ZEND_OPCODE_HANDLER_ARGS)
{
{棧底
 if (zend_ptr_stack_get_arg(arg_num, (void **) ¶m TSRMLS_CC)==FAILURE) {
 ……
 } else {
 zend_free_op free_resval🎜> } *var_ptr;
 // 驗證參數
 zend_verify_arg_type((zend_function *) EG(active_op_array), arg_num, *param TSRMLS_CC);
 var_ptr = get_zparam TSRMLS_CC);
 var_ptr = get_zparam TSRMLS_CC);
 var_ptr = get_zparam TSRMLS_CC);
 var_ptr = get_zparam. EX(Ts), &free_res, BP_VAR_W);

 // 取得參數
 if (PZVAL_IS_REF(*param)) {
 zend_assign_to_variable_reference(varm)) {
 zend_assign_to_variable_reference(varm)) {
 zend_assign_to_variable_reference(var_pRMs) }; 🎜> zend_receive(var_ptr, *param TSRMLS_CC);
 }
 }
 ZEND_VM_NEXT_OPCODE();複製程式碼
說到底很簡單，「取得參數」就是將這個參數加入到目前函數執行期間的「符號表」中，具體對應為EG(current_execute_data)->symbol_table。在本範例中，RECV完成之後，函數體內的symbol_table中有了一個符號‘str’，它的值為“hello world”。 
但argument_stack並沒有發生一絲變化，因為RECV只是讀取參數，而不會對堆疊產生類似pop操作。 


清理argument_stack
foo內部的print_r也是一個函數調用，因此也會產生壓棧-->清棧的操作。因此print_r執行之前的argument_stack為：


print_r執行之後argument_stack又回到了foo剛RECV完的狀態。 
具體呼叫print_r的過程並非本文闡述的重點。我們關心的是當呼叫foo結束之後，php是如何清理argument_stack的。 
上面展示的do_fcall程式碼片段中可以看出，清理工作由zend_ptr_stack_clear_multiple完成的。
 

{
 voidoidp = EG(argument_p. / 取棧頂保存的參數個數
 int delete_count = (int)(zend_uintptr_t) *p;
 EG(argument_stack).top -= (delete_count+2);

 // 從上至下，依序清理
 while (--delete_count>=0) {
 zval *q = *(zval **)(--p);
 *p = NULL;
 zval_ptr_dtor (&q);
 }
 EG(argument_stack).top_element = p;
}


複製程式碼


is_ref 0

type 6
is_ref 0