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