123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145 |
- #ifndef Py_CPYTHON_OBJIMPL_H
- # error "this header file must not be included directly"
- #endif
- #ifdef __cplusplus
- extern "C" {
- #endif
- #define _PyObject_SIZE(typeobj) ( (typeobj)->tp_basicsize )
- /* _PyObject_VAR_SIZE returns the number of bytes (as size_t) allocated for a
- vrbl-size object with nitems items, exclusive of gc overhead (if any). The
- value is rounded up to the closest multiple of sizeof(void *), in order to
- ensure that pointer fields at the end of the object are correctly aligned
- for the platform (this is of special importance for subclasses of, e.g.,
- str or int, so that pointers can be stored after the embedded data).
- Note that there's no memory wastage in doing this, as malloc has to
- return (at worst) pointer-aligned memory anyway.
- */
- #if ((SIZEOF_VOID_P - 1) & SIZEOF_VOID_P) != 0
- # error "_PyObject_VAR_SIZE requires SIZEOF_VOID_P be a power of 2"
- #endif
- #define _PyObject_VAR_SIZE(typeobj, nitems) \
- _Py_SIZE_ROUND_UP((typeobj)->tp_basicsize + \
- (nitems)*(typeobj)->tp_itemsize, \
- SIZEOF_VOID_P)
- /* This example code implements an object constructor with a custom
- allocator, where PyObject_New is inlined, and shows the important
- distinction between two steps (at least):
- 1) the actual allocation of the object storage;
- 2) the initialization of the Python specific fields
- in this storage with PyObject_{Init, InitVar}.
- PyObject *
- YourObject_New(...)
- {
- PyObject *op;
- op = (PyObject *) Your_Allocator(_PyObject_SIZE(YourTypeStruct));
- if (op == NULL)
- return PyErr_NoMemory();
- PyObject_Init(op, &YourTypeStruct);
- op->ob_field = value;
- ...
- return op;
- }
- Note that in C++, the use of the new operator usually implies that
- the 1st step is performed automatically for you, so in a C++ class
- constructor you would start directly with PyObject_Init/InitVar. */
- /* Inline functions trading binary compatibility for speed:
- PyObject_INIT() is the fast version of PyObject_Init(), and
- PyObject_INIT_VAR() is the fast version of PyObject_InitVar().
- These inline functions must not be called with op=NULL. */
- static inline PyObject*
- _PyObject_INIT(PyObject *op, PyTypeObject *typeobj)
- {
- assert(op != NULL);
- Py_SET_TYPE(op, typeobj);
- if (PyType_GetFlags(typeobj) & Py_TPFLAGS_HEAPTYPE) {
- Py_INCREF(typeobj);
- }
- _Py_NewReference(op);
- return op;
- }
- #define PyObject_INIT(op, typeobj) \
- _PyObject_INIT(_PyObject_CAST(op), (typeobj))
- static inline PyVarObject*
- _PyObject_INIT_VAR(PyVarObject *op, PyTypeObject *typeobj, Py_ssize_t size)
- {
- assert(op != NULL);
- Py_SET_SIZE(op, size);
- PyObject_INIT((PyObject *)op, typeobj);
- return op;
- }
- #define PyObject_INIT_VAR(op, typeobj, size) \
- _PyObject_INIT_VAR(_PyVarObject_CAST(op), (typeobj), (size))
- /* This function returns the number of allocated memory blocks, regardless of size */
- PyAPI_FUNC(Py_ssize_t) _Py_GetAllocatedBlocks(void);
- /* Macros */
- #ifdef WITH_PYMALLOC
- PyAPI_FUNC(int) _PyObject_DebugMallocStats(FILE *out);
- #endif
- typedef struct {
- /* user context passed as the first argument to the 2 functions */
- void *ctx;
- /* allocate an arena of size bytes */
- void* (*alloc) (void *ctx, size_t size);
- /* free an arena */
- void (*free) (void *ctx, void *ptr, size_t size);
- } PyObjectArenaAllocator;
- /* Get the arena allocator. */
- PyAPI_FUNC(void) PyObject_GetArenaAllocator(PyObjectArenaAllocator *allocator);
- /* Set the arena allocator. */
- PyAPI_FUNC(void) PyObject_SetArenaAllocator(PyObjectArenaAllocator *allocator);
- PyAPI_FUNC(Py_ssize_t) _PyGC_CollectNoFail(void);
- PyAPI_FUNC(Py_ssize_t) _PyGC_CollectIfEnabled(void);
- /* Test if an object implements the garbage collector protocol */
- PyAPI_FUNC(int) PyObject_IS_GC(PyObject *obj);
- /* Code built with Py_BUILD_CORE must include pycore_gc.h instead which
- defines a different _PyGC_FINALIZED() macro. */
- #ifndef Py_BUILD_CORE
- // Kept for backward compatibility with Python 3.8
- # define _PyGC_FINALIZED(o) PyObject_GC_IsFinalized(o)
- #endif
- PyAPI_FUNC(PyObject *) _PyObject_GC_Malloc(size_t size);
- PyAPI_FUNC(PyObject *) _PyObject_GC_Calloc(size_t size);
- /* Test if a type supports weak references */
- #define PyType_SUPPORTS_WEAKREFS(t) ((t)->tp_weaklistoffset > 0)
- PyAPI_FUNC(PyObject **) PyObject_GET_WEAKREFS_LISTPTR(PyObject *op);
- #ifdef __cplusplus
- }
- #endif
|