1 /* General python/gdb code
3 Copyright (C) 2008-2016 Free Software Foundation, Inc.
5 This file is part of GDB.
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.
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.
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/>. */
21 #include "arch-utils.h"
24 #include "cli/cli-script.h"
26 #include "progspace.h"
30 #include "event-loop.h"
32 #include "readline/tilde.h"
34 #include "extension-priv.h"
35 #include "cli/cli-utils.h"
38 #include "ser-event.h"
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";
45 /* "set python print-stack" choices. */
46 static const char *const python_excp_enums
[] =
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
58 static const char *gdbpy_should_print_stack
= python_excp_message
;
61 /* Forward decls, these are defined later. */
62 extern const struct extension_language_script_ops python_extension_script_ops
;
63 extern const struct extension_language_ops python_extension_ops
;
66 /* The main struct describing GDB's interface to the Python
67 extension language. */
68 const struct extension_language_defn extension_language_python
=
80 &python_extension_script_ops
,
90 #include "cli/cli-decode.h"
94 #include "python-internal.h"
99 #include "gdbthread.h"
101 #include "event-top.h"
103 /* True if Python has been successfully initialized, false
106 int gdb_python_initialized
;
108 extern PyMethodDef python_GdbMethods
[];
111 extern struct PyModuleDef python_GdbModuleDef
;
114 PyObject
*gdb_module
;
115 PyObject
*gdb_python_module
;
117 /* Some string constants we may wish to use. */
118 PyObject
*gdbpy_to_string_cst
;
119 PyObject
*gdbpy_children_cst
;
120 PyObject
*gdbpy_display_hint_cst
;
121 PyObject
*gdbpy_doc_cst
;
122 PyObject
*gdbpy_enabled_cst
;
123 PyObject
*gdbpy_value_cst
;
125 /* The GdbError exception. */
126 PyObject
*gdbpy_gdberror_exc
;
128 /* The `gdb.error' base class. */
129 PyObject
*gdbpy_gdb_error
;
131 /* The `gdb.MemoryError' exception. */
132 PyObject
*gdbpy_gdb_memory_error
;
134 static script_sourcer_func gdbpy_source_script
;
135 static objfile_script_sourcer_func gdbpy_source_objfile_script
;
136 static objfile_script_executor_func gdbpy_execute_objfile_script
;
137 static void gdbpy_finish_initialization
138 (const struct extension_language_defn
*);
139 static int gdbpy_initialized (const struct extension_language_defn
*);
140 static void gdbpy_eval_from_control_command
141 (const struct extension_language_defn
*, struct command_line
*cmd
);
142 static void gdbpy_start_type_printers (const struct extension_language_defn
*,
143 struct ext_lang_type_printers
*);
144 static enum ext_lang_rc gdbpy_apply_type_printers
145 (const struct extension_language_defn
*,
146 const struct ext_lang_type_printers
*, struct type
*, char **);
147 static void gdbpy_free_type_printers (const struct extension_language_defn
*,
148 struct ext_lang_type_printers
*);
149 static void gdbpy_set_quit_flag (const struct extension_language_defn
*);
150 static int gdbpy_check_quit_flag (const struct extension_language_defn
*);
151 static enum ext_lang_rc gdbpy_before_prompt_hook
152 (const struct extension_language_defn
*, const char *current_gdb_prompt
);
154 /* The interface between gdb proper and loading of python scripts. */
156 const struct extension_language_script_ops python_extension_script_ops
=
159 gdbpy_source_objfile_script
,
160 gdbpy_execute_objfile_script
,
161 gdbpy_auto_load_enabled
164 /* The interface between gdb proper and python extensions. */
166 const struct extension_language_ops python_extension_ops
=
168 gdbpy_finish_initialization
,
171 gdbpy_eval_from_control_command
,
173 gdbpy_start_type_printers
,
174 gdbpy_apply_type_printers
,
175 gdbpy_free_type_printers
,
177 gdbpy_apply_val_pretty_printer
,
179 gdbpy_apply_frame_filter
,
181 gdbpy_preserve_values
,
183 gdbpy_breakpoint_has_cond
,
184 gdbpy_breakpoint_cond_says_stop
,
187 gdbpy_check_quit_flag
,
189 gdbpy_before_prompt_hook
,
191 gdbpy_clone_xmethod_worker_data
,
192 gdbpy_free_xmethod_worker_data
,
193 gdbpy_get_matching_xmethod_workers
,
194 gdbpy_get_xmethod_arg_types
,
195 gdbpy_get_xmethod_result_type
,
199 /* Architecture and language to be used in callbacks from
200 the Python interpreter. */
201 struct gdbarch
*python_gdbarch
;
202 const struct language_defn
*python_language
;
204 /* Restore global language and architecture and Python GIL state
205 when leaving the Python interpreter. */
209 struct active_ext_lang_state
*previous_active
;
210 PyGILState_STATE state
;
211 struct gdbarch
*gdbarch
;
212 const struct language_defn
*language
;
213 PyObject
*error_type
, *error_value
, *error_traceback
;
217 restore_python_env (void *p
)
219 struct python_env
*env
= (struct python_env
*)p
;
221 /* Leftover Python error is forbidden by Python Exception Handling. */
222 if (PyErr_Occurred ())
224 /* This order is similar to the one calling error afterwards. */
225 gdbpy_print_stack ();
226 warning (_("internal error: Unhandled Python exception"));
229 PyErr_Restore (env
->error_type
, env
->error_value
, env
->error_traceback
);
231 PyGILState_Release (env
->state
);
232 python_gdbarch
= env
->gdbarch
;
233 python_language
= env
->language
;
235 restore_active_ext_lang (env
->previous_active
);
240 /* Called before entering the Python interpreter to install the
241 current language and architecture to be used for Python values.
242 Also set the active extension language for GDB so that SIGINT's
243 are directed our way, and if necessary install the right SIGINT
247 ensure_python_env (struct gdbarch
*gdbarch
,
248 const struct language_defn
*language
)
250 struct python_env
*env
= XNEW (struct python_env
);
252 /* We should not ever enter Python unless initialized. */
253 if (!gdb_python_initialized
)
254 error (_("Python not initialized"));
256 env
->previous_active
= set_active_ext_lang (&extension_language_python
);
258 env
->state
= PyGILState_Ensure ();
259 env
->gdbarch
= python_gdbarch
;
260 env
->language
= python_language
;
262 python_gdbarch
= gdbarch
;
263 python_language
= language
;
265 /* Save it and ensure ! PyErr_Occurred () afterwards. */
266 PyErr_Fetch (&env
->error_type
, &env
->error_value
, &env
->error_traceback
);
268 return make_cleanup (restore_python_env
, env
);
271 /* Set the quit flag. */
274 gdbpy_set_quit_flag (const struct extension_language_defn
*extlang
)
276 PyErr_SetInterrupt ();
279 /* Return true if the quit flag has been set, false otherwise. */
282 gdbpy_check_quit_flag (const struct extension_language_defn
*extlang
)
284 return PyOS_InterruptOccurred ();
287 /* Evaluate a Python command like PyRun_SimpleString, but uses
288 Py_single_input which prints the result of expressions, and does
289 not automatically print the stack on errors. */
292 eval_python_command (const char *command
)
296 m
= PyImport_AddModule ("__main__");
300 d
= PyModule_GetDict (m
);
303 v
= PyRun_StringFlags (command
, Py_single_input
, d
, d
, NULL
);
316 /* Implementation of the gdb "python-interactive" command. */
319 python_interactive_command (char *arg
, int from_tty
)
321 struct ui
*ui
= current_ui
;
322 struct cleanup
*cleanup
;
325 cleanup
= make_cleanup_restore_integer (¤t_ui
->async
);
326 current_ui
->async
= 0;
328 arg
= skip_spaces (arg
);
330 ensure_python_env (get_current_arch (), current_language
);
334 int len
= strlen (arg
);
335 char *script
= (char *) xmalloc (len
+ 2);
337 strcpy (script
, arg
);
339 script
[len
+ 1] = '\0';
340 err
= eval_python_command (script
);
345 err
= PyRun_InteractiveLoop (ui
->instream
, "<stdin>");
351 gdbpy_print_stack ();
352 error (_("Error while executing Python code."));
355 do_cleanups (cleanup
);
358 /* A wrapper around PyRun_SimpleFile. FILE is the Python script to run
361 On Windows hosts few users would build Python themselves (this is no
362 trivial task on this platform), and thus use binaries built by
363 someone else instead. There may happen situation where the Python
364 library and GDB are using two different versions of the C runtime
365 library. Python, being built with VC, would use one version of the
366 msvcr DLL (Eg. msvcr100.dll), while MinGW uses msvcrt.dll.
367 A FILE * from one runtime does not necessarily operate correctly in
370 To work around this potential issue, we create on Windows hosts the
371 FILE object using Python routines, thus making sure that it is
372 compatible with the Python library. */
375 python_run_simple_file (FILE *file
, const char *filename
)
379 PyRun_SimpleFile (file
, filename
);
384 PyObject
*python_file
;
385 struct cleanup
*cleanup
;
387 /* Because we have a string for a filename, and are using Python to
388 open the file, we need to expand any tilde in the path first. */
389 full_path
= tilde_expand (filename
);
390 cleanup
= make_cleanup (xfree
, full_path
);
391 python_file
= PyFile_FromString (full_path
, "r");
394 do_cleanups (cleanup
);
395 gdbpy_print_stack ();
396 error (_("Error while opening file: %s"), full_path
);
399 make_cleanup_py_decref (python_file
);
400 PyRun_SimpleFile (PyFile_AsFile (python_file
), filename
);
401 do_cleanups (cleanup
);
406 /* Given a command_line, return a command string suitable for passing
407 to Python. Lines in the string are separated by newlines. The
408 return value is allocated using xmalloc and the caller is
409 responsible for freeing it. */
412 compute_python_string (struct command_line
*l
)
414 struct command_line
*iter
;
419 for (iter
= l
; iter
; iter
= iter
->next
)
420 size
+= strlen (iter
->line
) + 1;
422 script
= (char *) xmalloc (size
+ 1);
424 for (iter
= l
; iter
; iter
= iter
->next
)
426 int len
= strlen (iter
->line
);
428 strcpy (&script
[here
], iter
->line
);
430 script
[here
++] = '\n';
436 /* Take a command line structure representing a 'python' command, and
437 evaluate its body using the Python interpreter. */
440 gdbpy_eval_from_control_command (const struct extension_language_defn
*extlang
,
441 struct command_line
*cmd
)
445 struct cleanup
*cleanup
;
447 if (cmd
->body_count
!= 1)
448 error (_("Invalid \"python\" block structure."));
450 cleanup
= ensure_python_env (get_current_arch (), current_language
);
452 script
= compute_python_string (cmd
->body_list
[0]);
453 ret
= PyRun_SimpleString (script
);
456 error (_("Error while executing Python code."));
458 do_cleanups (cleanup
);
461 /* Implementation of the gdb "python" command. */
464 python_command (char *arg
, int from_tty
)
466 struct cleanup
*cleanup
;
468 cleanup
= ensure_python_env (get_current_arch (), current_language
);
470 make_cleanup_restore_integer (¤t_ui
->async
);
471 current_ui
->async
= 0;
473 arg
= skip_spaces (arg
);
476 if (PyRun_SimpleString (arg
))
477 error (_("Error while executing Python code."));
481 struct command_line
*l
= get_command_line (python_control
, "");
483 make_cleanup_free_command_lines (&l
);
484 execute_control_command_untraced (l
);
487 do_cleanups (cleanup
);
492 /* Transform a gdb parameters's value into a Python value. May return
493 NULL (and set a Python exception) on error. Helper function for
496 gdbpy_parameter_value (enum var_types type
, void *var
)
501 case var_string_noescape
:
502 case var_optional_filename
:
506 char *str
= * (char **) var
;
510 return host_string_to_python_string (str
);
521 case var_auto_boolean
:
523 enum auto_boolean ab
= * (enum auto_boolean
*) var
;
525 if (ab
== AUTO_BOOLEAN_TRUE
)
527 else if (ab
== AUTO_BOOLEAN_FALSE
)
534 if ((* (int *) var
) == INT_MAX
)
538 return PyLong_FromLong (* (int *) var
);
542 unsigned int val
= * (unsigned int *) var
;
546 return PyLong_FromUnsignedLong (val
);
550 return PyErr_Format (PyExc_RuntimeError
,
551 _("Programmer error: unhandled type."));
554 /* A Python function which returns a gdb parameter's value as a Python
558 gdbpy_parameter (PyObject
*self
, PyObject
*args
)
560 struct gdb_exception except
= exception_none
;
561 struct cmd_list_element
*alias
, *prefix
, *cmd
;
566 if (! PyArg_ParseTuple (args
, "s", &arg
))
569 newarg
= concat ("show ", arg
, (char *) NULL
);
573 found
= lookup_cmd_composition (newarg
, &alias
, &prefix
, &cmd
);
575 CATCH (ex
, RETURN_MASK_ALL
)
582 GDB_PY_HANDLE_EXCEPTION (except
);
584 return PyErr_Format (PyExc_RuntimeError
,
585 _("Could not find parameter `%s'."), arg
);
588 return PyErr_Format (PyExc_RuntimeError
,
589 _("`%s' is not a parameter."), arg
);
590 return gdbpy_parameter_value (cmd
->var_type
, cmd
->var
);
593 /* Wrapper for target_charset. */
596 gdbpy_target_charset (PyObject
*self
, PyObject
*args
)
598 const char *cset
= target_charset (python_gdbarch
);
600 return PyUnicode_Decode (cset
, strlen (cset
), host_charset (), NULL
);
603 /* Wrapper for target_wide_charset. */
606 gdbpy_target_wide_charset (PyObject
*self
, PyObject
*args
)
608 const char *cset
= target_wide_charset (python_gdbarch
);
610 return PyUnicode_Decode (cset
, strlen (cset
), host_charset (), NULL
);
613 /* A Python function which evaluates a string using the gdb CLI. */
616 execute_gdb_command (PyObject
*self
, PyObject
*args
, PyObject
*kw
)
619 PyObject
*from_tty_obj
= NULL
, *to_string_obj
= NULL
;
620 int from_tty
, to_string
;
621 static char *keywords
[] = {"command", "from_tty", "to_string", NULL
};
624 if (! PyArg_ParseTupleAndKeywords (args
, kw
, "s|O!O!", keywords
, &arg
,
625 &PyBool_Type
, &from_tty_obj
,
626 &PyBool_Type
, &to_string_obj
))
632 int cmp
= PyObject_IsTrue (from_tty_obj
);
641 int cmp
= PyObject_IsTrue (to_string_obj
);
649 /* Copy the argument text in case the command modifies it. */
650 char *copy
= xstrdup (arg
);
651 struct cleanup
*cleanup
= make_cleanup (xfree
, copy
);
652 struct interp
*interp
;
654 make_cleanup_restore_integer (¤t_ui
->async
);
655 current_ui
->async
= 0;
657 make_cleanup_restore_current_uiout ();
659 /* Use the console interpreter uiout to have the same print format
660 for console or MI. */
661 interp
= interp_lookup (current_ui
, "console");
662 current_uiout
= interp_ui_out (interp
);
664 prevent_dont_repeat ();
666 result
= execute_command_to_string (copy
, from_tty
);
670 execute_command (copy
, from_tty
);
673 do_cleanups (cleanup
);
675 CATCH (except
, RETURN_MASK_ALL
)
677 GDB_PY_HANDLE_EXCEPTION (except
);
681 /* Do any commands attached to breakpoint we stopped at. */
682 bpstat_do_actions ();
686 PyObject
*r
= PyString_FromString (result
);
693 /* Implementation of gdb.solib_name (Long) -> String.
694 Returns the name of the shared library holding a given address, or None. */
697 gdbpy_solib_name (PyObject
*self
, PyObject
*args
)
703 if (!PyArg_ParseTuple (args
, GDB_PY_LLU_ARG
, &pc
))
706 soname
= solib_name_from_address (current_program_space
, pc
);
708 str_obj
= host_string_to_python_string (soname
);
718 /* A Python function which is a wrapper for decode_line_1. */
721 gdbpy_decode_line (PyObject
*self
, PyObject
*args
)
723 struct gdb_exception except
= exception_none
;
724 struct symtabs_and_lines sals
= { NULL
, 0 }; /* Initialize to
726 struct symtab_and_line sal
;
728 struct cleanup
*cleanups
;
729 PyObject
*result
= NULL
;
730 PyObject
*return_result
= NULL
;
731 PyObject
*unparsed
= NULL
;
732 struct event_location
*location
= NULL
;
734 if (! PyArg_ParseTuple (args
, "|s", &arg
))
737 cleanups
= make_cleanup (null_cleanup
, NULL
);
743 location
= new_linespec_location (&arg
);
744 make_cleanup_delete_event_location (location
);
749 if (location
!= NULL
)
750 sals
= decode_line_1 (location
, 0, NULL
, NULL
, 0);
753 set_default_source_symtab_and_line ();
754 sal
= get_current_source_symtab_and_line ();
759 CATCH (ex
, RETURN_MASK_ALL
)
765 if (sals
.sals
!= NULL
&& sals
.sals
!= &sal
)
766 make_cleanup (xfree
, sals
.sals
);
768 if (except
.reason
< 0)
770 do_cleanups (cleanups
);
771 /* We know this will always throw. */
772 gdbpy_convert_exception (except
);
780 result
= PyTuple_New (sals
.nelts
);
783 for (i
= 0; i
< sals
.nelts
; ++i
)
787 obj
= symtab_and_line_to_sal_object (sals
.sals
[i
]);
794 PyTuple_SetItem (result
, i
, obj
);
803 return_result
= PyTuple_New (2);
810 if (arg
!= NULL
&& strlen (arg
) > 0)
812 unparsed
= PyString_FromString (arg
);
813 if (unparsed
== NULL
)
816 Py_DECREF (return_result
);
817 return_result
= NULL
;
827 PyTuple_SetItem (return_result
, 0, unparsed
);
828 PyTuple_SetItem (return_result
, 1, result
);
831 do_cleanups (cleanups
);
833 return return_result
;
836 /* Parse a string and evaluate it as an expression. */
838 gdbpy_parse_and_eval (PyObject
*self
, PyObject
*args
)
840 const char *expr_str
;
841 struct value
*result
= NULL
;
843 if (!PyArg_ParseTuple (args
, "s", &expr_str
))
848 result
= parse_and_eval (expr_str
);
850 CATCH (except
, RETURN_MASK_ALL
)
852 GDB_PY_HANDLE_EXCEPTION (except
);
856 return value_to_value_object (result
);
859 /* Implementation of gdb.find_pc_line function.
860 Returns the gdb.Symtab_and_line object corresponding to a PC value. */
863 gdbpy_find_pc_line (PyObject
*self
, PyObject
*args
)
865 gdb_py_ulongest pc_llu
;
866 PyObject
*result
= NULL
; /* init for gcc -Wall */
868 if (!PyArg_ParseTuple (args
, GDB_PY_LLU_ARG
, &pc_llu
))
873 struct symtab_and_line sal
;
876 pc
= (CORE_ADDR
) pc_llu
;
877 sal
= find_pc_line (pc
, 0);
878 result
= symtab_and_line_to_sal_object (sal
);
880 CATCH (except
, RETURN_MASK_ALL
)
882 GDB_PY_HANDLE_EXCEPTION (except
);
889 /* Implementation of gdb.invalidate_cached_frames. */
892 gdbpy_invalidate_cached_frames (PyObject
*self
, PyObject
*args
)
894 reinit_frame_cache ();
898 /* Read a file as Python code.
899 This is the extension_language_script_ops.script_sourcer "method".
900 FILE is the file to load. FILENAME is name of the file FILE.
901 This does not throw any errors. If an exception occurs python will print
902 the traceback and clear the error indicator. */
905 gdbpy_source_script (const struct extension_language_defn
*extlang
,
906 FILE *file
, const char *filename
)
908 struct cleanup
*cleanup
;
910 cleanup
= ensure_python_env (get_current_arch (), current_language
);
911 python_run_simple_file (file
, filename
);
912 do_cleanups (cleanup
);
917 /* Posting and handling events. */
919 /* A single event. */
922 /* The Python event. This is just a callable object. */
924 /* The next event. */
925 struct gdbpy_event
*next
;
928 /* All pending events. */
929 static struct gdbpy_event
*gdbpy_event_list
;
930 /* The final link of the event list. */
931 static struct gdbpy_event
**gdbpy_event_list_end
;
933 /* So that we can wake up the main thread even when it is blocked in
935 static struct serial_event
*gdbpy_serial_event
;
937 /* The file handler callback. This reads from the internal pipe, and
938 then processes the Python event queue. This will always be run in
939 the main gdb thread. */
942 gdbpy_run_events (int error
, gdb_client_data client_data
)
944 struct cleanup
*cleanup
;
946 cleanup
= ensure_python_env (get_current_arch (), current_language
);
948 /* Clear the event fd. Do this before flushing the events list, so
949 that any new event post afterwards is sure to re-awake the event
951 serial_event_clear (gdbpy_serial_event
);
953 while (gdbpy_event_list
)
955 PyObject
*call_result
;
957 /* Dispatching the event might push a new element onto the event
958 loop, so we update here "atomically enough". */
959 struct gdbpy_event
*item
= gdbpy_event_list
;
960 gdbpy_event_list
= gdbpy_event_list
->next
;
961 if (gdbpy_event_list
== NULL
)
962 gdbpy_event_list_end
= &gdbpy_event_list
;
965 call_result
= PyObject_CallObject (item
->event
, NULL
);
966 if (call_result
== NULL
)
969 Py_XDECREF (call_result
);
970 Py_DECREF (item
->event
);
974 do_cleanups (cleanup
);
977 /* Submit an event to the gdb thread. */
979 gdbpy_post_event (PyObject
*self
, PyObject
*args
)
981 struct gdbpy_event
*event
;
985 if (!PyArg_ParseTuple (args
, "O", &func
))
988 if (!PyCallable_Check (func
))
990 PyErr_SetString (PyExc_RuntimeError
,
991 _("Posted event is not callable"));
997 /* From here until the end of the function, we have the GIL, so we
998 can operate on our global data structures without worrying. */
999 wakeup
= gdbpy_event_list
== NULL
;
1001 event
= XNEW (struct gdbpy_event
);
1002 event
->event
= func
;
1004 *gdbpy_event_list_end
= event
;
1005 gdbpy_event_list_end
= &event
->next
;
1007 /* Wake up gdb when needed. */
1009 serial_event_set (gdbpy_serial_event
);
1014 /* Initialize the Python event handler. */
1016 gdbpy_initialize_events (void)
1018 gdbpy_event_list_end
= &gdbpy_event_list
;
1020 gdbpy_serial_event
= make_serial_event ();
1021 add_file_handler (serial_event_fd (gdbpy_serial_event
),
1022 gdbpy_run_events
, NULL
);
1029 /* This is the extension_language_ops.before_prompt "method". */
1031 static enum ext_lang_rc
1032 gdbpy_before_prompt_hook (const struct extension_language_defn
*extlang
,
1033 const char *current_gdb_prompt
)
1035 struct cleanup
*cleanup
;
1036 char *prompt
= NULL
;
1038 if (!gdb_python_initialized
)
1039 return EXT_LANG_RC_NOP
;
1041 cleanup
= ensure_python_env (get_current_arch (), current_language
);
1043 if (gdb_python_module
1044 && PyObject_HasAttrString (gdb_python_module
, "prompt_hook"))
1048 hook
= PyObject_GetAttrString (gdb_python_module
, "prompt_hook");
1052 make_cleanup_py_decref (hook
);
1054 if (PyCallable_Check (hook
))
1057 PyObject
*current_prompt
;
1059 current_prompt
= PyString_FromString (current_gdb_prompt
);
1060 if (current_prompt
== NULL
)
1063 result
= PyObject_CallFunctionObjArgs (hook
, current_prompt
, NULL
);
1065 Py_DECREF (current_prompt
);
1070 make_cleanup_py_decref (result
);
1072 /* Return type should be None, or a String. If it is None,
1073 fall through, we will not set a prompt. If it is a
1074 string, set PROMPT. Anything else, set an exception. */
1075 if (result
!= Py_None
&& ! PyString_Check (result
))
1077 PyErr_Format (PyExc_RuntimeError
,
1078 _("Return from prompt_hook must " \
1079 "be either a Python string, or None"));
1083 if (result
!= Py_None
)
1085 prompt
= python_string_to_host_string (result
);
1090 make_cleanup (xfree
, prompt
);
1095 /* If a prompt has been set, PROMPT will not be NULL. If it is
1096 NULL, do not set the prompt. */
1098 set_prompt (prompt
);
1100 do_cleanups (cleanup
);
1101 return prompt
!= NULL
? EXT_LANG_RC_OK
: EXT_LANG_RC_NOP
;
1104 gdbpy_print_stack ();
1105 do_cleanups (cleanup
);
1106 return EXT_LANG_RC_ERROR
;
1113 /* A python function to write a single string using gdb's filtered
1114 output stream . The optional keyword STREAM can be used to write
1115 to a particular stream. The default stream is to gdb_stdout. */
1118 gdbpy_write (PyObject
*self
, PyObject
*args
, PyObject
*kw
)
1121 static char *keywords
[] = {"text", "stream", NULL
};
1122 int stream_type
= 0;
1124 if (! PyArg_ParseTupleAndKeywords (args
, kw
, "s|i", keywords
, &arg
,
1130 switch (stream_type
)
1134 fprintf_filtered (gdb_stderr
, "%s", arg
);
1139 fprintf_filtered (gdb_stdlog
, "%s", arg
);
1143 fprintf_filtered (gdb_stdout
, "%s", arg
);
1146 CATCH (except
, RETURN_MASK_ALL
)
1148 GDB_PY_HANDLE_EXCEPTION (except
);
1155 /* A python function to flush a gdb stream. The optional keyword
1156 STREAM can be used to flush a particular stream. The default stream
1160 gdbpy_flush (PyObject
*self
, PyObject
*args
, PyObject
*kw
)
1162 static char *keywords
[] = {"stream", NULL
};
1163 int stream_type
= 0;
1165 if (! PyArg_ParseTupleAndKeywords (args
, kw
, "|i", keywords
,
1169 switch (stream_type
)
1173 gdb_flush (gdb_stderr
);
1178 gdb_flush (gdb_stdlog
);
1182 gdb_flush (gdb_stdout
);
1188 /* Return non-zero if print-stack is not "none". */
1191 gdbpy_print_python_errors_p (void)
1193 return gdbpy_should_print_stack
!= python_excp_none
;
1196 /* Print a python exception trace, print just a message, or print
1197 nothing and clear the python exception, depending on
1198 gdbpy_should_print_stack. Only call this if a python exception is
1201 gdbpy_print_stack (void)
1204 /* Print "none", just clear exception. */
1205 if (gdbpy_should_print_stack
== python_excp_none
)
1209 /* Print "full" message and backtrace. */
1210 else if (gdbpy_should_print_stack
== python_excp_full
)
1213 /* PyErr_Print doesn't necessarily end output with a newline.
1214 This works because Python's stdout/stderr is fed through
1220 CATCH (except
, RETURN_MASK_ALL
)
1225 /* Print "message", just error print message. */
1228 PyObject
*ptype
, *pvalue
, *ptraceback
;
1229 char *msg
= NULL
, *type
= NULL
;
1231 PyErr_Fetch (&ptype
, &pvalue
, &ptraceback
);
1233 /* Fetch the error message contained within ptype, pvalue. */
1234 msg
= gdbpy_exception_to_string (ptype
, pvalue
);
1235 type
= gdbpy_obj_to_string (ptype
);
1241 /* An error occurred computing the string representation of the
1243 fprintf_filtered (gdb_stderr
,
1244 _("Error occurred computing Python error" \
1248 fprintf_filtered (gdb_stderr
, "Python Exception %s %s: \n",
1251 CATCH (except
, RETURN_MASK_ALL
)
1257 Py_XDECREF (pvalue
);
1258 Py_XDECREF (ptraceback
);
1265 /* Return the current Progspace.
1266 There always is one. */
1269 gdbpy_get_current_progspace (PyObject
*unused1
, PyObject
*unused2
)
1273 result
= pspace_to_pspace_object (current_program_space
);
1279 /* Return a sequence holding all the Progspaces. */
1282 gdbpy_progspaces (PyObject
*unused1
, PyObject
*unused2
)
1284 struct program_space
*ps
;
1287 list
= PyList_New (0);
1293 PyObject
*item
= pspace_to_pspace_object (ps
);
1295 if (!item
|| PyList_Append (list
, item
) == -1)
1307 /* The "current" objfile. This is set when gdb detects that a new
1308 objfile has been loaded. It is only set for the duration of a call to
1309 gdbpy_source_objfile_script and gdbpy_execute_objfile_script; it is NULL
1311 static struct objfile
*gdbpy_current_objfile
;
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
1315 occurs python will print the traceback and clear the error indicator.
1316 This is the extension_language_script_ops.objfile_script_sourcer
1320 gdbpy_source_objfile_script (const struct extension_language_defn
*extlang
,
1321 struct objfile
*objfile
, FILE *file
,
1322 const char *filename
)
1324 struct cleanup
*cleanups
;
1326 if (!gdb_python_initialized
)
1329 cleanups
= ensure_python_env (get_objfile_arch (objfile
), current_language
);
1330 gdbpy_current_objfile
= objfile
;
1332 python_run_simple_file (file
, filename
);
1334 do_cleanups (cleanups
);
1335 gdbpy_current_objfile
= NULL
;
1338 /* Set the current objfile to OBJFILE and then execute SCRIPT
1339 as Python code. This does not throw any errors. If an exception
1340 occurs python will print the traceback and clear the error indicator.
1341 This is the extension_language_script_ops.objfile_script_executor
1345 gdbpy_execute_objfile_script (const struct extension_language_defn
*extlang
,
1346 struct objfile
*objfile
, const char *name
,
1349 struct cleanup
*cleanups
;
1351 if (!gdb_python_initialized
)
1354 cleanups
= ensure_python_env (get_objfile_arch (objfile
), current_language
);
1355 gdbpy_current_objfile
= objfile
;
1357 PyRun_SimpleString (script
);
1359 do_cleanups (cleanups
);
1360 gdbpy_current_objfile
= NULL
;
1363 /* Return the current Objfile, or None if there isn't one. */
1366 gdbpy_get_current_objfile (PyObject
*unused1
, PyObject
*unused2
)
1370 if (! gdbpy_current_objfile
)
1373 result
= objfile_to_objfile_object (gdbpy_current_objfile
);
1379 /* Return a sequence holding all the Objfiles. */
1382 gdbpy_objfiles (PyObject
*unused1
, PyObject
*unused2
)
1384 struct objfile
*objf
;
1387 list
= PyList_New (0);
1393 PyObject
*item
= objfile_to_objfile_object (objf
);
1395 if (!item
|| PyList_Append (list
, item
) == -1)
1405 /* Compute the list of active python type printers and store them in
1406 EXT_PRINTERS->py_type_printers. The product of this function is used by
1407 gdbpy_apply_type_printers, and freed by gdbpy_free_type_printers.
1408 This is the extension_language_ops.start_type_printers "method". */
1411 gdbpy_start_type_printers (const struct extension_language_defn
*extlang
,
1412 struct ext_lang_type_printers
*ext_printers
)
1414 struct cleanup
*cleanups
;
1415 PyObject
*type_module
, *func
= NULL
, *printers_obj
= NULL
;
1417 if (!gdb_python_initialized
)
1420 cleanups
= ensure_python_env (get_current_arch (), current_language
);
1422 type_module
= PyImport_ImportModule ("gdb.types");
1423 if (type_module
== NULL
)
1425 gdbpy_print_stack ();
1429 func
= PyObject_GetAttrString (type_module
, "get_type_recognizers");
1432 gdbpy_print_stack ();
1436 printers_obj
= PyObject_CallFunctionObjArgs (func
, (char *) NULL
);
1437 if (printers_obj
== NULL
)
1438 gdbpy_print_stack ();
1440 ext_printers
->py_type_printers
= printers_obj
;
1443 Py_XDECREF (type_module
);
1445 do_cleanups (cleanups
);
1448 /* If TYPE is recognized by some type printer, store in *PRETTIED_TYPE
1449 a newly allocated string holding the type's replacement name, and return
1450 EXT_LANG_RC_OK. The caller is responsible for freeing the string.
1451 If there's a Python error return EXT_LANG_RC_ERROR.
1452 Otherwise, return EXT_LANG_RC_NOP.
1453 This is the extension_language_ops.apply_type_printers "method". */
1455 static enum ext_lang_rc
1456 gdbpy_apply_type_printers (const struct extension_language_defn
*extlang
,
1457 const struct ext_lang_type_printers
*ext_printers
,
1458 struct type
*type
, char **prettied_type
)
1460 struct cleanup
*cleanups
;
1461 PyObject
*type_obj
, *type_module
= NULL
, *func
= NULL
;
1462 PyObject
*result_obj
= NULL
;
1463 PyObject
*printers_obj
= (PyObject
*) ext_printers
->py_type_printers
;
1464 char *result
= NULL
;
1466 if (printers_obj
== NULL
)
1467 return EXT_LANG_RC_NOP
;
1469 if (!gdb_python_initialized
)
1470 return EXT_LANG_RC_NOP
;
1472 cleanups
= ensure_python_env (get_current_arch (), current_language
);
1474 type_obj
= type_to_type_object (type
);
1475 if (type_obj
== NULL
)
1477 gdbpy_print_stack ();
1481 type_module
= PyImport_ImportModule ("gdb.types");
1482 if (type_module
== NULL
)
1484 gdbpy_print_stack ();
1488 func
= PyObject_GetAttrString (type_module
, "apply_type_recognizers");
1491 gdbpy_print_stack ();
1495 result_obj
= PyObject_CallFunctionObjArgs (func
, printers_obj
,
1496 type_obj
, (char *) NULL
);
1497 if (result_obj
== NULL
)
1499 gdbpy_print_stack ();
1503 if (result_obj
!= Py_None
)
1505 result
= python_string_to_host_string (result_obj
);
1507 gdbpy_print_stack ();
1511 Py_XDECREF (type_obj
);
1512 Py_XDECREF (type_module
);
1514 Py_XDECREF (result_obj
);
1515 do_cleanups (cleanups
);
1517 *prettied_type
= result
;
1518 return result
!= NULL
? EXT_LANG_RC_OK
: EXT_LANG_RC_ERROR
;
1521 /* Free the result of start_type_printers.
1522 This is the extension_language_ops.free_type_printers "method". */
1525 gdbpy_free_type_printers (const struct extension_language_defn
*extlang
,
1526 struct ext_lang_type_printers
*ext_printers
)
1528 struct cleanup
*cleanups
;
1529 PyObject
*printers
= (PyObject
*) ext_printers
->py_type_printers
;
1531 if (printers
== NULL
)
1534 if (!gdb_python_initialized
)
1537 cleanups
= ensure_python_env (get_current_arch (), current_language
);
1538 Py_DECREF (printers
);
1539 do_cleanups (cleanups
);
1542 #else /* HAVE_PYTHON */
1544 /* Dummy implementation of the gdb "python-interactive" and "python"
1548 python_interactive_command (char *arg
, int from_tty
)
1550 arg
= skip_spaces (arg
);
1552 error (_("Python scripting is not supported in this copy of GDB."));
1555 struct command_line
*l
= get_command_line (python_control
, "");
1556 struct cleanup
*cleanups
= make_cleanup_free_command_lines (&l
);
1558 execute_control_command_untraced (l
);
1559 do_cleanups (cleanups
);
1564 python_command (char *arg
, int from_tty
)
1566 python_interactive_command (arg
, from_tty
);
1569 #endif /* HAVE_PYTHON */
1573 /* Lists for 'set python' commands. */
1575 static struct cmd_list_element
*user_set_python_list
;
1576 static struct cmd_list_element
*user_show_python_list
;
1578 /* Function for use by 'set python' prefix command. */
1581 user_set_python (char *args
, int from_tty
)
1583 help_list (user_set_python_list
, "set python ", all_commands
,
1587 /* Function for use by 'show python' prefix command. */
1590 user_show_python (char *args
, int from_tty
)
1592 cmd_show_list (user_show_python_list
, from_tty
, "");
1595 /* Initialize the Python code. */
1599 /* This is installed as a final cleanup and cleans up the
1600 interpreter. This lets Python's 'atexit' work. */
1603 finalize_python (void *ignore
)
1605 struct active_ext_lang_state
*previous_active
;
1607 /* We don't use ensure_python_env here because if we ever ran the
1608 cleanup, gdb would crash -- because the cleanup calls into the
1609 Python interpreter, which we are about to destroy. It seems
1610 clearer to make the needed calls explicitly here than to create a
1611 cleanup and then mysteriously discard it. */
1613 /* This is only called as a final cleanup so we can assume the active
1614 SIGINT handler is gdb's. We still need to tell it to notify Python. */
1615 previous_active
= set_active_ext_lang (&extension_language_python
);
1617 (void) PyGILState_Ensure ();
1618 python_gdbarch
= target_gdbarch ();
1619 python_language
= current_language
;
1623 restore_active_ext_lang (previous_active
);
1627 /* Provide a prototype to silence -Wmissing-prototypes. */
1628 extern initialize_file_ftype _initialize_python
;
1631 _initialize_python (void)
1636 size_t progsize
, count
;
1638 wchar_t *progname_copy
;
1641 add_com ("python-interactive", class_obscure
,
1642 python_interactive_command
,
1645 Start an interactive Python prompt.\n\
1647 To return to GDB, type the EOF character (e.g., Ctrl-D on an empty\n\
1650 Alternatively, a single-line Python command can be given as an\n\
1651 argument, and if the command is an expression, the result will be\n\
1652 printed. For example:\n\
1654 (gdb) python-interactive 2 + 3\n\
1657 #else /* HAVE_PYTHON */
1659 Start a Python interactive prompt.\n\
1661 Python scripting is not supported in this copy of GDB.\n\
1662 This command is only a placeholder.")
1663 #endif /* HAVE_PYTHON */
1665 add_com_alias ("pi", "python-interactive", class_obscure
, 1);
1667 add_com ("python", class_obscure
, python_command
,
1670 Evaluate a Python command.\n\
1672 The command can be given as an argument, for instance:\n\
1676 If no argument is given, the following lines are read and used\n\
1677 as the Python commands. Type a line containing \"end\" to indicate\n\
1678 the end of the command.")
1679 #else /* HAVE_PYTHON */
1681 Evaluate a Python command.\n\
1683 Python scripting is not supported in this copy of GDB.\n\
1684 This command is only a placeholder.")
1685 #endif /* HAVE_PYTHON */
1687 add_com_alias ("py", "python", class_obscure
, 1);
1689 /* Add set/show python print-stack. */
1690 add_prefix_cmd ("python", no_class
, user_show_python
,
1691 _("Prefix command for python preference settings."),
1692 &user_show_python_list
, "show python ", 0,
1695 add_prefix_cmd ("python", no_class
, user_set_python
,
1696 _("Prefix command for python preference settings."),
1697 &user_set_python_list
, "set python ", 0,
1700 add_setshow_enum_cmd ("print-stack", no_class
, python_excp_enums
,
1701 &gdbpy_should_print_stack
, _("\
1702 Set mode for Python stack dump on error."), _("\
1703 Show the mode of Python stack printing on error."), _("\
1704 none == no stack or message will be printed.\n\
1705 full == a message and a stack will be printed.\n\
1706 message == an error message without a stack will be printed."),
1708 &user_set_python_list
,
1709 &user_show_python_list
);
1712 #ifdef WITH_PYTHON_PATH
1713 /* Work around problem where python gets confused about where it is,
1714 and then can't find its libraries, etc.
1715 NOTE: Python assumes the following layout:
1717 /foo/lib/pythonX.Y/...
1718 This must be done before calling Py_Initialize. */
1719 progname
= concat (ldirname (python_libdir
), SLASH_STRING
, "bin",
1720 SLASH_STRING
, "python", (char *) NULL
);
1722 oldloc
= xstrdup (setlocale (LC_ALL
, NULL
));
1723 setlocale (LC_ALL
, "");
1724 progsize
= strlen (progname
);
1725 progname_copy
= (wchar_t *) PyMem_Malloc ((progsize
+ 1) * sizeof (wchar_t));
1729 fprintf (stderr
, "out of memory\n");
1732 count
= mbstowcs (progname_copy
, progname
, progsize
+ 1);
1733 if (count
== (size_t) -1)
1736 fprintf (stderr
, "Could not convert python path to string\n");
1739 setlocale (LC_ALL
, oldloc
);
1742 /* Note that Py_SetProgramName expects the string it is passed to
1743 remain alive for the duration of the program's execution, so
1744 it is not freed after this call. */
1745 Py_SetProgramName (progname_copy
);
1747 Py_SetProgramName (progname
);
1752 PyEval_InitThreads ();
1755 gdb_module
= PyModule_Create (&python_GdbModuleDef
);
1756 /* Add _gdb module to the list of known built-in modules. */
1757 _PyImport_FixupBuiltin (gdb_module
, "_gdb");
1759 gdb_module
= Py_InitModule ("_gdb", python_GdbMethods
);
1761 if (gdb_module
== NULL
)
1764 /* The casts to (char*) are for python 2.4. */
1765 if (PyModule_AddStringConstant (gdb_module
, "VERSION", (char*) version
) < 0
1766 || PyModule_AddStringConstant (gdb_module
, "HOST_CONFIG",
1767 (char*) host_name
) < 0
1768 || PyModule_AddStringConstant (gdb_module
, "TARGET_CONFIG",
1769 (char*) target_name
) < 0)
1772 /* Add stream constants. */
1773 if (PyModule_AddIntConstant (gdb_module
, "STDOUT", 0) < 0
1774 || PyModule_AddIntConstant (gdb_module
, "STDERR", 1) < 0
1775 || PyModule_AddIntConstant (gdb_module
, "STDLOG", 2) < 0)
1778 gdbpy_gdb_error
= PyErr_NewException ("gdb.error", PyExc_RuntimeError
, NULL
);
1779 if (gdbpy_gdb_error
== NULL
1780 || gdb_pymodule_addobject (gdb_module
, "error", gdbpy_gdb_error
) < 0)
1783 gdbpy_gdb_memory_error
= PyErr_NewException ("gdb.MemoryError",
1784 gdbpy_gdb_error
, NULL
);
1785 if (gdbpy_gdb_memory_error
== NULL
1786 || gdb_pymodule_addobject (gdb_module
, "MemoryError",
1787 gdbpy_gdb_memory_error
) < 0)
1790 gdbpy_gdberror_exc
= PyErr_NewException ("gdb.GdbError", NULL
, NULL
);
1791 if (gdbpy_gdberror_exc
== NULL
1792 || gdb_pymodule_addobject (gdb_module
, "GdbError",
1793 gdbpy_gdberror_exc
) < 0)
1796 gdbpy_initialize_gdb_readline ();
1798 if (gdbpy_initialize_auto_load () < 0
1799 || gdbpy_initialize_values () < 0
1800 || gdbpy_initialize_frames () < 0
1801 || gdbpy_initialize_commands () < 0
1802 || gdbpy_initialize_symbols () < 0
1803 || gdbpy_initialize_symtabs () < 0
1804 || gdbpy_initialize_blocks () < 0
1805 || gdbpy_initialize_functions () < 0
1806 || gdbpy_initialize_parameters () < 0
1807 || gdbpy_initialize_types () < 0
1808 || gdbpy_initialize_pspace () < 0
1809 || gdbpy_initialize_objfile () < 0
1810 || gdbpy_initialize_breakpoints () < 0
1811 || gdbpy_initialize_finishbreakpoints () < 0
1812 || gdbpy_initialize_lazy_string () < 0
1813 || gdbpy_initialize_linetable () < 0
1814 || gdbpy_initialize_thread () < 0
1815 || gdbpy_initialize_inferior () < 0
1816 || gdbpy_initialize_events () < 0
1817 || gdbpy_initialize_eventregistry () < 0
1818 || gdbpy_initialize_py_events () < 0
1819 || gdbpy_initialize_event () < 0
1820 || gdbpy_initialize_stop_event () < 0
1821 || gdbpy_initialize_signal_event () < 0
1822 || gdbpy_initialize_breakpoint_event () < 0
1823 || gdbpy_initialize_continue_event () < 0
1824 || gdbpy_initialize_inferior_call_pre_event () < 0
1825 || gdbpy_initialize_inferior_call_post_event () < 0
1826 || gdbpy_initialize_register_changed_event () < 0
1827 || gdbpy_initialize_memory_changed_event () < 0
1828 || gdbpy_initialize_exited_event () < 0
1829 || gdbpy_initialize_thread_event () < 0
1830 || gdbpy_initialize_new_objfile_event () < 0
1831 || gdbpy_initialize_clear_objfiles_event () < 0
1832 || gdbpy_initialize_arch () < 0
1833 || gdbpy_initialize_xmethods () < 0
1834 || gdbpy_initialize_unwind () < 0)
1837 gdbpy_to_string_cst
= PyString_FromString ("to_string");
1838 if (gdbpy_to_string_cst
== NULL
)
1840 gdbpy_children_cst
= PyString_FromString ("children");
1841 if (gdbpy_children_cst
== NULL
)
1843 gdbpy_display_hint_cst
= PyString_FromString ("display_hint");
1844 if (gdbpy_display_hint_cst
== NULL
)
1846 gdbpy_doc_cst
= PyString_FromString ("__doc__");
1847 if (gdbpy_doc_cst
== NULL
)
1849 gdbpy_enabled_cst
= PyString_FromString ("enabled");
1850 if (gdbpy_enabled_cst
== NULL
)
1852 gdbpy_value_cst
= PyString_FromString ("value");
1853 if (gdbpy_value_cst
== NULL
)
1856 /* Release the GIL while gdb runs. */
1857 PyThreadState_Swap (NULL
);
1858 PyEval_ReleaseLock ();
1860 make_final_cleanup (finalize_python
, NULL
);
1862 gdb_python_initialized
= 1;
1866 gdbpy_print_stack ();
1867 /* Do not set 'gdb_python_initialized'. */
1870 #endif /* HAVE_PYTHON */
1875 /* Perform the remaining python initializations.
1876 These must be done after GDB is at least mostly initialized.
1877 E.g., The "info pretty-printer" command needs the "info" prefix
1879 This is the extension_language_ops.finish_initialization "method". */
1882 gdbpy_finish_initialization (const struct extension_language_defn
*extlang
)
1885 char *gdb_pythondir
;
1887 struct cleanup
*cleanup
;
1889 cleanup
= ensure_python_env (get_current_arch (), current_language
);
1891 /* Add the initial data-directory to sys.path. */
1893 gdb_pythondir
= concat (gdb_datadir
, SLASH_STRING
, "python", (char *) NULL
);
1894 make_cleanup (xfree
, gdb_pythondir
);
1896 sys_path
= PySys_GetObject ("path");
1898 /* If sys.path is not defined yet, define it first. */
1899 if (!(sys_path
&& PyList_Check (sys_path
)))
1902 PySys_SetPath (L
"");
1906 sys_path
= PySys_GetObject ("path");
1908 if (sys_path
&& PyList_Check (sys_path
))
1910 PyObject
*pythondir
;
1913 pythondir
= PyString_FromString (gdb_pythondir
);
1914 if (pythondir
== NULL
)
1917 err
= PyList_Insert (sys_path
, 0, pythondir
);
1918 Py_DECREF (pythondir
);
1925 /* Import the gdb module to finish the initialization, and
1926 add it to __main__ for convenience. */
1927 m
= PyImport_AddModule ("__main__");
1931 gdb_python_module
= PyImport_ImportModule ("gdb");
1932 if (gdb_python_module
== NULL
)
1934 gdbpy_print_stack ();
1935 /* This is passed in one call to warning so that blank lines aren't
1936 inserted between each line of text. */
1938 "Could not load the Python gdb module from `%s'.\n"
1939 "Limited Python support is available from the _gdb module.\n"
1940 "Suggest passing --data-directory=/path/to/gdb/data-directory.\n"),
1942 do_cleanups (cleanup
);
1946 if (gdb_pymodule_addobject (m
, "gdb", gdb_python_module
) < 0)
1949 /* Keep the reference to gdb_python_module since it is in a global
1952 do_cleanups (cleanup
);
1956 gdbpy_print_stack ();
1957 warning (_("internal error: Unhandled Python exception"));
1958 do_cleanups (cleanup
);
1961 /* Return non-zero if Python has successfully initialized.
1962 This is the extension_languages_ops.initialized "method". */
1965 gdbpy_initialized (const struct extension_language_defn
*extlang
)
1967 return gdb_python_initialized
;
1970 #endif /* HAVE_PYTHON */
1976 PyMethodDef python_GdbMethods
[] =
1978 { "history", gdbpy_history
, METH_VARARGS
,
1979 "Get a value from history" },
1980 { "execute", (PyCFunction
) execute_gdb_command
, METH_VARARGS
| METH_KEYWORDS
,
1981 "execute (command [, from_tty] [, to_string]) -> [String]\n\
1982 Evaluate command, a string, as a gdb CLI command. Optionally returns\n\
1983 a Python String containing the output of the command if to_string is\n\
1985 { "parameter", gdbpy_parameter
, METH_VARARGS
,
1986 "Return a gdb parameter's value" },
1988 { "breakpoints", gdbpy_breakpoints
, METH_NOARGS
,
1989 "Return a tuple of all breakpoint objects" },
1991 { "default_visualizer", gdbpy_default_visualizer
, METH_VARARGS
,
1992 "Find the default visualizer for a Value." },
1994 { "current_progspace", gdbpy_get_current_progspace
, METH_NOARGS
,
1995 "Return the current Progspace." },
1996 { "progspaces", gdbpy_progspaces
, METH_NOARGS
,
1997 "Return a sequence of all progspaces." },
1999 { "current_objfile", gdbpy_get_current_objfile
, METH_NOARGS
,
2000 "Return the current Objfile being loaded, or None." },
2001 { "objfiles", gdbpy_objfiles
, METH_NOARGS
,
2002 "Return a sequence of all loaded objfiles." },
2004 { "newest_frame", gdbpy_newest_frame
, METH_NOARGS
,
2005 "newest_frame () -> gdb.Frame.\n\
2006 Return the newest frame object." },
2007 { "selected_frame", gdbpy_selected_frame
, METH_NOARGS
,
2008 "selected_frame () -> gdb.Frame.\n\
2009 Return the selected frame object." },
2010 { "frame_stop_reason_string", gdbpy_frame_stop_reason_string
, METH_VARARGS
,
2011 "stop_reason_string (Integer) -> String.\n\
2012 Return a string explaining unwind stop reason." },
2014 { "lookup_type", (PyCFunction
) gdbpy_lookup_type
,
2015 METH_VARARGS
| METH_KEYWORDS
,
2016 "lookup_type (name [, block]) -> type\n\
2017 Return a Type corresponding to the given name." },
2018 { "lookup_symbol", (PyCFunction
) gdbpy_lookup_symbol
,
2019 METH_VARARGS
| METH_KEYWORDS
,
2020 "lookup_symbol (name [, block] [, domain]) -> (symbol, is_field_of_this)\n\
2021 Return a tuple with the symbol corresponding to the given name (or None) and\n\
2022 a boolean indicating if name is a field of the current implied argument\n\
2023 `this' (when the current language is object-oriented)." },
2024 { "lookup_global_symbol", (PyCFunction
) gdbpy_lookup_global_symbol
,
2025 METH_VARARGS
| METH_KEYWORDS
,
2026 "lookup_global_symbol (name [, domain]) -> symbol\n\
2027 Return the symbol corresponding to the given name (or None)." },
2029 { "lookup_objfile", (PyCFunction
) gdbpy_lookup_objfile
,
2030 METH_VARARGS
| METH_KEYWORDS
,
2031 "lookup_objfile (name, [by_build_id]) -> objfile\n\
2032 Look up the specified objfile.\n\
2033 If by_build_id is True, the objfile is looked up by using name\n\
2034 as its build id." },
2036 { "block_for_pc", gdbpy_block_for_pc
, METH_VARARGS
,
2037 "Return the block containing the given pc value, or None." },
2038 { "solib_name", gdbpy_solib_name
, METH_VARARGS
,
2039 "solib_name (Long) -> String.\n\
2040 Return the name of the shared library holding a given address, or None." },
2041 { "decode_line", gdbpy_decode_line
, METH_VARARGS
,
2042 "decode_line (String) -> Tuple. Decode a string argument the way\n\
2043 that 'break' or 'edit' does. Return a tuple containing two elements.\n\
2044 The first element contains any unparsed portion of the String parameter\n\
2045 (or None if the string was fully parsed). The second element contains\n\
2046 a tuple that contains all the locations that match, represented as\n\
2047 gdb.Symtab_and_line objects (or None)."},
2048 { "parse_and_eval", gdbpy_parse_and_eval
, METH_VARARGS
,
2049 "parse_and_eval (String) -> Value.\n\
2050 Parse String as an expression, evaluate it, and return the result as a Value."
2052 { "find_pc_line", gdbpy_find_pc_line
, METH_VARARGS
,
2053 "find_pc_line (pc) -> Symtab_and_line.\n\
2054 Return the gdb.Symtab_and_line object corresponding to the pc value." },
2056 { "post_event", gdbpy_post_event
, METH_VARARGS
,
2057 "Post an event into gdb's event loop." },
2059 { "target_charset", gdbpy_target_charset
, METH_NOARGS
,
2060 "target_charset () -> string.\n\
2061 Return the name of the current target charset." },
2062 { "target_wide_charset", gdbpy_target_wide_charset
, METH_NOARGS
,
2063 "target_wide_charset () -> string.\n\
2064 Return the name of the current target wide charset." },
2066 { "string_to_argv", gdbpy_string_to_argv
, METH_VARARGS
,
2067 "string_to_argv (String) -> Array.\n\
2068 Parse String and return an argv-like array.\n\
2069 Arguments are separate by spaces and may be quoted."
2071 { "write", (PyCFunction
)gdbpy_write
, METH_VARARGS
| METH_KEYWORDS
,
2072 "Write a string using gdb's filtered stream." },
2073 { "flush", (PyCFunction
)gdbpy_flush
, METH_VARARGS
| METH_KEYWORDS
,
2074 "Flush gdb's filtered stdout stream." },
2075 { "selected_thread", gdbpy_selected_thread
, METH_NOARGS
,
2076 "selected_thread () -> gdb.InferiorThread.\n\
2077 Return the selected thread object." },
2078 { "selected_inferior", gdbpy_selected_inferior
, METH_NOARGS
,
2079 "selected_inferior () -> gdb.Inferior.\n\
2080 Return the selected inferior object." },
2081 { "inferiors", gdbpy_inferiors
, METH_NOARGS
,
2082 "inferiors () -> (gdb.Inferior, ...).\n\
2083 Return a tuple containing all inferiors." },
2085 { "invalidate_cached_frames", gdbpy_invalidate_cached_frames
, METH_NOARGS
,
2086 "invalidate_cached_frames () -> None.\n\
2087 Invalidate any cached frame objects in gdb.\n\
2088 Intended for internal use only." },
2090 {NULL
, NULL
, 0, NULL
}
2094 struct PyModuleDef python_GdbModuleDef
=
2096 PyModuleDef_HEAD_INIT
,
2107 #endif /* HAVE_PYTHON */