feat(server): adoption for off-heap memory management in kout module by Pengzna · Pull Request #2704 · apache/hugegraph

Pengzna · 2024-12-09T14:55:55Z

wip...

codecov · 2024-12-10T03:30:07Z

Codecov Report

❌ Patch coverage is 34.35115% with 86 lines in your changes missing coverage. Please review.
✅ Project coverage is 37.56%. Comparing base (f0b1395) to head (db3ee80).
⚠️ Report is 125 commits behind head on master.

Files with missing lines	Patch %	Lines
...e/hugegraph/memory/consumer/factory/IdFactory.java	0.00%	39 Missing ⚠️
...a/org/apache/hugegraph/api/traversers/KoutAPI.java	61.90%	7 Missing and 1 partial ⚠️
...graph/memory/consumer/factory/PropertyFactory.java	0.00%	8 Missing ⚠️
...g/apache/hugegraph/backend/store/BackendTable.java	0.00%	7 Missing ⚠️
...main/java/org/apache/hugegraph/util/Consumers.java	57.14%	5 Missing and 1 partial ⚠️
...graph/backend/cache/CachedSchemaTransactionV2.java	0.00%	5 Missing ⚠️
...g/apache/hugegraph/structure/HugeEdgeProperty.java	0.00%	3 Missing ⚠️
...ava/org/apache/hugegraph/schema/SchemaElement.java	33.33%	1 Missing and 1 partial ⚠️
.../java/org/apache/hugegraph/structure/HugeEdge.java	66.66%	1 Missing and 1 partial ⚠️
...ava/org/apache/hugegraph/structure/HugeVertex.java	66.66%	1 Missing and 1 partial ⚠️
... and 4 more

❗ There is a different number of reports uploaded between BASE (f0b1395) and HEAD (db3ee80). Click for more details.

HEAD has 3 uploads less than BASE

Flag BASE (f0b1395) HEAD (db3ee80)

7 4

Additional details and impacted files

@@             Coverage Diff              @@
##             master    #2704      +/-   ##
============================================
- Coverage     46.99%   37.56%   -9.43%     
+ Complexity      821      588     -233     
============================================
  Files           745      756      +11     
  Lines         60062    62108    +2046     
  Branches       7670     8068     +398     
============================================
- Hits          28225    23330    -4895     
- Misses        29014    36266    +7252     
+ Partials       2823     2512     -311

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

javeme · 2024-12-19T14:29:32Z

hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/api/traversers/KoutAPI.java

                  "'{}', max degree '{}', capacity '{}' and limit '{}'",
                  graph, source, direction, edgeLabel, depth,
                  nearest, maxDegree, capacity, limit);
+        MemoryPool queryPool = MemoryManager.getInstance().addQueryMemoryPool();


can we bind a MemoryPool for each graph, or bind MemoryManager to graph?

javeme · 2024-12-19T14:34:57Z

hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/api/traversers/KoutAPI.java

+                         .bindCorrespondingTaskMemoryPool(Thread.currentThread().getName(),
+                                                          (TaskMemoryPool) currentTaskPool);
+            MemoryPool currentOperationPool = currentTaskPool.addChildPool("kout-main-operation");
+        });


add a method like graph.switchToMemoryPool("kout", "main")?

javeme · 2024-12-19T14:36:48Z

hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/api/traversers/KoutAPI.java

+        });

-        ApiMeasurer measure = new ApiMeasurer();
+        try {


prefer to add a wrapper method for MemoryPool init-and-gc, then call the original method?

javeme · 2024-12-19T14:39:24Z

.../hugegraph-core/src/main/java/org/apache/hugegraph/backend/cache/CachedGraphTransaction.java

                return QueryResults.emptyIterator();
            }
            if (needCacheVertex(vertex)) {
+                vertex.convertIdToOnHeapIfNeeded();


it's ok to just call convert in HeapCache.update(), at the same time, we avoid modifying the code everywhere

javeme · 2024-12-19T14:46:24Z

...hugegraph-core/src/main/java/org/apache/hugegraph/backend/cache/CachedSchemaTransaction.java

        // NOTE: it's slower performance to use:
        // String.format("%x-%s", type.code(), name)
-        return IdGenerator.of(type.string() + "-" + id.asString());
+        return new IdGenerator.StringId(type.string() + "-" + id.asString());


add a OnHeapIdGenerator.of() class?

javeme · 2024-12-19T14:47:51Z

...ver/hugegraph-core/src/main/java/org/apache/hugegraph/memory/consumer/factory/IdFactory.java

                                                                                      Thread.currentThread()
                                                                                            .getName());
