Update this with latest changes from teds pecl

- Change offsetUnset into a helper method to remove valid offsets
- Add insert() method to add 0 or more elements into a valid offset
- Make the object iteration behavior with shift/unshift behave consistently.
  Iterators for a deque of size `n` now only has `n+1` iteration states
  (one state for each offset, plus one state for iterators being at the end of
  the deque)
- Switch from tracking an iteration offset to tracking an intrusive doubly
  linked list of active iterators for each Deque instance.
  This has better results for foreach.phpt when shifting from the start of a
  deque during iteration.

Author: TysonAndre

ext/collections/collections_deque.c

@@ -16,9 +16,9 @@
  * This supports amortized constant time pushing and popping onto the front or back of the Deque.
  *
  * Naming is based on https://www.php.net/spldoublylinkedlist
- * and on array_push/pop/unshift/shift.
+ * and on array_push/pop/unshift/shift and array_key_first.
  */
-final class Deque implements IteratorAggregate, Countable, JsonSerializable, ArrayAccess
+final class Deque implements \IteratorAggregate, \Countable, \JsonSerializable, \ArrayAccess
 {
     /** Construct the Deque from the values of the Traversable/array, ignoring keys */
     public function __construct(iterable $iterator = []) {}
@@ -77,10 +77,15 @@ public function last(): mixed {}
      */
     public function toArray(): array {}
 
+    /**
+     * Insert 0 or more values at the given offset of the Deque.
+     * @throws \OutOfBoundsException if the value of $offset is not within the bounds of this Deque.
+     */
+    public function insert(int $offset, mixed ...$values): void {}
     // Must be mixed for compatibility with ArrayAccess
     /**
      * Returns the value at offset (int)$offset (relative to the start of the Deque)
-     * @throws \OutOfBoundsException if the value of (int)$offset is not within the bounds of this vector
+     * @throws \OutOfBoundsException if the value of (int)$offset is not within the bounds of this Deque.
      */
     public function offsetGet(mixed $offset): mixed {}
     /**
@@ -90,11 +95,12 @@ public function offsetGet(mixed $offset): mixed {}
     public function offsetExists(mixed $offset): bool {}
     /**
      * Sets the value at offset $offset (relative to the start of the Deque) to $value
-     * @throws \OutOfBoundsException if the value of (int)$offset is not within the bounds of this vector
+     * @throws \OutOfBoundsException if the value of (int)$offset is not within the bounds of this Deque.
      */
     public function offsetSet(mixed $offset, mixed $value): void {}
     /**
-     * @throws \RuntimeException unconditionally because unset and null are different things, unlike SplFixedArray
+     * Removes the value at (int)$offset from the deque.
+     * @throws \OutOfBoundsException if the value of (int)$offset is not within the bounds of this Deque.
      */
     public function offsetUnset(mixed $offset): void {}
 

ext/collections/collections_deque.stub.php

@@ -0,0 +1,58 @@
+/*
+   +----------------------------------------------------------------------+
+   | Copyright (c) The PHP Group                                          |
+   +----------------------------------------------------------------------+
+   | This source file is subject to version 3.01 of the PHP license,      |
+   | that is bundled with this package in the file LICENSE, and is        |
+   | available through the world-wide-web at the following url:           |
+   | https://www.php.net/license/3_01.txt                                 |
+   | If you did not receive a copy of the PHP license and are unable to   |
+   | obtain it through the world-wide-web, please send a note to          |
+   | [email protected] so we can mail you a copy immediately.               |
+   +----------------------------------------------------------------------+
+   | Author: Tyson Andre <[email protected]>                                 |
+   +----------------------------------------------------------------------+
+*/
+
+#ifndef COLLECTIONS_INTERNALITERATOR_H
+#define COLLECTIONS_INTERNALITERATOR_H
+
+typedef struct _collections_intrusive_dllist_node {
+	struct _collections_intrusive_dllist_node *prev;
+	struct _collections_intrusive_dllist_node *next;
+} collections_intrusive_dllist_node;
+
+typedef struct _collections_intrusive_dllist {
+	struct _collections_intrusive_dllist_node *first;
+} collections_intrusive_dllist;
+
+static zend_always_inline void collections_intrusive_dllist_prepend(collections_intrusive_dllist *list, collections_intrusive_dllist_node *node) {
+	collections_intrusive_dllist_node *first = list->first;
+	ZEND_ASSERT(node != first);
+	node->next = first;
+	node->prev = NULL;
+	list->first = node;
+
+	if (first) {
+		ZEND_ASSERT(first->prev == NULL);
+		first->prev = node;
+	}
+}
+
+static zend_always_inline void collections_intrusive_dllist_remove(collections_intrusive_dllist *list, const collections_intrusive_dllist_node *node) {
+	collections_intrusive_dllist_node *next = node->next;
+	collections_intrusive_dllist_node *prev = node->prev;
+	ZEND_ASSERT(node != next);
+	ZEND_ASSERT(node != prev);
+	ZEND_ASSERT(next != prev || next == NULL);
+	if (next) {
+		next->prev = prev;
+	}
+	if (list->first == node) {
+		list->first = next;
+		ZEND_ASSERT(prev == NULL);
+	} else if (prev) {
+		prev->next = next;
+	}
+}
+#endif

ext/collections/collections_deque_arginfo.h

@@ -0,0 +1,41 @@
+/*
+   +----------------------------------------------------------------------+
+   | Copyright (c) The PHP Group                                          |
+   +----------------------------------------------------------------------+
+   | This source file is subject to version 3.01 of the PHP license,      |
+   | that is bundled with this package in the file LICENSE, and is        |
+   | available through the world-wide-web at the following url:           |
+   | https://www.php.net/license/3_01.txt                                 |
+   | If you did not receive a copy of the PHP license and are unable to   |
+   | obtain it through the world-wide-web, please send a note to          |
+   | [email protected] so we can mail you a copy immediately.               |
+   +----------------------------------------------------------------------+
+   | Author: Tyson Andre <[email protected]>                                 |
+   +----------------------------------------------------------------------+
+*/
+
+#include "collections_util.h"
+
+/* Override get_properties_for and use the default implementation of get_properties. See https://github.com/php/php-src/issues/9697#issuecomment-1273613175 */
+HashTable* collections_noop_empty_array_get_properties_for(zend_object *obj, zend_prop_purpose purpose) {
+	(void)obj;
+	(void)purpose;
+	return NULL;
+}
+
+HashTable* collections_noop_get_gc(zend_object *obj, zval **table, int *n) {
+	/* Zend/zend_gc.c does not initialize table or n. So we need to set n to 0 at minimum. */
+	*n = 0;
+	(void) table;
+	(void) obj;
+	/* Nothing needs to be garbage collected */
+	return NULL;
+}
+
+HashTable *collections_internaliterator_get_gc(zend_object_iterator *iter, zval **table, int *n)
+{
+	*table = &iter->data;
+	*n = 1;
+	return NULL;
+}
+

ext/collections/collections_internaliterator.h

@@ -0,0 +1,98 @@
+/*
+   +----------------------------------------------------------------------+
+   | Copyright (c) The PHP Group                                          |
+   +----------------------------------------------------------------------+
+   | This source file is subject to version 3.01 of the PHP license,      |
+   | that is bundled with this package in the file LICENSE, and is        |
+   | available through the world-wide-web at the following url:           |
+   | https://www.php.net/license/3_01.txt                                 |
+   | If you did not receive a copy of the PHP license and are unable to   |
+   | obtain it through the world-wide-web, please send a note to          |
+   | [email protected] so we can mail you a copy immediately.               |
+   +----------------------------------------------------------------------+
+   | Author: Tyson Andre <[email protected]>                                 |
+   +----------------------------------------------------------------------+
+*/
+#ifndef COLLECTIONS_UTIL_H
+#define COLLECTIONS_UTIL_H
+
+#include "Zend/zend.h"
+
+#define COLLECTIONS_MAX_ZVAL_COLLECTION_SIZE HT_MAX_SIZE
+#define empty_entry_list ((const void*) (((uint8_t*)NULL) + 16))
+static zend_always_inline uint32_t collections_next_pow2_capacity_uint32(uint32_t nSize, uint32_t min) {
+	if (nSize < min) {
+		return min;
+	}
+	/* Note that for values such as 63 or 31 of the form ((2^n) - 1),
+	 * subtracting and xor are the same things for numbers in the range of 0 to the max. */
+#ifdef ZEND_WIN32
+	unsigned long index;
+	if (BitScanReverse(&index, nSize - 1)) {
+		return 0x2u << ((31 - index) ^ 0x1f);
+	}
+	/* nSize is ensured to be in the valid range, fall back to it
+	 * rather than using an undefined bit scan result. */
+	return nSize;
+#elif (defined(__GNUC__) || __has_builtin(__builtin_clz))  && defined(PHP_HAVE_BUILTIN_CLZ)
+	return 0x2u << (__builtin_clz(nSize - 1) ^ 0x1f);
+#endif
+	nSize -= 1;
+	nSize |= (nSize >> 1);
+	nSize |= (nSize >> 2);
+	nSize |= (nSize >> 4);
+	nSize |= (nSize >> 8);
+	nSize |= (nSize >> 16);
+	return nSize + 1;
+}
+
+static zend_always_inline size_t collections_next_pow2_capacity(size_t nSize, size_t min) {
+#if SIZEOF_SIZE_T <= 4
+	return collections_next_pow2_capacity_uint32(nSize, min);
+#else
+	if (nSize < min) {
+		return min;
+	}
+	/* Note that for values such as 63 or 31 of the form ((2^n) - 1),
+	 * subtracting and xor are the same things for numbers in the range of 0 to the max. */
+#ifdef ZEND_WIN32
+	unsigned long index;
+	if (BitScanReverse64(&index, nSize - 1)) {
+		return 0x2u << ((63 - index) ^ 0x3f);
+	}
+	/* nSize is ensured to be in the valid range, fall back to it
+	 * rather than using an undefined bit scan result. */
+	return nSize;
+#elif (defined(__GNUC__) || __has_builtin(__builtin_clz))  && defined(PHP_HAVE_BUILTIN_CLZ)
+#if SIZEOF_SIZE_T > SIZEOF_INT
+	return 0x2u << (__builtin_clzl(nSize - 1) ^ (sizeof(long) * 8 - 1));
+#else
+	return 0x2u << (__builtin_clz(nSize - 1) ^ 0x1f);
+#endif
+#else
+	nSize -= 1;
+	nSize |= (nSize >> 1);
+	nSize |= (nSize >> 2);
+	nSize |= (nSize >> 4);
+	nSize |= (nSize >> 8);
+	nSize |= (nSize >> 16);
+	nSize |= (nSize >> 32);
+	return nSize + 1;
+#endif
+#endif
+}
+
+/**
+ * Returns absence of zvals or hash table to garbage collect.
+ * (e.g. for collections that are immutable or made of scalars instead of zvals)
+ */
+HashTable* collections_noop_get_gc(zend_object *obj, zval **table, int *n);
+/**
+ * Returns the immutable empty array in a get_properties handler.
+ * This is useful to keep memory low when a datastructure is guaranteed to be free of cycles (e.g. only scalars, or empty)
+ */
+HashTable* collections_noop_empty_array_get_properties_for(zend_object *obj, zend_prop_purpose purpose);
+
+HashTable *collections_internaliterator_get_gc(zend_object_iterator *iter, zval **table, int *n);
+
+#endif

ext/collections/collections_util.c

@@ -1,5 +1,5 @@
-PHP_NEW_EXTENSION(collections, php_collections.c collections_deque.c, no,, -DZEND_ENABLE_STATIC_TSRMLS_CACHE=1)
-PHP_INSTALL_HEADERS([ext/collections], [php_collections.h collections_deque.h])
+PHP_NEW_EXTENSION(collections, php_collections.c collections_deque.c collections_util.c, no,, -DZEND_ENABLE_STATIC_TSRMLS_CACHE=1)
+PHP_INSTALL_HEADERS([ext/collections], [php_collections.h collections_deque.h collections_internaliterator.h collections_util.h])
 PHP_ADD_EXTENSION_DEP(collections, spl, true)
 PHP_ADD_EXTENSION_DEP(collections, standard, true)
 PHP_ADD_EXTENSION_DEP(collections, json)

ext/collections/collections_util.h

@@ -1,5 +1,5 @@
 // vim:ft=javascript
 
-EXTENSION("collections", "php_collections.c collections_deque.c", false /*never shared */, "/DZEND_ENABLE_STATIC_TSRMLS_CACHE=1");
+EXTENSION("collections", "php_collections.c collections_deque.c collections_util.c", false /*never shared */, "/DZEND_ENABLE_STATIC_TSRMLS_CACHE=1");
 PHP_COLLECTIONS="yes";
-PHP_INSTALL_HEADERS("ext/collections", "php_collections.h collections_deque.h");
+PHP_INSTALL_HEADERS("ext/collections", "php_collections.h collections_deque.h collections_internaliterator.h collections_util.h");

ext/collections/config.m4

@@ -1,26 +1,20 @@
 --TEST--
-Collections\Deque can be cloned
+Collections\Deque can be cloned after building properties table.
 --FILE--
 <?php
-
-$it = new Collections\Deque([new stdClass(), new ArrayObject()]);
-$it2 = clone $it;
-unset($it);
-foreach ($it2 as $key => $value) {
-    echo "Saw entry:\n";
-    var_dump($key, $value);
-}
-
+$x = new Collections\Deque([new stdClass()]);
+var_dump($x);
+$y = clone $x;
+var_dump($y);
 ?>
 --EXPECT--
-Saw entry:
-int(0)
-object(stdClass)#2 (0) {
+object(Collections\Deque)#1 (1) {
+  [0]=>
+  object(stdClass)#2 (0) {
+  }
 }
-Saw entry:
-int(1)
-object(ArrayObject)#3 (1) {
-  ["storage":"ArrayObject":private]=>
-  array(0) {
+object(Collections\Deque)#3 (1) {
+  [0]=>
+  object(stdClass)#2 (0) {
   }
-}
+}