jpayne@69: /* Definitions for bytecode */ jpayne@69: jpayne@69: #ifndef Py_LIMITED_API jpayne@69: #ifndef Py_CODE_H jpayne@69: #define Py_CODE_H jpayne@69: #ifdef __cplusplus jpayne@69: extern "C" { jpayne@69: #endif jpayne@69: jpayne@69: typedef uint16_t _Py_CODEUNIT; jpayne@69: jpayne@69: #ifdef WORDS_BIGENDIAN jpayne@69: # define _Py_OPCODE(word) ((word) >> 8) jpayne@69: # define _Py_OPARG(word) ((word) & 255) jpayne@69: #else jpayne@69: # define _Py_OPCODE(word) ((word) & 255) jpayne@69: # define _Py_OPARG(word) ((word) >> 8) jpayne@69: #endif jpayne@69: jpayne@69: typedef struct _PyOpcache _PyOpcache; jpayne@69: jpayne@69: /* Bytecode object */ jpayne@69: typedef struct { jpayne@69: PyObject_HEAD jpayne@69: int co_argcount; /* #arguments, except *args */ jpayne@69: int co_posonlyargcount; /* #positional only arguments */ jpayne@69: int co_kwonlyargcount; /* #keyword only arguments */ jpayne@69: int co_nlocals; /* #local variables */ jpayne@69: int co_stacksize; /* #entries needed for evaluation stack */ jpayne@69: int co_flags; /* CO_..., see below */ jpayne@69: int co_firstlineno; /* first source line number */ jpayne@69: PyObject *co_code; /* instruction opcodes */ jpayne@69: PyObject *co_consts; /* list (constants used) */ jpayne@69: PyObject *co_names; /* list of strings (names used) */ jpayne@69: PyObject *co_varnames; /* tuple of strings (local variable names) */ jpayne@69: PyObject *co_freevars; /* tuple of strings (free variable names) */ jpayne@69: PyObject *co_cellvars; /* tuple of strings (cell variable names) */ jpayne@69: /* The rest aren't used in either hash or comparisons, except for co_name, jpayne@69: used in both. This is done to preserve the name and line number jpayne@69: for tracebacks and debuggers; otherwise, constant de-duplication jpayne@69: would collapse identical functions/lambdas defined on different lines. jpayne@69: */ jpayne@69: Py_ssize_t *co_cell2arg; /* Maps cell vars which are arguments. */ jpayne@69: PyObject *co_filename; /* unicode (where it was loaded from) */ jpayne@69: PyObject *co_name; /* unicode (name, for reference) */ jpayne@69: PyObject *co_lnotab; /* string (encoding addr<->lineno mapping) See jpayne@69: Objects/lnotab_notes.txt for details. */ jpayne@69: void *co_zombieframe; /* for optimization only (see frameobject.c) */ jpayne@69: PyObject *co_weakreflist; /* to support weakrefs to code objects */ jpayne@69: /* Scratch space for extra data relating to the code object. jpayne@69: Type is a void* to keep the format private in codeobject.c to force jpayne@69: people to go through the proper APIs. */ jpayne@69: void *co_extra; jpayne@69: jpayne@69: /* Per opcodes just-in-time cache jpayne@69: * jpayne@69: * To reduce cache size, we use indirect mapping from opcode index to jpayne@69: * cache object: jpayne@69: * cache = co_opcache[co_opcache_map[next_instr - first_instr] - 1] jpayne@69: */ jpayne@69: jpayne@69: // co_opcache_map is indexed by (next_instr - first_instr). jpayne@69: // * 0 means there is no cache for this opcode. jpayne@69: // * n > 0 means there is cache in co_opcache[n-1]. jpayne@69: unsigned char *co_opcache_map; jpayne@69: _PyOpcache *co_opcache; jpayne@69: int co_opcache_flag; // used to determine when create a cache. jpayne@69: unsigned char co_opcache_size; // length of co_opcache. jpayne@69: } PyCodeObject; jpayne@69: jpayne@69: /* Masks for co_flags above */ jpayne@69: #define CO_OPTIMIZED 0x0001 jpayne@69: #define CO_NEWLOCALS 0x0002 jpayne@69: #define CO_VARARGS 0x0004 jpayne@69: #define CO_VARKEYWORDS 0x0008 jpayne@69: #define CO_NESTED 0x0010 jpayne@69: #define CO_GENERATOR 0x0020 jpayne@69: /* The CO_NOFREE flag is set if there are no free or cell variables. jpayne@69: This information is redundant, but it allows a single flag test jpayne@69: to determine whether there is any extra work to be done when the jpayne@69: call frame it setup. jpayne@69: */ jpayne@69: #define CO_NOFREE 0x0040 jpayne@69: jpayne@69: /* The CO_COROUTINE flag is set for coroutine functions (defined with jpayne@69: ``async def`` keywords) */ jpayne@69: #define CO_COROUTINE 0x0080 jpayne@69: #define CO_ITERABLE_COROUTINE 0x0100 jpayne@69: #define CO_ASYNC_GENERATOR 0x0200 jpayne@69: jpayne@69: /* These are no longer used. */ jpayne@69: #if 0 jpayne@69: #define CO_GENERATOR_ALLOWED 0x1000 jpayne@69: #endif jpayne@69: #define CO_FUTURE_DIVISION 0x2000 jpayne@69: #define CO_FUTURE_ABSOLUTE_IMPORT 0x4000 /* do absolute imports by default */ jpayne@69: #define CO_FUTURE_WITH_STATEMENT 0x8000 jpayne@69: #define CO_FUTURE_PRINT_FUNCTION 0x10000 jpayne@69: #define CO_FUTURE_UNICODE_LITERALS 0x20000 jpayne@69: jpayne@69: #define CO_FUTURE_BARRY_AS_BDFL 0x40000 jpayne@69: #define CO_FUTURE_GENERATOR_STOP 0x80000 jpayne@69: #define CO_FUTURE_ANNOTATIONS 0x100000 jpayne@69: jpayne@69: /* This value is found in the co_cell2arg array when the associated cell jpayne@69: variable does not correspond to an argument. */ jpayne@69: #define CO_CELL_NOT_AN_ARG (-1) jpayne@69: jpayne@69: /* This should be defined if a future statement modifies the syntax. jpayne@69: For example, when a keyword is added. jpayne@69: */ jpayne@69: #define PY_PARSER_REQUIRES_FUTURE_KEYWORD jpayne@69: jpayne@69: #define CO_MAXBLOCKS 20 /* Max static block nesting within a function */ jpayne@69: jpayne@69: PyAPI_DATA(PyTypeObject) PyCode_Type; jpayne@69: jpayne@69: #define PyCode_Check(op) (Py_TYPE(op) == &PyCode_Type) jpayne@69: #define PyCode_GetNumFree(op) (PyTuple_GET_SIZE((op)->co_freevars)) jpayne@69: jpayne@69: /* Public interface */ jpayne@69: PyAPI_FUNC(PyCodeObject *) PyCode_New( jpayne@69: int, int, int, int, int, PyObject *, PyObject *, jpayne@69: PyObject *, PyObject *, PyObject *, PyObject *, jpayne@69: PyObject *, PyObject *, int, PyObject *); jpayne@69: jpayne@69: PyAPI_FUNC(PyCodeObject *) PyCode_NewWithPosOnlyArgs( jpayne@69: int, int, int, int, int, int, PyObject *, PyObject *, jpayne@69: PyObject *, PyObject *, PyObject *, PyObject *, jpayne@69: PyObject *, PyObject *, int, PyObject *); jpayne@69: /* same as struct above */ jpayne@69: jpayne@69: /* Creates a new empty code object with the specified source location. */ jpayne@69: PyAPI_FUNC(PyCodeObject *) jpayne@69: PyCode_NewEmpty(const char *filename, const char *funcname, int firstlineno); jpayne@69: jpayne@69: /* Return the line number associated with the specified bytecode index jpayne@69: in this code object. If you just need the line number of a frame, jpayne@69: use PyFrame_GetLineNumber() instead. */ jpayne@69: PyAPI_FUNC(int) PyCode_Addr2Line(PyCodeObject *, int); jpayne@69: jpayne@69: /* for internal use only */ jpayne@69: typedef struct _addr_pair { jpayne@69: int ap_lower; jpayne@69: int ap_upper; jpayne@69: } PyAddrPair; jpayne@69: jpayne@69: #ifndef Py_LIMITED_API jpayne@69: /* Update *bounds to describe the first and one-past-the-last instructions in the jpayne@69: same line as lasti. Return the number of that line. jpayne@69: */ jpayne@69: PyAPI_FUNC(int) _PyCode_CheckLineNumber(PyCodeObject* co, jpayne@69: int lasti, PyAddrPair *bounds); jpayne@69: jpayne@69: /* Create a comparable key used to compare constants taking in account the jpayne@69: * object type. It is used to make sure types are not coerced (e.g., float and jpayne@69: * complex) _and_ to distinguish 0.0 from -0.0 e.g. on IEEE platforms jpayne@69: * jpayne@69: * Return (type(obj), obj, ...): a tuple with variable size (at least 2 items) jpayne@69: * depending on the type and the value. The type is the first item to not jpayne@69: * compare bytes and str which can raise a BytesWarning exception. */ jpayne@69: PyAPI_FUNC(PyObject*) _PyCode_ConstantKey(PyObject *obj); jpayne@69: #endif jpayne@69: jpayne@69: PyAPI_FUNC(PyObject*) PyCode_Optimize(PyObject *code, PyObject* consts, jpayne@69: PyObject *names, PyObject *lnotab); jpayne@69: jpayne@69: jpayne@69: #ifndef Py_LIMITED_API jpayne@69: PyAPI_FUNC(int) _PyCode_GetExtra(PyObject *code, Py_ssize_t index, jpayne@69: void **extra); jpayne@69: PyAPI_FUNC(int) _PyCode_SetExtra(PyObject *code, Py_ssize_t index, jpayne@69: void *extra); jpayne@69: #endif jpayne@69: jpayne@69: #ifdef __cplusplus jpayne@69: } jpayne@69: #endif jpayne@69: #endif /* !Py_CODE_H */ jpayne@69: #endif /* Py_LIMITED_API */