URL
https://opencores.org/ocsvn/openrisc_me/openrisc_me/trunk
Subversion Repositories openrisc_me
[/] [openrisc/] [trunk/] [gnu-src/] [gdb-7.1/] [gdb/] [python/] [python.c] - Rev 318
Go to most recent revision | Compare with Previous | Blame | View Log
/* General python/gdb code Copyright (C) 2008, 2009, 2010 Free Software Foundation, Inc. This file is part of GDB. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>. */ #include "defs.h" #include "arch-utils.h" #include "command.h" #include "ui-out.h" #include "cli/cli-script.h" #include "gdbcmd.h" #include "objfiles.h" #include "observer.h" #include "value.h" #include "language.h" #include "exceptions.h" #include <ctype.h> /* True if we should print the stack when catching a Python error, false otherwise. */ static int gdbpy_should_print_stack = 1; /* This is true if we should auto-load python code when an objfile is opened, false otherwise. */ static int gdbpy_auto_load = 1; #ifdef HAVE_PYTHON #include "python.h" #include "libiberty.h" #include "cli/cli-decode.h" #include "charset.h" #include "top.h" #include "python-internal.h" #include "version.h" #include "target.h" #include "gdbthread.h" static PyMethodDef GdbMethods[]; PyObject *gdb_module; /* Some string constants we may wish to use. */ PyObject *gdbpy_to_string_cst; PyObject *gdbpy_children_cst; PyObject *gdbpy_display_hint_cst; PyObject *gdbpy_doc_cst; /* Architecture and language to be used in callbacks from the Python interpreter. */ struct gdbarch *python_gdbarch; const struct language_defn *python_language; /* Restore global language and architecture and Python GIL state when leaving the Python interpreter. */ struct python_env { PyGILState_STATE state; struct gdbarch *gdbarch; const struct language_defn *language; }; static void restore_python_env (void *p) { struct python_env *env = (struct python_env *)p; PyGILState_Release (env->state); python_gdbarch = env->gdbarch; python_language = env->language; xfree (env); } /* Called before entering the Python interpreter to install the current language and architecture to be used for Python values. */ struct cleanup * ensure_python_env (struct gdbarch *gdbarch, const struct language_defn *language) { struct python_env *env = xmalloc (sizeof *env); env->state = PyGILState_Ensure (); env->gdbarch = python_gdbarch; env->language = python_language; python_gdbarch = gdbarch; python_language = language; return make_cleanup (restore_python_env, env); } /* Given a command_line, return a command string suitable for passing to Python. Lines in the string are separated by newlines. The return value is allocated using xmalloc and the caller is responsible for freeing it. */ static char * compute_python_string (struct command_line *l) { struct command_line *iter; char *script = NULL; int size = 0; int here; for (iter = l; iter; iter = iter->next) size += strlen (iter->line) + 1; script = xmalloc (size + 1); here = 0; for (iter = l; iter; iter = iter->next) { int len = strlen (iter->line); strcpy (&script[here], iter->line); here += len; script[here++] = '\n'; } script[here] = '\0'; return script; } /* Take a command line structure representing a 'python' command, and evaluate its body using the Python interpreter. */ void eval_python_from_control_command (struct command_line *cmd) { int ret; char *script; struct cleanup *cleanup; if (cmd->body_count != 1) error (_("Invalid \"python\" block structure.")); cleanup = ensure_python_env (get_current_arch (), current_language); script = compute_python_string (cmd->body_list[0]); ret = PyRun_SimpleString (script); xfree (script); if (ret) { gdbpy_print_stack (); error (_("Error while executing Python code.")); } do_cleanups (cleanup); } /* Implementation of the gdb "python" command. */ static void python_command (char *arg, int from_tty) { struct cleanup *cleanup; cleanup = ensure_python_env (get_current_arch (), current_language); while (arg && *arg && isspace (*arg)) ++arg; if (arg && *arg) { if (PyRun_SimpleString (arg)) { gdbpy_print_stack (); error (_("Error while executing Python code.")); } } else { struct command_line *l = get_command_line (python_control, ""); make_cleanup_free_command_lines (&l); execute_control_command_untraced (l); } do_cleanups (cleanup); } /* Transform a gdb parameters's value into a Python value. May return NULL (and set a Python exception) on error. Helper function for get_parameter. */ static PyObject * parameter_to_python (struct cmd_list_element *cmd) { switch (cmd->var_type) { case var_string: case var_string_noescape: case var_optional_filename: case var_filename: case var_enum: { char *str = * (char **) cmd->var; if (! str) str = ""; return PyString_Decode (str, strlen (str), host_charset (), NULL); } case var_boolean: { if (* (int *) cmd->var) Py_RETURN_TRUE; else Py_RETURN_FALSE; } case var_auto_boolean: { enum auto_boolean ab = * (enum auto_boolean *) cmd->var; if (ab == AUTO_BOOLEAN_TRUE) Py_RETURN_TRUE; else if (ab == AUTO_BOOLEAN_FALSE) Py_RETURN_FALSE; else Py_RETURN_NONE; } case var_integer: if ((* (int *) cmd->var) == INT_MAX) Py_RETURN_NONE; /* Fall through. */ case var_zinteger: return PyLong_FromLong (* (int *) cmd->var); case var_uinteger: { unsigned int val = * (unsigned int *) cmd->var; if (val == UINT_MAX) Py_RETURN_NONE; return PyLong_FromUnsignedLong (val); } } return PyErr_Format (PyExc_RuntimeError, "programmer error: unhandled type"); } /* A Python function which returns a gdb parameter's value as a Python value. */ static PyObject * gdbpy_parameter (PyObject *self, PyObject *args) { struct cmd_list_element *alias, *prefix, *cmd; char *arg, *newarg; int found = -1; volatile struct gdb_exception except; if (! PyArg_ParseTuple (args, "s", &arg)) return NULL; newarg = concat ("show ", arg, (char *) NULL); TRY_CATCH (except, RETURN_MASK_ALL) { found = lookup_cmd_composition (newarg, &alias, &prefix, &cmd); } xfree (newarg); GDB_PY_HANDLE_EXCEPTION (except); if (!found) return PyErr_Format (PyExc_RuntimeError, "could not find parameter `%s'", arg); if (! cmd->var) return PyErr_Format (PyExc_RuntimeError, "`%s' is not a parameter", arg); return parameter_to_python (cmd); } /* A Python function which evaluates a string using the gdb CLI. */ static PyObject * execute_gdb_command (PyObject *self, PyObject *args) { struct cmd_list_element *alias, *prefix, *cmd; char *arg, *newarg; PyObject *from_tty_obj = NULL; int from_tty; int cmp; volatile struct gdb_exception except; if (! PyArg_ParseTuple (args, "s|O!", &arg, &PyBool_Type, &from_tty_obj)) return NULL; from_tty = 0; if (from_tty_obj) { cmp = PyObject_IsTrue (from_tty_obj); if (cmp < 0) return NULL; from_tty = cmp; } TRY_CATCH (except, RETURN_MASK_ALL) { /* Copy the argument text in case the command modifies it. */ char *copy = xstrdup (arg); struct cleanup *cleanup = make_cleanup (xfree, copy); execute_command (copy, from_tty); do_cleanups (cleanup); } GDB_PY_HANDLE_EXCEPTION (except); /* Do any commands attached to breakpoint we stopped at. */ bpstat_do_actions (); Py_RETURN_NONE; } /* Parse a string and evaluate it as an expression. */ static PyObject * gdbpy_parse_and_eval (PyObject *self, PyObject *args) { char *expr_str; struct value *result = NULL; volatile struct gdb_exception except; if (!PyArg_ParseTuple (args, "s", &expr_str)) return NULL; TRY_CATCH (except, RETURN_MASK_ALL) { result = parse_and_eval (expr_str); } GDB_PY_HANDLE_EXCEPTION (except); return value_to_value_object (result); } /* Read a file as Python code. STREAM is the input file; FILE is the name of the file. */ void source_python_script (FILE *stream, char *file) { PyGILState_STATE state; state = PyGILState_Ensure (); PyRun_SimpleFile (stream, file); fclose (stream); PyGILState_Release (state); } /* Printing. */ /* A python function to write a single string using gdb's filtered output stream. */ static PyObject * gdbpy_write (PyObject *self, PyObject *args) { char *arg; if (! PyArg_ParseTuple (args, "s", &arg)) return NULL; printf_filtered ("%s", arg); Py_RETURN_NONE; } /* A python function to flush gdb's filtered output stream. */ static PyObject * gdbpy_flush (PyObject *self, PyObject *args) { gdb_flush (gdb_stdout); Py_RETURN_NONE; } /* Print a python exception trace, or print nothing and clear the python exception, depending on gdbpy_should_print_stack. Only call this if a python exception is set. */ void gdbpy_print_stack (void) { if (gdbpy_should_print_stack) PyErr_Print (); else PyErr_Clear (); } /* The "current" objfile. This is set when gdb detects that a new objfile has been loaded. It is only set for the duration of a call to gdbpy_new_objfile; it is NULL at other times. */ static struct objfile *gdbpy_current_objfile; /* The file name we attempt to read. */ #define GDBPY_AUTO_FILENAME "-gdb.py" /* This is a new_objfile observer callback which loads python code based on the path to the objfile. */ static void gdbpy_new_objfile (struct objfile *objfile) { char *realname; char *filename, *debugfile; int len; FILE *input; struct cleanup *cleanups; if (!gdbpy_auto_load || !objfile || !objfile->name) return; cleanups = ensure_python_env (get_objfile_arch (objfile), current_language); gdbpy_current_objfile = objfile; realname = gdb_realpath (objfile->name); len = strlen (realname); filename = xmalloc (len + sizeof (GDBPY_AUTO_FILENAME)); memcpy (filename, realname, len); strcpy (filename + len, GDBPY_AUTO_FILENAME); input = fopen (filename, "r"); debugfile = filename; make_cleanup (xfree, filename); make_cleanup (xfree, realname); if (!input && debug_file_directory) { /* Also try the same file in the separate debug info directory. */ debugfile = xmalloc (strlen (filename) + strlen (debug_file_directory) + 1); strcpy (debugfile, debug_file_directory); /* FILENAME is absolute, so we don't need a "/" here. */ strcat (debugfile, filename); make_cleanup (xfree, debugfile); input = fopen (debugfile, "r"); } if (!input && gdb_datadir) { /* Also try the same file in a subdirectory of gdb's data directory. */ debugfile = xmalloc (strlen (gdb_datadir) + strlen (filename) + strlen ("/auto-load") + 1); strcpy (debugfile, gdb_datadir); strcat (debugfile, "/auto-load"); /* FILENAME is absolute, so we don't need a "/" here. */ strcat (debugfile, filename); make_cleanup (xfree, debugfile); input = fopen (debugfile, "r"); } if (input) { /* We don't want to throw an exception here -- but the user would like to know that something went wrong. */ if (PyRun_SimpleFile (input, debugfile)) gdbpy_print_stack (); fclose (input); } do_cleanups (cleanups); gdbpy_current_objfile = NULL; } /* Return the current Objfile, or None if there isn't one. */ static PyObject * gdbpy_get_current_objfile (PyObject *unused1, PyObject *unused2) { PyObject *result; if (! gdbpy_current_objfile) Py_RETURN_NONE; result = objfile_to_objfile_object (gdbpy_current_objfile); if (result) Py_INCREF (result); return result; } /* Return a sequence holding all the Objfiles. */ static PyObject * gdbpy_objfiles (PyObject *unused1, PyObject *unused2) { struct objfile *objf; PyObject *list; list = PyList_New (0); if (!list) return NULL; ALL_OBJFILES (objf) { PyObject *item = objfile_to_objfile_object (objf); if (!item || PyList_Append (list, item) == -1) { Py_DECREF (list); return NULL; } } return list; } #else /* HAVE_PYTHON */ /* Dummy implementation of the gdb "python" command. */ static void python_command (char *arg, int from_tty) { while (arg && *arg && isspace (*arg)) ++arg; if (arg && *arg) error (_("Python scripting is not supported in this copy of GDB.")); else { struct command_line *l = get_command_line (python_control, ""); struct cleanup *cleanups = make_cleanup_free_command_lines (&l); execute_control_command_untraced (l); do_cleanups (cleanups); } } void eval_python_from_control_command (struct command_line *cmd) { error (_("Python scripting is not supported in this copy of GDB.")); } void source_python_script (FILE *stream, char *file) { fclose (stream); throw_error (UNSUPPORTED_ERROR, _("Python scripting is not supported in this copy of GDB.")); } #endif /* HAVE_PYTHON */ /* Lists for 'maint set python' commands. */ static struct cmd_list_element *set_python_list; static struct cmd_list_element *show_python_list; /* Function for use by 'maint set python' prefix command. */ static void set_python (char *args, int from_tty) { help_list (set_python_list, "maintenance set python ", -1, gdb_stdout); } /* Function for use by 'maint show python' prefix command. */ static void show_python (char *args, int from_tty) { cmd_show_list (show_python_list, from_tty, ""); } /* Initialize the Python code. */ /* Provide a prototype to silence -Wmissing-prototypes. */ extern initialize_file_ftype _initialize_python; void _initialize_python (void) { add_com ("python", class_obscure, python_command, #ifdef HAVE_PYTHON _("\ Evaluate a Python command.\n\ \n\ The command can be given as an argument, for instance:\n\ \n\ python print 23\n\ \n\ If no argument is given, the following lines are read and used\n\ as the Python commands. Type a line containing \"end\" to indicate\n\ the end of the command.") #else /* HAVE_PYTHON */ _("\ Evaluate a Python command.\n\ \n\ Python scripting is not supported in this copy of GDB.\n\ This command is only a placeholder.") #endif /* HAVE_PYTHON */ ); add_prefix_cmd ("python", no_class, show_python, _("Prefix command for python maintenance settings."), &show_python_list, "maintenance show python ", 0, &maintenance_show_cmdlist); add_prefix_cmd ("python", no_class, set_python, _("Prefix command for python maintenance settings."), &set_python_list, "maintenance set python ", 0, &maintenance_set_cmdlist); add_setshow_boolean_cmd ("print-stack", class_maintenance, &gdbpy_should_print_stack, _("\ Enable or disable printing of Python stack dump on error."), _("\ Show whether Python stack will be printed on error."), _("\ Enables or disables printing of Python stack traces."), NULL, NULL, &set_python_list, &show_python_list); add_setshow_boolean_cmd ("auto-load", class_maintenance, &gdbpy_auto_load, _("\ Enable or disable auto-loading of Python code when an object is opened."), _("\ Show whether Python code will be auto-loaded when an object is opened."), _("\ Enables or disables auto-loading of Python code when an object is opened."), NULL, NULL, &set_python_list, &show_python_list); #ifdef HAVE_PYTHON Py_Initialize (); PyEval_InitThreads (); gdb_module = Py_InitModule ("gdb", GdbMethods); /* The casts to (char*) are for python 2.4. */ PyModule_AddStringConstant (gdb_module, "VERSION", (char*) version); PyModule_AddStringConstant (gdb_module, "HOST_CONFIG", (char*) host_name); PyModule_AddStringConstant (gdb_module, "TARGET_CONFIG", (char*) target_name); gdbpy_initialize_values (); gdbpy_initialize_frames (); gdbpy_initialize_commands (); gdbpy_initialize_functions (); gdbpy_initialize_types (); gdbpy_initialize_objfile (); gdbpy_initialize_lazy_string (); PyRun_SimpleString ("import gdb"); PyRun_SimpleString ("gdb.pretty_printers = []"); observer_attach_new_objfile (gdbpy_new_objfile); gdbpy_to_string_cst = PyString_FromString ("to_string"); gdbpy_children_cst = PyString_FromString ("children"); gdbpy_display_hint_cst = PyString_FromString ("display_hint"); gdbpy_doc_cst = PyString_FromString ("__doc__"); /* Create a couple objects which are used for Python's stdout and stderr. */ PyRun_SimpleString ("\ import sys\n\ class GdbOutputFile:\n\ def close(self):\n\ # Do nothing.\n\ return None\n\ \n\ def isatty(self):\n\ return False\n\ \n\ def write(self, s):\n\ gdb.write(s)\n\ \n\ def writelines(self, iterable):\n\ for line in iterable:\n\ self.write(line)\n\ \n\ def flush(self):\n\ gdb.flush()\n\ \n\ sys.stderr = GdbOutputFile()\n\ sys.stdout = GdbOutputFile()\n\ "); /* Release the GIL while gdb runs. */ PyThreadState_Swap (NULL); PyEval_ReleaseLock (); #endif /* HAVE_PYTHON */ } #if HAVE_PYTHON static PyMethodDef GdbMethods[] = { { "history", gdbpy_history, METH_VARARGS, "Get a value from history" }, { "execute", execute_gdb_command, METH_VARARGS, "Execute a gdb command" }, { "parameter", gdbpy_parameter, METH_VARARGS, "Return a gdb parameter's value" }, { "default_visualizer", gdbpy_default_visualizer, METH_VARARGS, "Find the default visualizer for a Value." }, { "current_objfile", gdbpy_get_current_objfile, METH_NOARGS, "Return the current Objfile being loaded, or None." }, { "objfiles", gdbpy_objfiles, METH_NOARGS, "Return a sequence of all loaded objfiles." }, { "selected_frame", gdbpy_selected_frame, METH_NOARGS, "selected_frame () -> gdb.Frame.\n\ Return the selected frame object." }, { "frame_stop_reason_string", gdbpy_frame_stop_reason_string, METH_VARARGS, "stop_reason_string (Integer) -> String.\n\ Return a string explaining unwind stop reason." }, { "lookup_type", (PyCFunction) gdbpy_lookup_type, METH_VARARGS | METH_KEYWORDS, "lookup_type (name [, block]) -> type\n\ Return a Type corresponding to the given name." }, { "parse_and_eval", gdbpy_parse_and_eval, METH_VARARGS, "parse_and_eval (String) -> Value.\n\ Parse String as an expression, evaluate it, and return the result as a Value." }, { "write", gdbpy_write, METH_VARARGS, "Write a string using gdb's filtered stream." }, { "flush", gdbpy_flush, METH_NOARGS, "Flush gdb's filtered stdout stream." }, {NULL, NULL, 0, NULL} }; #endif /* HAVE_PYTHON */
Go to most recent revision | Compare with Previous | Blame | View Log