[PHP源碼閱讀]empty和isset函數

近日被問到PHP中empty和isset函數時怎麼判斷變量的,剛開始我是一臉懵逼的,由於我本身也只是只知其一;不知其二,爲了弄懂其真正的原理,趕忙翻開源碼研究研究。通過分析可發現兩個函數調用的都是同一個函數,所以本文將對兩個函數一塊兒分析。php

我在github有對PHP源碼更詳細的註解。感興趣的能夠圍觀一下,給個star。PHP5.4源碼註解。能夠經過commit記錄查看已添加的註解。html

函數使用格式

empty

bool empty ( mixed $var )

判斷變量是否爲空。git

isset

bool isset ( mixed $var [ , mixed $... ] )

判斷變量是否被設置且不爲NULL。github

參數說明

對於empty,在PHP5.5版本之前,empty只支持變量參數,其餘類型的參數會致使解析錯誤,好比函數調用的結果不能做爲參數。數組

對於isset,若是變量被如unset的函數設爲NULL,則函數會返回false。若是多個參數被傳遞到isset函數,那麼只有全部參數都被設置isset函數纔會返回true。從左到右計算,一旦遇到沒被設置的變量就中止。函數

運行示例oop

$result = empty(0); // true
$result = empty(null); // true
$result = empty(false); // true
$result = empty(array()); // true
$result = empty('0'); // true
$result = empty(1); // false
$result = empty(callback function); // 報錯

$a = null;
$result = isset($a); // false;

$a = 1;
$result = isset($a); // true;

$a = 1;$b = 2;$c = 3;
$result = isset($a, $b, $c); // true

$a = 1;$b = null;$c = 3;
$result = isset($a, $b, $c); // false

找到函數的定義位置學習

實際上,empty不是一個函數,而是一個語言結構。語言結構是在PHP程序運行前編譯好的,所以不能像以前那樣簡單地搜索PHP_FUNCTION emptyZEND_FUNCTION empty查看其源碼。要想看empty等語言結構的源碼,先要理解PHP代碼執行的機制。spa

PHP執行代碼會通過4個步驟,其流程圖以下所示:
PHP執行步驟code

在第一個階段,即Scanning階段,程序會掃描zend_language_scanner.l文件將代碼文件轉換成語言片斷。對於isset和empty函數來講,在zend_language_scanner.l文件中搜索empty和isset能夠獲得函數在此文件中的宏定義以下:

<ST_IN_SCRIPTING>"isset" {
return T_ISSET;
}


<ST_IN_SCRIPTING>"empty" {
return T_EMPTY;
}

接下來就到了Parsing階段,這個階段,程序將T_ISSET和T_EMPTY等Tokens轉換成有意義的表達式,此時會作語法分析,Tokens的yacc保存在zend_language_parser.y文件中,能夠找到T_ISSET和T_EMPTY的定義:

internal_functions_in_yacc:
T_ISSET '(' isset_variables ')' { $$ = $3; }
| T_EMPTY '(' variable ')' { zend_do_isset_or_isempty(ZEND_ISEMPTY, &$$, &$3 TSRMLS_CC); }
| T_INCLUDE expr { zend_do_include_or_eval(ZEND_INCLUDE, &$$, &$2 TSRMLS_CC); }
| T_INCLUDE_ONCE expr { zend_do_include_or_eval(ZEND_INCLUDE_ONCE, &$$, &$2 TSRMLS_CC); }
| T_EVAL '(' expr ')' { zend_do_include_or_eval(ZEND_EVAL, &$$, &$3 TSRMLS_CC); }
| T_REQUIRE expr { zend_do_include_or_eval(ZEND_REQUIRE, &$$, &$2 TSRMLS_CC); }
| T_REQUIRE_ONCE expr { zend_do_include_or_eval(ZEND_REQUIRE_ONCE, &$$, &$2 TSRMLS_CC); }
;

isset和empty函數最終都執行了zend_do_isset_or_isempty函數,在源碼目錄中查找

grep -rn "zend_do_isset_or_isempty"

能夠發現,此函數在zend_compile.c文件中定義。

函數執行步驟

一、解析參數

二、檢查是否爲可寫變量

三、若是是變量的op_type是IS_CV(編譯時期的變量),則設置其opcode爲ZEND_ISSET_ISEMPTY_VAR;不然從active_op_array中獲取下一個op值,根據其op值設置last_op的opcode。

四、設置了opcode以後,以後會交給zend_excute執行。

源碼解讀

IS_CV是編譯器使用的一種cache機制,這種變量保存着它被引用的變量的地址,當一個變量第一次被引用的時候,就會被CV起來,之後這個變量的引用就不須要再去查找active符號表了。

