1 /* GDB routines for supporting auto-loaded scripts.
3 Copyright (C) 2012-2014 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 "auto-load.h"
22 #include "progspace.h"
23 #include "gdb_regex.h"
25 #include "filenames.h"
29 #include "cli/cli-script.h"
31 #include "cli/cli-cmds.h"
32 #include "cli/cli-decode.h"
33 #include "cli/cli-setshow.h"
35 #include "readline/tilde.h"
36 #include "completer.h"
39 #include "filestuff.h"
40 #include "extension.h"
41 #include "gdb/section-scripts.h"
43 /* The section to look in for auto-loaded scripts (in file formats that
45 Each entry in this section is a record that begins with a leading byte
46 identifying the record type.
47 At the moment we only support one record type: A leading byte of 1,
48 followed by the path of a python script to load. */
49 #define AUTO_SECTION_NAME ".debug_gdb_scripts"
51 static int maybe_add_script (struct auto_load_pspace_info *pspace_info,
52 int loaded, const char *name,
53 const char *full_path,
54 const struct extension_language_defn *language);
56 static int unsupported_script_warning_print (struct auto_load_pspace_info *);
58 static int script_not_found_warning_print (struct auto_load_pspace_info *);
60 /* Value of the 'set debug auto-load' configuration variable. */
61 static int debug_auto_load = 0;
63 /* "show" command for the debug_auto_load configuration variable. */
66 show_debug_auto_load (struct ui_file *file, int from_tty,
67 struct cmd_list_element *c, const char *value)
69 fprintf_filtered (file, _("Debugging output for files "
70 "of 'set auto-load ...' is %s.\n"),
74 /* User-settable option to enable/disable auto-loading of GDB_AUTO_FILE_NAME
76 set auto-load gdb-scripts on|off
77 This is true if we should auto-load associated scripts when an objfile
78 is opened, false otherwise. */
79 static int auto_load_gdb_scripts = 1;
81 /* "show" command for the auto_load_gdb_scripts configuration variable. */
84 show_auto_load_gdb_scripts (struct ui_file *file, int from_tty,
85 struct cmd_list_element *c, const char *value)
87 fprintf_filtered (file, _("Auto-loading of canned sequences of commands "
92 /* Return non-zero if auto-loading gdb scripts is enabled. */
95 auto_load_gdb_scripts_enabled (const struct extension_language_defn *extlang)
97 return auto_load_gdb_scripts;
100 /* Internal-use flag to enable/disable auto-loading.
101 This is true if we should auto-load python code when an objfile is opened,
104 Both auto_load_scripts && global_auto_load must be true to enable
107 This flag exists to facilitate deferring auto-loading during start-up
108 until after ./.gdbinit has been read; it may augment the search directories
109 used to find the scripts. */
110 int global_auto_load = 1;
112 /* Auto-load .gdbinit file from the current directory? */
113 int auto_load_local_gdbinit = 1;
115 /* Absolute pathname to the current directory .gdbinit, if it exists. */
116 char *auto_load_local_gdbinit_pathname = NULL;
118 /* Boolean value if AUTO_LOAD_LOCAL_GDBINIT_PATHNAME has been loaded. */
119 int auto_load_local_gdbinit_loaded = 0;
121 /* "show" command for the auto_load_local_gdbinit configuration variable. */
124 show_auto_load_local_gdbinit (struct ui_file *file, int from_tty,
125 struct cmd_list_element *c, const char *value)
127 fprintf_filtered (file, _("Auto-loading of .gdbinit script from current "
128 "directory is %s.\n"),
132 /* Directory list from which to load auto-loaded scripts. It is not checked
133 for absolute paths but they are strongly recommended. It is initialized by
134 _initialize_auto_load. */
135 static char *auto_load_dir;
137 /* "set" command for the auto_load_dir configuration variable. */
140 set_auto_load_dir (char *args, int from_tty, struct cmd_list_element *c)
142 /* Setting the variable to "" resets it to the compile time defaults. */
143 if (auto_load_dir[0] == '\0')
145 xfree (auto_load_dir);
146 auto_load_dir = xstrdup (AUTO_LOAD_DIR);
150 /* "show" command for the auto_load_dir configuration variable. */
153 show_auto_load_dir (struct ui_file *file, int from_tty,
154 struct cmd_list_element *c, const char *value)
156 fprintf_filtered (file, _("List of directories from which to load "
157 "auto-loaded scripts is %s.\n"),
161 /* Directory list safe to hold auto-loaded files. It is not checked for
162 absolute paths but they are strongly recommended. It is initialized by
163 _initialize_auto_load. */
164 static char *auto_load_safe_path;
166 /* Vector of directory elements of AUTO_LOAD_SAFE_PATH with each one normalized
167 by tilde_expand and possibly each entries has added its gdb_realpath
169 static VEC (char_ptr) *auto_load_safe_path_vec;
171 /* Expand $datadir and $debugdir in STRING according to the rules of
172 substitute_path_component. Return vector from dirnames_to_char_ptr_vec,
173 this vector must be freed by free_char_ptr_vec by the caller. */
175 static VEC (char_ptr) *
176 auto_load_expand_dir_vars (const char *string)
178 VEC (char_ptr) *dir_vec;
181 s = xstrdup (string);
182 substitute_path_component (&s, "$datadir", gdb_datadir);
183 substitute_path_component (&s, "$debugdir", debug_file_directory);
185 if (debug_auto_load && strcmp (s, string) != 0)
186 fprintf_unfiltered (gdb_stdlog,
187 _("auto-load: Expanded $-variables to \"%s\".\n"), s);
189 dir_vec = dirnames_to_char_ptr_vec (s);
195 /* Update auto_load_safe_path_vec from current AUTO_LOAD_SAFE_PATH. */
198 auto_load_safe_path_vec_update (void)
204 fprintf_unfiltered (gdb_stdlog,
205 _("auto-load: Updating directories of \"%s\".\n"),
206 auto_load_safe_path);
208 free_char_ptr_vec (auto_load_safe_path_vec);
210 auto_load_safe_path_vec = auto_load_expand_dir_vars (auto_load_safe_path);
211 len = VEC_length (char_ptr, auto_load_safe_path_vec);
213 /* Apply tilde_expand and gdb_realpath to each AUTO_LOAD_SAFE_PATH_VEC
215 for (ix = 0; ix < len; ix++)
217 char *dir = VEC_index (char_ptr, auto_load_safe_path_vec, ix);
218 char *expanded = tilde_expand (dir);
219 char *real_path = gdb_realpath (expanded);
221 /* Ensure the current entry is at least tilde_expand-ed. */
222 VEC_replace (char_ptr, auto_load_safe_path_vec, ix, expanded);
226 if (strcmp (expanded, dir) == 0)
227 fprintf_unfiltered (gdb_stdlog,
228 _("auto-load: Using directory \"%s\".\n"),
231 fprintf_unfiltered (gdb_stdlog,
232 _("auto-load: Resolved directory \"%s\" "
238 /* If gdb_realpath returns a different content, append it. */
239 if (strcmp (real_path, expanded) == 0)
243 VEC_safe_push (char_ptr, auto_load_safe_path_vec, real_path);
246 fprintf_unfiltered (gdb_stdlog,
247 _("auto-load: And canonicalized as \"%s\".\n"),
253 /* Variable gdb_datadir has been set. Update content depending on $datadir. */
256 auto_load_gdb_datadir_changed (void)
258 auto_load_safe_path_vec_update ();
261 /* "set" command for the auto_load_safe_path configuration variable. */
264 set_auto_load_safe_path (char *args, int from_tty, struct cmd_list_element *c)
266 /* Setting the variable to "" resets it to the compile time defaults. */
267 if (auto_load_safe_path[0] == '\0')
269 xfree (auto_load_safe_path);
270 auto_load_safe_path = xstrdup (AUTO_LOAD_SAFE_PATH);
273 auto_load_safe_path_vec_update ();
276 /* "show" command for the auto_load_safe_path configuration variable. */
279 show_auto_load_safe_path (struct ui_file *file, int from_tty,
280 struct cmd_list_element *c, const char *value)
284 /* Check if user has entered either "/" or for example ":".
285 But while more complicate content like ":/foo" would still also
286 permit any location do not hide those. */
288 for (cs = value; *cs && (*cs == DIRNAME_SEPARATOR || IS_DIR_SEPARATOR (*cs));
291 fprintf_filtered (file, _("Auto-load files are safe to load from any "
294 fprintf_filtered (file, _("List of directories from which it is safe to "
295 "auto-load files is %s.\n"),
299 /* "add-auto-load-safe-path" command for the auto_load_safe_path configuration
303 add_auto_load_safe_path (char *args, int from_tty)
307 if (args == NULL || *args == 0)
309 Directory argument required.\n\
310 Use 'set auto-load safe-path /' for disabling the auto-load safe-path security.\
313 s = xstrprintf ("%s%c%s", auto_load_safe_path, DIRNAME_SEPARATOR, args);
314 xfree (auto_load_safe_path);
315 auto_load_safe_path = s;
317 auto_load_safe_path_vec_update ();
320 /* "add-auto-load-scripts-directory" command for the auto_load_dir configuration
324 add_auto_load_dir (char *args, int from_tty)
328 if (args == NULL || *args == 0)
329 error (_("Directory argument required."));
331 s = xstrprintf ("%s%c%s", auto_load_dir, DIRNAME_SEPARATOR, args);
332 xfree (auto_load_dir);
336 /* Implementation for filename_is_in_pattern overwriting the caller's FILENAME
340 filename_is_in_pattern_1 (char *filename, char *pattern)
342 size_t pattern_len = strlen (pattern);
343 size_t filename_len = strlen (filename);
346 fprintf_unfiltered (gdb_stdlog, _("auto-load: Matching file \"%s\" "
347 "to pattern \"%s\"\n"),
350 /* Trim trailing slashes ("/") from PATTERN. Even for "d:\" paths as
351 trailing slashes are trimmed also from FILENAME it still matches
353 while (pattern_len && IS_DIR_SEPARATOR (pattern[pattern_len - 1]))
355 pattern[pattern_len] = '\0';
357 /* Ensure auto_load_safe_path "/" matches any FILENAME. On MS-Windows
358 platform FILENAME even after gdb_realpath does not have to start with
359 IS_DIR_SEPARATOR character, such as the 'C:\x.exe' filename. */
360 if (pattern_len == 0)
363 fprintf_unfiltered (gdb_stdlog,
364 _("auto-load: Matched - empty pattern\n"));
370 /* Trim trailing slashes ("/"). PATTERN also has slashes trimmed the
371 same way so they will match. */
372 while (filename_len && IS_DIR_SEPARATOR (filename[filename_len - 1]))
374 filename[filename_len] = '\0';
375 if (filename_len == 0)
378 fprintf_unfiltered (gdb_stdlog,
379 _("auto-load: Not matched - pattern \"%s\".\n"),
384 if (gdb_filename_fnmatch (pattern, filename, FNM_FILE_NAME | FNM_NOESCAPE)
388 fprintf_unfiltered (gdb_stdlog, _("auto-load: Matched - file "
389 "\"%s\" to pattern \"%s\".\n"),
394 /* Trim trailing FILENAME component. */
395 while (filename_len > 0 && !IS_DIR_SEPARATOR (filename[filename_len - 1]))
400 /* Return 1 if FILENAME matches PATTERN or if FILENAME resides in
401 a subdirectory of a directory that matches PATTERN. Return 0 otherwise.
402 gdb_realpath normalization is never done here. */
404 static ATTRIBUTE_PURE int
405 filename_is_in_pattern (const char *filename, const char *pattern)
407 char *filename_copy, *pattern_copy;
409 filename_copy = alloca (strlen (filename) + 1);
410 strcpy (filename_copy, filename);
411 pattern_copy = alloca (strlen (pattern) + 1);
412 strcpy (pattern_copy, pattern);
414 return filename_is_in_pattern_1 (filename_copy, pattern_copy);
417 /* Return 1 if FILENAME belongs to one of directory components of
418 AUTO_LOAD_SAFE_PATH_VEC. Return 0 otherwise.
419 auto_load_safe_path_vec_update is never called.
420 *FILENAME_REALP may be updated by gdb_realpath of FILENAME - it has to be
421 freed by the caller. */
424 filename_is_in_auto_load_safe_path_vec (const char *filename,
425 char **filename_realp)
430 for (ix = 0; VEC_iterate (char_ptr, auto_load_safe_path_vec, ix, pattern);
432 if (*filename_realp == NULL && filename_is_in_pattern (filename, pattern))
437 if (*filename_realp == NULL)
439 *filename_realp = gdb_realpath (filename);
440 if (debug_auto_load && strcmp (*filename_realp, filename) != 0)
441 fprintf_unfiltered (gdb_stdlog,
442 _("auto-load: Resolved "
443 "file \"%s\" as \"%s\".\n"),
444 filename, *filename_realp);
447 if (strcmp (*filename_realp, filename) != 0)
449 VEC_iterate (char_ptr, auto_load_safe_path_vec, ix, pattern); ++ix)
450 if (filename_is_in_pattern (*filename_realp, pattern))
457 fprintf_unfiltered (gdb_stdlog, _("auto-load: File \"%s\" matches "
458 "directory \"%s\".\n"),
466 /* Return 1 if FILENAME is located in one of the directories of
467 AUTO_LOAD_SAFE_PATH. Otherwise call warning and return 0. FILENAME does
468 not have to be an absolute path.
470 Existence of FILENAME is not checked. Function will still give a warning
471 even if the caller would quietly skip non-existing file in unsafe
475 file_is_auto_load_safe (const char *filename, const char *debug_fmt, ...)
477 char *filename_real = NULL;
478 struct cleanup *back_to;
479 static int advice_printed = 0;
485 va_start (debug_args, debug_fmt);
486 vfprintf_unfiltered (gdb_stdlog, debug_fmt, debug_args);
490 back_to = make_cleanup (free_current_contents, &filename_real);
492 if (filename_is_in_auto_load_safe_path_vec (filename, &filename_real))
494 do_cleanups (back_to);
498 auto_load_safe_path_vec_update ();
499 if (filename_is_in_auto_load_safe_path_vec (filename, &filename_real))
501 do_cleanups (back_to);
505 warning (_("File \"%s\" auto-loading has been declined by your "
506 "`auto-load safe-path' set to \"%s\"."),
507 filename_real, auto_load_safe_path);
511 const char *homedir = getenv ("HOME");
516 homeinit = xstrprintf ("%s/%s", homedir, gdbinit);
517 make_cleanup (xfree, homeinit);
519 printf_filtered (_("\
520 To enable execution of this file add\n\
521 \tadd-auto-load-safe-path %s\n\
522 line to your configuration file \"%s\".\n\
523 To completely disable this security protection add\n\
524 \tset auto-load safe-path /\n\
525 line to your configuration file \"%s\".\n\
526 For more information about this security protection see the\n\
527 \"Auto-loading safe path\" section in the GDB manual. E.g., run from the shell:\n\
528 \tinfo \"(gdb)Auto-loading safe path\"\n"),
529 filename_real, homeinit, homeinit);
533 do_cleanups (back_to);
537 /* For scripts specified in .debug_gdb_scripts, multiple objfiles may load
538 the same script. There's no point in loading the script multiple times,
539 and there can be a lot of objfiles and scripts, so we keep track of scripts
542 struct auto_load_pspace_info
544 /* For each program space we keep track of loaded scripts. */
545 struct htab *loaded_scripts;
547 /* Non-zero if we've issued the warning about an auto-load script not being
548 supported. We only want to issue this warning once. */
549 int unsupported_script_warning_printed;
551 /* Non-zero if we've issued the warning about an auto-load script not being
552 found. We only want to issue this warning once. */
553 int script_not_found_warning_printed;
556 /* Objects of this type are stored in the loaded script hash table. */
560 /* Name as provided by the objfile. */
563 /* Full path name or NULL if script wasn't found (or was otherwise
565 const char *full_path;
567 /* Non-zero if this script has been loaded. */
570 const struct extension_language_defn *language;
573 /* Per-program-space data key. */
574 static const struct program_space_data *auto_load_pspace_data;
577 auto_load_pspace_data_cleanup (struct program_space *pspace, void *arg)
579 struct auto_load_pspace_info *info = arg;
581 if (info->loaded_scripts)
582 htab_delete (info->loaded_scripts);
586 /* Get the current autoload data. If none is found yet, add it now. This
587 function always returns a valid object. */
589 static struct auto_load_pspace_info *
590 get_auto_load_pspace_data (struct program_space *pspace)
592 struct auto_load_pspace_info *info;
594 info = program_space_data (pspace, auto_load_pspace_data);
597 info = XCNEW (struct auto_load_pspace_info);
598 set_program_space_data (pspace, auto_load_pspace_data, info);
604 /* Hash function for the loaded script hash. */
607 hash_loaded_script_entry (const void *data)
609 const struct loaded_script *e = data;
611 return htab_hash_string (e->name) ^ htab_hash_pointer (e->language);
614 /* Equality function for the loaded script hash. */
617 eq_loaded_script_entry (const void *a, const void *b)
619 const struct loaded_script *ea = a;
620 const struct loaded_script *eb = b;
622 return strcmp (ea->name, eb->name) == 0 && ea->language == eb->language;
625 /* Initialize the table to track loaded scripts.
626 Each entry is hashed by the full path name. */
629 init_loaded_scripts_info (struct auto_load_pspace_info *pspace_info)
631 /* Choose 31 as the starting size of the hash table, somewhat arbitrarily.
632 Space for each entry is obtained with one malloc so we can free them
635 pspace_info->loaded_scripts = htab_create (31,
636 hash_loaded_script_entry,
637 eq_loaded_script_entry,
640 pspace_info->unsupported_script_warning_printed = FALSE;
641 pspace_info->script_not_found_warning_printed = FALSE;
644 /* Wrapper on get_auto_load_pspace_data to also allocate the hash table
645 for loading scripts. */
647 struct auto_load_pspace_info *
648 get_auto_load_pspace_data_for_loading (struct program_space *pspace)
650 struct auto_load_pspace_info *info;
652 info = get_auto_load_pspace_data (pspace);
653 if (info->loaded_scripts == NULL)
654 init_loaded_scripts_info (info);
659 /* Add script NAME in LANGUAGE to hash table of PSPACE_INFO. LOADED 1 if the
660 script has been (is going to) be loaded, 0 otherwise (such as if it has not
661 been found). FULL_PATH is NULL if the script wasn't found. The result is
662 true if the script was already in the hash table. */
665 maybe_add_script (struct auto_load_pspace_info *pspace_info, int loaded,
666 const char *name, const char *full_path,
667 const struct extension_language_defn *language)
669 struct htab *htab = pspace_info->loaded_scripts;
670 struct loaded_script **slot, entry;
674 entry.language = language;
675 slot = (struct loaded_script **) htab_find_slot (htab, &entry, INSERT);
676 in_hash_table = *slot != NULL;
678 /* If this script is not in the hash table, add it. */
684 /* Allocate all space in one chunk so it's easier to free. */
685 *slot = xmalloc (sizeof (**slot)
687 + (full_path != NULL ? (strlen (full_path) + 1) : 0));
688 p = ((char*) *slot) + sizeof (**slot);
691 if (full_path != NULL)
694 strcpy (p, full_path);
695 (*slot)->full_path = p;
698 (*slot)->full_path = NULL;
699 (*slot)->loaded = loaded;
700 (*slot)->language = language;
703 return in_hash_table;
706 /* Clear the table of loaded section scripts. */
709 clear_section_scripts (void)
711 struct program_space *pspace = current_program_space;
712 struct auto_load_pspace_info *info;
714 info = program_space_data (pspace, auto_load_pspace_data);
715 if (info != NULL && info->loaded_scripts != NULL)
717 htab_delete (info->loaded_scripts);
718 info->loaded_scripts = NULL;
719 info->unsupported_script_warning_printed = FALSE;
720 info->script_not_found_warning_printed = FALSE;
724 /* Look for the auto-load script in LANGUAGE associated with OBJFILE where
725 OBJFILE's gdb_realpath is REALNAME and load it. Return 1 if we found any
726 matching script, return 0 otherwise. */
729 auto_load_objfile_script_1 (struct objfile *objfile, const char *realname,
730 const struct extension_language_defn *language)
732 char *filename, *debugfile;
735 struct cleanup *cleanups;
736 const char *suffix = ext_lang_auto_load_suffix (language);
738 len = strlen (realname);
739 filename = xmalloc (len + strlen (suffix) + 1);
740 memcpy (filename, realname, len);
741 strcpy (filename + len, suffix);
743 cleanups = make_cleanup (xfree, filename);
745 input = gdb_fopen_cloexec (filename, "r");
746 debugfile = filename;
748 fprintf_unfiltered (gdb_stdlog, _("auto-load: Attempted file \"%s\" %s.\n"),
749 debugfile, input ? _("exists") : _("does not exist"));
757 /* Also try the same file in a subdirectory of gdb's data
760 vec = auto_load_expand_dir_vars (auto_load_dir);
761 make_cleanup_free_char_ptr_vec (vec);
764 fprintf_unfiltered (gdb_stdlog, _("auto-load: Searching 'set auto-load "
765 "scripts-directory' path \"%s\".\n"),
768 for (ix = 0; VEC_iterate (char_ptr, vec, ix, dir); ++ix)
770 debugfile = xmalloc (strlen (dir) + strlen (filename) + 1);
771 strcpy (debugfile, dir);
773 /* FILENAME is absolute, so we don't need a "/" here. */
774 strcat (debugfile, filename);
776 make_cleanup (xfree, debugfile);
777 input = gdb_fopen_cloexec (debugfile, "r");
779 fprintf_unfiltered (gdb_stdlog, _("auto-load: Attempted file "
782 input ? _("exists") : _("does not exist"));
791 struct auto_load_pspace_info *pspace_info;
793 make_cleanup_fclose (input);
796 = file_is_auto_load_safe (debugfile,
797 _("auto-load: Loading %s script \"%s\""
798 " by extension for objfile \"%s\".\n"),
799 ext_lang_name (language),
800 debugfile, objfile_name (objfile));
802 /* Add this script to the hash table too so
803 "info auto-load ${lang}-scripts" can print it. */
805 = get_auto_load_pspace_data_for_loading (current_program_space);
806 maybe_add_script (pspace_info, is_safe, debugfile, debugfile, language);
808 /* To preserve existing behaviour we don't check for whether the
809 script was already in the table, and always load it.
810 It's highly unlikely that we'd ever load it twice,
811 and these scripts are required to be idempotent under multiple
815 objfile_script_sourcer_func *sourcer
816 = ext_lang_objfile_script_sourcer (language);
818 /* We shouldn't get here if support for the language isn't
819 compiled in. And the extension language is required to implement
821 gdb_assert (sourcer != NULL);
822 sourcer (language, objfile, input, debugfile);
830 do_cleanups (cleanups);
834 /* Look for the auto-load script in LANGUAGE associated with OBJFILE and load
838 auto_load_objfile_script (struct objfile *objfile,
839 const struct extension_language_defn *language)
841 char *realname = gdb_realpath (objfile_name (objfile));
842 struct cleanup *cleanups = make_cleanup (xfree, realname);
844 if (!auto_load_objfile_script_1 (objfile, realname, language))
846 /* For Windows/DOS .exe executables, strip the .exe suffix, so that
847 FOO-gdb.gdb could be used for FOO.exe, and try again. */
849 size_t len = strlen (realname);
850 const size_t lexe = sizeof (".exe") - 1;
852 if (len > lexe && strcasecmp (realname + len - lexe, ".exe") == 0)
855 realname[len] = '\0';
857 fprintf_unfiltered (gdb_stdlog, _("auto-load: Stripped .exe suffix, "
858 "retrying with \"%s\".\n"),
860 auto_load_objfile_script_1 (objfile, realname, language);
864 do_cleanups (cleanups);
867 /* Load scripts specified in OBJFILE.
868 START,END delimit a buffer containing a list of nul-terminated
870 SECTION_NAME is used in error messages.
872 Scripts are found per normal "source -s" command processing.
873 First the script is looked for in $cwd. If not found there the
874 source search path is used.
876 The section contains a list of path names of script files to load.
877 Each path is null-terminated. */
880 source_section_scripts (struct objfile *objfile, const char *section_name,
881 const char *start, const char *end)
884 struct auto_load_pspace_info *pspace_info;
886 pspace_info = get_auto_load_pspace_data_for_loading (current_program_space);
888 for (p = start; p < end; ++p)
893 int opened, in_hash_table;
894 struct cleanup *back_to;
895 const struct extension_language_defn *language;
896 objfile_script_sourcer_func *sourcer;
900 case SECTION_SCRIPT_ID_PYTHON_FILE:
901 language = get_ext_lang_defn (EXT_LANG_PYTHON);
903 case SECTION_SCRIPT_ID_SCHEME_FILE:
904 language = get_ext_lang_defn (EXT_LANG_GUILE);
907 warning (_("Invalid entry in %s section"), section_name);
908 /* We could try various heuristics to find the next valid entry,
909 but it's safer to just punt. */
914 while (p < end && *p != '\0')
918 char *buf = alloca (p - file + 1);
920 memcpy (buf, file, p - file);
921 buf[p - file] = '\0';
922 warning (_("Non-null-terminated path in %s: %s"),
929 warning (_("Empty path in %s"), section_name);
933 /* Until we support more types of records in .debug_gdb_scripts we do
934 all the processing here. The expectation is to add a new
935 extension_language_script_ops "method" that handles all the records
936 for the language. For now we can just use
937 extension_language_script_ops.objfile_script_sourcer. */
939 /* Skip this script if support is not compiled in. */
940 sourcer = ext_lang_objfile_script_sourcer (language);
943 /* We don't throw an error, the program is still debuggable. */
944 if (!unsupported_script_warning_print (pspace_info))
946 warning (_("Unsupported auto-load scripts referenced in"
949 "Use `info auto-load %s-scripts [REGEXP]'"
951 section_name, objfile_name (objfile),
952 ext_lang_name (language));
954 /* We *could* still try to open it, but there's no point. */
955 maybe_add_script (pspace_info, 0, file, NULL, language);
959 /* Skip this script if auto-loading it has been disabled. */
960 if (!ext_lang_auto_load_enabled (language))
962 /* No message is printed, just skip it. */
966 opened = find_and_open_script (file, 1 /*search_path*/,
967 &stream, &full_path);
969 back_to = make_cleanup (null_cleanup, NULL);
972 make_cleanup_fclose (stream);
973 make_cleanup (xfree, full_path);
975 if (!file_is_auto_load_safe (full_path,
976 _("auto-load: Loading %s script "
977 "\"%s\" from section \"%s\" of "
978 "objfile \"%s\".\n"),
979 ext_lang_name (language), full_path,
980 section_name, objfile_name (objfile)))
987 /* If one script isn't found it's not uncommon for more to not be
988 found either. We don't want to print a message for each script,
989 too much noise. Instead, we print the warning once and tell the
990 user how to find the list of scripts that weren't loaded.
991 We don't throw an error, the program is still debuggable.
993 IWBN if complaints.c were more general-purpose. */
995 if (script_not_found_warning_print (pspace_info))
996 warning (_("Missing auto-load scripts referenced in section %s\n\
998 Use `info auto-load %s-scripts [REGEXP]' to list them."),
999 section_name, objfile_name (objfile),
1000 ext_lang_name (language));
1003 in_hash_table = maybe_add_script (pspace_info, opened, file, full_path,
1006 /* If this file is not currently loaded, load it. */
1007 if (opened && !in_hash_table)
1008 sourcer (language, objfile, stream, full_path);
1010 do_cleanups (back_to);
1014 /* Load scripts specified in section SECTION_NAME of OBJFILE. */
1017 auto_load_section_scripts (struct objfile *objfile, const char *section_name)
1019 bfd *abfd = objfile->obfd;
1020 asection *scripts_sect;
1021 bfd_byte *data = NULL;
1023 scripts_sect = bfd_get_section_by_name (abfd, section_name);
1024 if (scripts_sect == NULL)
1027 if (!bfd_get_full_section_contents (abfd, scripts_sect, &data))
1028 warning (_("Couldn't read %s section of %s"),
1029 section_name, bfd_get_filename (abfd));
1032 struct cleanup *cleanups;
1033 char *p = (char *) data;
1035 cleanups = make_cleanup (xfree, p);
1036 source_section_scripts (objfile, section_name, p,
1037 p + bfd_get_section_size (scripts_sect));
1038 do_cleanups (cleanups);
1042 /* Load any auto-loaded scripts for OBJFILE. */
1045 load_auto_scripts_for_objfile (struct objfile *objfile)
1047 /* Return immediately if auto-loading has been globally disabled.
1048 This is to handle sequencing of operations during gdb startup.
1049 Also return immediately if OBJFILE is not actually a file. */
1050 if (!global_auto_load || (objfile->flags & OBJF_NOT_FILENAME) != 0)
1053 /* Load any extension language scripts for this objfile.
1054 E.g., foo-gdb.gdb, foo-gdb.py. */
1055 auto_load_ext_lang_scripts_for_objfile (objfile);
1057 /* Load any scripts mentioned in AUTO_SECTION_NAME (.debug_gdb_scripts). */
1058 auto_load_section_scripts (objfile, AUTO_SECTION_NAME);
1061 /* This is a new_objfile observer callback to auto-load scripts.
1063 Two flavors of auto-loaded scripts are supported.
1064 1) based on the path to the objfile
1065 2) from .debug_gdb_scripts section */
1068 auto_load_new_objfile (struct objfile *objfile)
1072 /* OBJFILE is NULL when loading a new "main" symbol-file. */
1073 clear_section_scripts ();
1077 load_auto_scripts_for_objfile (objfile);
1080 /* Collect scripts to be printed in a vec. */
1082 typedef struct loaded_script *loaded_script_ptr;
1083 DEF_VEC_P (loaded_script_ptr);
1085 struct collect_matching_scripts_data
1087 VEC (loaded_script_ptr) **scripts_p;
1089 const struct extension_language_defn *language;
1092 /* Traversal function for htab_traverse.
1093 Collect the entry if it matches the regexp. */
1096 collect_matching_scripts (void **slot, void *info)
1098 struct loaded_script *script = *slot;
1099 struct collect_matching_scripts_data *data = info;
1101 if (script->language == data->language && re_exec (script->name))
1102 VEC_safe_push (loaded_script_ptr, *data->scripts_p, script);
1110 print_script (struct loaded_script *script)
1112 struct ui_out *uiout = current_uiout;
1113 struct cleanup *chain;
1115 chain = make_cleanup_ui_out_tuple_begin_end (uiout, NULL);
1117 ui_out_field_string (uiout, "loaded", script->loaded ? "Yes" : "No");
1118 ui_out_field_string (uiout, "script", script->name);
1119 ui_out_text (uiout, "\n");
1121 /* If the name isn't the full path, print it too. */
1122 if (script->full_path != NULL
1123 && strcmp (script->name, script->full_path) != 0)
1125 ui_out_text (uiout, "\tfull name: ");
1126 ui_out_field_string (uiout, "full_path", script->full_path);
1127 ui_out_text (uiout, "\n");
1130 do_cleanups (chain);
1133 /* Helper for info_auto_load_scripts to sort the scripts by name. */
1136 sort_scripts_by_name (const void *ap, const void *bp)
1138 const struct loaded_script *a = *(const struct loaded_script **) ap;
1139 const struct loaded_script *b = *(const struct loaded_script **) bp;
1141 return FILENAME_CMP (a->name, b->name);
1144 /* Special internal GDB value of auto_load_info_scripts's PATTERN identify
1145 the "info auto-load XXX" command has been executed through the general
1146 "info auto-load" invocation. Extra newline will be printed if needed. */
1147 char auto_load_info_scripts_pattern_nl[] = "";
1149 /* Implementation for "info auto-load gdb-scripts"
1150 (and "info auto-load python-scripts"). List scripts in LANGUAGE matching
1151 PATTERN. FROM_TTY is the usual GDB boolean for user interactivity. */
1154 auto_load_info_scripts (char *pattern, int from_tty,
1155 const struct extension_language_defn *language)
1157 struct ui_out *uiout = current_uiout;
1158 struct auto_load_pspace_info *pspace_info;
1159 struct cleanup *script_chain;
1160 VEC (loaded_script_ptr) *scripts;
1165 pspace_info = get_auto_load_pspace_data (current_program_space);
1167 if (pattern && *pattern)
1169 char *re_err = re_comp (pattern);
1172 error (_("Invalid regexp: %s"), re_err);
1179 /* We need to know the number of rows before we build the table.
1180 Plus we want to sort the scripts by name.
1181 So first traverse the hash table collecting the matching scripts. */
1183 scripts = VEC_alloc (loaded_script_ptr, 10);
1184 script_chain = make_cleanup (VEC_cleanup (loaded_script_ptr), &scripts);
1186 if (pspace_info != NULL && pspace_info->loaded_scripts != NULL)
1188 struct collect_matching_scripts_data data = { &scripts, language };
1190 /* Pass a pointer to scripts as VEC_safe_push can realloc space. */
1191 htab_traverse_noresize (pspace_info->loaded_scripts,
1192 collect_matching_scripts, &data);
1195 nr_scripts = VEC_length (loaded_script_ptr, scripts);
1197 /* Table header shifted right by preceding "gdb-scripts: " would not match
1199 if (nr_scripts > 0 && pattern == auto_load_info_scripts_pattern_nl)
1200 ui_out_text (uiout, "\n");
1202 make_cleanup_ui_out_table_begin_end (uiout, 2, nr_scripts,
1203 "AutoLoadedScriptsTable");
1205 ui_out_table_header (uiout, 7, ui_left, "loaded", "Loaded");
1206 ui_out_table_header (uiout, 70, ui_left, "script", "Script");
1207 ui_out_table_body (uiout);
1212 loaded_script_ptr script;
1214 qsort (VEC_address (loaded_script_ptr, scripts),
1215 VEC_length (loaded_script_ptr, scripts),
1216 sizeof (loaded_script_ptr), sort_scripts_by_name);
1217 for (i = 0; VEC_iterate (loaded_script_ptr, scripts, i, script); ++i)
1218 print_script (script);
1221 do_cleanups (script_chain);
1223 if (nr_scripts == 0)
1225 if (pattern && *pattern)
1226 ui_out_message (uiout, 0, "No auto-load scripts matching %s.\n",
1229 ui_out_message (uiout, 0, "No auto-load scripts.\n");
1233 /* Wrapper for "info auto-load gdb-scripts". */
1236 info_auto_load_gdb_scripts (char *pattern, int from_tty)
1238 auto_load_info_scripts (pattern, from_tty, &extension_language_gdb);
1241 /* Implement 'info auto-load local-gdbinit'. */
1244 info_auto_load_local_gdbinit (char *args, int from_tty)
1246 if (auto_load_local_gdbinit_pathname == NULL)
1247 printf_filtered (_("Local .gdbinit file was not found.\n"));
1248 else if (auto_load_local_gdbinit_loaded)
1249 printf_filtered (_("Local .gdbinit file \"%s\" has been loaded.\n"),
1250 auto_load_local_gdbinit_pathname);
1252 printf_filtered (_("Local .gdbinit file \"%s\" has not been loaded.\n"),
1253 auto_load_local_gdbinit_pathname);
1256 /* Return non-zero if UNSUPPORTED_SCRIPT_WARNING_PRINTED of PSPACE_INFO was
1257 unset before calling this function. Always set
1258 UNSUPPORTED_SCRIPT_WARNING_PRINTED of PSPACE_INFO. */
1261 unsupported_script_warning_print (struct auto_load_pspace_info *pspace_info)
1263 int retval = !pspace_info->unsupported_script_warning_printed;
1265 pspace_info->unsupported_script_warning_printed = 1;
1270 /* Return non-zero if SCRIPT_NOT_FOUND_WARNING_PRINTED of PSPACE_INFO was unset
1271 before calling this function. Always set SCRIPT_NOT_FOUND_WARNING_PRINTED
1275 script_not_found_warning_print (struct auto_load_pspace_info *pspace_info)
1277 int retval = !pspace_info->script_not_found_warning_printed;
1279 pspace_info->script_not_found_warning_printed = 1;
1284 /* The only valid "set auto-load" argument is off|0|no|disable. */
1287 set_auto_load_cmd (char *args, int from_tty)
1289 struct cmd_list_element *list;
1292 /* See parse_binary_operation in use by the sub-commands. */
1294 length = args ? strlen (args) : 0;
1296 while (length > 0 && (args[length - 1] == ' ' || args[length - 1] == '\t'))
1299 if (length == 0 || (strncmp (args, "off", length) != 0
1300 && strncmp (args, "0", length) != 0
1301 && strncmp (args, "no", length) != 0
1302 && strncmp (args, "disable", length) != 0))
1303 error (_("Valid is only global 'set auto-load no'; "
1304 "otherwise check the auto-load sub-commands."));
1306 for (list = *auto_load_set_cmdlist_get (); list != NULL; list = list->next)
1307 if (list->var_type == var_boolean)
1309 gdb_assert (list->type == set_cmd);
1310 do_set_command (args, from_tty, list);
1314 /* Initialize "set auto-load " commands prefix and return it. */
1316 struct cmd_list_element **
1317 auto_load_set_cmdlist_get (void)
1319 static struct cmd_list_element *retval;
1322 add_prefix_cmd ("auto-load", class_maintenance, set_auto_load_cmd, _("\
1323 Auto-loading specific settings.\n\
1324 Configure various auto-load-specific variables such as\n\
1325 automatic loading of Python scripts."),
1326 &retval, "set auto-load ",
1327 1/*allow-unknown*/, &setlist);
1332 /* Command "show auto-load" displays summary of all the current
1333 "show auto-load " settings. */
1336 show_auto_load_cmd (char *args, int from_tty)
1338 cmd_show_list (*auto_load_show_cmdlist_get (), from_tty, "");
1341 /* Initialize "show auto-load " commands prefix and return it. */
1343 struct cmd_list_element **
1344 auto_load_show_cmdlist_get (void)
1346 static struct cmd_list_element *retval;
1349 add_prefix_cmd ("auto-load", class_maintenance, show_auto_load_cmd, _("\
1350 Show auto-loading specific settings.\n\
1351 Show configuration of various auto-load-specific variables such as\n\
1352 automatic loading of Python scripts."),
1353 &retval, "show auto-load ",
1354 0/*allow-unknown*/, &showlist);
1359 /* Command "info auto-load" displays whether the various auto-load files have
1360 been loaded. This is reimplementation of cmd_show_list which inserts
1361 newlines at proper places. */
1364 info_auto_load_cmd (char *args, int from_tty)
1366 struct cmd_list_element *list;
1367 struct cleanup *infolist_chain;
1368 struct ui_out *uiout = current_uiout;
1370 infolist_chain = make_cleanup_ui_out_tuple_begin_end (uiout, "infolist");
1372 for (list = *auto_load_info_cmdlist_get (); list != NULL; list = list->next)
1374 struct cleanup *option_chain
1375 = make_cleanup_ui_out_tuple_begin_end (uiout, "option");
1377 gdb_assert (!list->prefixlist);
1378 gdb_assert (list->type == not_set_cmd);
1380 ui_out_field_string (uiout, "name", list->name);
1381 ui_out_text (uiout, ": ");
1382 cmd_func (list, auto_load_info_scripts_pattern_nl, from_tty);
1384 /* Close the tuple. */
1385 do_cleanups (option_chain);
1388 /* Close the tuple. */
1389 do_cleanups (infolist_chain);
1392 /* Initialize "info auto-load " commands prefix and return it. */
1394 struct cmd_list_element **
1395 auto_load_info_cmdlist_get (void)
1397 static struct cmd_list_element *retval;
1400 add_prefix_cmd ("auto-load", class_info, info_auto_load_cmd, _("\
1401 Print current status of auto-loaded files.\n\
1402 Print whether various files like Python scripts or .gdbinit files have been\n\
1403 found and/or loaded."),
1404 &retval, "info auto-load ",
1405 0/*allow-unknown*/, &infolist);
1410 void _initialize_auto_load (void);
1413 _initialize_auto_load (void)
1415 struct cmd_list_element *cmd;
1416 char *scripts_directory_help, *gdb_name_help, *python_name_help;
1417 char *guile_name_help;
1420 auto_load_pspace_data
1421 = register_program_space_data_with_cleanup (NULL,
1422 auto_load_pspace_data_cleanup);
1424 observer_attach_new_objfile (auto_load_new_objfile);
1426 add_setshow_boolean_cmd ("gdb-scripts", class_support,
1427 &auto_load_gdb_scripts, _("\
1428 Enable or disable auto-loading of canned sequences of commands scripts."), _("\
1429 Show whether auto-loading of canned sequences of commands scripts is enabled."),
1431 If enabled, canned sequences of commands are loaded when the debugger reads\n\
1432 an executable or shared library.\n\
1433 This options has security implications for untrusted inferiors."),
1434 NULL, show_auto_load_gdb_scripts,
1435 auto_load_set_cmdlist_get (),
1436 auto_load_show_cmdlist_get ());
1438 add_cmd ("gdb-scripts", class_info, info_auto_load_gdb_scripts,
1439 _("Print the list of automatically loaded sequences of commands.\n\
1440 Usage: info auto-load gdb-scripts [REGEXP]"),
1441 auto_load_info_cmdlist_get ());
1443 add_setshow_boolean_cmd ("local-gdbinit", class_support,
1444 &auto_load_local_gdbinit, _("\
1445 Enable or disable auto-loading of .gdbinit script in current directory."), _("\
1446 Show whether auto-loading .gdbinit script in current directory is enabled."),
1448 If enabled, canned sequences of commands are loaded when debugger starts\n\
1449 from .gdbinit file in current directory. Such files are deprecated,\n\
1450 use a script associated with inferior executable file instead.\n\
1451 This options has security implications for untrusted inferiors."),
1452 NULL, show_auto_load_local_gdbinit,
1453 auto_load_set_cmdlist_get (),
1454 auto_load_show_cmdlist_get ());
1456 add_cmd ("local-gdbinit", class_info, info_auto_load_local_gdbinit,
1457 _("Print whether current directory .gdbinit file has been loaded.\n\
1458 Usage: info auto-load local-gdbinit"),
1459 auto_load_info_cmdlist_get ());
1461 auto_load_dir = xstrdup (AUTO_LOAD_DIR);
1463 suffix = ext_lang_auto_load_suffix (get_ext_lang_defn (EXT_LANG_GDB));
1466 GDB scripts: OBJFILE%s\n"),
1468 python_name_help = NULL;
1470 suffix = ext_lang_auto_load_suffix (get_ext_lang_defn (EXT_LANG_PYTHON));
1473 Python scripts: OBJFILE%s\n"),
1476 guile_name_help = NULL;
1478 suffix = ext_lang_auto_load_suffix (get_ext_lang_defn (EXT_LANG_GUILE));
1481 Guile scripts: OBJFILE%s\n"),
1484 scripts_directory_help
1486 Automatically loaded scripts are located in one of the directories listed\n\
1492 This option is ignored for the kinds of scripts \
1493 having 'set auto-load ... off'.\n\
1494 Directories listed here need to be present also \
1495 in the 'set auto-load safe-path'\n\
1498 python_name_help ? python_name_help : "",
1499 guile_name_help ? guile_name_help : "");
1501 add_setshow_optional_filename_cmd ("scripts-directory", class_support,
1502 &auto_load_dir, _("\
1503 Set the list of directories from which to load auto-loaded scripts."), _("\
1504 Show the list of directories from which to load auto-loaded scripts."),
1505 scripts_directory_help,
1506 set_auto_load_dir, show_auto_load_dir,
1507 auto_load_set_cmdlist_get (),
1508 auto_load_show_cmdlist_get ());
1509 xfree (scripts_directory_help);
1510 xfree (python_name_help);
1511 xfree (gdb_name_help);
1512 xfree (guile_name_help);
1514 auto_load_safe_path = xstrdup (AUTO_LOAD_SAFE_PATH);
1515 auto_load_safe_path_vec_update ();
1516 add_setshow_optional_filename_cmd ("safe-path", class_support,
1517 &auto_load_safe_path, _("\
1518 Set the list of files and directories that are safe for auto-loading."), _("\
1519 Show the list of files and directories that are safe for auto-loading."), _("\
1520 Various files loaded automatically for the 'set auto-load ...' options must\n\
1521 be located in one of the directories listed by this option. Warning will be\n\
1522 printed and file will not be used otherwise.\n\
1523 You can mix both directory and filename entries.\n\
1524 Setting this parameter to an empty list resets it to its default value.\n\
1525 Setting this parameter to '/' (without the quotes) allows any file\n\
1526 for the 'set auto-load ...' options. Each path entry can be also shell\n\
1527 wildcard pattern; '*' does not match directory separator.\n\
1528 This option is ignored for the kinds of files having 'set auto-load ... off'.\n\
1529 This options has security implications for untrusted inferiors."),
1530 set_auto_load_safe_path,
1531 show_auto_load_safe_path,
1532 auto_load_set_cmdlist_get (),
1533 auto_load_show_cmdlist_get ());
1534 observer_attach_gdb_datadir_changed (auto_load_gdb_datadir_changed);
1536 cmd = add_cmd ("add-auto-load-safe-path", class_support,
1537 add_auto_load_safe_path,
1538 _("Add entries to the list of directories from which it is safe "
1539 "to auto-load files.\n\
1540 See the commands 'set auto-load safe-path' and 'show auto-load safe-path' to\n\
1541 access the current full list setting."),
1543 set_cmd_completer (cmd, filename_completer);
1545 cmd = add_cmd ("add-auto-load-scripts-directory", class_support,
1547 _("Add entries to the list of directories from which to load "
1548 "auto-loaded scripts.\n\
1549 See the commands 'set auto-load scripts-directory' and\n\
1550 'show auto-load scripts-directory' to access the current full list setting."),
1552 set_cmd_completer (cmd, filename_completer);
1554 add_setshow_boolean_cmd ("auto-load", class_maintenance,
1555 &debug_auto_load, _("\
1556 Set auto-load verifications debugging."), _("\
1557 Show auto-load verifications debugging."), _("\
1558 When non-zero, debugging output for files of 'set auto-load ...'\n\
1560 NULL, show_debug_auto_load,
1561 &setdebuglist, &showdebuglist);