A Close Look Into PHP Zval

最近研究了一下PHP variable的内部实现也就是zval，以及引申出来的Copy on Write, Reference等概念和机制。为了检验一下我是不是真的弄懂了，一个好的方法就是看能不能把它清楚地写下来并让人能够读懂。

什么是zval

简单的来说zval就是PHP variable的value在低层C的表示。大家都知道PHP主要是用C语言来写的，于是所有东西应该都有一个C的对应，PHP variable的value对应就是zval struct。首先先来看一下zval struct的定义：

struct {
    union {
        long lval;
        double dval;
        struct {
            char *val;
            int len;
        } str;
        HashTable *ht;
        zend_object_value obj;
    } value;
    zend_uint refcount;
    zend_uchar type;
    zend_uchar is_ref;
} zval;

接下来我们就从最简单的开始，逐一解释一下各个字段的含义。

type

首先是type字段，这个顾名思义就是表示PHP variable是什么类型的。由于PHP是动态类型语言，因此需要这个字段来标识，同时根据这个字段可以判断出value字段里的值到底是什么。

value

value字段存放的是PHP variable的值，可以看出这是个union类型，也就是说这个字段可以有多种解释，关键看type的值是什么，这不就有点像多态么。接下里我们就看看type和value的对应关系是什么：

PHP variable type	zval value	Notes
Long	long lval
Double	double dval
String	struct{…} str
Resource	long lval	存放的只是resource的identifier,而不是resource本身
Boolean	long lval	0表示FALSE，1表示TRUE
Array	HashTable *ht	PHP的很多东西都是用HashTable来实现的
Ojbect	zend_object_value obj
NULL		NULL本身也是一种类型，但它不需要使用`value`字段

其中Long, Double, String, Boolean, NULL应该是很清晰了，用zval可以完全表示，略复杂一点的是Object,Array和Resource。在这里我们就只讨论Ojbect和Array。

Object

从上面的对应表可以看出Object的value是用zend_object_value这个struct来表示的，我们就看看这个struct的定义：

struct {
    zend_object_handle handle;
    zend_object_handlers *handlers;
} zend_object_value;

在这里要说明的是一个ojbect的data并不是直接存放在zend_object_value里面的，而是放在object store中，也就是说每个object都有一个对应的object store（这应该也是用HashTable来实现的吧），里面放着object的data，也就是object属性的值，这些值本身也是一个个的zval。接下里PHP要做的就是建立object和object store的一一对应关系，而这个就是通过zend_object_handle handle来实现的，这是一个long值，相当于object store的identifier,通过这个handle就可以找到object的data在那里了。而zend_object_handlers *handlers指向了一些处理函数，比如用来访问object属性的函数等等，这个在这里就不再详述了，有兴趣的可以看这里。讲到这里，我们应该知道了对于object的zval来说本身并没有存放object的data，而只是存放了一个整数型的handle。认识到这一点很重要，因为这会对接下来讨论的copy by reference和copy by value产生直接的影响。

Array

PHP的Array是用HashTable来实现的，通过这个就可以存放Array中的Key-Value了。关于这个HashTable具体是如何实现的，可以看这里。我根据那个tutorial画了个示意图如下：

在这里我们要知道的是Key-Value中的value也就是一个个的zval，就和object的属性值一样，HashTable中就存放着指向这些zval的指针。

refcount & if_ref

看完了type和value字段，接下来就看看refcount和if_ref字段，这两个字段关系到gc,关系到copy by value和copy by reference，所以非常重要，需要仔细讲解。refcount表明当前有多少个variable指向了这个zval，这个信息就可以用来gc，当refcount变为0后，这个zval就可以被回收。if_ref表明当前指向这个zval的variable是不是reference。在PHP中一个variable可以是value type就像这样$b = $a或者是reference type就像这样$b = &$a。在语义上这两者是不同的，因此也就拥有不同的行为，我们首先要区分这两种类型的variable，这个通过代码解释最好不过了。

