Separate cursor close and release phase

The close() call now only stops further use of the cursor until reopened,
and hands it back to the pool. PageCursors and other resources are not
released until calling release() though, which means that they may be
reused via the instance cache.

community/kernel/src/main/java/org/neo4j/kernel/impl/newapi/DefaultNodeCursor.java

@@ -20,7 +20,6 @@
 package org.neo4j.kernel.impl.newapi;
 
 import java.util.Set;
-import java.util.function.Consumer;
 
 import org.neo4j.collection.primitive.Primitive;
 import org.neo4j.collection.primitive.PrimitiveIntSet;
@@ -48,9 +47,9 @@ class DefaultNodeCursor extends NodeRecord implements NodeCursor
     private HasChanges hasChanges = HasChanges.MAYBE;
     private Set<Long> addedNodes;
 
-    private final Consumer<DefaultNodeCursor> pool;
+    private final DefaultCursors pool;
 
-    DefaultNodeCursor( Consumer<DefaultNodeCursor> pool )
+    DefaultNodeCursor( DefaultCursors pool )
     {
         super( NO_ID );
         this.pool = pool;
@@ -246,21 +245,12 @@ public boolean shouldRetry()
     @Override
     public void close()
     {
-        read = null;
-        hasChanges = HasChanges.MAYBE;
-        addedNodes = emptySet();
-        reset();
-
-        if ( labelCursor != null )
+        if ( !isClosed() )
         {
-            labelCursor.close();
-            labelCursor = null;
-        }
-
-        if ( pageCursor != null )
-        {
-            pageCursor.close();
-            pageCursor = null;
+            read = null;
+            hasChanges = HasChanges.MAYBE;
+            addedNodes = emptySet();
+            reset();
 
             pool.accept( this );
         }
@@ -269,7 +259,7 @@ public void close()
     @Override
     public boolean isClosed()
     {
-        return pageCursor == null;
+        return read == null;
     }
 
     /**
@@ -337,4 +327,19 @@ public String toString()
             return "NodeCursor[id=" + getId() + ", open state with: highMark=" + highMark + ", next=" + next + ", underlying record=" + super.toString() + " ]";
         }
     }
+
+    void release()
+    {
+        if ( labelCursor != null )
+        {
+            labelCursor.close();
+            labelCursor = null;
+        }
+
+        if ( pageCursor != null )
+        {
+            pageCursor.close();
+            pageCursor = null;
+        }
+    }
 }

community/kernel/src/main/java/org/neo4j/kernel/impl/newapi/DefaultNodeExplicitIndexCursor.java

@@ -19,8 +19,6 @@
  */
 package org.neo4j.kernel.impl.newapi;
 
-import java.util.function.Consumer;
-
 import org.neo4j.internal.kernel.api.NodeCursor;
 import org.neo4j.storageengine.api.schema.IndexProgressor.ExplicitClient;
 
@@ -34,9 +32,9 @@ class DefaultNodeExplicitIndexCursor extends IndexCursor<ExplicitIndexProgressor
     private long node;
     private float score;
 
-    private final Consumer<DefaultNodeExplicitIndexCursor> pool;
+    private final DefaultCursors pool;
 
-    DefaultNodeExplicitIndexCursor( Consumer<DefaultNodeExplicitIndexCursor> pool )
+    DefaultNodeExplicitIndexCursor( DefaultCursors pool )
     {
         this.pool = pool;
         node = NO_ID;
@@ -126,4 +124,9 @@ public String toString()
                     ", underlying record=" + super.toString() + " ]";
         }
     }
+
+    public void release()
+    {
+        // nothing to do
+    }
 }

community/kernel/src/main/java/org/neo4j/kernel/impl/newapi/DefaultNodeLabelIndexCursor.java

@@ -21,7 +21,6 @@
 
 import java.util.HashSet;
 import java.util.Set;
-import java.util.function.Consumer;
 
 import org.neo4j.collection.primitive.PrimitiveLongCollections;
 import org.neo4j.collection.primitive.PrimitiveLongIterator;
@@ -44,9 +43,9 @@ class DefaultNodeLabelIndexCursor extends IndexCursor<LabelScanValueIndexProgres
     private PrimitiveLongIterator added;
     private Set<Long> removed;
 
