zend_weakrefs.c 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656
  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. #include "zend.h"
  17. #include "zend_interfaces.h"
  18. #include "zend_objects_API.h"
  19. #include "zend_weakrefs.h"
  20. #include "zend_weakrefs_arginfo.h"
  21. typedef struct _zend_weakref {
  22. zend_object *referent;
  23. zend_object std;
  24. } zend_weakref;
  25. typedef struct _zend_weakmap {
  26. HashTable ht;
  27. zend_object std;
  28. } zend_weakmap;
  29. typedef struct _zend_weakmap_iterator {
  30. zend_object_iterator it;
  31. uint32_t ht_iter;
  32. } zend_weakmap_iterator;
  33. /* The EG(weakrefs) ht is a map from object address a tagged pointer, that may be one of
  34. * zend_weakref*, zend_weakmap* or HashTable*. */
  35. #define ZEND_WEAKREF_TAG_REF 0
  36. #define ZEND_WEAKREF_TAG_MAP 1
  37. #define ZEND_WEAKREF_TAG_HT 2
  38. #define ZEND_WEAKREF_GET_TAG(p) (((uintptr_t) (p)) & 3)
  39. #define ZEND_WEAKREF_GET_PTR(p) ((void *) (((uintptr_t) (p)) & ~3))
  40. #define ZEND_WEAKREF_ENCODE(p, t) ((void *) (((uintptr_t) (p)) | (t)))
  41. zend_class_entry *zend_ce_weakref;
  42. zend_class_entry *zend_ce_weakmap;
  43. static zend_object_handlers zend_weakref_handlers;
  44. static zend_object_handlers zend_weakmap_handlers;
  45. #define zend_weakref_from(o) ((zend_weakref*)(((char*) o) - XtOffsetOf(zend_weakref, std)))
  46. #define zend_weakref_fetch(z) zend_weakref_from(Z_OBJ_P(z))
  47. #define zend_weakmap_from(o) ((zend_weakmap*)(((char*) o) - XtOffsetOf(zend_weakmap, std)))
  48. #define zend_weakmap_fetch(z) zend_weakmap_from(Z_OBJ_P(z))
  49. static inline void zend_weakref_unref_single(
  50. void *ptr, uintptr_t tag, zend_ulong obj_addr)
  51. {
  52. if (tag == ZEND_WEAKREF_TAG_REF) {
  53. zend_weakref *wr = ptr;
  54. wr->referent = NULL;
  55. } else {
  56. ZEND_ASSERT(tag == ZEND_WEAKREF_TAG_MAP);
  57. zend_hash_index_del((HashTable *) ptr, obj_addr);
  58. }
  59. }
  60. static void zend_weakref_unref(zend_ulong obj_addr, void *tagged_ptr) {
  61. void *ptr = ZEND_WEAKREF_GET_PTR(tagged_ptr);
  62. uintptr_t tag = ZEND_WEAKREF_GET_TAG(tagged_ptr);
  63. if (tag == ZEND_WEAKREF_TAG_HT) {
  64. HashTable *ht = ptr;
  65. ZEND_HASH_FOREACH_PTR(ht, tagged_ptr) {
  66. zend_weakref_unref_single(
  67. ZEND_WEAKREF_GET_PTR(tagged_ptr), ZEND_WEAKREF_GET_TAG(tagged_ptr), obj_addr);
  68. } ZEND_HASH_FOREACH_END();
  69. zend_hash_destroy(ht);
  70. FREE_HASHTABLE(ht);
  71. } else {
  72. zend_weakref_unref_single(ptr, tag, obj_addr);
  73. }
  74. }
  75. static void zend_weakref_register(zend_object *object, void *payload) {
  76. GC_ADD_FLAGS(object, IS_OBJ_WEAKLY_REFERENCED);
  77. zend_ulong obj_addr = (zend_ulong) object;
  78. zval *zv = zend_hash_index_find(&EG(weakrefs), obj_addr);
  79. if (!zv) {
  80. zend_hash_index_add_new_ptr(&EG(weakrefs), obj_addr, payload);
  81. return;
  82. }
  83. void *tagged_ptr = Z_PTR_P(zv);
  84. if (ZEND_WEAKREF_GET_TAG(tagged_ptr) == ZEND_WEAKREF_TAG_HT) {
  85. HashTable *ht = ZEND_WEAKREF_GET_PTR(tagged_ptr);
  86. zend_hash_index_add_new_ptr(ht, (zend_ulong) payload, payload);
  87. return;
  88. }
  89. /* Convert simple pointer to hashtable. */
  90. HashTable *ht = emalloc(sizeof(HashTable));
  91. zend_hash_init(ht, 0, NULL, NULL, 0);
  92. zend_hash_index_add_new_ptr(ht, (zend_ulong) tagged_ptr, tagged_ptr);
  93. zend_hash_index_add_new_ptr(ht, (zend_ulong) payload, payload);
  94. zend_hash_index_update_ptr(
  95. &EG(weakrefs), obj_addr, ZEND_WEAKREF_ENCODE(ht, ZEND_WEAKREF_TAG_HT));
  96. }
  97. static void zend_weakref_unregister(zend_object *object, void *payload) {
  98. zend_ulong obj_addr = (zend_ulong) object;
  99. void *tagged_ptr = zend_hash_index_find_ptr(&EG(weakrefs), obj_addr);
  100. ZEND_ASSERT(tagged_ptr && "Weakref not registered?");
  101. void *ptr = ZEND_WEAKREF_GET_PTR(tagged_ptr);
  102. uintptr_t tag = ZEND_WEAKREF_GET_TAG(tagged_ptr);
  103. if (tag != ZEND_WEAKREF_TAG_HT) {
  104. ZEND_ASSERT(tagged_ptr == payload);
  105. zend_hash_index_del(&EG(weakrefs), obj_addr);
  106. GC_DEL_FLAGS(object, IS_OBJ_WEAKLY_REFERENCED);
  107. /* Do this last, as it may destroy the object. */
  108. zend_weakref_unref_single(ptr, tag, obj_addr);
  109. return;
  110. }
  111. HashTable *ht = ptr;
  112. tagged_ptr = zend_hash_index_find_ptr(ht, (zend_ulong) payload);
  113. ZEND_ASSERT(tagged_ptr && "Weakref not registered?");
  114. ZEND_ASSERT(tagged_ptr == payload);
  115. zend_hash_index_del(ht, (zend_ulong) payload);
  116. if (zend_hash_num_elements(ht) == 0) {
  117. GC_DEL_FLAGS(object, IS_OBJ_WEAKLY_REFERENCED);
  118. zend_hash_destroy(ht);
  119. FREE_HASHTABLE(ht);
  120. zend_hash_index_del(&EG(weakrefs), obj_addr);
  121. }
  122. /* Do this last, as it may destroy the object. */
  123. zend_weakref_unref_single(
  124. ZEND_WEAKREF_GET_PTR(payload), ZEND_WEAKREF_GET_TAG(payload), obj_addr);
  125. }
  126. ZEND_API zval *zend_weakrefs_hash_add(HashTable *ht, zend_object *key, zval *pData) {
  127. zval *zv = zend_hash_index_add(ht, (zend_ulong) key, pData);
  128. if (zv) {
  129. zend_weakref_register(key, ZEND_WEAKREF_ENCODE(ht, ZEND_WEAKREF_TAG_MAP));
  130. }
  131. return zv;
  132. }
  133. ZEND_API zend_result zend_weakrefs_hash_del(HashTable *ht, zend_object *key) {
  134. zval *zv = zend_hash_index_find(ht, (zend_ulong) key);
  135. if (zv) {
  136. zend_weakref_unregister(key, ZEND_WEAKREF_ENCODE(ht, ZEND_WEAKREF_TAG_MAP));
  137. return SUCCESS;
  138. }
  139. return FAILURE;
  140. }
  141. void zend_weakrefs_init(void) {
  142. zend_hash_init(&EG(weakrefs), 8, NULL, NULL, 0);
  143. }
  144. void zend_weakrefs_notify(zend_object *object) {
  145. /* Annoyingly we can't use the HT destructor here, because we need access to the key (which
  146. * is the object address), which is not provided to the dtor. */
  147. zend_ulong obj_addr = (zend_ulong) object;
  148. void *tagged_ptr = zend_hash_index_find_ptr(&EG(weakrefs), obj_addr);
  149. #if ZEND_DEBUG
  150. ZEND_ASSERT(tagged_ptr && "Tracking of the IS_OBJ_WEAKLY_REFERENCE flag should be precise");
  151. #endif
  152. if (tagged_ptr) {
  153. zend_hash_index_del(&EG(weakrefs), obj_addr);
  154. zend_weakref_unref(obj_addr, tagged_ptr);
  155. }
  156. }
  157. void zend_weakrefs_shutdown(void) {
  158. zend_ulong obj_addr;
  159. void *tagged_ptr;
  160. ZEND_HASH_FOREACH_NUM_KEY_PTR(&EG(weakrefs), obj_addr, tagged_ptr) {
  161. zend_weakref_unref(obj_addr, tagged_ptr);
  162. } ZEND_HASH_FOREACH_END();
  163. zend_hash_destroy(&EG(weakrefs));
  164. }
  165. static zend_object* zend_weakref_new(zend_class_entry *ce) {
  166. zend_weakref *wr = zend_object_alloc(sizeof(zend_weakref), zend_ce_weakref);
  167. zend_object_std_init(&wr->std, zend_ce_weakref);
  168. wr->std.handlers = &zend_weakref_handlers;
  169. return &wr->std;
  170. }
  171. static zend_always_inline bool zend_weakref_find(zend_object *referent, zval *return_value) {
  172. void *tagged_ptr = zend_hash_index_find_ptr(&EG(weakrefs), (zend_ulong) referent);
  173. if (!tagged_ptr) {
  174. return 0;
  175. }
  176. void *ptr = ZEND_WEAKREF_GET_PTR(tagged_ptr);
  177. uintptr_t tag = ZEND_WEAKREF_GET_TAG(tagged_ptr);
  178. if (tag == ZEND_WEAKREF_TAG_REF) {
  179. zend_weakref *wr;
  180. found_weakref:
  181. wr = ptr;
  182. RETVAL_OBJ_COPY(&wr->std);
  183. return 1;
  184. }
  185. if (tag == ZEND_WEAKREF_TAG_HT) {
  186. ZEND_HASH_FOREACH_PTR(ptr, tagged_ptr) {
  187. if (ZEND_WEAKREF_GET_TAG(tagged_ptr) == ZEND_WEAKREF_TAG_REF) {
  188. ptr = ZEND_WEAKREF_GET_PTR(tagged_ptr);
  189. goto found_weakref;
  190. }
  191. } ZEND_HASH_FOREACH_END();
  192. }
  193. return 0;
  194. }
  195. static zend_always_inline void zend_weakref_create(zend_object *referent, zval *return_value) {
  196. zend_weakref *wr;
  197. object_init_ex(return_value, zend_ce_weakref);
  198. wr = zend_weakref_fetch(return_value);
  199. wr->referent = referent;
  200. zend_weakref_register(wr->referent, ZEND_WEAKREF_ENCODE(wr, ZEND_WEAKREF_TAG_REF));
  201. }
  202. static zend_always_inline void zend_weakref_get(zval *weakref, zval *return_value) {
  203. zend_weakref *wr = zend_weakref_fetch(weakref);
  204. if (wr->referent) {
  205. RETVAL_OBJ_COPY(wr->referent);
  206. }
  207. }
  208. static void zend_weakref_free(zend_object *zo) {
  209. zend_weakref *wr = zend_weakref_from(zo);
  210. if (wr->referent) {
  211. zend_weakref_unregister(wr->referent, ZEND_WEAKREF_ENCODE(wr, ZEND_WEAKREF_TAG_REF));
  212. }
  213. zend_object_std_dtor(&wr->std);
  214. }
  215. ZEND_COLD ZEND_METHOD(WeakReference, __construct)
  216. {
  217. zend_throw_error(NULL, "Direct instantiation of WeakReference is not allowed, use WeakReference::create instead");
  218. }
  219. ZEND_METHOD(WeakReference, create)
  220. {
  221. zend_object *referent;
  222. ZEND_PARSE_PARAMETERS_START(1,1)
  223. Z_PARAM_OBJ(referent)
  224. ZEND_PARSE_PARAMETERS_END();
  225. if (zend_weakref_find(referent, return_value)) {
  226. return;
  227. }
  228. zend_weakref_create(referent, return_value);
  229. }
  230. ZEND_METHOD(WeakReference, get)
  231. {
  232. ZEND_PARSE_PARAMETERS_NONE();
  233. zend_weakref_get(getThis(), return_value);
  234. }
  235. static zend_object *zend_weakmap_create_object(zend_class_entry *ce)
  236. {
  237. zend_weakmap *wm = zend_object_alloc(sizeof(zend_weakmap), ce);
  238. zend_object_std_init(&wm->std, ce);
  239. wm->std.handlers = &zend_weakmap_handlers;
  240. zend_hash_init(&wm->ht, 0, NULL, ZVAL_PTR_DTOR, 0);
  241. return &wm->std;
  242. }
  243. static void zend_weakmap_free_obj(zend_object *object)
  244. {
  245. zend_weakmap *wm = zend_weakmap_from(object);
  246. zend_ulong obj_addr;
  247. ZEND_HASH_FOREACH_NUM_KEY(&wm->ht, obj_addr) {
  248. zend_weakref_unregister(
  249. (zend_object *) obj_addr, ZEND_WEAKREF_ENCODE(&wm->ht, ZEND_WEAKREF_TAG_MAP));
  250. } ZEND_HASH_FOREACH_END();
  251. zend_hash_destroy(&wm->ht);
  252. zend_object_std_dtor(&wm->std);
  253. }
  254. static zval *zend_weakmap_read_dimension(zend_object *object, zval *offset, int type, zval *rv)
  255. {
  256. if (offset == NULL) {
  257. zend_throw_error(NULL, "Cannot append to WeakMap");
  258. return NULL;
  259. }
  260. ZVAL_DEREF(offset);
  261. if (Z_TYPE_P(offset) != IS_OBJECT) {
  262. zend_type_error("WeakMap key must be an object");
  263. return NULL;
  264. }
  265. zend_weakmap *wm = zend_weakmap_from(object);
  266. zend_object *obj_key = Z_OBJ_P(offset);
  267. zval *zv = zend_hash_index_find(&wm->ht, (zend_ulong) obj_key);
  268. if (zv == NULL) {
  269. if (type != BP_VAR_IS) {
  270. zend_throw_error(NULL,
  271. "Object %s#%d not contained in WeakMap", ZSTR_VAL(obj_key->ce->name), obj_key->handle);
  272. return NULL;
  273. }
  274. return NULL;
  275. }
  276. if (type == BP_VAR_W || type == BP_VAR_RW) {
  277. ZVAL_MAKE_REF(zv);
  278. }
  279. return zv;
  280. }
  281. static void zend_weakmap_write_dimension(zend_object *object, zval *offset, zval *value)
  282. {
  283. if (offset == NULL) {
  284. zend_throw_error(NULL, "Cannot append to WeakMap");
  285. return;
  286. }
  287. ZVAL_DEREF(offset);
  288. if (Z_TYPE_P(offset) != IS_OBJECT) {
  289. zend_type_error("WeakMap key must be an object");
  290. return;
  291. }
  292. zend_weakmap *wm = zend_weakmap_from(object);
  293. zend_object *obj_key = Z_OBJ_P(offset);
  294. Z_TRY_ADDREF_P(value);
  295. zval *zv = zend_hash_index_find(&wm->ht, (zend_ulong) obj_key);
  296. if (zv) {
  297. /* Because the destructors can have side effects such as resizing or rehashing the WeakMap storage,
  298. * free the zval only after overwriting the original value. */
  299. zval zv_orig;
  300. ZVAL_COPY_VALUE(&zv_orig, zv);
  301. ZVAL_COPY_VALUE(zv, value);
  302. zval_ptr_dtor(&zv_orig);
  303. return;
  304. }
  305. zend_weakref_register(obj_key, ZEND_WEAKREF_ENCODE(&wm->ht, ZEND_WEAKREF_TAG_MAP));
  306. zend_hash_index_add_new(&wm->ht, (zend_ulong) obj_key, value);
  307. }
  308. /* int return and check_empty due to Object Handler API */
  309. static int zend_weakmap_has_dimension(zend_object *object, zval *offset, int check_empty)
  310. {
  311. ZVAL_DEREF(offset);
  312. if (Z_TYPE_P(offset) != IS_OBJECT) {
  313. zend_type_error("WeakMap key must be an object");
  314. return 0;
  315. }
  316. zend_weakmap *wm = zend_weakmap_from(object);
  317. zval *zv = zend_hash_index_find(&wm->ht, (zend_ulong) Z_OBJ_P(offset));
  318. if (!zv) {
  319. return 0;
  320. }
  321. if (check_empty) {
  322. return i_zend_is_true(zv);
  323. }
  324. return Z_TYPE_P(zv) != IS_NULL;
  325. }
  326. static void zend_weakmap_unset_dimension(zend_object *object, zval *offset)
  327. {
  328. ZVAL_DEREF(offset);
  329. if (Z_TYPE_P(offset) != IS_OBJECT) {
  330. zend_type_error("WeakMap key must be an object");
  331. return;
  332. }
  333. zend_weakmap *wm = zend_weakmap_from(object);
  334. zend_object *obj_key = Z_OBJ_P(offset);
  335. if (!zend_hash_index_exists(&wm->ht, (zend_ulong) Z_OBJ_P(offset))) {
  336. /* Object not in WeakMap, do nothing. */
  337. return;
  338. }
  339. zend_weakref_unregister(obj_key, ZEND_WEAKREF_ENCODE(&wm->ht, ZEND_WEAKREF_TAG_MAP));
  340. }
  341. static int zend_weakmap_count_elements(zend_object *object, zend_long *count)
  342. {
  343. zend_weakmap *wm = zend_weakmap_from(object);
  344. *count = zend_hash_num_elements(&wm->ht);
  345. return SUCCESS;
  346. }
  347. static HashTable *zend_weakmap_get_properties_for(zend_object *object, zend_prop_purpose purpose)
  348. {
  349. if (purpose != ZEND_PROP_PURPOSE_DEBUG) {
  350. return NULL;
  351. }
  352. zend_weakmap *wm = zend_weakmap_from(object);
  353. HashTable *ht;
  354. ALLOC_HASHTABLE(ht);
  355. zend_hash_init(ht, zend_hash_num_elements(&wm->ht), NULL, ZVAL_PTR_DTOR, 0);
  356. zend_ulong obj_addr;
  357. zval *val;
  358. ZEND_HASH_FOREACH_NUM_KEY_VAL(&wm->ht, obj_addr, val) {
  359. zend_object *obj = (zend_object*)obj_addr;
  360. zval pair;
  361. array_init(&pair);
  362. GC_ADDREF(obj);
  363. add_assoc_object(&pair, "key", obj);
  364. Z_TRY_ADDREF_P(val);
  365. add_assoc_zval(&pair, "value", val);
  366. zend_hash_next_index_insert_new(ht, &pair);
  367. } ZEND_HASH_FOREACH_END();
  368. return ht;
  369. }
  370. static HashTable *zend_weakmap_get_gc(zend_object *object, zval **table, int *n)
  371. {
  372. zend_weakmap *wm = zend_weakmap_from(object);
  373. zend_get_gc_buffer *gc_buffer = zend_get_gc_buffer_create();
  374. zval *val;
  375. ZEND_HASH_FOREACH_VAL(&wm->ht, val) {
  376. zend_get_gc_buffer_add_zval(gc_buffer, val);
  377. } ZEND_HASH_FOREACH_END();
  378. zend_get_gc_buffer_use(gc_buffer, table, n);
  379. return NULL;
  380. }
  381. static zend_object *zend_weakmap_clone_obj(zend_object *old_object)
  382. {
  383. zend_object *new_object = zend_weakmap_create_object(zend_ce_weakmap);
  384. zend_weakmap *old_wm = zend_weakmap_from(old_object);
  385. zend_weakmap *new_wm = zend_weakmap_from(new_object);
  386. zend_hash_copy(&new_wm->ht, &old_wm->ht, NULL);
  387. zend_ulong obj_addr;
  388. zval *val;
  389. ZEND_HASH_FOREACH_NUM_KEY_VAL(&new_wm->ht, obj_addr, val) {
  390. zend_weakref_register(
  391. (zend_object *) obj_addr, ZEND_WEAKREF_ENCODE(new_wm, ZEND_WEAKREF_TAG_MAP));
  392. zval_add_ref(val);
  393. } ZEND_HASH_FOREACH_END();
  394. return new_object;
  395. }
  396. static HashPosition *zend_weakmap_iterator_get_pos_ptr(zend_weakmap_iterator *iter) {
  397. ZEND_ASSERT(iter->ht_iter != (uint32_t) -1);
  398. return &EG(ht_iterators)[iter->ht_iter].pos;
  399. }
  400. static void zend_weakmap_iterator_dtor(zend_object_iterator *obj_iter)
  401. {
  402. zend_weakmap_iterator *iter = (zend_weakmap_iterator *) obj_iter;
  403. zend_hash_iterator_del(iter->ht_iter);
  404. zval_ptr_dtor(&iter->it.data);
  405. }
  406. static int zend_weakmap_iterator_valid(zend_object_iterator *obj_iter)
  407. {
  408. zend_weakmap_iterator *iter = (zend_weakmap_iterator *) obj_iter;
  409. zend_weakmap *wm = zend_weakmap_fetch(&iter->it.data);
  410. HashPosition *pos = zend_weakmap_iterator_get_pos_ptr(iter);
  411. return zend_hash_has_more_elements_ex(&wm->ht, pos);
  412. }
  413. static zval *zend_weakmap_iterator_get_current_data(zend_object_iterator *obj_iter)
  414. {
  415. zend_weakmap_iterator *iter = (zend_weakmap_iterator *) obj_iter;
  416. zend_weakmap *wm = zend_weakmap_fetch(&iter->it.data);
  417. HashPosition *pos = zend_weakmap_iterator_get_pos_ptr(iter);
  418. return zend_hash_get_current_data_ex(&wm->ht, pos);
  419. }
  420. static void zend_weakmap_iterator_get_current_key(zend_object_iterator *obj_iter, zval *key)
  421. {
  422. zend_weakmap_iterator *iter = (zend_weakmap_iterator *) obj_iter;
  423. zend_weakmap *wm = zend_weakmap_fetch(&iter->it.data);
  424. HashPosition *pos = zend_weakmap_iterator_get_pos_ptr(iter);
  425. zend_string *string_key;
  426. zend_ulong num_key;
  427. int key_type = zend_hash_get_current_key_ex(&wm->ht, &string_key, &num_key, pos);
  428. if (key_type != HASH_KEY_IS_LONG) {
  429. ZEND_ASSERT(0 && "Must have integer key");
  430. }
  431. ZVAL_OBJ_COPY(key, (zend_object *) num_key);
  432. }
  433. static void zend_weakmap_iterator_move_forward(zend_object_iterator *obj_iter)
  434. {
  435. zend_weakmap_iterator *iter = (zend_weakmap_iterator *) obj_iter;
  436. zend_weakmap *wm = zend_weakmap_fetch(&iter->it.data);
  437. HashPosition *pos = zend_weakmap_iterator_get_pos_ptr(iter);
  438. zend_hash_move_forward_ex(&wm->ht, pos);
  439. }
  440. static void zend_weakmap_iterator_rewind(zend_object_iterator *obj_iter)
  441. {
  442. zend_weakmap_iterator *iter = (zend_weakmap_iterator *) obj_iter;
  443. zend_weakmap *wm = zend_weakmap_fetch(&iter->it.data);
  444. HashPosition *pos = zend_weakmap_iterator_get_pos_ptr(iter);
  445. zend_hash_internal_pointer_reset_ex(&wm->ht, pos);
  446. }
  447. static const zend_object_iterator_funcs zend_weakmap_iterator_funcs = {
  448. zend_weakmap_iterator_dtor,
  449. zend_weakmap_iterator_valid,
  450. zend_weakmap_iterator_get_current_data,
  451. zend_weakmap_iterator_get_current_key,
  452. zend_weakmap_iterator_move_forward,
  453. zend_weakmap_iterator_rewind,
  454. NULL,
  455. NULL, /* get_gc */
  456. };
  457. /* by_ref is int due to Iterator API */
  458. static zend_object_iterator *zend_weakmap_get_iterator(
  459. zend_class_entry *ce, zval *object, int by_ref)
  460. {
  461. zend_weakmap *wm = zend_weakmap_fetch(object);
  462. zend_weakmap_iterator *iter = emalloc(sizeof(zend_weakmap_iterator));
  463. zend_iterator_init(&iter->it);
  464. iter->it.funcs = &zend_weakmap_iterator_funcs;
  465. ZVAL_COPY(&iter->it.data, object);
  466. iter->ht_iter = zend_hash_iterator_add(&wm->ht, 0);
  467. return &iter->it;
  468. }
  469. ZEND_METHOD(WeakMap, offsetGet)
  470. {
  471. zval *key;
  472. if (zend_parse_parameters(ZEND_NUM_ARGS(), "z", &key) == FAILURE) {
  473. return;
  474. }
  475. zval *zv = zend_weakmap_read_dimension(Z_OBJ_P(ZEND_THIS), key, BP_VAR_R, NULL);
  476. if (!zv) {
  477. return;
  478. }
  479. ZVAL_COPY(return_value, zv);
  480. }
  481. ZEND_METHOD(WeakMap, offsetSet)
  482. {
  483. zval *key, *value;
  484. if (zend_parse_parameters(ZEND_NUM_ARGS(), "zz", &key, &value) == FAILURE) {
  485. return;
  486. }
  487. zend_weakmap_write_dimension(Z_OBJ_P(ZEND_THIS), key, value);
  488. }
  489. ZEND_METHOD(WeakMap, offsetExists)
  490. {
  491. zval *key;
  492. if (zend_parse_parameters(ZEND_NUM_ARGS(), "z", &key) == FAILURE) {
  493. return;
  494. }
  495. RETURN_BOOL(zend_weakmap_has_dimension(Z_OBJ_P(ZEND_THIS), key, /* check_empty */ 0));
  496. }
  497. ZEND_METHOD(WeakMap, offsetUnset)
  498. {
  499. zval *key;
  500. if (zend_parse_parameters(ZEND_NUM_ARGS(), "z", &key) == FAILURE) {
  501. return;
  502. }
  503. zend_weakmap_unset_dimension(Z_OBJ_P(ZEND_THIS), key);
  504. }
  505. ZEND_METHOD(WeakMap, count)
  506. {
  507. if (zend_parse_parameters_none() == FAILURE) {
  508. return;
  509. }
  510. zend_long count;
  511. zend_weakmap_count_elements(Z_OBJ_P(ZEND_THIS), &count);
  512. RETURN_LONG(count);
  513. }
  514. ZEND_METHOD(WeakMap, getIterator)
  515. {
  516. if (zend_parse_parameters_none() == FAILURE) {
  517. return;
  518. }
  519. zend_create_internal_iterator_zval(return_value, ZEND_THIS);
  520. }
  521. void zend_register_weakref_ce(void) /* {{{ */
  522. {
  523. zend_ce_weakref = register_class_WeakReference();
  524. zend_ce_weakref->create_object = zend_weakref_new;
  525. memcpy(&zend_weakref_handlers, zend_get_std_object_handlers(), sizeof(zend_object_handlers));
  526. zend_weakref_handlers.offset = XtOffsetOf(zend_weakref, std);
  527. zend_weakref_handlers.free_obj = zend_weakref_free;
  528. zend_weakref_handlers.clone_obj = NULL;
  529. zend_ce_weakmap = register_class_WeakMap(zend_ce_arrayaccess, zend_ce_countable, zend_ce_aggregate);
  530. zend_ce_weakmap->create_object = zend_weakmap_create_object;
  531. zend_ce_weakmap->get_iterator = zend_weakmap_get_iterator;
  532. memcpy(&zend_weakmap_handlers, zend_get_std_object_handlers(), sizeof(zend_object_handlers));
  533. zend_weakmap_handlers.offset = XtOffsetOf(zend_weakmap, std);
  534. zend_weakmap_handlers.free_obj = zend_weakmap_free_obj;
  535. zend_weakmap_handlers.read_dimension = zend_weakmap_read_dimension;
  536. zend_weakmap_handlers.write_dimension = zend_weakmap_write_dimension;
  537. zend_weakmap_handlers.has_dimension = zend_weakmap_has_dimension;
  538. zend_weakmap_handlers.unset_dimension = zend_weakmap_unset_dimension;
  539. zend_weakmap_handlers.count_elements = zend_weakmap_count_elements;
  540. zend_weakmap_handlers.get_properties_for = zend_weakmap_get_properties_for;
  541. zend_weakmap_handlers.get_gc = zend_weakmap_get_gc;
  542. zend_weakmap_handlers.clone_obj = zend_weakmap_clone_obj;
  543. }
  544. /* }}} */