1 /*
2 +----------------------------------------------------------------------+
3 | Copyright (c) The PHP Group |
4 +----------------------------------------------------------------------+
5 | This source file is subject to version 2.00 of the Zend license, |
6 | that is bundled with this package in the file LICENSE, and is |
7 | available through the world-wide-web at the following url: |
8 | http://www.zend.com/license/2_00.txt. |
9 | If you did not receive a copy of the Zend license and are unable to |
10 | obtain it through the world-wide-web, please send a note to |
11 | license@zend.com so we can mail you a copy immediately. |
12 +----------------------------------------------------------------------+
13 | Authors: krakjoe@php.net |
14 +----------------------------------------------------------------------+
15 */
16
17 #include "zend.h"
18 #include "zend_interfaces.h"
19 #include "zend_objects_API.h"
20 #include "zend_types.h"
21 #include "zend_weakrefs.h"
22 #include "zend_weakrefs_arginfo.h"
23
24 typedef struct _zend_weakref {
25 zend_object *referent;
26 zend_object std;
27 } zend_weakref;
28
29 typedef struct _zend_weakmap {
30 HashTable ht;
31 zend_object std;
32 } zend_weakmap;
33
34 typedef struct _zend_weakmap_iterator {
35 zend_object_iterator it;
36 uint32_t ht_iter;
37 } zend_weakmap_iterator;
38
39 /* EG(weakrefs) is a map from a key corresponding to a zend_object pointer to all the WeakReference and/or WeakMap entries relating to that pointer.
40 *
41 * 1. For a single WeakReference,
42 * the HashTable's corresponding value's tag is a ZEND_WEAKREF_TAG_REF and the pointer is a singleton WeakReference instance (zend_weakref *) for that zend_object pointer (from WeakReference::create()).
43 * 2. For a single WeakMap, the HashTable's corresponding value's tag is a ZEND_WEAKREF_TAG_MAP and the pointer is a WeakMap instance (zend_weakmap *).
44 * 3. For multiple values associated with the same zend_object pointer, the HashTable entry's tag is a ZEND_WEAKREF_TAG_HT with a HashTable mapping
45 * tagged pointers of at most 1 WeakReference and 1 or more WeakMaps to the same tagged pointer.
46 *
47 * ZEND_MM_ALIGNED_OFFSET_LOG2 is at least 2 on supported architectures (pointers to the objects in question are aligned to 4 bytes (1<<2) even on 32-bit systems),
48 * i.e. the least two significant bits of the pointer can be used as a tag (ZEND_WEAKREF_TAG_*). */
49 #define ZEND_WEAKREF_TAG_REF 0
50 #define ZEND_WEAKREF_TAG_MAP 1
51 #define ZEND_WEAKREF_TAG_HT 2
52 #define ZEND_WEAKREF_GET_TAG(p) (((uintptr_t) (p)) & 3)
53 #define ZEND_WEAKREF_GET_PTR(p) ((void *) (((uintptr_t) (p)) & ~3))
54 #define ZEND_WEAKREF_ENCODE(p, t) ((void *) (((uintptr_t) (p)) | (t)))
55
56 zend_class_entry *zend_ce_weakref;
57 zend_class_entry *zend_ce_weakmap;
58 static zend_object_handlers zend_weakref_handlers;
59 static zend_object_handlers zend_weakmap_handlers;
60
61 #define zend_weakref_from(o) ((zend_weakref*)(((char*) o) - XtOffsetOf(zend_weakref, std)))
62 #define zend_weakref_fetch(z) zend_weakref_from(Z_OBJ_P(z))
63
64 #define zend_weakmap_from(o) ((zend_weakmap*)(((char*) o) - XtOffsetOf(zend_weakmap, std)))
65 #define zend_weakmap_fetch(z) zend_weakmap_from(Z_OBJ_P(z))
66
zend_weakref_unref_single(void * ptr,uintptr_t tag,zend_object * object)67 static inline void zend_weakref_unref_single(
68 void *ptr, uintptr_t tag, zend_object *object)
69 {
70 if (tag == ZEND_WEAKREF_TAG_REF) {
71 /* Unreferencing WeakReference (at ptr) singleton that pointed to object. */
72 zend_weakref *wr = ptr;
73 wr->referent = NULL;
74 } else {
75 /* unreferencing WeakMap entry (at ptr) with a key of object. */
76 ZEND_ASSERT(tag == ZEND_WEAKREF_TAG_MAP);
77 zend_hash_index_del((HashTable *) ptr, zend_object_to_weakref_key(object));
78 }
79 }
80
zend_weakref_unref(zend_object * object,void * tagged_ptr)81 static void zend_weakref_unref(zend_object *object, void *tagged_ptr) {
82 void *ptr = ZEND_WEAKREF_GET_PTR(tagged_ptr);
83 uintptr_t tag = ZEND_WEAKREF_GET_TAG(tagged_ptr);
84 if (tag == ZEND_WEAKREF_TAG_HT) {
85 HashTable *ht = ptr;
86 ZEND_HASH_MAP_FOREACH_PTR(ht, tagged_ptr) {
87 zend_weakref_unref_single(
88 ZEND_WEAKREF_GET_PTR(tagged_ptr), ZEND_WEAKREF_GET_TAG(tagged_ptr), object);
89 } ZEND_HASH_FOREACH_END();
90 zend_hash_destroy(ht);
91 FREE_HASHTABLE(ht);
92 } else {
93 zend_weakref_unref_single(ptr, tag, object);
94 }
95 }
96
zend_weakref_register(zend_object * object,void * payload)97 static void zend_weakref_register(zend_object *object, void *payload) {
98 GC_ADD_FLAGS(object, IS_OBJ_WEAKLY_REFERENCED);
99
100 zend_ulong obj_key = zend_object_to_weakref_key(object);
101 zval *zv = zend_hash_index_lookup(&EG(weakrefs), obj_key);
102 if (Z_TYPE_P(zv) == IS_NULL) {
103 ZVAL_PTR(zv, payload);
104 return;
105 }
106
107 void *tagged_ptr = Z_PTR_P(zv);
108 if (ZEND_WEAKREF_GET_TAG(tagged_ptr) == ZEND_WEAKREF_TAG_HT) {
109 HashTable *ht = ZEND_WEAKREF_GET_PTR(tagged_ptr);
110 zend_hash_index_add_new_ptr(ht, (zend_ulong) payload, payload);
111 return;
112 }
113
114 /* Convert simple pointer to hashtable. */
115 HashTable *ht = emalloc(sizeof(HashTable));
116 zend_hash_init(ht, 0, NULL, NULL, 0);
117 zend_hash_index_add_new_ptr(ht, (zend_ulong) tagged_ptr, tagged_ptr);
118 zend_hash_index_add_new_ptr(ht, (zend_ulong) payload, payload);
119 /* Replace the single WeakMap or WeakReference entry in EG(weakrefs) with a HashTable with 2 entries in place. */
120 ZVAL_PTR(zv, ZEND_WEAKREF_ENCODE(ht, ZEND_WEAKREF_TAG_HT));
121 }
122
zend_weakref_unregister(zend_object * object,void * payload,bool weakref_free)123 static void zend_weakref_unregister(zend_object *object, void *payload, bool weakref_free) {
124 zend_ulong obj_key = zend_object_to_weakref_key(object);
125 void *tagged_ptr = zend_hash_index_find_ptr(&EG(weakrefs), obj_key);
126 ZEND_ASSERT(tagged_ptr && "Weakref not registered?");
127
128 void *ptr = ZEND_WEAKREF_GET_PTR(tagged_ptr);
129 uintptr_t tag = ZEND_WEAKREF_GET_TAG(tagged_ptr);
130 if (tag != ZEND_WEAKREF_TAG_HT) {
131 ZEND_ASSERT(tagged_ptr == payload);
132 zend_hash_index_del(&EG(weakrefs), obj_key);
133 GC_DEL_FLAGS(object, IS_OBJ_WEAKLY_REFERENCED);
134
135 /* Do this last, as it may destroy the object. */
136 if (weakref_free) {
137 zend_weakref_unref_single(ptr, tag, object);
138 } else {
139 /* The optimization of skipping unref is only used in the destructor of WeakMap */
140 ZEND_ASSERT(ZEND_WEAKREF_GET_TAG(payload) == ZEND_WEAKREF_TAG_MAP);
141 }
142 return;
143 }
144
145 HashTable *ht = ptr;
146 #if ZEND_DEBUG
147 void *old_payload = zend_hash_index_find_ptr(ht, (zend_ulong) payload);
148 ZEND_ASSERT(old_payload && "Weakref not registered?");
149 ZEND_ASSERT(old_payload == payload);
150 #endif
151 zend_hash_index_del(ht, (zend_ulong) payload);
152 if (zend_hash_num_elements(ht) == 0) {
153 GC_DEL_FLAGS(object, IS_OBJ_WEAKLY_REFERENCED);
154 zend_hash_destroy(ht);
155 FREE_HASHTABLE(ht);
156 zend_hash_index_del(&EG(weakrefs), obj_key);
157 }
158
159 /* Do this last, as it may destroy the object. */
160 if (weakref_free) {
161 zend_weakref_unref_single(
162 ZEND_WEAKREF_GET_PTR(payload), ZEND_WEAKREF_GET_TAG(payload), object);
163 } else {
164 /* The optimization of skipping unref is only used in the destructor of WeakMap */
165 ZEND_ASSERT(ZEND_WEAKREF_GET_TAG(payload) == ZEND_WEAKREF_TAG_MAP);
166 }
167 }
168
zend_weakrefs_hash_add(HashTable * ht,zend_object * key,zval * pData)169 ZEND_API zval *zend_weakrefs_hash_add(HashTable *ht, zend_object *key, zval *pData) {
170 zval *zv = zend_hash_index_add(ht, zend_object_to_weakref_key(key), pData);
171 if (zv) {
172 zend_weakref_register(key, ZEND_WEAKREF_ENCODE(ht, ZEND_WEAKREF_TAG_MAP));
173 }
174 return zv;
175 }
176
zend_weakrefs_hash_del(HashTable * ht,zend_object * key)177 ZEND_API zend_result zend_weakrefs_hash_del(HashTable *ht, zend_object *key) {
178 zval *zv = zend_hash_index_find(ht, zend_object_to_weakref_key(key));
179 if (zv) {
180 zend_weakref_unregister(key, ZEND_WEAKREF_ENCODE(ht, ZEND_WEAKREF_TAG_MAP), 1);
181 return SUCCESS;
182 }
183 return FAILURE;
184 }
185
zend_weakrefs_init(void)186 void zend_weakrefs_init(void) {
187 zend_hash_init(&EG(weakrefs), 8, NULL, NULL, 0);
188 }
189
190 /* This is called when the object is garbage collected
191 * to remove all WeakReference and WeakMap entries weakly referencing that object. */
zend_weakrefs_notify(zend_object * object)192 void zend_weakrefs_notify(zend_object *object) {
193 /* Annoyingly we can't use the HT destructor here, because we need access to the key (which
194 * is the object address), which is not provided to the dtor. */
195 const zend_ulong obj_key = zend_object_to_weakref_key(object);
196 void *tagged_ptr = zend_hash_index_find_ptr(&EG(weakrefs), obj_key);
197 #if ZEND_DEBUG
198 ZEND_ASSERT(tagged_ptr && "Tracking of the IS_OBJ_WEAKLY_REFERENCE flag should be precise");
199 #endif
200 if (tagged_ptr) {
201 zend_weakref_unref(object, tagged_ptr);
202 zend_hash_index_del(&EG(weakrefs), obj_key);
203 }
204 }
205
zend_weakrefs_shutdown(void)206 void zend_weakrefs_shutdown(void) {
207 zend_hash_destroy(&EG(weakrefs));
208 }
209
zend_weakref_new(zend_class_entry * ce)210 static zend_object* zend_weakref_new(zend_class_entry *ce) {
211 zend_weakref *wr = zend_object_alloc(sizeof(zend_weakref), zend_ce_weakref);
212
213 zend_object_std_init(&wr->std, zend_ce_weakref);
214 return &wr->std;
215 }
216
zend_weakref_find(zend_object * referent,zval * return_value)217 static zend_always_inline bool zend_weakref_find(zend_object *referent, zval *return_value) {
218 void *tagged_ptr = zend_hash_index_find_ptr(&EG(weakrefs), zend_object_to_weakref_key(referent));
219 if (!tagged_ptr) {
220 return 0;
221 }
222
223 void *ptr = ZEND_WEAKREF_GET_PTR(tagged_ptr);
224 uintptr_t tag = ZEND_WEAKREF_GET_TAG(tagged_ptr);
225 if (tag == ZEND_WEAKREF_TAG_REF) {
226 zend_weakref *wr;
227 found_weakref:
228 wr = ptr;
229 RETVAL_OBJ_COPY(&wr->std);
230 return 1;
231 }
232
233 if (tag == ZEND_WEAKREF_TAG_HT) {
234 ZEND_HASH_MAP_FOREACH_PTR(ptr, tagged_ptr) {
235 if (ZEND_WEAKREF_GET_TAG(tagged_ptr) == ZEND_WEAKREF_TAG_REF) {
236 ptr = ZEND_WEAKREF_GET_PTR(tagged_ptr);
237 goto found_weakref;
238 }
239 } ZEND_HASH_FOREACH_END();
240 }
241
242 return 0;
243 }
244
zend_weakref_create(zend_object * referent,zval * return_value)245 static zend_always_inline void zend_weakref_create(zend_object *referent, zval *return_value) {
246 zend_weakref *wr;
247
248 object_init_ex(return_value, zend_ce_weakref);
249
250 wr = zend_weakref_fetch(return_value);
251 wr->referent = referent;
252
253 zend_weakref_register(wr->referent, ZEND_WEAKREF_ENCODE(wr, ZEND_WEAKREF_TAG_REF));
254 }
255
zend_weakref_get(zval * weakref,zval * return_value)256 static zend_always_inline void zend_weakref_get(zval *weakref, zval *return_value) {
257 zend_weakref *wr = zend_weakref_fetch(weakref);
258
259 if (wr->referent) {
260 RETVAL_OBJ_COPY(wr->referent);
261 }
262 }
263
zend_weakref_free(zend_object * zo)264 static void zend_weakref_free(zend_object *zo) {
265 zend_weakref *wr = zend_weakref_from(zo);
266
267 if (wr->referent) {
268 zend_weakref_unregister(wr->referent, ZEND_WEAKREF_ENCODE(wr, ZEND_WEAKREF_TAG_REF), 1);
269 }
270
271 zend_object_std_dtor(&wr->std);
272 }
273
ZEND_METHOD(WeakReference,__construct)274 ZEND_COLD ZEND_METHOD(WeakReference, __construct)
275 {
276 zend_throw_error(NULL, "Direct instantiation of WeakReference is not allowed, use WeakReference::create instead");
277 }
278
ZEND_METHOD(WeakReference,create)279 ZEND_METHOD(WeakReference, create)
280 {
281 zend_object *referent;
282
283 ZEND_PARSE_PARAMETERS_START(1,1)
284 Z_PARAM_OBJ(referent)
285 ZEND_PARSE_PARAMETERS_END();
286
287 if (zend_weakref_find(referent, return_value)) {
288 return;
289 }
290
291 zend_weakref_create(referent, return_value);
292 }
293
ZEND_METHOD(WeakReference,get)294 ZEND_METHOD(WeakReference, get)
295 {
296 ZEND_PARSE_PARAMETERS_NONE();
297
298 zend_weakref_get(getThis(), return_value);
299 }
300
zend_weakmap_create_object(zend_class_entry * ce)301 static zend_object *zend_weakmap_create_object(zend_class_entry *ce)
302 {
303 zend_weakmap *wm = zend_object_alloc(sizeof(zend_weakmap), ce);
304 zend_object_std_init(&wm->std, ce);
305
306 zend_hash_init(&wm->ht, 0, NULL, ZVAL_PTR_DTOR, 0);
307 return &wm->std;
308 }
309
zend_weakmap_free_obj(zend_object * object)310 static void zend_weakmap_free_obj(zend_object *object)
311 {
312 zend_weakmap *wm = zend_weakmap_from(object);
313 zend_ulong obj_key;
314 ZEND_HASH_MAP_FOREACH_NUM_KEY(&wm->ht, obj_key) {
315 /* Optimization: Don't call zend_weakref_unref_single to free individual entries from wm->ht when unregistering (which would do a hash table lookup, call zend_hash_index_del, and skip over any bucket collisions).
316 * Let freeing the corresponding values for WeakMap entries be done in zend_hash_destroy, freeing objects sequentially.
317 * The performance difference is notable for larger WeakMaps with worse cache locality. */
318 zend_weakref_unregister(
319 zend_weakref_key_to_object(obj_key), ZEND_WEAKREF_ENCODE(&wm->ht, ZEND_WEAKREF_TAG_MAP), 0);
320 } ZEND_HASH_FOREACH_END();
321 zend_hash_destroy(&wm->ht);
322 zend_object_std_dtor(&wm->std);
323 }
324
zend_weakmap_read_dimension(zend_object * object,zval * offset,int type,zval * rv)325 static zval *zend_weakmap_read_dimension(zend_object *object, zval *offset, int type, zval *rv)
326 {
327 if (offset == NULL) {
328 zend_throw_error(NULL, "Cannot append to WeakMap");
329 return NULL;
330 }
331
332 ZVAL_DEREF(offset);
333 if (Z_TYPE_P(offset) != IS_OBJECT) {
334 zend_type_error("WeakMap key must be an object");
335 return NULL;
336 }
337
338 zend_weakmap *wm = zend_weakmap_from(object);
339 zend_object *obj_addr = Z_OBJ_P(offset);
340 zval *zv = zend_hash_index_find(&wm->ht, zend_object_to_weakref_key(obj_addr));
341 if (zv == NULL) {
342 if (type != BP_VAR_IS) {
343 zend_throw_error(NULL,
344 "Object %s#%d not contained in WeakMap", ZSTR_VAL(obj_addr->ce->name), obj_addr->handle);
345 return NULL;
346 }
347 return NULL;
348 }
349
350 if (type == BP_VAR_W || type == BP_VAR_RW) {
351 ZVAL_MAKE_REF(zv);
352 }
353 return zv;
354 }
355
zend_weakmap_write_dimension(zend_object * object,zval * offset,zval * value)356 static void zend_weakmap_write_dimension(zend_object *object, zval *offset, zval *value)
357 {
358 if (offset == NULL) {
359 zend_throw_error(NULL, "Cannot append to WeakMap");
360 return;
361 }
362
363 ZVAL_DEREF(offset);
364 if (Z_TYPE_P(offset) != IS_OBJECT) {
365 zend_type_error("WeakMap key must be an object");
366 return;
367 }
368
369 zend_weakmap *wm = zend_weakmap_from(object);
370 zend_object *obj_addr = Z_OBJ_P(offset);
371 zend_ulong obj_key = zend_object_to_weakref_key(obj_addr);
372 Z_TRY_ADDREF_P(value);
373
374 zval *zv = zend_hash_index_find(&wm->ht, obj_key);
375 if (zv) {
376 /* Because the destructors can have side effects such as resizing or rehashing the WeakMap storage,
377 * free the zval only after overwriting the original value. */
378 zval zv_orig;
379 ZVAL_COPY_VALUE(&zv_orig, zv);
380 ZVAL_COPY_VALUE(zv, value);
381 zval_ptr_dtor(&zv_orig);
382 return;
383 }
384
385 zend_weakref_register(obj_addr, ZEND_WEAKREF_ENCODE(&wm->ht, ZEND_WEAKREF_TAG_MAP));
386 zend_hash_index_add_new(&wm->ht, obj_key, value);
387 }
388
389 /* int return and check_empty due to Object Handler API */
zend_weakmap_has_dimension(zend_object * object,zval * offset,int check_empty)390 static int zend_weakmap_has_dimension(zend_object *object, zval *offset, int check_empty)
391 {
392 ZVAL_DEREF(offset);
393 if (Z_TYPE_P(offset) != IS_OBJECT) {
394 zend_type_error("WeakMap key must be an object");
395 return 0;
396 }
397
398 zend_weakmap *wm = zend_weakmap_from(object);
399 zval *zv = zend_hash_index_find(&wm->ht, zend_object_to_weakref_key(Z_OBJ_P(offset)));
400 if (!zv) {
401 return 0;
402 }
403
404 if (check_empty) {
405 return i_zend_is_true(zv);
406 }
407 return Z_TYPE_P(zv) != IS_NULL;
408 }
409
zend_weakmap_unset_dimension(zend_object * object,zval * offset)410 static void zend_weakmap_unset_dimension(zend_object *object, zval *offset)
411 {
412 ZVAL_DEREF(offset);
413 if (Z_TYPE_P(offset) != IS_OBJECT) {
414 zend_type_error("WeakMap key must be an object");
415 return;
416 }
417
418 zend_weakmap *wm = zend_weakmap_from(object);
419 zend_object *obj_addr = Z_OBJ_P(offset);
420 if (!zend_hash_index_exists(&wm->ht, zend_object_to_weakref_key(obj_addr))) {
421 /* Object not in WeakMap, do nothing. */
422 return;
423 }
424
425 zend_weakref_unregister(obj_addr, ZEND_WEAKREF_ENCODE(&wm->ht, ZEND_WEAKREF_TAG_MAP), 1);
426 }
427
zend_weakmap_count_elements(zend_object * object,zend_long * count)428 static zend_result zend_weakmap_count_elements(zend_object *object, zend_long *count)
429 {
430 zend_weakmap *wm = zend_weakmap_from(object);
431 *count = zend_hash_num_elements(&wm->ht);
432 return SUCCESS;
433 }
434
zend_weakmap_get_properties_for(zend_object * object,zend_prop_purpose purpose)435 static HashTable *zend_weakmap_get_properties_for(zend_object *object, zend_prop_purpose purpose)
436 {
437 if (purpose != ZEND_PROP_PURPOSE_DEBUG) {
438 return NULL;
439 }
440
441 zend_weakmap *wm = zend_weakmap_from(object);
442 HashTable *ht;
443 ALLOC_HASHTABLE(ht);
444 zend_hash_init(ht, zend_hash_num_elements(&wm->ht), NULL, ZVAL_PTR_DTOR, 0);
445
446 zend_ulong obj_key;
447 zval *val;
448 ZEND_HASH_MAP_FOREACH_NUM_KEY_VAL(&wm->ht, obj_key, val) {
449 zend_object *obj = zend_weakref_key_to_object(obj_key);
450 zval pair;
451 array_init(&pair);
452
453 GC_ADDREF(obj);
454 add_assoc_object(&pair, "key", obj);
455 Z_TRY_ADDREF_P(val);
456 add_assoc_zval(&pair, "value", val);
457
458 zend_hash_next_index_insert_new(ht, &pair);
459 } ZEND_HASH_FOREACH_END();
460
461 return ht;
462 }
463
zend_weakmap_get_gc(zend_object * object,zval ** table,int * n)464 HashTable *zend_weakmap_get_gc(zend_object *object, zval **table, int *n)
465 {
466 zend_weakmap *wm = zend_weakmap_from(object);
467 zend_get_gc_buffer *gc_buffer = zend_get_gc_buffer_create();
468 zval *val;
469 ZEND_HASH_MAP_FOREACH_VAL(&wm->ht, val) {
470 zend_get_gc_buffer_add_zval(gc_buffer, val);
471 } ZEND_HASH_FOREACH_END();
472 zend_get_gc_buffer_use(gc_buffer, table, n);
473 return NULL;
474 }
475
zend_weakmap_get_key_entry_gc(zend_object * object,zval ** table,int * n)476 HashTable *zend_weakmap_get_key_entry_gc(zend_object *object, zval **table, int *n)
477 {
478 zend_weakmap *wm = zend_weakmap_from(object);
479 zend_get_gc_buffer *gc_buffer = zend_get_gc_buffer_create();
480 zend_ulong h;
481 zval *val;
482 ZEND_HASH_MAP_FOREACH_NUM_KEY_VAL(&wm->ht, h, val) {
483 zend_object *key = zend_weakref_key_to_object(h);
484 zend_get_gc_buffer_add_obj(gc_buffer, key);
485 zend_get_gc_buffer_add_ptr(gc_buffer, val);
486 } ZEND_HASH_FOREACH_END();
487 zend_get_gc_buffer_use(gc_buffer, table, n);
488 return NULL;
489 }
490
zend_weakmap_get_entry_gc(zend_object * object,zval ** table,int * n)491 HashTable *zend_weakmap_get_entry_gc(zend_object *object, zval **table, int *n)
492 {
493 zend_weakmap *wm = zend_weakmap_from(object);
494 zend_get_gc_buffer *gc_buffer = zend_get_gc_buffer_create();
495 zval *val;
496 ZEND_HASH_MAP_FOREACH_VAL(&wm->ht, val) {
497 zend_get_gc_buffer_add_ptr(gc_buffer, val);
498 } ZEND_HASH_FOREACH_END();
499 zend_get_gc_buffer_use(gc_buffer, table, n);
500 return NULL;
501 }
502
zend_weakmap_get_object_key_entry_gc(zend_object * object,zval ** table,int * n)503 HashTable *zend_weakmap_get_object_key_entry_gc(zend_object *object, zval **table, int *n)
504 {
505 zend_get_gc_buffer *gc_buffer = zend_get_gc_buffer_create();
506 const zend_ulong obj_key = zend_object_to_weakref_key(object);
507 void *tagged_ptr = zend_hash_index_find_ptr(&EG(weakrefs), obj_key);
508 #if ZEND_DEBUG
509 ZEND_ASSERT(tagged_ptr && "Tracking of the IS_OBJ_WEAKLY_REFERENCE flag should be precise");
510 #endif
511 void *ptr = ZEND_WEAKREF_GET_PTR(tagged_ptr);
512 uintptr_t tag = ZEND_WEAKREF_GET_TAG(tagged_ptr);
513
514 if (tag == ZEND_WEAKREF_TAG_HT) {
515 HashTable *ht = ptr;
516 ZEND_HASH_MAP_FOREACH_PTR(ht, tagged_ptr) {
517 if (ZEND_WEAKREF_GET_TAG(tagged_ptr) == ZEND_WEAKREF_TAG_MAP) {
518 zend_weakmap *wm = (zend_weakmap*) ZEND_WEAKREF_GET_PTR(tagged_ptr);
519 zval *zv = zend_hash_index_find(&wm->ht, obj_key);
520 ZEND_ASSERT(zv);
521 zend_get_gc_buffer_add_ptr(gc_buffer, zv);
522 zend_get_gc_buffer_add_obj(gc_buffer, &wm->std);
523 }
524 } ZEND_HASH_FOREACH_END();
525 } else if (tag == ZEND_WEAKREF_TAG_MAP) {
526 zend_weakmap *wm = (zend_weakmap*) ptr;
527 zval *zv = zend_hash_index_find(&wm->ht, obj_key);
528 ZEND_ASSERT(zv);
529 zend_get_gc_buffer_add_ptr(gc_buffer, zv);
530 zend_get_gc_buffer_add_obj(gc_buffer, &wm->std);
531 }
532
533 zend_get_gc_buffer_use(gc_buffer, table, n);
534
535 return NULL;
536 }
537
zend_weakmap_get_object_entry_gc(zend_object * object,zval ** table,int * n)538 HashTable *zend_weakmap_get_object_entry_gc(zend_object *object, zval **table, int *n)
539 {
540 zend_get_gc_buffer *gc_buffer = zend_get_gc_buffer_create();
541 const zend_ulong obj_key = zend_object_to_weakref_key(object);
542 void *tagged_ptr = zend_hash_index_find_ptr(&EG(weakrefs), obj_key);
543 #if ZEND_DEBUG
544 ZEND_ASSERT(tagged_ptr && "Tracking of the IS_OBJ_WEAKLY_REFERENCE flag should be precise");
545 #endif
546 void *ptr = ZEND_WEAKREF_GET_PTR(tagged_ptr);
547 uintptr_t tag = ZEND_WEAKREF_GET_TAG(tagged_ptr);
548
549 if (tag == ZEND_WEAKREF_TAG_HT) {
550 HashTable *ht = ptr;
551 ZEND_HASH_MAP_FOREACH_PTR(ht, tagged_ptr) {
552 if (ZEND_WEAKREF_GET_TAG(tagged_ptr) == ZEND_WEAKREF_TAG_MAP) {
553 zend_weakmap *wm = (zend_weakmap*) ZEND_WEAKREF_GET_PTR(tagged_ptr);
554 zval *zv = zend_hash_index_find(&wm->ht, obj_key);
555 ZEND_ASSERT(zv);
556 zend_get_gc_buffer_add_ptr(gc_buffer, zv);
557 }
558 } ZEND_HASH_FOREACH_END();
559 } else if (tag == ZEND_WEAKREF_TAG_MAP) {
560 zend_weakmap *wm = (zend_weakmap*) ptr;
561 zval *zv = zend_hash_index_find(&wm->ht, obj_key);
562 ZEND_ASSERT(zv);
563 zend_get_gc_buffer_add_ptr(gc_buffer, zv);
564 }
565
566 zend_get_gc_buffer_use(gc_buffer, table, n);
567
568 return NULL;
569 }
570
zend_weakmap_clone_obj(zend_object * old_object)571 static zend_object *zend_weakmap_clone_obj(zend_object *old_object)
572 {
573 zend_object *new_object = zend_weakmap_create_object(zend_ce_weakmap);
574 zend_weakmap *old_wm = zend_weakmap_from(old_object);
575 zend_weakmap *new_wm = zend_weakmap_from(new_object);
576 zend_hash_copy(&new_wm->ht, &old_wm->ht, NULL);
577
578 zend_ulong obj_key;
579 zval *val;
580 ZEND_HASH_MAP_FOREACH_NUM_KEY_VAL(&new_wm->ht, obj_key, val) {
581 zend_weakref_register(
582 zend_weakref_key_to_object(obj_key), ZEND_WEAKREF_ENCODE(new_wm, ZEND_WEAKREF_TAG_MAP));
583 zval_add_ref(val);
584 } ZEND_HASH_FOREACH_END();
585 return new_object;
586 }
587
zend_weakmap_iterator_get_pos_ptr(zend_weakmap_iterator * iter)588 static HashPosition *zend_weakmap_iterator_get_pos_ptr(zend_weakmap_iterator *iter) {
589 ZEND_ASSERT(iter->ht_iter != (uint32_t) -1);
590 return &EG(ht_iterators)[iter->ht_iter].pos;
591 }
592
zend_weakmap_iterator_dtor(zend_object_iterator * obj_iter)593 static void zend_weakmap_iterator_dtor(zend_object_iterator *obj_iter)
594 {
595 zend_weakmap_iterator *iter = (zend_weakmap_iterator *) obj_iter;
596 zend_hash_iterator_del(iter->ht_iter);
597 zval_ptr_dtor(&iter->it.data);
598 }
599
zend_weakmap_iterator_valid(zend_object_iterator * obj_iter)600 static int zend_weakmap_iterator_valid(zend_object_iterator *obj_iter)
601 {
602 zend_weakmap_iterator *iter = (zend_weakmap_iterator *) obj_iter;
603 zend_weakmap *wm = zend_weakmap_fetch(&iter->it.data);
604 HashPosition *pos = zend_weakmap_iterator_get_pos_ptr(iter);
605 return zend_hash_has_more_elements_ex(&wm->ht, pos);
606 }
607
zend_weakmap_iterator_get_current_data(zend_object_iterator * obj_iter)608 static zval *zend_weakmap_iterator_get_current_data(zend_object_iterator *obj_iter)
609 {
610 zend_weakmap_iterator *iter = (zend_weakmap_iterator *) obj_iter;
611 zend_weakmap *wm = zend_weakmap_fetch(&iter->it.data);
612 HashPosition *pos = zend_weakmap_iterator_get_pos_ptr(iter);
613 return zend_hash_get_current_data_ex(&wm->ht, pos);
614 }
615
zend_weakmap_iterator_get_current_key(zend_object_iterator * obj_iter,zval * key)616 static void zend_weakmap_iterator_get_current_key(zend_object_iterator *obj_iter, zval *key)
617 {
618 zend_weakmap_iterator *iter = (zend_weakmap_iterator *) obj_iter;
619 zend_weakmap *wm = zend_weakmap_fetch(&iter->it.data);
620 HashPosition *pos = zend_weakmap_iterator_get_pos_ptr(iter);
621
622 zend_string *string_key;
623 zend_ulong num_key;
624 int key_type = zend_hash_get_current_key_ex(&wm->ht, &string_key, &num_key, pos);
625 if (key_type != HASH_KEY_IS_LONG) {
626 ZEND_ASSERT(0 && "Must have integer key");
627 }
628
629 ZVAL_OBJ_COPY(key, zend_weakref_key_to_object(num_key));
630 }
631
zend_weakmap_iterator_move_forward(zend_object_iterator * obj_iter)632 static void zend_weakmap_iterator_move_forward(zend_object_iterator *obj_iter)
633 {
634 zend_weakmap_iterator *iter = (zend_weakmap_iterator *) obj_iter;
635 zend_weakmap *wm = zend_weakmap_fetch(&iter->it.data);
636 HashPosition *pos = zend_weakmap_iterator_get_pos_ptr(iter);
637 zend_hash_move_forward_ex(&wm->ht, pos);
638 }
639
zend_weakmap_iterator_rewind(zend_object_iterator * obj_iter)640 static void zend_weakmap_iterator_rewind(zend_object_iterator *obj_iter)
641 {
642 zend_weakmap_iterator *iter = (zend_weakmap_iterator *) obj_iter;
643 zend_weakmap *wm = zend_weakmap_fetch(&iter->it.data);
644 HashPosition *pos = zend_weakmap_iterator_get_pos_ptr(iter);
645 zend_hash_internal_pointer_reset_ex(&wm->ht, pos);
646 }
647
648 static const zend_object_iterator_funcs zend_weakmap_iterator_funcs = {
649 zend_weakmap_iterator_dtor,
650 zend_weakmap_iterator_valid,
651 zend_weakmap_iterator_get_current_data,
652 zend_weakmap_iterator_get_current_key,
653 zend_weakmap_iterator_move_forward,
654 zend_weakmap_iterator_rewind,
655 NULL,
656 NULL, /* get_gc */
657 };
658
659 /* by_ref is int due to Iterator API */
zend_weakmap_get_iterator(zend_class_entry * ce,zval * object,int by_ref)660 static zend_object_iterator *zend_weakmap_get_iterator(
661 zend_class_entry *ce, zval *object, int by_ref)
662 {
663 zend_weakmap *wm = zend_weakmap_fetch(object);
664 zend_weakmap_iterator *iter = emalloc(sizeof(zend_weakmap_iterator));
665 zend_iterator_init(&iter->it);
666 iter->it.funcs = &zend_weakmap_iterator_funcs;
667 ZVAL_COPY(&iter->it.data, object);
668 iter->ht_iter = zend_hash_iterator_add(&wm->ht, 0);
669 return &iter->it;
670 }
671
ZEND_METHOD(WeakMap,offsetGet)672 ZEND_METHOD(WeakMap, offsetGet)
673 {
674 zval *key;
675
676 if (zend_parse_parameters(ZEND_NUM_ARGS(), "z", &key) == FAILURE) {
677 return;
678 }
679
680 zval *zv = zend_weakmap_read_dimension(Z_OBJ_P(ZEND_THIS), key, BP_VAR_R, NULL);
681 if (!zv) {
682 return;
683 }
684
685 ZVAL_COPY(return_value, zv);
686 }
687
ZEND_METHOD(WeakMap,offsetSet)688 ZEND_METHOD(WeakMap, offsetSet)
689 {
690 zval *key, *value;
691
692 if (zend_parse_parameters(ZEND_NUM_ARGS(), "zz", &key, &value) == FAILURE) {
693 return;
694 }
695
696 zend_weakmap_write_dimension(Z_OBJ_P(ZEND_THIS), key, value);
697 }
698
ZEND_METHOD(WeakMap,offsetExists)699 ZEND_METHOD(WeakMap, offsetExists)
700 {
701 zval *key;
702
703 if (zend_parse_parameters(ZEND_NUM_ARGS(), "z", &key) == FAILURE) {
704 return;
705 }
706
707 RETURN_BOOL(zend_weakmap_has_dimension(Z_OBJ_P(ZEND_THIS), key, /* check_empty */ 0));
708 }
709
ZEND_METHOD(WeakMap,offsetUnset)710 ZEND_METHOD(WeakMap, offsetUnset)
711 {
712 zval *key;
713
714 if (zend_parse_parameters(ZEND_NUM_ARGS(), "z", &key) == FAILURE) {
715 return;
716 }
717
718 zend_weakmap_unset_dimension(Z_OBJ_P(ZEND_THIS), key);
719 }
720
ZEND_METHOD(WeakMap,count)721 ZEND_METHOD(WeakMap, count)
722 {
723 if (zend_parse_parameters_none() == FAILURE) {
724 return;
725 }
726
727 zend_long count;
728 zend_weakmap_count_elements(Z_OBJ_P(ZEND_THIS), &count);
729 RETURN_LONG(count);
730 }
731
ZEND_METHOD(WeakMap,getIterator)732 ZEND_METHOD(WeakMap, getIterator)
733 {
734 if (zend_parse_parameters_none() == FAILURE) {
735 return;
736 }
737
738 zend_create_internal_iterator_zval(return_value, ZEND_THIS);
739 }
740
zend_register_weakref_ce(void)741 void zend_register_weakref_ce(void) /* {{{ */
742 {
743 zend_ce_weakref = register_class_WeakReference();
744
745 zend_ce_weakref->create_object = zend_weakref_new;
746 zend_ce_weakref->default_object_handlers = &zend_weakref_handlers;
747
748 memcpy(&zend_weakref_handlers, zend_get_std_object_handlers(), sizeof(zend_object_handlers));
749 zend_weakref_handlers.offset = XtOffsetOf(zend_weakref, std);
750
751 zend_weakref_handlers.free_obj = zend_weakref_free;
752 zend_weakref_handlers.clone_obj = NULL;
753
754 zend_ce_weakmap = register_class_WeakMap(zend_ce_arrayaccess, zend_ce_countable, zend_ce_aggregate);
755
756 zend_ce_weakmap->create_object = zend_weakmap_create_object;
757 zend_ce_weakmap->get_iterator = zend_weakmap_get_iterator;
758 zend_ce_weakmap->default_object_handlers = &zend_weakmap_handlers;
759
760 memcpy(&zend_weakmap_handlers, zend_get_std_object_handlers(), sizeof(zend_object_handlers));
761 zend_weakmap_handlers.offset = XtOffsetOf(zend_weakmap, std);
762 zend_weakmap_handlers.free_obj = zend_weakmap_free_obj;
763 zend_weakmap_handlers.read_dimension = zend_weakmap_read_dimension;
764 zend_weakmap_handlers.write_dimension = zend_weakmap_write_dimension;
765 zend_weakmap_handlers.has_dimension = zend_weakmap_has_dimension;
766 zend_weakmap_handlers.unset_dimension = zend_weakmap_unset_dimension;
767 zend_weakmap_handlers.count_elements = zend_weakmap_count_elements;
768 zend_weakmap_handlers.get_properties_for = zend_weakmap_get_properties_for;
769 zend_weakmap_handlers.get_gc = zend_weakmap_get_gc;
770 zend_weakmap_handlers.clone_obj = zend_weakmap_clone_obj;
771 }
772 /* }}} */
773
774