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