Commit | Line | Data |
---|---|---|
d11916aa SS |
1 | /* Python frame unwinder interface. |
2 | ||
b811d2c2 | 3 | Copyright (C) 2015-2020 Free Software Foundation, Inc. |
d11916aa SS |
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 "arch-utils.h" | |
22 | #include "frame-unwind.h" | |
23 | #include "gdb_obstack.h" | |
24 | #include "gdbcmd.h" | |
25 | #include "language.h" | |
76727919 | 26 | #include "observable.h" |
d11916aa SS |
27 | #include "python-internal.h" |
28 | #include "regcache.h" | |
29 | #include "valprint.h" | |
30 | #include "user-regs.h" | |
31 | ||
32 | #define TRACE_PY_UNWIND(level, args...) if (pyuw_debug >= level) \ | |
33 | { fprintf_unfiltered (gdb_stdlog, args); } | |
34 | ||
35 | typedef struct | |
36 | { | |
37 | PyObject_HEAD | |
38 | ||
39 | /* Frame we are unwinding. */ | |
40 | struct frame_info *frame_info; | |
41 | ||
42 | /* Its architecture, passed by the sniffer caller. */ | |
43 | struct gdbarch *gdbarch; | |
44 | } pending_frame_object; | |
45 | ||
46 | /* Saved registers array item. */ | |
47 | ||
0c6aef22 | 48 | struct saved_reg |
d11916aa | 49 | { |
0c6aef22 TT |
50 | saved_reg (int n, gdbpy_ref<> &&v) |
51 | : number (n), | |
52 | value (std::move (v)) | |
53 | { | |
54 | } | |
55 | ||
d11916aa | 56 | int number; |
0c6aef22 TT |
57 | gdbpy_ref<> value; |
58 | }; | |
d11916aa SS |
59 | |
60 | /* The data we keep for the PyUnwindInfo: pending_frame, saved registers | |
61 | and frame ID. */ | |
62 | ||
63 | typedef struct | |
64 | { | |
65 | PyObject_HEAD | |
66 | ||
67 | /* gdb.PendingFrame for the frame we are unwinding. */ | |
68 | PyObject *pending_frame; | |
69 | ||
70 | /* Its ID. */ | |
71 | struct frame_id frame_id; | |
72 | ||
73 | /* Saved registers array. */ | |
0c6aef22 | 74 | std::vector<saved_reg> *saved_regs; |
d11916aa SS |
75 | } unwind_info_object; |
76 | ||
77 | /* The data we keep for a frame we can unwind: frame ID and an array of | |
78 | (register_number, register_value) pairs. */ | |
79 | ||
80 | typedef struct | |
81 | { | |
82 | /* Frame ID. */ | |
83 | struct frame_id frame_id; | |
84 | ||
85 | /* GDB Architecture. */ | |
86 | struct gdbarch *gdbarch; | |
87 | ||
88 | /* Length of the `reg' array below. */ | |
89 | int reg_count; | |
90 | ||
4fa847d7 | 91 | cached_reg_t reg[]; |
d11916aa SS |
92 | } cached_frame_info; |
93 | ||
13fa0398 | 94 | extern PyTypeObject pending_frame_object_type |
d11916aa SS |
95 | CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("pending_frame_object"); |
96 | ||
13fa0398 | 97 | extern PyTypeObject unwind_info_object_type |
d11916aa SS |
98 | CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("unwind_info_object"); |
99 | ||
100 | static unsigned int pyuw_debug = 0; | |
101 | ||
102 | static struct gdbarch_data *pyuw_gdbarch_data; | |
103 | ||
104 | /* Parses register id, which can be either a number or a name. | |
105 | Returns 1 on success, 0 otherwise. */ | |
106 | ||
107 | static int | |
108 | pyuw_parse_register_id (struct gdbarch *gdbarch, PyObject *pyo_reg_id, | |
109 | int *reg_num) | |
110 | { | |
111 | if (pyo_reg_id == NULL) | |
112 | return 0; | |
113 | if (gdbpy_is_string (pyo_reg_id)) | |
114 | { | |
9b972014 | 115 | gdb::unique_xmalloc_ptr<char> reg_name (gdbpy_obj_to_string (pyo_reg_id)); |
d11916aa SS |
116 | |
117 | if (reg_name == NULL) | |
118 | return 0; | |
9b972014 TT |
119 | *reg_num = user_reg_map_name_to_regnum (gdbarch, reg_name.get (), |
120 | strlen (reg_name.get ())); | |
d11916aa SS |
121 | return *reg_num >= 0; |
122 | } | |
123 | else if (PyInt_Check (pyo_reg_id)) | |
124 | { | |
125 | long value; | |
126 | if (gdb_py_int_as_long (pyo_reg_id, &value) && (int) value == value) | |
127 | { | |
128 | *reg_num = (int) value; | |
129 | return user_reg_map_regnum_to_name (gdbarch, *reg_num) != NULL; | |
130 | } | |
131 | } | |
132 | return 0; | |
133 | } | |
134 | ||
135 | /* Convert gdb.Value instance to inferior's pointer. Return 1 on success, | |
136 | 0 on failure. */ | |
137 | ||
138 | static int | |
139 | pyuw_value_obj_to_pointer (PyObject *pyo_value, CORE_ADDR *addr) | |
140 | { | |
141 | int rc = 0; | |
142 | struct value *value; | |
143 | ||
a70b8144 | 144 | try |
d11916aa SS |
145 | { |
146 | if ((value = value_object_to_value (pyo_value)) != NULL) | |
147 | { | |
148 | *addr = unpack_pointer (value_type (value), | |
149 | value_contents (value)); | |
150 | rc = 1; | |
151 | } | |
152 | } | |
230d2906 | 153 | catch (const gdb_exception &except) |
d11916aa SS |
154 | { |
155 | gdbpy_convert_exception (except); | |
156 | } | |
d11916aa SS |
157 | return rc; |
158 | } | |
159 | ||
160 | /* Get attribute from an object and convert it to the inferior's | |
161 | pointer value. Return 1 if attribute exists and its value can be | |
162 | converted. Otherwise, if attribute does not exist or its value is | |
163 | None, return 0. In all other cases set Python error and return | |
164 | 0. */ | |
165 | ||
166 | static int | |
167 | pyuw_object_attribute_to_pointer (PyObject *pyo, const char *attr_name, | |
168 | CORE_ADDR *addr) | |
169 | { | |
170 | int rc = 0; | |
171 | ||
172 | if (PyObject_HasAttrString (pyo, attr_name)) | |
173 | { | |
7780f186 | 174 | gdbpy_ref<> pyo_value (PyObject_GetAttrString (pyo, attr_name)); |
d11916aa SS |
175 | |
176 | if (pyo_value != NULL && pyo_value != Py_None) | |
177 | { | |
4586d543 | 178 | rc = pyuw_value_obj_to_pointer (pyo_value.get (), addr); |
d11916aa SS |
179 | if (!rc) |
180 | PyErr_Format ( | |
181 | PyExc_ValueError, | |
182 | _("The value of the '%s' attribute is not a pointer."), | |
183 | attr_name); | |
184 | } | |
d11916aa SS |
185 | } |
186 | return rc; | |
187 | } | |
188 | ||
189 | /* Called by the Python interpreter to obtain string representation | |
190 | of the UnwindInfo object. */ | |
191 | ||
192 | static PyObject * | |
193 | unwind_infopy_str (PyObject *self) | |
194 | { | |
d11916aa | 195 | unwind_info_object *unwind_info = (unwind_info_object *) self; |
d7e74731 | 196 | string_file stb; |
d11916aa | 197 | |
d7e74731 PA |
198 | stb.puts ("Frame ID: "); |
199 | fprint_frame_id (&stb, unwind_info->frame_id); | |
d11916aa | 200 | { |
a121b7c1 | 201 | const char *sep = ""; |
d11916aa | 202 | struct value_print_options opts; |
d11916aa SS |
203 | |
204 | get_user_print_options (&opts); | |
d7e74731 | 205 | stb.printf ("\nSaved registers: ("); |
0c6aef22 | 206 | for (const saved_reg ® : *unwind_info->saved_regs) |
d11916aa | 207 | { |
0c6aef22 | 208 | struct value *value = value_object_to_value (reg.value.get ()); |
d11916aa | 209 | |
0c6aef22 | 210 | stb.printf ("%s(%d, ", sep, reg.number); |
d11916aa SS |
211 | if (value != NULL) |
212 | { | |
a70b8144 | 213 | try |
d11916aa | 214 | { |
d7e74731 PA |
215 | value_print (value, &stb, &opts); |
216 | stb.puts (")"); | |
d11916aa | 217 | } |
230d2906 | 218 | catch (const gdb_exception &except) |
d11916aa SS |
219 | { |
220 | GDB_PY_HANDLE_EXCEPTION (except); | |
221 | } | |
d11916aa SS |
222 | } |
223 | else | |
d7e74731 | 224 | stb.puts ("<BAD>)"); |
d11916aa SS |
225 | sep = ", "; |
226 | } | |
d7e74731 | 227 | stb.puts (")"); |
d11916aa | 228 | } |
d11916aa | 229 | |
d7e74731 | 230 | return PyString_FromString (stb.c_str ()); |
d11916aa SS |
231 | } |
232 | ||
233 | /* Create UnwindInfo instance for given PendingFrame and frame ID. | |
234 | Sets Python error and returns NULL on error. */ | |
235 | ||
236 | static PyObject * | |
237 | pyuw_create_unwind_info (PyObject *pyo_pending_frame, | |
238 | struct frame_id frame_id) | |
239 | { | |
240 | unwind_info_object *unwind_info | |
241 | = PyObject_New (unwind_info_object, &unwind_info_object_type); | |
242 | ||
243 | if (((pending_frame_object *) pyo_pending_frame)->frame_info == NULL) | |
244 | { | |
245 | PyErr_SetString (PyExc_ValueError, | |
246 | "Attempting to use stale PendingFrame"); | |
247 | return NULL; | |
248 | } | |
249 | unwind_info->frame_id = frame_id; | |
250 | Py_INCREF (pyo_pending_frame); | |
251 | unwind_info->pending_frame = pyo_pending_frame; | |
0c6aef22 | 252 | unwind_info->saved_regs = new std::vector<saved_reg>; |
d11916aa SS |
253 | return (PyObject *) unwind_info; |
254 | } | |
255 | ||
256 | /* The implementation of | |
257 | gdb.UnwindInfo.add_saved_register (REG, VALUE) -> None. */ | |
258 | ||
259 | static PyObject * | |
260 | unwind_infopy_add_saved_register (PyObject *self, PyObject *args) | |
261 | { | |
262 | unwind_info_object *unwind_info = (unwind_info_object *) self; | |
263 | pending_frame_object *pending_frame | |
264 | = (pending_frame_object *) (unwind_info->pending_frame); | |
265 | PyObject *pyo_reg_id; | |
266 | PyObject *pyo_reg_value; | |
267 | int regnum; | |
268 | ||
269 | if (pending_frame->frame_info == NULL) | |
270 | { | |
271 | PyErr_SetString (PyExc_ValueError, | |
272 | "UnwindInfo instance refers to a stale PendingFrame"); | |
273 | return NULL; | |
274 | } | |
275 | if (!PyArg_UnpackTuple (args, "previous_frame_register", 2, 2, | |
276 | &pyo_reg_id, &pyo_reg_value)) | |
277 | return NULL; | |
278 | if (!pyuw_parse_register_id (pending_frame->gdbarch, pyo_reg_id, ®num)) | |
279 | { | |
280 | PyErr_SetString (PyExc_ValueError, "Bad register"); | |
281 | return NULL; | |
282 | } | |
283 | { | |
284 | struct value *value; | |
285 | size_t data_size; | |
286 | ||
287 | if (pyo_reg_value == NULL | |
288 | || (value = value_object_to_value (pyo_reg_value)) == NULL) | |
289 | { | |
290 | PyErr_SetString (PyExc_ValueError, "Bad register value"); | |
291 | return NULL; | |
292 | } | |
293 | data_size = register_size (pending_frame->gdbarch, regnum); | |
294 | if (data_size != TYPE_LENGTH (value_type (value))) | |
295 | { | |
296 | PyErr_Format ( | |
297 | PyExc_ValueError, | |
298 | "The value of the register returned by the Python " | |
299 | "sniffer has unexpected size: %u instead of %u.", | |
300 | (unsigned) TYPE_LENGTH (value_type (value)), | |
301 | (unsigned) data_size); | |
302 | return NULL; | |
303 | } | |
304 | } | |
305 | { | |
0c6aef22 TT |
306 | gdbpy_ref<> new_value = gdbpy_ref<>::new_reference (pyo_reg_value); |
307 | bool found = false; | |
308 | for (saved_reg ® : *unwind_info->saved_regs) | |
d11916aa | 309 | { |
0c6aef22 | 310 | if (regnum == reg.number) |
d11916aa | 311 | { |
0c6aef22 TT |
312 | found = true; |
313 | reg.value = std::move (new_value); | |
d11916aa SS |
314 | break; |
315 | } | |
316 | } | |
0c6aef22 TT |
317 | if (!found) |
318 | unwind_info->saved_regs->emplace_back (regnum, std::move (new_value)); | |
d11916aa SS |
319 | } |
320 | Py_RETURN_NONE; | |
321 | } | |
322 | ||
323 | /* UnwindInfo cleanup. */ | |
324 | ||
325 | static void | |
326 | unwind_infopy_dealloc (PyObject *self) | |
327 | { | |
328 | unwind_info_object *unwind_info = (unwind_info_object *) self; | |
d11916aa SS |
329 | |
330 | Py_XDECREF (unwind_info->pending_frame); | |
0c6aef22 | 331 | delete unwind_info->saved_regs; |
d11916aa SS |
332 | Py_TYPE (self)->tp_free (self); |
333 | } | |
334 | ||
335 | /* Called by the Python interpreter to obtain string representation | |
336 | of the PendingFrame object. */ | |
337 | ||
338 | static PyObject * | |
339 | pending_framepy_str (PyObject *self) | |
340 | { | |
341 | struct frame_info *frame = ((pending_frame_object *) self)->frame_info; | |
342 | const char *sp_str = NULL; | |
343 | const char *pc_str = NULL; | |
344 | ||
345 | if (frame == NULL) | |
346 | return PyString_FromString ("Stale PendingFrame instance"); | |
a70b8144 | 347 | try |
d11916aa SS |
348 | { |
349 | sp_str = core_addr_to_string_nz (get_frame_sp (frame)); | |
350 | pc_str = core_addr_to_string_nz (get_frame_pc (frame)); | |
351 | } | |
230d2906 | 352 | catch (const gdb_exception &except) |
d11916aa SS |
353 | { |
354 | GDB_PY_HANDLE_EXCEPTION (except); | |
355 | } | |
d11916aa SS |
356 | |
357 | return PyString_FromFormat ("SP=%s,PC=%s", sp_str, pc_str); | |
358 | } | |
359 | ||
360 | /* Implementation of gdb.PendingFrame.read_register (self, reg) -> gdb.Value. | |
361 | Returns the value of register REG as gdb.Value instance. */ | |
362 | ||
363 | static PyObject * | |
364 | pending_framepy_read_register (PyObject *self, PyObject *args) | |
365 | { | |
366 | pending_frame_object *pending_frame = (pending_frame_object *) self; | |
367 | struct value *val = NULL; | |
368 | int regnum; | |
369 | PyObject *pyo_reg_id; | |
370 | ||
371 | if (pending_frame->frame_info == NULL) | |
372 | { | |
373 | PyErr_SetString (PyExc_ValueError, | |
374 | "Attempting to read register from stale PendingFrame"); | |
375 | return NULL; | |
376 | } | |
377 | if (!PyArg_UnpackTuple (args, "read_register", 1, 1, &pyo_reg_id)) | |
378 | return NULL; | |
379 | if (!pyuw_parse_register_id (pending_frame->gdbarch, pyo_reg_id, ®num)) | |
380 | { | |
381 | PyErr_SetString (PyExc_ValueError, "Bad register"); | |
382 | return NULL; | |
383 | } | |
384 | ||
a70b8144 | 385 | try |
d11916aa | 386 | { |
33cc7d36 KB |
387 | /* Fetch the value associated with a register, whether it's |
388 | a real register or a so called "user" register, like "pc", | |
389 | which maps to a real register. In the past, | |
390 | get_frame_register_value() was used here, which did not | |
391 | handle the user register case. */ | |
392 | val = value_of_register (regnum, pending_frame->frame_info); | |
d11916aa SS |
393 | if (val == NULL) |
394 | PyErr_Format (PyExc_ValueError, | |
395 | "Cannot read register %d from frame.", | |
396 | regnum); | |
397 | } | |
230d2906 | 398 | catch (const gdb_exception &except) |
d11916aa SS |
399 | { |
400 | GDB_PY_HANDLE_EXCEPTION (except); | |
401 | } | |
d11916aa SS |
402 | |
403 | return val == NULL ? NULL : value_to_value_object (val); | |
404 | } | |
405 | ||
406 | /* Implementation of | |
407 | PendingFrame.create_unwind_info (self, frameId) -> UnwindInfo. */ | |
408 | ||
409 | static PyObject * | |
410 | pending_framepy_create_unwind_info (PyObject *self, PyObject *args) | |
411 | { | |
412 | PyObject *pyo_frame_id; | |
413 | CORE_ADDR sp; | |
414 | CORE_ADDR pc; | |
415 | CORE_ADDR special; | |
416 | ||
417 | if (!PyArg_ParseTuple (args, "O:create_unwind_info", &pyo_frame_id)) | |
418 | return NULL; | |
419 | if (!pyuw_object_attribute_to_pointer (pyo_frame_id, "sp", &sp)) | |
420 | { | |
421 | PyErr_SetString (PyExc_ValueError, | |
422 | _("frame_id should have 'sp' attribute.")); | |
423 | return NULL; | |
424 | } | |
425 | ||
426 | /* The logic of building frame_id depending on the attributes of | |
427 | the frame_id object: | |
428 | Has Has Has Function to call | |
429 | 'sp'? 'pc'? 'special'? | |
430 | ------|------|--------------|------------------------- | |
431 | Y N * frame_id_build_wild (sp) | |
432 | Y Y N frame_id_build (sp, pc) | |
433 | Y Y Y frame_id_build_special (sp, pc, special) | |
434 | */ | |
435 | if (!pyuw_object_attribute_to_pointer (pyo_frame_id, "pc", &pc)) | |
436 | return pyuw_create_unwind_info (self, frame_id_build_wild (sp)); | |
437 | if (!pyuw_object_attribute_to_pointer (pyo_frame_id, "special", &special)) | |
438 | return pyuw_create_unwind_info (self, frame_id_build (sp, pc)); | |
439 | else | |
440 | return pyuw_create_unwind_info (self, | |
441 | frame_id_build_special (sp, pc, special)); | |
442 | } | |
443 | ||
87dbc774 AB |
444 | /* Implementation of PendingFrame.architecture (self) -> gdb.Architecture. */ |
445 | ||
446 | static PyObject * | |
447 | pending_framepy_architecture (PyObject *self, PyObject *args) | |
448 | { | |
449 | pending_frame_object *pending_frame = (pending_frame_object *) self; | |
450 | ||
451 | if (pending_frame->frame_info == NULL) | |
452 | { | |
453 | PyErr_SetString (PyExc_ValueError, | |
454 | "Attempting to read register from stale PendingFrame"); | |
455 | return NULL; | |
456 | } | |
457 | return gdbarch_to_arch_object (pending_frame->gdbarch); | |
458 | } | |
459 | ||
d11916aa SS |
460 | /* frame_unwind.this_id method. */ |
461 | ||
462 | static void | |
463 | pyuw_this_id (struct frame_info *this_frame, void **cache_ptr, | |
464 | struct frame_id *this_id) | |
465 | { | |
466 | *this_id = ((cached_frame_info *) *cache_ptr)->frame_id; | |
467 | if (pyuw_debug >= 1) | |
468 | { | |
469 | fprintf_unfiltered (gdb_stdlog, "%s: frame_id: ", __FUNCTION__); | |
470 | fprint_frame_id (gdb_stdlog, *this_id); | |
471 | fprintf_unfiltered (gdb_stdlog, "\n"); | |
472 | } | |
473 | } | |
474 | ||
475 | /* frame_unwind.prev_register. */ | |
476 | ||
477 | static struct value * | |
478 | pyuw_prev_register (struct frame_info *this_frame, void **cache_ptr, | |
479 | int regnum) | |
480 | { | |
19ba03f4 | 481 | cached_frame_info *cached_frame = (cached_frame_info *) *cache_ptr; |
4fa847d7 AH |
482 | cached_reg_t *reg_info = cached_frame->reg; |
483 | cached_reg_t *reg_info_end = reg_info + cached_frame->reg_count; | |
d11916aa SS |
484 | |
485 | TRACE_PY_UNWIND (1, "%s (frame=%p,...,reg=%d)\n", __FUNCTION__, this_frame, | |
486 | regnum); | |
487 | for (; reg_info < reg_info_end; ++reg_info) | |
488 | { | |
4fa847d7 | 489 | if (regnum == reg_info->num) |
d11916aa SS |
490 | return frame_unwind_got_bytes (this_frame, regnum, reg_info->data); |
491 | } | |
492 | ||
493 | return frame_unwind_got_optimized (this_frame, regnum); | |
494 | } | |
495 | ||
496 | /* Frame sniffer dispatch. */ | |
497 | ||
498 | static int | |
499 | pyuw_sniffer (const struct frame_unwind *self, struct frame_info *this_frame, | |
500 | void **cache_ptr) | |
501 | { | |
502 | struct gdbarch *gdbarch = (struct gdbarch *) (self->unwind_data); | |
d11916aa SS |
503 | cached_frame_info *cached_frame; |
504 | ||
c0171de6 TT |
505 | gdbpy_enter enter_py (gdbarch, current_language); |
506 | ||
d11916aa SS |
507 | TRACE_PY_UNWIND (3, "%s (SP=%s, PC=%s)\n", __FUNCTION__, |
508 | paddress (gdbarch, get_frame_sp (this_frame)), | |
509 | paddress (gdbarch, get_frame_pc (this_frame))); | |
510 | ||
511 | /* Create PendingFrame instance to pass to sniffers. */ | |
c0171de6 TT |
512 | pending_frame_object *pfo = PyObject_New (pending_frame_object, |
513 | &pending_frame_object_type); | |
7780f186 | 514 | gdbpy_ref<> pyo_pending_frame ((PyObject *) pfo); |
d11916aa | 515 | if (pyo_pending_frame == NULL) |
c0171de6 TT |
516 | { |
517 | gdbpy_print_stack (); | |
518 | return 0; | |
519 | } | |
520 | pfo->gdbarch = gdbarch; | |
521 | scoped_restore invalidate_frame = make_scoped_restore (&pfo->frame_info, | |
522 | this_frame); | |
d11916aa SS |
523 | |
524 | /* Run unwinders. */ | |
525 | if (gdb_python_module == NULL | |
08235187 | 526 | || ! PyObject_HasAttrString (gdb_python_module, "_execute_unwinders")) |
d11916aa SS |
527 | { |
528 | PyErr_SetString (PyExc_NameError, | |
08235187 | 529 | "Installation error: gdb._execute_unwinders function " |
d11916aa | 530 | "is missing"); |
c0171de6 TT |
531 | gdbpy_print_stack (); |
532 | return 0; | |
d11916aa | 533 | } |
7780f186 | 534 | gdbpy_ref<> pyo_execute (PyObject_GetAttrString (gdb_python_module, |
08235187 | 535 | "_execute_unwinders")); |
d11916aa | 536 | if (pyo_execute == NULL) |
c0171de6 TT |
537 | { |
538 | gdbpy_print_stack (); | |
539 | return 0; | |
540 | } | |
541 | ||
7780f186 | 542 | gdbpy_ref<> pyo_unwind_info |
c0171de6 TT |
543 | (PyObject_CallFunctionObjArgs (pyo_execute.get (), |
544 | pyo_pending_frame.get (), NULL)); | |
d11916aa | 545 | if (pyo_unwind_info == NULL) |
c0171de6 | 546 | { |
9ccabccd PA |
547 | /* If the unwinder is cancelled due to a Ctrl-C, then propagate |
548 | the Ctrl-C as a GDB exception instead of swallowing it. */ | |
6ef2312a | 549 | gdbpy_print_stack_or_quit (); |
c0171de6 TT |
550 | return 0; |
551 | } | |
d11916aa | 552 | if (pyo_unwind_info == Py_None) |
c0171de6 | 553 | return 0; |
d11916aa SS |
554 | |
555 | /* Received UnwindInfo, cache data. */ | |
c0171de6 | 556 | if (PyObject_IsInstance (pyo_unwind_info.get (), |
d11916aa SS |
557 | (PyObject *) &unwind_info_object_type) <= 0) |
558 | error (_("A Unwinder should return gdb.UnwindInfo instance.")); | |
559 | ||
560 | { | |
c0171de6 TT |
561 | unwind_info_object *unwind_info = |
562 | (unwind_info_object *) pyo_unwind_info.get (); | |
0c6aef22 | 563 | int reg_count = unwind_info->saved_regs->size (); |
d11916aa | 564 | |
16892a03 AH |
565 | cached_frame |
566 | = ((cached_frame_info *) | |
567 | xmalloc (sizeof (*cached_frame) | |
568 | + reg_count * sizeof (cached_frame->reg[0]))); | |
d11916aa SS |
569 | cached_frame->gdbarch = gdbarch; |
570 | cached_frame->frame_id = unwind_info->frame_id; | |
571 | cached_frame->reg_count = reg_count; | |
572 | ||
573 | /* Populate registers array. */ | |
0c6aef22 | 574 | for (int i = 0; i < unwind_info->saved_regs->size (); ++i) |
d11916aa | 575 | { |
0c6aef22 TT |
576 | saved_reg *reg = &(*unwind_info->saved_regs)[i]; |
577 | ||
578 | struct value *value = value_object_to_value (reg->value.get ()); | |
d11916aa SS |
579 | size_t data_size = register_size (gdbarch, reg->number); |
580 | ||
4fa847d7 | 581 | cached_frame->reg[i].num = reg->number; |
d11916aa SS |
582 | |
583 | /* `value' validation was done before, just assert. */ | |
584 | gdb_assert (value != NULL); | |
585 | gdb_assert (data_size == TYPE_LENGTH (value_type (value))); | |
d11916aa | 586 | |
4fa847d7 | 587 | cached_frame->reg[i].data = (gdb_byte *) xmalloc (data_size); |
d11916aa SS |
588 | memcpy (cached_frame->reg[i].data, value_contents (value), data_size); |
589 | } | |
590 | } | |
591 | ||
592 | *cache_ptr = cached_frame; | |
d11916aa | 593 | return 1; |
d11916aa SS |
594 | } |
595 | ||
596 | /* Frame cache release shim. */ | |
597 | ||
598 | static void | |
599 | pyuw_dealloc_cache (struct frame_info *this_frame, void *cache) | |
600 | { | |
601 | TRACE_PY_UNWIND (3, "%s: enter", __FUNCTION__); | |
4fa847d7 AH |
602 | cached_frame_info *cached_frame = (cached_frame_info *) cache; |
603 | ||
8455d262 | 604 | for (int i = 0; i < cached_frame->reg_count; i++) |
4fa847d7 AH |
605 | xfree (cached_frame->reg[i].data); |
606 | ||
d11916aa SS |
607 | xfree (cache); |
608 | } | |
609 | ||
610 | struct pyuw_gdbarch_data_type | |
611 | { | |
612 | /* Has the unwinder shim been prepended? */ | |
613 | int unwinder_registered; | |
614 | }; | |
615 | ||
616 | static void * | |
617 | pyuw_gdbarch_data_init (struct gdbarch *gdbarch) | |
618 | { | |
619 | return GDBARCH_OBSTACK_ZALLOC (gdbarch, struct pyuw_gdbarch_data_type); | |
620 | } | |
621 | ||
622 | /* New inferior architecture callback: register the Python unwinders | |
623 | intermediary. */ | |
624 | ||
625 | static void | |
626 | pyuw_on_new_gdbarch (struct gdbarch *newarch) | |
627 | { | |
19ba03f4 SM |
628 | struct pyuw_gdbarch_data_type *data |
629 | = (struct pyuw_gdbarch_data_type *) gdbarch_data (newarch, | |
630 | pyuw_gdbarch_data); | |
d11916aa SS |
631 | |
632 | if (!data->unwinder_registered) | |
633 | { | |
634 | struct frame_unwind *unwinder | |
635 | = GDBARCH_OBSTACK_ZALLOC (newarch, struct frame_unwind); | |
636 | ||
637 | unwinder->type = NORMAL_FRAME; | |
638 | unwinder->stop_reason = default_frame_unwind_stop_reason; | |
639 | unwinder->this_id = pyuw_this_id; | |
640 | unwinder->prev_register = pyuw_prev_register; | |
19ba03f4 | 641 | unwinder->unwind_data = (const struct frame_data *) newarch; |
d11916aa SS |
642 | unwinder->sniffer = pyuw_sniffer; |
643 | unwinder->dealloc_cache = pyuw_dealloc_cache; | |
644 | frame_unwind_prepend_unwinder (newarch, unwinder); | |
645 | data->unwinder_registered = 1; | |
646 | } | |
647 | } | |
648 | ||
649 | /* Initialize unwind machinery. */ | |
650 | ||
651 | int | |
652 | gdbpy_initialize_unwind (void) | |
653 | { | |
654 | int rc; | |
655 | add_setshow_zuinteger_cmd | |
656 | ("py-unwind", class_maintenance, &pyuw_debug, | |
657 | _("Set Python unwinder debugging."), | |
658 | _("Show Python unwinder debugging."), | |
659 | _("When non-zero, Python unwinder debugging is enabled."), | |
660 | NULL, | |
661 | NULL, | |
662 | &setdebuglist, &showdebuglist); | |
663 | pyuw_gdbarch_data | |
664 | = gdbarch_data_register_post_init (pyuw_gdbarch_data_init); | |
76727919 | 665 | gdb::observers::architecture_changed.attach (pyuw_on_new_gdbarch); |
d11916aa SS |
666 | |
667 | if (PyType_Ready (&pending_frame_object_type) < 0) | |
668 | return -1; | |
669 | rc = gdb_pymodule_addobject (gdb_module, "PendingFrame", | |
670 | (PyObject *) &pending_frame_object_type); | |
671 | if (rc) | |
672 | return rc; | |
673 | ||
674 | if (PyType_Ready (&unwind_info_object_type) < 0) | |
675 | return -1; | |
676 | return gdb_pymodule_addobject (gdb_module, "UnwindInfo", | |
677 | (PyObject *) &unwind_info_object_type); | |
678 | } | |
679 | ||
680 | static PyMethodDef pending_frame_object_methods[] = | |
681 | { | |
682 | { "read_register", pending_framepy_read_register, METH_VARARGS, | |
683 | "read_register (REG) -> gdb.Value\n" | |
684 | "Return the value of the REG in the frame." }, | |
685 | { "create_unwind_info", | |
686 | pending_framepy_create_unwind_info, METH_VARARGS, | |
687 | "create_unwind_info (FRAME_ID) -> gdb.UnwindInfo\n" | |
688 | "Construct UnwindInfo for this PendingFrame, using FRAME_ID\n" | |
689 | "to identify it." }, | |
87dbc774 AB |
690 | { "architecture", |
691 | pending_framepy_architecture, METH_NOARGS, | |
692 | "architecture () -> gdb.Architecture\n" | |
693 | "The architecture for this PendingFrame." }, | |
d11916aa SS |
694 | {NULL} /* Sentinel */ |
695 | }; | |
696 | ||
13fa0398 | 697 | PyTypeObject pending_frame_object_type = |
d11916aa SS |
698 | { |
699 | PyVarObject_HEAD_INIT (NULL, 0) | |
700 | "gdb.PendingFrame", /* tp_name */ | |
701 | sizeof (pending_frame_object), /* tp_basicsize */ | |
702 | 0, /* tp_itemsize */ | |
703 | 0, /* tp_dealloc */ | |
704 | 0, /* tp_print */ | |
705 | 0, /* tp_getattr */ | |
706 | 0, /* tp_setattr */ | |
707 | 0, /* tp_compare */ | |
708 | 0, /* tp_repr */ | |
709 | 0, /* tp_as_number */ | |
710 | 0, /* tp_as_sequence */ | |
711 | 0, /* tp_as_mapping */ | |
712 | 0, /* tp_hash */ | |
713 | 0, /* tp_call */ | |
714 | pending_framepy_str, /* tp_str */ | |
715 | 0, /* tp_getattro */ | |
716 | 0, /* tp_setattro */ | |
717 | 0, /* tp_as_buffer */ | |
718 | Py_TPFLAGS_DEFAULT, /* tp_flags */ | |
719 | "GDB PendingFrame object", /* tp_doc */ | |
720 | 0, /* tp_traverse */ | |
721 | 0, /* tp_clear */ | |
722 | 0, /* tp_richcompare */ | |
723 | 0, /* tp_weaklistoffset */ | |
724 | 0, /* tp_iter */ | |
725 | 0, /* tp_iternext */ | |
726 | pending_frame_object_methods, /* tp_methods */ | |
727 | 0, /* tp_members */ | |
728 | 0, /* tp_getset */ | |
729 | 0, /* tp_base */ | |
730 | 0, /* tp_dict */ | |
731 | 0, /* tp_descr_get */ | |
732 | 0, /* tp_descr_set */ | |
733 | 0, /* tp_dictoffset */ | |
734 | 0, /* tp_init */ | |
735 | 0, /* tp_alloc */ | |
736 | }; | |
737 | ||
738 | static PyMethodDef unwind_info_object_methods[] = | |
739 | { | |
740 | { "add_saved_register", | |
741 | unwind_infopy_add_saved_register, METH_VARARGS, | |
742 | "add_saved_register (REG, VALUE) -> None\n" | |
743 | "Set the value of the REG in the previous frame to VALUE." }, | |
744 | { NULL } /* Sentinel */ | |
745 | }; | |
746 | ||
13fa0398 | 747 | PyTypeObject unwind_info_object_type = |
d11916aa SS |
748 | { |
749 | PyVarObject_HEAD_INIT (NULL, 0) | |
750 | "gdb.UnwindInfo", /* tp_name */ | |
751 | sizeof (unwind_info_object), /* tp_basicsize */ | |
752 | 0, /* tp_itemsize */ | |
753 | unwind_infopy_dealloc, /* tp_dealloc */ | |
754 | 0, /* tp_print */ | |
755 | 0, /* tp_getattr */ | |
756 | 0, /* tp_setattr */ | |
757 | 0, /* tp_compare */ | |
758 | 0, /* tp_repr */ | |
759 | 0, /* tp_as_number */ | |
760 | 0, /* tp_as_sequence */ | |
761 | 0, /* tp_as_mapping */ | |
762 | 0, /* tp_hash */ | |
763 | 0, /* tp_call */ | |
764 | unwind_infopy_str, /* tp_str */ | |
765 | 0, /* tp_getattro */ | |
766 | 0, /* tp_setattro */ | |
767 | 0, /* tp_as_buffer */ | |
768 | Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */ | |
769 | "GDB UnwindInfo object", /* tp_doc */ | |
770 | 0, /* tp_traverse */ | |
771 | 0, /* tp_clear */ | |
772 | 0, /* tp_richcompare */ | |
773 | 0, /* tp_weaklistoffset */ | |
774 | 0, /* tp_iter */ | |
775 | 0, /* tp_iternext */ | |
776 | unwind_info_object_methods, /* tp_methods */ | |
777 | 0, /* tp_members */ | |
778 | 0, /* tp_getset */ | |
779 | 0, /* tp_base */ | |
780 | 0, /* tp_dict */ | |
781 | 0, /* tp_descr_get */ | |
782 | 0, /* tp_descr_set */ | |
783 | 0, /* tp_dictoffset */ | |
784 | 0, /* tp_init */ | |
785 | 0, /* tp_alloc */ | |
786 | }; |