Skip to content

Add zend_argument_type_error_ex, zend_argument_error_ex #21829

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
arnaud-lb wants to merge 2 commits into
base: master
Choose a base branch
from
+50 −15
Open

Add zend_argument_type_error_ex, zend_argument_error_ex #21829

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
add4d02
Add zend_argument_type_error_ex, zend_argument_error_ex
arnaud-lb Apr 22, 2026
2fd627d
Reduce API surface
arnaud-lb May 6, 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
39 changes: 32 additions & 7 deletions Zend/zend_API.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -374,7 +374,9 @@ ZEND_API ZEND_COLD void ZEND_FASTCALL zend_unexpected_extra_named_error(void)
);
}

ZEND_API ZEND_COLD void ZEND_FASTCALL zend_argument_error_variadic(zend_class_entry *error_ce, uint32_t arg_num, const char *format, va_list va) /* {{{ */
Comment thread
TimWolla marked this conversation as resolved.
ZEND_API ZEND_COLD void ZEND_FASTCALL zend_argument_error_variadic(
const zend_function *function, uint32_t arg_num,
zend_class_entry *error_ce, const char *format, va_list va)
Comment on lines +377 to +379
Copy link
Copy Markdown
Member

@TimWolla TimWolla May 6, 2026

Choose a reason for hiding this comment

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

Suggested change
ZEND_API ZEND_COLD void ZEND_FASTCALL zend_argument_error_variadic(
const zend_function *function, uint32_t arg_num,
zend_class_entry *error_ce, const char *format, va_list va)
ZEND_API ZEND_COLD void ZEND_FASTCALL zend_argument_error_variadic(
const zend_function *function, zend_class_entry *error_ce,
uint32_t arg_num, const char *format, va_list va)

