Commit | Line | Data |
---|---|---|
f8f6f20b TJB |
1 | /* Python interface to stack frames |
2 | ||
28e7fd62 | 3 | Copyright (C) 2008-2013 Free Software Foundation, Inc. |
f8f6f20b TJB |
4 | |
5 | This file is part of GDB. | |
6 | ||
7 | This program is free software; you can redistribute it and/or modify | |
8 | it under the terms of the GNU General Public License as published by | |
9 | the Free Software Foundation; either version 3 of the License, or | |
10 | (at your option) any later version. | |
11 | ||
12 | This program is distributed in the hope that it will be useful, | |
13 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
15 | GNU General Public License for more details. | |
16 | ||
17 | You should have received a copy of the GNU General Public License | |
18 | along with this program. If not, see <http://www.gnu.org/licenses/>. */ | |
19 | ||
20 | #include "defs.h" | |
21 | #include "charset.h" | |
22 | #include "block.h" | |
23 | #include "frame.h" | |
24 | #include "exceptions.h" | |
25 | #include "symtab.h" | |
26 | #include "stack.h" | |
27 | #include "value.h" | |
28 | #include "python-internal.h" | |
f3e9a817 PM |
29 | #include "symfile.h" |
30 | #include "objfiles.h" | |
f8f6f20b TJB |
31 | |
32 | typedef struct { | |
33 | PyObject_HEAD | |
34 | struct frame_id frame_id; | |
35 | struct gdbarch *gdbarch; | |
36 | ||
37 | /* Marks that the FRAME_ID member actually holds the ID of the frame next | |
38 | to this, and not this frames' ID itself. This is a hack to permit Python | |
39 | frame objects which represent invalid frames (i.e., the last frame_info | |
40 | in a corrupt stack). The problem arises from the fact that this code | |
41 | relies on FRAME_ID to uniquely identify a frame, which is not always true | |
42 | for the last "frame" in a corrupt stack (it can have a null ID, or the same | |
43 | ID as the previous frame). Whenever get_prev_frame returns NULL, we | |
44 | record the frame_id of the next frame and set FRAME_ID_IS_NEXT to 1. */ | |
45 | int frame_id_is_next; | |
46 | } frame_object; | |
47 | ||
48 | /* Require a valid frame. This must be called inside a TRY_CATCH, or | |
49 | another context in which a gdb exception is allowed. */ | |
50 | #define FRAPY_REQUIRE_VALID(frame_obj, frame) \ | |
51 | do { \ | |
52 | frame = frame_object_to_frame_info (frame_obj); \ | |
53 | if (frame == NULL) \ | |
044c0f87 | 54 | error (_("Frame is invalid.")); \ |
f8f6f20b TJB |
55 | } while (0) |
56 | ||
f8f6f20b TJB |
57 | /* Returns the frame_info object corresponding to the given Python Frame |
58 | object. If the frame doesn't exist anymore (the frame id doesn't | |
59 | correspond to any frame in the inferior), returns NULL. */ | |
60 | ||
cc72b2a2 KP |
61 | struct frame_info * |
62 | frame_object_to_frame_info (PyObject *obj) | |
f8f6f20b | 63 | { |
cc72b2a2 | 64 | frame_object *frame_obj = (frame_object *) obj; |
f8f6f20b TJB |
65 | struct frame_info *frame; |
66 | ||
67 | frame = frame_find_by_id (frame_obj->frame_id); | |
68 | if (frame == NULL) | |
69 | return NULL; | |
70 | ||
71 | if (frame_obj->frame_id_is_next) | |
72 | frame = get_prev_frame (frame); | |
73 | ||
74 | return frame; | |
75 | } | |
76 | ||
77 | /* Called by the Python interpreter to obtain string representation | |
78 | of the object. */ | |
79 | ||
80 | static PyObject * | |
81 | frapy_str (PyObject *self) | |
82 | { | |
83 | char *s; | |
f8f6f20b TJB |
84 | PyObject *result; |
85 | struct ui_file *strfile; | |
86 | ||
87 | strfile = mem_fileopen (); | |
88 | fprint_frame_id (strfile, ((frame_object *) self)->frame_id); | |
759ef836 | 89 | s = ui_file_xstrdup (strfile, NULL); |
f8f6f20b TJB |
90 | result = PyString_FromString (s); |
91 | xfree (s); | |
92 | ||
93 | return result; | |
94 | } | |
95 | ||
96 | /* Implementation of gdb.Frame.is_valid (self) -> Boolean. | |
97 | Returns True if the frame corresponding to the frame_id of this | |
98 | object still exists in the inferior. */ | |
99 | ||
100 | static PyObject * | |
101 | frapy_is_valid (PyObject *self, PyObject *args) | |
102 | { | |
76dce0be PM |
103 | struct frame_info *frame = NULL; |
104 | volatile struct gdb_exception except; | |
105 | ||
106 | TRY_CATCH (except, RETURN_MASK_ALL) | |
107 | { | |
cc72b2a2 | 108 | frame = frame_object_to_frame_info (self); |
76dce0be PM |
109 | } |
110 | GDB_PY_HANDLE_EXCEPTION (except); | |
f8f6f20b | 111 | |
f8f6f20b TJB |
112 | if (frame == NULL) |
113 | Py_RETURN_FALSE; | |
114 | ||
115 | Py_RETURN_TRUE; | |
116 | } | |
117 | ||
118 | /* Implementation of gdb.Frame.name (self) -> String. | |
119 | Returns the name of the function corresponding to this frame. */ | |
120 | ||
121 | static PyObject * | |
122 | frapy_name (PyObject *self, PyObject *args) | |
123 | { | |
124 | struct frame_info *frame; | |
55b87a52 | 125 | char *name = NULL; |
f8f6f20b TJB |
126 | enum language lang; |
127 | PyObject *result; | |
128 | volatile struct gdb_exception except; | |
129 | ||
130 | TRY_CATCH (except, RETURN_MASK_ALL) | |
131 | { | |
cc72b2a2 | 132 | FRAPY_REQUIRE_VALID (self, frame); |
f8f6f20b | 133 | |
e9e07ba6 | 134 | find_frame_funname (frame, &name, &lang, NULL); |
f8f6f20b | 135 | } |
55b87a52 KS |
136 | |
137 | if (except.reason < 0) | |
138 | xfree (name); | |
139 | ||
f8f6f20b TJB |
140 | GDB_PY_HANDLE_EXCEPTION (except); |
141 | ||
142 | if (name) | |
55b87a52 KS |
143 | { |
144 | result = PyUnicode_Decode (name, strlen (name), host_charset (), NULL); | |
145 | xfree (name); | |
146 | } | |
f8f6f20b TJB |
147 | else |
148 | { | |
149 | result = Py_None; | |
150 | Py_INCREF (Py_None); | |
151 | } | |
152 | ||
153 | return result; | |
154 | } | |
155 | ||
156 | /* Implementation of gdb.Frame.type (self) -> Integer. | |
157 | Returns the frame type, namely one of the gdb.*_FRAME constants. */ | |
158 | ||
159 | static PyObject * | |
160 | frapy_type (PyObject *self, PyObject *args) | |
161 | { | |
162 | struct frame_info *frame; | |
163 | enum frame_type type = NORMAL_FRAME;/* Initialize to appease gcc warning. */ | |
164 | volatile struct gdb_exception except; | |
165 | ||
166 | TRY_CATCH (except, RETURN_MASK_ALL) | |
167 | { | |
cc72b2a2 | 168 | FRAPY_REQUIRE_VALID (self, frame); |
f8f6f20b TJB |
169 | |
170 | type = get_frame_type (frame); | |
171 | } | |
172 | GDB_PY_HANDLE_EXCEPTION (except); | |
173 | ||
174 | return PyInt_FromLong (type); | |
175 | } | |
176 | ||
bea883fd SCR |
177 | /* Implementation of gdb.Frame.architecture (self) -> gdb.Architecture. |
178 | Returns the frame's architecture as a gdb.Architecture object. */ | |
179 | ||
180 | static PyObject * | |
181 | frapy_arch (PyObject *self, PyObject *args) | |
182 | { | |
183 | struct frame_info *frame = NULL; /* Initialize to appease gcc warning. */ | |
184 | frame_object *obj = (frame_object *) self; | |
185 | volatile struct gdb_exception except; | |
186 | ||
187 | TRY_CATCH (except, RETURN_MASK_ALL) | |
188 | { | |
189 | FRAPY_REQUIRE_VALID (self, frame); | |
190 | } | |
191 | GDB_PY_HANDLE_EXCEPTION (except); | |
192 | ||
193 | return gdbarch_to_arch_object (obj->gdbarch); | |
194 | } | |
195 | ||
f8f6f20b TJB |
196 | /* Implementation of gdb.Frame.unwind_stop_reason (self) -> Integer. |
197 | Returns one of the gdb.FRAME_UNWIND_* constants. */ | |
198 | ||
199 | static PyObject * | |
200 | frapy_unwind_stop_reason (PyObject *self, PyObject *args) | |
201 | { | |
202 | struct frame_info *frame = NULL; /* Initialize to appease gcc warning. */ | |
203 | volatile struct gdb_exception except; | |
204 | enum unwind_stop_reason stop_reason; | |
205 | ||
206 | TRY_CATCH (except, RETURN_MASK_ALL) | |
207 | { | |
cc72b2a2 | 208 | FRAPY_REQUIRE_VALID (self, frame); |
f8f6f20b TJB |
209 | } |
210 | GDB_PY_HANDLE_EXCEPTION (except); | |
211 | ||
212 | stop_reason = get_frame_unwind_stop_reason (frame); | |
213 | ||
214 | return PyInt_FromLong (stop_reason); | |
215 | } | |
216 | ||
217 | /* Implementation of gdb.Frame.pc (self) -> Long. | |
218 | Returns the frame's resume address. */ | |
219 | ||
220 | static PyObject * | |
221 | frapy_pc (PyObject *self, PyObject *args) | |
222 | { | |
223 | CORE_ADDR pc = 0; /* Initialize to appease gcc warning. */ | |
224 | struct frame_info *frame; | |
225 | volatile struct gdb_exception except; | |
226 | ||
227 | TRY_CATCH (except, RETURN_MASK_ALL) | |
228 | { | |
cc72b2a2 | 229 | FRAPY_REQUIRE_VALID (self, frame); |
f8f6f20b TJB |
230 | |
231 | pc = get_frame_pc (frame); | |
232 | } | |
233 | GDB_PY_HANDLE_EXCEPTION (except); | |
234 | ||
74aedc46 | 235 | return gdb_py_long_from_ulongest (pc); |
f8f6f20b TJB |
236 | } |
237 | ||
f3e9a817 PM |
238 | /* Implementation of gdb.Frame.block (self) -> gdb.Block. |
239 | Returns the frame's code block. */ | |
240 | ||
241 | static PyObject * | |
242 | frapy_block (PyObject *self, PyObject *args) | |
243 | { | |
244 | struct frame_info *frame; | |
57126e4a | 245 | struct block *block = NULL, *fn_block; |
f3e9a817 | 246 | volatile struct gdb_exception except; |
f3e9a817 PM |
247 | |
248 | TRY_CATCH (except, RETURN_MASK_ALL) | |
249 | { | |
cc72b2a2 | 250 | FRAPY_REQUIRE_VALID (self, frame); |
57126e4a | 251 | block = get_frame_block (frame, NULL); |
f3e9a817 PM |
252 | } |
253 | GDB_PY_HANDLE_EXCEPTION (except); | |
254 | ||
57126e4a TT |
255 | for (fn_block = block; |
256 | fn_block != NULL && BLOCK_FUNCTION (fn_block) == NULL; | |
257 | fn_block = BLOCK_SUPERBLOCK (fn_block)) | |
258 | ; | |
259 | ||
260 | if (block == NULL || fn_block == NULL || BLOCK_FUNCTION (fn_block) == NULL) | |
f3e9a817 PM |
261 | { |
262 | PyErr_SetString (PyExc_RuntimeError, | |
044c0f87 | 263 | _("Cannot locate object file for block.")); |
f3e9a817 PM |
264 | return NULL; |
265 | } | |
266 | ||
267 | if (block) | |
57126e4a TT |
268 | { |
269 | struct symtab *symt; | |
270 | ||
271 | symt = SYMBOL_SYMTAB (BLOCK_FUNCTION (fn_block)); | |
272 | return block_to_block_object (block, symt->objfile); | |
273 | } | |
f3e9a817 PM |
274 | |
275 | Py_RETURN_NONE; | |
276 | } | |
277 | ||
278 | ||
279 | /* Implementation of gdb.Frame.function (self) -> gdb.Symbol. | |
280 | Returns the symbol for the function corresponding to this frame. */ | |
281 | ||
282 | static PyObject * | |
283 | frapy_function (PyObject *self, PyObject *args) | |
284 | { | |
285 | struct symbol *sym = NULL; | |
286 | struct frame_info *frame; | |
287 | volatile struct gdb_exception except; | |
288 | ||
289 | TRY_CATCH (except, RETURN_MASK_ALL) | |
290 | { | |
cc72b2a2 | 291 | FRAPY_REQUIRE_VALID (self, frame); |
f3e9a817 PM |
292 | |
293 | sym = find_pc_function (get_frame_address_in_block (frame)); | |
294 | } | |
295 | GDB_PY_HANDLE_EXCEPTION (except); | |
296 | ||
297 | if (sym) | |
298 | return symbol_to_symbol_object (sym); | |
299 | ||
300 | Py_RETURN_NONE; | |
301 | } | |
302 | ||
f8f6f20b TJB |
303 | /* Convert a frame_info struct to a Python Frame object. |
304 | Sets a Python exception and returns NULL on error. */ | |
305 | ||
595939de | 306 | PyObject * |
f8f6f20b TJB |
307 | frame_info_to_frame_object (struct frame_info *frame) |
308 | { | |
309 | frame_object *frame_obj; | |
76dce0be | 310 | volatile struct gdb_exception except; |
f8f6f20b TJB |
311 | |
312 | frame_obj = PyObject_New (frame_object, &frame_object_type); | |
313 | if (frame_obj == NULL) | |
6cbc7c3d | 314 | return NULL; |
f8f6f20b | 315 | |
76dce0be | 316 | TRY_CATCH (except, RETURN_MASK_ALL) |
f8f6f20b | 317 | { |
f8f6f20b | 318 | |
76dce0be PM |
319 | /* Try to get the previous frame, to determine if this is the last frame |
320 | in a corrupt stack. If so, we need to store the frame_id of the next | |
321 | frame and not of this one (which is possibly invalid). */ | |
322 | if (get_prev_frame (frame) == NULL | |
323 | && get_frame_unwind_stop_reason (frame) != UNWIND_NO_REASON | |
324 | && get_next_frame (frame) != NULL) | |
325 | { | |
326 | frame_obj->frame_id = get_frame_id (get_next_frame (frame)); | |
327 | frame_obj->frame_id_is_next = 1; | |
328 | } | |
329 | else | |
330 | { | |
331 | frame_obj->frame_id = get_frame_id (frame); | |
332 | frame_obj->frame_id_is_next = 0; | |
333 | } | |
334 | frame_obj->gdbarch = get_frame_arch (frame); | |
335 | } | |
336 | GDB_PY_HANDLE_EXCEPTION (except); | |
f8f6f20b | 337 | |
595939de | 338 | return (PyObject *) frame_obj; |
f8f6f20b TJB |
339 | } |
340 | ||
341 | /* Implementation of gdb.Frame.older (self) -> gdb.Frame. | |
342 | Returns the frame immediately older (outer) to this frame, or None if | |
343 | there isn't one. */ | |
344 | ||
345 | static PyObject * | |
346 | frapy_older (PyObject *self, PyObject *args) | |
347 | { | |
dcf87832 | 348 | struct frame_info *frame, *prev = NULL; |
f8f6f20b TJB |
349 | volatile struct gdb_exception except; |
350 | PyObject *prev_obj = NULL; /* Initialize to appease gcc warning. */ | |
351 | ||
352 | TRY_CATCH (except, RETURN_MASK_ALL) | |
353 | { | |
cc72b2a2 | 354 | FRAPY_REQUIRE_VALID (self, frame); |
f8f6f20b TJB |
355 | |
356 | prev = get_prev_frame (frame); | |
f8f6f20b TJB |
357 | } |
358 | GDB_PY_HANDLE_EXCEPTION (except); | |
359 | ||
dcf87832 TT |
360 | if (prev) |
361 | prev_obj = (PyObject *) frame_info_to_frame_object (prev); | |
362 | else | |
363 | { | |
364 | Py_INCREF (Py_None); | |
365 | prev_obj = Py_None; | |
366 | } | |
367 | ||
f8f6f20b TJB |
368 | return prev_obj; |
369 | } | |
370 | ||
371 | /* Implementation of gdb.Frame.newer (self) -> gdb.Frame. | |
372 | Returns the frame immediately newer (inner) to this frame, or None if | |
373 | there isn't one. */ | |
374 | ||
375 | static PyObject * | |
376 | frapy_newer (PyObject *self, PyObject *args) | |
377 | { | |
dcf87832 | 378 | struct frame_info *frame, *next = NULL; |
f8f6f20b TJB |
379 | volatile struct gdb_exception except; |
380 | PyObject *next_obj = NULL; /* Initialize to appease gcc warning. */ | |
381 | ||
382 | TRY_CATCH (except, RETURN_MASK_ALL) | |
383 | { | |
cc72b2a2 | 384 | FRAPY_REQUIRE_VALID (self, frame); |
f8f6f20b TJB |
385 | |
386 | next = get_next_frame (frame); | |
f8f6f20b TJB |
387 | } |
388 | GDB_PY_HANDLE_EXCEPTION (except); | |
389 | ||
dcf87832 TT |
390 | if (next) |
391 | next_obj = (PyObject *) frame_info_to_frame_object (next); | |
392 | else | |
393 | { | |
394 | Py_INCREF (Py_None); | |
395 | next_obj = Py_None; | |
396 | } | |
397 | ||
f8f6f20b TJB |
398 | return next_obj; |
399 | } | |
400 | ||
f3e9a817 PM |
401 | /* Implementation of gdb.Frame.find_sal (self) -> gdb.Symtab_and_line. |
402 | Returns the frame's symtab and line. */ | |
403 | ||
404 | static PyObject * | |
405 | frapy_find_sal (PyObject *self, PyObject *args) | |
406 | { | |
407 | struct frame_info *frame; | |
408 | struct symtab_and_line sal; | |
f3e9a817 PM |
409 | volatile struct gdb_exception except; |
410 | PyObject *sal_obj = NULL; /* Initialize to appease gcc warning. */ | |
411 | ||
412 | TRY_CATCH (except, RETURN_MASK_ALL) | |
413 | { | |
cc72b2a2 | 414 | FRAPY_REQUIRE_VALID (self, frame); |
f3e9a817 PM |
415 | |
416 | find_frame_sal (frame, &sal); | |
417 | sal_obj = symtab_and_line_to_sal_object (sal); | |
418 | } | |
419 | GDB_PY_HANDLE_EXCEPTION (except); | |
420 | ||
421 | return sal_obj; | |
422 | } | |
423 | ||
dc00d89f PM |
424 | /* Implementation of gdb.Frame.read_var_value (self, variable, |
425 | [block]) -> gdb.Value. If the optional block argument is provided | |
426 | start the search from that block, otherwise search from the frame's | |
427 | current block (determined by examining the resume address of the | |
428 | frame). The variable argument must be a string or an instance of a | |
8dc78533 JK |
429 | gdb.Symbol. The block argument must be an instance of gdb.Block. Returns |
430 | NULL on error, with a python exception set. */ | |
f8f6f20b TJB |
431 | static PyObject * |
432 | frapy_read_var (PyObject *self, PyObject *args) | |
433 | { | |
434 | struct frame_info *frame; | |
dc00d89f | 435 | PyObject *sym_obj, *block_obj = NULL; |
f8f6f20b TJB |
436 | struct symbol *var = NULL; /* gcc-4.3.2 false warning. */ |
437 | struct value *val = NULL; | |
438 | volatile struct gdb_exception except; | |
439 | ||
dc00d89f | 440 | if (!PyArg_ParseTuple (args, "O|O", &sym_obj, &block_obj)) |
f8f6f20b TJB |
441 | return NULL; |
442 | ||
f3e9a817 PM |
443 | if (PyObject_TypeCheck (sym_obj, &symbol_object_type)) |
444 | var = symbol_object_to_symbol (sym_obj); | |
445 | else if (gdbpy_is_string (sym_obj)) | |
f8f6f20b TJB |
446 | { |
447 | char *var_name; | |
9df2fbc4 | 448 | const struct block *block = NULL; |
f8f6f20b TJB |
449 | struct cleanup *cleanup; |
450 | volatile struct gdb_exception except; | |
451 | ||
452 | var_name = python_string_to_target_string (sym_obj); | |
453 | if (!var_name) | |
454 | return NULL; | |
455 | cleanup = make_cleanup (xfree, var_name); | |
456 | ||
dc00d89f PM |
457 | if (block_obj) |
458 | { | |
459 | block = block_object_to_block (block_obj); | |
460 | if (!block) | |
461 | { | |
462 | PyErr_SetString (PyExc_RuntimeError, | |
463 | _("Second argument must be block.")); | |
af1c6971 | 464 | do_cleanups (cleanup); |
dc00d89f PM |
465 | return NULL; |
466 | } | |
467 | } | |
468 | ||
f8f6f20b TJB |
469 | TRY_CATCH (except, RETURN_MASK_ALL) |
470 | { | |
cc72b2a2 | 471 | FRAPY_REQUIRE_VALID (self, frame); |
f8f6f20b | 472 | |
dc00d89f | 473 | if (!block) |
626e7282 | 474 | block = get_frame_block (frame, NULL); |
f8f6f20b TJB |
475 | var = lookup_symbol (var_name, block, VAR_DOMAIN, NULL); |
476 | } | |
af1c6971 TT |
477 | if (except.reason < 0) |
478 | { | |
479 | do_cleanups (cleanup); | |
f3300387 TT |
480 | gdbpy_convert_exception (except); |
481 | return NULL; | |
af1c6971 | 482 | } |
f8f6f20b TJB |
483 | |
484 | if (!var) | |
485 | { | |
486 | PyErr_Format (PyExc_ValueError, | |
044c0f87 | 487 | _("Variable '%s' not found."), var_name); |
f8f6f20b TJB |
488 | do_cleanups (cleanup); |
489 | ||
490 | return NULL; | |
491 | } | |
492 | ||
493 | do_cleanups (cleanup); | |
494 | } | |
495 | else | |
496 | { | |
497 | PyErr_SetString (PyExc_TypeError, | |
044c0f87 | 498 | _("Argument must be a symbol or string.")); |
f8f6f20b TJB |
499 | return NULL; |
500 | } | |
501 | ||
502 | TRY_CATCH (except, RETURN_MASK_ALL) | |
503 | { | |
cc72b2a2 | 504 | FRAPY_REQUIRE_VALID (self, frame); |
f8f6f20b TJB |
505 | |
506 | val = read_var_value (var, frame); | |
507 | } | |
508 | GDB_PY_HANDLE_EXCEPTION (except); | |
509 | ||
dc00d89f | 510 | return value_to_value_object (val); |
f8f6f20b TJB |
511 | } |
512 | ||
f3e9a817 PM |
513 | /* Select this frame. */ |
514 | ||
515 | static PyObject * | |
516 | frapy_select (PyObject *self, PyObject *args) | |
517 | { | |
518 | struct frame_info *fi; | |
f3e9a817 PM |
519 | volatile struct gdb_exception except; |
520 | ||
521 | TRY_CATCH (except, RETURN_MASK_ALL) | |
522 | { | |
cc72b2a2 | 523 | FRAPY_REQUIRE_VALID (self, fi); |
f3e9a817 PM |
524 | |
525 | select_frame (fi); | |
526 | } | |
527 | GDB_PY_HANDLE_EXCEPTION (except); | |
528 | ||
529 | Py_RETURN_NONE; | |
530 | } | |
531 | ||
d8e22779 TT |
532 | /* Implementation of gdb.newest_frame () -> gdb.Frame. |
533 | Returns the newest frame object. */ | |
534 | ||
535 | PyObject * | |
536 | gdbpy_newest_frame (PyObject *self, PyObject *args) | |
537 | { | |
dcf87832 | 538 | struct frame_info *frame = NULL; |
d8e22779 TT |
539 | volatile struct gdb_exception except; |
540 | ||
541 | TRY_CATCH (except, RETURN_MASK_ALL) | |
542 | { | |
543 | frame = get_current_frame (); | |
d8e22779 TT |
544 | } |
545 | GDB_PY_HANDLE_EXCEPTION (except); | |
546 | ||
dcf87832 | 547 | return frame_info_to_frame_object (frame); |
d8e22779 TT |
548 | } |
549 | ||
f8f6f20b TJB |
550 | /* Implementation of gdb.selected_frame () -> gdb.Frame. |
551 | Returns the selected frame object. */ | |
552 | ||
553 | PyObject * | |
554 | gdbpy_selected_frame (PyObject *self, PyObject *args) | |
555 | { | |
dcf87832 | 556 | struct frame_info *frame = NULL; |
f8f6f20b TJB |
557 | volatile struct gdb_exception except; |
558 | ||
559 | TRY_CATCH (except, RETURN_MASK_ALL) | |
560 | { | |
561 | frame = get_selected_frame ("No frame is currently selected."); | |
f8f6f20b TJB |
562 | } |
563 | GDB_PY_HANDLE_EXCEPTION (except); | |
564 | ||
dcf87832 | 565 | return frame_info_to_frame_object (frame); |
f8f6f20b TJB |
566 | } |
567 | ||
568 | /* Implementation of gdb.stop_reason_string (Integer) -> String. | |
569 | Return a string explaining the unwind stop reason. */ | |
570 | ||
571 | PyObject * | |
572 | gdbpy_frame_stop_reason_string (PyObject *self, PyObject *args) | |
573 | { | |
574 | int reason; | |
575 | const char *str; | |
576 | ||
577 | if (!PyArg_ParseTuple (args, "i", &reason)) | |
578 | return NULL; | |
579 | ||
2231f1fb | 580 | if (reason < UNWIND_FIRST || reason > UNWIND_LAST) |
f8f6f20b | 581 | { |
044c0f87 PM |
582 | PyErr_SetString (PyExc_ValueError, |
583 | _("Invalid frame stop reason.")); | |
f8f6f20b TJB |
584 | return NULL; |
585 | } | |
586 | ||
587 | str = frame_stop_reason_string (reason); | |
588 | return PyUnicode_Decode (str, strlen (str), host_charset (), NULL); | |
589 | } | |
590 | ||
591 | /* Implements the equality comparison for Frame objects. | |
592 | All other comparison operators will throw a TypeError Python exception, | |
593 | as they aren't valid for frames. */ | |
594 | ||
595 | static PyObject * | |
596 | frapy_richcompare (PyObject *self, PyObject *other, int op) | |
597 | { | |
18e8c3bc TT |
598 | int result; |
599 | ||
600 | if (!PyObject_TypeCheck (other, &frame_object_type) | |
601 | || (op != Py_EQ && op != Py_NE)) | |
f8f6f20b | 602 | { |
18e8c3bc TT |
603 | Py_INCREF (Py_NotImplemented); |
604 | return Py_NotImplemented; | |
f8f6f20b TJB |
605 | } |
606 | ||
607 | if (frame_id_eq (((frame_object *) self)->frame_id, | |
608 | ((frame_object *) other)->frame_id)) | |
18e8c3bc TT |
609 | result = Py_EQ; |
610 | else | |
611 | result = Py_NE; | |
f8f6f20b | 612 | |
18e8c3bc TT |
613 | if (op == result) |
614 | Py_RETURN_TRUE; | |
f8f6f20b TJB |
615 | Py_RETURN_FALSE; |
616 | } | |
617 | ||
618 | /* Sets up the Frame API in the gdb module. */ | |
619 | ||
999633ed | 620 | int |
f8f6f20b TJB |
621 | gdbpy_initialize_frames (void) |
622 | { | |
6a1b1664 | 623 | frame_object_type.tp_new = PyType_GenericNew; |
f8f6f20b | 624 | if (PyType_Ready (&frame_object_type) < 0) |
999633ed | 625 | return -1; |
f8f6f20b | 626 | |
9a2b4c1b MS |
627 | /* Note: These would probably be best exposed as class attributes of |
628 | Frame, but I don't know how to do it except by messing with the | |
629 | type's dictionary. That seems too messy. */ | |
999633ed TT |
630 | if (PyModule_AddIntConstant (gdb_module, "NORMAL_FRAME", NORMAL_FRAME) < 0 |
631 | || PyModule_AddIntConstant (gdb_module, "DUMMY_FRAME", DUMMY_FRAME) < 0 | |
632 | || PyModule_AddIntConstant (gdb_module, "INLINE_FRAME", INLINE_FRAME) < 0 | |
633 | || PyModule_AddIntConstant (gdb_module, "TAILCALL_FRAME", | |
634 | TAILCALL_FRAME) < 0 | |
635 | || PyModule_AddIntConstant (gdb_module, "SIGTRAMP_FRAME", | |
636 | SIGTRAMP_FRAME) < 0 | |
637 | || PyModule_AddIntConstant (gdb_module, "ARCH_FRAME", ARCH_FRAME) < 0 | |
638 | || PyModule_AddIntConstant (gdb_module, "SENTINEL_FRAME", | |
639 | SENTINEL_FRAME) < 0) | |
640 | return -1; | |
2231f1fb KP |
641 | |
642 | #define SET(name, description) \ | |
999633ed TT |
643 | if (PyModule_AddIntConstant (gdb_module, "FRAME_"#name, name) < 0) \ |
644 | return -1; | |
2231f1fb | 645 | #define FIRST_ERROR(name) \ |
999633ed TT |
646 | if (PyModule_AddIntConstant (gdb_module, "FRAME_"#name, name) < 0) \ |
647 | return -1; | |
2231f1fb KP |
648 | #include "unwind_stop_reasons.def" |
649 | #undef SET | |
999633ed | 650 | #undef FIRST_ERROR |
f8f6f20b | 651 | |
aa36459a TT |
652 | return gdb_pymodule_addobject (gdb_module, "Frame", |
653 | (PyObject *) &frame_object_type); | |
f8f6f20b TJB |
654 | } |
655 | ||
656 | \f | |
657 | ||
658 | static PyMethodDef frame_object_methods[] = { | |
659 | { "is_valid", frapy_is_valid, METH_NOARGS, | |
660 | "is_valid () -> Boolean.\n\ | |
661 | Return true if this frame is valid, false if not." }, | |
662 | { "name", frapy_name, METH_NOARGS, | |
663 | "name () -> String.\n\ | |
664 | Return the function name of the frame, or None if it can't be determined." }, | |
665 | { "type", frapy_type, METH_NOARGS, | |
666 | "type () -> Integer.\n\ | |
667 | Return the type of the frame." }, | |
bea883fd SCR |
668 | { "architecture", frapy_arch, METH_NOARGS, |
669 | "architecture () -> gdb.Architecture.\n\ | |
670 | Return the architecture of the frame." }, | |
f8f6f20b TJB |
671 | { "unwind_stop_reason", frapy_unwind_stop_reason, METH_NOARGS, |
672 | "unwind_stop_reason () -> Integer.\n\ | |
673 | Return the reason why it's not possible to find frames older than this." }, | |
674 | { "pc", frapy_pc, METH_NOARGS, | |
675 | "pc () -> Long.\n\ | |
676 | Return the frame's resume address." }, | |
f3e9a817 PM |
677 | { "block", frapy_block, METH_NOARGS, |
678 | "block () -> gdb.Block.\n\ | |
679 | Return the frame's code block." }, | |
680 | { "function", frapy_function, METH_NOARGS, | |
681 | "function () -> gdb.Symbol.\n\ | |
682 | Returns the symbol for the function corresponding to this frame." }, | |
f8f6f20b TJB |
683 | { "older", frapy_older, METH_NOARGS, |
684 | "older () -> gdb.Frame.\n\ | |
685 | Return the frame that called this frame." }, | |
686 | { "newer", frapy_newer, METH_NOARGS, | |
687 | "newer () -> gdb.Frame.\n\ | |
688 | Return the frame called by this frame." }, | |
f3e9a817 PM |
689 | { "find_sal", frapy_find_sal, METH_NOARGS, |
690 | "find_sal () -> gdb.Symtab_and_line.\n\ | |
691 | Return the frame's symtab and line." }, | |
f8f6f20b TJB |
692 | { "read_var", frapy_read_var, METH_VARARGS, |
693 | "read_var (variable) -> gdb.Value.\n\ | |
694 | Return the value of the variable in this frame." }, | |
f3e9a817 PM |
695 | { "select", frapy_select, METH_NOARGS, |
696 | "Select this frame as the user's current frame." }, | |
f8f6f20b TJB |
697 | {NULL} /* Sentinel */ |
698 | }; | |
699 | ||
f0823d2c | 700 | PyTypeObject frame_object_type = { |
9a27f2c6 | 701 | PyVarObject_HEAD_INIT (NULL, 0) |
f8f6f20b TJB |
702 | "gdb.Frame", /* tp_name */ |
703 | sizeof (frame_object), /* tp_basicsize */ | |
704 | 0, /* tp_itemsize */ | |
705 | 0, /* tp_dealloc */ | |
706 | 0, /* tp_print */ | |
707 | 0, /* tp_getattr */ | |
708 | 0, /* tp_setattr */ | |
709 | 0, /* tp_compare */ | |
710 | 0, /* tp_repr */ | |
711 | 0, /* tp_as_number */ | |
712 | 0, /* tp_as_sequence */ | |
713 | 0, /* tp_as_mapping */ | |
714 | 0, /* tp_hash */ | |
715 | 0, /* tp_call */ | |
716 | frapy_str, /* tp_str */ | |
717 | 0, /* tp_getattro */ | |
718 | 0, /* tp_setattro */ | |
719 | 0, /* tp_as_buffer */ | |
720 | Py_TPFLAGS_DEFAULT, /* tp_flags */ | |
721 | "GDB frame object", /* tp_doc */ | |
722 | 0, /* tp_traverse */ | |
723 | 0, /* tp_clear */ | |
724 | frapy_richcompare, /* tp_richcompare */ | |
725 | 0, /* tp_weaklistoffset */ | |
726 | 0, /* tp_iter */ | |
727 | 0, /* tp_iternext */ | |
728 | frame_object_methods, /* tp_methods */ | |
729 | 0, /* tp_members */ | |
730 | 0, /* tp_getset */ | |
731 | 0, /* tp_base */ | |
732 | 0, /* tp_dict */ | |
733 | 0, /* tp_descr_get */ | |
734 | 0, /* tp_descr_set */ | |
735 | 0, /* tp_dictoffset */ | |
736 | 0, /* tp_init */ | |
737 | 0, /* tp_alloc */ | |
f8f6f20b | 738 | }; |