Introduce CTypeConversion.asByteBuffer

danielnorberg · Oct 12, 2018 · 5fd3aea · 5fd3aea
1 parent 8bed697
commit 5fd3aea
Show file tree

Hide file tree

Showing 10 changed files with 58 additions and 41 deletions.
diff --git a/sdk/src/org.graalvm.nativeimage/src/org/graalvm/nativeimage/c/type/CTypeConversion.java b/sdk/src/org.graalvm.nativeimage/src/org/graalvm/nativeimage/c/type/CTypeConversion.java
@@ -40,6 +40,8 @@
  */
 package org.graalvm.nativeimage.c.type;
 
+import java.nio.ByteBuffer;
+import java.nio.ByteOrder;
 import java.nio.charset.Charset;
 
 import org.graalvm.nativeimage.ImageSingletons;
@@ -259,4 +261,18 @@ public void close() {
     public static CCharPointerPointerHolder toCStrings(CharSequence[] javaStrings) {
         return new CCharPointerPointerHolder(javaStrings);
     }
+
+    /**
+     * Creates a {@link ByteBuffer} that refers to the native memory at the specified address. The
+     * passed size becomes the {@linkplain ByteBuffer#capacity capacity} of the byte buffer, and the
+     * buffer's {@linkplain ByteBuffer#order() byte order} is set to
+     * {@linkplain ByteOrder#nativeOrder() native byte order}. The caller is responsible for
+     * ensuring that the memory can be safely accessed while the ByteBuffer is used, and for freeing
+     * the memory afterwards.
+     *
+     * @since 1.0
+     */
+    public static ByteBuffer asByteBuffer(PointerBase address, int size) {
+        return ImageSingletons.lookup(CTypeConversionSupport.class).asByteBuffer(address, size);
+    }
 }
diff --git a/sdk/src/org.graalvm.nativeimage/src/org/graalvm/nativeimage/impl/CTypeConversionSupport.java b/sdk/src/org.graalvm.nativeimage/src/org/graalvm/nativeimage/impl/CTypeConversionSupport.java
@@ -40,10 +40,12 @@
  */
 package org.graalvm.nativeimage.impl;
 
+import java.nio.ByteBuffer;
 import java.nio.charset.Charset;
 
 import org.graalvm.nativeimage.c.type.CCharPointer;
 import org.graalvm.nativeimage.c.type.CTypeConversion.CCharPointerHolder;
