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