PECL operator で演算子オーバーロード

PECL operator で演算子オーバーロード
内山雄司 (@y__uti)
2018-06-15 PHPカンファレンス福岡非公式前夜祭

自己紹介
内山雄司 (@y__uti)
◦ http://y-uti.hatenablog.jp/ (phpusers-ja)
◦ 東京方面から来ました
仕事
◦ 受託開発の会社 (株式会社ピコラボ) でプログラマをしています
興味
◦ プログラミング言語処理系
◦ 機械学習
2018-06-15 PHPカンファレンス福岡非公式前夜祭 2

きっかけ
今年の 1 月頃に Stack Overflow に投稿された質問
https://stackoverflow.com/questions/48270127/can-a-1-a-2-a-3-ever-evaluate-to-true

解答例
toString をオーバーライドする方法

解答例
with を使って getter を定義する方法

解答例
「見えない文字」を変数名に含める方法
◦ 3 箇所の a はすべて異なる変数
◦ HALFWIDTH HANGUL FILLER (U+FFA0) だそうです

解答例
== 演算子をオーバーロードする方法 (Ruby, Python での解答)
Ruby Python

我らが PHP では？
Can
($a==1 && $a==2 && $a==3)
ever evaluate to true?

解答例 (PHP の場合)
悩むまでもなかった。
$a = true;
if ($a == 1 && $a == 2 && $a == 3) {
echo "Hello, world!¥n";
}
http://php.net/manual/ja/language.operators.comparison.php

我らが PHP では？ (改)
Can
($a==0 && $a==1 && $a==2)
ever evaluate to true?
今度はむずかしいぞ！・・・というか無理 (だと思う)

PECL operator
演算子オーバーロードを可能にする拡張モジュール
https://pecl.php.net/package/operator
GitHub リポジトリで PHP 7 対応版も公開されています
https://github.com/php/pecl-php-operator

解答例 (operator 拡張モジュールを利用)
== 演算子をオーバーロードする方法 (PHP での解答)
class A {
public function __is_equal($other) {
return true;
}
}
$a = new A();
if ($a == 0 && $a == 1 && $a == 2) {
echo "Don't do this!¥n";
}

定義可能な演算子
オーバーロードできる演算子の一覧

実現方法 [1/2]
バイトコード命令の処理を置き換え
static int op_handler(zend_execute_data *execute_data) {
...
}
◦ zend_set_user_opcode_handler 関数
◦ ユーザが定義した関数をバイトコード命令ハンドラに設定する
static PHP_MINIT_FUNCTION(operator) {
...
zend_set_user_opcode_handler(ZEND_IS_EQUAL, op_handler);
...
}

実現方法 [1/2]
バイトコード命令の処理を置き換え
...
}
◦ zend_set_user_opcode_handler 関数
◦ ユーザが定義した関数をバイトコード命令ハンドラに設定する
static PHP_MINIT_FUNCTION(operator) {
...
zend_set_user_opcode_handler(ZEND_IS_EQUAL, op_handler);
...
}
この命令の処理をこの関数に任せる

実現方法 [2/2]
メソッドが定義されていたら呼び出す
...
if ((Z_TYPE_P(op1) != IS_OBJECT) ||
!operator_get_method(method, op1, &fci, &fcc)) {
return ZEND_USER_OPCODE_DISPATCH;
}
...
if (FAILURE == zend_call_function(&fci, &fcc)) { ... }
...
return ZEND_USER_OPCODE_CONTINUE;
}

実現方法 [2/2]
メソッドが定義されていたら呼び出す
...
if ((Z_TYPE_P(op1) != IS_OBJECT) ||
!operator_get_method(method, op1, &fci, &fcc)) {
return ZEND_USER_OPCODE_DISPATCH;
}
...
if (FAILURE == zend_call_function(&fci, &fcc)) { ... }
...
return ZEND_USER_OPCODE_CONTINUE;
}
オーバーロードされていなければ本来の処理を実行
メソッドを実行して次のバイトコード命令に進む

