1 | /* Frame object implementation */
|
---|
2 |
|
---|
3 | #include "Python.h"
|
---|
4 |
|
---|
5 | #include "code.h"
|
---|
6 | #include "frameobject.h"
|
---|
7 | #include "opcode.h"
|
---|
8 | #include "structmember.h"
|
---|
9 |
|
---|
10 | #undef MIN
|
---|
11 | #undef MAX
|
---|
12 | #define MIN(a, b) ((a) < (b) ? (a) : (b))
|
---|
13 | #define MAX(a, b) ((a) > (b) ? (a) : (b))
|
---|
14 |
|
---|
15 | #define OFF(x) offsetof(PyFrameObject, x)
|
---|
16 |
|
---|
17 | static PyMemberDef frame_memberlist[] = {
|
---|
18 | {"f_back", T_OBJECT, OFF(f_back), RO},
|
---|
19 | {"f_code", T_OBJECT, OFF(f_code), RO},
|
---|
20 | {"f_builtins", T_OBJECT, OFF(f_builtins),RO},
|
---|
21 | {"f_globals", T_OBJECT, OFF(f_globals), RO},
|
---|
22 | {"f_lasti", T_INT, OFF(f_lasti), RO},
|
---|
23 | {"f_exc_type", T_OBJECT, OFF(f_exc_type)},
|
---|
24 | {"f_exc_value", T_OBJECT, OFF(f_exc_value)},
|
---|
25 | {"f_exc_traceback", T_OBJECT, OFF(f_exc_traceback)},
|
---|
26 | {NULL} /* Sentinel */
|
---|
27 | };
|
---|
28 |
|
---|
29 | static PyObject *
|
---|
30 | frame_getlocals(PyFrameObject *f, void *closure)
|
---|
31 | {
|
---|
32 | PyFrame_FastToLocals(f);
|
---|
33 | Py_INCREF(f->f_locals);
|
---|
34 | return f->f_locals;
|
---|
35 | }
|
---|
36 |
|
---|
37 | static PyObject *
|
---|
38 | frame_getlineno(PyFrameObject *f, void *closure)
|
---|
39 | {
|
---|
40 | int lineno;
|
---|
41 |
|
---|
42 | if (f->f_trace)
|
---|
43 | lineno = f->f_lineno;
|
---|
44 | else
|
---|
45 | lineno = PyCode_Addr2Line(f->f_code, f->f_lasti);
|
---|
46 |
|
---|
47 | return PyInt_FromLong(lineno);
|
---|
48 | }
|
---|
49 |
|
---|
50 | /* Setter for f_lineno - you can set f_lineno from within a trace function in
|
---|
51 | * order to jump to a given line of code, subject to some restrictions. Most
|
---|
52 | * lines are OK to jump to because they don't make any assumptions about the
|
---|
53 | * state of the stack (obvious because you could remove the line and the code
|
---|
54 | * would still work without any stack errors), but there are some constructs
|
---|
55 | * that limit jumping:
|
---|
56 | *
|
---|
57 | * o Lines with an 'except' statement on them can't be jumped to, because
|
---|
58 | * they expect an exception to be on the top of the stack.
|
---|
59 | * o Lines that live in a 'finally' block can't be jumped from or to, since
|
---|
60 | * the END_FINALLY expects to clean up the stack after the 'try' block.
|
---|
61 | * o 'try'/'for'/'while' blocks can't be jumped into because the blockstack
|
---|
62 | * needs to be set up before their code runs, and for 'for' loops the
|
---|
63 | * iterator needs to be on the stack.
|
---|
64 | */
|
---|
65 | static int
|
---|
66 | frame_setlineno(PyFrameObject *f, PyObject* p_new_lineno)
|
---|
67 | {
|
---|
68 | int new_lineno = 0; /* The new value of f_lineno */
|
---|
69 | int new_lasti = 0; /* The new value of f_lasti */
|
---|
70 | int new_iblock = 0; /* The new value of f_iblock */
|
---|
71 | char *code = NULL; /* The bytecode for the frame... */
|
---|
72 | Py_ssize_t code_len = 0; /* ...and its length */
|
---|
73 | char *lnotab = NULL; /* Iterating over co_lnotab */
|
---|
74 | Py_ssize_t lnotab_len = 0; /* (ditto) */
|
---|
75 | int offset = 0; /* (ditto) */
|
---|
76 | int line = 0; /* (ditto) */
|
---|
77 | int addr = 0; /* (ditto) */
|
---|
78 | int min_addr = 0; /* Scanning the SETUPs and POPs */
|
---|
79 | int max_addr = 0; /* (ditto) */
|
---|
80 | int delta_iblock = 0; /* (ditto) */
|
---|
81 | int min_delta_iblock = 0; /* (ditto) */
|
---|
82 | int min_iblock = 0; /* (ditto) */
|
---|
83 | int f_lasti_setup_addr = 0; /* Policing no-jump-into-finally */
|
---|
84 | int new_lasti_setup_addr = 0; /* (ditto) */
|
---|
85 | int blockstack[CO_MAXBLOCKS]; /* Walking the 'finally' blocks */
|
---|
86 | int in_finally[CO_MAXBLOCKS]; /* (ditto) */
|
---|
87 | int blockstack_top = 0; /* (ditto) */
|
---|
88 | int setup_op = 0; /* (ditto) */
|
---|
89 |
|
---|
90 | /* f_lineno must be an integer. */
|
---|
91 | if (!PyInt_Check(p_new_lineno)) {
|
---|
92 | PyErr_SetString(PyExc_ValueError,
|
---|
93 | "lineno must be an integer");
|
---|
94 | return -1;
|
---|
95 | }
|
---|
96 |
|
---|
97 | /* You can only do this from within a trace function, not via
|
---|
98 | * _getframe or similar hackery. */
|
---|
99 | if (!f->f_trace)
|
---|
100 | {
|
---|
101 | PyErr_Format(PyExc_ValueError,
|
---|
102 | "f_lineno can only be set by a trace function");
|
---|
103 | return -1;
|
---|
104 | }
|
---|
105 |
|
---|
106 | /* Fail if the line comes before the start of the code block. */
|
---|
107 | new_lineno = (int) PyInt_AsLong(p_new_lineno);
|
---|
108 | if (new_lineno < f->f_code->co_firstlineno) {
|
---|
109 | PyErr_Format(PyExc_ValueError,
|
---|
110 | "line %d comes before the current code block",
|
---|
111 | new_lineno);
|
---|
112 | return -1;
|
---|
113 | }
|
---|
114 |
|
---|
115 | /* Find the bytecode offset for the start of the given line, or the
|
---|
116 | * first code-owning line after it. */
|
---|
117 | PyString_AsStringAndSize(f->f_code->co_lnotab, &lnotab, &lnotab_len);
|
---|
118 | addr = 0;
|
---|
119 | line = f->f_code->co_firstlineno;
|
---|
120 | new_lasti = -1;
|
---|
121 | for (offset = 0; offset < lnotab_len; offset += 2) {
|
---|
122 | addr += lnotab[offset];
|
---|
123 | line += lnotab[offset+1];
|
---|
124 | if (line >= new_lineno) {
|
---|
125 | new_lasti = addr;
|
---|
126 | new_lineno = line;
|
---|
127 | break;
|
---|
128 | }
|
---|
129 | }
|
---|
130 |
|
---|
131 | /* If we didn't reach the requested line, return an error. */
|
---|
132 | if (new_lasti == -1) {
|
---|
133 | PyErr_Format(PyExc_ValueError,
|
---|
134 | "line %d comes after the current code block",
|
---|
135 | new_lineno);
|
---|
136 | return -1;
|
---|
137 | }
|
---|
138 |
|
---|
139 | /* We're now ready to look at the bytecode. */
|
---|
140 | PyString_AsStringAndSize(f->f_code->co_code, &code, &code_len);
|
---|
141 | min_addr = MIN(new_lasti, f->f_lasti);
|
---|
142 | max_addr = MAX(new_lasti, f->f_lasti);
|
---|
143 |
|
---|
144 | /* You can't jump onto a line with an 'except' statement on it -
|
---|
145 | * they expect to have an exception on the top of the stack, which
|
---|
146 | * won't be true if you jump to them. They always start with code
|
---|
147 | * that either pops the exception using POP_TOP (plain 'except:'
|
---|
148 | * lines do this) or duplicates the exception on the stack using
|
---|
149 | * DUP_TOP (if there's an exception type specified). See compile.c,
|
---|
150 | * 'com_try_except' for the full details. There aren't any other
|
---|
151 | * cases (AFAIK) where a line's code can start with DUP_TOP or
|
---|
152 | * POP_TOP, but if any ever appear, they'll be subject to the same
|
---|
153 | * restriction (but with a different error message). */
|
---|
154 | if (code[new_lasti] == DUP_TOP || code[new_lasti] == POP_TOP) {
|
---|
155 | PyErr_SetString(PyExc_ValueError,
|
---|
156 | "can't jump to 'except' line as there's no exception");
|
---|
157 | return -1;
|
---|
158 | }
|
---|
159 |
|
---|
160 | /* You can't jump into or out of a 'finally' block because the 'try'
|
---|
161 | * block leaves something on the stack for the END_FINALLY to clean
|
---|
162 | * up. So we walk the bytecode, maintaining a simulated blockstack.
|
---|
163 | * When we reach the old or new address and it's in a 'finally' block
|
---|
164 | * we note the address of the corresponding SETUP_FINALLY. The jump
|
---|
165 | * is only legal if neither address is in a 'finally' block or
|
---|
166 | * they're both in the same one. 'blockstack' is a stack of the
|
---|
167 | * bytecode addresses of the SETUP_X opcodes, and 'in_finally' tracks
|
---|
168 | * whether we're in a 'finally' block at each blockstack level. */
|
---|
169 | f_lasti_setup_addr = -1;
|
---|
170 | new_lasti_setup_addr = -1;
|
---|
171 | memset(blockstack, '\0', sizeof(blockstack));
|
---|
172 | memset(in_finally, '\0', sizeof(in_finally));
|
---|
173 | blockstack_top = 0;
|
---|
174 | for (addr = 0; addr < code_len; addr++) {
|
---|
175 | unsigned char op = code[addr];
|
---|
176 | switch (op) {
|
---|
177 | case SETUP_LOOP:
|
---|
178 | case SETUP_EXCEPT:
|
---|
179 | case SETUP_FINALLY:
|
---|
180 | blockstack[blockstack_top++] = addr;
|
---|
181 | in_finally[blockstack_top-1] = 0;
|
---|
182 | break;
|
---|
183 |
|
---|
184 | case POP_BLOCK:
|
---|
185 | assert(blockstack_top > 0);
|
---|
186 | setup_op = code[blockstack[blockstack_top-1]];
|
---|
187 | if (setup_op == SETUP_FINALLY) {
|
---|
188 | in_finally[blockstack_top-1] = 1;
|
---|
189 | }
|
---|
190 | else {
|
---|
191 | blockstack_top--;
|
---|
192 | }
|
---|
193 | break;
|
---|
194 |
|
---|
195 | case END_FINALLY:
|
---|
196 | /* Ignore END_FINALLYs for SETUP_EXCEPTs - they exist
|
---|
197 | * in the bytecode but don't correspond to an actual
|
---|
198 | * 'finally' block. (If blockstack_top is 0, we must
|
---|
199 | * be seeing such an END_FINALLY.) */
|
---|
200 | if (blockstack_top > 0) {
|
---|
201 | setup_op = code[blockstack[blockstack_top-1]];
|
---|
202 | if (setup_op == SETUP_FINALLY) {
|
---|
203 | blockstack_top--;
|
---|
204 | }
|
---|
205 | }
|
---|
206 | break;
|
---|
207 | }
|
---|
208 |
|
---|
209 | /* For the addresses we're interested in, see whether they're
|
---|
210 | * within a 'finally' block and if so, remember the address
|
---|
211 | * of the SETUP_FINALLY. */
|
---|
212 | if (addr == new_lasti || addr == f->f_lasti) {
|
---|
213 | int i = 0;
|
---|
214 | int setup_addr = -1;
|
---|
215 | for (i = blockstack_top-1; i >= 0; i--) {
|
---|
216 | if (in_finally[i]) {
|
---|
217 | setup_addr = blockstack[i];
|
---|
218 | break;
|
---|
219 | }
|
---|
220 | }
|
---|
221 |
|
---|
222 | if (setup_addr != -1) {
|
---|
223 | if (addr == new_lasti) {
|
---|
224 | new_lasti_setup_addr = setup_addr;
|
---|
225 | }
|
---|
226 |
|
---|
227 | if (addr == f->f_lasti) {
|
---|
228 | f_lasti_setup_addr = setup_addr;
|
---|
229 | }
|
---|
230 | }
|
---|
231 | }
|
---|
232 |
|
---|
233 | if (op >= HAVE_ARGUMENT) {
|
---|
234 | addr += 2;
|
---|
235 | }
|
---|
236 | }
|
---|
237 |
|
---|
238 | /* Verify that the blockstack tracking code didn't get lost. */
|
---|
239 | assert(blockstack_top == 0);
|
---|
240 |
|
---|
241 | /* After all that, are we jumping into / out of a 'finally' block? */
|
---|
242 | if (new_lasti_setup_addr != f_lasti_setup_addr) {
|
---|
243 | PyErr_SetString(PyExc_ValueError,
|
---|
244 | "can't jump into or out of a 'finally' block");
|
---|
245 | return -1;
|
---|
246 | }
|
---|
247 |
|
---|
248 |
|
---|
249 | /* Police block-jumping (you can't jump into the middle of a block)
|
---|
250 | * and ensure that the blockstack finishes up in a sensible state (by
|
---|
251 | * popping any blocks we're jumping out of). We look at all the
|
---|
252 | * blockstack operations between the current position and the new
|
---|
253 | * one, and keep track of how many blocks we drop out of on the way.
|
---|
254 | * By also keeping track of the lowest blockstack position we see, we
|
---|
255 | * can tell whether the jump goes into any blocks without coming out
|
---|
256 | * again - in that case we raise an exception below. */
|
---|
257 | delta_iblock = 0;
|
---|
258 | for (addr = min_addr; addr < max_addr; addr++) {
|
---|
259 | unsigned char op = code[addr];
|
---|
260 | switch (op) {
|
---|
261 | case SETUP_LOOP:
|
---|
262 | case SETUP_EXCEPT:
|
---|
263 | case SETUP_FINALLY:
|
---|
264 | delta_iblock++;
|
---|
265 | break;
|
---|
266 |
|
---|
267 | case POP_BLOCK:
|
---|
268 | delta_iblock--;
|
---|
269 | break;
|
---|
270 | }
|
---|
271 |
|
---|
272 | min_delta_iblock = MIN(min_delta_iblock, delta_iblock);
|
---|
273 |
|
---|
274 | if (op >= HAVE_ARGUMENT) {
|
---|
275 | addr += 2;
|
---|
276 | }
|
---|
277 | }
|
---|
278 |
|
---|
279 | /* Derive the absolute iblock values from the deltas. */
|
---|
280 | min_iblock = f->f_iblock + min_delta_iblock;
|
---|
281 | if (new_lasti > f->f_lasti) {
|
---|
282 | /* Forwards jump. */
|
---|
283 | new_iblock = f->f_iblock + delta_iblock;
|
---|
284 | }
|
---|
285 | else {
|
---|
286 | /* Backwards jump. */
|
---|
287 | new_iblock = f->f_iblock - delta_iblock;
|
---|
288 | }
|
---|
289 |
|
---|
290 | /* Are we jumping into a block? */
|
---|
291 | if (new_iblock > min_iblock) {
|
---|
292 | PyErr_SetString(PyExc_ValueError,
|
---|
293 | "can't jump into the middle of a block");
|
---|
294 | return -1;
|
---|
295 | }
|
---|
296 |
|
---|
297 | /* Pop any blocks that we're jumping out of. */
|
---|
298 | while (f->f_iblock > new_iblock) {
|
---|
299 | PyTryBlock *b = &f->f_blockstack[--f->f_iblock];
|
---|
300 | while ((f->f_stacktop - f->f_valuestack) > b->b_level) {
|
---|
301 | PyObject *v = (*--f->f_stacktop);
|
---|
302 | Py_DECREF(v);
|
---|
303 | }
|
---|
304 | }
|
---|
305 |
|
---|
306 | /* Finally set the new f_lineno and f_lasti and return OK. */
|
---|
307 | f->f_lineno = new_lineno;
|
---|
308 | f->f_lasti = new_lasti;
|
---|
309 | return 0;
|
---|
310 | }
|
---|
311 |
|
---|
312 | static PyObject *
|
---|
313 | frame_gettrace(PyFrameObject *f, void *closure)
|
---|
314 | {
|
---|
315 | PyObject* trace = f->f_trace;
|
---|
316 |
|
---|
317 | if (trace == NULL)
|
---|
318 | trace = Py_None;
|
---|
319 |
|
---|
320 | Py_INCREF(trace);
|
---|
321 |
|
---|
322 | return trace;
|
---|
323 | }
|
---|
324 |
|
---|
325 | static int
|
---|
326 | frame_settrace(PyFrameObject *f, PyObject* v, void *closure)
|
---|
327 | {
|
---|
328 | /* We rely on f_lineno being accurate when f_trace is set. */
|
---|
329 |
|
---|
330 | PyObject* old_value = f->f_trace;
|
---|
331 |
|
---|
332 | Py_XINCREF(v);
|
---|
333 | f->f_trace = v;
|
---|
334 |
|
---|
335 | if (v != NULL)
|
---|
336 | f->f_lineno = PyCode_Addr2Line(f->f_code, f->f_lasti);
|
---|
337 |
|
---|
338 | Py_XDECREF(old_value);
|
---|
339 |
|
---|
340 | return 0;
|
---|
341 | }
|
---|
342 |
|
---|
343 | static PyObject *
|
---|
344 | frame_getrestricted(PyFrameObject *f, void *closure)
|
---|
345 | {
|
---|
346 | return PyBool_FromLong(PyFrame_IsRestricted(f));
|
---|
347 | }
|
---|
348 |
|
---|
349 | static PyGetSetDef frame_getsetlist[] = {
|
---|
350 | {"f_locals", (getter)frame_getlocals, NULL, NULL},
|
---|
351 | {"f_lineno", (getter)frame_getlineno,
|
---|
352 | (setter)frame_setlineno, NULL},
|
---|
353 | {"f_trace", (getter)frame_gettrace, (setter)frame_settrace, NULL},
|
---|
354 | {"f_restricted",(getter)frame_getrestricted,NULL, NULL},
|
---|
355 | {0}
|
---|
356 | };
|
---|
357 |
|
---|
358 | /* Stack frames are allocated and deallocated at a considerable rate.
|
---|
359 | In an attempt to improve the speed of function calls, we:
|
---|
360 |
|
---|
361 | 1. Hold a single "zombie" frame on each code object. This retains
|
---|
362 | the allocated and initialised frame object from an invocation of
|
---|
363 | the code object. The zombie is reanimated the next time we need a
|
---|
364 | frame object for that code object. Doing this saves the malloc/
|
---|
365 | realloc required when using a free_list frame that isn't the
|
---|
366 | correct size. It also saves some field initialisation.
|
---|
367 |
|
---|
368 | In zombie mode, no field of PyFrameObject holds a reference, but
|
---|
369 | the following fields are still valid:
|
---|
370 |
|
---|
371 | * ob_type, ob_size, f_code, f_valuestack;
|
---|
372 |
|
---|
373 | * f_locals, f_trace,
|
---|
374 | f_exc_type, f_exc_value, f_exc_traceback are NULL;
|
---|
375 |
|
---|
376 | * f_localsplus does not require re-allocation and
|
---|
377 | the local variables in f_localsplus are NULL.
|
---|
378 |
|
---|
379 | 2. We also maintain a separate free list of stack frames (just like
|
---|
380 | integers are allocated in a special way -- see intobject.c). When
|
---|
381 | a stack frame is on the free list, only the following members have
|
---|
382 | a meaning:
|
---|
383 | ob_type == &Frametype
|
---|
384 | f_back next item on free list, or NULL
|
---|
385 | f_stacksize size of value stack
|
---|
386 | ob_size size of localsplus
|
---|
387 | Note that the value and block stacks are preserved -- this can save
|
---|
388 | another malloc() call or two (and two free() calls as well!).
|
---|
389 | Also note that, unlike for integers, each frame object is a
|
---|
390 | malloc'ed object in its own right -- it is only the actual calls to
|
---|
391 | malloc() that we are trying to save here, not the administration.
|
---|
392 | After all, while a typical program may make millions of calls, a
|
---|
393 | call depth of more than 20 or 30 is probably already exceptional
|
---|
394 | unless the program contains run-away recursion. I hope.
|
---|
395 |
|
---|
396 | Later, MAXFREELIST was added to bound the # of frames saved on
|
---|
397 | free_list. Else programs creating lots of cyclic trash involving
|
---|
398 | frames could provoke free_list into growing without bound.
|
---|
399 | */
|
---|
400 |
|
---|
401 | static PyFrameObject *free_list = NULL;
|
---|
402 | static int numfree = 0; /* number of frames currently in free_list */
|
---|
403 | #define MAXFREELIST 200 /* max value for numfree */
|
---|
404 |
|
---|
405 | static void
|
---|
406 | frame_dealloc(PyFrameObject *f)
|
---|
407 | {
|
---|
408 | PyObject **p, **valuestack;
|
---|
409 | PyCodeObject *co;
|
---|
410 |
|
---|
411 | PyObject_GC_UnTrack(f);
|
---|
412 | Py_TRASHCAN_SAFE_BEGIN(f)
|
---|
413 | /* Kill all local variables */
|
---|
414 | valuestack = f->f_valuestack;
|
---|
415 | for (p = f->f_localsplus; p < valuestack; p++)
|
---|
416 | Py_CLEAR(*p);
|
---|
417 |
|
---|
418 | /* Free stack */
|
---|
419 | if (f->f_stacktop != NULL) {
|
---|
420 | for (p = valuestack; p < f->f_stacktop; p++)
|
---|
421 | Py_XDECREF(*p);
|
---|
422 | }
|
---|
423 |
|
---|
424 | Py_XDECREF(f->f_back);
|
---|
425 | Py_DECREF(f->f_builtins);
|
---|
426 | Py_DECREF(f->f_globals);
|
---|
427 | Py_CLEAR(f->f_locals);
|
---|
428 | Py_CLEAR(f->f_trace);
|
---|
429 | Py_CLEAR(f->f_exc_type);
|
---|
430 | Py_CLEAR(f->f_exc_value);
|
---|
431 | Py_CLEAR(f->f_exc_traceback);
|
---|
432 |
|
---|
433 | co = f->f_code;
|
---|
434 | if (co->co_zombieframe == NULL)
|
---|
435 | co->co_zombieframe = f;
|
---|
436 | else if (numfree < MAXFREELIST) {
|
---|
437 | ++numfree;
|
---|
438 | f->f_back = free_list;
|
---|
439 | free_list = f;
|
---|
440 | }
|
---|
441 | else
|
---|
442 | PyObject_GC_Del(f);
|
---|
443 |
|
---|
444 | Py_DECREF(co);
|
---|
445 | Py_TRASHCAN_SAFE_END(f)
|
---|
446 | }
|
---|
447 |
|
---|
448 | static int
|
---|
449 | frame_traverse(PyFrameObject *f, visitproc visit, void *arg)
|
---|
450 | {
|
---|
451 | PyObject **fastlocals, **p;
|
---|
452 | int i, slots;
|
---|
453 |
|
---|
454 | Py_VISIT(f->f_back);
|
---|
455 | Py_VISIT(f->f_code);
|
---|
456 | Py_VISIT(f->f_builtins);
|
---|
457 | Py_VISIT(f->f_globals);
|
---|
458 | Py_VISIT(f->f_locals);
|
---|
459 | Py_VISIT(f->f_trace);
|
---|
460 | Py_VISIT(f->f_exc_type);
|
---|
461 | Py_VISIT(f->f_exc_value);
|
---|
462 | Py_VISIT(f->f_exc_traceback);
|
---|
463 |
|
---|
464 | /* locals */
|
---|
465 | slots = f->f_code->co_nlocals + PyTuple_GET_SIZE(f->f_code->co_cellvars) + PyTuple_GET_SIZE(f->f_code->co_freevars);
|
---|
466 | fastlocals = f->f_localsplus;
|
---|
467 | for (i = slots; --i >= 0; ++fastlocals)
|
---|
468 | Py_VISIT(*fastlocals);
|
---|
469 |
|
---|
470 | /* stack */
|
---|
471 | if (f->f_stacktop != NULL) {
|
---|
472 | for (p = f->f_valuestack; p < f->f_stacktop; p++)
|
---|
473 | Py_VISIT(*p);
|
---|
474 | }
|
---|
475 | return 0;
|
---|
476 | }
|
---|
477 |
|
---|
478 | static void
|
---|
479 | frame_clear(PyFrameObject *f)
|
---|
480 | {
|
---|
481 | PyObject **fastlocals, **p, **oldtop;
|
---|
482 | int i, slots;
|
---|
483 |
|
---|
484 | /* Before anything else, make sure that this frame is clearly marked
|
---|
485 | * as being defunct! Else, e.g., a generator reachable from this
|
---|
486 | * frame may also point to this frame, believe itself to still be
|
---|
487 | * active, and try cleaning up this frame again.
|
---|
488 | */
|
---|
489 | oldtop = f->f_stacktop;
|
---|
490 | f->f_stacktop = NULL;
|
---|
491 |
|
---|
492 | Py_CLEAR(f->f_exc_type);
|
---|
493 | Py_CLEAR(f->f_exc_value);
|
---|
494 | Py_CLEAR(f->f_exc_traceback);
|
---|
495 | Py_CLEAR(f->f_trace);
|
---|
496 |
|
---|
497 | /* locals */
|
---|
498 | slots = f->f_code->co_nlocals + PyTuple_GET_SIZE(f->f_code->co_cellvars) + PyTuple_GET_SIZE(f->f_code->co_freevars);
|
---|
499 | fastlocals = f->f_localsplus;
|
---|
500 | for (i = slots; --i >= 0; ++fastlocals)
|
---|
501 | Py_CLEAR(*fastlocals);
|
---|
502 |
|
---|
503 | /* stack */
|
---|
504 | if (oldtop != NULL) {
|
---|
505 | for (p = f->f_valuestack; p < oldtop; p++)
|
---|
506 | Py_CLEAR(*p);
|
---|
507 | }
|
---|
508 | }
|
---|
509 |
|
---|
510 |
|
---|
511 | PyTypeObject PyFrame_Type = {
|
---|
512 | PyObject_HEAD_INIT(&PyType_Type)
|
---|
513 | 0,
|
---|
514 | "frame",
|
---|
515 | sizeof(PyFrameObject),
|
---|
516 | sizeof(PyObject *),
|
---|
517 | (destructor)frame_dealloc, /* tp_dealloc */
|
---|
518 | 0, /* tp_print */
|
---|
519 | 0, /* tp_getattr */
|
---|
520 | 0, /* tp_setattr */
|
---|
521 | 0, /* tp_compare */
|
---|
522 | 0, /* tp_repr */
|
---|
523 | 0, /* tp_as_number */
|
---|
524 | 0, /* tp_as_sequence */
|
---|
525 | 0, /* tp_as_mapping */
|
---|
526 | 0, /* tp_hash */
|
---|
527 | 0, /* tp_call */
|
---|
528 | 0, /* tp_str */
|
---|
529 | PyObject_GenericGetAttr, /* tp_getattro */
|
---|
530 | PyObject_GenericSetAttr, /* tp_setattro */
|
---|
531 | 0, /* tp_as_buffer */
|
---|
532 | Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC,/* tp_flags */
|
---|
533 | 0, /* tp_doc */
|
---|
534 | (traverseproc)frame_traverse, /* tp_traverse */
|
---|
535 | (inquiry)frame_clear, /* tp_clear */
|
---|
536 | 0, /* tp_richcompare */
|
---|
537 | 0, /* tp_weaklistoffset */
|
---|
538 | 0, /* tp_iter */
|
---|
539 | 0, /* tp_iternext */
|
---|
540 | 0, /* tp_methods */
|
---|
541 | frame_memberlist, /* tp_members */
|
---|
542 | frame_getsetlist, /* tp_getset */
|
---|
543 | 0, /* tp_base */
|
---|
544 | 0, /* tp_dict */
|
---|
545 | };
|
---|
546 |
|
---|
547 | static PyObject *builtin_object;
|
---|
548 |
|
---|
549 | int _PyFrame_Init()
|
---|
550 | {
|
---|
551 | builtin_object = PyString_InternFromString("__builtins__");
|
---|
552 | return (builtin_object != NULL);
|
---|
553 | }
|
---|
554 |
|
---|
555 | PyFrameObject *
|
---|
556 | PyFrame_New(PyThreadState *tstate, PyCodeObject *code, PyObject *globals,
|
---|
557 | PyObject *locals)
|
---|
558 | {
|
---|
559 | PyFrameObject *back = tstate->frame;
|
---|
560 | PyFrameObject *f;
|
---|
561 | PyObject *builtins;
|
---|
562 | Py_ssize_t i;
|
---|
563 |
|
---|
564 | #ifdef Py_DEBUG
|
---|
565 | if (code == NULL || globals == NULL || !PyDict_Check(globals) ||
|
---|
566 | (locals != NULL && !PyMapping_Check(locals))) {
|
---|
567 | PyErr_BadInternalCall();
|
---|
568 | return NULL;
|
---|
569 | }
|
---|
570 | #endif
|
---|
571 | if (back == NULL || back->f_globals != globals) {
|
---|
572 | builtins = PyDict_GetItem(globals, builtin_object);
|
---|
573 | if (builtins) {
|
---|
574 | if (PyModule_Check(builtins)) {
|
---|
575 | builtins = PyModule_GetDict(builtins);
|
---|
576 | assert(!builtins || PyDict_Check(builtins));
|
---|
577 | }
|
---|
578 | else if (!PyDict_Check(builtins))
|
---|
579 | builtins = NULL;
|
---|
580 | }
|
---|
581 | if (builtins == NULL) {
|
---|
582 | /* No builtins! Make up a minimal one
|
---|
583 | Give them 'None', at least. */
|
---|
584 | builtins = PyDict_New();
|
---|
585 | if (builtins == NULL ||
|
---|
586 | PyDict_SetItemString(
|
---|
587 | builtins, "None", Py_None) < 0)
|
---|
588 | return NULL;
|
---|
589 | }
|
---|
590 | else
|
---|
591 | Py_INCREF(builtins);
|
---|
592 |
|
---|
593 | }
|
---|
594 | else {
|
---|
595 | /* If we share the globals, we share the builtins.
|
---|
596 | Save a lookup and a call. */
|
---|
597 | builtins = back->f_builtins;
|
---|
598 | assert(builtins != NULL && PyDict_Check(builtins));
|
---|
599 | Py_INCREF(builtins);
|
---|
600 | }
|
---|
601 | if (code->co_zombieframe != NULL) {
|
---|
602 | f = code->co_zombieframe;
|
---|
603 | code->co_zombieframe = NULL;
|
---|
604 | _Py_NewReference((PyObject *)f);
|
---|
605 | assert(f->f_code == code);
|
---|
606 | }
|
---|
607 | else {
|
---|
608 | Py_ssize_t extras, ncells, nfrees;
|
---|
609 | ncells = PyTuple_GET_SIZE(code->co_cellvars);
|
---|
610 | nfrees = PyTuple_GET_SIZE(code->co_freevars);
|
---|
611 | extras = code->co_stacksize + code->co_nlocals + ncells +
|
---|
612 | nfrees;
|
---|
613 | if (free_list == NULL) {
|
---|
614 | f = PyObject_GC_NewVar(PyFrameObject, &PyFrame_Type,
|
---|
615 | extras);
|
---|
616 | if (f == NULL) {
|
---|
617 | Py_DECREF(builtins);
|
---|
618 | return NULL;
|
---|
619 | }
|
---|
620 | }
|
---|
621 | else {
|
---|
622 | assert(numfree > 0);
|
---|
623 | --numfree;
|
---|
624 | f = free_list;
|
---|
625 | free_list = free_list->f_back;
|
---|
626 | if (f->ob_size < extras) {
|
---|
627 | f = PyObject_GC_Resize(PyFrameObject, f, extras);
|
---|
628 | if (f == NULL) {
|
---|
629 | Py_DECREF(builtins);
|
---|
630 | return NULL;
|
---|
631 | }
|
---|
632 | }
|
---|
633 | _Py_NewReference((PyObject *)f);
|
---|
634 | }
|
---|
635 |
|
---|
636 | f->f_code = code;
|
---|
637 | extras = code->co_nlocals + ncells + nfrees;
|
---|
638 | f->f_valuestack = f->f_localsplus + extras;
|
---|
639 | for (i=0; i<extras; i++)
|
---|
640 | f->f_localsplus[i] = NULL;
|
---|
641 | f->f_locals = NULL;
|
---|
642 | f->f_trace = NULL;
|
---|
643 | f->f_exc_type = f->f_exc_value = f->f_exc_traceback = NULL;
|
---|
644 | }
|
---|
645 | f->f_stacktop = f->f_valuestack;
|
---|
646 | f->f_builtins = builtins;
|
---|
647 | Py_XINCREF(back);
|
---|
648 | f->f_back = back;
|
---|
649 | Py_INCREF(code);
|
---|
650 | Py_INCREF(globals);
|
---|
651 | f->f_globals = globals;
|
---|
652 | /* Most functions have CO_NEWLOCALS and CO_OPTIMIZED set. */
|
---|
653 | if ((code->co_flags & (CO_NEWLOCALS | CO_OPTIMIZED)) ==
|
---|
654 | (CO_NEWLOCALS | CO_OPTIMIZED))
|
---|
655 | ; /* f_locals = NULL; will be set by PyFrame_FastToLocals() */
|
---|
656 | else if (code->co_flags & CO_NEWLOCALS) {
|
---|
657 | locals = PyDict_New();
|
---|
658 | if (locals == NULL) {
|
---|
659 | Py_DECREF(f);
|
---|
660 | return NULL;
|
---|
661 | }
|
---|
662 | f->f_locals = locals;
|
---|
663 | }
|
---|
664 | else {
|
---|
665 | if (locals == NULL)
|
---|
666 | locals = globals;
|
---|
667 | Py_INCREF(locals);
|
---|
668 | f->f_locals = locals;
|
---|
669 | }
|
---|
670 | f->f_tstate = tstate;
|
---|
671 |
|
---|
672 | f->f_lasti = -1;
|
---|
673 | f->f_lineno = code->co_firstlineno;
|
---|
674 | f->f_iblock = 0;
|
---|
675 |
|
---|
676 | _PyObject_GC_TRACK(f);
|
---|
677 | return f;
|
---|
678 | }
|
---|
679 |
|
---|
680 | /* Block management */
|
---|
681 |
|
---|
682 | void
|
---|
683 | PyFrame_BlockSetup(PyFrameObject *f, int type, int handler, int level)
|
---|
684 | {
|
---|
685 | PyTryBlock *b;
|
---|
686 | if (f->f_iblock >= CO_MAXBLOCKS)
|
---|
687 | Py_FatalError("XXX block stack overflow");
|
---|
688 | b = &f->f_blockstack[f->f_iblock++];
|
---|
689 | b->b_type = type;
|
---|
690 | b->b_level = level;
|
---|
691 | b->b_handler = handler;
|
---|
692 | }
|
---|
693 |
|
---|
694 | PyTryBlock *
|
---|
695 | PyFrame_BlockPop(PyFrameObject *f)
|
---|
696 | {
|
---|
697 | PyTryBlock *b;
|
---|
698 | if (f->f_iblock <= 0)
|
---|
699 | Py_FatalError("XXX block stack underflow");
|
---|
700 | b = &f->f_blockstack[--f->f_iblock];
|
---|
701 | return b;
|
---|
702 | }
|
---|
703 |
|
---|
704 | /* Convert between "fast" version of locals and dictionary version */
|
---|
705 |
|
---|
706 | static void
|
---|
707 | map_to_dict(PyObject *map, Py_ssize_t nmap, PyObject *dict, PyObject **values,
|
---|
708 | Py_ssize_t deref)
|
---|
709 | {
|
---|
710 | Py_ssize_t j;
|
---|
711 | for (j = nmap; --j >= 0; ) {
|
---|
712 | PyObject *key = PyTuple_GET_ITEM(map, j);
|
---|
713 | PyObject *value = values[j];
|
---|
714 | if (deref)
|
---|
715 | value = PyCell_GET(value);
|
---|
716 | if (value == NULL) {
|
---|
717 | if (PyObject_DelItem(dict, key) != 0)
|
---|
718 | PyErr_Clear();
|
---|
719 | }
|
---|
720 | else {
|
---|
721 | if (PyObject_SetItem(dict, key, value) != 0)
|
---|
722 | PyErr_Clear();
|
---|
723 | }
|
---|
724 | }
|
---|
725 | }
|
---|
726 |
|
---|
727 | static void
|
---|
728 | dict_to_map(PyObject *map, Py_ssize_t nmap, PyObject *dict, PyObject **values,
|
---|
729 | Py_ssize_t deref, int clear)
|
---|
730 | {
|
---|
731 | Py_ssize_t j;
|
---|
732 | for (j = nmap; --j >= 0; ) {
|
---|
733 | PyObject *key = PyTuple_GET_ITEM(map, j);
|
---|
734 | PyObject *value = PyObject_GetItem(dict, key);
|
---|
735 | if (value == NULL)
|
---|
736 | PyErr_Clear();
|
---|
737 | if (deref) {
|
---|
738 | if (value || clear) {
|
---|
739 | if (PyCell_GET(values[j]) != value) {
|
---|
740 | if (PyCell_Set(values[j], value) < 0)
|
---|
741 | PyErr_Clear();
|
---|
742 | }
|
---|
743 | }
|
---|
744 | } else if (value != NULL || clear) {
|
---|
745 | if (values[j] != value) {
|
---|
746 | Py_XINCREF(value);
|
---|
747 | Py_XDECREF(values[j]);
|
---|
748 | values[j] = value;
|
---|
749 | }
|
---|
750 | }
|
---|
751 | Py_XDECREF(value);
|
---|
752 | }
|
---|
753 | }
|
---|
754 |
|
---|
755 | void
|
---|
756 | PyFrame_FastToLocals(PyFrameObject *f)
|
---|
757 | {
|
---|
758 | /* Merge fast locals into f->f_locals */
|
---|
759 | PyObject *locals, *map;
|
---|
760 | PyObject **fast;
|
---|
761 | PyObject *error_type, *error_value, *error_traceback;
|
---|
762 | PyCodeObject *co;
|
---|
763 | Py_ssize_t j;
|
---|
764 | int ncells, nfreevars;
|
---|
765 | if (f == NULL)
|
---|
766 | return;
|
---|
767 | locals = f->f_locals;
|
---|
768 | if (locals == NULL) {
|
---|
769 | locals = f->f_locals = PyDict_New();
|
---|
770 | if (locals == NULL) {
|
---|
771 | PyErr_Clear(); /* Can't report it :-( */
|
---|
772 | return;
|
---|
773 | }
|
---|
774 | }
|
---|
775 | co = f->f_code;
|
---|
776 | map = co->co_varnames;
|
---|
777 | if (!PyTuple_Check(map))
|
---|
778 | return;
|
---|
779 | PyErr_Fetch(&error_type, &error_value, &error_traceback);
|
---|
780 | fast = f->f_localsplus;
|
---|
781 | j = PyTuple_GET_SIZE(map);
|
---|
782 | if (j > co->co_nlocals)
|
---|
783 | j = co->co_nlocals;
|
---|
784 | if (co->co_nlocals)
|
---|
785 | map_to_dict(map, j, locals, fast, 0);
|
---|
786 | ncells = PyTuple_GET_SIZE(co->co_cellvars);
|
---|
787 | nfreevars = PyTuple_GET_SIZE(co->co_freevars);
|
---|
788 | if (ncells || nfreevars) {
|
---|
789 | map_to_dict(co->co_cellvars, ncells,
|
---|
790 | locals, fast + co->co_nlocals, 1);
|
---|
791 | map_to_dict(co->co_freevars, nfreevars,
|
---|
792 | locals, fast + co->co_nlocals + ncells, 1);
|
---|
793 | }
|
---|
794 | PyErr_Restore(error_type, error_value, error_traceback);
|
---|
795 | }
|
---|
796 |
|
---|
797 | void
|
---|
798 | PyFrame_LocalsToFast(PyFrameObject *f, int clear)
|
---|
799 | {
|
---|
800 | /* Merge f->f_locals into fast locals */
|
---|
801 | PyObject *locals, *map;
|
---|
802 | PyObject **fast;
|
---|
803 | PyObject *error_type, *error_value, *error_traceback;
|
---|
804 | PyCodeObject *co;
|
---|
805 | Py_ssize_t j;
|
---|
806 | int ncells, nfreevars;
|
---|
807 | if (f == NULL)
|
---|
808 | return;
|
---|
809 | locals = f->f_locals;
|
---|
810 | co = f->f_code;
|
---|
811 | map = co->co_varnames;
|
---|
812 | if (locals == NULL)
|
---|
813 | return;
|
---|
814 | if (!PyTuple_Check(map))
|
---|
815 | return;
|
---|
816 | PyErr_Fetch(&error_type, &error_value, &error_traceback);
|
---|
817 | fast = f->f_localsplus;
|
---|
818 | j = PyTuple_GET_SIZE(map);
|
---|
819 | if (j > co->co_nlocals)
|
---|
820 | j = co->co_nlocals;
|
---|
821 | if (co->co_nlocals)
|
---|
822 | dict_to_map(co->co_varnames, j, locals, fast, 0, clear);
|
---|
823 | ncells = PyTuple_GET_SIZE(co->co_cellvars);
|
---|
824 | nfreevars = PyTuple_GET_SIZE(co->co_freevars);
|
---|
825 | if (ncells || nfreevars) {
|
---|
826 | dict_to_map(co->co_cellvars, ncells,
|
---|
827 | locals, fast + co->co_nlocals, 1, clear);
|
---|
828 | dict_to_map(co->co_freevars, nfreevars,
|
---|
829 | locals, fast + co->co_nlocals + ncells, 1,
|
---|
830 | clear);
|
---|
831 | }
|
---|
832 | PyErr_Restore(error_type, error_value, error_traceback);
|
---|
833 | }
|
---|
834 |
|
---|
835 | /* Clear out the free list */
|
---|
836 |
|
---|
837 | void
|
---|
838 | PyFrame_Fini(void)
|
---|
839 | {
|
---|
840 | while (free_list != NULL) {
|
---|
841 | PyFrameObject *f = free_list;
|
---|
842 | free_list = free_list->f_back;
|
---|
843 | PyObject_GC_Del(f);
|
---|
844 | --numfree;
|
---|
845 | }
|
---|
846 | assert(numfree == 0);
|
---|
847 | Py_XDECREF(builtin_object);
|
---|
848 | builtin_object = NULL;
|
---|
849 | }
|
---|