1 /* General python/gdb code
3 Copyright (C) 2008-2018 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 #include "py-event.h"
105 /* True if Python has been successfully initialized, false
108 int gdb_python_initialized;
110 extern PyMethodDef python_GdbMethods[];
113 extern struct PyModuleDef python_GdbModuleDef;
116 PyObject *gdb_module;
117 PyObject *gdb_python_module;
119 /* Some string constants we may wish to use. */
120 PyObject *gdbpy_to_string_cst;
121 PyObject *gdbpy_children_cst;
122 PyObject *gdbpy_display_hint_cst;
123 PyObject *gdbpy_doc_cst;
124 PyObject *gdbpy_enabled_cst;
125 PyObject *gdbpy_value_cst;
127 /* The GdbError exception. */
128 PyObject *gdbpy_gdberror_exc;
130 /* The `gdb.error' base class. */
131 PyObject *gdbpy_gdb_error;
133 /* The `gdb.MemoryError' exception. */
134 PyObject *gdbpy_gdb_memory_error;
136 static script_sourcer_func gdbpy_source_script;
137 static objfile_script_sourcer_func gdbpy_source_objfile_script;
138 static objfile_script_executor_func gdbpy_execute_objfile_script;
139 static void gdbpy_finish_initialization
140 (const struct extension_language_defn *);
141 static int gdbpy_initialized (const struct extension_language_defn *);
142 static void gdbpy_eval_from_control_command
143 (const struct extension_language_defn *, struct command_line *cmd);
144 static void gdbpy_start_type_printers (const struct extension_language_defn *,
145 struct ext_lang_type_printers *);
146 static enum ext_lang_rc gdbpy_apply_type_printers
147 (const struct extension_language_defn *,
148 const struct ext_lang_type_printers *, struct type *, char **);
149 static void gdbpy_free_type_printers (const struct extension_language_defn *,
150 struct ext_lang_type_printers *);
151 static void gdbpy_set_quit_flag (const struct extension_language_defn *);
152 static int gdbpy_check_quit_flag (const struct extension_language_defn *);
153 static enum ext_lang_rc gdbpy_before_prompt_hook
154 (const struct extension_language_defn *, const char *current_gdb_prompt);
156 /* The interface between gdb proper and loading of python scripts. */
158 const struct extension_language_script_ops python_extension_script_ops =
161 gdbpy_source_objfile_script,
162 gdbpy_execute_objfile_script,
163 gdbpy_auto_load_enabled
166 /* The interface between gdb proper and python extensions. */
168 const struct extension_language_ops python_extension_ops =
170 gdbpy_finish_initialization,
173 gdbpy_eval_from_control_command,
175 gdbpy_start_type_printers,
176 gdbpy_apply_type_printers,
177 gdbpy_free_type_printers,
179 gdbpy_apply_val_pretty_printer,
181 gdbpy_apply_frame_filter,
183 gdbpy_preserve_values,
185 gdbpy_breakpoint_has_cond,
186 gdbpy_breakpoint_cond_says_stop,
189 gdbpy_check_quit_flag,
191 gdbpy_before_prompt_hook,
193 gdbpy_get_matching_xmethod_workers,
196 /* Architecture and language to be used in callbacks from
197 the Python interpreter. */
198 struct gdbarch *python_gdbarch;
199 const struct language_defn *python_language;
201 gdbpy_enter::gdbpy_enter (struct gdbarch *gdbarch,
202 const struct language_defn *language)
203 : m_gdbarch (python_gdbarch),
204 m_language (python_language)
206 /* We should not ever enter Python unless initialized. */
207 if (!gdb_python_initialized)
208 error (_("Python not initialized"));
210 m_previous_active = set_active_ext_lang (&extension_language_python);
212 m_state = PyGILState_Ensure ();
214 python_gdbarch = gdbarch;
215 python_language = language;
217 /* Save it and ensure ! PyErr_Occurred () afterwards. */
218 PyErr_Fetch (&m_error_type, &m_error_value, &m_error_traceback);
221 gdbpy_enter::~gdbpy_enter ()
223 /* Leftover Python error is forbidden by Python Exception Handling. */
224 if (PyErr_Occurred ())
226 /* This order is similar to the one calling error afterwards. */
227 gdbpy_print_stack ();
228 warning (_("internal error: Unhandled Python exception"));
231 PyErr_Restore (m_error_type, m_error_value, m_error_traceback);
233 PyGILState_Release (m_state);
234 python_gdbarch = m_gdbarch;
235 python_language = m_language;
237 restore_active_ext_lang (m_previous_active);
240 /* Set the quit flag. */
243 gdbpy_set_quit_flag (const struct extension_language_defn *extlang)
245 PyErr_SetInterrupt ();
248 /* Return true if the quit flag has been set, false otherwise. */
251 gdbpy_check_quit_flag (const struct extension_language_defn *extlang)
253 return PyOS_InterruptOccurred ();
256 /* Evaluate a Python command like PyRun_SimpleString, but uses
257 Py_single_input which prints the result of expressions, and does
258 not automatically print the stack on errors. */
261 eval_python_command (const char *command)
265 m = PyImport_AddModule ("__main__");
269 d = PyModule_GetDict (m);
272 gdbpy_ref<> v (PyRun_StringFlags (command, Py_single_input, d, d, NULL));
284 /* Implementation of the gdb "python-interactive" command. */
287 python_interactive_command (const char *arg, int from_tty)
289 struct ui *ui = current_ui;
292 scoped_restore save_async = make_scoped_restore (¤t_ui->async, 0);
294 arg = skip_spaces (arg);
296 gdbpy_enter enter_py (get_current_arch (), current_language);
300 int len = strlen (arg);
301 char *script = (char *) xmalloc (len + 2);
303 strcpy (script, arg);
305 script[len + 1] = '\0';
306 err = eval_python_command (script);
311 err = PyRun_InteractiveLoop (ui->instream, "<stdin>");
317 gdbpy_print_stack ();
318 error (_("Error while executing Python code."));
322 /* A wrapper around PyRun_SimpleFile. FILE is the Python script to run
325 On Windows hosts few users would build Python themselves (this is no
326 trivial task on this platform), and thus use binaries built by
327 someone else instead. There may happen situation where the Python
328 library and GDB are using two different versions of the C runtime
329 library. Python, being built with VC, would use one version of the
330 msvcr DLL (Eg. msvcr100.dll), while MinGW uses msvcrt.dll.
331 A FILE * from one runtime does not necessarily operate correctly in
334 To work around this potential issue, we create on Windows hosts the
335 FILE object using Python routines, thus making sure that it is
336 compatible with the Python library. */
339 python_run_simple_file (FILE *file, const char *filename)
343 PyRun_SimpleFile (file, filename);
347 /* Because we have a string for a filename, and are using Python to
348 open the file, we need to expand any tilde in the path first. */
349 gdb::unique_xmalloc_ptr<char> full_path (tilde_expand (filename));
350 gdbpy_ref<> python_file (PyFile_FromString (full_path.get (), (char *) "r"));
351 if (python_file == NULL)
353 gdbpy_print_stack ();
354 error (_("Error while opening file: %s"), full_path.get ());
357 PyRun_SimpleFile (PyFile_AsFile (python_file.get ()), filename);
362 /* Given a command_line, return a command string suitable for passing
363 to Python. Lines in the string are separated by newlines. */
366 compute_python_string (struct command_line *l)
368 struct command_line *iter;
371 for (iter = l; iter; iter = iter->next)
373 script += iter->line;
379 /* Take a command line structure representing a 'python' command, and
380 evaluate its body using the Python interpreter. */
383 gdbpy_eval_from_control_command (const struct extension_language_defn *extlang,
384 struct command_line *cmd)
388 if (cmd->body_list_1 != nullptr)
389 error (_("Invalid \"python\" block structure."));
391 gdbpy_enter enter_py (get_current_arch (), current_language);
393 std::string script = compute_python_string (cmd->body_list_0.get ());
394 ret = PyRun_SimpleString (script.c_str ());
396 error (_("Error while executing Python code."));
399 /* Implementation of the gdb "python" command. */
402 python_command (const char *arg, int from_tty)
404 gdbpy_enter enter_py (get_current_arch (), current_language);
406 scoped_restore save_async = make_scoped_restore (¤t_ui->async, 0);
408 arg = skip_spaces (arg);
411 if (PyRun_SimpleString (arg))
412 error (_("Error while executing Python code."));
416 counted_command_line l = get_command_line (python_control, "");
418 execute_control_command_untraced (l.get ());
424 /* Transform a gdb parameters's value into a Python value. May return
425 NULL (and set a Python exception) on error. Helper function for
428 gdbpy_parameter_value (enum var_types type, void *var)
433 case var_string_noescape:
434 case var_optional_filename:
438 const char *str = *(char **) var;
442 return host_string_to_python_string (str);
453 case var_auto_boolean:
455 enum auto_boolean ab = * (enum auto_boolean *) var;
457 if (ab == AUTO_BOOLEAN_TRUE)
459 else if (ab == AUTO_BOOLEAN_FALSE)
466 if ((* (int *) var) == INT_MAX)
470 case var_zuinteger_unlimited:
471 return PyLong_FromLong (* (int *) var);
475 unsigned int val = * (unsigned int *) var;
479 return PyLong_FromUnsignedLong (val);
484 unsigned int val = * (unsigned int *) var;
485 return PyLong_FromUnsignedLong (val);
489 return PyErr_Format (PyExc_RuntimeError,
490 _("Programmer error: unhandled type."));
493 /* A Python function which returns a gdb parameter's value as a Python
497 gdbpy_parameter (PyObject *self, PyObject *args)
499 struct gdb_exception except = exception_none;
500 struct cmd_list_element *alias, *prefix, *cmd;
505 if (! PyArg_ParseTuple (args, "s", &arg))
508 newarg = concat ("show ", arg, (char *) NULL);
512 found = lookup_cmd_composition (newarg, &alias, &prefix, &cmd);
514 CATCH (ex, RETURN_MASK_ALL)
521 GDB_PY_HANDLE_EXCEPTION (except);
523 return PyErr_Format (PyExc_RuntimeError,
524 _("Could not find parameter `%s'."), arg);
527 return PyErr_Format (PyExc_RuntimeError,
528 _("`%s' is not a parameter."), arg);
529 return gdbpy_parameter_value (cmd->var_type, cmd->var);
532 /* Wrapper for target_charset. */
535 gdbpy_target_charset (PyObject *self, PyObject *args)
537 const char *cset = target_charset (python_gdbarch);
539 return PyUnicode_Decode (cset, strlen (cset), host_charset (), NULL);
542 /* Wrapper for target_wide_charset. */
545 gdbpy_target_wide_charset (PyObject *self, PyObject *args)
547 const char *cset = target_wide_charset (python_gdbarch);
549 return PyUnicode_Decode (cset, strlen (cset), host_charset (), NULL);
552 /* A Python function which evaluates a string using the gdb CLI. */
555 execute_gdb_command (PyObject *self, PyObject *args, PyObject *kw)
558 PyObject *from_tty_obj = NULL, *to_string_obj = NULL;
559 int from_tty, to_string;
560 static const char *keywords[] = { "command", "from_tty", "to_string", NULL };
562 if (!gdb_PyArg_ParseTupleAndKeywords (args, kw, "s|O!O!", keywords, &arg,
563 &PyBool_Type, &from_tty_obj,
564 &PyBool_Type, &to_string_obj))
570 int cmp = PyObject_IsTrue (from_tty_obj);
579 int cmp = PyObject_IsTrue (to_string_obj);
585 std::string to_string_res;
589 struct interp *interp;
591 std::string arg_copy = arg;
593 char *save_ptr = nullptr;
597 const char *result = strtok_r (first ? &arg_copy[0] : nullptr,
603 counted_command_line lines = read_command_lines_1 (reader, 1, nullptr);
605 scoped_restore save_async = make_scoped_restore (¤t_ui->async, 0);
607 scoped_restore save_uiout = make_scoped_restore (¤t_uiout);
609 /* Use the console interpreter uiout to have the same print format
610 for console or MI. */
611 interp = interp_lookup (current_ui, "console");
612 current_uiout = interp->interp_ui_out ();
614 scoped_restore preventer = prevent_dont_repeat ();
616 to_string_res = execute_control_commands_to_string (lines.get (),
619 execute_control_commands (lines.get (), from_tty);
621 CATCH (except, RETURN_MASK_ALL)
623 GDB_PY_HANDLE_EXCEPTION (except);
627 /* Do any commands attached to breakpoint we stopped at. */
628 bpstat_do_actions ();
631 return PyString_FromString (to_string_res.c_str ());
635 /* Implementation of gdb.solib_name (Long) -> String.
636 Returns the name of the shared library holding a given address, or None. */
639 gdbpy_solib_name (PyObject *self, PyObject *args)
645 if (!PyArg_ParseTuple (args, GDB_PY_LLU_ARG, &pc))
648 soname = solib_name_from_address (current_program_space, pc);
650 str_obj = host_string_to_python_string (soname);
660 /* Implementation of Python rbreak command. Take a REGEX and
661 optionally a MINSYMS, THROTTLE and SYMTABS keyword and return a
662 Python list that contains newly set breakpoints that match that
663 criteria. REGEX refers to a GDB format standard regex pattern of
664 symbols names to search; MINSYMS is an optional boolean (default
665 False) that indicates if the function should search GDB's minimal
666 symbols; THROTTLE is an optional integer (default unlimited) that
667 indicates the maximum amount of breakpoints allowable before the
668 function exits (note, if the throttle bound is passed, no
669 breakpoints will be set and a runtime error returned); SYMTABS is
670 an optional Python iterable that contains a set of gdb.Symtabs to
671 constrain the search within. */
674 gdbpy_rbreak (PyObject *self, PyObject *args, PyObject *kw)
676 /* A simple type to ensure clean up of a vector of allocated strings
677 when a C interface demands a const char *array[] type
679 struct symtab_list_type
683 for (const char *elem: vec)
684 xfree ((void *) elem);
686 std::vector<const char *> vec;
690 std::vector<symbol_search> symbols;
691 unsigned long count = 0;
692 PyObject *symtab_list = NULL;
693 PyObject *minsyms_p_obj = NULL;
695 unsigned int throttle = 0;
696 static const char *keywords[] = {"regex","minsyms", "throttle",
698 symtab_list_type symtab_paths;
700 if (!gdb_PyArg_ParseTupleAndKeywords (args, kw, "s|O!IO", keywords,
701 ®ex, &PyBool_Type,
702 &minsyms_p_obj, &throttle,
706 /* Parse minsyms keyword. */
707 if (minsyms_p_obj != NULL)
709 int cmp = PyObject_IsTrue (minsyms_p_obj);
715 /* The "symtabs" keyword is any Python iterable object that returns
716 a gdb.Symtab on each iteration. If specified, iterate through
717 the provided gdb.Symtabs and extract their full path. As
718 python_string_to_target_string returns a
719 gdb::unique_xmalloc_ptr<char> and a vector containing these types
720 cannot be coerced to a const char **p[] via the vector.data call,
721 release the value from the unique_xmalloc_ptr and place it in a
722 simple type symtab_list_type (which holds the vector and a
723 destructor that frees the contents of the allocated strings. */
724 if (symtab_list != NULL)
726 gdbpy_ref<> iter (PyObject_GetIter (symtab_list));
733 gdbpy_ref<> next (PyIter_Next (iter.get ()));
737 if (PyErr_Occurred ())
742 gdbpy_ref<> obj_name (PyObject_GetAttrString (next.get (),
745 if (obj_name == NULL)
748 /* Is the object file still valid? */
749 if (obj_name == Py_None)
752 gdb::unique_xmalloc_ptr<char> filename =
753 python_string_to_target_string (obj_name.get ());
755 if (filename == NULL)
758 /* Make sure there is a definite place to store the value of
759 filename before it is released. */
760 symtab_paths.vec.push_back (nullptr);
761 symtab_paths.vec.back () = filename.release ();
767 const char **files = symtab_paths.vec.data ();
769 symbols = search_symbols (regex, FUNCTIONS_DOMAIN,
770 symtab_paths.vec.size (), files);
773 symbols = search_symbols (regex, FUNCTIONS_DOMAIN, 0, NULL);
775 /* Count the number of symbols (both symbols and optionally minimal
776 symbols) so we can correctly check the throttle limit. */
777 for (const symbol_search &p : symbols)
779 /* Minimal symbols included? */
782 if (p.msymbol.minsym != NULL)
786 if (p.symbol != NULL)
790 /* Check throttle bounds and exit if in excess. */
791 if (throttle != 0 && count > throttle)
793 PyErr_SetString (PyExc_RuntimeError,
794 _("Number of breakpoints exceeds throttled maximum."));
798 gdbpy_ref<> return_list (PyList_New (0));
800 if (return_list == NULL)
803 /* Construct full path names for symbols and call the Python
804 breakpoint constructor on the resulting names. Be tolerant of
805 individual breakpoint failures. */
806 for (const symbol_search &p : symbols)
808 std::string symbol_name;
810 /* Skipping minimal symbols? */
812 if (p.msymbol.minsym != NULL)
815 if (p.msymbol.minsym == NULL)
817 struct symtab *symtab = symbol_symtab (p.symbol);
818 const char *fullname = symtab_to_fullname (symtab);
820 symbol_name = fullname;
822 symbol_name += SYMBOL_LINKAGE_NAME (p.symbol);
825 symbol_name = MSYMBOL_LINKAGE_NAME (p.msymbol.minsym);
827 gdbpy_ref<> argList (Py_BuildValue("(s)", symbol_name.c_str ()));
828 gdbpy_ref<> obj (PyObject_CallObject ((PyObject *)
829 &breakpoint_object_type,
832 /* Tolerate individual breakpoint failures. */
834 gdbpy_print_stack ();
837 if (PyList_Append (return_list.get (), obj.get ()) == -1)
841 return return_list.release ();
844 /* A Python function which is a wrapper for decode_line_1. */
847 gdbpy_decode_line (PyObject *self, PyObject *args)
849 const char *arg = NULL;
851 gdbpy_ref<> unparsed;
852 event_location_up location;
854 if (! PyArg_ParseTuple (args, "|s", &arg))
858 location = string_to_event_location_basic (&arg, python_language,
859 symbol_name_match_type::WILD);
861 std::vector<symtab_and_line> decoded_sals;
862 symtab_and_line def_sal;
863 gdb::array_view<symtab_and_line> sals;
866 if (location != NULL)
868 decoded_sals = decode_line_1 (location.get (), 0, NULL, NULL, 0);
873 set_default_source_symtab_and_line ();
874 def_sal = get_current_source_symtab_and_line ();
878 CATCH (ex, RETURN_MASK_ALL)
880 /* We know this will always throw. */
881 gdbpy_convert_exception (ex);
888 result.reset (PyTuple_New (sals.size ()));
891 for (size_t i = 0; i < sals.size (); ++i)
893 PyObject *obj = symtab_and_line_to_sal_object (sals[i]);
897 PyTuple_SetItem (result.get (), i, obj);
901 result = gdbpy_ref<>::new_reference (Py_None);
903 gdbpy_ref<> return_result (PyTuple_New (2));
904 if (return_result == NULL)
907 if (arg != NULL && strlen (arg) > 0)
909 unparsed.reset (PyString_FromString (arg));
910 if (unparsed == NULL)
914 unparsed = gdbpy_ref<>::new_reference (Py_None);
916 PyTuple_SetItem (return_result.get (), 0, unparsed.release ());
917 PyTuple_SetItem (return_result.get (), 1, result.release ());
919 return return_result.release ();
922 /* Parse a string and evaluate it as an expression. */
924 gdbpy_parse_and_eval (PyObject *self, PyObject *args)
926 const char *expr_str;
927 struct value *result = NULL;
929 if (!PyArg_ParseTuple (args, "s", &expr_str))
934 result = parse_and_eval (expr_str);
936 CATCH (except, RETURN_MASK_ALL)
938 GDB_PY_HANDLE_EXCEPTION (except);
942 return value_to_value_object (result);
945 /* Implementation of gdb.find_pc_line function.
946 Returns the gdb.Symtab_and_line object corresponding to a PC value. */
949 gdbpy_find_pc_line (PyObject *self, PyObject *args)
951 gdb_py_ulongest pc_llu;
952 PyObject *result = NULL; /* init for gcc -Wall */
954 if (!PyArg_ParseTuple (args, GDB_PY_LLU_ARG, &pc_llu))
959 struct symtab_and_line sal;
962 pc = (CORE_ADDR) pc_llu;
963 sal = find_pc_line (pc, 0);
964 result = symtab_and_line_to_sal_object (sal);
966 CATCH (except, RETURN_MASK_ALL)
968 GDB_PY_HANDLE_EXCEPTION (except);
975 /* Implementation of gdb.invalidate_cached_frames. */
978 gdbpy_invalidate_cached_frames (PyObject *self, PyObject *args)
980 reinit_frame_cache ();
984 /* Read a file as Python code.
985 This is the extension_language_script_ops.script_sourcer "method".
986 FILE is the file to load. FILENAME is name of the file FILE.
987 This does not throw any errors. If an exception occurs python will print
988 the traceback and clear the error indicator. */
991 gdbpy_source_script (const struct extension_language_defn *extlang,
992 FILE *file, const char *filename)
994 gdbpy_enter enter_py (get_current_arch (), current_language);
995 python_run_simple_file (file, filename);
1000 /* Posting and handling events. */
1002 /* A single event. */
1005 /* The Python event. This is just a callable object. */
1007 /* The next event. */
1008 struct gdbpy_event *next;
1011 /* All pending events. */
1012 static struct gdbpy_event *gdbpy_event_list;
1013 /* The final link of the event list. */
1014 static struct gdbpy_event **gdbpy_event_list_end;
1016 /* So that we can wake up the main thread even when it is blocked in
1018 static struct serial_event *gdbpy_serial_event;
1020 /* The file handler callback. This reads from the internal pipe, and
1021 then processes the Python event queue. This will always be run in
1022 the main gdb thread. */
1025 gdbpy_run_events (int error, gdb_client_data client_data)
1027 gdbpy_enter enter_py (get_current_arch (), current_language);
1029 /* Clear the event fd. Do this before flushing the events list, so
1030 that any new event post afterwards is sure to re-awake the event
1032 serial_event_clear (gdbpy_serial_event);
1034 while (gdbpy_event_list)
1036 /* Dispatching the event might push a new element onto the event
1037 loop, so we update here "atomically enough". */
1038 struct gdbpy_event *item = gdbpy_event_list;
1039 gdbpy_event_list = gdbpy_event_list->next;
1040 if (gdbpy_event_list == NULL)
1041 gdbpy_event_list_end = &gdbpy_event_list;
1043 /* Ignore errors. */
1044 gdbpy_ref<> call_result (PyObject_CallObject (item->event, NULL));
1045 if (call_result == NULL)
1048 Py_DECREF (item->event);
1053 /* Submit an event to the gdb thread. */
1055 gdbpy_post_event (PyObject *self, PyObject *args)
1057 struct gdbpy_event *event;
1061 if (!PyArg_ParseTuple (args, "O", &func))
1064 if (!PyCallable_Check (func))
1066 PyErr_SetString (PyExc_RuntimeError,
1067 _("Posted event is not callable"));
1073 /* From here until the end of the function, we have the GIL, so we
1074 can operate on our global data structures without worrying. */
1075 wakeup = gdbpy_event_list == NULL;
1077 event = XNEW (struct gdbpy_event);
1078 event->event = func;
1080 *gdbpy_event_list_end = event;
1081 gdbpy_event_list_end = &event->next;
1083 /* Wake up gdb when needed. */
1085 serial_event_set (gdbpy_serial_event);
1090 /* Initialize the Python event handler. */
1092 gdbpy_initialize_events (void)
1094 gdbpy_event_list_end = &gdbpy_event_list;
1096 gdbpy_serial_event = make_serial_event ();
1097 add_file_handler (serial_event_fd (gdbpy_serial_event),
1098 gdbpy_run_events, NULL);
1105 /* This is the extension_language_ops.before_prompt "method". */
1107 static enum ext_lang_rc
1108 gdbpy_before_prompt_hook (const struct extension_language_defn *extlang,
1109 const char *current_gdb_prompt)
1111 if (!gdb_python_initialized)
1112 return EXT_LANG_RC_NOP;
1114 gdbpy_enter enter_py (get_current_arch (), current_language);
1116 if (!evregpy_no_listeners_p (gdb_py_events.before_prompt)
1117 && evpy_emit_event (NULL, gdb_py_events.before_prompt) < 0)
1118 return EXT_LANG_RC_ERROR;
1120 if (gdb_python_module
1121 && PyObject_HasAttrString (gdb_python_module, "prompt_hook"))
1123 gdbpy_ref<> hook (PyObject_GetAttrString (gdb_python_module,
1127 gdbpy_print_stack ();
1128 return EXT_LANG_RC_ERROR;
1131 if (PyCallable_Check (hook.get ()))
1133 gdbpy_ref<> current_prompt (PyString_FromString (current_gdb_prompt));
1134 if (current_prompt == NULL)
1136 gdbpy_print_stack ();
1137 return EXT_LANG_RC_ERROR;
1141 (PyObject_CallFunctionObjArgs (hook.get (), current_prompt.get (),
1145 gdbpy_print_stack ();
1146 return EXT_LANG_RC_ERROR;
1149 /* Return type should be None, or a String. If it is None,
1150 fall through, we will not set a prompt. If it is a
1151 string, set PROMPT. Anything else, set an exception. */
1152 if (result != Py_None && ! PyString_Check (result.get ()))
1154 PyErr_Format (PyExc_RuntimeError,
1155 _("Return from prompt_hook must " \
1156 "be either a Python string, or None"));
1157 gdbpy_print_stack ();
1158 return EXT_LANG_RC_ERROR;
1161 if (result != Py_None)
1163 gdb::unique_xmalloc_ptr<char>
1164 prompt (python_string_to_host_string (result.get ()));
1168 gdbpy_print_stack ();
1169 return EXT_LANG_RC_ERROR;
1172 set_prompt (prompt.get ());
1173 return EXT_LANG_RC_OK;
1178 return EXT_LANG_RC_NOP;
1185 /* A python function to write a single string using gdb's filtered
1186 output stream . The optional keyword STREAM can be used to write
1187 to a particular stream. The default stream is to gdb_stdout. */
1190 gdbpy_write (PyObject *self, PyObject *args, PyObject *kw)
1193 static const char *keywords[] = { "text", "stream", NULL };
1194 int stream_type = 0;
1196 if (!gdb_PyArg_ParseTupleAndKeywords (args, kw, "s|i", keywords, &arg,
1202 switch (stream_type)
1206 fprintf_filtered (gdb_stderr, "%s", arg);
1211 fprintf_filtered (gdb_stdlog, "%s", arg);
1215 fprintf_filtered (gdb_stdout, "%s", arg);
1218 CATCH (except, RETURN_MASK_ALL)
1220 GDB_PY_HANDLE_EXCEPTION (except);
1227 /* A python function to flush a gdb stream. The optional keyword
1228 STREAM can be used to flush a particular stream. The default stream
1232 gdbpy_flush (PyObject *self, PyObject *args, PyObject *kw)
1234 static const char *keywords[] = { "stream", NULL };
1235 int stream_type = 0;
1237 if (!gdb_PyArg_ParseTupleAndKeywords (args, kw, "|i", keywords,
1241 switch (stream_type)
1245 gdb_flush (gdb_stderr);
1250 gdb_flush (gdb_stdlog);
1254 gdb_flush (gdb_stdout);
1260 /* Return non-zero if print-stack is not "none". */
1263 gdbpy_print_python_errors_p (void)
1265 return gdbpy_should_print_stack != python_excp_none;
1268 /* Print a python exception trace, print just a message, or print
1269 nothing and clear the python exception, depending on
1270 gdbpy_should_print_stack. Only call this if a python exception is
1273 gdbpy_print_stack (void)
1276 /* Print "none", just clear exception. */
1277 if (gdbpy_should_print_stack == python_excp_none)
1281 /* Print "full" message and backtrace. */
1282 else if (gdbpy_should_print_stack == python_excp_full)
1285 /* PyErr_Print doesn't necessarily end output with a newline.
1286 This works because Python's stdout/stderr is fed through
1292 CATCH (except, RETURN_MASK_ALL)
1297 /* Print "message", just error print message. */
1300 PyObject *ptype, *pvalue, *ptraceback;
1302 PyErr_Fetch (&ptype, &pvalue, &ptraceback);
1304 /* Fetch the error message contained within ptype, pvalue. */
1305 gdb::unique_xmalloc_ptr<char>
1306 msg (gdbpy_exception_to_string (ptype, pvalue));
1307 gdb::unique_xmalloc_ptr<char> type (gdbpy_obj_to_string (ptype));
1313 /* An error occurred computing the string representation of the
1315 fprintf_filtered (gdb_stderr,
1316 _("Error occurred computing Python error" \
1320 fprintf_filtered (gdb_stderr, "Python Exception %s %s: \n",
1321 type.get (), msg.get ());
1323 CATCH (except, RETURN_MASK_ALL)
1329 Py_XDECREF (pvalue);
1330 Py_XDECREF (ptraceback);
1336 /* Return the current Progspace.
1337 There always is one. */
1340 gdbpy_get_current_progspace (PyObject *unused1, PyObject *unused2)
1344 result = pspace_to_pspace_object (current_program_space);
1350 /* Return a sequence holding all the Progspaces. */
1353 gdbpy_progspaces (PyObject *unused1, PyObject *unused2)
1355 struct program_space *ps;
1357 gdbpy_ref<> list (PyList_New (0));
1363 PyObject *item = pspace_to_pspace_object (ps);
1365 if (!item || PyList_Append (list.get (), item) == -1)
1369 return list.release ();
1374 /* The "current" objfile. This is set when gdb detects that a new
1375 objfile has been loaded. It is only set for the duration of a call to
1376 gdbpy_source_objfile_script and gdbpy_execute_objfile_script; it is NULL
1378 static struct objfile *gdbpy_current_objfile;
1380 /* Set the current objfile to OBJFILE and then read FILE named FILENAME
1381 as Python code. This does not throw any errors. If an exception
1382 occurs python will print the traceback and clear the error indicator.
1383 This is the extension_language_script_ops.objfile_script_sourcer
1387 gdbpy_source_objfile_script (const struct extension_language_defn *extlang,
1388 struct objfile *objfile, FILE *file,
1389 const char *filename)
1391 if (!gdb_python_initialized)
1394 gdbpy_enter enter_py (get_objfile_arch (objfile), current_language);
1395 gdbpy_current_objfile = objfile;
1397 python_run_simple_file (file, filename);
1399 gdbpy_current_objfile = NULL;
1402 /* Set the current objfile to OBJFILE and then execute SCRIPT
1403 as Python code. This does not throw any errors. If an exception
1404 occurs python will print the traceback and clear the error indicator.
1405 This is the extension_language_script_ops.objfile_script_executor
1409 gdbpy_execute_objfile_script (const struct extension_language_defn *extlang,
1410 struct objfile *objfile, const char *name,
1413 if (!gdb_python_initialized)
1416 gdbpy_enter enter_py (get_objfile_arch (objfile), current_language);
1417 gdbpy_current_objfile = objfile;
1419 PyRun_SimpleString (script);
1421 gdbpy_current_objfile = NULL;
1424 /* Return the current Objfile, or None if there isn't one. */
1427 gdbpy_get_current_objfile (PyObject *unused1, PyObject *unused2)
1431 if (! gdbpy_current_objfile)
1434 result = objfile_to_objfile_object (gdbpy_current_objfile);
1440 /* Return a sequence holding all the Objfiles. */
1443 gdbpy_objfiles (PyObject *unused1, PyObject *unused2)
1445 struct objfile *objf;
1447 gdbpy_ref<> list (PyList_New (0));
1453 PyObject *item = objfile_to_objfile_object (objf);
1455 if (!item || PyList_Append (list.get (), item) == -1)
1459 return list.release ();
1462 /* Compute the list of active python type printers and store them in
1463 EXT_PRINTERS->py_type_printers. The product of this function is used by
1464 gdbpy_apply_type_printers, and freed by gdbpy_free_type_printers.
1465 This is the extension_language_ops.start_type_printers "method". */
1468 gdbpy_start_type_printers (const struct extension_language_defn *extlang,
1469 struct ext_lang_type_printers *ext_printers)
1471 PyObject *printers_obj = NULL;
1473 if (!gdb_python_initialized)
1476 gdbpy_enter enter_py (get_current_arch (), current_language);
1478 gdbpy_ref<> type_module (PyImport_ImportModule ("gdb.types"));
1479 if (type_module == NULL)
1481 gdbpy_print_stack ();
1485 gdbpy_ref<> func (PyObject_GetAttrString (type_module.get (),
1486 "get_type_recognizers"));
1489 gdbpy_print_stack ();
1493 printers_obj = PyObject_CallFunctionObjArgs (func.get (), (char *) NULL);
1494 if (printers_obj == NULL)
1495 gdbpy_print_stack ();
1497 ext_printers->py_type_printers = printers_obj;
1500 /* If TYPE is recognized by some type printer, store in *PRETTIED_TYPE
1501 a newly allocated string holding the type's replacement name, and return
1502 EXT_LANG_RC_OK. The caller is responsible for freeing the string.
1503 If there's a Python error return EXT_LANG_RC_ERROR.
1504 Otherwise, return EXT_LANG_RC_NOP.
1505 This is the extension_language_ops.apply_type_printers "method". */
1507 static enum ext_lang_rc
1508 gdbpy_apply_type_printers (const struct extension_language_defn *extlang,
1509 const struct ext_lang_type_printers *ext_printers,
1510 struct type *type, char **prettied_type)
1512 PyObject *printers_obj = (PyObject *) ext_printers->py_type_printers;
1513 gdb::unique_xmalloc_ptr<char> result;
1515 if (printers_obj == NULL)
1516 return EXT_LANG_RC_NOP;
1518 if (!gdb_python_initialized)
1519 return EXT_LANG_RC_NOP;
1521 gdbpy_enter enter_py (get_current_arch (), current_language);
1523 gdbpy_ref<> type_obj (type_to_type_object (type));
1524 if (type_obj == NULL)
1526 gdbpy_print_stack ();
1527 return EXT_LANG_RC_ERROR;
1530 gdbpy_ref<> type_module (PyImport_ImportModule ("gdb.types"));
1531 if (type_module == NULL)
1533 gdbpy_print_stack ();
1534 return EXT_LANG_RC_ERROR;
1537 gdbpy_ref<> func (PyObject_GetAttrString (type_module.get (),
1538 "apply_type_recognizers"));
1541 gdbpy_print_stack ();
1542 return EXT_LANG_RC_ERROR;
1545 gdbpy_ref<> result_obj (PyObject_CallFunctionObjArgs (func.get (),
1549 if (result_obj == NULL)
1551 gdbpy_print_stack ();
1552 return EXT_LANG_RC_ERROR;
1555 if (result_obj == Py_None)
1556 return EXT_LANG_RC_NOP;
1558 result = python_string_to_host_string (result_obj.get ());
1561 gdbpy_print_stack ();
1562 return EXT_LANG_RC_ERROR;
1565 *prettied_type = result.release ();
1566 return EXT_LANG_RC_OK;
1569 /* Free the result of start_type_printers.
1570 This is the extension_language_ops.free_type_printers "method". */
1573 gdbpy_free_type_printers (const struct extension_language_defn *extlang,
1574 struct ext_lang_type_printers *ext_printers)
1576 PyObject *printers = (PyObject *) ext_printers->py_type_printers;
1578 if (printers == NULL)
1581 if (!gdb_python_initialized)
1584 gdbpy_enter enter_py (get_current_arch (), current_language);
1585 Py_DECREF (printers);
1588 #else /* HAVE_PYTHON */
1590 /* Dummy implementation of the gdb "python-interactive" and "python"
1594 python_interactive_command (const char *arg, int from_tty)
1596 arg = skip_spaces (arg);
1598 error (_("Python scripting is not supported in this copy of GDB."));
1601 counted_command_line l = get_command_line (python_control, "");
1603 execute_control_command_untraced (l.get ());
1608 python_command (const char *arg, int from_tty)
1610 python_interactive_command (arg, from_tty);
1613 #endif /* HAVE_PYTHON */
1617 /* Lists for 'set python' commands. */
1619 static struct cmd_list_element *user_set_python_list;
1620 static struct cmd_list_element *user_show_python_list;
1622 /* Function for use by 'set python' prefix command. */
1625 user_set_python (const char *args, int from_tty)
1627 help_list (user_set_python_list, "set python ", all_commands,
1631 /* Function for use by 'show python' prefix command. */
1634 user_show_python (const char *args, int from_tty)
1636 cmd_show_list (user_show_python_list, from_tty, "");
1639 /* Initialize the Python code. */
1643 /* This is installed as a final cleanup and cleans up the
1644 interpreter. This lets Python's 'atexit' work. */
1647 finalize_python (void *ignore)
1649 struct active_ext_lang_state *previous_active;
1651 /* We don't use ensure_python_env here because if we ever ran the
1652 cleanup, gdb would crash -- because the cleanup calls into the
1653 Python interpreter, which we are about to destroy. It seems
1654 clearer to make the needed calls explicitly here than to create a
1655 cleanup and then mysteriously discard it. */
1657 /* This is only called as a final cleanup so we can assume the active
1658 SIGINT handler is gdb's. We still need to tell it to notify Python. */
1659 previous_active = set_active_ext_lang (&extension_language_python);
1661 (void) PyGILState_Ensure ();
1662 python_gdbarch = target_gdbarch ();
1663 python_language = current_language;
1667 restore_active_ext_lang (previous_active);
1671 do_start_initialization ()
1674 size_t progsize, count;
1675 wchar_t *progname_copy;
1678 #ifdef WITH_PYTHON_PATH
1679 /* Work around problem where python gets confused about where it is,
1680 and then can't find its libraries, etc.
1681 NOTE: Python assumes the following layout:
1683 /foo/lib/pythonX.Y/...
1684 This must be done before calling Py_Initialize. */
1685 gdb::unique_xmalloc_ptr<char> progname
1686 (concat (ldirname (python_libdir).c_str (), SLASH_STRING, "bin",
1687 SLASH_STRING, "python", (char *) NULL));
1689 std::string oldloc = setlocale (LC_ALL, NULL);
1690 setlocale (LC_ALL, "");
1691 progsize = strlen (progname.get ());
1692 progname_copy = (wchar_t *) PyMem_Malloc ((progsize + 1) * sizeof (wchar_t));
1695 fprintf (stderr, "out of memory\n");
1698 count = mbstowcs (progname_copy, progname.get (), progsize + 1);
1699 if (count == (size_t) -1)
1701 fprintf (stderr, "Could not convert python path to string\n");
1704 setlocale (LC_ALL, oldloc.c_str ());
1706 /* Note that Py_SetProgramName expects the string it is passed to
1707 remain alive for the duration of the program's execution, so
1708 it is not freed after this call. */
1709 Py_SetProgramName (progname_copy);
1711 Py_SetProgramName (progname.release ());
1716 PyEval_InitThreads ();
1719 gdb_module = PyModule_Create (&python_GdbModuleDef);
1720 /* Add _gdb module to the list of known built-in modules. */
1721 _PyImport_FixupBuiltin (gdb_module, "_gdb");
1723 gdb_module = Py_InitModule ("_gdb", python_GdbMethods);
1725 if (gdb_module == NULL)
1728 /* The casts to (char*) are for python 2.4. */
1729 if (PyModule_AddStringConstant (gdb_module, "VERSION", (char*) version) < 0
1730 || PyModule_AddStringConstant (gdb_module, "HOST_CONFIG",
1731 (char*) host_name) < 0
1732 || PyModule_AddStringConstant (gdb_module, "TARGET_CONFIG",
1733 (char*) target_name) < 0)
1736 /* Add stream constants. */
1737 if (PyModule_AddIntConstant (gdb_module, "STDOUT", 0) < 0
1738 || PyModule_AddIntConstant (gdb_module, "STDERR", 1) < 0
1739 || PyModule_AddIntConstant (gdb_module, "STDLOG", 2) < 0)
1742 gdbpy_gdb_error = PyErr_NewException ("gdb.error", PyExc_RuntimeError, NULL);
1743 if (gdbpy_gdb_error == NULL
1744 || gdb_pymodule_addobject (gdb_module, "error", gdbpy_gdb_error) < 0)
1747 gdbpy_gdb_memory_error = PyErr_NewException ("gdb.MemoryError",
1748 gdbpy_gdb_error, NULL);
1749 if (gdbpy_gdb_memory_error == NULL
1750 || gdb_pymodule_addobject (gdb_module, "MemoryError",
1751 gdbpy_gdb_memory_error) < 0)
1754 gdbpy_gdberror_exc = PyErr_NewException ("gdb.GdbError", NULL, NULL);
1755 if (gdbpy_gdberror_exc == NULL
1756 || gdb_pymodule_addobject (gdb_module, "GdbError",
1757 gdbpy_gdberror_exc) < 0)
1760 gdbpy_initialize_gdb_readline ();
1762 if (gdbpy_initialize_auto_load () < 0
1763 || gdbpy_initialize_values () < 0
1764 || gdbpy_initialize_frames () < 0
1765 || gdbpy_initialize_commands () < 0
1766 || gdbpy_initialize_instruction () < 0
1767 || gdbpy_initialize_record () < 0
1768 || gdbpy_initialize_btrace () < 0
1769 || gdbpy_initialize_symbols () < 0
1770 || gdbpy_initialize_symtabs () < 0
1771 || gdbpy_initialize_blocks () < 0
1772 || gdbpy_initialize_functions () < 0
1773 || gdbpy_initialize_parameters () < 0
1774 || gdbpy_initialize_types () < 0
1775 || gdbpy_initialize_pspace () < 0
1776 || gdbpy_initialize_objfile () < 0
1777 || gdbpy_initialize_breakpoints () < 0
1778 || gdbpy_initialize_finishbreakpoints () < 0
1779 || gdbpy_initialize_lazy_string () < 0
1780 || gdbpy_initialize_linetable () < 0
1781 || gdbpy_initialize_thread () < 0
1782 || gdbpy_initialize_inferior () < 0
1783 || gdbpy_initialize_events () < 0
1784 || gdbpy_initialize_eventregistry () < 0
1785 || gdbpy_initialize_py_events () < 0
1786 || gdbpy_initialize_event () < 0
1787 || gdbpy_initialize_arch () < 0
1788 || gdbpy_initialize_xmethods () < 0
1789 || gdbpy_initialize_unwind () < 0)
1792 #define GDB_PY_DEFINE_EVENT_TYPE(name, py_name, doc, base) \
1793 if (gdbpy_initialize_event_generic (&name##_event_object_type, py_name) < 0) \
1795 #include "py-event-types.def"
1796 #undef GDB_PY_DEFINE_EVENT_TYPE
1798 gdbpy_to_string_cst = PyString_FromString ("to_string");
1799 if (gdbpy_to_string_cst == NULL)
1801 gdbpy_children_cst = PyString_FromString ("children");
1802 if (gdbpy_children_cst == NULL)
1804 gdbpy_display_hint_cst = PyString_FromString ("display_hint");
1805 if (gdbpy_display_hint_cst == NULL)
1807 gdbpy_doc_cst = PyString_FromString ("__doc__");
1808 if (gdbpy_doc_cst == NULL)
1810 gdbpy_enabled_cst = PyString_FromString ("enabled");
1811 if (gdbpy_enabled_cst == NULL)
1813 gdbpy_value_cst = PyString_FromString ("value");
1814 if (gdbpy_value_cst == NULL)
1817 /* Release the GIL while gdb runs. */
1818 PyThreadState_Swap (NULL);
1819 PyEval_ReleaseLock ();
1821 make_final_cleanup (finalize_python, NULL);
1823 /* Only set this when initialization has succeeded. */
1824 gdb_python_initialized = 1;
1828 #endif /* HAVE_PYTHON */
1831 _initialize_python (void)
1833 add_com ("python-interactive", class_obscure,
1834 python_interactive_command,
1837 Start an interactive Python prompt.\n\
1839 To return to GDB, type the EOF character (e.g., Ctrl-D on an empty\n\
1842 Alternatively, a single-line Python command can be given as an\n\
1843 argument, and if the command is an expression, the result will be\n\
1844 printed. For example:\n\
1846 (gdb) python-interactive 2 + 3\n\
1849 #else /* HAVE_PYTHON */
1851 Start a Python interactive prompt.\n\
1853 Python scripting is not supported in this copy of GDB.\n\
1854 This command is only a placeholder.")
1855 #endif /* HAVE_PYTHON */
1857 add_com_alias ("pi", "python-interactive", class_obscure, 1);
1859 add_com ("python", class_obscure, python_command,
1862 Evaluate a Python command.\n\
1864 The command can be given as an argument, for instance:\n\
1868 If no argument is given, the following lines are read and used\n\
1869 as the Python commands. Type a line containing \"end\" to indicate\n\
1870 the end of the command.")
1871 #else /* HAVE_PYTHON */
1873 Evaluate a Python command.\n\
1875 Python scripting is not supported in this copy of GDB.\n\
1876 This command is only a placeholder.")
1877 #endif /* HAVE_PYTHON */
1879 add_com_alias ("py", "python", class_obscure, 1);
1881 /* Add set/show python print-stack. */
1882 add_prefix_cmd ("python", no_class, user_show_python,
1883 _("Prefix command for python preference settings."),
1884 &user_show_python_list, "show python ", 0,
1887 add_prefix_cmd ("python", no_class, user_set_python,
1888 _("Prefix command for python preference settings."),
1889 &user_set_python_list, "set python ", 0,
1892 add_setshow_enum_cmd ("print-stack", no_class, python_excp_enums,
1893 &gdbpy_should_print_stack, _("\
1894 Set mode for Python stack dump on error."), _("\
1895 Show the mode of Python stack printing on error."), _("\
1896 none == no stack or message will be printed.\n\
1897 full == a message and a stack will be printed.\n\
1898 message == an error message without a stack will be printed."),
1900 &user_set_python_list,
1901 &user_show_python_list);
1904 if (!do_start_initialization () && PyErr_Occurred ())
1905 gdbpy_print_stack ();
1906 #endif /* HAVE_PYTHON */
1911 /* Helper function for gdbpy_finish_initialization. This does the
1912 work and then returns false if an error has occurred and must be
1913 displayed, or true on success. */
1916 do_finish_initialization (const struct extension_language_defn *extlang)
1921 /* Add the initial data-directory to sys.path. */
1923 std::string gdb_pythondir = (std::string (gdb_datadir) + SLASH_STRING
1926 sys_path = PySys_GetObject ("path");
1928 /* If sys.path is not defined yet, define it first. */
1929 if (!(sys_path && PyList_Check (sys_path)))
1932 PySys_SetPath (L"");
1936 sys_path = PySys_GetObject ("path");
1938 if (sys_path && PyList_Check (sys_path))
1940 gdbpy_ref<> pythondir (PyString_FromString (gdb_pythondir.c_str ()));
1941 if (pythondir == NULL || PyList_Insert (sys_path, 0, pythondir.get ()))
1947 /* Import the gdb module to finish the initialization, and
1948 add it to __main__ for convenience. */
1949 m = PyImport_AddModule ("__main__");
1953 /* Keep the reference to gdb_python_module since it is in a global
1955 gdb_python_module = PyImport_ImportModule ("gdb");
1956 if (gdb_python_module == NULL)
1958 gdbpy_print_stack ();
1959 /* This is passed in one call to warning so that blank lines aren't
1960 inserted between each line of text. */
1962 "Could not load the Python gdb module from `%s'.\n"
1963 "Limited Python support is available from the _gdb module.\n"
1964 "Suggest passing --data-directory=/path/to/gdb/data-directory.\n"),
1965 gdb_pythondir.c_str ());
1966 /* We return "success" here as we've already emitted the
1971 return gdb_pymodule_addobject (m, "gdb", gdb_python_module) >= 0;
1974 /* Perform the remaining python initializations.
1975 These must be done after GDB is at least mostly initialized.
1976 E.g., The "info pretty-printer" command needs the "info" prefix
1978 This is the extension_language_ops.finish_initialization "method". */
1981 gdbpy_finish_initialization (const struct extension_language_defn *extlang)
1983 gdbpy_enter enter_py (get_current_arch (), current_language);
1985 if (!do_finish_initialization (extlang))
1987 gdbpy_print_stack ();
1988 warning (_("internal error: Unhandled Python exception"));
1992 /* Return non-zero if Python has successfully initialized.
1993 This is the extension_languages_ops.initialized "method". */
1996 gdbpy_initialized (const struct extension_language_defn *extlang)
1998 return gdb_python_initialized;
2001 #endif /* HAVE_PYTHON */
2007 PyMethodDef python_GdbMethods[] =
2009 { "history", gdbpy_history, METH_VARARGS,
2010 "Get a value from history" },
2011 { "execute", (PyCFunction) execute_gdb_command, METH_VARARGS | METH_KEYWORDS,
2012 "execute (command [, from_tty] [, to_string]) -> [String]\n\
2013 Evaluate command, a string, as a gdb CLI command. Optionally returns\n\
2014 a Python String containing the output of the command if to_string is\n\
2016 { "parameter", gdbpy_parameter, METH_VARARGS,
2017 "Return a gdb parameter's value" },
2019 { "breakpoints", gdbpy_breakpoints, METH_NOARGS,
2020 "Return a tuple of all breakpoint objects" },
2022 { "default_visualizer", gdbpy_default_visualizer, METH_VARARGS,
2023 "Find the default visualizer for a Value." },
2025 { "current_progspace", gdbpy_get_current_progspace, METH_NOARGS,
2026 "Return the current Progspace." },
2027 { "progspaces", gdbpy_progspaces, METH_NOARGS,
2028 "Return a sequence of all progspaces." },
2030 { "current_objfile", gdbpy_get_current_objfile, METH_NOARGS,
2031 "Return the current Objfile being loaded, or None." },
2032 { "objfiles", gdbpy_objfiles, METH_NOARGS,
2033 "Return a sequence of all loaded objfiles." },
2035 { "newest_frame", gdbpy_newest_frame, METH_NOARGS,
2036 "newest_frame () -> gdb.Frame.\n\
2037 Return the newest frame object." },
2038 { "selected_frame", gdbpy_selected_frame, METH_NOARGS,
2039 "selected_frame () -> gdb.Frame.\n\
2040 Return the selected frame object." },
2041 { "frame_stop_reason_string", gdbpy_frame_stop_reason_string, METH_VARARGS,
2042 "stop_reason_string (Integer) -> String.\n\
2043 Return a string explaining unwind stop reason." },
2045 { "start_recording", gdbpy_start_recording, METH_VARARGS,
2046 "start_recording ([method] [, format]) -> gdb.Record.\n\
2047 Start recording with the given method. If no method is given, will fall back\n\
2048 to the system default method. If no format is given, will fall back to the\n\
2049 default format for the given method."},
2050 { "current_recording", gdbpy_current_recording, METH_NOARGS,
2051 "current_recording () -> gdb.Record.\n\
2052 Return current recording object." },
2053 { "stop_recording", gdbpy_stop_recording, METH_NOARGS,
2054 "stop_recording () -> None.\n\
2055 Stop current recording." },
2057 { "lookup_type", (PyCFunction) gdbpy_lookup_type,
2058 METH_VARARGS | METH_KEYWORDS,
2059 "lookup_type (name [, block]) -> type\n\
2060 Return a Type corresponding to the given name." },
2061 { "lookup_symbol", (PyCFunction) gdbpy_lookup_symbol,
2062 METH_VARARGS | METH_KEYWORDS,
2063 "lookup_symbol (name [, block] [, domain]) -> (symbol, is_field_of_this)\n\
2064 Return a tuple with the symbol corresponding to the given name (or None) and\n\
2065 a boolean indicating if name is a field of the current implied argument\n\
2066 `this' (when the current language is object-oriented)." },
2067 { "lookup_global_symbol", (PyCFunction) gdbpy_lookup_global_symbol,
2068 METH_VARARGS | METH_KEYWORDS,
2069 "lookup_global_symbol (name [, domain]) -> symbol\n\
2070 Return the symbol corresponding to the given name (or None)." },
2072 { "lookup_objfile", (PyCFunction) gdbpy_lookup_objfile,
2073 METH_VARARGS | METH_KEYWORDS,
2074 "lookup_objfile (name, [by_build_id]) -> objfile\n\
2075 Look up the specified objfile.\n\
2076 If by_build_id is True, the objfile is looked up by using name\n\
2077 as its build id." },
2079 { "block_for_pc", gdbpy_block_for_pc, METH_VARARGS,
2080 "Return the block containing the given pc value, or None." },
2081 { "solib_name", gdbpy_solib_name, METH_VARARGS,
2082 "solib_name (Long) -> String.\n\
2083 Return the name of the shared library holding a given address, or None." },
2084 { "decode_line", gdbpy_decode_line, METH_VARARGS,
2085 "decode_line (String) -> Tuple. Decode a string argument the way\n\
2086 that 'break' or 'edit' does. Return a tuple containing two elements.\n\
2087 The first element contains any unparsed portion of the String parameter\n\
2088 (or None if the string was fully parsed). The second element contains\n\
2089 a tuple that contains all the locations that match, represented as\n\
2090 gdb.Symtab_and_line objects (or None)."},
2091 { "parse_and_eval", gdbpy_parse_and_eval, METH_VARARGS,
2092 "parse_and_eval (String) -> Value.\n\
2093 Parse String as an expression, evaluate it, and return the result as a Value."
2095 { "find_pc_line", gdbpy_find_pc_line, METH_VARARGS,
2096 "find_pc_line (pc) -> Symtab_and_line.\n\
2097 Return the gdb.Symtab_and_line object corresponding to the pc value." },
2099 { "post_event", gdbpy_post_event, METH_VARARGS,
2100 "Post an event into gdb's event loop." },
2102 { "target_charset", gdbpy_target_charset, METH_NOARGS,
2103 "target_charset () -> string.\n\
2104 Return the name of the current target charset." },
2105 { "target_wide_charset", gdbpy_target_wide_charset, METH_NOARGS,
2106 "target_wide_charset () -> string.\n\
2107 Return the name of the current target wide charset." },
2108 { "rbreak", (PyCFunction) gdbpy_rbreak, METH_VARARGS | METH_KEYWORDS,
2109 "rbreak (Regex) -> List.\n\
2110 Return a Tuple containing gdb.Breakpoint objects that match the given Regex." },
2111 { "string_to_argv", gdbpy_string_to_argv, METH_VARARGS,
2112 "string_to_argv (String) -> Array.\n\
2113 Parse String and return an argv-like array.\n\
2114 Arguments are separate by spaces and may be quoted."
2116 { "write", (PyCFunction)gdbpy_write, METH_VARARGS | METH_KEYWORDS,
2117 "Write a string using gdb's filtered stream." },
2118 { "flush", (PyCFunction)gdbpy_flush, METH_VARARGS | METH_KEYWORDS,
2119 "Flush gdb's filtered stdout stream." },
2120 { "selected_thread", gdbpy_selected_thread, METH_NOARGS,
2121 "selected_thread () -> gdb.InferiorThread.\n\
2122 Return the selected thread object." },
2123 { "selected_inferior", gdbpy_selected_inferior, METH_NOARGS,
2124 "selected_inferior () -> gdb.Inferior.\n\
2125 Return the selected inferior object." },
2126 { "inferiors", gdbpy_inferiors, METH_NOARGS,
2127 "inferiors () -> (gdb.Inferior, ...).\n\
2128 Return a tuple containing all inferiors." },
2130 { "invalidate_cached_frames", gdbpy_invalidate_cached_frames, METH_NOARGS,
2131 "invalidate_cached_frames () -> None.\n\
2132 Invalidate any cached frame objects in gdb.\n\
2133 Intended for internal use only." },
2135 { "convenience_variable", gdbpy_convenience_variable, METH_VARARGS,
2136 "convenience_variable (NAME) -> value.\n\
2137 Return the value of the convenience variable $NAME,\n\
2138 or None if not set." },
2139 { "set_convenience_variable", gdbpy_set_convenience_variable, METH_VARARGS,
2140 "convenience_variable (NAME, VALUE) -> None.\n\
2141 Set the value of the convenience variable $NAME." },
2143 {NULL, NULL, 0, NULL}
2147 struct PyModuleDef python_GdbModuleDef =
2149 PyModuleDef_HEAD_INIT,
2161 /* Define all the event objects. */
2162 #define GDB_PY_DEFINE_EVENT_TYPE(name, py_name, doc, base) \
2163 PyTypeObject name##_event_object_type \
2164 CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("event_object") \
2166 PyVarObject_HEAD_INIT (NULL, 0) \
2167 "gdb." py_name, /* tp_name */ \
2168 sizeof (event_object), /* tp_basicsize */ \
2169 0, /* tp_itemsize */ \
2170 evpy_dealloc, /* tp_dealloc */ \
2172 0, /* tp_getattr */ \
2173 0, /* tp_setattr */ \
2174 0, /* tp_compare */ \
2176 0, /* tp_as_number */ \
2177 0, /* tp_as_sequence */ \
2178 0, /* tp_as_mapping */ \
2182 0, /* tp_getattro */ \
2183 0, /* tp_setattro */ \
2184 0, /* tp_as_buffer */ \
2185 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */ \
2187 0, /* tp_traverse */ \
2189 0, /* tp_richcompare */ \
2190 0, /* tp_weaklistoffset */ \
2192 0, /* tp_iternext */ \
2193 0, /* tp_methods */ \
2194 0, /* tp_members */ \
2195 0, /* tp_getset */ \
2196 &base, /* tp_base */ \
2198 0, /* tp_descr_get */ \
2199 0, /* tp_descr_set */ \
2200 0, /* tp_dictoffset */ \
2204 #include "py-event-types.def"
2205 #undef GDB_PY_DEFINE_EVENT_TYPE
2207 #endif /* HAVE_PYTHON */