[GR-40343] Various C API changes that improve opaqueness of the API.

PullRequest: graalpython/2394

Author: fangerer

graalpython/com.oracle.graal.python.cext/include/boolobject.h

@@ -1,4 +1,4 @@
-/* Copyright (c) 2018, 2021, Oracle and/or its affiliates.
+/* Copyright (c) 2018, 2022, Oracle and/or its affiliates.
  * Copyright (C) 1996-2017 Python Software Foundation
  *
  * Licensed under the PYTHON SOFTWARE FOUNDATION LICENSE VERSION 2
@@ -20,11 +20,14 @@ PyAPI_DATA(PyTypeObject) PyBool_Type;
 Don't forget to apply Py_INCREF() when returning either!!! */
 
 /* Don't use these directly */
-PyAPI_DATA(struct _longobject) _Py_FalseStruct, _Py_TrueStruct;
+PyAPI_DATA(struct _longobject*) _Py_FalseStructReference;
+PyAPI_DATA(struct _longobject*) _Py_TrueStructReference;
+#define _Py_TrueStruct (*_Py_TrueStructReference)
+#define _Py_FalseStruct (*_Py_FalseStructReference)
 
 /* Use these macros */
-#define Py_False ((PyObject *) &_Py_FalseStruct)
-#define Py_True ((PyObject *) &_Py_TrueStruct)
+#define Py_False ((PyObject *) _Py_FalseStructReference)
+#define Py_True ((PyObject *) _Py_TrueStructReference)
 
 /* Macros for returning Py_True or Py_False, respectively */
 #define Py_RETURN_TRUE return Py_INCREF(Py_True), Py_True

graalpython/com.oracle.graal.python.cext/include/classobject.h

@@ -1,4 +1,4 @@
-/* Copyright (c) 2018, 2021, Oracle and/or its affiliates.
+/* Copyright (c) 2018, 2022, Oracle and/or its affiliates.
  * Copyright (C) 1996-2020 Python Software Foundation
  *
  * Licensed under the PYTHON SOFTWARE FOUNDATION LICENSE VERSION 2
@@ -24,7 +24,7 @@ typedef struct {
 
 PyAPI_DATA(PyTypeObject) PyMethod_Type;
 
-#define PyMethod_Check(op) ((op)->ob_type == &PyMethod_Type)
+#define PyMethod_Check(op) (Py_TYPE(op) == &PyMethod_Type)
 
 PyAPI_FUNC(PyObject *) PyMethod_New(PyObject *, PyObject *);
 
@@ -47,7 +47,7 @@ typedef struct {
 
 PyAPI_DATA(PyTypeObject) PyInstanceMethod_Type;
 
-#define PyInstanceMethod_Check(op) ((op)->ob_type == &PyInstanceMethod_Type)
+#define PyInstanceMethod_Check(op) (Py_TYPE(op) == &PyInstanceMethod_Type)
 
 PyAPI_FUNC(PyObject *) PyInstanceMethod_New(PyObject *);
 PyAPI_FUNC(PyObject *) PyInstanceMethod_Function(PyObject *);

graalpython/com.oracle.graal.python.cext/include/cpython/abstract.h

@@ -1,4 +1,4 @@
-/* Copyright (c) 2020, 2021, Oracle and/or its affiliates.
+/* Copyright (c) 2020, 2022, Oracle and/or its affiliates.
  * Copyright (C) 1996-2020 Python Software Foundation
  *
  * Licensed under the PYTHON SOFTWARE FOUNDATION LICENSE VERSION 2
@@ -130,7 +130,7 @@ _PyObject_Vectorcall(PyObject *callable, PyObject *const *args,
         return _PyObject_MakeTpCall(callable, args, nargs, kwnames);
     }
     res = func(callable, args, nargsf, kwnames);
-    return _Py_CheckFunctionResult(callable, res, NULL);
+    return res; // _Py_CheckFunctionResult(callable, res, NULL);
 }
 
 /* Same as _PyObject_Vectorcall except that keyword arguments are passed as
@@ -197,8 +197,8 @@ PyAPI_FUNC(Py_ssize_t) PyObject_LengthHint(PyObject *o, Py_ssize_t);
 
 /* Return 1 if the getbuffer function is available, otherwise return 0. */
 #define PyObject_CheckBuffer(obj) \
