1 /* GDB routines for supporting auto-loaded scripts.
3 Copyright (C) 2012-2017 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/>. */
22 #include "auto-load.h"
23 #include "progspace.h"
24 #include "gdb_regex.h"
26 #include "filenames.h"
30 #include "cli/cli-script.h"
32 #include "cli/cli-cmds.h"
33 #include "cli/cli-decode.h"
34 #include "cli/cli-setshow.h"
36 #include "readline/tilde.h"
37 #include "completer.h"
40 #include "filestuff.h"
41 #include "extension.h"
42 #include "gdb/section-scripts.h"
44 /* The section to look in for auto-loaded scripts (in file formats that
46 Each entry in this section is a record that begins with a leading byte
47 identifying the record type.
48 At the moment we only support one record type: A leading byte of 1,
49 followed by the path of a python script to load. */
50 #define AUTO_SECTION_NAME ".debug_gdb_scripts"
52 static void maybe_print_unsupported_script_warning
53 (struct auto_load_pspace_info
*, struct objfile
*objfile
,
54 const struct extension_language_defn
*language
,
55 const char *section_name
, unsigned offset
);
57 static void maybe_print_script_not_found_warning
58 (struct auto_load_pspace_info
*, struct objfile
*objfile
,
59 const struct extension_language_defn
*language
,
60 const char *section_name
, unsigned offset
);
62 /* Value of the 'set debug auto-load' configuration variable. */
63 static int debug_auto_load
= 0;
65 /* "show" command for the debug_auto_load configuration variable. */
68 show_debug_auto_load (struct ui_file
*file
, int from_tty
,
69 struct cmd_list_element
*c
, const char *value
)
71 fprintf_filtered (file
, _("Debugging output for files "
72 "of 'set auto-load ...' is %s.\n"),
76 /* User-settable option to enable/disable auto-loading of GDB_AUTO_FILE_NAME
78 set auto-load gdb-scripts on|off
79 This is true if we should auto-load associated scripts when an objfile
80 is opened, false otherwise. */
81 static int auto_load_gdb_scripts
= 1;
83 /* "show" command for the auto_load_gdb_scripts configuration variable. */
86 show_auto_load_gdb_scripts (struct ui_file
*file
, int from_tty
,
87 struct cmd_list_element
*c
, const char *value
)
89 fprintf_filtered (file
, _("Auto-loading of canned sequences of commands "
94 /* Return non-zero if auto-loading gdb scripts is enabled. */
97 auto_load_gdb_scripts_enabled (const struct extension_language_defn
*extlang
)
99 return auto_load_gdb_scripts
;
102 /* Internal-use flag to enable/disable auto-loading.
103 This is true if we should auto-load python code when an objfile is opened,
106 Both auto_load_scripts && global_auto_load must be true to enable
109 This flag exists to facilitate deferring auto-loading during start-up
110 until after ./.gdbinit has been read; it may augment the search directories
111 used to find the scripts. */
112 int global_auto_load
= 1;
114 /* Auto-load .gdbinit file from the current directory? */
115 int auto_load_local_gdbinit
= 1;
117 /* Absolute pathname to the current directory .gdbinit, if it exists. */
118 char *auto_load_local_gdbinit_pathname
= NULL
;
120 /* Boolean value if AUTO_LOAD_LOCAL_GDBINIT_PATHNAME has been loaded. */
121 int auto_load_local_gdbinit_loaded
= 0;
123 /* "show" command for the auto_load_local_gdbinit configuration variable. */
126 show_auto_load_local_gdbinit (struct ui_file
*file
, int from_tty
,
127 struct cmd_list_element
*c
, const char *value
)
129 fprintf_filtered (file
, _("Auto-loading of .gdbinit script from current "
130 "directory is %s.\n"),
134 /* Directory list from which to load auto-loaded scripts. It is not checked
135 for absolute paths but they are strongly recommended. It is initialized by
136 _initialize_auto_load. */
137 static char *auto_load_dir
;
139 /* "set" command for the auto_load_dir configuration variable. */
142 set_auto_load_dir (char *args
, int from_tty
, struct cmd_list_element
*c
)
144 /* Setting the variable to "" resets it to the compile time defaults. */
145 if (auto_load_dir
[0] == '\0')
147 xfree (auto_load_dir
);
148 auto_load_dir
= xstrdup (AUTO_LOAD_DIR
);
152 /* "show" command for the auto_load_dir configuration variable. */
155 show_auto_load_dir (struct ui_file
*file
, int from_tty
,
156 struct cmd_list_element
*c
, const char *value
)
158 fprintf_filtered (file
, _("List of directories from which to load "
159 "auto-loaded scripts is %s.\n"),
163 /* Directory list safe to hold auto-loaded files. It is not checked for
164 absolute paths but they are strongly recommended. It is initialized by
165 _initialize_auto_load. */
166 static char *auto_load_safe_path
;
168 /* Vector of directory elements of AUTO_LOAD_SAFE_PATH with each one normalized
169 by tilde_expand and possibly each entries has added its gdb_realpath
171 static VEC (char_ptr
) *auto_load_safe_path_vec
;
173 /* Expand $datadir and $debugdir in STRING according to the rules of
174 substitute_path_component. Return vector from dirnames_to_char_ptr_vec,
175 this vector must be freed by free_char_ptr_vec by the caller. */
177 static VEC (char_ptr
) *
178 auto_load_expand_dir_vars (const char *string
)
180 VEC (char_ptr
) *dir_vec
;
183 s
= xstrdup (string
);
184 substitute_path_component (&s
, "$datadir", gdb_datadir
);
185 substitute_path_component (&s
, "$debugdir", debug_file_directory
);
187 if (debug_auto_load
&& strcmp (s
, string
) != 0)
188 fprintf_unfiltered (gdb_stdlog
,
189 _("auto-load: Expanded $-variables to \"%s\".\n"), s
);
191 dir_vec
= dirnames_to_char_ptr_vec (s
);
197 /* Update auto_load_safe_path_vec from current AUTO_LOAD_SAFE_PATH. */
200 auto_load_safe_path_vec_update (void)
206 fprintf_unfiltered (gdb_stdlog
,
207 _("auto-load: Updating directories of \"%s\".\n"),
208 auto_load_safe_path
);
210 free_char_ptr_vec (auto_load_safe_path_vec
);
212 auto_load_safe_path_vec
= auto_load_expand_dir_vars (auto_load_safe_path
);
213 len
= VEC_length (char_ptr
, auto_load_safe_path_vec
);
215 /* Apply tilde_expand and gdb_realpath to each AUTO_LOAD_SAFE_PATH_VEC
217 for (ix
= 0; ix
< len
; ix
++)
219 char *dir
= VEC_index (char_ptr
, auto_load_safe_path_vec
, ix
);
220 char *expanded
= tilde_expand (dir
);
221 char *real_path
= gdb_realpath (expanded
);
223 /* Ensure the current entry is at least tilde_expand-ed. */
224 VEC_replace (char_ptr
, auto_load_safe_path_vec
, ix
, expanded
);
228 if (strcmp (expanded
, dir
) == 0)
229 fprintf_unfiltered (gdb_stdlog
,
230 _("auto-load: Using directory \"%s\".\n"),
233 fprintf_unfiltered (gdb_stdlog
,
234 _("auto-load: Resolved directory \"%s\" "
240 /* If gdb_realpath returns a different content, append it. */
241 if (strcmp (real_path
, expanded
) == 0)
245 VEC_safe_push (char_ptr
, auto_load_safe_path_vec
, real_path
);
248 fprintf_unfiltered (gdb_stdlog
,
249 _("auto-load: And canonicalized as \"%s\".\n"),
255 /* Variable gdb_datadir has been set. Update content depending on $datadir. */
258 auto_load_gdb_datadir_changed (void)
260 auto_load_safe_path_vec_update ();
263 /* "set" command for the auto_load_safe_path configuration variable. */
266 set_auto_load_safe_path (char *args
, int from_tty
, struct cmd_list_element
*c
)
268 /* Setting the variable to "" resets it to the compile time defaults. */
269 if (auto_load_safe_path
[0] == '\0')
271 xfree (auto_load_safe_path
);
272 auto_load_safe_path
= xstrdup (AUTO_LOAD_SAFE_PATH
);
275 auto_load_safe_path_vec_update ();
278 /* "show" command for the auto_load_safe_path configuration variable. */
281 show_auto_load_safe_path (struct ui_file
*file
, int from_tty
,
282 struct cmd_list_element
*c
, const char *value
)
286 /* Check if user has entered either "/" or for example ":".
287 But while more complicate content like ":/foo" would still also
288 permit any location do not hide those. */
290 for (cs
= value
; *cs
&& (*cs
== DIRNAME_SEPARATOR
|| IS_DIR_SEPARATOR (*cs
));
293 fprintf_filtered (file
, _("Auto-load files are safe to load from any "
296 fprintf_filtered (file
, _("List of directories from which it is safe to "
297 "auto-load files is %s.\n"),
301 /* "add-auto-load-safe-path" command for the auto_load_safe_path configuration
305 add_auto_load_safe_path (char *args
, int from_tty
)
309 if (args
== NULL
|| *args
== 0)
311 Directory argument required.\n\
312 Use 'set auto-load safe-path /' for disabling the auto-load safe-path security.\
315 s
= xstrprintf ("%s%c%s", auto_load_safe_path
, DIRNAME_SEPARATOR
, args
);
316 xfree (auto_load_safe_path
);
317 auto_load_safe_path
= s
;
319 auto_load_safe_path_vec_update ();
322 /* "add-auto-load-scripts-directory" command for the auto_load_dir configuration
326 add_auto_load_dir (char *args
, int from_tty
)
330 if (args
== NULL
|| *args
== 0)
331 error (_("Directory argument required."));
333 s
= xstrprintf ("%s%c%s", auto_load_dir
, DIRNAME_SEPARATOR
, args
);
334 xfree (auto_load_dir
);
338 /* Implementation for filename_is_in_pattern overwriting the caller's FILENAME
342 filename_is_in_pattern_1 (char *filename
, char *pattern
)
344 size_t pattern_len
= strlen (pattern
);
345 size_t filename_len
= strlen (filename
);
348 fprintf_unfiltered (gdb_stdlog
, _("auto-load: Matching file \"%s\" "
349 "to pattern \"%s\"\n"),
352 /* Trim trailing slashes ("/") from PATTERN. Even for "d:\" paths as
353 trailing slashes are trimmed also from FILENAME it still matches
355 while (pattern_len
&& IS_DIR_SEPARATOR (pattern
[pattern_len
- 1]))
357 pattern
[pattern_len
] = '\0';
359 /* Ensure auto_load_safe_path "/" matches any FILENAME. On MS-Windows
360 platform FILENAME even after gdb_realpath does not have to start with
361 IS_DIR_SEPARATOR character, such as the 'C:\x.exe' filename. */
362 if (pattern_len
== 0)
365 fprintf_unfiltered (gdb_stdlog
,
366 _("auto-load: Matched - empty pattern\n"));
372 /* Trim trailing slashes ("/"). PATTERN also has slashes trimmed the
373 same way so they will match. */
374 while (filename_len
&& IS_DIR_SEPARATOR (filename
[filename_len
- 1]))
376 filename
[filename_len
] = '\0';
377 if (filename_len
== 0)
380 fprintf_unfiltered (gdb_stdlog
,
381 _("auto-load: Not matched - pattern \"%s\".\n"),
386 if (gdb_filename_fnmatch (pattern
, filename
, FNM_FILE_NAME
| FNM_NOESCAPE
)
390 fprintf_unfiltered (gdb_stdlog
, _("auto-load: Matched - file "
391 "\"%s\" to pattern \"%s\".\n"),
396 /* Trim trailing FILENAME component. */
397 while (filename_len
> 0 && !IS_DIR_SEPARATOR (filename
[filename_len
- 1]))
402 /* Return 1 if FILENAME matches PATTERN or if FILENAME resides in
403 a subdirectory of a directory that matches PATTERN. Return 0 otherwise.
404 gdb_realpath normalization is never done here. */
406 static ATTRIBUTE_PURE
int
407 filename_is_in_pattern (const char *filename
, const char *pattern
)
409 char *filename_copy
, *pattern_copy
;
411 filename_copy
= (char *) alloca (strlen (filename
) + 1);
412 strcpy (filename_copy
, filename
);
413 pattern_copy
= (char *) alloca (strlen (pattern
) + 1);
414 strcpy (pattern_copy
, pattern
);
416 return filename_is_in_pattern_1 (filename_copy
, pattern_copy
);
419 /* Return 1 if FILENAME belongs to one of directory components of
420 AUTO_LOAD_SAFE_PATH_VEC. Return 0 otherwise.
421 auto_load_safe_path_vec_update is never called.
422 *FILENAME_REALP may be updated by gdb_realpath of FILENAME - it has to be
423 freed by the caller. */
426 filename_is_in_auto_load_safe_path_vec (const char *filename
,
427 char **filename_realp
)
432 for (ix
= 0; VEC_iterate (char_ptr
, auto_load_safe_path_vec
, ix
, pattern
);
434 if (*filename_realp
== NULL
&& filename_is_in_pattern (filename
, pattern
))
439 if (*filename_realp
== NULL
)
441 *filename_realp
= gdb_realpath (filename
);
442 if (debug_auto_load
&& strcmp (*filename_realp
, filename
) != 0)
443 fprintf_unfiltered (gdb_stdlog
,
444 _("auto-load: Resolved "
445 "file \"%s\" as \"%s\".\n"),
446 filename
, *filename_realp
);
449 if (strcmp (*filename_realp
, filename
) != 0)
451 VEC_iterate (char_ptr
, auto_load_safe_path_vec
, ix
, pattern
); ++ix
)
452 if (filename_is_in_pattern (*filename_realp
, pattern
))
459 fprintf_unfiltered (gdb_stdlog
, _("auto-load: File \"%s\" matches "
460 "directory \"%s\".\n"),
468 /* Return 1 if FILENAME is located in one of the directories of
469 AUTO_LOAD_SAFE_PATH. Otherwise call warning and return 0. FILENAME does
470 not have to be an absolute path.
472 Existence of FILENAME is not checked. Function will still give a warning
473 even if the caller would quietly skip non-existing file in unsafe
477 file_is_auto_load_safe (const char *filename
, const char *debug_fmt
, ...)
479 char *filename_real
= NULL
;
480 struct cleanup
*back_to
;
481 static int advice_printed
= 0;
487 va_start (debug_args
, debug_fmt
);
488 vfprintf_unfiltered (gdb_stdlog
, debug_fmt
, debug_args
);
492 back_to
= make_cleanup (free_current_contents
, &filename_real
);
494 if (filename_is_in_auto_load_safe_path_vec (filename
, &filename_real
))
496 do_cleanups (back_to
);
500 auto_load_safe_path_vec_update ();
501 if (filename_is_in_auto_load_safe_path_vec (filename
, &filename_real
))
503 do_cleanups (back_to
);
507 warning (_("File \"%s\" auto-loading has been declined by your "
508 "`auto-load safe-path' set to \"%s\"."),
509 filename_real
, auto_load_safe_path
);
513 const char *homedir
= getenv ("HOME");
518 homeinit
= xstrprintf ("%s/%s", homedir
, gdbinit
);
519 make_cleanup (xfree
, homeinit
);
521 printf_filtered (_("\
522 To enable execution of this file add\n\
523 \tadd-auto-load-safe-path %s\n\
524 line to your configuration file \"%s\".\n\
525 To completely disable this security protection add\n\
526 \tset auto-load safe-path /\n\
527 line to your configuration file \"%s\".\n\
528 For more information about this security protection see the\n\
529 \"Auto-loading safe path\" section in the GDB manual. E.g., run from the shell:\n\
530 \tinfo \"(gdb)Auto-loading safe path\"\n"),
531 filename_real
, homeinit
, homeinit
);
535 do_cleanups (back_to
);
539 /* For scripts specified in .debug_gdb_scripts, multiple objfiles may load
540 the same script. There's no point in loading the script multiple times,
541 and there can be a lot of objfiles and scripts, so we keep track of scripts
544 struct auto_load_pspace_info
546 /* For each program space we keep track of loaded scripts, both when
547 specified as file names and as scripts to be executed directly. */
548 struct htab
*loaded_script_files
;
549 struct htab
*loaded_script_texts
;
551 /* Non-zero if we've issued the warning about an auto-load script not being
552 supported. We only want to issue this warning once. */
553 int unsupported_script_warning_printed
;
555 /* Non-zero if we've issued the warning about an auto-load script not being
556 found. We only want to issue this warning once. */
557 int script_not_found_warning_printed
;
560 /* Objects of this type are stored in the loaded_script hash table. */
564 /* Name as provided by the objfile. */
567 /* Full path name or NULL if script wasn't found (or was otherwise
568 inaccessible), or NULL for loaded_script_texts. */
569 const char *full_path
;
571 /* Non-zero if this script has been loaded. */
574 const struct extension_language_defn
*language
;
577 /* Per-program-space data key. */
578 static const struct program_space_data
*auto_load_pspace_data
;
581 auto_load_pspace_data_cleanup (struct program_space
*pspace
, void *arg
)
583 struct auto_load_pspace_info
*info
= (struct auto_load_pspace_info
*) arg
;
585 if (info
->loaded_script_files
)
586 htab_delete (info
->loaded_script_files
);
587 if (info
->loaded_script_texts
)
588 htab_delete (info
->loaded_script_texts
);
592 /* Get the current autoload data. If none is found yet, add it now. This
593 function always returns a valid object. */
595 static struct auto_load_pspace_info
*
596 get_auto_load_pspace_data (struct program_space
*pspace
)
598 struct auto_load_pspace_info
*info
;
600 info
= ((struct auto_load_pspace_info
*)
601 program_space_data (pspace
, auto_load_pspace_data
));
604 info
= XCNEW (struct auto_load_pspace_info
);
605 set_program_space_data (pspace
, auto_load_pspace_data
, info
);
611 /* Hash function for the loaded script hash. */
614 hash_loaded_script_entry (const void *data
)
616 const struct loaded_script
*e
= (const struct loaded_script
*) data
;
618 return htab_hash_string (e
->name
) ^ htab_hash_pointer (e
->language
);
621 /* Equality function for the loaded script hash. */
624 eq_loaded_script_entry (const void *a
, const void *b
)
626 const struct loaded_script
*ea
= (const struct loaded_script
*) a
;
627 const struct loaded_script
*eb
= (const struct loaded_script
*) b
;
629 return strcmp (ea
->name
, eb
->name
) == 0 && ea
->language
== eb
->language
;
632 /* Initialize the table to track loaded scripts.
633 Each entry is hashed by the full path name. */
636 init_loaded_scripts_info (struct auto_load_pspace_info
*pspace_info
)
638 /* Choose 31 as the starting size of the hash table, somewhat arbitrarily.
639 Space for each entry is obtained with one malloc so we can free them
642 pspace_info
->loaded_script_files
= htab_create (31,
643 hash_loaded_script_entry
,
644 eq_loaded_script_entry
,
646 pspace_info
->loaded_script_texts
= htab_create (31,
647 hash_loaded_script_entry
,
648 eq_loaded_script_entry
,
651 pspace_info
->unsupported_script_warning_printed
= FALSE
;
652 pspace_info
->script_not_found_warning_printed
= FALSE
;
655 /* Wrapper on get_auto_load_pspace_data to also allocate the hash table
656 for loading scripts. */
658 struct auto_load_pspace_info
*
659 get_auto_load_pspace_data_for_loading (struct program_space
*pspace
)
661 struct auto_load_pspace_info
*info
;
663 info
= get_auto_load_pspace_data (pspace
);
664 if (info
->loaded_script_files
== NULL
)
665 init_loaded_scripts_info (info
);
670 /* Add script file NAME in LANGUAGE to hash table of PSPACE_INFO.
671 LOADED 1 if the script has been (is going to) be loaded, 0 otherwise
672 (such as if it has not been found).
673 FULL_PATH is NULL if the script wasn't found.
674 The result is true if the script was already in the hash table. */
677 maybe_add_script_file (struct auto_load_pspace_info
*pspace_info
, int loaded
,
678 const char *name
, const char *full_path
,
679 const struct extension_language_defn
*language
)
681 struct htab
*htab
= pspace_info
->loaded_script_files
;
682 struct loaded_script
**slot
, entry
;
686 entry
.language
= language
;
687 slot
= (struct loaded_script
**) htab_find_slot (htab
, &entry
, INSERT
);
688 in_hash_table
= *slot
!= NULL
;
690 /* If this script is not in the hash table, add it. */
696 /* Allocate all space in one chunk so it's easier to free. */
697 *slot
= ((struct loaded_script
*)
698 xmalloc (sizeof (**slot
)
700 + (full_path
!= NULL
? (strlen (full_path
) + 1) : 0)));
701 p
= ((char*) *slot
) + sizeof (**slot
);
704 if (full_path
!= NULL
)
707 strcpy (p
, full_path
);
708 (*slot
)->full_path
= p
;
711 (*slot
)->full_path
= NULL
;
712 (*slot
)->loaded
= loaded
;
713 (*slot
)->language
= language
;
716 return in_hash_table
;
719 /* Add script contents NAME in LANGUAGE to hash table of PSPACE_INFO.
720 LOADED 1 if the script has been (is going to) be loaded, 0 otherwise
721 (such as if it has not been found).
722 The result is true if the script was already in the hash table. */
725 maybe_add_script_text (struct auto_load_pspace_info
*pspace_info
,
726 int loaded
, const char *name
,
727 const struct extension_language_defn
*language
)
729 struct htab
*htab
= pspace_info
->loaded_script_texts
;
730 struct loaded_script
**slot
, entry
;
734 entry
.language
= language
;
735 slot
= (struct loaded_script
**) htab_find_slot (htab
, &entry
, INSERT
);
736 in_hash_table
= *slot
!= NULL
;
738 /* If this script is not in the hash table, add it. */
744 /* Allocate all space in one chunk so it's easier to free. */
745 *slot
= ((struct loaded_script
*)
746 xmalloc (sizeof (**slot
) + strlen (name
) + 1));
747 p
= ((char*) *slot
) + sizeof (**slot
);
750 (*slot
)->full_path
= NULL
;
751 (*slot
)->loaded
= loaded
;
752 (*slot
)->language
= language
;
755 return in_hash_table
;
758 /* Clear the table of loaded section scripts. */
761 clear_section_scripts (void)
763 struct program_space
*pspace
= current_program_space
;
764 struct auto_load_pspace_info
*info
;
766 info
= ((struct auto_load_pspace_info
*)
767 program_space_data (pspace
, auto_load_pspace_data
));
768 if (info
!= NULL
&& info
->loaded_script_files
!= NULL
)
770 htab_delete (info
->loaded_script_files
);
771 htab_delete (info
->loaded_script_texts
);
772 info
->loaded_script_files
= NULL
;
773 info
->loaded_script_texts
= NULL
;
774 info
->unsupported_script_warning_printed
= FALSE
;
775 info
->script_not_found_warning_printed
= FALSE
;
779 /* Look for the auto-load script in LANGUAGE associated with OBJFILE where
780 OBJFILE's gdb_realpath is REALNAME and load it. Return 1 if we found any
781 matching script, return 0 otherwise. */
784 auto_load_objfile_script_1 (struct objfile
*objfile
, const char *realname
,
785 const struct extension_language_defn
*language
)
787 char *filename
, *debugfile
;
789 struct cleanup
*cleanups
;
790 const char *suffix
= ext_lang_auto_load_suffix (language
);
792 len
= strlen (realname
);
793 filename
= (char *) xmalloc (len
+ strlen (suffix
) + 1);
794 memcpy (filename
, realname
, len
);
795 strcpy (filename
+ len
, suffix
);
797 cleanups
= make_cleanup (xfree
, filename
);
799 gdb_file_up input
= gdb_fopen_cloexec (filename
, "r");
800 debugfile
= filename
;
802 fprintf_unfiltered (gdb_stdlog
, _("auto-load: Attempted file \"%s\" %s.\n"),
803 debugfile
, input
? _("exists") : _("does not exist"));
811 /* Also try the same file in a subdirectory of gdb's data
814 vec
= auto_load_expand_dir_vars (auto_load_dir
);
815 make_cleanup_free_char_ptr_vec (vec
);
818 fprintf_unfiltered (gdb_stdlog
, _("auto-load: Searching 'set auto-load "
819 "scripts-directory' path \"%s\".\n"),
822 for (ix
= 0; VEC_iterate (char_ptr
, vec
, ix
, dir
); ++ix
)
824 debugfile
= (char *) xmalloc (strlen (dir
) + strlen (filename
) + 1);
825 strcpy (debugfile
, dir
);
827 /* FILENAME is absolute, so we don't need a "/" here. */
828 strcat (debugfile
, filename
);
830 make_cleanup (xfree
, debugfile
);
831 input
= gdb_fopen_cloexec (debugfile
, "r");
833 fprintf_unfiltered (gdb_stdlog
, _("auto-load: Attempted file "
836 input
? _("exists") : _("does not exist"));
845 struct auto_load_pspace_info
*pspace_info
;
848 = file_is_auto_load_safe (debugfile
,
849 _("auto-load: Loading %s script \"%s\""
850 " by extension for objfile \"%s\".\n"),
851 ext_lang_name (language
),
852 debugfile
, objfile_name (objfile
));
854 /* Add this script to the hash table too so
855 "info auto-load ${lang}-scripts" can print it. */
857 = get_auto_load_pspace_data_for_loading (current_program_space
);
858 maybe_add_script_file (pspace_info
, is_safe
, debugfile
, debugfile
,
861 /* To preserve existing behaviour we don't check for whether the
862 script was already in the table, and always load it.
863 It's highly unlikely that we'd ever load it twice,
864 and these scripts are required to be idempotent under multiple
868 objfile_script_sourcer_func
*sourcer
869 = ext_lang_objfile_script_sourcer (language
);
871 /* We shouldn't get here if support for the language isn't
872 compiled in. And the extension language is required to implement
874 gdb_assert (sourcer
!= NULL
);
875 sourcer (language
, objfile
, input
.get (), debugfile
);
883 do_cleanups (cleanups
);
887 /* Look for the auto-load script in LANGUAGE associated with OBJFILE and load
891 auto_load_objfile_script (struct objfile
*objfile
,
892 const struct extension_language_defn
*language
)
894 char *realname
= gdb_realpath (objfile_name (objfile
));
895 struct cleanup
*cleanups
= make_cleanup (xfree
, realname
);
897 if (!auto_load_objfile_script_1 (objfile
, realname
, language
))
899 /* For Windows/DOS .exe executables, strip the .exe suffix, so that
900 FOO-gdb.gdb could be used for FOO.exe, and try again. */
902 size_t len
= strlen (realname
);
903 const size_t lexe
= sizeof (".exe") - 1;
905 if (len
> lexe
&& strcasecmp (realname
+ len
- lexe
, ".exe") == 0)
908 realname
[len
] = '\0';
910 fprintf_unfiltered (gdb_stdlog
, _("auto-load: Stripped .exe suffix, "
911 "retrying with \"%s\".\n"),
913 auto_load_objfile_script_1 (objfile
, realname
, language
);
917 do_cleanups (cleanups
);
920 /* Subroutine of source_section_scripts to simplify it.
921 Load FILE as a script in extension language LANGUAGE.
922 The script is from section SECTION_NAME in OBJFILE at offset OFFSET. */
925 source_script_file (struct auto_load_pspace_info
*pspace_info
,
926 struct objfile
*objfile
,
927 const struct extension_language_defn
*language
,
928 const char *section_name
, unsigned int offset
,
932 objfile_script_sourcer_func
*sourcer
;
934 /* Skip this script if support is not compiled in. */
935 sourcer
= ext_lang_objfile_script_sourcer (language
);
938 /* We don't throw an error, the program is still debuggable. */
939 maybe_print_unsupported_script_warning (pspace_info
, objfile
, language
,
940 section_name
, offset
);
941 /* We *could* still try to open it, but there's no point. */
942 maybe_add_script_file (pspace_info
, 0, file
, NULL
, language
);
946 /* Skip this script if auto-loading it has been disabled. */
947 if (!ext_lang_auto_load_enabled (language
))
949 /* No message is printed, just skip it. */
953 gdb::optional
<open_script
> opened
= find_and_open_script (file
,
958 if (!file_is_auto_load_safe (opened
->full_path
.get (),
959 _("auto-load: Loading %s script "
960 "\"%s\" from section \"%s\" of "
961 "objfile \"%s\".\n"),
962 ext_lang_name (language
),
963 opened
->full_path
.get (),
964 section_name
, objfile_name (objfile
)))
969 /* If one script isn't found it's not uncommon for more to not be
970 found either. We don't want to print a message for each script,
971 too much noise. Instead, we print the warning once and tell the
972 user how to find the list of scripts that weren't loaded.
973 We don't throw an error, the program is still debuggable.
975 IWBN if complaints.c were more general-purpose. */
977 maybe_print_script_not_found_warning (pspace_info
, objfile
, language
,
978 section_name
, offset
);
981 in_hash_table
= maybe_add_script_file (pspace_info
, bool (opened
), file
,
983 ? opened
->full_path
.get ()
987 /* If this file is not currently loaded, load it. */
988 if (opened
&& !in_hash_table
)
989 sourcer (language
, objfile
, opened
->stream
.get (),
990 opened
->full_path
.get ());
993 /* Subroutine of source_section_scripts to simplify it.
994 Execute SCRIPT as a script in extension language LANG.
995 The script is from section SECTION_NAME in OBJFILE at offset OFFSET. */
998 execute_script_contents (struct auto_load_pspace_info
*pspace_info
,
999 struct objfile
*objfile
,
1000 const struct extension_language_defn
*language
,
1001 const char *section_name
, unsigned int offset
,
1004 objfile_script_executor_func
*executor
;
1005 const char *newline
, *script_text
;
1007 int is_safe
, in_hash_table
;
1008 struct cleanup
*cleanups
;
1010 cleanups
= make_cleanup (null_cleanup
, NULL
);
1012 /* The first line of the script is the name of the script.
1013 It must not contain any kind of space character. */
1015 newline
= strchr (script
, '\n');
1016 if (newline
!= NULL
)
1020 /* Put the name in a buffer and validate it. */
1021 buf
= xstrndup (script
, newline
- script
);
1022 make_cleanup (xfree
, buf
);
1023 for (p
= buf
; *p
!= '\0'; ++p
)
1028 /* We don't allow nameless scripts, they're not helpful to the user. */
1029 if (p
!= buf
&& *p
== '\0')
1034 /* We don't throw an error, the program is still debuggable. */
1036 Missing/bad script name in entry at offset %u in section %s\n\
1038 offset
, section_name
, objfile_name (objfile
));
1039 do_cleanups (cleanups
);
1042 script_text
= newline
+ 1;
1044 /* Skip this script if support is not compiled in. */
1045 executor
= ext_lang_objfile_script_executor (language
);
1046 if (executor
== NULL
)
1048 /* We don't throw an error, the program is still debuggable. */
1049 maybe_print_unsupported_script_warning (pspace_info
, objfile
, language
,
1050 section_name
, offset
);
1051 maybe_add_script_text (pspace_info
, 0, name
, language
);
1052 do_cleanups (cleanups
);
1056 /* Skip this script if auto-loading it has been disabled. */
1057 if (!ext_lang_auto_load_enabled (language
))
1059 /* No message is printed, just skip it. */
1060 do_cleanups (cleanups
);
1064 is_safe
= file_is_auto_load_safe (objfile_name (objfile
),
1065 _("auto-load: Loading %s script "
1066 "\"%s\" from section \"%s\" of "
1067 "objfile \"%s\".\n"),
1068 ext_lang_name (language
), name
,
1069 section_name
, objfile_name (objfile
));
1071 in_hash_table
= maybe_add_script_text (pspace_info
, is_safe
, name
, language
);
1073 /* If this file is not currently loaded, load it. */
1074 if (is_safe
&& !in_hash_table
)
1075 executor (language
, objfile
, name
, script_text
);
1077 do_cleanups (cleanups
);
1080 /* Load scripts specified in OBJFILE.
1081 START,END delimit a buffer containing a list of nul-terminated
1083 SECTION_NAME is used in error messages.
1085 Scripts specified as file names are found per normal "source -s" command
1086 processing. First the script is looked for in $cwd. If not found there
1087 the source search path is used.
1089 The section contains a list of path names of script files to load or
1090 actual script contents. Each entry is nul-terminated. */
1093 source_section_scripts (struct objfile
*objfile
, const char *section_name
,
1094 const char *start
, const char *end
)
1097 struct auto_load_pspace_info
*pspace_info
;
1099 pspace_info
= get_auto_load_pspace_data_for_loading (current_program_space
);
1101 for (p
= start
; p
< end
; ++p
)
1104 const struct extension_language_defn
*language
;
1105 unsigned int offset
= p
- start
;
1110 case SECTION_SCRIPT_ID_PYTHON_FILE
:
1111 case SECTION_SCRIPT_ID_PYTHON_TEXT
:
1112 language
= get_ext_lang_defn (EXT_LANG_PYTHON
);
1114 case SECTION_SCRIPT_ID_SCHEME_FILE
:
1115 case SECTION_SCRIPT_ID_SCHEME_TEXT
:
1116 language
= get_ext_lang_defn (EXT_LANG_GUILE
);
1119 warning (_("Invalid entry in %s section"), section_name
);
1120 /* We could try various heuristics to find the next valid entry,
1121 but it's safer to just punt. */
1126 while (p
< end
&& *p
!= '\0')
1130 warning (_("Non-nul-terminated entry in %s at offset %u"),
1131 section_name
, offset
);
1132 /* Don't load/execute it. */
1138 case SECTION_SCRIPT_ID_PYTHON_FILE
:
1139 case SECTION_SCRIPT_ID_SCHEME_FILE
:
1142 warning (_("Empty entry in %s at offset %u"),
1143 section_name
, offset
);
1146 source_script_file (pspace_info
, objfile
, language
,
1147 section_name
, offset
, entry
);
1149 case SECTION_SCRIPT_ID_PYTHON_TEXT
:
1150 case SECTION_SCRIPT_ID_SCHEME_TEXT
:
1151 execute_script_contents (pspace_info
, objfile
, language
,
1152 section_name
, offset
, entry
);
1158 /* Load scripts specified in section SECTION_NAME of OBJFILE. */
1161 auto_load_section_scripts (struct objfile
*objfile
, const char *section_name
)
1163 bfd
*abfd
= objfile
->obfd
;
1164 asection
*scripts_sect
;
1165 bfd_byte
*data
= NULL
;
1167 scripts_sect
= bfd_get_section_by_name (abfd
, section_name
);
1168 if (scripts_sect
== NULL
1169 || (bfd_get_section_flags (abfd
, scripts_sect
) & SEC_HAS_CONTENTS
) == 0)
1172 if (!bfd_get_full_section_contents (abfd
, scripts_sect
, &data
))
1173 warning (_("Couldn't read %s section of %s"),
1174 section_name
, bfd_get_filename (abfd
));
1177 struct cleanup
*cleanups
;
1178 char *p
= (char *) data
;
1180 cleanups
= make_cleanup (xfree
, p
);
1181 source_section_scripts (objfile
, section_name
, p
,
1182 p
+ bfd_get_section_size (scripts_sect
));
1183 do_cleanups (cleanups
);
1187 /* Load any auto-loaded scripts for OBJFILE. */
1190 load_auto_scripts_for_objfile (struct objfile
*objfile
)
1192 /* Return immediately if auto-loading has been globally disabled.
1193 This is to handle sequencing of operations during gdb startup.
1194 Also return immediately if OBJFILE was not created from a file
1195 on the local filesystem. */
1196 if (!global_auto_load
1197 || (objfile
->flags
& OBJF_NOT_FILENAME
) != 0
1198 || is_target_filename (objfile
->original_name
))
1201 /* Load any extension language scripts for this objfile.
1202 E.g., foo-gdb.gdb, foo-gdb.py. */
1203 auto_load_ext_lang_scripts_for_objfile (objfile
);
1205 /* Load any scripts mentioned in AUTO_SECTION_NAME (.debug_gdb_scripts). */
1206 auto_load_section_scripts (objfile
, AUTO_SECTION_NAME
);
1209 /* This is a new_objfile observer callback to auto-load scripts.
1211 Two flavors of auto-loaded scripts are supported.
1212 1) based on the path to the objfile
1213 2) from .debug_gdb_scripts section */
1216 auto_load_new_objfile (struct objfile
*objfile
)
1220 /* OBJFILE is NULL when loading a new "main" symbol-file. */
1221 clear_section_scripts ();
1225 load_auto_scripts_for_objfile (objfile
);
1228 /* Collect scripts to be printed in a vec. */
1230 typedef struct loaded_script
*loaded_script_ptr
;
1231 DEF_VEC_P (loaded_script_ptr
);
1233 struct collect_matching_scripts_data
1235 VEC (loaded_script_ptr
) **scripts_p
;
1237 const struct extension_language_defn
*language
;
1240 /* Traversal function for htab_traverse.
1241 Collect the entry if it matches the regexp. */
1244 collect_matching_scripts (void **slot
, void *info
)
1246 struct loaded_script
*script
= (struct loaded_script
*) *slot
;
1247 struct collect_matching_scripts_data
*data
1248 = (struct collect_matching_scripts_data
*) info
;
1250 if (script
->language
== data
->language
&& re_exec (script
->name
))
1251 VEC_safe_push (loaded_script_ptr
, *data
->scripts_p
, script
);
1259 print_script (struct loaded_script
*script
)
1261 struct ui_out
*uiout
= current_uiout
;
1263 ui_out_emit_tuple
tuple_emitter (uiout
, NULL
);
1265 uiout
->field_string ("loaded", script
->loaded
? "Yes" : "No");
1266 uiout
->field_string ("script", script
->name
);
1269 /* If the name isn't the full path, print it too. */
1270 if (script
->full_path
!= NULL
1271 && strcmp (script
->name
, script
->full_path
) != 0)
1273 uiout
->text ("\tfull name: ");
1274 uiout
->field_string ("full_path", script
->full_path
);
1279 /* Helper for info_auto_load_scripts to sort the scripts by name. */
1282 sort_scripts_by_name (const void *ap
, const void *bp
)
1284 const struct loaded_script
*a
= *(const struct loaded_script
**) ap
;
1285 const struct loaded_script
*b
= *(const struct loaded_script
**) bp
;
1287 return FILENAME_CMP (a
->name
, b
->name
);
1290 /* Special internal GDB value of auto_load_info_scripts's PATTERN identify
1291 the "info auto-load XXX" command has been executed through the general
1292 "info auto-load" invocation. Extra newline will be printed if needed. */
1293 char auto_load_info_scripts_pattern_nl
[] = "";
1295 /* Subroutine of auto_load_info_scripts to simplify it.
1299 print_scripts (VEC (loaded_script_ptr
) *scripts
)
1302 loaded_script_ptr script
;
1304 qsort (VEC_address (loaded_script_ptr
, scripts
),
1305 VEC_length (loaded_script_ptr
, scripts
),
1306 sizeof (loaded_script_ptr
), sort_scripts_by_name
);
1307 for (i
= 0; VEC_iterate (loaded_script_ptr
, scripts
, i
, script
); ++i
)
1308 print_script (script
);
1311 /* Implementation for "info auto-load gdb-scripts"
1312 (and "info auto-load python-scripts"). List scripts in LANGUAGE matching
1313 PATTERN. FROM_TTY is the usual GDB boolean for user interactivity. */
1316 auto_load_info_scripts (char *pattern
, int from_tty
,
1317 const struct extension_language_defn
*language
)
1319 struct ui_out
*uiout
= current_uiout
;
1320 struct auto_load_pspace_info
*pspace_info
;
1321 struct cleanup
*script_chain
;
1322 VEC (loaded_script_ptr
) *script_files
, *script_texts
;
1327 pspace_info
= get_auto_load_pspace_data (current_program_space
);
1329 if (pattern
&& *pattern
)
1331 char *re_err
= re_comp (pattern
);
1334 error (_("Invalid regexp: %s"), re_err
);
1341 /* We need to know the number of rows before we build the table.
1342 Plus we want to sort the scripts by name.
1343 So first traverse the hash table collecting the matching scripts. */
1345 script_files
= VEC_alloc (loaded_script_ptr
, 10);
1346 script_texts
= VEC_alloc (loaded_script_ptr
, 10);
1347 script_chain
= make_cleanup (VEC_cleanup (loaded_script_ptr
), &script_files
);
1348 make_cleanup (VEC_cleanup (loaded_script_ptr
), &script_texts
);
1350 if (pspace_info
!= NULL
&& pspace_info
->loaded_script_files
!= NULL
)
1352 struct collect_matching_scripts_data data
= { &script_files
, language
};
1354 /* Pass a pointer to scripts as VEC_safe_push can realloc space. */
1355 htab_traverse_noresize (pspace_info
->loaded_script_files
,
1356 collect_matching_scripts
, &data
);
1359 if (pspace_info
!= NULL
&& pspace_info
->loaded_script_texts
!= NULL
)
1361 struct collect_matching_scripts_data data
= { &script_texts
, language
};
1363 /* Pass a pointer to scripts as VEC_safe_push can realloc space. */
1364 htab_traverse_noresize (pspace_info
->loaded_script_texts
,
1365 collect_matching_scripts
, &data
);
1368 nr_scripts
= (VEC_length (loaded_script_ptr
, script_files
)
1369 + VEC_length (loaded_script_ptr
, script_texts
));
1371 /* Table header shifted right by preceding "gdb-scripts: " would not match
1373 if (nr_scripts
> 0 && pattern
== auto_load_info_scripts_pattern_nl
)
1377 ui_out_emit_table
table_emitter (uiout
, 2, nr_scripts
,
1378 "AutoLoadedScriptsTable");
1380 uiout
->table_header (7, ui_left
, "loaded", "Loaded");
1381 uiout
->table_header (70, ui_left
, "script", "Script");
1382 uiout
->table_body ();
1384 print_scripts (script_files
);
1385 print_scripts (script_texts
);
1388 do_cleanups (script_chain
);
1390 if (nr_scripts
== 0)
1392 if (pattern
&& *pattern
)
1393 uiout
->message ("No auto-load scripts matching %s.\n", pattern
);
1395 uiout
->message ("No auto-load scripts.\n");
1399 /* Wrapper for "info auto-load gdb-scripts". */
1402 info_auto_load_gdb_scripts (char *pattern
, int from_tty
)
1404 auto_load_info_scripts (pattern
, from_tty
, &extension_language_gdb
);
1407 /* Implement 'info auto-load local-gdbinit'. */
1410 info_auto_load_local_gdbinit (char *args
, int from_tty
)
1412 if (auto_load_local_gdbinit_pathname
== NULL
)
1413 printf_filtered (_("Local .gdbinit file was not found.\n"));
1414 else if (auto_load_local_gdbinit_loaded
)
1415 printf_filtered (_("Local .gdbinit file \"%s\" has been loaded.\n"),
1416 auto_load_local_gdbinit_pathname
);
1418 printf_filtered (_("Local .gdbinit file \"%s\" has not been loaded.\n"),
1419 auto_load_local_gdbinit_pathname
);
1422 /* Print an "unsupported script" warning if it has not already been printed.
1423 The script is in language LANGUAGE at offset OFFSET in section SECTION_NAME
1427 maybe_print_unsupported_script_warning
1428 (struct auto_load_pspace_info
*pspace_info
,
1429 struct objfile
*objfile
, const struct extension_language_defn
*language
,
1430 const char *section_name
, unsigned offset
)
1432 if (!pspace_info
->unsupported_script_warning_printed
)
1435 Unsupported auto-load script at offset %u in section %s\n\
1437 Use `info auto-load %s-scripts [REGEXP]' to list them."),
1438 offset
, section_name
, objfile_name (objfile
),
1439 ext_lang_name (language
));
1440 pspace_info
->unsupported_script_warning_printed
= 1;
1444 /* Return non-zero if SCRIPT_NOT_FOUND_WARNING_PRINTED of PSPACE_INFO was unset
1445 before calling this function. Always set SCRIPT_NOT_FOUND_WARNING_PRINTED
1449 maybe_print_script_not_found_warning
1450 (struct auto_load_pspace_info
*pspace_info
,
1451 struct objfile
*objfile
, const struct extension_language_defn
*language
,
1452 const char *section_name
, unsigned offset
)
1454 if (!pspace_info
->script_not_found_warning_printed
)
1457 Missing auto-load script at offset %u in section %s\n\
1459 Use `info auto-load %s-scripts [REGEXP]' to list them."),
1460 offset
, section_name
, objfile_name (objfile
),
1461 ext_lang_name (language
));
1462 pspace_info
->script_not_found_warning_printed
= 1;
1466 /* The only valid "set auto-load" argument is off|0|no|disable. */
1469 set_auto_load_cmd (char *args
, int from_tty
)
1471 struct cmd_list_element
*list
;
1474 /* See parse_binary_operation in use by the sub-commands. */
1476 length
= args
? strlen (args
) : 0;
1478 while (length
> 0 && (args
[length
- 1] == ' ' || args
[length
- 1] == '\t'))
1481 if (length
== 0 || (strncmp (args
, "off", length
) != 0
1482 && strncmp (args
, "0", length
) != 0
1483 && strncmp (args
, "no", length
) != 0
1484 && strncmp (args
, "disable", length
) != 0))
1485 error (_("Valid is only global 'set auto-load no'; "
1486 "otherwise check the auto-load sub-commands."));
1488 for (list
= *auto_load_set_cmdlist_get (); list
!= NULL
; list
= list
->next
)
1489 if (list
->var_type
== var_boolean
)
1491 gdb_assert (list
->type
== set_cmd
);
1492 do_set_command (args
, from_tty
, list
);
1496 /* Initialize "set auto-load " commands prefix and return it. */
1498 struct cmd_list_element
**
1499 auto_load_set_cmdlist_get (void)
1501 static struct cmd_list_element
*retval
;
1504 add_prefix_cmd ("auto-load", class_maintenance
, set_auto_load_cmd
, _("\
1505 Auto-loading specific settings.\n\
1506 Configure various auto-load-specific variables such as\n\
1507 automatic loading of Python scripts."),
1508 &retval
, "set auto-load ",
1509 1/*allow-unknown*/, &setlist
);
1514 /* Command "show auto-load" displays summary of all the current
1515 "show auto-load " settings. */
1518 show_auto_load_cmd (char *args
, int from_tty
)
1520 cmd_show_list (*auto_load_show_cmdlist_get (), from_tty
, "");
1523 /* Initialize "show auto-load " commands prefix and return it. */
1525 struct cmd_list_element
**
1526 auto_load_show_cmdlist_get (void)
1528 static struct cmd_list_element
*retval
;
1531 add_prefix_cmd ("auto-load", class_maintenance
, show_auto_load_cmd
, _("\
1532 Show auto-loading specific settings.\n\
1533 Show configuration of various auto-load-specific variables such as\n\
1534 automatic loading of Python scripts."),
1535 &retval
, "show auto-load ",
1536 0/*allow-unknown*/, &showlist
);
1541 /* Command "info auto-load" displays whether the various auto-load files have
1542 been loaded. This is reimplementation of cmd_show_list which inserts
1543 newlines at proper places. */
1546 info_auto_load_cmd (char *args
, int from_tty
)
1548 struct cmd_list_element
*list
;
1549 struct cleanup
*infolist_chain
;
1550 struct ui_out
*uiout
= current_uiout
;
1552 ui_out_emit_tuple
tuple_emitter (uiout
, "infolist");
1554 for (list
= *auto_load_info_cmdlist_get (); list
!= NULL
; list
= list
->next
)
1556 ui_out_emit_tuple
option_emitter (uiout
, "option");
1558 gdb_assert (!list
->prefixlist
);
1559 gdb_assert (list
->type
== not_set_cmd
);
1561 uiout
->field_string ("name", list
->name
);
1563 cmd_func (list
, auto_load_info_scripts_pattern_nl
, from_tty
);
1567 /* Initialize "info auto-load " commands prefix and return it. */
1569 struct cmd_list_element
**
1570 auto_load_info_cmdlist_get (void)
1572 static struct cmd_list_element
*retval
;
1575 add_prefix_cmd ("auto-load", class_info
, info_auto_load_cmd
, _("\
1576 Print current status of auto-loaded files.\n\
1577 Print whether various files like Python scripts or .gdbinit files have been\n\
1578 found and/or loaded."),
1579 &retval
, "info auto-load ",
1580 0/*allow-unknown*/, &infolist
);
1585 void _initialize_auto_load (void);
1588 _initialize_auto_load (void)
1590 struct cmd_list_element
*cmd
;
1591 char *scripts_directory_help
, *gdb_name_help
, *python_name_help
;
1592 char *guile_name_help
;
1595 auto_load_pspace_data
1596 = register_program_space_data_with_cleanup (NULL
,
1597 auto_load_pspace_data_cleanup
);
1599 observer_attach_new_objfile (auto_load_new_objfile
);
1601 add_setshow_boolean_cmd ("gdb-scripts", class_support
,
1602 &auto_load_gdb_scripts
, _("\
1603 Enable or disable auto-loading of canned sequences of commands scripts."), _("\
1604 Show whether auto-loading of canned sequences of commands scripts is enabled."),
1606 If enabled, canned sequences of commands are loaded when the debugger reads\n\
1607 an executable or shared library.\n\
1608 This options has security implications for untrusted inferiors."),
1609 NULL
, show_auto_load_gdb_scripts
,
1610 auto_load_set_cmdlist_get (),
1611 auto_load_show_cmdlist_get ());
1613 add_cmd ("gdb-scripts", class_info
, info_auto_load_gdb_scripts
,
1614 _("Print the list of automatically loaded sequences of commands.\n\
1615 Usage: info auto-load gdb-scripts [REGEXP]"),
1616 auto_load_info_cmdlist_get ());
1618 add_setshow_boolean_cmd ("local-gdbinit", class_support
,
1619 &auto_load_local_gdbinit
, _("\
1620 Enable or disable auto-loading of .gdbinit script in current directory."), _("\
1621 Show whether auto-loading .gdbinit script in current directory is enabled."),
1623 If enabled, canned sequences of commands are loaded when debugger starts\n\
1624 from .gdbinit file in current directory. Such files are deprecated,\n\
1625 use a script associated with inferior executable file instead.\n\
1626 This options has security implications for untrusted inferiors."),
1627 NULL
, show_auto_load_local_gdbinit
,
1628 auto_load_set_cmdlist_get (),
1629 auto_load_show_cmdlist_get ());
1631 add_cmd ("local-gdbinit", class_info
, info_auto_load_local_gdbinit
,
1632 _("Print whether current directory .gdbinit file has been loaded.\n\
1633 Usage: info auto-load local-gdbinit"),
1634 auto_load_info_cmdlist_get ());
1636 auto_load_dir
= xstrdup (AUTO_LOAD_DIR
);
1638 suffix
= ext_lang_auto_load_suffix (get_ext_lang_defn (EXT_LANG_GDB
));
1641 GDB scripts: OBJFILE%s\n"),
1643 python_name_help
= NULL
;
1645 suffix
= ext_lang_auto_load_suffix (get_ext_lang_defn (EXT_LANG_PYTHON
));
1648 Python scripts: OBJFILE%s\n"),
1651 guile_name_help
= NULL
;
1653 suffix
= ext_lang_auto_load_suffix (get_ext_lang_defn (EXT_LANG_GUILE
));
1656 Guile scripts: OBJFILE%s\n"),
1659 scripts_directory_help
1661 Automatically loaded scripts are located in one of the directories listed\n\
1667 This option is ignored for the kinds of scripts \
1668 having 'set auto-load ... off'.\n\
1669 Directories listed here need to be present also \
1670 in the 'set auto-load safe-path'\n\
1673 python_name_help
? python_name_help
: "",
1674 guile_name_help
? guile_name_help
: "");
1676 add_setshow_optional_filename_cmd ("scripts-directory", class_support
,
1677 &auto_load_dir
, _("\
1678 Set the list of directories from which to load auto-loaded scripts."), _("\
1679 Show the list of directories from which to load auto-loaded scripts."),
1680 scripts_directory_help
,
1681 set_auto_load_dir
, show_auto_load_dir
,
1682 auto_load_set_cmdlist_get (),
1683 auto_load_show_cmdlist_get ());
1684 xfree (scripts_directory_help
);
1685 xfree (python_name_help
);
1686 xfree (gdb_name_help
);
1687 xfree (guile_name_help
);
1689 auto_load_safe_path
= xstrdup (AUTO_LOAD_SAFE_PATH
);
1690 auto_load_safe_path_vec_update ();
1691 add_setshow_optional_filename_cmd ("safe-path", class_support
,
1692 &auto_load_safe_path
, _("\
1693 Set the list of files and directories that are safe for auto-loading."), _("\
1694 Show the list of files and directories that are safe for auto-loading."), _("\
1695 Various files loaded automatically for the 'set auto-load ...' options must\n\
1696 be located in one of the directories listed by this option. Warning will be\n\
1697 printed and file will not be used otherwise.\n\
1698 You can mix both directory and filename entries.\n\
1699 Setting this parameter to an empty list resets it to its default value.\n\
1700 Setting this parameter to '/' (without the quotes) allows any file\n\
1701 for the 'set auto-load ...' options. Each path entry can be also shell\n\
1702 wildcard pattern; '*' does not match directory separator.\n\
1703 This option is ignored for the kinds of files having 'set auto-load ... off'.\n\
1704 This options has security implications for untrusted inferiors."),
1705 set_auto_load_safe_path
,
1706 show_auto_load_safe_path
,
1707 auto_load_set_cmdlist_get (),
1708 auto_load_show_cmdlist_get ());
1709 observer_attach_gdb_datadir_changed (auto_load_gdb_datadir_changed
);
1711 cmd
= add_cmd ("add-auto-load-safe-path", class_support
,
1712 add_auto_load_safe_path
,
1713 _("Add entries to the list of directories from which it is safe "
1714 "to auto-load files.\n\
1715 See the commands 'set auto-load safe-path' and 'show auto-load safe-path' to\n\
1716 access the current full list setting."),
1718 set_cmd_completer (cmd
, filename_completer
);
1720 cmd
= add_cmd ("add-auto-load-scripts-directory", class_support
,
1722 _("Add entries to the list of directories from which to load "
1723 "auto-loaded scripts.\n\
1724 See the commands 'set auto-load scripts-directory' and\n\
1725 'show auto-load scripts-directory' to access the current full list setting."),
1727 set_cmd_completer (cmd
, filename_completer
);
1729 add_setshow_boolean_cmd ("auto-load", class_maintenance
,
1730 &debug_auto_load
, _("\
1731 Set auto-load verifications debugging."), _("\
1732 Show auto-load verifications debugging."), _("\
1733 When non-zero, debugging output for files of 'set auto-load ...'\n\
1735 NULL
, show_debug_auto_load
,
1736 &setdebuglist
, &showdebuglist
);