Enable partitioned loading of compiled code at non-contiguous memory locations.

Author: spaske00

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

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2019, 2023, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2019, 2025, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -46,6 +46,8 @@
 import jdk.graal.compiler.api.replacements.Fold;
 import jdk.graal.compiler.word.Word;
 
+import static com.oracle.svm.core.Uninterruptible.CALLED_FROM_UNINTERRUPTIBLE_CODE;
+
 /**
  * Provides functionality to query information about a unit of compiled code from a {@link CodeInfo}
  * object. This helper class is necessary to ensure that {@link CodeInfo} objects are used
@@ -184,6 +186,13 @@ public static CodePointer getCodeStart(CodeInfo info) {
         return cast(info).getCodeStart();
     }
 
+    /** @see CodeInfoImpl#setCodeStart */
+    @Uninterruptible(reason = CALLED_FROM_UNINTERRUPTIBLE_CODE, mayBeInlined = true)
+    public static void setCodeStart(CodeInfo info, CodePointer codeStart) {
+        CodeInfoImpl impl = cast(info);
+        impl.setCodeStart(codeStart);
+    }
+
     @Uninterruptible(reason = "Called from uninterruptible code.", mayBeInlined = true)
     public static UnsignedWord getCodeEntryPointOffset(CodeInfo info) {
         return cast(info).getCodeEntryPointOffset();
@@ -195,6 +204,13 @@ public static UnsignedWord getCodeSize(CodeInfo info) {
         return cast(info).getCodeSize();
     }
 
+    /** @see CodeInfoImpl#setCodeSize */
+    @Uninterruptible(reason = CALLED_FROM_UNINTERRUPTIBLE_CODE, mayBeInlined = true)
+    public static void setCodeSize(CodeInfo info, UnsignedWord codeSize) {
+        CodeInfoImpl impl = cast(info);
+        impl.setCodeSize(codeSize);
+    }
+
     /** @see CodeInfoImpl#getDataSize */
     @Uninterruptible(reason = "Called from uninterruptible code.", mayBeInlined = true)
     public static UnsignedWord getDataSize(CodeInfo info) {
@@ -245,7 +261,9 @@ public static boolean contains(CodeInfo info, CodePointer ip) {
     @Uninterruptible(reason = "Called from uninterruptible code.", mayBeInlined = true)
     public static long relativeIP(CodeInfo info, CodePointer ip) {
         assert contains(info, ip);
-        return ((UnsignedWord) ip).subtract((UnsignedWord) cast(info).getCodeStart()).rawValue();
+        CodeInfoImpl impl = cast(info);
+        UnsignedWord baseOffset = ((UnsignedWord) ip).subtract((UnsignedWord) impl.getCodeStart());
+        return baseOffset.add(impl.getRelativeIPOffset()).rawValue();
     }
 
     public static CodePointer absoluteIP(CodeInfo info, long relativeIP) {
@@ -444,6 +462,15 @@ public static CodeInfo getNextImageCodeInfo(CodeInfo info) {
         return cast(info).getNextImageCodeInfo();
     }
 
+    /** @see CodeInfoImpl#setNextImageCodeInfo */
+    @Uninterruptible(reason = CALLED_FROM_UNINTERRUPTIBLE_CODE, mayBeInlined = true)
+    public static void setNextImageCodeInfo(CodeInfo info, CodeInfo next) {
+        assert isAOTImageCode(info);
+        CodeInfoImpl impl = cast(info);
+        assert impl.getNextImageCodeInfo().isNull();
+        impl.setNextImageCodeInfo(next);
+    }
+
     @Uninterruptible(reason = "Called from uninterruptible code.", mayBeInlined = true)
     private static CodeInfoImpl cast(UntetheredCodeInfo info) {
         assert isValid(info);

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

@@ -0,0 +1,61 @@
+/*
+ * Copyright (c) 2015, 2025, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.  Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+package com.oracle.svm.core.code;
+
+import com.oracle.svm.core.feature.AutomaticallyRegisteredFeature;
+import com.oracle.svm.core.feature.InternalFeature;
+import com.oracle.svm.core.util.CounterFeature;
+import org.graalvm.nativeimage.ImageSingletons;
+import org.graalvm.nativeimage.hosted.Feature;
+
+import java.util.Arrays;
+import java.util.List;
+
+@AutomaticallyRegisteredFeature
+public class CodeInfoFeature implements InternalFeature {
+    @Override
+    public List<Class<? extends Feature>> getRequiredFeatures() {
+        return Arrays.asList(CounterFeature.class);
+    }
+
+    @Override
+    public void duringSetup(DuringSetupAccess access) {
+        ImageSingletons.add(CodeInfoTableCounters.class, new CodeInfoTableCounters());
+        ImageSingletons.add(CodeInfoDecoderCounters.class, new CodeInfoDecoderCounters());
+        ImageSingletons.add(CodeInfoEncoder.Counters.class, new CodeInfoEncoder.Counters());
+
+        ImageSingletons.add(ImageCodeInfo.class, new ImageCodeInfo());
+        ImageSingletons.add(RuntimeCodeInfoHistory.class, new RuntimeCodeInfoHistory());
+        ImageSingletons.add(RuntimeCodeCache.class, new RuntimeCodeCache());
+        ImageSingletons.add(RuntimeCodeInfoMemory.class, new RuntimeCodeInfoMemory());
+    }
+
+    @Override
+    public void afterCompilation(AfterCompilationAccess config) {
+        ImageCodeInfo imageInfo = CodeInfoTable.getCurrentLayerImageCodeCache();
+        imageInfo.registerAsImmutable(config);
+    }
+
+}

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

@@ -169,6 +169,16 @@ interface CodeInfoImpl extends CodeInfo {
     @RawField
     void setCodeAndDataMemorySize(UnsignedWord codeAndDataMemorySize);
 
+    @RawField
+    void setRelativeIPOffset(UnsignedWord offset);
+
+    /**
+     * An offset that enables us to store code in different memory regions while keeping the code
+     * info encoding as if it were part of a single continuous memory region.
+     */
+    @RawField
+    UnsignedWord getRelativeIPOffset();
+
     @RawField
     NonmovableArray<Byte> getCodeInfoIndex();
 

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

@@ -26,22 +26,16 @@
 
 import static com.oracle.svm.core.deopt.Deoptimizer.Options.LazyDeoptimization;
 
-import java.util.Arrays;
-import java.util.List;
-
 import org.graalvm.nativeimage.ImageSingletons;
 import org.graalvm.nativeimage.Platform;
 import org.graalvm.nativeimage.Platforms;
 import org.graalvm.nativeimage.c.function.CodePointer;
-import org.graalvm.nativeimage.hosted.Feature;
 import org.graalvm.word.Pointer;
 
 import com.oracle.svm.core.Uninterruptible;
 import com.oracle.svm.core.c.NonmovableArray;
 import com.oracle.svm.core.c.NonmovableArrays;
 import com.oracle.svm.core.deopt.SubstrateInstalledCode;
-import com.oracle.svm.core.feature.AutomaticallyRegisteredFeature;
-import com.oracle.svm.core.feature.InternalFeature;
 import com.oracle.svm.core.heap.CodeReferenceMapDecoder;
 import com.oracle.svm.core.heap.ObjectReferenceVisitor;
 import com.oracle.svm.core.heap.ReferenceMapIndex;
@@ -56,7 +50,6 @@
 import com.oracle.svm.core.thread.JavaVMOperation;
 import com.oracle.svm.core.thread.VMOperation;
 import com.oracle.svm.core.util.Counter;
-import com.oracle.svm.core.util.CounterFeature;
 import com.oracle.svm.core.util.VMError;
 
 import jdk.graal.compiler.api.replacements.Fold;
@@ -112,7 +105,7 @@ public static CodeInfo getFirstImageCodeInfo() {
 
     @Uninterruptible(reason = "Called from uninterruptible code.", mayBeInlined = true)
     public static CodeInfo getFirstImageCodeInfo(int layerNumber) {
-        return MultiLayeredImageSingleton.getForLayer(ImageCodeInfoStorage.class, layerNumber).getData();
+        return MultiLayeredImageSingleton.getForLayer(ImageCodeInfoStorage.class, layerNumber).getCodeInfo();
     }
 
     @Uninterruptible(reason = "Called from uninterruptible code.", mayBeInlined = true)
@@ -318,37 +311,3 @@ final class CodeInfoTableCounters {
     final Counter lookupInstalledCodeCount = new Counter(counters, "lookupInstalledCode", "");
     final Counter invalidateInstalledCodeCount = new Counter(counters, "invalidateInstalledCode", "");
 }
-
-@AutomaticallyRegisteredFeature
-class CodeInfoFeature implements InternalFeature {
-    @Override
-    public List<Class<? extends Feature>> getRequiredFeatures() {
-        return Arrays.asList(CounterFeature.class);
-    }
-
-    @Override
-    public void duringSetup(DuringSetupAccess access) {
-        ImageSingletons.add(CodeInfoTableCounters.class, new CodeInfoTableCounters());
-        ImageSingletons.add(CodeInfoDecoderCounters.class, new CodeInfoDecoderCounters());
-        ImageSingletons.add(CodeInfoEncoder.Counters.class, new CodeInfoEncoder.Counters());
-        ImageSingletons.add(ImageCodeInfo.class, new ImageCodeInfo());
-        ImageSingletons.add(RuntimeCodeInfoHistory.class, new RuntimeCodeInfoHistory());
-        ImageSingletons.add(RuntimeCodeCache.class, new RuntimeCodeCache());
-        ImageSingletons.add(RuntimeCodeInfoMemory.class, new RuntimeCodeInfoMemory());
-    }
-
-    @Override
-    public void afterCompilation(AfterCompilationAccess config) {
-        ImageCodeInfo imageInfo = CodeInfoTable.getCurrentLayerImageCodeCache();
-        config.registerAsImmutable(imageInfo);
-        config.registerAsImmutable(imageInfo.codeInfoIndex);
-        config.registerAsImmutable(imageInfo.codeInfoEncodings);
-        config.registerAsImmutable(imageInfo.referenceMapEncoding);
-        config.registerAsImmutable(imageInfo.frameInfoEncodings);
-        config.registerAsImmutable(imageInfo.objectConstants);
-        config.registerAsImmutable(imageInfo.classes);
-        config.registerAsImmutable(imageInfo.memberNames);
-        config.registerAsImmutable(imageInfo.otherStrings);
-        config.registerAsImmutable(imageInfo.methodTable);
-    }
-}

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

@@ -30,6 +30,7 @@
 import org.graalvm.nativeimage.Platform;
 import org.graalvm.nativeimage.Platforms;
 import org.graalvm.nativeimage.c.function.CodePointer;
+import org.graalvm.nativeimage.hosted.Feature;
 import org.graalvm.word.ComparableWord;
 import org.graalvm.word.UnsignedWord;
 
@@ -60,6 +61,7 @@ public class ImageCodeInfo implements MultiLayeredImageSingleton, UnsavedSinglet
     @UnknownPrimitiveField(availability = AfterCompilation.class) private UnsignedWord dataOffset;
     @UnknownPrimitiveField(availability = AfterCompilation.class) private UnsignedWord dataSize;
     @UnknownPrimitiveField(availability = AfterCompilation.class) private UnsignedWord codeAndDataMemorySize;
+    @UnknownPrimitiveField(availability = AfterCompilation.class) private UnsignedWord relativeIPOffset;
     @UnknownPrimitiveField(availability = AfterCompilation.class) private int methodTableFirstId;
 
     private final Object[] objectFields;
@@ -74,7 +76,7 @@ public class ImageCodeInfo implements MultiLayeredImageSingleton, UnsavedSinglet
     @UnknownObjectField(availability = AfterCompilation.class) byte[] methodTable;
 
     @Platforms(Platform.HOSTED_ONLY.class)
-    ImageCodeInfo() {
+    protected ImageCodeInfo() {
         NonmovableObjectArray<Object> objfields = NonmovableArrays.createObjectArray(Object[].class, CodeInfoImpl.OBJFIELDS_COUNT, NmtCategory.Code);
         NonmovableArrays.setObject(objfields, CodeInfoImpl.NAME_OBJFIELD, CODE_INFO_NAME);
         // The image code info is never invalidated, so we consider it as always tethered.
@@ -90,24 +92,24 @@ static CodeInfo prepareCodeInfo() {
         int size = imageCodeInfos.length;
         for (int i = 0; i < size; i++) {
             ImageCodeInfo imageCodeInfo = imageCodeInfos[i];
-            CodeInfoImpl codeInfoImpl = runtimeCodeInfos[i].getData();
-            CodeInfoImpl nextCodeInfoImpl = i + 1 < size ? runtimeCodeInfos[i + 1].getData() : Word.nullPointer();
+            CodeInfoImpl codeInfoImpl = runtimeCodeInfos[i].getCodeInfo();
+            CodeInfoImpl nextCodeInfoImpl = i + 1 < size ? runtimeCodeInfos[i + 1].getCodeInfo() : Word.nullPointer();
 
             ImageCodeInfo.prepareCodeInfo0(imageCodeInfo, codeInfoImpl, nextCodeInfoImpl);
         }
-        return runtimeCodeInfos[0].getData();
+        return runtimeCodeInfos[0].getCodeInfo();
     }
 
     @Uninterruptible(reason = "Executes during isolate creation.")
-    private static void prepareCodeInfo0(ImageCodeInfo imageCodeInfo, CodeInfoImpl infoImpl, CodeInfo next) {
+    protected static void prepareCodeInfo0(ImageCodeInfo imageCodeInfo, CodeInfoImpl infoImpl, CodeInfo next) {
         assert infoImpl.getCodeStart().isNull() : "already initialized";
-
         infoImpl.setObjectFields(NonmovableArrays.fromImageHeap(imageCodeInfo.objectFields));
         infoImpl.setCodeStart(imageCodeInfo.codeStart);
         infoImpl.setCodeSize(imageCodeInfo.codeSize);
         infoImpl.setDataOffset(imageCodeInfo.dataOffset);
         infoImpl.setDataSize(imageCodeInfo.dataSize);
         infoImpl.setCodeAndDataMemorySize(imageCodeInfo.codeAndDataMemorySize);
+        infoImpl.setRelativeIPOffset(imageCodeInfo.relativeIPOffset);
         infoImpl.setCodeInfoIndex(NonmovableArrays.fromImageHeap(imageCodeInfo.codeInfoIndex));
         infoImpl.setCodeInfoEncodings(NonmovableArrays.fromImageHeap(imageCodeInfo.codeInfoEncodings));
         infoImpl.setStackReferenceMapEncoding(NonmovableArrays.fromImageHeap(imageCodeInfo.referenceMapEncoding));
@@ -122,6 +124,20 @@ private static void prepareCodeInfo0(ImageCodeInfo imageCodeInfo, CodeInfoImpl i
         infoImpl.setNextImageCodeInfo(next);
     }
 
+    @Platforms(Platform.HOSTED_ONLY.class)
+    public void registerAsImmutable(Feature.AfterCompilationAccess config) {
+        config.registerAsImmutable(this);
+        config.registerAsImmutable(codeInfoIndex);
+        config.registerAsImmutable(codeInfoEncodings);
+        config.registerAsImmutable(referenceMapEncoding);
+        config.registerAsImmutable(frameInfoEncodings);
+        config.registerAsImmutable(objectConstants);
+        config.registerAsImmutable(classes);
+        config.registerAsImmutable(memberNames);
+        config.registerAsImmutable(otherStrings);
+        config.registerAsImmutable(methodTable);
+    }
+
     /**
      * Use {@link CodeInfoTable#getImageCodeInfo} and {@link CodeInfoAccess#getCodeStart} instead.
      * This method is intended only for VM-internal usage.
@@ -216,6 +232,16 @@ public void setCodeAndDataMemorySize(UnsignedWord value) {
             codeAndDataMemorySize = value;
         }
 
+        @Override
+        public void setRelativeIPOffset(UnsignedWord offset) {
+            relativeIPOffset = offset;
+        }
+
+        @Override
+        public UnsignedWord getRelativeIPOffset() {
+            return relativeIPOffset;
+        }
+
         @Override
         public NonmovableArray<Byte> getCodeInfoIndex() {
             return NonmovableArrays.fromImageHeap(codeInfoIndex);

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

@@ -29,7 +29,6 @@
 import org.graalvm.nativeimage.ImageSingletons;
 import org.graalvm.nativeimage.c.struct.SizeOf;
 import org.graalvm.word.Pointer;
-import org.graalvm.word.UnsignedWord;
 
 import com.oracle.svm.core.Uninterruptible;
 import com.oracle.svm.core.c.CIsolateData;
@@ -59,28 +58,23 @@ public class ImageCodeInfoStorage implements MultiLayeredImageSingleton, Unsaved
      */
     static final int ALIGNMENT = Long.BYTES;
 
-    ImageCodeInfoStorage(int dataSize) {
+    protected ImageCodeInfoStorage() {
+        long size = SizeOf.get(CodeInfoImpl.class);
+        int arrayBaseOffset = ConfigurationValues.getObjectLayout().getArrayBaseOffset(JavaKind.Byte);
+        int alignedOffset = getAlignedOffsetInArray();
+        int addend = alignedOffset - arrayBaseOffset;
+        int dataSize = NumUtil.safeToInt(size + addend);
         data = new byte[dataSize];
     }
 
-    @Uninterruptible(reason = "Called from uninterruptible code.", mayBeInlined = true)
-    static CodeInfoImpl get() {
-        return ImageSingletons.lookup(ImageCodeInfoStorage.class).getData();
-    }
-
     @Fold
-    protected static UnsignedWord offset() {
-        return Word.unsigned(calculateOffset());
-    }
-
-    static int calculateOffset() {
+    static int getAlignedOffsetInArray() {
         return NumUtil.roundUp(ConfigurationValues.getObjectLayout().getArrayBaseOffset(JavaKind.Byte), ALIGNMENT);
     }
 
     @Uninterruptible(reason = "Called from uninterruptible code.", mayBeInlined = true)
-    CodeInfoImpl getData() {
-        Pointer base = Word.objectToUntrackedPointer(data).add(offset());
-
+    public CodeInfoImpl getCodeInfo() {
+        Pointer base = Word.objectToUntrackedPointer(data).add(Word.unsigned(getAlignedOffsetInArray()));
         return (CodeInfoImpl) base;
     }
 
@@ -92,14 +86,8 @@ public EnumSet<LayeredImageSingletonBuilderFlags> getImageBuilderFlags() {
 
 @AutomaticallyRegisteredFeature
 class ImageCodeInfoStorageFeature implements InternalFeature, UnsavedSingleton, FeatureSingleton {
-
     @Override
     public void duringSetup(DuringSetupAccess access) {
-        long size = SizeOf.get(CodeInfoImpl.class);
-        int arrayBaseOffset = ConfigurationValues.getObjectLayout().getArrayBaseOffset(JavaKind.Byte);
-        int actualOffset = ImageCodeInfoStorage.calculateOffset();
-        int addend = actualOffset - arrayBaseOffset;
-
-        ImageSingletons.add(ImageCodeInfoStorage.class, new ImageCodeInfoStorage(NumUtil.safeToInt(size + addend)));
+        ImageSingletons.add(ImageCodeInfoStorage.class, new ImageCodeInfoStorage());
     }
 }