-    (((obj)->ob_type->tp_as_buffer != NULL) &&  \
-     ((obj)->ob_type->tp_as_buffer->bf_getbuffer != NULL))
+    ((Py_TYPE(obj)->tp_as_buffer != NULL) &&  \
+     (Py_TYPE(obj)->tp_as_buffer->bf_getbuffer != NULL))
 
 /* This is a C-API version of the getbuffer function call.  It checks
    to make sure object has the required function pointer and issues the
@@ -266,14 +266,14 @@ PyAPI_FUNC(void) PyBuffer_Release(Py_buffer *view);
 /* ==== Iterators ================================================ */
 
 #define PyIter_Check(obj) \
-    ((obj)->ob_type->tp_iternext != NULL && \
-     (obj)->ob_type->tp_iternext != &_PyObject_NextNotImplemented)
+    (Py_TYPE(obj)->tp_iternext != NULL && \
+     Py_TYPE(obj)->tp_iternext != &_PyObject_NextNotImplemented)
 
 /* === Number Protocol ================================================== */
 
 #define PyIndex_Check(obj)                              \
-    ((obj)->ob_type->tp_as_number != NULL &&            \
-     (obj)->ob_type->tp_as_number->nb_index != NULL)
+    (Py_TYPE(obj)->tp_as_number != NULL &&            \
+     Py_TYPE(obj)->tp_as_number->nb_index != NULL)
 
 /* === Sequence protocol ================================================ */
 

graalpython/com.oracle.graal.python.cext/include/object.h

@@ -1,4 +1,4 @@
-/* Copyright (c) 2018, 2021, Oracle and/or its affiliates.
+/* Copyright (c) 2018, 2022, Oracle and/or its affiliates.
  * Copyright (C) 1996-2020 Python Software Foundation
  *
  * Licensed under the PYTHON SOFTWARE FOUNDATION LICENSE VERSION 2
@@ -123,9 +123,22 @@ typedef struct {
 /* Cast argument to PyVarObject* type. */
 #define _PyVarObject_CAST(op) ((PyVarObject*)(op))
 
-#define Py_REFCNT(ob)           (_PyObject_CAST(ob)->ob_refcnt)
-#define Py_TYPE(ob)             (_PyObject_CAST(ob)->ob_type)
-#define Py_SIZE(ob)             (_PyVarObject_CAST(ob)->ob_size)
+PyAPI_FUNC(Py_ssize_t) _Py_REFCNT(PyObject *);
+PyAPI_FUNC(void) _Py_SET_REFCNT(PyObject*, Py_ssize_t);
+PyAPI_FUNC(struct _typeobject*) _Py_TYPE(PyObject *);
+PyAPI_FUNC(void) _Py_SET_TYPE(PyObject *, struct _typeobject *);
+PyAPI_FUNC(Py_ssize_t) _Py_SIZE(PyVarObject *);
+PyAPI_FUNC(void) _Py_SET_SIZE(PyVarObject *, Py_ssize_t);
+
+#define Py_REFCNT(ob)           (_Py_REFCNT(_PyObject_CAST(ob)))
+#define Py_SET_REFCNT(ob, v)    (_Py_SET_REFCNT(_PyObject_CAST(ob), v))
+#define Py_TYPE(ob)             (_Py_TYPE(_PyObject_CAST(ob)))
+#define Py_SIZE(ob)             (_Py_SIZE(_PyVarObject_CAST(ob)))
+
+#define Py_SET_TYPE(ob, v)      (_Py_SET_TYPE(_PyObject_CAST(ob), (struct _typeobject *) v))
+#define Py_SET_SIZE(ob, v)      (_Py_SET_SIZE(_PyVarObject_CAST(ob), (Py_ssize_t) v))
+
+#define Py_IS_TYPE(ob, type) (Py_TYPE(ob) == (type))
 
 /*
 Type objects contain a string containing the type name (to help somewhat
@@ -445,7 +458,7 @@ static inline void _Py_NewReference(PyObject *op)
     }
     _Py_INC_TPALLOCS(op);
     _Py_INC_REFTOTAL;
-    Py_REFCNT(op) = 1;
+    Py_SET_REFCNT(op, 1);
 }
 
 static inline void _Py_ForgetReference(PyObject *op)
@@ -562,8 +575,9 @@ where NULL (nil) is not suitable (since NULL often means 'error').
 
 Don't forget to apply Py_INCREF() when returning this value!!!
 */