-    private final Consumer<DefaultNodeLabelIndexCursor> pool;
+    private final DefaultCursors pool;
 
-    DefaultNodeLabelIndexCursor( Consumer<DefaultNodeLabelIndexCursor> pool )
+    DefaultNodeLabelIndexCursor( DefaultCursors pool )
     {
         this.pool = pool;
         node = NO_ID;
@@ -180,4 +179,9 @@ private boolean isRemoved( long reference )
     {
         return removed != null && removed.contains( reference );
     }
+
+    public void release()
+    {
+        // nothing to do
+    }
 }

community/kernel/src/main/java/org/neo4j/kernel/impl/newapi/DefaultNodeValueIndexCursor.java

@@ -20,7 +20,6 @@
 package org.neo4j.kernel.impl.newapi;
 
 import java.util.Arrays;
-import java.util.function.Consumer;
 
 import org.neo4j.collection.primitive.PrimitiveLongCollections;
 import org.neo4j.collection.primitive.PrimitiveLongIterator;
@@ -52,9 +51,9 @@ final class DefaultNodeValueIndexCursor extends IndexCursor<IndexProgressor>
     private PrimitiveLongIterator added = emptyIterator();
     private PrimitiveLongSet removed = emptySet();
     private boolean needsValues;
-    private final Consumer<DefaultNodeValueIndexCursor> pool;
+    private final DefaultCursors pool;
 
-    DefaultNodeValueIndexCursor( Consumer<DefaultNodeValueIndexCursor> pool )
+    DefaultNodeValueIndexCursor( DefaultCursors pool )
     {
         this.pool = pool;
         node = NO_ID;
@@ -312,4 +311,9 @@ private PrimitiveLongSet removed( TransactionState txState, PrimitiveLongReadabl
         longSet.addAll( changes.getRemoved().iterator() );
         return longSet;
     }
+
+    public void release()
+    {
+        // nothing to do
+    }
 }

community/kernel/src/main/java/org/neo4j/kernel/impl/newapi/DefaultPropertyCursor.java

@@ -21,7 +21,6 @@
 
 import java.nio.ByteBuffer;
 import java.util.Iterator;
-import java.util.function.Consumer;
 import java.util.regex.Pattern;
 
 import org.neo4j.internal.kernel.api.PropertyCursor;
@@ -66,9 +65,9 @@ public class DefaultPropertyCursor extends PropertyRecord implements PropertyCur
     private Iterator<StorageProperty> txStateChangedProperties;
     private StorageProperty txStateValue;
     private AssertOpen assertOpen;
-    private final Consumer<DefaultPropertyCursor> pool;
+    private final DefaultCursors pool;
 
-    public DefaultPropertyCursor( Consumer<DefaultPropertyCursor> pool )
+    public DefaultPropertyCursor( DefaultCursors pool )
     {
         super( NO_ID );
         this.pool = pool;
@@ -233,26 +232,13 @@ public boolean shouldRetry()
     @Override
     public void close()
     {
-        propertiesState = null;
-        txStateChangedProperties = null;
-        txStateValue = null;
-        read = null;
-        clear();
-
-        if ( stringPage != null )
+        if ( !isClosed() )
         {
-            stringPage.close();
-            stringPage = null;
-        }
-        if ( arrayPage != null )
-        {
-            arrayPage.close();
-            arrayPage = null;
-        }
-        if ( page != null )
-        {
-            page.close();
-            page = null;
+            propertiesState = null;
+            txStateChangedProperties = null;
+            txStateValue = null;
+            read = null;
+            clear();
 
             pool.accept( this );
         }
@@ -558,7 +544,7 @@ public boolean valueLessThanOrEqualTo( double number )
     @Override
     public boolean isClosed()
     {
-        return page == null;
+        return read == null;
     }
 
     @Override
@@ -574,4 +560,23 @@ public String toString()
                    ", underlying record=" + super.toString() + " ]";
         }
     }
+
+    public void release()
+    {
+        if ( stringPage != null )
+        {
+            stringPage.close();
+            stringPage = null;
+        }
+        if ( arrayPage != null )
+        {
+            arrayPage.close();
+            arrayPage = null;
+        }
+        if ( page != null )
+        {
+            page.close();
+            page = null;
+        }
+    }
 }

