Mercurial > cpython-lru_cache-weakref
annotate Include/code.h @ 54297:dddf424bd669 legacy-trunk
Issue #6042:
lnotab-based tracing is very complicated and isn't documented very well. There
were at least 3 comment blocks purporting to document co_lnotab, and none did a
very good job. This patch unifies them into Objects/lnotab_notes.txt which
tries to completely capture the current state of affairs.
I also discovered that we've attached 2 layers of patches to the basic tracing
scheme. The first layer avoids jumping to instructions that don't start a line,
to avoid problems in if statements and while loops. The second layer
discovered that jumps backward do need to trace at instructions that don't
start a line, so it added extra lnotab entries for 'while' and 'for' loops, and
added a special case for backward jumps within the same line. I replaced these
patches by just treating forward and backward jumps differently.
| author | Jeffrey Yasskin <jyasskin@gmail.com> |
|---|---|
| date | Sat, 23 May 2009 23:23:01 +0000 |
| parents | 9ef683d41c9b |
| children | 22f589a8e3ab |
| rev | line source |
|---|---|
| 35742 | 1 /* Definitions for bytecode */ |
| 2 | |
| 3 #ifndef Py_CODE_H | |
| 4 #define Py_CODE_H | |
| 5 #ifdef __cplusplus | |
| 6 extern "C" { | |
| 7 #endif | |
| 8 | |
| 9 /* Bytecode object */ | |
| 10 typedef struct { | |
| 11 PyObject_HEAD | |
| 12 int co_argcount; /* #arguments, except *args */ | |
| 13 int co_nlocals; /* #local variables */ | |
| 14 int co_stacksize; /* #entries needed for evaluation stack */ | |
| 15 int co_flags; /* CO_..., see below */ | |
| 16 PyObject *co_code; /* instruction opcodes */ | |
| 17 PyObject *co_consts; /* list (constants used) */ | |
| 18 PyObject *co_names; /* list of strings (names used) */ | |
| 19 PyObject *co_varnames; /* tuple of strings (local variable names) */ | |
| 20 PyObject *co_freevars; /* tuple of strings (free variable names) */ | |
| 21 PyObject *co_cellvars; /* tuple of strings (cell variable names) */ | |
| 22 /* The rest doesn't count for hash/cmp */ | |
| 23 PyObject *co_filename; /* string (where it was loaded from) */ | |
| 24 PyObject *co_name; /* string (name, for reference) */ | |
| 25 int co_firstlineno; /* first source line number */ | |
| 54297 | 26 PyObject *co_lnotab; /* string (encoding addr<->lineno mapping) See |
| 27 Objects/lnotab_notes.txt for details. */ | |
|
38244
a637c78bf119
Merge from rjones-funccall branch.
Richard Jones <richard@commonground.com.au>
parents:
37838
diff
changeset
|
28 void *co_zombieframe; /* for optimization only (see frameobject.c) */ |
| 35742 | 29 } PyCodeObject; |
| 30 | |
| 31 /* Masks for co_flags above */ | |
| 32 #define CO_OPTIMIZED 0x0001 | |
| 33 #define CO_NEWLOCALS 0x0002 | |
| 34 #define CO_VARARGS 0x0004 | |
| 35 #define CO_VARKEYWORDS 0x0008 | |
| 36 #define CO_NESTED 0x0010 | |
| 37 #define CO_GENERATOR 0x0020 | |
| 38 /* The CO_NOFREE flag is set if there are no free or cell variables. | |
| 39 This information is redundant, but it allows a single flag test | |
| 40 to determine whether there is any extra work to be done when the | |
| 41 call frame it setup. | |
| 42 */ | |
| 43 #define CO_NOFREE 0x0040 | |
|
36602
9c0fd586475c
Generators have been permanent for a while. This comment is no longer applicable.
Neal Norwitz <nnorwitz@gmail.com>
parents:
35744
diff
changeset
|
44 |
|
36654
6b42920accc9
Per discussion on python-dev, remove CO_GENERATOR_ALLOWED. Leave comment about not removing yet.
Neal Norwitz <nnorwitz@gmail.com>
parents:
36602
diff
changeset
|
45 #if 0 |
|
6b42920accc9
Per discussion on python-dev, remove CO_GENERATOR_ALLOWED. Leave comment about not removing yet.
Neal Norwitz <nnorwitz@gmail.com>
parents:
36602
diff
changeset
|
46 /* This is no longer used. Stopped defining in 2.5, do not re-use. */ |
|
6b42920accc9
Per discussion on python-dev, remove CO_GENERATOR_ALLOWED. Leave comment about not removing yet.
Neal Norwitz <nnorwitz@gmail.com>
parents:
36602
diff
changeset
|
47 #define CO_GENERATOR_ALLOWED 0x1000 |
|
6b42920accc9
Per discussion on python-dev, remove CO_GENERATOR_ALLOWED. Leave comment about not removing yet.
Neal Norwitz <nnorwitz@gmail.com>
parents:
36602
diff
changeset
|
48 #endif |
| 35742 | 49 #define CO_FUTURE_DIVISION 0x2000 |
|
37418
cea54c9d921d
Don't abbreviate ABS, use long name ABSOLUTE.
Neal Norwitz <nnorwitz@gmail.com>
parents:
36726
diff
changeset
|
50 #define CO_FUTURE_ABSOLUTE_IMPORT 0x4000 /* do absolute imports by default */ |
|
36726
bbf16fd024df
from __future__ import with_statement addon for 'with', mostly written by
Thomas Wouters <thomas@python.org>
parents:
36712
diff
changeset
|
51 #define CO_FUTURE_WITH_STATEMENT 0x8000 |
|
45891
727f743cf630
Backport of the print function, using a __future__ import.
Eric Smith <eric@trueblade.com>
parents:
44350
diff
changeset
|
52 #define CO_FUTURE_PRINT_FUNCTION 0x10000 |
|
46118
c78d3586c474
Patch #2477: Added from __future__ import unicode_literals
Christian Heimes <christian@cheimes.de>
parents:
45891
diff
changeset
|
53 #define CO_FUTURE_UNICODE_LITERALS 0x20000 |
|
36726
bbf16fd024df
from __future__ import with_statement addon for 'with', mostly written by
Thomas Wouters <thomas@python.org>
parents:
36712
diff
changeset
|
54 |
|
bbf16fd024df
from __future__ import with_statement addon for 'with', mostly written by
Thomas Wouters <thomas@python.org>
parents:
36712
diff
changeset
|
55 /* This should be defined if a future statement modifies the syntax. |
|
bbf16fd024df
from __future__ import with_statement addon for 'with', mostly written by
Thomas Wouters <thomas@python.org>
parents:
36712
diff
changeset
|
56 For example, when a keyword is added. |
|
bbf16fd024df
from __future__ import with_statement addon for 'with', mostly written by
Thomas Wouters <thomas@python.org>
parents:
36712
diff
changeset
|
57 */ |
|
45891
727f743cf630
Backport of the print function, using a __future__ import.
Eric Smith <eric@trueblade.com>
parents:
44350
diff
changeset
|
58 #if 1 |
|
36726
bbf16fd024df
from __future__ import with_statement addon for 'with', mostly written by
Thomas Wouters <thomas@python.org>
parents:
36712
diff
changeset
|
59 #define PY_PARSER_REQUIRES_FUTURE_KEYWORD |
|
39779
b8fbd322760a
with and as are now keywords. There are some generated files I can't recreate.
Neal Norwitz <nnorwitz@gmail.com>
parents:
39601
diff
changeset
|
60 #endif |
| 35742 | 61 |
| 62 #define CO_MAXBLOCKS 20 /* Max static block nesting within a function */ | |
| 63 | |
|
35744
e7815495bb27
Use the newer names for APIs after the AST merge
Neal Norwitz <nnorwitz@gmail.com>
parents:
35742
diff
changeset
|
64 PyAPI_DATA(PyTypeObject) PyCode_Type; |
| 35742 | 65 |
|
44350
26384b8180c7
#1629: Renamed Py_Size, Py_Type and Py_Refcnt to Py_SIZE, Py_TYPE and Py_REFCNT. Macros for b/w compatibility are available.
Christian Heimes <christian@cheimes.de>
parents:
42333
diff
changeset
|
66 #define PyCode_Check(op) (Py_TYPE(op) == &PyCode_Type) |
| 35742 | 67 #define PyCode_GetNumFree(op) (PyTuple_GET_SIZE((op)->co_freevars)) |
| 68 | |
| 69 /* Public interface */ | |
|
35744
e7815495bb27
Use the newer names for APIs after the AST merge
Neal Norwitz <nnorwitz@gmail.com>
parents:
35742
diff
changeset
|
70 PyAPI_FUNC(PyCodeObject *) PyCode_New( |
| 35742 | 71 int, int, int, int, PyObject *, PyObject *, PyObject *, PyObject *, |
| 72 PyObject *, PyObject *, PyObject *, PyObject *, int, PyObject *); | |
| 73 /* same as struct above */ | |
| 53930 | 74 |
| 75 /* Creates a new empty code object with the specified source location. */ | |
| 76 PyAPI_FUNC(PyCodeObject *) | |
| 77 PyCode_NewEmpty(const char *filename, const char *funcname, int firstlineno); | |
| 78 | |
|
53931
9ef683d41c9b
Issue 5954, PyFrame_GetLineNumber:
Jeffrey Yasskin <jyasskin@gmail.com>
parents:
53930
diff
changeset
|
79 /* Return the line number associated with the specified bytecode index |
|
9ef683d41c9b
Issue 5954, PyFrame_GetLineNumber:
Jeffrey Yasskin <jyasskin@gmail.com>
parents:
53930
diff
changeset
|
80 in this code object. If you just need the line number of a frame, |
|
9ef683d41c9b
Issue 5954, PyFrame_GetLineNumber:
Jeffrey Yasskin <jyasskin@gmail.com>
parents:
53930
diff
changeset
|
81 use PyFrame_GetLineNumber() instead. */ |
|
35744
e7815495bb27
Use the newer names for APIs after the AST merge
Neal Norwitz <nnorwitz@gmail.com>
parents:
35742
diff
changeset
|
82 PyAPI_FUNC(int) PyCode_Addr2Line(PyCodeObject *, int); |
| 35742 | 83 |
| 84 /* for internal use only */ | |
| 85 #define _PyCode_GETCODEPTR(co, pp) \ | |
|
44350
26384b8180c7
#1629: Renamed Py_Size, Py_Type and Py_Refcnt to Py_SIZE, Py_TYPE and Py_REFCNT. Macros for b/w compatibility are available.
Christian Heimes <christian@cheimes.de>
parents:
42333
diff
changeset
|
86 ((*Py_TYPE((co)->co_code)->tp_as_buffer->bf_getreadbuffer) \ |
| 35742 | 87 ((co)->co_code, 0, (void **)(pp))) |
| 88 | |
|
37838
cc48985c3266
Refactor: Move code that uses co_lnotab from ceval to codeobject
Jeremy Hylton <jeremy@alum.mit.edu>
parents:
37418
diff
changeset
|
89 typedef struct _addr_pair { |
|
cc48985c3266
Refactor: Move code that uses co_lnotab from ceval to codeobject
Jeremy Hylton <jeremy@alum.mit.edu>
parents:
37418
diff
changeset
|
90 int ap_lower; |
|
cc48985c3266
Refactor: Move code that uses co_lnotab from ceval to codeobject
Jeremy Hylton <jeremy@alum.mit.edu>
parents:
37418
diff
changeset
|
91 int ap_upper; |
|
cc48985c3266
Refactor: Move code that uses co_lnotab from ceval to codeobject
Jeremy Hylton <jeremy@alum.mit.edu>
parents:
37418
diff
changeset
|
92 } PyAddrPair; |
|
cc48985c3266
Refactor: Move code that uses co_lnotab from ceval to codeobject
Jeremy Hylton <jeremy@alum.mit.edu>
parents:
37418
diff
changeset
|
93 |
| 54297 | 94 /* Update *bounds to describe the first and one-past-the-last instructions in the |
| 95 same line as lasti. Return the number of that line. | |
|
37838
cc48985c3266
Refactor: Move code that uses co_lnotab from ceval to codeobject
Jeremy Hylton <jeremy@alum.mit.edu>
parents:
37418
diff
changeset
|
96 */ |
| 54297 | 97 PyAPI_FUNC(int) _PyCode_CheckLineNumber(PyCodeObject* co, |
| 98 int lasti, PyAddrPair *bounds); | |
|
37838
cc48985c3266
Refactor: Move code that uses co_lnotab from ceval to codeobject
Jeremy Hylton <jeremy@alum.mit.edu>
parents:
37418
diff
changeset
|
99 |
|
39601
eeda2704130e
Move peephole optimizer to separate file. (Forgot .h in previous checkin.)
Jeremy Hylton <jeremy@alum.mit.edu>
parents:
38244
diff
changeset
|
100 PyAPI_FUNC(PyObject*) PyCode_Optimize(PyObject *code, PyObject* consts, |
|
eeda2704130e
Move peephole optimizer to separate file. (Forgot .h in previous checkin.)
Jeremy Hylton <jeremy@alum.mit.edu>
parents:
38244
diff
changeset
|
101 PyObject *names, PyObject *lineno_obj); |
|
eeda2704130e
Move peephole optimizer to separate file. (Forgot .h in previous checkin.)
Jeremy Hylton <jeremy@alum.mit.edu>
parents:
38244
diff
changeset
|
102 |
| 35742 | 103 #ifdef __cplusplus |
| 104 } | |
| 105 #endif | |
| 106 #endif /* !Py_CODE_H */ |