$a = 'hello';
$b = $a; // $b is value type
$a = 'world';
var_dump($a); // 'world'
var_dump($b); // 'hello'

$a = 'hello';
$b = &$a; // $b is reference type
$a = 'world';
var_dump($a); // 'world'
var_dump($b); // 'world'

从上面一段代码可以看出如果$b是value type的话，它的值并不会随着$a的改变而改变，就好像在执行$b = $a时，$a的值(zval)被复制了一份，也就是说$a和$b拥有自己独立的zval，两者互不影响。而如果是reference type的话，就如同$a和$b共用了一个zval，不管是改变$a，还是$b，其实都是改变一个zval。但事实没有这么简单，如果真像上面所说的那样执行$b = $a时，zval复制了一份，那么效率也太低了，因为有可能$b和$a在接下来的使用过程中都是只读的，它们本可以共用一个zval而不会出问题。那么PHP究竟是如何实现的呢，答案就是通过refcount和if_ref实现了copy on write机制。而这个copy on write机制对于不同type的变量也会有些不同的表现，接下来我们就通过一系列的图例来理解这个机制。

前两张图大家应该很好理解，可以清楚的看到copy on write的发生并可以看到if_ref和refcount的作用，PHP正是依赖于if_ref和refcount来决定是否需要copy on write。而从第三张图中可以看到在没有write发生的情况下就发生了copy，而这是为什么呢，貌似$a、$b和$c可以共用一个zval的呀。原因其实很简单，那就是如果这三个变量共用一个zval那么is_ref的值就不知道该填什么了，0或1都不正确，因为这三个变量中既有value type又有reference type。如果is_ref为0那么$a和$c是reference关系这个信息就无法表达,PHP会认为$a、$b和$c是value type，改变其中任何一个的值并不会对另外两个造成影响，这显然不对。如果is_ref为1那么PHP会认为$a、$b和$c是reference type，改变其中任何一个的值都会反映在另外两个上，这显然也是不对的。综上所述在这种情况下只能copy出一份zval出来，这样才能保证接下来不管是操作$a、$b或者$c都不会出问题。之前的这三种图展示的是type为Long的variable的情况，而Boolean、Double、String和Long是一样的，就不再画出来了，而Array和Object比较复杂，情况也特殊，所以拿出来单独讨论。

从上面两张图看出Array和Object的行为存在着显著的不同，Array拥有by-value semantics而Object拥有by-reference semantics。Array的表现更像之前提到的Long type，也会有Copy on Write行为，而它的Copy从上图中可以看出比较智能，只Copy那些必须的zval。而Object则不一样，不管是value type还是reference type，它们都共用一个object store，也就是说任何属性的值发生了变化，所有指向这个object的variable都能知道，就好像Copy on Write对Object不起作用了。为了强制Copy，最后执行了$c = &$a这条语句，为什么这条语句能强制使zval copy一份的原理在上面已经讲过了，这里就不再复述。这里有趣的是zval确实copy了一份，但是两个zval还是指向了同一个object store，也就是说不管通过$a、$b或者$c改变了某个属性，这三个变量都能知道。那么zval的copy到底做了什么呢？还记得上面提到过zend_object_value中只是存放了一个整型的handle字段，而通过这个字段可以找到object store在哪，那么zval的copy也就只会将这个handle字段copy一份，于是两个zval中拥有同样的handle值，它们就当然指向了同一个object store。那么如何让Object发生像Array那样类似的Copy呢，PHP为此提供了clone关键字。

说到这差不多把zval给讲清楚了，同时也讲了一下Copy on Write机制，Value type和Reference type的区别。有了上面的解释，我们也应该能知道函数传参的Pass by Value和Pass by Reference的区别了，在这里就不多说了。如果有人想看更多类似我上面的图的话，可以看这里。如果有人想问我是怎么知道低层zval的变化的话，可以看这里。最后还可以看看这个和zval有关的问题。

Jiajun Yao

Stay hungry, Stay foolish.