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