Merge pull request #4765 from evolvedbinary/feature/lock-object-optimisation

Lock object optimisation

Author: dizzzz

exist-core/pom.xml

@@ -710,12 +710,16 @@
                                 <exclude>src/main/java/org/exist/storage/lock/LockEventJsonListener.java</exclude>
                                 <exclude>src/main/java/org/exist/storage/lock/LockEventLogListener.java</exclude>
                                 <exclude>src/main/java/org/exist/storage/lock/LockEventXmlListener.java</exclude>
+                                <exclude>src/main/java/org/exist/storage/lock/LockedPath.java</exclude>
+                                <exclude>src/main/java/org/exist/storage/lock/LockGroup.java</exclude>
                                 <exclude>src/main/java/org/exist/storage/lock/LockManager.java</exclude>
                                 <exclude>src/main/java/org/exist/storage/lock/LockTable.java</exclude>
                                 <exclude>src/main/java/org/exist/storage/lock/LockTableUtils.java</exclude>
                                 <exclude>src/main/java/org/exist/storage/lock/ManagedCollectionLock.java</exclude>
                                 <exclude>src/main/java/org/exist/storage/lock/ManagedDocumentLock.java</exclude>
                                 <exclude>src/main/java/org/exist/storage/lock/ManagedLock.java</exclude>
+                                <exclude>src/main/java/org/exist/storage/lock/ManagedLockGroupDocumentLock.java</exclude>
+                                <exclude>src/main/java/org/exist/storage/lock/ManagedSingleLockDocumentLock.java</exclude>
                                 <exclude>src/test/java/org/exist/storage/lock/CollectionLocksTest.java</exclude>
                                 <exclude>src/test/java/org/exist/storage/lock/DocumentLocksTest.java</exclude>
                                 <exclude>src/test/java/org/exist/storage/lock/LockManagerTest.java</exclude>
@@ -862,12 +866,16 @@ The original license statement is also included below.]]></preamble>
                                 <include>src/main/java/org/exist/storage/lock/LockEventJsonListener.java</include>
                                 <include>src/main/java/org/exist/storage/lock/LockEventLogListener.java</include>
                                 <include>src/main/java/org/exist/storage/lock/LockEventXmlListener.java</include>
+                                <include>src/main/java/org/exist/storage/lock/LockedPath.java</include>
+                                <include>src/main/java/org/exist/storage/lock/LockGroup.java</include>
                                 <include>src/main/java/org/exist/storage/lock/LockManager.java</include>
                                 <include>src/main/java/org/exist/storage/lock/LockTable.java</include>
                                 <include>src/main/java/org/exist/storage/lock/LockTableUtils.java</include>
                                 <include>src/main/java/org/exist/storage/lock/ManagedCollectionLock.java</include>
                                 <include>src/main/java/org/exist/storage/lock/ManagedDocumentLock.java</include>
                                 <include>src/main/java/org/exist/storage/lock/ManagedLock.java</include>
+                                <include>src/main/java/org/exist/storage/lock/ManagedLockGroupDocumentLock.java</include>
+                                <include>src/main/java/org/exist/storage/lock/ManagedSingleLockDocumentLock.java</include>
                                 <include>src/test/java/org/exist/storage/lock/CollectionLocksTest.java</include>
                                 <include>src/test/java/org/exist/storage/lock/DocumentLocksTest.java</include>
                                 <include>src/test/java/org/exist/storage/lock/LockManagerTest.java</include>

exist-core/src/main/java/org/exist/collections/MutableCollection.java

@@ -568,7 +568,7 @@ private void addDocumentsToSet(final DBBroker broker, final Iterator<DocumentImp
 
                     case NO_LOCK:
                     default:
-                        documentLock = ManagedDocumentLock.notLocked(doc.getURI());
+                        documentLock = ManagedSingleLockDocumentLock.notLocked(doc.getURI());
                         break;
                 }
 
@@ -710,7 +710,7 @@ public LockedDocument getDocumentWithLock(final DBBroker broker, final XmldbURI
 
                 case NO_LOCK:
                 default:
-                    documentLock = ManagedDocumentLock.notLocked(getURI().append(name.lastSegment()));
+                    documentLock = ManagedSingleLockDocumentLock.notLocked(getURI().append(name.lastSegment()));
                     unlockFn = () -> {};
             }
 

exist-core/src/main/java/org/exist/storage/lock/LockGroup.java

