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.
This commit is contained in:
Jan Kratochvil
2012-04-17 15:51:48 +00:00
parent e2207b9a28
commit bf88dd6849
14 changed files with 1096 additions and 115 deletions

View File

@@ -27,19 +27,92 @@
#include "command.h"
#include "observer.h"
#include "objfiles.h"
#include "python/python-internal.h"
#include "exceptions.h"
#include "cli/cli-script.h"
#include "gdbcmd.h"
#include "cli/cli-decode.h"
#include "cli/cli-setshow.h"
/* The suffix of per-objfile scripts to auto-load as non-Python command files.
E.g. When the program loads libfoo.so, look for libfoo-gdb.gdb. */
#define GDB_AUTO_FILE_NAME "-gdb.gdb"
static void source_gdb_script_for_objfile (struct objfile *objfile, FILE *file,
const char *filename);
/* User-settable option to enable/disable auto-loading of GDB_AUTO_FILE_NAME
scripts:
set auto-load gdb-scripts on|off
This is true if we should auto-load associated scripts when an objfile
is opened, false otherwise. */
static int auto_load_gdb_scripts = 1;
/* "show" command for the auto_load_gdb_scripts configuration variable. */
static void
show_auto_load_gdb_scripts (struct ui_file *file, int from_tty,
struct cmd_list_element *c, const char *value)
{
fprintf_filtered (file, _("Auto-loading of canned sequences of commands "
"scripts is %s.\n"),
value);
}
/* Internal-use flag to enable/disable auto-loading.
This is true if we should auto-load python code when an objfile is opened,
false otherwise.
Both auto_load_scripts && gdbpy_global_auto_load must be true to enable
Both auto_load_scripts && global_auto_load must be true to enable
auto-loading.
This flag exists to facilitate deferring auto-loading during start-up
until after ./.gdbinit has been read; it may augment the search directories
used to find the scripts. */
int gdbpy_global_auto_load = 1;
int global_auto_load = 1;
/* Auto-load .gdbinit file from the current directory? */
int auto_load_local_gdbinit = 1;
/* Absolute pathname to the current directory .gdbinit, if it exists. */
char *auto_load_local_gdbinit_pathname = NULL;
/* Boolean value if AUTO_LOAD_LOCAL_GDBINIT_PATHNAME has been loaded. */
int auto_load_local_gdbinit_loaded = 0;
/* "show" command for the auto_load_local_gdbinit configuration variable. */
static void
show_auto_load_local_gdbinit (struct ui_file *file, int from_tty,
struct cmd_list_element *c, const char *value)
{
fprintf_filtered (file, _("Auto-loading of .gdbinit script from current "
"directory is %s.\n"),
value);
}
/* Definition of script language for GDB canned sequences of commands. */
static const struct script_language script_language_gdb
= { GDB_AUTO_FILE_NAME, source_gdb_script_for_objfile };
static void
source_gdb_script_for_objfile (struct objfile *objfile, FILE *file,
const char *filename)
{
struct auto_load_pspace_info *pspace_info;
volatile struct gdb_exception e;
/* Add this script to the hash table too so "info auto-load gdb-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_gdb);
TRY_CATCH (e, RETURN_MASK_ALL)
{
script_from_file (file, filename);
}
exception_print (gdb_stderr, e);
}
/* For scripts specified in .debug_gdb_scripts, multiple objfiles may load
the same script. There's no point in loading the script multiple times,
@@ -62,9 +135,12 @@ struct loaded_script
{
/* Name as provided by the objfile. */
const char *name;
/* Full path name or NULL if script wasn't found (or was otherwise
inaccessible). */
const char *full_path;
const struct script_language *language;
};
/* Per-program-space data key. */
@@ -109,7 +185,7 @@ hash_loaded_script_entry (const void *data)
{
const struct loaded_script *e = data;
return htab_hash_string (e->name);
return htab_hash_string (e->name) ^ htab_hash_pointer (e->language);
}
/* Equality function for the loaded script hash. */
@@ -120,7 +196,7 @@ eq_loaded_script_entry (const void *a, const void *b)
const struct loaded_script *ea = a;
const struct loaded_script *eb = b;
return strcmp (ea->name, eb->name) == 0;
return strcmp (ea->name, eb->name) == 0 && ea->language == eb->language;
}
/* Initialize the table to track loaded scripts.
@@ -156,20 +232,21 @@ get_auto_load_pspace_data_for_loading (struct program_space *pspace)
return info;
}
/* Add script NAME to hash table of PSPACE_INFO.
FULL_PATH is NULL if the script wasn't found.
The result is true if the script was already in the hash table. */
/* Add script NAME in LANGUAGE to hash table of PSPACE_INFO.
FULL_PATH is NULL if the script wasn't found. The result is
true if the script was already in the hash table. */
int
maybe_add_script (struct auto_load_pspace_info *pspace_info, const char *name,
const char *full_path)
maybe_add_script (struct auto_load_pspace_info *pspace_info,
const char *name, const char *full_path,
const struct script_language *language)
{
struct htab *htab = pspace_info->loaded_scripts;
struct loaded_script **slot, entry;
int in_hash_table;
entry.name = name;
entry.full_path = full_path;
entry.language = language;
slot = (struct loaded_script **) htab_find_slot (htab, &entry, INSERT);
in_hash_table = *slot != NULL;
@@ -194,6 +271,7 @@ maybe_add_script (struct auto_load_pspace_info *pspace_info, const char *name,
}
else
(*slot)->full_path = NULL;
(*slot)->language = language;
}
return in_hash_table;
@@ -216,10 +294,12 @@ clear_section_scripts (void)
}
}
/* Look for the auto-load script associated with OBJFILE and load it. */
/* Look for the auto-load script in LANGUAGE associated with OBJFILE and load
it. */
void
auto_load_objfile_script (struct objfile *objfile, const char *suffix)
auto_load_objfile_script (struct objfile *objfile,
const struct script_language *language)
{
char *realname;
char *filename, *debugfile;
@@ -229,9 +309,9 @@ auto_load_objfile_script (struct objfile *objfile, const char *suffix)
realname = gdb_realpath (objfile->name);
len = strlen (realname);
filename = xmalloc (len + strlen (suffix) + 1);
filename = xmalloc (len + strlen (language->suffix) + 1);
memcpy (filename, realname, len);
strcpy (filename + len, suffix);
strcpy (filename + len, language->suffix);
cleanups = make_cleanup (xfree, filename);
make_cleanup (xfree, realname);
@@ -269,27 +349,33 @@ auto_load_objfile_script (struct objfile *objfile, const char *suffix)
if (input)
{
struct auto_load_pspace_info *pspace_info;
make_cleanup_fclose (input);
/* Add this script to the hash table too so "info auto-load-scripts"
can print it. */
pspace_info =
get_auto_load_pspace_data_for_loading (current_program_space);
maybe_add_script (pspace_info, debugfile, debugfile);
/* To preserve existing behaviour we don't check for whether the
script was already in the table, and always load it.
It's highly unlikely that we'd ever load it twice,
and these scripts are required to be idempotent under multiple
loads anyway. */
source_python_script_for_objfile (objfile, input, debugfile);
language->source_script_for_objfile (objfile, input, debugfile);
}
do_cleanups (cleanups);
}
/* Load any auto-loaded scripts for OBJFILE. */
void
load_auto_scripts_for_objfile (struct objfile *objfile)
{
if (!global_auto_load)
return;
if (auto_load_gdb_scripts)
auto_load_objfile_script (objfile, &script_language_gdb);
gdbpy_load_auto_scripts_for_objfile (objfile);
}
/* This is a new_objfile observer callback to auto-load scripts.
Two flavors of auto-loaded scripts are supported.
@@ -314,6 +400,13 @@ auto_load_new_objfile (struct objfile *objfile)
typedef struct loaded_script *loaded_script_ptr;
DEF_VEC_P (loaded_script_ptr);
struct collect_matching_scripts_data
{
VEC (loaded_script_ptr) **scripts_p;
const struct script_language *language;
};
/* Traversal function for htab_traverse.
Collect the entry if it matches the regexp. */
@@ -321,10 +414,10 @@ static int
collect_matching_scripts (void **slot, void *info)
{
struct loaded_script *script = *slot;
VEC (loaded_script_ptr) **scripts_ptr = info;
struct collect_matching_scripts_data *data = info;
if (re_exec (script->name))
VEC_safe_push (loaded_script_ptr, *scripts_ptr, script);
if (script->language == data->language && re_exec (script->name))
VEC_safe_push (loaded_script_ptr, *data->scripts_p, script);
return 1;
}
@@ -366,10 +459,18 @@ sort_scripts_by_name (const void *ap, const void *bp)
return FILENAME_CMP (a->name, b->name);
}
/* "info auto-load-scripts" command. */
/* Special internal GDB value of auto_load_info_scripts's PATTERN identify
the "info auto-load XXX" command has been executed through the general
"info auto-load" invocation. Extra newline will be printed if needed. */
char auto_load_info_scripts_pattern_nl[] = "";
static void
info_auto_load_scripts (char *pattern, int from_tty)
/* Implementation for "info auto-load gdb-scripts"
(and "info auto-load python-scripts"). List scripts in LANGUAGE matching
PATTERN. FROM_TTY is the usual GDB boolean for user interactivity. */
void
auto_load_info_scripts (char *pattern, int from_tty,
const struct script_language *language)
{
struct ui_out *uiout = current_uiout;
struct auto_load_pspace_info *pspace_info;
@@ -402,14 +503,22 @@ info_auto_load_scripts (char *pattern, int from_tty)
if (pspace_info != NULL && pspace_info->loaded_scripts != NULL)
{
struct collect_matching_scripts_data data = { &scripts, language };
immediate_quit++;
/* Pass a pointer to scripts as VEC_safe_push can realloc space. */
htab_traverse_noresize (pspace_info->loaded_scripts,
collect_matching_scripts, &scripts);
collect_matching_scripts, &data);
immediate_quit--;
}
nr_scripts = VEC_length (loaded_script_ptr, scripts);
/* Table header shifted right by preceding "gdb-scripts: " would not match
its columns. */
if (nr_scripts > 0 && pattern == auto_load_info_scripts_pattern_nl)
ui_out_text (uiout, "\n");
make_cleanup_ui_out_table_begin_end (uiout, 2, nr_scripts,
"AutoLoadedScriptsTable");
@@ -441,6 +550,29 @@ info_auto_load_scripts (char *pattern, int from_tty)
}
}
/* Wrapper for "info auto-load gdb-scripts". */
static void
info_auto_load_gdb_scripts (char *pattern, int from_tty)
{
auto_load_info_scripts (pattern, from_tty, &script_language_gdb);
}
/* Implement 'info auto-load local-gdbinit'. */
static void
info_auto_load_local_gdbinit (char *args, int from_tty)
{
if (auto_load_local_gdbinit_pathname == NULL)
printf_filtered (_("Local .gdbinit file was not found.\n"));
else if (auto_load_local_gdbinit_loaded)
printf_filtered (_("Local .gdbinit file \"%s\" has been loaded.\n"),
auto_load_local_gdbinit_pathname);
else
printf_filtered (_("Local .gdbinit file \"%s\" has not been loaded.\n"),
auto_load_local_gdbinit_pathname);
}
/* Return non-zero if SCRIPT_NOT_FOUND_WARNING_PRINTED of PSPACE_INFO was unset
before calling this function. Always set SCRIPT_NOT_FOUND_WARNING_PRINTED
of PSPACE_INFO. */
@@ -455,6 +587,132 @@ script_not_found_warning_print (struct auto_load_pspace_info *pspace_info)
return retval;
}
/* The only valid "set auto-load" argument is off|0|no|disable. */
static void
set_auto_load_cmd (char *args, int from_tty)
{
struct cmd_list_element *list;
size_t length;
/* See parse_binary_operation in use by the sub-commands. */
length = args ? strlen (args) : 0;
while (length > 0 && (args[length - 1] == ' ' || args[length - 1] == '\t'))
length--;
if (length == 0 || (strncmp (args, "off", length) != 0
&& strncmp (args, "0", length) != 0
&& strncmp (args, "no", length) != 0
&& strncmp (args, "disable", length) != 0))
error (_("Valid is only global 'set auto-load no'; "
"otherwise check the auto-load sub-commands."));
for (list = *auto_load_set_cmdlist_get (); list != NULL; list = list->next)
if (list->var_type == var_boolean)
{
gdb_assert (list->type == set_cmd);
do_setshow_command (args, from_tty, list);
}
}
/* Initialize "set auto-load " commands prefix and return it. */
struct cmd_list_element **
auto_load_set_cmdlist_get (void)
{
static struct cmd_list_element *retval;
if (retval == NULL)
add_prefix_cmd ("auto-load", class_maintenance, set_auto_load_cmd, _("\
Auto-loading specific settings.\n\
Configure various auto-load-specific variables such as\n\
automatic loading of Python scripts."),
&retval, "set auto-load ",
1/*allow-unknown*/, &setlist);
return &retval;
}
/* Command "show auto-load" displays summary of all the current
"show auto-load " settings. */
static void
show_auto_load_cmd (char *args, int from_tty)
{
cmd_show_list (*auto_load_show_cmdlist_get (), from_tty, "");
}
/* Initialize "show auto-load " commands prefix and return it. */
struct cmd_list_element **
auto_load_show_cmdlist_get (void)
{
static struct cmd_list_element *retval;
if (retval == NULL)
add_prefix_cmd ("auto-load", class_maintenance, show_auto_load_cmd, _("\
Show auto-loading specific settings.\n\
Show configuration of various auto-load-specific variables such as\n\
automatic loading of Python scripts."),
&retval, "show auto-load ",
0/*allow-unknown*/, &showlist);
return &retval;
}
/* Command "info auto-load" displays whether the various auto-load files have
been loaded. This is reimplementation of cmd_show_list which inserts
newlines at proper places. */
static void
info_auto_load_cmd (char *args, int from_tty)
{
struct cmd_list_element *list;
struct cleanup *infolist_chain;
struct ui_out *uiout = current_uiout;
infolist_chain = make_cleanup_ui_out_tuple_begin_end (uiout, "infolist");
for (list = *auto_load_info_cmdlist_get (); list != NULL; list = list->next)
{
struct cleanup *option_chain
= make_cleanup_ui_out_tuple_begin_end (uiout, "option");
gdb_assert (!list->prefixlist);
gdb_assert (list->type == not_set_cmd);
ui_out_field_string (uiout, "name", list->name);
ui_out_text (uiout, ": ");
cmd_func (list, auto_load_info_scripts_pattern_nl, from_tty);
/* Close the tuple. */
do_cleanups (option_chain);
}
/* Close the tuple. */
do_cleanups (infolist_chain);
}
/* Initialize "info auto-load " commands prefix and return it. */
struct cmd_list_element **
auto_load_info_cmdlist_get (void)
{
static struct cmd_list_element *retval;
if (retval == NULL)
add_prefix_cmd ("auto-load", class_info, info_auto_load_cmd, _("\
Print current status of auto-loaded files.\n\
Print whether various files like Python scripts or .gdbinit files have been\n\
found and/or loaded."),
&retval, "info auto-load ",
0/*allow-unknown*/, &infolist);
return &retval;
}
void _initialize_auto_load (void);
void
@@ -465,8 +723,38 @@ _initialize_auto_load (void)
observer_attach_new_objfile (auto_load_new_objfile);
add_info ("auto-load-scripts",
info_auto_load_scripts,
_("Print the list of automatically loaded scripts.\n\
Usage: info auto-load-scripts [REGEXP]"));
add_setshow_boolean_cmd ("gdb-scripts", class_support,
&auto_load_gdb_scripts, _("\
Enable or disable auto-loading of canned sequences of commands scripts."), _("\
Show whether auto-loading of canned sequences of commands scripts is enabled."),
_("\
If enabled, canned sequences of commands 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_gdb_scripts,
auto_load_set_cmdlist_get (),
auto_load_show_cmdlist_get ());
add_cmd ("gdb-scripts", class_info, info_auto_load_gdb_scripts,
_("Print the list of automatically loaded sequences of commands.\n\
Usage: info auto-load gdb-scripts [REGEXP]"),
auto_load_info_cmdlist_get ());
add_setshow_boolean_cmd ("local-gdbinit", class_support,
&auto_load_local_gdbinit, _("\
Enable or disable auto-loading of .gdbinit script in current directory."), _("\
Show whether auto-loading .gdbinit script in current directory is enabled."),
_("\
If enabled, canned sequences of commands are loaded when debugger starts\n\
from .gdbinit file in current directory. Such files are deprecated,\n\
use a script associated with inferior executable file instead.\n\
This options has security implications for untrusted inferiors."),
NULL, show_auto_load_local_gdbinit,
auto_load_set_cmdlist_get (),
auto_load_show_cmdlist_get ());
add_cmd ("local-gdbinit", class_info, info_auto_load_local_gdbinit,
_("Print whether current directory .gdbinit file has been loaded.\n\
Usage: info auto-load local-gdbinit"),
auto_load_info_cmdlist_get ());
}