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