1 /* GDB routines for supporting auto-loaded scripts.
3 Copyright (C) 2012-2020 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"
28 #include "observable.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"
35 #include "readline/tilde.h"
36 #include "completer.h"
39 #include "gdbsupport/filestuff.h"
40 #include "extension.h"
41 #include "gdb/section-scripts.h"
43 #include "gdbsupport/pathstuff.h"
44 #include "cli/cli-style.h"
46 /* The section to look in for auto-loaded scripts (in file formats that
48 Each entry in this section is a record that begins with a leading byte
49 identifying the record type.
50 At the moment we only support one record type: A leading byte of 1,
51 followed by the path of a python script to load. */
52 #define AUTO_SECTION_NAME ".debug_gdb_scripts"
54 static void maybe_print_unsupported_script_warning
55 (struct auto_load_pspace_info
*, struct objfile
*objfile
,
56 const struct extension_language_defn
*language
,
57 const char *section_name
, unsigned offset
);
59 static void maybe_print_script_not_found_warning
60 (struct auto_load_pspace_info
*, struct objfile
*objfile
,
61 const struct extension_language_defn
*language
,
62 const char *section_name
, unsigned offset
);
64 /* Value of the 'set debug auto-load' configuration variable. */
65 static bool debug_auto_load
= false;
67 /* "show" command for the debug_auto_load configuration variable. */
70 show_debug_auto_load (struct ui_file
*file
, int from_tty
,
71 struct cmd_list_element
*c
, const char *value
)
73 fprintf_filtered (file
, _("Debugging output for files "
74 "of 'set auto-load ...' is %s.\n"),
78 /* User-settable option to enable/disable auto-loading of GDB_AUTO_FILE_NAME
80 set auto-load gdb-scripts on|off
81 This is true if we should auto-load associated scripts when an objfile
82 is opened, false otherwise. */
83 static bool auto_load_gdb_scripts
= true;
85 /* "show" command for the auto_load_gdb_scripts configuration variable. */
88 show_auto_load_gdb_scripts (struct ui_file
*file
, int from_tty
,
89 struct cmd_list_element
*c
, const char *value
)
91 fprintf_filtered (file
, _("Auto-loading of canned sequences of commands "
96 /* Return non-zero if auto-loading gdb scripts is enabled. */
99 auto_load_gdb_scripts_enabled (const struct extension_language_defn
*extlang
)
101 return auto_load_gdb_scripts
;
104 /* Internal-use flag to enable/disable auto-loading.
105 This is true if we should auto-load python code when an objfile is opened,
108 Both auto_load_scripts && global_auto_load must be true to enable
111 This flag exists to facilitate deferring auto-loading during start-up
112 until after ./.gdbinit has been read; it may augment the search directories
113 used to find the scripts. */
114 bool global_auto_load
= true;
116 /* Auto-load .gdbinit file from the current directory? */
117 bool auto_load_local_gdbinit
= true;
119 /* Absolute pathname to the current directory .gdbinit, if it exists. */
120 char *auto_load_local_gdbinit_pathname
= NULL
;
122 /* if AUTO_LOAD_LOCAL_GDBINIT_PATHNAME has been loaded. */
123 bool auto_load_local_gdbinit_loaded
= false;
125 /* "show" command for the auto_load_local_gdbinit configuration variable. */
128 show_auto_load_local_gdbinit (struct ui_file
*file
, int from_tty
,
129 struct cmd_list_element
*c
, const char *value
)
131 fprintf_filtered (file
, _("Auto-loading of .gdbinit script from current "
132 "directory is %s.\n"),
136 /* Directory list from which to load auto-loaded scripts. It is not checked
137 for absolute paths but they are strongly recommended. It is initialized by
138 _initialize_auto_load. */
139 static char *auto_load_dir
;
141 /* "set" command for the auto_load_dir configuration variable. */
144 set_auto_load_dir (const char *args
, int from_tty
, struct cmd_list_element
*c
)
146 /* Setting the variable to "" resets it to the compile time defaults. */
147 if (auto_load_dir
[0] == '\0')
149 xfree (auto_load_dir
);
150 auto_load_dir
= xstrdup (AUTO_LOAD_DIR
);
154 /* "show" command for the auto_load_dir configuration variable. */
157 show_auto_load_dir (struct ui_file
*file
, int from_tty
,
158 struct cmd_list_element
*c
, const char *value
)
160 fprintf_filtered (file
, _("List of directories from which to load "
161 "auto-loaded scripts is %s.\n"),
165 /* Directory list safe to hold auto-loaded files. It is not checked for
166 absolute paths but they are strongly recommended. It is initialized by
167 _initialize_auto_load. */
168 static char *auto_load_safe_path
;
170 /* Vector of directory elements of AUTO_LOAD_SAFE_PATH with each one normalized
171 by tilde_expand and possibly each entries has added its gdb_realpath
173 std::vector
<gdb::unique_xmalloc_ptr
<char>> auto_load_safe_path_vec
;
175 /* Expand $datadir and $debugdir in STRING according to the rules of
176 substitute_path_component. */
178 static std::vector
<gdb::unique_xmalloc_ptr
<char>>
179 auto_load_expand_dir_vars (const char *string
)
181 char *s
= xstrdup (string
);
182 substitute_path_component (&s
, "$datadir", gdb_datadir
.c_str ());
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 std::vector
<gdb::unique_xmalloc_ptr
<char>> dir_vec
190 = dirnames_to_char_ptr_vec (s
);
196 /* Update auto_load_safe_path_vec from current AUTO_LOAD_SAFE_PATH. */
199 auto_load_safe_path_vec_update (void)
202 fprintf_unfiltered (gdb_stdlog
,
203 _("auto-load: Updating directories of \"%s\".\n"),
204 auto_load_safe_path
);
206 auto_load_safe_path_vec
= auto_load_expand_dir_vars (auto_load_safe_path
);
207 size_t len
= auto_load_safe_path_vec
.size ();
209 /* Apply tilde_expand and gdb_realpath to each AUTO_LOAD_SAFE_PATH_VEC
211 for (size_t i
= 0; i
< len
; i
++)
213 gdb::unique_xmalloc_ptr
<char> &in_vec
= auto_load_safe_path_vec
[i
];
214 gdb::unique_xmalloc_ptr
<char> expanded (tilde_expand (in_vec
.get ()));
215 gdb::unique_xmalloc_ptr
<char> real_path
= gdb_realpath (expanded
.get ());
217 /* Ensure the current entry is at least tilde_expand-ed. ORIGINAL makes
218 sure we free the original string. */
219 gdb::unique_xmalloc_ptr
<char> original
= std::move (in_vec
);
220 in_vec
= std::move (expanded
);
224 if (strcmp (in_vec
.get (), original
.get ()) == 0)
225 fprintf_unfiltered (gdb_stdlog
,
226 _("auto-load: Using directory \"%s\".\n"),
229 fprintf_unfiltered (gdb_stdlog
,
230 _("auto-load: Resolved directory \"%s\" "
232 original
.get (), in_vec
.get ());
235 /* If gdb_realpath returns a different content, append it. */
236 if (strcmp (real_path
.get (), in_vec
.get ()) != 0)
239 fprintf_unfiltered (gdb_stdlog
,
240 _("auto-load: And canonicalized as \"%s\".\n"),
243 auto_load_safe_path_vec
.push_back (std::move (real_path
));
248 /* Variable gdb_datadir has been set. Update content depending on $datadir. */
251 auto_load_gdb_datadir_changed (void)
253 auto_load_safe_path_vec_update ();
256 /* "set" command for the auto_load_safe_path configuration variable. */
259 set_auto_load_safe_path (const char *args
,
260 int from_tty
, struct cmd_list_element
*c
)
262 /* Setting the variable to "" resets it to the compile time defaults. */
263 if (auto_load_safe_path
[0] == '\0')
265 xfree (auto_load_safe_path
);
266 auto_load_safe_path
= xstrdup (AUTO_LOAD_SAFE_PATH
);
269 auto_load_safe_path_vec_update ();
272 /* "show" command for the auto_load_safe_path configuration variable. */
275 show_auto_load_safe_path (struct ui_file
*file
, int from_tty
,
276 struct cmd_list_element
*c
, const char *value
)
280 /* Check if user has entered either "/" or for example ":".
281 But while more complicate content like ":/foo" would still also
282 permit any location do not hide those. */
284 for (cs
= value
; *cs
&& (*cs
== DIRNAME_SEPARATOR
|| IS_DIR_SEPARATOR (*cs
));
287 fprintf_filtered (file
, _("Auto-load files are safe to load from any "
290 fprintf_filtered (file
, _("List of directories from which it is safe to "
291 "auto-load files is %s.\n"),
295 /* "add-auto-load-safe-path" command for the auto_load_safe_path configuration
299 add_auto_load_safe_path (const char *args
, int from_tty
)
303 if (args
== NULL
|| *args
== 0)
305 Directory argument required.\n\
306 Use 'set auto-load safe-path /' for disabling the auto-load safe-path security.\
309 s
= xstrprintf ("%s%c%s", auto_load_safe_path
, DIRNAME_SEPARATOR
, args
);
310 xfree (auto_load_safe_path
);
311 auto_load_safe_path
= s
;
313 auto_load_safe_path_vec_update ();
316 /* "add-auto-load-scripts-directory" command for the auto_load_dir configuration
320 add_auto_load_dir (const char *args
, int from_tty
)
324 if (args
== NULL
|| *args
== 0)
325 error (_("Directory argument required."));
327 s
= xstrprintf ("%s%c%s", auto_load_dir
, DIRNAME_SEPARATOR
, args
);
328 xfree (auto_load_dir
);
332 /* Implementation for filename_is_in_pattern overwriting the caller's FILENAME
336 filename_is_in_pattern_1 (char *filename
, char *pattern
)
338 size_t pattern_len
= strlen (pattern
);
339 size_t filename_len
= strlen (filename
);
342 fprintf_unfiltered (gdb_stdlog
, _("auto-load: Matching file \"%s\" "
343 "to pattern \"%s\"\n"),
346 /* Trim trailing slashes ("/") from PATTERN. Even for "d:\" paths as
347 trailing slashes are trimmed also from FILENAME it still matches
349 while (pattern_len
&& IS_DIR_SEPARATOR (pattern
[pattern_len
- 1]))
351 pattern
[pattern_len
] = '\0';
353 /* Ensure auto_load_safe_path "/" matches any FILENAME. On MS-Windows
354 platform FILENAME even after gdb_realpath does not have to start with
355 IS_DIR_SEPARATOR character, such as the 'C:\x.exe' filename. */
356 if (pattern_len
== 0)
359 fprintf_unfiltered (gdb_stdlog
,
360 _("auto-load: Matched - empty pattern\n"));
366 /* Trim trailing slashes ("/"). PATTERN also has slashes trimmed the
367 same way so they will match. */
368 while (filename_len
&& IS_DIR_SEPARATOR (filename
[filename_len
- 1]))
370 filename
[filename_len
] = '\0';
371 if (filename_len
== 0)
374 fprintf_unfiltered (gdb_stdlog
,
375 _("auto-load: Not matched - pattern \"%s\".\n"),
380 if (gdb_filename_fnmatch (pattern
, filename
, FNM_FILE_NAME
| FNM_NOESCAPE
)
384 fprintf_unfiltered (gdb_stdlog
, _("auto-load: Matched - file "
385 "\"%s\" to pattern \"%s\".\n"),
390 /* Trim trailing FILENAME component. */
391 while (filename_len
> 0 && !IS_DIR_SEPARATOR (filename
[filename_len
- 1]))
396 /* Return 1 if FILENAME matches PATTERN or if FILENAME resides in
397 a subdirectory of a directory that matches PATTERN. Return 0 otherwise.
398 gdb_realpath normalization is never done here. */
400 static ATTRIBUTE_PURE
int
401 filename_is_in_pattern (const char *filename
, const char *pattern
)
403 char *filename_copy
, *pattern_copy
;
405 filename_copy
= (char *) alloca (strlen (filename
) + 1);
406 strcpy (filename_copy
, filename
);
407 pattern_copy
= (char *) alloca (strlen (pattern
) + 1);
408 strcpy (pattern_copy
, pattern
);
410 return filename_is_in_pattern_1 (filename_copy
, pattern_copy
);
413 /* Return 1 if FILENAME belongs to one of directory components of
414 AUTO_LOAD_SAFE_PATH_VEC. Return 0 otherwise.
415 auto_load_safe_path_vec_update is never called.
416 *FILENAME_REALP may be updated by gdb_realpath of FILENAME. */
419 filename_is_in_auto_load_safe_path_vec (const char *filename
,
420 gdb::unique_xmalloc_ptr
<char> *filename_realp
)
422 const char *pattern
= NULL
;
424 for (const gdb::unique_xmalloc_ptr
<char> &p
: auto_load_safe_path_vec
)
425 if (*filename_realp
== NULL
&& filename_is_in_pattern (filename
, p
.get ()))
433 if (*filename_realp
== NULL
)
435 *filename_realp
= gdb_realpath (filename
);
436 if (debug_auto_load
&& strcmp (filename_realp
->get (), filename
) != 0)
437 fprintf_unfiltered (gdb_stdlog
,
438 _("auto-load: Resolved "
439 "file \"%s\" as \"%s\".\n"),
440 filename
, filename_realp
->get ());
443 if (strcmp (filename_realp
->get (), filename
) != 0)
444 for (const gdb::unique_xmalloc_ptr
<char> &p
: auto_load_safe_path_vec
)
445 if (filename_is_in_pattern (filename_realp
->get (), p
.get ()))
455 fprintf_unfiltered (gdb_stdlog
, _("auto-load: File \"%s\" matches "
456 "directory \"%s\".\n"),
464 /* Return 1 if FILENAME is located in one of the directories of
465 AUTO_LOAD_SAFE_PATH. Otherwise call warning and return 0. FILENAME does
466 not have to be an absolute path.
468 Existence of FILENAME is not checked. Function will still give a warning
469 even if the caller would quietly skip non-existing file in unsafe
473 file_is_auto_load_safe (const char *filename
, const char *debug_fmt
, ...)
475 gdb::unique_xmalloc_ptr
<char> filename_real
;
476 static int advice_printed
= 0;
482 va_start (debug_args
, debug_fmt
);
483 vfprintf_unfiltered (gdb_stdlog
, debug_fmt
, debug_args
);
487 if (filename_is_in_auto_load_safe_path_vec (filename
, &filename_real
))
490 auto_load_safe_path_vec_update ();
491 if (filename_is_in_auto_load_safe_path_vec (filename
, &filename_real
))
494 warning (_("File \"%ps\" auto-loading has been declined by your "
495 "`auto-load safe-path' set to \"%s\"."),
496 styled_string (file_name_style
.style (), filename_real
.get ()),
497 auto_load_safe_path
);
501 const char *homedir
= getenv ("HOME");
505 std::string homeinit
= string_printf ("%s/%s", homedir
, GDBINIT
);
507 printf_filtered (_("\
508 To enable execution of this file add\n\
509 \tadd-auto-load-safe-path %s\n\
510 line to your configuration file \"%s\".\n\
511 To completely disable this security protection add\n\
512 \tset auto-load safe-path /\n\
513 line to your configuration file \"%s\".\n\
514 For more information about this security protection see the\n\
515 \"Auto-loading safe path\" section in the GDB manual. E.g., run from the shell:\n\
516 \tinfo \"(gdb)Auto-loading safe path\"\n"),
517 filename_real
.get (),
518 homeinit
.c_str (), homeinit
.c_str ());
525 /* For scripts specified in .debug_gdb_scripts, multiple objfiles may load
526 the same script. There's no point in loading the script multiple times,
527 and there can be a lot of objfiles and scripts, so we keep track of scripts
530 struct auto_load_pspace_info
532 /* For each program space we keep track of loaded scripts, both when
533 specified as file names and as scripts to be executed directly. */
534 htab_up loaded_script_files
;
535 htab_up loaded_script_texts
;
537 /* Non-zero if we've issued the warning about an auto-load script not being
538 supported. We only want to issue this warning once. */
539 bool unsupported_script_warning_printed
= false;
541 /* Non-zero if we've issued the warning about an auto-load script not being
542 found. We only want to issue this warning once. */
543 bool script_not_found_warning_printed
= false;
546 /* Objects of this type are stored in the loaded_script hash table. */
550 /* Name as provided by the objfile. */
553 /* Full path name or NULL if script wasn't found (or was otherwise
554 inaccessible), or NULL for loaded_script_texts. */
555 const char *full_path
;
557 /* Non-zero if this script has been loaded. */
560 const struct extension_language_defn
*language
;
563 /* Per-program-space data key. */
564 static const struct program_space_key
<struct auto_load_pspace_info
>
565 auto_load_pspace_data
;
567 /* Get the current autoload data. If none is found yet, add it now. This
568 function always returns a valid object. */
570 static struct auto_load_pspace_info
*
571 get_auto_load_pspace_data (struct program_space
*pspace
)
573 struct auto_load_pspace_info
*info
;
575 info
= auto_load_pspace_data
.get (pspace
);
577 info
= auto_load_pspace_data
.emplace (pspace
);
582 /* Hash function for the loaded script hash. */
585 hash_loaded_script_entry (const void *data
)
587 const struct loaded_script
*e
= (const struct loaded_script
*) data
;
589 return htab_hash_string (e
->name
) ^ htab_hash_pointer (e
->language
);
592 /* Equality function for the loaded script hash. */
595 eq_loaded_script_entry (const void *a
, const void *b
)
597 const struct loaded_script
*ea
= (const struct loaded_script
*) a
;
598 const struct loaded_script
*eb
= (const struct loaded_script
*) b
;
600 return strcmp (ea
->name
, eb
->name
) == 0 && ea
->language
== eb
->language
;
603 /* Initialize the table to track loaded scripts.
604 Each entry is hashed by the full path name. */
607 init_loaded_scripts_info (struct auto_load_pspace_info
*pspace_info
)
609 /* Choose 31 as the starting size of the hash table, somewhat arbitrarily.
610 Space for each entry is obtained with one malloc so we can free them
613 pspace_info
->loaded_script_files
.reset
615 hash_loaded_script_entry
,
616 eq_loaded_script_entry
,
618 pspace_info
->loaded_script_texts
.reset
620 hash_loaded_script_entry
,
621 eq_loaded_script_entry
,
624 pspace_info
->unsupported_script_warning_printed
= false;
625 pspace_info
->script_not_found_warning_printed
= false;
628 /* Wrapper on get_auto_load_pspace_data to also allocate the hash table
629 for loading scripts. */
631 struct auto_load_pspace_info
*
632 get_auto_load_pspace_data_for_loading (struct program_space
*pspace
)
634 struct auto_load_pspace_info
*info
;
636 info
= get_auto_load_pspace_data (pspace
);
637 if (info
->loaded_script_files
== NULL
)
638 init_loaded_scripts_info (info
);
643 /* Add script file NAME in LANGUAGE to hash table of PSPACE_INFO.
644 LOADED 1 if the script has been (is going to) be loaded, 0 otherwise
645 (such as if it has not been found).
646 FULL_PATH is NULL if the script wasn't found.
647 The result is true if the script was already in the hash table. */
650 maybe_add_script_file (struct auto_load_pspace_info
*pspace_info
, int loaded
,
651 const char *name
, const char *full_path
,
652 const struct extension_language_defn
*language
)
654 struct htab
*htab
= pspace_info
->loaded_script_files
.get ();
655 struct loaded_script
**slot
, entry
;
659 entry
.language
= language
;
660 slot
= (struct loaded_script
**) htab_find_slot (htab
, &entry
, INSERT
);
661 in_hash_table
= *slot
!= NULL
;
663 /* If this script is not in the hash table, add it. */
669 /* Allocate all space in one chunk so it's easier to free. */
670 *slot
= ((struct loaded_script
*)
671 xmalloc (sizeof (**slot
)
673 + (full_path
!= NULL
? (strlen (full_path
) + 1) : 0)));
674 p
= ((char*) *slot
) + sizeof (**slot
);
677 if (full_path
!= NULL
)
680 strcpy (p
, full_path
);
681 (*slot
)->full_path
= p
;
684 (*slot
)->full_path
= NULL
;
685 (*slot
)->loaded
= loaded
;
686 (*slot
)->language
= language
;
689 return in_hash_table
;
692 /* Add script contents NAME in LANGUAGE to hash table of PSPACE_INFO.
693 LOADED 1 if the script has been (is going to) be loaded, 0 otherwise
694 (such as if it has not been found).
695 The result is true if the script was already in the hash table. */
698 maybe_add_script_text (struct auto_load_pspace_info
*pspace_info
,
699 int loaded
, const char *name
,
700 const struct extension_language_defn
*language
)
702 struct htab
*htab
= pspace_info
->loaded_script_texts
.get ();
703 struct loaded_script
**slot
, entry
;
707 entry
.language
= language
;
708 slot
= (struct loaded_script
**) htab_find_slot (htab
, &entry
, INSERT
);
709 in_hash_table
= *slot
!= NULL
;
711 /* If this script is not in the hash table, add it. */
717 /* Allocate all space in one chunk so it's easier to free. */
718 *slot
= ((struct loaded_script
*)
719 xmalloc (sizeof (**slot
) + strlen (name
) + 1));
720 p
= ((char*) *slot
) + sizeof (**slot
);
723 (*slot
)->full_path
= NULL
;
724 (*slot
)->loaded
= loaded
;
725 (*slot
)->language
= language
;
728 return in_hash_table
;
731 /* Clear the table of loaded section scripts. */
734 clear_section_scripts (void)
736 struct program_space
*pspace
= current_program_space
;
737 struct auto_load_pspace_info
*info
;
739 info
= auto_load_pspace_data
.get (pspace
);
740 if (info
!= NULL
&& info
->loaded_script_files
!= NULL
)
741 auto_load_pspace_data
.clear (pspace
);
744 /* Look for the auto-load script in LANGUAGE associated with OBJFILE where
745 OBJFILE's gdb_realpath is REALNAME and load it. Return 1 if we found any
746 matching script, return 0 otherwise. */
749 auto_load_objfile_script_1 (struct objfile
*objfile
, const char *realname
,
750 const struct extension_language_defn
*language
)
752 const char *debugfile
;
754 const char *suffix
= ext_lang_auto_load_suffix (language
);
756 std::string filename
= std::string (realname
) + suffix
;
758 gdb_file_up input
= gdb_fopen_cloexec (filename
.c_str (), "r");
759 debugfile
= filename
.c_str ();
761 fprintf_unfiltered (gdb_stdlog
, _("auto-load: Attempted file \"%s\" %s.\n"),
762 debugfile
, input
? _("exists") : _("does not exist"));
764 std::string debugfile_holder
;
767 /* Also try the same file in a subdirectory of gdb's data
770 std::vector
<gdb::unique_xmalloc_ptr
<char>> vec
771 = auto_load_expand_dir_vars (auto_load_dir
);
774 fprintf_unfiltered (gdb_stdlog
, _("auto-load: Searching 'set auto-load "
775 "scripts-directory' path \"%s\".\n"),
778 /* Convert Windows file name from c:/dir/file to /c/dir/file. */
779 if (HAS_DRIVE_SPEC (debugfile
))
780 filename
= (std::string("\\") + debugfile
[0]
781 + STRIP_DRIVE_SPEC (debugfile
));
783 for (const gdb::unique_xmalloc_ptr
<char> &dir
: vec
)
785 /* FILENAME is absolute, so we don't need a "/" here. */
786 debugfile_holder
= dir
.get () + filename
;
787 debugfile
= debugfile_holder
.c_str ();
789 input
= gdb_fopen_cloexec (debugfile
, "r");
791 fprintf_unfiltered (gdb_stdlog
, _("auto-load: Attempted file "
794 input
? _("exists") : _("does not exist"));
803 struct auto_load_pspace_info
*pspace_info
;
806 = file_is_auto_load_safe (debugfile
,
807 _("auto-load: Loading %s script \"%s\""
808 " by extension for objfile \"%s\".\n"),
809 ext_lang_name (language
),
810 debugfile
, objfile_name (objfile
));
812 /* Add this script to the hash table too so
813 "info auto-load ${lang}-scripts" can print it. */
815 = get_auto_load_pspace_data_for_loading (current_program_space
);
816 maybe_add_script_file (pspace_info
, is_safe
, debugfile
, debugfile
,
819 /* To preserve existing behaviour we don't check for whether the
820 script was already in the table, and always load it.
821 It's highly unlikely that we'd ever load it twice,
822 and these scripts are required to be idempotent under multiple
826 objfile_script_sourcer_func
*sourcer
827 = ext_lang_objfile_script_sourcer (language
);
829 /* We shouldn't get here if support for the language isn't
830 compiled in. And the extension language is required to implement
832 gdb_assert (sourcer
!= NULL
);
833 sourcer (language
, objfile
, input
.get (), debugfile
);
844 /* Look for the auto-load script in LANGUAGE associated with OBJFILE and load
848 auto_load_objfile_script (struct objfile
*objfile
,
849 const struct extension_language_defn
*language
)
851 gdb::unique_xmalloc_ptr
<char> realname
852 = gdb_realpath (objfile_name (objfile
));
854 if (!auto_load_objfile_script_1 (objfile
, realname
.get (), language
))
856 /* For Windows/DOS .exe executables, strip the .exe suffix, so that
857 FOO-gdb.gdb could be used for FOO.exe, and try again. */
859 size_t len
= strlen (realname
.get ());
860 const size_t lexe
= sizeof (".exe") - 1;
862 if (len
> lexe
&& strcasecmp (realname
.get () + len
- lexe
, ".exe") == 0)
865 realname
.get ()[len
] = '\0';
867 fprintf_unfiltered (gdb_stdlog
, _("auto-load: Stripped .exe suffix, "
868 "retrying with \"%s\".\n"),
870 auto_load_objfile_script_1 (objfile
, realname
.get (), language
);
875 /* Subroutine of source_section_scripts to simplify it.
876 Load FILE as a script in extension language LANGUAGE.
877 The script is from section SECTION_NAME in OBJFILE at offset OFFSET. */
880 source_script_file (struct auto_load_pspace_info
*pspace_info
,
881 struct objfile
*objfile
,
882 const struct extension_language_defn
*language
,
883 const char *section_name
, unsigned int offset
,
887 objfile_script_sourcer_func
*sourcer
;
889 /* Skip this script if support is not compiled in. */
890 sourcer
= ext_lang_objfile_script_sourcer (language
);
893 /* We don't throw an error, the program is still debuggable. */
894 maybe_print_unsupported_script_warning (pspace_info
, objfile
, language
,
895 section_name
, offset
);
896 /* We *could* still try to open it, but there's no point. */
897 maybe_add_script_file (pspace_info
, 0, file
, NULL
, language
);
901 /* Skip this script if auto-loading it has been disabled. */
902 if (!ext_lang_auto_load_enabled (language
))
904 /* No message is printed, just skip it. */
908 gdb::optional
<open_script
> opened
= find_and_open_script (file
,
913 if (!file_is_auto_load_safe (opened
->full_path
.get (),
914 _("auto-load: Loading %s script "
915 "\"%s\" from section \"%s\" of "
916 "objfile \"%s\".\n"),
917 ext_lang_name (language
),
918 opened
->full_path
.get (),
919 section_name
, objfile_name (objfile
)))
924 /* If one script isn't found it's not uncommon for more to not be
925 found either. We don't want to print a message for each script,
926 too much noise. Instead, we print the warning once and tell the
927 user how to find the list of scripts that weren't loaded.
928 We don't throw an error, the program is still debuggable.
930 IWBN if complaints.c were more general-purpose. */
932 maybe_print_script_not_found_warning (pspace_info
, objfile
, language
,
933 section_name
, offset
);
936 in_hash_table
= maybe_add_script_file (pspace_info
, bool (opened
), file
,
938 ? opened
->full_path
.get ()
942 /* If this file is not currently loaded, load it. */
943 if (opened
&& !in_hash_table
)
944 sourcer (language
, objfile
, opened
->stream
.get (),
945 opened
->full_path
.get ());
948 /* Subroutine of source_section_scripts to simplify it.
949 Execute SCRIPT as a script in extension language LANG.
950 The script is from section SECTION_NAME in OBJFILE at offset OFFSET. */
953 execute_script_contents (struct auto_load_pspace_info
*pspace_info
,
954 struct objfile
*objfile
,
955 const struct extension_language_defn
*language
,
956 const char *section_name
, unsigned int offset
,
959 objfile_script_executor_func
*executor
;
960 const char *newline
, *script_text
;
962 int is_safe
, in_hash_table
;
964 /* The first line of the script is the name of the script.
965 It must not contain any kind of space character. */
967 newline
= strchr (script
, '\n');
968 std::string name_holder
;
973 /* Put the name in a buffer and validate it. */
974 name_holder
= std::string (script
, newline
- script
);
975 buf
= name_holder
.c_str ();
976 for (p
= buf
; *p
!= '\0'; ++p
)
981 /* We don't allow nameless scripts, they're not helpful to the user. */
982 if (p
!= buf
&& *p
== '\0')
987 /* We don't throw an error, the program is still debuggable. */
989 Missing/bad script name in entry at offset %u in section %s\n\
991 offset
, section_name
,
992 styled_string (file_name_style
.style (),
993 objfile_name (objfile
)));
996 script_text
= newline
+ 1;
998 /* Skip this script if support is not compiled in. */
999 executor
= ext_lang_objfile_script_executor (language
);
1000 if (executor
== NULL
)
1002 /* We don't throw an error, the program is still debuggable. */
1003 maybe_print_unsupported_script_warning (pspace_info
, objfile
, language
,
1004 section_name
, offset
);
1005 maybe_add_script_text (pspace_info
, 0, name
, language
);
1009 /* Skip this script if auto-loading it has been disabled. */
1010 if (!ext_lang_auto_load_enabled (language
))
1012 /* No message is printed, just skip it. */
1016 is_safe
= file_is_auto_load_safe (objfile_name (objfile
),
1017 _("auto-load: Loading %s script "
1018 "\"%s\" from section \"%s\" of "
1019 "objfile \"%s\".\n"),
1020 ext_lang_name (language
), name
,
1021 section_name
, objfile_name (objfile
));
1023 in_hash_table
= maybe_add_script_text (pspace_info
, is_safe
, name
, language
);
1025 /* If this file is not currently loaded, load it. */
1026 if (is_safe
&& !in_hash_table
)
1027 executor (language
, objfile
, name
, script_text
);
1030 /* Load scripts specified in OBJFILE.
1031 START,END delimit a buffer containing a list of nul-terminated
1033 SECTION_NAME is used in error messages.
1035 Scripts specified as file names are found per normal "source -s" command
1036 processing. First the script is looked for in $cwd. If not found there
1037 the source search path is used.
1039 The section contains a list of path names of script files to load or
1040 actual script contents. Each entry is nul-terminated. */
1043 source_section_scripts (struct objfile
*objfile
, const char *section_name
,
1044 const char *start
, const char *end
)
1047 struct auto_load_pspace_info
*pspace_info
;
1049 pspace_info
= get_auto_load_pspace_data_for_loading (current_program_space
);
1051 for (p
= start
; p
< end
; ++p
)
1054 const struct extension_language_defn
*language
;
1055 unsigned int offset
= p
- start
;
1060 case SECTION_SCRIPT_ID_PYTHON_FILE
:
1061 case SECTION_SCRIPT_ID_PYTHON_TEXT
:
1062 language
= get_ext_lang_defn (EXT_LANG_PYTHON
);
1064 case SECTION_SCRIPT_ID_SCHEME_FILE
:
1065 case SECTION_SCRIPT_ID_SCHEME_TEXT
:
1066 language
= get_ext_lang_defn (EXT_LANG_GUILE
);
1069 warning (_("Invalid entry in %s section"), section_name
);
1070 /* We could try various heuristics to find the next valid entry,
1071 but it's safer to just punt. */
1076 while (p
< end
&& *p
!= '\0')
1080 warning (_("Non-nul-terminated entry in %s at offset %u"),
1081 section_name
, offset
);
1082 /* Don't load/execute it. */
1088 case SECTION_SCRIPT_ID_PYTHON_FILE
:
1089 case SECTION_SCRIPT_ID_SCHEME_FILE
:
1092 warning (_("Empty entry in %s at offset %u"),
1093 section_name
, offset
);
1096 source_script_file (pspace_info
, objfile
, language
,
1097 section_name
, offset
, entry
);
1099 case SECTION_SCRIPT_ID_PYTHON_TEXT
:
1100 case SECTION_SCRIPT_ID_SCHEME_TEXT
:
1101 execute_script_contents (pspace_info
, objfile
, language
,
1102 section_name
, offset
, entry
);
1108 /* Load scripts specified in section SECTION_NAME of OBJFILE. */
1111 auto_load_section_scripts (struct objfile
*objfile
, const char *section_name
)
1113 bfd
*abfd
= objfile
->obfd
;
1114 asection
*scripts_sect
;
1115 bfd_byte
*data
= NULL
;
1117 scripts_sect
= bfd_get_section_by_name (abfd
, section_name
);
1118 if (scripts_sect
== NULL
1119 || (bfd_section_flags (scripts_sect
) & SEC_HAS_CONTENTS
) == 0)
1122 if (!bfd_get_full_section_contents (abfd
, scripts_sect
, &data
))
1123 warning (_("Couldn't read %s section of %ps"),
1125 styled_string (file_name_style
.style (),
1126 bfd_get_filename (abfd
)));
1129 gdb::unique_xmalloc_ptr
<bfd_byte
> data_holder (data
);
1131 char *p
= (char *) data
;
1132 source_section_scripts (objfile
, section_name
, p
,
1133 p
+ bfd_section_size (scripts_sect
));
1137 /* Load any auto-loaded scripts for OBJFILE. */
1140 load_auto_scripts_for_objfile (struct objfile
*objfile
)
1142 /* Return immediately if auto-loading has been globally disabled.
1143 This is to handle sequencing of operations during gdb startup.
1144 Also return immediately if OBJFILE was not created from a file
1145 on the local filesystem. */
1146 if (!global_auto_load
1147 || (objfile
->flags
& OBJF_NOT_FILENAME
) != 0
1148 || is_target_filename (objfile
->original_name
))
1151 /* Load any extension language scripts for this objfile.
1152 E.g., foo-gdb.gdb, foo-gdb.py. */
1153 auto_load_ext_lang_scripts_for_objfile (objfile
);
1155 /* Load any scripts mentioned in AUTO_SECTION_NAME (.debug_gdb_scripts). */
1156 auto_load_section_scripts (objfile
, AUTO_SECTION_NAME
);
1159 /* This is a new_objfile observer callback to auto-load scripts.
1161 Two flavors of auto-loaded scripts are supported.
1162 1) based on the path to the objfile
1163 2) from .debug_gdb_scripts section */
1166 auto_load_new_objfile (struct objfile
*objfile
)
1170 /* OBJFILE is NULL when loading a new "main" symbol-file. */
1171 clear_section_scripts ();
1175 load_auto_scripts_for_objfile (objfile
);
1178 /* Collect scripts to be printed in a vec. */
1180 struct collect_matching_scripts_data
1182 collect_matching_scripts_data (std::vector
<loaded_script
*> *scripts_p_
,
1183 const extension_language_defn
*language_
)
1184 : scripts_p (scripts_p_
), language (language_
)
1187 std::vector
<loaded_script
*> *scripts_p
;
1188 const struct extension_language_defn
*language
;
1191 /* Traversal function for htab_traverse.
1192 Collect the entry if it matches the regexp. */
1195 collect_matching_scripts (void **slot
, void *info
)
1197 struct loaded_script
*script
= (struct loaded_script
*) *slot
;
1198 struct collect_matching_scripts_data
*data
1199 = (struct collect_matching_scripts_data
*) info
;
1201 if (script
->language
== data
->language
&& re_exec (script
->name
))
1202 data
->scripts_p
->push_back (script
);
1210 print_script (struct loaded_script
*script
)
1212 struct ui_out
*uiout
= current_uiout
;
1214 ui_out_emit_tuple
tuple_emitter (uiout
, NULL
);
1216 uiout
->field_string ("loaded", script
->loaded
? "Yes" : "No");
1217 uiout
->field_string ("script", script
->name
);
1220 /* If the name isn't the full path, print it too. */
1221 if (script
->full_path
!= NULL
1222 && strcmp (script
->name
, script
->full_path
) != 0)
1224 uiout
->text ("\tfull name: ");
1225 uiout
->field_string ("full_path", script
->full_path
);
1230 /* Helper for info_auto_load_scripts to sort the scripts by name. */
1233 sort_scripts_by_name (loaded_script
*a
, loaded_script
*b
)
1235 return FILENAME_CMP (a
->name
, b
->name
) < 0;
1238 /* Special internal GDB value of auto_load_info_scripts's PATTERN identify
1239 the "info auto-load XXX" command has been executed through the general
1240 "info auto-load" invocation. Extra newline will be printed if needed. */
1241 char auto_load_info_scripts_pattern_nl
[] = "";
1243 /* Subroutine of auto_load_info_scripts to simplify it.
1247 print_scripts (const std::vector
<loaded_script
*> &scripts
)
1249 for (loaded_script
*script
: scripts
)
1250 print_script (script
);
1253 /* Implementation for "info auto-load gdb-scripts"
1254 (and "info auto-load python-scripts"). List scripts in LANGUAGE matching
1255 PATTERN. FROM_TTY is the usual GDB boolean for user interactivity. */
1258 auto_load_info_scripts (const char *pattern
, int from_tty
,
1259 const struct extension_language_defn
*language
)
1261 struct ui_out
*uiout
= current_uiout
;
1262 struct auto_load_pspace_info
*pspace_info
;
1266 pspace_info
= get_auto_load_pspace_data (current_program_space
);
1268 if (pattern
&& *pattern
)
1270 char *re_err
= re_comp (pattern
);
1273 error (_("Invalid regexp: %s"), re_err
);
1280 /* We need to know the number of rows before we build the table.
1281 Plus we want to sort the scripts by name.
1282 So first traverse the hash table collecting the matching scripts. */
1284 std::vector
<loaded_script
*> script_files
, script_texts
;
1286 if (pspace_info
!= NULL
&& pspace_info
->loaded_script_files
!= NULL
)
1288 collect_matching_scripts_data
data (&script_files
, language
);
1290 /* Pass a pointer to scripts as VEC_safe_push can realloc space. */
1291 htab_traverse_noresize (pspace_info
->loaded_script_files
.get (),
1292 collect_matching_scripts
, &data
);
1294 std::sort (script_files
.begin (), script_files
.end (),
1295 sort_scripts_by_name
);
1298 if (pspace_info
!= NULL
&& pspace_info
->loaded_script_texts
!= NULL
)
1300 collect_matching_scripts_data
data (&script_texts
, language
);
1302 /* Pass a pointer to scripts as VEC_safe_push can realloc space. */
1303 htab_traverse_noresize (pspace_info
->loaded_script_texts
.get (),
1304 collect_matching_scripts
, &data
);
1306 std::sort (script_texts
.begin (), script_texts
.end (),
1307 sort_scripts_by_name
);
1310 int nr_scripts
= script_files
.size () + script_texts
.size ();
1312 /* Table header shifted right by preceding "gdb-scripts: " would not match
1314 if (nr_scripts
> 0 && pattern
== auto_load_info_scripts_pattern_nl
)
1318 ui_out_emit_table
table_emitter (uiout
, 2, nr_scripts
,
1319 "AutoLoadedScriptsTable");
1321 uiout
->table_header (7, ui_left
, "loaded", "Loaded");
1322 uiout
->table_header (70, ui_left
, "script", "Script");
1323 uiout
->table_body ();
1325 print_scripts (script_files
);
1326 print_scripts (script_texts
);
1329 if (nr_scripts
== 0)
1331 if (pattern
&& *pattern
)
1332 uiout
->message ("No auto-load scripts matching %s.\n", pattern
);
1334 uiout
->message ("No auto-load scripts.\n");
1338 /* Wrapper for "info auto-load gdb-scripts". */
1341 info_auto_load_gdb_scripts (const char *pattern
, int from_tty
)
1343 auto_load_info_scripts (pattern
, from_tty
, &extension_language_gdb
);
1346 /* Implement 'info auto-load local-gdbinit'. */
1349 info_auto_load_local_gdbinit (const char *args
, int from_tty
)
1351 if (auto_load_local_gdbinit_pathname
== NULL
)
1352 printf_filtered (_("Local .gdbinit file was not found.\n"));
1353 else if (auto_load_local_gdbinit_loaded
)
1354 printf_filtered (_("Local .gdbinit file \"%ps\" has been loaded.\n"),
1355 styled_string (file_name_style
.style (),
1356 auto_load_local_gdbinit_pathname
));
1358 printf_filtered (_("Local .gdbinit file \"%ps\" has not been loaded.\n"),
1359 styled_string (file_name_style
.style (),
1360 auto_load_local_gdbinit_pathname
));
1363 /* Print an "unsupported script" warning if it has not already been printed.
1364 The script is in language LANGUAGE at offset OFFSET in section SECTION_NAME
1368 maybe_print_unsupported_script_warning
1369 (struct auto_load_pspace_info
*pspace_info
,
1370 struct objfile
*objfile
, const struct extension_language_defn
*language
,
1371 const char *section_name
, unsigned offset
)
1373 if (!pspace_info
->unsupported_script_warning_printed
)
1376 Unsupported auto-load script at offset %u in section %s\n\
1378 Use `info auto-load %s-scripts [REGEXP]' to list them."),
1379 offset
, section_name
,
1380 styled_string (file_name_style
.style (),
1381 objfile_name (objfile
)),
1382 ext_lang_name (language
));
1383 pspace_info
->unsupported_script_warning_printed
= true;
1387 /* Return non-zero if SCRIPT_NOT_FOUND_WARNING_PRINTED of PSPACE_INFO was unset
1388 before calling this function. Always set SCRIPT_NOT_FOUND_WARNING_PRINTED
1392 maybe_print_script_not_found_warning
1393 (struct auto_load_pspace_info
*pspace_info
,
1394 struct objfile
*objfile
, const struct extension_language_defn
*language
,
1395 const char *section_name
, unsigned offset
)
1397 if (!pspace_info
->script_not_found_warning_printed
)
1400 Missing auto-load script at offset %u in section %s\n\
1402 Use `info auto-load %s-scripts [REGEXP]' to list them."),
1403 offset
, section_name
,
1404 styled_string (file_name_style
.style (),
1405 objfile_name (objfile
)),
1406 ext_lang_name (language
));
1407 pspace_info
->script_not_found_warning_printed
= true;
1411 /* The only valid "set auto-load" argument is off|0|no|disable. */
1414 set_auto_load_cmd (const char *args
, int from_tty
)
1416 struct cmd_list_element
*list
;
1419 /* See parse_binary_operation in use by the sub-commands. */
1421 length
= args
? strlen (args
) : 0;
1423 while (length
> 0 && (args
[length
- 1] == ' ' || args
[length
- 1] == '\t'))
1426 if (length
== 0 || (strncmp (args
, "off", length
) != 0
1427 && strncmp (args
, "0", length
) != 0
1428 && strncmp (args
, "no", length
) != 0
1429 && strncmp (args
, "disable", length
) != 0))
1430 error (_("Valid is only global 'set auto-load no'; "
1431 "otherwise check the auto-load sub-commands."));
1433 for (list
= *auto_load_set_cmdlist_get (); list
!= NULL
; list
= list
->next
)
1434 if (list
->var_type
== var_boolean
)
1436 gdb_assert (list
->type
== set_cmd
);
1437 do_set_command (args
, from_tty
, list
);
1441 /* Initialize "set auto-load " commands prefix and return it. */
1443 struct cmd_list_element
**
1444 auto_load_set_cmdlist_get (void)
1446 static struct cmd_list_element
*retval
;
1449 add_prefix_cmd ("auto-load", class_maintenance
, set_auto_load_cmd
, _("\
1450 Auto-loading specific settings.\n\
1451 Configure various auto-load-specific variables such as\n\
1452 automatic loading of Python scripts."),
1453 &retval
, "set auto-load ",
1454 1/*allow-unknown*/, &setlist
);
1459 /* Initialize "show auto-load " commands prefix and return it. */
1461 struct cmd_list_element
**
1462 auto_load_show_cmdlist_get (void)
1464 static struct cmd_list_element
*retval
;
1467 add_show_prefix_cmd ("auto-load", class_maintenance
, _("\
1468 Show auto-loading specific settings.\n\
1469 Show configuration of various auto-load-specific variables such as\n\
1470 automatic loading of Python scripts."),
1471 &retval
, "show auto-load ",
1472 0/*allow-unknown*/, &showlist
);
1477 /* Command "info auto-load" displays whether the various auto-load files have
1478 been loaded. This is reimplementation of cmd_show_list which inserts
1479 newlines at proper places. */
1482 info_auto_load_cmd (const char *args
, int from_tty
)
1484 struct cmd_list_element
*list
;
1485 struct ui_out
*uiout
= current_uiout
;
1487 ui_out_emit_tuple
tuple_emitter (uiout
, "infolist");
1489 for (list
= *auto_load_info_cmdlist_get (); list
!= NULL
; list
= list
->next
)
1491 ui_out_emit_tuple
option_emitter (uiout
, "option");
1493 gdb_assert (!list
->prefixlist
);
1494 gdb_assert (list
->type
== not_set_cmd
);
1496 uiout
->field_string ("name", list
->name
);
1498 cmd_func (list
, auto_load_info_scripts_pattern_nl
, from_tty
);
1502 /* Initialize "info auto-load " commands prefix and return it. */
1504 struct cmd_list_element
**
1505 auto_load_info_cmdlist_get (void)
1507 static struct cmd_list_element
*retval
;
1510 add_prefix_cmd ("auto-load", class_info
, info_auto_load_cmd
, _("\
1511 Print current status of auto-loaded files.\n\
1512 Print whether various files like Python scripts or .gdbinit files have been\n\
1513 found and/or loaded."),
1514 &retval
, "info auto-load ",
1515 0/*allow-unknown*/, &infolist
);
1520 void _initialize_auto_load ();
1522 _initialize_auto_load ()
1524 struct cmd_list_element
*cmd
;
1525 char *scripts_directory_help
, *gdb_name_help
, *python_name_help
;
1526 char *guile_name_help
;
1529 gdb::observers::new_objfile
.attach (auto_load_new_objfile
);
1531 add_setshow_boolean_cmd ("gdb-scripts", class_support
,
1532 &auto_load_gdb_scripts
, _("\
1533 Enable or disable auto-loading of canned sequences of commands scripts."), _("\
1534 Show whether auto-loading of canned sequences of commands scripts is enabled."),
1536 If enabled, canned sequences of commands are loaded when the debugger reads\n\
1537 an executable or shared library.\n\
1538 This option has security implications for untrusted inferiors."),
1539 NULL
, show_auto_load_gdb_scripts
,
1540 auto_load_set_cmdlist_get (),
1541 auto_load_show_cmdlist_get ());
1543 add_cmd ("gdb-scripts", class_info
, info_auto_load_gdb_scripts
,
1544 _("Print the list of automatically loaded sequences of commands.\n\
1545 Usage: info auto-load gdb-scripts [REGEXP]"),
1546 auto_load_info_cmdlist_get ());
1548 add_setshow_boolean_cmd ("local-gdbinit", class_support
,
1549 &auto_load_local_gdbinit
, _("\
1550 Enable or disable auto-loading of .gdbinit script in current directory."), _("\
1551 Show whether auto-loading .gdbinit script in current directory is enabled."),
1553 If enabled, canned sequences of commands are loaded when debugger starts\n\
1554 from .gdbinit file in current directory. Such files are deprecated,\n\
1555 use a script associated with inferior executable file instead.\n\
1556 This option has security implications for untrusted inferiors."),
1557 NULL
, show_auto_load_local_gdbinit
,
1558 auto_load_set_cmdlist_get (),
1559 auto_load_show_cmdlist_get ());
1561 add_cmd ("local-gdbinit", class_info
, info_auto_load_local_gdbinit
,
1562 _("Print whether current directory .gdbinit file has been loaded.\n\
1563 Usage: info auto-load local-gdbinit"),
1564 auto_load_info_cmdlist_get ());
1566 auto_load_dir
= xstrdup (AUTO_LOAD_DIR
);
1568 suffix
= ext_lang_auto_load_suffix (get_ext_lang_defn (EXT_LANG_GDB
));
1571 GDB scripts: OBJFILE%s\n"),
1573 python_name_help
= NULL
;
1575 suffix
= ext_lang_auto_load_suffix (get_ext_lang_defn (EXT_LANG_PYTHON
));
1578 Python scripts: OBJFILE%s\n"),
1581 guile_name_help
= NULL
;
1583 suffix
= ext_lang_auto_load_suffix (get_ext_lang_defn (EXT_LANG_GUILE
));
1586 Guile scripts: OBJFILE%s\n"),
1589 scripts_directory_help
1591 Automatically loaded scripts are located in one of the directories listed\n\
1597 This option is ignored for the kinds of scripts \
1598 having 'set auto-load ... off'.\n\
1599 Directories listed here need to be present also \
1600 in the 'set auto-load safe-path'\n\
1603 python_name_help
? python_name_help
: "",
1604 guile_name_help
? guile_name_help
: "");
1606 add_setshow_optional_filename_cmd ("scripts-directory", class_support
,
1607 &auto_load_dir
, _("\
1608 Set the list of directories from which to load auto-loaded scripts."), _("\
1609 Show the list of directories from which to load auto-loaded scripts."),
1610 scripts_directory_help
,
1611 set_auto_load_dir
, show_auto_load_dir
,
1612 auto_load_set_cmdlist_get (),
1613 auto_load_show_cmdlist_get ());
1614 xfree (scripts_directory_help
);
1615 xfree (python_name_help
);
1616 xfree (gdb_name_help
);
1617 xfree (guile_name_help
);
1619 auto_load_safe_path
= xstrdup (AUTO_LOAD_SAFE_PATH
);
1620 auto_load_safe_path_vec_update ();
1621 add_setshow_optional_filename_cmd ("safe-path", class_support
,
1622 &auto_load_safe_path
, _("\
1623 Set the list of files and directories that are safe for auto-loading."), _("\
1624 Show the list of files and directories that are safe for auto-loading."), _("\
1625 Various files loaded automatically for the 'set auto-load ...' options must\n\
1626 be located in one of the directories listed by this option. Warning will be\n\
1627 printed and file will not be used otherwise.\n\
1628 You can mix both directory and filename entries.\n\
1629 Setting this parameter to an empty list resets it to its default value.\n\
1630 Setting this parameter to '/' (without the quotes) allows any file\n\
1631 for the 'set auto-load ...' options. Each path entry can be also shell\n\
1632 wildcard pattern; '*' does not match directory separator.\n\
1633 This option is ignored for the kinds of files having 'set auto-load ... off'.\n\
1634 This option has security implications for untrusted inferiors."),
1635 set_auto_load_safe_path
,
1636 show_auto_load_safe_path
,
1637 auto_load_set_cmdlist_get (),
1638 auto_load_show_cmdlist_get ());
1639 gdb::observers::gdb_datadir_changed
.attach (auto_load_gdb_datadir_changed
);
1641 cmd
= add_cmd ("add-auto-load-safe-path", class_support
,
1642 add_auto_load_safe_path
,
1643 _("Add entries to the list of directories from which it is safe "
1644 "to auto-load files.\n\
1645 See the commands 'set auto-load safe-path' and 'show auto-load safe-path' to\n\
1646 access the current full list setting."),
1648 set_cmd_completer (cmd
, filename_completer
);
1650 cmd
= add_cmd ("add-auto-load-scripts-directory", class_support
,
1652 _("Add entries to the list of directories from which to load "
1653 "auto-loaded scripts.\n\
1654 See the commands 'set auto-load scripts-directory' and\n\
1655 'show auto-load scripts-directory' to access the current full list setting."),
1657 set_cmd_completer (cmd
, filename_completer
);
1659 add_setshow_boolean_cmd ("auto-load", class_maintenance
,
1660 &debug_auto_load
, _("\
1661 Set auto-load verifications debugging."), _("\
1662 Show auto-load verifications debugging."), _("\
1663 When non-zero, debugging output for files of 'set auto-load ...'\n\
1665 NULL
, show_debug_auto_load
,
1666 &setdebuglist
, &showdebuglist
);