community/kernel/src/main/java/org/neo4j/kernel/impl/newapi/DefaultRelationshipExplicitIndexCursor.java

@@ -19,8 +19,6 @@
  */
 package org.neo4j.kernel.impl.newapi;
 
-import java.util.function.Consumer;
-
 import org.neo4j.internal.kernel.api.NodeCursor;
 import org.neo4j.internal.kernel.api.RelationshipExplicitIndexCursor;
 import org.neo4j.internal.kernel.api.RelationshipScanCursor;
@@ -36,9 +34,9 @@ class DefaultRelationshipExplicitIndexCursor extends IndexCursor<ExplicitIndexPr
     private long relationship;
     private float score;
 
-    private final Consumer<DefaultRelationshipExplicitIndexCursor> pool;
+    private final DefaultCursors pool;
 
-    DefaultRelationshipExplicitIndexCursor( Consumer<DefaultRelationshipExplicitIndexCursor> pool )
+    DefaultRelationshipExplicitIndexCursor( DefaultCursors pool )
     {
         this.pool = pool;
     }
@@ -157,4 +155,9 @@ public String toString()
                     " ,underlying record=" + super.toString() + " ]";
         }
     }
+
+    public void release()
+    {
+        // nothing to do
+    }
 }

community/kernel/src/main/java/org/neo4j/kernel/impl/newapi/DefaultRelationshipGroupCursor.java

@@ -19,8 +19,6 @@
  */
 package org.neo4j.kernel.impl.newapi;
 
-import java.util.function.Consumer;
-
 import org.neo4j.collection.primitive.Primitive;
 import org.neo4j.collection.primitive.PrimitiveIntIterator;
 import org.neo4j.collection.primitive.PrimitiveIntObjectMap;
@@ -46,7 +44,7 @@ class DefaultRelationshipGroupCursor extends RelationshipGroupRecord implements
 {
     private Read read;
     private final RelationshipRecord edge = new RelationshipRecord( NO_ID );
-    private final Consumer<DefaultRelationshipGroupCursor> pool;
+    private final DefaultCursors pool;
 
     private BufferedGroup bufferedGroup;
     private PageCursor page;
@@ -55,7 +53,7 @@ class DefaultRelationshipGroupCursor extends RelationshipGroupRecord implements
     private final PrimitiveIntSet txTypes = Primitive.intSet();
     private PrimitiveIntIterator txTypeIterator;
 
-    DefaultRelationshipGroupCursor( Consumer<DefaultRelationshipGroupCursor> pool )
+    DefaultRelationshipGroupCursor( DefaultCursors pool )
     {
         super( NO_ID );
         this.pool = pool;
@@ -243,23 +241,17 @@ public boolean shouldRetry()
     @Override
     public void close()
     {
-        bufferedGroup = null;
-        read = null;
-        setId( NO_ID );
-        clear();
-
-        if ( edgePage != null )
+        if ( !isClosed() )
         {
-            edgePage.close();
-            edgePage = null;
-        }
+            bufferedGroup = null;
+            read = null;
+            setId( NO_ID );
+            clear();
 
-        if ( page != null )
-        {
-            page.close();
-            page = null;
-
-            pool.accept( this );
+            if ( pool != null )
+            {
+                pool.accept( this );
+            }
         }
     }
 
@@ -410,7 +402,7 @@ public long loopsReference()
     @Override
     public boolean isClosed()
     {
-        return page == null && bufferedGroup == null;
+        return read == null && bufferedGroup == null;
     }
 
     @Override
@@ -470,6 +462,21 @@ private long encodeRelationshipReference( long relationshipId )
         return isBuffered() ? encodeForFiltering( relationshipId ) : encodeForTxStateFiltering( relationshipId );
     }
 
+    public void release()
+    {
+        if ( edgePage != null )
+        {
+            edgePage.close();
+            edgePage = null;
+        }
+
+        if ( page != null )
+        {
+            page.close();
+            page = null;
+        }
+    }
+
     static class BufferedGroup
     {
         final int label;