From bf88dd68493db2b646b42165e6258573d3a597b5 Mon Sep 17 00:00:00 2001 From: Jan Kratochvil Date: Tue, 17 Apr 2012 15:51:48 +0000 Subject: gdb/ auto-load: Implementation. * NEWS: New descriptions for "info auto-load", "info auto-load gdb-scripts", "info auto-load python-scripts", "info auto-load local-gdbinit" and "info auto-load libthread-db". Deprecate "info auto-load-scripts", "set auto-load-scripts on|off" and "show auto-load-scripts". New description for "set auto-load", "show auto-load", "set auto-load gdb-scripts", "show auto-load gdb-scripts", "set auto-load python-scripts", "show auto-load python-scripts", "set auto-load local-gdbinit", "show auto-load local-gdbinit", "set auto-load libthread-db" and "show auto-load libthread-db". * auto-load.c: Remove include python/python-internal.h. Add includes exceptions.h, cli/cli-script.h, gdbcmd.h, cli/cli-decode.h and cli/cli-setshow.h. (GDB_AUTO_FILE_NAME, source_gdb_script_for_objfile) (auto_load_gdb_scripts, show_auto_load_gdb_scripts): New. (gdbpy_global_auto_load): Rename to ... (global_auto_load): ... here. (auto_load_local_gdbinit, auto_load_local_gdbinit_pathname) (auto_load_local_gdbinit_loaded, show_auto_load_local_gdbinit) (script_language_gdb, source_gdb_script_for_objfile): New. (struct loaded_script): New field language. (hash_loaded_script_entry, eq_loaded_script_entry): Calculate also LANGUAGE. (maybe_add_script): Add parameter language. Drop redundant entry.full_path initialization. Initialize entry.language and (*slot)->language. (auto_load_objfile_script): Change parameter suffix to language. Remove the call of maybe_add_script. Call language->source_script_for_objfile. (load_auto_scripts_for_objfile, struct collect_matching_scripts_data): New. (collect_matching_scripts): Adjust it for struct collect_matching_scripts_data. (auto_load_info_scripts_pattern_nl): New variable. (info_auto_load_scripts): Rename to ... (auto_load_info_scripts): ... here, add parameter language. Adjust it for struct collect_matching_scripts_data. (info_auto_load_gdb_scripts, info_auto_load_local_gdbinit) (set_auto_load_cmd, auto_load_set_cmdlist_get, show_auto_load_cmd) (auto_load_show_cmdlist_get, info_auto_load_cmd) (auto_load_info_cmdlist_get): New. (_initialize_auto_load): Move add_info of "auto-load-scripts" to python/py-auto-load.c. New installment for "set auto-load gdb-scripts", "info auto-load gdb-scripts", "set auto-load local-gdbinit" and "info auto-load local-gdbinit". * auto-load.h (struct script_language): New. (gdbpy_global_auto_load): Rename to ... (global_auto_load): ... here. (auto_load_local_gdbinit, auto_load_local_gdbinit_pathname) (auto_load_local_gdbinit_loaded): New declarations. (maybe_add_script): New parameter language. (auto_load_objfile_script): Change parameter suffix to language. (load_auto_scripts_for_objfile, auto_load_info_scripts_pattern_nl) (auto_load_info_scripts, auto_load_set_cmdlist_get) (auto_load_show_cmdlist_get, auto_load_info_cmdlist_get): New declarations. * linux-thread-db.c: Include auto-load.h and ctype.h. (auto_load_thread_db, show_auto_load_thread_db): New. (struct thread_db_info): New field filename. (delete_thread_db_info): Call xfree for FILENAME. (try_thread_db_load): Initialize FILENAME. (try_thread_db_load_from_pdir, try_thread_db_load_from_dir): Return if !AUTO_LOAD_THREAD_DB. (info_auto_load_libthread_db_compare, info_auto_load_libthread_db): New. (_initialize_thread_db): Install auto_load_thread_db as "set auto-load libthread-db" and install info_auto_load_libthread_db as "info auto-load libthread-db". * main.c (captured_main): Rename gdbpy_global_auto_load to global_auto_load. Initialize AUTO_LOAD_LOCAL_GDBINIT_PATHNAME and AUTO_LOAD_LOCAL_GDBINIT_LOADED. (print_gdb_help): Extend the help for 'local init file'. * python/py-auto-load.c: Remove a comment about gdb scripts extension. (GDBPY_AUTO_SECTION_NAME): Extend the comment it is Python specific. (auto_load_scripts): Rename to ... (auto_load_python_scripts): ... here, update the comment. (gdbpy_load_auto_script_for_objfile): New declaration. (show_auto_load_python_scripts, script_language_python) (gdbpy_load_auto_script_for_objfile): New. (source_section_scripts): Refactor the code. (load_auto_scripts_for_objfile): Rename to ... (gdbpy_load_auto_scripts_for_objfile): ... here, update the auto_load_objfile_script caller, drop GDBPY_GLOBAL_AUTO_LOAD checking. (info_auto_load_python_scripts): New. (gdbpy_initialize_auto_load): New variables cmd and cmd_name. Rename "set auto-load-scripts" to "set auto-load python-scripts". Register "set auto-load-scripts" as its deprecated alias. Register "info auto-load python-scripts". Register "info auto-load-scripts" as its deprecated alias. (load_auto_scripts_for_objfile): Rename to ... (gdbpy_load_auto_scripts_for_objfile): ... here. * python/python.h (load_auto_scripts_for_objfile): Rename to ... (gdbpy_load_auto_scripts_for_objfile): ... here. gdb/doc/ auto-load: Implementation. * gdb.texinfo (Mode Options): New anchor for -nx. (Startup): New anchors for Option -init-eval-command, Home Directory Init File and Init File in the Current Directory during Startup. Mention set auto-load local-gdbinit with a reference. Change the sample code to "set auto-load python-scripts". (Threads): New anchor set libthread-db-search-path. Provide references to libthread_db.so.1 file. (Controlling GDB): New menu item for Auto-loading. (Auto-loading, Init File in the Current Directory) (libthread_db.so.1 file, objfile-gdb.gdb file): New nodes. (Python): Rename the menu item Auto-loading to Python Auto-loading. (Writing a Pretty-Printer, Objfiles In Python): Update the renamed reference. (Auto-loading): Rename to ... (Python Auto-loading): ... here. Change "set auto-load-scripts" to "set auto-load python-scripts", new anchor for it. Change "show auto-load-scripts" to "show auto-load python-scripts", new anchor for it. Change "info auto-load-scripts" to "info auto-load python-scripts", new anchor for it. Change "scripts" to "Python scripts". gdb/testsuite/ auto-load: Implementation. * gdb.base/help.exp (test set height): Increase the height. * gdb.python/py-objfile-script.exp (info auto-load-scripts): Change to ... (info auto-load python-scripts): ... here. * gdb.python/py-section-script.exp (info auto-load-scripts *): Change to ... (info auto-load python-scripts *): ... here. --- gdb/python/py-auto-load.c | 153 +++++++++++++++++++++++++++++++++------------- gdb/python/python.h | 2 +- 2 files changed, 110 insertions(+), 45 deletions(-) (limited to 'gdb/python') diff --git a/gdb/python/py-auto-load.c b/gdb/python/py-auto-load.c index a80960b..7eb021c 100644 --- a/gdb/python/py-auto-load.c +++ b/gdb/python/py-auto-load.c @@ -31,29 +31,56 @@ #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). +/* The section to look for Python auto-loaded 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; +/* 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; + +static void gdbpy_load_auto_script_for_objfile (struct objfile *objfile, + FILE *file, + const char *filename); + +/* "show" command for the auto_load_python_scripts configuration variable. */ + +static void +show_auto_load_python_scripts (struct ui_file *file, int from_tty, + struct cmd_list_element *c, const char *value) +{ + fprintf_filtered (file, _("Auto-loading of Python scripts is %s.\n"), value); +} + +/* Definition of script language for Python scripts. */ + +static const struct script_language script_language_python + = { GDBPY_AUTO_FILE_NAME, gdbpy_load_auto_script_for_objfile }; + +/* Wrapper of source_python_script_for_objfile for script_language_python. */ + +static void +gdbpy_load_auto_script_for_objfile (struct objfile *objfile, FILE *file, + const char *filename) +{ + struct auto_load_pspace_info *pspace_info; + + /* Add this script to the hash table too so "info auto-load python-scripts" + can print it. */ + pspace_info = get_auto_load_pspace_data_for_loading (current_program_space); + maybe_add_script (pspace_info, filename, filename, &script_language_python); + + source_python_script_for_objfile (objfile, file, filename); +} /* Load scripts specified in OBJFILE. START,END delimit a buffer containing a list of nul-terminated @@ -121,6 +148,17 @@ source_section_scripts (struct objfile *objfile, const char *source_name, make_cleanup_fclose (stream); make_cleanup (xfree, full_path); } + else + { + full_path = NULL; + + /* 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 python [REGEXP]' to list them."), + GDBPY_AUTO_SECTION_NAME, objfile->name); + } /* 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 @@ -129,24 +167,12 @@ source_section_scripts (struct objfile *objfile, const char *source_name, IWBN if complaints.c were more general-purpose. */ - in_hash_table = maybe_add_script (pspace_info, file, - opened ? full_path : NULL); + in_hash_table = maybe_add_script (pspace_info, file, full_path, + &script_language_python); - 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); - } + /* If this file is not currently loaded, load it. */ + if (opened && !in_hash_table) + source_python_script_for_objfile (objfile, stream, full_path); do_cleanups (back_to); } @@ -181,36 +207,75 @@ auto_load_section_scripts (struct objfile *objfile, const char *section_name) do_cleanups (cleanups); } -/* Load any auto-loaded scripts for OBJFILE. */ +/* Load any Python auto-loaded scripts for OBJFILE. */ void -load_auto_scripts_for_objfile (struct objfile *objfile) +gdbpy_load_auto_scripts_for_objfile (struct objfile *objfile) { - if (auto_load_scripts && gdbpy_global_auto_load) + if (auto_load_python_scripts) { - auto_load_objfile_script (objfile, GDBPY_AUTO_FILE_NAME); + auto_load_objfile_script (objfile, &script_language_python); auto_load_section_scripts (objfile, GDBPY_AUTO_SECTION_NAME); } } + +/* Wrapper for "info auto-load python-scripts". */ + +static void +info_auto_load_python_scripts (char *pattern, int from_tty) +{ + auto_load_info_scripts (pattern, from_tty, &script_language_python); +} void gdbpy_initialize_auto_load (void) { + struct cmd_list_element *cmd; + 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 ()); + 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); + &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"); } #else /* ! HAVE_PYTHON */ void -load_auto_scripts_for_objfile (struct objfile *objfile) +gdbpy_load_auto_scripts_for_objfile (struct objfile *objfile) { } diff --git a/gdb/python/python.h b/gdb/python/python.h index 08eb29e..dd7066f 100644 --- a/gdb/python/python.h +++ b/gdb/python/python.h @@ -39,7 +39,7 @@ int apply_val_pretty_printer (struct type *type, const gdb_byte *valaddr, void preserve_python_values (struct objfile *objfile, htab_t copied_types); -void load_auto_scripts_for_objfile (struct objfile *objfile); +void gdbpy_load_auto_scripts_for_objfile (struct objfile *objfile); int gdbpy_should_stop (struct breakpoint_object *bp_obj); -- cgit v1.1