Skip to content

Zend: refactor zend_parse_arg_class() so that it can be reused #23104

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Girgias wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Zend: refactor zend_parse_arg_class() so that it can be reused #23104

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
10a9bf7
Zend: refactor zend_parse_arg_class() so that it can be reused
Girgias Aug 4, 2026
6946594
fix format
Girgias Aug 24, 2026
c9d613f
fix type
Girgias Aug 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
187 changes: 94 additions & 93 deletions Zend/zend_API.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,48 +225,6 @@ ZEND_API ZEND_COLD void ZEND_FASTCALL zend_wrong_parameters_count_error(uint32_t
}
/* }}} */

ZEND_API ZEND_COLD void ZEND_FASTCALL zend_wrong_parameter_error(zpp_error error_code, uint32_t num, char *name, zend_expected_type expected_type, const zval *arg) /* {{{ */
{
switch (error_code) {
case ZPP_ERROR_WRONG_CALLBACK:
zend_wrong_callback_error(num, name);
break;
case ZPP_ERROR_WRONG_CALLBACK_OR_NULL:
zend_wrong_callback_or_null_error(num, name);
break;
case ZPP_ERROR_WRONG_CLASS:
zend_wrong_parameter_class_error(num, name, arg);
break;
case ZPP_ERROR_WRONG_CLASS_OR_NULL:
zend_wrong_parameter_class_or_null_error(num, name, arg);
break;
case ZPP_ERROR_WRONG_CLASS_OR_STRING:
zend_wrong_parameter_class_or_string_error(num, name, arg);
break;
case ZPP_ERROR_WRONG_CLASS_OR_STRING_OR_NULL:
zend_wrong_parameter_class_or_string_or_null_error(num, name, arg);
break;
case ZPP_ERROR_WRONG_CLASS_OR_LONG:
zend_wrong_parameter_class_or_long_error(num, name, arg);
break;
case ZPP_ERROR_WRONG_CLASS_OR_LONG_OR_NULL:
zend_wrong_parameter_class_or_long_or_null_error(num, name, arg);
break;
case ZPP_ERROR_WRONG_ARG:
zend_wrong_parameter_type_error(num, expected_type, arg);
break;
case ZPP_ERROR_UNEXPECTED_EXTRA_NAMED:
zend_unexpected_extra_named_error();
break;
case ZPP_ERROR_FAILURE:
ZEND_ASSERT(EG(exception) && "Should have produced an error already");
break;
case ZPP_ERROR_OK:
ZEND_UNREACHABLE();
}
}
/* }}} */