@@ -0,0 +1,47 @@
+/*
+ * Copyright (C) 2014, Evolved Binary Ltd
+ *
+ * This file was originally ported from FusionDB to eXist-db by
+ * Evolved Binary, for the benefit of the eXist-db Open Source community.
+ * Only the ported code as it appears in this file, at the time that
+ * it was contributed to eXist-db, was re-licensed under The GNU
+ * Lesser General Public License v2.1 only for use in eXist-db.
+ *
+ * This license grant applies only to a snapshot of the code as it
+ * appeared when ported, it does not offer or infer any rights to either
+ * updates of this source code or access to the original source code.
+ *
+ * The GNU Lesser General Public License v2.1 only license follows.
+ *
+ * ---------------------------------------------------------------------
+ *
+ * Copyright (C) 2014, Evolved Binary Ltd
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; version 2.1.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ */
+package org.exist.storage.lock;
+
+/**
+ * @author <a href="mailto:[email protected]">Adam Retter</a>
+ */
+class LockGroup {
+    final long groupId;
+    final LockedPath[] locks;
+
+
+    LockGroup(final long groupId, final LockedPath[] locks) {
+        this.groupId = groupId;
+        this.locks = locks;
+    }
+}

exist-core/src/main/java/org/exist/storage/lock/LockManager.java

@@ -32,7 +32,6 @@
  */
 package org.exist.storage.lock;
 
-import com.evolvedbinary.j8fu.tuple.Tuple3;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 import org.exist.storage.lock.Lock.LockType;
@@ -42,7 +41,6 @@
 import org.exist.xmldb.XmldbURI;
 import uk.ac.ic.doc.slurp.multilock.MultiLock;
 
-import java.util.Arrays;
 import java.util.concurrent.locks.ReentrantLock;
 import java.util.function.Consumer;
 
@@ -219,19 +217,8 @@ public ManagedCollectionLock acquireCollectionReadLock(final XmldbURI collection
         final LockGroup lockGroup = acquirePathReadLock(LockType.COLLECTION, collectionPath);
         return new ManagedCollectionLock(
                 collectionPath,
-                Arrays.stream(lockGroup.locks).map(Tuple3::get_1).toArray(MultiLock[]::new),
-                () -> unlockAll(lockGroup.locks, l -> lockTable.released(lockGroup.groupId, l._3, LockType.COLLECTION, l._2))
-        );
-    }
-
-    private static class LockGroup {
-        final long groupId;
-        final Tuple3<MultiLock, Lock.LockMode, String>[] locks;
-
-        private LockGroup(final long groupId, final Tuple3<MultiLock, Lock.LockMode, String>[] locks) {
-            this.groupId = groupId;
-            this.locks = locks;
-        }
+                lockGroup,
+                lockTable);
     }
 
     /**
@@ -250,7 +237,7 @@ public LockGroup acquirePathReadLock(final LockType lockType, final XmldbURI pat
         final long groupId = System.nanoTime();
 
         String pathStr = "";
-        final Tuple3<MultiLock, Lock.LockMode, String>[] locked = new Tuple3[segments.length];
+        final LockedPath[] locked = new LockedPath[segments.length];
         for (int i = 0; i < segments.length; i++) {
             pathStr += '/' + segments[i].toString();
 
@@ -265,12 +252,12 @@ public LockGroup acquirePathReadLock(final LockType lockType, final XmldbURI pat
 
             lockTable.attempt(groupId, pathStr, lockType, lockMode);
             if (lock(lock, lockMode)) {
-                locked[i] = new Tuple3<>(lock, lockMode, pathStr);
+                locked[i] = new LockedPath(lock, lockMode, pathStr);
                 lockTable.acquired(groupId, pathStr, lockType, lockMode);
             } else {
                 lockTable.attemptFailed(groupId, pathStr, lockType, lockMode);
 
-                unlockAll(locked, l -> lockTable.released(groupId, l._3, lockType, l._2));
+                unlockAll(locked, l -> lockTable.released(groupId, l.path, lockType, l.mode));
 
                 throw new LockException("Unable to acquire " + lockType + " " + lockMode + " for: " + pathStr);
             }
@@ -287,7 +274,7 @@ public LockGroup acquirePathReadLock(final LockType lockType, final XmldbURI pat
      *
      * @return true, if we were able to lock with the mode.
      */
