/* GDB routines for supporting auto-loaded scripts.
- Copyright (C) 2010-2012 Free Software Foundation, Inc.
+ Copyright (C) 2010-2018 Free Software Foundation, Inc.
This file is part of GDB.
along with this program. If not, see <http://www.gnu.org/licenses/>. */
#include "defs.h"
-#include "gdb_string.h"
#include "top.h"
-#include "exceptions.h"
#include "gdbcmd.h"
#include "objfiles.h"
#include "python.h"
-#include "cli/cli-cmds.h"
#include "auto-load.h"
-
-#ifdef HAVE_PYTHON
-
#include "python-internal.h"
-/* NOTE: It's trivial to also support auto-loading normal gdb scripts.
- There has yet to be a need so it's not implemented. */
-
-/* The suffix of per-objfile scripts to auto-load.
- E.g. When the program loads libfoo.so, look for libfoo-gdb.py. */
-#define GDBPY_AUTO_FILE_NAME "-gdb.py"
-
-/* The section to look for scripts (in file formats that support sections).
- Each entry in this section is a byte of value 1, and then the nul-terminated
- name of the script. The script name may include a directory.
- The leading byte is to allow upward compatible extensions. */
-#define GDBPY_AUTO_SECTION_NAME ".debug_gdb_scripts"
-
-/* User-settable option to enable/disable auto-loading:
- set auto-load-scripts on|off
- This is true if we should auto-load associated scripts when an objfile
- is opened, false otherwise.
- At the moment, this only affects python scripts, but there's no reason
- one couldn't also have other kinds of auto-loaded scripts, and there's
- no reason to have them each controlled by a separate flag.
- So we elide "python" from the name here and in the option.
- The fact that it lives here is just an implementation detail. */
-static int auto_load_scripts = 1;
-
-/* Load scripts specified in OBJFILE.
- START,END delimit a buffer containing a list of nul-terminated
- file names.
- SOURCE_NAME is used in error messages.
-
- Scripts are found per normal "source -s" command processing.
- First the script is looked for in $cwd. If not found there the
- source search path is used.
-
- The section contains a list of path names of files containing
- python code to load. Each path is null-terminated. */
+/* User-settable option to enable/disable auto-loading of Python scripts:
+ set auto-load python-scripts on|off
+ This is true if we should auto-load associated Python scripts when an
+ objfile is opened, false otherwise. */
+static int auto_load_python_scripts = 1;
+
+/* "show" command for the auto_load_python_scripts configuration variable. */
static void
-source_section_scripts (struct objfile *objfile, const char *source_name,
- const char *start, const char *end)
+show_auto_load_python_scripts (struct ui_file *file, int from_tty,
+ struct cmd_list_element *c, const char *value)
{
- const char *p;
- struct auto_load_pspace_info *pspace_info;
-
- pspace_info = get_auto_load_pspace_data_for_loading (current_program_space);
-
- for (p = start; p < end; ++p)
- {
- const char *file;
- FILE *stream;
- char *full_path;
- int opened, in_hash_table;
- struct cleanup *back_to;
-
- if (*p != 1)
- {
- warning (_("Invalid entry in %s section"), GDBPY_AUTO_SECTION_NAME);
- /* We could try various heuristics to find the next valid entry,
- but it's safer to just punt. */
- break;
- }
- file = ++p;
-
- while (p < end && *p != '\0')
- ++p;
- if (p == end)
- {
- char *buf = alloca (p - file + 1);
-
- memcpy (buf, file, p - file);
- buf[p - file] = '\0';
- warning (_("Non-null-terminated path in %s: %s"),
- source_name, buf);
- /* Don't load it. */
- break;
- }
- if (p == file)
- {
- warning (_("Empty path in %s"), source_name);
- continue;
- }
-
- opened = find_and_open_script (file, 1 /*search_path*/,
- &stream, &full_path);
-
- back_to = make_cleanup (null_cleanup, NULL);
- if (opened)
- {
- make_cleanup_fclose (stream);
- make_cleanup (xfree, full_path);
- }
-
- /* If one script isn't found it's not uncommon for more to not be
- found either. We don't want to print an error message for each
- script, too much noise. Instead, we print the warning once and tell
- the user how to find the list of scripts that weren't loaded.
-
- IWBN if complaints.c were more general-purpose. */
-
- in_hash_table = maybe_add_script (pspace_info, file,
- opened ? full_path : NULL);
-
- if (! opened)
- {
- /* We don't throw an error, the program is still debuggable. */
- if (script_not_found_warning_print (pspace_info))
- warning (_("Missing auto-load scripts referenced in section %s\n\
-of file %s\n\
-Use `info auto-load-scripts [REGEXP]' to list them."),
- GDBPY_AUTO_SECTION_NAME, objfile->name);
- }
- else
- {
- /* If this file is not currently loaded, load it. */
- if (! in_hash_table)
- source_python_script_for_objfile (objfile, stream, full_path);
- }
-
- do_cleanups (back_to);
- }
+ fprintf_filtered (file, _("Auto-loading of Python scripts is %s.\n"), value);
}
-/* Load scripts specified in section SECTION_NAME of OBJFILE. */
+/* Return non-zero if auto-loading Python scripts is enabled.
+ This is the extension_language_script_ops.auto_load_enabled "method". */
-static void
-auto_load_section_scripts (struct objfile *objfile, const char *section_name)
+int
+gdbpy_auto_load_enabled (const struct extension_language_defn *extlang)
{
- bfd *abfd = objfile->obfd;
- asection *scripts_sect;
- bfd_size_type size;
- char *p;
- struct cleanup *cleanups;
-
- scripts_sect = bfd_get_section_by_name (abfd, section_name);
- if (scripts_sect == NULL)
- return;
-
- size = bfd_get_section_size (scripts_sect);
- p = xmalloc (size);
-
- cleanups = make_cleanup (xfree, p);
-
- if (bfd_get_section_contents (abfd, scripts_sect, p, (file_ptr) 0, size))
- source_section_scripts (objfile, section_name, p, p + size);
- else
- warning (_("Couldn't read %s section of %s"),
- section_name, bfd_get_filename (abfd));
-
- do_cleanups (cleanups);
+ return auto_load_python_scripts;
}
-/* Load any auto-loaded scripts for OBJFILE. */
+/* Wrapper for "info auto-load python-scripts". */
-void
-load_auto_scripts_for_objfile (struct objfile *objfile)
+static void
+info_auto_load_python_scripts (const char *pattern, int from_tty)
{
- if (auto_load_scripts && gdbpy_global_auto_load)
- {
- auto_load_objfile_script (objfile, GDBPY_AUTO_FILE_NAME);
- auto_load_section_scripts (objfile, GDBPY_AUTO_SECTION_NAME);
- }
+ auto_load_info_scripts (pattern, from_tty, &extension_language_python);
}
\f
-void
+int
gdbpy_initialize_auto_load (void)
{
- add_setshow_boolean_cmd ("auto-load-scripts", class_support,
- &auto_load_scripts, _("\
-Set the debugger's behaviour regarding auto-loaded scripts."), _("\
-Show the debugger's behaviour regarding auto-loaded scripts."), _("\
-If enabled, auto-loaded scripts are loaded when the debugger reads\n\
-an executable or shared library."),
- NULL, NULL,
- &setlist,
- &showlist);
-}
-
-#else /* ! HAVE_PYTHON */
+ struct cmd_list_element *cmd;
+ const char *cmd_name;
+
+ add_setshow_boolean_cmd ("python-scripts", class_support,
+ &auto_load_python_scripts, _("\
+Set the debugger's behaviour regarding auto-loaded Python scripts."), _("\
+Show the debugger's behaviour regarding auto-loaded Python scripts."), _("\
+If enabled, auto-loaded Python scripts are loaded when the debugger reads\n\
+an executable or shared library.\n\
+This options has security implications for untrusted inferiors."),
+ NULL, show_auto_load_python_scripts,
+ auto_load_set_cmdlist_get (),
+ auto_load_show_cmdlist_get ());
-void
-load_auto_scripts_for_objfile (struct objfile *objfile)
-{
+ add_setshow_boolean_cmd ("auto-load-scripts", class_support,
+ &auto_load_python_scripts, _("\
+Set the debugger's behaviour regarding auto-loaded Python scripts, "
+ "deprecated."),
+ _("\
+Show the debugger's behaviour regarding auto-loaded Python scripts, "
+ "deprecated."),
+ NULL, NULL, show_auto_load_python_scripts,
+ &setlist, &showlist);
+ cmd_name = "auto-load-scripts";
+ cmd = lookup_cmd (&cmd_name, setlist, "", -1, 1);
+ deprecate_cmd (cmd, "set auto-load python-scripts");
+
+ /* It is needed because lookup_cmd updates the CMD_NAME pointer. */
+ cmd_name = "auto-load-scripts";
+ cmd = lookup_cmd (&cmd_name, showlist, "", -1, 1);
+ deprecate_cmd (cmd, "show auto-load python-scripts");
+
+ add_cmd ("python-scripts", class_info, info_auto_load_python_scripts,
+ _("Print the list of automatically loaded Python scripts.\n\
+Usage: info auto-load python-scripts [REGEXP]"),
+ auto_load_info_cmdlist_get ());
+
+ cmd = add_info ("auto-load-scripts", info_auto_load_python_scripts, _("\
+Print the list of automatically loaded Python scripts, deprecated."));
+ deprecate_cmd (cmd, "info auto-load python-scripts");
+
+ return 0;
}
-
-#endif /* ! HAVE_PYTHON */