[GR-63366] [GR-63470] Refactor and cleanup the safepoint handling in Native Image.

PullRequest: graal/20385

Author: christianhaeubl

substratevm/src/com.oracle.svm.core.graal.aarch64/src/com/oracle/svm/core/graal/aarch64/AArch64SafepointCheckOp.java

@@ -27,6 +27,8 @@
 import com.oracle.svm.core.ReservedRegisters;
 import com.oracle.svm.core.nodes.SafepointCheckNode;
 import com.oracle.svm.core.thread.Safepoint;
+import com.oracle.svm.core.thread.SafepointCheckCounter;
+import com.oracle.svm.core.thread.SafepointSlowpath;
 import com.oracle.svm.core.thread.ThreadingSupportImpl;
 
 import jdk.graal.compiler.asm.aarch64.AArch64Address;
@@ -54,24 +56,24 @@ public void emitCode(CompilationResultBuilder crb, AArch64MacroAssembler masm) {
         int safepointSize = 32; // safepoint is an integer
         AArch64Address safepointAddress = AArch64Address.createImmediateAddress(safepointSize, AArch64Address.AddressingMode.IMMEDIATE_UNSIGNED_SCALED,
                         ReservedRegisters.singleton().getThreadRegister(),
-                        Safepoint.getThreadLocalSafepointRequestedOffset());
+                        SafepointCheckCounter.getThreadLocalOffset());
         try (ScratchRegister scratchRegister = masm.getScratchRegister()) {
             Register scratch = scratchRegister.getRegister();
             masm.ldr(safepointSize, scratch, safepointAddress);
             if (ThreadingSupportImpl.isRecurringCallbackSupported()) {
-                /* Before subtraction, Safepoint.safepointRequested is being compared against 1. */
+                /* Before subtraction, the counter is compared against 1. */
                 masm.subs(safepointSize, scratch, scratch, 1);
                 masm.str(safepointSize, scratch, safepointAddress);
             } else {
-                /* Safepoint.safepointRequested is being compared against 0. */
+                /* Counter is compared against 0. */
                 masm.compare(safepointSize, scratch, 0);
             }
         }
     }
 
     /**
-     * The slow path should be entered when Safepoint.safepointRequested is <= 0. See Safepoint.java
-     * for more details about safepoint orchestration.
+     * The slow path should be entered when the counter is <= 0. See classes {@link Safepoint} and
+     * {@link SafepointSlowpath} for more details about safepoint orchestration.
      */
     public AArch64Assembler.ConditionFlag getConditionFlag() {
         return AArch64Assembler.ConditionFlag.LE;

substratevm/src/com.oracle.svm.core.graal.amd64/src/com/oracle/svm/core/graal/amd64/AMD64SafepointCheckOp.java

@@ -26,7 +26,7 @@
 
 import com.oracle.svm.core.ReservedRegisters;
 import com.oracle.svm.core.nodes.SafepointCheckNode;
-import com.oracle.svm.core.thread.Safepoint;
+import com.oracle.svm.core.thread.SafepointCheckCounter;
 import com.oracle.svm.core.thread.ThreadingSupportImpl;
 
 import jdk.graal.compiler.asm.amd64.AMD64Address;
@@ -51,13 +51,12 @@ public AMD64SafepointCheckOp() {
 
     @Override
     public void emitCode(CompilationResultBuilder crb, AMD64MacroAssembler masm) {
-        int safepointRequestedOffset = Safepoint.getThreadLocalSafepointRequestedOffset();
-        AMD64Address safepointRequested = new AMD64Address(ReservedRegisters.singleton().getThreadRegister(), safepointRequestedOffset);
+        int counterOffset = SafepointCheckCounter.getThreadLocalOffset();
+        AMD64Address counter = new AMD64Address(ReservedRegisters.singleton().getThreadRegister(), counterOffset);
         if (ThreadingSupportImpl.isRecurringCallbackSupported()) {
-            masm.subl(safepointRequested, 1);
+            masm.subl(counter, 1);
         } else {
-            // Ensuring safepointRequested offset fits a byte would make for a smaller instruction
-            masm.cmpl(safepointRequested, 0);
+            masm.cmpl(counter, 0);
         }
     }
 

substratevm/src/com.oracle.svm.core.graal.llvm/src/com/oracle/svm/core/graal/llvm/NodeLLVMBuilder.java

@@ -63,7 +63,7 @@
 import com.oracle.svm.core.meta.SharedField;
 import com.oracle.svm.core.meta.SubstrateObjectConstant;
 import com.oracle.svm.core.nodes.SafepointCheckNode;
-import com.oracle.svm.core.thread.Safepoint;
+import com.oracle.svm.core.thread.SafepointCheckCounter;
 import com.oracle.svm.core.thread.ThreadingSupportImpl;
 import com.oracle.svm.core.thread.VMThreads;
 import com.oracle.svm.core.util.VMError;
@@ -358,7 +358,7 @@ private LLVMValueRef emitCondition(LogicNode condition) {
         if (condition instanceof SafepointCheckNode) {
             LLVMValueRef threadData = gen.buildInlineGetRegister(ReservedRegisters.singleton().getThreadRegister().name);
             threadData = builder.buildIntToPtr(threadData, builder.rawPointerType());
-            LLVMValueRef safepointCounterAddr = builder.buildGEP(threadData, builder.constantInt(Safepoint.getThreadLocalSafepointRequestedOffset()));
+            LLVMValueRef safepointCounterAddr = builder.buildGEP(threadData, builder.constantInt(SafepointCheckCounter.getThreadLocalOffset()));
             LLVMValueRef safepointCount = builder.buildLoad(safepointCounterAddr, builder.intType());
             if (ThreadingSupportImpl.isRecurringCallbackSupported()) {
                 safepointCount = builder.buildSub(safepointCount, builder.constantInt(1));

substratevm/src/com.oracle.svm.core.posix/src/com/oracle/svm/core/posix/thread/PosixVMThreads.java

@@ -141,7 +141,7 @@ public ComparableWord getThreadIdentifier() {
         @Override
         @Uninterruptible(reason = "Called from uninterruptible code.", mayBeInlined = true)
         public boolean matchesThread(IsolateThread thread, ComparableWord identifier) {
-            return VMThreads.OSThreadHandleTL.get(thread).notEqual(identifier);
+            return VMThreads.OSThreadHandleTL.get(thread).equal(identifier);
         }
     }
 }

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/code/RuntimeCodeInfoHistory.java

@@ -142,7 +142,7 @@ public void setValues(String kind, CodeInfo codeInfo, int codeInfoState, String
             assert VMOperation.isInProgressAtSafepoint();
             assert Heap.getHeap().isInImageHeap(kind);
 
-            this.safepointId = Safepoint.Master.singleton().getSafepointId();
+            this.safepointId = Safepoint.singleton().getSafepointId();
             this.uptimeMillis = Isolates.getUptimeMillis();
             this.kind = kind;
             this.codeInfo = codeInfo;

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/graal/snippets/CEntryPointSnippets.java

@@ -95,8 +95,8 @@
 import com.oracle.svm.core.snippets.SubstrateForeignCallTarget;
 import com.oracle.svm.core.stack.StackOverflowCheck;
 import com.oracle.svm.core.thread.PlatformThreads;
-import com.oracle.svm.core.thread.Safepoint;
 import com.oracle.svm.core.thread.ThreadListenerSupport;
+import com.oracle.svm.core.thread.ThreadStatusTransition;
 import com.oracle.svm.core.thread.ThreadingSupportImpl;
 import com.oracle.svm.core.thread.VMOperationControl;
 import com.oracle.svm.core.thread.VMThreads;
@@ -212,7 +212,7 @@ public static int createIsolateSnippet(CEntryPointCreateIsolateParameters parame
         if (result != CEntryPointErrors.NO_ERROR) {
             return result;
         }
-        Safepoint.transitionNativeToJava(false);
+        ThreadStatusTransition.fromNativeToJava(false);
 
         return runtimeCallInitializeIsolate(INITIALIZE_ISOLATE, parameters);
     }
@@ -516,7 +516,7 @@ public static int attachThreadSnippet(Isolate isolate, boolean startedByIsolate,
             return error;
         }
 
-        Safepoint.transitionNativeToJava(false);
+        ThreadStatusTransition.fromNativeToJava(false);
 
         if (ensureJavaThread) {
             return runtimeCallEnsureJavaThread(ENSURE_JAVA_THREAD);
@@ -725,7 +725,7 @@ public static int enterByIsolateSnippet(Isolate isolate) {
         result = runtimeCall(ENTER_BY_ISOLATE, isolate);
         if (result == CEntryPointErrors.NO_ERROR) {
             if (VMThreads.StatusSupport.isStatusNativeOrSafepoint()) {
-                Safepoint.transitionNativeToJava(false);
+                ThreadStatusTransition.fromNativeToJava(false);
             }
         }
         return result;
@@ -765,7 +765,7 @@ public static int enterSnippet(IsolateThread thread) {
              */
             runtimeCall(VERIFY_ISOLATE_THREAD, thread);
         }
-        Safepoint.transitionNativeToJava(false);
+        ThreadStatusTransition.fromNativeToJava(false);
 
         return CEntryPointErrors.NO_ERROR;
 
@@ -826,7 +826,7 @@ private static void logException(Throwable exception) {
 
     @Snippet(allowMissingProbabilities = true)
     public static int returnFromJavaToCSnippet() {
-        VMThreads.StatusSupport.setStatusNative();
+        ThreadStatusTransition.fromJavaToNative();
         return CEntryPointErrors.NO_ERROR;
     }
 

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/graal/snippets/CFunctionSnippets.java

@@ -47,7 +47,7 @@
 import com.oracle.svm.core.nodes.CPrologueData;
 import com.oracle.svm.core.stack.JavaFrameAnchor;
 import com.oracle.svm.core.stack.JavaFrameAnchors;
-import com.oracle.svm.core.thread.Safepoint;
+import com.oracle.svm.core.thread.ThreadStatusTransition;
 import com.oracle.svm.core.thread.VMThreads.StatusSupport;
 import com.oracle.svm.core.util.VMError;
 
@@ -128,9 +128,9 @@ private static CPrologueData prologueSnippet(@ConstantParameter int newThreadSta
     @Snippet
     private static void epilogueSnippet(@ConstantParameter int oldThreadStatus) {
         if (oldThreadStatus == StatusSupport.STATUS_IN_NATIVE) {
-            Safepoint.transitionNativeToJava(true);
+            ThreadStatusTransition.fromNativeToJava(true);
         } else if (oldThreadStatus == StatusSupport.STATUS_IN_VM) {
-            Safepoint.transitionVMToJava(true);
+            ThreadStatusTransition.fromVMToJava(true);
         } else {
             ReplacementsUtil.staticAssert(false, "Unexpected thread status");
         }

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/graal/snippets/SafepointSnippets.java

@@ -39,7 +39,8 @@
 import com.oracle.svm.core.graal.meta.SubstrateForeignCallsProvider;
 import com.oracle.svm.core.meta.SharedMethod;
 import com.oracle.svm.core.nodes.SafepointCheckNode;
-import com.oracle.svm.core.thread.Safepoint;
+import com.oracle.svm.core.thread.SafepointCheckCounter;
+import com.oracle.svm.core.thread.SafepointSlowpath;
 
 import jdk.graal.compiler.api.replacements.Snippet;
 import jdk.graal.compiler.core.common.spi.ForeignCallDescriptor;
@@ -59,16 +60,7 @@
 import jdk.graal.compiler.replacements.SnippetTemplate.SnippetInfo;
 import jdk.graal.compiler.replacements.Snippets;
 
-final class SafepointSnippets extends SubstrateTemplates implements Snippets {
-
-    @Snippet
-    private static void safepointSnippet() {
-        final boolean needSlowPath = SafepointCheckNode.test();
-        if (BranchProbabilityNode.probability(BranchProbabilityNode.VERY_SLOW_PATH_PROBABILITY, needSlowPath)) {
-            callSlowPathSafepointCheck(Safepoint.ENTER_SLOW_PATH_SAFEPOINT_CHECK);
-        }
-    }
-
+public final class SafepointSnippets extends SubstrateTemplates implements Snippets {
     private final SnippetInfo safepoint;
 
     SafepointSnippets(OptionValues options, Providers providers, Map<Class<? extends Node>, NodeLoweringProvider<?>> lowerings) {
@@ -78,10 +70,18 @@ private static void safepointSnippet() {
         lowerings.put(SafepointNode.class, new SafepointLowering());
     }
 
+    @Snippet
+    private static void safepointSnippet() {
+        final boolean needSlowPath = SafepointCheckNode.test();
+        if (BranchProbabilityNode.probability(BranchProbabilityNode.VERY_SLOW_PATH_PROBABILITY, needSlowPath)) {
+            callSlowPathSafepointCheck(SafepointSlowpath.ENTER_SLOW_PATH_SAFEPOINT_CHECK);
+        }
+    }
+
     private static LocationIdentity[] getKilledLocations() {
         int newLength = GC_LOCATIONS.length + 1;
         LocationIdentity[] locations = Arrays.copyOf(GC_LOCATIONS, newLength);
-        locations[newLength - 1] = Safepoint.getThreadLocalSafepointRequestedLocationIdentity();
+        locations[newLength - 1] = SafepointCheckCounter.getLocationIdentity();
         return locations;
     }
 
@@ -109,7 +109,7 @@ class SafepointFeature implements InternalFeature {
 
     @Override
     public void registerForeignCalls(SubstrateForeignCallsProvider foreignCalls) {
-        foreignCalls.register(Safepoint.FOREIGN_CALLS);
+        foreignCalls.register(SafepointSlowpath.FOREIGN_CALLS);
     }
 
     @Override

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/jdk/UninterruptibleUtils.java

@@ -432,6 +432,11 @@ public static int clamp(int value, int min, int max) {
             return min(max(value, min), max);
         }
 
+        @Uninterruptible(reason = "Called from uninterruptible code.", mayBeInlined = true)
+        public static long clamp(long value, long min, long max) {
+            return min(max(value, min), max);
+        }
+
         @Uninterruptible(reason = "Called from uninterruptible code.", mayBeInlined = true)
         public static int abs(int a) {
             return (a < 0) ? -a : a;

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/jfr/events/ExecuteVMOperationEvent.java

@@ -62,7 +62,7 @@ private static void emit0(VMOperation vmOperation, long requestingThreadId, long
             JfrNativeEventWriter.putBoolean(data, vmOperation.getCausesSafepoint());
             JfrNativeEventWriter.putBoolean(data, vmOperation.isBlocking());
             JfrNativeEventWriter.putThread(data, requestingThreadId);
-            JfrNativeEventWriter.putLong(data, vmOperation.getCausesSafepoint() ? Safepoint.Master.singleton().getSafepointId().rawValue() : 0);
+            JfrNativeEventWriter.putLong(data, vmOperation.getCausesSafepoint() ? Safepoint.singleton().getSafepointId().rawValue() : 0);
             JfrNativeEventWriter.endSmallEvent(data);
         }
     }