Skip to content

Commit b8f704d

Browse files
vstinnervstinner
authored
bpo-40421: Add Include/cpython/code.h header file (GH-19756)
bpo-35134, bpo-40421: Add Include/cpython/code.h header file. code.h now defines PyCodeObject type in the limited C API. It is now included by Python.h. Give a name to the PyCodeObject structure: it is now called "struct PyCodeObject". So it becomes possible to define PyCodeObject as "struct PyCodeObject" in the limited C API without defining the structure.
1 parent 7c59d7c commit b8f704d

File tree

7 files changed

+175
-165
lines changed

7 files changed

+175
-165
lines changed

‎Include/Python.h‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,7 @@
114114
#include "classobject.h"
115115
#include "fileobject.h"
116116
#include "pycapsule.h"
117+
#include "code.h"
117118
#include "pyframe.h"
118119
#include "traceback.h"
119120
#include "sliceobject.h"

‎Include/code.h‎

Lines changed: 4 additions & 164 deletions
Original file line numberDiff line numberDiff line change
@@ -1,180 +1,20 @@
11
/* Definitions for bytecode */
22

3-
#ifndef Py_LIMITED_API
43
#ifndef Py_CODE_H
54
#define Py_CODE_H
65
#ifdef __cplusplus
76
extern "C" {
87
#endif
98

10-
typedef uint16_t _Py_CODEUNIT;
11-
12-
#ifdef WORDS_BIGENDIAN
13-
# define _Py_OPCODE(word) ((word) >> 8)
14-
# define _Py_OPARG(word) ((word) & 255)
15-
#else
16-
# define _Py_OPCODE(word) ((word) & 255)
17-
# define _Py_OPARG(word) ((word) >> 8)
18-
#endif
19-
20-
typedef struct _PyOpcache _PyOpcache;
21-
22-
/* Bytecode object */
23-
typedef struct {
24-
PyObject_HEAD
25-
int co_argcount; /* #arguments, except *args */
26-
int co_posonlyargcount; /* #positional only arguments */
27-
int co_kwonlyargcount; /* #keyword only arguments */
28-
int co_nlocals; /* #local variables */
29-
int co_stacksize; /* #entries needed for evaluation stack */
30-
int co_flags; /* CO_..., see below */
31-
int co_firstlineno; /* first source line number */
32-
PyObject *co_code; /* instruction opcodes */
33-
PyObject *co_consts; /* list (constants used) */
34-
PyObject *co_names; /* list of strings (names used) */
35-
PyObject *co_varnames; /* tuple of strings (local variable names) */
36-
PyObject *co_freevars; /* tuple of strings (free variable names) */
37-
PyObject *co_cellvars; /* tuple of strings (cell variable names) */
38-
/* The rest aren't used in either hash or comparisons, except for co_name,
39-
used in both. This is done to preserve the name and line number
40-
for tracebacks and debuggers; otherwise, constant de-duplication
41-
would collapse identical functions/lambdas defined on different lines.
42-
*/
43-
Py_ssize_t *co_cell2arg; /* Maps cell vars which are arguments. */
44-
PyObject *co_filename; /* unicode (where it was loaded from) */
45-
PyObject *co_name; /* unicode (name, for reference) */
46-
PyObject *co_lnotab; /* string (encoding addr<->lineno mapping) See
47-
Objects/lnotab_notes.txt for details. */
48-
void *co_zombieframe; /* for optimization only (see frameobject.c) */
49-
PyObject *co_weakreflist; /* to support weakrefs to code objects */
50-
/* Scratch space for extra data relating to the code object.
51-
Type is a void* to keep the format private in codeobject.c to force
52-
people to go through the proper APIs. */
53-
void *co_extra;
54-
55-
/* Per opcodes just-in-time cache
56-
*
57-
* To reduce cache size, we use indirect mapping from opcode index to
58-
* cache object:
59-
* cache = co_opcache[co_opcache_map[next_instr - first_instr] - 1]
60-
*/
61-
62-
// co_opcache_map is indexed by (next_instr - first_instr).
63-
// * 0 means there is no cache for this opcode.
64-
// * n > 0 means there is cache in co_opcache[n-1].
65-
unsigned char *co_opcache_map;
66-
_PyOpcache *co_opcache;
67-
int co_opcache_flag; // used to determine when create a cache.
68-
unsigned char co_opcache_size; // length of co_opcache.
69-
} PyCodeObject;
70-
71-
/* Masks for co_flags above */
72-
#define CO_OPTIMIZED 0x0001
73-
#define CO_NEWLOCALS 0x0002
74-
#define CO_VARARGS 0x0004
75-
#define CO_VARKEYWORDS 0x0008
76-
#define CO_NESTED 0x0010
77-
#define CO_GENERATOR 0x0020
78-
/* The CO_NOFREE flag is set if there are no free or cell variables.
79-
This information is redundant, but it allows a single flag test
80-
to determine whether there is any extra work to be done when the
81-
call frame it setup.
82-
*/
83-
#define CO_NOFREE 0x0040
84-
85-
/* The CO_COROUTINE flag is set for coroutine functions (defined with
86-
``async def`` keywords) */
87-
#define CO_COROUTINE 0x0080
88-
#define CO_ITERABLE_COROUTINE 0x0100
89-
#define CO_ASYNC_GENERATOR 0x0200
90-
91-
/* bpo-39562: These constant values are changed in Python 3.9
92-
to prevent collision with compiler flags. CO_FUTURE_ and PyCF_
93-
constants must be kept unique. PyCF_ constants can use bits from
94-
0x0100 to 0x10000. CO_FUTURE_ constants use bits starting at 0x20000. */
95-
#define CO_FUTURE_DIVISION 0x20000
96-
#define CO_FUTURE_ABSOLUTE_IMPORT 0x40000 /* do absolute imports by default */
97-
#define CO_FUTURE_WITH_STATEMENT 0x80000
98-
#define CO_FUTURE_PRINT_FUNCTION 0x100000
99-
#define CO_FUTURE_UNICODE_LITERALS 0x200000
100-
101-
#define CO_FUTURE_BARRY_AS_BDFL 0x400000
102-
#define CO_FUTURE_GENERATOR_STOP 0x800000
103-
#define CO_FUTURE_ANNOTATIONS 0x1000000
104-
105-
/* This value is found in the co_cell2arg array when the associated cell
106-
variable does not correspond to an argument. */
107-
#define CO_CELL_NOT_AN_ARG (-1)
108-
109-
/* This should be defined if a future statement modifies the syntax.
110-
For example, when a keyword is added.
111-
*/
112-
#define PY_PARSER_REQUIRES_FUTURE_KEYWORD
113-
114-
#define CO_MAXBLOCKS 20 /* Max static block nesting within a function */
115-
116-
PyAPI_DATA(PyTypeObject) PyCode_Type;
117-
118-
#define PyCode_Check(op) Py_IS_TYPE(op, &PyCode_Type)
119-
#define PyCode_GetNumFree(op) (PyTuple_GET_SIZE((op)->co_freevars))
120-
121-
/* Public interface */
122-
PyAPI_FUNC(PyCodeObject *) PyCode_New(
123-
int, int, int, int, int, PyObject *, PyObject *,
124-
PyObject *, PyObject *, PyObject *, PyObject *,
125-
PyObject *, PyObject *, int, PyObject *);
126-
127-
PyAPI_FUNC(PyCodeObject *) PyCode_NewWithPosOnlyArgs(
128-
int, int, int, int, int, int, PyObject *, PyObject *,
129-
PyObject *, PyObject *, PyObject *, PyObject *,
130-
PyObject *, PyObject *, int, PyObject *);
131-
/* same as struct above */
132-
133-
/* Creates a new empty code object with the specified source location. */
134-
PyAPI_FUNC(PyCodeObject *)
135-
PyCode_NewEmpty(const char *filename, const char *funcname, int firstlineno);
136-
137-
/* Return the line number associated with the specified bytecode index
138-
in this code object. If you just need the line number of a frame,
139-
use PyFrame_GetLineNumber() instead. */
140-
PyAPI_FUNC(int) PyCode_Addr2Line(PyCodeObject *, int);
141-
142-
/* for internal use only */
143-
typedef struct _addr_pair {
144-
int ap_lower;
145-
int ap_upper;
146-
} PyAddrPair;
147-
148-
#ifndef Py_LIMITED_API
149-
/* Update *bounds to describe the first and one-past-the-last instructions in the
150-
same line as lasti. Return the number of that line.
151-
*/
152-
PyAPI_FUNC(int) _PyCode_CheckLineNumber(PyCodeObject* co,
153-
int lasti, PyAddrPair *bounds);
154-
155-
/* Create a comparable key used to compare constants taking in account the
156-
* object type. It is used to make sure types are not coerced (e.g., float and
157-
* complex) _and_ to distinguish 0.0 from -0.0 e.g. on IEEE platforms
158-
*
159-
* Return (type(obj), obj, ...): a tuple with variable size (at least 2 items)
160-
* depending on the type and the value. The type is the first item to not
161-
* compare bytes and str which can raise a BytesWarning exception. */
162-
PyAPI_FUNC(PyObject*) _PyCode_ConstantKey(PyObject *obj);
163-
#endif
164-
165-
PyAPI_FUNC(PyObject*) PyCode_Optimize(PyObject *code, PyObject* consts,
166-
PyObject *names, PyObject *lnotab);
167-
9+
typedef struct PyCodeObject PyCodeObject;
16810

16911
#ifndef Py_LIMITED_API
170-
PyAPI_FUNC(int) _PyCode_GetExtra(PyObject *code, Py_ssize_t index,
171-
void **extra);
172-
PyAPI_FUNC(int) _PyCode_SetExtra(PyObject *code, Py_ssize_t index,
173-
void *extra);
12+
# define Py_CPYTHON_CODE_H
13+
# include "cpython/code.h"
14+
# undef Py_CPYTHON_CODE_H
17415
#endif
17516

17617
#ifdef __cplusplus
17718
}
17819
#endif
17920
#endif /* !Py_CODE_H */
180-
#endif /* Py_LIMITED_API */

