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 | Dmitry Stogov <dmitry@php.net> |
18 | Xinchen Hui <laruence@php.net> |
19 +----------------------------------------------------------------------+
20 */
21
22 #ifndef ZEND_TYPES_H
23 #define ZEND_TYPES_H
24
25 #include "zend_portability.h"
26 #include "zend_long.h"
27 #include <stdbool.h>
28
29 #ifdef __SSE2__
30 # include <mmintrin.h>
31 # include <emmintrin.h>
32 #endif
33
34 #ifdef WORDS_BIGENDIAN
35 # define ZEND_ENDIAN_LOHI(lo, hi) hi; lo;
36 # define ZEND_ENDIAN_LOHI_3(lo, mi, hi) hi; mi; lo;
37 # define ZEND_ENDIAN_LOHI_4(a, b, c, d) d; c; b; a;
38 # define ZEND_ENDIAN_LOHI_C(lo, hi) hi, lo
39 # define ZEND_ENDIAN_LOHI_C_3(lo, mi, hi) hi, mi, lo,
40 # define ZEND_ENDIAN_LOHI_C_4(a, b, c, d) d, c, b, a
41 #else
42 # define ZEND_ENDIAN_LOHI(lo, hi) lo; hi;
43 # define ZEND_ENDIAN_LOHI_3(lo, mi, hi) lo; mi; hi;
44 # define ZEND_ENDIAN_LOHI_4(a, b, c, d) a; b; c; d;
45 # define ZEND_ENDIAN_LOHI_C(lo, hi) lo, hi
46 # define ZEND_ENDIAN_LOHI_C_3(lo, mi, hi) lo, mi, hi,
47 # define ZEND_ENDIAN_LOHI_C_4(a, b, c, d) a, b, c, d
48 #endif
49
50 typedef bool zend_bool;
51 typedef unsigned char zend_uchar;
52
53 typedef enum {
54 SUCCESS = 0,
55 FAILURE = -1, /* this MUST stay a negative number, or it may affect functions! */
56 } ZEND_RESULT_CODE;
57
58 typedef ZEND_RESULT_CODE zend_result;
59
60 #ifdef ZEND_ENABLE_ZVAL_LONG64
61 # ifdef ZEND_WIN32
62 # define ZEND_SIZE_MAX _UI64_MAX
63 # else
64 # define ZEND_SIZE_MAX SIZE_MAX
65 # endif
66 #else
67 # if defined(ZEND_WIN32)
68 # define ZEND_SIZE_MAX _UI32_MAX
69 # else
70 # define ZEND_SIZE_MAX SIZE_MAX
71 # endif
72 #endif
73
74 typedef intptr_t zend_intptr_t;
75 typedef uintptr_t zend_uintptr_t;
76
77 #ifdef ZTS
78 #define ZEND_TLS static TSRM_TLS
79 #define ZEND_EXT_TLS TSRM_TLS
80 #else
81 #define ZEND_TLS static
82 #define ZEND_EXT_TLS
83 #endif
84
85 typedef struct _zend_object_handlers zend_object_handlers;
86 typedef struct _zend_class_entry zend_class_entry;
87 typedef union _zend_function zend_function;
88 typedef struct _zend_execute_data zend_execute_data;
89
90 typedef struct _zval_struct zval;
91
92 typedef struct _zend_refcounted zend_refcounted;
93 typedef struct _zend_string zend_string;
94 typedef struct _zend_array zend_array;
95 typedef struct _zend_object zend_object;
96 typedef struct _zend_resource zend_resource;
97 typedef struct _zend_reference zend_reference;
98 typedef struct _zend_ast_ref zend_ast_ref;
99 typedef struct _zend_ast zend_ast;
100
101 typedef int (*compare_func_t)(const void *, const void *);
102 typedef void (*swap_func_t)(void *, void *);
103 typedef void (*sort_func_t)(void *, size_t, size_t, compare_func_t, swap_func_t);
104 typedef void (*dtor_func_t)(zval *pDest);
105 typedef void (*copy_ctor_func_t)(zval *pElement);
106
107 /*
108 * zend_type - is an abstraction layer to represent information about type hint.
109 * It shouldn't be used directly. Only through ZEND_TYPE_* macros.
110 *
111 * ZEND_TYPE_IS_SET() - checks if there is a type-hint
112 * ZEND_TYPE_IS_ONLY_MASK() - checks if type-hint refer to standard type only
113 * ZEND_TYPE_IS_COMPLEX() - checks if type is a type_list, or contains a class either as a CE or as a name
114 * ZEND_TYPE_HAS_NAME() - checks if type-hint contains some class as zend_string *
115 * ZEND_TYPE_IS_INTERSECTION() - checks if the type_list represents an intersection type list
116 * ZEND_TYPE_IS_UNION() - checks if the type_list represents a union type list
117 *
118 * ZEND_TYPE_NAME() - returns referenced class name
119 * ZEND_TYPE_PURE_MASK() - returns MAY_BE_* type mask
120 * ZEND_TYPE_FULL_MASK() - returns MAY_BE_* type mask together with other flags
121 *
122 * ZEND_TYPE_ALLOW_NULL() - checks if NULL is allowed
123 *
124 * ZEND_TYPE_INIT_*() should be used for construction.
125 */
126
127 typedef struct {
128 /* Not using a union here, because there's no good way to initialize them
129 * in a way that is supported in both C and C++ (designated initializers
130 * are only supported since C++20). */
131 void *ptr;
132 uint32_t type_mask;
133 /* TODO: We could use the extra 32-bit of padding on 64-bit systems. */
134 } zend_type;
135
136 typedef struct {
137 uint32_t num_types;
138 zend_type types[1];
139 } zend_type_list;
140
141 #define _ZEND_TYPE_EXTRA_FLAGS_SHIFT 25
142 #define _ZEND_TYPE_MASK ((1u << 25) - 1)
143 /* Only one of these bits may be set. */
144 #define _ZEND_TYPE_NAME_BIT (1u << 24)
145 #define _ZEND_TYPE_LIST_BIT (1u << 22)
146 #define _ZEND_TYPE_KIND_MASK (_ZEND_TYPE_LIST_BIT|_ZEND_TYPE_NAME_BIT)
147 /* TODO: bit 21 is not used */
148 /* Whether the type list is arena allocated */
149 #define _ZEND_TYPE_ARENA_BIT (1u << 20)
150 /* Whether the type list is an intersection type */
151 #define _ZEND_TYPE_INTERSECTION_BIT (1u << 19)
152 /* Whether the type is a union type */
153 #define _ZEND_TYPE_UNION_BIT (1u << 18)
154 /* Type mask excluding the flags above. */
155 #define _ZEND_TYPE_MAY_BE_MASK ((1u << 18) - 1)
156 /* Must have same value as MAY_BE_NULL */
157 #define _ZEND_TYPE_NULLABLE_BIT 0x2u
158
159 #define ZEND_TYPE_IS_SET(t) \
160 (((t).type_mask & _ZEND_TYPE_MASK) != 0)
161
162 /* If a type is complex it means it's either a list with a union or intersection,
163 * or the void pointer is a class name */
164 #define ZEND_TYPE_IS_COMPLEX(t) \
165 ((((t).type_mask) & _ZEND_TYPE_KIND_MASK) != 0)
166
167 #define ZEND_TYPE_HAS_NAME(t) \
168 ((((t).type_mask) & _ZEND_TYPE_NAME_BIT) != 0)
169
170 #define ZEND_TYPE_HAS_LIST(t) \
171 ((((t).type_mask) & _ZEND_TYPE_LIST_BIT) != 0)
172
173 #define ZEND_TYPE_IS_INTERSECTION(t) \
174 ((((t).type_mask) & _ZEND_TYPE_INTERSECTION_BIT) != 0)
175
176 #define ZEND_TYPE_IS_UNION(t) \
177 ((((t).type_mask) & _ZEND_TYPE_UNION_BIT) != 0)
178
179 #define ZEND_TYPE_USES_ARENA(t) \
180 ((((t).type_mask) & _ZEND_TYPE_ARENA_BIT) != 0)
181
182 #define ZEND_TYPE_IS_ONLY_MASK(t) \
183 (ZEND_TYPE_IS_SET(t) && (t).ptr == NULL)
184
185 #define ZEND_TYPE_NAME(t) \
186 ((zend_string *) (t).ptr)
187
188 #define ZEND_TYPE_LITERAL_NAME(t) \
189 ((const char *) (t).ptr)
190
191 #define ZEND_TYPE_LIST(t) \
192 ((zend_type_list *) (t).ptr)
193
194 #define ZEND_TYPE_LIST_SIZE(num_types) \
195 (sizeof(zend_type_list) + ((num_types) - 1) * sizeof(zend_type))
196
197 /* This iterates over a zend_type_list. */
198 #define ZEND_TYPE_LIST_FOREACH(list, type_ptr) do { \
199 zend_type *_list = (list)->types; \
200 zend_type *_end = _list + (list)->num_types; \
201 for (; _list < _end; _list++) { \
202 type_ptr = _list;
203
204 #define ZEND_TYPE_LIST_FOREACH_END() \
205 } \
206 } while (0)
207
208 /* This iterates over any zend_type. If it's a type list, all list elements will
209 * be visited. If it's a single type, only the single type is visited. */
210 #define ZEND_TYPE_FOREACH(type, type_ptr) do { \
211 zend_type *_cur, *_end; \
212 if (ZEND_TYPE_HAS_LIST(type)) { \
213 zend_type_list *_list = ZEND_TYPE_LIST(type); \
214 _cur = _list->types; \
215 _end = _cur + _list->num_types; \
216 } else { \
217 _cur = &(type); \
218 _end = _cur + 1; \
219 } \
220 do { \
221 type_ptr = _cur;
222
223 #define ZEND_TYPE_FOREACH_END() \
224 } while (++_cur < _end); \
225 } while (0)
226
227 #define ZEND_TYPE_SET_PTR(t, _ptr) \
228 ((t).ptr = (_ptr))
229
230 #define ZEND_TYPE_SET_PTR_AND_KIND(t, _ptr, kind_bit) do { \
231 (t).ptr = (_ptr); \
232 (t).type_mask &= ~_ZEND_TYPE_KIND_MASK; \
233 (t).type_mask |= (kind_bit); \
234 } while (0)
235
236 #define ZEND_TYPE_SET_LIST(t, list) \
237 ZEND_TYPE_SET_PTR_AND_KIND(t, list, _ZEND_TYPE_LIST_BIT)
238
239 /* FULL_MASK() includes the MAY_BE_* type mask, as well as additional metadata bits.
240 * The PURE_MASK() only includes the MAY_BE_* type mask. */
241 #define ZEND_TYPE_FULL_MASK(t) \
242 ((t).type_mask)
243
244 #define ZEND_TYPE_PURE_MASK(t) \
245 ((t).type_mask & _ZEND_TYPE_MAY_BE_MASK)
246
247 #define ZEND_TYPE_FULL_MASK_WITHOUT_NULL(t) \
248 ((t).type_mask & ~_ZEND_TYPE_NULLABLE_BIT)
249
250 #define ZEND_TYPE_PURE_MASK_WITHOUT_NULL(t) \
251 ((t).type_mask & _ZEND_TYPE_MAY_BE_MASK & ~_ZEND_TYPE_NULLABLE_BIT)
252
253 #define ZEND_TYPE_CONTAINS_CODE(t, code) \
254 (((t).type_mask & (1u << (code))) != 0)
255
256 #define ZEND_TYPE_ALLOW_NULL(t) \
257 (((t).type_mask & _ZEND_TYPE_NULLABLE_BIT) != 0)
258
259 #define ZEND_TYPE_INIT_NONE(extra_flags) \
260 { NULL, (extra_flags) }
261
262 #define ZEND_TYPE_INIT_MASK(_type_mask) \
263 { NULL, (_type_mask) }
264
265 #define ZEND_TYPE_INIT_CODE(code, allow_null, extra_flags) \
266 ZEND_TYPE_INIT_MASK(((code) == _IS_BOOL ? MAY_BE_BOOL : ((code) == IS_MIXED ? MAY_BE_ANY : (1 << (code)))) \
267 | ((allow_null) ? _ZEND_TYPE_NULLABLE_BIT : 0) | (extra_flags))
268
269 #define ZEND_TYPE_INIT_PTR(ptr, type_kind, allow_null, extra_flags) \
270 { (void *) (ptr), \
271 (type_kind) | ((allow_null) ? _ZEND_TYPE_NULLABLE_BIT : 0) | (extra_flags) }
272
273 #define ZEND_TYPE_INIT_PTR_MASK(ptr, type_mask) \
274 { (void *) (ptr), (type_mask) }
275
276 #define ZEND_TYPE_INIT_UNION(ptr, extra_flags) \
277 { (void *) (ptr), (_ZEND_TYPE_LIST_BIT|_ZEND_TYPE_UNION_BIT) | (extra_flags) }
278
279 #define ZEND_TYPE_INIT_CLASS(class_name, allow_null, extra_flags) \
280 ZEND_TYPE_INIT_PTR(class_name, _ZEND_TYPE_NAME_BIT, allow_null, extra_flags)
281
282 #define ZEND_TYPE_INIT_CLASS_CONST(class_name, allow_null, extra_flags) \
283 ZEND_TYPE_INIT_PTR(class_name, _ZEND_TYPE_NAME_BIT, allow_null, extra_flags)
284
285 #define ZEND_TYPE_INIT_CLASS_CONST_MASK(class_name, type_mask) \
286 ZEND_TYPE_INIT_PTR_MASK(class_name, _ZEND_TYPE_NAME_BIT | (type_mask))
287
288 typedef union _zend_value {
289 zend_long lval; /* long value */
290 double dval; /* double value */
291 zend_refcounted *counted;
292 zend_string *str;
293 zend_array *arr;
294 zend_object *obj;
295 zend_resource *res;
296 zend_reference *ref;
297 zend_ast_ref *ast;
298 zval *zv;
299 void *ptr;
300 zend_class_entry *ce;
301 zend_function *func;
302 struct {
303 uint32_t w1;
304 uint32_t w2;
305 } ww;
306 } zend_value;
307
308 struct _zval_struct {
309 zend_value value; /* value */
310 union {
311 uint32_t type_info;
312 struct {
313 ZEND_ENDIAN_LOHI_3(
314 zend_uchar type, /* active type */
315 zend_uchar type_flags,
316 union {
317 uint16_t extra; /* not further specified */
318 } u)
319 } v;
320 } u1;
321 union {
322 uint32_t next; /* hash collision chain */
323 uint32_t cache_slot; /* cache slot (for RECV_INIT) */
324 uint32_t opline_num; /* opline number (for FAST_CALL) */
325 uint32_t lineno; /* line number (for ast nodes) */
326 uint32_t num_args; /* arguments number for EX(This) */
327 uint32_t fe_pos; /* foreach position */
328 uint32_t fe_iter_idx; /* foreach iterator index */
329 uint32_t property_guard; /* single property guard */
330 uint32_t constant_flags; /* constant flags */
331 uint32_t extra; /* not further specified */
332 } u2;
333 };
334
335 typedef struct _zend_refcounted_h {
336 uint32_t refcount; /* reference counter 32-bit */
337 union {
338 uint32_t type_info;
339 } u;
340 } zend_refcounted_h;
341
342 struct _zend_refcounted {
343 zend_refcounted_h gc;
344 };
345
346 struct _zend_string {
347 zend_refcounted_h gc;
348 zend_ulong h; /* hash value */
349 size_t len;
350 char val[1];
351 };
352
353 typedef struct _Bucket {
354 zval val;
355 zend_ulong h; /* hash value (or numeric index) */
356 zend_string *key; /* string key or NULL for numerics */
357 } Bucket;
358
359 typedef struct _zend_array HashTable;
360
361 struct _zend_array {
362 zend_refcounted_h gc;
363 union {
364 struct {
365 ZEND_ENDIAN_LOHI_4(
366 zend_uchar flags,
367 zend_uchar _unused,
368 zend_uchar nIteratorsCount,
369 zend_uchar _unused2)
370 } v;
371 uint32_t flags;
372 } u;
373 uint32_t nTableMask;
374 Bucket *arData;
375 uint32_t nNumUsed;
376 uint32_t nNumOfElements;
377 uint32_t nTableSize;
378 uint32_t nInternalPointer;
379 zend_long nNextFreeElement;
380 dtor_func_t pDestructor;
381 };
382
383 /*
384 * HashTable Data Layout
385 * =====================
386 *
387 * +=============================+
388 * | HT_HASH(ht, ht->nTableMask) |
389 * | ... |
390 * | HT_HASH(ht, -1) |
391 * +-----------------------------+
392 * ht->arData ---> | Bucket[0] |
393 * | ... |
394 * | Bucket[ht->nTableSize-1] |
395 * +=============================+
396 */
397
398 #define HT_INVALID_IDX ((uint32_t) -1)
399
400 #define HT_MIN_MASK ((uint32_t) -2)
401 #define HT_MIN_SIZE 8
402
403 #if SIZEOF_SIZE_T == 4
404 # define HT_MAX_SIZE 0x04000000 /* small enough to avoid overflow checks */
405 # define HT_HASH_TO_BUCKET_EX(data, idx) \
406 ((Bucket*)((char*)(data) + (idx)))
407 # define HT_IDX_TO_HASH(idx) \
408 ((idx) * sizeof(Bucket))
409 # define HT_HASH_TO_IDX(idx) \
410 ((idx) / sizeof(Bucket))
411 #elif SIZEOF_SIZE_T == 8
412 # define HT_MAX_SIZE 0x80000000
413 # define HT_HASH_TO_BUCKET_EX(data, idx) \
414 ((data) + (idx))
415 # define HT_IDX_TO_HASH(idx) \
416 (idx)
417 # define HT_HASH_TO_IDX(idx) \
418 (idx)
419 #else
420 # error "Unknown SIZEOF_SIZE_T"
421 #endif
422
423 #define HT_HASH_EX(data, idx) \
424 ((uint32_t*)(data))[(int32_t)(idx)]
425 #define HT_HASH(ht, idx) \
426 HT_HASH_EX((ht)->arData, idx)
427
428 #define HT_SIZE_TO_MASK(nTableSize) \
429 ((uint32_t)(-((nTableSize) + (nTableSize))))
430 #define HT_HASH_SIZE(nTableMask) \
431 (((size_t)(uint32_t)-(int32_t)(nTableMask)) * sizeof(uint32_t))
432 #define HT_DATA_SIZE(nTableSize) \
433 ((size_t)(nTableSize) * sizeof(Bucket))
434 #define HT_SIZE_EX(nTableSize, nTableMask) \
435 (HT_DATA_SIZE((nTableSize)) + HT_HASH_SIZE((nTableMask)))
436 #define HT_SIZE(ht) \
437 HT_SIZE_EX((ht)->nTableSize, (ht)->nTableMask)
438 #define HT_USED_SIZE(ht) \
439 (HT_HASH_SIZE((ht)->nTableMask) + ((size_t)(ht)->nNumUsed * sizeof(Bucket)))
440 #ifdef __SSE2__
441 # define HT_HASH_RESET(ht) do { \
442 char *p = (char*)&HT_HASH(ht, (ht)->nTableMask); \
443 size_t size = HT_HASH_SIZE((ht)->nTableMask); \
444 __m128i xmm0 = _mm_setzero_si128(); \
445 xmm0 = _mm_cmpeq_epi8(xmm0, xmm0); \
446 ZEND_ASSERT(size >= 64 && ((size & 0x3f) == 0)); \
447 do { \
448 _mm_storeu_si128((__m128i*)p, xmm0); \
449 _mm_storeu_si128((__m128i*)(p+16), xmm0); \
450 _mm_storeu_si128((__m128i*)(p+32), xmm0); \
451 _mm_storeu_si128((__m128i*)(p+48), xmm0); \
452 p += 64; \
453 size -= 64; \
454 } while (size != 0); \
455 } while (0)
456 #else
457 # define HT_HASH_RESET(ht) \
458 memset(&HT_HASH(ht, (ht)->nTableMask), HT_INVALID_IDX, HT_HASH_SIZE((ht)->nTableMask))
459 #endif
460 #define HT_HASH_RESET_PACKED(ht) do { \
461 HT_HASH(ht, -2) = HT_INVALID_IDX; \
462 HT_HASH(ht, -1) = HT_INVALID_IDX; \
463 } while (0)
464 #define HT_HASH_TO_BUCKET(ht, idx) \
465 HT_HASH_TO_BUCKET_EX((ht)->arData, idx)
466
467 #define HT_SET_DATA_ADDR(ht, ptr) do { \
468 (ht)->arData = (Bucket*)(((char*)(ptr)) + HT_HASH_SIZE((ht)->nTableMask)); \
469 } while (0)
470 #define HT_GET_DATA_ADDR(ht) \
471 ((char*)((ht)->arData) - HT_HASH_SIZE((ht)->nTableMask))
472
473 typedef uint32_t HashPosition;
474
475 typedef struct _HashTableIterator {
476 HashTable *ht;
477 HashPosition pos;
478 } HashTableIterator;
479
480 struct _zend_object {
481 zend_refcounted_h gc;
482 uint32_t handle; // TODO: may be removed ???
483 zend_class_entry *ce;
484 const zend_object_handlers *handlers;
485 HashTable *properties;
486 zval properties_table[1];
487 };
488
489 struct _zend_resource {
490 zend_refcounted_h gc;
491 zend_long handle; // TODO: may be removed ???
492 int type;
493 void *ptr;
494 };
495
496 typedef struct {
497 size_t num;
498 size_t num_allocated;
499 struct _zend_property_info *ptr[1];
500 } zend_property_info_list;
501
502 typedef union {
503 struct _zend_property_info *ptr;
504 uintptr_t list;
505 } zend_property_info_source_list;
506
507 #define ZEND_PROPERTY_INFO_SOURCE_FROM_LIST(list) (0x1 | (uintptr_t) (list))
508 #define ZEND_PROPERTY_INFO_SOURCE_TO_LIST(list) ((zend_property_info_list *) ((list) & ~0x1))
509 #define ZEND_PROPERTY_INFO_SOURCE_IS_LIST(list) ((list) & 0x1)
510
511 struct _zend_reference {
512 zend_refcounted_h gc;
513 zval val;
514 zend_property_info_source_list sources;
515 };
516
517 struct _zend_ast_ref {
518 zend_refcounted_h gc;
519 /*zend_ast ast; zend_ast follows the zend_ast_ref structure */
520 };
521
522 /* Regular data types: Must be in sync with zend_variables.c. */
523 #define IS_UNDEF 0
524 #define IS_NULL 1
525 #define IS_FALSE 2
526 #define IS_TRUE 3
527 #define IS_LONG 4
528 #define IS_DOUBLE 5
529 #define IS_STRING 6
530 #define IS_ARRAY 7
531 #define IS_OBJECT 8
532 #define IS_RESOURCE 9
533 #define IS_REFERENCE 10
534 #define IS_CONSTANT_AST 11 /* Constant expressions */
535
536 /* Fake types used only for type hinting.
537 * These are allowed to overlap with the types below. */
538 #define IS_CALLABLE 12
539 #define IS_ITERABLE 13
540 #define IS_VOID 14
541 #define IS_STATIC 15
542 #define IS_MIXED 16
543 #define IS_NEVER 17
544
545 /* internal types */
546 #define IS_INDIRECT 12
547 #define IS_PTR 13
548 #define IS_ALIAS_PTR 14
549 #define _IS_ERROR 15
550
551 /* used for casts */
552 #define _IS_BOOL 18
553 #define _IS_NUMBER 19
554
zval_get_type(const zval * pz)555 static zend_always_inline zend_uchar zval_get_type(const zval* pz) {
556 return pz->u1.v.type;
557 }
558
559 #define ZEND_SAME_FAKE_TYPE(faketype, realtype) ( \
560 (faketype) == (realtype) \
561 || ((faketype) == _IS_BOOL && ((realtype) == IS_TRUE || (realtype) == IS_FALSE)) \
562 )
563
564 /* we should never set just Z_TYPE, we should set Z_TYPE_INFO */
565 #define Z_TYPE(zval) zval_get_type(&(zval))
566 #define Z_TYPE_P(zval_p) Z_TYPE(*(zval_p))
567
568 #define Z_TYPE_FLAGS(zval) (zval).u1.v.type_flags
569 #define Z_TYPE_FLAGS_P(zval_p) Z_TYPE_FLAGS(*(zval_p))
570
571 #define Z_TYPE_INFO(zval) (zval).u1.type_info
572 #define Z_TYPE_INFO_P(zval_p) Z_TYPE_INFO(*(zval_p))
573
574 #define Z_NEXT(zval) (zval).u2.next
575 #define Z_NEXT_P(zval_p) Z_NEXT(*(zval_p))
576
577 #define Z_CACHE_SLOT(zval) (zval).u2.cache_slot
578 #define Z_CACHE_SLOT_P(zval_p) Z_CACHE_SLOT(*(zval_p))
579
580 #define Z_LINENO(zval) (zval).u2.lineno
581 #define Z_LINENO_P(zval_p) Z_LINENO(*(zval_p))
582
583 #define Z_OPLINE_NUM(zval) (zval).u2.opline_num
584 #define Z_OPLINE_NUM_P(zval_p) Z_OPLINE_NUM(*(zval_p))
585
586 #define Z_FE_POS(zval) (zval).u2.fe_pos
587 #define Z_FE_POS_P(zval_p) Z_FE_POS(*(zval_p))
588
589 #define Z_FE_ITER(zval) (zval).u2.fe_iter_idx
590 #define Z_FE_ITER_P(zval_p) Z_FE_ITER(*(zval_p))
591
592 #define Z_PROPERTY_GUARD(zval) (zval).u2.property_guard
593 #define Z_PROPERTY_GUARD_P(zval_p) Z_PROPERTY_GUARD(*(zval_p))
594
595 #define Z_CONSTANT_FLAGS(zval) (zval).u2.constant_flags
596 #define Z_CONSTANT_FLAGS_P(zval_p) Z_CONSTANT_FLAGS(*(zval_p))
597
598 #define Z_EXTRA(zval) (zval).u2.extra
599 #define Z_EXTRA_P(zval_p) Z_EXTRA(*(zval_p))
600
601 #define Z_COUNTED(zval) (zval).value.counted
602 #define Z_COUNTED_P(zval_p) Z_COUNTED(*(zval_p))
603
604 #define Z_TYPE_MASK 0xff
605 #define Z_TYPE_FLAGS_MASK 0xff00
606
607 #define Z_TYPE_FLAGS_SHIFT 8
608
609 #define GC_REFCOUNT(p) zend_gc_refcount(&(p)->gc)
610 #define GC_SET_REFCOUNT(p, rc) zend_gc_set_refcount(&(p)->gc, rc)
611 #define GC_ADDREF(p) zend_gc_addref(&(p)->gc)
612 #define GC_DELREF(p) zend_gc_delref(&(p)->gc)
613 #define GC_ADDREF_EX(p, rc) zend_gc_addref_ex(&(p)->gc, rc)
614 #define GC_DELREF_EX(p, rc) zend_gc_delref_ex(&(p)->gc, rc)
615 #define GC_TRY_ADDREF(p) zend_gc_try_addref(&(p)->gc)
616 #define GC_TRY_DELREF(p) zend_gc_try_delref(&(p)->gc)
617
618 #define GC_TYPE_MASK 0x0000000f
619 #define GC_FLAGS_MASK 0x000003f0
620 #define GC_INFO_MASK 0xfffffc00
621 #define GC_FLAGS_SHIFT 0
622 #define GC_INFO_SHIFT 10
623
zval_gc_type(uint32_t gc_type_info)624 static zend_always_inline zend_uchar zval_gc_type(uint32_t gc_type_info) {
625 return (gc_type_info & GC_TYPE_MASK);
626 }
627
zval_gc_flags(uint32_t gc_type_info)628 static zend_always_inline uint32_t zval_gc_flags(uint32_t gc_type_info) {
629 return (gc_type_info >> GC_FLAGS_SHIFT) & (GC_FLAGS_MASK >> GC_FLAGS_SHIFT);
630 }
631
zval_gc_info(uint32_t gc_type_info)632 static zend_always_inline uint32_t zval_gc_info(uint32_t gc_type_info) {
633 return (gc_type_info >> GC_INFO_SHIFT);
634 }
635
636 #define GC_TYPE_INFO(p) (p)->gc.u.type_info
637 #define GC_TYPE(p) zval_gc_type(GC_TYPE_INFO(p))
638 #define GC_FLAGS(p) zval_gc_flags(GC_TYPE_INFO(p))
639 #define GC_INFO(p) zval_gc_info(GC_TYPE_INFO(p))
640
641 #define GC_ADD_FLAGS(p, flags) do { \
642 GC_TYPE_INFO(p) |= (flags) << GC_FLAGS_SHIFT; \
643 } while (0)
644 #define GC_DEL_FLAGS(p, flags) do { \
645 GC_TYPE_INFO(p) &= ~((flags) << GC_FLAGS_SHIFT); \
646 } while (0)
647
648 #define Z_GC_TYPE(zval) GC_TYPE(Z_COUNTED(zval))
649 #define Z_GC_TYPE_P(zval_p) Z_GC_TYPE(*(zval_p))
650
651 #define Z_GC_FLAGS(zval) GC_FLAGS(Z_COUNTED(zval))
652 #define Z_GC_FLAGS_P(zval_p) Z_GC_FLAGS(*(zval_p))
653
654 #define Z_GC_INFO(zval) GC_INFO(Z_COUNTED(zval))
655 #define Z_GC_INFO_P(zval_p) Z_GC_INFO(*(zval_p))
656 #define Z_GC_TYPE_INFO(zval) GC_TYPE_INFO(Z_COUNTED(zval))
657 #define Z_GC_TYPE_INFO_P(zval_p) Z_GC_TYPE_INFO(*(zval_p))
658
659 /* zval_gc_flags(zval.value->gc.u.type_info) (common flags) */
660 #define GC_NOT_COLLECTABLE (1<<4)
661 #define GC_PROTECTED (1<<5) /* used for recursion detection */
662 #define GC_IMMUTABLE (1<<6) /* can't be changed in place */
663 #define GC_PERSISTENT (1<<7) /* allocated using malloc */
664 #define GC_PERSISTENT_LOCAL (1<<8) /* persistent, but thread-local */
665
666 #define GC_NULL (IS_NULL | (GC_NOT_COLLECTABLE << GC_FLAGS_SHIFT))
667 #define GC_STRING (IS_STRING | (GC_NOT_COLLECTABLE << GC_FLAGS_SHIFT))
668 #define GC_ARRAY IS_ARRAY
669 #define GC_OBJECT IS_OBJECT
670 #define GC_RESOURCE (IS_RESOURCE | (GC_NOT_COLLECTABLE << GC_FLAGS_SHIFT))
671 #define GC_REFERENCE (IS_REFERENCE | (GC_NOT_COLLECTABLE << GC_FLAGS_SHIFT))
672 #define GC_CONSTANT_AST (IS_CONSTANT_AST | (GC_NOT_COLLECTABLE << GC_FLAGS_SHIFT))
673
674 /* zval.u1.v.type_flags */
675 #define IS_TYPE_REFCOUNTED (1<<0)
676 #define IS_TYPE_COLLECTABLE (1<<1)
677
678 #if 1
679 /* This optimized version assumes that we have a single "type_flag" */
680 /* IS_TYPE_COLLECTABLE may be used only with IS_TYPE_REFCOUNTED */
681 # define Z_TYPE_INFO_REFCOUNTED(t) (((t) & Z_TYPE_FLAGS_MASK) != 0)
682 #else
683 # define Z_TYPE_INFO_REFCOUNTED(t) (((t) & (IS_TYPE_REFCOUNTED << Z_TYPE_FLAGS_SHIFT)) != 0)
684 #endif
685
686 /* extended types */
687 #define IS_INTERNED_STRING_EX IS_STRING
688
689 #define IS_STRING_EX (IS_STRING | (IS_TYPE_REFCOUNTED << Z_TYPE_FLAGS_SHIFT))
690 #define IS_ARRAY_EX (IS_ARRAY | (IS_TYPE_REFCOUNTED << Z_TYPE_FLAGS_SHIFT) | (IS_TYPE_COLLECTABLE << Z_TYPE_FLAGS_SHIFT))
691 #define IS_OBJECT_EX (IS_OBJECT | (IS_TYPE_REFCOUNTED << Z_TYPE_FLAGS_SHIFT) | (IS_TYPE_COLLECTABLE << Z_TYPE_FLAGS_SHIFT))
692 #define IS_RESOURCE_EX (IS_RESOURCE | (IS_TYPE_REFCOUNTED << Z_TYPE_FLAGS_SHIFT))
693 #define IS_REFERENCE_EX (IS_REFERENCE | (IS_TYPE_REFCOUNTED << Z_TYPE_FLAGS_SHIFT))
694
695 #define IS_CONSTANT_AST_EX (IS_CONSTANT_AST | (IS_TYPE_REFCOUNTED << Z_TYPE_FLAGS_SHIFT))
696
697 /* string flags (zval.value->gc.u.flags) */
698 #define IS_STR_CLASS_NAME_MAP_PTR GC_PROTECTED /* refcount is a map_ptr offset of class_entry */
699 #define IS_STR_INTERNED GC_IMMUTABLE /* interned string */
700 #define IS_STR_PERSISTENT GC_PERSISTENT /* allocated using malloc */
701 #define IS_STR_PERMANENT (1<<8) /* relives request boundary */
702 #define IS_STR_VALID_UTF8 (1<<9) /* valid UTF-8 according to PCRE */
703
704 /* array flags */
705 #define IS_ARRAY_IMMUTABLE GC_IMMUTABLE
706 #define IS_ARRAY_PERSISTENT GC_PERSISTENT
707
708 /* object flags (zval.value->gc.u.flags) */
709 #define IS_OBJ_WEAKLY_REFERENCED GC_PERSISTENT
710 #define IS_OBJ_DESTRUCTOR_CALLED (1<<8)
711 #define IS_OBJ_FREE_CALLED (1<<9)
712
713 #define OBJ_FLAGS(obj) GC_FLAGS(obj)
714
715 /* Fast class cache */
716 #define ZSTR_HAS_CE_CACHE(s) (GC_FLAGS(s) & IS_STR_CLASS_NAME_MAP_PTR)
717 #define ZSTR_GET_CE_CACHE(s) ZSTR_GET_CE_CACHE_EX(s, 1)
718 #define ZSTR_SET_CE_CACHE(s, ce) ZSTR_SET_CE_CACHE_EX(s, ce, 1)
719
720 #define ZSTR_VALID_CE_CACHE(s) EXPECTED((GC_REFCOUNT(s)-1)/sizeof(void *) < CG(map_ptr_last))
721
722 #define ZSTR_GET_CE_CACHE_EX(s, validate) \
723 ((!(validate) || ZSTR_VALID_CE_CACHE(s)) ? GET_CE_CACHE(GC_REFCOUNT(s)) : NULL)
724
725 #define ZSTR_SET_CE_CACHE_EX(s, ce, validate) do { \
726 if (!(validate) || ZSTR_VALID_CE_CACHE(s)) { \
727 SET_CE_CACHE(GC_REFCOUNT(s), ce); \
728 } \
729 } while (0)
730
731 #define GET_CE_CACHE(ce_cache) \
732 (*(zend_class_entry **)ZEND_MAP_PTR_OFFSET2PTR(ce_cache))
733
734 #define SET_CE_CACHE(ce_cache, ce) do { \
735 *((zend_class_entry **)ZEND_MAP_PTR_OFFSET2PTR(ce_cache)) = ce; \
736 } while (0)
737
738 /* Recursion protection macros must be used only for arrays and objects */
739 #define GC_IS_RECURSIVE(p) \
740 (GC_FLAGS(p) & GC_PROTECTED)
741
742 #define GC_PROTECT_RECURSION(p) do { \
743 GC_ADD_FLAGS(p, GC_PROTECTED); \
744 } while (0)
745
746 #define GC_UNPROTECT_RECURSION(p) do { \
747 GC_DEL_FLAGS(p, GC_PROTECTED); \
748 } while (0)
749
750 #define GC_TRY_PROTECT_RECURSION(p) do { \
751 if (!(GC_FLAGS(p) & GC_IMMUTABLE)) GC_PROTECT_RECURSION(p); \
752 } while (0)
753
754 #define GC_TRY_UNPROTECT_RECURSION(p) do { \
755 if (!(GC_FLAGS(p) & GC_IMMUTABLE)) GC_UNPROTECT_RECURSION(p); \
756 } while (0)
757
758 #define Z_IS_RECURSIVE(zval) GC_IS_RECURSIVE(Z_COUNTED(zval))
759 #define Z_PROTECT_RECURSION(zval) GC_PROTECT_RECURSION(Z_COUNTED(zval))
760 #define Z_UNPROTECT_RECURSION(zval) GC_UNPROTECT_RECURSION(Z_COUNTED(zval))
761 #define Z_IS_RECURSIVE_P(zv) Z_IS_RECURSIVE(*(zv))
762 #define Z_PROTECT_RECURSION_P(zv) Z_PROTECT_RECURSION(*(zv))
763 #define Z_UNPROTECT_RECURSION_P(zv) Z_UNPROTECT_RECURSION(*(zv))
764
765 /* All data types < IS_STRING have their constructor/destructors skipped */
766 #define Z_CONSTANT(zval) (Z_TYPE(zval) == IS_CONSTANT_AST)
767 #define Z_CONSTANT_P(zval_p) Z_CONSTANT(*(zval_p))
768
769 #if 1
770 /* This optimized version assumes that we have a single "type_flag" */
771 /* IS_TYPE_COLLECTABLE may be used only with IS_TYPE_REFCOUNTED */
772 #define Z_REFCOUNTED(zval) (Z_TYPE_FLAGS(zval) != 0)
773 #else
774 #define Z_REFCOUNTED(zval) ((Z_TYPE_FLAGS(zval) & IS_TYPE_REFCOUNTED) != 0)
775 #endif
776 #define Z_REFCOUNTED_P(zval_p) Z_REFCOUNTED(*(zval_p))
777
778 #define Z_COLLECTABLE(zval) ((Z_TYPE_FLAGS(zval) & IS_TYPE_COLLECTABLE) != 0)
779 #define Z_COLLECTABLE_P(zval_p) Z_COLLECTABLE(*(zval_p))
780
781 /* deprecated: (COPYABLE is the same as IS_ARRAY) */
782 #define Z_COPYABLE(zval) (Z_TYPE(zval) == IS_ARRAY)
783 #define Z_COPYABLE_P(zval_p) Z_COPYABLE(*(zval_p))
784
785 /* deprecated: (IMMUTABLE is the same as IS_ARRAY && !REFCOUNTED) */
786 #define Z_IMMUTABLE(zval) (Z_TYPE_INFO(zval) == IS_ARRAY)
787 #define Z_IMMUTABLE_P(zval_p) Z_IMMUTABLE(*(zval_p))
788 #define Z_OPT_IMMUTABLE(zval) Z_IMMUTABLE(zval_p)
789 #define Z_OPT_IMMUTABLE_P(zval_p) Z_IMMUTABLE(*(zval_p))
790
791 /* the following Z_OPT_* macros make better code when Z_TYPE_INFO accessed before */
792 #define Z_OPT_TYPE(zval) (Z_TYPE_INFO(zval) & Z_TYPE_MASK)
793 #define Z_OPT_TYPE_P(zval_p) Z_OPT_TYPE(*(zval_p))
794
795 #define Z_OPT_CONSTANT(zval) (Z_OPT_TYPE(zval) == IS_CONSTANT_AST)
796 #define Z_OPT_CONSTANT_P(zval_p) Z_OPT_CONSTANT(*(zval_p))
797
798 #define Z_OPT_REFCOUNTED(zval) Z_TYPE_INFO_REFCOUNTED(Z_TYPE_INFO(zval))
799 #define Z_OPT_REFCOUNTED_P(zval_p) Z_OPT_REFCOUNTED(*(zval_p))
800
801 /* deprecated: (COPYABLE is the same as IS_ARRAY) */
802 #define Z_OPT_COPYABLE(zval) (Z_OPT_TYPE(zval) == IS_ARRAY)
803 #define Z_OPT_COPYABLE_P(zval_p) Z_OPT_COPYABLE(*(zval_p))
804
805 #define Z_OPT_ISREF(zval) (Z_OPT_TYPE(zval) == IS_REFERENCE)
806 #define Z_OPT_ISREF_P(zval_p) Z_OPT_ISREF(*(zval_p))
807
808 #define Z_ISREF(zval) (Z_TYPE(zval) == IS_REFERENCE)
809 #define Z_ISREF_P(zval_p) Z_ISREF(*(zval_p))
810
811 #define Z_ISUNDEF(zval) (Z_TYPE(zval) == IS_UNDEF)
812 #define Z_ISUNDEF_P(zval_p) Z_ISUNDEF(*(zval_p))
813
814 #define Z_ISNULL(zval) (Z_TYPE(zval) == IS_NULL)
815 #define Z_ISNULL_P(zval_p) Z_ISNULL(*(zval_p))
816
817 #define Z_ISERROR(zval) (Z_TYPE(zval) == _IS_ERROR)
818 #define Z_ISERROR_P(zval_p) Z_ISERROR(*(zval_p))
819
820 #define Z_LVAL(zval) (zval).value.lval
821 #define Z_LVAL_P(zval_p) Z_LVAL(*(zval_p))
822
823 #define Z_DVAL(zval) (zval).value.dval
824 #define Z_DVAL_P(zval_p) Z_DVAL(*(zval_p))
825
826 #define Z_STR(zval) (zval).value.str
827 #define Z_STR_P(zval_p) Z_STR(*(zval_p))
828
829 #define Z_STRVAL(zval) ZSTR_VAL(Z_STR(zval))
830 #define Z_STRVAL_P(zval_p) Z_STRVAL(*(zval_p))
831
832 #define Z_STRLEN(zval) ZSTR_LEN(Z_STR(zval))
833 #define Z_STRLEN_P(zval_p) Z_STRLEN(*(zval_p))
834
835 #define Z_STRHASH(zval) ZSTR_HASH(Z_STR(zval))
836 #define Z_STRHASH_P(zval_p) Z_STRHASH(*(zval_p))
837
838 #define Z_ARR(zval) (zval).value.arr
839 #define Z_ARR_P(zval_p) Z_ARR(*(zval_p))
840
841 #define Z_ARRVAL(zval) Z_ARR(zval)
842 #define Z_ARRVAL_P(zval_p) Z_ARRVAL(*(zval_p))
843
844 #define Z_OBJ(zval) (zval).value.obj
845 #define Z_OBJ_P(zval_p) Z_OBJ(*(zval_p))
846
847 #define Z_OBJ_HT(zval) Z_OBJ(zval)->handlers
848 #define Z_OBJ_HT_P(zval_p) Z_OBJ_HT(*(zval_p))
849
850 #define Z_OBJ_HANDLER(zval, hf) Z_OBJ_HT((zval))->hf
851 #define Z_OBJ_HANDLER_P(zv_p, hf) Z_OBJ_HANDLER(*(zv_p), hf)
852
853 #define Z_OBJ_HANDLE(zval) (Z_OBJ((zval)))->handle
854 #define Z_OBJ_HANDLE_P(zval_p) Z_OBJ_HANDLE(*(zval_p))
855
856 #define Z_OBJCE(zval) (Z_OBJ(zval)->ce)
857 #define Z_OBJCE_P(zval_p) Z_OBJCE(*(zval_p))
858
859 #define Z_OBJPROP(zval) Z_OBJ_HT((zval))->get_properties(Z_OBJ(zval))
860 #define Z_OBJPROP_P(zval_p) Z_OBJPROP(*(zval_p))
861
862 #define Z_RES(zval) (zval).value.res
863 #define Z_RES_P(zval_p) Z_RES(*zval_p)
864
865 #define Z_RES_HANDLE(zval) Z_RES(zval)->handle
866 #define Z_RES_HANDLE_P(zval_p) Z_RES_HANDLE(*zval_p)
867
868 #define Z_RES_TYPE(zval) Z_RES(zval)->type
869 #define Z_RES_TYPE_P(zval_p) Z_RES_TYPE(*zval_p)
870
871 #define Z_RES_VAL(zval) Z_RES(zval)->ptr
872 #define Z_RES_VAL_P(zval_p) Z_RES_VAL(*zval_p)
873
874 #define Z_REF(zval) (zval).value.ref
875 #define Z_REF_P(zval_p) Z_REF(*(zval_p))
876
877 #define Z_REFVAL(zval) &Z_REF(zval)->val
878 #define Z_REFVAL_P(zval_p) Z_REFVAL(*(zval_p))
879
880 #define Z_AST(zval) (zval).value.ast
881 #define Z_AST_P(zval_p) Z_AST(*(zval_p))
882
883 #define GC_AST(p) ((zend_ast*)(((char*)p) + sizeof(zend_ast_ref)))
884
885 #define Z_ASTVAL(zval) GC_AST(Z_AST(zval))
886 #define Z_ASTVAL_P(zval_p) Z_ASTVAL(*(zval_p))
887
888 #define Z_INDIRECT(zval) (zval).value.zv
889 #define Z_INDIRECT_P(zval_p) Z_INDIRECT(*(zval_p))
890
891 #define Z_CE(zval) (zval).value.ce
892 #define Z_CE_P(zval_p) Z_CE(*(zval_p))
893
894 #define Z_FUNC(zval) (zval).value.func
895 #define Z_FUNC_P(zval_p) Z_FUNC(*(zval_p))
896
897 #define Z_PTR(zval) (zval).value.ptr
898 #define Z_PTR_P(zval_p) Z_PTR(*(zval_p))
899
900 #define ZVAL_UNDEF(z) do { \
901 Z_TYPE_INFO_P(z) = IS_UNDEF; \
902 } while (0)
903
904 #define ZVAL_NULL(z) do { \
905 Z_TYPE_INFO_P(z) = IS_NULL; \
906 } while (0)
907
908 #define ZVAL_FALSE(z) do { \
909 Z_TYPE_INFO_P(z) = IS_FALSE; \
910 } while (0)
911
912 #define ZVAL_TRUE(z) do { \
913 Z_TYPE_INFO_P(z) = IS_TRUE; \
914 } while (0)
915
916 #define ZVAL_BOOL(z, b) do { \
917 Z_TYPE_INFO_P(z) = \
918 (b) ? IS_TRUE : IS_FALSE; \
919 } while (0)
920
921 #define ZVAL_LONG(z, l) do { \
922 zval *__z = (z); \
923 Z_LVAL_P(__z) = l; \
924 Z_TYPE_INFO_P(__z) = IS_LONG; \
925 } while (0)
926
927 #define ZVAL_DOUBLE(z, d) do { \
928 zval *__z = (z); \
929 Z_DVAL_P(__z) = d; \
930 Z_TYPE_INFO_P(__z) = IS_DOUBLE; \
931 } while (0)
932
933 #define ZVAL_STR(z, s) do { \
934 zval *__z = (z); \
935 zend_string *__s = (s); \
936 Z_STR_P(__z) = __s; \
937 /* interned strings support */ \
938 Z_TYPE_INFO_P(__z) = ZSTR_IS_INTERNED(__s) ? \
939 IS_INTERNED_STRING_EX : \
940 IS_STRING_EX; \
941 } while (0)
942
943 #define ZVAL_INTERNED_STR(z, s) do { \
944 zval *__z = (z); \
945 zend_string *__s = (s); \
946 Z_STR_P(__z) = __s; \
947 Z_TYPE_INFO_P(__z) = IS_INTERNED_STRING_EX; \
948 } while (0)
949
950 #define ZVAL_NEW_STR(z, s) do { \
951 zval *__z = (z); \
952 zend_string *__s = (s); \
953 Z_STR_P(__z) = __s; \
954 Z_TYPE_INFO_P(__z) = IS_STRING_EX; \
955 } while (0)
956
957 #define ZVAL_STR_COPY(z, s) do { \
958 zval *__z = (z); \
959 zend_string *__s = (s); \
960 Z_STR_P(__z) = __s; \
961 /* interned strings support */ \
962 if (ZSTR_IS_INTERNED(__s)) { \
963 Z_TYPE_INFO_P(__z) = IS_INTERNED_STRING_EX; \
964 } else { \
965 GC_ADDREF(__s); \
966 Z_TYPE_INFO_P(__z) = IS_STRING_EX; \
967 } \
968 } while (0)
969
970 #define ZVAL_ARR(z, a) do { \
971 zend_array *__arr = (a); \
972 zval *__z = (z); \
973 Z_ARR_P(__z) = __arr; \
974 Z_TYPE_INFO_P(__z) = IS_ARRAY_EX; \
975 } while (0)
976
977 #define ZVAL_NEW_PERSISTENT_ARR(z) do { \
978 zval *__z = (z); \
979 zend_array *_arr = \
980 (zend_array *) malloc(sizeof(zend_array)); \
981 Z_ARR_P(__z) = _arr; \
982 Z_TYPE_INFO_P(__z) = IS_ARRAY_EX; \
983 } while (0)
984
985 #define ZVAL_OBJ(z, o) do { \
986 zval *__z = (z); \
987 Z_OBJ_P(__z) = (o); \
988 Z_TYPE_INFO_P(__z) = IS_OBJECT_EX; \
989 } while (0)
990
991 #define ZVAL_OBJ_COPY(z, o) do { \
992 zval *__z = (z); \
993 zend_object *__o = (o); \
994 GC_ADDREF(__o); \
995 Z_OBJ_P(__z) = __o; \
996 Z_TYPE_INFO_P(__z) = IS_OBJECT_EX; \
997 } while (0)
998
999 #define ZVAL_RES(z, r) do { \
1000 zval *__z = (z); \
1001 Z_RES_P(__z) = (r); \
1002 Z_TYPE_INFO_P(__z) = IS_RESOURCE_EX; \
1003 } while (0)
1004
1005 #define ZVAL_NEW_RES(z, h, p, t) do { \
1006 zend_resource *_res = \
1007 (zend_resource *) emalloc(sizeof(zend_resource)); \
1008 zval *__z; \
1009 GC_SET_REFCOUNT(_res, 1); \
1010 GC_TYPE_INFO(_res) = GC_RESOURCE; \
1011 _res->handle = (h); \
1012 _res->type = (t); \
1013 _res->ptr = (p); \
1014 __z = (z); \
1015 Z_RES_P(__z) = _res; \
1016 Z_TYPE_INFO_P(__z) = IS_RESOURCE_EX; \
1017 } while (0)
1018
1019 #define ZVAL_NEW_PERSISTENT_RES(z, h, p, t) do { \
1020 zend_resource *_res = \
1021 (zend_resource *) malloc(sizeof(zend_resource)); \
1022 zval *__z; \
1023 GC_SET_REFCOUNT(_res, 1); \
1024 GC_TYPE_INFO(_res) = GC_RESOURCE | \
1025 (GC_PERSISTENT << GC_FLAGS_SHIFT); \
1026 _res->handle = (h); \
1027 _res->type = (t); \
1028 _res->ptr = (p); \
1029 __z = (z); \
1030 Z_RES_P(__z) = _res; \
1031 Z_TYPE_INFO_P(__z) = IS_RESOURCE_EX; \
1032 } while (0)
1033
1034 #define ZVAL_REF(z, r) do { \
1035 zval *__z = (z); \
1036 Z_REF_P(__z) = (r); \
1037 Z_TYPE_INFO_P(__z) = IS_REFERENCE_EX; \
1038 } while (0)
1039
1040 #define ZVAL_NEW_EMPTY_REF(z) do { \
1041 zend_reference *_ref = \
1042 (zend_reference *) emalloc(sizeof(zend_reference)); \
1043 GC_SET_REFCOUNT(_ref, 1); \
1044 GC_TYPE_INFO(_ref) = GC_REFERENCE; \
1045 _ref->sources.ptr = NULL; \
1046 Z_REF_P(z) = _ref; \
1047 Z_TYPE_INFO_P(z) = IS_REFERENCE_EX; \
1048 } while (0)
1049
1050 #define ZVAL_NEW_REF(z, r) do { \
1051 zend_reference *_ref = \
1052 (zend_reference *) emalloc(sizeof(zend_reference)); \
1053 GC_SET_REFCOUNT(_ref, 1); \
1054 GC_TYPE_INFO(_ref) = GC_REFERENCE; \
1055 ZVAL_COPY_VALUE(&_ref->val, r); \
1056 _ref->sources.ptr = NULL; \
1057 Z_REF_P(z) = _ref; \
1058 Z_TYPE_INFO_P(z) = IS_REFERENCE_EX; \
1059 } while (0)
1060
1061 #define ZVAL_MAKE_REF_EX(z, refcount) do { \
1062 zval *_z = (z); \
1063 zend_reference *_ref = \
1064 (zend_reference *) emalloc(sizeof(zend_reference)); \
1065 GC_SET_REFCOUNT(_ref, (refcount)); \
1066 GC_TYPE_INFO(_ref) = GC_REFERENCE; \
1067 ZVAL_COPY_VALUE(&_ref->val, _z); \
1068 _ref->sources.ptr = NULL; \
1069 Z_REF_P(_z) = _ref; \
1070 Z_TYPE_INFO_P(_z) = IS_REFERENCE_EX; \
1071 } while (0)
1072
1073 #define ZVAL_NEW_PERSISTENT_REF(z, r) do { \
1074 zend_reference *_ref = \
1075 (zend_reference *) malloc(sizeof(zend_reference)); \
1076 GC_SET_REFCOUNT(_ref, 1); \
1077 GC_TYPE_INFO(_ref) = GC_REFERENCE | \
1078 (GC_PERSISTENT << GC_FLAGS_SHIFT); \
1079 ZVAL_COPY_VALUE(&_ref->val, r); \
1080 _ref->sources.ptr = NULL; \
1081 Z_REF_P(z) = _ref; \
1082 Z_TYPE_INFO_P(z) = IS_REFERENCE_EX; \
1083 } while (0)
1084
1085 #define ZVAL_AST(z, ast) do { \
1086 zval *__z = (z); \
1087 Z_AST_P(__z) = ast; \
1088 Z_TYPE_INFO_P(__z) = IS_CONSTANT_AST_EX; \
1089 } while (0)
1090
1091 #define ZVAL_INDIRECT(z, v) do { \
1092 Z_INDIRECT_P(z) = (v); \
1093 Z_TYPE_INFO_P(z) = IS_INDIRECT; \
1094 } while (0)
1095
1096 #define ZVAL_PTR(z, p) do { \
1097 Z_PTR_P(z) = (p); \
1098 Z_TYPE_INFO_P(z) = IS_PTR; \
1099 } while (0)
1100
1101 #define ZVAL_FUNC(z, f) do { \
1102 Z_FUNC_P(z) = (f); \
1103 Z_TYPE_INFO_P(z) = IS_PTR; \
1104 } while (0)
1105
1106 #define ZVAL_CE(z, c) do { \
1107 Z_CE_P(z) = (c); \
1108 Z_TYPE_INFO_P(z) = IS_PTR; \
1109 } while (0)
1110
1111 #define ZVAL_ALIAS_PTR(z, p) do { \
1112 Z_PTR_P(z) = (p); \
1113 Z_TYPE_INFO_P(z) = IS_ALIAS_PTR; \
1114 } while (0)
1115
1116 #define ZVAL_ERROR(z) do { \
1117 Z_TYPE_INFO_P(z) = _IS_ERROR; \
1118 } while (0)
1119
1120 #define Z_REFCOUNT_P(pz) zval_refcount_p(pz)
1121 #define Z_SET_REFCOUNT_P(pz, rc) zval_set_refcount_p(pz, rc)
1122 #define Z_ADDREF_P(pz) zval_addref_p(pz)
1123 #define Z_DELREF_P(pz) zval_delref_p(pz)
1124
1125 #define Z_REFCOUNT(z) Z_REFCOUNT_P(&(z))
1126 #define Z_SET_REFCOUNT(z, rc) Z_SET_REFCOUNT_P(&(z), rc)
1127 #define Z_ADDREF(z) Z_ADDREF_P(&(z))
1128 #define Z_DELREF(z) Z_DELREF_P(&(z))
1129
1130 #define Z_TRY_ADDREF_P(pz) do { \
1131 if (Z_REFCOUNTED_P((pz))) { \
1132 Z_ADDREF_P((pz)); \
1133 } \
1134 } while (0)
1135
1136 #define Z_TRY_DELREF_P(pz) do { \
1137 if (Z_REFCOUNTED_P((pz))) { \
1138 Z_DELREF_P((pz)); \
1139 } \
1140 } while (0)
1141
1142 #define Z_TRY_ADDREF(z) Z_TRY_ADDREF_P(&(z))
1143 #define Z_TRY_DELREF(z) Z_TRY_DELREF_P(&(z))
1144
1145 #ifndef ZEND_RC_DEBUG
1146 # define ZEND_RC_DEBUG 0
1147 #endif
1148
1149 #if ZEND_RC_DEBUG
1150 extern ZEND_API bool zend_rc_debug;
1151 /* The GC_PERSISTENT flag is reused for IS_OBJ_WEAKLY_REFERENCED on objects.
1152 * Skip checks for OBJECT/NULL type to avoid interpreting the flag incorrectly. */
1153 # define ZEND_RC_MOD_CHECK(p) do { \
1154 if (zend_rc_debug) { \
1155 zend_uchar type = zval_gc_type((p)->u.type_info); \
1156 if (type != IS_OBJECT && type != IS_NULL) { \
1157 ZEND_ASSERT(!(zval_gc_flags((p)->u.type_info) & GC_IMMUTABLE)); \
1158 ZEND_ASSERT((zval_gc_flags((p)->u.type_info) & (GC_PERSISTENT|GC_PERSISTENT_LOCAL)) != GC_PERSISTENT); \
1159 } \
1160 } \
1161 } while (0)
1162 # define GC_MAKE_PERSISTENT_LOCAL(p) do { \
1163 GC_ADD_FLAGS(p, GC_PERSISTENT_LOCAL); \
1164 } while (0)
1165 #else
1166 # define ZEND_RC_MOD_CHECK(p) \
1167 do { } while (0)
1168 # define GC_MAKE_PERSISTENT_LOCAL(p) \
1169 do { } while (0)
1170 #endif
1171
zend_gc_refcount(const zend_refcounted_h * p)1172 static zend_always_inline uint32_t zend_gc_refcount(const zend_refcounted_h *p) {
1173 return p->refcount;
1174 }
1175
zend_gc_set_refcount(zend_refcounted_h * p,uint32_t rc)1176 static zend_always_inline uint32_t zend_gc_set_refcount(zend_refcounted_h *p, uint32_t rc) {
1177 p->refcount = rc;
1178 return p->refcount;
1179 }
1180
zend_gc_addref(zend_refcounted_h * p)1181 static zend_always_inline uint32_t zend_gc_addref(zend_refcounted_h *p) {
1182 ZEND_RC_MOD_CHECK(p);
1183 return ++(p->refcount);
1184 }
1185
zend_gc_try_addref(zend_refcounted_h * p)1186 static zend_always_inline void zend_gc_try_addref(zend_refcounted_h *p) {
1187 if (!(p->u.type_info & GC_IMMUTABLE)) {
1188 ZEND_RC_MOD_CHECK(p);
1189 ++p->refcount;
1190 }
1191 }
1192
zend_gc_try_delref(zend_refcounted_h * p)1193 static zend_always_inline void zend_gc_try_delref(zend_refcounted_h *p) {
1194 if (!(p->u.type_info & GC_IMMUTABLE)) {
1195 ZEND_RC_MOD_CHECK(p);
1196 --p->refcount;
1197 }
1198 }
1199
zend_gc_delref(zend_refcounted_h * p)1200 static zend_always_inline uint32_t zend_gc_delref(zend_refcounted_h *p) {
1201 ZEND_ASSERT(p->refcount > 0);
1202 ZEND_RC_MOD_CHECK(p);
1203 return --(p->refcount);
1204 }
1205
zend_gc_addref_ex(zend_refcounted_h * p,uint32_t rc)1206 static zend_always_inline uint32_t zend_gc_addref_ex(zend_refcounted_h *p, uint32_t rc) {
1207 ZEND_RC_MOD_CHECK(p);
1208 p->refcount += rc;
1209 return p->refcount;
1210 }
1211
zend_gc_delref_ex(zend_refcounted_h * p,uint32_t rc)1212 static zend_always_inline uint32_t zend_gc_delref_ex(zend_refcounted_h *p, uint32_t rc) {
1213 ZEND_RC_MOD_CHECK(p);
1214 p->refcount -= rc;
1215 return p->refcount;
1216 }
1217
zval_refcount_p(const zval * pz)1218 static zend_always_inline uint32_t zval_refcount_p(const zval* pz) {
1219 #if ZEND_DEBUG
1220 ZEND_ASSERT(Z_REFCOUNTED_P(pz) || Z_TYPE_P(pz) == IS_ARRAY);
1221 #endif
1222 return GC_REFCOUNT(Z_COUNTED_P(pz));
1223 }
1224
zval_set_refcount_p(zval * pz,uint32_t rc)1225 static zend_always_inline uint32_t zval_set_refcount_p(zval* pz, uint32_t rc) {
1226 ZEND_ASSERT(Z_REFCOUNTED_P(pz));
1227 return GC_SET_REFCOUNT(Z_COUNTED_P(pz), rc);
1228 }
1229
zval_addref_p(zval * pz)1230 static zend_always_inline uint32_t zval_addref_p(zval* pz) {
1231 ZEND_ASSERT(Z_REFCOUNTED_P(pz));
1232 return GC_ADDREF(Z_COUNTED_P(pz));
1233 }
1234
zval_delref_p(zval * pz)1235 static zend_always_inline uint32_t zval_delref_p(zval* pz) {
1236 ZEND_ASSERT(Z_REFCOUNTED_P(pz));
1237 return GC_DELREF(Z_COUNTED_P(pz));
1238 }
1239
1240 #if SIZEOF_SIZE_T == 4
1241 # define ZVAL_COPY_VALUE_EX(z, v, gc, t) \
1242 do { \
1243 uint32_t _w2 = v->value.ww.w2; \
1244 Z_COUNTED_P(z) = gc; \
1245 z->value.ww.w2 = _w2; \
1246 Z_TYPE_INFO_P(z) = t; \
1247 } while (0)
1248 #elif SIZEOF_SIZE_T == 8
1249 # define ZVAL_COPY_VALUE_EX(z, v, gc, t) \
1250 do { \
1251 Z_COUNTED_P(z) = gc; \
1252 Z_TYPE_INFO_P(z) = t; \
1253 } while (0)
1254 #else
1255 # error "Unknown SIZEOF_SIZE_T"
1256 #endif
1257
1258 #define ZVAL_COPY_VALUE(z, v) \
1259 do { \
1260 zval *_z1 = (z); \
1261 const zval *_z2 = (v); \
1262 zend_refcounted *_gc = Z_COUNTED_P(_z2); \
1263 uint32_t _t = Z_TYPE_INFO_P(_z2); \
1264 ZVAL_COPY_VALUE_EX(_z1, _z2, _gc, _t); \
1265 } while (0)
1266
1267 #define ZVAL_COPY(z, v) \
1268 do { \
1269 zval *_z1 = (z); \
1270 const zval *_z2 = (v); \
1271 zend_refcounted *_gc = Z_COUNTED_P(_z2); \
1272 uint32_t _t = Z_TYPE_INFO_P(_z2); \
1273 ZVAL_COPY_VALUE_EX(_z1, _z2, _gc, _t); \
1274 if (Z_TYPE_INFO_REFCOUNTED(_t)) { \
1275 GC_ADDREF(_gc); \
1276 } \
1277 } while (0)
1278
1279 #define ZVAL_DUP(z, v) \
1280 do { \
1281 zval *_z1 = (z); \
1282 const zval *_z2 = (v); \
1283 zend_refcounted *_gc = Z_COUNTED_P(_z2); \
1284 uint32_t _t = Z_TYPE_INFO_P(_z2); \
1285 if ((_t & Z_TYPE_MASK) == IS_ARRAY) { \
1286 ZVAL_ARR(_z1, zend_array_dup((zend_array*)_gc));\
1287 } else { \
1288 if (Z_TYPE_INFO_REFCOUNTED(_t)) { \
1289 GC_ADDREF(_gc); \
1290 } \
1291 ZVAL_COPY_VALUE_EX(_z1, _z2, _gc, _t); \
1292 } \
1293 } while (0)
1294
1295
1296 /* ZVAL_COPY_OR_DUP() should be used instead of ZVAL_COPY() and ZVAL_DUP()
1297 * in all places where the source may be a persistent zval.
1298 */
1299 #define ZVAL_COPY_OR_DUP(z, v) \
1300 do { \
1301 zval *_z1 = (z); \
1302 const zval *_z2 = (v); \
1303 zend_refcounted *_gc = Z_COUNTED_P(_z2); \
1304 uint32_t _t = Z_TYPE_INFO_P(_z2); \
1305 ZVAL_COPY_VALUE_EX(_z1, _z2, _gc, _t); \
1306 if (Z_TYPE_INFO_REFCOUNTED(_t)) { \
1307 /* Objects reuse PERSISTENT as WEAKLY_REFERENCED */ \
1308 if (EXPECTED(!(GC_FLAGS(_gc) & GC_PERSISTENT) \
1309 || GC_TYPE(_gc) == IS_OBJECT)) { \
1310 GC_ADDREF(_gc); \
1311 } else { \
1312 zval_copy_ctor_func(_z1); \
1313 } \
1314 } \
1315 } while (0)
1316
1317 #define ZVAL_DEREF(z) do { \
1318 if (UNEXPECTED(Z_ISREF_P(z))) { \
1319 (z) = Z_REFVAL_P(z); \
1320 } \
1321 } while (0)
1322
1323 #define ZVAL_DEINDIRECT(z) do { \
1324 if (Z_TYPE_P(z) == IS_INDIRECT) { \
1325 (z) = Z_INDIRECT_P(z); \
1326 } \
1327 } while (0)
1328
1329 #define ZVAL_OPT_DEREF(z) do { \
1330 if (UNEXPECTED(Z_OPT_ISREF_P(z))) { \
1331 (z) = Z_REFVAL_P(z); \
1332 } \
1333 } while (0)
1334
1335 #define ZVAL_MAKE_REF(zv) do { \
1336 zval *__zv = (zv); \
1337 if (!Z_ISREF_P(__zv)) { \
1338 ZVAL_NEW_REF(__zv, __zv); \
1339 } \
1340 } while (0)
1341
1342 #define ZVAL_UNREF(z) do { \
1343 zval *_z = (z); \
1344 zend_reference *ref; \
1345 ZEND_ASSERT(Z_ISREF_P(_z)); \
1346 ref = Z_REF_P(_z); \
1347 ZVAL_COPY_VALUE(_z, &ref->val); \
1348 efree_size(ref, sizeof(zend_reference)); \
1349 } while (0)
1350
1351 #define ZVAL_COPY_DEREF(z, v) do { \
1352 zval *_z3 = (v); \
1353 if (Z_OPT_REFCOUNTED_P(_z3)) { \
1354 if (UNEXPECTED(Z_OPT_ISREF_P(_z3))) { \
1355 _z3 = Z_REFVAL_P(_z3); \
1356 if (Z_OPT_REFCOUNTED_P(_z3)) { \
1357 Z_ADDREF_P(_z3); \
1358 } \
1359 } else { \
1360 Z_ADDREF_P(_z3); \
1361 } \
1362 } \
1363 ZVAL_COPY_VALUE(z, _z3); \
1364 } while (0)
1365
1366
1367 #define SEPARATE_STRING(zv) do { \
1368 zval *_zv = (zv); \
1369 if (Z_REFCOUNT_P(_zv) > 1) { \
1370 zend_string *_str = Z_STR_P(_zv); \
1371 ZEND_ASSERT(Z_REFCOUNTED_P(_zv)); \
1372 ZEND_ASSERT(!ZSTR_IS_INTERNED(_str)); \
1373 ZVAL_NEW_STR(_zv, zend_string_init( \
1374 ZSTR_VAL(_str), ZSTR_LEN(_str), 0)); \
1375 GC_DELREF(_str); \
1376 } \
1377 } while (0)
1378
1379 #define SEPARATE_ARRAY(zv) do { \
1380 zval *__zv = (zv); \
1381 zend_array *_arr = Z_ARR_P(__zv); \
1382 if (UNEXPECTED(GC_REFCOUNT(_arr) > 1)) { \
1383 ZVAL_ARR(__zv, zend_array_dup(_arr)); \
1384 GC_TRY_DELREF(_arr); \
1385 } \
1386 } while (0)
1387
1388 #define SEPARATE_ZVAL_NOREF(zv) do { \
1389 zval *_zv = (zv); \
1390 ZEND_ASSERT(Z_TYPE_P(_zv) != IS_REFERENCE); \
1391 if (Z_TYPE_P(_zv) == IS_ARRAY) { \
1392 SEPARATE_ARRAY(_zv); \
1393 } \
1394 } while (0)
1395
1396 #define SEPARATE_ZVAL(zv) do { \
1397 zval *_zv = (zv); \
1398 if (Z_ISREF_P(_zv)) { \
1399 zend_reference *_r = Z_REF_P(_zv); \
1400 ZVAL_COPY_VALUE(_zv, &_r->val); \
1401 if (GC_DELREF(_r) == 0) { \
1402 efree_size(_r, sizeof(zend_reference)); \
1403 } else if (Z_OPT_TYPE_P(_zv) == IS_ARRAY) { \
1404 ZVAL_ARR(_zv, zend_array_dup(Z_ARR_P(_zv)));\
1405 break; \
1406 } else if (Z_OPT_REFCOUNTED_P(_zv)) { \
1407 Z_ADDREF_P(_zv); \
1408 break; \
1409 } \
1410 } \
1411 if (Z_TYPE_P(_zv) == IS_ARRAY) { \
1412 SEPARATE_ARRAY(_zv); \
1413 } \
1414 } while (0)
1415
1416 /* Properties store a flag distinguishing unset and uninitialized properties
1417 * (both use IS_UNDEF type) in the Z_EXTRA space. As such we also need to copy
1418 * the Z_EXTRA space when copying property default values etc. We define separate
1419 * macros for this purpose, so this workaround is easier to remove in the future. */
1420 #define IS_PROP_UNINIT 1
1421 #define Z_PROP_FLAG_P(z) Z_EXTRA_P(z)
1422 #define ZVAL_COPY_VALUE_PROP(z, v) \
1423 do { *(z) = *(v); } while (0)
1424 #define ZVAL_COPY_PROP(z, v) \
1425 do { ZVAL_COPY(z, v); Z_PROP_FLAG_P(z) = Z_PROP_FLAG_P(v); } while (0)
1426 #define ZVAL_COPY_OR_DUP_PROP(z, v) \
1427 do { ZVAL_COPY_OR_DUP(z, v); Z_PROP_FLAG_P(z) = Z_PROP_FLAG_P(v); } while (0)
1428
1429
1430 #endif /* ZEND_TYPES_H */
1431