-                return new BinaryIdOffHeap(bytes, null,
+                return taskMemoryPool == null ?


expect this.taskMemoryPool style

javeme · 2024-12-19T14:48:29Z

...ver/hugegraph-core/src/main/java/org/apache/hugegraph/memory/consumer/factory/IdFactory.java

@@ -58,7 +58,9 @@ public BinaryBackendEntry.BinaryId newBinaryId(byte[] bytes, Id id) {
                                                                              .getCorrespondingTaskMemoryPool(
                                                                                      Thread.currentThread()
                                                                                            .getName());


prefer by Thread id instead of Thread name to avoid duplicate names

javeme · 2024-12-19T15:03:32Z

hugegraph-server/hugegraph-core/src/main/java/org/apache/hugegraph/memory/MemoryManager.java

+            return null;
+        }
+
        int count = queryMemoryPools.size();


expect this.xx stype

What is the difference between QueryMemoryPool and MemoryPool? if no difference, just naming MemoryPool is ok.
and can we make some special names for CorrespondingTaskMemoryPool and CurrentWorkingOperatorMemoryPool, such as RequestMemoryPool and RequestStageMemoryPool

javeme · 2024-12-19T15:07:44Z

hugegraph-server/hugegraph-core/src/main/java/org/apache/hugegraph/memory/MemoryManager.java

    private final ExecutorService arbitrateExecutor;

-    private static MemoryMode MEMORY_MODE = MemoryMode.ENABLE_OFF_HEAP_MANAGEMENT;
+    private static MemoryMode MEMORY_MODE = MemoryMode.DISABLE_MEMORY_MANAGEMENT;


MEMORY_MODE style is only for const var, and if there is only a single MemoryManager, also remove static mark: private MemoryMode memoryMode

javeme · 2024-12-19T15:13:29Z

...ver/hugegraph-core/src/main/java/org/apache/hugegraph/memory/consumer/factory/IdFactory.java

-                return new BinaryIdOffHeap(bytes, null,
+                return taskMemoryPool == null ?
+                       new BinaryBackendEntry.BinaryId(bytes, id) :
+                       new BinaryIdOffHeap(bytes, null,


We can directly get the memory pool at one time MemoryManager.getInstance().currentMemoryPool(), it does the 2 steps:
getCorrespondingTaskMemoryPool, getCurrentWorkingOperatorMemoryPool.

and can we rename some methods for a more concise and consistent style:

getCorrespondingTaskMemoryPool => currentTaskMemoryPool

getCurrentWorkingOperatorMemoryPool => currentOperatorMemoryPool

MemoryPool.getSnapShot() => MemoryPool.getStats()

also move MemoryPoolStats out from impl?

prefer to get MemoryPool from threadlocal

github-actions · 2025-01-18T21:04:20Z

Due to the lack of activity, the current pr is marked as stale and will be closed after 180 days, any update will remove the stale label

javeme

This is a great improvement to our memory performance, looking forward to merging it soon.

javeme · 2025-08-23T13:37:16Z

hugegraph-server/hugegraph-core/src/main/java/org/apache/hugegraph/util/Consumers.java

+                         .bindCorrespondingTaskMemoryPool(Thread.currentThread().getName(),
+                                                          (TaskMemoryPool) currentTaskPool);
+            MemoryPool currentOperationPool =
+                    currentTaskPool.addChildPool("kout-consume-operation");


the Consumers is a general class, seems it's not appropriate to put the upper-level kout code here

javeme · 2025-08-23T13:40:19Z

hugegraph-server/hugegraph-core/src/main/java/org/apache/hugegraph/util/Consumers.java

            this.runningFutures.add(
-                    this.executor.submit(new ContextCallable<>(this::runAndDone)));
+                    this.executor.submit(
+                            new ContextCallable<>(() -> this.runAndDone(MemoryManager.getInstance()


should we move this TaskMemoryPool-bind code into ContextCallable?

javeme · 2025-08-23T14:11:47Z

...ver/hugegraph-core/src/main/java/org/apache/hugegraph/memory/consumer/factory/IdFactory.java

-                return new BinaryIdOffHeap(bytes, null,
+                return taskMemoryPool == null ?
+                       new BinaryBackendEntry.BinaryId(bytes, id) :
+                       new BinaryIdOffHeap(bytes, null,


and can we rename some methods for a more concise and consistent style:

getCorrespondingTaskMemoryPool => currentTaskMemoryPool

getCurrentWorkingOperatorMemoryPool => currentOperatorMemoryPool

MemoryPool.getSnapShot() => MemoryPool.getStats()

javeme · 2025-08-23T14:18:30Z

hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/api/traversers/KoutAPI.java

+            MemoryManager.getInstance()
+                         .bindCorrespondingTaskMemoryPool(Thread.currentThread().getName(),
+                                                          (TaskMemoryPool) currentTaskPool);
+            MemoryPool currentOperationPool = currentTaskPool.addChildPool("kout-main-operation");


we can let:

MemoryPool.addChildPool return QueryMemoryPool

QueryMemoryPool.addChildPool return TaskMemoryPool

TaskMemoryPooll.addChildPool return OperatorMemoryPool

javeme · 2025-08-23T14:30:07Z

...ver/hugegraph-core/src/main/java/org/apache/hugegraph/memory/consumer/factory/IdFactory.java

-                return new BinaryIdOffHeap(bytes, null,
+                return taskMemoryPool == null ?
+                       new BinaryBackendEntry.BinaryId(bytes, id) :
+                       new BinaryIdOffHeap(bytes, null,


also move MemoryPoolStats out from impl?

javeme · 2025-08-23T14:51:06Z

hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/api/traversers/KoutAPI.java

+            }
+            return manager.serializer(g, measure.measures()).writeList("vertices", ids);
+        } finally {
+            Optional.ofNullable(queryPool)


prefer if-style

javeme · 2025-08-23T14:54:18Z

...ver/hugegraph-core/src/main/java/org/apache/hugegraph/memory/consumer/factory/IdFactory.java

-                return new BinaryIdOffHeap(bytes, null,
+                return taskMemoryPool == null ?
+                       new BinaryBackendEntry.BinaryId(bytes, id) :
+                       new BinaryIdOffHeap(bytes, null,


prefer to get MemoryPool from threadlocal

javeme · 2025-08-23T14:55:03Z

hugegraph-server/hugegraph-core/src/main/java/org/apache/hugegraph/structure/HugeEdge.java

        this.isOutEdge = true;
    }

+    public void convertIdToOnHeapIfNeeded() {


move to super class?

javeme · 2025-08-23T14:55:40Z

hugegraph-server/hugegraph-core/src/main/java/org/apache/hugegraph/structure/HugeEdge.java

-        return new HugeEdgeProperty<>(this, pkey, val);
+        Class<V> valueType = (Class<V>) val.getClass();
+        PropertyFactory<V> propertyFactory = PropertyFactory.getInstance(valueType);
+        return propertyFactory.newHugeEdgeProperty(this, pkey, val);


we have no OffheapEdge?

javeme · 2025-08-23T15:13:40Z

...gegraph-core/src/main/java/org/apache/hugegraph/memory/consumer/factory/PropertyFactory.java

+                       new HugeVertexProperty<>(owner, key, value) :
+                       new HugeVertexPropertyOffHeap<>(
+                               taskMemoryPool.getCurrentWorkingOperatorMemoryPool(), owner, key,
+                               value);


can we avoid bytes copy in serializeSelfToByteBuf

preter to let OffHeapObject.serializeSelfToByteBuf return ByteBuf.

can we rename OffHeapObject.zeroCopyReadFromByteBuf to readAsHeapObject?

OffHeapObject.getAllMemoryBlock is useless? will we release an object individually?

HugeVertexPropertyOffHeap.isPresent optimize with 'valueOffHeap != null'

Pengzna and others added 3 commits December 9, 2024 22:51

off-heap adoption for id

4d4cb22

off-heap adoption for property & kout query pool

29b7845

wip

a402ddb

Pengzna added 3 commits December 10, 2024 15:55

backend entry iter

88604cf

fix bootstrap bugs

a342870

cache use on-heap id && adopt for disabled mode

db3ee80

javeme reviewed Dec 19, 2024

View reviewed changes

github-actions bot added the inactive label Jan 18, 2025

github-actions bot closed this Jul 17, 2025

Pengzna reopened this Jul 18, 2025

dosubot bot mentioned this pull request Jul 21, 2025

[Question] 有哪些方法可以调优查询 #2836

Closed

1 task

javeme reviewed Aug 23, 2025

View reviewed changes

github-actions bot closed this Feb 19, 2026

Conversation

Pengzna commented Dec 9, 2024

Uh oh!

codecov bot commented Dec 10, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

javeme Dec 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

javeme Dec 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Jan 18, 2025

Uh oh!

javeme left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

codecov bot commented Dec 10, 2024 •

edited

Loading

javeme Dec 19, 2024 •

edited

Loading

javeme Dec 19, 2024 •

edited

Loading