Skip to content

[WIP, DO NOT MERGE] bpo-41188: Prepare CPython for opague PyObject structure. #21262

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
WildCard65 wants to merge 6 commits into from
Closed

[WIP, DO NOT MERGE] bpo-41188: Prepare CPython for opague PyObject structure. #21262

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3d5826b
Added new type member 'tp_obj_offset'.
WildCard65 Jul 1, 2020
ff05339
Added static library "slib_pythoncore" to act as a medium between CPy…
WildCard65 Jul 1, 2020
8aa000e
Added basic implementation of "Py_TPFLAGS_OMIT_PYOBJECT_SIZE".
WildCard65 Jul 2, 2020
8774b02
Fixed GCC error
WildCard65 Jul 2, 2020
da3b98a
Add forgotten member documentation.
WildCard65 Jul 2, 2020
686d657
Trick PyObject into believing it's an opaque type.
WildCard65 Jul 2, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Added new type member 'tp_obj_offset'. 
This member is the companion member required for 'Py_TPFLAGS_USES_OPAQUE_OBJECT' flag.
  • Loading branch information
@WildCard65
WildCard65 committed Jul 1, 2020
commit 3d5826b52e7c916b496151bea2dae6211b0cc90e
8 changes: 8 additions & 0 deletions Doc/c-api/typeobj.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,8 @@ Quick Reference
+------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
| :c:member:`~PyTypeObject.tp_vectorcall` | :c:type:`vectorcallfunc` | | | | | |
+------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
| :c:member:`~PyTypeObject.tp_obj_offset` | const Py_ssize_t | | | X | ~ | |
+------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+

.. [#slots]
A slot name in parentheses indicates it is (effectively) deprecated.
Expand Down Expand Up @@ -1015,6 +1017,12 @@ and :c:type:`PyType_Type` effectively act as defaults.)
:c:func:`PyType_HasFeature` takes a type and a flags value, *tp* and *f*, and
checks whether ``tp->tp_flags & f`` is non-zero.

.. data:: Py_TPFLAGS_USES_OPAQUE_OBJECT

This bit is set when the type object's :c:member:`PyTypeObject.tp_basicsize` is configured
for an opaque :c:type:`PyObject` structure. The value of :c:member:`PyTypeObject.tp_basicsize` is the size of the type's
internal object structure EXCLUDING the base type's structure size.

.. data:: Py_TPFLAGS_HEAPTYPE

This bit is set when the type object itself is allocated on the heap, for
Expand Down
2 changes: 2 additions & 0 deletions Include/cpython/object.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -263,6 +263,8 @@ struct _typeobject {

destructor tp_finalize;
vectorcallfunc tp_vectorcall;
/* INTERNAL USE ONLY! MODIFYING THIS CAN CRASH PYTHON! */
const Py_ssize_t tp_obj_offset;
};

/* The *real* layout of a type object when allocated on the heap */
Expand Down
3 changes: 3 additions & 0 deletions Include/object.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -317,6 +317,9 @@ Code can use PyType_HasFeature(type_ob, flag_value) to test whether the
given type object has a specified feature.
*/

/* Set if the type object's tp_basicsize is set for opague object */
#define Py_TPFLAGS_OPAQUE_OBJECT (1UL << 8)
Copy link
Copy Markdown
Member

@vstinner vstinner Jul 1, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would prefer a more explicit name, lilke: Py_TPFLAGS_OMIT_PYOBJECT_SIZE.


/* Set if the type object is dynamically allocated */
#define Py_TPFLAGS_HEAPTYPE (1UL << 9)

Expand Down