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_types.h"
24 #include "zend_gc.h"
25 #include "zend_alloc.h"
26 #include "zend_compile.h" /* For zend_property_info */
27
28 #define OBJ_BUCKET_INVALID (1<<0)
29
30 #define IS_OBJ_VALID(o) (!(((uintptr_t)(o)) & OBJ_BUCKET_INVALID))
31
32 #define SET_OBJ_INVALID(o) ((zend_object*)((((uintptr_t)(o)) | OBJ_BUCKET_INVALID)))
33
34 #define GET_OBJ_BUCKET_NUMBER(o) (((intptr_t)(o)) >> 1)
35
36 #define SET_OBJ_BUCKET_NUMBER(o, n) do { \
37 (o) = (zend_object*)((((uintptr_t)(n)) << 1) | OBJ_BUCKET_INVALID); \
38 } while (0)
39
40 #define ZEND_OBJECTS_STORE_ADD_TO_FREE_LIST(h) do { \
41 SET_OBJ_BUCKET_NUMBER(EG(objects_store).object_buckets[(h)], EG(objects_store).free_list_head); \
42 EG(objects_store).free_list_head = (h); \
43 } while (0)
44
45 #define OBJ_RELEASE(obj) zend_object_release(obj)
46
47 typedef struct _zend_objects_store {
48 zend_object **object_buckets;
49 uint32_t top;
50 uint32_t size;
51 int free_list_head;
52 } zend_objects_store;
53
54 /* Global store handling functions */
55 BEGIN_EXTERN_C()
56 ZEND_API void ZEND_FASTCALL zend_objects_store_init(zend_objects_store *objects, uint32_t init_size);
57 ZEND_API void ZEND_FASTCALL zend_objects_store_call_destructors(zend_objects_store *objects);
58 ZEND_API void ZEND_FASTCALL zend_objects_store_mark_destructed(zend_objects_store *objects);
59 ZEND_API void ZEND_FASTCALL zend_objects_store_free_object_storage(zend_objects_store *objects, bool fast_shutdown);
60 ZEND_API void ZEND_FASTCALL zend_objects_store_destroy(zend_objects_store *objects);
61
62 /* Store API functions */
63 ZEND_API void ZEND_FASTCALL zend_objects_store_put(zend_object *object);
64 ZEND_API void ZEND_FASTCALL zend_objects_store_del(zend_object *object);
65
66 /* Called when the ctor was terminated by an exception */
zend_object_store_ctor_failed(zend_object * obj)67 static zend_always_inline void zend_object_store_ctor_failed(zend_object *obj)
68 {
69 GC_ADD_FLAGS(obj, IS_OBJ_DESTRUCTOR_CALLED);
70 }
71
END_EXTERN_C()72 END_EXTERN_C()
73
74 static zend_always_inline void zend_object_release(zend_object *obj)
75 {
76 if (GC_DELREF(obj) == 0) {
77 zend_objects_store_del(obj);
78 } else if (UNEXPECTED(GC_MAY_LEAK((zend_refcounted*)obj))) {
79 gc_possible_root((zend_refcounted*)obj);
80 }
81 }
82
zend_object_properties_size(zend_class_entry * ce)83 static zend_always_inline size_t zend_object_properties_size(zend_class_entry *ce)
84 {
85 return sizeof(zval) *
86 (ce->default_properties_count -
87 ((ce->ce_flags & ZEND_ACC_USE_GUARDS) ? 0 : 1));
88 }
89
90 /* Allocates object type and zeros it, but not the standard zend_object and properties.
91 * Standard object MUST be initialized using zend_object_std_init().
92 * Properties MUST be initialized using object_properties_init(). */
zend_object_alloc(size_t obj_size,zend_class_entry * ce)93 static zend_always_inline void *zend_object_alloc(size_t obj_size, zend_class_entry *ce) {
94 void *obj = emalloc(obj_size + zend_object_properties_size(ce));
95 memset(obj, 0, obj_size - sizeof(zend_object));
96 return obj;
97 }
98
99 /* Use when 'slot' was obtained directly from obj->properties_table, or when
100 * 'obj' can not be lazy. Otherwise, use zend_get_property_info_for_slot(). */
zend_get_property_info_for_slot_self(zend_object * obj,zval * slot)101 static inline zend_property_info *zend_get_property_info_for_slot_self(zend_object *obj, zval *slot)
102 {
103 zend_property_info **table = obj->ce->properties_info_table;
104 intptr_t prop_num = slot - obj->properties_table;
105 ZEND_ASSERT(prop_num >= 0 && prop_num < obj->ce->default_properties_count);
106 return table[prop_num];
107 }
108
zend_get_property_info_for_slot(zend_object * obj,zval * slot)109 static inline zend_property_info *zend_get_property_info_for_slot(zend_object *obj, zval *slot)
110 {
111 if (UNEXPECTED(zend_object_is_lazy_proxy(obj))) {
112 return zend_lazy_object_get_property_info_for_slot(obj, slot);
113 }
114 zend_property_info **table = obj->ce->properties_info_table;
115 intptr_t prop_num = slot - obj->properties_table;
116 ZEND_ASSERT(prop_num >= 0 && prop_num < obj->ce->default_properties_count);
117 return table[prop_num];
118 }
119
120 /* 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)121 static inline zend_property_info *zend_get_typed_property_info_for_slot(zend_object *obj, zval *slot)
122 {
123 zend_property_info *prop_info = zend_get_property_info_for_slot(obj, slot);
124 if (prop_info && ZEND_TYPE_IS_SET(prop_info->type)) {
125 return prop_info;
126 }
127 return NULL;
128 }
129
130
131 #endif /* ZEND_OBJECTS_H */
132
