PHILO-HE commented on code in PR #9391:
URL: https://github.com/apache/incubator-gluten/pull/9391#discussion_r2280221901


##########
docs/developers/VeloxDynamicSizingOffheap.md:
##########
@@ -0,0 +1,24 @@
+## Dynamic Off-heap Sizing
+Spark requires setting both on-heap and off-heap memory sizes, which 
initializes different memory layouts. Improper configuration of these settings 
can lead to lower performance. Dynamic off-heap sizing is an experimental 
feature designed to simplify this process. When enabled, off-heap settings are 
ignored, and Velox uses the on-heap size as the memory size.

Review Comment:
   Nit: recommend to break this into multiple code lines, which is more 
readable for editors not wrapping text visually. And it can also improve the 
readability in diffs.
   Ditto for other changes.



##########
docs/developers/VeloxDynamicSizingOffheap.md:
##########
@@ -0,0 +1,24 @@
+## Dynamic Off-heap Sizing
+Spark requires setting both on-heap and off-heap memory sizes, which 
initializes different memory layouts. Improper configuration of these settings 
can lead to lower performance. Dynamic off-heap sizing is an experimental 
feature designed to simplify this process. When enabled, off-heap settings are 
ignored, and Velox uses the on-heap size as the memory size.
+## Detail implementations
+To understand the details, it's essential to learn the basics of JVM memory 
management. There are many resources discussing JVM internals:
+- https://exia.dev/blog/2019-12-10/JVM-Memory-Model/
+- 
https://docs.oracle.com/cd/E13150_01/jrockit_jvm/jrockit/geninfo/diagnos/garbage_collect.html
+- https://www.scaler.com/topics/memory-management-in-java/
+- 
https://developers.redhat.com/articles/2021/09/09/how-jvm-uses-and-allocates-memory#
+
+In general, the feature works as follows:
+
+- Spark first attempts to allocate memory based on the on-heap size. Note that 
the maximum memory size is controlled by spark.executor.memory.
+- When Velox tries to allocate memory, Gluten attempts to allocate from system 
memory and records this in the memory allocator.
+- If there is sufficient memory, allocations proceed normally.
+- If memory is insufficient, Spark performs garbage collection (GC) to free 
on-heap memory, allowing Velox to allocate memory.
+- If memory remains insufficient after GC, Spark reports an out-of-memory 
(OOM) issue.
+
+We then enforce a total memory quota, calculated as the sum of committed and 
in-use memory in the Java heap (using Runtime.getRuntime().totalMemory() - 
Runtime.getRuntime().freeMemory()) plus tracked off-heap memory in 
TreeMemoryConsumer. If an allocation exceeds this total committed memory, the 
allocation fails, triggering an OOM.
+
+With this change, the "quota check" is performed when an allocation in the 
native engine is informed to Gluten. In practice, this means the Java codebase 
can oversubscribe memory within the on-heap quota, even if off-heap usage is 
sufficient to fail the allocation.
+
+## Limitations
+
+This feature is still under heavy development.

Review Comment:
   Suggestion: ** is still in early development.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to