對於empty函數,到了opcode的步驟後,參閱opcode處理函數,能夠知道,isset和empty在excute的時候執行的是ZEND_ISSET_ISEMPTY_VAR等一系列函數,以ZEND_ISSET_ISEMPTY_VAR_SPEC_CV_VAR_HANDLER爲例,找到這個函數的定義在zend_vm_execute.h。查看函數能夠知道,empty函數的最終執行函數是i_zend_is_true(),而i_zend_is_true函數定義在zend_execute.h。i_zend_is_true函數的核心代碼以下:

switch (Z_TYPE_P(op)) {
    case IS_NULL:
        result = 0;
        break;
    case IS_LONG:
    case IS_BOOL:
    case IS_RESOURCE:
        // empty參數爲整數時非0的話就爲false
        result = (Z_LVAL_P(op)?1:0);
        break;
    case IS_DOUBLE:
        result = (Z_DVAL_P(op) ? 1 : 0);
        break;
    case IS_STRING:
        if (Z_STRLEN_P(op) == 0
            || (Z_STRLEN_P(op)==1 && Z_STRVAL_P(op)[0]=='0')) {
            // empty("0") == true
            result = 0;
        } else {
            result = 1;
        }
        break;
    case IS_ARRAY:
        // empty(array) 是根據數組的數量來判斷
        result = (zend_hash_num_elements(Z_ARRVAL_P(op))?1:0);
        break;
    case IS_OBJECT:
        if(IS_ZEND_STD_OBJECT(*op)) {
            TSRMLS_FETCH();

            if (Z_OBJ_HT_P(op)->cast_object) {
                zval tmp;
                if (Z_OBJ_HT_P(op)->cast_object(op, &tmp, IS_BOOL TSRMLS_CC) == SUCCESS) {
                    result = Z_LVAL(tmp);
                    break;
                }
            } else if (Z_OBJ_HT_P(op)->get) {
                zval *tmp = Z_OBJ_HT_P(op)->get(op TSRMLS_CC);
                if(Z_TYPE_P(tmp) != IS_OBJECT) {
                    /* for safety - avoid loop */
                    convert_to_boolean(tmp);
                    result = Z_LVAL_P(tmp);
                    zval_ptr_dtor(&tmp);
                    break;
                }
            }
        }
        result = 1;
        break;
    default:
        result = 0;
        break;
}

這段代碼比較直觀,函數沒有對檢測值作任何的轉換,經過這段代碼來進一步分析示例中的empty函數作分析:
empty(null),到IS_NULL分支,result=0,i_zend_is_true() == 0,!i_zend_is_true() == 1,所以返回true。

empty(false),到IS_BOOL分支,result = ZLVAL_P(false) = 0,i_zend_is_true() == 0,!i_zend_is_true() == 1,所以返回true。

empty(array()),到IS_ARRAY分支,result = zend_hash_num_elements(Z_ARRVAL_P(op)) ? 1 : 0),zend_hash_num_elements返回數組元素的數量,array爲空,所以result爲0,i_zend_is_true() == 0,!i_zend_is_true() == 1,所以返回true。

empty('0'),到IS_STRING分支,由於Z_STRLENP(op) == 1 且 Z_STRVAL_P(op)[0] == '0',所以result爲0,i_zend_is_true() == 0,!i_zend_is_true() == 1,所以返回true。

empty(1),到IS_LONG分支,result = Z_LVAL_P(op) = 1,i_zend_is_true == 1,!i_zend_is_true() == 0,所以返回false。

對於isset函數,最終實現判斷的代碼是:

if (isset && Z_TYPE_PP(value) != IS_NULL) {
    ZVAL_BOOL(&EX_T(opline->result.var).tmp_var, 1);
} else {
    ZVAL_BOOL(&EX_T(opline->result.var).tmp_var, 0);
}

只要value被設置了且不爲NULL,isset函數就返回true。

小結

此次閱讀這兩個函數的源碼,學習到了:

一、PHP代碼在編譯期間的執行步驟

二、如何查找PHP語言結構的源碼位置

三、如何查找opcode處理函數的具體函數

學無止境,每一個人都有本身的短板,只有經過不斷學習才能將本身的短板補上。

原創文章,文筆有限,才疏學淺,文中如有不正之處,萬望告知。

若是本文對你有幫助,請點下推薦吧,謝謝^_^

我在github有對PHP源碼更詳細的註解。感興趣的能夠圍觀一下,給個star。PHP5.4源碼註解。能夠經過commit記錄查看已添加的註解。

參考文章
opcode處理函數查找:http://www.laruence.com/2008/06/18/221.html

PHPopcode深刻理解及PHP代碼執行步驟:http://www.php-internals.com/book/?p=chapt02/02-03-03-from-opcode-to-handler

更多源碼文章,歡迎訪問我的主頁繼續查看:hoohack

相關文章
相關標籤/搜索