Invariant contract violation for receiver.

Author: tzezula

truffle/src/com.oracle.truffle.api.test/src/com/oracle/truffle/api/test/ThreadUtils.java

@@ -0,0 +1,73 @@
+/*
+ * Copyright (c) 2025, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * The Universal Permissive License (UPL), Version 1.0
+ *
+ * Subject to the condition set forth below, permission is hereby granted to any
+ * person obtaining a copy of this software, associated documentation and/or
+ * data (collectively the "Software"), free of charge and under any and all
+ * copyright rights in the Software, and any and all patent rights owned or
+ * freely licensable by each licensor hereunder covering either (i) the
+ * unmodified Software as contributed to or provided by such licensor, or (ii)
+ * the Larger Works (as defined below), to deal in both
+ *
+ * (a) the Software, and
+ *
+ * (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
+ * one is included with the Software each a "Larger Work" to which the Software
+ * is contributed by such licensors),
+ *
+ * without restriction, including without limitation the rights to copy, create
+ * derivative works of, display, perform, and distribute the Software and make,
+ * use, sell, offer for sale, import, export, have made, and have sold the
+ * Software and the Larger Work(s), and to sublicense the foregoing rights on
+ * either these or other terms.
+ *
+ * This license is subject to the following condition:
+ *
+ * The above copyright notice and either this complete permission notice or at a
+ * minimum a reference to the UPL must be included in all copies or substantial
+ * portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+package com.oracle.truffle.api.test;
+
+import java.util.Arrays;
+
+/**
+ * Utility class providing common thread-related helpers for use in unit tests.
+ */
+public final class ThreadUtils {
+
+    private ThreadUtils() {
+    }
+
+    /**
+     * Returns an array containing all threads that were alive at the time of the call.
+     * <p>
+     * Note that some threads in the returned array may terminate immediately after being captured,
+     * so it is possible that they are no longer alive by the time the array is iterated.
+     */
+    public static Thread[] getAllThreads() {
+        ThreadGroup rootGroup = Thread.currentThread().getThreadGroup();
+        ThreadGroup parentGroup;
+        while ((parentGroup = rootGroup.getParent()) != null) {
+            rootGroup = parentGroup;
+        }
+
+        Thread[] threads = new Thread[rootGroup.activeCount()];
+        int cnt;
+        while ((cnt = rootGroup.enumerate(threads, true)) == threads.length) {
+            threads = new Thread[threads.length * 2];
+        }
+        return Arrays.copyOf(threads, cnt);
+    }
+}

truffle/src/com.oracle.truffle.api.test/src/com/oracle/truffle/api/test/polyglot/ThreadInitializationAndDisposalTest.java

@@ -40,9 +40,12 @@
  */
 package com.oracle.truffle.api.test.polyglot;
 
+import java.time.Duration;
 import java.util.concurrent.atomic.AtomicLong;
 
+import com.oracle.truffle.api.test.ThreadUtils;
 import org.graalvm.polyglot.Context;
+import org.graalvm.polyglot.Engine;
 import org.junit.Assert;
 import org.junit.Test;
 
@@ -106,23 +109,74 @@ protected void disposeThread(ExecutableContext context, Thread thread) {
         }
     }
 