+import org.graalvm.word.PointerBase;
 import org.graalvm.word.UnsignedWord;
 
 public interface CTypeConversionSupport {
@@ -59,4 +61,6 @@ public interface CTypeConversionSupport {
     String toJavaString(CCharPointer cString, UnsignedWord length);
 
     String toJavaString(CCharPointer cString, UnsignedWord length, Charset charset);
+
+    ByteBuffer asByteBuffer(PointerBase address, int size);
 }
diff --git a/...rc/com.oracle.svm.core.graal/src/com/oracle/svm/core/graal/meta/InstalledCodeBuilder.java b/...rc/com.oracle.svm.core.graal/src/com/oracle/svm/core/graal/meta/InstalledCodeBuilder.java
@@ -39,11 +39,11 @@
 import org.graalvm.compiler.debug.Indent;
 import org.graalvm.nativeimage.ImageSingletons;
 import org.graalvm.nativeimage.c.function.CodePointer;
+import org.graalvm.nativeimage.c.type.CTypeConversion;
 import org.graalvm.word.Pointer;
 import org.graalvm.word.UnsignedWord;
 import org.graalvm.word.WordFactory;
 
-import com.oracle.svm.core.SubstrateUtil;
 import com.oracle.svm.core.annotate.Uninterruptible;
 import com.oracle.svm.core.code.CodeInfoEncoder;
 import com.oracle.svm.core.code.CodeInfoTable;
@@ -294,7 +294,7 @@ private void installOperation() {
         }
 
         /* Write primitive constants to the buffer, record object constants with offsets */
-        ByteBuffer constantsBuffer = SubstrateUtil.wrapAsByteBuffer(code.add(constantsOffset), compilation.getDataSection().getSectionSize());
+        ByteBuffer constantsBuffer = CTypeConversion.asByteBuffer(code.add(constantsOffset), compilation.getDataSection().getSectionSize());
         compilation.getDataSection().buildDataSection(constantsBuffer, (position, constant) -> {
             objectConstants.add(constantsOffset + position, (SubstrateObjectConstant) constant);
         });

diff --git a/...c/com.oracle.svm.core.posix/src/com/oracle/svm/core/posix/PosixJavaLangSubstitutions.java b/...c/com.oracle.svm.core.posix/src/com/oracle/svm/core/posix/PosixJavaLangSubstitutions.java
@@ -54,7 +54,6 @@
 
 import com.oracle.svm.core.LibCHelper;
 import com.oracle.svm.core.SubstrateOptions;
-import com.oracle.svm.core.SubstrateUtil;
 import com.oracle.svm.core.annotate.Alias;
 import com.oracle.svm.core.annotate.Delete;
 import com.oracle.svm.core.annotate.InjectAccessors;
@@ -161,11 +160,11 @@ static byte[][] environ() {
                 int valLength = (int) LibC.strlen(valBeg).rawValue();
 
                 byte[] var = new byte[varLength];
-                SubstrateUtil.wrapAsByteBuffer(varBeg, varLength).get(var);
+                CTypeConversion.asByteBuffer(varBeg, varLength).get(var);
                 result[2 * j] = var;
 
                 byte[] val = new byte[valLength];
-                SubstrateUtil.wrapAsByteBuffer(valBeg, valLength).get(val);
+                CTypeConversion.asByteBuffer(valBeg, valLength).get(val);
                 result[2 * j + 1] = val;
 
                 j++;

diff --git a/substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/SubstrateUtil.java b/substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/SubstrateUtil.java
@@ -27,7 +27,6 @@
 import java.io.FileDescriptor;
 import java.io.FileOutputStream;
 import java.nio.ByteBuffer;
-import java.nio.MappedByteBuffer;
 import java.util.Arrays;
 
 import org.graalvm.compiler.api.replacements.Fold;
@@ -56,7 +55,6 @@
 import com.oracle.svm.core.annotate.TargetClass;
 import com.oracle.svm.core.annotate.Uninterruptible;
 import com.oracle.svm.core.code.CodeInfoTable;
-import com.oracle.svm.core.config.ConfigurationValues;
 import com.oracle.svm.core.deopt.DeoptimizationSupport;
 import com.oracle.svm.core.deopt.DeoptimizedFrame;
 import com.oracle.svm.core.deopt.Deoptimizer;
@@ -149,30 +147,10 @@ public static UnsignedWord strlen(CCharPointer str) {
         return n;
     }
 
-    @TargetClass(className = "java.nio.DirectByteBuffer")
-    @SuppressWarnings("unused")
-    static final class Target_java_nio_DirectByteBuffer {
-        @Alias
-        Target_java_nio_DirectByteBuffer(long addr, int cap) {
-        }
-
-        @Alias
-        public native long address();
-    }
-
-    /**
-     * Wraps a pointer to C memory into a {@link ByteBuffer}.
-     *
-     * @param pointer The pointer to C memory.
-     * @param size The size of the C memory.
-     * @return A new {@link ByteBuffer} wrapping the pointer.
-     */
+    /** @deprecated replaced by {@link CTypeConversion#asByteBuffer(PointerBase, int)} */
+    @Deprecated
     public static ByteBuffer wrapAsByteBuffer(PointerBase pointer, int size) {
-        return KnownIntrinsics.unsafeCast(new Target_java_nio_DirectByteBuffer(pointer.rawValue(), size), ByteBuffer.class).order(ConfigurationValues.getTarget().arch.getByteOrder());
-    }
-
-    public static <T extends PointerBase> T getBaseAddress(MappedByteBuffer buffer) {
-        return WordFactory.pointer(KnownIntrinsics.unsafeCast(buffer, Target_java_nio_DirectByteBuffer.class).address());
+        return CTypeConversion.asByteBuffer(pointer, size);
     }
 
     /**

diff --git a/...tratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/c/CTypeConversionSupportImpl.java b/...tratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/c/CTypeConversionSupportImpl.java
@@ -24,6 +24,7 @@
  */
 package com.oracle.svm.core.c;
 
+import java.nio.ByteBuffer;
 import java.nio.charset.Charset;
 import java.util.Arrays;
 
@@ -34,11 +35,16 @@
 import org.graalvm.nativeimage.c.type.CTypeConversion.CCharPointerHolder;
 import org.graalvm.nativeimage.impl.CTypeConversionSupport;
 import org.graalvm.word.Pointer;
+import org.graalvm.word.PointerBase;
 import org.graalvm.word.UnsignedWord;
 import org.graalvm.word.WordFactory;
 
 import com.oracle.svm.core.SubstrateUtil;
+import com.oracle.svm.core.annotate.Alias;
 import com.oracle.svm.core.annotate.AutomaticFeature;
+import com.oracle.svm.core.annotate.TargetClass;
+import com.oracle.svm.core.config.ConfigurationValues;
+import com.oracle.svm.core.snippets.KnownIntrinsics;
 
 class CTypeConversionSupportImpl implements CTypeConversionSupport {
 
@@ -130,6 +136,20 @@ public CCharPointerHolder toCString(CharSequence javaString) {
         }
         return new CCharPointerHolderImpl(javaString);
     }
+
+    @TargetClass(className = "java.nio.DirectByteBuffer")
+    @SuppressWarnings("unused")
+    static final class Target_java_nio_DirectByteBuffer {
+        @Alias
+        Target_java_nio_DirectByteBuffer(long addr, int cap) {
+        }
+    }
+
+    @Override
+    public ByteBuffer asByteBuffer(PointerBase address, int size) {
+        ByteBuffer byteBuffer = KnownIntrinsics.unsafeCast(new Target_java_nio_DirectByteBuffer(address.rawValue(), size), ByteBuffer.class);
+        return byteBuffer.order(ConfigurationValues.getTarget().arch.getByteOrder());
+    }
 }
 
 final class CCharPointerHolderImpl implements CCharPointerHolder {

diff --git a/substratevm/src/com.oracle.svm.jni/src/com/oracle/svm/jni/functions/JNIFunctions.java b/substratevm/src/com.oracle.svm.jni/src/com/oracle/svm/jni/functions/JNIFunctions.java
@@ -443,7 +443,7 @@ static JNIObjectHandle NewString(JNIEnvironment env, CShortPointer unicode, int
     static JNIObjectHandle NewStringUTF(JNIEnvironment env, CCharPointer bytes) {
         String str = null;
         if (bytes.isNonNull()) {
-            ByteBuffer buffer = SubstrateUtil.wrapAsByteBuffer(bytes, Integer.MAX_VALUE);
+            ByteBuffer buffer = CTypeConversion.asByteBuffer(bytes, Integer.MAX_VALUE);
             try {
                 str = Utf8.utf8ToString(true, buffer);
             } catch (CharConversionException ignore) {
@@ -578,7 +578,7 @@ static void GetStringUTFRegion(JNIEnvironment env, JNIObjectHandle hstr, int sta
         }
         int capacity = Utf8.maxUtf8ByteLength(len, true); // estimate: caller must pre-allocate
                                                           // enough
-        ByteBuffer buffer = SubstrateUtil.wrapAsByteBuffer(buf, capacity);
+        ByteBuffer buffer = CTypeConversion.asByteBuffer(buf, capacity);
         Utf8.substringToUtf8(buffer, str, start, start + len, true);
     }
 

diff --git a/...atevm/src/com.oracle.svm.jni/src/com/oracle/svm/jni/functions/JNIInvocationInterface.java b/...atevm/src/com.oracle.svm.jni/src/com/oracle/svm/jni/functions/JNIInvocationInterface.java
@@ -46,7 +46,6 @@
 import org.graalvm.word.WordFactory;
 
 import com.oracle.svm.core.MonitorSupport;
-import com.oracle.svm.core.SubstrateUtil;
 import com.oracle.svm.core.annotate.Uninterruptible;
 import com.oracle.svm.core.c.function.CEntryPointActions;
 import com.oracle.svm.core.c.function.CEntryPointOptions;
@@ -273,7 +272,7 @@ static int attachCurrentThread(JNIJavaVM vm, JNIEnvironmentPointer penv, JNIJava
                 if (args.isNonNull() && args.getVersion() != JNIVersion.JNI_VERSION_1_1()) {
                     group = JNIObjectHandles.getObject(args.getGroup());
                     if (args.getName().isNonNull()) {
-                        ByteBuffer buffer = SubstrateUtil.wrapAsByteBuffer(args.getName(), Integer.MAX_VALUE);
+                        ByteBuffer buffer = CTypeConversion.asByteBuffer(args.getName(), Integer.MAX_VALUE);
                         try {
                             name = Utf8.utf8ToString(true, buffer);
                         } catch (CharConversionException ignore) {

diff --git a/substratevm/src/com.oracle.svm.truffle.nfi/src/com/oracle/svm/truffle/nfi/NativeClosure.java b/substratevm/src/com.oracle.svm.truffle.nfi/src/com/oracle/svm/truffle/nfi/NativeClosure.java
@@ -40,13 +40,13 @@
 import org.graalvm.nativeimage.c.type.CCharPointer;
 import org.graalvm.nativeimage.c.type.CCharPointerPointer;
 import org.graalvm.nativeimage.c.type.CIntPointer;
+import org.graalvm.nativeimage.c.type.CTypeConversion;
 import org.graalvm.nativeimage.c.type.WordPointer;
 import org.graalvm.word.Pointer;
 import org.graalvm.word.PointerBase;
 import org.graalvm.word.WordBase;
 import org.graalvm.word.WordFactory;
 
-import com.oracle.svm.core.SubstrateUtil;
 import com.oracle.svm.core.c.function.CEntryPointActions;
 import com.oracle.svm.core.c.function.CEntryPointOptions;
 import com.oracle.svm.core.c.function.CEntryPointOptions.Publish;
@@ -85,7 +85,7 @@ private ByteBuffer createRetBuffer(PointerBase buffer) {
         if (size < SizeOf.get(ffi_arg.class)) {
             size = SizeOf.get(ffi_arg.class);
         }
-        return SubstrateUtil.wrapAsByteBuffer(buffer, size);
+        return CTypeConversion.asByteBuffer(buffer, size);
     }
 
     static Target_com_oracle_truffle_nfi_impl_ClosureNativePointer prepareClosure(Target_com_oracle_truffle_nfi_impl_NFIContext ctx,
@@ -125,7 +125,7 @@ private Object call(WordPointer argPointers, ByteBuffer retBuffer) {
                 // skip
             } else {
                 WordPointer argPtr = argPointers.read(i);
-                args[argIdx++] = SubstrateUtil.wrapAsByteBuffer(argPtr, argTypes[i].size);
+                args[argIdx++] = CTypeConversion.asByteBuffer(argPtr, argTypes[i].size);
             }
         }
 

diff --git a/...tevm/src/com.oracle.svm.truffle.nfi/src/com/oracle/svm/truffle/nfi/TruffleNFISupport.java b/...tevm/src/com.oracle.svm.truffle.nfi/src/com/oracle/svm/truffle/nfi/TruffleNFISupport.java
@@ -33,7 +33,11 @@
 
 import org.graalvm.nativeimage.ObjectHandle;
 import org.graalvm.nativeimage.ObjectHandles;
+import org.graalvm.nativeimage.Platform;
+import org.graalvm.nativeimage.Platform.DARWIN;
+import org.graalvm.nativeimage.Platform.LINUX;
 import org.graalvm.nativeimage.c.type.CCharPointer;
+import org.graalvm.nativeimage.c.type.CTypeConversion;
 import org.graalvm.word.SignedWord;
 import org.graalvm.word.UnsignedWord;
 import org.graalvm.word.WordFactory;
@@ -44,9 +48,6 @@
 import com.oracle.svm.core.util.VMError;
 import com.oracle.svm.truffle.nfi.NativeAPI.TruffleContextHandle;
 import com.oracle.truffle.api.CompilerDirectives.TruffleBoundary;
-import org.graalvm.nativeimage.Platform;
-import org.graalvm.nativeimage.Platform.DARWIN;
-import org.graalvm.nativeimage.Platform.LINUX;
 
 public final class TruffleNFISupport {
 
@@ -142,7 +143,7 @@ static String utf8ToJavaString(CCharPointer str) {
             return null;
         } else {
             UnsignedWord len = SubstrateUtil.strlen(str);
-            ByteBuffer buffer = SubstrateUtil.wrapAsByteBuffer(str, (int) len.rawValue());
+            ByteBuffer buffer = CTypeConversion.asByteBuffer(str, (int) len.rawValue());
             return UTF8.decode(buffer).toString();
         }
     }