Skip to content

Zend: add new zend_object_init{_with_constructor}() API #24135

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 17 commits into
base: master
Choose a base branch
from
+257 −253
Open

Zend: add new zend_object_init{_with_constructor}() API #24135

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
93db860
Zend: assert that the object is a Throwable in zend_throw_exception_i…
Girgias Oct 14, 2026
7238c45
Zend: refactor _object_and_properties_init() to return zend_object*
Girgias Sep 30, 2026
c51ba83
Zend: add const qualifier to object API
Girgias Sep 30, 2026
04b5b01
Zend: add new zend_object_init() API
Girgias Sep 30, 2026
62b1370
Zend: migrate to new zend_object_init() API
Girgias Sep 30, 2026
e776a13
Zend: add zend_object_init_with_constructor() API
Girgias Oct 5, 2026
452f637
Zend: refactor zend_get_attribute_object() to return zend_object*
Girgias Oct 5, 2026
6ad8d6b
ftp: migrate to new zend_object_init() API
Girgias Sep 30, 2026
716e019
hash: migrate to new zend_object_init() API
Girgias Sep 30, 2026
98bf16f
pdo: migrate to new zend_object_init() API
Girgias Sep 30, 2026
7f4ef66
socket: migrate to new zend_object_init() API
Girgias Sep 30, 2026
0e40afd
shmop: migrate to new zend_object_init() API
Girgias Sep 30, 2026
d6f44c8
mysqli: migrate to new zend_object_init() API
Girgias Sep 30, 2026
02ead33
streams: migrate to new zend_object_init() API
Girgias Sep 30, 2026
2bdea0f
libxml: migrate to new zend_object_init() API
Girgias Sep 30, 2026
afd805f
phar: migrate to zend_object_init_with_constructor() API
Girgias Oct 5, 2026
203213a
spl: migrate to zend_object_init_with_constructor() API
Girgias Oct 5, 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
82 changes: 49 additions & 33 deletions Zend/zend_API.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1685,7 +1685,7 @@ ZEND_API zend_result zend_update_class_constants(zend_class_entry *ce) /* {{{ */
}
/* }}} */

