1 /* General python/gdb code
3 Copyright (C) 2008-2019 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"
93 #include "python-internal.h"
96 #include "common/version.h"
98 #include "gdbthread.h"
100 #include "event-top.h"
101 #include "py-event.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_get_matching_xmethod_workers
,
194 /* Architecture and language to be used in callbacks from
195 the Python interpreter. */
196 struct gdbarch
*python_gdbarch
;
197 const struct language_defn
*python_language
;
199 gdbpy_enter::gdbpy_enter (struct gdbarch
*gdbarch
,
200 const struct language_defn
*language
)
201 : m_gdbarch (python_gdbarch
),
202 m_language (python_language
)
204 /* We should not ever enter Python unless initialized. */
205 if (!gdb_python_initialized
)
206 error (_("Python not initialized"));
208 m_previous_active
= set_active_ext_lang (&extension_language_python
);
210 m_state
= PyGILState_Ensure ();
212 python_gdbarch
= gdbarch
;
213 python_language
= language
;
215 /* Save it and ensure ! PyErr_Occurred () afterwards. */
219 gdbpy_enter::~gdbpy_enter ()
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"));
231 PyGILState_Release (m_state
);
232 python_gdbarch
= m_gdbarch
;
233 python_language
= m_language
;
235 restore_active_ext_lang (m_previous_active
);
238 /* Set the quit flag. */
241 gdbpy_set_quit_flag (const struct extension_language_defn
*extlang
)
243 PyErr_SetInterrupt ();
246 /* Return true if the quit flag has been set, false otherwise. */
249 gdbpy_check_quit_flag (const struct extension_language_defn
*extlang
)
251 return PyOS_InterruptOccurred ();
254 /* Evaluate a Python command like PyRun_SimpleString, but uses
255 Py_single_input which prints the result of expressions, and does
256 not automatically print the stack on errors. */
259 eval_python_command (const char *command
)
263 m
= PyImport_AddModule ("__main__");
267 d
= PyModule_GetDict (m
);
270 gdbpy_ref
<> v (PyRun_StringFlags (command
, Py_single_input
, d
, d
, NULL
));
282 /* Implementation of the gdb "python-interactive" command. */
285 python_interactive_command (const char *arg
, int from_tty
)
287 struct ui
*ui
= current_ui
;
290 scoped_restore save_async
= make_scoped_restore (¤t_ui
->async
, 0);
292 arg
= skip_spaces (arg
);
294 gdbpy_enter
enter_py (get_current_arch (), current_language
);
298 std::string script
= std::string (arg
) + "\n";
299 err
= eval_python_command (script
.c_str ());
303 err
= PyRun_InteractiveLoop (ui
->instream
, "<stdin>");
309 gdbpy_print_stack ();
310 error (_("Error while executing Python code."));
314 /* A wrapper around PyRun_SimpleFile. FILE is the Python script to run
317 On Windows hosts few users would build Python themselves (this is no
318 trivial task on this platform), and thus use binaries built by
319 someone else instead. There may happen situation where the Python
320 library and GDB are using two different versions of the C runtime
321 library. Python, being built with VC, would use one version of the
322 msvcr DLL (Eg. msvcr100.dll), while MinGW uses msvcrt.dll.
323 A FILE * from one runtime does not necessarily operate correctly in
326 To work around this potential issue, we create on Windows hosts the
327 FILE object using Python routines, thus making sure that it is
328 compatible with the Python library. */
331 python_run_simple_file (FILE *file
, const char *filename
)
335 PyRun_SimpleFile (file
, filename
);
339 /* Because we have a string for a filename, and are using Python to
340 open the file, we need to expand any tilde in the path first. */
341 gdb::unique_xmalloc_ptr
<char> full_path (tilde_expand (filename
));
342 gdbpy_ref
<> python_file (PyFile_FromString (full_path
.get (), (char *) "r"));
343 if (python_file
== NULL
)
345 gdbpy_print_stack ();
346 error (_("Error while opening file: %s"), full_path
.get ());
349 PyRun_SimpleFile (PyFile_AsFile (python_file
.get ()), filename
);
354 /* Given a command_line, return a command string suitable for passing
355 to Python. Lines in the string are separated by newlines. */
358 compute_python_string (struct command_line
*l
)
360 struct command_line
*iter
;
363 for (iter
= l
; iter
; iter
= iter
->next
)
365 script
+= iter
->line
;
371 /* Take a command line structure representing a 'python' command, and
372 evaluate its body using the Python interpreter. */
375 gdbpy_eval_from_control_command (const struct extension_language_defn
*extlang
,
376 struct command_line
*cmd
)
380 if (cmd
->body_list_1
!= nullptr)
381 error (_("Invalid \"python\" block structure."));
383 gdbpy_enter
enter_py (get_current_arch (), current_language
);
385 std::string script
= compute_python_string (cmd
->body_list_0
.get ());
386 ret
= PyRun_SimpleString (script
.c_str ());
388 error (_("Error while executing Python code."));
391 /* Implementation of the gdb "python" command. */
394 python_command (const char *arg
, int from_tty
)
396 gdbpy_enter
enter_py (get_current_arch (), current_language
);
398 scoped_restore save_async
= make_scoped_restore (¤t_ui
->async
, 0);
400 arg
= skip_spaces (arg
);
403 if (PyRun_SimpleString (arg
))
404 error (_("Error while executing Python code."));
408 counted_command_line l
= get_command_line (python_control
, "");
410 execute_control_command_untraced (l
.get ());
416 /* Transform a gdb parameters's value into a Python value. May return
417 NULL (and set a Python exception) on error. Helper function for
420 gdbpy_parameter_value (enum var_types type
, void *var
)
425 case var_string_noescape
:
426 case var_optional_filename
:
430 const char *str
= *(char **) var
;
434 return host_string_to_python_string (str
).release ();
445 case var_auto_boolean
:
447 enum auto_boolean ab
= * (enum auto_boolean
*) var
;
449 if (ab
== AUTO_BOOLEAN_TRUE
)
451 else if (ab
== AUTO_BOOLEAN_FALSE
)
458 if ((* (int *) var
) == INT_MAX
)
462 case var_zuinteger_unlimited
:
463 return PyLong_FromLong (* (int *) var
);
467 unsigned int val
= * (unsigned int *) var
;
471 return PyLong_FromUnsignedLong (val
);
476 unsigned int val
= * (unsigned int *) var
;
477 return PyLong_FromUnsignedLong (val
);
481 return PyErr_Format (PyExc_RuntimeError
,
482 _("Programmer error: unhandled type."));
485 /* A Python function which returns a gdb parameter's value as a Python
489 gdbpy_parameter (PyObject
*self
, PyObject
*args
)
491 struct cmd_list_element
*alias
, *prefix
, *cmd
;
495 if (! PyArg_ParseTuple (args
, "s", &arg
))
498 std::string newarg
= std::string ("show ") + arg
;
502 found
= lookup_cmd_composition (newarg
.c_str (), &alias
, &prefix
, &cmd
);
504 CATCH (ex
, RETURN_MASK_ALL
)
506 GDB_PY_HANDLE_EXCEPTION (ex
);
511 return PyErr_Format (PyExc_RuntimeError
,
512 _("Could not find parameter `%s'."), arg
);
515 return PyErr_Format (PyExc_RuntimeError
,
516 _("`%s' is not a parameter."), arg
);
517 return gdbpy_parameter_value (cmd
->var_type
, cmd
->var
);
520 /* Wrapper for target_charset. */
523 gdbpy_target_charset (PyObject
*self
, PyObject
*args
)
525 const char *cset
= target_charset (python_gdbarch
);
527 return PyUnicode_Decode (cset
, strlen (cset
), host_charset (), NULL
);
530 /* Wrapper for target_wide_charset. */
533 gdbpy_target_wide_charset (PyObject
*self
, PyObject
*args
)
535 const char *cset
= target_wide_charset (python_gdbarch
);
537 return PyUnicode_Decode (cset
, strlen (cset
), host_charset (), NULL
);
540 /* A Python function which evaluates a string using the gdb CLI. */
543 execute_gdb_command (PyObject
*self
, PyObject
*args
, PyObject
*kw
)
546 PyObject
*from_tty_obj
= NULL
, *to_string_obj
= NULL
;
547 int from_tty
, to_string
;
548 static const char *keywords
[] = { "command", "from_tty", "to_string", NULL
};
550 if (!gdb_PyArg_ParseTupleAndKeywords (args
, kw
, "s|O!O!", keywords
, &arg
,
551 &PyBool_Type
, &from_tty_obj
,
552 &PyBool_Type
, &to_string_obj
))
558 int cmp
= PyObject_IsTrue (from_tty_obj
);
567 int cmp
= PyObject_IsTrue (to_string_obj
);
573 std::string to_string_res
;
575 scoped_restore preventer
= prevent_dont_repeat ();
579 struct interp
*interp
;
581 std::string arg_copy
= arg
;
583 char *save_ptr
= nullptr;
587 const char *result
= strtok_r (first
? &arg_copy
[0] : nullptr,
593 counted_command_line lines
= read_command_lines_1 (reader
, 1, nullptr);
596 scoped_restore save_async
= make_scoped_restore (¤t_ui
->async
,
599 scoped_restore save_uiout
= make_scoped_restore (¤t_uiout
);
601 /* Use the console interpreter uiout to have the same print format
602 for console or MI. */
603 interp
= interp_lookup (current_ui
, "console");
604 current_uiout
= interp
->interp_ui_out ();
607 to_string_res
= execute_control_commands_to_string (lines
.get (),
610 execute_control_commands (lines
.get (), from_tty
);
613 /* Do any commands attached to breakpoint we stopped at. */
614 bpstat_do_actions ();
616 CATCH (except
, RETURN_MASK_ALL
)
618 GDB_PY_HANDLE_EXCEPTION (except
);
623 return PyString_FromString (to_string_res
.c_str ());
627 /* Implementation of Python rbreak command. Take a REGEX and
628 optionally a MINSYMS, THROTTLE and SYMTABS keyword and return a
629 Python list that contains newly set breakpoints that match that
630 criteria. REGEX refers to a GDB format standard regex pattern of
631 symbols names to search; MINSYMS is an optional boolean (default
632 False) that indicates if the function should search GDB's minimal
633 symbols; THROTTLE is an optional integer (default unlimited) that
634 indicates the maximum amount of breakpoints allowable before the
635 function exits (note, if the throttle bound is passed, no
636 breakpoints will be set and a runtime error returned); SYMTABS is
637 an optional Python iterable that contains a set of gdb.Symtabs to
638 constrain the search within. */
641 gdbpy_rbreak (PyObject
*self
, PyObject
*args
, PyObject
*kw
)
643 /* A simple type to ensure clean up of a vector of allocated strings
644 when a C interface demands a const char *array[] type
646 struct symtab_list_type
650 for (const char *elem
: vec
)
651 xfree ((void *) elem
);
653 std::vector
<const char *> vec
;
657 std::vector
<symbol_search
> symbols
;
658 unsigned long count
= 0;
659 PyObject
*symtab_list
= NULL
;
660 PyObject
*minsyms_p_obj
= NULL
;
662 unsigned int throttle
= 0;
663 static const char *keywords
[] = {"regex","minsyms", "throttle",
665 symtab_list_type symtab_paths
;
667 if (!gdb_PyArg_ParseTupleAndKeywords (args
, kw
, "s|O!IO", keywords
,
668 ®ex
, &PyBool_Type
,
669 &minsyms_p_obj
, &throttle
,
673 /* Parse minsyms keyword. */
674 if (minsyms_p_obj
!= NULL
)
676 int cmp
= PyObject_IsTrue (minsyms_p_obj
);
682 /* The "symtabs" keyword is any Python iterable object that returns
683 a gdb.Symtab on each iteration. If specified, iterate through
684 the provided gdb.Symtabs and extract their full path. As
685 python_string_to_target_string returns a
686 gdb::unique_xmalloc_ptr<char> and a vector containing these types
687 cannot be coerced to a const char **p[] via the vector.data call,
688 release the value from the unique_xmalloc_ptr and place it in a
689 simple type symtab_list_type (which holds the vector and a
690 destructor that frees the contents of the allocated strings. */
691 if (symtab_list
!= NULL
)
693 gdbpy_ref
<> iter (PyObject_GetIter (symtab_list
));
700 gdbpy_ref
<> next (PyIter_Next (iter
.get ()));
704 if (PyErr_Occurred ())
709 gdbpy_ref
<> obj_name (PyObject_GetAttrString (next
.get (),
712 if (obj_name
== NULL
)
715 /* Is the object file still valid? */
716 if (obj_name
== Py_None
)
719 gdb::unique_xmalloc_ptr
<char> filename
=
720 python_string_to_target_string (obj_name
.get ());
722 if (filename
== NULL
)
725 /* Make sure there is a definite place to store the value of
726 filename before it is released. */
727 symtab_paths
.vec
.push_back (nullptr);
728 symtab_paths
.vec
.back () = filename
.release ();
734 const char **files
= symtab_paths
.vec
.data ();
736 symbols
= search_symbols (regex
, FUNCTIONS_DOMAIN
, NULL
,
737 symtab_paths
.vec
.size (), files
);
740 symbols
= search_symbols (regex
, FUNCTIONS_DOMAIN
, NULL
, 0, NULL
);
742 /* Count the number of symbols (both symbols and optionally minimal
743 symbols) so we can correctly check the throttle limit. */
744 for (const symbol_search
&p
: symbols
)
746 /* Minimal symbols included? */
749 if (p
.msymbol
.minsym
!= NULL
)
753 if (p
.symbol
!= NULL
)
757 /* Check throttle bounds and exit if in excess. */
758 if (throttle
!= 0 && count
> throttle
)
760 PyErr_SetString (PyExc_RuntimeError
,
761 _("Number of breakpoints exceeds throttled maximum."));
765 gdbpy_ref
<> return_list (PyList_New (0));
767 if (return_list
== NULL
)
770 /* Construct full path names for symbols and call the Python
771 breakpoint constructor on the resulting names. Be tolerant of
772 individual breakpoint failures. */
773 for (const symbol_search
&p
: symbols
)
775 std::string symbol_name
;
777 /* Skipping minimal symbols? */
779 if (p
.msymbol
.minsym
!= NULL
)
782 if (p
.msymbol
.minsym
== NULL
)
784 struct symtab
*symtab
= symbol_symtab (p
.symbol
);
785 const char *fullname
= symtab_to_fullname (symtab
);
787 symbol_name
= fullname
;
789 symbol_name
+= SYMBOL_LINKAGE_NAME (p
.symbol
);
792 symbol_name
= MSYMBOL_LINKAGE_NAME (p
.msymbol
.minsym
);
794 gdbpy_ref
<> argList (Py_BuildValue("(s)", symbol_name
.c_str ()));
795 gdbpy_ref
<> obj (PyObject_CallObject ((PyObject
*)
796 &breakpoint_object_type
,
799 /* Tolerate individual breakpoint failures. */
801 gdbpy_print_stack ();
804 if (PyList_Append (return_list
.get (), obj
.get ()) == -1)
808 return return_list
.release ();
811 /* A Python function which is a wrapper for decode_line_1. */
814 gdbpy_decode_line (PyObject
*self
, PyObject
*args
)
816 const char *arg
= NULL
;
818 gdbpy_ref
<> unparsed
;
819 event_location_up location
;
821 if (! PyArg_ParseTuple (args
, "|s", &arg
))
825 location
= string_to_event_location_basic (&arg
, python_language
,
826 symbol_name_match_type::WILD
);
828 std::vector
<symtab_and_line
> decoded_sals
;
829 symtab_and_line def_sal
;
830 gdb::array_view
<symtab_and_line
> sals
;
833 if (location
!= NULL
)
835 decoded_sals
= decode_line_1 (location
.get (), 0, NULL
, NULL
, 0);
840 set_default_source_symtab_and_line ();
841 def_sal
= get_current_source_symtab_and_line ();
845 CATCH (ex
, RETURN_MASK_ALL
)
847 /* We know this will always throw. */
848 gdbpy_convert_exception (ex
);
855 result
.reset (PyTuple_New (sals
.size ()));
858 for (size_t i
= 0; i
< sals
.size (); ++i
)
860 PyObject
*obj
= symtab_and_line_to_sal_object (sals
[i
]);
864 PyTuple_SetItem (result
.get (), i
, obj
);
868 result
= gdbpy_ref
<>::new_reference (Py_None
);
870 gdbpy_ref
<> return_result (PyTuple_New (2));
871 if (return_result
== NULL
)
874 if (arg
!= NULL
&& strlen (arg
) > 0)
876 unparsed
.reset (PyString_FromString (arg
));
877 if (unparsed
== NULL
)
881 unparsed
= gdbpy_ref
<>::new_reference (Py_None
);
883 PyTuple_SetItem (return_result
.get (), 0, unparsed
.release ());
884 PyTuple_SetItem (return_result
.get (), 1, result
.release ());
886 return return_result
.release ();
889 /* Parse a string and evaluate it as an expression. */
891 gdbpy_parse_and_eval (PyObject
*self
, PyObject
*args
)
893 const char *expr_str
;
894 struct value
*result
= NULL
;
896 if (!PyArg_ParseTuple (args
, "s", &expr_str
))
901 result
= parse_and_eval (expr_str
);
903 CATCH (except
, RETURN_MASK_ALL
)
905 GDB_PY_HANDLE_EXCEPTION (except
);
909 return value_to_value_object (result
);
912 /* Implementation of gdb.invalidate_cached_frames. */
915 gdbpy_invalidate_cached_frames (PyObject
*self
, PyObject
*args
)
917 reinit_frame_cache ();
921 /* Read a file as Python code.
922 This is the extension_language_script_ops.script_sourcer "method".
923 FILE is the file to load. FILENAME is name of the file FILE.
924 This does not throw any errors. If an exception occurs python will print
925 the traceback and clear the error indicator. */
928 gdbpy_source_script (const struct extension_language_defn
*extlang
,
929 FILE *file
, const char *filename
)
931 gdbpy_enter
enter_py (get_current_arch (), current_language
);
932 python_run_simple_file (file
, filename
);
937 /* Posting and handling events. */
939 /* A single event. */
942 /* The Python event. This is just a callable object. */
944 /* The next event. */
945 struct gdbpy_event
*next
;
948 /* All pending events. */
949 static struct gdbpy_event
*gdbpy_event_list
;
950 /* The final link of the event list. */
951 static struct gdbpy_event
**gdbpy_event_list_end
;
953 /* So that we can wake up the main thread even when it is blocked in
955 static struct serial_event
*gdbpy_serial_event
;
957 /* The file handler callback. This reads from the internal pipe, and
958 then processes the Python event queue. This will always be run in
959 the main gdb thread. */
962 gdbpy_run_events (int error
, gdb_client_data client_data
)
964 gdbpy_enter
enter_py (get_current_arch (), current_language
);
966 /* Clear the event fd. Do this before flushing the events list, so
967 that any new event post afterwards is sure to re-awake the event
969 serial_event_clear (gdbpy_serial_event
);
971 while (gdbpy_event_list
)
973 /* Dispatching the event might push a new element onto the event
974 loop, so we update here "atomically enough". */
975 struct gdbpy_event
*item
= gdbpy_event_list
;
976 gdbpy_event_list
= gdbpy_event_list
->next
;
977 if (gdbpy_event_list
== NULL
)
978 gdbpy_event_list_end
= &gdbpy_event_list
;
980 gdbpy_ref
<> call_result (PyObject_CallObject (item
->event
, NULL
));
981 if (call_result
== NULL
)
982 gdbpy_print_stack ();
984 Py_DECREF (item
->event
);
989 /* Submit an event to the gdb thread. */
991 gdbpy_post_event (PyObject
*self
, PyObject
*args
)
993 struct gdbpy_event
*event
;
997 if (!PyArg_ParseTuple (args
, "O", &func
))
1000 if (!PyCallable_Check (func
))
1002 PyErr_SetString (PyExc_RuntimeError
,
1003 _("Posted event is not callable"));
1009 /* From here until the end of the function, we have the GIL, so we
1010 can operate on our global data structures without worrying. */
1011 wakeup
= gdbpy_event_list
== NULL
;
1013 event
= XNEW (struct gdbpy_event
);
1014 event
->event
= func
;
1016 *gdbpy_event_list_end
= event
;
1017 gdbpy_event_list_end
= &event
->next
;
1019 /* Wake up gdb when needed. */
1021 serial_event_set (gdbpy_serial_event
);
1026 /* Initialize the Python event handler. */
1028 gdbpy_initialize_events (void)
1030 gdbpy_event_list_end
= &gdbpy_event_list
;
1032 gdbpy_serial_event
= make_serial_event ();
1033 add_file_handler (serial_event_fd (gdbpy_serial_event
),
1034 gdbpy_run_events
, NULL
);
1041 /* This is the extension_language_ops.before_prompt "method". */
1043 static enum ext_lang_rc
1044 gdbpy_before_prompt_hook (const struct extension_language_defn
*extlang
,
1045 const char *current_gdb_prompt
)
1047 if (!gdb_python_initialized
)
1048 return EXT_LANG_RC_NOP
;
1050 gdbpy_enter
enter_py (get_current_arch (), current_language
);
1052 if (!evregpy_no_listeners_p (gdb_py_events
.before_prompt
)
1053 && evpy_emit_event (NULL
, gdb_py_events
.before_prompt
) < 0)
1054 return EXT_LANG_RC_ERROR
;
1056 if (gdb_python_module
1057 && PyObject_HasAttrString (gdb_python_module
, "prompt_hook"))
1059 gdbpy_ref
<> hook (PyObject_GetAttrString (gdb_python_module
,
1063 gdbpy_print_stack ();
1064 return EXT_LANG_RC_ERROR
;
1067 if (PyCallable_Check (hook
.get ()))
1069 gdbpy_ref
<> current_prompt (PyString_FromString (current_gdb_prompt
));
1070 if (current_prompt
== NULL
)
1072 gdbpy_print_stack ();
1073 return EXT_LANG_RC_ERROR
;
1077 (PyObject_CallFunctionObjArgs (hook
.get (), current_prompt
.get (),
1081 gdbpy_print_stack ();
1082 return EXT_LANG_RC_ERROR
;
1085 /* Return type should be None, or a String. If it is None,
1086 fall through, we will not set a prompt. If it is a
1087 string, set PROMPT. Anything else, set an exception. */
1088 if (result
!= Py_None
&& ! PyString_Check (result
.get ()))
1090 PyErr_Format (PyExc_RuntimeError
,
1091 _("Return from prompt_hook must " \
1092 "be either a Python string, or None"));
1093 gdbpy_print_stack ();
1094 return EXT_LANG_RC_ERROR
;
1097 if (result
!= Py_None
)
1099 gdb::unique_xmalloc_ptr
<char>
1100 prompt (python_string_to_host_string (result
.get ()));
1104 gdbpy_print_stack ();
1105 return EXT_LANG_RC_ERROR
;
1108 set_prompt (prompt
.get ());
1109 return EXT_LANG_RC_OK
;
1114 return EXT_LANG_RC_NOP
;
1121 /* A python function to write a single string using gdb's filtered
1122 output stream . The optional keyword STREAM can be used to write
1123 to a particular stream. The default stream is to gdb_stdout. */
1126 gdbpy_write (PyObject
*self
, PyObject
*args
, PyObject
*kw
)
1129 static const char *keywords
[] = { "text", "stream", NULL
};
1130 int stream_type
= 0;
1132 if (!gdb_PyArg_ParseTupleAndKeywords (args
, kw
, "s|i", keywords
, &arg
,
1138 switch (stream_type
)
1142 fprintf_filtered (gdb_stderr
, "%s", arg
);
1147 fprintf_filtered (gdb_stdlog
, "%s", arg
);
1151 fprintf_filtered (gdb_stdout
, "%s", arg
);
1154 CATCH (except
, RETURN_MASK_ALL
)
1156 GDB_PY_HANDLE_EXCEPTION (except
);
1163 /* A python function to flush a gdb stream. The optional keyword
1164 STREAM can be used to flush a particular stream. The default stream
1168 gdbpy_flush (PyObject
*self
, PyObject
*args
, PyObject
*kw
)
1170 static const char *keywords
[] = { "stream", NULL
};
1171 int stream_type
= 0;
1173 if (!gdb_PyArg_ParseTupleAndKeywords (args
, kw
, "|i", keywords
,
1177 switch (stream_type
)
1181 gdb_flush (gdb_stderr
);
1186 gdb_flush (gdb_stdlog
);
1190 gdb_flush (gdb_stdout
);
1196 /* Return non-zero if print-stack is not "none". */
1199 gdbpy_print_python_errors_p (void)
1201 return gdbpy_should_print_stack
!= python_excp_none
;
1204 /* Print a python exception trace, print just a message, or print
1205 nothing and clear the python exception, depending on
1206 gdbpy_should_print_stack. Only call this if a python exception is
1209 gdbpy_print_stack (void)
1212 /* Print "none", just clear exception. */
1213 if (gdbpy_should_print_stack
== python_excp_none
)
1217 /* Print "full" message and backtrace. */
1218 else if (gdbpy_should_print_stack
== python_excp_full
)
1221 /* PyErr_Print doesn't necessarily end output with a newline.
1222 This works because Python's stdout/stderr is fed through
1228 CATCH (except
, RETURN_MASK_ALL
)
1233 /* Print "message", just error print message. */
1236 gdbpy_err_fetch fetched_error
;
1238 gdb::unique_xmalloc_ptr
<char> msg
= fetched_error
.to_string ();
1239 gdb::unique_xmalloc_ptr
<char> type
;
1240 /* Don't compute TYPE if MSG already indicates that there is an
1243 type
= fetched_error
.type_to_string ();
1247 if (msg
== NULL
|| type
== NULL
)
1249 /* An error occurred computing the string representation of the
1251 fprintf_filtered (gdb_stderr
,
1252 _("Error occurred computing Python error" \
1257 fprintf_filtered (gdb_stderr
, "Python Exception %s %s: \n",
1258 type
.get (), msg
.get ());
1260 CATCH (except
, RETURN_MASK_ALL
)
1267 /* Like gdbpy_print_stack, but if the exception is a
1268 KeyboardException, throw a gdb "quit" instead. */
1271 gdbpy_print_stack_or_quit ()
1273 if (PyErr_ExceptionMatches (PyExc_KeyboardInterrupt
))
1276 throw_quit ("Quit");
1278 gdbpy_print_stack ();
1283 /* Return a sequence holding all the Progspaces. */
1286 gdbpy_progspaces (PyObject
*unused1
, PyObject
*unused2
)
1288 struct program_space
*ps
;
1290 gdbpy_ref
<> list (PyList_New (0));
1296 gdbpy_ref
<> item
= pspace_to_pspace_object (ps
);
1298 if (item
== NULL
|| PyList_Append (list
.get (), item
.get ()) == -1)
1302 return list
.release ();
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 if (!gdb_python_initialized
)
1327 gdbpy_enter
enter_py (get_objfile_arch (objfile
), current_language
);
1328 gdbpy_current_objfile
= objfile
;
1330 python_run_simple_file (file
, filename
);
1332 gdbpy_current_objfile
= NULL
;
1335 /* Set the current objfile to OBJFILE and then execute SCRIPT
1336 as Python code. This does not throw any errors. If an exception
1337 occurs python will print the traceback and clear the error indicator.
1338 This is the extension_language_script_ops.objfile_script_executor
1342 gdbpy_execute_objfile_script (const struct extension_language_defn
*extlang
,
1343 struct objfile
*objfile
, const char *name
,
1346 if (!gdb_python_initialized
)
1349 gdbpy_enter
enter_py (get_objfile_arch (objfile
), current_language
);
1350 gdbpy_current_objfile
= objfile
;
1352 PyRun_SimpleString (script
);
1354 gdbpy_current_objfile
= NULL
;
1357 /* Return the current Objfile, or None if there isn't one. */
1360 gdbpy_get_current_objfile (PyObject
*unused1
, PyObject
*unused2
)
1362 if (! gdbpy_current_objfile
)
1365 return objfile_to_objfile_object (gdbpy_current_objfile
).release ();
1368 /* Compute the list of active python type printers and store them in
1369 EXT_PRINTERS->py_type_printers. The product of this function is used by
1370 gdbpy_apply_type_printers, and freed by gdbpy_free_type_printers.
1371 This is the extension_language_ops.start_type_printers "method". */
1374 gdbpy_start_type_printers (const struct extension_language_defn
*extlang
,
1375 struct ext_lang_type_printers
*ext_printers
)
1377 PyObject
*printers_obj
= NULL
;
1379 if (!gdb_python_initialized
)
1382 gdbpy_enter
enter_py (get_current_arch (), current_language
);
1384 gdbpy_ref
<> type_module (PyImport_ImportModule ("gdb.types"));
1385 if (type_module
== NULL
)
1387 gdbpy_print_stack ();
1391 gdbpy_ref
<> func (PyObject_GetAttrString (type_module
.get (),
1392 "get_type_recognizers"));
1395 gdbpy_print_stack ();
1399 printers_obj
= PyObject_CallFunctionObjArgs (func
.get (), (char *) NULL
);
1400 if (printers_obj
== NULL
)
1401 gdbpy_print_stack ();
1403 ext_printers
->py_type_printers
= printers_obj
;
1406 /* If TYPE is recognized by some type printer, store in *PRETTIED_TYPE
1407 a newly allocated string holding the type's replacement name, and return
1408 EXT_LANG_RC_OK. The caller is responsible for freeing the string.
1409 If there's a Python error return EXT_LANG_RC_ERROR.
1410 Otherwise, return EXT_LANG_RC_NOP.
1411 This is the extension_language_ops.apply_type_printers "method". */
1413 static enum ext_lang_rc
1414 gdbpy_apply_type_printers (const struct extension_language_defn
*extlang
,
1415 const struct ext_lang_type_printers
*ext_printers
,
1416 struct type
*type
, char **prettied_type
)
1418 PyObject
*printers_obj
= (PyObject
*) ext_printers
->py_type_printers
;
1419 gdb::unique_xmalloc_ptr
<char> result
;
1421 if (printers_obj
== NULL
)
1422 return EXT_LANG_RC_NOP
;
1424 if (!gdb_python_initialized
)
1425 return EXT_LANG_RC_NOP
;
1427 gdbpy_enter
enter_py (get_current_arch (), current_language
);
1429 gdbpy_ref
<> type_obj (type_to_type_object (type
));
1430 if (type_obj
== NULL
)
1432 gdbpy_print_stack ();
1433 return EXT_LANG_RC_ERROR
;
1436 gdbpy_ref
<> type_module (PyImport_ImportModule ("gdb.types"));
1437 if (type_module
== NULL
)
1439 gdbpy_print_stack ();
1440 return EXT_LANG_RC_ERROR
;
1443 gdbpy_ref
<> func (PyObject_GetAttrString (type_module
.get (),
1444 "apply_type_recognizers"));
1447 gdbpy_print_stack ();
1448 return EXT_LANG_RC_ERROR
;
1451 gdbpy_ref
<> result_obj (PyObject_CallFunctionObjArgs (func
.get (),
1455 if (result_obj
== NULL
)
1457 gdbpy_print_stack ();
1458 return EXT_LANG_RC_ERROR
;
1461 if (result_obj
== Py_None
)
1462 return EXT_LANG_RC_NOP
;
1464 result
= python_string_to_host_string (result_obj
.get ());
1467 gdbpy_print_stack ();
1468 return EXT_LANG_RC_ERROR
;
1471 *prettied_type
= result
.release ();
1472 return EXT_LANG_RC_OK
;
1475 /* Free the result of start_type_printers.
1476 This is the extension_language_ops.free_type_printers "method". */
1479 gdbpy_free_type_printers (const struct extension_language_defn
*extlang
,
1480 struct ext_lang_type_printers
*ext_printers
)
1482 PyObject
*printers
= (PyObject
*) ext_printers
->py_type_printers
;
1484 if (printers
== NULL
)
1487 if (!gdb_python_initialized
)
1490 gdbpy_enter
enter_py (get_current_arch (), current_language
);
1491 Py_DECREF (printers
);
1494 #else /* HAVE_PYTHON */
1496 /* Dummy implementation of the gdb "python-interactive" and "python"
1500 python_interactive_command (const char *arg
, int from_tty
)
1502 arg
= skip_spaces (arg
);
1504 error (_("Python scripting is not supported in this copy of GDB."));
1507 counted_command_line l
= get_command_line (python_control
, "");
1509 execute_control_command_untraced (l
.get ());
1514 python_command (const char *arg
, int from_tty
)
1516 python_interactive_command (arg
, from_tty
);
1519 #endif /* HAVE_PYTHON */
1523 /* Lists for 'set python' commands. */
1525 static struct cmd_list_element
*user_set_python_list
;
1526 static struct cmd_list_element
*user_show_python_list
;
1528 /* Function for use by 'set python' prefix command. */
1531 user_set_python (const char *args
, int from_tty
)
1533 help_list (user_set_python_list
, "set python ", all_commands
,
1537 /* Function for use by 'show python' prefix command. */
1540 user_show_python (const char *args
, int from_tty
)
1542 cmd_show_list (user_show_python_list
, from_tty
, "");
1545 /* Initialize the Python code. */
1549 /* This is installed as a final cleanup and cleans up the
1550 interpreter. This lets Python's 'atexit' work. */
1553 finalize_python (void *ignore
)
1555 struct active_ext_lang_state
*previous_active
;
1557 /* We don't use ensure_python_env here because if we ever ran the
1558 cleanup, gdb would crash -- because the cleanup calls into the
1559 Python interpreter, which we are about to destroy. It seems
1560 clearer to make the needed calls explicitly here than to create a
1561 cleanup and then mysteriously discard it. */
1563 /* This is only called as a final cleanup so we can assume the active
1564 SIGINT handler is gdb's. We still need to tell it to notify Python. */
1565 previous_active
= set_active_ext_lang (&extension_language_python
);
1567 (void) PyGILState_Ensure ();
1568 python_gdbarch
= target_gdbarch ();
1569 python_language
= current_language
;
1573 restore_active_ext_lang (previous_active
);
1577 /* This is called via the PyImport_AppendInittab mechanism called
1578 during initialization, to make the built-in _gdb module known to
1581 init__gdb_module (void)
1583 return PyModule_Create (&python_GdbModuleDef
);
1588 do_start_initialization ()
1591 size_t progsize
, count
;
1592 wchar_t *progname_copy
;
1595 #ifdef WITH_PYTHON_PATH
1596 /* Work around problem where python gets confused about where it is,
1597 and then can't find its libraries, etc.
1598 NOTE: Python assumes the following layout:
1600 /foo/lib/pythonX.Y/...
1601 This must be done before calling Py_Initialize. */
1602 gdb::unique_xmalloc_ptr
<char> progname
1603 (concat (ldirname (python_libdir
).c_str (), SLASH_STRING
, "bin",
1604 SLASH_STRING
, "python", (char *) NULL
));
1606 std::string oldloc
= setlocale (LC_ALL
, NULL
);
1607 setlocale (LC_ALL
, "");
1608 progsize
= strlen (progname
.get ());
1609 progname_copy
= (wchar_t *) PyMem_Malloc ((progsize
+ 1) * sizeof (wchar_t));
1612 fprintf (stderr
, "out of memory\n");
1615 count
= mbstowcs (progname_copy
, progname
.get (), progsize
+ 1);
1616 if (count
== (size_t) -1)
1618 fprintf (stderr
, "Could not convert python path to string\n");
1621 setlocale (LC_ALL
, oldloc
.c_str ());
1623 /* Note that Py_SetProgramName expects the string it is passed to
1624 remain alive for the duration of the program's execution, so
1625 it is not freed after this call. */
1626 Py_SetProgramName (progname_copy
);
1628 /* Define _gdb as a built-in module. */
1629 PyImport_AppendInittab ("_gdb", init__gdb_module
);
1631 Py_SetProgramName (progname
.release ());
1636 PyEval_InitThreads ();
1639 gdb_module
= PyImport_ImportModule ("_gdb");
1641 gdb_module
= Py_InitModule ("_gdb", python_GdbMethods
);
1643 if (gdb_module
== NULL
)
1646 /* The casts to (char*) are for python 2.4. */
1647 if (PyModule_AddStringConstant (gdb_module
, "VERSION", (char*) version
) < 0
1648 || PyModule_AddStringConstant (gdb_module
, "HOST_CONFIG",
1649 (char*) host_name
) < 0
1650 || PyModule_AddStringConstant (gdb_module
, "TARGET_CONFIG",
1651 (char*) target_name
) < 0)
1654 /* Add stream constants. */
1655 if (PyModule_AddIntConstant (gdb_module
, "STDOUT", 0) < 0
1656 || PyModule_AddIntConstant (gdb_module
, "STDERR", 1) < 0
1657 || PyModule_AddIntConstant (gdb_module
, "STDLOG", 2) < 0)
1660 gdbpy_gdb_error
= PyErr_NewException ("gdb.error", PyExc_RuntimeError
, NULL
);
1661 if (gdbpy_gdb_error
== NULL
1662 || gdb_pymodule_addobject (gdb_module
, "error", gdbpy_gdb_error
) < 0)
1665 gdbpy_gdb_memory_error
= PyErr_NewException ("gdb.MemoryError",
1666 gdbpy_gdb_error
, NULL
);
1667 if (gdbpy_gdb_memory_error
== NULL
1668 || gdb_pymodule_addobject (gdb_module
, "MemoryError",
1669 gdbpy_gdb_memory_error
) < 0)
1672 gdbpy_gdberror_exc
= PyErr_NewException ("gdb.GdbError", NULL
, NULL
);
1673 if (gdbpy_gdberror_exc
== NULL
1674 || gdb_pymodule_addobject (gdb_module
, "GdbError",
1675 gdbpy_gdberror_exc
) < 0)
1678 gdbpy_initialize_gdb_readline ();
1680 if (gdbpy_initialize_auto_load () < 0
1681 || gdbpy_initialize_values () < 0
1682 || gdbpy_initialize_frames () < 0
1683 || gdbpy_initialize_commands () < 0
1684 || gdbpy_initialize_instruction () < 0
1685 || gdbpy_initialize_record () < 0
1686 || gdbpy_initialize_btrace () < 0
1687 || gdbpy_initialize_symbols () < 0
1688 || gdbpy_initialize_symtabs () < 0
1689 || gdbpy_initialize_blocks () < 0
1690 || gdbpy_initialize_functions () < 0
1691 || gdbpy_initialize_parameters () < 0
1692 || gdbpy_initialize_types () < 0
1693 || gdbpy_initialize_pspace () < 0
1694 || gdbpy_initialize_objfile () < 0
1695 || gdbpy_initialize_breakpoints () < 0
1696 || gdbpy_initialize_finishbreakpoints () < 0
1697 || gdbpy_initialize_lazy_string () < 0
1698 || gdbpy_initialize_linetable () < 0
1699 || gdbpy_initialize_thread () < 0
1700 || gdbpy_initialize_inferior () < 0
1701 || gdbpy_initialize_events () < 0
1702 || gdbpy_initialize_eventregistry () < 0
1703 || gdbpy_initialize_py_events () < 0
1704 || gdbpy_initialize_event () < 0
1705 || gdbpy_initialize_arch () < 0
1706 || gdbpy_initialize_xmethods () < 0
1707 || gdbpy_initialize_unwind () < 0)
1710 #define GDB_PY_DEFINE_EVENT_TYPE(name, py_name, doc, base) \
1711 if (gdbpy_initialize_event_generic (&name##_event_object_type, py_name) < 0) \
1713 #include "py-event-types.def"
1714 #undef GDB_PY_DEFINE_EVENT_TYPE
1716 gdbpy_to_string_cst
= PyString_FromString ("to_string");
1717 if (gdbpy_to_string_cst
== NULL
)
1719 gdbpy_children_cst
= PyString_FromString ("children");
1720 if (gdbpy_children_cst
== NULL
)
1722 gdbpy_display_hint_cst
= PyString_FromString ("display_hint");
1723 if (gdbpy_display_hint_cst
== NULL
)
1725 gdbpy_doc_cst
= PyString_FromString ("__doc__");
1726 if (gdbpy_doc_cst
== NULL
)
1728 gdbpy_enabled_cst
= PyString_FromString ("enabled");
1729 if (gdbpy_enabled_cst
== NULL
)
1731 gdbpy_value_cst
= PyString_FromString ("value");
1732 if (gdbpy_value_cst
== NULL
)
1735 /* Release the GIL while gdb runs. */
1736 PyThreadState_Swap (NULL
);
1737 PyEval_ReleaseLock ();
1739 make_final_cleanup (finalize_python
, NULL
);
1741 /* Only set this when initialization has succeeded. */
1742 gdb_python_initialized
= 1;
1746 #endif /* HAVE_PYTHON */
1749 cmd_list_element
*python_cmd_element
= nullptr;
1752 _initialize_python (void)
1754 add_com ("python-interactive", class_obscure
,
1755 python_interactive_command
,
1758 Start an interactive Python prompt.\n\
1760 To return to GDB, type the EOF character (e.g., Ctrl-D on an empty\n\
1763 Alternatively, a single-line Python command can be given as an\n\
1764 argument, and if the command is an expression, the result will be\n\
1765 printed. For example:\n\
1767 (gdb) python-interactive 2 + 3\n\
1770 #else /* HAVE_PYTHON */
1772 Start a Python interactive prompt.\n\
1774 Python scripting is not supported in this copy of GDB.\n\
1775 This command is only a placeholder.")
1776 #endif /* HAVE_PYTHON */
1778 add_com_alias ("pi", "python-interactive", class_obscure
, 1);
1780 python_cmd_element
= add_com ("python", class_obscure
, python_command
,
1783 Evaluate a Python command.\n\
1785 The command can be given as an argument, for instance:\n\
1787 python print (23)\n\
1789 If no argument is given, the following lines are read and used\n\
1790 as the Python commands. Type a line containing \"end\" to indicate\n\
1791 the end of the command.")
1792 #else /* HAVE_PYTHON */
1794 Evaluate a Python command.\n\
1796 Python scripting is not supported in this copy of GDB.\n\
1797 This command is only a placeholder.")
1798 #endif /* HAVE_PYTHON */
1800 add_com_alias ("py", "python", class_obscure
, 1);
1802 /* Add set/show python print-stack. */
1803 add_prefix_cmd ("python", no_class
, user_show_python
,
1804 _("Prefix command for python preference settings."),
1805 &user_show_python_list
, "show python ", 0,
1808 add_prefix_cmd ("python", no_class
, user_set_python
,
1809 _("Prefix command for python preference settings."),
1810 &user_set_python_list
, "set python ", 0,
1813 add_setshow_enum_cmd ("print-stack", no_class
, python_excp_enums
,
1814 &gdbpy_should_print_stack
, _("\
1815 Set mode for Python stack dump on error."), _("\
1816 Show the mode of Python stack printing on error."), _("\
1817 none == no stack or message will be printed.\n\
1818 full == a message and a stack will be printed.\n\
1819 message == an error message without a stack will be printed."),
1821 &user_set_python_list
,
1822 &user_show_python_list
);
1825 if (!do_start_initialization () && PyErr_Occurred ())
1826 gdbpy_print_stack ();
1827 #endif /* HAVE_PYTHON */
1832 /* Helper function for gdbpy_finish_initialization. This does the
1833 work and then returns false if an error has occurred and must be
1834 displayed, or true on success. */
1837 do_finish_initialization (const struct extension_language_defn
*extlang
)
1842 /* Add the initial data-directory to sys.path. */
1844 std::string gdb_pythondir
= (std::string (gdb_datadir
) + SLASH_STRING
1847 sys_path
= PySys_GetObject ("path");
1849 /* If sys.path is not defined yet, define it first. */
1850 if (!(sys_path
&& PyList_Check (sys_path
)))
1853 PySys_SetPath (L
"");
1857 sys_path
= PySys_GetObject ("path");
1859 if (sys_path
&& PyList_Check (sys_path
))
1861 gdbpy_ref
<> pythondir (PyString_FromString (gdb_pythondir
.c_str ()));
1862 if (pythondir
== NULL
|| PyList_Insert (sys_path
, 0, pythondir
.get ()))
1868 /* Import the gdb module to finish the initialization, and
1869 add it to __main__ for convenience. */
1870 m
= PyImport_AddModule ("__main__");
1874 /* Keep the reference to gdb_python_module since it is in a global
1876 gdb_python_module
= PyImport_ImportModule ("gdb");
1877 if (gdb_python_module
== NULL
)
1879 gdbpy_print_stack ();
1880 /* This is passed in one call to warning so that blank lines aren't
1881 inserted between each line of text. */
1883 "Could not load the Python gdb module from `%s'.\n"
1884 "Limited Python support is available from the _gdb module.\n"
1885 "Suggest passing --data-directory=/path/to/gdb/data-directory.\n"),
1886 gdb_pythondir
.c_str ());
1887 /* We return "success" here as we've already emitted the
1892 return gdb_pymodule_addobject (m
, "gdb", gdb_python_module
) >= 0;
1895 /* Perform the remaining python initializations.
1896 These must be done after GDB is at least mostly initialized.
1897 E.g., The "info pretty-printer" command needs the "info" prefix
1899 This is the extension_language_ops.finish_initialization "method". */
1902 gdbpy_finish_initialization (const struct extension_language_defn
*extlang
)
1904 gdbpy_enter
enter_py (get_current_arch (), current_language
);
1906 if (!do_finish_initialization (extlang
))
1908 gdbpy_print_stack ();
1909 warning (_("internal error: Unhandled Python exception"));
1913 /* Return non-zero if Python has successfully initialized.
1914 This is the extension_languages_ops.initialized "method". */
1917 gdbpy_initialized (const struct extension_language_defn
*extlang
)
1919 return gdb_python_initialized
;
1922 #endif /* HAVE_PYTHON */
1928 PyMethodDef python_GdbMethods
[] =
1930 { "history", gdbpy_history
, METH_VARARGS
,
1931 "Get a value from history" },
1932 { "execute", (PyCFunction
) execute_gdb_command
, METH_VARARGS
| METH_KEYWORDS
,
1933 "execute (command [, from_tty] [, to_string]) -> [String]\n\
1934 Evaluate command, a string, as a gdb CLI command. Optionally returns\n\
1935 a Python String containing the output of the command if to_string is\n\
1937 { "parameter", gdbpy_parameter
, METH_VARARGS
,
1938 "Return a gdb parameter's value" },
1940 { "breakpoints", gdbpy_breakpoints
, METH_NOARGS
,
1941 "Return a tuple of all breakpoint objects" },
1943 { "default_visualizer", gdbpy_default_visualizer
, METH_VARARGS
,
1944 "Find the default visualizer for a Value." },
1946 { "progspaces", gdbpy_progspaces
, METH_NOARGS
,
1947 "Return a sequence of all progspaces." },
1949 { "current_objfile", gdbpy_get_current_objfile
, METH_NOARGS
,
1950 "Return the current Objfile being loaded, or None." },
1952 { "newest_frame", gdbpy_newest_frame
, METH_NOARGS
,
1953 "newest_frame () -> gdb.Frame.\n\
1954 Return the newest frame object." },
1955 { "selected_frame", gdbpy_selected_frame
, METH_NOARGS
,
1956 "selected_frame () -> gdb.Frame.\n\
1957 Return the selected frame object." },
1958 { "frame_stop_reason_string", gdbpy_frame_stop_reason_string
, METH_VARARGS
,
1959 "stop_reason_string (Integer) -> String.\n\
1960 Return a string explaining unwind stop reason." },
1962 { "start_recording", gdbpy_start_recording
, METH_VARARGS
,
1963 "start_recording ([method] [, format]) -> gdb.Record.\n\
1964 Start recording with the given method. If no method is given, will fall back\n\
1965 to the system default method. If no format is given, will fall back to the\n\
1966 default format for the given method."},
1967 { "current_recording", gdbpy_current_recording
, METH_NOARGS
,
1968 "current_recording () -> gdb.Record.\n\
1969 Return current recording object." },
1970 { "stop_recording", gdbpy_stop_recording
, METH_NOARGS
,
1971 "stop_recording () -> None.\n\
1972 Stop current recording." },
1974 { "lookup_type", (PyCFunction
) gdbpy_lookup_type
,
1975 METH_VARARGS
| METH_KEYWORDS
,
1976 "lookup_type (name [, block]) -> type\n\
1977 Return a Type corresponding to the given name." },
1978 { "lookup_symbol", (PyCFunction
) gdbpy_lookup_symbol
,
1979 METH_VARARGS
| METH_KEYWORDS
,
1980 "lookup_symbol (name [, block] [, domain]) -> (symbol, is_field_of_this)\n\
1981 Return a tuple with the symbol corresponding to the given name (or None) and\n\
1982 a boolean indicating if name is a field of the current implied argument\n\
1983 `this' (when the current language is object-oriented)." },
1984 { "lookup_global_symbol", (PyCFunction
) gdbpy_lookup_global_symbol
,
1985 METH_VARARGS
| METH_KEYWORDS
,
1986 "lookup_global_symbol (name [, domain]) -> symbol\n\
1987 Return the symbol corresponding to the given name (or None)." },
1989 { "lookup_objfile", (PyCFunction
) gdbpy_lookup_objfile
,
1990 METH_VARARGS
| METH_KEYWORDS
,
1991 "lookup_objfile (name, [by_build_id]) -> objfile\n\
1992 Look up the specified objfile.\n\
1993 If by_build_id is True, the objfile is looked up by using name\n\
1994 as its build id." },
1996 { "decode_line", gdbpy_decode_line
, METH_VARARGS
,
1997 "decode_line (String) -> Tuple. Decode a string argument the way\n\
1998 that 'break' or 'edit' does. Return a tuple containing two elements.\n\
1999 The first element contains any unparsed portion of the String parameter\n\
2000 (or None if the string was fully parsed). The second element contains\n\
2001 a tuple that contains all the locations that match, represented as\n\
2002 gdb.Symtab_and_line objects (or None)."},
2003 { "parse_and_eval", gdbpy_parse_and_eval
, METH_VARARGS
,
2004 "parse_and_eval (String) -> Value.\n\
2005 Parse String as an expression, evaluate it, and return the result as a Value."
2008 { "post_event", gdbpy_post_event
, METH_VARARGS
,
2009 "Post an event into gdb's event loop." },
2011 { "target_charset", gdbpy_target_charset
, METH_NOARGS
,
2012 "target_charset () -> string.\n\
2013 Return the name of the current target charset." },
2014 { "target_wide_charset", gdbpy_target_wide_charset
, METH_NOARGS
,
2015 "target_wide_charset () -> string.\n\
2016 Return the name of the current target wide charset." },
2017 { "rbreak", (PyCFunction
) gdbpy_rbreak
, METH_VARARGS
| METH_KEYWORDS
,
2018 "rbreak (Regex) -> List.\n\
2019 Return a Tuple containing gdb.Breakpoint objects that match the given Regex." },
2020 { "string_to_argv", gdbpy_string_to_argv
, METH_VARARGS
,
2021 "string_to_argv (String) -> Array.\n\
2022 Parse String and return an argv-like array.\n\
2023 Arguments are separate by spaces and may be quoted."
2025 { "write", (PyCFunction
)gdbpy_write
, METH_VARARGS
| METH_KEYWORDS
,
2026 "Write a string using gdb's filtered stream." },
2027 { "flush", (PyCFunction
)gdbpy_flush
, METH_VARARGS
| METH_KEYWORDS
,
2028 "Flush gdb's filtered stdout stream." },
2029 { "selected_thread", gdbpy_selected_thread
, METH_NOARGS
,
2030 "selected_thread () -> gdb.InferiorThread.\n\
2031 Return the selected thread object." },
2032 { "selected_inferior", gdbpy_selected_inferior
, METH_NOARGS
,
2033 "selected_inferior () -> gdb.Inferior.\n\
2034 Return the selected inferior object." },
2035 { "inferiors", gdbpy_inferiors
, METH_NOARGS
,
2036 "inferiors () -> (gdb.Inferior, ...).\n\
2037 Return a tuple containing all inferiors." },
2039 { "invalidate_cached_frames", gdbpy_invalidate_cached_frames
, METH_NOARGS
,
2040 "invalidate_cached_frames () -> None.\n\
2041 Invalidate any cached frame objects in gdb.\n\
2042 Intended for internal use only." },
2044 { "convenience_variable", gdbpy_convenience_variable
, METH_VARARGS
,
2045 "convenience_variable (NAME) -> value.\n\
2046 Return the value of the convenience variable $NAME,\n\
2047 or None if not set." },
2048 { "set_convenience_variable", gdbpy_set_convenience_variable
, METH_VARARGS
,
2049 "convenience_variable (NAME, VALUE) -> None.\n\
2050 Set the value of the convenience variable $NAME." },
2052 {NULL
, NULL
, 0, NULL
}
2056 struct PyModuleDef python_GdbModuleDef
=
2058 PyModuleDef_HEAD_INIT
,
2070 /* Define all the event objects. */
2071 #define GDB_PY_DEFINE_EVENT_TYPE(name, py_name, doc, base) \
2072 PyTypeObject name##_event_object_type \
2073 CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("event_object") \
2075 PyVarObject_HEAD_INIT (NULL, 0) \
2076 "gdb." py_name, /* tp_name */ \
2077 sizeof (event_object), /* tp_basicsize */ \
2078 0, /* tp_itemsize */ \
2079 evpy_dealloc, /* tp_dealloc */ \
2081 0, /* tp_getattr */ \
2082 0, /* tp_setattr */ \
2083 0, /* tp_compare */ \
2085 0, /* tp_as_number */ \
2086 0, /* tp_as_sequence */ \
2087 0, /* tp_as_mapping */ \
2091 0, /* tp_getattro */ \
2092 0, /* tp_setattro */ \
2093 0, /* tp_as_buffer */ \
2094 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */ \
2096 0, /* tp_traverse */ \
2098 0, /* tp_richcompare */ \
2099 0, /* tp_weaklistoffset */ \
2101 0, /* tp_iternext */ \
2102 0, /* tp_methods */ \
2103 0, /* tp_members */ \
2104 0, /* tp_getset */ \
2105 &base, /* tp_base */ \
2107 0, /* tp_descr_get */ \
2108 0, /* tp_descr_set */ \
2109 0, /* tp_dictoffset */ \
2113 #include "py-event-types.def"
2114 #undef GDB_PY_DEFINE_EVENT_TYPE
2116 #endif /* HAVE_PYTHON */