-    private boolean lock(final MultiLock lock, final Lock.LockMode lockMode) {
+    private static boolean lock(final MultiLock lock, final Lock.LockMode lockMode) {
         switch (lockMode) {
             case INTENTION_READ:
                 lock.intentionReadLock();
@@ -319,10 +306,10 @@ private boolean lock(final MultiLock lock, final Lock.LockMode lockMode) {
      *
      * @param locked An array of locks in acquisition order
      */
-    private void unlockAll(final Tuple3<MultiLock, Lock.LockMode, String>[] locked, final Consumer<Tuple3<MultiLock, Lock.LockMode, String>> unlockListener) {
-        for(int i = locked.length - 1; i >= 0; i--) {
-            final Tuple3<MultiLock, Lock.LockMode, String> lock = locked[i];
-            unlock(lock._1, lock._2);
+    static void unlockAll(final LockedPath[] locked, final Consumer<LockedPath> unlockListener) {
+        for (int i = locked.length - 1; i >= 0; i--) {
+            final LockedPath lock = locked[i];
+            unlock(lock.lock, lock.mode);
             unlockListener.accept(lock);
         }
     }
@@ -333,8 +320,8 @@ private void unlockAll(final Tuple3<MultiLock, Lock.LockMode, String>[] locked,
      * @param lock The lock object to unlock.
      * @param lockMode The mode of the {@code lock} to release.
      */
-    private void unlock(final MultiLock lock, final Lock.LockMode lockMode) {
-        switch(lockMode) {
+    static void unlock(final MultiLock lock, final Lock.LockMode lockMode) {
+        switch (lockMode) {
             case INTENTION_READ:
                 lock.unlockIntentionRead();
                 break;
@@ -380,9 +367,8 @@ ManagedCollectionLock acquireCollectionWriteLock(final XmldbURI collectionPath,
         final LockGroup lockGroup = acquirePathWriteLock(LockType.COLLECTION, collectionPath, lockParent);
         return new ManagedCollectionLock(
                 collectionPath,
-                Arrays.stream(lockGroup.locks).map(Tuple3::get_1).toArray(MultiLock[]::new),
-                () -> unlockAll(lockGroup.locks, l -> lockTable.released(lockGroup.groupId, l._3, LockType.COLLECTION, l._2))
-        );
+                lockGroup,
+                lockTable);
     }
 
     /**
@@ -400,7 +386,7 @@ LockGroup acquirePathWriteLock(final LockType lockType, final XmldbURI path,
         final long groupId = System.nanoTime();
 
         String pathStr = "";
-        final Tuple3<MultiLock, Lock.LockMode, String>[] locked = new Tuple3[segments.length];
+        final LockedPath[] locked = new LockedPath[segments.length];
         for (int i = 0; i < segments.length; i++) {
             pathStr += '/' + segments[i].toString();
 
@@ -437,12 +423,12 @@ LockGroup acquirePathWriteLock(final LockType lockType, final XmldbURI path,
 
             lockTable.attempt(groupId, pathStr, lockType, lockMode);
             if (lock(lock, lockMode)) {
-                locked[i] = new Tuple3<>(lock, lockMode, pathStr);
+                locked[i] = new LockedPath(lock, lockMode, pathStr);
                 lockTable.acquired(groupId, pathStr, lockType, lockMode);
             } else {
                 lockTable.attemptFailed(groupId, pathStr, lockType, lockMode);
 
-                unlockAll(locked, l -> lockTable.released(groupId, l._3, lockType, l._2));
+                unlockAll(locked, l -> lockTable.released(groupId, l.path, lockType, l.mode));
 
                 throw new LockException("Unable to acquire " + lockType + " " + lockMode + " for: " + pathStr);
             }
@@ -503,11 +489,7 @@ MultiLock getDocumentLock(final String documentPath) {
     public ManagedDocumentLock acquireDocumentReadLock(final XmldbURI documentPath) throws LockException {
         if (usePathLocksForDocuments) {
             final LockGroup lockGroup = acquirePathReadLock(LockType.DOCUMENT, documentPath);
-            return new ManagedDocumentLock(
-                    documentPath,
-                    Arrays.stream(lockGroup.locks).map(Tuple3::get_1).toArray(MultiLock[]::new),
-                    () -> unlockAll(lockGroup.locks, l -> lockTable.released(lockGroup.groupId, l._3, LockType.DOCUMENT, l._2))
-            );
+            return new ManagedLockGroupDocumentLock(documentPath, lockGroup, lockTable);
         } else {
             final long groupId = System.nanoTime();
             final String path = documentPath.toString();
@@ -523,10 +505,7 @@ public ManagedDocumentLock acquireDocumentReadLock(final XmldbURI documentPath)
                 throw new LockException("Unable to acquire READ_LOCK for: " + path);
             }
 
-            return new ManagedDocumentLock(documentPath, lock, () -> {
-                lock.asReadLock().unlock();
-                lockTable.released(groupId, path, LockType.DOCUMENT, Lock.LockMode.READ_LOCK);
-            });
+            return new ManagedSingleLockDocumentLock(documentPath, groupId, lock, Lock.LockMode.READ_LOCK, lockTable);
         }
     }
 
@@ -542,11 +521,7 @@ public ManagedDocumentLock acquireDocumentReadLock(final XmldbURI documentPath)
     public ManagedDocumentLock acquireDocumentWriteLock(final XmldbURI documentPath) throws LockException {
         if (usePathLocksForDocuments) {
             final LockGroup lockGroup = acquirePathWriteLock(LockType.DOCUMENT, documentPath, false);
-            return new ManagedDocumentLock(
-                    documentPath,
-                    Arrays.stream(lockGroup.locks).map(Tuple3::get_1).toArray(MultiLock[]::new),
-                    () -> unlockAll(lockGroup.locks, l -> lockTable.released(lockGroup.groupId, l._3, LockType.DOCUMENT, l._2))
-            );
+            return new ManagedLockGroupDocumentLock(documentPath, lockGroup, lockTable);
         } else {
             final long groupId = System.nanoTime();
             final String path = documentPath.toString();
@@ -561,10 +536,7 @@ public ManagedDocumentLock acquireDocumentWriteLock(final XmldbURI documentPath)
                 throw new LockException("Unable to acquire WRITE_LOCK for: " + path);
             }
 
-            return new ManagedDocumentLock(documentPath, lock, () -> {
-                lock.asWriteLock().unlock();
-                lockTable.released(groupId, path, LockType.DOCUMENT, Lock.LockMode.WRITE_LOCK);
-            });
+            return new ManagedSingleLockDocumentLock(documentPath, groupId, lock, Lock.LockMode.WRITE_LOCK, lockTable);
         }
     }
 

exist-core/src/main/java/org/exist/storage/lock/LockedPath.java

@@ -0,0 +1,50 @@
+/*
+ * Copyright (C) 2014, Evolved Binary Ltd
+ *
+ * This file was originally ported from FusionDB to eXist-db by
+ * Evolved Binary, for the benefit of the eXist-db Open Source community.
+ * Only the ported code as it appears in this file, at the time that
+ * it was contributed to eXist-db, was re-licensed under The GNU
+ * Lesser General Public License v2.1 only for use in eXist-db.
+ *
+ * This license grant applies only to a snapshot of the code as it
+ * appeared when ported, it does not offer or infer any rights to either
+ * updates of this source code or access to the original source code.
+ *
+ * The GNU Lesser General Public License v2.1 only license follows.
+ *
+ * ---------------------------------------------------------------------
+ *
+ * Copyright (C) 2014, Evolved Binary Ltd
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; version 2.1.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ */
+package org.exist.storage.lock;
+
+import uk.ac.ic.doc.slurp.multilock.MultiLock;
+
+/**
+ * @author <a href="mailto:[email protected]">Adam Retter</a>
+ */
+class LockedPath {
+    final MultiLock lock;
+    final Lock.LockMode mode;
+    final String path;
+
+    LockedPath(final MultiLock lock, final Lock.LockMode mode, final String path) {
+        this.lock = lock;
+        this.mode = mode;
+        this.path = path;
+    }
+}

exist-core/src/main/java/org/exist/storage/lock/ManagedCollectionLock.java

@@ -33,25 +33,40 @@
 package org.exist.storage.lock;
 
 import org.exist.xmldb.XmldbURI;
-import uk.ac.ic.doc.slurp.multilock.MultiLock;
+
+import javax.annotation.Nullable;
 
 /**
  * @author <a href="mailto:[email protected]">Adam Retter</a>
  */
-public class ManagedCollectionLock extends ManagedLock<MultiLock[]> {
+public class ManagedCollectionLock extends ManagedLock<LockGroup> {
 
     private final XmldbURI collectionUri;
+    @Nullable private final LockTable lockTable;  // NOTE(AR) only null when called via private constructor from {@link #notLocked(XmldbURI)}.
 
-    public ManagedCollectionLock(final XmldbURI collectionUri, final MultiLock[] locks, final Runnable closer) {
-        super(locks, closer);
+    public ManagedCollectionLock(final XmldbURI collectionUri, final LockGroup lockGroup, final LockTable lockTable) {
+        super(lockGroup, null);  // NOTE(AR) we can set the closer as null here, because we override {@link #close()} below!
         this.collectionUri = collectionUri;
+        this.lockTable = lockTable;
+    }
+
+    private ManagedCollectionLock(final XmldbURI collectionUri) {
+        this(collectionUri, null, null);
     }
 
     public XmldbURI getPath() {
         return collectionUri;
     }
 
+    @Override
+    public void close() {
+        if (!closed && lock != null) {  // NOTE(AR) only null when constructed from {@link #notLocked(XmldbURI)}.
+            LockManager.unlockAll(lock.locks, l -> lockTable.released(lock.groupId, l.path, Lock.LockType.COLLECTION, l.mode));
+        }
+        this.closed = true;
+    }
+
     public static ManagedCollectionLock notLocked(final XmldbURI collectionUri) {
-        return new ManagedCollectionLock(collectionUri, null, () -> {});
+        return new ManagedCollectionLock(collectionUri);
     }
 }