Use foreign memory arena for big bindings cache #13872

Akirathan · 2025-08-28T14:52:27Z

Closes #13816

Blocked by #13918

Pull Request Description

Using java.lang.foreign.Arena for mmapping a big cache file when loading the cache.

Important Notes

When loading big cache file:
- A previous Arena is closed. Which invalidates any byte buffers associated with that Arena.
- New Arena is created.
- File is mmapped via that new arena.
Both load and save closes previous arena.

Checklist

Please ensure that the following checklist has been satisfied before submitting the PR:

The documentation has been updated, if necessary.
Screenshots/screencasts have been attached, if there are any visual changes. For interactive or animated visual changes, a screencast is preferred.
All code follows the
Scala,
Java,
TypeScript,
and
Rust
style guides. In case you are using a language not listed above, follow the Rust style guide.
Unit tests have been written where possible.
If meaningful changes were made to logic or tests affecting Enso Cloud integration in the libraries,
or the Snowflake database integration, a run of the Extra Tests has been scheduled.
- If applicable, it is suggested to paste a link to a successful run of the Extra Tests.

engine/runtime/src/main/java/org/enso/interpreter/caches/CacheStatistics.java

JaroslavTulach · 2025-08-29T08:43:29Z

build.sbt

  .settings(
-    frgaalJavaCompilerSetting,
+    // Needed for `java.lang.Foreign`.
+    customFrgaalJavaCompilerSettings("24"),


I was afraid that this would be needed.

I wanted to suggest to create a separate runtime-caches module:

move all the cache related code there

invoke it with requires (from runtime)/provides pattern

if the runtime-caches module is missing, then runtime would just avoid loading caches

Because such a change would prevent usage of runtime inside of IGV/VSCode on LTS JDK (e.g. JDK 21)

but we don't need runtime in there anyway

the plans we have count with usage of runtime-compiler at max

and runtime-compiler can still run on JDK21, maybe even JDK17

Tracked in #13898

engine/runtime/src/main/java/org/enso/interpreter/caches/Cache.java

engine/runtime/src/main/java/org/enso/interpreter/caches/CacheEvent.java

JaroslavTulach

close mmapped files first, only then write
avoid yet another level of indirection - e.g. remove statistics abstractions

This reverts commit 963afda.

This reverts commit 883dc14.

It is accessed from different threads in SerializationPool

engine/runner/src/main/resources/META-INF/native-image/org/enso/runner/native-image.properties

JaroslavTulach

I'd suggest to keep allocate new Arena when mmapping.

engine/runtime/src/main/java/org/enso/interpreter/caches/Cache.java

Previous arena is closed both in load and save.

# Conflicts: # engine/runtime/src/main/java/org/enso/interpreter/caches/Cache.java

Akirathan added 10 commits August 27, 2025 17:22

Test that second cache serialization fails

06ae858

Cache uses native memory Arena

ab0fc5e

Add optional CacheStatistics to EnsoContext

883dc14

Use logName instead of entryName

963afda

Test save of suggestions and bindings caches

5a14330

Use hamcrest matchers

24b7c4d

Add test for loading caches

58b92e8

Rename test

822bf5d

Test that loading bindings cache of big project should be mmapped

e3a1c36

refact: extract method

54deef1

Akirathan self-assigned this Aug 28, 2025

Akirathan added CI: No changelog needed Do not require a changelog entry for this PR. CI: Clean build required CI runners will be cleaned before and after this PR is built. labels Aug 28, 2025

Akirathan added 4 commits August 28, 2025 17:52

Test that cache can be saved.

cef3885

Test global cache save preference

04eaf57

More cache tests

225beaa

Use only primitive bytes

3e362b8

Akirathan commented Aug 28, 2025

View reviewed changes

engine/runtime/src/main/java/org/enso/interpreter/caches/CacheStatistics.java Outdated Show resolved Hide resolved

enso-bot bot mentioned this pull request Aug 28, 2025

Experimental Bazel support for backend #9768

Closed

JaroslavTulach reviewed Aug 29, 2025

View reviewed changes

engine/runtime/src/main/java/org/enso/interpreter/caches/Cache.java Outdated Show resolved Hide resolved

JaroslavTulach reviewed Aug 29, 2025

View reviewed changes

engine/runtime/src/main/java/org/enso/interpreter/caches/CacheEvent.java Outdated Show resolved Hide resolved

JaroslavTulach requested changes Aug 29, 2025

View reviewed changes

Akirathan added 7 commits August 29, 2025 13:51

Revert "Use logName instead of entryName"

f63d3a3

This reverts commit 963afda.

Revert "Add optional CacheStatistics to EnsoContext"

be04961

This reverts commit 883dc14.

Test caches by collecting logs

ae1d687

CachedData test class is an empty class.

4f01c2c

Add memory arena validity assert

5bce4bc

First close memory arena and then writeBytesTo

46b42e5

Memory arena must be shared.

8653350

It is accessed from different threads in SerializationPool

Akirathan added 8 commits September 1, 2025 13:44

Cache.invalidate closes memory arena

2756b69

Test that memory arena is closed after cache is saved

7cf44a9

Test that byteBuffer from deserialization is read only

a38623a

readability is tested via ByteBuffer.get

74a9fc6

Random is not static field

e79df91

Test that byteBuffer is closed after cache is invalidated

79ecc3c

randomBytes is not static method

00e3786

fmt

b1bd76a

Akirathan mentioned this pull request Sep 1, 2025

Extract runtime caches to separate project #13898

Open

Add -H:+ForeignAPISupport NI flag

c7cbcac

JaroslavTulach reviewed Sep 1, 2025

View reviewed changes

engine/runner/src/main/resources/META-INF/native-image/org/enso/runner/native-image.properties Show resolved Hide resolved

JaroslavTulach reviewed Sep 1, 2025

View reviewed changes

This was referenced Sep 2, 2025

No need for jvm: true when running Generic_JDBC_Tests #13900

Merged

800ms in loadCachesFrom - better up-to-date check (for Standard libraries) #13756

Closed

Akirathan added 2 commits September 3, 2025 13:20

New Arena is created before mmap.

72478c0

Previous arena is closed both in load and save.

Merge branch 'develop' into wip/akirathan/13816-bindings-via-arena

1de26ec

# Conflicts: # engine/runtime/src/main/java/org/enso/interpreter/caches/Cache.java

Akirathan added the x-on-hold label Sep 3, 2025

JaroslavTulach approved these changes Sep 3, 2025

View reviewed changes

JaroslavTulach mentioned this pull request Sep 30, 2025

Update to GraalVM 25 #14019

Open

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Use foreign memory arena for big bindings cache #13872

Use foreign memory arena for big bindings cache #13872

Uh oh!

Akirathan commented Aug 28, 2025 •

edited

Loading

Uh oh!

Uh oh!

JaroslavTulach Aug 29, 2025

Uh oh!

Akirathan Sep 1, 2025

Uh oh!

Uh oh!

Uh oh!

JaroslavTulach left a comment

Uh oh!

Uh oh!

JaroslavTulach left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Use foreign memory arena for big bindings cache #13872

Are you sure you want to change the base?

Use foreign memory arena for big bindings cache #13872

Uh oh!

Conversation

Akirathan commented Aug 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Description

Important Notes

Checklist

Uh oh!

Uh oh!

JaroslavTulach Aug 29, 2025

Choose a reason for hiding this comment

Uh oh!

Akirathan Sep 1, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

JaroslavTulach left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

JaroslavTulach left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Akirathan commented Aug 28, 2025 •

edited

Loading