[GR-44043] Avoid storing the RubyLanguage Cleaner in image heap for SVM

PullRequest: truffleruby/3644

Author: eregon

src/main/java/org/truffleruby/RubyLanguage.java

@@ -231,6 +231,7 @@ private RubyThread getOrCreateForeignThread(RubyContext context, Thread thread)
 
     @CompilationFinal public boolean singleContext = true;
     @CompilationFinal public Optional<RubyContext> contextIfSingleContext;
+    private int numberOfContexts = 0;
 
     public final CyclicAssumption traceFuncUnusedAssumption = new CyclicAssumption("set_trace_func is not used");
 
@@ -245,8 +246,10 @@ private RubyThread getOrCreateForeignThread(RubyContext context, Thread thread)
     public final SymbolTable symbolTable;
     public final KeywordArgumentsDescriptorManager keywordArgumentsDescriptorManager = new KeywordArgumentsDescriptorManager();
     public final FrozenStringLiterals frozenStringLiterals;
-    public final Cleaner cleaner = Cleaner.create();
 
+    // GR-44025: We store the cleanerThread explicitly here to make it a clear image building failure if it would still be set.
+    public Thread cleanerThread = null;
+    @CompilationFinal public Cleaner cleaner = null;
 
     public volatile ValueWrapperManager.HandleBlockWeakReference[] handleBlockSharedMap = new ValueWrapperManager.HandleBlockWeakReference[0];
     public final ValueWrapperManager.HandleBlockAllocator handleBlockAllocator = new ValueWrapperManager.HandleBlockAllocator();
@@ -422,6 +425,9 @@ public RubyContext createContext(Env env) {
         Metrics.initializeOption();
 
         synchronized (this) {
+            numberOfContexts++;
+            setupCleaner();
+
             if (this.options == null) { // First context
                 this.allocationReporter = env.lookup(AllocationReporter.class);
                 this.options = new LanguageOptions(env, env.getOptions(), singleContext);
@@ -461,8 +467,12 @@ protected void initializeContext(RubyContext context) {
         try {
             Metrics.printTime("before-initialize-context");
             context.initialize();
+
             if (context.isPreInitializing()) {
-                setRubyHome(context.getEnv(), null);
+                synchronized (this) {
+                    setRubyHome(context.getEnv(), null);
+                    resetCleaner();
+                }
             }
             Metrics.printTime("after-initialize-context");
         } catch (Throwable e) {
@@ -493,7 +503,10 @@ protected boolean patchContext(RubyContext context, Env newEnv) {
             return false;
         }
 
-        setRubyHome(newEnv, findRubyHome());
+        synchronized (this) {
+            setRubyHome(newEnv, findRubyHome());
+            setupCleaner();
+        }
 
         boolean patched = context.patchContext(newEnv);
         Metrics.printTime("after-patch-context");
@@ -514,6 +527,14 @@ protected void disposeContext(RubyContext context) {
         if (options.COVERAGE_GLOBAL) {
             coverageManager.print(this, System.out);
         }
+
+        synchronized (this) {
+            // GR-28354: Workaround for no "before CacheStore hook"
+            numberOfContexts--;
+            if (numberOfContexts == 0 && !singleContext) {
+                resetCleaner();
+            }
+        }
     }
 
     public static RubyContext getCurrentContext() {
@@ -653,6 +674,19 @@ protected Object getScope(RubyContext context) {
         return context.getTopScopeObject();
     }
 
+    private void setupCleaner() {
+        assert Thread.holdsLock(this);
+        if (cleaner == null) {
+            cleaner = Cleaner.create(runnable -> this.cleanerThread = new Thread(runnable, "Ruby-Cleaner"));
+        }
+    }
+
+    private void resetCleaner() {
+        assert Thread.holdsLock(this);
+        cleanerThread = null;
+        cleaner = null;
+    }
+
     public String getRubyHome() {
         return rubyHome;
     }
@@ -671,6 +705,7 @@ public String getPathRelativeToHome(String path) {
     }
 
     private void setRubyHome(Env env, String home) {
+        assert Thread.holdsLock(this);
         rubyHome = home;
         setRubyHomeTruffleFile(env, home);
     }