+++ /dev/null
-/* An arena-like memory interface for the compiler.\r
- */\r
-\r
-#ifndef Py_PYARENA_H\r
-#define Py_PYARENA_H\r
-\r
-#ifdef __cplusplus\r
-extern "C" {\r
-#endif\r
-\r
- typedef struct _arena PyArena;\r
-\r
- /* PyArena_New() and PyArena_Free() create a new arena and free it,\r
- respectively. Once an arena has been created, it can be used\r
- to allocate memory via PyArena_Malloc(). Pointers to PyObject can\r
- also be registered with the arena via PyArena_AddPyObject(), and the\r
- arena will ensure that the PyObjects stay alive at least until\r
- PyArena_Free() is called. When an arena is freed, all the memory it\r
- allocated is freed, the arena releases internal references to registered\r
- PyObject*, and none of its pointers are valid.\r
- XXX (tim) What does "none of its pointers are valid" mean? Does it\r
- XXX mean that pointers previously obtained via PyArena_Malloc() are\r
- XXX no longer valid? (That's clearly true, but not sure that's what\r
- XXX the text is trying to say.)\r
-\r
- PyArena_New() returns an arena pointer. On error, it\r
- returns a negative number and sets an exception.\r
- XXX (tim): Not true. On error, PyArena_New() actually returns NULL,\r
- XXX and looks like it may or may not set an exception (e.g., if the\r
- XXX internal PyList_New(0) returns NULL, PyArena_New() passes that on\r
- XXX and an exception is set; OTOH, if the internal\r
- XXX block_new(DEFAULT_BLOCK_SIZE) returns NULL, that's passed on but\r
- XXX an exception is not set in that case).\r
- */\r
- PyAPI_FUNC(PyArena *) PyArena_New(void);\r
- PyAPI_FUNC(void) PyArena_Free(PyArena *);\r
-\r
- /* Mostly like malloc(), return the address of a block of memory spanning\r
- * `size` bytes, or return NULL (without setting an exception) if enough\r
- * new memory can't be obtained. Unlike malloc(0), PyArena_Malloc() with\r
- * size=0 does not guarantee to return a unique pointer (the pointer\r
- * returned may equal one or more other pointers obtained from\r
- * PyArena_Malloc()).\r
- * Note that pointers obtained via PyArena_Malloc() must never be passed to\r
- * the system free() or realloc(), or to any of Python's similar memory-\r
- * management functions. PyArena_Malloc()-obtained pointers remain valid\r
- * until PyArena_Free(ar) is called, at which point all pointers obtained\r
- * from the arena `ar` become invalid simultaneously.\r
- */\r
- PyAPI_FUNC(void *) PyArena_Malloc(PyArena *, size_t size);\r
-\r
- /* This routine isn't a proper arena allocation routine. It takes\r
- * a PyObject* and records it so that it can be DECREFed when the\r
- * arena is freed.\r
- */\r
- PyAPI_FUNC(int) PyArena_AddPyObject(PyArena *, PyObject *);\r
-\r
-#ifdef __cplusplus\r
-}\r
-#endif\r
-\r
-#endif /* !Py_PYARENA_H */\r