Skip to content

Commit

Permalink
gh-91320: Add _Py_reinterpret_cast() macro (#91959)
Browse files Browse the repository at this point in the history
Fix C++ compiler warnings about "old-style cast"
(g++ -Wold-style-cast) in the Python C API.  Use C++
reinterpret_cast<> and static_cast<> casts when the Python C API is
used in C++.

Example of fixed warning:

    Include/object.h:107:43: error: use of old-style cast to
    ‘PyObject*’ {aka ‘struct _object*’} [-Werror=old-style-cast]
    #define _PyObject_CAST(op) ((PyObject*)(op))

Add _Py_reinterpret_cast() and _Py_static_cast() macros.
  • Loading branch information
vstinner committed Apr 27, 2022
1 parent f882d33 commit 29e2245
Show file tree
Hide file tree
Showing 10 changed files with 42 additions and 17 deletions.
3 changes: 2 additions & 1 deletion Include/cpython/abstract.h
Expand Up @@ -50,7 +50,8 @@ PyAPI_FUNC(PyObject *) _PyObject_MakeTpCall(
PyObject *const *args, Py_ssize_t nargs,
PyObject *keywords);

#define PY_VECTORCALL_ARGUMENTS_OFFSET ((size_t)1 << (8 * sizeof(size_t) - 1))
#define PY_VECTORCALL_ARGUMENTS_OFFSET \
(_Py_static_cast(size_t, 1) << (8 * sizeof(size_t) - 1))

static inline Py_ssize_t
PyVectorcall_NARGS(size_t n)
Expand Down
3 changes: 2 additions & 1 deletion Include/cpython/listobject.h
Expand Up @@ -25,7 +25,8 @@ PyAPI_FUNC(PyObject *) _PyList_Extend(PyListObject *, PyObject *);
PyAPI_FUNC(void) _PyList_DebugMallocStats(FILE *out);

/* Cast argument to PyListObject* type. */
#define _PyList_CAST(op) (assert(PyList_Check(op)), (PyListObject *)(op))
#define _PyList_CAST(op) \
(assert(PyList_Check(op)), _Py_reinterpret_cast(PyListObject*, (op)))

// Macros and static inline functions, trading safety for speed

Expand Down
6 changes: 4 additions & 2 deletions Include/cpython/methodobject.h
Expand Up @@ -8,9 +8,11 @@ PyAPI_DATA(PyTypeObject) PyCMethod_Type;
#define PyCMethod_Check(op) PyObject_TypeCheck(op, &PyCMethod_Type)

#define _PyCFunctionObject_CAST(func) \
(assert(PyCFunction_Check(func)), (PyCFunctionObject *)(func))
(assert(PyCFunction_Check(func)), \
_Py_reinterpret_cast(PyCFunctionObject*, (func)))
#define _PyCMethodObject_CAST(func) \
(assert(PyCMethod_Check(func)), (PyCMethodObject *)(func))
(assert(PyCMethod_Check(func)), \
_Py_reinterpret_cast(PyCMethodObject*, (func)))

/* Macros for direct access to these values. Type checks are *not*
done, so use with care. */
Expand Down
3 changes: 2 additions & 1 deletion Include/cpython/tupleobject.h
Expand Up @@ -14,7 +14,8 @@ PyAPI_FUNC(int) _PyTuple_Resize(PyObject **, Py_ssize_t);
PyAPI_FUNC(void) _PyTuple_MaybeUntrack(PyObject *);

/* Cast argument to PyTupleObject* type. */
#define _PyTuple_CAST(op) (assert(PyTuple_Check(op)), (PyTupleObject *)(op))
#define _PyTuple_CAST(op) \
(assert(PyTuple_Check(op)), _Py_reinterpret_cast(PyTupleObject*, (op)))

// Macros and static inline functions, trading safety for speed

Expand Down
9 changes: 6 additions & 3 deletions Include/cpython/unicodeobject.h
Expand Up @@ -236,11 +236,14 @@ PyAPI_FUNC(int) _PyUnicode_CheckConsistency(


#define _PyASCIIObject_CAST(op) \
(assert(PyUnicode_Check(op)), (PyASCIIObject*)(op))
(assert(PyUnicode_Check(op)), \
_Py_reinterpret_cast(PyASCIIObject*, (op)))
#define _PyCompactUnicodeObject_CAST(op) \
(assert(PyUnicode_Check(op)), (PyCompactUnicodeObject*)(op))
(assert(PyUnicode_Check(op)), \
_Py_reinterpret_cast(PyCompactUnicodeObject*, (op)))
#define _PyUnicodeObject_CAST(op) \
(assert(PyUnicode_Check(op)), (PyUnicodeObject*)(op))
(assert(PyUnicode_Check(op)), \
_Py_reinterpret_cast(PyUnicodeObject*, (op)))


/* --- Flexible String Representation Helper Macros (PEP 393) -------------- */
Expand Down
4 changes: 3 additions & 1 deletion Include/methodobject.h
Expand Up @@ -42,7 +42,9 @@ typedef PyObject *(*PyCMethod)(PyObject *, PyTypeObject *, PyObject *const *,
// used to prevent a compiler warning. If the function has a single parameter,
// it triggers an undefined behavior when Python calls it with 2 parameters
// (bpo-33012).
#define _PyCFunction_CAST(func) ((PyCFunction)(void(*)(void))(func))
#define _PyCFunction_CAST(func) \
_Py_reinterpret_cast(PyCFunction, \
_Py_reinterpret_cast(void(*)(void), (func)))

PyAPI_FUNC(PyCFunction) PyCFunction_GetFunction(PyObject *);
PyAPI_FUNC(PyObject *) PyCFunction_GetSelf(PyObject *);
Expand Down
7 changes: 4 additions & 3 deletions Include/object.h
Expand Up @@ -104,15 +104,15 @@ struct _object {
};

/* Cast argument to PyObject* type. */
#define _PyObject_CAST(op) ((PyObject*)(op))
#define _PyObject_CAST(op) _Py_reinterpret_cast(PyObject*, (op))

typedef struct {
PyObject ob_base;
Py_ssize_t ob_size; /* Number of items in variable part */
} PyVarObject;

/* Cast argument to PyVarObject* type. */
#define _PyVarObject_CAST(op) ((PyVarObject*)(op))
#define _PyVarObject_CAST(op) _Py_reinterpret_cast(PyVarObject*, (op))


// Test if the 'x' object is the 'y' object, the same as "x is y" in Python.
Expand Down Expand Up @@ -780,7 +780,8 @@ static inline int PyType_Check(PyObject *op) {
# define PyType_Check(op) PyType_Check(_PyObject_CAST(op))
#endif

#define _PyType_CAST(op) (assert(PyType_Check(op)), (PyTypeObject*)(op))
#define _PyType_CAST(op) \
(assert(PyType_Check(op)), _Py_reinterpret_cast(PyTypeObject*, (op)))

static inline int PyType_CheckExact(PyObject *op) {
return Py_IS_TYPE(op, &PyType_Type);
Expand Down
4 changes: 2 additions & 2 deletions Include/objimpl.h
Expand Up @@ -182,9 +182,9 @@ PyAPI_FUNC(void) PyObject_GC_UnTrack(void *);
PyAPI_FUNC(void) PyObject_GC_Del(void *);

#define PyObject_GC_New(type, typeobj) \
( (type *) _PyObject_GC_New(typeobj) )
_Py_reinterpret_cast(type*, _PyObject_GC_New(typeobj))
#define PyObject_GC_NewVar(type, typeobj, n) \
( (type *) _PyObject_GC_NewVar((typeobj), (n)) )
_Py_reinterpret_cast(type*, _PyObject_GC_NewVar((typeobj), (n)))

PyAPI_FUNC(int) PyObject_GC_IsTracked(PyObject *);
PyAPI_FUNC(int) PyObject_GC_IsFinalized(PyObject *);
Expand Down
17 changes: 14 additions & 3 deletions Include/pyport.h
Expand Up @@ -14,6 +14,16 @@
#endif


// Macro to use C++ static_cast<> and reinterpret_cast<> in the Python C API
#ifdef __cplusplus
# define _Py_static_cast(type, expr) static_cast<type>(expr)
# define _Py_reinterpret_cast(type, expr) reinterpret_cast<type>(expr)
#else
# define _Py_static_cast(type, expr) ((type)(expr))
# define _Py_reinterpret_cast(type, expr) ((type)(expr))
#endif


/* Defines to build Python and its standard library:
*
* - Py_BUILD_CORE: Build Python core. Give access to Python internals, but
Expand Down Expand Up @@ -295,10 +305,11 @@ extern "C" {
* VALUE may be evaluated more than once.
*/
#ifdef Py_DEBUG
#define Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW) \
(assert((WIDE)(NARROW)(VALUE) == (VALUE)), (NARROW)(VALUE))
# define Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW) \
(assert((WIDE)(NARROW)(VALUE) == (VALUE)), (NARROW)(VALUE))
#else
#define Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW) (NARROW)(VALUE)
# define Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW) \
_Py_reinterpret_cast(NARROW, (VALUE))
#endif


Expand Down
@@ -0,0 +1,3 @@
Fix C++ compiler warnings about "old-style cast" (``g++ -Wold-style-cast``) in
the Python C API. Use C++ ``reinterpret_cast<>`` and ``static_cast<>`` casts
when the Python C API is used in C++. Patch by Victor Stinner.

0 comments on commit 29e2245

Please sign in to comment.