{
zend_string *func_name;
const char *arg_name;
Expand All @@ -383,8 +385,8 @@ ZEND_API ZEND_COLD void ZEND_FASTCALL zend_argument_error_variadic(zend_class_en
return;
}

func_name = get_active_function_or_method_name();
arg_name = get_active_function_arg_name(arg_num);
func_name = get_function_or_method_name(function);
arg_name = get_function_arg_name(function, arg_num);

zend_vspprintf(&message, 0, format, va);
zend_throw_error(error_ce, "%s(): Argument #%d%s%s%s %s",
Expand All @@ -394,34 +396,57 @@ ZEND_API ZEND_COLD void ZEND_FASTCALL zend_argument_error_variadic(zend_class_en
efree(message);
zend_string_release(func_name);
}
/* }}} */

ZEND_API ZEND_COLD void zend_argument_error_ex(const zend_function *function,
uint32_t arg_num, zend_class_entry *error_ce, const char *format, ...)
Comment on lines +400 to +401
Copy link
Copy Markdown
Member

@TimWolla TimWolla May 6, 2026

Choose a reason for hiding this comment

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

I'm only noticing now that error_ce and arg_num are flipped compared to the existing zend_argument_error(). That should be adjusted.

Suggested change
ZEND_API ZEND_COLD void zend_argument_error_ex(const zend_function *function,
uint32_t arg_num, zend_class_entry *error_ce, const char *format, ...)
ZEND_API ZEND_COLD void zend_argument_error_ex(const zend_function *function,
zend_class_entry *error_ce, uint32_t arg_num, const char *format, ...)

Copy link
Copy Markdown
Member Author

@arnaud-lb arnaud-lb May 7, 2026

Choose a reason for hiding this comment

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

Could you explain why? Is it to match the order of the non-_ex function?

function and arg_num are related, so grouping them would make sense.

Looking at other format-and-throw functions, extra args tend to be grouped in between ce and format:

zend_object *zend_throw_exception(zend_class_entry *exception_ce, const char *message, zend_long code);
zend_object *zend_throw_exception_ex(zend_class_entry *exception_ce, zend_long code, const char *format, ...);
void ZEND_FASTCALL zend_argument_error_variadic(zend_class_entry *error_ce, uint32_t arg_num, const char *format, va_list va);

void zend_argument_error(zend_class_entry *error_ce, uint32_t arg_num, const char *format, ...);

What do you think of this?

Suggested change
ZEND_API ZEND_COLD void zend_argument_error_ex(const zend_function *function,
uint32_t arg_num, zend_class_entry *error_ce, const char *format, ...)
ZEND_API ZEND_COLD void zend_argument_error_ex(zend_class_entry *error_ce,
const zend_function *function, uint32_t arg_num, const char *format, ...)

Copy link
Copy Markdown
Member

@TimWolla TimWolla May 7, 2026

Choose a reason for hiding this comment

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

Is it to match the order of the non-_ex function?

Yes, my motivation was making this consistent with the existing non-_ex zend_argument_error(). Changing the argument order of that one would would be too impactful, I feel. That's why I suggested adjusting the new functions for consistency with their direct sibling, rather than zend_throw_exception.

{
va_list va;

va_start(va, format);
zend_argument_error_variadic(function, arg_num, error_ce, format, va);
Copy link
Copy Markdown
Member

@TimWolla TimWolla May 6, 2026

Choose a reason for hiding this comment

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

Suggested change
zend_argument_error_variadic(function, arg_num, error_ce, format, va);
zend_argument_error_variadic(function, error_ce, arg_num, format, va);

va_end(va);
}

ZEND_API ZEND_COLD void zend_argument_error(zend_class_entry *error_ce, uint32_t arg_num, const char *format, ...) /* {{{ */
{
va_list va;
const zend_function *function = zend_active_function();

va_start(va, format);
zend_argument_error_variadic(error_ce, arg_num, format, va);
zend_argument_error_variadic(function, arg_num, error_ce, format, va);
Copy link
Copy Markdown
Member

@TimWolla TimWolla May 6, 2026

Choose a reason for hiding this comment

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

Suggested change
zend_argument_error_variadic(function, arg_num, error_ce, format, va);
zend_argument_error_variadic(function, error_ce, arg_num, format, va);

va_end(va);
}
/* }}} */

ZEND_API ZEND_COLD void zend_argument_type_error_ex(
const zend_function *function, uint32_t arg_num,
const char *format, ...)
{
va_list va;

va_start(va, format);
zend_argument_error_variadic(function, arg_num, zend_ce_type_error, format, va);
Copy link
Copy Markdown
Member

@TimWolla TimWolla May 6, 2026

Choose a reason for hiding this comment

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

Suggested change
zend_argument_error_variadic(function, arg_num, zend_ce_type_error, format, va);
zend_argument_error_variadic(function, zend_ce_type_error, arg_num, format, va);

va_end(va);
}

ZEND_API ZEND_COLD void zend_argument_type_error(uint32_t arg_num, const char *format, ...) /* {{{ */
{
va_list va;
const zend_function *function = zend_active_function();

va_start(va, format);
zend_argument_error_variadic(zend_ce_type_error, arg_num, format, va);
zend_argument_error_variadic(function, arg_num, zend_ce_type_error, format, va);
Copy link
Copy Markdown
Member

@TimWolla TimWolla May 6, 2026

Choose a reason for hiding this comment

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

Suggested change
zend_argument_error_variadic(function, arg_num, zend_ce_type_error, format, va);
zend_argument_error_variadic(function, zend_ce_type_error, arg_num, format, va);

va_end(va);
}
/* }}} */

ZEND_API ZEND_COLD void zend_argument_value_error(uint32_t arg_num, const char *format, ...) /* {{{ */
{
va_list va;
const zend_function *function = zend_active_function();

va_start(va, format);
zend_argument_error_variadic(zend_ce_value_error, arg_num, format, va);
zend_argument_error_variadic(function, arg_num, zend_ce_value_error, format, va);
Copy link
Copy Markdown
Member

@TimWolla TimWolla May 6, 2026

Choose a reason for hiding this comment

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

Suggested change
zend_argument_error_variadic(function, arg_num, zend_ce_value_error, format, va);
zend_argument_error_variadic(function, zend_ce_value_error, arg_num, format, va);

va_end(va);
}
/* }}} */
Expand Down
9 changes: 8 additions & 1 deletion Zend/zend_API.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1564,9 +1564,16 @@ ZEND_API ZEND_COLD void ZEND_FASTCALL zend_wrong_parameter_class_or_string_or_nu
ZEND_API ZEND_COLD void ZEND_FASTCALL zend_wrong_callback_error(uint32_t num, char *error);
ZEND_API ZEND_COLD void ZEND_FASTCALL zend_wrong_callback_or_null_error(uint32_t num, char *error);
ZEND_API ZEND_COLD void ZEND_FASTCALL zend_unexpected_extra_named_error(void);
ZEND_API ZEND_COLD void ZEND_FASTCALL zend_argument_error_variadic(zend_class_entry *error_ce, uint32_t arg_num, const char *format, va_list va);
ZEND_API ZEND_COLD void ZEND_FASTCALL zend_argument_error_variadic(
const zend_function *function, uint32_t arg_num,
zend_class_entry *error_ce, const char *format, va_list va);
ZEND_API ZEND_COLD void zend_argument_error(zend_class_entry *error_ce, uint32_t arg_num, const char *format, ...);
ZEND_API ZEND_COLD void zend_argument_error_ex(const zend_function *function,
uint32_t arg_num, zend_class_entry *error_ce, const char *format, ...);
ZEND_API ZEND_COLD void zend_argument_type_error(uint32_t arg_num, const char *format, ...);
ZEND_API ZEND_COLD void zend_argument_type_error_ex(
const zend_function *function, uint32_t arg_num,
const char *format, ...);
Comment on lines +1567 to +1576
Copy link
Copy Markdown
Member

@TimWolla TimWolla May 6, 2026

Choose a reason for hiding this comment

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

Suggested change
ZEND_API ZEND_COLD void ZEND_FASTCALL zend_argument_error_variadic(
const zend_function *function, uint32_t arg_num,
zend_class_entry *error_ce, const char *format, va_list va);
ZEND_API ZEND_COLD void zend_argument_error(zend_class_entry *error_ce, uint32_t arg_num, const char *format, ...);
ZEND_API ZEND_COLD void zend_argument_error_ex(const zend_function *function,
uint32_t arg_num, zend_class_entry *error_ce, const char *format, ...);
ZEND_API ZEND_COLD void zend_argument_type_error(uint32_t arg_num, const char *format, ...);
ZEND_API ZEND_COLD void zend_argument_type_error_ex(
const zend_function *function, uint32_t arg_num,
const char *format, ...);
ZEND_API ZEND_COLD void ZEND_FASTCALL zend_argument_error_variadic(
const zend_function *function, zend_class_entry *error_ce,
uint32_t arg_num, const char *format, va_list va);
ZEND_API ZEND_COLD void zend_argument_error(zend_class_entry *error_ce, uint32_t arg_num, const char *format, ...);
ZEND_API ZEND_COLD void zend_argument_error_ex(const zend_function *function,
zend_class_entry *error_ce, uint32_t arg_num, const char *format, ...);
ZEND_API ZEND_COLD void zend_argument_type_error(uint32_t arg_num, const char *format, ...);
ZEND_API ZEND_COLD void zend_argument_type_error_ex(
const zend_function *function, uint32_t arg_num,
const char *format, ...);

ZEND_API ZEND_COLD void zend_argument_value_error(uint32_t arg_num, const char *format, ...);
ZEND_API ZEND_COLD void zend_argument_must_not_be_empty_error(uint32_t arg_num);
ZEND_API ZEND_COLD void zend_class_redeclaration_error(int type, const zend_class_entry *old_ce);
Expand Down
5 changes: 3 additions & 2 deletions Zend/zend_vm_def.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8918,9 +8918,10 @@ ZEND_VM_HOT_HANDLER(211, ZEND_TYPE_ASSERT, CONST, ANY, NUM)
zend_arg_info *arginfo = &fbc->common.arg_info[argno - 1];

if (!zend_check_type(&arginfo->type, value, /* is_return_type */ false, /* is_internal */ true)) {
const char *param_name = get_function_arg_name(fbc, argno);
zend_string *expected = zend_type_to_string(arginfo->type);
zend_type_error("%s(): Argument #%d%s%s%s must be of type %s, %s given", ZSTR_VAL(fbc->common.function_name), argno, param_name ? " ($" : "", param_name ? param_name : "", param_name ? ")" : "", ZSTR_VAL(expected), zend_zval_value_name(value));
zend_argument_type_error_ex(fbc, argno,
"must be of type %s, %s given",
ZSTR_VAL(expected), zend_zval_value_name(value));
zend_string_release(expected);
}
}
Expand Down
10 changes: 6 additions & 4 deletions Zend/zend_vm_execute.h
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion ext/openssl/openssl.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -566,7 +566,7 @@ static void php_openssl_check_path_error(uint32_t arg_num, int type, const char
va_start(va, format);

if (type == E_ERROR) {
zend_argument_error_variadic(zend_ce_value_error, arg_num, format, va);
zend_argument_error_variadic(zend_active_function(), arg_num, zend_ce_value_error, format, va);
Copy link
Copy Markdown
Member

@TimWolla TimWolla May 6, 2026

Choose a reason for hiding this comment

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

Suggested change
zend_argument_error_variadic(zend_active_function(), arg_num, zend_ce_value_error, format, va);
zend_argument_error_variadic(zend_active_function(), zend_ce_value_error, arg_num, format, va);

} else {
arg_name = get_active_function_arg_name(arg_num);
php_verror(NULL, arg_name, type, format, va);
Expand Down
Loading