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_count
!= 1)
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]);
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 command_line_up 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 scoped_restore save_async
= make_scoped_restore (¤t_ui
->async
, 0);
593 scoped_restore save_uiout
= make_scoped_restore (¤t_uiout
);
595 /* Use the console interpreter uiout to have the same print format
596 for console or MI. */
597 interp
= interp_lookup (current_ui
, "console");
598 current_uiout
= interp_ui_out (interp
);
600 scoped_restore preventer
= prevent_dont_repeat ();
602 to_string_res
= execute_command_to_string (arg
, from_tty
);
604 execute_command (arg
, from_tty
);
606 CATCH (except
, RETURN_MASK_ALL
)
608 GDB_PY_HANDLE_EXCEPTION (except
);
612 /* Do any commands attached to breakpoint we stopped at. */
613 bpstat_do_actions ();
616 return PyString_FromString (to_string_res
.c_str ());
620 /* Implementation of gdb.solib_name (Long) -> String.
621 Returns the name of the shared library holding a given address, or None. */
624 gdbpy_solib_name (PyObject
*self
, PyObject
*args
)
630 if (!PyArg_ParseTuple (args
, GDB_PY_LLU_ARG
, &pc
))
633 soname
= solib_name_from_address (current_program_space
, pc
);
635 str_obj
= host_string_to_python_string (soname
);
645 /* Implementation of Python rbreak command. Take a REGEX and
646 optionally a MINSYMS, THROTTLE and SYMTABS keyword and return a
647 Python list that contains newly set breakpoints that match that
648 criteria. REGEX refers to a GDB format standard regex pattern of
649 symbols names to search; MINSYMS is an optional boolean (default
650 False) that indicates if the function should search GDB's minimal
651 symbols; THROTTLE is an optional integer (default unlimited) that
652 indicates the maximum amount of breakpoints allowable before the
653 function exits (note, if the throttle bound is passed, no
654 breakpoints will be set and a runtime error returned); SYMTABS is
655 an optional Python iterable that contains a set of gdb.Symtabs to
656 constrain the search within. */
659 gdbpy_rbreak (PyObject
*self
, PyObject
*args
, PyObject
*kw
)
661 /* A simple type to ensure clean up of a vector of allocated strings
662 when a C interface demands a const char *array[] type
664 struct symtab_list_type
668 for (const char *elem
: vec
)
669 xfree ((void *) elem
);
671 std::vector
<const char *> vec
;
675 std::vector
<symbol_search
> symbols
;
676 unsigned long count
= 0;
677 PyObject
*symtab_list
= NULL
;
678 PyObject
*minsyms_p_obj
= NULL
;
680 unsigned int throttle
= 0;
681 static const char *keywords
[] = {"regex","minsyms", "throttle",
683 symtab_list_type symtab_paths
;
685 if (!gdb_PyArg_ParseTupleAndKeywords (args
, kw
, "s|O!IO", keywords
,
686 ®ex
, &PyBool_Type
,
687 &minsyms_p_obj
, &throttle
,
691 /* Parse minsyms keyword. */
692 if (minsyms_p_obj
!= NULL
)
694 int cmp
= PyObject_IsTrue (minsyms_p_obj
);
700 /* The "symtabs" keyword is any Python iterable object that returns
701 a gdb.Symtab on each iteration. If specified, iterate through
702 the provided gdb.Symtabs and extract their full path. As
703 python_string_to_target_string returns a
704 gdb::unique_xmalloc_ptr<char> and a vector containing these types
705 cannot be coerced to a const char **p[] via the vector.data call,
706 release the value from the unique_xmalloc_ptr and place it in a
707 simple type symtab_list_type (which holds the vector and a
708 destructor that frees the contents of the allocated strings. */
709 if (symtab_list
!= NULL
)
711 gdbpy_ref
<> iter (PyObject_GetIter (symtab_list
));
718 gdbpy_ref
<> next (PyIter_Next (iter
.get ()));
722 if (PyErr_Occurred ())
727 gdbpy_ref
<> obj_name (PyObject_GetAttrString (next
.get (),
730 if (obj_name
== NULL
)
733 /* Is the object file still valid? */
734 if (obj_name
== Py_None
)
737 gdb::unique_xmalloc_ptr
<char> filename
=
738 python_string_to_target_string (obj_name
.get ());
740 if (filename
== NULL
)
743 /* Make sure there is a definite place to store the value of
744 filename before it is released. */
745 symtab_paths
.vec
.push_back (nullptr);
746 symtab_paths
.vec
.back () = filename
.release ();
752 const char **files
= symtab_paths
.vec
.data ();
754 symbols
= search_symbols (regex
, FUNCTIONS_DOMAIN
,
755 symtab_paths
.vec
.size (), files
);
758 symbols
= search_symbols (regex
, FUNCTIONS_DOMAIN
, 0, NULL
);
760 /* Count the number of symbols (both symbols and optionally minimal
761 symbols) so we can correctly check the throttle limit. */
762 for (const symbol_search
&p
: symbols
)
764 /* Minimal symbols included? */
767 if (p
.msymbol
.minsym
!= NULL
)
771 if (p
.symbol
!= NULL
)
775 /* Check throttle bounds and exit if in excess. */
776 if (throttle
!= 0 && count
> throttle
)
778 PyErr_SetString (PyExc_RuntimeError
,
779 _("Number of breakpoints exceeds throttled maximum."));
783 gdbpy_ref
<> return_list (PyList_New (0));
785 if (return_list
== NULL
)
788 /* Construct full path names for symbols and call the Python
789 breakpoint constructor on the resulting names. Be tolerant of
790 individual breakpoint failures. */
791 for (const symbol_search
&p
: symbols
)
793 std::string symbol_name
;
795 /* Skipping minimal symbols? */
797 if (p
.msymbol
.minsym
!= NULL
)
800 if (p
.msymbol
.minsym
== NULL
)
802 struct symtab
*symtab
= symbol_symtab (p
.symbol
);
803 const char *fullname
= symtab_to_fullname (symtab
);
805 symbol_name
= fullname
;
807 symbol_name
+= SYMBOL_LINKAGE_NAME (p
.symbol
);
810 symbol_name
= MSYMBOL_LINKAGE_NAME (p
.msymbol
.minsym
);
812 gdbpy_ref
<> argList (Py_BuildValue("(s)", symbol_name
.c_str ()));
813 gdbpy_ref
<> obj (PyObject_CallObject ((PyObject
*)
814 &breakpoint_object_type
,
817 /* Tolerate individual breakpoint failures. */
819 gdbpy_print_stack ();
822 if (PyList_Append (return_list
.get (), obj
.get ()) == -1)
826 return return_list
.release ();
829 /* A Python function which is a wrapper for decode_line_1. */
832 gdbpy_decode_line (PyObject
*self
, PyObject
*args
)
834 const char *arg
= NULL
;
836 gdbpy_ref
<> unparsed
;
837 event_location_up location
;
839 if (! PyArg_ParseTuple (args
, "|s", &arg
))
843 location
= string_to_event_location_basic (&arg
, python_language
,
844 symbol_name_match_type::WILD
);
846 std::vector
<symtab_and_line
> decoded_sals
;
847 symtab_and_line def_sal
;
848 gdb::array_view
<symtab_and_line
> sals
;
851 if (location
!= NULL
)
853 decoded_sals
= decode_line_1 (location
.get (), 0, NULL
, NULL
, 0);
858 set_default_source_symtab_and_line ();
859 def_sal
= get_current_source_symtab_and_line ();
863 CATCH (ex
, RETURN_MASK_ALL
)
865 /* We know this will always throw. */
866 gdbpy_convert_exception (ex
);
873 result
.reset (PyTuple_New (sals
.size ()));
876 for (size_t i
= 0; i
< sals
.size (); ++i
)
878 PyObject
*obj
= symtab_and_line_to_sal_object (sals
[i
]);
882 PyTuple_SetItem (result
.get (), i
, obj
);
886 result
= gdbpy_ref
<>::new_reference (Py_None
);
888 gdbpy_ref
<> return_result (PyTuple_New (2));
889 if (return_result
== NULL
)
892 if (arg
!= NULL
&& strlen (arg
) > 0)
894 unparsed
.reset (PyString_FromString (arg
));
895 if (unparsed
== NULL
)
899 unparsed
= gdbpy_ref
<>::new_reference (Py_None
);
901 PyTuple_SetItem (return_result
.get (), 0, unparsed
.release ());
902 PyTuple_SetItem (return_result
.get (), 1, result
.release ());
904 return return_result
.release ();
907 /* Parse a string and evaluate it as an expression. */
909 gdbpy_parse_and_eval (PyObject
*self
, PyObject
*args
)
911 const char *expr_str
;
912 struct value
*result
= NULL
;
914 if (!PyArg_ParseTuple (args
, "s", &expr_str
))
919 result
= parse_and_eval (expr_str
);
921 CATCH (except
, RETURN_MASK_ALL
)
923 GDB_PY_HANDLE_EXCEPTION (except
);
927 return value_to_value_object (result
);
930 /* Implementation of gdb.find_pc_line function.
931 Returns the gdb.Symtab_and_line object corresponding to a PC value. */
934 gdbpy_find_pc_line (PyObject
*self
, PyObject
*args
)
936 gdb_py_ulongest pc_llu
;
937 PyObject
*result
= NULL
; /* init for gcc -Wall */
939 if (!PyArg_ParseTuple (args
, GDB_PY_LLU_ARG
, &pc_llu
))
944 struct symtab_and_line sal
;
947 pc
= (CORE_ADDR
) pc_llu
;
948 sal
= find_pc_line (pc
, 0);
949 result
= symtab_and_line_to_sal_object (sal
);
951 CATCH (except
, RETURN_MASK_ALL
)
953 GDB_PY_HANDLE_EXCEPTION (except
);
960 /* Implementation of gdb.invalidate_cached_frames. */
963 gdbpy_invalidate_cached_frames (PyObject
*self
, PyObject
*args
)
965 reinit_frame_cache ();
969 /* Read a file as Python code.
970 This is the extension_language_script_ops.script_sourcer "method".
971 FILE is the file to load. FILENAME is name of the file FILE.
972 This does not throw any errors. If an exception occurs python will print
973 the traceback and clear the error indicator. */
976 gdbpy_source_script (const struct extension_language_defn
*extlang
,
977 FILE *file
, const char *filename
)
979 gdbpy_enter
enter_py (get_current_arch (), current_language
);
980 python_run_simple_file (file
, filename
);
985 /* Posting and handling events. */
987 /* A single event. */
990 /* The Python event. This is just a callable object. */
992 /* The next event. */
993 struct gdbpy_event
*next
;
996 /* All pending events. */
997 static struct gdbpy_event
*gdbpy_event_list
;
998 /* The final link of the event list. */
999 static struct gdbpy_event
**gdbpy_event_list_end
;
1001 /* So that we can wake up the main thread even when it is blocked in
1003 static struct serial_event
*gdbpy_serial_event
;
1005 /* The file handler callback. This reads from the internal pipe, and
1006 then processes the Python event queue. This will always be run in
1007 the main gdb thread. */
1010 gdbpy_run_events (int error
, gdb_client_data client_data
)
1012 gdbpy_enter
enter_py (get_current_arch (), current_language
);
1014 /* Clear the event fd. Do this before flushing the events list, so
1015 that any new event post afterwards is sure to re-awake the event
1017 serial_event_clear (gdbpy_serial_event
);
1019 while (gdbpy_event_list
)
1021 /* Dispatching the event might push a new element onto the event
1022 loop, so we update here "atomically enough". */
1023 struct gdbpy_event
*item
= gdbpy_event_list
;
1024 gdbpy_event_list
= gdbpy_event_list
->next
;
1025 if (gdbpy_event_list
== NULL
)
1026 gdbpy_event_list_end
= &gdbpy_event_list
;
1028 /* Ignore errors. */
1029 gdbpy_ref
<> call_result (PyObject_CallObject (item
->event
, NULL
));
1030 if (call_result
== NULL
)
1033 Py_DECREF (item
->event
);
1038 /* Submit an event to the gdb thread. */
1040 gdbpy_post_event (PyObject
*self
, PyObject
*args
)
1042 struct gdbpy_event
*event
;
1046 if (!PyArg_ParseTuple (args
, "O", &func
))
1049 if (!PyCallable_Check (func
))
1051 PyErr_SetString (PyExc_RuntimeError
,
1052 _("Posted event is not callable"));
1058 /* From here until the end of the function, we have the GIL, so we
1059 can operate on our global data structures without worrying. */
1060 wakeup
= gdbpy_event_list
== NULL
;
1062 event
= XNEW (struct gdbpy_event
);
1063 event
->event
= func
;
1065 *gdbpy_event_list_end
= event
;
1066 gdbpy_event_list_end
= &event
->next
;
1068 /* Wake up gdb when needed. */
1070 serial_event_set (gdbpy_serial_event
);
1075 /* Initialize the Python event handler. */
1077 gdbpy_initialize_events (void)
1079 gdbpy_event_list_end
= &gdbpy_event_list
;
1081 gdbpy_serial_event
= make_serial_event ();
1082 add_file_handler (serial_event_fd (gdbpy_serial_event
),
1083 gdbpy_run_events
, NULL
);
1090 /* This is the extension_language_ops.before_prompt "method". */
1092 static enum ext_lang_rc
1093 gdbpy_before_prompt_hook (const struct extension_language_defn
*extlang
,
1094 const char *current_gdb_prompt
)
1096 if (!gdb_python_initialized
)
1097 return EXT_LANG_RC_NOP
;
1099 gdbpy_enter
enter_py (get_current_arch (), current_language
);
1101 if (!evregpy_no_listeners_p (gdb_py_events
.before_prompt
)
1102 && evpy_emit_event (NULL
, gdb_py_events
.before_prompt
) < 0)
1103 return EXT_LANG_RC_ERROR
;
1105 if (gdb_python_module
1106 && PyObject_HasAttrString (gdb_python_module
, "prompt_hook"))
1108 gdbpy_ref
<> hook (PyObject_GetAttrString (gdb_python_module
,
1112 gdbpy_print_stack ();
1113 return EXT_LANG_RC_ERROR
;
1116 if (PyCallable_Check (hook
.get ()))
1118 gdbpy_ref
<> current_prompt (PyString_FromString (current_gdb_prompt
));
1119 if (current_prompt
== NULL
)
1121 gdbpy_print_stack ();
1122 return EXT_LANG_RC_ERROR
;
1126 (PyObject_CallFunctionObjArgs (hook
.get (), current_prompt
.get (),
1130 gdbpy_print_stack ();
1131 return EXT_LANG_RC_ERROR
;
1134 /* Return type should be None, or a String. If it is None,
1135 fall through, we will not set a prompt. If it is a
1136 string, set PROMPT. Anything else, set an exception. */
1137 if (result
!= Py_None
&& ! PyString_Check (result
.get ()))
1139 PyErr_Format (PyExc_RuntimeError
,
1140 _("Return from prompt_hook must " \
1141 "be either a Python string, or None"));
1142 gdbpy_print_stack ();
1143 return EXT_LANG_RC_ERROR
;
1146 if (result
!= Py_None
)
1148 gdb::unique_xmalloc_ptr
<char>
1149 prompt (python_string_to_host_string (result
.get ()));
1153 gdbpy_print_stack ();
1154 return EXT_LANG_RC_ERROR
;
1157 set_prompt (prompt
.get ());
1158 return EXT_LANG_RC_OK
;
1163 return EXT_LANG_RC_NOP
;
1170 /* A python function to write a single string using gdb's filtered
1171 output stream . The optional keyword STREAM can be used to write
1172 to a particular stream. The default stream is to gdb_stdout. */
1175 gdbpy_write (PyObject
*self
, PyObject
*args
, PyObject
*kw
)
1178 static const char *keywords
[] = { "text", "stream", NULL
};
1179 int stream_type
= 0;
1181 if (!gdb_PyArg_ParseTupleAndKeywords (args
, kw
, "s|i", keywords
, &arg
,
1187 switch (stream_type
)
1191 fprintf_filtered (gdb_stderr
, "%s", arg
);
1196 fprintf_filtered (gdb_stdlog
, "%s", arg
);
1200 fprintf_filtered (gdb_stdout
, "%s", arg
);
1203 CATCH (except
, RETURN_MASK_ALL
)
1205 GDB_PY_HANDLE_EXCEPTION (except
);
1212 /* A python function to flush a gdb stream. The optional keyword
1213 STREAM can be used to flush a particular stream. The default stream
1217 gdbpy_flush (PyObject
*self
, PyObject
*args
, PyObject
*kw
)
1219 static const char *keywords
[] = { "stream", NULL
};
1220 int stream_type
= 0;
1222 if (!gdb_PyArg_ParseTupleAndKeywords (args
, kw
, "|i", keywords
,
1226 switch (stream_type
)
1230 gdb_flush (gdb_stderr
);
1235 gdb_flush (gdb_stdlog
);
1239 gdb_flush (gdb_stdout
);
1245 /* Return non-zero if print-stack is not "none". */
1248 gdbpy_print_python_errors_p (void)
1250 return gdbpy_should_print_stack
!= python_excp_none
;
1253 /* Print a python exception trace, print just a message, or print
1254 nothing and clear the python exception, depending on
1255 gdbpy_should_print_stack. Only call this if a python exception is
1258 gdbpy_print_stack (void)
1261 /* Print "none", just clear exception. */
1262 if (gdbpy_should_print_stack
== python_excp_none
)
1266 /* Print "full" message and backtrace. */
1267 else if (gdbpy_should_print_stack
== python_excp_full
)
1270 /* PyErr_Print doesn't necessarily end output with a newline.
1271 This works because Python's stdout/stderr is fed through
1277 CATCH (except
, RETURN_MASK_ALL
)
1282 /* Print "message", just error print message. */
1285 PyObject
*ptype
, *pvalue
, *ptraceback
;
1287 PyErr_Fetch (&ptype
, &pvalue
, &ptraceback
);
1289 /* Fetch the error message contained within ptype, pvalue. */
1290 gdb::unique_xmalloc_ptr
<char>
1291 msg (gdbpy_exception_to_string (ptype
, pvalue
));
1292 gdb::unique_xmalloc_ptr
<char> type (gdbpy_obj_to_string (ptype
));
1298 /* An error occurred computing the string representation of the
1300 fprintf_filtered (gdb_stderr
,
1301 _("Error occurred computing Python error" \
1305 fprintf_filtered (gdb_stderr
, "Python Exception %s %s: \n",
1306 type
.get (), msg
.get ());
1308 CATCH (except
, RETURN_MASK_ALL
)
1314 Py_XDECREF (pvalue
);
1315 Py_XDECREF (ptraceback
);
1321 /* Return the current Progspace.
1322 There always is one. */
1325 gdbpy_get_current_progspace (PyObject
*unused1
, PyObject
*unused2
)
1329 result
= pspace_to_pspace_object (current_program_space
);
1335 /* Return a sequence holding all the Progspaces. */
1338 gdbpy_progspaces (PyObject
*unused1
, PyObject
*unused2
)
1340 struct program_space
*ps
;
1342 gdbpy_ref
<> list (PyList_New (0));
1348 PyObject
*item
= pspace_to_pspace_object (ps
);
1350 if (!item
|| PyList_Append (list
.get (), item
) == -1)
1354 return list
.release ();
1359 /* The "current" objfile. This is set when gdb detects that a new
1360 objfile has been loaded. It is only set for the duration of a call to
1361 gdbpy_source_objfile_script and gdbpy_execute_objfile_script; it is NULL
1363 static struct objfile
*gdbpy_current_objfile
;
1365 /* Set the current objfile to OBJFILE and then read FILE named FILENAME
1366 as Python code. This does not throw any errors. If an exception
1367 occurs python will print the traceback and clear the error indicator.
1368 This is the extension_language_script_ops.objfile_script_sourcer
1372 gdbpy_source_objfile_script (const struct extension_language_defn
*extlang
,
1373 struct objfile
*objfile
, FILE *file
,
1374 const char *filename
)
1376 if (!gdb_python_initialized
)
1379 gdbpy_enter
enter_py (get_objfile_arch (objfile
), current_language
);
1380 gdbpy_current_objfile
= objfile
;
1382 python_run_simple_file (file
, filename
);
1384 gdbpy_current_objfile
= NULL
;
1387 /* Set the current objfile to OBJFILE and then execute SCRIPT
1388 as Python code. This does not throw any errors. If an exception
1389 occurs python will print the traceback and clear the error indicator.
1390 This is the extension_language_script_ops.objfile_script_executor
1394 gdbpy_execute_objfile_script (const struct extension_language_defn
*extlang
,
1395 struct objfile
*objfile
, const char *name
,
1398 if (!gdb_python_initialized
)
1401 gdbpy_enter
enter_py (get_objfile_arch (objfile
), current_language
);
1402 gdbpy_current_objfile
= objfile
;
1404 PyRun_SimpleString (script
);
1406 gdbpy_current_objfile
= NULL
;
1409 /* Return the current Objfile, or None if there isn't one. */
1412 gdbpy_get_current_objfile (PyObject
*unused1
, PyObject
*unused2
)
1416 if (! gdbpy_current_objfile
)
1419 result
= objfile_to_objfile_object (gdbpy_current_objfile
);
1425 /* Return a sequence holding all the Objfiles. */
1428 gdbpy_objfiles (PyObject
*unused1
, PyObject
*unused2
)
1430 struct objfile
*objf
;
1432 gdbpy_ref
<> list (PyList_New (0));
1438 PyObject
*item
= objfile_to_objfile_object (objf
);
1440 if (!item
|| PyList_Append (list
.get (), item
) == -1)
1444 return list
.release ();
1447 /* Compute the list of active python type printers and store them in
1448 EXT_PRINTERS->py_type_printers. The product of this function is used by
1449 gdbpy_apply_type_printers, and freed by gdbpy_free_type_printers.
1450 This is the extension_language_ops.start_type_printers "method". */
1453 gdbpy_start_type_printers (const struct extension_language_defn
*extlang
,
1454 struct ext_lang_type_printers
*ext_printers
)
1456 PyObject
*printers_obj
= NULL
;
1458 if (!gdb_python_initialized
)
1461 gdbpy_enter
enter_py (get_current_arch (), current_language
);
1463 gdbpy_ref
<> type_module (PyImport_ImportModule ("gdb.types"));
1464 if (type_module
== NULL
)
1466 gdbpy_print_stack ();
1470 gdbpy_ref
<> func (PyObject_GetAttrString (type_module
.get (),
1471 "get_type_recognizers"));
1474 gdbpy_print_stack ();
1478 printers_obj
= PyObject_CallFunctionObjArgs (func
.get (), (char *) NULL
);
1479 if (printers_obj
== NULL
)
1480 gdbpy_print_stack ();
1482 ext_printers
->py_type_printers
= printers_obj
;
1485 /* If TYPE is recognized by some type printer, store in *PRETTIED_TYPE
1486 a newly allocated string holding the type's replacement name, and return
1487 EXT_LANG_RC_OK. The caller is responsible for freeing the string.
1488 If there's a Python error return EXT_LANG_RC_ERROR.
1489 Otherwise, return EXT_LANG_RC_NOP.
1490 This is the extension_language_ops.apply_type_printers "method". */
1492 static enum ext_lang_rc
1493 gdbpy_apply_type_printers (const struct extension_language_defn
*extlang
,
1494 const struct ext_lang_type_printers
*ext_printers
,
1495 struct type
*type
, char **prettied_type
)
1497 PyObject
*printers_obj
= (PyObject
*) ext_printers
->py_type_printers
;
1498 gdb::unique_xmalloc_ptr
<char> result
;
1500 if (printers_obj
== NULL
)
1501 return EXT_LANG_RC_NOP
;
1503 if (!gdb_python_initialized
)
1504 return EXT_LANG_RC_NOP
;
1506 gdbpy_enter
enter_py (get_current_arch (), current_language
);
1508 gdbpy_ref
<> type_obj (type_to_type_object (type
));
1509 if (type_obj
== NULL
)
1511 gdbpy_print_stack ();
1512 return EXT_LANG_RC_ERROR
;
1515 gdbpy_ref
<> type_module (PyImport_ImportModule ("gdb.types"));
1516 if (type_module
== NULL
)
1518 gdbpy_print_stack ();
1519 return EXT_LANG_RC_ERROR
;
1522 gdbpy_ref
<> func (PyObject_GetAttrString (type_module
.get (),
1523 "apply_type_recognizers"));
1526 gdbpy_print_stack ();
1527 return EXT_LANG_RC_ERROR
;
1530 gdbpy_ref
<> result_obj (PyObject_CallFunctionObjArgs (func
.get (),
1534 if (result_obj
== NULL
)
1536 gdbpy_print_stack ();
1537 return EXT_LANG_RC_ERROR
;
1540 if (result_obj
== Py_None
)
1541 return EXT_LANG_RC_NOP
;
1543 result
= python_string_to_host_string (result_obj
.get ());
1546 gdbpy_print_stack ();
1547 return EXT_LANG_RC_ERROR
;
1550 *prettied_type
= result
.release ();
1551 return EXT_LANG_RC_OK
;
1554 /* Free the result of start_type_printers.
1555 This is the extension_language_ops.free_type_printers "method". */
1558 gdbpy_free_type_printers (const struct extension_language_defn
*extlang
,
1559 struct ext_lang_type_printers
*ext_printers
)
1561 PyObject
*printers
= (PyObject
*) ext_printers
->py_type_printers
;
1563 if (printers
== NULL
)
1566 if (!gdb_python_initialized
)
1569 gdbpy_enter
enter_py (get_current_arch (), current_language
);
1570 Py_DECREF (printers
);
1573 #else /* HAVE_PYTHON */
1575 /* Dummy implementation of the gdb "python-interactive" and "python"
1579 python_interactive_command (const char *arg
, int from_tty
)
1581 arg
= skip_spaces (arg
);
1583 error (_("Python scripting is not supported in this copy of GDB."));
1586 command_line_up l
= get_command_line (python_control
, "");
1588 execute_control_command_untraced (l
.get ());
1593 python_command (const char *arg
, int from_tty
)
1595 python_interactive_command (arg
, from_tty
);
1598 #endif /* HAVE_PYTHON */
1602 /* Lists for 'set python' commands. */
1604 static struct cmd_list_element
*user_set_python_list
;
1605 static struct cmd_list_element
*user_show_python_list
;
1607 /* Function for use by 'set python' prefix command. */
1610 user_set_python (const char *args
, int from_tty
)
1612 help_list (user_set_python_list
, "set python ", all_commands
,
1616 /* Function for use by 'show python' prefix command. */
1619 user_show_python (const char *args
, int from_tty
)
1621 cmd_show_list (user_show_python_list
, from_tty
, "");
1624 /* Initialize the Python code. */
1628 /* This is installed as a final cleanup and cleans up the
1629 interpreter. This lets Python's 'atexit' work. */
1632 finalize_python (void *ignore
)
1634 struct active_ext_lang_state
*previous_active
;
1636 /* We don't use ensure_python_env here because if we ever ran the
1637 cleanup, gdb would crash -- because the cleanup calls into the
1638 Python interpreter, which we are about to destroy. It seems
1639 clearer to make the needed calls explicitly here than to create a
1640 cleanup and then mysteriously discard it. */
1642 /* This is only called as a final cleanup so we can assume the active
1643 SIGINT handler is gdb's. We still need to tell it to notify Python. */
1644 previous_active
= set_active_ext_lang (&extension_language_python
);
1646 (void) PyGILState_Ensure ();
1647 python_gdbarch
= target_gdbarch ();
1648 python_language
= current_language
;
1652 restore_active_ext_lang (previous_active
);
1656 do_start_initialization ()
1659 size_t progsize
, count
;
1660 wchar_t *progname_copy
;
1663 #ifdef WITH_PYTHON_PATH
1664 /* Work around problem where python gets confused about where it is,
1665 and then can't find its libraries, etc.
1666 NOTE: Python assumes the following layout:
1668 /foo/lib/pythonX.Y/...
1669 This must be done before calling Py_Initialize. */
1670 gdb::unique_xmalloc_ptr
<char> progname
1671 (concat (ldirname (python_libdir
).c_str (), SLASH_STRING
, "bin",
1672 SLASH_STRING
, "python", (char *) NULL
));
1674 std::string oldloc
= setlocale (LC_ALL
, NULL
);
1675 setlocale (LC_ALL
, "");
1676 progsize
= strlen (progname
.get ());
1677 progname_copy
= (wchar_t *) PyMem_Malloc ((progsize
+ 1) * sizeof (wchar_t));
1680 fprintf (stderr
, "out of memory\n");
1683 count
= mbstowcs (progname_copy
, progname
.get (), progsize
+ 1);
1684 if (count
== (size_t) -1)
1686 fprintf (stderr
, "Could not convert python path to string\n");
1689 setlocale (LC_ALL
, oldloc
.c_str ());
1691 /* Note that Py_SetProgramName expects the string it is passed to
1692 remain alive for the duration of the program's execution, so
1693 it is not freed after this call. */
1694 Py_SetProgramName (progname_copy
);
1696 Py_SetProgramName (progname
.release ());
1701 PyEval_InitThreads ();
1704 gdb_module
= PyModule_Create (&python_GdbModuleDef
);
1705 /* Add _gdb module to the list of known built-in modules. */
1706 _PyImport_FixupBuiltin (gdb_module
, "_gdb");
1708 gdb_module
= Py_InitModule ("_gdb", python_GdbMethods
);
1710 if (gdb_module
== NULL
)
1713 /* The casts to (char*) are for python 2.4. */
1714 if (PyModule_AddStringConstant (gdb_module
, "VERSION", (char*) version
) < 0
1715 || PyModule_AddStringConstant (gdb_module
, "HOST_CONFIG",
1716 (char*) host_name
) < 0
1717 || PyModule_AddStringConstant (gdb_module
, "TARGET_CONFIG",
1718 (char*) target_name
) < 0)
1721 /* Add stream constants. */
1722 if (PyModule_AddIntConstant (gdb_module
, "STDOUT", 0) < 0
1723 || PyModule_AddIntConstant (gdb_module
, "STDERR", 1) < 0
1724 || PyModule_AddIntConstant (gdb_module
, "STDLOG", 2) < 0)
1727 gdbpy_gdb_error
= PyErr_NewException ("gdb.error", PyExc_RuntimeError
, NULL
);
1728 if (gdbpy_gdb_error
== NULL
1729 || gdb_pymodule_addobject (gdb_module
, "error", gdbpy_gdb_error
) < 0)
1732 gdbpy_gdb_memory_error
= PyErr_NewException ("gdb.MemoryError",
1733 gdbpy_gdb_error
, NULL
);
1734 if (gdbpy_gdb_memory_error
== NULL
1735 || gdb_pymodule_addobject (gdb_module
, "MemoryError",
1736 gdbpy_gdb_memory_error
) < 0)
1739 gdbpy_gdberror_exc
= PyErr_NewException ("gdb.GdbError", NULL
, NULL
);
1740 if (gdbpy_gdberror_exc
== NULL
1741 || gdb_pymodule_addobject (gdb_module
, "GdbError",
1742 gdbpy_gdberror_exc
) < 0)
1745 gdbpy_initialize_gdb_readline ();
1747 if (gdbpy_initialize_auto_load () < 0
1748 || gdbpy_initialize_values () < 0
1749 || gdbpy_initialize_frames () < 0
1750 || gdbpy_initialize_commands () < 0
1751 || gdbpy_initialize_instruction () < 0
1752 || gdbpy_initialize_record () < 0
1753 || gdbpy_initialize_btrace () < 0
1754 || gdbpy_initialize_symbols () < 0
1755 || gdbpy_initialize_symtabs () < 0
1756 || gdbpy_initialize_blocks () < 0
1757 || gdbpy_initialize_functions () < 0
1758 || gdbpy_initialize_parameters () < 0
1759 || gdbpy_initialize_types () < 0
1760 || gdbpy_initialize_pspace () < 0
1761 || gdbpy_initialize_objfile () < 0
1762 || gdbpy_initialize_breakpoints () < 0
1763 || gdbpy_initialize_finishbreakpoints () < 0
1764 || gdbpy_initialize_lazy_string () < 0
1765 || gdbpy_initialize_linetable () < 0
1766 || gdbpy_initialize_thread () < 0
1767 || gdbpy_initialize_inferior () < 0
1768 || gdbpy_initialize_events () < 0
1769 || gdbpy_initialize_eventregistry () < 0
1770 || gdbpy_initialize_py_events () < 0
1771 || gdbpy_initialize_event () < 0
1772 || gdbpy_initialize_arch () < 0
1773 || gdbpy_initialize_xmethods () < 0
1774 || gdbpy_initialize_unwind () < 0)
1777 #define GDB_PY_DEFINE_EVENT_TYPE(name, py_name, doc, base) \
1778 if (gdbpy_initialize_event_generic (&name##_event_object_type, py_name) < 0) \
1780 #include "py-event-types.def"
1781 #undef GDB_PY_DEFINE_EVENT_TYPE
1783 gdbpy_to_string_cst
= PyString_FromString ("to_string");
1784 if (gdbpy_to_string_cst
== NULL
)
1786 gdbpy_children_cst
= PyString_FromString ("children");
1787 if (gdbpy_children_cst
== NULL
)
1789 gdbpy_display_hint_cst
= PyString_FromString ("display_hint");
1790 if (gdbpy_display_hint_cst
== NULL
)
1792 gdbpy_doc_cst
= PyString_FromString ("__doc__");
1793 if (gdbpy_doc_cst
== NULL
)
1795 gdbpy_enabled_cst
= PyString_FromString ("enabled");
1796 if (gdbpy_enabled_cst
== NULL
)
1798 gdbpy_value_cst
= PyString_FromString ("value");
1799 if (gdbpy_value_cst
== NULL
)
1802 /* Release the GIL while gdb runs. */
1803 PyThreadState_Swap (NULL
);
1804 PyEval_ReleaseLock ();
1806 make_final_cleanup (finalize_python
, NULL
);
1808 /* Only set this when initialization has succeeded. */
1809 gdb_python_initialized
= 1;
1813 #endif /* HAVE_PYTHON */
1816 _initialize_python (void)
1818 add_com ("python-interactive", class_obscure
,
1819 python_interactive_command
,
1822 Start an interactive Python prompt.\n\
1824 To return to GDB, type the EOF character (e.g., Ctrl-D on an empty\n\
1827 Alternatively, a single-line Python command can be given as an\n\
1828 argument, and if the command is an expression, the result will be\n\
1829 printed. For example:\n\
1831 (gdb) python-interactive 2 + 3\n\
1834 #else /* HAVE_PYTHON */
1836 Start a Python interactive prompt.\n\
1838 Python scripting is not supported in this copy of GDB.\n\
1839 This command is only a placeholder.")
1840 #endif /* HAVE_PYTHON */
1842 add_com_alias ("pi", "python-interactive", class_obscure
, 1);
1844 add_com ("python", class_obscure
, python_command
,
1847 Evaluate a Python command.\n\
1849 The command can be given as an argument, for instance:\n\
1853 If no argument is given, the following lines are read and used\n\
1854 as the Python commands. Type a line containing \"end\" to indicate\n\
1855 the end of the command.")
1856 #else /* HAVE_PYTHON */
1858 Evaluate a Python command.\n\
1860 Python scripting is not supported in this copy of GDB.\n\
1861 This command is only a placeholder.")
1862 #endif /* HAVE_PYTHON */
1864 add_com_alias ("py", "python", class_obscure
, 1);
1866 /* Add set/show python print-stack. */
1867 add_prefix_cmd ("python", no_class
, user_show_python
,
1868 _("Prefix command for python preference settings."),
1869 &user_show_python_list
, "show python ", 0,
1872 add_prefix_cmd ("python", no_class
, user_set_python
,
1873 _("Prefix command for python preference settings."),
1874 &user_set_python_list
, "set python ", 0,
1877 add_setshow_enum_cmd ("print-stack", no_class
, python_excp_enums
,
1878 &gdbpy_should_print_stack
, _("\
1879 Set mode for Python stack dump on error."), _("\
1880 Show the mode of Python stack printing on error."), _("\
1881 none == no stack or message will be printed.\n\
1882 full == a message and a stack will be printed.\n\
1883 message == an error message without a stack will be printed."),
1885 &user_set_python_list
,
1886 &user_show_python_list
);
1889 if (!do_start_initialization () && PyErr_Occurred ())
1890 gdbpy_print_stack ();
1891 #endif /* HAVE_PYTHON */
1896 /* Helper function for gdbpy_finish_initialization. This does the
1897 work and then returns false if an error has occurred and must be
1898 displayed, or true on success. */
1901 do_finish_initialization (const struct extension_language_defn
*extlang
)
1906 /* Add the initial data-directory to sys.path. */
1908 std::string gdb_pythondir
= (std::string (gdb_datadir
) + SLASH_STRING
1911 sys_path
= PySys_GetObject ("path");
1913 /* If sys.path is not defined yet, define it first. */
1914 if (!(sys_path
&& PyList_Check (sys_path
)))
1917 PySys_SetPath (L
"");
1921 sys_path
= PySys_GetObject ("path");
1923 if (sys_path
&& PyList_Check (sys_path
))
1925 gdbpy_ref
<> pythondir (PyString_FromString (gdb_pythondir
.c_str ()));
1926 if (pythondir
== NULL
|| PyList_Insert (sys_path
, 0, pythondir
.get ()))
1932 /* Import the gdb module to finish the initialization, and
1933 add it to __main__ for convenience. */
1934 m
= PyImport_AddModule ("__main__");
1938 /* Keep the reference to gdb_python_module since it is in a global
1940 gdb_python_module
= PyImport_ImportModule ("gdb");
1941 if (gdb_python_module
== NULL
)
1943 gdbpy_print_stack ();
1944 /* This is passed in one call to warning so that blank lines aren't
1945 inserted between each line of text. */
1947 "Could not load the Python gdb module from `%s'.\n"
1948 "Limited Python support is available from the _gdb module.\n"
1949 "Suggest passing --data-directory=/path/to/gdb/data-directory.\n"),
1950 gdb_pythondir
.c_str ());
1951 /* We return "success" here as we've already emitted the
1956 return gdb_pymodule_addobject (m
, "gdb", gdb_python_module
) >= 0;
1959 /* Perform the remaining python initializations.
1960 These must be done after GDB is at least mostly initialized.
1961 E.g., The "info pretty-printer" command needs the "info" prefix
1963 This is the extension_language_ops.finish_initialization "method". */
1966 gdbpy_finish_initialization (const struct extension_language_defn
*extlang
)
1968 gdbpy_enter
enter_py (get_current_arch (), current_language
);
1970 if (!do_finish_initialization (extlang
))
1972 gdbpy_print_stack ();
1973 warning (_("internal error: Unhandled Python exception"));
1977 /* Return non-zero if Python has successfully initialized.
1978 This is the extension_languages_ops.initialized "method". */
1981 gdbpy_initialized (const struct extension_language_defn
*extlang
)
1983 return gdb_python_initialized
;
1986 #endif /* HAVE_PYTHON */
1992 PyMethodDef python_GdbMethods
[] =
1994 { "history", gdbpy_history
, METH_VARARGS
,
1995 "Get a value from history" },
1996 { "execute", (PyCFunction
) execute_gdb_command
, METH_VARARGS
| METH_KEYWORDS
,
1997 "execute (command [, from_tty] [, to_string]) -> [String]\n\
1998 Evaluate command, a string, as a gdb CLI command. Optionally returns\n\
1999 a Python String containing the output of the command if to_string is\n\
2001 { "parameter", gdbpy_parameter
, METH_VARARGS
,
2002 "Return a gdb parameter's value" },
2004 { "breakpoints", gdbpy_breakpoints
, METH_NOARGS
,
2005 "Return a tuple of all breakpoint objects" },
2007 { "default_visualizer", gdbpy_default_visualizer
, METH_VARARGS
,
2008 "Find the default visualizer for a Value." },
2010 { "current_progspace", gdbpy_get_current_progspace
, METH_NOARGS
,
2011 "Return the current Progspace." },
2012 { "progspaces", gdbpy_progspaces
, METH_NOARGS
,
2013 "Return a sequence of all progspaces." },
2015 { "current_objfile", gdbpy_get_current_objfile
, METH_NOARGS
,
2016 "Return the current Objfile being loaded, or None." },
2017 { "objfiles", gdbpy_objfiles
, METH_NOARGS
,
2018 "Return a sequence of all loaded objfiles." },
2020 { "newest_frame", gdbpy_newest_frame
, METH_NOARGS
,
2021 "newest_frame () -> gdb.Frame.\n\
2022 Return the newest frame object." },
2023 { "selected_frame", gdbpy_selected_frame
, METH_NOARGS
,
2024 "selected_frame () -> gdb.Frame.\n\
2025 Return the selected frame object." },
2026 { "frame_stop_reason_string", gdbpy_frame_stop_reason_string
, METH_VARARGS
,
2027 "stop_reason_string (Integer) -> String.\n\
2028 Return a string explaining unwind stop reason." },
2030 { "start_recording", gdbpy_start_recording
, METH_VARARGS
,
2031 "start_recording ([method] [, format]) -> gdb.Record.\n\
2032 Start recording with the given method. If no method is given, will fall back\n\
2033 to the system default method. If no format is given, will fall back to the\n\
2034 default format for the given method."},
2035 { "current_recording", gdbpy_current_recording
, METH_NOARGS
,
2036 "current_recording () -> gdb.Record.\n\
2037 Return current recording object." },
2038 { "stop_recording", gdbpy_stop_recording
, METH_NOARGS
,
2039 "stop_recording () -> None.\n\
2040 Stop current recording." },
2042 { "lookup_type", (PyCFunction
) gdbpy_lookup_type
,
2043 METH_VARARGS
| METH_KEYWORDS
,
2044 "lookup_type (name [, block]) -> type\n\
2045 Return a Type corresponding to the given name." },
2046 { "lookup_symbol", (PyCFunction
) gdbpy_lookup_symbol
,
2047 METH_VARARGS
| METH_KEYWORDS
,
2048 "lookup_symbol (name [, block] [, domain]) -> (symbol, is_field_of_this)\n\
2049 Return a tuple with the symbol corresponding to the given name (or None) and\n\
2050 a boolean indicating if name is a field of the current implied argument\n\
2051 `this' (when the current language is object-oriented)." },
2052 { "lookup_global_symbol", (PyCFunction
) gdbpy_lookup_global_symbol
,
2053 METH_VARARGS
| METH_KEYWORDS
,
2054 "lookup_global_symbol (name [, domain]) -> symbol\n\
2055 Return the symbol corresponding to the given name (or None)." },
2057 { "lookup_objfile", (PyCFunction
) gdbpy_lookup_objfile
,
2058 METH_VARARGS
| METH_KEYWORDS
,
2059 "lookup_objfile (name, [by_build_id]) -> objfile\n\
2060 Look up the specified objfile.\n\
2061 If by_build_id is True, the objfile is looked up by using name\n\
2062 as its build id." },
2064 { "block_for_pc", gdbpy_block_for_pc
, METH_VARARGS
,
2065 "Return the block containing the given pc value, or None." },
2066 { "solib_name", gdbpy_solib_name
, METH_VARARGS
,
2067 "solib_name (Long) -> String.\n\
2068 Return the name of the shared library holding a given address, or None." },
2069 { "decode_line", gdbpy_decode_line
, METH_VARARGS
,
2070 "decode_line (String) -> Tuple. Decode a string argument the way\n\
2071 that 'break' or 'edit' does. Return a tuple containing two elements.\n\
2072 The first element contains any unparsed portion of the String parameter\n\
2073 (or None if the string was fully parsed). The second element contains\n\
2074 a tuple that contains all the locations that match, represented as\n\
2075 gdb.Symtab_and_line objects (or None)."},
2076 { "parse_and_eval", gdbpy_parse_and_eval
, METH_VARARGS
,
2077 "parse_and_eval (String) -> Value.\n\
2078 Parse String as an expression, evaluate it, and return the result as a Value."
2080 { "find_pc_line", gdbpy_find_pc_line
, METH_VARARGS
,
2081 "find_pc_line (pc) -> Symtab_and_line.\n\
2082 Return the gdb.Symtab_and_line object corresponding to the pc value." },
2084 { "post_event", gdbpy_post_event
, METH_VARARGS
,
2085 "Post an event into gdb's event loop." },
2087 { "target_charset", gdbpy_target_charset
, METH_NOARGS
,
2088 "target_charset () -> string.\n\
2089 Return the name of the current target charset." },
2090 { "target_wide_charset", gdbpy_target_wide_charset
, METH_NOARGS
,
2091 "target_wide_charset () -> string.\n\
2092 Return the name of the current target wide charset." },
2093 { "rbreak", (PyCFunction
) gdbpy_rbreak
, METH_VARARGS
| METH_KEYWORDS
,
2094 "rbreak (Regex) -> List.\n\
2095 Return a Tuple containing gdb.Breakpoint objects that match the given Regex." },
2096 { "string_to_argv", gdbpy_string_to_argv
, METH_VARARGS
,
2097 "string_to_argv (String) -> Array.\n\
2098 Parse String and return an argv-like array.\n\
2099 Arguments are separate by spaces and may be quoted."
2101 { "write", (PyCFunction
)gdbpy_write
, METH_VARARGS
| METH_KEYWORDS
,
2102 "Write a string using gdb's filtered stream." },
2103 { "flush", (PyCFunction
)gdbpy_flush
, METH_VARARGS
| METH_KEYWORDS
,
2104 "Flush gdb's filtered stdout stream." },
2105 { "selected_thread", gdbpy_selected_thread
, METH_NOARGS
,
2106 "selected_thread () -> gdb.InferiorThread.\n\
2107 Return the selected thread object." },
2108 { "selected_inferior", gdbpy_selected_inferior
, METH_NOARGS
,
2109 "selected_inferior () -> gdb.Inferior.\n\
2110 Return the selected inferior object." },
2111 { "inferiors", gdbpy_inferiors
, METH_NOARGS
,
2112 "inferiors () -> (gdb.Inferior, ...).\n\
2113 Return a tuple containing all inferiors." },
2115 { "invalidate_cached_frames", gdbpy_invalidate_cached_frames
, METH_NOARGS
,
2116 "invalidate_cached_frames () -> None.\n\
2117 Invalidate any cached frame objects in gdb.\n\
2118 Intended for internal use only." },
2120 {NULL
, NULL
, 0, NULL
}
2124 struct PyModuleDef python_GdbModuleDef
=
2126 PyModuleDef_HEAD_INIT
,
2138 /* Define all the event objects. */
2139 #define GDB_PY_DEFINE_EVENT_TYPE(name, py_name, doc, base) \
2140 PyTypeObject name##_event_object_type \
2141 CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("event_object") \
2143 PyVarObject_HEAD_INIT (NULL, 0) \
2144 "gdb." py_name, /* tp_name */ \
2145 sizeof (event_object), /* tp_basicsize */ \
2146 0, /* tp_itemsize */ \
2147 evpy_dealloc, /* tp_dealloc */ \
2149 0, /* tp_getattr */ \
2150 0, /* tp_setattr */ \
2151 0, /* tp_compare */ \
2153 0, /* tp_as_number */ \
2154 0, /* tp_as_sequence */ \
2155 0, /* tp_as_mapping */ \
2159 0, /* tp_getattro */ \
2160 0, /* tp_setattro */ \
2161 0, /* tp_as_buffer */ \
2162 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */ \
2164 0, /* tp_traverse */ \
2166 0, /* tp_richcompare */ \
2167 0, /* tp_weaklistoffset */ \
2169 0, /* tp_iternext */ \
2170 0, /* tp_methods */ \
2171 0, /* tp_members */ \
2172 0, /* tp_getset */ \
2173 &base, /* tp_base */ \
2175 0, /* tp_descr_get */ \
2176 0, /* tp_descr_set */ \
2177 0, /* tp_dictoffset */ \
2181 #include "py-event-types.def"
2182 #undef GDB_PY_DEFINE_EVENT_TYPE
2184 #endif /* HAVE_PYTHON */