-PyAPI_DATA(PyObject) _Py_NoneStruct; /* Don't use this directly */
-#define Py_None (&_Py_NoneStruct)
+PyAPI_DATA(PyObject*) _Py_NoneStructReference; /* Don't use this directly */
+#define _Py_NoneStruct (*_Py_NoneStructReference)
+#define Py_None (_Py_NoneStructReference)
 
 /* Macro for returning Py_None from a function */
 #define Py_RETURN_NONE return Py_INCREF(Py_None), Py_None
@@ -572,8 +586,9 @@ PyAPI_DATA(PyObject) _Py_NoneStruct; /* Don't use this directly */
 Py_NotImplemented is a singleton used to signal that an operation is
 not implemented for a given type combination.
 */
-PyAPI_DATA(PyObject) _Py_NotImplementedStruct; /* Don't use this directly */
-#define Py_NotImplemented (&_Py_NotImplementedStruct)
+PyAPI_DATA(PyObject*) _Py_NotImplementedStructReference; /* Don't use this directly */
+#define _Py_NotImplementedStruct (*_Py_NotImplementedStructReference)
+#define Py_NotImplemented (_Py_NotImplementedStructReference)
 
 /* Macro for returning Py_NotImplemented from a function */
 #define Py_RETURN_NOTIMPLEMENTED \

graalpython/com.oracle.graal.python.cext/include/objimpl.h

@@ -1,4 +1,4 @@
-/* Copyright (c) 2018, 2021, Oracle and/or its affiliates.
+/* Copyright (c) 2018, 2022, Oracle and/or its affiliates.
  * Copyright (C) 1996-2020 Python Software Foundation
  *
  * Licensed under the PYTHON SOFTWARE FOUNDATION LICENSE VERSION 2
@@ -142,7 +142,7 @@ static inline PyObject*
 _PyObject_INIT(PyObject *op, PyTypeObject *typeobj)
 {
     assert(op != NULL);
-    Py_TYPE(op) = typeobj;
+    Py_SET_TYPE(op, typeobj);
     if (PyType_GetFlags(typeobj) & Py_TPFLAGS_HEAPTYPE) {
         Py_INCREF(typeobj);
     }
@@ -157,7 +157,7 @@ static inline PyVarObject*
 _PyObject_INIT_VAR(PyVarObject *op, PyTypeObject *typeobj, Py_ssize_t size)
 {
     assert(op != NULL);
-    Py_SIZE(op) = size;
+    Py_SET_SIZE(op, size);
     PyObject_INIT((PyObject *)op, typeobj);
     return op;
 }

graalpython/com.oracle.graal.python.cext/include/pycapsule.h

@@ -1,4 +1,4 @@
-/* Copyright (c) 2018, 2021, Oracle and/or its affiliates.
+/* Copyright (c) 2018, 2022, Oracle and/or its affiliates.
  * Copyright (C) 1996-2017 Python Software Foundation
  *
  * Licensed under the PYTHON SOFTWARE FOUNDATION LICENSE VERSION 2
@@ -22,7 +22,8 @@
 extern "C" {
 #endif
 
-PyAPI_DATA(PyTypeObject) PyCapsule_Type;
+PyAPI_DATA(PyTypeObject*) PyCapsule_TypeReference;
+#define PyCapsule_Type (*PyCapsule_TypeReference)
 
 typedef void (*PyCapsule_Destructor)(PyObject *);
 

graalpython/com.oracle.graal.python.cext/include/pyerrors.h

@@ -1,4 +1,4 @@
-/* Copyright (c) 2018, 2021, Oracle and/or its affiliates.
+/* Copyright (c) 2018, 2022, Oracle and/or its affiliates.
  * Copyright (C) 1996-2020 Python Software Foundation
  *
  * Licensed under the PYTHON SOFTWARE FOUNDATION LICENSE VERSION 2
@@ -59,11 +59,11 @@ PyAPI_FUNC(void) PyException_SetContext(PyObject *, PyObject *);
      PyType_FastSubclass((PyTypeObject*)(x), Py_TPFLAGS_BASE_EXC_SUBCLASS))
 
 #define PyExceptionInstance_Check(x)                    \
-    PyType_FastSubclass((x)->ob_type, Py_TPFLAGS_BASE_EXC_SUBCLASS)
+    PyType_FastSubclass(Py_TYPE(x), Py_TPFLAGS_BASE_EXC_SUBCLASS)
 
 PyAPI_FUNC(const char *) PyExceptionClass_Name(PyObject *);
 
-#define PyExceptionInstance_Class(x) ((PyObject*)((x)->ob_type))
+#define PyExceptionInstance_Class(x) ((PyObject*)(Py_TYPE(x)))
 
 
 /* Predefined exceptions */

