Add C API type 'PyCapsule'.

Author: fangerer

graalpython/com.oracle.graal.python.cext/src/capi.c

@@ -83,6 +83,7 @@ static void initialize_capi() {
     initialize_type_structure(&PySlice_Type, "slice");
     initialize_type_structure(&PyByteArray_Type, "bytearray");
     initialize_type_structure(&_PyNotImplemented_Type, "NotImplementedType");
+    initialize_type_structure(&PyCapsule_Type, "PyCapsule");
 
     // initialize global variables like '_Py_NoneStruct', etc.
     initialize_globals();

graalpython/com.oracle.graal.python.cext/src/capi.h

@@ -51,6 +51,14 @@ typedef struct {
     PyObject *md_name;  /* for logging purposes after md_dict is cleared */
 } PyModuleObject;
 
+// taken from CPython "Objects/capsule.c"
+typedef struct {
+    PyObject_HEAD
+    void *pointer;
+    const char *name;
+    void *context;
+    PyCapsule_Destructor destructor;
+} PyCapsule;
 
 /* Declare Python structs/types for explicit polyglot typecasts. */
 /* NOTE: Also add an appropriate case in 'PyTruffle_Explicit_Cast' ! */
@@ -64,6 +72,7 @@ POLYGLOT_DECLARE_TYPE(PyDictObject);
 POLYGLOT_DECLARE_TYPE(PyUnicodeObject);
 POLYGLOT_DECLARE_TYPE(PyBytesObject);
 POLYGLOT_DECLARE_STRUCT(_longobject);
+POLYGLOT_DECLARE_TYPE(PyCapsule);
 
 
 extern void* to_java(PyObject* obj);

graalpython/com.oracle.graal.python.cext/src/capsule.c

@@ -38,7 +38,26 @@
  */
 #include "capi.h"
 
+PyTypeObject PyCapsule_Type = PY_TRUFFLE_TYPE("PyCapsule", &PyType_Type, 0);
+
 PyObject* PyCapsule_New(void *pointer, const char *name, PyCapsule_Destructor destructor) {
-    // TODO: fail for now
-    return NULL;
+    return (PyObject *)polyglot_as_PyCapsule(to_sulong(polyglot_invoke(PY_TRUFFLE_CEXT, "PyCapsule", polyglot_from_string(name, "ascii"), pointer, destructor)));
+}
+
+void * PyCapsule_GetContext(PyObject *o) {
+	void *result = polyglot_invoke(PY_TRUFFLE_CEXT, "PyCapsule_GetContext", to_java(o), ERROR_MARKER);
+	if (result == ERROR_MARKER) {
+		return NULL;
+	}
+	return (void *)as_long(result);
 }
+
+void * PyCapsule_GetPointer(PyObject *o, const char *name) {
+	void *result = polyglot_invoke(PY_TRUFFLE_CEXT, "PyCapsule_GetPointer", to_java(o), polyglot_from_string(name, "ascii"), ERROR_MARKER);
+	if (result == ERROR_MARKER) {
+		return NULL;
+	}
+	return (void *)as_long(result);
+}
+
+

graalpython/com.oracle.graal.python.test/src/tests/cpyext/test_capsule.py

@@ -0,0 +1,62 @@
+# Copyright (c) 2018, Oracle and/or its affiliates.
+#
+# 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.
+
+import sys
+from . import CPyExtTestCase, CPyExtFunction, CPyExtFunctionOutVars, unhandled_error_compare, GRAALPYTHON
+__dir__ = __file__.rpartition("/")[0]
+
+class TestPyCapsule(CPyExtTestCase):
+    def compile_module(self, name):
+        type(self).mro()[1].__dict__["test_%s" % name].create_module(name)
+        super(TestPyCapsule, self).compile_module(name)
+
+    test_PyCapsule_CheckExact = CPyExtFunction(
+        lambda args: True,
+        lambda: (
+            ("hello",0xDEADBEEF), 
+        ),
+        code='''int wrap_PyCapsule_Check(char * name, Py_ssize_t ptr) {
+            PyObject* capsule = PyCapsule_New(ptr, name, NULL);
+            return PyCapsule_CheckExact(capsule);
+        }
+        ''',
+        resultspec="i",
+        argspec='sn',
+        arguments=["PyObject* name", "Py_ssize_t ptr"],
+        callfunction="wrap_PyCapsule_Check",
+        cmpfunc=unhandled_error_compare
+    )

graalpython/lib-graalpython/python_cext.py

@@ -532,6 +532,50 @@ def PyUnicode_Format(format, args, error_marker):
     return error_marker
 
 
+##################### CAPSULE
+
+
+class PyCapsule:
+    name = None
+    pointer = None
+    context = None
+
+    def __init__(self, name, pointer, destructor):
+        self.name = name
+        self.pointer = pointer
+
+    def __repr__(self):
+        name = "NULL" if self.name is None else self.name
+        quote = "" if self.name is None else '"'
+        return "<capsule object %s%s%s at %p>" % (quote, name, quote, self.pointer)
+
+
+def PyCapsule_GetContext(obj, error_marker):
+    typ = val = tb = None
+    try:
+        if not isinstance(obj, PyCapsule) or obj.pointer is None:
+            raise ValueError("PyCapsule_GetContext called with invalid PyCapsule object")
+        return obj.context
+    except BaseException:
+        typ, val, tb = sys.exc_info()
+    PyErr_Restore(typ, val, tb)
+    return error_marker
+
+
+def PyCapsule_GetPointer(obj, name, error_marker):
+    typ = val = tb = None
+    try:
+        if not isinstance(obj, PyCapsule) or obj.pointer is None:
+            raise ValueError("PyCapsule_GetPointer called with invalid PyCapsule object")
+        if name != obj.name:
+            raise ValueError("PyCapsule_GetPointer called with incorrect name")
+        return obj.pointer
+    except BaseException:
+        typ, val, tb = sys.exc_info()
+    PyErr_Restore(typ, val, tb)
+    return error_marker
+
+
 def PyModule_AddObject(m, k, v):
     m.__dict__[k] = v
     return None
@@ -996,6 +1040,8 @@ def PyTruffle_Type(type_name):
         return type(sys)
     elif type_name == "NoneType":
         return type(None)
+    elif type_name == "PyCapsule":
+        return PyCapsule
     else:
         return getattr(sys.modules["builtins"], type_name)