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