graalpython/com.oracle.graal.python.cext/include/sliceobject.h

@@ -1,4 +1,4 @@
-/* Copyright (c) 2018, 2021, Oracle and/or its affiliates.
+/* Copyright (c) 2018, 2022, Oracle and/or its affiliates.
  * Copyright (C) 1996-2020 Python Software Foundation
  *
  * Licensed under the PYTHON SOFTWARE FOUNDATION LICENSE VERSION 2
@@ -11,9 +11,10 @@ extern "C" {
 
 /* The unique ellipsis object "..." */
 
-PyAPI_DATA(PyObject) _Py_EllipsisObject; /* Don't use this directly */
+PyAPI_DATA(PyObject*) _Py_EllipsisObjectReference; /* Don't use this directly */
 
-#define Py_Ellipsis (&_Py_EllipsisObject)
+#define _Py_EllipsisObject (*_Py_EllipsisObjectReference)
+#define Py_Ellipsis (_Py_EllipsisObjectReference)
 
 /* Slice object interface */
 

graalpython/com.oracle.graal.python.cext/modules/_cpython_struct.c

@@ -1,4 +1,4 @@
-/* Copyright (c) 2018, 2021, Oracle and/or its affiliates.
+/* Copyright (c) 2018, 2022, Oracle and/or its affiliates.
  * Copyright (C) 1996-2020 Python Software Foundation
  *
  * Licensed under the PYTHON SOFTWARE FOUNDATION LICENSE VERSION 2
@@ -11,7 +11,7 @@
 
 #define PY_SSIZE_T_CLEAN
 
-#include "Python.h"
+#include "capi.h"
 #include "structmember.h"
 #include <ctype.h>
 
@@ -1285,6 +1285,7 @@ align(Py_ssize_t size, char c, const formatdef *e)
 static int
 prepare_s(PyStructObject *self)
 {
+	self = native_pointer_to_java(self);
     const formatdef *f;
     const formatdef *e;
     formatcode *codes;
@@ -1294,9 +1295,10 @@ prepare_s(PyStructObject *self)
     char c;
     Py_ssize_t size, len, num, itemsize;
     size_t ncodes;
+    PyObject* self_format = native_pointer_to_java(self->s_format);
 
-    fmt = PyBytes_AS_STRING(self->s_format);
-    if (strlen(fmt) != (size_t)PyBytes_GET_SIZE(self->s_format)) {
+    fmt = PyBytes_AS_STRING(self_format);
+    if (strlen(fmt) != (size_t)PyBytes_GET_SIZE(self_format)) {
         PyErr_SetString(StructError, "embedded null character");
         return -1;
     }
@@ -1611,7 +1613,7 @@ Struct_unpack_from_impl(PyStructObject *self, Py_buffer *buffer,
                      buffer->len);
         return NULL;
     }
-    return s_unpack_internal(self, (char*)buffer->buf + offset);
+    return s_unpack_internal(self, (char*)native_pointer_to_java(buffer->buf) + offset);
 }
 
 
@@ -2084,7 +2086,10 @@ PyTypeObject PyStructType = {
 /* ---- Standalone functions  ---- */
 
 #define MAXCACHE 100
