Commit | Line | Data |
---|---|---|
d57a3c85 TJB |
1 | /* General python/gdb code |
2 | ||
61baf725 | 3 | Copyright (C) 2008-2017 Free Software Foundation, Inc. |
d57a3c85 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" | |
d452c4bc | 21 | #include "arch-utils.h" |
d57a3c85 TJB |
22 | #include "command.h" |
23 | #include "ui-out.h" | |
24 | #include "cli/cli-script.h" | |
25 | #include "gdbcmd.h" | |
fa33c3cd | 26 | #include "progspace.h" |
89c73ade | 27 | #include "objfiles.h" |
d452c4bc UW |
28 | #include "value.h" |
29 | #include "language.h" | |
ca5c20b6 | 30 | #include "event-loop.h" |
4a532131 | 31 | #include "serial.h" |
3ab1ec27 | 32 | #include "readline/tilde.h" |
7371cf6d | 33 | #include "python.h" |
6dddc817 | 34 | #include "extension-priv.h" |
529480d0 | 35 | #include "cli/cli-utils.h" |
d57a3c85 | 36 | #include <ctype.h> |
f00aae0f | 37 | #include "location.h" |
6eddd09a | 38 | #include "ser-event.h" |
d57a3c85 | 39 | |
80b6e756 PM |
40 | /* Declared constants and enum for python stack printing. */ |
41 | static const char python_excp_none[] = "none"; | |
42 | static const char python_excp_full[] = "full"; | |
43 | static const char python_excp_message[] = "message"; | |
44 | ||
45 | /* "set python print-stack" choices. */ | |
40478521 | 46 | static const char *const python_excp_enums[] = |
80b6e756 PM |
47 | { |
48 | python_excp_none, | |
49 | python_excp_full, | |
50 | python_excp_message, | |
51 | NULL | |
52 | }; | |
53 | ||
54 | /* The exception printing variable. 'full' if we want to print the | |
55 | error message and stack, 'none' if we want to print nothing, and | |
56 | 'message' if we only want to print the error message. 'message' is | |
57 | the default. */ | |
58 | static const char *gdbpy_should_print_stack = python_excp_message; | |
d57a3c85 | 59 | |
6dddc817 DE |
60 | #ifdef HAVE_PYTHON |
61 | /* Forward decls, these are defined later. */ | |
e36122e9 TT |
62 | extern const struct extension_language_script_ops python_extension_script_ops; |
63 | extern const struct extension_language_ops python_extension_ops; | |
6dddc817 DE |
64 | #endif |
65 | ||
66 | /* The main struct describing GDB's interface to the Python | |
67 | extension language. */ | |
68 | const struct extension_language_defn extension_language_python = | |
69 | { | |
70 | EXT_LANG_PYTHON, | |
71 | "python", | |
72 | "Python", | |
73 | ||
74 | ".py", | |
75 | "-gdb.py", | |
76 | ||
77 | python_control, | |
78 | ||
79 | #ifdef HAVE_PYTHON | |
80 | &python_extension_script_ops, | |
81 | &python_extension_ops | |
82 | #else | |
83 | NULL, | |
84 | NULL | |
85 | #endif | |
86 | }; | |
87 | \f | |
d57a3c85 TJB |
88 | #ifdef HAVE_PYTHON |
89 | ||
d57a3c85 TJB |
90 | #include "cli/cli-decode.h" |
91 | #include "charset.h" | |
92 | #include "top.h" | |
cb2e07a6 | 93 | #include "solib.h" |
d57a3c85 | 94 | #include "python-internal.h" |
cb2e07a6 PM |
95 | #include "linespec.h" |
96 | #include "source.h" | |
d57a3c85 TJB |
97 | #include "version.h" |
98 | #include "target.h" | |
99 | #include "gdbthread.h" | |
b4a14fd0 | 100 | #include "interps.h" |
9a27f2c6 | 101 | #include "event-top.h" |
ff3724f5 | 102 | #include "py-ref.h" |
3f77c769 | 103 | #include "py-event.h" |
d57a3c85 | 104 | |
999633ed TT |
105 | /* True if Python has been successfully initialized, false |
106 | otherwise. */ | |
107 | ||
108 | int gdb_python_initialized; | |
109 | ||
bcabf420 | 110 | extern PyMethodDef python_GdbMethods[]; |
d57a3c85 | 111 | |
9a27f2c6 | 112 | #ifdef IS_PY3K |
bcabf420 | 113 | extern struct PyModuleDef python_GdbModuleDef; |
9a27f2c6 PK |
114 | #endif |
115 | ||
d57a3c85 | 116 | PyObject *gdb_module; |
b9516fa1 | 117 | PyObject *gdb_python_module; |
d57a3c85 | 118 | |
a6bac58e TT |
119 | /* Some string constants we may wish to use. */ |
120 | PyObject *gdbpy_to_string_cst; | |
121 | PyObject *gdbpy_children_cst; | |
122 | PyObject *gdbpy_display_hint_cst; | |
d8906c6f | 123 | PyObject *gdbpy_doc_cst; |
967cf477 | 124 | PyObject *gdbpy_enabled_cst; |
fb6a3ed3 | 125 | PyObject *gdbpy_value_cst; |
d8906c6f | 126 | |
07ca107c DE |
127 | /* The GdbError exception. */ |
128 | PyObject *gdbpy_gdberror_exc; | |
d452c4bc | 129 | |
621c8364 TT |
130 | /* The `gdb.error' base class. */ |
131 | PyObject *gdbpy_gdb_error; | |
132 | ||
133 | /* The `gdb.MemoryError' exception. */ | |
134 | PyObject *gdbpy_gdb_memory_error; | |
135 | ||
6dddc817 DE |
136 | static script_sourcer_func gdbpy_source_script; |
137 | static objfile_script_sourcer_func gdbpy_source_objfile_script; | |
9f050062 | 138 | static objfile_script_executor_func gdbpy_execute_objfile_script; |
6dddc817 DE |
139 | static void gdbpy_finish_initialization |
140 | (const struct extension_language_defn *); | |
141 | static int gdbpy_initialized (const struct extension_language_defn *); | |
142 | static void gdbpy_eval_from_control_command | |
143 | (const struct extension_language_defn *, struct command_line *cmd); | |
144 | static void gdbpy_start_type_printers (const struct extension_language_defn *, | |
145 | struct ext_lang_type_printers *); | |
146 | static enum ext_lang_rc gdbpy_apply_type_printers | |
147 | (const struct extension_language_defn *, | |
148 | const struct ext_lang_type_printers *, struct type *, char **); | |
149 | static void gdbpy_free_type_printers (const struct extension_language_defn *, | |
150 | struct ext_lang_type_printers *); | |
6dddc817 DE |
151 | static void gdbpy_set_quit_flag (const struct extension_language_defn *); |
152 | static int gdbpy_check_quit_flag (const struct extension_language_defn *); | |
153 | static enum ext_lang_rc gdbpy_before_prompt_hook | |
154 | (const struct extension_language_defn *, const char *current_gdb_prompt); | |
155 | ||
156 | /* The interface between gdb proper and loading of python scripts. */ | |
157 | ||
e36122e9 | 158 | const struct extension_language_script_ops python_extension_script_ops = |
6dddc817 DE |
159 | { |
160 | gdbpy_source_script, | |
161 | gdbpy_source_objfile_script, | |
9f050062 | 162 | gdbpy_execute_objfile_script, |
6dddc817 DE |
163 | gdbpy_auto_load_enabled |
164 | }; | |
165 | ||
166 | /* The interface between gdb proper and python extensions. */ | |
167 | ||
e36122e9 | 168 | const struct extension_language_ops python_extension_ops = |
6dddc817 DE |
169 | { |
170 | gdbpy_finish_initialization, | |
171 | gdbpy_initialized, | |
172 | ||
173 | gdbpy_eval_from_control_command, | |
174 | ||
175 | gdbpy_start_type_printers, | |
176 | gdbpy_apply_type_printers, | |
177 | gdbpy_free_type_printers, | |
178 | ||
179 | gdbpy_apply_val_pretty_printer, | |
180 | ||
181 | gdbpy_apply_frame_filter, | |
182 | ||
183 | gdbpy_preserve_values, | |
184 | ||
185 | gdbpy_breakpoint_has_cond, | |
186 | gdbpy_breakpoint_cond_says_stop, | |
187 | ||
6dddc817 DE |
188 | gdbpy_set_quit_flag, |
189 | gdbpy_check_quit_flag, | |
190 | ||
883964a7 SC |
191 | gdbpy_before_prompt_hook, |
192 | ||
193 | gdbpy_clone_xmethod_worker_data, | |
194 | gdbpy_free_xmethod_worker_data, | |
195 | gdbpy_get_matching_xmethod_workers, | |
196 | gdbpy_get_xmethod_arg_types, | |
2ce1cdbf | 197 | gdbpy_get_xmethod_result_type, |
883964a7 | 198 | gdbpy_invoke_xmethod |
6dddc817 DE |
199 | }; |
200 | ||
d452c4bc UW |
201 | /* Architecture and language to be used in callbacks from |
202 | the Python interpreter. */ | |
203 | struct gdbarch *python_gdbarch; | |
204 | const struct language_defn *python_language; | |
205 | ||
4ecee2c4 TT |
206 | gdbpy_enter::gdbpy_enter (struct gdbarch *gdbarch, |
207 | const struct language_defn *language) | |
208 | : m_gdbarch (python_gdbarch), | |
209 | m_language (python_language) | |
d452c4bc | 210 | { |
4ecee2c4 TT |
211 | /* We should not ever enter Python unless initialized. */ |
212 | if (!gdb_python_initialized) | |
213 | error (_("Python not initialized")); | |
d452c4bc | 214 | |
4ecee2c4 | 215 | m_previous_active = set_active_ext_lang (&extension_language_python); |
d59b6f6c | 216 | |
4ecee2c4 TT |
217 | m_state = PyGILState_Ensure (); |
218 | ||
219 | python_gdbarch = gdbarch; | |
220 | python_language = language; | |
221 | ||
222 | /* Save it and ensure ! PyErr_Occurred () afterwards. */ | |
223 | PyErr_Fetch (&m_error_type, &m_error_value, &m_error_traceback); | |
224 | } | |
225 | ||
226 | gdbpy_enter::~gdbpy_enter () | |
227 | { | |
8dc78533 JK |
228 | /* Leftover Python error is forbidden by Python Exception Handling. */ |
229 | if (PyErr_Occurred ()) | |
230 | { | |
231 | /* This order is similar to the one calling error afterwards. */ | |
232 | gdbpy_print_stack (); | |
233 | warning (_("internal error: Unhandled Python exception")); | |
234 | } | |
235 | ||
4ecee2c4 | 236 | PyErr_Restore (m_error_type, m_error_value, m_error_traceback); |
8dc78533 | 237 | |
4ecee2c4 TT |
238 | PyGILState_Release (m_state); |
239 | python_gdbarch = m_gdbarch; | |
240 | python_language = m_language; | |
6dddc817 | 241 | |
4ecee2c4 TT |
242 | restore_active_ext_lang (m_previous_active); |
243 | } | |
244 | ||
522002f9 TT |
245 | /* Set the quit flag. */ |
246 | ||
6dddc817 DE |
247 | static void |
248 | gdbpy_set_quit_flag (const struct extension_language_defn *extlang) | |
522002f9 TT |
249 | { |
250 | PyErr_SetInterrupt (); | |
251 | } | |
252 | ||
253 | /* Return true if the quit flag has been set, false otherwise. */ | |
254 | ||
6dddc817 DE |
255 | static int |
256 | gdbpy_check_quit_flag (const struct extension_language_defn *extlang) | |
522002f9 TT |
257 | { |
258 | return PyOS_InterruptOccurred (); | |
259 | } | |
260 | ||
8315665e YPK |
261 | /* Evaluate a Python command like PyRun_SimpleString, but uses |
262 | Py_single_input which prints the result of expressions, and does | |
263 | not automatically print the stack on errors. */ | |
264 | ||
265 | static int | |
266 | eval_python_command (const char *command) | |
267 | { | |
59876f8f | 268 | PyObject *m, *d; |
8315665e YPK |
269 | |
270 | m = PyImport_AddModule ("__main__"); | |
271 | if (m == NULL) | |
272 | return -1; | |
273 | ||
274 | d = PyModule_GetDict (m); | |
275 | if (d == NULL) | |
276 | return -1; | |
7780f186 | 277 | gdbpy_ref<> v (PyRun_StringFlags (command, Py_single_input, d, d, NULL)); |
8315665e YPK |
278 | if (v == NULL) |
279 | return -1; | |
280 | ||
9a27f2c6 | 281 | #ifndef IS_PY3K |
8315665e YPK |
282 | if (Py_FlushLine ()) |
283 | PyErr_Clear (); | |
9a27f2c6 | 284 | #endif |
8315665e YPK |
285 | |
286 | return 0; | |
287 | } | |
288 | ||
289 | /* Implementation of the gdb "python-interactive" command. */ | |
290 | ||
291 | static void | |
0b39b52e | 292 | python_interactive_command (const char *arg, int from_tty) |
8315665e | 293 | { |
f38d3ad1 | 294 | struct ui *ui = current_ui; |
8315665e YPK |
295 | int err; |
296 | ||
b7b633e9 | 297 | scoped_restore save_async = make_scoped_restore (¤t_ui->async, 0); |
8315665e | 298 | |
529480d0 | 299 | arg = skip_spaces (arg); |
8315665e | 300 | |
396a78b6 | 301 | gdbpy_enter enter_py (get_current_arch (), current_language); |
8315665e YPK |
302 | |
303 | if (arg && *arg) | |
304 | { | |
305 | int len = strlen (arg); | |
224c3ddb | 306 | char *script = (char *) xmalloc (len + 2); |
8315665e YPK |
307 | |
308 | strcpy (script, arg); | |
309 | script[len] = '\n'; | |
310 | script[len + 1] = '\0'; | |
311 | err = eval_python_command (script); | |
312 | xfree (script); | |
313 | } | |
314 | else | |
315 | { | |
f38d3ad1 | 316 | err = PyRun_InteractiveLoop (ui->instream, "<stdin>"); |
8315665e YPK |
317 | dont_repeat (); |
318 | } | |
319 | ||
320 | if (err) | |
321 | { | |
322 | gdbpy_print_stack (); | |
323 | error (_("Error while executing Python code.")); | |
324 | } | |
8315665e YPK |
325 | } |
326 | ||
4c63965b JK |
327 | /* A wrapper around PyRun_SimpleFile. FILE is the Python script to run |
328 | named FILENAME. | |
329 | ||
330 | On Windows hosts few users would build Python themselves (this is no | |
331 | trivial task on this platform), and thus use binaries built by | |
332 | someone else instead. There may happen situation where the Python | |
333 | library and GDB are using two different versions of the C runtime | |
334 | library. Python, being built with VC, would use one version of the | |
335 | msvcr DLL (Eg. msvcr100.dll), while MinGW uses msvcrt.dll. | |
336 | A FILE * from one runtime does not necessarily operate correctly in | |
7ed7d719 JB |
337 | the other runtime. |
338 | ||
4c63965b JK |
339 | To work around this potential issue, we create on Windows hosts the |
340 | FILE object using Python routines, thus making sure that it is | |
341 | compatible with the Python library. */ | |
7ed7d719 JB |
342 | |
343 | static void | |
4c63965b | 344 | python_run_simple_file (FILE *file, const char *filename) |
7ed7d719 | 345 | { |
4c63965b JK |
346 | #ifndef _WIN32 |
347 | ||
348 | PyRun_SimpleFile (file, filename); | |
349 | ||
350 | #else /* _WIN32 */ | |
351 | ||
3ab1ec27 PM |
352 | /* Because we have a string for a filename, and are using Python to |
353 | open the file, we need to expand any tilde in the path first. */ | |
9de10f6d | 354 | gdb::unique_xmalloc_ptr<char> full_path (tilde_expand (filename)); |
0dedf377 | 355 | gdbpy_ref<> python_file (PyFile_FromString (full_path.get (), (char *) "r")); |
9de10f6d | 356 | if (python_file == NULL) |
3ab1ec27 | 357 | { |
3ab1ec27 | 358 | gdbpy_print_stack (); |
9de10f6d | 359 | error (_("Error while opening file: %s"), full_path.get ()); |
3ab1ec27 | 360 | } |
256458bc | 361 | |
9de10f6d | 362 | PyRun_SimpleFile (PyFile_AsFile (python_file.get ()), filename); |
4c63965b JK |
363 | |
364 | #endif /* _WIN32 */ | |
7ed7d719 | 365 | } |
d452c4bc | 366 | |
d57a3c85 | 367 | /* Given a command_line, return a command string suitable for passing |
7f968c89 | 368 | to Python. Lines in the string are separated by newlines. */ |
d57a3c85 | 369 | |
7f968c89 | 370 | static std::string |
d57a3c85 TJB |
371 | compute_python_string (struct command_line *l) |
372 | { | |
373 | struct command_line *iter; | |
7f968c89 | 374 | std::string script; |
d57a3c85 | 375 | |
d57a3c85 TJB |
376 | for (iter = l; iter; iter = iter->next) |
377 | { | |
7f968c89 TT |
378 | script += iter->line; |
379 | script += '\n'; | |
d57a3c85 | 380 | } |
d57a3c85 TJB |
381 | return script; |
382 | } | |
383 | ||
384 | /* Take a command line structure representing a 'python' command, and | |
385 | evaluate its body using the Python interpreter. */ | |
386 | ||
6dddc817 DE |
387 | static void |
388 | gdbpy_eval_from_control_command (const struct extension_language_defn *extlang, | |
389 | struct command_line *cmd) | |
d57a3c85 | 390 | { |
12453b93 | 391 | int ret; |
d57a3c85 TJB |
392 | |
393 | if (cmd->body_count != 1) | |
394 | error (_("Invalid \"python\" block structure.")); | |
395 | ||
60e600ec | 396 | gdbpy_enter enter_py (get_current_arch (), current_language); |
ca30a762 | 397 | |
7f968c89 TT |
398 | std::string script = compute_python_string (cmd->body_list[0]); |
399 | ret = PyRun_SimpleString (script.c_str ()); | |
12453b93 | 400 | if (ret) |
80b6e756 | 401 | error (_("Error while executing Python code.")); |
d57a3c85 TJB |
402 | } |
403 | ||
404 | /* Implementation of the gdb "python" command. */ | |
405 | ||
406 | static void | |
0b39b52e | 407 | python_command (const char *arg, int from_tty) |
d57a3c85 | 408 | { |
a7785f8c | 409 | gdbpy_enter enter_py (get_current_arch (), current_language); |
b4a14fd0 | 410 | |
b7b633e9 | 411 | scoped_restore save_async = make_scoped_restore (¤t_ui->async, 0); |
b4a14fd0 | 412 | |
529480d0 | 413 | arg = skip_spaces (arg); |
d57a3c85 TJB |
414 | if (arg && *arg) |
415 | { | |
12453b93 | 416 | if (PyRun_SimpleString (arg)) |
80b6e756 | 417 | error (_("Error while executing Python code.")); |
d57a3c85 TJB |
418 | } |
419 | else | |
420 | { | |
93921405 | 421 | command_line_up l = get_command_line (python_control, ""); |
d59b6f6c | 422 | |
93921405 | 423 | execute_control_command_untraced (l.get ()); |
d57a3c85 TJB |
424 | } |
425 | } | |
426 | ||
427 | \f | |
428 | ||
429 | /* Transform a gdb parameters's value into a Python value. May return | |
430 | NULL (and set a Python exception) on error. Helper function for | |
431 | get_parameter. */ | |
d7b32ed3 PM |
432 | PyObject * |
433 | gdbpy_parameter_value (enum var_types type, void *var) | |
d57a3c85 | 434 | { |
d7b32ed3 | 435 | switch (type) |
d57a3c85 TJB |
436 | { |
437 | case var_string: | |
438 | case var_string_noescape: | |
439 | case var_optional_filename: | |
440 | case var_filename: | |
441 | case var_enum: | |
442 | { | |
a121b7c1 | 443 | const char *str = *(char **) var; |
d59b6f6c | 444 | |
d57a3c85 TJB |
445 | if (! str) |
446 | str = ""; | |
4ae6cc19 | 447 | return host_string_to_python_string (str); |
d57a3c85 TJB |
448 | } |
449 | ||
450 | case var_boolean: | |
451 | { | |
d7b32ed3 | 452 | if (* (int *) var) |
d57a3c85 TJB |
453 | Py_RETURN_TRUE; |
454 | else | |
455 | Py_RETURN_FALSE; | |
456 | } | |
457 | ||
458 | case var_auto_boolean: | |
459 | { | |
d7b32ed3 | 460 | enum auto_boolean ab = * (enum auto_boolean *) var; |
d59b6f6c | 461 | |
d57a3c85 TJB |
462 | if (ab == AUTO_BOOLEAN_TRUE) |
463 | Py_RETURN_TRUE; | |
464 | else if (ab == AUTO_BOOLEAN_FALSE) | |
465 | Py_RETURN_FALSE; | |
466 | else | |
467 | Py_RETURN_NONE; | |
468 | } | |
469 | ||
470 | case var_integer: | |
d7b32ed3 | 471 | if ((* (int *) var) == INT_MAX) |
d57a3c85 TJB |
472 | Py_RETURN_NONE; |
473 | /* Fall through. */ | |
474 | case var_zinteger: | |
d7b32ed3 | 475 | return PyLong_FromLong (* (int *) var); |
d57a3c85 TJB |
476 | |
477 | case var_uinteger: | |
478 | { | |
d7b32ed3 | 479 | unsigned int val = * (unsigned int *) var; |
d59b6f6c | 480 | |
d57a3c85 TJB |
481 | if (val == UINT_MAX) |
482 | Py_RETURN_NONE; | |
483 | return PyLong_FromUnsignedLong (val); | |
484 | } | |
485 | } | |
486 | ||
256458bc | 487 | return PyErr_Format (PyExc_RuntimeError, |
044c0f87 | 488 | _("Programmer error: unhandled type.")); |
d57a3c85 TJB |
489 | } |
490 | ||
491 | /* A Python function which returns a gdb parameter's value as a Python | |
492 | value. */ | |
493 | ||
0c72ed4c | 494 | static PyObject * |
8f500870 | 495 | gdbpy_parameter (PyObject *self, PyObject *args) |
d57a3c85 | 496 | { |
492d29ea | 497 | struct gdb_exception except = exception_none; |
d57a3c85 | 498 | struct cmd_list_element *alias, *prefix, *cmd; |
ddd49eee TT |
499 | const char *arg; |
500 | char *newarg; | |
cc924cad | 501 | int found = -1; |
d57a3c85 TJB |
502 | |
503 | if (! PyArg_ParseTuple (args, "s", &arg)) | |
504 | return NULL; | |
505 | ||
506 | newarg = concat ("show ", arg, (char *) NULL); | |
507 | ||
492d29ea | 508 | TRY |
d57a3c85 | 509 | { |
cc924cad | 510 | found = lookup_cmd_composition (newarg, &alias, &prefix, &cmd); |
d57a3c85 | 511 | } |
492d29ea PA |
512 | CATCH (ex, RETURN_MASK_ALL) |
513 | { | |
514 | except = ex; | |
515 | } | |
516 | END_CATCH | |
517 | ||
d57a3c85 TJB |
518 | xfree (newarg); |
519 | GDB_PY_HANDLE_EXCEPTION (except); | |
cc924cad TJB |
520 | if (!found) |
521 | return PyErr_Format (PyExc_RuntimeError, | |
044c0f87 | 522 | _("Could not find parameter `%s'."), arg); |
d57a3c85 TJB |
523 | |
524 | if (! cmd->var) | |
256458bc | 525 | return PyErr_Format (PyExc_RuntimeError, |
044c0f87 | 526 | _("`%s' is not a parameter."), arg); |
d7b32ed3 | 527 | return gdbpy_parameter_value (cmd->var_type, cmd->var); |
d57a3c85 TJB |
528 | } |
529 | ||
f870a310 TT |
530 | /* Wrapper for target_charset. */ |
531 | ||
532 | static PyObject * | |
533 | gdbpy_target_charset (PyObject *self, PyObject *args) | |
534 | { | |
535 | const char *cset = target_charset (python_gdbarch); | |
d59b6f6c | 536 | |
f870a310 TT |
537 | return PyUnicode_Decode (cset, strlen (cset), host_charset (), NULL); |
538 | } | |
539 | ||
540 | /* Wrapper for target_wide_charset. */ | |
541 | ||
542 | static PyObject * | |
543 | gdbpy_target_wide_charset (PyObject *self, PyObject *args) | |
544 | { | |
545 | const char *cset = target_wide_charset (python_gdbarch); | |
d59b6f6c | 546 | |
f870a310 TT |
547 | return PyUnicode_Decode (cset, strlen (cset), host_charset (), NULL); |
548 | } | |
549 | ||
d57a3c85 TJB |
550 | /* A Python function which evaluates a string using the gdb CLI. */ |
551 | ||
552 | static PyObject * | |
bc9f0842 | 553 | execute_gdb_command (PyObject *self, PyObject *args, PyObject *kw) |
d57a3c85 | 554 | { |
ddd49eee | 555 | const char *arg; |
bc9f0842 TT |
556 | PyObject *from_tty_obj = NULL, *to_string_obj = NULL; |
557 | int from_tty, to_string; | |
2adadf51 | 558 | static const char *keywords[] = { "command", "from_tty", "to_string", NULL }; |
d57a3c85 | 559 | |
2adadf51 PA |
560 | if (!gdb_PyArg_ParseTupleAndKeywords (args, kw, "s|O!O!", keywords, &arg, |
561 | &PyBool_Type, &from_tty_obj, | |
562 | &PyBool_Type, &to_string_obj)) | |
d57a3c85 TJB |
563 | return NULL; |
564 | ||
12453b93 TJB |
565 | from_tty = 0; |
566 | if (from_tty_obj) | |
567 | { | |
bc9f0842 | 568 | int cmp = PyObject_IsTrue (from_tty_obj); |
12453b93 | 569 | if (cmp < 0) |
bc9f0842 | 570 | return NULL; |
12453b93 TJB |
571 | from_tty = cmp; |
572 | } | |
573 | ||
bc9f0842 TT |
574 | to_string = 0; |
575 | if (to_string_obj) | |
576 | { | |
577 | int cmp = PyObject_IsTrue (to_string_obj); | |
578 | if (cmp < 0) | |
579 | return NULL; | |
580 | to_string = cmp; | |
581 | } | |
582 | ||
db1ec11f PA |
583 | std::string to_string_res; |
584 | ||
492d29ea | 585 | TRY |
d57a3c85 | 586 | { |
e7ea3ec7 | 587 | struct interp *interp; |
bc9f0842 | 588 | |
b7b633e9 | 589 | scoped_restore save_async = make_scoped_restore (¤t_ui->async, 0); |
b4a14fd0 | 590 | |
67ad9399 | 591 | scoped_restore save_uiout = make_scoped_restore (¤t_uiout); |
cd94f6d5 | 592 | |
e7ea3ec7 CU |
593 | /* Use the console interpreter uiout to have the same print format |
594 | for console or MI. */ | |
8322445e | 595 | interp = interp_lookup (current_ui, "console"); |
e7ea3ec7 CU |
596 | current_uiout = interp_ui_out (interp); |
597 | ||
1ac32117 | 598 | scoped_restore preventer = prevent_dont_repeat (); |
bc9f0842 | 599 | if (to_string) |
95a6b0a1 | 600 | to_string_res = execute_command_to_string (arg, from_tty); |
5da1313b | 601 | else |
95a6b0a1 | 602 | execute_command (arg, from_tty); |
d57a3c85 | 603 | } |
492d29ea PA |
604 | CATCH (except, RETURN_MASK_ALL) |
605 | { | |
606 | GDB_PY_HANDLE_EXCEPTION (except); | |
607 | } | |
608 | END_CATCH | |
d57a3c85 | 609 | |
347bddb7 PA |
610 | /* Do any commands attached to breakpoint we stopped at. */ |
611 | bpstat_do_actions (); | |
d57a3c85 | 612 | |
db1ec11f PA |
613 | if (to_string) |
614 | return PyString_FromString (to_string_res.c_str ()); | |
d57a3c85 TJB |
615 | Py_RETURN_NONE; |
616 | } | |
617 | ||
cb2e07a6 PM |
618 | /* Implementation of gdb.solib_name (Long) -> String. |
619 | Returns the name of the shared library holding a given address, or None. */ | |
620 | ||
621 | static PyObject * | |
622 | gdbpy_solib_name (PyObject *self, PyObject *args) | |
623 | { | |
624 | char *soname; | |
625 | PyObject *str_obj; | |
1b40ec05 | 626 | gdb_py_ulongest pc; |
74aedc46 | 627 | |
1b40ec05 | 628 | if (!PyArg_ParseTuple (args, GDB_PY_LLU_ARG, &pc)) |
cb2e07a6 PM |
629 | return NULL; |
630 | ||
631 | soname = solib_name_from_address (current_program_space, pc); | |
632 | if (soname) | |
4ae6cc19 | 633 | str_obj = host_string_to_python_string (soname); |
cb2e07a6 PM |
634 | else |
635 | { | |
636 | str_obj = Py_None; | |
637 | Py_INCREF (Py_None); | |
638 | } | |
639 | ||
640 | return str_obj; | |
641 | } | |
642 | ||
d8ae99a7 PM |
643 | /* Implementation of Python rbreak command. Take a REGEX and |
644 | optionally a MINSYMS, THROTTLE and SYMTABS keyword and return a | |
645 | Python list that contains newly set breakpoints that match that | |
646 | criteria. REGEX refers to a GDB format standard regex pattern of | |
647 | symbols names to search; MINSYMS is an optional boolean (default | |
648 | False) that indicates if the function should search GDB's minimal | |
649 | symbols; THROTTLE is an optional integer (default unlimited) that | |
650 | indicates the maximum amount of breakpoints allowable before the | |
651 | function exits (note, if the throttle bound is passed, no | |
652 | breakpoints will be set and a runtime error returned); SYMTABS is | |
653 | an optional Python iterable that contains a set of gdb.Symtabs to | |
654 | constrain the search within. */ | |
655 | ||
656 | static PyObject * | |
657 | gdbpy_rbreak (PyObject *self, PyObject *args, PyObject *kw) | |
658 | { | |
659 | /* A simple type to ensure clean up of a vector of allocated strings | |
660 | when a C interface demands a const char *array[] type | |
661 | interface. */ | |
662 | struct symtab_list_type | |
663 | { | |
664 | ~symtab_list_type () | |
665 | { | |
666 | for (const char *elem: vec) | |
667 | xfree ((void *) elem); | |
668 | } | |
669 | std::vector<const char *> vec; | |
670 | }; | |
671 | ||
672 | char *regex = NULL; | |
673 | std::vector<symbol_search> symbols; | |
674 | unsigned long count = 0; | |
675 | PyObject *symtab_list = NULL; | |
676 | PyObject *minsyms_p_obj = NULL; | |
677 | int minsyms_p = 0; | |
678 | unsigned int throttle = 0; | |
679 | static const char *keywords[] = {"regex","minsyms", "throttle", | |
680 | "symtabs", NULL}; | |
681 | symtab_list_type symtab_paths; | |
682 | ||
683 | if (!gdb_PyArg_ParseTupleAndKeywords (args, kw, "s|O!IO", keywords, | |
684 | ®ex, &PyBool_Type, | |
685 | &minsyms_p_obj, &throttle, | |
686 | &symtab_list)) | |
687 | return NULL; | |
688 | ||
689 | /* Parse minsyms keyword. */ | |
690 | if (minsyms_p_obj != NULL) | |
691 | { | |
692 | int cmp = PyObject_IsTrue (minsyms_p_obj); | |
693 | if (cmp < 0) | |
694 | return NULL; | |
695 | minsyms_p = cmp; | |
696 | } | |
697 | ||
698 | /* The "symtabs" keyword is any Python iterable object that returns | |
699 | a gdb.Symtab on each iteration. If specified, iterate through | |
700 | the provided gdb.Symtabs and extract their full path. As | |
701 | python_string_to_target_string returns a | |
702 | gdb::unique_xmalloc_ptr<char> and a vector containing these types | |
703 | cannot be coerced to a const char **p[] via the vector.data call, | |
704 | release the value from the unique_xmalloc_ptr and place it in a | |
705 | simple type symtab_list_type (which holds the vector and a | |
706 | destructor that frees the contents of the allocated strings. */ | |
707 | if (symtab_list != NULL) | |
708 | { | |
709 | gdbpy_ref<> iter (PyObject_GetIter (symtab_list)); | |
710 | ||
711 | if (iter == NULL) | |
712 | return NULL; | |
713 | ||
714 | while (true) | |
715 | { | |
716 | gdbpy_ref<> next (PyIter_Next (iter.get ())); | |
717 | ||
718 | if (next == NULL) | |
719 | { | |
720 | if (PyErr_Occurred ()) | |
721 | return NULL; | |
722 | break; | |
723 | } | |
724 | ||
725 | gdbpy_ref<> obj_name (PyObject_GetAttrString (next.get (), | |
726 | "filename")); | |
727 | ||
728 | if (obj_name == NULL) | |
729 | return NULL; | |
730 | ||
731 | /* Is the object file still valid? */ | |
732 | if (obj_name == Py_None) | |
733 | continue; | |
734 | ||
735 | gdb::unique_xmalloc_ptr<char> filename = | |
736 | python_string_to_target_string (obj_name.get ()); | |
737 | ||
738 | if (filename == NULL) | |
739 | return NULL; | |
740 | ||
741 | /* Make sure there is a definite place to store the value of | |
742 | filename before it is released. */ | |
743 | symtab_paths.vec.push_back (nullptr); | |
744 | symtab_paths.vec.back () = filename.release (); | |
745 | } | |
746 | } | |
747 | ||
748 | if (symtab_list) | |
749 | { | |
750 | const char **files = symtab_paths.vec.data (); | |
751 | ||
752 | symbols = search_symbols (regex, FUNCTIONS_DOMAIN, | |
753 | symtab_paths.vec.size (), files); | |
754 | } | |
755 | else | |
756 | symbols = search_symbols (regex, FUNCTIONS_DOMAIN, 0, NULL); | |
757 | ||
758 | /* Count the number of symbols (both symbols and optionally minimal | |
759 | symbols) so we can correctly check the throttle limit. */ | |
760 | for (const symbol_search &p : symbols) | |
761 | { | |
762 | /* Minimal symbols included? */ | |
763 | if (minsyms_p) | |
764 | { | |
765 | if (p.msymbol.minsym != NULL) | |
766 | count++; | |
767 | } | |
768 | ||
769 | if (p.symbol != NULL) | |
770 | count++; | |
771 | } | |
772 | ||
773 | /* Check throttle bounds and exit if in excess. */ | |
774 | if (throttle != 0 && count > throttle) | |
775 | { | |
776 | PyErr_SetString (PyExc_RuntimeError, | |
777 | _("Number of breakpoints exceeds throttled maximum.")); | |
778 | return NULL; | |
779 | } | |
780 | ||
781 | gdbpy_ref<> return_list (PyList_New (0)); | |
782 | ||
783 | if (return_list == NULL) | |
784 | return NULL; | |
785 | ||
786 | /* Construct full path names for symbols and call the Python | |
787 | breakpoint constructor on the resulting names. Be tolerant of | |
788 | individual breakpoint failures. */ | |
789 | for (const symbol_search &p : symbols) | |
790 | { | |
791 | std::string symbol_name; | |
792 | ||
793 | /* Skipping minimal symbols? */ | |
794 | if (minsyms_p == 0) | |
795 | if (p.msymbol.minsym != NULL) | |
796 | continue; | |
797 | ||
798 | if (p.msymbol.minsym == NULL) | |
799 | { | |
800 | struct symtab *symtab = symbol_symtab (p.symbol); | |
801 | const char *fullname = symtab_to_fullname (symtab); | |
802 | ||
803 | symbol_name = fullname; | |
804 | symbol_name += ":"; | |
805 | symbol_name += SYMBOL_LINKAGE_NAME (p.symbol); | |
806 | } | |
807 | else | |
808 | symbol_name = MSYMBOL_LINKAGE_NAME (p.msymbol.minsym); | |
809 | ||
810 | gdbpy_ref<> argList (Py_BuildValue("(s)", symbol_name.c_str ())); | |
811 | gdbpy_ref<> obj (PyObject_CallObject ((PyObject *) | |
812 | &breakpoint_object_type, | |
813 | argList.get ())); | |
814 | ||
815 | /* Tolerate individual breakpoint failures. */ | |
816 | if (obj == NULL) | |
817 | gdbpy_print_stack (); | |
818 | else | |
819 | { | |
820 | if (PyList_Append (return_list.get (), obj.get ()) == -1) | |
821 | return NULL; | |
822 | } | |
823 | } | |
824 | return return_list.release (); | |
825 | } | |
826 | ||
cb2e07a6 PM |
827 | /* A Python function which is a wrapper for decode_line_1. */ |
828 | ||
829 | static PyObject * | |
830 | gdbpy_decode_line (PyObject *self, PyObject *args) | |
831 | { | |
f2fc3015 | 832 | const char *arg = NULL; |
7780f186 TT |
833 | gdbpy_ref<> result; |
834 | gdbpy_ref<> unparsed; | |
ffc2605c | 835 | event_location_up location; |
cb2e07a6 PM |
836 | |
837 | if (! PyArg_ParseTuple (args, "|s", &arg)) | |
838 | return NULL; | |
839 | ||
f00aae0f | 840 | if (arg != NULL) |
ffc2605c | 841 | location = string_to_event_location_basic (&arg, python_language); |
f00aae0f | 842 | |
6c5b2ebe PA |
843 | std::vector<symtab_and_line> decoded_sals; |
844 | symtab_and_line def_sal; | |
845 | gdb::array_view<symtab_and_line> sals; | |
492d29ea | 846 | TRY |
cb2e07a6 | 847 | { |
59ecaff3 | 848 | if (location != NULL) |
6c5b2ebe PA |
849 | { |
850 | decoded_sals = decode_line_1 (location.get (), 0, NULL, NULL, 0); | |
851 | sals = decoded_sals; | |
852 | } | |
cb2e07a6 PM |
853 | else |
854 | { | |
855 | set_default_source_symtab_and_line (); | |
6c5b2ebe PA |
856 | def_sal = get_current_source_symtab_and_line (); |
857 | sals = def_sal; | |
cb2e07a6 PM |
858 | } |
859 | } | |
492d29ea | 860 | CATCH (ex, RETURN_MASK_ALL) |
cb2e07a6 | 861 | { |
cb2e07a6 | 862 | /* We know this will always throw. */ |
6c5b2ebe | 863 | gdbpy_convert_exception (ex); |
f3300387 | 864 | return NULL; |
cb2e07a6 | 865 | } |
6c5b2ebe | 866 | END_CATCH |
cb2e07a6 | 867 | |
6c5b2ebe | 868 | if (!sals.empty ()) |
cb2e07a6 | 869 | { |
6c5b2ebe | 870 | result.reset (PyTuple_New (sals.size ())); |
59876f8f | 871 | if (result == NULL) |
0d50bde3 | 872 | return NULL; |
6c5b2ebe | 873 | for (size_t i = 0; i < sals.size (); ++i) |
cb2e07a6 | 874 | { |
6c5b2ebe PA |
875 | PyObject *obj = symtab_and_line_to_sal_object (sals[i]); |
876 | if (obj == NULL) | |
0d50bde3 | 877 | return NULL; |
cb2e07a6 | 878 | |
59876f8f | 879 | PyTuple_SetItem (result.get (), i, obj); |
cb2e07a6 PM |
880 | } |
881 | } | |
882 | else | |
883 | { | |
59876f8f | 884 | result.reset (Py_None); |
cb2e07a6 PM |
885 | Py_INCREF (Py_None); |
886 | } | |
887 | ||
7780f186 | 888 | gdbpy_ref<> return_result (PyTuple_New (2)); |
59876f8f | 889 | if (return_result == NULL) |
0d50bde3 | 890 | return NULL; |
cb2e07a6 | 891 | |
f00aae0f | 892 | if (arg != NULL && strlen (arg) > 0) |
9bc3523d | 893 | { |
59876f8f | 894 | unparsed.reset (PyString_FromString (arg)); |
9bc3523d | 895 | if (unparsed == NULL) |
0d50bde3 | 896 | return NULL; |
9bc3523d | 897 | } |
cb2e07a6 PM |
898 | else |
899 | { | |
59876f8f | 900 | unparsed.reset (Py_None); |
cb2e07a6 PM |
901 | Py_INCREF (Py_None); |
902 | } | |
903 | ||
59876f8f TT |
904 | PyTuple_SetItem (return_result.get (), 0, unparsed.release ()); |
905 | PyTuple_SetItem (return_result.get (), 1, result.release ()); | |
cb2e07a6 | 906 | |
59876f8f | 907 | return return_result.release (); |
cb2e07a6 PM |
908 | } |
909 | ||
57a1d736 TT |
910 | /* Parse a string and evaluate it as an expression. */ |
911 | static PyObject * | |
912 | gdbpy_parse_and_eval (PyObject *self, PyObject *args) | |
913 | { | |
ddd49eee | 914 | const char *expr_str; |
57a1d736 | 915 | struct value *result = NULL; |
57a1d736 TT |
916 | |
917 | if (!PyArg_ParseTuple (args, "s", &expr_str)) | |
918 | return NULL; | |
919 | ||
492d29ea | 920 | TRY |
57a1d736 | 921 | { |
bbc13ae3 | 922 | result = parse_and_eval (expr_str); |
57a1d736 | 923 | } |
492d29ea PA |
924 | CATCH (except, RETURN_MASK_ALL) |
925 | { | |
926 | GDB_PY_HANDLE_EXCEPTION (except); | |
927 | } | |
928 | END_CATCH | |
57a1d736 TT |
929 | |
930 | return value_to_value_object (result); | |
931 | } | |
932 | ||
7efc75aa SCR |
933 | /* Implementation of gdb.find_pc_line function. |
934 | Returns the gdb.Symtab_and_line object corresponding to a PC value. */ | |
935 | ||
936 | static PyObject * | |
937 | gdbpy_find_pc_line (PyObject *self, PyObject *args) | |
938 | { | |
29ca12b3 | 939 | gdb_py_ulongest pc_llu; |
62d7fb51 | 940 | PyObject *result = NULL; /* init for gcc -Wall */ |
7efc75aa SCR |
941 | |
942 | if (!PyArg_ParseTuple (args, GDB_PY_LLU_ARG, &pc_llu)) | |
943 | return NULL; | |
944 | ||
492d29ea | 945 | TRY |
9e974e55 TT |
946 | { |
947 | struct symtab_and_line sal; | |
948 | CORE_ADDR pc; | |
949 | ||
950 | pc = (CORE_ADDR) pc_llu; | |
951 | sal = find_pc_line (pc, 0); | |
952 | result = symtab_and_line_to_sal_object (sal); | |
953 | } | |
492d29ea PA |
954 | CATCH (except, RETURN_MASK_ALL) |
955 | { | |
956 | GDB_PY_HANDLE_EXCEPTION (except); | |
957 | } | |
958 | END_CATCH | |
9e974e55 TT |
959 | |
960 | return result; | |
7efc75aa SCR |
961 | } |
962 | ||
e0f3fd7c TT |
963 | /* Implementation of gdb.invalidate_cached_frames. */ |
964 | ||
965 | static PyObject * | |
966 | gdbpy_invalidate_cached_frames (PyObject *self, PyObject *args) | |
967 | { | |
968 | reinit_frame_cache (); | |
969 | Py_RETURN_NONE; | |
970 | } | |
971 | ||
d234ef5c | 972 | /* Read a file as Python code. |
6dddc817 DE |
973 | This is the extension_language_script_ops.script_sourcer "method". |
974 | FILE is the file to load. FILENAME is name of the file FILE. | |
d234ef5c DE |
975 | This does not throw any errors. If an exception occurs python will print |
976 | the traceback and clear the error indicator. */ | |
973817a3 | 977 | |
6dddc817 DE |
978 | static void |
979 | gdbpy_source_script (const struct extension_language_defn *extlang, | |
980 | FILE *file, const char *filename) | |
973817a3 | 981 | { |
60e600ec | 982 | gdbpy_enter enter_py (get_current_arch (), current_language); |
4c63965b | 983 | python_run_simple_file (file, filename); |
973817a3 JB |
984 | } |
985 | ||
d57a3c85 TJB |
986 | \f |
987 | ||
ca5c20b6 PM |
988 | /* Posting and handling events. */ |
989 | ||
990 | /* A single event. */ | |
991 | struct gdbpy_event | |
992 | { | |
993 | /* The Python event. This is just a callable object. */ | |
994 | PyObject *event; | |
995 | /* The next event. */ | |
996 | struct gdbpy_event *next; | |
997 | }; | |
998 | ||
999 | /* All pending events. */ | |
1000 | static struct gdbpy_event *gdbpy_event_list; | |
1001 | /* The final link of the event list. */ | |
1002 | static struct gdbpy_event **gdbpy_event_list_end; | |
1003 | ||
6eddd09a PA |
1004 | /* So that we can wake up the main thread even when it is blocked in |
1005 | poll(). */ | |
1006 | static struct serial_event *gdbpy_serial_event; | |
ca5c20b6 PM |
1007 | |
1008 | /* The file handler callback. This reads from the internal pipe, and | |
1009 | then processes the Python event queue. This will always be run in | |
1010 | the main gdb thread. */ | |
4a532131 | 1011 | |
ca5c20b6 | 1012 | static void |
6eddd09a | 1013 | gdbpy_run_events (int error, gdb_client_data client_data) |
ca5c20b6 | 1014 | { |
60e600ec | 1015 | gdbpy_enter enter_py (get_current_arch (), current_language); |
ca5c20b6 | 1016 | |
6eddd09a PA |
1017 | /* Clear the event fd. Do this before flushing the events list, so |
1018 | that any new event post afterwards is sure to re-awake the event | |
4a532131 | 1019 | loop. */ |
6eddd09a | 1020 | serial_event_clear (gdbpy_serial_event); |
ca5c20b6 PM |
1021 | |
1022 | while (gdbpy_event_list) | |
1023 | { | |
1024 | /* Dispatching the event might push a new element onto the event | |
1025 | loop, so we update here "atomically enough". */ | |
1026 | struct gdbpy_event *item = gdbpy_event_list; | |
1027 | gdbpy_event_list = gdbpy_event_list->next; | |
1028 | if (gdbpy_event_list == NULL) | |
1029 | gdbpy_event_list_end = &gdbpy_event_list; | |
1030 | ||
1031 | /* Ignore errors. */ | |
7780f186 | 1032 | gdbpy_ref<> call_result (PyObject_CallObject (item->event, NULL)); |
02146ba5 | 1033 | if (call_result == NULL) |
ca5c20b6 PM |
1034 | PyErr_Clear (); |
1035 | ||
1036 | Py_DECREF (item->event); | |
1037 | xfree (item); | |
1038 | } | |
ca5c20b6 PM |
1039 | } |
1040 | ||
1041 | /* Submit an event to the gdb thread. */ | |
1042 | static PyObject * | |
1043 | gdbpy_post_event (PyObject *self, PyObject *args) | |
1044 | { | |
1045 | struct gdbpy_event *event; | |
1046 | PyObject *func; | |
1047 | int wakeup; | |
1048 | ||
1049 | if (!PyArg_ParseTuple (args, "O", &func)) | |
1050 | return NULL; | |
1051 | ||
1052 | if (!PyCallable_Check (func)) | |
1053 | { | |
256458bc | 1054 | PyErr_SetString (PyExc_RuntimeError, |
ca5c20b6 PM |
1055 | _("Posted event is not callable")); |
1056 | return NULL; | |
1057 | } | |
1058 | ||
1059 | Py_INCREF (func); | |
1060 | ||
1061 | /* From here until the end of the function, we have the GIL, so we | |
1062 | can operate on our global data structures without worrying. */ | |
1063 | wakeup = gdbpy_event_list == NULL; | |
1064 | ||
1065 | event = XNEW (struct gdbpy_event); | |
1066 | event->event = func; | |
1067 | event->next = NULL; | |
1068 | *gdbpy_event_list_end = event; | |
1069 | gdbpy_event_list_end = &event->next; | |
1070 | ||
1071 | /* Wake up gdb when needed. */ | |
1072 | if (wakeup) | |
6eddd09a | 1073 | serial_event_set (gdbpy_serial_event); |
ca5c20b6 PM |
1074 | |
1075 | Py_RETURN_NONE; | |
1076 | } | |
1077 | ||
1078 | /* Initialize the Python event handler. */ | |
999633ed | 1079 | static int |
ca5c20b6 PM |
1080 | gdbpy_initialize_events (void) |
1081 | { | |
6eddd09a PA |
1082 | gdbpy_event_list_end = &gdbpy_event_list; |
1083 | ||
1084 | gdbpy_serial_event = make_serial_event (); | |
1085 | add_file_handler (serial_event_fd (gdbpy_serial_event), | |
1086 | gdbpy_run_events, NULL); | |
999633ed TT |
1087 | |
1088 | return 0; | |
ca5c20b6 PM |
1089 | } |
1090 | ||
d17b6f81 PM |
1091 | \f |
1092 | ||
6dddc817 DE |
1093 | /* This is the extension_language_ops.before_prompt "method". */ |
1094 | ||
1095 | static enum ext_lang_rc | |
1096 | gdbpy_before_prompt_hook (const struct extension_language_defn *extlang, | |
1097 | const char *current_gdb_prompt) | |
d17b6f81 | 1098 | { |
0646da15 | 1099 | if (!gdb_python_initialized) |
6dddc817 | 1100 | return EXT_LANG_RC_NOP; |
0646da15 | 1101 | |
a88b13c7 | 1102 | gdbpy_enter enter_py (get_current_arch (), current_language); |
d17b6f81 | 1103 | |
3f77c769 TT |
1104 | if (!evregpy_no_listeners_p (gdb_py_events.before_prompt) |
1105 | && evpy_emit_event (NULL, gdb_py_events.before_prompt) < 0) | |
1106 | return EXT_LANG_RC_ERROR; | |
1107 | ||
b9516fa1 YPK |
1108 | if (gdb_python_module |
1109 | && PyObject_HasAttrString (gdb_python_module, "prompt_hook")) | |
d17b6f81 | 1110 | { |
7780f186 TT |
1111 | gdbpy_ref<> hook (PyObject_GetAttrString (gdb_python_module, |
1112 | "prompt_hook")); | |
d17b6f81 | 1113 | if (hook == NULL) |
d17b6f81 | 1114 | { |
a88b13c7 TT |
1115 | gdbpy_print_stack (); |
1116 | return EXT_LANG_RC_ERROR; | |
1117 | } | |
d17b6f81 | 1118 | |
a88b13c7 TT |
1119 | if (PyCallable_Check (hook.get ())) |
1120 | { | |
7780f186 | 1121 | gdbpy_ref<> current_prompt (PyString_FromString (current_gdb_prompt)); |
d17b6f81 | 1122 | if (current_prompt == NULL) |
a88b13c7 TT |
1123 | { |
1124 | gdbpy_print_stack (); | |
1125 | return EXT_LANG_RC_ERROR; | |
1126 | } | |
d17b6f81 | 1127 | |
7780f186 TT |
1128 | gdbpy_ref<> result |
1129 | (PyObject_CallFunctionObjArgs (hook.get (), current_prompt.get (), | |
1130 | NULL)); | |
d17b6f81 | 1131 | if (result == NULL) |
a88b13c7 TT |
1132 | { |
1133 | gdbpy_print_stack (); | |
1134 | return EXT_LANG_RC_ERROR; | |
1135 | } | |
d17b6f81 PM |
1136 | |
1137 | /* Return type should be None, or a String. If it is None, | |
1138 | fall through, we will not set a prompt. If it is a | |
1139 | string, set PROMPT. Anything else, set an exception. */ | |
a88b13c7 | 1140 | if (result != Py_None && ! PyString_Check (result.get ())) |
d17b6f81 PM |
1141 | { |
1142 | PyErr_Format (PyExc_RuntimeError, | |
1143 | _("Return from prompt_hook must " \ | |
1144 | "be either a Python string, or None")); | |
a88b13c7 TT |
1145 | gdbpy_print_stack (); |
1146 | return EXT_LANG_RC_ERROR; | |
d17b6f81 PM |
1147 | } |
1148 | ||
1149 | if (result != Py_None) | |
1150 | { | |
a88b13c7 TT |
1151 | gdb::unique_xmalloc_ptr<char> |
1152 | prompt (python_string_to_host_string (result.get ())); | |
d17b6f81 PM |
1153 | |
1154 | if (prompt == NULL) | |
a88b13c7 TT |
1155 | { |
1156 | gdbpy_print_stack (); | |
1157 | return EXT_LANG_RC_ERROR; | |
1158 | } | |
1159 | ||
1160 | set_prompt (prompt.get ()); | |
1161 | return EXT_LANG_RC_OK; | |
d17b6f81 PM |
1162 | } |
1163 | } | |
1164 | } | |
1165 | ||
a88b13c7 | 1166 | return EXT_LANG_RC_NOP; |
d17b6f81 PM |
1167 | } |
1168 | ||
1169 | \f | |
1170 | ||
d57a3c85 TJB |
1171 | /* Printing. */ |
1172 | ||
1173 | /* A python function to write a single string using gdb's filtered | |
99c3dc11 PM |
1174 | output stream . The optional keyword STREAM can be used to write |
1175 | to a particular stream. The default stream is to gdb_stdout. */ | |
1176 | ||
d57a3c85 | 1177 | static PyObject * |
99c3dc11 | 1178 | gdbpy_write (PyObject *self, PyObject *args, PyObject *kw) |
d57a3c85 | 1179 | { |
ddd49eee | 1180 | const char *arg; |
2adadf51 | 1181 | static const char *keywords[] = { "text", "stream", NULL }; |
99c3dc11 | 1182 | int stream_type = 0; |
256458bc | 1183 | |
2adadf51 PA |
1184 | if (!gdb_PyArg_ParseTupleAndKeywords (args, kw, "s|i", keywords, &arg, |
1185 | &stream_type)) | |
d57a3c85 | 1186 | return NULL; |
99c3dc11 | 1187 | |
492d29ea | 1188 | TRY |
99c3dc11 | 1189 | { |
adb4fe3b ME |
1190 | switch (stream_type) |
1191 | { | |
1192 | case 1: | |
1193 | { | |
1194 | fprintf_filtered (gdb_stderr, "%s", arg); | |
1195 | break; | |
1196 | } | |
1197 | case 2: | |
1198 | { | |
1199 | fprintf_filtered (gdb_stdlog, "%s", arg); | |
1200 | break; | |
1201 | } | |
1202 | default: | |
1203 | fprintf_filtered (gdb_stdout, "%s", arg); | |
1204 | } | |
99c3dc11 | 1205 | } |
492d29ea PA |
1206 | CATCH (except, RETURN_MASK_ALL) |
1207 | { | |
1208 | GDB_PY_HANDLE_EXCEPTION (except); | |
1209 | } | |
1210 | END_CATCH | |
256458bc | 1211 | |
d57a3c85 TJB |
1212 | Py_RETURN_NONE; |
1213 | } | |
1214 | ||
99c3dc11 PM |
1215 | /* A python function to flush a gdb stream. The optional keyword |
1216 | STREAM can be used to flush a particular stream. The default stream | |
1217 | is gdb_stdout. */ | |
1218 | ||
d57a3c85 | 1219 | static PyObject * |
99c3dc11 | 1220 | gdbpy_flush (PyObject *self, PyObject *args, PyObject *kw) |
d57a3c85 | 1221 | { |
2adadf51 | 1222 | static const char *keywords[] = { "stream", NULL }; |
99c3dc11 | 1223 | int stream_type = 0; |
256458bc | 1224 | |
2adadf51 PA |
1225 | if (!gdb_PyArg_ParseTupleAndKeywords (args, kw, "|i", keywords, |
1226 | &stream_type)) | |
99c3dc11 PM |
1227 | return NULL; |
1228 | ||
1229 | switch (stream_type) | |
1230 | { | |
1231 | case 1: | |
1232 | { | |
1233 | gdb_flush (gdb_stderr); | |
1234 | break; | |
1235 | } | |
1236 | case 2: | |
1237 | { | |
1238 | gdb_flush (gdb_stdlog); | |
1239 | break; | |
1240 | } | |
1241 | default: | |
1242 | gdb_flush (gdb_stdout); | |
1243 | } | |
256458bc | 1244 | |
d57a3c85 TJB |
1245 | Py_RETURN_NONE; |
1246 | } | |
1247 | ||
69b4374a DE |
1248 | /* Return non-zero if print-stack is not "none". */ |
1249 | ||
1250 | int | |
1251 | gdbpy_print_python_errors_p (void) | |
1252 | { | |
1253 | return gdbpy_should_print_stack != python_excp_none; | |
1254 | } | |
1255 | ||
80b6e756 PM |
1256 | /* Print a python exception trace, print just a message, or print |
1257 | nothing and clear the python exception, depending on | |
1258 | gdbpy_should_print_stack. Only call this if a python exception is | |
1259 | set. */ | |
d57a3c85 TJB |
1260 | void |
1261 | gdbpy_print_stack (void) | |
1262 | { | |
7f6a5dde | 1263 | |
80b6e756 PM |
1264 | /* Print "none", just clear exception. */ |
1265 | if (gdbpy_should_print_stack == python_excp_none) | |
1266 | { | |
1267 | PyErr_Clear (); | |
1268 | } | |
1269 | /* Print "full" message and backtrace. */ | |
1270 | else if (gdbpy_should_print_stack == python_excp_full) | |
0bf0f8c4 DE |
1271 | { |
1272 | PyErr_Print (); | |
1273 | /* PyErr_Print doesn't necessarily end output with a newline. | |
1274 | This works because Python's stdout/stderr is fed through | |
1275 | printf_filtered. */ | |
492d29ea | 1276 | TRY |
7f6a5dde TT |
1277 | { |
1278 | begin_line (); | |
1279 | } | |
492d29ea PA |
1280 | CATCH (except, RETURN_MASK_ALL) |
1281 | { | |
1282 | } | |
1283 | END_CATCH | |
0bf0f8c4 | 1284 | } |
80b6e756 | 1285 | /* Print "message", just error print message. */ |
d57a3c85 | 1286 | else |
80b6e756 PM |
1287 | { |
1288 | PyObject *ptype, *pvalue, *ptraceback; | |
80b6e756 PM |
1289 | |
1290 | PyErr_Fetch (&ptype, &pvalue, &ptraceback); | |
1291 | ||
1292 | /* Fetch the error message contained within ptype, pvalue. */ | |
9b972014 TT |
1293 | gdb::unique_xmalloc_ptr<char> |
1294 | msg (gdbpy_exception_to_string (ptype, pvalue)); | |
1295 | gdb::unique_xmalloc_ptr<char> type (gdbpy_obj_to_string (ptype)); | |
7f6a5dde | 1296 | |
492d29ea | 1297 | TRY |
80b6e756 | 1298 | { |
7f6a5dde TT |
1299 | if (msg == NULL) |
1300 | { | |
1301 | /* An error occurred computing the string representation of the | |
1302 | error message. */ | |
1303 | fprintf_filtered (gdb_stderr, | |
1304 | _("Error occurred computing Python error" \ | |
1305 | "message.\n")); | |
1306 | } | |
1307 | else | |
1308 | fprintf_filtered (gdb_stderr, "Python Exception %s %s: \n", | |
9b972014 | 1309 | type.get (), msg.get ()); |
80b6e756 | 1310 | } |
492d29ea PA |
1311 | CATCH (except, RETURN_MASK_ALL) |
1312 | { | |
1313 | } | |
1314 | END_CATCH | |
80b6e756 PM |
1315 | |
1316 | Py_XDECREF (ptype); | |
1317 | Py_XDECREF (pvalue); | |
1318 | Py_XDECREF (ptraceback); | |
80b6e756 | 1319 | } |
d57a3c85 TJB |
1320 | } |
1321 | ||
89c73ade TT |
1322 | \f |
1323 | ||
fa33c3cd DE |
1324 | /* Return the current Progspace. |
1325 | There always is one. */ | |
1326 | ||
1327 | static PyObject * | |
1328 | gdbpy_get_current_progspace (PyObject *unused1, PyObject *unused2) | |
1329 | { | |
1330 | PyObject *result; | |
1331 | ||
1332 | result = pspace_to_pspace_object (current_program_space); | |
1333 | if (result) | |
1334 | Py_INCREF (result); | |
1335 | return result; | |
1336 | } | |
1337 | ||
1338 | /* Return a sequence holding all the Progspaces. */ | |
1339 | ||
1340 | static PyObject * | |
1341 | gdbpy_progspaces (PyObject *unused1, PyObject *unused2) | |
1342 | { | |
1343 | struct program_space *ps; | |
fa33c3cd | 1344 | |
7780f186 | 1345 | gdbpy_ref<> list (PyList_New (0)); |
ff3724f5 | 1346 | if (list == NULL) |
fa33c3cd DE |
1347 | return NULL; |
1348 | ||
1349 | ALL_PSPACES (ps) | |
1350 | { | |
1351 | PyObject *item = pspace_to_pspace_object (ps); | |
d59b6f6c | 1352 | |
ff3724f5 TT |
1353 | if (!item || PyList_Append (list.get (), item) == -1) |
1354 | return NULL; | |
fa33c3cd DE |
1355 | } |
1356 | ||
ff3724f5 | 1357 | return list.release (); |
fa33c3cd DE |
1358 | } |
1359 | ||
1360 | \f | |
1361 | ||
89c73ade | 1362 | /* The "current" objfile. This is set when gdb detects that a new |
8a1ea21f | 1363 | objfile has been loaded. It is only set for the duration of a call to |
9f050062 DE |
1364 | gdbpy_source_objfile_script and gdbpy_execute_objfile_script; it is NULL |
1365 | at other times. */ | |
89c73ade TT |
1366 | static struct objfile *gdbpy_current_objfile; |
1367 | ||
4c63965b JK |
1368 | /* Set the current objfile to OBJFILE and then read FILE named FILENAME |
1369 | as Python code. This does not throw any errors. If an exception | |
6dddc817 DE |
1370 | occurs python will print the traceback and clear the error indicator. |
1371 | This is the extension_language_script_ops.objfile_script_sourcer | |
1372 | "method". */ | |
89c73ade | 1373 | |
6dddc817 DE |
1374 | static void |
1375 | gdbpy_source_objfile_script (const struct extension_language_defn *extlang, | |
1376 | struct objfile *objfile, FILE *file, | |
1377 | const char *filename) | |
89c73ade | 1378 | { |
0646da15 TT |
1379 | if (!gdb_python_initialized) |
1380 | return; | |
1381 | ||
60e600ec | 1382 | gdbpy_enter enter_py (get_objfile_arch (objfile), current_language); |
89c73ade TT |
1383 | gdbpy_current_objfile = objfile; |
1384 | ||
4c63965b | 1385 | python_run_simple_file (file, filename); |
89c73ade | 1386 | |
89c73ade | 1387 | gdbpy_current_objfile = NULL; |
89c73ade TT |
1388 | } |
1389 | ||
9f050062 DE |
1390 | /* Set the current objfile to OBJFILE and then execute SCRIPT |
1391 | as Python code. This does not throw any errors. If an exception | |
1392 | occurs python will print the traceback and clear the error indicator. | |
1393 | This is the extension_language_script_ops.objfile_script_executor | |
1394 | "method". */ | |
1395 | ||
1396 | static void | |
1397 | gdbpy_execute_objfile_script (const struct extension_language_defn *extlang, | |
1398 | struct objfile *objfile, const char *name, | |
1399 | const char *script) | |
1400 | { | |
9f050062 DE |
1401 | if (!gdb_python_initialized) |
1402 | return; | |
1403 | ||
60e600ec | 1404 | gdbpy_enter enter_py (get_objfile_arch (objfile), current_language); |
9f050062 DE |
1405 | gdbpy_current_objfile = objfile; |
1406 | ||
1407 | PyRun_SimpleString (script); | |
1408 | ||
9f050062 DE |
1409 | gdbpy_current_objfile = NULL; |
1410 | } | |
1411 | ||
89c73ade | 1412 | /* Return the current Objfile, or None if there isn't one. */ |
8a1ea21f | 1413 | |
89c73ade TT |
1414 | static PyObject * |
1415 | gdbpy_get_current_objfile (PyObject *unused1, PyObject *unused2) | |
1416 | { | |
1417 | PyObject *result; | |
1418 | ||
1419 | if (! gdbpy_current_objfile) | |
1420 | Py_RETURN_NONE; | |
1421 | ||
1422 | result = objfile_to_objfile_object (gdbpy_current_objfile); | |
1423 | if (result) | |
1424 | Py_INCREF (result); | |
1425 | return result; | |
1426 | } | |
1427 | ||
1428 | /* Return a sequence holding all the Objfiles. */ | |
fa33c3cd | 1429 | |
89c73ade TT |
1430 | static PyObject * |
1431 | gdbpy_objfiles (PyObject *unused1, PyObject *unused2) | |
1432 | { | |
1433 | struct objfile *objf; | |
89c73ade | 1434 | |
7780f186 | 1435 | gdbpy_ref<> list (PyList_New (0)); |
ff3724f5 | 1436 | if (list == NULL) |
89c73ade TT |
1437 | return NULL; |
1438 | ||
1439 | ALL_OBJFILES (objf) | |
1440 | { | |
1441 | PyObject *item = objfile_to_objfile_object (objf); | |
d59b6f6c | 1442 | |
ff3724f5 TT |
1443 | if (!item || PyList_Append (list.get (), item) == -1) |
1444 | return NULL; | |
89c73ade TT |
1445 | } |
1446 | ||
ff3724f5 | 1447 | return list.release (); |
89c73ade TT |
1448 | } |
1449 | ||
6dddc817 DE |
1450 | /* Compute the list of active python type printers and store them in |
1451 | EXT_PRINTERS->py_type_printers. The product of this function is used by | |
1452 | gdbpy_apply_type_printers, and freed by gdbpy_free_type_printers. | |
1453 | This is the extension_language_ops.start_type_printers "method". */ | |
18a9fc12 | 1454 | |
6dddc817 DE |
1455 | static void |
1456 | gdbpy_start_type_printers (const struct extension_language_defn *extlang, | |
1457 | struct ext_lang_type_printers *ext_printers) | |
18a9fc12 | 1458 | { |
59876f8f | 1459 | PyObject *printers_obj = NULL; |
18a9fc12 | 1460 | |
0646da15 | 1461 | if (!gdb_python_initialized) |
6dddc817 | 1462 | return; |
0646da15 | 1463 | |
60e600ec | 1464 | gdbpy_enter enter_py (get_current_arch (), current_language); |
18a9fc12 | 1465 | |
7780f186 | 1466 | gdbpy_ref<> type_module (PyImport_ImportModule ("gdb.types")); |
18a9fc12 TT |
1467 | if (type_module == NULL) |
1468 | { | |
1469 | gdbpy_print_stack (); | |
59876f8f | 1470 | return; |
18a9fc12 | 1471 | } |
18a9fc12 | 1472 | |
7780f186 TT |
1473 | gdbpy_ref<> func (PyObject_GetAttrString (type_module.get (), |
1474 | "get_type_recognizers")); | |
18a9fc12 TT |
1475 | if (func == NULL) |
1476 | { | |
1477 | gdbpy_print_stack (); | |
59876f8f | 1478 | return; |
18a9fc12 | 1479 | } |
18a9fc12 | 1480 | |
59876f8f | 1481 | printers_obj = PyObject_CallFunctionObjArgs (func.get (), (char *) NULL); |
6dddc817 | 1482 | if (printers_obj == NULL) |
18a9fc12 | 1483 | gdbpy_print_stack (); |
6dddc817 DE |
1484 | else |
1485 | ext_printers->py_type_printers = printers_obj; | |
18a9fc12 TT |
1486 | } |
1487 | ||
6dddc817 DE |
1488 | /* If TYPE is recognized by some type printer, store in *PRETTIED_TYPE |
1489 | a newly allocated string holding the type's replacement name, and return | |
1490 | EXT_LANG_RC_OK. The caller is responsible for freeing the string. | |
1491 | If there's a Python error return EXT_LANG_RC_ERROR. | |
1492 | Otherwise, return EXT_LANG_RC_NOP. | |
1493 | This is the extension_language_ops.apply_type_printers "method". */ | |
1494 | ||
1495 | static enum ext_lang_rc | |
1496 | gdbpy_apply_type_printers (const struct extension_language_defn *extlang, | |
1497 | const struct ext_lang_type_printers *ext_printers, | |
1498 | struct type *type, char **prettied_type) | |
18a9fc12 | 1499 | { |
19ba03f4 | 1500 | PyObject *printers_obj = (PyObject *) ext_printers->py_type_printers; |
9b972014 | 1501 | gdb::unique_xmalloc_ptr<char> result; |
18a9fc12 TT |
1502 | |
1503 | if (printers_obj == NULL) | |
6dddc817 | 1504 | return EXT_LANG_RC_NOP; |
18a9fc12 | 1505 | |
0646da15 | 1506 | if (!gdb_python_initialized) |
6dddc817 | 1507 | return EXT_LANG_RC_NOP; |
0646da15 | 1508 | |
60e600ec | 1509 | gdbpy_enter enter_py (get_current_arch (), current_language); |
18a9fc12 | 1510 | |
7780f186 | 1511 | gdbpy_ref<> type_obj (type_to_type_object (type)); |
18a9fc12 TT |
1512 | if (type_obj == NULL) |
1513 | { | |
1514 | gdbpy_print_stack (); | |
59876f8f | 1515 | return EXT_LANG_RC_ERROR; |
18a9fc12 | 1516 | } |
18a9fc12 | 1517 | |
7780f186 | 1518 | gdbpy_ref<> type_module (PyImport_ImportModule ("gdb.types")); |
18a9fc12 TT |
1519 | if (type_module == NULL) |
1520 | { | |
1521 | gdbpy_print_stack (); | |
59876f8f | 1522 | return EXT_LANG_RC_ERROR; |
18a9fc12 | 1523 | } |
18a9fc12 | 1524 | |
7780f186 TT |
1525 | gdbpy_ref<> func (PyObject_GetAttrString (type_module.get (), |
1526 | "apply_type_recognizers")); | |
18a9fc12 TT |
1527 | if (func == NULL) |
1528 | { | |
1529 | gdbpy_print_stack (); | |
59876f8f | 1530 | return EXT_LANG_RC_ERROR; |
18a9fc12 | 1531 | } |
18a9fc12 | 1532 | |
7780f186 TT |
1533 | gdbpy_ref<> result_obj (PyObject_CallFunctionObjArgs (func.get (), |
1534 | printers_obj, | |
1535 | type_obj.get (), | |
1536 | (char *) NULL)); | |
18a9fc12 TT |
1537 | if (result_obj == NULL) |
1538 | { | |
1539 | gdbpy_print_stack (); | |
59876f8f | 1540 | return EXT_LANG_RC_ERROR; |
18a9fc12 | 1541 | } |
18a9fc12 | 1542 | |
59876f8f TT |
1543 | if (result_obj == Py_None) |
1544 | return EXT_LANG_RC_NOP; | |
18a9fc12 | 1545 | |
59876f8f TT |
1546 | result = python_string_to_host_string (result_obj.get ()); |
1547 | if (result == NULL) | |
9b972014 | 1548 | { |
59876f8f TT |
1549 | gdbpy_print_stack (); |
1550 | return EXT_LANG_RC_ERROR; | |
9b972014 | 1551 | } |
59876f8f TT |
1552 | |
1553 | *prettied_type = result.release (); | |
1554 | return EXT_LANG_RC_OK; | |
18a9fc12 TT |
1555 | } |
1556 | ||
6dddc817 DE |
1557 | /* Free the result of start_type_printers. |
1558 | This is the extension_language_ops.free_type_printers "method". */ | |
18a9fc12 | 1559 | |
6dddc817 DE |
1560 | static void |
1561 | gdbpy_free_type_printers (const struct extension_language_defn *extlang, | |
1562 | struct ext_lang_type_printers *ext_printers) | |
18a9fc12 | 1563 | { |
19ba03f4 | 1564 | PyObject *printers = (PyObject *) ext_printers->py_type_printers; |
18a9fc12 TT |
1565 | |
1566 | if (printers == NULL) | |
1567 | return; | |
1568 | ||
0646da15 TT |
1569 | if (!gdb_python_initialized) |
1570 | return; | |
1571 | ||
60e600ec | 1572 | gdbpy_enter enter_py (get_current_arch (), current_language); |
18a9fc12 | 1573 | Py_DECREF (printers); |
18a9fc12 TT |
1574 | } |
1575 | ||
d57a3c85 TJB |
1576 | #else /* HAVE_PYTHON */ |
1577 | ||
8315665e YPK |
1578 | /* Dummy implementation of the gdb "python-interactive" and "python" |
1579 | command. */ | |
d57a3c85 TJB |
1580 | |
1581 | static void | |
0b39b52e | 1582 | python_interactive_command (const char *arg, int from_tty) |
d57a3c85 | 1583 | { |
529480d0 | 1584 | arg = skip_spaces (arg); |
d57a3c85 TJB |
1585 | if (arg && *arg) |
1586 | error (_("Python scripting is not supported in this copy of GDB.")); | |
1587 | else | |
1588 | { | |
93921405 | 1589 | command_line_up l = get_command_line (python_control, ""); |
d59b6f6c | 1590 | |
93921405 | 1591 | execute_control_command_untraced (l.get ()); |
d57a3c85 TJB |
1592 | } |
1593 | } | |
1594 | ||
8315665e | 1595 | static void |
0b39b52e | 1596 | python_command (const char *arg, int from_tty) |
8315665e YPK |
1597 | { |
1598 | python_interactive_command (arg, from_tty); | |
1599 | } | |
1600 | ||
d57a3c85 TJB |
1601 | #endif /* HAVE_PYTHON */ |
1602 | ||
1603 | \f | |
1604 | ||
713389e0 PM |
1605 | /* Lists for 'set python' commands. */ |
1606 | ||
1607 | static struct cmd_list_element *user_set_python_list; | |
1608 | static struct cmd_list_element *user_show_python_list; | |
d57a3c85 | 1609 | |
713389e0 PM |
1610 | /* Function for use by 'set python' prefix command. */ |
1611 | ||
1612 | static void | |
981a3fb3 | 1613 | user_set_python (const char *args, int from_tty) |
713389e0 PM |
1614 | { |
1615 | help_list (user_set_python_list, "set python ", all_commands, | |
1616 | gdb_stdout); | |
1617 | } | |
1618 | ||
1619 | /* Function for use by 'show python' prefix command. */ | |
1620 | ||
1621 | static void | |
981a3fb3 | 1622 | user_show_python (const char *args, int from_tty) |
d57a3c85 | 1623 | { |
713389e0 | 1624 | cmd_show_list (user_show_python_list, from_tty, ""); |
d57a3c85 TJB |
1625 | } |
1626 | ||
1627 | /* Initialize the Python code. */ | |
1628 | ||
810849a3 AS |
1629 | #ifdef HAVE_PYTHON |
1630 | ||
d7de8e3c TT |
1631 | /* This is installed as a final cleanup and cleans up the |
1632 | interpreter. This lets Python's 'atexit' work. */ | |
1633 | ||
1634 | static void | |
1635 | finalize_python (void *ignore) | |
1636 | { | |
6dddc817 DE |
1637 | struct active_ext_lang_state *previous_active; |
1638 | ||
d7de8e3c TT |
1639 | /* We don't use ensure_python_env here because if we ever ran the |
1640 | cleanup, gdb would crash -- because the cleanup calls into the | |
1641 | Python interpreter, which we are about to destroy. It seems | |
1642 | clearer to make the needed calls explicitly here than to create a | |
1643 | cleanup and then mysteriously discard it. */ | |
6dddc817 DE |
1644 | |
1645 | /* This is only called as a final cleanup so we can assume the active | |
1646 | SIGINT handler is gdb's. We still need to tell it to notify Python. */ | |
1647 | previous_active = set_active_ext_lang (&extension_language_python); | |
1648 | ||
b1209b03 | 1649 | (void) PyGILState_Ensure (); |
f5656ead | 1650 | python_gdbarch = target_gdbarch (); |
d7de8e3c TT |
1651 | python_language = current_language; |
1652 | ||
1653 | Py_Finalize (); | |
6dddc817 DE |
1654 | |
1655 | restore_active_ext_lang (previous_active); | |
d7de8e3c | 1656 | } |
2bb8f231 TT |
1657 | |
1658 | static bool | |
1659 | do_start_initialization () | |
d57a3c85 | 1660 | { |
9a27f2c6 PK |
1661 | char *progname; |
1662 | #ifdef IS_PY3K | |
1663 | int i; | |
1664 | size_t progsize, count; | |
9a27f2c6 PK |
1665 | wchar_t *progname_copy; |
1666 | #endif | |
713389e0 | 1667 | |
0c4a4063 DE |
1668 | #ifdef WITH_PYTHON_PATH |
1669 | /* Work around problem where python gets confused about where it is, | |
1670 | and then can't find its libraries, etc. | |
1671 | NOTE: Python assumes the following layout: | |
1672 | /foo/bin/python | |
1673 | /foo/lib/pythonX.Y/... | |
1674 | This must be done before calling Py_Initialize. */ | |
d721ba37 | 1675 | progname = concat (ldirname (python_libdir).c_str (), SLASH_STRING, "bin", |
b36cec19 | 1676 | SLASH_STRING, "python", (char *) NULL); |
9a27f2c6 | 1677 | #ifdef IS_PY3K |
7f968c89 | 1678 | std::string oldloc = setlocale (LC_ALL, NULL); |
9a27f2c6 PK |
1679 | setlocale (LC_ALL, ""); |
1680 | progsize = strlen (progname); | |
db0f0d0c | 1681 | progname_copy = (wchar_t *) PyMem_Malloc ((progsize + 1) * sizeof (wchar_t)); |
9a27f2c6 PK |
1682 | if (!progname_copy) |
1683 | { | |
1684 | fprintf (stderr, "out of memory\n"); | |
2bb8f231 | 1685 | return false; |
9a27f2c6 PK |
1686 | } |
1687 | count = mbstowcs (progname_copy, progname, progsize + 1); | |
1688 | if (count == (size_t) -1) | |
1689 | { | |
1690 | fprintf (stderr, "Could not convert python path to string\n"); | |
2bb8f231 | 1691 | return false; |
9a27f2c6 | 1692 | } |
7f968c89 | 1693 | setlocale (LC_ALL, oldloc.c_str ()); |
9a27f2c6 PK |
1694 | |
1695 | /* Note that Py_SetProgramName expects the string it is passed to | |
1696 | remain alive for the duration of the program's execution, so | |
1697 | it is not freed after this call. */ | |
1698 | Py_SetProgramName (progname_copy); | |
1699 | #else | |
1700 | Py_SetProgramName (progname); | |
1701 | #endif | |
0c4a4063 DE |
1702 | #endif |
1703 | ||
d57a3c85 | 1704 | Py_Initialize (); |
ca30a762 | 1705 | PyEval_InitThreads (); |
d57a3c85 | 1706 | |
9a27f2c6 | 1707 | #ifdef IS_PY3K |
bcabf420 | 1708 | gdb_module = PyModule_Create (&python_GdbModuleDef); |
9a27f2c6 PK |
1709 | /* Add _gdb module to the list of known built-in modules. */ |
1710 | _PyImport_FixupBuiltin (gdb_module, "_gdb"); | |
1711 | #else | |
bcabf420 | 1712 | gdb_module = Py_InitModule ("_gdb", python_GdbMethods); |
9a27f2c6 | 1713 | #endif |
999633ed | 1714 | if (gdb_module == NULL) |
2bb8f231 | 1715 | return false; |
d57a3c85 TJB |
1716 | |
1717 | /* The casts to (char*) are for python 2.4. */ | |
999633ed TT |
1718 | if (PyModule_AddStringConstant (gdb_module, "VERSION", (char*) version) < 0 |
1719 | || PyModule_AddStringConstant (gdb_module, "HOST_CONFIG", | |
1720 | (char*) host_name) < 0 | |
1721 | || PyModule_AddStringConstant (gdb_module, "TARGET_CONFIG", | |
1722 | (char*) target_name) < 0) | |
2bb8f231 | 1723 | return false; |
f17618ea | 1724 | |
99c3dc11 | 1725 | /* Add stream constants. */ |
999633ed TT |
1726 | if (PyModule_AddIntConstant (gdb_module, "STDOUT", 0) < 0 |
1727 | || PyModule_AddIntConstant (gdb_module, "STDERR", 1) < 0 | |
1728 | || PyModule_AddIntConstant (gdb_module, "STDLOG", 2) < 0) | |
2bb8f231 | 1729 | return false; |
d57a3c85 | 1730 | |
621c8364 | 1731 | gdbpy_gdb_error = PyErr_NewException ("gdb.error", PyExc_RuntimeError, NULL); |
999633ed | 1732 | if (gdbpy_gdb_error == NULL |
aa36459a | 1733 | || gdb_pymodule_addobject (gdb_module, "error", gdbpy_gdb_error) < 0) |
2bb8f231 | 1734 | return false; |
621c8364 TT |
1735 | |
1736 | gdbpy_gdb_memory_error = PyErr_NewException ("gdb.MemoryError", | |
1737 | gdbpy_gdb_error, NULL); | |
999633ed | 1738 | if (gdbpy_gdb_memory_error == NULL |
aa36459a TT |
1739 | || gdb_pymodule_addobject (gdb_module, "MemoryError", |
1740 | gdbpy_gdb_memory_error) < 0) | |
2bb8f231 | 1741 | return false; |
621c8364 | 1742 | |
07ca107c | 1743 | gdbpy_gdberror_exc = PyErr_NewException ("gdb.GdbError", NULL, NULL); |
999633ed | 1744 | if (gdbpy_gdberror_exc == NULL |
aa36459a TT |
1745 | || gdb_pymodule_addobject (gdb_module, "GdbError", |
1746 | gdbpy_gdberror_exc) < 0) | |
2bb8f231 | 1747 | return false; |
07ca107c | 1748 | |
037bbc8e | 1749 | gdbpy_initialize_gdb_readline (); |
999633ed TT |
1750 | |
1751 | if (gdbpy_initialize_auto_load () < 0 | |
1752 | || gdbpy_initialize_values () < 0 | |
1753 | || gdbpy_initialize_frames () < 0 | |
1754 | || gdbpy_initialize_commands () < 0 | |
d050f7d7 | 1755 | || gdbpy_initialize_instruction () < 0 |
4726b2d8 | 1756 | || gdbpy_initialize_record () < 0 |
75c0bdf4 | 1757 | || gdbpy_initialize_btrace () < 0 |
999633ed TT |
1758 | || gdbpy_initialize_symbols () < 0 |
1759 | || gdbpy_initialize_symtabs () < 0 | |
1760 | || gdbpy_initialize_blocks () < 0 | |
1761 | || gdbpy_initialize_functions () < 0 | |
1762 | || gdbpy_initialize_parameters () < 0 | |
1763 | || gdbpy_initialize_types () < 0 | |
1764 | || gdbpy_initialize_pspace () < 0 | |
1765 | || gdbpy_initialize_objfile () < 0 | |
1766 | || gdbpy_initialize_breakpoints () < 0 | |
1767 | || gdbpy_initialize_finishbreakpoints () < 0 | |
1768 | || gdbpy_initialize_lazy_string () < 0 | |
bc79de95 | 1769 | || gdbpy_initialize_linetable () < 0 |
999633ed TT |
1770 | || gdbpy_initialize_thread () < 0 |
1771 | || gdbpy_initialize_inferior () < 0 | |
1772 | || gdbpy_initialize_events () < 0 | |
1773 | || gdbpy_initialize_eventregistry () < 0 | |
1774 | || gdbpy_initialize_py_events () < 0 | |
1775 | || gdbpy_initialize_event () < 0 | |
883964a7 | 1776 | || gdbpy_initialize_arch () < 0 |
d11916aa SS |
1777 | || gdbpy_initialize_xmethods () < 0 |
1778 | || gdbpy_initialize_unwind () < 0) | |
2bb8f231 | 1779 | return false; |
505500db | 1780 | |
7d221d74 TT |
1781 | #define GDB_PY_DEFINE_EVENT_TYPE(name, py_name, doc, base) \ |
1782 | if (gdbpy_initialize_event_generic (&name##_event_object_type, py_name) < 0) \ | |
1783 | return false; | |
1784 | #include "py-event-types.def" | |
1785 | #undef GDB_PY_DEFINE_EVENT_TYPE | |
1786 | ||
a6bac58e | 1787 | gdbpy_to_string_cst = PyString_FromString ("to_string"); |
999633ed | 1788 | if (gdbpy_to_string_cst == NULL) |
2bb8f231 | 1789 | return false; |
a6bac58e | 1790 | gdbpy_children_cst = PyString_FromString ("children"); |
999633ed | 1791 | if (gdbpy_children_cst == NULL) |
2bb8f231 | 1792 | return false; |
a6bac58e | 1793 | gdbpy_display_hint_cst = PyString_FromString ("display_hint"); |
999633ed | 1794 | if (gdbpy_display_hint_cst == NULL) |
2bb8f231 | 1795 | return false; |
d8906c6f | 1796 | gdbpy_doc_cst = PyString_FromString ("__doc__"); |
999633ed | 1797 | if (gdbpy_doc_cst == NULL) |
2bb8f231 | 1798 | return false; |
967cf477 | 1799 | gdbpy_enabled_cst = PyString_FromString ("enabled"); |
999633ed | 1800 | if (gdbpy_enabled_cst == NULL) |
2bb8f231 | 1801 | return false; |
fb6a3ed3 | 1802 | gdbpy_value_cst = PyString_FromString ("value"); |
999633ed | 1803 | if (gdbpy_value_cst == NULL) |
2bb8f231 | 1804 | return false; |
d8906c6f | 1805 | |
9dea9163 DE |
1806 | /* Release the GIL while gdb runs. */ |
1807 | PyThreadState_Swap (NULL); | |
1808 | PyEval_ReleaseLock (); | |
1809 | ||
d7de8e3c | 1810 | make_final_cleanup (finalize_python, NULL); |
999633ed | 1811 | |
2bb8f231 | 1812 | /* Only set this when initialization has succeeded. */ |
999633ed | 1813 | gdb_python_initialized = 1; |
2bb8f231 TT |
1814 | return true; |
1815 | } | |
999633ed | 1816 | |
2bb8f231 | 1817 | #endif /* HAVE_PYTHON */ |
999633ed | 1818 | |
2bb8f231 TT |
1819 | void |
1820 | _initialize_python (void) | |
1821 | { | |
1822 | add_com ("python-interactive", class_obscure, | |
1823 | python_interactive_command, | |
1824 | #ifdef HAVE_PYTHON | |
1825 | _("\ | |
1826 | Start an interactive Python prompt.\n\ | |
1827 | \n\ | |
1828 | To return to GDB, type the EOF character (e.g., Ctrl-D on an empty\n\ | |
1829 | prompt).\n\ | |
1830 | \n\ | |
1831 | Alternatively, a single-line Python command can be given as an\n\ | |
1832 | argument, and if the command is an expression, the result will be\n\ | |
1833 | printed. For example:\n\ | |
1834 | \n\ | |
1835 | (gdb) python-interactive 2 + 3\n\ | |
1836 | 5\n\ | |
1837 | ") | |
1838 | #else /* HAVE_PYTHON */ | |
1839 | _("\ | |
1840 | Start a Python interactive prompt.\n\ | |
1841 | \n\ | |
1842 | Python scripting is not supported in this copy of GDB.\n\ | |
1843 | This command is only a placeholder.") | |
1844 | #endif /* HAVE_PYTHON */ | |
1845 | ); | |
1846 | add_com_alias ("pi", "python-interactive", class_obscure, 1); | |
1847 | ||
1848 | add_com ("python", class_obscure, python_command, | |
1849 | #ifdef HAVE_PYTHON | |
1850 | _("\ | |
1851 | Evaluate a Python command.\n\ | |
1852 | \n\ | |
1853 | The command can be given as an argument, for instance:\n\ | |
1854 | \n\ | |
1855 | python print 23\n\ | |
1856 | \n\ | |
1857 | If no argument is given, the following lines are read and used\n\ | |
1858 | as the Python commands. Type a line containing \"end\" to indicate\n\ | |
1859 | the end of the command.") | |
1860 | #else /* HAVE_PYTHON */ | |
1861 | _("\ | |
1862 | Evaluate a Python command.\n\ | |
1863 | \n\ | |
1864 | Python scripting is not supported in this copy of GDB.\n\ | |
1865 | This command is only a placeholder.") | |
1866 | #endif /* HAVE_PYTHON */ | |
1867 | ); | |
1868 | add_com_alias ("py", "python", class_obscure, 1); | |
1869 | ||
1870 | /* Add set/show python print-stack. */ | |
1871 | add_prefix_cmd ("python", no_class, user_show_python, | |
1872 | _("Prefix command for python preference settings."), | |
1873 | &user_show_python_list, "show python ", 0, | |
1874 | &showlist); | |
1875 | ||
1876 | add_prefix_cmd ("python", no_class, user_set_python, | |
1877 | _("Prefix command for python preference settings."), | |
1878 | &user_set_python_list, "set python ", 0, | |
1879 | &setlist); | |
1880 | ||
1881 | add_setshow_enum_cmd ("print-stack", no_class, python_excp_enums, | |
1882 | &gdbpy_should_print_stack, _("\ | |
1883 | Set mode for Python stack dump on error."), _("\ | |
1884 | Show the mode of Python stack printing on error."), _("\ | |
1885 | none == no stack or message will be printed.\n\ | |
1886 | full == a message and a stack will be printed.\n\ | |
1887 | message == an error message without a stack will be printed."), | |
1888 | NULL, NULL, | |
1889 | &user_set_python_list, | |
1890 | &user_show_python_list); | |
1891 | ||
1892 | #ifdef HAVE_PYTHON | |
1893 | if (!do_start_initialization () && PyErr_Occurred ()) | |
1894 | gdbpy_print_stack (); | |
9dea9163 DE |
1895 | #endif /* HAVE_PYTHON */ |
1896 | } | |
1897 | ||
1898 | #ifdef HAVE_PYTHON | |
1899 | ||
a7785f8c TT |
1900 | /* Helper function for gdbpy_finish_initialization. This does the |
1901 | work and then returns false if an error has occurred and must be | |
1902 | displayed, or true on success. */ | |
9dea9163 | 1903 | |
a7785f8c TT |
1904 | static bool |
1905 | do_finish_initialization (const struct extension_language_defn *extlang) | |
9dea9163 | 1906 | { |
b9516fa1 | 1907 | PyObject *m; |
b9516fa1 | 1908 | PyObject *sys_path; |
f17618ea | 1909 | |
b9516fa1 YPK |
1910 | /* Add the initial data-directory to sys.path. */ |
1911 | ||
a7785f8c TT |
1912 | std::string gdb_pythondir = (std::string (gdb_datadir) + SLASH_STRING |
1913 | + "python"); | |
b9516fa1 YPK |
1914 | |
1915 | sys_path = PySys_GetObject ("path"); | |
ca30a762 | 1916 | |
9a27f2c6 PK |
1917 | /* If sys.path is not defined yet, define it first. */ |
1918 | if (!(sys_path && PyList_Check (sys_path))) | |
1919 | { | |
1920 | #ifdef IS_PY3K | |
1921 | PySys_SetPath (L""); | |
1922 | #else | |
1923 | PySys_SetPath (""); | |
1924 | #endif | |
1925 | sys_path = PySys_GetObject ("path"); | |
1926 | } | |
256458bc | 1927 | if (sys_path && PyList_Check (sys_path)) |
b9516fa1 | 1928 | { |
7780f186 | 1929 | gdbpy_ref<> pythondir (PyString_FromString (gdb_pythondir.c_str ())); |
a7785f8c TT |
1930 | if (pythondir == NULL || PyList_Insert (sys_path, 0, pythondir.get ())) |
1931 | return false; | |
b9516fa1 YPK |
1932 | } |
1933 | else | |
a7785f8c | 1934 | return false; |
b9516fa1 YPK |
1935 | |
1936 | /* Import the gdb module to finish the initialization, and | |
1937 | add it to __main__ for convenience. */ | |
1938 | m = PyImport_AddModule ("__main__"); | |
1939 | if (m == NULL) | |
a7785f8c | 1940 | return false; |
b9516fa1 | 1941 | |
a7785f8c TT |
1942 | /* Keep the reference to gdb_python_module since it is in a global |
1943 | variable. */ | |
b9516fa1 YPK |
1944 | gdb_python_module = PyImport_ImportModule ("gdb"); |
1945 | if (gdb_python_module == NULL) | |
1946 | { | |
1947 | gdbpy_print_stack (); | |
41245087 DE |
1948 | /* This is passed in one call to warning so that blank lines aren't |
1949 | inserted between each line of text. */ | |
1950 | warning (_("\n" | |
1951 | "Could not load the Python gdb module from `%s'.\n" | |
1952 | "Limited Python support is available from the _gdb module.\n" | |
1953 | "Suggest passing --data-directory=/path/to/gdb/data-directory.\n"), | |
a7785f8c TT |
1954 | gdb_pythondir.c_str ()); |
1955 | /* We return "success" here as we've already emitted the | |
1956 | warning. */ | |
1957 | return true; | |
b9516fa1 YPK |
1958 | } |
1959 | ||
a7785f8c TT |
1960 | return gdb_pymodule_addobject (m, "gdb", gdb_python_module) >= 0; |
1961 | } | |
b9516fa1 | 1962 | |
a7785f8c TT |
1963 | /* Perform the remaining python initializations. |
1964 | These must be done after GDB is at least mostly initialized. | |
1965 | E.g., The "info pretty-printer" command needs the "info" prefix | |
1966 | command installed. | |
1967 | This is the extension_language_ops.finish_initialization "method". */ | |
b9516fa1 | 1968 | |
a7785f8c TT |
1969 | static void |
1970 | gdbpy_finish_initialization (const struct extension_language_defn *extlang) | |
1971 | { | |
1972 | gdbpy_enter enter_py (get_current_arch (), current_language); | |
b9516fa1 | 1973 | |
a7785f8c TT |
1974 | if (!do_finish_initialization (extlang)) |
1975 | { | |
1976 | gdbpy_print_stack (); | |
1977 | warning (_("internal error: Unhandled Python exception")); | |
1978 | } | |
9dea9163 | 1979 | } |
ca30a762 | 1980 | |
6dddc817 DE |
1981 | /* Return non-zero if Python has successfully initialized. |
1982 | This is the extension_languages_ops.initialized "method". */ | |
1983 | ||
1984 | static int | |
1985 | gdbpy_initialized (const struct extension_language_defn *extlang) | |
1986 | { | |
1987 | return gdb_python_initialized; | |
1988 | } | |
1989 | ||
d57a3c85 | 1990 | #endif /* HAVE_PYTHON */ |
12453b93 TJB |
1991 | |
1992 | \f | |
1993 | ||
9dea9163 | 1994 | #ifdef HAVE_PYTHON |
12453b93 | 1995 | |
bcabf420 | 1996 | PyMethodDef python_GdbMethods[] = |
12453b93 TJB |
1997 | { |
1998 | { "history", gdbpy_history, METH_VARARGS, | |
1999 | "Get a value from history" }, | |
bc9f0842 | 2000 | { "execute", (PyCFunction) execute_gdb_command, METH_VARARGS | METH_KEYWORDS, |
751e7549 PM |
2001 | "execute (command [, from_tty] [, to_string]) -> [String]\n\ |
2002 | Evaluate command, a string, as a gdb CLI command. Optionally returns\n\ | |
2003 | a Python String containing the output of the command if to_string is\n\ | |
2004 | set to True." }, | |
8f500870 | 2005 | { "parameter", gdbpy_parameter, METH_VARARGS, |
12453b93 TJB |
2006 | "Return a gdb parameter's value" }, |
2007 | ||
adc36818 PM |
2008 | { "breakpoints", gdbpy_breakpoints, METH_NOARGS, |
2009 | "Return a tuple of all breakpoint objects" }, | |
2010 | ||
b6313243 TT |
2011 | { "default_visualizer", gdbpy_default_visualizer, METH_VARARGS, |
2012 | "Find the default visualizer for a Value." }, | |
2013 | ||
fa33c3cd DE |
2014 | { "current_progspace", gdbpy_get_current_progspace, METH_NOARGS, |
2015 | "Return the current Progspace." }, | |
2016 | { "progspaces", gdbpy_progspaces, METH_NOARGS, | |
2017 | "Return a sequence of all progspaces." }, | |
2018 | ||
89c73ade TT |
2019 | { "current_objfile", gdbpy_get_current_objfile, METH_NOARGS, |
2020 | "Return the current Objfile being loaded, or None." }, | |
2021 | { "objfiles", gdbpy_objfiles, METH_NOARGS, | |
2022 | "Return a sequence of all loaded objfiles." }, | |
2023 | ||
d8e22779 TT |
2024 | { "newest_frame", gdbpy_newest_frame, METH_NOARGS, |
2025 | "newest_frame () -> gdb.Frame.\n\ | |
2026 | Return the newest frame object." }, | |
f8f6f20b TJB |
2027 | { "selected_frame", gdbpy_selected_frame, METH_NOARGS, |
2028 | "selected_frame () -> gdb.Frame.\n\ | |
2029 | Return the selected frame object." }, | |
2030 | { "frame_stop_reason_string", gdbpy_frame_stop_reason_string, METH_VARARGS, | |
2031 | "stop_reason_string (Integer) -> String.\n\ | |
2032 | Return a string explaining unwind stop reason." }, | |
2033 | ||
4726b2d8 TW |
2034 | { "start_recording", gdbpy_start_recording, METH_VARARGS, |
2035 | "start_recording ([method] [, format]) -> gdb.Record.\n\ | |
2036 | Start recording with the given method. If no method is given, will fall back\n\ | |
2037 | to the system default method. If no format is given, will fall back to the\n\ | |
2038 | default format for the given method."}, | |
2039 | { "current_recording", gdbpy_current_recording, METH_NOARGS, | |
2040 | "current_recording () -> gdb.Record.\n\ | |
2041 | Return current recording object." }, | |
2042 | { "stop_recording", gdbpy_stop_recording, METH_NOARGS, | |
2043 | "stop_recording () -> None.\n\ | |
2044 | Stop current recording." }, | |
2045 | ||
2c74e833 TT |
2046 | { "lookup_type", (PyCFunction) gdbpy_lookup_type, |
2047 | METH_VARARGS | METH_KEYWORDS, | |
2048 | "lookup_type (name [, block]) -> type\n\ | |
2049 | Return a Type corresponding to the given name." }, | |
f3e9a817 PM |
2050 | { "lookup_symbol", (PyCFunction) gdbpy_lookup_symbol, |
2051 | METH_VARARGS | METH_KEYWORDS, | |
2052 | "lookup_symbol (name [, block] [, domain]) -> (symbol, is_field_of_this)\n\ | |
2053 | Return a tuple with the symbol corresponding to the given name (or None) and\n\ | |
2054 | a boolean indicating if name is a field of the current implied argument\n\ | |
2055 | `this' (when the current language is object-oriented)." }, | |
6e6fbe60 DE |
2056 | { "lookup_global_symbol", (PyCFunction) gdbpy_lookup_global_symbol, |
2057 | METH_VARARGS | METH_KEYWORDS, | |
2058 | "lookup_global_symbol (name [, domain]) -> symbol\n\ | |
2059 | Return the symbol corresponding to the given name (or None)." }, | |
6dddd6a5 DE |
2060 | |
2061 | { "lookup_objfile", (PyCFunction) gdbpy_lookup_objfile, | |
2062 | METH_VARARGS | METH_KEYWORDS, | |
2063 | "lookup_objfile (name, [by_build_id]) -> objfile\n\ | |
2064 | Look up the specified objfile.\n\ | |
2065 | If by_build_id is True, the objfile is looked up by using name\n\ | |
2066 | as its build id." }, | |
2067 | ||
f3e9a817 PM |
2068 | { "block_for_pc", gdbpy_block_for_pc, METH_VARARGS, |
2069 | "Return the block containing the given pc value, or None." }, | |
cb2e07a6 PM |
2070 | { "solib_name", gdbpy_solib_name, METH_VARARGS, |
2071 | "solib_name (Long) -> String.\n\ | |
2072 | Return the name of the shared library holding a given address, or None." }, | |
2073 | { "decode_line", gdbpy_decode_line, METH_VARARGS, | |
2074 | "decode_line (String) -> Tuple. Decode a string argument the way\n\ | |
2075 | that 'break' or 'edit' does. Return a tuple containing two elements.\n\ | |
2076 | The first element contains any unparsed portion of the String parameter\n\ | |
2077 | (or None if the string was fully parsed). The second element contains\n\ | |
2078 | a tuple that contains all the locations that match, represented as\n\ | |
2079 | gdb.Symtab_and_line objects (or None)."}, | |
57a1d736 TT |
2080 | { "parse_and_eval", gdbpy_parse_and_eval, METH_VARARGS, |
2081 | "parse_and_eval (String) -> Value.\n\ | |
2082 | Parse String as an expression, evaluate it, and return the result as a Value." | |
2083 | }, | |
7efc75aa SCR |
2084 | { "find_pc_line", gdbpy_find_pc_line, METH_VARARGS, |
2085 | "find_pc_line (pc) -> Symtab_and_line.\n\ | |
2086 | Return the gdb.Symtab_and_line object corresponding to the pc value." }, | |
57a1d736 | 2087 | |
ca5c20b6 PM |
2088 | { "post_event", gdbpy_post_event, METH_VARARGS, |
2089 | "Post an event into gdb's event loop." }, | |
2090 | ||
f870a310 TT |
2091 | { "target_charset", gdbpy_target_charset, METH_NOARGS, |
2092 | "target_charset () -> string.\n\ | |
2093 | Return the name of the current target charset." }, | |
2094 | { "target_wide_charset", gdbpy_target_wide_charset, METH_NOARGS, | |
2095 | "target_wide_charset () -> string.\n\ | |
2096 | Return the name of the current target wide charset." }, | |
d8ae99a7 PM |
2097 | { "rbreak", (PyCFunction) gdbpy_rbreak, METH_VARARGS | METH_KEYWORDS, |
2098 | "rbreak (Regex) -> List.\n\ | |
2099 | Return a Tuple containing gdb.Breakpoint objects that match the given Regex." }, | |
07ca107c DE |
2100 | { "string_to_argv", gdbpy_string_to_argv, METH_VARARGS, |
2101 | "string_to_argv (String) -> Array.\n\ | |
2102 | Parse String and return an argv-like array.\n\ | |
2103 | Arguments are separate by spaces and may be quoted." | |
2104 | }, | |
99c3dc11 | 2105 | { "write", (PyCFunction)gdbpy_write, METH_VARARGS | METH_KEYWORDS, |
12453b93 | 2106 | "Write a string using gdb's filtered stream." }, |
99c3dc11 | 2107 | { "flush", (PyCFunction)gdbpy_flush, METH_VARARGS | METH_KEYWORDS, |
12453b93 | 2108 | "Flush gdb's filtered stdout stream." }, |
595939de PM |
2109 | { "selected_thread", gdbpy_selected_thread, METH_NOARGS, |
2110 | "selected_thread () -> gdb.InferiorThread.\n\ | |
2111 | Return the selected thread object." }, | |
2aa48337 KP |
2112 | { "selected_inferior", gdbpy_selected_inferior, METH_NOARGS, |
2113 | "selected_inferior () -> gdb.Inferior.\n\ | |
2114 | Return the selected inferior object." }, | |
595939de PM |
2115 | { "inferiors", gdbpy_inferiors, METH_NOARGS, |
2116 | "inferiors () -> (gdb.Inferior, ...).\n\ | |
2117 | Return a tuple containing all inferiors." }, | |
e0f3fd7c TT |
2118 | |
2119 | { "invalidate_cached_frames", gdbpy_invalidate_cached_frames, METH_NOARGS, | |
2120 | "invalidate_cached_frames () -> None.\n\ | |
2121 | Invalidate any cached frame objects in gdb.\n\ | |
2122 | Intended for internal use only." }, | |
2123 | ||
12453b93 TJB |
2124 | {NULL, NULL, 0, NULL} |
2125 | }; | |
2126 | ||
9a27f2c6 | 2127 | #ifdef IS_PY3K |
bcabf420 | 2128 | struct PyModuleDef python_GdbModuleDef = |
9a27f2c6 PK |
2129 | { |
2130 | PyModuleDef_HEAD_INIT, | |
2131 | "_gdb", | |
2132 | NULL, | |
256458bc | 2133 | -1, |
02e62830 | 2134 | python_GdbMethods, |
9a27f2c6 PK |
2135 | NULL, |
2136 | NULL, | |
2137 | NULL, | |
2138 | NULL | |
2139 | }; | |
2140 | #endif | |
7d221d74 TT |
2141 | |
2142 | /* Define all the event objects. */ | |
2143 | #define GDB_PY_DEFINE_EVENT_TYPE(name, py_name, doc, base) \ | |
2144 | PyTypeObject name##_event_object_type \ | |
2145 | CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("event_object") \ | |
2146 | = { \ | |
2147 | PyVarObject_HEAD_INIT (NULL, 0) \ | |
2148 | "gdb." py_name, /* tp_name */ \ | |
2149 | sizeof (event_object), /* tp_basicsize */ \ | |
2150 | 0, /* tp_itemsize */ \ | |
2151 | evpy_dealloc, /* tp_dealloc */ \ | |
2152 | 0, /* tp_print */ \ | |
2153 | 0, /* tp_getattr */ \ | |
2154 | 0, /* tp_setattr */ \ | |
2155 | 0, /* tp_compare */ \ | |
2156 | 0, /* tp_repr */ \ | |
2157 | 0, /* tp_as_number */ \ | |
2158 | 0, /* tp_as_sequence */ \ | |
2159 | 0, /* tp_as_mapping */ \ | |
2160 | 0, /* tp_hash */ \ | |
2161 | 0, /* tp_call */ \ | |
2162 | 0, /* tp_str */ \ | |
2163 | 0, /* tp_getattro */ \ | |
2164 | 0, /* tp_setattro */ \ | |
2165 | 0, /* tp_as_buffer */ \ | |
2166 | Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */ \ | |
2167 | doc, /* tp_doc */ \ | |
2168 | 0, /* tp_traverse */ \ | |
2169 | 0, /* tp_clear */ \ | |
2170 | 0, /* tp_richcompare */ \ | |
2171 | 0, /* tp_weaklistoffset */ \ | |
2172 | 0, /* tp_iter */ \ | |
2173 | 0, /* tp_iternext */ \ | |
2174 | 0, /* tp_methods */ \ | |
2175 | 0, /* tp_members */ \ | |
2176 | 0, /* tp_getset */ \ | |
2177 | &base, /* tp_base */ \ | |
2178 | 0, /* tp_dict */ \ | |
2179 | 0, /* tp_descr_get */ \ | |
2180 | 0, /* tp_descr_set */ \ | |
2181 | 0, /* tp_dictoffset */ \ | |
2182 | 0, /* tp_init */ \ | |
2183 | 0 /* tp_alloc */ \ | |
2184 | }; | |
2185 | #include "py-event-types.def" | |
2186 | #undef GDB_PY_DEFINE_EVENT_TYPE | |
2187 | ||
12453b93 | 2188 | #endif /* HAVE_PYTHON */ |