NO-JIRA Let SparseArrayLinkedList to reuse the last empty array

artemis-commons/src/main/java/org/apache/activemq/artemis/utils/collections/SparseArrayLinkedList.java

@@ -29,7 +29,10 @@ import java.util.function.Predicate;
  * Differently from an {@code UnrolledLinkedList} this list doesn't optimize addition and removal to achieve a balanced
  * utilization among chunks ie a chunk is removed only if empty and chunks can't be merged.
  * This list has been optimized for small-sized chunks (ideally <= 32 elements): this allow search/removal to
- * be performed with a greedy approach despite a sparse chunk utilization (ie chunks contains few sparse elements)
+ * be performed with a greedy approach despite a sparse chunk utilization (ie chunks contains few sparse elements).<br>
+ *
+ * From the memory footprint's point of view, this list won't remove the last remaining array although empty to optimize
+ * the case where its capacity would be enough to hold incoming elements, hence saving a new array allocation.
  */
 public final class SparseArrayLinkedList<T> {
 
@@ -89,6 +92,11 @@ public final class SparseArrayLinkedList<T> {
             }
          }
          size -= removed;
+         // reset the tail in case of no elements left:
+         // tail is set to be the next of the last
+         if (size == 0) {
+            tail = 0;
+         }
          return removed;
       }
 
@@ -134,10 +142,10 @@ public final class SparseArrayLinkedList<T> {
          final int justRemoved = sparseArray.remove(filter);
          removed += justRemoved;
          if (justRemoved > 0) {
-            // remove RecordInfo only if empty:
+            // remove the array only if empty and not the last one:
             // it means that there is a chance of fragmentation
-            // proportional with the capacity of chunk
-            if (sparseArray.size() == 0) {
+            // proportional with the array capacity
+            if (sparseArrayList.size() > 1 && sparseArray.size() == 0) {
                iter.remove();
             }
          }
@@ -159,11 +167,13 @@ public final class SparseArrayLinkedList<T> {
       final int size = sparseArrayList.size();
       long count = 0;
       if (size > 0) {
-         for (int i = 0; i < size; i++) {
+         for (int i = 0; i < size - 1; i++) {
             // LinkedList::remove(0) is fast as LinkedList::getFirst
             final SparseArray<T> removed = sparseArrayList.remove(0);
             count += removed.clear(consumer);
          }
+         // LinkedList::get(0) is fast as LinkedList::getFirst
+         count += sparseArrayList.get(0).clear(consumer);
       }
       return count;
    }

artemis-commons/src/test/java/org/apache/activemq/artemis/utils/collections/SparseArrayLinkedListTest.java

@@ -76,7 +76,7 @@ public class SparseArrayLinkedListTest {
       }
       final List<Integer> removed = new ArrayList<>(elements);
       Assert.assertEquals(elements, list.clear(removed::add));
-      Assert.assertEquals(0, list.sparseArraysCount());
+      Assert.assertEquals(1, list.sparseArraysCount());
       Assert.assertEquals(0, list.size());
       Assert.assertThat(removed, is(expected));
    }
@@ -93,8 +93,9 @@ public class SparseArrayLinkedListTest {
       Assert.assertEquals(elements - 1, list.size());
       Assert.assertEquals(elements - 1, list.remove(e -> true));
       Assert.assertEquals(0, list.size());
+      Assert.assertEquals(1, list.sparseArraysCount());
       Assert.assertEquals(0, list.remove(e -> true));
-      Assert.assertEquals(0, list.sparseArraysCount());
+      Assert.assertEquals(1, list.sparseArraysCount());
    }
 
    @Test
@@ -120,7 +121,7 @@ public class SparseArrayLinkedListTest {
       final int endNotInclusiveLast = elements;
       Assert.assertEquals(list.sparseArrayCapacity(),
                           list.remove(e -> e.intValue() >= startInclusiveLast && e.intValue() < endNotInclusiveLast));
-      Assert.assertEquals(0, list.sparseArraysCount());
+      Assert.assertEquals(1, list.sparseArraysCount());
    }
 
    @Test
@@ -139,6 +140,22 @@ public class SparseArrayLinkedListTest {
       Assert.assertEquals(2, list.sparseArraysCount());
    }
 
+   @Test
+   public void shouldReuseAllTheAvailableSpaceInTheSameArray() {
+      final int elements = list.sparseArrayCapacity();
+      for (int i = 0; i < elements; i++) {
+         list.add(i);
+      }
+      Assert.assertEquals(1, list.sparseArraysCount());
+      // removing all elements
+      Assert.assertEquals(elements, list.remove(e -> true));
+      Assert.assertEquals(1, list.sparseArraysCount());
+      for (int i = 0; i < elements; i++) {
+         list.add(i);
+      }
+      Assert.assertEquals(1, list.sparseArraysCount());
+   }
+
    @Test
    public void shouldClearConsumeRemainingElementsInOrder() {
       final int elements = ELEMENTS;