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_OBJECT_HANDLERS_H 21 #define ZEND_OBJECT_HANDLERS_H 22 23 struct _zend_property_info; 24 25 #define ZEND_WRONG_PROPERTY_INFO \ 26 ((struct _zend_property_info*)((intptr_t)-1)) 27 28 #define ZEND_DYNAMIC_PROPERTY_OFFSET ((uintptr_t)(intptr_t)(-1)) 29 30 #define IS_VALID_PROPERTY_OFFSET(offset) ((intptr_t)(offset) > 0) 31 #define IS_WRONG_PROPERTY_OFFSET(offset) ((intptr_t)(offset) == 0) 32 #define IS_DYNAMIC_PROPERTY_OFFSET(offset) ((intptr_t)(offset) < 0) 33 34 #define IS_UNKNOWN_DYNAMIC_PROPERTY_OFFSET(offset) (offset == ZEND_DYNAMIC_PROPERTY_OFFSET) 35 #define ZEND_DECODE_DYN_PROP_OFFSET(offset) ((uintptr_t)(-(intptr_t)(offset) - 2)) 36 #define ZEND_ENCODE_DYN_PROP_OFFSET(offset) ((uintptr_t)(-((intptr_t)(offset) + 2))) 37 38 39 /* Used to fetch property from the object, read-only */ 40 typedef zval *(*zend_object_read_property_t)(zend_object *object, zend_string *member, int type, void **cache_slot, zval *rv); 41 42 /* Used to fetch dimension from the object, read-only */ 43 typedef zval *(*zend_object_read_dimension_t)(zend_object *object, zval *offset, int type, zval *rv); 44 45 46 /* Used to set property of the object 47 You must return the final value of the assigned property. 48 */ 49 typedef zval *(*zend_object_write_property_t)(zend_object *object, zend_string *member, zval *value, void **cache_slot); 50 51 /* Used to set dimension of the object */ 52 typedef void (*zend_object_write_dimension_t)(zend_object *object, zval *offset, zval *value); 53 54 55 /* Used to create pointer to the property of the object, for future direct r/w access. 56 * May return one of: 57 * * A zval pointer, without incrementing the reference count. 58 * * &EG(error_zval), if an exception has been thrown. 59 * * NULL, if acquiring a direct pointer is not possible. 60 * In this case, the VM will fall back to using read_property and write_property. 61 */ 62 typedef zval *(*zend_object_get_property_ptr_ptr_t)(zend_object *object, zend_string *member, int type, void **cache_slot); 63 64 /* Used to check if a property of the object exists */ 65 /* param has_set_exists: 66 * 0 (has) whether property exists and is not NULL 67 * 1 (set) whether property exists and is true 68 * 2 (exists) whether property exists 69 */ 70 typedef int (*zend_object_has_property_t)(zend_object *object, zend_string *member, int has_set_exists, void **cache_slot); 71 72 /* Used to check if a dimension of the object exists */ 73 typedef int (*zend_object_has_dimension_t)(zend_object *object, zval *member, int check_empty); 74 75 /* Used to remove a property of the object */ 76 typedef void (*zend_object_unset_property_t)(zend_object *object, zend_string *member, void **cache_slot); 77 78 /* Used to remove a dimension of the object */ 79 typedef void (*zend_object_unset_dimension_t)(zend_object *object, zval *offset); 80 81 /* Used to get hash of the properties of the object, as hash of zval's */ 82 typedef HashTable *(*zend_object_get_properties_t)(zend_object *object); 83 84 typedef HashTable *(*zend_object_get_debug_info_t)(zend_object *object, int *is_temp); 85 86 typedef enum _zend_prop_purpose { 87 /* Used for debugging. Supersedes get_debug_info handler. */ 88 ZEND_PROP_PURPOSE_DEBUG, 89 /* Used for (array) casts. */ 90 ZEND_PROP_PURPOSE_ARRAY_CAST, 91 /* Used for serialization using the "O" scheme. 92 * Unserialization will use __wakeup(). */ 93 ZEND_PROP_PURPOSE_SERIALIZE, 94 /* Used for var_export(). 95 * The data will be passed to __set_state() when evaluated. */ 96 ZEND_PROP_PURPOSE_VAR_EXPORT, 97 /* Used for json_encode(). */ 98 ZEND_PROP_PURPOSE_JSON, 99 /* Dummy member to ensure that "default" is specified. */ 100 _ZEND_PROP_PURPOSE_NON_EXHAUSTIVE_ENUM 101 } zend_prop_purpose; 102 103 /* The return value must be released using zend_release_properties(). */ 104 typedef zend_array *(*zend_object_get_properties_for_t)(zend_object *object, zend_prop_purpose purpose); 105 106 /* Used to call methods */ 107 /* args on stack! */ 108 /* Andi - EX(fbc) (function being called) needs to be initialized already in the INIT fcall opcode so that the parameters can be parsed the right way. We need to add another callback for this. 109 */ 110 typedef zend_function *(*zend_object_get_method_t)(zend_object **object, zend_string *method, const zval *key); 111 typedef zend_function *(*zend_object_get_constructor_t)(zend_object *object); 112 113 /* free_obj should release any resources the object holds, without freeing the 114 * object structure itself. The object does not need to be in a valid state after 115 * free_obj finishes running. 116 * 117 * free_obj will always be invoked, even if the object leaks or a fatal error 118 * occurs. However, during shutdown it may be called once the executor is no 119 * longer active, in which case execution of user code may be skipped. 120 */ 121 typedef void (*zend_object_free_obj_t)(zend_object *object); 122 123 /* dtor_obj is called before free_obj. The object must remain in a valid state 124 * after dtor_obj finishes running. Unlike free_obj, it is run prior to 125 * deactivation of the executor during shutdown, which allows user code to run. 126 * 127 * This handler is not guaranteed to be called (e.g. on fatal error), and as 128 * such should not be used to release resources or deallocate memory. Furthermore, 129 * releasing resources in this handler can break detection of memory leaks, as 130 * cycles may be broken early. 131 * 132 * dtor_obj should be used *only* to call user destruction hooks, such as __destruct. 133 */ 134 typedef void (*zend_object_dtor_obj_t)(zend_object *object); 135 136 typedef zend_object* (*zend_object_clone_obj_t)(zend_object *object); 137 138 /* Get class name for display in var_dump and other debugging functions. 139 * Must be defined and must return a non-NULL value. */ 140 typedef zend_string *(*zend_object_get_class_name_t)(const zend_object *object); 141 142 typedef int (*zend_object_compare_t)(zval *object1, zval *object2); 143 144 /* Cast an object to some other type. 145 * readobj and retval must point to distinct zvals. 146 */ 147 typedef int (*zend_object_cast_t)(zend_object *readobj, zval *retval, int type); 148 149 /* updates *count to hold the number of elements present and returns SUCCESS. 150 * Returns FAILURE if the object does not have any sense of overloaded dimensions */ 151 typedef int (*zend_object_count_elements_t)(zend_object *object, zend_long *count); 152 153 typedef int (*zend_object_get_closure_t)(zend_object *obj, zend_class_entry **ce_ptr, zend_function **fptr_ptr, zend_object **obj_ptr, bool check_only); 154 155 typedef HashTable *(*zend_object_get_gc_t)(zend_object *object, zval **table, int *n); 156 157 typedef int (*zend_object_do_operation_t)(zend_uchar opcode, zval *result, zval *op1, zval *op2); 158 159 struct _zend_object_handlers { 160 /* offset of real object header (usually zero) */ 161 int offset; 162 /* object handlers */ 163 zend_object_free_obj_t free_obj; /* required */ 164 zend_object_dtor_obj_t dtor_obj; /* required */ 165 zend_object_clone_obj_t clone_obj; /* optional */ 166 zend_object_read_property_t read_property; /* required */ 167 zend_object_write_property_t write_property; /* required */ 168 zend_object_read_dimension_t read_dimension; /* required */ 169 zend_object_write_dimension_t write_dimension; /* required */ 170 zend_object_get_property_ptr_ptr_t get_property_ptr_ptr; /* required */ 171 zend_object_has_property_t has_property; /* required */ 172 zend_object_unset_property_t unset_property; /* required */ 173 zend_object_has_dimension_t has_dimension; /* required */ 174 zend_object_unset_dimension_t unset_dimension; /* required */ 175 zend_object_get_properties_t get_properties; /* required */ 176 zend_object_get_method_t get_method; /* required */ 177 zend_object_get_constructor_t get_constructor; /* required */ 178 zend_object_get_class_name_t get_class_name; /* required */ 179 zend_object_cast_t cast_object; /* required */ 180 zend_object_count_elements_t count_elements; /* optional */ 181 zend_object_get_debug_info_t get_debug_info; /* optional */ 182 zend_object_get_closure_t get_closure; /* optional */ 183 zend_object_get_gc_t get_gc; /* required */ 184 zend_object_do_operation_t do_operation; /* optional */ 185 zend_object_compare_t compare; /* required */ 186 zend_object_get_properties_for_t get_properties_for; /* optional */ 187 }; 188 189 BEGIN_EXTERN_C() 190 extern const ZEND_API zend_object_handlers std_object_handlers; 191 192 #define zend_get_std_object_handlers() \ 193 (&std_object_handlers) 194 195 #define zend_get_function_root_class(fbc) \ 196 ((fbc)->common.prototype ? (fbc)->common.prototype->common.scope : (fbc)->common.scope) 197 198 #define ZEND_PROPERTY_ISSET 0x0 /* Property exists and is not NULL */ 199 #define ZEND_PROPERTY_NOT_EMPTY ZEND_ISEMPTY /* Property is not empty */ 200 #define ZEND_PROPERTY_EXISTS 0x2 /* Property exists */ 201 202 ZEND_API void zend_class_init_statics(zend_class_entry *ce); 203 ZEND_API zend_function *zend_std_get_static_method(zend_class_entry *ce, zend_string *function_name_strval, const zval *key); 204 ZEND_API zval *zend_std_get_static_property_with_info(zend_class_entry *ce, zend_string *property_name, int type, struct _zend_property_info **prop_info); 205 ZEND_API zval *zend_std_get_static_property(zend_class_entry *ce, zend_string *property_name, int type); 206 ZEND_API ZEND_COLD bool zend_std_unset_static_property(zend_class_entry *ce, zend_string *property_name); 207 ZEND_API zend_function *zend_std_get_constructor(zend_object *object); 208 ZEND_API struct _zend_property_info *zend_get_property_info(zend_class_entry *ce, zend_string *member, int silent); 209 ZEND_API HashTable *zend_std_get_properties(zend_object *object); 210 ZEND_API HashTable *zend_std_get_gc(zend_object *object, zval **table, int *n); 211 ZEND_API HashTable *zend_std_get_debug_info(zend_object *object, int *is_temp); 212 ZEND_API int zend_std_cast_object_tostring(zend_object *object, zval *writeobj, int type); 213 ZEND_API zval *zend_std_get_property_ptr_ptr(zend_object *object, zend_string *member, int type, void **cache_slot); 214 ZEND_API zval *zend_std_read_property(zend_object *object, zend_string *member, int type, void **cache_slot, zval *rv); 215 ZEND_API zval *zend_std_write_property(zend_object *object, zend_string *member, zval *value, void **cache_slot); 216 ZEND_API int zend_std_has_property(zend_object *object, zend_string *member, int has_set_exists, void **cache_slot); 217 ZEND_API void zend_std_unset_property(zend_object *object, zend_string *member, void **cache_slot); 218 ZEND_API zval *zend_std_read_dimension(zend_object *object, zval *offset, int type, zval *rv); 219 ZEND_API void zend_std_write_dimension(zend_object *object, zval *offset, zval *value); 220 ZEND_API int zend_std_has_dimension(zend_object *object, zval *offset, int check_empty); 221 ZEND_API void zend_std_unset_dimension(zend_object *object, zval *offset); 222 ZEND_API zend_function *zend_std_get_method(zend_object **obj_ptr, zend_string *method_name, const zval *key); 223 ZEND_API zend_string *zend_std_get_class_name(const zend_object *zobj); 224 ZEND_API int zend_std_compare_objects(zval *o1, zval *o2); 225 ZEND_API int zend_std_get_closure(zend_object *obj, zend_class_entry **ce_ptr, zend_function **fptr_ptr, zend_object **obj_ptr, bool check_only); 226 ZEND_API void rebuild_object_properties(zend_object *zobj); 227 228 ZEND_API HashTable *zend_std_build_object_properties_array(zend_object *zobj); 229 230 /* Handler for objects that cannot be meaningfully compared. 231 * Only objects with the same identity will be considered equal. */ 232 ZEND_API int zend_objects_not_comparable(zval *o1, zval *o2); 233 234 ZEND_API int zend_check_protected(zend_class_entry *ce, zend_class_entry *scope); 235 236 ZEND_API int zend_check_property_access(zend_object *zobj, zend_string *prop_info_name, bool is_dynamic); 237 238 ZEND_API zend_function *zend_get_call_trampoline_func(zend_class_entry *ce, zend_string *method_name, int is_static); 239 240 ZEND_API uint32_t *zend_get_property_guard(zend_object *zobj, zend_string *member); 241 242 /* Default behavior for get_properties_for. For use as a fallback in custom 243 * get_properties_for implementations. */ 244 ZEND_API HashTable *zend_std_get_properties_for(zend_object *obj, zend_prop_purpose purpose); 245 246 /* Will call get_properties_for handler or use default behavior. For use by 247 * consumers of the get_properties_for API. */ 248 ZEND_API HashTable *zend_get_properties_for(zval *obj, zend_prop_purpose purpose); 249 250 #define zend_release_properties(ht) do { \ 251 if ((ht) && !(GC_FLAGS(ht) & GC_IMMUTABLE) && !GC_DELREF(ht)) { \ 252 zend_array_destroy(ht); \ 253 } \ 254 } while (0) 255 256 #define zend_free_trampoline(func) do { \ 257 if ((func) == &EG(trampoline)) { \ 258 EG(trampoline).common.function_name = NULL; \ 259 } else { \ 260 efree(func); \ 261 } \ 262 } while (0) 263 264 /* Fallback to default comparison implementation if the arguments aren't both objects 265 * and have the same compare() handler. You'll likely want to use this unless you 266 * explicitly wish to support comparisons between objects and non-objects. */ 267 #define ZEND_COMPARE_OBJECTS_FALLBACK(op1, op2) \ 268 if (Z_TYPE_P(op1) != IS_OBJECT || \ 269 Z_TYPE_P(op2) != IS_OBJECT || \ 270 Z_OBJ_HT_P(op1)->compare != Z_OBJ_HT_P(op2)->compare) { \ 271 return zend_std_compare_objects(op1, op2); \ 272 } 273 274 END_EXTERN_C() 275 276 #endif 277
