[GR-33139] Implement HPy JNI backend.

PullRequest: graalpython/1907

Author: fangerer

graalpython/com.oracle.graal.python.cext/hpy/hpy.c

@@ -84,9 +84,6 @@ int graal_hpy_init(HPyContext context, void *initObject) {
 	polyglot_invoke(initObject, "setHPyNativeType", polyglot_HPy_typeid());
 	polyglot_invoke(initObject, "setHPyArrayNativeType", polyglot_array_typeid(polyglot_HPy_typeid(), 0));
 
-	// register null handle
-	polyglot_invoke(initObject, "setHPyNullHandle", HPy_NULL);
-
 	// register size of wchar_t
 	polyglot_invoke(initObject, "setWcharSize", sizeof(wchar_t));
 
@@ -587,19 +584,19 @@ void graal_hpy_write_ptr(void* object, HPy_ssize_t offset, void* value) {
 
 typedef void (*destroyfunc)(void *);
 /* to be used from Java code only */
-int graal_hpy_bulk_free(void* ptrArray[], int64_t len) {
+int graal_hpy_bulk_free(uint64_t ptrArray[], int64_t len) {
 	int64_t i;
-	void* obj;
+	uint64_t obj;
 	destroyfunc func;
 
 	for (i=0; i < len; i+=2) {
 		obj = ptrArray[i];
-	    func = ptrArray[i+1];
-		if (obj != NULL) {
+	    func = (destroyfunc) ptrArray[i+1];
+		if (obj) {
 		    if (func != NULL) {
-		        func(obj);
+		        func((void *) obj);
 		    }
-			free(obj);
+			free((void *) obj);
 		}
 	}
     return 0;
@@ -1250,9 +1247,13 @@ HPyAPI_STORAGE void _HPy_IMPL_NAME(Dump)(HPyContext ctx, HPy h) {
 #undef _HPy_IMPL_NAME_NOPREFIX
 #undef _HPy_IMPL_NAME
 
+#include "hpynative.h"
+
 /* Allocate a native HPy context structure and fill it. */
-HPyContext graal_hpy_context_to_native(HPyContext managed_context) {
-	HPyContext native_context = (HPyContext) malloc(sizeof(struct _HPyContext_s));
+HPyContext graal_hpy_context_to_native(HPyContext managed_context, HPyContext overrides) {
+	GraalHPyContext *full_native_context = (GraalHPyContext *) malloc(sizeof(GraalHPyContext));
+
+	HPyContext native_context = graal_native_context_get_hpy_context(full_native_context);
 
 #define COPY(__member) native_context->__member = managed_context->__member
 	COPY(name);
@@ -1334,7 +1335,7 @@ HPyContext graal_hpy_context_to_native(HPyContext managed_context) {
     COPY(h_ListType);
 #undef COPY
 
-#define HPY_CTX_UPCALL(__fun) native_context->__fun = __fun;
+#define HPY_CTX_UPCALL(__fun) { void* v = overrides->__fun; if (v != NULL) native_context->__fun = v; else native_context->__fun = __fun; }
     HPY_CTX_UPCALL(ctx_Module_Create);
     HPY_CTX_UPCALL(ctx_Dup);
     HPY_CTX_UPCALL(ctx_Close);

graalpython/com.oracle.graal.python.cext/hpy/hpynative.h

@@ -0,0 +1,66 @@
+/*
+ * Copyright (c) 2021, 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.
+ */
+
+#ifndef HPY_HPYNATIVE_H_
+#define HPY_HPYNATIVE_H_
+
+#include <stddef.h>
+
+#include "hpy.h"
+
+typedef struct {
+    void *jni_context;
+
+	/* embed HPy context */
+	struct _HPyContext_s hpy_context;
+} GraalHPyContext;
+
+#define MUST_INLINE __attribute__((always_inline)) static inline
+
+MUST_INLINE HPyContext graal_native_context_get_hpy_context(GraalHPyContext *native_context) {
+	return &(native_context->hpy_context);
+}
+
+MUST_INLINE GraalHPyContext *graal_hpy_context_get_native_context(HPyContext hpy_context) {
+	return (GraalHPyContext *)(((void *)hpy_context) - offsetof(GraalHPyContext, hpy_context));
+}
+
+#endif /* HPY_HPYNATIVE_H_ */

graalpython/com.oracle.graal.python.cext/include/universal/autogen_ctx.h

@@ -37,10 +37,12 @@
 typedef HPy* _HPyPtr;
 typedef HPy _HPyConst;
 
+#ifdef GRAALVM_PYTHON_LLVM
 #define HPy void*
 #define HPyListBuilder void*
 #define HPyTupleBuilder void*
 #define HPyTracker void*
+#endif
 
 
 struct _HPyContext_s {
@@ -249,7 +251,9 @@ struct _HPyContext_s {
     void (*ctx_Dump)(HPyContext ctx, HPy h);
 };
 
+#ifdef GRAALVM_PYTHON_LLVM
 #undef HPy
 #undef HPyListBuilder
 #undef HPyTupleBuilder
 #undef HPyTracker
+#endif

graalpython/com.oracle.graal.python.cext/include/universal/autogen_trampolines.h

@@ -34,6 +34,7 @@
 
 */
 
+#ifdef GRAALVM_PYTHON_LLVM
 #define UNWRAP(_h) ((_h)._i)
 #define WRAP(_ptr) ((HPy){(_ptr)})
 #define UNWRAP_TUPLE_BUILDER(_h) ((_h)._tup)
@@ -42,6 +43,16 @@
 #define WRAP_LIST_BUILDER(_ptr) ((HPyListBuilder){(_ptr)})
 #define UNWRAP_TRACKER(_h) ((_h)._i)
 #define WRAP_TRACKER(_ptr) ((HPyTracker){(_ptr)})
+#else
+#define UNWRAP(_h) _h
+#define WRAP(_ptr) _ptr
+#define UNWRAP_TUPLE_BUILDER(_h) _h
+#define WRAP_TUPLE_BUILDER(_ptr) _ptr
+#define UNWRAP_LIST_BUILDER(_h) _h
+#define WRAP_LIST_BUILDER(_ptr) _ptr
+#define UNWRAP_TRACKER(_h) _h
+#define WRAP_TRACKER(_ptr) _ptr
+#endif
 
 static inline HPy HPyModule_Create(HPyContext ctx, HPyModuleDef *def) {
      return WRAP(ctx->ctx_Module_Create ( ctx, def ));

graalpython/com.oracle.graal.python.cext/include/universal/hpy.h

@@ -56,10 +56,17 @@ typedef intptr_t HPy_hash_t;
    are each just a pointer-sized integer.  What this integer (or pointer)
    means is up to the implementation.  For example, on both CPython and PyPy,
    the HPy structure contains an index in a global array. */
+#ifndef GRAALVM_PYTHON_LLVM
+typedef struct _HPy_s { HPy_ssize_t _i; } HPy;
+typedef struct { HPy_ssize_t _lst; } HPyListBuilder;
+typedef struct { HPy_ssize_t _tup; } HPyTupleBuilder;
+typedef struct { HPy_ssize_t _i; } HPyTracker;
+#else
 typedef struct _HPy_s { void* _i; } HPy;
 typedef struct { void* _lst; } HPyListBuilder;
 typedef struct { void* _tup; } HPyTupleBuilder;
 typedef struct { void* _i; } HPyTracker;
+#endif
 
 typedef struct _HPyContext_s *HPyContext;
 
@@ -68,14 +75,24 @@ typedef struct _HPyContext_s *HPyContext;
 
 
 /* misc stuff, which should probably go in its own header */
+#ifndef GRAALVM_PYTHON_LLVM
+#define HPy_NULL ((HPy){0})
+#define HPy_IsNull(x) ((x)._i == 0)
+#else
 #define HPy_NULL ((HPy){NULL})
 #define HPy_IsNull(x) ((x)._i == NULL)
+#endif
 
 // XXX: we need to decide whether these are part of the official API or not,
 // and maybe introduce a better naming convetion. For now, they are needed for
 // ujson
+#ifndef GRAALVM_PYTHON_LLVM
+static inline HPy HPy_FromVoidP(void *p) { return (HPy){(HPy_ssize_t)p}; }
+static inline void* HPy_AsVoidP(HPy h) { return (void*)h._i; }
+#else
 static inline HPy HPy_FromVoidP(void *p) { return (HPy){p}; }
 static inline void* HPy_AsVoidP(HPy h) { return h._i; }
+#endif
 
 // include runtime functions
 #include "common/macros.h"
@@ -91,6 +108,14 @@ static inline void* HPy_AsVoidP(HPy h) { return h._i; }
 
 /* manual trampolines */
 
+#ifdef GRAALVM_PYTHON_LLVM
+#define UNWRAP(_h) ((_h)._i)
+#define WRAP(_ptr) ((HPy){(_ptr)})
+#else
+#define UNWRAP(_h) _h
+#define WRAP(_ptr) _ptr
+#endif
+
 static inline HPy _HPy_New(HPyContext ctx, HPy h_type, void **data) {
     /* Performance hack: the autogenerated version of this trampoline would
        simply forward data to ctx_New.
@@ -108,7 +133,7 @@ static inline HPy _HPy_New(HPyContext ctx, HPy h_type, void **data) {
        See https://github.com/pyhandle/hpy/pull/22#pullrequestreview-413365845
     */
     void *data_result;
-    HPy h = HPy_FromVoidP(ctx->ctx_New(ctx, HPy_AsVoidP(h_type), &data_result));
+    HPy h = WRAP(ctx->ctx_New(ctx, UNWRAP(h_type), &data_result));
     *data = data_result;
     return h;
 }

graalpython/com.oracle.graal.python.cext/setup.py

@@ -426,7 +426,7 @@ def build_libhpy(capi_home):
     files = [os.path.abspath(os.path.join(src_dir, f)) for f in os.listdir(src_dir) if f.endswith(".c")]
     module = Extension(libhpy_name,
                        sources=files,
-                       define_macros=[("HPY_UNIVERSAL_ABI", None)],
+                       define_macros=[("HPY_UNIVERSAL_ABI", 1)],
                        extra_compile_args=cflags_warnings,
     )
     args = [verbosity, 'build', 'install_lib', '-f', '--install-dir=%s' % capi_home, "clean"]