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 (const 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 (const 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 struct interp
*interp
;
589 scoped_restore save_async
= make_scoped_restore (¤t_ui
->async
, 0);
591 scoped_restore save_uiout
= make_scoped_restore (¤t_uiout
);
593 /* Use the console interpreter uiout to have the same print format
594 for console or MI. */
595 interp
= interp_lookup (current_ui
, "console");
596 current_uiout
= interp_ui_out (interp
);
598 scoped_restore preventer
= prevent_dont_repeat ();
600 to_string_res
= execute_command_to_string (arg
, from_tty
);
602 execute_command (arg
, from_tty
);
604 CATCH (except
, RETURN_MASK_ALL
)
606 GDB_PY_HANDLE_EXCEPTION (except
);
610 /* Do any commands attached to breakpoint we stopped at. */
611 bpstat_do_actions ();
614 return PyString_FromString (to_string_res
.c_str ());
618 /* Implementation of gdb.solib_name (Long) -> String.
619 Returns the name of the shared library holding a given address, or None. */
622 gdbpy_solib_name (PyObject
*self
, PyObject
*args
)
628 if (!PyArg_ParseTuple (args
, GDB_PY_LLU_ARG
, &pc
))
631 soname
= solib_name_from_address (current_program_space
, pc
);
633 str_obj
= host_string_to_python_string (soname
);
643 /* A Python function which is a wrapper for decode_line_1. */
646 gdbpy_decode_line (PyObject
*self
, PyObject
*args
)
648 const char *arg
= NULL
;
650 gdbpy_ref
<> unparsed
;
651 event_location_up location
;
653 if (! PyArg_ParseTuple (args
, "|s", &arg
))
657 location
= string_to_event_location_basic (&arg
, python_language
);
659 std::vector
<symtab_and_line
> decoded_sals
;
660 symtab_and_line def_sal
;
661 gdb::array_view
<symtab_and_line
> sals
;
664 if (location
!= NULL
)
666 decoded_sals
= decode_line_1 (location
.get (), 0, NULL
, NULL
, 0);
671 set_default_source_symtab_and_line ();
672 def_sal
= get_current_source_symtab_and_line ();
676 CATCH (ex
, RETURN_MASK_ALL
)
678 /* We know this will always throw. */
679 gdbpy_convert_exception (ex
);
686 result
.reset (PyTuple_New (sals
.size ()));
689 for (size_t i
= 0; i
< sals
.size (); ++i
)
691 PyObject
*obj
= symtab_and_line_to_sal_object (sals
[i
]);
695 PyTuple_SetItem (result
.get (), i
, obj
);
700 result
.reset (Py_None
);
704 gdbpy_ref
<> return_result (PyTuple_New (2));
705 if (return_result
== NULL
)
708 if (arg
!= NULL
&& strlen (arg
) > 0)
710 unparsed
.reset (PyString_FromString (arg
));
711 if (unparsed
== NULL
)
716 unparsed
.reset (Py_None
);
720 PyTuple_SetItem (return_result
.get (), 0, unparsed
.release ());
721 PyTuple_SetItem (return_result
.get (), 1, result
.release ());
723 return return_result
.release ();
726 /* Parse a string and evaluate it as an expression. */
728 gdbpy_parse_and_eval (PyObject
*self
, PyObject
*args
)
730 const char *expr_str
;
731 struct value
*result
= NULL
;
733 if (!PyArg_ParseTuple (args
, "s", &expr_str
))
738 result
= parse_and_eval (expr_str
);
740 CATCH (except
, RETURN_MASK_ALL
)
742 GDB_PY_HANDLE_EXCEPTION (except
);
746 return value_to_value_object (result
);
749 /* Implementation of gdb.find_pc_line function.
750 Returns the gdb.Symtab_and_line object corresponding to a PC value. */
753 gdbpy_find_pc_line (PyObject
*self
, PyObject
*args
)
755 gdb_py_ulongest pc_llu
;
756 PyObject
*result
= NULL
; /* init for gcc -Wall */
758 if (!PyArg_ParseTuple (args
, GDB_PY_LLU_ARG
, &pc_llu
))
763 struct symtab_and_line sal
;
766 pc
= (CORE_ADDR
) pc_llu
;
767 sal
= find_pc_line (pc
, 0);
768 result
= symtab_and_line_to_sal_object (sal
);
770 CATCH (except
, RETURN_MASK_ALL
)
772 GDB_PY_HANDLE_EXCEPTION (except
);
779 /* Implementation of gdb.invalidate_cached_frames. */
782 gdbpy_invalidate_cached_frames (PyObject
*self
, PyObject
*args
)
784 reinit_frame_cache ();
788 /* Read a file as Python code.
789 This is the extension_language_script_ops.script_sourcer "method".
790 FILE is the file to load. FILENAME is name of the file FILE.
791 This does not throw any errors. If an exception occurs python will print
792 the traceback and clear the error indicator. */
795 gdbpy_source_script (const struct extension_language_defn
*extlang
,
796 FILE *file
, const char *filename
)
798 gdbpy_enter
enter_py (get_current_arch (), current_language
);
799 python_run_simple_file (file
, filename
);
804 /* Posting and handling events. */
806 /* A single event. */
809 /* The Python event. This is just a callable object. */
811 /* The next event. */
812 struct gdbpy_event
*next
;
815 /* All pending events. */
816 static struct gdbpy_event
*gdbpy_event_list
;
817 /* The final link of the event list. */
818 static struct gdbpy_event
**gdbpy_event_list_end
;
820 /* So that we can wake up the main thread even when it is blocked in
822 static struct serial_event
*gdbpy_serial_event
;
824 /* The file handler callback. This reads from the internal pipe, and
825 then processes the Python event queue. This will always be run in
826 the main gdb thread. */
829 gdbpy_run_events (int error
, gdb_client_data client_data
)
831 gdbpy_enter
enter_py (get_current_arch (), current_language
);
833 /* Clear the event fd. Do this before flushing the events list, so
834 that any new event post afterwards is sure to re-awake the event
836 serial_event_clear (gdbpy_serial_event
);
838 while (gdbpy_event_list
)
840 /* Dispatching the event might push a new element onto the event
841 loop, so we update here "atomically enough". */
842 struct gdbpy_event
*item
= gdbpy_event_list
;
843 gdbpy_event_list
= gdbpy_event_list
->next
;
844 if (gdbpy_event_list
== NULL
)
845 gdbpy_event_list_end
= &gdbpy_event_list
;
848 gdbpy_ref
<> call_result (PyObject_CallObject (item
->event
, NULL
));
849 if (call_result
== NULL
)
852 Py_DECREF (item
->event
);
857 /* Submit an event to the gdb thread. */
859 gdbpy_post_event (PyObject
*self
, PyObject
*args
)
861 struct gdbpy_event
*event
;
865 if (!PyArg_ParseTuple (args
, "O", &func
))
868 if (!PyCallable_Check (func
))
870 PyErr_SetString (PyExc_RuntimeError
,
871 _("Posted event is not callable"));
877 /* From here until the end of the function, we have the GIL, so we
878 can operate on our global data structures without worrying. */
879 wakeup
= gdbpy_event_list
== NULL
;
881 event
= XNEW (struct gdbpy_event
);
884 *gdbpy_event_list_end
= event
;
885 gdbpy_event_list_end
= &event
->next
;
887 /* Wake up gdb when needed. */
889 serial_event_set (gdbpy_serial_event
);
894 /* Initialize the Python event handler. */
896 gdbpy_initialize_events (void)
898 gdbpy_event_list_end
= &gdbpy_event_list
;
900 gdbpy_serial_event
= make_serial_event ();
901 add_file_handler (serial_event_fd (gdbpy_serial_event
),
902 gdbpy_run_events
, NULL
);
909 /* This is the extension_language_ops.before_prompt "method". */
911 static enum ext_lang_rc
912 gdbpy_before_prompt_hook (const struct extension_language_defn
*extlang
,
913 const char *current_gdb_prompt
)
915 if (!gdb_python_initialized
)
916 return EXT_LANG_RC_NOP
;
918 gdbpy_enter
enter_py (get_current_arch (), current_language
);
920 if (!evregpy_no_listeners_p (gdb_py_events
.before_prompt
)
921 && evpy_emit_event (NULL
, gdb_py_events
.before_prompt
) < 0)
922 return EXT_LANG_RC_ERROR
;
924 if (gdb_python_module
925 && PyObject_HasAttrString (gdb_python_module
, "prompt_hook"))
927 gdbpy_ref
<> hook (PyObject_GetAttrString (gdb_python_module
,
931 gdbpy_print_stack ();
932 return EXT_LANG_RC_ERROR
;
935 if (PyCallable_Check (hook
.get ()))
937 gdbpy_ref
<> current_prompt (PyString_FromString (current_gdb_prompt
));
938 if (current_prompt
== NULL
)
940 gdbpy_print_stack ();
941 return EXT_LANG_RC_ERROR
;
945 (PyObject_CallFunctionObjArgs (hook
.get (), current_prompt
.get (),
949 gdbpy_print_stack ();
950 return EXT_LANG_RC_ERROR
;
953 /* Return type should be None, or a String. If it is None,
954 fall through, we will not set a prompt. If it is a
955 string, set PROMPT. Anything else, set an exception. */
956 if (result
!= Py_None
&& ! PyString_Check (result
.get ()))
958 PyErr_Format (PyExc_RuntimeError
,
959 _("Return from prompt_hook must " \
960 "be either a Python string, or None"));
961 gdbpy_print_stack ();
962 return EXT_LANG_RC_ERROR
;
965 if (result
!= Py_None
)
967 gdb::unique_xmalloc_ptr
<char>
968 prompt (python_string_to_host_string (result
.get ()));
972 gdbpy_print_stack ();
973 return EXT_LANG_RC_ERROR
;
976 set_prompt (prompt
.get ());
977 return EXT_LANG_RC_OK
;
982 return EXT_LANG_RC_NOP
;
989 /* A python function to write a single string using gdb's filtered
990 output stream . The optional keyword STREAM can be used to write
991 to a particular stream. The default stream is to gdb_stdout. */
994 gdbpy_write (PyObject
*self
, PyObject
*args
, PyObject
*kw
)
997 static const char *keywords
[] = { "text", "stream", NULL
};
1000 if (!gdb_PyArg_ParseTupleAndKeywords (args
, kw
, "s|i", keywords
, &arg
,
1006 switch (stream_type
)
1010 fprintf_filtered (gdb_stderr
, "%s", arg
);
1015 fprintf_filtered (gdb_stdlog
, "%s", arg
);
1019 fprintf_filtered (gdb_stdout
, "%s", arg
);
1022 CATCH (except
, RETURN_MASK_ALL
)
1024 GDB_PY_HANDLE_EXCEPTION (except
);
1031 /* A python function to flush a gdb stream. The optional keyword
1032 STREAM can be used to flush a particular stream. The default stream
1036 gdbpy_flush (PyObject
*self
, PyObject
*args
, PyObject
*kw
)
1038 static const char *keywords
[] = { "stream", NULL
};
1039 int stream_type
= 0;
1041 if (!gdb_PyArg_ParseTupleAndKeywords (args
, kw
, "|i", keywords
,
1045 switch (stream_type
)
1049 gdb_flush (gdb_stderr
);
1054 gdb_flush (gdb_stdlog
);
1058 gdb_flush (gdb_stdout
);
1064 /* Return non-zero if print-stack is not "none". */
1067 gdbpy_print_python_errors_p (void)
1069 return gdbpy_should_print_stack
!= python_excp_none
;
1072 /* Print a python exception trace, print just a message, or print
1073 nothing and clear the python exception, depending on
1074 gdbpy_should_print_stack. Only call this if a python exception is
1077 gdbpy_print_stack (void)
1080 /* Print "none", just clear exception. */
1081 if (gdbpy_should_print_stack
== python_excp_none
)
1085 /* Print "full" message and backtrace. */
1086 else if (gdbpy_should_print_stack
== python_excp_full
)
1089 /* PyErr_Print doesn't necessarily end output with a newline.
1090 This works because Python's stdout/stderr is fed through
1096 CATCH (except
, RETURN_MASK_ALL
)
1101 /* Print "message", just error print message. */
1104 PyObject
*ptype
, *pvalue
, *ptraceback
;
1106 PyErr_Fetch (&ptype
, &pvalue
, &ptraceback
);
1108 /* Fetch the error message contained within ptype, pvalue. */
1109 gdb::unique_xmalloc_ptr
<char>
1110 msg (gdbpy_exception_to_string (ptype
, pvalue
));
1111 gdb::unique_xmalloc_ptr
<char> type (gdbpy_obj_to_string (ptype
));
1117 /* An error occurred computing the string representation of the
1119 fprintf_filtered (gdb_stderr
,
1120 _("Error occurred computing Python error" \
1124 fprintf_filtered (gdb_stderr
, "Python Exception %s %s: \n",
1125 type
.get (), msg
.get ());
1127 CATCH (except
, RETURN_MASK_ALL
)
1133 Py_XDECREF (pvalue
);
1134 Py_XDECREF (ptraceback
);
1140 /* Return the current Progspace.
1141 There always is one. */
1144 gdbpy_get_current_progspace (PyObject
*unused1
, PyObject
*unused2
)
1148 result
= pspace_to_pspace_object (current_program_space
);
1154 /* Return a sequence holding all the Progspaces. */
1157 gdbpy_progspaces (PyObject
*unused1
, PyObject
*unused2
)
1159 struct program_space
*ps
;
1161 gdbpy_ref
<> list (PyList_New (0));
1167 PyObject
*item
= pspace_to_pspace_object (ps
);
1169 if (!item
|| PyList_Append (list
.get (), item
) == -1)
1173 return list
.release ();
1178 /* The "current" objfile. This is set when gdb detects that a new
1179 objfile has been loaded. It is only set for the duration of a call to
1180 gdbpy_source_objfile_script and gdbpy_execute_objfile_script; it is NULL
1182 static struct objfile
*gdbpy_current_objfile
;
1184 /* Set the current objfile to OBJFILE and then read FILE named FILENAME
1185 as Python code. This does not throw any errors. If an exception
1186 occurs python will print the traceback and clear the error indicator.
1187 This is the extension_language_script_ops.objfile_script_sourcer
1191 gdbpy_source_objfile_script (const struct extension_language_defn
*extlang
,
1192 struct objfile
*objfile
, FILE *file
,
1193 const char *filename
)
1195 if (!gdb_python_initialized
)
1198 gdbpy_enter
enter_py (get_objfile_arch (objfile
), current_language
);
1199 gdbpy_current_objfile
= objfile
;
1201 python_run_simple_file (file
, filename
);
1203 gdbpy_current_objfile
= NULL
;
1206 /* Set the current objfile to OBJFILE and then execute SCRIPT
1207 as Python code. This does not throw any errors. If an exception
1208 occurs python will print the traceback and clear the error indicator.
1209 This is the extension_language_script_ops.objfile_script_executor
1213 gdbpy_execute_objfile_script (const struct extension_language_defn
*extlang
,
1214 struct objfile
*objfile
, const char *name
,
1217 if (!gdb_python_initialized
)
1220 gdbpy_enter
enter_py (get_objfile_arch (objfile
), current_language
);
1221 gdbpy_current_objfile
= objfile
;
1223 PyRun_SimpleString (script
);
1225 gdbpy_current_objfile
= NULL
;
1228 /* Return the current Objfile, or None if there isn't one. */
1231 gdbpy_get_current_objfile (PyObject
*unused1
, PyObject
*unused2
)
1235 if (! gdbpy_current_objfile
)
1238 result
= objfile_to_objfile_object (gdbpy_current_objfile
);
1244 /* Return a sequence holding all the Objfiles. */
1247 gdbpy_objfiles (PyObject
*unused1
, PyObject
*unused2
)
1249 struct objfile
*objf
;
1251 gdbpy_ref
<> list (PyList_New (0));
1257 PyObject
*item
= objfile_to_objfile_object (objf
);
1259 if (!item
|| PyList_Append (list
.get (), item
) == -1)
1263 return list
.release ();
1266 /* Compute the list of active python type printers and store them in
1267 EXT_PRINTERS->py_type_printers. The product of this function is used by
1268 gdbpy_apply_type_printers, and freed by gdbpy_free_type_printers.
1269 This is the extension_language_ops.start_type_printers "method". */
1272 gdbpy_start_type_printers (const struct extension_language_defn
*extlang
,
1273 struct ext_lang_type_printers
*ext_printers
)
1275 PyObject
*printers_obj
= NULL
;
1277 if (!gdb_python_initialized
)
1280 gdbpy_enter
enter_py (get_current_arch (), current_language
);
1282 gdbpy_ref
<> type_module (PyImport_ImportModule ("gdb.types"));
1283 if (type_module
== NULL
)
1285 gdbpy_print_stack ();
1289 gdbpy_ref
<> func (PyObject_GetAttrString (type_module
.get (),
1290 "get_type_recognizers"));
1293 gdbpy_print_stack ();
1297 printers_obj
= PyObject_CallFunctionObjArgs (func
.get (), (char *) NULL
);
1298 if (printers_obj
== NULL
)
1299 gdbpy_print_stack ();
1301 ext_printers
->py_type_printers
= printers_obj
;
1304 /* If TYPE is recognized by some type printer, store in *PRETTIED_TYPE
1305 a newly allocated string holding the type's replacement name, and return
1306 EXT_LANG_RC_OK. The caller is responsible for freeing the string.
1307 If there's a Python error return EXT_LANG_RC_ERROR.
1308 Otherwise, return EXT_LANG_RC_NOP.
1309 This is the extension_language_ops.apply_type_printers "method". */
1311 static enum ext_lang_rc
1312 gdbpy_apply_type_printers (const struct extension_language_defn
*extlang
,
1313 const struct ext_lang_type_printers
*ext_printers
,
1314 struct type
*type
, char **prettied_type
)
1316 PyObject
*printers_obj
= (PyObject
*) ext_printers
->py_type_printers
;
1317 gdb::unique_xmalloc_ptr
<char> result
;
1319 if (printers_obj
== NULL
)
1320 return EXT_LANG_RC_NOP
;
1322 if (!gdb_python_initialized
)
1323 return EXT_LANG_RC_NOP
;
1325 gdbpy_enter
enter_py (get_current_arch (), current_language
);
1327 gdbpy_ref
<> type_obj (type_to_type_object (type
));
1328 if (type_obj
== NULL
)
1330 gdbpy_print_stack ();
1331 return EXT_LANG_RC_ERROR
;
1334 gdbpy_ref
<> type_module (PyImport_ImportModule ("gdb.types"));
1335 if (type_module
== NULL
)
1337 gdbpy_print_stack ();
1338 return EXT_LANG_RC_ERROR
;
1341 gdbpy_ref
<> func (PyObject_GetAttrString (type_module
.get (),
1342 "apply_type_recognizers"));
1345 gdbpy_print_stack ();
1346 return EXT_LANG_RC_ERROR
;
1349 gdbpy_ref
<> result_obj (PyObject_CallFunctionObjArgs (func
.get (),
1353 if (result_obj
== NULL
)
1355 gdbpy_print_stack ();
1356 return EXT_LANG_RC_ERROR
;
1359 if (result_obj
== Py_None
)
1360 return EXT_LANG_RC_NOP
;
1362 result
= python_string_to_host_string (result_obj
.get ());
1365 gdbpy_print_stack ();
1366 return EXT_LANG_RC_ERROR
;
1369 *prettied_type
= result
.release ();
1370 return EXT_LANG_RC_OK
;
1373 /* Free the result of start_type_printers.
1374 This is the extension_language_ops.free_type_printers "method". */
1377 gdbpy_free_type_printers (const struct extension_language_defn
*extlang
,
1378 struct ext_lang_type_printers
*ext_printers
)
1380 PyObject
*printers
= (PyObject
*) ext_printers
->py_type_printers
;
1382 if (printers
== NULL
)
1385 if (!gdb_python_initialized
)
1388 gdbpy_enter
enter_py (get_current_arch (), current_language
);
1389 Py_DECREF (printers
);
1392 #else /* HAVE_PYTHON */
1394 /* Dummy implementation of the gdb "python-interactive" and "python"
1398 python_interactive_command (const char *arg
, int from_tty
)
1400 arg
= skip_spaces (arg
);
1402 error (_("Python scripting is not supported in this copy of GDB."));
1405 command_line_up l
= get_command_line (python_control
, "");
1407 execute_control_command_untraced (l
.get ());
1412 python_command (const char *arg
, int from_tty
)
1414 python_interactive_command (arg
, from_tty
);
1417 #endif /* HAVE_PYTHON */
1421 /* Lists for 'set python' commands. */
1423 static struct cmd_list_element
*user_set_python_list
;
1424 static struct cmd_list_element
*user_show_python_list
;
1426 /* Function for use by 'set python' prefix command. */
1429 user_set_python (const char *args
, int from_tty
)
1431 help_list (user_set_python_list
, "set python ", all_commands
,
1435 /* Function for use by 'show python' prefix command. */
1438 user_show_python (const char *args
, int from_tty
)
1440 cmd_show_list (user_show_python_list
, from_tty
, "");
1443 /* Initialize the Python code. */
1447 /* This is installed as a final cleanup and cleans up the
1448 interpreter. This lets Python's 'atexit' work. */
1451 finalize_python (void *ignore
)
1453 struct active_ext_lang_state
*previous_active
;
1455 /* We don't use ensure_python_env here because if we ever ran the
1456 cleanup, gdb would crash -- because the cleanup calls into the
1457 Python interpreter, which we are about to destroy. It seems
1458 clearer to make the needed calls explicitly here than to create a
1459 cleanup and then mysteriously discard it. */
1461 /* This is only called as a final cleanup so we can assume the active
1462 SIGINT handler is gdb's. We still need to tell it to notify Python. */
1463 previous_active
= set_active_ext_lang (&extension_language_python
);
1465 (void) PyGILState_Ensure ();
1466 python_gdbarch
= target_gdbarch ();
1467 python_language
= current_language
;
1471 restore_active_ext_lang (previous_active
);
1475 do_start_initialization ()
1480 size_t progsize
, count
;
1481 wchar_t *progname_copy
;
1484 #ifdef WITH_PYTHON_PATH
1485 /* Work around problem where python gets confused about where it is,
1486 and then can't find its libraries, etc.
1487 NOTE: Python assumes the following layout:
1489 /foo/lib/pythonX.Y/...
1490 This must be done before calling Py_Initialize. */
1491 progname
= concat (ldirname (python_libdir
).c_str (), SLASH_STRING
, "bin",
1492 SLASH_STRING
, "python", (char *) NULL
);
1494 std::string oldloc
= setlocale (LC_ALL
, NULL
);
1495 setlocale (LC_ALL
, "");
1496 progsize
= strlen (progname
);
1497 progname_copy
= (wchar_t *) PyMem_Malloc ((progsize
+ 1) * sizeof (wchar_t));
1500 fprintf (stderr
, "out of memory\n");
1503 count
= mbstowcs (progname_copy
, progname
, progsize
+ 1);
1504 if (count
== (size_t) -1)
1506 fprintf (stderr
, "Could not convert python path to string\n");
1509 setlocale (LC_ALL
, oldloc
.c_str ());
1511 /* Note that Py_SetProgramName expects the string it is passed to
1512 remain alive for the duration of the program's execution, so
1513 it is not freed after this call. */
1514 Py_SetProgramName (progname_copy
);
1516 Py_SetProgramName (progname
);
1521 PyEval_InitThreads ();
1524 gdb_module
= PyModule_Create (&python_GdbModuleDef
);
1525 /* Add _gdb module to the list of known built-in modules. */
1526 _PyImport_FixupBuiltin (gdb_module
, "_gdb");
1528 gdb_module
= Py_InitModule ("_gdb", python_GdbMethods
);
1530 if (gdb_module
== NULL
)
1533 /* The casts to (char*) are for python 2.4. */
1534 if (PyModule_AddStringConstant (gdb_module
, "VERSION", (char*) version
) < 0
1535 || PyModule_AddStringConstant (gdb_module
, "HOST_CONFIG",
1536 (char*) host_name
) < 0
1537 || PyModule_AddStringConstant (gdb_module
, "TARGET_CONFIG",
1538 (char*) target_name
) < 0)
1541 /* Add stream constants. */
1542 if (PyModule_AddIntConstant (gdb_module
, "STDOUT", 0) < 0
1543 || PyModule_AddIntConstant (gdb_module
, "STDERR", 1) < 0
1544 || PyModule_AddIntConstant (gdb_module
, "STDLOG", 2) < 0)
1547 gdbpy_gdb_error
= PyErr_NewException ("gdb.error", PyExc_RuntimeError
, NULL
);
1548 if (gdbpy_gdb_error
== NULL
1549 || gdb_pymodule_addobject (gdb_module
, "error", gdbpy_gdb_error
) < 0)
1552 gdbpy_gdb_memory_error
= PyErr_NewException ("gdb.MemoryError",
1553 gdbpy_gdb_error
, NULL
);
1554 if (gdbpy_gdb_memory_error
== NULL
1555 || gdb_pymodule_addobject (gdb_module
, "MemoryError",
1556 gdbpy_gdb_memory_error
) < 0)
1559 gdbpy_gdberror_exc
= PyErr_NewException ("gdb.GdbError", NULL
, NULL
);
1560 if (gdbpy_gdberror_exc
== NULL
1561 || gdb_pymodule_addobject (gdb_module
, "GdbError",
1562 gdbpy_gdberror_exc
) < 0)
1565 gdbpy_initialize_gdb_readline ();
1567 if (gdbpy_initialize_auto_load () < 0
1568 || gdbpy_initialize_values () < 0
1569 || gdbpy_initialize_frames () < 0
1570 || gdbpy_initialize_commands () < 0
1571 || gdbpy_initialize_instruction () < 0
1572 || gdbpy_initialize_record () < 0
1573 || gdbpy_initialize_btrace () < 0
1574 || gdbpy_initialize_symbols () < 0
1575 || gdbpy_initialize_symtabs () < 0
1576 || gdbpy_initialize_blocks () < 0
1577 || gdbpy_initialize_functions () < 0
1578 || gdbpy_initialize_parameters () < 0
1579 || gdbpy_initialize_types () < 0
1580 || gdbpy_initialize_pspace () < 0
1581 || gdbpy_initialize_objfile () < 0
1582 || gdbpy_initialize_breakpoints () < 0
1583 || gdbpy_initialize_finishbreakpoints () < 0
1584 || gdbpy_initialize_lazy_string () < 0
1585 || gdbpy_initialize_linetable () < 0
1586 || gdbpy_initialize_thread () < 0
1587 || gdbpy_initialize_inferior () < 0
1588 || gdbpy_initialize_events () < 0
1589 || gdbpy_initialize_eventregistry () < 0
1590 || gdbpy_initialize_py_events () < 0
1591 || gdbpy_initialize_event () < 0
1592 || gdbpy_initialize_arch () < 0
1593 || gdbpy_initialize_xmethods () < 0
1594 || gdbpy_initialize_unwind () < 0)
1597 #define GDB_PY_DEFINE_EVENT_TYPE(name, py_name, doc, base) \
1598 if (gdbpy_initialize_event_generic (&name##_event_object_type, py_name) < 0) \
1600 #include "py-event-types.def"
1601 #undef GDB_PY_DEFINE_EVENT_TYPE
1603 gdbpy_to_string_cst
= PyString_FromString ("to_string");
1604 if (gdbpy_to_string_cst
== NULL
)
1606 gdbpy_children_cst
= PyString_FromString ("children");
1607 if (gdbpy_children_cst
== NULL
)
1609 gdbpy_display_hint_cst
= PyString_FromString ("display_hint");
1610 if (gdbpy_display_hint_cst
== NULL
)
1612 gdbpy_doc_cst
= PyString_FromString ("__doc__");
1613 if (gdbpy_doc_cst
== NULL
)
1615 gdbpy_enabled_cst
= PyString_FromString ("enabled");
1616 if (gdbpy_enabled_cst
== NULL
)
1618 gdbpy_value_cst
= PyString_FromString ("value");
1619 if (gdbpy_value_cst
== NULL
)
1622 /* Release the GIL while gdb runs. */
1623 PyThreadState_Swap (NULL
);
1624 PyEval_ReleaseLock ();
1626 make_final_cleanup (finalize_python
, NULL
);
1628 /* Only set this when initialization has succeeded. */
1629 gdb_python_initialized
= 1;
1633 #endif /* HAVE_PYTHON */
1636 _initialize_python (void)
1638 add_com ("python-interactive", class_obscure
,
1639 python_interactive_command
,
1642 Start an interactive Python prompt.\n\
1644 To return to GDB, type the EOF character (e.g., Ctrl-D on an empty\n\
1647 Alternatively, a single-line Python command can be given as an\n\
1648 argument, and if the command is an expression, the result will be\n\
1649 printed. For example:\n\
1651 (gdb) python-interactive 2 + 3\n\
1654 #else /* HAVE_PYTHON */
1656 Start a Python interactive prompt.\n\
1658 Python scripting is not supported in this copy of GDB.\n\
1659 This command is only a placeholder.")
1660 #endif /* HAVE_PYTHON */
1662 add_com_alias ("pi", "python-interactive", class_obscure
, 1);
1664 add_com ("python", class_obscure
, python_command
,
1667 Evaluate a Python command.\n\
1669 The command can be given as an argument, for instance:\n\
1673 If no argument is given, the following lines are read and used\n\
1674 as the Python commands. Type a line containing \"end\" to indicate\n\
1675 the end of the command.")
1676 #else /* HAVE_PYTHON */
1678 Evaluate a Python command.\n\
1680 Python scripting is not supported in this copy of GDB.\n\
1681 This command is only a placeholder.")
1682 #endif /* HAVE_PYTHON */
1684 add_com_alias ("py", "python", class_obscure
, 1);
1686 /* Add set/show python print-stack. */
1687 add_prefix_cmd ("python", no_class
, user_show_python
,
1688 _("Prefix command for python preference settings."),
1689 &user_show_python_list
, "show python ", 0,
1692 add_prefix_cmd ("python", no_class
, user_set_python
,
1693 _("Prefix command for python preference settings."),
1694 &user_set_python_list
, "set python ", 0,
1697 add_setshow_enum_cmd ("print-stack", no_class
, python_excp_enums
,
1698 &gdbpy_should_print_stack
, _("\
1699 Set mode for Python stack dump on error."), _("\
1700 Show the mode of Python stack printing on error."), _("\
1701 none == no stack or message will be printed.\n\
1702 full == a message and a stack will be printed.\n\
1703 message == an error message without a stack will be printed."),
1705 &user_set_python_list
,
1706 &user_show_python_list
);
1709 if (!do_start_initialization () && PyErr_Occurred ())
1710 gdbpy_print_stack ();
1711 #endif /* HAVE_PYTHON */
1716 /* Helper function for gdbpy_finish_initialization. This does the
1717 work and then returns false if an error has occurred and must be
1718 displayed, or true on success. */
1721 do_finish_initialization (const struct extension_language_defn
*extlang
)
1726 /* Add the initial data-directory to sys.path. */
1728 std::string gdb_pythondir
= (std::string (gdb_datadir
) + SLASH_STRING
1731 sys_path
= PySys_GetObject ("path");
1733 /* If sys.path is not defined yet, define it first. */
1734 if (!(sys_path
&& PyList_Check (sys_path
)))
1737 PySys_SetPath (L
"");
1741 sys_path
= PySys_GetObject ("path");
1743 if (sys_path
&& PyList_Check (sys_path
))
1745 gdbpy_ref
<> pythondir (PyString_FromString (gdb_pythondir
.c_str ()));
1746 if (pythondir
== NULL
|| PyList_Insert (sys_path
, 0, pythondir
.get ()))
1752 /* Import the gdb module to finish the initialization, and
1753 add it to __main__ for convenience. */
1754 m
= PyImport_AddModule ("__main__");
1758 /* Keep the reference to gdb_python_module since it is in a global
1760 gdb_python_module
= PyImport_ImportModule ("gdb");
1761 if (gdb_python_module
== NULL
)
1763 gdbpy_print_stack ();
1764 /* This is passed in one call to warning so that blank lines aren't
1765 inserted between each line of text. */
1767 "Could not load the Python gdb module from `%s'.\n"
1768 "Limited Python support is available from the _gdb module.\n"
1769 "Suggest passing --data-directory=/path/to/gdb/data-directory.\n"),
1770 gdb_pythondir
.c_str ());
1771 /* We return "success" here as we've already emitted the
1776 return gdb_pymodule_addobject (m
, "gdb", gdb_python_module
) >= 0;
1779 /* Perform the remaining python initializations.
1780 These must be done after GDB is at least mostly initialized.
1781 E.g., The "info pretty-printer" command needs the "info" prefix
1783 This is the extension_language_ops.finish_initialization "method". */
1786 gdbpy_finish_initialization (const struct extension_language_defn
*extlang
)
1788 gdbpy_enter
enter_py (get_current_arch (), current_language
);
1790 if (!do_finish_initialization (extlang
))
1792 gdbpy_print_stack ();
1793 warning (_("internal error: Unhandled Python exception"));
1797 /* Return non-zero if Python has successfully initialized.
1798 This is the extension_languages_ops.initialized "method". */
1801 gdbpy_initialized (const struct extension_language_defn
*extlang
)
1803 return gdb_python_initialized
;
1806 #endif /* HAVE_PYTHON */
1812 PyMethodDef python_GdbMethods
[] =
1814 { "history", gdbpy_history
, METH_VARARGS
,
1815 "Get a value from history" },
1816 { "execute", (PyCFunction
) execute_gdb_command
, METH_VARARGS
| METH_KEYWORDS
,
1817 "execute (command [, from_tty] [, to_string]) -> [String]\n\
1818 Evaluate command, a string, as a gdb CLI command. Optionally returns\n\
1819 a Python String containing the output of the command if to_string is\n\
1821 { "parameter", gdbpy_parameter
, METH_VARARGS
,
1822 "Return a gdb parameter's value" },
1824 { "breakpoints", gdbpy_breakpoints
, METH_NOARGS
,
1825 "Return a tuple of all breakpoint objects" },
1827 { "default_visualizer", gdbpy_default_visualizer
, METH_VARARGS
,
1828 "Find the default visualizer for a Value." },
1830 { "current_progspace", gdbpy_get_current_progspace
, METH_NOARGS
,
1831 "Return the current Progspace." },
1832 { "progspaces", gdbpy_progspaces
, METH_NOARGS
,
1833 "Return a sequence of all progspaces." },
1835 { "current_objfile", gdbpy_get_current_objfile
, METH_NOARGS
,
1836 "Return the current Objfile being loaded, or None." },
1837 { "objfiles", gdbpy_objfiles
, METH_NOARGS
,
1838 "Return a sequence of all loaded objfiles." },
1840 { "newest_frame", gdbpy_newest_frame
, METH_NOARGS
,
1841 "newest_frame () -> gdb.Frame.\n\
1842 Return the newest frame object." },
1843 { "selected_frame", gdbpy_selected_frame
, METH_NOARGS
,
1844 "selected_frame () -> gdb.Frame.\n\
1845 Return the selected frame object." },
1846 { "frame_stop_reason_string", gdbpy_frame_stop_reason_string
, METH_VARARGS
,
1847 "stop_reason_string (Integer) -> String.\n\
1848 Return a string explaining unwind stop reason." },
1850 { "start_recording", gdbpy_start_recording
, METH_VARARGS
,
1851 "start_recording ([method] [, format]) -> gdb.Record.\n\
1852 Start recording with the given method. If no method is given, will fall back\n\
1853 to the system default method. If no format is given, will fall back to the\n\
1854 default format for the given method."},
1855 { "current_recording", gdbpy_current_recording
, METH_NOARGS
,
1856 "current_recording () -> gdb.Record.\n\
1857 Return current recording object." },
1858 { "stop_recording", gdbpy_stop_recording
, METH_NOARGS
,
1859 "stop_recording () -> None.\n\
1860 Stop current recording." },
1862 { "lookup_type", (PyCFunction
) gdbpy_lookup_type
,
1863 METH_VARARGS
| METH_KEYWORDS
,
1864 "lookup_type (name [, block]) -> type\n\
1865 Return a Type corresponding to the given name." },
1866 { "lookup_symbol", (PyCFunction
) gdbpy_lookup_symbol
,
1867 METH_VARARGS
| METH_KEYWORDS
,
1868 "lookup_symbol (name [, block] [, domain]) -> (symbol, is_field_of_this)\n\
1869 Return a tuple with the symbol corresponding to the given name (or None) and\n\
1870 a boolean indicating if name is a field of the current implied argument\n\
1871 `this' (when the current language is object-oriented)." },
1872 { "lookup_global_symbol", (PyCFunction
) gdbpy_lookup_global_symbol
,
1873 METH_VARARGS
| METH_KEYWORDS
,
1874 "lookup_global_symbol (name [, domain]) -> symbol\n\
1875 Return the symbol corresponding to the given name (or None)." },
1877 { "lookup_objfile", (PyCFunction
) gdbpy_lookup_objfile
,
1878 METH_VARARGS
| METH_KEYWORDS
,
1879 "lookup_objfile (name, [by_build_id]) -> objfile\n\
1880 Look up the specified objfile.\n\
1881 If by_build_id is True, the objfile is looked up by using name\n\
1882 as its build id." },
1884 { "block_for_pc", gdbpy_block_for_pc
, METH_VARARGS
,
1885 "Return the block containing the given pc value, or None." },
1886 { "solib_name", gdbpy_solib_name
, METH_VARARGS
,
1887 "solib_name (Long) -> String.\n\
1888 Return the name of the shared library holding a given address, or None." },
1889 { "decode_line", gdbpy_decode_line
, METH_VARARGS
,
1890 "decode_line (String) -> Tuple. Decode a string argument the way\n\
1891 that 'break' or 'edit' does. Return a tuple containing two elements.\n\
1892 The first element contains any unparsed portion of the String parameter\n\
1893 (or None if the string was fully parsed). The second element contains\n\
1894 a tuple that contains all the locations that match, represented as\n\
1895 gdb.Symtab_and_line objects (or None)."},
1896 { "parse_and_eval", gdbpy_parse_and_eval
, METH_VARARGS
,
1897 "parse_and_eval (String) -> Value.\n\
1898 Parse String as an expression, evaluate it, and return the result as a Value."
1900 { "find_pc_line", gdbpy_find_pc_line
, METH_VARARGS
,
1901 "find_pc_line (pc) -> Symtab_and_line.\n\
1902 Return the gdb.Symtab_and_line object corresponding to the pc value." },
1904 { "post_event", gdbpy_post_event
, METH_VARARGS
,
1905 "Post an event into gdb's event loop." },
1907 { "target_charset", gdbpy_target_charset
, METH_NOARGS
,
1908 "target_charset () -> string.\n\
1909 Return the name of the current target charset." },
1910 { "target_wide_charset", gdbpy_target_wide_charset
, METH_NOARGS
,
1911 "target_wide_charset () -> string.\n\
1912 Return the name of the current target wide charset." },
1914 { "string_to_argv", gdbpy_string_to_argv
, METH_VARARGS
,
1915 "string_to_argv (String) -> Array.\n\
1916 Parse String and return an argv-like array.\n\
1917 Arguments are separate by spaces and may be quoted."
1919 { "write", (PyCFunction
)gdbpy_write
, METH_VARARGS
| METH_KEYWORDS
,
1920 "Write a string using gdb's filtered stream." },
1921 { "flush", (PyCFunction
)gdbpy_flush
, METH_VARARGS
| METH_KEYWORDS
,
1922 "Flush gdb's filtered stdout stream." },
1923 { "selected_thread", gdbpy_selected_thread
, METH_NOARGS
,
1924 "selected_thread () -> gdb.InferiorThread.\n\
1925 Return the selected thread object." },
1926 { "selected_inferior", gdbpy_selected_inferior
, METH_NOARGS
,
1927 "selected_inferior () -> gdb.Inferior.\n\
1928 Return the selected inferior object." },
1929 { "inferiors", gdbpy_inferiors
, METH_NOARGS
,
1930 "inferiors () -> (gdb.Inferior, ...).\n\
1931 Return a tuple containing all inferiors." },
1933 { "invalidate_cached_frames", gdbpy_invalidate_cached_frames
, METH_NOARGS
,
1934 "invalidate_cached_frames () -> None.\n\
1935 Invalidate any cached frame objects in gdb.\n\
1936 Intended for internal use only." },
1938 {NULL
, NULL
, 0, NULL
}
1942 struct PyModuleDef python_GdbModuleDef
=
1944 PyModuleDef_HEAD_INIT
,
1956 /* Define all the event objects. */
1957 #define GDB_PY_DEFINE_EVENT_TYPE(name, py_name, doc, base) \
1958 PyTypeObject name##_event_object_type \
1959 CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("event_object") \
1961 PyVarObject_HEAD_INIT (NULL, 0) \
1962 "gdb." py_name, /* tp_name */ \
1963 sizeof (event_object), /* tp_basicsize */ \
1964 0, /* tp_itemsize */ \
1965 evpy_dealloc, /* tp_dealloc */ \
1967 0, /* tp_getattr */ \
1968 0, /* tp_setattr */ \
1969 0, /* tp_compare */ \
1971 0, /* tp_as_number */ \
1972 0, /* tp_as_sequence */ \
1973 0, /* tp_as_mapping */ \
1977 0, /* tp_getattro */ \
1978 0, /* tp_setattro */ \
1979 0, /* tp_as_buffer */ \
1980 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */ \
1982 0, /* tp_traverse */ \
1984 0, /* tp_richcompare */ \
1985 0, /* tp_weaklistoffset */ \
1987 0, /* tp_iternext */ \
1988 0, /* tp_methods */ \
1989 0, /* tp_members */ \
1990 0, /* tp_getset */ \
1991 &base, /* tp_base */ \
1993 0, /* tp_descr_get */ \
1994 0, /* tp_descr_set */ \
1995 0, /* tp_dictoffset */ \
1999 #include "py-event-types.def"
2000 #undef GDB_PY_DEFINE_EVENT_TYPE
2002 #endif /* HAVE_PYTHON */