static zend_always_inline void _object_properties_init(zend_object *object, zend_class_entry *ce) /* {{{ */
static zend_always_inline void _object_properties_init(zend_object *object, const zend_class_entry *ce) /* {{{ */
{
if (ce->default_properties_count) {
zval *src = CE_DEFAULT_PROPERTIES_TABLE(ce);
Expand All @@ -1712,7 +1712,7 @@ static zend_always_inline void _object_properties_init(zend_object *object, zend
}
/* }}} */

ZEND_API void object_properties_init(zend_object *object, zend_class_entry *ce) /* {{{ */
ZEND_API void object_properties_init(zend_object *object, const zend_class_entry *ce) /* {{{ */
{
object->properties = NULL;
_object_properties_init(object, ce);
Expand Down Expand Up @@ -1870,7 +1870,7 @@ ZEND_API void object_properties_load(zend_object *object, const HashTable *prope
* class and all props being public. If only a subset is given or the class
* has protected members then you need to merge the properties separately by
* calling zend_merge_properties(). */
static zend_always_inline zend_result _object_and_properties_init(zval *arg, zend_class_entry *ce, HashTable *properties) /* {{{ */
static zend_always_inline zend_object *_object_and_properties_init(zend_class_entry *ce, HashTable *properties) /* {{{ */
{
if (UNEXPECTED(ce->ce_flags & ZEND_ACC_UNINSTANTIABLE)) {
if (ce->ce_flags & ZEND_ACC_INTERFACE) {
Expand All @@ -1883,55 +1883,63 @@ static zend_always_inline zend_result _object_and_properties_init(zval *arg, zen
ZEND_ASSERT(ce->ce_flags & (ZEND_ACC_IMPLICIT_ABSTRACT_CLASS|ZEND_ACC_EXPLICIT_ABSTRACT_CLASS));
zend_throw_error(NULL, "Cannot instantiate abstract class %s", ZSTR_VAL(ce->name));
}
ZVAL_NULL(arg);
Z_OBJ_P(arg) = NULL;
return FAILURE;
return NULL;
}

if (UNEXPECTED(!(ce->ce_flags & ZEND_ACC_CONSTANTS_UPDATED))) {
if (UNEXPECTED(zend_update_class_constants(ce) != SUCCESS)) {
ZVAL_NULL(arg);
Z_OBJ_P(arg) = NULL;
return FAILURE;
return NULL;
}
}

if (ce->create_object == NULL) {
zend_object *obj = zend_objects_new(ce);

ZVAL_OBJ(arg, obj);
if (properties) {
object_properties_init_ex(obj, properties);
} else {
_object_properties_init(obj, ce);
}
return obj;
} else {
ZVAL_OBJ(arg, ce->create_object(ce));
return ce->create_object(ce);
}
return SUCCESS;
}
/* }}} */

ZEND_API zend_result object_and_properties_init(zval *arg, zend_class_entry *ce, HashTable *properties) /* {{{ */
{
return _object_and_properties_init(arg, ce, properties);
zend_object *obj = _object_and_properties_init(ce, properties);
if (UNEXPECTED(!obj)) {
ZVAL_NULL(arg);
return FAILURE;
}
ZVAL_OBJ(arg, obj);
return SUCCESS;
}
/* }}} */

ZEND_API zend_result object_init_ex(zval *arg, zend_class_entry *ce) /* {{{ */
{
return _object_and_properties_init(arg, ce, NULL);
zend_object *obj = _object_and_properties_init(ce, NULL);
if (UNEXPECTED(!obj)) {
ZVAL_NULL(arg);
return FAILURE;
}
ZVAL_OBJ(arg, obj);
return SUCCESS;
}
/* }}} */

ZEND_API zend_result object_init_with_constructor(zval *arg, zend_class_entry *ce, uint32_t param_count, zval *params, HashTable *named_params) /* {{{ */
ZEND_API zend_object *zend_object_init(zend_class_entry *ce) {
return _object_and_properties_init(ce, NULL);
}

ZEND_API zend_object *zend_object_init_with_constructor(zend_class_entry *ce, uint32_t param_count, zval *params, HashTable *named_params) /* {{{ */
{
zend_result status = _object_and_properties_init(arg, ce, NULL);
if (UNEXPECTED(status == FAILURE)) {
ZVAL_UNDEF(arg);
return FAILURE;
zend_object *obj = _object_and_properties_init(ce, NULL);
if (UNEXPECTED(!obj)) {
return NULL;
}
zend_object *obj = Z_OBJ_P(arg);
zend_function *constructor = obj->handlers->get_constructor(obj);
if (constructor == NULL) {
/* The constructor can be NULL for 2 different reasons:
Expand All @@ -1942,9 +1950,9 @@ ZEND_API zend_result object_init_with_constructor(zval *arg, zend_class_entry *c
* in the latter we need to destroy the object as initialization failed
*/
if (UNEXPECTED(EG(exception))) {
zval_ptr_dtor(arg);
ZVAL_UNDEF(arg);
return FAILURE;
zend_object_store_ctor_failed(obj);

@TimWolla TimWolla Oct 12, 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.

Is this change fixing a pre-existing bug?

@Girgias Girgias Oct 13, 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.

I don't think it does, as that branch is tested via the ext/zend_test/tests/zend_object_init_with_constructor.phpt and the destructor doesn't seem to be called already. So I'm slightly confused. But this whole logic will go away when I get back round to remove the annoying get_constructor object handler.

@ndossche ndossche Oct 14, 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.

I agree this looks like a sus behaviour change

@ndossche ndossche Oct 14, 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.

This should be testable with a non-final class that throws with a destructor. I don't think we have a class already that can show this difference

@Girgias Girgias Oct 14, 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.

Isn't that case already covered by the ThrowingUser class in ext/zend_test/tests/zend_object_init_with_constructor.phpt?

@ndossche ndossche Oct 14, 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.

No, you're looking for a class that throws in get_constructor without implicitly already calling zend_object_store_ctor_failed, and then subclass that with a destructor

OBJ_RELEASE(obj);
return NULL;
}

/* Surprisingly, this is the only case where internal classes will allow to pass extra arguments
Expand All @@ -1958,11 +1966,10 @@ ZEND_API zend_result object_init_with_constructor(zval *arg, zend_class_entry *c
zend_throw_error(NULL, "Unknown named parameter $%s", ZSTR_VAL(arg_name));
/* Do not call destructor, free object, and set arg to IS_UNDEF */
zend_object_store_ctor_failed(obj);
zval_ptr_dtor(arg);
ZVAL_UNDEF(arg);
return FAILURE;
OBJ_RELEASE(obj);
return NULL;
} else {
return SUCCESS;
return obj;
}
}
/* A constructor should not return a value, however if an exception is thrown
Expand All @@ -1980,16 +1987,25 @@ ZEND_API zend_result object_init_with_constructor(zval *arg, zend_class_entry *c
if (Z_TYPE(retval) == IS_UNDEF) {
/* Do not call destructor, free object, and set arg to IS_UNDEF */
zend_object_store_ctor_failed(obj);
zval_ptr_dtor(arg);
ZVAL_UNDEF(arg);
return FAILURE;
OBJ_RELEASE(obj);
return NULL;
} else {
/* Unlikely, but user constructors may return any value they want */
zval_ptr_dtor(&retval);
return SUCCESS;
return obj;
}
}
/* }}} */

ZEND_API zend_result object_init_with_constructor(zval *arg, zend_class_entry *ce, uint32_t param_count, zval *params, HashTable *named_params)
{
zend_object *obj = zend_object_init_with_constructor(ce, param_count, params, named_params);
if (UNEXPECTED(obj == NULL)) {
ZVAL_UNDEF(arg);
return FAILURE;
}
ZVAL_OBJ(arg, obj);
return SUCCESS;
}

ZEND_API void object_init(zval *arg) /* {{{ */
{
Expand Down
8 changes: 7 additions & 1 deletion Zend/zend_API.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -514,11 +514,17 @@ static zend_always_inline void array_init(zval *arg)
array_init_size(arg, 0);
}

static inline zend_object *zend_object_init_std(void) {
return zend_objects_new(zend_standard_class_def);
}

ZEND_API zend_object *zend_object_init(zend_class_entry *ce);
ZEND_API zend_object *zend_object_init_with_constructor(zend_class_entry *ce, uint32_t param_count, zval *params, HashTable *named_params);
ZEND_API void object_init(zval *arg);
ZEND_API zend_result object_init_ex(zval *arg, zend_class_entry *ce);
ZEND_API zend_result object_init_with_constructor(zval *arg, zend_class_entry *ce, uint32_t param_count, zval *params, HashTable *named_params);
ZEND_API zend_result object_and_properties_init(zval *arg, zend_class_entry *ce, HashTable *properties);
ZEND_API void object_properties_init(zend_object *object, zend_class_entry *ce);
ZEND_API void object_properties_init(zend_object *object, const zend_class_entry *ce);
ZEND_API void object_properties_init_ex(zend_object *object, HashTable *properties);
ZEND_API void object_properties_load(zend_object *object, const HashTable *properties);

Expand Down
12 changes: 5 additions & 7 deletions Zend/zend_attributes.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -332,7 +332,7 @@ ZEND_API zend_result zend_get_attribute_value(zval *ret, const zend_attribute *a
return SUCCESS;
}

ZEND_API zend_result zend_get_attribute_object(zval *obj, zend_class_entry *attribute_ce, zend_attribute *attribute_data, zend_class_entry *scope, zend_string *filename)
ZEND_API zend_object *zend_get_attribute_object(zend_class_entry *attribute_ce, zend_attribute *attribute_data, zend_class_entry *scope, zend_string *filename)
{
zend_execute_data *call = NULL;

Expand Down Expand Up @@ -373,8 +373,7 @@ ZEND_API zend_result zend_get_attribute_object(zval *obj, zend_class_entry *attr

zval *args = NULL;
HashTable *named_params = NULL;

zend_result result = FAILURE;
zend_object *obj = NULL;

uint32_t argc = 0;
if (attribute_data->argc) {
Expand All @@ -383,7 +382,6 @@ ZEND_API zend_result zend_get_attribute_object(zval *obj, zend_class_entry *attr
for (uint32_t i = 0; i < attribute_data->argc; i++) {
zval val;
if (FAILURE == zend_get_attribute_value(&val, attribute_data, i, scope)) {
result = FAILURE;
goto out;
}
if (attribute_data->args[i].name) {
Expand All @@ -398,9 +396,9 @@ ZEND_API zend_result zend_get_attribute_object(zval *obj, zend_class_entry *attr
}
}

result = object_init_with_constructor(obj, attribute_ce, argc, args, named_params);
obj = zend_object_init_with_constructor(attribute_ce, argc, args, named_params);

out:
out:
for (uint32_t i = 0; i < argc; i++) {
zval_ptr_dtor(&args[i]);
}
Expand All @@ -416,7 +414,7 @@ ZEND_API zend_result zend_get_attribute_object(zval *obj, zend_class_entry *attr
zend_vm_stack_free_call_frame(call);
}

return result;
return obj;
}

static const char *target_names[] = {
Expand Down
2 changes: 1 addition & 1 deletion Zend/zend_attributes.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ ZEND_API zend_attribute *zend_get_parameter_attribute(const HashTable *attribute
ZEND_API zend_attribute *zend_get_parameter_attribute_str(const HashTable *attributes, const char *str, size_t len, uint32_t offset);

ZEND_API zend_result zend_get_attribute_value(zval *ret, const zend_attribute *attr, uint32_t i, zend_class_entry *scope);
ZEND_API zend_result zend_get_attribute_object(zval *out, zend_class_entry *attribute_ce, zend_attribute *attribute_data, zend_class_entry *scope, zend_string *filename);
ZEND_API zend_object *zend_get_attribute_object(zend_class_entry *attribute_ce, zend_attribute *attribute_data, zend_class_entry *scope, zend_string *filename);

ZEND_API zend_string *zend_get_attribute_target_names(uint32_t targets);
ZEND_API bool zend_is_attribute_repeated(const HashTable *attributes, const zend_attribute *attr);
Expand Down
45 changes: 26 additions & 19 deletions Zend/zend_closures.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ ZEND_API zend_class_entry *zend_ce_closure;
static zend_object_handlers closure_handlers;

static zend_result zend_closure_get_closure(zend_object *obj, zend_class_entry **ce_ptr, zend_function **fptr_ptr, zend_object **obj_ptr, bool check_only);
static void zend_create_closure_ex(zval *res, zend_function *func, zend_class_entry *scope, zend_class_entry *called_scope, zend_object *this_ptr, bool is_fake, uint32_t flags);
static zend_object *zend_create_closure_ex(zend_function *func, zend_class_entry *scope, zend_class_entry *called_scope, zend_object *this_ptr, bool is_fake, uint32_t flags);

static inline uint32_t zend_closure_flags(const zend_closure *closure)
{
Expand Down Expand Up @@ -178,11 +178,14 @@ ZEND_METHOD(Closure, call)
fci.retval = &closure_result;

if (closure->func.common.fn_flags & ZEND_ACC_GENERATOR) {
zval new_closure;
zend_create_closure_ex(&new_closure, &closure->func, newclass,
closure->called_scope, new_this,
zend_closure_is_fake(closure), zend_closure_flags(closure));
closure = (zend_closure *) Z_OBJ(new_closure);
zend_object *new_closure = zend_create_closure_ex(
&closure->func,
newclass,
closure->called_scope, new_this,
zend_closure_is_fake(closure),
zend_closure_flags(closure)
);
closure = (zend_closure *) new_closure;
fci_cache.function_handler = &closure->func;

zend_call_function(&fci, &fci_cache);
Expand Down Expand Up @@ -273,13 +276,14 @@ static zend_result do_closure_bind(zval *return_value, zval *zclosure, zend_obje
called_scope = ce;
}

zend_create_closure_ex(return_value, &closure->func, ce, called_scope, new_this,
zend_object *new_closure_zobj = zend_create_closure_ex(&closure->func, ce, called_scope, new_this,
zend_closure_is_fake(closure), zend_closure_flags(closure));
RETVAL_OBJ(new_closure_zobj);

if (zend_closure_flags(closure) & ZEND_PARTIAL_OF_CLOSURE) {
/* Re-bind the inner closure */

zend_closure *new_closure = (zend_closure*)Z_OBJ_P(return_value);
zend_closure *new_closure = (zend_closure*)new_closure_zobj;
HashTable *static_variables = ZEND_MAP_PTR_GET(new_closure->func.op_array.static_variables_ptr);
ZEND_ASSERT(static_variables->nNumOfElements > 0);
zval *inner = &static_variables->arData[0].val;
Expand Down Expand Up @@ -626,13 +630,12 @@ static zend_object *zend_closure_new(zend_class_entry *class_type) /* {{{ */
static zend_object *zend_closure_clone(zend_object *zobject) /* {{{ */
{
zend_closure *closure = (zend_closure *)zobject;
zval result;

zend_create_closure_ex(&result, &closure->func,
zend_object *result = zend_create_closure_ex(&closure->func,
closure->func.common.scope, closure->called_scope,
closure->this_ptr,
zend_closure_is_fake(closure), zend_closure_flags(closure));
return Z_OBJ(result);
return result;
}
/* }}} */

Expand Down Expand Up @@ -802,17 +805,17 @@ static ZEND_NAMED_FUNCTION(zend_closure_internal_handler) /* {{{ */
}
/* }}} */

static void zend_create_closure_ex(
zval *res, zend_function *func,
static zend_object *zend_create_closure_ex(
zend_function *func,
zend_class_entry *scope, zend_class_entry *called_scope,
zend_object *this_ptr, bool is_fake, uint32_t flags) /* {{{ */
{
zend_closure *closure;
void *ptr;

object_init_ex(res, zend_ce_closure);
zend_object *result = zend_object_init(zend_ce_closure);

closure = (zend_closure *)Z_OBJ_P(res);
closure = (zend_closure *)result;
closure->std.extra_flags = flags;

if ((scope == NULL) && this_ptr) {
Expand Down Expand Up @@ -905,28 +908,31 @@ static void zend_create_closure_ex(
closure->this_ptr = zend_object_copy(this_ptr);
}
}
return result;
}
/* }}} */

ZEND_API void zend_create_closure(zval *res, zend_function *func, zend_class_entry *scope, zend_class_entry *called_scope, zend_object *this_ptr)
{
zend_create_closure_ex(res, func, scope, called_scope, this_ptr,
zend_object *closure = zend_create_closure_ex(func, scope, called_scope, this_ptr,
/* is_fake */ (func->common.fn_flags & ZEND_ACC_FAKE_CLOSURE) != 0,
/* flags */ 0);
ZVAL_OBJ(res, closure);
}

ZEND_API void zend_create_fake_closure(zval *res, zend_function *func, zend_class_entry *scope, zend_class_entry *called_scope, zend_object *this_ptr) /* {{{ */
{
zend_closure *closure;

zend_create_closure_ex(res, func, scope, called_scope, this_ptr,
zend_object *closure_zobj = zend_create_closure_ex(func, scope, called_scope, this_ptr,
/* is_fake */ true, /* flags */ 0);

closure = (zend_closure *)Z_OBJ_P(res);
closure = (zend_closure *)closure_zobj;
closure->func.common.fn_flags |= ZEND_ACC_FAKE_CLOSURE;
if (!closure->this_ptr) {
GC_ADD_FLAGS(&closure->std, GC_NOT_COLLECTABLE);
}
ZVAL_OBJ(res, closure_zobj);
}
/* }}} */

Expand All @@ -936,8 +942,9 @@ ZEND_API void zend_create_partial_closure(zval *res, zend_function *func, zend_c
if (partial_of_closure) {
flags |= ZEND_PARTIAL_OF_CLOSURE;
}
zend_create_closure_ex(res, func, scope, called_scope, this_ptr,
zend_object *closure = zend_create_closure_ex(func, scope, called_scope, this_ptr,
/* is_fake */ false, flags);
ZVAL_OBJ(res, closure);
}

void zend_closure_from_frame(zval *return_value, const zend_execute_data *call) { /* {{{ */
Expand Down
Loading
Loading