gdb: add target_ops::supports_displaced_step
[deliverable/binutils-gdb.git] / gdb / auto-load.c
1 /* GDB routines for supporting auto-loaded scripts.
2
3 Copyright (C) 2012-2020 Free Software Foundation, Inc.
4
5 This file is part of GDB.
6
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.
11
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.
16
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/>. */
19
20 #include "defs.h"
21 #include <ctype.h>
22 #include "auto-load.h"
23 #include "progspace.h"
24 #include "gdb_regex.h"
25 #include "ui-out.h"
26 #include "filenames.h"
27 #include "command.h"
28 #include "observable.h"
29 #include "objfiles.h"
30 #include "cli/cli-script.h"
31 #include "gdbcmd.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"
37 #include "fnmatch.h"
38 #include "top.h"
39 #include "gdbsupport/filestuff.h"
40 #include "extension.h"
41 #include "gdb/section-scripts.h"
42 #include <algorithm>
43 #include "gdbsupport/pathstuff.h"
44 #include "cli/cli-style.h"
45
46 /* The section to look in for auto-loaded scripts (in file formats that
47 support sections).
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"
53
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);
58
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);
63
64 /* Value of the 'set debug auto-load' configuration variable. */
65 static bool debug_auto_load = false;
66
67 /* "show" command for the debug_auto_load configuration variable. */
68
69 static void
70 show_debug_auto_load (struct ui_file *file, int from_tty,
71 struct cmd_list_element *c, const char *value)
72 {
73 fprintf_filtered (file, _("Debugging output for files "
74 "of 'set auto-load ...' is %s.\n"),
75 value);
76 }
77
78 /* User-settable option to enable/disable auto-loading of GDB_AUTO_FILE_NAME
79 scripts:
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;
84
85 /* "show" command for the auto_load_gdb_scripts configuration variable. */
86
87 static void
88 show_auto_load_gdb_scripts (struct ui_file *file, int from_tty,
89 struct cmd_list_element *c, const char *value)
90 {
91 fprintf_filtered (file, _("Auto-loading of canned sequences of commands "
92 "scripts is %s.\n"),
93 value);
94 }
95
96 /* Return non-zero if auto-loading gdb scripts is enabled. */
97
98 int
99 auto_load_gdb_scripts_enabled (const struct extension_language_defn *extlang)
100 {
101 return auto_load_gdb_scripts;
102 }
103
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,
106 false otherwise.
107
108 Both auto_load_scripts && global_auto_load must be true to enable
109 auto-loading.
110
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;
115
116 /* Auto-load .gdbinit file from the current directory? */
117 bool auto_load_local_gdbinit = true;
118
119 /* Absolute pathname to the current directory .gdbinit, if it exists. */
120 char *auto_load_local_gdbinit_pathname = NULL;
121
122 /* if AUTO_LOAD_LOCAL_GDBINIT_PATHNAME has been loaded. */
123 bool auto_load_local_gdbinit_loaded = false;
124
125 /* "show" command for the auto_load_local_gdbinit configuration variable. */
126
127 static void
128 show_auto_load_local_gdbinit (struct ui_file *file, int from_tty,
129 struct cmd_list_element *c, const char *value)
130 {
131 fprintf_filtered (file, _("Auto-loading of .gdbinit script from current "
132 "directory is %s.\n"),
133 value);
134 }
135
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;
140
141 /* "set" command for the auto_load_dir configuration variable. */
142
143 static void
144 set_auto_load_dir (const char *args, int from_tty, struct cmd_list_element *c)
145 {
146 /* Setting the variable to "" resets it to the compile time defaults. */
147 if (auto_load_dir[0] == '\0')
148 {
149 xfree (auto_load_dir);
150 auto_load_dir = xstrdup (AUTO_LOAD_DIR);
151 }
152 }
153
154 /* "show" command for the auto_load_dir configuration variable. */
155
156 static void
157 show_auto_load_dir (struct ui_file *file, int from_tty,
158 struct cmd_list_element *c, const char *value)
159 {
160 fprintf_filtered (file, _("List of directories from which to load "
161 "auto-loaded scripts is %s.\n"),
162 value);
163 }
164
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;
169
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
172 counterpart. */
173 std::vector<gdb::unique_xmalloc_ptr<char>> auto_load_safe_path_vec;
174
175 /* Expand $datadir and $debugdir in STRING according to the rules of
176 substitute_path_component. */
177
178 static std::vector<gdb::unique_xmalloc_ptr<char>>
179 auto_load_expand_dir_vars (const char *string)
180 {
181 char *s = xstrdup (string);
182 substitute_path_component (&s, "$datadir", gdb_datadir.c_str ());
183 substitute_path_component (&s, "$debugdir", debug_file_directory);
184
185 if (debug_auto_load && strcmp (s, string) != 0)
186 fprintf_unfiltered (gdb_stdlog,
187 _("auto-load: Expanded $-variables to \"%s\".\n"), s);
188
189 std::vector<gdb::unique_xmalloc_ptr<char>> dir_vec
190 = dirnames_to_char_ptr_vec (s);
191 xfree(s);
192
193 return dir_vec;
194 }
195
196 /* Update auto_load_safe_path_vec from current AUTO_LOAD_SAFE_PATH. */
197
198 static void
199 auto_load_safe_path_vec_update (void)
200 {
201 if (debug_auto_load)
202 fprintf_unfiltered (gdb_stdlog,
203 _("auto-load: Updating directories of \"%s\".\n"),
204 auto_load_safe_path);
205
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 ();
208
209 /* Apply tilde_expand and gdb_realpath to each AUTO_LOAD_SAFE_PATH_VEC
210 element. */
211 for (size_t i = 0; i < len; i++)
212 {
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 ());
216
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);
221
222 if (debug_auto_load)
223 {
224 if (strcmp (in_vec.get (), original.get ()) == 0)
225 fprintf_unfiltered (gdb_stdlog,
226 _("auto-load: Using directory \"%s\".\n"),
227 in_vec.get ());
228 else
229 fprintf_unfiltered (gdb_stdlog,
230 _("auto-load: Resolved directory \"%s\" "
231 "as \"%s\".\n"),
232 original.get (), in_vec.get ());
233 }
234
235 /* If gdb_realpath returns a different content, append it. */
236 if (strcmp (real_path.get (), in_vec.get ()) != 0)
237 {
238 if (debug_auto_load)
239 fprintf_unfiltered (gdb_stdlog,
240 _("auto-load: And canonicalized as \"%s\".\n"),
241 real_path.get ());
242
243 auto_load_safe_path_vec.push_back (std::move (real_path));
244 }
245 }
246 }
247
248 /* Variable gdb_datadir has been set. Update content depending on $datadir. */
249
250 static void
251 auto_load_gdb_datadir_changed (void)
252 {
253 auto_load_safe_path_vec_update ();
254 }
255
256 /* "set" command for the auto_load_safe_path configuration variable. */
257
258 static void
259 set_auto_load_safe_path (const char *args,
260 int from_tty, struct cmd_list_element *c)
261 {
262 /* Setting the variable to "" resets it to the compile time defaults. */
263 if (auto_load_safe_path[0] == '\0')
264 {
265 xfree (auto_load_safe_path);
266 auto_load_safe_path = xstrdup (AUTO_LOAD_SAFE_PATH);
267 }
268
269 auto_load_safe_path_vec_update ();
270 }
271
272 /* "show" command for the auto_load_safe_path configuration variable. */
273
274 static void
275 show_auto_load_safe_path (struct ui_file *file, int from_tty,
276 struct cmd_list_element *c, const char *value)
277 {
278 const char *cs;
279
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. */
283
284 for (cs = value; *cs && (*cs == DIRNAME_SEPARATOR || IS_DIR_SEPARATOR (*cs));
285 cs++);
286 if (*cs == 0)
287 fprintf_filtered (file, _("Auto-load files are safe to load from any "
288 "directory.\n"));
289 else
290 fprintf_filtered (file, _("List of directories from which it is safe to "
291 "auto-load files is %s.\n"),
292 value);
293 }
294
295 /* "add-auto-load-safe-path" command for the auto_load_safe_path configuration
296 variable. */
297
298 static void
299 add_auto_load_safe_path (const char *args, int from_tty)
300 {
301 char *s;
302
303 if (args == NULL || *args == 0)
304 error (_("\
305 Directory argument required.\n\
306 Use 'set auto-load safe-path /' for disabling the auto-load safe-path security.\
307 "));
308
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;
312
313 auto_load_safe_path_vec_update ();
314 }
315
316 /* "add-auto-load-scripts-directory" command for the auto_load_dir configuration
317 variable. */
318
319 static void
320 add_auto_load_dir (const char *args, int from_tty)
321 {
322 char *s;
323
324 if (args == NULL || *args == 0)
325 error (_("Directory argument required."));
326
327 s = xstrprintf ("%s%c%s", auto_load_dir, DIRNAME_SEPARATOR, args);
328 xfree (auto_load_dir);
329 auto_load_dir = s;
330 }
331
332 /* Implementation for filename_is_in_pattern overwriting the caller's FILENAME
333 and PATTERN. */
334
335 static int
336 filename_is_in_pattern_1 (char *filename, char *pattern)
337 {
338 size_t pattern_len = strlen (pattern);
339 size_t filename_len = strlen (filename);
340
341 if (debug_auto_load)
342 fprintf_unfiltered (gdb_stdlog, _("auto-load: Matching file \"%s\" "
343 "to pattern \"%s\"\n"),
344 filename, pattern);
345
346 /* Trim trailing slashes ("/") from PATTERN. Even for "d:\" paths as
347 trailing slashes are trimmed also from FILENAME it still matches
348 correctly. */
349 while (pattern_len && IS_DIR_SEPARATOR (pattern[pattern_len - 1]))
350 pattern_len--;
351 pattern[pattern_len] = '\0';
352
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)
357 {
358 if (debug_auto_load)
359 fprintf_unfiltered (gdb_stdlog,
360 _("auto-load: Matched - empty pattern\n"));
361 return 1;
362 }
363
364 for (;;)
365 {
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]))
369 filename_len--;
370 filename[filename_len] = '\0';
371 if (filename_len == 0)
372 {
373 if (debug_auto_load)
374 fprintf_unfiltered (gdb_stdlog,
375 _("auto-load: Not matched - pattern \"%s\".\n"),
376 pattern);
377 return 0;
378 }
379
380 if (gdb_filename_fnmatch (pattern, filename, FNM_FILE_NAME | FNM_NOESCAPE)
381 == 0)
382 {
383 if (debug_auto_load)
384 fprintf_unfiltered (gdb_stdlog, _("auto-load: Matched - file "
385 "\"%s\" to pattern \"%s\".\n"),
386 filename, pattern);
387 return 1;
388 }
389
390 /* Trim trailing FILENAME component. */
391 while (filename_len > 0 && !IS_DIR_SEPARATOR (filename[filename_len - 1]))
392 filename_len--;
393 }
394 }
395
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. */
399
400 static ATTRIBUTE_PURE int
401 filename_is_in_pattern (const char *filename, const char *pattern)
402 {
403 char *filename_copy, *pattern_copy;
404
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);
409
410 return filename_is_in_pattern_1 (filename_copy, pattern_copy);
411 }
412
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. */
417
418 static int
419 filename_is_in_auto_load_safe_path_vec (const char *filename,
420 gdb::unique_xmalloc_ptr<char> *filename_realp)
421 {
422 const char *pattern = NULL;
423
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 ()))
426 {
427 pattern = p.get ();
428 break;
429 }
430
431 if (pattern == NULL)
432 {
433 if (*filename_realp == NULL)
434 {
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 ());
441 }
442
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 ()))
446 {
447 pattern = p.get ();
448 break;
449 }
450 }
451
452 if (pattern != NULL)
453 {
454 if (debug_auto_load)
455 fprintf_unfiltered (gdb_stdlog, _("auto-load: File \"%s\" matches "
456 "directory \"%s\".\n"),
457 filename, pattern);
458 return 1;
459 }
460
461 return 0;
462 }
463
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.
467
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
470 directory. */
471
472 int
473 file_is_auto_load_safe (const char *filename, const char *debug_fmt, ...)
474 {
475 gdb::unique_xmalloc_ptr<char> filename_real;
476 static int advice_printed = 0;
477
478 if (debug_auto_load)
479 {
480 va_list debug_args;
481
482 va_start (debug_args, debug_fmt);
483 vfprintf_unfiltered (gdb_stdlog, debug_fmt, debug_args);
484 va_end (debug_args);
485 }
486
487 if (filename_is_in_auto_load_safe_path_vec (filename, &filename_real))
488 return 1;
489
490 auto_load_safe_path_vec_update ();
491 if (filename_is_in_auto_load_safe_path_vec (filename, &filename_real))
492 return 1;
493
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);
498
499 if (!advice_printed)
500 {
501 const char *homedir = getenv ("HOME");
502
503 if (homedir == NULL)
504 homedir = "$HOME";
505 std::string homeinit = string_printf ("%s/%s", homedir, GDBINIT);
506
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 ());
519 advice_printed = 1;
520 }
521
522 return 0;
523 }
524
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
528 loaded this way. */
529
530 struct auto_load_pspace_info
531 {
532 auto_load_pspace_info () = default;
533 ~auto_load_pspace_info ();
534
535 /* For each program space we keep track of loaded scripts, both when
536 specified as file names and as scripts to be executed directly. */
537 struct htab *loaded_script_files = nullptr;
538 struct htab *loaded_script_texts = nullptr;
539
540 /* Non-zero if we've issued the warning about an auto-load script not being
541 supported. We only want to issue this warning once. */
542 bool unsupported_script_warning_printed = false;
543
544 /* Non-zero if we've issued the warning about an auto-load script not being
545 found. We only want to issue this warning once. */
546 bool script_not_found_warning_printed = false;
547 };
548
549 /* Objects of this type are stored in the loaded_script hash table. */
550
551 struct loaded_script
552 {
553 /* Name as provided by the objfile. */
554 const char *name;
555
556 /* Full path name or NULL if script wasn't found (or was otherwise
557 inaccessible), or NULL for loaded_script_texts. */
558 const char *full_path;
559
560 /* Non-zero if this script has been loaded. */
561 int loaded;
562
563 const struct extension_language_defn *language;
564 };
565
566 /* Per-program-space data key. */
567 static const struct program_space_key<struct auto_load_pspace_info>
568 auto_load_pspace_data;
569
570 auto_load_pspace_info::~auto_load_pspace_info ()
571 {
572 if (loaded_script_files)
573 htab_delete (loaded_script_files);
574 if (loaded_script_texts)
575 htab_delete (loaded_script_texts);
576 }
577
578 /* Get the current autoload data. If none is found yet, add it now. This
579 function always returns a valid object. */
580
581 static struct auto_load_pspace_info *
582 get_auto_load_pspace_data (struct program_space *pspace)
583 {
584 struct auto_load_pspace_info *info;
585
586 info = auto_load_pspace_data.get (pspace);
587 if (info == NULL)
588 info = auto_load_pspace_data.emplace (pspace);
589
590 return info;
591 }
592
593 /* Hash function for the loaded script hash. */
594
595 static hashval_t
596 hash_loaded_script_entry (const void *data)
597 {
598 const struct loaded_script *e = (const struct loaded_script *) data;
599
600 return htab_hash_string (e->name) ^ htab_hash_pointer (e->language);
601 }
602
603 /* Equality function for the loaded script hash. */
604
605 static int
606 eq_loaded_script_entry (const void *a, const void *b)
607 {
608 const struct loaded_script *ea = (const struct loaded_script *) a;
609 const struct loaded_script *eb = (const struct loaded_script *) b;
610
611 return strcmp (ea->name, eb->name) == 0 && ea->language == eb->language;
612 }
613
614 /* Initialize the table to track loaded scripts.
615 Each entry is hashed by the full path name. */
616
617 static void
618 init_loaded_scripts_info (struct auto_load_pspace_info *pspace_info)
619 {
620 /* Choose 31 as the starting size of the hash table, somewhat arbitrarily.
621 Space for each entry is obtained with one malloc so we can free them
622 easily. */
623
624 pspace_info->loaded_script_files = htab_create (31,
625 hash_loaded_script_entry,
626 eq_loaded_script_entry,
627 xfree);
628 pspace_info->loaded_script_texts = htab_create (31,
629 hash_loaded_script_entry,
630 eq_loaded_script_entry,
631 xfree);
632
633 pspace_info->unsupported_script_warning_printed = false;
634 pspace_info->script_not_found_warning_printed = false;
635 }
636
637 /* Wrapper on get_auto_load_pspace_data to also allocate the hash table
638 for loading scripts. */
639
640 struct auto_load_pspace_info *
641 get_auto_load_pspace_data_for_loading (struct program_space *pspace)
642 {
643 struct auto_load_pspace_info *info;
644
645 info = get_auto_load_pspace_data (pspace);
646 if (info->loaded_script_files == NULL)
647 init_loaded_scripts_info (info);
648
649 return info;
650 }
651
652 /* Add script file NAME in LANGUAGE to hash table of PSPACE_INFO.
653 LOADED 1 if the script has been (is going to) be loaded, 0 otherwise
654 (such as if it has not been found).
655 FULL_PATH is NULL if the script wasn't found.
656 The result is true if the script was already in the hash table. */
657
658 static int
659 maybe_add_script_file (struct auto_load_pspace_info *pspace_info, int loaded,
660 const char *name, const char *full_path,
661 const struct extension_language_defn *language)
662 {
663 struct htab *htab = pspace_info->loaded_script_files;
664 struct loaded_script **slot, entry;
665 int in_hash_table;
666
667 entry.name = name;
668 entry.language = language;
669 slot = (struct loaded_script **) htab_find_slot (htab, &entry, INSERT);
670 in_hash_table = *slot != NULL;
671
672 /* If this script is not in the hash table, add it. */
673
674 if (!in_hash_table)
675 {
676 char *p;
677
678 /* Allocate all space in one chunk so it's easier to free. */
679 *slot = ((struct loaded_script *)
680 xmalloc (sizeof (**slot)
681 + strlen (name) + 1
682 + (full_path != NULL ? (strlen (full_path) + 1) : 0)));
683 p = ((char*) *slot) + sizeof (**slot);
684 strcpy (p, name);
685 (*slot)->name = p;
686 if (full_path != NULL)
687 {
688 p += strlen (p) + 1;
689 strcpy (p, full_path);
690 (*slot)->full_path = p;
691 }
692 else
693 (*slot)->full_path = NULL;
694 (*slot)->loaded = loaded;
695 (*slot)->language = language;
696 }
697
698 return in_hash_table;
699 }
700
701 /* Add script contents NAME in LANGUAGE to hash table of PSPACE_INFO.
702 LOADED 1 if the script has been (is going to) be loaded, 0 otherwise
703 (such as if it has not been found).
704 The result is true if the script was already in the hash table. */
705
706 static int
707 maybe_add_script_text (struct auto_load_pspace_info *pspace_info,
708 int loaded, const char *name,
709 const struct extension_language_defn *language)
710 {
711 struct htab *htab = pspace_info->loaded_script_texts;
712 struct loaded_script **slot, entry;
713 int in_hash_table;
714
715 entry.name = name;
716 entry.language = language;
717 slot = (struct loaded_script **) htab_find_slot (htab, &entry, INSERT);
718 in_hash_table = *slot != NULL;
719
720 /* If this script is not in the hash table, add it. */
721
722 if (!in_hash_table)
723 {
724 char *p;
725
726 /* Allocate all space in one chunk so it's easier to free. */
727 *slot = ((struct loaded_script *)
728 xmalloc (sizeof (**slot) + strlen (name) + 1));
729 p = ((char*) *slot) + sizeof (**slot);
730 strcpy (p, name);
731 (*slot)->name = p;
732 (*slot)->full_path = NULL;
733 (*slot)->loaded = loaded;
734 (*slot)->language = language;
735 }
736
737 return in_hash_table;
738 }
739
740 /* Clear the table of loaded section scripts. */
741
742 static void
743 clear_section_scripts (void)
744 {
745 struct program_space *pspace = current_program_space;
746 struct auto_load_pspace_info *info;
747
748 info = auto_load_pspace_data.get (pspace);
749 if (info != NULL && info->loaded_script_files != NULL)
750 auto_load_pspace_data.clear (pspace);
751 }
752
753 /* Look for the auto-load script in LANGUAGE associated with OBJFILE where
754 OBJFILE's gdb_realpath is REALNAME and load it. Return 1 if we found any
755 matching script, return 0 otherwise. */
756
757 static int
758 auto_load_objfile_script_1 (struct objfile *objfile, const char *realname,
759 const struct extension_language_defn *language)
760 {
761 const char *debugfile;
762 int retval;
763 const char *suffix = ext_lang_auto_load_suffix (language);
764
765 std::string filename = std::string (realname) + suffix;
766
767 gdb_file_up input = gdb_fopen_cloexec (filename.c_str (), "r");
768 debugfile = filename.c_str ();
769 if (debug_auto_load)
770 fprintf_unfiltered (gdb_stdlog, _("auto-load: Attempted file \"%s\" %s.\n"),
771 debugfile, input ? _("exists") : _("does not exist"));
772
773 std::string debugfile_holder;
774 if (!input)
775 {
776 /* Also try the same file in a subdirectory of gdb's data
777 directory. */
778
779 std::vector<gdb::unique_xmalloc_ptr<char>> vec
780 = auto_load_expand_dir_vars (auto_load_dir);
781
782 if (debug_auto_load)
783 fprintf_unfiltered (gdb_stdlog, _("auto-load: Searching 'set auto-load "
784 "scripts-directory' path \"%s\".\n"),
785 auto_load_dir);
786
787 for (const gdb::unique_xmalloc_ptr<char> &dir : vec)
788 {
789 /* FILENAME is absolute, so we don't need a "/" here. */
790 debugfile_holder = dir.get () + filename;
791 debugfile = debugfile_holder.c_str ();
792
793 input = gdb_fopen_cloexec (debugfile, "r");
794 if (debug_auto_load)
795 fprintf_unfiltered (gdb_stdlog, _("auto-load: Attempted file "
796 "\"%s\" %s.\n"),
797 debugfile,
798 input ? _("exists") : _("does not exist"));
799 if (input != NULL)
800 break;
801 }
802 }
803
804 if (input)
805 {
806 int is_safe;
807 struct auto_load_pspace_info *pspace_info;
808
809 is_safe
810 = file_is_auto_load_safe (debugfile,
811 _("auto-load: Loading %s script \"%s\""
812 " by extension for objfile \"%s\".\n"),
813 ext_lang_name (language),
814 debugfile, objfile_name (objfile));
815
816 /* Add this script to the hash table too so
817 "info auto-load ${lang}-scripts" can print it. */
818 pspace_info
819 = get_auto_load_pspace_data_for_loading (current_program_space);
820 maybe_add_script_file (pspace_info, is_safe, debugfile, debugfile,
821 language);
822
823 /* To preserve existing behaviour we don't check for whether the
824 script was already in the table, and always load it.
825 It's highly unlikely that we'd ever load it twice,
826 and these scripts are required to be idempotent under multiple
827 loads anyway. */
828 if (is_safe)
829 {
830 objfile_script_sourcer_func *sourcer
831 = ext_lang_objfile_script_sourcer (language);
832
833 /* We shouldn't get here if support for the language isn't
834 compiled in. And the extension language is required to implement
835 this function. */
836 gdb_assert (sourcer != NULL);
837 sourcer (language, objfile, input.get (), debugfile);
838 }
839
840 retval = 1;
841 }
842 else
843 retval = 0;
844
845 return retval;
846 }
847
848 /* Look for the auto-load script in LANGUAGE associated with OBJFILE and load
849 it. */
850
851 void
852 auto_load_objfile_script (struct objfile *objfile,
853 const struct extension_language_defn *language)
854 {
855 gdb::unique_xmalloc_ptr<char> realname
856 = gdb_realpath (objfile_name (objfile));
857
858 if (!auto_load_objfile_script_1 (objfile, realname.get (), language))
859 {
860 /* For Windows/DOS .exe executables, strip the .exe suffix, so that
861 FOO-gdb.gdb could be used for FOO.exe, and try again. */
862
863 size_t len = strlen (realname.get ());
864 const size_t lexe = sizeof (".exe") - 1;
865
866 if (len > lexe && strcasecmp (realname.get () + len - lexe, ".exe") == 0)
867 {
868 len -= lexe;
869 realname.get ()[len] = '\0';
870 if (debug_auto_load)
871 fprintf_unfiltered (gdb_stdlog, _("auto-load: Stripped .exe suffix, "
872 "retrying with \"%s\".\n"),
873 realname.get ());
874 auto_load_objfile_script_1 (objfile, realname.get (), language);
875 }
876 }
877 }
878
879 /* Subroutine of source_section_scripts to simplify it.
880 Load FILE as a script in extension language LANGUAGE.
881 The script is from section SECTION_NAME in OBJFILE at offset OFFSET. */
882
883 static void
884 source_script_file (struct auto_load_pspace_info *pspace_info,
885 struct objfile *objfile,
886 const struct extension_language_defn *language,
887 const char *section_name, unsigned int offset,
888 const char *file)
889 {
890 int in_hash_table;
891 objfile_script_sourcer_func *sourcer;
892
893 /* Skip this script if support is not compiled in. */
894 sourcer = ext_lang_objfile_script_sourcer (language);
895 if (sourcer == NULL)
896 {
897 /* We don't throw an error, the program is still debuggable. */
898 maybe_print_unsupported_script_warning (pspace_info, objfile, language,
899 section_name, offset);
900 /* We *could* still try to open it, but there's no point. */
901 maybe_add_script_file (pspace_info, 0, file, NULL, language);
902 return;
903 }
904
905 /* Skip this script if auto-loading it has been disabled. */
906 if (!ext_lang_auto_load_enabled (language))
907 {
908 /* No message is printed, just skip it. */
909 return;
910 }
911
912 gdb::optional<open_script> opened = find_and_open_script (file,
913 1 /*search_path*/);
914
915 if (opened)
916 {
917 if (!file_is_auto_load_safe (opened->full_path.get (),
918 _("auto-load: Loading %s script "
919 "\"%s\" from section \"%s\" of "
920 "objfile \"%s\".\n"),
921 ext_lang_name (language),
922 opened->full_path.get (),
923 section_name, objfile_name (objfile)))
924 opened.reset ();
925 }
926 else
927 {
928 /* If one script isn't found it's not uncommon for more to not be
929 found either. We don't want to print a message for each script,
930 too much noise. Instead, we print the warning once and tell the
931 user how to find the list of scripts that weren't loaded.
932 We don't throw an error, the program is still debuggable.
933
934 IWBN if complaints.c were more general-purpose. */
935
936 maybe_print_script_not_found_warning (pspace_info, objfile, language,
937 section_name, offset);
938 }
939
940 in_hash_table = maybe_add_script_file (pspace_info, bool (opened), file,
941 (opened
942 ? opened->full_path.get ()
943 : NULL),
944 language);
945
946 /* If this file is not currently loaded, load it. */
947 if (opened && !in_hash_table)
948 sourcer (language, objfile, opened->stream.get (),
949 opened->full_path.get ());
950 }
951
952 /* Subroutine of source_section_scripts to simplify it.
953 Execute SCRIPT as a script in extension language LANG.
954 The script is from section SECTION_NAME in OBJFILE at offset OFFSET. */
955
956 static void
957 execute_script_contents (struct auto_load_pspace_info *pspace_info,
958 struct objfile *objfile,
959 const struct extension_language_defn *language,
960 const char *section_name, unsigned int offset,
961 const char *script)
962 {
963 objfile_script_executor_func *executor;
964 const char *newline, *script_text;
965 const char *name;
966 int is_safe, in_hash_table;
967
968 /* The first line of the script is the name of the script.
969 It must not contain any kind of space character. */
970 name = NULL;
971 newline = strchr (script, '\n');
972 std::string name_holder;
973 if (newline != NULL)
974 {
975 const char *buf, *p;
976
977 /* Put the name in a buffer and validate it. */
978 name_holder = std::string (script, newline - script);
979 buf = name_holder.c_str ();
980 for (p = buf; *p != '\0'; ++p)
981 {
982 if (isspace (*p))
983 break;
984 }
985 /* We don't allow nameless scripts, they're not helpful to the user. */
986 if (p != buf && *p == '\0')
987 name = buf;
988 }
989 if (name == NULL)
990 {
991 /* We don't throw an error, the program is still debuggable. */
992 warning (_("\
993 Missing/bad script name in entry at offset %u in section %s\n\
994 of file %ps."),
995 offset, section_name,
996 styled_string (file_name_style.style (),
997 objfile_name (objfile)));
998 return;
999 }
1000 script_text = newline + 1;
1001
1002 /* Skip this script if support is not compiled in. */
1003 executor = ext_lang_objfile_script_executor (language);
1004 if (executor == NULL)
1005 {
1006 /* We don't throw an error, the program is still debuggable. */
1007 maybe_print_unsupported_script_warning (pspace_info, objfile, language,
1008 section_name, offset);
1009 maybe_add_script_text (pspace_info, 0, name, language);
1010 return;
1011 }
1012
1013 /* Skip this script if auto-loading it has been disabled. */
1014 if (!ext_lang_auto_load_enabled (language))
1015 {
1016 /* No message is printed, just skip it. */
1017 return;
1018 }
1019
1020 is_safe = file_is_auto_load_safe (objfile_name (objfile),
1021 _("auto-load: Loading %s script "
1022 "\"%s\" from section \"%s\" of "
1023 "objfile \"%s\".\n"),
1024 ext_lang_name (language), name,
1025 section_name, objfile_name (objfile));
1026
1027 in_hash_table = maybe_add_script_text (pspace_info, is_safe, name, language);
1028
1029 /* If this file is not currently loaded, load it. */
1030 if (is_safe && !in_hash_table)
1031 executor (language, objfile, name, script_text);
1032 }
1033
1034 /* Load scripts specified in OBJFILE.
1035 START,END delimit a buffer containing a list of nul-terminated
1036 file names.
1037 SECTION_NAME is used in error messages.
1038
1039 Scripts specified as file names are found per normal "source -s" command
1040 processing. First the script is looked for in $cwd. If not found there
1041 the source search path is used.
1042
1043 The section contains a list of path names of script files to load or
1044 actual script contents. Each entry is nul-terminated. */
1045
1046 static void
1047 source_section_scripts (struct objfile *objfile, const char *section_name,
1048 const char *start, const char *end)
1049 {
1050 const char *p;
1051 struct auto_load_pspace_info *pspace_info;
1052
1053 pspace_info = get_auto_load_pspace_data_for_loading (current_program_space);
1054
1055 for (p = start; p < end; ++p)
1056 {
1057 const char *entry;
1058 const struct extension_language_defn *language;
1059 unsigned int offset = p - start;
1060 int code = *p;
1061
1062 switch (code)
1063 {
1064 case SECTION_SCRIPT_ID_PYTHON_FILE:
1065 case SECTION_SCRIPT_ID_PYTHON_TEXT:
1066 language = get_ext_lang_defn (EXT_LANG_PYTHON);
1067 break;
1068 case SECTION_SCRIPT_ID_SCHEME_FILE:
1069 case SECTION_SCRIPT_ID_SCHEME_TEXT:
1070 language = get_ext_lang_defn (EXT_LANG_GUILE);
1071 break;
1072 default:
1073 warning (_("Invalid entry in %s section"), section_name);
1074 /* We could try various heuristics to find the next valid entry,
1075 but it's safer to just punt. */
1076 return;
1077 }
1078 entry = ++p;
1079
1080 while (p < end && *p != '\0')
1081 ++p;
1082 if (p == end)
1083 {
1084 warning (_("Non-nul-terminated entry in %s at offset %u"),
1085 section_name, offset);
1086 /* Don't load/execute it. */
1087 break;
1088 }
1089
1090 switch (code)
1091 {
1092 case SECTION_SCRIPT_ID_PYTHON_FILE:
1093 case SECTION_SCRIPT_ID_SCHEME_FILE:
1094 if (p == entry)
1095 {
1096 warning (_("Empty entry in %s at offset %u"),
1097 section_name, offset);
1098 continue;
1099 }
1100 source_script_file (pspace_info, objfile, language,
1101 section_name, offset, entry);
1102 break;
1103 case SECTION_SCRIPT_ID_PYTHON_TEXT:
1104 case SECTION_SCRIPT_ID_SCHEME_TEXT:
1105 execute_script_contents (pspace_info, objfile, language,
1106 section_name, offset, entry);
1107 break;
1108 }
1109 }
1110 }
1111
1112 /* Load scripts specified in section SECTION_NAME of OBJFILE. */
1113
1114 static void
1115 auto_load_section_scripts (struct objfile *objfile, const char *section_name)
1116 {
1117 bfd *abfd = objfile->obfd;
1118 asection *scripts_sect;
1119 bfd_byte *data = NULL;
1120
1121 scripts_sect = bfd_get_section_by_name (abfd, section_name);
1122 if (scripts_sect == NULL
1123 || (bfd_section_flags (scripts_sect) & SEC_HAS_CONTENTS) == 0)
1124 return;
1125
1126 if (!bfd_get_full_section_contents (abfd, scripts_sect, &data))
1127 warning (_("Couldn't read %s section of %ps"),
1128 section_name,
1129 styled_string (file_name_style.style (),
1130 bfd_get_filename (abfd)));
1131 else
1132 {
1133 gdb::unique_xmalloc_ptr<bfd_byte> data_holder (data);
1134
1135 char *p = (char *) data;
1136 source_section_scripts (objfile, section_name, p,
1137 p + bfd_section_size (scripts_sect));
1138 }
1139 }
1140
1141 /* Load any auto-loaded scripts for OBJFILE. */
1142
1143 void
1144 load_auto_scripts_for_objfile (struct objfile *objfile)
1145 {
1146 /* Return immediately if auto-loading has been globally disabled.
1147 This is to handle sequencing of operations during gdb startup.
1148 Also return immediately if OBJFILE was not created from a file
1149 on the local filesystem. */
1150 if (!global_auto_load
1151 || (objfile->flags & OBJF_NOT_FILENAME) != 0
1152 || is_target_filename (objfile->original_name))
1153 return;
1154
1155 /* Load any extension language scripts for this objfile.
1156 E.g., foo-gdb.gdb, foo-gdb.py. */
1157 auto_load_ext_lang_scripts_for_objfile (objfile);
1158
1159 /* Load any scripts mentioned in AUTO_SECTION_NAME (.debug_gdb_scripts). */
1160 auto_load_section_scripts (objfile, AUTO_SECTION_NAME);
1161 }
1162
1163 /* This is a new_objfile observer callback to auto-load scripts.
1164
1165 Two flavors of auto-loaded scripts are supported.
1166 1) based on the path to the objfile
1167 2) from .debug_gdb_scripts section */
1168
1169 static void
1170 auto_load_new_objfile (struct objfile *objfile)
1171 {
1172 if (!objfile)
1173 {
1174 /* OBJFILE is NULL when loading a new "main" symbol-file. */
1175 clear_section_scripts ();
1176 return;
1177 }
1178
1179 load_auto_scripts_for_objfile (objfile);
1180 }
1181
1182 /* Collect scripts to be printed in a vec. */
1183
1184 struct collect_matching_scripts_data
1185 {
1186 collect_matching_scripts_data (std::vector<loaded_script *> *scripts_p_,
1187 const extension_language_defn *language_)
1188 : scripts_p (scripts_p_), language (language_)
1189 {}
1190
1191 std::vector<loaded_script *> *scripts_p;
1192 const struct extension_language_defn *language;
1193 };
1194
1195 /* Traversal function for htab_traverse.
1196 Collect the entry if it matches the regexp. */
1197
1198 static int
1199 collect_matching_scripts (void **slot, void *info)
1200 {
1201 struct loaded_script *script = (struct loaded_script *) *slot;
1202 struct collect_matching_scripts_data *data
1203 = (struct collect_matching_scripts_data *) info;
1204
1205 if (script->language == data->language && re_exec (script->name))
1206 data->scripts_p->push_back (script);
1207
1208 return 1;
1209 }
1210
1211 /* Print SCRIPT. */
1212
1213 static void
1214 print_script (struct loaded_script *script)
1215 {
1216 struct ui_out *uiout = current_uiout;
1217
1218 ui_out_emit_tuple tuple_emitter (uiout, NULL);
1219
1220 uiout->field_string ("loaded", script->loaded ? "Yes" : "No");
1221 uiout->field_string ("script", script->name);
1222 uiout->text ("\n");
1223
1224 /* If the name isn't the full path, print it too. */
1225 if (script->full_path != NULL
1226 && strcmp (script->name, script->full_path) != 0)
1227 {
1228 uiout->text ("\tfull name: ");
1229 uiout->field_string ("full_path", script->full_path);
1230 uiout->text ("\n");
1231 }
1232 }
1233
1234 /* Helper for info_auto_load_scripts to sort the scripts by name. */
1235
1236 static bool
1237 sort_scripts_by_name (loaded_script *a, loaded_script *b)
1238 {
1239 return FILENAME_CMP (a->name, b->name) < 0;
1240 }
1241
1242 /* Special internal GDB value of auto_load_info_scripts's PATTERN identify
1243 the "info auto-load XXX" command has been executed through the general
1244 "info auto-load" invocation. Extra newline will be printed if needed. */
1245 char auto_load_info_scripts_pattern_nl[] = "";
1246
1247 /* Subroutine of auto_load_info_scripts to simplify it.
1248 Print SCRIPTS. */
1249
1250 static void
1251 print_scripts (const std::vector<loaded_script *> &scripts)
1252 {
1253 for (loaded_script *script : scripts)
1254 print_script (script);
1255 }
1256
1257 /* Implementation for "info auto-load gdb-scripts"
1258 (and "info auto-load python-scripts"). List scripts in LANGUAGE matching
1259 PATTERN. FROM_TTY is the usual GDB boolean for user interactivity. */
1260
1261 void
1262 auto_load_info_scripts (const char *pattern, int from_tty,
1263 const struct extension_language_defn *language)
1264 {
1265 struct ui_out *uiout = current_uiout;
1266 struct auto_load_pspace_info *pspace_info;
1267
1268 dont_repeat ();
1269
1270 pspace_info = get_auto_load_pspace_data (current_program_space);
1271
1272 if (pattern && *pattern)
1273 {
1274 char *re_err = re_comp (pattern);
1275
1276 if (re_err)
1277 error (_("Invalid regexp: %s"), re_err);
1278 }
1279 else
1280 {
1281 re_comp ("");
1282 }
1283
1284 /* We need to know the number of rows before we build the table.
1285 Plus we want to sort the scripts by name.
1286 So first traverse the hash table collecting the matching scripts. */
1287
1288 std::vector<loaded_script *> script_files, script_texts;
1289
1290 if (pspace_info != NULL && pspace_info->loaded_script_files != NULL)
1291 {
1292 collect_matching_scripts_data data (&script_files, language);
1293
1294 /* Pass a pointer to scripts as VEC_safe_push can realloc space. */
1295 htab_traverse_noresize (pspace_info->loaded_script_files,
1296 collect_matching_scripts, &data);
1297
1298 std::sort (script_files.begin (), script_files.end (),
1299 sort_scripts_by_name);
1300 }
1301
1302 if (pspace_info != NULL && pspace_info->loaded_script_texts != NULL)
1303 {
1304 collect_matching_scripts_data data (&script_texts, language);
1305
1306 /* Pass a pointer to scripts as VEC_safe_push can realloc space. */
1307 htab_traverse_noresize (pspace_info->loaded_script_texts,
1308 collect_matching_scripts, &data);
1309
1310 std::sort (script_texts.begin (), script_texts.end (),
1311 sort_scripts_by_name);
1312 }
1313
1314 int nr_scripts = script_files.size () + script_texts.size ();
1315
1316 /* Table header shifted right by preceding "gdb-scripts: " would not match
1317 its columns. */
1318 if (nr_scripts > 0 && pattern == auto_load_info_scripts_pattern_nl)
1319 uiout->text ("\n");
1320
1321 {
1322 ui_out_emit_table table_emitter (uiout, 2, nr_scripts,
1323 "AutoLoadedScriptsTable");
1324
1325 uiout->table_header (7, ui_left, "loaded", "Loaded");
1326 uiout->table_header (70, ui_left, "script", "Script");
1327 uiout->table_body ();
1328
1329 print_scripts (script_files);
1330 print_scripts (script_texts);
1331 }
1332
1333 if (nr_scripts == 0)
1334 {
1335 if (pattern && *pattern)
1336 uiout->message ("No auto-load scripts matching %s.\n", pattern);
1337 else
1338 uiout->message ("No auto-load scripts.\n");
1339 }
1340 }
1341
1342 /* Wrapper for "info auto-load gdb-scripts". */
1343
1344 static void
1345 info_auto_load_gdb_scripts (const char *pattern, int from_tty)
1346 {
1347 auto_load_info_scripts (pattern, from_tty, &extension_language_gdb);
1348 }
1349
1350 /* Implement 'info auto-load local-gdbinit'. */
1351
1352 static void
1353 info_auto_load_local_gdbinit (const char *args, int from_tty)
1354 {
1355 if (auto_load_local_gdbinit_pathname == NULL)
1356 printf_filtered (_("Local .gdbinit file was not found.\n"));
1357 else if (auto_load_local_gdbinit_loaded)
1358 printf_filtered (_("Local .gdbinit file \"%ps\" has been loaded.\n"),
1359 styled_string (file_name_style.style (),
1360 auto_load_local_gdbinit_pathname));
1361 else
1362 printf_filtered (_("Local .gdbinit file \"%ps\" has not been loaded.\n"),
1363 styled_string (file_name_style.style (),
1364 auto_load_local_gdbinit_pathname));
1365 }
1366
1367 /* Print an "unsupported script" warning if it has not already been printed.
1368 The script is in language LANGUAGE at offset OFFSET in section SECTION_NAME
1369 of OBJFILE. */
1370
1371 static void
1372 maybe_print_unsupported_script_warning
1373 (struct auto_load_pspace_info *pspace_info,
1374 struct objfile *objfile, const struct extension_language_defn *language,
1375 const char *section_name, unsigned offset)
1376 {
1377 if (!pspace_info->unsupported_script_warning_printed)
1378 {
1379 warning (_("\
1380 Unsupported auto-load script at offset %u in section %s\n\
1381 of file %ps.\n\
1382 Use `info auto-load %s-scripts [REGEXP]' to list them."),
1383 offset, section_name,
1384 styled_string (file_name_style.style (),
1385 objfile_name (objfile)),
1386 ext_lang_name (language));
1387 pspace_info->unsupported_script_warning_printed = true;
1388 }
1389 }
1390
1391 /* Return non-zero if SCRIPT_NOT_FOUND_WARNING_PRINTED of PSPACE_INFO was unset
1392 before calling this function. Always set SCRIPT_NOT_FOUND_WARNING_PRINTED
1393 of PSPACE_INFO. */
1394
1395 static void
1396 maybe_print_script_not_found_warning
1397 (struct auto_load_pspace_info *pspace_info,
1398 struct objfile *objfile, const struct extension_language_defn *language,
1399 const char *section_name, unsigned offset)
1400 {
1401 if (!pspace_info->script_not_found_warning_printed)
1402 {
1403 warning (_("\
1404 Missing auto-load script at offset %u in section %s\n\
1405 of file %ps.\n\
1406 Use `info auto-load %s-scripts [REGEXP]' to list them."),
1407 offset, section_name,
1408 styled_string (file_name_style.style (),
1409 objfile_name (objfile)),
1410 ext_lang_name (language));
1411 pspace_info->script_not_found_warning_printed = true;
1412 }
1413 }
1414
1415 /* The only valid "set auto-load" argument is off|0|no|disable. */
1416
1417 static void
1418 set_auto_load_cmd (const char *args, int from_tty)
1419 {
1420 struct cmd_list_element *list;
1421 size_t length;
1422
1423 /* See parse_binary_operation in use by the sub-commands. */
1424
1425 length = args ? strlen (args) : 0;
1426
1427 while (length > 0 && (args[length - 1] == ' ' || args[length - 1] == '\t'))
1428 length--;
1429
1430 if (length == 0 || (strncmp (args, "off", length) != 0
1431 && strncmp (args, "0", length) != 0
1432 && strncmp (args, "no", length) != 0
1433 && strncmp (args, "disable", length) != 0))
1434 error (_("Valid is only global 'set auto-load no'; "
1435 "otherwise check the auto-load sub-commands."));
1436
1437 for (list = *auto_load_set_cmdlist_get (); list != NULL; list = list->next)
1438 if (list->var_type == var_boolean)
1439 {
1440 gdb_assert (list->type == set_cmd);
1441 do_set_command (args, from_tty, list);
1442 }
1443 }
1444
1445 /* Initialize "set auto-load " commands prefix and return it. */
1446
1447 struct cmd_list_element **
1448 auto_load_set_cmdlist_get (void)
1449 {
1450 static struct cmd_list_element *retval;
1451
1452 if (retval == NULL)
1453 add_prefix_cmd ("auto-load", class_maintenance, set_auto_load_cmd, _("\
1454 Auto-loading specific settings.\n\
1455 Configure various auto-load-specific variables such as\n\
1456 automatic loading of Python scripts."),
1457 &retval, "set auto-load ",
1458 1/*allow-unknown*/, &setlist);
1459
1460 return &retval;
1461 }
1462
1463 /* Initialize "show auto-load " commands prefix and return it. */
1464
1465 struct cmd_list_element **
1466 auto_load_show_cmdlist_get (void)
1467 {
1468 static struct cmd_list_element *retval;
1469
1470 if (retval == NULL)
1471 add_show_prefix_cmd ("auto-load", class_maintenance, _("\
1472 Show auto-loading specific settings.\n\
1473 Show configuration of various auto-load-specific variables such as\n\
1474 automatic loading of Python scripts."),
1475 &retval, "show auto-load ",
1476 0/*allow-unknown*/, &showlist);
1477
1478 return &retval;
1479 }
1480
1481 /* Command "info auto-load" displays whether the various auto-load files have
1482 been loaded. This is reimplementation of cmd_show_list which inserts
1483 newlines at proper places. */
1484
1485 static void
1486 info_auto_load_cmd (const char *args, int from_tty)
1487 {
1488 struct cmd_list_element *list;
1489 struct ui_out *uiout = current_uiout;
1490
1491 ui_out_emit_tuple tuple_emitter (uiout, "infolist");
1492
1493 for (list = *auto_load_info_cmdlist_get (); list != NULL; list = list->next)
1494 {
1495 ui_out_emit_tuple option_emitter (uiout, "option");
1496
1497 gdb_assert (!list->prefixlist);
1498 gdb_assert (list->type == not_set_cmd);
1499
1500 uiout->field_string ("name", list->name);
1501 uiout->text (": ");
1502 cmd_func (list, auto_load_info_scripts_pattern_nl, from_tty);
1503 }
1504 }
1505
1506 /* Initialize "info auto-load " commands prefix and return it. */
1507
1508 struct cmd_list_element **
1509 auto_load_info_cmdlist_get (void)
1510 {
1511 static struct cmd_list_element *retval;
1512
1513 if (retval == NULL)
1514 add_prefix_cmd ("auto-load", class_info, info_auto_load_cmd, _("\
1515 Print current status of auto-loaded files.\n\
1516 Print whether various files like Python scripts or .gdbinit files have been\n\
1517 found and/or loaded."),
1518 &retval, "info auto-load ",
1519 0/*allow-unknown*/, &infolist);
1520
1521 return &retval;
1522 }
1523
1524 void _initialize_auto_load ();
1525 void
1526 _initialize_auto_load ()
1527 {
1528 struct cmd_list_element *cmd;
1529 char *scripts_directory_help, *gdb_name_help, *python_name_help;
1530 char *guile_name_help;
1531 const char *suffix;
1532
1533 gdb::observers::new_objfile.attach (auto_load_new_objfile);
1534
1535 add_setshow_boolean_cmd ("gdb-scripts", class_support,
1536 &auto_load_gdb_scripts, _("\
1537 Enable or disable auto-loading of canned sequences of commands scripts."), _("\
1538 Show whether auto-loading of canned sequences of commands scripts is enabled."),
1539 _("\
1540 If enabled, canned sequences of commands are loaded when the debugger reads\n\
1541 an executable or shared library.\n\
1542 This option has security implications for untrusted inferiors."),
1543 NULL, show_auto_load_gdb_scripts,
1544 auto_load_set_cmdlist_get (),
1545 auto_load_show_cmdlist_get ());
1546
1547 add_cmd ("gdb-scripts", class_info, info_auto_load_gdb_scripts,
1548 _("Print the list of automatically loaded sequences of commands.\n\
1549 Usage: info auto-load gdb-scripts [REGEXP]"),
1550 auto_load_info_cmdlist_get ());
1551
1552 add_setshow_boolean_cmd ("local-gdbinit", class_support,
1553 &auto_load_local_gdbinit, _("\
1554 Enable or disable auto-loading of .gdbinit script in current directory."), _("\
1555 Show whether auto-loading .gdbinit script in current directory is enabled."),
1556 _("\
1557 If enabled, canned sequences of commands are loaded when debugger starts\n\
1558 from .gdbinit file in current directory. Such files are deprecated,\n\
1559 use a script associated with inferior executable file instead.\n\
1560 This option has security implications for untrusted inferiors."),
1561 NULL, show_auto_load_local_gdbinit,
1562 auto_load_set_cmdlist_get (),
1563 auto_load_show_cmdlist_get ());
1564
1565 add_cmd ("local-gdbinit", class_info, info_auto_load_local_gdbinit,
1566 _("Print whether current directory .gdbinit file has been loaded.\n\
1567 Usage: info auto-load local-gdbinit"),
1568 auto_load_info_cmdlist_get ());
1569
1570 auto_load_dir = xstrdup (AUTO_LOAD_DIR);
1571
1572 suffix = ext_lang_auto_load_suffix (get_ext_lang_defn (EXT_LANG_GDB));
1573 gdb_name_help
1574 = xstrprintf (_("\
1575 GDB scripts: OBJFILE%s\n"),
1576 suffix);
1577 python_name_help = NULL;
1578 #ifdef HAVE_PYTHON
1579 suffix = ext_lang_auto_load_suffix (get_ext_lang_defn (EXT_LANG_PYTHON));
1580 python_name_help
1581 = xstrprintf (_("\
1582 Python scripts: OBJFILE%s\n"),
1583 suffix);
1584 #endif
1585 guile_name_help = NULL;
1586 #ifdef HAVE_GUILE
1587 suffix = ext_lang_auto_load_suffix (get_ext_lang_defn (EXT_LANG_GUILE));
1588 guile_name_help
1589 = xstrprintf (_("\
1590 Guile scripts: OBJFILE%s\n"),
1591 suffix);
1592 #endif
1593 scripts_directory_help
1594 = xstrprintf (_("\
1595 Automatically loaded scripts are located in one of the directories listed\n\
1596 by this option.\n\
1597 \n\
1598 Script names:\n\
1599 %s%s%s\
1600 \n\
1601 This option is ignored for the kinds of scripts \
1602 having 'set auto-load ... off'.\n\
1603 Directories listed here need to be present also \
1604 in the 'set auto-load safe-path'\n\
1605 option."),
1606 gdb_name_help,
1607 python_name_help ? python_name_help : "",
1608 guile_name_help ? guile_name_help : "");
1609
1610 add_setshow_optional_filename_cmd ("scripts-directory", class_support,
1611 &auto_load_dir, _("\
1612 Set the list of directories from which to load auto-loaded scripts."), _("\
1613 Show the list of directories from which to load auto-loaded scripts."),
1614 scripts_directory_help,
1615 set_auto_load_dir, show_auto_load_dir,
1616 auto_load_set_cmdlist_get (),
1617 auto_load_show_cmdlist_get ());
1618 xfree (scripts_directory_help);
1619 xfree (python_name_help);
1620 xfree (gdb_name_help);
1621 xfree (guile_name_help);
1622
1623 auto_load_safe_path = xstrdup (AUTO_LOAD_SAFE_PATH);
1624 auto_load_safe_path_vec_update ();
1625 add_setshow_optional_filename_cmd ("safe-path", class_support,
1626 &auto_load_safe_path, _("\
1627 Set the list of files and directories that are safe for auto-loading."), _("\
1628 Show the list of files and directories that are safe for auto-loading."), _("\
1629 Various files loaded automatically for the 'set auto-load ...' options must\n\
1630 be located in one of the directories listed by this option. Warning will be\n\
1631 printed and file will not be used otherwise.\n\
1632 You can mix both directory and filename entries.\n\
1633 Setting this parameter to an empty list resets it to its default value.\n\
1634 Setting this parameter to '/' (without the quotes) allows any file\n\
1635 for the 'set auto-load ...' options. Each path entry can be also shell\n\
1636 wildcard pattern; '*' does not match directory separator.\n\
1637 This option is ignored for the kinds of files having 'set auto-load ... off'.\n\
1638 This option has security implications for untrusted inferiors."),
1639 set_auto_load_safe_path,
1640 show_auto_load_safe_path,
1641 auto_load_set_cmdlist_get (),
1642 auto_load_show_cmdlist_get ());
1643 gdb::observers::gdb_datadir_changed.attach (auto_load_gdb_datadir_changed);
1644
1645 cmd = add_cmd ("add-auto-load-safe-path", class_support,
1646 add_auto_load_safe_path,
1647 _("Add entries to the list of directories from which it is safe "
1648 "to auto-load files.\n\
1649 See the commands 'set auto-load safe-path' and 'show auto-load safe-path' to\n\
1650 access the current full list setting."),
1651 &cmdlist);
1652 set_cmd_completer (cmd, filename_completer);
1653
1654 cmd = add_cmd ("add-auto-load-scripts-directory", class_support,
1655 add_auto_load_dir,
1656 _("Add entries to the list of directories from which to load "
1657 "auto-loaded scripts.\n\
1658 See the commands 'set auto-load scripts-directory' and\n\
1659 'show auto-load scripts-directory' to access the current full list setting."),
1660 &cmdlist);
1661 set_cmd_completer (cmd, filename_completer);
1662
1663 add_setshow_boolean_cmd ("auto-load", class_maintenance,
1664 &debug_auto_load, _("\
1665 Set auto-load verifications debugging."), _("\
1666 Show auto-load verifications debugging."), _("\
1667 When non-zero, debugging output for files of 'set auto-load ...'\n\
1668 is displayed."),
1669 NULL, show_debug_auto_load,
1670 &setdebuglist, &showdebuglist);
1671 }
This page took 0.07481 seconds and 4 git commands to generate.