[php-src を読む] DateTimeInterface オブジェクト比較編
この記事は PHP Advent Calendar 2023 14 日目の記事です。
初めに結論
DateTimeInterface オブジェクトの比較演算子はオーバーライドされていて、DateTimeInterface オブジェクト同士を比較するときはオブジェクトが持つ日付と時間を利用します。
環境とスクリプト
こちらの記事で作成した環境を利用します。
実行する PHP スクリプトは以下です。
<?php
new DateTime() <= new DateTime();
ソースコードを読んでいく
あたりをつける
GDB を利用して処理を追っていきます。
いちから処理を追うのは大変なので、ブレークポイントを設定するコードのあたりをつけます。
今回は <= から比較処理を探してみます。
ソースコード上を検索して探すことも可能ですが、検索に引っかかる数が多すぎるので、PHP マニュアルのパーサトークンの一覧から探します。
<= は T_IS_SMALLER_OR_EQUAL という名前で定義されてるようなので、これをソースコードから探します。
T_IS_SMALLER_OR_EQUAL
T_IS_SMALLER_OR_EQUAL は Zend/zend_language_parser.y に定義されています。
%token T_IS_SMALLER_OR_EQUAL "'<='"
また、規則部には <= が使われたときのアクションも記載されています。
ここで出てきた ZEND_IS_SMALLER_OR_EQUAL を検索してみます。
| expr T_IS_SMALLER_OR_EQUAL expr
{ $$ = zend_ast_create_binary_op(ZEND_IS_SMALLER_OR_EQUAL, $1, $3); }
ZEND_IS_SMALLER_OR_EQUAL
ZEND_IS_SMALLER_OR_EQUAL は Zend/zend_opcode.c に定義してある get_binary_op 関数で使われています。
次はこの関数で返却している is_smaller_or_equal_function を検索します。
ZEND_API binary_op_type get_binary_op(int opcode)
{
switch (opcode) {
// 省略
case ZEND_IS_SMALLER_OR_EQUAL:
return (binary_op_type) is_smaller_or_equal_function;
// 省略
}
}
is_smaller_or_equal_function 関数
is_smaller_or_equal_function 関数は Zend/zend_operators.c にあります。
次は zend_compare 関数を探します。
ZEND_API zend_result ZEND_FASTCALL is_smaller_or_equal_function(zval *result, zval *op1, zval *op2) /* {{{ */
{
ZVAL_BOOL(result, (zend_compare(op1, op2) <= 0));
return SUCCESS;
}
/* }}} */
zend_compare 関数
zend_compare 関数は is_smaller_or_equal_function 関数と同じく、Zend/zend_operators.c にあります。
この関数に渡された 2 つの引数の型に応じて比較をしているようです。
今回はどちらもオブジェクトなので、 Z_TYPE_P() の結果が IS_OBJECT になると予想されます。
ここまできたら、GDB でデバッグするためにブレークポイントを設定し、実際にデバッグをします。
ZEND_API int ZEND_FASTCALL zend_compare(zval *op1, zval *op2) /* {{{ */
{
int converted = 0;
zval op1_copy, op2_copy;
while (1) {
switch (TYPE_PAIR(Z_TYPE_P(op1), Z_TYPE_P(op2))) {
// 省略
default:
if (Z_ISREF_P(op1)) {
op1 = Z_REFVAL_P(op1);
continue;
} else if (Z_ISREF_P(op2)) {
op2 = Z_REFVAL_P(op2);
continue;
}
if (Z_TYPE_P(op1) == IS_OBJECT
&& Z_TYPE_P(op2) == IS_OBJECT
&& Z_OBJ_P(op1) == Z_OBJ_P(op2)) {
return 0;
} else if (Z_TYPE_P(op1) == IS_OBJECT) {
return Z_OBJ_HANDLER_P(op1, compare)(op1, op2); // 今回はここにブレークポイントを設定する
} else if (Z_TYPE_P(op2) == IS_OBJECT) {
return Z_OBJ_HANDLER_P(op2, compare)(op1, op2);
}
// 省略
}
}
}
/* }}} */
GDB でデバッグ
return Z_OBJ_HANDLER_P(op1, compare)(op1, op2); にブレークポイントを設定し、PHP スクリプトを実行します。
ブレークポイントを設定したところで処理が止まったので、ステップイン実行で比較処理の中身を見ていきます。
ステップイン実行すると、date_object_compare_date 関数に飛びます。
なぜ date_object_compare_date 関数が実行されるのか
Z_OBJ_HANDLER_P() は第一引数の構造体が持つ第二引数のメンバを返します。
今回の場合、op1 の compare には date_object_compare_date 関数がセットされています。
そのため、ステップ実行すると date_object_compare_date 関数に飛びます。
date_object_compare_date は DateTimeInterface オブジェクトがインスタンス化するときにセットされます。
static void date_register_classes(void) /* {{{ */
{
date_ce_interface = register_class_DateTimeInterface();
date_ce_interface->interface_gets_implemented = implement_date_interface_handler;
date_ce_date = register_class_DateTime(date_ce_interface);
date_ce_date->create_object = date_object_new_date;
date_ce_date->default_object_handlers = &date_object_handlers_date;
memcpy(&date_object_handlers_date, &std_object_handlers, sizeof(zend_object_handlers));
date_object_handlers_date.offset = XtOffsetOf(php_date_obj, std);
date_object_handlers_date.free_obj = date_object_free_storage_date;
date_object_handlers_date.clone_obj = date_object_clone_date;
date_object_handlers_date.compare = date_object_compare_date; // ここでセットしている
date_object_handlers_date.get_properties_for = date_object_get_properties_for;
date_object_handlers_date.get_gc = date_object_get_gc;
// 省略
} /* }}} */
date_object_compare_date 関数
ここでは引数を php_date_obj に変換しています。
実際の比較は timelib_time_compare 関数が担っています。
static int date_object_compare_date(zval *d1, zval *d2) /* {{{ */
{
php_date_obj *o1;
php_date_obj *o2;
ZEND_COMPARE_OBJECTS_FALLBACK(d1, d2);
o1 = Z_PHPDATE_P(d1);
o2 = Z_PHPDATE_P(d2);
if (!o1->time || !o2->time) {
zend_throw_error(date_ce_date_object_error, "Trying to compare an incomplete DateTime or DateTimeImmutable object");
return ZEND_UNCOMPARABLE;
}
if (!o1->time->sse_uptodate) {
timelib_update_ts(o1->time, o1->time->tz_info);
}
if (!o2->time->sse_uptodate) {
timelib_update_ts(o2->time, o2->time->tz_info);
}
return timelib_time_compare(o1->time, o2->time);
} /* }}} */
timelib_time_compare 関数
timelib_time_compare 関数は ext/date/lib/timelib.c に定義してあります。
ここで構造体のメンバである UNIX タイムスタンプとマイクロ秒を使い比較をしています。
int timelib_time_compare(timelib_time *t1, timelib_time *t2)
{
if (t1->sse == t2->sse) { // UNIX タイムスタンプの比較
if (t1->us == t2->us) { // マイクロ秒の比較
return 0;
}
return (t1->us < t2->us) ? -1 : 1;
}
return (t1->sse < t2->sse) ? -1 : 1;
}
Discussion