‎Include/compile.h‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
#define Py_COMPILE_H
33

44
#ifndef Py_LIMITED_API
5-
#include "code.h"
65

76
#ifdef __cplusplus
87
extern "C" {

‎Include/cpython/code.h‎

Lines changed: 165 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
#ifndef Py_CPYTHON_CODE_H
2+
# error "this header file must not be included directly"
3+
#endif
4+
5+
typedef uint16_t _Py_CODEUNIT;
6+
7+
#ifdef WORDS_BIGENDIAN
8+
# define _Py_OPCODE(word) ((word) >> 8)
9+
# define _Py_OPARG(word) ((word) & 255)
10+
#else
11+
# define _Py_OPCODE(word) ((word) & 255)
12+
# define _Py_OPARG(word) ((word) >> 8)
13+
#endif
14+
15+
typedef struct _PyOpcache _PyOpcache;
16+
17+
/* Bytecode object */
18+
struct PyCodeObject {
19+
PyObject_HEAD
20+
int co_argcount; /* #arguments, except *args */
21+
int co_posonlyargcount; /* #positional only arguments */
22+
int co_kwonlyargcount; /* #keyword only arguments */
23+
int co_nlocals; /* #local variables */
24+
int co_stacksize; /* #entries needed for evaluation stack */
25+
int co_flags; /* CO_..., see below */
26+
int co_firstlineno; /* first source line number */
27+
PyObject *co_code; /* instruction opcodes */
28+
PyObject *co_consts; /* list (constants used) */
29+
PyObject *co_names; /* list of strings (names used) */
30+
PyObject *co_varnames; /* tuple of strings (local variable names) */
31+
PyObject *co_freevars; /* tuple of strings (free variable names) */
32+
PyObject *co_cellvars; /* tuple of strings (cell variable names) */
33+
/* The rest aren't used in either hash or comparisons, except for co_name,
34+
used in both. This is done to preserve the name and line number
35+
for tracebacks and debuggers; otherwise, constant de-duplication
36+
would collapse identical functions/lambdas defined on different lines.
37+
*/
38+
Py_ssize_t *co_cell2arg; /* Maps cell vars which are arguments. */
39+
PyObject *co_filename; /* unicode (where it was loaded from) */
40+
PyObject *co_name; /* unicode (name, for reference) */
41+
PyObject *co_lnotab; /* string (encoding addr<->lineno mapping) See
42+
Objects/lnotab_notes.txt for details. */
43+
void *co_zombieframe; /* for optimization only (see frameobject.c) */
44+
PyObject *co_weakreflist; /* to support weakrefs to code objects */
45+
/* Scratch space for extra data relating to the code object.
46+
Type is a void* to keep the format private in codeobject.c to force
47+
people to go through the proper APIs. */
48+
void *co_extra;
49+
50+
/* Per opcodes just-in-time cache
51+
*
52+
* To reduce cache size, we use indirect mapping from opcode index to
53+
* cache object:
54+
* cache = co_opcache[co_opcache_map[next_instr - first_instr] - 1]
55+
*/
56+
57+
// co_opcache_map is indexed by (next_instr - first_instr).
58+
// * 0 means there is no cache for this opcode.
59+
// * n > 0 means there is cache in co_opcache[n-1].
60+
unsigned char *co_opcache_map;
61+
_PyOpcache *co_opcache;
62+
int co_opcache_flag; // used to determine when create a cache.
63+
unsigned char co_opcache_size; // length of co_opcache.
64+
};
65+
66+
/* Masks for co_flags above */
67+
#define CO_OPTIMIZED 0x0001
68+
#define CO_NEWLOCALS 0x0002
69+
#define CO_VARARGS 0x0004
70+
#define CO_VARKEYWORDS 0x0008
71+
#define CO_NESTED 0x0010
72+
#define CO_GENERATOR 0x0020
73+
/* The CO_NOFREE flag is set if there are no free or cell variables.
74+
This information is redundant, but it allows a single flag test
75+
to determine whether there is any extra work to be done when the
76+
call frame it setup.
77+
*/
78+
#define CO_NOFREE 0x0040
79+
80+
/* The CO_COROUTINE flag is set for coroutine functions (defined with
81+
``async def`` keywords) */
82+
#define CO_COROUTINE 0x0080
83+
#define CO_ITERABLE_COROUTINE 0x0100
84+
#define CO_ASYNC_GENERATOR 0x0200
85+
86+
/* bpo-39562: These constant values are changed in Python 3.9
87+
to prevent collision with compiler flags. CO_FUTURE_ and PyCF_
88+
constants must be kept unique. PyCF_ constants can use bits from
89+
0x0100 to 0x10000. CO_FUTURE_ constants use bits starting at 0x20000. */
90+
#define CO_FUTURE_DIVISION 0x20000
91+
#define CO_FUTURE_ABSOLUTE_IMPORT 0x40000 /* do absolute imports by default */
92+
#define CO_FUTURE_WITH_STATEMENT 0x80000
93+
#define CO_FUTURE_PRINT_FUNCTION 0x100000
94+
#define CO_FUTURE_UNICODE_LITERALS 0x200000
95+
96+
#define CO_FUTURE_BARRY_AS_BDFL 0x400000
97+
#define CO_FUTURE_GENERATOR_STOP 0x800000
98+
#define CO_FUTURE_ANNOTATIONS 0x1000000
99+
100+
/* This value is found in the co_cell2arg array when the associated cell
101+
variable does not correspond to an argument. */
102+
#define CO_CELL_NOT_AN_ARG (-1)
103+
104+
/* This should be defined if a future statement modifies the syntax.
105+
For example, when a keyword is added.
106+
*/
107+
#define PY_PARSER_REQUIRES_FUTURE_KEYWORD
108+
109+
#define CO_MAXBLOCKS 20 /* Max static block nesting within a function */
110+
111+
PyAPI_DATA(PyTypeObject) PyCode_Type;
112+
113+
#define PyCode_Check(op) Py_IS_TYPE(op, &PyCode_Type)
114+
#define PyCode_GetNumFree(op) (PyTuple_GET_SIZE((op)->co_freevars))
115+
116+
/* Public interface */
117+
PyAPI_FUNC(PyCodeObject *) PyCode_New(
118+
int, int, int, int, int, PyObject *, PyObject *,
119+
PyObject *, PyObject *, PyObject *, PyObject *,
120+
PyObject *, PyObject *, int, PyObject *);
121+
122+
PyAPI_FUNC(PyCodeObject *) PyCode_NewWithPosOnlyArgs(
123+
int, int, int, int, int, int, PyObject *, PyObject *,
124+
PyObject *, PyObject *, PyObject *, PyObject *,
125+
PyObject *, PyObject *, int, PyObject *);
126+
/* same as struct above */
127+
128+
/* Creates a new empty code object with the specified source location. */
129+
PyAPI_FUNC(PyCodeObject *)
130+
PyCode_NewEmpty(const char *filename, const char *funcname, int firstlineno);
131+
132+
/* Return the line number associated with the specified bytecode index
133+
in this code object. If you just need the line number of a frame,
134+
use PyFrame_GetLineNumber() instead. */
135+
PyAPI_FUNC(int) PyCode_Addr2Line(PyCodeObject *, int);
136+
137+
/* for internal use only */
138+
typedef struct _addr_pair {
139+
int ap_lower;
140+
int ap_upper;
141+
} PyAddrPair;
142+
143+
/* Update *bounds to describe the first and one-past-the-last instructions in the
144+
same line as lasti. Return the number of that line.
145+
*/
146+
PyAPI_FUNC(int) _PyCode_CheckLineNumber(PyCodeObject* co,
147+
int lasti, PyAddrPair *bounds);
148+
149+
/* Create a comparable key used to compare constants taking in account the
150+
* object type. It is used to make sure types are not coerced (e.g., float and
151+
* complex) _and_ to distinguish 0.0 from -0.0 e.g. on IEEE platforms
152+
*
153+
* Return (type(obj), obj, ...): a tuple with variable size (at least 2 items)
154+
* depending on the type and the value. The type is the first item to not
155+
* compare bytes and str which can raise a BytesWarning exception. */
156+
PyAPI_FUNC(PyObject*) _PyCode_ConstantKey(PyObject *obj);
157+
158+
PyAPI_FUNC(PyObject*) PyCode_Optimize(PyObject *code, PyObject* consts,
159+
PyObject *names, PyObject *lnotab);
160+
161+
162+
PyAPI_FUNC(int) _PyCode_GetExtra(PyObject *code, Py_ssize_t index,
163+
void **extra);
164+
PyAPI_FUNC(int) _PyCode_SetExtra(PyObject *code, Py_ssize_t index,
165+
void *extra);

‎Makefile.pre.in‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1086,6 +1086,7 @@ PYTHON_HEADERS= \
10861086
$(srcdir)/Include/cpython/bytearrayobject.h \
10871087
$(srcdir)/Include/cpython/bytesobject.h \
10881088
$(srcdir)/Include/cpython/ceval.h \
1089+
$(srcdir)/Include/cpython/code.h \
10891090
$(srcdir)/Include/cpython/dictobject.h \
10901091
$(srcdir)/Include/cpython/fileobject.h \
10911092
$(srcdir)/Include/cpython/fileutils.h \

‎PCbuild/pythoncore.vcxproj‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,7 @@
131131
<ClInclude Include="..\Include\cpython\bytearrayobject.h" />
132132
<ClInclude Include="..\Include\cpython\bytesobject.h" />
133133
<ClInclude Include="..\Include\cpython\ceval.h" />
134+
<ClInclude Include="..\Include\cpython\code.h" />
134135
<ClInclude Include="..\Include\cpython\dictobject.h" />
135136
<ClInclude Include="..\Include\cpython\fileobject.h" />
136137
<ClInclude Include="..\Include\cpython\fileutils.h" />

‎PCbuild/pythoncore.vcxproj.filters‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,9 @@
9090
<ClInclude Include="..\Include\cpython\ceval.h">
9191
<Filter>Include</Filter>
9292
</ClInclude>
93+
<ClInclude Include="..\Include\cpython\code.h">
94+
<Filter>Include</Filter>
95+
</ClInclude>
9396
<ClInclude Include="..\Include\cpython\dictobject.h">
9497
<Filter>Include</Filter>
9598
</ClInclude>

0 commit comments

Comments
 (0)