1 /* General python/gdb code
3 Copyright (C) 2008-2017 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_clone_xmethod_worker_data
,
194 gdbpy_free_xmethod_worker_data
,
195 gdbpy_get_matching_xmethod_workers
,
196 gdbpy_get_xmethod_arg_types
,
197 gdbpy_get_xmethod_result_type
,
201 /* Architecture and language to be used in callbacks from
202 the Python interpreter. */
203 struct gdbarch
*python_gdbarch
;
204 const struct language_defn
*python_language
;
206 gdbpy_enter::gdbpy_enter (struct gdbarch
*gdbarch
,
207 const struct language_defn
*language
)
208 : m_gdbarch (python_gdbarch
),
209 m_language (python_language
)
211 /* We should not ever enter Python unless initialized. */
212 if (!gdb_python_initialized
)
213 error (_("Python not initialized"));
215 m_previous_active
= set_active_ext_lang (&extension_language_python
);
217 m_state
= PyGILState_Ensure ();
219 python_gdbarch
= gdbarch
;
220 python_language
= language
;
222 /* Save it and ensure ! PyErr_Occurred () afterwards. */
223 PyErr_Fetch (&m_error_type
, &m_error_value
, &m_error_traceback
);
226 gdbpy_enter::~gdbpy_enter ()
228 /* Leftover Python error is forbidden by Python Exception Handling. */
229 if (PyErr_Occurred ())
231 /* This order is similar to the one calling error afterwards. */
232 gdbpy_print_stack ();
233 warning (_("internal error: Unhandled Python exception"));
236 PyErr_Restore (m_error_type
, m_error_value
, m_error_traceback
);
238 PyGILState_Release (m_state
);
239 python_gdbarch
= m_gdbarch
;
240 python_language
= m_language
;
242 restore_active_ext_lang (m_previous_active
);
245 /* Set the quit flag. */
248 gdbpy_set_quit_flag (const struct extension_language_defn
*extlang
)
250 PyErr_SetInterrupt ();
253 /* Return true if the quit flag has been set, false otherwise. */
256 gdbpy_check_quit_flag (const struct extension_language_defn
*extlang
)
258 return PyOS_InterruptOccurred ();
261 /* Evaluate a Python command like PyRun_SimpleString, but uses
262 Py_single_input which prints the result of expressions, and does
263 not automatically print the stack on errors. */
266 eval_python_command (const char *command
)
270 m
= PyImport_AddModule ("__main__");
274 d
= PyModule_GetDict (m
);
277 gdbpy_ref
<> v (PyRun_StringFlags (command
, Py_single_input
, d
, d
, NULL
));
289 /* Implementation of the gdb "python-interactive" command. */
292 python_interactive_command (char *arg
, int from_tty
)
294 struct ui
*ui
= current_ui
;
297 scoped_restore save_async
= make_scoped_restore (¤t_ui
->async
, 0);
299 arg
= skip_spaces (arg
);
301 gdbpy_enter
enter_py (get_current_arch (), current_language
);
305 int len
= strlen (arg
);
306 char *script
= (char *) xmalloc (len
+ 2);
308 strcpy (script
, arg
);
310 script
[len
+ 1] = '\0';
311 err
= eval_python_command (script
);
316 err
= PyRun_InteractiveLoop (ui
->instream
, "<stdin>");
322 gdbpy_print_stack ();
323 error (_("Error while executing Python code."));
327 /* A wrapper around PyRun_SimpleFile. FILE is the Python script to run
330 On Windows hosts few users would build Python themselves (this is no
331 trivial task on this platform), and thus use binaries built by
332 someone else instead. There may happen situation where the Python
333 library and GDB are using two different versions of the C runtime
334 library. Python, being built with VC, would use one version of the
335 msvcr DLL (Eg. msvcr100.dll), while MinGW uses msvcrt.dll.
336 A FILE * from one runtime does not necessarily operate correctly in
339 To work around this potential issue, we create on Windows hosts the
340 FILE object using Python routines, thus making sure that it is
341 compatible with the Python library. */
344 python_run_simple_file (FILE *file
, const char *filename
)
348 PyRun_SimpleFile (file
, filename
);
352 /* Because we have a string for a filename, and are using Python to
353 open the file, we need to expand any tilde in the path first. */
354 gdb::unique_xmalloc_ptr
<char> full_path (tilde_expand (filename
));
355 gdbpy_ref
<> python_file (PyFile_FromString (full_path
.get (), (char *) "r"));
356 if (python_file
== NULL
)
358 gdbpy_print_stack ();
359 error (_("Error while opening file: %s"), full_path
.get ());
362 PyRun_SimpleFile (PyFile_AsFile (python_file
.get ()), filename
);
367 /* Given a command_line, return a command string suitable for passing
368 to Python. Lines in the string are separated by newlines. */
371 compute_python_string (struct command_line
*l
)
373 struct command_line
*iter
;
376 for (iter
= l
; iter
; iter
= iter
->next
)
378 script
+= iter
->line
;
384 /* Take a command line structure representing a 'python' command, and
385 evaluate its body using the Python interpreter. */
388 gdbpy_eval_from_control_command (const struct extension_language_defn
*extlang
,
389 struct command_line
*cmd
)
393 if (cmd
->body_count
!= 1)
394 error (_("Invalid \"python\" block structure."));
396 gdbpy_enter
enter_py (get_current_arch (), current_language
);
398 std::string script
= compute_python_string (cmd
->body_list
[0]);
399 ret
= PyRun_SimpleString (script
.c_str ());
401 error (_("Error while executing Python code."));
404 /* Implementation of the gdb "python" command. */
407 python_command (char *arg
, int from_tty
)
409 gdbpy_enter
enter_py (get_current_arch (), current_language
);
411 scoped_restore save_async
= make_scoped_restore (¤t_ui
->async
, 0);
413 arg
= skip_spaces (arg
);
416 if (PyRun_SimpleString (arg
))
417 error (_("Error while executing Python code."));
421 command_line_up l
= get_command_line (python_control
, "");
423 execute_control_command_untraced (l
.get ());
429 /* Transform a gdb parameters's value into a Python value. May return
430 NULL (and set a Python exception) on error. Helper function for
433 gdbpy_parameter_value (enum var_types type
, void *var
)
438 case var_string_noescape
:
439 case var_optional_filename
:
443 const char *str
= *(char **) var
;
447 return host_string_to_python_string (str
);
458 case var_auto_boolean
:
460 enum auto_boolean ab
= * (enum auto_boolean
*) var
;
462 if (ab
== AUTO_BOOLEAN_TRUE
)
464 else if (ab
== AUTO_BOOLEAN_FALSE
)
471 if ((* (int *) var
) == INT_MAX
)
475 return PyLong_FromLong (* (int *) var
);
479 unsigned int val
= * (unsigned int *) var
;
483 return PyLong_FromUnsignedLong (val
);
487 return PyErr_Format (PyExc_RuntimeError
,
488 _("Programmer error: unhandled type."));
491 /* A Python function which returns a gdb parameter's value as a Python
495 gdbpy_parameter (PyObject
*self
, PyObject
*args
)
497 struct gdb_exception except
= exception_none
;
498 struct cmd_list_element
*alias
, *prefix
, *cmd
;
503 if (! PyArg_ParseTuple (args
, "s", &arg
))
506 newarg
= concat ("show ", arg
, (char *) NULL
);
510 found
= lookup_cmd_composition (newarg
, &alias
, &prefix
, &cmd
);
512 CATCH (ex
, RETURN_MASK_ALL
)
519 GDB_PY_HANDLE_EXCEPTION (except
);
521 return PyErr_Format (PyExc_RuntimeError
,
522 _("Could not find parameter `%s'."), arg
);
525 return PyErr_Format (PyExc_RuntimeError
,
526 _("`%s' is not a parameter."), arg
);
527 return gdbpy_parameter_value (cmd
->var_type
, cmd
->var
);
530 /* Wrapper for target_charset. */
533 gdbpy_target_charset (PyObject
*self
, PyObject
*args
)
535 const char *cset
= target_charset (python_gdbarch
);
537 return PyUnicode_Decode (cset
, strlen (cset
), host_charset (), NULL
);
540 /* Wrapper for target_wide_charset. */
543 gdbpy_target_wide_charset (PyObject
*self
, PyObject
*args
)
545 const char *cset
= target_wide_charset (python_gdbarch
);
547 return PyUnicode_Decode (cset
, strlen (cset
), host_charset (), NULL
);
550 /* A Python function which evaluates a string using the gdb CLI. */
553 execute_gdb_command (PyObject
*self
, PyObject
*args
, PyObject
*kw
)
556 PyObject
*from_tty_obj
= NULL
, *to_string_obj
= NULL
;
557 int from_tty
, to_string
;
558 static const char *keywords
[] = { "command", "from_tty", "to_string", NULL
};
560 if (!gdb_PyArg_ParseTupleAndKeywords (args
, kw
, "s|O!O!", keywords
, &arg
,
561 &PyBool_Type
, &from_tty_obj
,
562 &PyBool_Type
, &to_string_obj
))
568 int cmp
= PyObject_IsTrue (from_tty_obj
);
577 int cmp
= PyObject_IsTrue (to_string_obj
);
583 std::string to_string_res
;
587 /* Copy the argument text in case the command modifies it. */
588 std::string
copy (arg
);
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 (©
[0], from_tty
);
604 execute_command (©
[0], 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 /* A Python function which is a wrapper for decode_line_1. */
648 gdbpy_decode_line (PyObject
*self
, PyObject
*args
)
650 struct gdb_exception except
= exception_none
;
651 struct symtabs_and_lines sals
= { NULL
, 0 }; /* Initialize to
653 struct symtab_and_line sal
;
656 gdbpy_ref
<> unparsed
;
657 event_location_up location
;
659 if (! PyArg_ParseTuple (args
, "|s", &arg
))
665 location
= string_to_event_location_basic (&arg
, python_language
);
669 if (location
!= NULL
)
670 sals
= decode_line_1 (location
.get (), 0, NULL
, NULL
, 0);
673 set_default_source_symtab_and_line ();
674 sal
= get_current_source_symtab_and_line ();
679 CATCH (ex
, RETURN_MASK_ALL
)
685 /* Ensure that the sals data is freed, when needed. */
686 gdb::unique_xmalloc_ptr
<struct symtab_and_line
> free_sals
;
687 if (sals
.sals
!= NULL
&& sals
.sals
!= &sal
)
688 free_sals
.reset (sals
.sals
);
690 if (except
.reason
< 0)
692 /* We know this will always throw. */
693 gdbpy_convert_exception (except
);
701 result
.reset (PyTuple_New (sals
.nelts
));
704 for (i
= 0; i
< sals
.nelts
; ++i
)
708 obj
= symtab_and_line_to_sal_object (sals
.sals
[i
]);
712 PyTuple_SetItem (result
.get (), i
, obj
);
717 result
.reset (Py_None
);
721 gdbpy_ref
<> return_result (PyTuple_New (2));
722 if (return_result
== NULL
)
725 if (arg
!= NULL
&& strlen (arg
) > 0)
727 unparsed
.reset (PyString_FromString (arg
));
728 if (unparsed
== NULL
)
733 unparsed
.reset (Py_None
);
737 PyTuple_SetItem (return_result
.get (), 0, unparsed
.release ());
738 PyTuple_SetItem (return_result
.get (), 1, result
.release ());
740 return return_result
.release ();
743 /* Parse a string and evaluate it as an expression. */
745 gdbpy_parse_and_eval (PyObject
*self
, PyObject
*args
)
747 const char *expr_str
;
748 struct value
*result
= NULL
;
750 if (!PyArg_ParseTuple (args
, "s", &expr_str
))
755 result
= parse_and_eval (expr_str
);
757 CATCH (except
, RETURN_MASK_ALL
)
759 GDB_PY_HANDLE_EXCEPTION (except
);
763 return value_to_value_object (result
);
766 /* Implementation of gdb.find_pc_line function.
767 Returns the gdb.Symtab_and_line object corresponding to a PC value. */
770 gdbpy_find_pc_line (PyObject
*self
, PyObject
*args
)
772 gdb_py_ulongest pc_llu
;
773 PyObject
*result
= NULL
; /* init for gcc -Wall */
775 if (!PyArg_ParseTuple (args
, GDB_PY_LLU_ARG
, &pc_llu
))
780 struct symtab_and_line sal
;
783 pc
= (CORE_ADDR
) pc_llu
;
784 sal
= find_pc_line (pc
, 0);
785 result
= symtab_and_line_to_sal_object (sal
);
787 CATCH (except
, RETURN_MASK_ALL
)
789 GDB_PY_HANDLE_EXCEPTION (except
);
796 /* Implementation of gdb.invalidate_cached_frames. */
799 gdbpy_invalidate_cached_frames (PyObject
*self
, PyObject
*args
)
801 reinit_frame_cache ();
805 /* Read a file as Python code.
806 This is the extension_language_script_ops.script_sourcer "method".
807 FILE is the file to load. FILENAME is name of the file FILE.
808 This does not throw any errors. If an exception occurs python will print
809 the traceback and clear the error indicator. */
812 gdbpy_source_script (const struct extension_language_defn
*extlang
,
813 FILE *file
, const char *filename
)
815 gdbpy_enter
enter_py (get_current_arch (), current_language
);
816 python_run_simple_file (file
, filename
);
821 /* Posting and handling events. */
823 /* A single event. */
826 /* The Python event. This is just a callable object. */
828 /* The next event. */
829 struct gdbpy_event
*next
;
832 /* All pending events. */
833 static struct gdbpy_event
*gdbpy_event_list
;
834 /* The final link of the event list. */
835 static struct gdbpy_event
**gdbpy_event_list_end
;
837 /* So that we can wake up the main thread even when it is blocked in
839 static struct serial_event
*gdbpy_serial_event
;
841 /* The file handler callback. This reads from the internal pipe, and
842 then processes the Python event queue. This will always be run in
843 the main gdb thread. */
846 gdbpy_run_events (int error
, gdb_client_data client_data
)
848 gdbpy_enter
enter_py (get_current_arch (), current_language
);
850 /* Clear the event fd. Do this before flushing the events list, so
851 that any new event post afterwards is sure to re-awake the event
853 serial_event_clear (gdbpy_serial_event
);
855 while (gdbpy_event_list
)
857 /* Dispatching the event might push a new element onto the event
858 loop, so we update here "atomically enough". */
859 struct gdbpy_event
*item
= gdbpy_event_list
;
860 gdbpy_event_list
= gdbpy_event_list
->next
;
861 if (gdbpy_event_list
== NULL
)
862 gdbpy_event_list_end
= &gdbpy_event_list
;
865 gdbpy_ref
<> call_result (PyObject_CallObject (item
->event
, NULL
));
866 if (call_result
== NULL
)
869 Py_DECREF (item
->event
);
874 /* Submit an event to the gdb thread. */
876 gdbpy_post_event (PyObject
*self
, PyObject
*args
)
878 struct gdbpy_event
*event
;
882 if (!PyArg_ParseTuple (args
, "O", &func
))
885 if (!PyCallable_Check (func
))
887 PyErr_SetString (PyExc_RuntimeError
,
888 _("Posted event is not callable"));
894 /* From here until the end of the function, we have the GIL, so we
895 can operate on our global data structures without worrying. */
896 wakeup
= gdbpy_event_list
== NULL
;
898 event
= XNEW (struct gdbpy_event
);
901 *gdbpy_event_list_end
= event
;
902 gdbpy_event_list_end
= &event
->next
;
904 /* Wake up gdb when needed. */
906 serial_event_set (gdbpy_serial_event
);
911 /* Initialize the Python event handler. */
913 gdbpy_initialize_events (void)
915 gdbpy_event_list_end
= &gdbpy_event_list
;
917 gdbpy_serial_event
= make_serial_event ();
918 add_file_handler (serial_event_fd (gdbpy_serial_event
),
919 gdbpy_run_events
, NULL
);
926 /* This is the extension_language_ops.before_prompt "method". */
928 static enum ext_lang_rc
929 gdbpy_before_prompt_hook (const struct extension_language_defn
*extlang
,
930 const char *current_gdb_prompt
)
932 if (!gdb_python_initialized
)
933 return EXT_LANG_RC_NOP
;
935 gdbpy_enter
enter_py (get_current_arch (), current_language
);
937 if (!evregpy_no_listeners_p (gdb_py_events
.before_prompt
)
938 && evpy_emit_event (NULL
, gdb_py_events
.before_prompt
) < 0)
939 return EXT_LANG_RC_ERROR
;
941 if (gdb_python_module
942 && PyObject_HasAttrString (gdb_python_module
, "prompt_hook"))
944 gdbpy_ref
<> hook (PyObject_GetAttrString (gdb_python_module
,
948 gdbpy_print_stack ();
949 return EXT_LANG_RC_ERROR
;
952 if (PyCallable_Check (hook
.get ()))
954 gdbpy_ref
<> current_prompt (PyString_FromString (current_gdb_prompt
));
955 if (current_prompt
== NULL
)
957 gdbpy_print_stack ();
958 return EXT_LANG_RC_ERROR
;
962 (PyObject_CallFunctionObjArgs (hook
.get (), current_prompt
.get (),
966 gdbpy_print_stack ();
967 return EXT_LANG_RC_ERROR
;
970 /* Return type should be None, or a String. If it is None,
971 fall through, we will not set a prompt. If it is a
972 string, set PROMPT. Anything else, set an exception. */
973 if (result
!= Py_None
&& ! PyString_Check (result
.get ()))
975 PyErr_Format (PyExc_RuntimeError
,
976 _("Return from prompt_hook must " \
977 "be either a Python string, or None"));
978 gdbpy_print_stack ();
979 return EXT_LANG_RC_ERROR
;
982 if (result
!= Py_None
)
984 gdb::unique_xmalloc_ptr
<char>
985 prompt (python_string_to_host_string (result
.get ()));
989 gdbpy_print_stack ();
990 return EXT_LANG_RC_ERROR
;
993 set_prompt (prompt
.get ());
994 return EXT_LANG_RC_OK
;
999 return EXT_LANG_RC_NOP
;
1006 /* A python function to write a single string using gdb's filtered
1007 output stream . The optional keyword STREAM can be used to write
1008 to a particular stream. The default stream is to gdb_stdout. */
1011 gdbpy_write (PyObject
*self
, PyObject
*args
, PyObject
*kw
)
1014 static const char *keywords
[] = { "text", "stream", NULL
};
1015 int stream_type
= 0;
1017 if (!gdb_PyArg_ParseTupleAndKeywords (args
, kw
, "s|i", keywords
, &arg
,
1023 switch (stream_type
)
1027 fprintf_filtered (gdb_stderr
, "%s", arg
);
1032 fprintf_filtered (gdb_stdlog
, "%s", arg
);
1036 fprintf_filtered (gdb_stdout
, "%s", arg
);
1039 CATCH (except
, RETURN_MASK_ALL
)
1041 GDB_PY_HANDLE_EXCEPTION (except
);
1048 /* A python function to flush a gdb stream. The optional keyword
1049 STREAM can be used to flush a particular stream. The default stream
1053 gdbpy_flush (PyObject
*self
, PyObject
*args
, PyObject
*kw
)
1055 static const char *keywords
[] = { "stream", NULL
};
1056 int stream_type
= 0;
1058 if (!gdb_PyArg_ParseTupleAndKeywords (args
, kw
, "|i", keywords
,
1062 switch (stream_type
)
1066 gdb_flush (gdb_stderr
);
1071 gdb_flush (gdb_stdlog
);
1075 gdb_flush (gdb_stdout
);
1081 /* Return non-zero if print-stack is not "none". */
1084 gdbpy_print_python_errors_p (void)
1086 return gdbpy_should_print_stack
!= python_excp_none
;
1089 /* Print a python exception trace, print just a message, or print
1090 nothing and clear the python exception, depending on
1091 gdbpy_should_print_stack. Only call this if a python exception is
1094 gdbpy_print_stack (void)
1097 /* Print "none", just clear exception. */
1098 if (gdbpy_should_print_stack
== python_excp_none
)
1102 /* Print "full" message and backtrace. */
1103 else if (gdbpy_should_print_stack
== python_excp_full
)
1106 /* PyErr_Print doesn't necessarily end output with a newline.
1107 This works because Python's stdout/stderr is fed through
1113 CATCH (except
, RETURN_MASK_ALL
)
1118 /* Print "message", just error print message. */
1121 PyObject
*ptype
, *pvalue
, *ptraceback
;
1123 PyErr_Fetch (&ptype
, &pvalue
, &ptraceback
);
1125 /* Fetch the error message contained within ptype, pvalue. */
1126 gdb::unique_xmalloc_ptr
<char>
1127 msg (gdbpy_exception_to_string (ptype
, pvalue
));
1128 gdb::unique_xmalloc_ptr
<char> type (gdbpy_obj_to_string (ptype
));
1134 /* An error occurred computing the string representation of the
1136 fprintf_filtered (gdb_stderr
,
1137 _("Error occurred computing Python error" \
1141 fprintf_filtered (gdb_stderr
, "Python Exception %s %s: \n",
1142 type
.get (), msg
.get ());
1144 CATCH (except
, RETURN_MASK_ALL
)
1150 Py_XDECREF (pvalue
);
1151 Py_XDECREF (ptraceback
);
1157 /* Return the current Progspace.
1158 There always is one. */
1161 gdbpy_get_current_progspace (PyObject
*unused1
, PyObject
*unused2
)
1165 result
= pspace_to_pspace_object (current_program_space
);
1171 /* Return a sequence holding all the Progspaces. */
1174 gdbpy_progspaces (PyObject
*unused1
, PyObject
*unused2
)
1176 struct program_space
*ps
;
1178 gdbpy_ref
<> list (PyList_New (0));
1184 PyObject
*item
= pspace_to_pspace_object (ps
);
1186 if (!item
|| PyList_Append (list
.get (), item
) == -1)
1190 return list
.release ();
1195 /* The "current" objfile. This is set when gdb detects that a new
1196 objfile has been loaded. It is only set for the duration of a call to
1197 gdbpy_source_objfile_script and gdbpy_execute_objfile_script; it is NULL
1199 static struct objfile
*gdbpy_current_objfile
;
1201 /* Set the current objfile to OBJFILE and then read FILE named FILENAME
1202 as Python code. This does not throw any errors. If an exception
1203 occurs python will print the traceback and clear the error indicator.
1204 This is the extension_language_script_ops.objfile_script_sourcer
1208 gdbpy_source_objfile_script (const struct extension_language_defn
*extlang
,
1209 struct objfile
*objfile
, FILE *file
,
1210 const char *filename
)
1212 if (!gdb_python_initialized
)
1215 gdbpy_enter
enter_py (get_objfile_arch (objfile
), current_language
);
1216 gdbpy_current_objfile
= objfile
;
1218 python_run_simple_file (file
, filename
);
1220 gdbpy_current_objfile
= NULL
;
1223 /* Set the current objfile to OBJFILE and then execute SCRIPT
1224 as Python code. This does not throw any errors. If an exception
1225 occurs python will print the traceback and clear the error indicator.
1226 This is the extension_language_script_ops.objfile_script_executor
1230 gdbpy_execute_objfile_script (const struct extension_language_defn
*extlang
,
1231 struct objfile
*objfile
, const char *name
,
1234 if (!gdb_python_initialized
)
1237 gdbpy_enter
enter_py (get_objfile_arch (objfile
), current_language
);
1238 gdbpy_current_objfile
= objfile
;
1240 PyRun_SimpleString (script
);
1242 gdbpy_current_objfile
= NULL
;
1245 /* Return the current Objfile, or None if there isn't one. */
1248 gdbpy_get_current_objfile (PyObject
*unused1
, PyObject
*unused2
)
1252 if (! gdbpy_current_objfile
)
1255 result
= objfile_to_objfile_object (gdbpy_current_objfile
);
1261 /* Return a sequence holding all the Objfiles. */
1264 gdbpy_objfiles (PyObject
*unused1
, PyObject
*unused2
)
1266 struct objfile
*objf
;
1268 gdbpy_ref
<> list (PyList_New (0));
1274 PyObject
*item
= objfile_to_objfile_object (objf
);
1276 if (!item
|| PyList_Append (list
.get (), item
) == -1)
1280 return list
.release ();
1283 /* Compute the list of active python type printers and store them in
1284 EXT_PRINTERS->py_type_printers. The product of this function is used by
1285 gdbpy_apply_type_printers, and freed by gdbpy_free_type_printers.
1286 This is the extension_language_ops.start_type_printers "method". */
1289 gdbpy_start_type_printers (const struct extension_language_defn
*extlang
,
1290 struct ext_lang_type_printers
*ext_printers
)
1292 PyObject
*printers_obj
= NULL
;
1294 if (!gdb_python_initialized
)
1297 gdbpy_enter
enter_py (get_current_arch (), current_language
);
1299 gdbpy_ref
<> type_module (PyImport_ImportModule ("gdb.types"));
1300 if (type_module
== NULL
)
1302 gdbpy_print_stack ();
1306 gdbpy_ref
<> func (PyObject_GetAttrString (type_module
.get (),
1307 "get_type_recognizers"));
1310 gdbpy_print_stack ();
1314 printers_obj
= PyObject_CallFunctionObjArgs (func
.get (), (char *) NULL
);
1315 if (printers_obj
== NULL
)
1316 gdbpy_print_stack ();
1318 ext_printers
->py_type_printers
= printers_obj
;
1321 /* If TYPE is recognized by some type printer, store in *PRETTIED_TYPE
1322 a newly allocated string holding the type's replacement name, and return
1323 EXT_LANG_RC_OK. The caller is responsible for freeing the string.
1324 If there's a Python error return EXT_LANG_RC_ERROR.
1325 Otherwise, return EXT_LANG_RC_NOP.
1326 This is the extension_language_ops.apply_type_printers "method". */
1328 static enum ext_lang_rc
1329 gdbpy_apply_type_printers (const struct extension_language_defn
*extlang
,
1330 const struct ext_lang_type_printers
*ext_printers
,
1331 struct type
*type
, char **prettied_type
)
1333 PyObject
*printers_obj
= (PyObject
*) ext_printers
->py_type_printers
;
1334 gdb::unique_xmalloc_ptr
<char> result
;
1336 if (printers_obj
== NULL
)
1337 return EXT_LANG_RC_NOP
;
1339 if (!gdb_python_initialized
)
1340 return EXT_LANG_RC_NOP
;
1342 gdbpy_enter
enter_py (get_current_arch (), current_language
);
1344 gdbpy_ref
<> type_obj (type_to_type_object (type
));
1345 if (type_obj
== NULL
)
1347 gdbpy_print_stack ();
1348 return EXT_LANG_RC_ERROR
;
1351 gdbpy_ref
<> type_module (PyImport_ImportModule ("gdb.types"));
1352 if (type_module
== NULL
)
1354 gdbpy_print_stack ();
1355 return EXT_LANG_RC_ERROR
;
1358 gdbpy_ref
<> func (PyObject_GetAttrString (type_module
.get (),
1359 "apply_type_recognizers"));
1362 gdbpy_print_stack ();
1363 return EXT_LANG_RC_ERROR
;
1366 gdbpy_ref
<> result_obj (PyObject_CallFunctionObjArgs (func
.get (),
1370 if (result_obj
== NULL
)
1372 gdbpy_print_stack ();
1373 return EXT_LANG_RC_ERROR
;
1376 if (result_obj
== Py_None
)
1377 return EXT_LANG_RC_NOP
;
1379 result
= python_string_to_host_string (result_obj
.get ());
1382 gdbpy_print_stack ();
1383 return EXT_LANG_RC_ERROR
;
1386 *prettied_type
= result
.release ();
1387 return EXT_LANG_RC_OK
;
1390 /* Free the result of start_type_printers.
1391 This is the extension_language_ops.free_type_printers "method". */
1394 gdbpy_free_type_printers (const struct extension_language_defn
*extlang
,
1395 struct ext_lang_type_printers
*ext_printers
)
1397 PyObject
*printers
= (PyObject
*) ext_printers
->py_type_printers
;
1399 if (printers
== NULL
)
1402 if (!gdb_python_initialized
)
1405 gdbpy_enter
enter_py (get_current_arch (), current_language
);
1406 Py_DECREF (printers
);
1409 #else /* HAVE_PYTHON */
1411 /* Dummy implementation of the gdb "python-interactive" and "python"
1415 python_interactive_command (char *arg
, int from_tty
)
1417 arg
= skip_spaces (arg
);
1419 error (_("Python scripting is not supported in this copy of GDB."));
1422 command_line_up l
= get_command_line (python_control
, "");
1424 execute_control_command_untraced (l
.get ());
1429 python_command (char *arg
, int from_tty
)
1431 python_interactive_command (arg
, from_tty
);
1434 #endif /* HAVE_PYTHON */
1438 /* Lists for 'set python' commands. */
1440 static struct cmd_list_element
*user_set_python_list
;
1441 static struct cmd_list_element
*user_show_python_list
;
1443 /* Function for use by 'set python' prefix command. */
1446 user_set_python (char *args
, int from_tty
)
1448 help_list (user_set_python_list
, "set python ", all_commands
,
1452 /* Function for use by 'show python' prefix command. */
1455 user_show_python (char *args
, int from_tty
)
1457 cmd_show_list (user_show_python_list
, from_tty
, "");
1460 /* Initialize the Python code. */
1464 /* This is installed as a final cleanup and cleans up the
1465 interpreter. This lets Python's 'atexit' work. */
1468 finalize_python (void *ignore
)
1470 struct active_ext_lang_state
*previous_active
;
1472 /* We don't use ensure_python_env here because if we ever ran the
1473 cleanup, gdb would crash -- because the cleanup calls into the
1474 Python interpreter, which we are about to destroy. It seems
1475 clearer to make the needed calls explicitly here than to create a
1476 cleanup and then mysteriously discard it. */
1478 /* This is only called as a final cleanup so we can assume the active
1479 SIGINT handler is gdb's. We still need to tell it to notify Python. */
1480 previous_active
= set_active_ext_lang (&extension_language_python
);
1482 (void) PyGILState_Ensure ();
1483 python_gdbarch
= target_gdbarch ();
1484 python_language
= current_language
;
1488 restore_active_ext_lang (previous_active
);
1492 /* Provide a prototype to silence -Wmissing-prototypes. */
1493 extern initialize_file_ftype _initialize_python
;
1498 do_start_initialization ()
1503 size_t progsize
, count
;
1504 wchar_t *progname_copy
;
1507 #ifdef WITH_PYTHON_PATH
1508 /* Work around problem where python gets confused about where it is,
1509 and then can't find its libraries, etc.
1510 NOTE: Python assumes the following layout:
1512 /foo/lib/pythonX.Y/...
1513 This must be done before calling Py_Initialize. */
1514 progname
= concat (ldirname (python_libdir
).c_str (), SLASH_STRING
, "bin",
1515 SLASH_STRING
, "python", (char *) NULL
);
1517 std::string oldloc
= setlocale (LC_ALL
, NULL
);
1518 setlocale (LC_ALL
, "");
1519 progsize
= strlen (progname
);
1520 progname_copy
= (wchar_t *) PyMem_Malloc ((progsize
+ 1) * sizeof (wchar_t));
1523 fprintf (stderr
, "out of memory\n");
1526 count
= mbstowcs (progname_copy
, progname
, progsize
+ 1);
1527 if (count
== (size_t) -1)
1529 fprintf (stderr
, "Could not convert python path to string\n");
1532 setlocale (LC_ALL
, oldloc
.c_str ());
1534 /* Note that Py_SetProgramName expects the string it is passed to
1535 remain alive for the duration of the program's execution, so
1536 it is not freed after this call. */
1537 Py_SetProgramName (progname_copy
);
1539 Py_SetProgramName (progname
);
1544 PyEval_InitThreads ();
1547 gdb_module
= PyModule_Create (&python_GdbModuleDef
);
1548 /* Add _gdb module to the list of known built-in modules. */
1549 _PyImport_FixupBuiltin (gdb_module
, "_gdb");
1551 gdb_module
= Py_InitModule ("_gdb", python_GdbMethods
);
1553 if (gdb_module
== NULL
)
1556 /* The casts to (char*) are for python 2.4. */
1557 if (PyModule_AddStringConstant (gdb_module
, "VERSION", (char*) version
) < 0
1558 || PyModule_AddStringConstant (gdb_module
, "HOST_CONFIG",
1559 (char*) host_name
) < 0
1560 || PyModule_AddStringConstant (gdb_module
, "TARGET_CONFIG",
1561 (char*) target_name
) < 0)
1564 /* Add stream constants. */
1565 if (PyModule_AddIntConstant (gdb_module
, "STDOUT", 0) < 0
1566 || PyModule_AddIntConstant (gdb_module
, "STDERR", 1) < 0
1567 || PyModule_AddIntConstant (gdb_module
, "STDLOG", 2) < 0)
1570 gdbpy_gdb_error
= PyErr_NewException ("gdb.error", PyExc_RuntimeError
, NULL
);
1571 if (gdbpy_gdb_error
== NULL
1572 || gdb_pymodule_addobject (gdb_module
, "error", gdbpy_gdb_error
) < 0)
1575 gdbpy_gdb_memory_error
= PyErr_NewException ("gdb.MemoryError",
1576 gdbpy_gdb_error
, NULL
);
1577 if (gdbpy_gdb_memory_error
== NULL
1578 || gdb_pymodule_addobject (gdb_module
, "MemoryError",
1579 gdbpy_gdb_memory_error
) < 0)
1582 gdbpy_gdberror_exc
= PyErr_NewException ("gdb.GdbError", NULL
, NULL
);
1583 if (gdbpy_gdberror_exc
== NULL
1584 || gdb_pymodule_addobject (gdb_module
, "GdbError",
1585 gdbpy_gdberror_exc
) < 0)
1588 gdbpy_initialize_gdb_readline ();
1590 if (gdbpy_initialize_auto_load () < 0
1591 || gdbpy_initialize_values () < 0
1592 || gdbpy_initialize_frames () < 0
1593 || gdbpy_initialize_commands () < 0
1594 || gdbpy_initialize_instruction () < 0
1595 || gdbpy_initialize_record () < 0
1596 || gdbpy_initialize_btrace () < 0
1597 || gdbpy_initialize_symbols () < 0
1598 || gdbpy_initialize_symtabs () < 0
1599 || gdbpy_initialize_blocks () < 0
1600 || gdbpy_initialize_functions () < 0
1601 || gdbpy_initialize_parameters () < 0
1602 || gdbpy_initialize_types () < 0
1603 || gdbpy_initialize_pspace () < 0
1604 || gdbpy_initialize_objfile () < 0
1605 || gdbpy_initialize_breakpoints () < 0
1606 || gdbpy_initialize_finishbreakpoints () < 0
1607 || gdbpy_initialize_lazy_string () < 0
1608 || gdbpy_initialize_linetable () < 0
1609 || gdbpy_initialize_thread () < 0
1610 || gdbpy_initialize_inferior () < 0
1611 || gdbpy_initialize_events () < 0
1612 || gdbpy_initialize_eventregistry () < 0
1613 || gdbpy_initialize_py_events () < 0
1614 || gdbpy_initialize_event () < 0
1615 || gdbpy_initialize_stop_event () < 0
1616 || gdbpy_initialize_signal_event () < 0
1617 || gdbpy_initialize_breakpoint_event () < 0
1618 || gdbpy_initialize_continue_event () < 0
1619 || gdbpy_initialize_inferior_call_pre_event () < 0
1620 || gdbpy_initialize_inferior_call_post_event () < 0
1621 || gdbpy_initialize_register_changed_event () < 0
1622 || gdbpy_initialize_memory_changed_event () < 0
1623 || gdbpy_initialize_exited_event () < 0
1624 || gdbpy_initialize_thread_event () < 0
1625 || gdbpy_initialize_new_objfile_event () < 0
1626 || gdbpy_initialize_clear_objfiles_event () < 0
1627 || gdbpy_initialize_arch () < 0
1628 || gdbpy_initialize_xmethods () < 0
1629 || gdbpy_initialize_unwind () < 0)
1632 gdbpy_to_string_cst
= PyString_FromString ("to_string");
1633 if (gdbpy_to_string_cst
== NULL
)
1635 gdbpy_children_cst
= PyString_FromString ("children");
1636 if (gdbpy_children_cst
== NULL
)
1638 gdbpy_display_hint_cst
= PyString_FromString ("display_hint");
1639 if (gdbpy_display_hint_cst
== NULL
)
1641 gdbpy_doc_cst
= PyString_FromString ("__doc__");
1642 if (gdbpy_doc_cst
== NULL
)
1644 gdbpy_enabled_cst
= PyString_FromString ("enabled");
1645 if (gdbpy_enabled_cst
== NULL
)
1647 gdbpy_value_cst
= PyString_FromString ("value");
1648 if (gdbpy_value_cst
== NULL
)
1651 /* Release the GIL while gdb runs. */
1652 PyThreadState_Swap (NULL
);
1653 PyEval_ReleaseLock ();
1655 make_final_cleanup (finalize_python
, NULL
);
1657 /* Only set this when initialization has succeeded. */
1658 gdb_python_initialized
= 1;
1662 #endif /* HAVE_PYTHON */
1665 _initialize_python (void)
1667 add_com ("python-interactive", class_obscure
,
1668 python_interactive_command
,
1671 Start an interactive Python prompt.\n\
1673 To return to GDB, type the EOF character (e.g., Ctrl-D on an empty\n\
1676 Alternatively, a single-line Python command can be given as an\n\
1677 argument, and if the command is an expression, the result will be\n\
1678 printed. For example:\n\
1680 (gdb) python-interactive 2 + 3\n\
1683 #else /* HAVE_PYTHON */
1685 Start a Python interactive prompt.\n\
1687 Python scripting is not supported in this copy of GDB.\n\
1688 This command is only a placeholder.")
1689 #endif /* HAVE_PYTHON */
1691 add_com_alias ("pi", "python-interactive", class_obscure
, 1);
1693 add_com ("python", class_obscure
, python_command
,
1696 Evaluate a Python command.\n\
1698 The command can be given as an argument, for instance:\n\
1702 If no argument is given, the following lines are read and used\n\
1703 as the Python commands. Type a line containing \"end\" to indicate\n\
1704 the end of the command.")
1705 #else /* HAVE_PYTHON */
1707 Evaluate a Python command.\n\
1709 Python scripting is not supported in this copy of GDB.\n\
1710 This command is only a placeholder.")
1711 #endif /* HAVE_PYTHON */
1713 add_com_alias ("py", "python", class_obscure
, 1);
1715 /* Add set/show python print-stack. */
1716 add_prefix_cmd ("python", no_class
, user_show_python
,
1717 _("Prefix command for python preference settings."),
1718 &user_show_python_list
, "show python ", 0,
1721 add_prefix_cmd ("python", no_class
, user_set_python
,
1722 _("Prefix command for python preference settings."),
1723 &user_set_python_list
, "set python ", 0,
1726 add_setshow_enum_cmd ("print-stack", no_class
, python_excp_enums
,
1727 &gdbpy_should_print_stack
, _("\
1728 Set mode for Python stack dump on error."), _("\
1729 Show the mode of Python stack printing on error."), _("\
1730 none == no stack or message will be printed.\n\
1731 full == a message and a stack will be printed.\n\
1732 message == an error message without a stack will be printed."),
1734 &user_set_python_list
,
1735 &user_show_python_list
);
1738 if (!do_start_initialization () && PyErr_Occurred ())
1739 gdbpy_print_stack ();
1740 #endif /* HAVE_PYTHON */
1745 /* Helper function for gdbpy_finish_initialization. This does the
1746 work and then returns false if an error has occurred and must be
1747 displayed, or true on success. */
1750 do_finish_initialization (const struct extension_language_defn
*extlang
)
1755 /* Add the initial data-directory to sys.path. */
1757 std::string gdb_pythondir
= (std::string (gdb_datadir
) + SLASH_STRING
1760 sys_path
= PySys_GetObject ("path");
1762 /* If sys.path is not defined yet, define it first. */
1763 if (!(sys_path
&& PyList_Check (sys_path
)))
1766 PySys_SetPath (L
"");
1770 sys_path
= PySys_GetObject ("path");
1772 if (sys_path
&& PyList_Check (sys_path
))
1774 gdbpy_ref
<> pythondir (PyString_FromString (gdb_pythondir
.c_str ()));
1775 if (pythondir
== NULL
|| PyList_Insert (sys_path
, 0, pythondir
.get ()))
1781 /* Import the gdb module to finish the initialization, and
1782 add it to __main__ for convenience. */
1783 m
= PyImport_AddModule ("__main__");
1787 /* Keep the reference to gdb_python_module since it is in a global
1789 gdb_python_module
= PyImport_ImportModule ("gdb");
1790 if (gdb_python_module
== NULL
)
1792 gdbpy_print_stack ();
1793 /* This is passed in one call to warning so that blank lines aren't
1794 inserted between each line of text. */
1796 "Could not load the Python gdb module from `%s'.\n"
1797 "Limited Python support is available from the _gdb module.\n"
1798 "Suggest passing --data-directory=/path/to/gdb/data-directory.\n"),
1799 gdb_pythondir
.c_str ());
1800 /* We return "success" here as we've already emitted the
1805 return gdb_pymodule_addobject (m
, "gdb", gdb_python_module
) >= 0;
1808 /* Perform the remaining python initializations.
1809 These must be done after GDB is at least mostly initialized.
1810 E.g., The "info pretty-printer" command needs the "info" prefix
1812 This is the extension_language_ops.finish_initialization "method". */
1815 gdbpy_finish_initialization (const struct extension_language_defn
*extlang
)
1817 gdbpy_enter
enter_py (get_current_arch (), current_language
);
1819 if (!do_finish_initialization (extlang
))
1821 gdbpy_print_stack ();
1822 warning (_("internal error: Unhandled Python exception"));
1826 /* Return non-zero if Python has successfully initialized.
1827 This is the extension_languages_ops.initialized "method". */
1830 gdbpy_initialized (const struct extension_language_defn
*extlang
)
1832 return gdb_python_initialized
;
1835 #endif /* HAVE_PYTHON */
1841 PyMethodDef python_GdbMethods
[] =
1843 { "history", gdbpy_history
, METH_VARARGS
,
1844 "Get a value from history" },
1845 { "execute", (PyCFunction
) execute_gdb_command
, METH_VARARGS
| METH_KEYWORDS
,
1846 "execute (command [, from_tty] [, to_string]) -> [String]\n\
1847 Evaluate command, a string, as a gdb CLI command. Optionally returns\n\
1848 a Python String containing the output of the command if to_string is\n\
1850 { "parameter", gdbpy_parameter
, METH_VARARGS
,
1851 "Return a gdb parameter's value" },
1853 { "breakpoints", gdbpy_breakpoints
, METH_NOARGS
,
1854 "Return a tuple of all breakpoint objects" },
1856 { "default_visualizer", gdbpy_default_visualizer
, METH_VARARGS
,
1857 "Find the default visualizer for a Value." },
1859 { "current_progspace", gdbpy_get_current_progspace
, METH_NOARGS
,
1860 "Return the current Progspace." },
1861 { "progspaces", gdbpy_progspaces
, METH_NOARGS
,
1862 "Return a sequence of all progspaces." },
1864 { "current_objfile", gdbpy_get_current_objfile
, METH_NOARGS
,
1865 "Return the current Objfile being loaded, or None." },
1866 { "objfiles", gdbpy_objfiles
, METH_NOARGS
,
1867 "Return a sequence of all loaded objfiles." },
1869 { "newest_frame", gdbpy_newest_frame
, METH_NOARGS
,
1870 "newest_frame () -> gdb.Frame.\n\
1871 Return the newest frame object." },
1872 { "selected_frame", gdbpy_selected_frame
, METH_NOARGS
,
1873 "selected_frame () -> gdb.Frame.\n\
1874 Return the selected frame object." },
1875 { "frame_stop_reason_string", gdbpy_frame_stop_reason_string
, METH_VARARGS
,
1876 "stop_reason_string (Integer) -> String.\n\
1877 Return a string explaining unwind stop reason." },
1879 { "start_recording", gdbpy_start_recording
, METH_VARARGS
,
1880 "start_recording ([method] [, format]) -> gdb.Record.\n\
1881 Start recording with the given method. If no method is given, will fall back\n\
1882 to the system default method. If no format is given, will fall back to the\n\
1883 default format for the given method."},
1884 { "current_recording", gdbpy_current_recording
, METH_NOARGS
,
1885 "current_recording () -> gdb.Record.\n\
1886 Return current recording object." },
1887 { "stop_recording", gdbpy_stop_recording
, METH_NOARGS
,
1888 "stop_recording () -> None.\n\
1889 Stop current recording." },
1891 { "lookup_type", (PyCFunction
) gdbpy_lookup_type
,
1892 METH_VARARGS
| METH_KEYWORDS
,
1893 "lookup_type (name [, block]) -> type\n\
1894 Return a Type corresponding to the given name." },
1895 { "lookup_symbol", (PyCFunction
) gdbpy_lookup_symbol
,
1896 METH_VARARGS
| METH_KEYWORDS
,
1897 "lookup_symbol (name [, block] [, domain]) -> (symbol, is_field_of_this)\n\
1898 Return a tuple with the symbol corresponding to the given name (or None) and\n\
1899 a boolean indicating if name is a field of the current implied argument\n\
1900 `this' (when the current language is object-oriented)." },
1901 { "lookup_global_symbol", (PyCFunction
) gdbpy_lookup_global_symbol
,
1902 METH_VARARGS
| METH_KEYWORDS
,
1903 "lookup_global_symbol (name [, domain]) -> symbol\n\
1904 Return the symbol corresponding to the given name (or None)." },
1906 { "lookup_objfile", (PyCFunction
) gdbpy_lookup_objfile
,
1907 METH_VARARGS
| METH_KEYWORDS
,
1908 "lookup_objfile (name, [by_build_id]) -> objfile\n\
1909 Look up the specified objfile.\n\
1910 If by_build_id is True, the objfile is looked up by using name\n\
1911 as its build id." },
1913 { "block_for_pc", gdbpy_block_for_pc
, METH_VARARGS
,
1914 "Return the block containing the given pc value, or None." },
1915 { "solib_name", gdbpy_solib_name
, METH_VARARGS
,
1916 "solib_name (Long) -> String.\n\
1917 Return the name of the shared library holding a given address, or None." },
1918 { "decode_line", gdbpy_decode_line
, METH_VARARGS
,
1919 "decode_line (String) -> Tuple. Decode a string argument the way\n\
1920 that 'break' or 'edit' does. Return a tuple containing two elements.\n\
1921 The first element contains any unparsed portion of the String parameter\n\
1922 (or None if the string was fully parsed). The second element contains\n\
1923 a tuple that contains all the locations that match, represented as\n\
1924 gdb.Symtab_and_line objects (or None)."},
1925 { "parse_and_eval", gdbpy_parse_and_eval
, METH_VARARGS
,
1926 "parse_and_eval (String) -> Value.\n\
1927 Parse String as an expression, evaluate it, and return the result as a Value."
1929 { "find_pc_line", gdbpy_find_pc_line
, METH_VARARGS
,
1930 "find_pc_line (pc) -> Symtab_and_line.\n\
1931 Return the gdb.Symtab_and_line object corresponding to the pc value." },
1933 { "post_event", gdbpy_post_event
, METH_VARARGS
,
1934 "Post an event into gdb's event loop." },
1936 { "target_charset", gdbpy_target_charset
, METH_NOARGS
,
1937 "target_charset () -> string.\n\
1938 Return the name of the current target charset." },
1939 { "target_wide_charset", gdbpy_target_wide_charset
, METH_NOARGS
,
1940 "target_wide_charset () -> string.\n\
1941 Return the name of the current target wide charset." },
1943 { "string_to_argv", gdbpy_string_to_argv
, METH_VARARGS
,
1944 "string_to_argv (String) -> Array.\n\
1945 Parse String and return an argv-like array.\n\
1946 Arguments are separate by spaces and may be quoted."
1948 { "write", (PyCFunction
)gdbpy_write
, METH_VARARGS
| METH_KEYWORDS
,
1949 "Write a string using gdb's filtered stream." },
1950 { "flush", (PyCFunction
)gdbpy_flush
, METH_VARARGS
| METH_KEYWORDS
,
1951 "Flush gdb's filtered stdout stream." },
1952 { "selected_thread", gdbpy_selected_thread
, METH_NOARGS
,
1953 "selected_thread () -> gdb.InferiorThread.\n\
1954 Return the selected thread object." },
1955 { "selected_inferior", gdbpy_selected_inferior
, METH_NOARGS
,
1956 "selected_inferior () -> gdb.Inferior.\n\
1957 Return the selected inferior object." },
1958 { "inferiors", gdbpy_inferiors
, METH_NOARGS
,
1959 "inferiors () -> (gdb.Inferior, ...).\n\
1960 Return a tuple containing all inferiors." },
1962 { "invalidate_cached_frames", gdbpy_invalidate_cached_frames
, METH_NOARGS
,
1963 "invalidate_cached_frames () -> None.\n\
1964 Invalidate any cached frame objects in gdb.\n\
1965 Intended for internal use only." },
1967 {NULL
, NULL
, 0, NULL
}
1971 struct PyModuleDef python_GdbModuleDef
=
1973 PyModuleDef_HEAD_INIT
,
1984 #endif /* HAVE_PYTHON */