+    /**
+     * A utility language used to wait for the termination of a specific thread identified by ID.
+     * <p>
+     * In the context of external isolates, the "mirror" thread created for a host thread terminates
+     * after the host thread itself. This delay introduces a race condition in tests such as
+     * {@code testDeadThreadDisposed}, which assume that once the host thread is no longer alive, it
+     * must have been finalized. This language resolves the issue by actively waiting for the
+     * "mirror" thread to terminate before continuing.
+     */
+    @TruffleLanguage.Registration
+    static final class WaitForThreadTermination extends AbstractExecutableTestLanguage {
+
+        @Override
+        @CompilerDirectives.TruffleBoundary
+        protected Object execute(RootNode node, Env env, Object[] contextArguments, Object[] frameArguments) throws Exception {
+            long threadId = (long) contextArguments[0];
+            long timeOutMillis = (long) contextArguments[1];
+            Thread thread = findThread(threadId);
+            if (thread == null || !thread.isAlive()) {
+                return true;
+            }
+            thread.join(timeOutMillis);
+            return !thread.isAlive();
+        }
+
+        private static Thread findThread(long threadId) {
+            for (Thread thread : ThreadUtils.getAllThreads()) {
+                if (thread.threadId() == threadId) {
+                    return thread;
+                }
+            }
+            return null;
+        }
+
+        /**
+         * Waits for the thread identified by {@code threadId} to terminate within the given
+         * timeout. This call is executed in a separate {@link Context} to avoid affecting the
+         * currently running test.
+         *
+         * @return {@code true} if the thread terminated within the timeout, {@code false} otherwise
+         */
+        static boolean doWait(long threadId, Duration timeOut, Engine engine) {
+            try (Context context = Context.newBuilder().engine(engine).build()) {
+                return AbstractExecutableTestLanguage.evalTestLanguage(context, WaitForThreadTermination.class, "", threadId, timeOut.toMillis()).asBoolean();
+            }
+        }
+    }
+
     @Test
     public void testDeadThreadDisposed() throws InterruptedException {
         /*
          * Context pre-initialization enters the context on the main thread, but we need the first
          * enter on the main thread to occur after the separate thread is joined, so that it causes
          * the separate thread's disposal.
          */
-        try (Context context = Context.newBuilder().allowExperimentalOptions(true).option("engine.UsePreInitializedContext", "false").build()) {
-            AtomicLong threadId = new AtomicLong();
-            Thread t = new Thread(() -> threadId.set(AbstractExecutableTestLanguage.evalTestLanguage(context, DeadThreadDisposedTestLanguage.class, "").asLong()));
-            t.start();
-            t.join();
-            Assert.assertFalse(t.isAlive());
-            long mainThreadId = AbstractExecutableTestLanguage.evalTestLanguage(context, DeadThreadDisposedTestLanguage.class, "").asLong();
-            Assert.assertEquals(threadId.get() + "," + mainThreadId, context.getBindings(DeadThreadDisposedTestLanguage.ID).getMember("initialized").asString());
-            Assert.assertEquals(String.valueOf(threadId.get()), context.getBindings(DeadThreadDisposedTestLanguage.ID).getMember("finalized").asString());
-            Assert.assertEquals(String.valueOf(threadId.get()), context.getBindings(DeadThreadDisposedTestLanguage.ID).getMember("disposed").asString());
+        try (Engine engine = Engine.newBuilder().allowExperimentalOptions(true).option("engine.UsePreInitializedContext", "false").build()) {
+            try (Context context = Context.newBuilder().engine(engine).build()) {
+                AtomicLong threadId = new AtomicLong();
+                Thread t = new Thread(() -> threadId.set(AbstractExecutableTestLanguage.evalTestLanguage(context, DeadThreadDisposedTestLanguage.class, "").asLong()));
+                t.start();
+                t.join();
+                Assert.assertFalse(t.isAlive());
+                Assert.assertTrue(WaitForThreadTermination.doWait(threadId.get(), Duration.ofSeconds(10), engine));
+                long mainThreadId = AbstractExecutableTestLanguage.evalTestLanguage(context, DeadThreadDisposedTestLanguage.class, "").asLong();
+                Assert.assertEquals(threadId.get() + "," + mainThreadId, context.getBindings(DeadThreadDisposedTestLanguage.ID).getMember("initialized").asString());
+                Assert.assertEquals(String.valueOf(threadId.get()), context.getBindings(DeadThreadDisposedTestLanguage.ID).getMember("finalized").asString());
+                Assert.assertEquals(String.valueOf(threadId.get()), context.getBindings(DeadThreadDisposedTestLanguage.ID).getMember("disposed").asString());
+            }
         }
     }
 }