ZEND_API ZEND_COLD void ZEND_FASTCALL zend_wrong_parameter_type_error(uint32_t num, zend_expected_type expected_type, const zval *arg) /* {{{ */
{
static const char * const expected_error[] = {
Expand Down Expand Up @@ -358,6 +316,34 @@ ZEND_API ZEND_COLD void ZEND_FASTCALL zend_wrong_parameter_class_or_string_or_nu
}
/* }}} */

static ZEND_COLD void ZEND_FASTCALL zend_wrong_class_name_error(uint32_t num, const char *name, const zval *arg)
{
if (EG(exception)) {
return;
}

if (name && Z_TYPE_P(arg) == IS_STRING) {
zend_argument_type_error(num, "must be a class name derived from %s, \"%s\" given", name, Z_STRVAL_P(arg));
return;
}

zend_wrong_parameter_type_error(num, Z_EXPECTED_CLASS_NAME, arg);
}

static ZEND_COLD void ZEND_FASTCALL zend_wrong_class_name_or_null_error(uint32_t num, const char *name, const zval *arg)
{
if (EG(exception)) {
return;
}

if (name && Z_TYPE_P(arg) == IS_STRING) {
zend_argument_type_error(num, "must be a class name derived from %s, \"%s\" given", name, Z_STRVAL_P(arg));
return;
}

zend_wrong_parameter_type_error(num, Z_EXPECTED_CLASS_NAME_OR_NULL, arg);
}

ZEND_API ZEND_COLD void ZEND_FASTCALL zend_wrong_callback_error(uint32_t num, char *error) /* {{{ */
{
if (!EG(exception)) {
Expand All @@ -376,6 +362,54 @@ ZEND_API ZEND_COLD void ZEND_FASTCALL zend_wrong_callback_or_null_error(uint32_t
}
/* }}} */

ZEND_API ZEND_COLD void ZEND_FASTCALL zend_wrong_parameter_error(zpp_error error_code, uint32_t num, char *name, zend_expected_type expected_type, const zval *arg) /* {{{ */
{
switch (error_code) {
case ZPP_ERROR_WRONG_CALLBACK:
zend_wrong_callback_error(num, name);
break;
case ZPP_ERROR_WRONG_CALLBACK_OR_NULL:
zend_wrong_callback_or_null_error(num, name);
break;
case ZPP_ERROR_WRONG_CLASS_NAME:
zend_wrong_class_name_error(num, name, arg);
break;
case ZPP_ERROR_WRONG_CLASS_NAME_OR_NULL:
zend_wrong_class_name_or_null_error(num, name, arg);
break;
case ZPP_ERROR_WRONG_CLASS:
zend_wrong_parameter_class_error(num, name, arg);
break;
case ZPP_ERROR_WRONG_CLASS_OR_NULL:
zend_wrong_parameter_class_or_null_error(num, name, arg);
break;
case ZPP_ERROR_WRONG_CLASS_OR_STRING:
zend_wrong_parameter_class_or_string_error(num, name, arg);
break;
case ZPP_ERROR_WRONG_CLASS_OR_STRING_OR_NULL:
zend_wrong_parameter_class_or_string_or_null_error(num, name, arg);
break;
case ZPP_ERROR_WRONG_CLASS_OR_LONG:
zend_wrong_parameter_class_or_long_error(num, name, arg);
break;
case ZPP_ERROR_WRONG_CLASS_OR_LONG_OR_NULL:
zend_wrong_parameter_class_or_long_or_null_error(num, name, arg);
break;
case ZPP_ERROR_WRONG_ARG:
zend_wrong_parameter_type_error(num, expected_type, arg);
break;
case ZPP_ERROR_UNEXPECTED_EXTRA_NAMED:
zend_unexpected_extra_named_error();
break;
case ZPP_ERROR_FAILURE:
ZEND_ASSERT(EG(exception) && "Should have produced an error already");
break;
case ZPP_ERROR_OK:
ZEND_UNREACHABLE();
}
}
/* }}} */

ZEND_API ZEND_COLD void ZEND_FASTCALL zend_unexpected_extra_named_error(void)
{
const char *space;
Expand Down Expand Up @@ -494,41 +528,36 @@ ZEND_API ZEND_COLD void zend_class_redeclaration_error(int type, const zend_clas
zend_class_redeclaration_error_ex(type, old_ce->name, old_ce);
}

ZEND_API bool ZEND_FASTCALL zend_parse_arg_class(zval *arg, zend_class_entry **pce, uint32_t num, bool check_null) /* {{{ */
ZEND_API bool ZEND_FASTCALL zend_parse_arg_class(zval *arg, zend_class_entry **pce, uint32_t num, bool check_null)
{
const zend_class_entry *ce_base = *pce;

if (check_null && Z_TYPE_P(arg) == IS_NULL) {
*pce = NULL;
return 1;
return true;
}
/* Only accept string and Stringable(?) as int/foat/bool are not valid class names */
if (UNEXPECTED(Z_TYPE_P(arg) != IS_STRING)) {
if (Z_TYPE_P(arg) != IS_OBJECT || !zend_parse_arg_str_slow(arg, num)) {
*pce = NULL;
zend_wrong_parameter_type_error(num, check_null ? Z_EXPECTED_CLASS_NAME_OR_NULL : Z_EXPECTED_CLASS_NAME, arg);
return 0;
return false;
}
/* Object was converted to string */
ZEND_ASSERT(Z_TYPE_P(arg) == IS_STRING);
}
zend_string *class_name = Z_STR_P(arg);

*pce = zend_lookup_class(class_name);
if (ce_base) {
if ((!*pce || !instanceof_function(*pce, ce_base))) {
zend_argument_type_error(num, "must be a class name derived from %s, \"%s\" given", ZSTR_VAL(ce_base->name), ZSTR_VAL(class_name));
*pce = NULL;
return 0;
}
}
if (!*pce) {
zend_wrong_parameter_type_error(num, check_null ? Z_EXPECTED_CLASS_NAME_OR_NULL : Z_EXPECTED_CLASS_NAME, arg);
return 0;
return false;
}
return 1;
if (ce_base && !instanceof_function(*pce, ce_base)) {
*pce = NULL;
return false;
}
return true;
}
/* }}} */

static ZEND_COLD bool zend_null_arg_deprecated(const char *fallback_type, uint32_t arg_num) {
const zend_function *func = zend_active_function();
Expand Down Expand Up @@ -1022,41 +1051,10 @@ static zend_expected_type zend_parse_arg_impl(zval *arg, va_list *va, const char
zend_class_entry **pce = va_arg(*va, zend_class_entry **);
const zend_class_entry *ce_base = *pce;

if (check_null && Z_TYPE_P(arg) == IS_NULL) {
*pce = NULL;
break;
}

/* Only accept string and Stringable(?) as int/foat/bool are not valid class names */
if (UNEXPECTED(Z_TYPE_P(arg) != IS_STRING)) {
if (Z_TYPE_P(arg) != IS_OBJECT || !zend_parse_arg_str_slow(arg, arg_num)) {
/* __toString may throw */
if (!EG(exception)) {
zend_spprintf(error, 0, "must be a valid class name%s, %s given",
check_null ? " or null" : "", zend_zval_value_name(arg));
}
*pce = NULL;
return check_null ? Z_EXPECTED_CLASS_NAME_OR_NULL : Z_EXPECTED_CLASS_NAME;
}
/* Object was converted to string */
ZEND_ASSERT(Z_TYPE_P(arg) == IS_STRING);
}
zend_string *class_name = Z_STR_P(arg);

*pce = zend_lookup_class(class_name);
if (ce_base) {
if ((!*pce || !instanceof_function(*pce, ce_base))) {
zend_spprintf(error, 0, "must be a class name derived from %s%s, \"%s\" given",
ZSTR_VAL(ce_base->name), check_null ? " or null" : "", Z_STRVAL_P(arg));
*pce = NULL;
return check_null ? Z_EXPECTED_CLASS_NAME_OR_NULL : Z_EXPECTED_CLASS_NAME;
}
}
if (!*pce) {
*error = *pce ? ZSTR_VAL(ce_base->name) : NULL;
if (!zend_parse_arg_class(arg, pce, arg_num, check_null)) {
return check_null ? Z_EXPECTED_CLASS_NAME_OR_NULL : Z_EXPECTED_CLASS_NAME;
}
break;

}
break;

Expand Down Expand Up @@ -1135,18 +1133,21 @@ static zend_result zend_parse_arg(uint32_t arg_num, zval *arg, va_list *va, cons
zend_wrong_callback_or_null_error(arg_num, error);
break;
case Z_EXPECTED_CLASS_NAME:
/* DO NOT FREE error: it's a pointer to ZSTR_VAL(ce->name) */
zend_wrong_class_name_error(arg_num, error, arg);
break;
case Z_EXPECTED_CLASS_NAME_OR_NULL:
zend_argument_type_error(arg_num, "%s", error);
efree(error);
/* DO NOT FREE error: it's a pointer to ZSTR_VAL(ce->name) */
zend_wrong_class_name_or_null_error(arg_num, error, arg);
break;
default:
ZEND_UNREACHABLE();
}
}
zend_wrong_parameter_type_error(arg_num, expected_type, arg);
} else if (error
/* DO NOT FREE error when it's a pointer to ZSTR_VAL(ce->name) */
&& expected_type != Z_EXPECTED_OBJECT && expected_type != Z_EXPECTED_OBJECT_OR_NULL) {
/* Only free error if it's a callable expected type, as otherwise it's a pointer to ZSTR_VAL(ce->name) */
&& (expected_type == Z_EXPECTED_FUNC || expected_type == Z_EXPECTED_FUNC_OR_NULL)) {
efree(error);
}

Expand Down
8 changes: 6 additions & 2 deletions Zend/zend_API.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1590,6 +1590,9 @@ C23_ENUM(zpp_error, uint8_t) {
ZPP_ERROR_OK,
ZPP_ERROR_FAILURE,
ZPP_ERROR_WRONG_CALLBACK,
ZPP_ERROR_WRONG_CALLBACK_OR_NULL,
ZPP_ERROR_WRONG_CLASS_NAME,
ZPP_ERROR_WRONG_CLASS_NAME_OR_NULL,
ZPP_ERROR_WRONG_CLASS,
ZPP_ERROR_WRONG_CLASS_OR_NULL,
ZPP_ERROR_WRONG_CLASS_OR_STRING,
Expand All @@ -1598,7 +1601,6 @@ C23_ENUM(zpp_error, uint8_t) {
ZPP_ERROR_WRONG_CLASS_OR_LONG_OR_NULL,
ZPP_ERROR_WRONG_ARG,
ZPP_ERROR_UNEXPECTED_EXTRA_NAMED,
ZPP_ERROR_WRONG_CALLBACK_OR_NULL,
};

ZEND_API ZEND_COLD void ZEND_FASTCALL zend_wrong_parameters_none_error(void);
Expand Down Expand Up @@ -1767,8 +1769,10 @@ ZEND_API ZEND_COLD void zend_class_redeclaration_error_ex(int type, zend_string
/* old "C" */
#define Z_PARAM_CLASS_EX(dest, check_null, deref) \
Z_PARAM_PROLOGUE(deref, 0); \
_error = dest ? ZSTR_VAL((dest)->name) : NULL; \

@arnaud-lb arnaud-lb Aug 25, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we avoid saving this in the non-error case? This increases code size and the load adds overhead.

We could change zend_parse_arg_class() so that it returns a zend_class_entry* or NULL. This way we don't need to take the address of dest, which is inline with previous refactorings:

zend_class_entry *ce = dest;
dest = zend_parse_arg_class(_arg, ce, _i, check_null);
if (UNEXPECTED(!dest)) {
    _error = ce ? ZSTR_VAL(ce->name) : NULL;
    ...
}

@Girgias Girgias Aug 25, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That should work yeah. Those semantics will be quite weird.

I do think we should get rid of the "derived from" behaviour and introduce a custom FastZPP specifier for it that takes the CE explicitly rather than re-using the pointer for two different things. But that'll need to wait for PHP next I think as this affects extensions in non obvious ways.

@arnaud-lb arnaud-lb Aug 25, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's what zend_parse_arg_class() does in my code snippet :) (no re-use, ce is explicit). The semantics of Z_PARAM_CLASS_EX() doesn't change however.

if (UNEXPECTED(!zend_parse_arg_class(_arg, &dest, _i, check_null))) { \
_error_code = ZPP_ERROR_FAILURE; \
_expected_type = check_null ? Z_EXPECTED_CLASS_NAME_OR_NULL : Z_EXPECTED_CLASS_NAME; \
_error_code = check_null ? ZPP_ERROR_WRONG_CLASS_NAME_OR_NULL : ZPP_ERROR_WRONG_CLASS_NAME; \
break; \
}

Expand Down
Loading