-static PyObject *cache = NULL;
+/* Please note: the name of the cache needs to be prefixed because this file
+   includes 'capi.h' which defines a global variable with name 'cache'. */
+#define STRUCT_CACHE _cpython_struct_cache
+static PyObject *STRUCT_CACHE = NULL;
 
 static int
 cache_struct_converter(PyObject *fmt, PyStructObject **ptr)
@@ -2097,13 +2102,13 @@ cache_struct_converter(PyObject *fmt, PyStructObject **ptr)
         return 1;
     }
 
-    if (cache == NULL) {
-        cache = PyDict_New();
-        if (cache == NULL)
+    if (STRUCT_CACHE == NULL) {
+        STRUCT_CACHE = PyDict_New();
+        if (STRUCT_CACHE == NULL)
             return 0;
     }
 
-    s_object = PyDict_GetItemWithError(cache, fmt);
+    s_object = PyDict_GetItemWithError(STRUCT_CACHE, fmt);
     if (s_object != NULL) {
         Py_INCREF(s_object);
         *ptr = (PyStructObject *)s_object;
@@ -2115,10 +2120,10 @@ cache_struct_converter(PyObject *fmt, PyStructObject **ptr)
 
     s_object = PyObject_CallFunctionObjArgs((PyObject *)(&PyStructType), fmt, NULL);
     if (s_object != NULL) {
-        if (PyDict_GET_SIZE(cache) >= MAXCACHE)
-            PyDict_Clear(cache);
+        if (PyDict_GET_SIZE(STRUCT_CACHE) >= MAXCACHE)
+            PyDict_Clear(STRUCT_CACHE);
         /* Attempt to cache the result */
-        if (PyDict_SetItem(cache, fmt, s_object) == -1)
+        if (PyDict_SetItem(STRUCT_CACHE, fmt, s_object) == -1)
             PyErr_Clear();
         *ptr = (PyStructObject *)s_object;
         return Py_CLEANUP_SUPPORTED;
@@ -2136,7 +2141,7 @@ static PyObject *
 _clearcache_impl(PyObject *module)
 /*[clinic end generated code: output=ce4fb8a7bf7cb523 input=463eaae04bab3211]*/
 {
-    Py_CLEAR(cache);
+    Py_CLEAR(STRUCT_CACHE);
     Py_RETURN_NONE;
 }
 
@@ -2344,7 +2349,7 @@ PyInit__cpython_struct(void)
     if (m == NULL)
         return NULL;
 
-    Py_TYPE(&PyStructType) = &PyType_Type;
+    Py_SET_TYPE(&PyStructType, &PyType_Type);
     if (PyType_Ready(&PyStructType) < 0)
         return NULL;
 

graalpython/com.oracle.graal.python.cext/modules/_cpython_unicodedata.c

@@ -1,4 +1,4 @@
-/* Copyright (c) 2018, 2021, Oracle and/or its affiliates.
+/* Copyright (c) 2018, 2022, Oracle and/or its affiliates.
  * Copyright (C) 1996-2020 Python Software Foundation
  *
  * Licensed under the PYTHON SOFTWARE FOUNDATION LICENSE VERSION 2
@@ -1460,7 +1460,7 @@ PyInit__cpython_unicodedata(void)
 {
     PyObject *m, *v;
 
-    Py_TYPE(&UCD_Type) = &PyType_Type;
+    Py_SET_TYPE(&UCD_Type, &PyType_Type);
 
     m = PyModule_Create(&unicodedatamodule);
     if (!m)