Merge pull request #378 from fangerer/fa/capsule_dtor

Improve API/implementation for HPyCapsule_Destructor
hpyproject · Nov 23, 2022 · ff1488d · ff1488d
2 parents 414be8b + a818bb7
commit ff1488d
Show file tree

Hide file tree

Showing 18 changed files with 158 additions and 295 deletions.
diff --git a/hpy/debug/src/autogen_debug_ctx_init.h b/hpy/debug/src/autogen_debug_ctx_init.h
diff --git a/hpy/debug/src/autogen_debug_wrappers.c b/hpy/debug/src/autogen_debug_wrappers.c
diff --git a/hpy/debug/src/debug_ctx_cpython.c b/hpy/debug/src/debug_ctx_cpython.c
@@ -186,6 +186,14 @@ void debug_ctx_CallRealFunctionFromTrampoline(HPyContext *dctx,
                                                       a->visit, a->arg);
         return;
     }
+    case HPyFunc_CAPSULE_DESTRUCTOR: {
+        HPyFunc_Capsule_Destructor f = (HPyFunc_Capsule_Destructor)func;
+        PyObject *capsule = (PyObject *)args;
+        const char *name = PyCapsule_GetName(capsule);
+        f(name, PyCapsule_GetPointer(capsule, name),
+                PyCapsule_GetContext(capsule));
+        return;
+    }
 #include "autogen_debug_ctx_call.i"
     default:
         Py_FatalError("Unsupported HPyFunc_Signature in debug_ctx_cpython.c");

diff --git a/hpy/devel/include/hpy.h b/hpy/devel/include/hpy.h
@@ -156,8 +156,6 @@ typedef struct _HPyContext_s HPyContext;
     typedef Py_UCS4 HPy_UCS4;
 #endif
 
-typedef void (*HPyCapsule_Destructor)(const char *name, void *pointer, void *context);
-
 
 /* ~~~~~~~~~~~~~~~~ Additional #includes ~~~~~~~~~~~~~~~~ */
 

diff --git a/hpy/devel/include/hpy/cpy_types.h b/hpy/devel/include/hpy/cpy_types.h
@@ -14,6 +14,7 @@ typedef int (*cpy_visitproc)(cpy_PyObject *, void *);
 typedef cpy_PyObject *(*cpy_PyCFunction)(cpy_PyObject *, cpy_PyObject *);
 typedef cpy_PyObject *(*cpy_getter)(cpy_PyObject *, void *);
 typedef int (*cpy_setter)(cpy_PyObject *, cpy_PyObject *, void *);
+typedef void (*cpy_PyCapsule_Destructor)(cpy_PyObject *);
 
 
 #endif /* HPY_UNIVERSAL_CPY_TYPES_H */
diff --git a/hpy/devel/include/hpy/cpython/hpyfunc_trampolines.h b/hpy/devel/include/hpy/cpython/hpyfunc_trampolines.h
@@ -107,4 +107,12 @@ typedef int (*_HPyCFunction_RELEASEBUFFERPROC)(HPyContext *, HPy, HPy_buffer *);
                                                  visit, arg);           \
     }
 
+#define HPyCapsule_DESTRUCTOR_TRAMPOLINE(SYM, IMPL)                            \
+    static void SYM(PyObject *capsule)                                         \
+    {                                                                          \
+        const char *name = PyCapsule_GetName(capsule);                         \
+        IMPL(name, PyCapsule_GetPointer(capsule, name),                        \
+                PyCapsule_GetContext(capsule));                                \
+    }
+
 #endif // HPY_CPYTHON_HPYFUNC_TRAMPOLINES_H
diff --git a/hpy/devel/include/hpy/cpython/misc.h b/hpy/devel/include/hpy/cpython/misc.h
@@ -384,7 +384,7 @@ HPyAPI_FUNC int HPyErr_Occurred(HPyContext *ctx) {
     return ctx_Err_Occurred(ctx);
 }
 
-HPyAPI_FUNC HPy HPyCapsule_New(HPyContext *ctx, void *pointer, const char *name, HPyCapsule_Destructor destructor)
+HPyAPI_FUNC HPy HPyCapsule_New(HPyContext *ctx, void *pointer, const char *name, HPyCapsule_Destructor *destructor)
 {
     return ctx_Capsule_New(ctx, pointer, name, destructor);
 }