とはいえ
実用に耐えるものではなく・・・

さまざまな問題 [1/3]
実行速度の低下
$a = 1;
$b = 1;
for ($i = 0; $i < 50000000; ++$i) {
$a == $b;
}
Intel Core i5-3337U 1.80GHz
2GB Memory
CentOS 7 (VM on Windows7)
各 5 回の実行の平均
0.979
4.816
0.0
1.0
2.0
3.0
4.0
5.0
6.0
PHP 7.2.6 PHP 7.2.6 + operator
実行時間[秒]

ユーザ定義命令ハンドラの衝突
たとえば Xdebug と共存できない
...
XDEBUG_SET_OPCODE_OVERRIDE_COMMON(ZEND_IS_EQUAL);
...
https://github.com/xdebug/xdebug/blob/master/xdebug.c より抜粋

演算子に対応するバイトコード命令があるとは限らない
たとえば $a > $b
__is_greater() and __is_greater_or_equal() require a rebuild of the main PHP runtime
using the included patch. Without this patch, $a > $b is automatically remapped to $b < $a
by the engine.
◦ PHP ではコンパイラが $a > $b を $b < $a に変換する
◦ PECL operator では元々どちらだったかを記録することで対処

別のアプローチ

zend_object_handlers
拡張モジュールで自作したクラスの比較方法は自由に定義できる
struct _zend_object_handlers {
...
zend_object_compare_t compare_objects;
...
};
◦ オブジェクトの比較で compare_objects に設定された関数が呼ばれる
http://php.net/manual/ja/language.oop5.object-comparison.php

DateTime の例
DateTime オブジェクトの比較
<?php
$utc = new DateTime('2017-01-01 00:00:00 UTC');
$jst = new DateTime('2017-01-01 09:00:00 JST');
echo ($utc == $jst ? 1 : 0), "¥n"; // 1 が出力される
◦ タイムゾーンが違っても同じ日時なら等しい
◦ PHP では "==" の挙動は変えられない
◦ 拡張モジュールで定義しているクラスだからできる

DateTime の例 (内部実装)
date_object_compare_date 関数で比較するように設定している
static void date_register_classes(void) {
...
INIT_CLASS_ENTRY(ce_date, "DateTime", date_funcs_date);
...
date_object_handlers_date.compare_objects = date_object_compare_date;
...
}
static int date_object_compare_date(zval *d1, zval *d2) {
php_date_obj *o1 = Z_PHPDATE_P(d1);
php_date_obj *o2 = Z_PHPDATE_P(d2);
...
return timelib_time_compare(o1->time, o2->time);
}
https://github.com/php/php-src/blob/master/ext/date/php_date.c
オブジェクトの比較をこの関数に任せる

Comparable interface for PHP
https://github.com/nikic/comparable
このアプローチで Comparable インタフェースを定義
<?php
class MyClass implements Comparable
{
public static function compare($a, $b) {
...
}
}
◦ Comparable インタフェースを実装するクラスを定義する
◦ そのクラスのオブジェクトの比較では compare メソッドが使われる

これは実用になる？
そういう感じではない
Note: This is to the most part just code demonstrating the implementation of a magic interface
for a tutorial. I do not currently plan on proposing including such an interface for PHP itself.
https://github.com/nikic/comparable
いくつかの問題
◦ そもそも上記のとおり実用を意図していない
◦ PHP 7 に対応していない
◦ 比較演算しか変えられない
◦ この拡張を真似して実装しても任意の演算子の処理を定義できるようにはならない
◦ zend_object_handlers で管理されている操作だけ

まとめ
素直に equals メソッドを定義しましょう

PECL operator で演算子オーバーロード

Recommended

Recommended

More Related Content

What's hot

What's hot (20)

Similar to PECL operator で演算子オーバーロード

Similar to PECL operator で演算子オーバーロード (20)

More from y-uti

More from y-uti (20)

Recently uploaded

Recently uploaded (9)

PECL operator で演算子オーバーロード