xref: /PHP-7.4/Zend/zend_objects_API.h (revision 92ac598a)
1 /*
2    +----------------------------------------------------------------------+
3    | Zend Engine                                                          |
4    +----------------------------------------------------------------------+
5    | Copyright (c) Zend Technologies Ltd. (http://www.zend.com)           |
6    +----------------------------------------------------------------------+
7    | This source file is subject to version 2.00 of the Zend license,     |
8    | that is bundled with this package in the file LICENSE, and is        |
9    | available through the world-wide-web at the following url:           |
10    | http://www.zend.com/license/2_00.txt.                                |
11    | If you did not receive a copy of the Zend license and are unable to  |
12    | obtain it through the world-wide-web, please send a note to          |
13    | license@zend.com so we can mail you a copy immediately.              |
14    +----------------------------------------------------------------------+
15    | Authors: Andi Gutmans <andi@php.net>                                 |
16    |          Zeev Suraski <zeev@php.net>                                 |
17    +----------------------------------------------------------------------+
18 */
19 
20 #ifndef ZEND_OBJECTS_API_H
21 #define ZEND_OBJECTS_API_H
22 
23 #include "zend.h"
24 #include "zend_compile.h"
25 
26 #define OBJ_BUCKET_INVALID			(1<<0)
27 
28 #define IS_OBJ_VALID(o)				(!(((zend_uintptr_t)(o)) & OBJ_BUCKET_INVALID))
29 
30 #define SET_OBJ_INVALID(o)			((zend_object*)((((zend_uintptr_t)(o)) | OBJ_BUCKET_INVALID)))
31 
32 #define GET_OBJ_BUCKET_NUMBER(o)	(((zend_intptr_t)(o)) >> 1)
33 
34 #define SET_OBJ_BUCKET_NUMBER(o, n)	do { \
35 		(o) = (zend_object*)((((zend_uintptr_t)(n)) << 1) | OBJ_BUCKET_INVALID); \
36 	} while (0)
37 
38 #define ZEND_OBJECTS_STORE_ADD_TO_FREE_LIST(h) do { \
39 		SET_OBJ_BUCKET_NUMBER(EG(objects_store).object_buckets[(h)], EG(objects_store).free_list_head); \
40 		EG(objects_store).free_list_head = (h); \
41 	} while (0)
42 
43 #define OBJ_RELEASE(obj) zend_object_release(obj)
44 
45 typedef struct _zend_objects_store {
46 	zend_object **object_buckets;
47 	uint32_t top;
48 	uint32_t size;
49 	int free_list_head;
50 } zend_objects_store;
51 
52 /* Global store handling functions */
53 BEGIN_EXTERN_C()
54 ZEND_API void ZEND_FASTCALL zend_objects_store_init(zend_objects_store *objects, uint32_t init_size);
55 ZEND_API void ZEND_FASTCALL zend_objects_store_call_destructors(zend_objects_store *objects);
56 ZEND_API void ZEND_FASTCALL zend_objects_store_mark_destructed(zend_objects_store *objects);
57 ZEND_API void ZEND_FASTCALL zend_objects_store_free_object_storage(zend_objects_store *objects, zend_bool fast_shutdown);
58 ZEND_API void ZEND_FASTCALL zend_objects_store_destroy(zend_objects_store *objects);
59 
60 /* Store API functions */
61 ZEND_API void ZEND_FASTCALL zend_objects_store_put(zend_object *object);
62 ZEND_API void ZEND_FASTCALL zend_objects_store_del(zend_object *object);
63 
64 /* Called when the ctor was terminated by an exception */
zend_object_store_ctor_failed(zend_object * obj)65 static zend_always_inline void zend_object_store_ctor_failed(zend_object *obj)
66 {
67 	GC_ADD_FLAGS(obj, IS_OBJ_DESTRUCTOR_CALLED);
68 }
69 
END_EXTERN_C()70 END_EXTERN_C()
71 
72 static zend_always_inline void zend_object_release(zend_object *obj)
73 {
74 	if (GC_DELREF(obj) == 0) {
75 		zend_objects_store_del(obj);
76 	} else if (UNEXPECTED(GC_MAY_LEAK((zend_refcounted*)obj))) {
77 		gc_possible_root((zend_refcounted*)obj);
78 	}
79 }
80 
zend_object_properties_size(zend_class_entry * ce)81 static zend_always_inline size_t zend_object_properties_size(zend_class_entry *ce)
82 {
83 	return sizeof(zval) *
84 		(ce->default_properties_count -
85 			((ce->ce_flags & ZEND_ACC_USE_GUARDS) ? 0 : 1));
86 }
87 
88 /* Allocates object type and zeros it, but not the properties.
89  * Properties MUST be initialized using object_properties_init(). */
zend_object_alloc(size_t obj_size,zend_class_entry * ce)90 static zend_always_inline void *zend_object_alloc(size_t obj_size, zend_class_entry *ce) {
91 	void *obj = emalloc(obj_size + zend_object_properties_size(ce));
92 	/* Subtraction of sizeof(zval) is necessary, because zend_object_properties_size() may be
93 	 * -sizeof(zval), if the object has no properties. */
94 	memset(obj, 0, obj_size - sizeof(zval));
95 	return obj;
96 }
97 
zend_get_property_info_for_slot(zend_object * obj,zval * slot)98 static inline zend_property_info *zend_get_property_info_for_slot(zend_object *obj, zval *slot)
99 {
100 	zend_property_info **table = obj->ce->properties_info_table;
101 	intptr_t prop_num = slot - obj->properties_table;
102 	ZEND_ASSERT(prop_num >= 0 && prop_num < obj->ce->default_properties_count);
103 	return table[prop_num];
104 }
105 
106 /* Helper for cases where we're only interested in property info of typed properties. */
zend_get_typed_property_info_for_slot(zend_object * obj,zval * slot)107 static inline zend_property_info *zend_get_typed_property_info_for_slot(zend_object *obj, zval *slot)
108 {
109 	zend_property_info *prop_info = zend_get_property_info_for_slot(obj, slot);
110 	if (prop_info && prop_info->type) {
111 		return prop_info;
112 	}
113 	return NULL;
114 }
115 
116 
117 #endif /* ZEND_OBJECTS_H */
118