@@ -404,11 +404,6 @@ HPyAPI_FUNC void * HPyCapsule_GetContext(HPyContext *ctx, HPy capsule)
     return PyCapsule_GetContext(_h2py(capsule));
 }
 
-HPyAPI_FUNC HPyCapsule_Destructor HPyCapsule_GetDestructor(HPyContext *ctx, HPy capsule)
-{
-    return ctx_Capsule_GetDestructor(ctx, capsule);
-}
-
 HPyAPI_FUNC int HPyCapsule_SetPointer(HPyContext *ctx, HPy capsule, void *pointer)
 {
     return PyCapsule_SetPointer(_h2py(capsule), pointer);
@@ -424,7 +419,7 @@ HPyAPI_FUNC int HPyCapsule_SetContext(HPyContext *ctx, HPy capsule, void *contex
     return PyCapsule_SetContext(_h2py(capsule), context);
 }
 
-HPyAPI_FUNC int HPyCapsule_SetDestructor(HPyContext *ctx, HPy capsule, HPyCapsule_Destructor destructor)
+HPyAPI_FUNC int HPyCapsule_SetDestructor(HPyContext *ctx, HPy capsule, HPyCapsule_Destructor *destructor)
 {
     return ctx_Capsule_SetDestructor(ctx, capsule, destructor);
 }

diff --git a/hpy/devel/include/hpy/hpydef.h b/hpy/devel/include/hpy/hpydef.h
@@ -11,6 +11,7 @@ extern "C" {
 #include "hpy/cpy_types.h"
 
 typedef void* (*HPyCFunction)();
+typedef void (*HPyFunc_Capsule_Destructor)(const char *name, void *pointer, void *context);
 
 typedef struct {
     HPySlot_Slot slot;     // The slot to fill
@@ -93,6 +94,12 @@ typedef struct {
     };
 } HPyDef;
 
+typedef struct {
+    cpy_PyCapsule_Destructor cpy_trampoline;
+    HPyFunc_Capsule_Destructor impl;
+} HPyCapsule_Destructor;
+
+
 // macros to automatically define HPyDefs of various kinds
 
 /* ~~~ HPySlot_SIG ~~~
@@ -114,18 +121,18 @@ typedef struct {
    more detailed explanation in the comments around HPyFunc_DECLARE in
    hpyfunc.h
 */
-#define HPyDef_SLOT_IMPL(SYM, IMPL, SLOT)                            \
-    enum { SYM##_slot = SLOT };                                 \
+#define HPyDef_SLOT_IMPL(SYM, IMPL, SLOT)            \
+    enum { SYM##_slot = SLOT };                      \
     _HPyDef_SLOT(SYM, IMPL, SLOT, HPySlot_SIG(SLOT))
 
-#define HPyDef_SLOT(SYM, SLOT)                                 \
+#define HPyDef_SLOT(SYM, SLOT) \
     HPyDef_SLOT_IMPL(SYM, SYM##_impl, SLOT)
 
 
 // this is the actual implementation, after we determined the SIG
 #define _HPyDef_SLOT(SYM, IMPL, SLOT, SIG)                              \
     HPyFunc_DECLARE(IMPL, SIG);                                         \
-    HPyFunc_TRAMPOLINE(SYM##_trampoline, IMPL, SIG);             \
+    HPyFunc_TRAMPOLINE(SYM##_trampoline, IMPL, SIG);                    \
     HPyDef SYM = {                                                      \
         .kind = HPyDef_Kind_Slot,                                       \
         .slot = {                                                       \
@@ -136,9 +143,9 @@ typedef struct {
     };
 
 
-#define HPyDef_METH_IMPL(SYM, NAME, IMPL, SIG, ...)                          \
+#define HPyDef_METH_IMPL(SYM, NAME, IMPL, SIG, ...)                     \
     HPyFunc_DECLARE(IMPL, SIG);                                         \
-    HPyFunc_TRAMPOLINE(SYM##_trampoline, IMPL, SIG);             \
+    HPyFunc_TRAMPOLINE(SYM##_trampoline, IMPL, SIG);                    \
     HPyDef SYM = {                                                      \
         .kind = HPyDef_Kind_Meth,                                       \
         .meth = {                                                       \
@@ -150,7 +157,7 @@ typedef struct {
         }                                                               \
     };
 
-#define HPyDef_METH(SYM, NAME, SIG, ...)       \
+#define HPyDef_METH(SYM, NAME, SIG, ...) \
     HPyDef_METH_IMPL(SYM, NAME, SYM##_impl, SIG, __VA_ARGS__)
 
 #define HPyDef_MEMBER(SYM, NAME, TYPE, OFFSET, ...) \
@@ -164,9 +171,9 @@ typedef struct {
         }                                           \
     };
 
-#define HPyDef_GET_IMPL(SYM, NAME, GETIMPL, ...)                                     \
+#define HPyDef_GET_IMPL(SYM, NAME, GETIMPL, ...)                                \
     HPyFunc_DECLARE(GETIMPL, HPyFunc_GETTER);                                   \
-    HPyFunc_TRAMPOLINE(SYM##_get_trampoline, GETIMPL, HPyFunc_GETTER); \
+    HPyFunc_TRAMPOLINE(SYM##_get_trampoline, GETIMPL, HPyFunc_GETTER);          \
     HPyDef SYM = {                                                              \
         .kind = HPyDef_Kind_GetSet,                                             \
         .getset = {                                                             \
@@ -177,12 +184,12 @@ typedef struct {
         }                                                                       \
     };
 
-#define HPyDef_GET(SYM, NAME, ...)         \
+#define HPyDef_GET(SYM, NAME, ...) \
     HPyDef_GET_IMPL(SYM, NAME, SYM##_get, __VA_ARGS__)
 
-#define HPyDef_SET_IMPL(SYM, NAME, SETIMPL, ...)                                     \
+#define HPyDef_SET_IMPL(SYM, NAME, SETIMPL, ...)                                \
     HPyFunc_DECLARE(SETIMPL, HPyFunc_SETTER);                                   \
-    HPyFunc_TRAMPOLINE(SYM##_set_trampoline, SETIMPL, HPyFunc_SETTER); \
+    HPyFunc_TRAMPOLINE(SYM##_set_trampoline, SETIMPL, HPyFunc_SETTER);          \
     HPyDef SYM = {                                                              \
         .kind = HPyDef_Kind_GetSet,                                             \
         .getset = {                                                             \
@@ -193,14 +200,14 @@ typedef struct {
         }                                                                       \
     };
 
-#define HPyDef_SET(SYM, NAME, ...)      \
+#define HPyDef_SET(SYM, NAME, ...) \
     HPyDef_SET_IMPL(SYM, NAME, SYM##_set, __VA_ARGS__)
 
-#define HPyDef_GETSET_IMPL(SYM, NAME, GETIMPL, SETIMPL, ...)                         \
+#define HPyDef_GETSET_IMPL(SYM, NAME, GETIMPL, SETIMPL, ...)                    \
     HPyFunc_DECLARE(GETIMPL, HPyFunc_GETTER);                                   \
-    HPyFunc_TRAMPOLINE(SYM##_get_trampoline, GETIMPL, HPyFunc_GETTER); \
+    HPyFunc_TRAMPOLINE(SYM##_get_trampoline, GETIMPL, HPyFunc_GETTER);          \
     HPyFunc_DECLARE(SETIMPL, HPyFunc_SETTER);                                   \
-    HPyFunc_TRAMPOLINE(SYM##_set_trampoline, SETIMPL, HPyFunc_SETTER); \
+    HPyFunc_TRAMPOLINE(SYM##_set_trampoline, SETIMPL, HPyFunc_SETTER);          \
     HPyDef SYM = {                                                              \
         .kind = HPyDef_Kind_GetSet,                                             \
         .getset = {                                                             \
@@ -213,9 +220,17 @@ typedef struct {
         }                                                                       \
     };
 
-#define HPyDef_GETSET(SYM, NAME, ...)      \
+#define HPyDef_GETSET(SYM, NAME, ...) \
     HPyDef_GETSET_IMPL(SYM, NAME, SYM##_get, SYM##_set, __VA_ARGS__)
 
+#define HPyCapsule_DESTRUCTOR(SYM)                                             \
+    static void SYM##_impl(const char *name, void *pointer, void *context);    \
+    HPyCapsule_DESTRUCTOR_TRAMPOLINE(SYM##_trampoline, SYM##_impl);            \
+    static HPyCapsule_Destructor SYM = {                                       \
+        .cpy_trampoline = SYM##_trampoline,                                    \
+        .impl = SYM##_impl                                                     \
+    };
+
 #ifdef __cplusplus
 }
 #endif

diff --git a/hpy/devel/include/hpy/hpyfunc.h b/hpy/devel/include/hpy/hpyfunc.h
@@ -39,6 +39,7 @@ typedef enum {
     HPyFunc_OBJOBJPROC,
     HPyFunc_TRAVERSEPROC,
     HPyFunc_DESTRUCTOR,
+    HPyFunc_CAPSULE_DESTRUCTOR,
 
 } HPyFunc_Signature;
 

diff --git a/hpy/devel/include/hpy/runtime/ctx_funcs.h b/hpy/devel/include/hpy/runtime/ctx_funcs.h
@@ -60,12 +60,10 @@ _HPy_HIDDEN HPy ctx_Tuple_FromArray(HPyContext *ctx, HPy items[], HPy_ssize_t n)
 _HPy_HIDDEN HPy ctx_Capsule_New(HPyContext *ctx,
                                 void *pointer,
                                 const char *name,
-                                HPyCapsule_Destructor destructor);
-_HPy_HIDDEN HPyCapsule_Destructor ctx_Capsule_GetDestructor(HPyContext *ctx,
-                                                            HPy h_capsule);
+                                HPyCapsule_Destructor *destructor);
 _HPy_HIDDEN int ctx_Capsule_SetDestructor(HPyContext *ctx,
                                           HPy h_capsule,
-                                          HPyCapsule_Destructor destructor);
+                                          HPyCapsule_Destructor *destructor);
 #ifdef HPY_UNIVERSAL_ABI
 _HPy_HIDDEN void* ctx_Capsule_Get(HPyContext *ctx,
                                   HPy capsule,

diff --git a/hpy/devel/include/hpy/universal/autogen_ctx.h b/hpy/devel/include/hpy/universal/autogen_ctx.h
diff --git a/hpy/devel/include/hpy/universal/autogen_trampolines.h b/hpy/devel/include/hpy/universal/autogen_trampolines.h
diff --git a/hpy/devel/include/hpy/universal/hpyfunc_trampolines.h b/hpy/devel/include/hpy/universal/hpyfunc_trampolines.h
@@ -160,6 +160,12 @@ typedef struct {
         return a.result; \
     }
 
+#define HPyCapsule_DESTRUCTOR_TRAMPOLINE(SYM, IMPL)                            \
+    static void SYM(cpy_PyObject *capsule)                                     \
+    {                                                                          \
+        _HPy_CallRealFunctionFromTrampoline(_ctx_for_trampolines,              \
+                HPyFunc_CAPSULE_DESTRUCTOR, (HPyCFunction)IMPL, capsule);      \
+    }
 
 
 #endif // HPY_UNIVERSAL_HPYFUNC_TRAMPOLINES_H
diff --git a/hpy/devel/include/hpy/universal/misc_trampolines.h b/hpy/devel/include/hpy/universal/misc_trampolines.h
@@ -54,13 +54,6 @@ HPyCapsule_GetContext(HPyContext *ctx, HPy capsule)
             ctx, capsule, HPyCapsule_key_Context, NULL);
 }
 
-static inline HPyCapsule_Destructor
-HPyCapsule_GetDestructor(HPyContext *ctx, HPy capsule)
-{
-    return (HPyCapsule_Destructor) ctx->ctx_Capsule_Get(
-            ctx, capsule, HPyCapsule_key_Destructor, NULL);
-}
-
 static inline int
 HPyCapsule_SetPointer(HPyContext *ctx, HPy capsule, void *pointer)
 {
@@ -84,7 +77,7 @@ HPyCapsule_SetContext(HPyContext *ctx, HPy capsule, void *context)
 
 static inline int
 HPyCapsule_SetDestructor(HPyContext *ctx, HPy capsule,
-        HPyCapsule_Destructor destructor)
+        HPyCapsule_Destructor *destructor)
 {
     return ctx->ctx_Capsule_Set(
             ctx, capsule, HPyCapsule_key_Destructor, (void *) destructor);