Skip to content
This repository has been archived by the owner on Jul 5, 2023. It is now read-only.

Commit

Permalink
Fix compilation on python 3.10.0a7 (#158)
Browse files Browse the repository at this point in the history
PyArena was removed from the public api in python/cpython#25007
This commit adds two new files (a copy of each for ast27 and ast3):
* pycore_pyarena.h: Taken from the cpython source code with minimal
  changes
* pyarena.h: Maps the new, underscored function names to the old
  function names, allowing the code to work on both python 3.10 and
  older versions
  • Loading branch information
freundTech authored Apr 6, 2021
1 parent adfe297 commit f3355fd
Show file tree
Hide file tree
Showing 6 changed files with 156 additions and 0 deletions.
2 changes: 2 additions & 0 deletions ast27/Include/asdl.h
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
#ifndef Ta27_ASDL_H
#define Ta27_ASDL_H

#include "../Include/pyarena.h"

typedef PyObject * identifier;
typedef PyObject * string;
typedef PyObject * object;
Expand Down
16 changes: 16 additions & 0 deletions ast27/Include/pyarena.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
/* An arena-like memory interface for the compiler.
*/

#ifndef Ta27_PYARENA_H
#define Ta27_PYARENA_H

#if PY_MINOR_VERSION >= 10
#include "../Include/pycore_pyarena.h"

#define PyArena_New _PyArena_New
#define PyArena_Free _PyArena_Free
#define PyArena_Malloc _PyArena_Malloc
#define PyArena_AddPyObject _PyArena_AddPyObject
#endif

#endif /* !Ta27_PYARENA_H */
60 changes: 60 additions & 0 deletions ast27/Include/pycore_pyarena.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
/* An arena-like memory interface for the compiler.
*/

#ifndef Ta27_INTERNAL_PYARENA_H
#define Ta27_INTERNAL_PYARENA_H
#ifdef __cplusplus
extern "C" {
#endif

typedef struct _arena PyArena;

/* _PyArena_New() and _PyArena_Free() create a new arena and free it,
respectively. Once an arena has been created, it can be used
to allocate memory via _PyArena_Malloc(). Pointers to PyObject can
also be registered with the arena via _PyArena_AddPyObject(), and the
arena will ensure that the PyObjects stay alive at least until
_PyArena_Free() is called. When an arena is freed, all the memory it
allocated is freed, the arena releases internal references to registered
PyObject*, and none of its pointers are valid.
XXX (tim) What does "none of its pointers are valid" mean? Does it
XXX mean that pointers previously obtained via _PyArena_Malloc() are
XXX no longer valid? (That's clearly true, but not sure that's what
XXX the text is trying to say.)
_PyArena_New() returns an arena pointer. On error, it
returns a negative number and sets an exception.
XXX (tim): Not true. On error, _PyArena_New() actually returns NULL,
XXX and looks like it may or may not set an exception (e.g., if the
XXX internal PyList_New(0) returns NULL, _PyArena_New() passes that on
XXX and an exception is set; OTOH, if the internal
XXX block_new(DEFAULT_BLOCK_SIZE) returns NULL, that's passed on but
XXX an exception is not set in that case).
*/
PyAPI_FUNC(PyArena*) _PyArena_New(void);
PyAPI_FUNC(void) _PyArena_Free(PyArena *);

/* Mostly like malloc(), return the address of a block of memory spanning
* `size` bytes, or return NULL (without setting an exception) if enough
* new memory can't be obtained. Unlike malloc(0), _PyArena_Malloc() with
* size=0 does not guarantee to return a unique pointer (the pointer
* returned may equal one or more other pointers obtained from
* _PyArena_Malloc()).
* Note that pointers obtained via _PyArena_Malloc() must never be passed to
* the system free() or realloc(), or to any of Python's similar memory-
* management functions. _PyArena_Malloc()-obtained pointers remain valid
* until _PyArena_Free(ar) is called, at which point all pointers obtained
* from the arena `ar` become invalid simultaneously.
*/
PyAPI_FUNC(void*) _PyArena_Malloc(PyArena *, size_t size);

/* This routine isn't a proper arena allocation routine. It takes
* a PyObject* and records it so that it can be DECREFed when the
* arena is freed.
*/
PyAPI_FUNC(int) _PyArena_AddPyObject(PyArena *, PyObject *);

#ifdef __cplusplus
}
#endif
#endif /* !Ta27_INTERNAL_PYARENA_H */
2 changes: 2 additions & 0 deletions ast3/Include/asdl.h
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
#ifndef Ta3_ASDL_H
#define Ta3_ASDL_H

#include "../Include/pyarena.h"

typedef PyObject * identifier;
typedef PyObject * string;
typedef PyObject * bytes;
Expand Down
16 changes: 16 additions & 0 deletions ast3/Include/pyarena.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
/* An arena-like memory interface for the compiler.
*/

#ifndef Ta3_PYARENA_H
#define Ta3_PYARENA_H

#if PY_MINOR_VERSION >= 10
#include "../Include/pycore_pyarena.h"

#define PyArena_New _PyArena_New
#define PyArena_Free _PyArena_Free
#define PyArena_Malloc _PyArena_Malloc
#define PyArena_AddPyObject _PyArena_AddPyObject
#endif

#endif /* !Ta3_PYARENA_H */
60 changes: 60 additions & 0 deletions ast3/Include/pycore_pyarena.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
/* An arena-like memory interface for the compiler.
*/

#ifndef Ta3_INTERNAL_PYARENA_H
#define Ta3_INTERNAL_PYARENA_H
#ifdef __cplusplus
extern "C" {
#endif

typedef struct _arena PyArena;

/* _PyArena_New() and _PyArena_Free() create a new arena and free it,
respectively. Once an arena has been created, it can be used
to allocate memory via _PyArena_Malloc(). Pointers to PyObject can
also be registered with the arena via _PyArena_AddPyObject(), and the
arena will ensure that the PyObjects stay alive at least until
_PyArena_Free() is called. When an arena is freed, all the memory it
allocated is freed, the arena releases internal references to registered
PyObject*, and none of its pointers are valid.
XXX (tim) What does "none of its pointers are valid" mean? Does it
XXX mean that pointers previously obtained via _PyArena_Malloc() are
XXX no longer valid? (That's clearly true, but not sure that's what
XXX the text is trying to say.)
_PyArena_New() returns an arena pointer. On error, it
returns a negative number and sets an exception.
XXX (tim): Not true. On error, _PyArena_New() actually returns NULL,
XXX and looks like it may or may not set an exception (e.g., if the
XXX internal PyList_New(0) returns NULL, _PyArena_New() passes that on
XXX and an exception is set; OTOH, if the internal
XXX block_new(DEFAULT_BLOCK_SIZE) returns NULL, that's passed on but
XXX an exception is not set in that case).
*/
PyAPI_FUNC(PyArena*) _PyArena_New(void);
PyAPI_FUNC(void) _PyArena_Free(PyArena *);

/* Mostly like malloc(), return the address of a block of memory spanning
* `size` bytes, or return NULL (without setting an exception) if enough
* new memory can't be obtained. Unlike malloc(0), _PyArena_Malloc() with
* size=0 does not guarantee to return a unique pointer (the pointer
* returned may equal one or more other pointers obtained from
* _PyArena_Malloc()).
* Note that pointers obtained via _PyArena_Malloc() must never be passed to
* the system free() or realloc(), or to any of Python's similar memory-
* management functions. _PyArena_Malloc()-obtained pointers remain valid
* until _PyArena_Free(ar) is called, at which point all pointers obtained
* from the arena `ar` become invalid simultaneously.
*/
PyAPI_FUNC(void*) _PyArena_Malloc(PyArena *, size_t size);

/* This routine isn't a proper arena allocation routine. It takes
* a PyObject* and records it so that it can be DECREFed when the
* arena is freed.
*/
PyAPI_FUNC(int) _PyArena_AddPyObject(PyArena *, PyObject *);

#ifdef __cplusplus
}
#endif
#endif /* !Ta3_INTERNAL_PYARENA_H */

0 comments on commit f3355fd

Please sign in to comment.