From 420cee633f2607b6897993938ac1fe806354a945 Mon Sep 17 00:00:00 2001 From: Artem Ananev Date: Mon, 3 Apr 2023 14:28:15 -0700 Subject: [PATCH 1/3] 5179: Bucket.findEntryOffset() can reduce calls to getKeySize() Signed-off-by: Artem Ananev --- .../merkledb/files/hashmap/Bucket.java | 109 ++++++++---------- .../merkledb/files/hashmap/BucketTest.java | 2 +- 2 files changed, 47 insertions(+), 64 deletions(-) diff --git a/platform-sdk/swirlds-jasperdb/src/main/java/com/swirlds/merkledb/files/hashmap/Bucket.java b/platform-sdk/swirlds-jasperdb/src/main/java/com/swirlds/merkledb/files/hashmap/Bucket.java index 96b58fa6e1d6..afcbdd5cf81d 100644 --- a/platform-sdk/swirlds-jasperdb/src/main/java/com/swirlds/merkledb/files/hashmap/Bucket.java +++ b/platform-sdk/swirlds-jasperdb/src/main/java/com/swirlds/merkledb/files/hashmap/Bucket.java @@ -22,7 +22,6 @@ import static com.swirlds.merkledb.files.hashmap.HalfDiskHashMap.SPECIAL_DELETE_ME_VALUE; import static com.swirlds.merkledb.files.hashmap.HalfDiskHashMap.VALUE_SIZE; -import com.swirlds.common.io.streams.SerializableDataOutputStream; import com.swirlds.common.utility.Units; import com.swirlds.merkledb.serialize.KeySerializer; import com.swirlds.virtualmap.VirtualKey; @@ -43,14 +42,13 @@ *
  • int - Bucket index in map hash index
    • *
  • int - Bucket size, total number of bytes taken by bucket including header
    • *
  • int - Number of entries in this bucket
    • - *
  • Entry[] - array of entries
    • * * - * Each Entry contains: + * Then comes an array of entries. Each Entry contains: * * */ @@ -72,10 +70,17 @@ public final class Bucket> { private static final int BUCKET_HEADER_SIZE = BUCKET_ENTRY_COUNT_OFFSET + BUCKET_ENTRY_COUNT_SIZE; private static final int ENTRY_VALUE_OFFSET = KEY_HASHCODE_SIZE; + private static final int ENTRY_KEY_OFFSET = KEY_HASHCODE_SIZE + VALUE_SIZE; + /** Keep track of the largest bucket we have ever created for logging */ private static final AtomicInteger LARGEST_SIZE_OF_BUCKET_CREATED = new AtomicInteger(0); private int keySerializationVersion; + /** + * Byte buffer that holds this bucket data, including bucket index, size in bytes, number of + * entries, and entry data. Buffer is expanded as needed, when new entries are added. Buffer + * limit is kept equal to the bucket size in bytes. + */ private ByteBuffer bucketBuffer; private KeySerializer keySerializer; private ByteBuffer reusableBuffer; @@ -107,8 +112,7 @@ public Bucket clear() { // reset size setSize(BUCKET_HEADER_SIZE); // reset buffer - bucketBuffer.position(0); - bucketBuffer.limit(bucketBuffer.capacity()); + bucketBuffer.clear(); return this; } @@ -200,7 +204,7 @@ public long findValue(final int keyHashCode, final K key, final long notFoundVal final FindResult found = findEntryOffset(keyHashCode, key); if (found.found) { // yay! we found it - return getValue(found.entryOffset); + return found.entryValue; } else { return notFoundValue; } @@ -233,23 +237,15 @@ public void putValue(final K key, final long value) { // move all entries after this one up final int offsetOfNextEntry = result.entryOffset + entrySize; final int sizeOfEntriesToMove = currentSize - offsetOfNextEntry; - // FUTURE WORK For Java 17 do this - // https://github.com/swirlds/swirlds-platform/issues/4090 - // bucketBuffer.put(result.entryOffset,bucketBuffer,offsetOfNextEntry,sizeOfEntriesToMove); - final byte[] bucketBytes = bucketBuffer.array(); - System.arraycopy( - bucketBytes, offsetOfNextEntry, bucketBytes, result.entryOffset, sizeOfEntriesToMove); + bucketBuffer.put(result.entryOffset, bucketBuffer, offsetOfNextEntry, sizeOfEntriesToMove); } // decrement count decrementBucketEntryCount(); // update size by removing entry size from size setSize(currentSize - entrySize); // we are done deleting - return; - } else { - // was not found, and we are deleting so nothing to do - return; } + return; } // handle UPDATE if (result.found) { @@ -260,7 +256,7 @@ public void putValue(final K key, final long value) { /* We have to serialize a variable-size key to a temp byte buffer to check if there is going to be enough room to store it in this bucket. */ if (keySerializer.isVariableSize()) { - reusableBuffer.rewind(); + reusableBuffer.clear(); while (true) { try { keySerializer.serialize(key, reusableBuffer); @@ -281,12 +277,6 @@ public void putValue(final K key, final long value) { // write the key reusableBuffer.flip(); bucketBuffer.put(reusableBuffer); - // shrink reusable buffer, if possible - if (keySizeBytes < reusableBuffer.capacity() / 2) { - reusableBuffer = ByteBuffer.allocate(reusableBuffer.capacity() / 2); - } - // increment count and update size - incrementBucketEntryCount(); } else { final int newSize = result.entryOffset + KEY_HASHCODE_SIZE + VALUE_SIZE + keySerializer.getSerializedSize(); @@ -297,9 +287,9 @@ public void putValue(final K key, final long value) { bucketBuffer.putInt(keyHashCode); bucketBuffer.putLong(value); keySerializer.serialize(key, bucketBuffer); - // increment count - incrementBucketEntryCount(); } + // increment count + incrementBucketEntryCount(); } catch (IOException e) { logger.error(EXCEPTION.getMarker(), "Failed putting key={} value={} in a bucket", key, value, e); throw new UncheckedIOException(e); @@ -313,27 +303,18 @@ public void putValue(final K key, final long value) { */ public void putAllData(ByteBuffer dataBuffer) { ensureCapacity(dataBuffer.limit()); - /* FUTURE WORK - https://github.com/swirlds/swirlds-platform/issues/3939 Maybe we should wrap not copy buffer */ bucketBuffer.rewind().put(dataBuffer); } /** - * Write the complete data bytes for this bucket to a output stream. + * Write the complete data bytes for this bucket to a byte buffer * - * @param outputStream The stream to write to + * @param buffer The byte buffer to write to * @return the number of bytes written - * @throws IOException If there was a problem writing */ - public int writeToOutputStream(final SerializableDataOutputStream outputStream) throws IOException { - final int bucketSize = getSize(); - outputStream.write(bucketBuffer.array(), 0, bucketSize); - return bucketSize; - } - public int writeToByteBuffer(final ByteBuffer buffer) { - final int bucketSize = getSize(); - buffer.put(ByteBuffer.wrap(bucketBuffer.array(), 0, bucketSize)); - return bucketSize; + buffer.put(bucketBuffer.rewind()); + return getSize(); } // ================================================================================================================= @@ -341,7 +322,7 @@ public int writeToByteBuffer(final ByteBuffer buffer) { /** * Expand the capacity of this bucket to make sure it is at least big enough to contain - * neededSize + * neededSize and sets bucket buffer limit to the requested size. */ private void ensureCapacity(int neededSize) { int capacity = bucketBuffer.capacity(); @@ -354,6 +335,7 @@ private void ensureCapacity(int neededSize) { newBucketBuffer.put(bucketBuffer); bucketBuffer = newBucketBuffer; } + bucketBuffer.limit(neededSize); } /** @@ -370,22 +352,26 @@ private FindResult findEntryOffset(final int keyHashCode, final K key) throws IO final int entryCount = getBucketEntryCount(); int entryOffset = BUCKET_HEADER_SIZE; for (int i = 0; i < entryCount; i++) { - final int readHashCode = bucketBuffer.getInt(entryOffset); + bucketBuffer.position(entryOffset); + final int readHashCode = bucketBuffer.getInt(); if (readHashCode == keyHashCode) { + final long readValue = bucketBuffer.getLong(); // now check the full key - bucketBuffer.position(entryOffset + KEY_HASHCODE_SIZE + VALUE_SIZE); if (keySerializer.equals(bucketBuffer, keySerializationVersion, key)) { // yay! we found it - return new FindResult(entryOffset, i, true); + return new FindResult(entryOffset, i, true, readValue); } } - // now read the key size so we can jump - /* FUTURE WORK - https://github.com/swirlds/swirlds-platform/issues/3932 */ - int keySize = getKeySize(entryOffset); - // move to next entry - entryOffset += KEY_HASHCODE_SIZE + VALUE_SIZE + keySize; + // Move entry offset to the next entry. No need to do this for the last entry + if (i < entryCount - 1) { + // now read the key size so we can jump + int keySize = getKeySize(entryOffset); + // move to next entry + entryOffset += KEY_HASHCODE_SIZE + VALUE_SIZE + keySize; + } } - return new FindResult(entryOffset, -1, false); + // Entry is not found. Return the current size of the buffer as the offset + return new FindResult(getSize(), -1, false, 0); } /** @@ -398,7 +384,7 @@ private int getKeySize(final int entryOffset) { if (!keySerializer.isVariableSize()) { return keySerializer.getSerializedSize(); } - bucketBuffer.position(entryOffset + KEY_HASHCODE_SIZE + VALUE_SIZE); + bucketBuffer.position(entryOffset + ENTRY_KEY_OFFSET); return keySerializer.deserializeKeySize(bucketBuffer); } @@ -410,7 +396,7 @@ private int getKeySize(final int entryOffset) { * @throws IOException If there was a problem reading or deserializing the key */ private K getKey(int entryOffset) throws IOException { - bucketBuffer.position(entryOffset + Integer.BYTES); + bucketBuffer.position(entryOffset + ENTRY_KEY_OFFSET); return keySerializer.deserialize(bucketBuffer, keySerializationVersion); } @@ -480,17 +466,14 @@ public String toString() { // ================================================================================================================= // FindResult class - /** Simple struct style data class for allowing return of two things */ - private static class FindResult { - public final int entryOffset; - public final int entryIndex; - public final boolean found; - - public FindResult(final int entryOffset, final int entryIndex, final boolean found) { - this.entryOffset = entryOffset; - this.entryIndex = entryIndex; - this.found = found; - } + /** + * Simple record for entry lookup results. If an entry is found, "found" is set to true, + * "entryOffset" is the entry offset in bytes in the bucket buffer, "entryIndex" is the + * entry index in the array of entries, and "entryValue" is the entry value. If no entity + * is found, "found" is false, "entryOffset" is the total size of the bucket buffer, + * "entryIndex" and "entryValue" are undefined. + */ + private record FindResult(int entryOffset, int entryIndex, boolean found, long entryValue) { } /** Get bucket buffer for tests */ diff --git a/platform-sdk/swirlds-jasperdb/src/test/java/com/swirlds/merkledb/files/hashmap/BucketTest.java b/platform-sdk/swirlds-jasperdb/src/test/java/com/swirlds/merkledb/files/hashmap/BucketTest.java index 495585d0cffc..2d070810e071 100644 --- a/platform-sdk/swirlds-jasperdb/src/test/java/com/swirlds/merkledb/files/hashmap/BucketTest.java +++ b/platform-sdk/swirlds-jasperdb/src/test/java/com/swirlds/merkledb/files/hashmap/BucketTest.java @@ -250,7 +250,7 @@ void toStringAsExpectedForBucket() { bucket.setBucketIndex(0); final String nonEmptyBucketRepr = "Bucket{bucketIndex=0, entryCount=1, size=32\n" + " ENTRY[0] value= 5124 keyHashCode=2056 keyVer=3054" - + " key=LongVirtualKey{value=5124, hashCode=5124} keySize=8\n" + + " key=LongVirtualKey{value=2056, hashCode=2056} keySize=8\n" + "} RAW DATA = 00 00 00 00 00 00 00 20 00 00 00 01 00 00 08 08 00 00 00 00 00" + " 00 14 04 00 00 00 00 00 00 08 08 "; assertEquals(nonEmptyBucketRepr, bucket.toString(), "Non-empty bucket represent as expected"); From cb0334954d63acdc06ee94077194875bdade5541 Mon Sep 17 00:00:00 2001 From: Artem Ananev Date: Mon, 3 Apr 2023 14:58:59 -0700 Subject: [PATCH 2/3] Redundant private getValue() and setValue() methods are removed from Bucket Signed-off-by: Artem Ananev --- .../merkledb/files/hashmap/Bucket.java | 22 +------------------ 1 file changed, 1 insertion(+), 21 deletions(-) diff --git a/platform-sdk/swirlds-jasperdb/src/main/java/com/swirlds/merkledb/files/hashmap/Bucket.java b/platform-sdk/swirlds-jasperdb/src/main/java/com/swirlds/merkledb/files/hashmap/Bucket.java index afcbdd5cf81d..62deaa9b39e8 100644 --- a/platform-sdk/swirlds-jasperdb/src/main/java/com/swirlds/merkledb/files/hashmap/Bucket.java +++ b/platform-sdk/swirlds-jasperdb/src/main/java/com/swirlds/merkledb/files/hashmap/Bucket.java @@ -250,7 +250,7 @@ public void putValue(final K key, final long value) { // handle UPDATE if (result.found) { // yay! we found it, so update value - setValue(result.entryOffset, value); + bucketBuffer.putLong(result.entryOffset + ENTRY_VALUE_OFFSET, value); return; } /* We have to serialize a variable-size key to a temp byte buffer to check @@ -400,26 +400,6 @@ private K getKey(int entryOffset) throws IOException { return keySerializer.deserialize(bucketBuffer, keySerializationVersion); } - /** - * Read a value for a given entry - * - * @param entryOffset the offset for the entry - * @return the value stored in given entry - */ - private long getValue(int entryOffset) { - return bucketBuffer.getLong(entryOffset + ENTRY_VALUE_OFFSET); - } - - /** - * Read a value for a given entry - * - * @param entryOffset the offset for the entry - * @param value the value to set for entry - */ - private void setValue(int entryOffset, long value) { - bucketBuffer.putLong(entryOffset + ENTRY_VALUE_OFFSET, value); - } - /** toString for debugging */ @SuppressWarnings("StringConcatenationInsideStringBufferAppend") @Override From 249cdcf5062256f2f56115ff6401987994e778c3 Mon Sep 17 00:00:00 2001 From: Artem Ananev Date: Mon, 3 Apr 2023 15:49:34 -0700 Subject: [PATCH 3/3] Spotless formatting Signed-off-by: Artem Ananev --- .../main/java/com/swirlds/merkledb/files/hashmap/Bucket.java | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/platform-sdk/swirlds-jasperdb/src/main/java/com/swirlds/merkledb/files/hashmap/Bucket.java b/platform-sdk/swirlds-jasperdb/src/main/java/com/swirlds/merkledb/files/hashmap/Bucket.java index 62deaa9b39e8..f91e6bb8832e 100644 --- a/platform-sdk/swirlds-jasperdb/src/main/java/com/swirlds/merkledb/files/hashmap/Bucket.java +++ b/platform-sdk/swirlds-jasperdb/src/main/java/com/swirlds/merkledb/files/hashmap/Bucket.java @@ -76,12 +76,14 @@ public final class Bucket> { private static final AtomicInteger LARGEST_SIZE_OF_BUCKET_CREATED = new AtomicInteger(0); private int keySerializationVersion; + /** * Byte buffer that holds this bucket data, including bucket index, size in bytes, number of * entries, and entry data. Buffer is expanded as needed, when new entries are added. Buffer * limit is kept equal to the bucket size in bytes. */ private ByteBuffer bucketBuffer; + private KeySerializer keySerializer; private ByteBuffer reusableBuffer; @@ -453,8 +455,7 @@ public String toString() { * is found, "found" is false, "entryOffset" is the total size of the bucket buffer, * "entryIndex" and "entryValue" are undefined. */ - private record FindResult(int entryOffset, int entryIndex, boolean found, long entryValue) { - } + private record FindResult(int entryOffset, int entryIndex, boolean found, long entryValue) {} /** Get bucket buffer for tests */ ByteBuffer getBucketBuffer() {