プロパティストレージ¶

PHPではオブジェクトのプロパティは宣言できますが、宣言しないといけないというわけではありません。このような状況をどのように処理するのが効率的でしょうか。それを探るため、今一度、標準の zend_object 構造体を思い出してみましょう。

typedef struct _zend_object {
    zend_class_entry *ce;
    HashTable *properties;
    zval **properties_table;
    HashTable *guards;
} zend_object;

この構造体はプロパティを保持するために2つのフィールドを含んでいます。つまり properties のハッシュテーブルと properties_table のzvalの配列です。分離したその2つのフィールドは、宣言されたプロパティと動的に追加されたプロパティの両方を最も良い方法で操作するために使用されます。動的に追加される、つまりクラスで宣言されていないプロパティに関しては、 properties (単なるプロパティ名 => 値のマッピング)を使うしか仕方ありません。

一方、宣言されたプロパティに関しては、それらをハッシュテーブルで保持するのは非常に無駄となるでしょう。というのも、PHPのハッシュテーブルは要素毎のオーバーヘッドが非常に大きいですが(100バイト近い)、ここで必要なのは値の zval へのポインターを保持するだけだからです。このため、PHPはちょっとしたトリックを採用しています。その方法とは、プロパティは通常のCの配列に格納し、オフセットを使ってアクセスするようにするというものです。それぞれのプロパティ名のためのオフセットはクラスエントリ内の(グローバルの)ハッシュテーブルに格納されています。そのため、プロパティの参照は一段階余分に間接参照されます。つまり、直接にプロパティの値を取得するのではなく、まずプロパティのオフセットを取得してから、そのオフセットを使用して実際のプロパティの値を取り出します。

プロパティ情報(ストレージのオフセットも含めて)は class_entry->properties_info に格納されています。このハッシュテーブルはプロパティ名を zend_property_info 構造体に対応付けしています。

typedef struct _zend_property_info {
    zend_uint flags;
    const char *name;
    int name_length;
    ulong h;                 /* ハッシュ名 */
    int offset;              /* ストレージのオフセット */
    const char *doc_comment;
    int doc_comment_len;
    zend_class_entry *ce;    /* 宣言するクラスのクラスエントリー */
} zend_property_info;

ここで１つ残る疑問は、プロパティの両方のタイプが存在する際にどうなるかということです。この場合、両方のプロパティの構造体が同時に使用されます。全てのハッシュテーブルは properties ハッシュテーブルに格納されますが、同時に properties_table にもプロパティへのポインターが含まれます。しかし両方が使用されている場合には、プロパティテーブルは zval* ではなく zval** で値を保持することに注意してください。

全てのプロパティが宣言されていたとしても、 get_properties ハンドラーが使われる場合などでは、ハッシュテーブルとしてのプロパティが必要になることがあります。この場合、PHPは properties を使用する方に切り替えます(あるいは前述したように、両方を使用するというハイブリッドなアプローチをとることもあります)。このハンドリングは rebuild_object_properties 関数によって行われます。

ZEND_API HashTable *zend_std_get_properties(zval *object TSRMLS_DC)
{
    zend_object *zobj;
    zobj = Z_OBJ_P(object);
    if (!zobj->properties) {
        rebuild_object_properties(zobj);
    }
    return zobj->properties;
}

プロパティの名前修飾¶

下記のコードスニペットについて考えてみましょう。

<?php

class A {
    private $prop = 'A';
}

class B extends A {
    private $prop = 'B';
}

class C extends B {
    protected $prop = 'C';
}

var_dump(new C);

// Output:
object(C)#1 (3) {
  ["prop":protected]=>
  string(1) "C"
  ["prop":"B":private]=>
  string(1) "B"
  ["prop":"A":private]=>
  string(1) "A"
}

上記の例では、同じ名前の $prop というプロパティが3回定義されています。それぞれ、 A のprivateなプロパティ、 B のprivateなプロパティ、 C のprotectedなプロパティとなっています。これら3つのプロパティが同じ名前であっても、それぞれ別のプロパティとして区別されていますし、別個のストレージを必要とします。

このような状況に対応するために、PHPはプロパティ名をプロパティのアクセス権のタイプと定義しているクラスで修飾しています。:

class Foo { private $prop;   } => "\0Foo\0prop"
class Bar { private $prop;   } => "\0Bar\0prop"
class Rab { protected $prop; } => "\0*\0prop"
class Oof { public $prop;    } => "prop"

ご覧のように、publicなプロパティはそのままの名前で、protectedなプロパティには \0*\0 の接頭辞( \0 はヌルバイトです)が付き、privateなプロパティには \0ClassName\0 で始まるようになります。

大抵は、この修飾された名前はユーザーランド上には出てこないようになっています。この名前が見受けられるのはいくつかの特殊なケースのみで、例えばオブジェクトを配列に型変換した場合や、シリアライズされた結果でなどです。内部的にも、この名前修飾(マングリング)については意識しなくてもよいようになっていて、例えば zend_declare_property APIは自動的に名前修飾してくれます。

唯一、名前修飾について気をつけないとならないケースは、 property_info->name フィールドを使う場合や、 zobj->properties のハッシュテーブルを直接使う場合になります。この場合には、 zend_(un)mangle_property_name APIを使えばよいでしょう。

// アンマングリング
const char *class_name, *property_name;
int property_name_len;

if (zend_unmangle_property_name_ex(
        mangled_property_name, mangled_property_name_len,
        &class_name, &property_name, &property_name_len
    ) == SUCCESS) {
    // ...
}

// マングリング
char *mangled_property_name;
int mangled_property_name_len;

zend_mangle_property_name(
    &mangled_property_name, &mangled_property_name_len,
    class_name, class_name_len, property_name, property_name_len,
    should_do_persistent_alloc ? 1 : 0
);

プロパティの再帰保護機能¶

zend_object の最後のメンバーは HashTable *guards フィールドです。これが何のために使用されるのかを探るため、__set のマジックメソッドを使っている下記のコードがどのような結果になるのかを考えてみてください。

<?php

class Foo {
    public function __set($name, $value) {
        $this->$name = $value;
    }
}

$foo = new Foo;
$foo->bar = 'baz';
var_dump($foo->bar);

このスクリプトでの $foo->bar = 'baz' の代入は、 $bar のプロパティが定義されていないので、 $foo->__set('bar', 'baz') が実行されるでしょう。この場合、メソッドの中身の $this->$name = $value の行は $foo->bar = 'baz' となるでしょう。ここでも $bar が定義されていないのは同じです。ではここでも __set が(再帰的に)呼び出されることを意味するのでしょうか。

実際にはそのようなことは起こりません。むしろ、PHPは __set 内かどうかを確認して、再帰呼び出しをしないようにします。このようにすることで、新しい $bar というプロパティがつくられます。この振る舞いを実装するために、PHPは既に __set が呼び出しているかどうかを記憶しておくという再帰保護機能を使っています。このような保護機能は、プロパティ名と zend_guard 構造体を対応付けした guards というハッシュテーブルに保持されています。

typedef struct _zend_guard {
    zend_bool in_get;
    zend_bool in_set;
    zend_bool in_unset;
    zend_bool in_isset;
    zend_bool dummy; /* sizeof(zend_guard) must not be equal to sizeof(void*) */
} zend_guard;