forked from gbenson/binutils-gdb
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathauto-load.c
1752 lines (1443 loc) · 52.8 KB
/
auto-load.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* GDB routines for supporting auto-loaded scripts.
Copyright (C) 2012-2015 Free Software Foundation, Inc.
This file is part of GDB.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>. */
#include "defs.h"
#include <ctype.h>
#include "auto-load.h"
#include "progspace.h"
#include "gdb_regex.h"
#include "ui-out.h"
#include "filenames.h"
#include "command.h"
#include "observer.h"
#include "objfiles.h"
#include "cli/cli-script.h"
#include "gdbcmd.h"
#include "cli/cli-cmds.h"
#include "cli/cli-decode.h"
#include "cli/cli-setshow.h"
#include "gdb_vecs.h"
#include "readline/tilde.h"
#include "completer.h"
#include "fnmatch.h"
#include "top.h"
#include "filestuff.h"
#include "extension.h"
#include "gdb/section-scripts.h"
/* The section to look in for auto-loaded scripts (in file formats that
support sections).
Each entry in this section is a record that begins with a leading byte
identifying the record type.
At the moment we only support one record type: A leading byte of 1,
followed by the path of a python script to load. */
#define AUTO_SECTION_NAME ".debug_gdb_scripts"
static void maybe_print_unsupported_script_warning
(struct auto_load_pspace_info *, struct objfile *objfile,
const struct extension_language_defn *language,
const char *section_name, unsigned offset);
static void maybe_print_script_not_found_warning
(struct auto_load_pspace_info *, struct objfile *objfile,
const struct extension_language_defn *language,
const char *section_name, unsigned offset);
/* Value of the 'set debug auto-load' configuration variable. */
static int debug_auto_load = 0;
/* "show" command for the debug_auto_load configuration variable. */
static void
show_debug_auto_load (struct ui_file *file, int from_tty,
struct cmd_list_element *c, const char *value)
{
fprintf_filtered (file, _("Debugging output for files "
"of 'set auto-load ...' is %s.\n"),
value);
}
/* User-settable option to enable/disable auto-loading of GDB_AUTO_FILE_NAME
scripts:
set auto-load gdb-scripts on|off
This is true if we should auto-load associated scripts when an objfile
is opened, false otherwise. */
static int auto_load_gdb_scripts = 1;
/* "show" command for the auto_load_gdb_scripts configuration variable. */
static void
show_auto_load_gdb_scripts (struct ui_file *file, int from_tty,
struct cmd_list_element *c, const char *value)
{
fprintf_filtered (file, _("Auto-loading of canned sequences of commands "
"scripts is %s.\n"),
value);
}
/* Return non-zero if auto-loading gdb scripts is enabled. */
int
auto_load_gdb_scripts_enabled (const struct extension_language_defn *extlang)
{
return auto_load_gdb_scripts;
}
/* Internal-use flag to enable/disable auto-loading.
This is true if we should auto-load python code when an objfile is opened,
false otherwise.
Both auto_load_scripts && global_auto_load must be true to enable
auto-loading.
This flag exists to facilitate deferring auto-loading during start-up
until after ./.gdbinit has been read; it may augment the search directories
used to find the scripts. */
int global_auto_load = 1;
/* Auto-load .gdbinit file from the current directory? */
int auto_load_local_gdbinit = 1;
/* Absolute pathname to the current directory .gdbinit, if it exists. */
char *auto_load_local_gdbinit_pathname = NULL;
/* Boolean value if AUTO_LOAD_LOCAL_GDBINIT_PATHNAME has been loaded. */
int auto_load_local_gdbinit_loaded = 0;
/* "show" command for the auto_load_local_gdbinit configuration variable. */
static void
show_auto_load_local_gdbinit (struct ui_file *file, int from_tty,
struct cmd_list_element *c, const char *value)
{
fprintf_filtered (file, _("Auto-loading of .gdbinit script from current "
"directory is %s.\n"),
value);
}
/* Directory list from which to load auto-loaded scripts. It is not checked
for absolute paths but they are strongly recommended. It is initialized by
_initialize_auto_load. */
static char *auto_load_dir;
/* "set" command for the auto_load_dir configuration variable. */
static void
set_auto_load_dir (char *args, int from_tty, struct cmd_list_element *c)
{
/* Setting the variable to "" resets it to the compile time defaults. */
if (auto_load_dir[0] == '\0')
{
xfree (auto_load_dir);
auto_load_dir = xstrdup (AUTO_LOAD_DIR);
}
}
/* "show" command for the auto_load_dir configuration variable. */
static void
show_auto_load_dir (struct ui_file *file, int from_tty,
struct cmd_list_element *c, const char *value)
{
fprintf_filtered (file, _("List of directories from which to load "
"auto-loaded scripts is %s.\n"),
value);
}
/* Directory list safe to hold auto-loaded files. It is not checked for
absolute paths but they are strongly recommended. It is initialized by
_initialize_auto_load. */
static char *auto_load_safe_path;
/* Vector of directory elements of AUTO_LOAD_SAFE_PATH with each one normalized
by tilde_expand and possibly each entries has added its gdb_realpath
counterpart. */
static VEC (char_ptr) *auto_load_safe_path_vec;
/* Expand $datadir and $debugdir in STRING according to the rules of
substitute_path_component. Return vector from dirnames_to_char_ptr_vec,
this vector must be freed by free_char_ptr_vec by the caller. */
static VEC (char_ptr) *
auto_load_expand_dir_vars (const char *string)
{
VEC (char_ptr) *dir_vec;
char *s;
s = xstrdup (string);
substitute_path_component (&s, "$datadir", gdb_datadir);
substitute_path_component (&s, "$debugdir", debug_file_directory);
if (debug_auto_load && strcmp (s, string) != 0)
fprintf_unfiltered (gdb_stdlog,
_("auto-load: Expanded $-variables to \"%s\".\n"), s);
dir_vec = dirnames_to_char_ptr_vec (s);
xfree(s);
return dir_vec;
}
/* Update auto_load_safe_path_vec from current AUTO_LOAD_SAFE_PATH. */
static void
auto_load_safe_path_vec_update (void)
{
unsigned len;
int ix;
if (debug_auto_load)
fprintf_unfiltered (gdb_stdlog,
_("auto-load: Updating directories of \"%s\".\n"),
auto_load_safe_path);
free_char_ptr_vec (auto_load_safe_path_vec);
auto_load_safe_path_vec = auto_load_expand_dir_vars (auto_load_safe_path);
len = VEC_length (char_ptr, auto_load_safe_path_vec);
/* Apply tilde_expand and gdb_realpath to each AUTO_LOAD_SAFE_PATH_VEC
element. */
for (ix = 0; ix < len; ix++)
{
char *dir = VEC_index (char_ptr, auto_load_safe_path_vec, ix);
char *expanded = tilde_expand (dir);
char *real_path = gdb_realpath (expanded);
/* Ensure the current entry is at least tilde_expand-ed. */
VEC_replace (char_ptr, auto_load_safe_path_vec, ix, expanded);
if (debug_auto_load)
{
if (strcmp (expanded, dir) == 0)
fprintf_unfiltered (gdb_stdlog,
_("auto-load: Using directory \"%s\".\n"),
expanded);
else
fprintf_unfiltered (gdb_stdlog,
_("auto-load: Resolved directory \"%s\" "
"as \"%s\".\n"),
dir, expanded);
}
xfree (dir);
/* If gdb_realpath returns a different content, append it. */
if (strcmp (real_path, expanded) == 0)
xfree (real_path);
else
{
VEC_safe_push (char_ptr, auto_load_safe_path_vec, real_path);
if (debug_auto_load)
fprintf_unfiltered (gdb_stdlog,
_("auto-load: And canonicalized as \"%s\".\n"),
real_path);
}
}
}
/* Variable gdb_datadir has been set. Update content depending on $datadir. */
static void
auto_load_gdb_datadir_changed (void)
{
auto_load_safe_path_vec_update ();
}
/* "set" command for the auto_load_safe_path configuration variable. */
static void
set_auto_load_safe_path (char *args, int from_tty, struct cmd_list_element *c)
{
/* Setting the variable to "" resets it to the compile time defaults. */
if (auto_load_safe_path[0] == '\0')
{
xfree (auto_load_safe_path);
auto_load_safe_path = xstrdup (AUTO_LOAD_SAFE_PATH);
}
auto_load_safe_path_vec_update ();
}
/* "show" command for the auto_load_safe_path configuration variable. */
static void
show_auto_load_safe_path (struct ui_file *file, int from_tty,
struct cmd_list_element *c, const char *value)
{
const char *cs;
/* Check if user has entered either "/" or for example ":".
But while more complicate content like ":/foo" would still also
permit any location do not hide those. */
for (cs = value; *cs && (*cs == DIRNAME_SEPARATOR || IS_DIR_SEPARATOR (*cs));
cs++);
if (*cs == 0)
fprintf_filtered (file, _("Auto-load files are safe to load from any "
"directory.\n"));
else
fprintf_filtered (file, _("List of directories from which it is safe to "
"auto-load files is %s.\n"),
value);
}
/* "add-auto-load-safe-path" command for the auto_load_safe_path configuration
variable. */
static void
add_auto_load_safe_path (char *args, int from_tty)
{
char *s;
if (args == NULL || *args == 0)
error (_("\
Directory argument required.\n\
Use 'set auto-load safe-path /' for disabling the auto-load safe-path security.\
"));
s = xstrprintf ("%s%c%s", auto_load_safe_path, DIRNAME_SEPARATOR, args);
xfree (auto_load_safe_path);
auto_load_safe_path = s;
auto_load_safe_path_vec_update ();
}
/* "add-auto-load-scripts-directory" command for the auto_load_dir configuration
variable. */
static void
add_auto_load_dir (char *args, int from_tty)
{
char *s;
if (args == NULL || *args == 0)
error (_("Directory argument required."));
s = xstrprintf ("%s%c%s", auto_load_dir, DIRNAME_SEPARATOR, args);
xfree (auto_load_dir);
auto_load_dir = s;
}
/* Implementation for filename_is_in_pattern overwriting the caller's FILENAME
and PATTERN. */
static int
filename_is_in_pattern_1 (char *filename, char *pattern)
{
size_t pattern_len = strlen (pattern);
size_t filename_len = strlen (filename);
if (debug_auto_load)
fprintf_unfiltered (gdb_stdlog, _("auto-load: Matching file \"%s\" "
"to pattern \"%s\"\n"),
filename, pattern);
/* Trim trailing slashes ("/") from PATTERN. Even for "d:\" paths as
trailing slashes are trimmed also from FILENAME it still matches
correctly. */
while (pattern_len && IS_DIR_SEPARATOR (pattern[pattern_len - 1]))
pattern_len--;
pattern[pattern_len] = '\0';
/* Ensure auto_load_safe_path "/" matches any FILENAME. On MS-Windows
platform FILENAME even after gdb_realpath does not have to start with
IS_DIR_SEPARATOR character, such as the 'C:\x.exe' filename. */
if (pattern_len == 0)
{
if (debug_auto_load)
fprintf_unfiltered (gdb_stdlog,
_("auto-load: Matched - empty pattern\n"));
return 1;
}
for (;;)
{
/* Trim trailing slashes ("/"). PATTERN also has slashes trimmed the
same way so they will match. */
while (filename_len && IS_DIR_SEPARATOR (filename[filename_len - 1]))
filename_len--;
filename[filename_len] = '\0';
if (filename_len == 0)
{
if (debug_auto_load)
fprintf_unfiltered (gdb_stdlog,
_("auto-load: Not matched - pattern \"%s\".\n"),
pattern);
return 0;
}
if (gdb_filename_fnmatch (pattern, filename, FNM_FILE_NAME | FNM_NOESCAPE)
== 0)
{
if (debug_auto_load)
fprintf_unfiltered (gdb_stdlog, _("auto-load: Matched - file "
"\"%s\" to pattern \"%s\".\n"),
filename, pattern);
return 1;
}
/* Trim trailing FILENAME component. */
while (filename_len > 0 && !IS_DIR_SEPARATOR (filename[filename_len - 1]))
filename_len--;
}
}
/* Return 1 if FILENAME matches PATTERN or if FILENAME resides in
a subdirectory of a directory that matches PATTERN. Return 0 otherwise.
gdb_realpath normalization is never done here. */
static ATTRIBUTE_PURE int
filename_is_in_pattern (const char *filename, const char *pattern)
{
char *filename_copy, *pattern_copy;
filename_copy = alloca (strlen (filename) + 1);
strcpy (filename_copy, filename);
pattern_copy = alloca (strlen (pattern) + 1);
strcpy (pattern_copy, pattern);
return filename_is_in_pattern_1 (filename_copy, pattern_copy);
}
/* Return 1 if FILENAME belongs to one of directory components of
AUTO_LOAD_SAFE_PATH_VEC. Return 0 otherwise.
auto_load_safe_path_vec_update is never called.
*FILENAME_REALP may be updated by gdb_realpath of FILENAME - it has to be
freed by the caller. */
static int
filename_is_in_auto_load_safe_path_vec (const char *filename,
char **filename_realp)
{
char *pattern;
int ix;
for (ix = 0; VEC_iterate (char_ptr, auto_load_safe_path_vec, ix, pattern);
++ix)
if (*filename_realp == NULL && filename_is_in_pattern (filename, pattern))
break;
if (pattern == NULL)
{
if (*filename_realp == NULL)
{
*filename_realp = gdb_realpath (filename);
if (debug_auto_load && strcmp (*filename_realp, filename) != 0)
fprintf_unfiltered (gdb_stdlog,
_("auto-load: Resolved "
"file \"%s\" as \"%s\".\n"),
filename, *filename_realp);
}
if (strcmp (*filename_realp, filename) != 0)
for (ix = 0;
VEC_iterate (char_ptr, auto_load_safe_path_vec, ix, pattern); ++ix)
if (filename_is_in_pattern (*filename_realp, pattern))
break;
}
if (pattern != NULL)
{
if (debug_auto_load)
fprintf_unfiltered (gdb_stdlog, _("auto-load: File \"%s\" matches "
"directory \"%s\".\n"),
filename, pattern);
return 1;
}
return 0;
}
/* Return 1 if FILENAME is located in one of the directories of
AUTO_LOAD_SAFE_PATH. Otherwise call warning and return 0. FILENAME does
not have to be an absolute path.
Existence of FILENAME is not checked. Function will still give a warning
even if the caller would quietly skip non-existing file in unsafe
directory. */
int
file_is_auto_load_safe (const char *filename, const char *debug_fmt, ...)
{
char *filename_real = NULL;
struct cleanup *back_to;
static int advice_printed = 0;
if (debug_auto_load)
{
va_list debug_args;
va_start (debug_args, debug_fmt);
vfprintf_unfiltered (gdb_stdlog, debug_fmt, debug_args);
va_end (debug_args);
}
back_to = make_cleanup (free_current_contents, &filename_real);
if (filename_is_in_auto_load_safe_path_vec (filename, &filename_real))
{
do_cleanups (back_to);
return 1;
}
auto_load_safe_path_vec_update ();
if (filename_is_in_auto_load_safe_path_vec (filename, &filename_real))
{
do_cleanups (back_to);
return 1;
}
warning (_("File \"%s\" auto-loading has been declined by your "
"`auto-load safe-path' set to \"%s\"."),
filename_real, auto_load_safe_path);
if (!advice_printed)
{
const char *homedir = getenv ("HOME");
char *homeinit;
if (homedir == NULL)
homedir = "$HOME";
homeinit = xstrprintf ("%s/%s", homedir, gdbinit);
make_cleanup (xfree, homeinit);
printf_filtered (_("\
To enable execution of this file add\n\
\tadd-auto-load-safe-path %s\n\
line to your configuration file \"%s\".\n\
To completely disable this security protection add\n\
\tset auto-load safe-path /\n\
line to your configuration file \"%s\".\n\
For more information about this security protection see the\n\
\"Auto-loading safe path\" section in the GDB manual. E.g., run from the shell:\n\
\tinfo \"(gdb)Auto-loading safe path\"\n"),
filename_real, homeinit, homeinit);
advice_printed = 1;
}
do_cleanups (back_to);
return 0;
}
/* For scripts specified in .debug_gdb_scripts, multiple objfiles may load
the same script. There's no point in loading the script multiple times,
and there can be a lot of objfiles and scripts, so we keep track of scripts
loaded this way. */
struct auto_load_pspace_info
{
/* For each program space we keep track of loaded scripts, both when
specified as file names and as scripts to be executed directly. */
struct htab *loaded_script_files;
struct htab *loaded_script_texts;
/* Non-zero if we've issued the warning about an auto-load script not being
supported. We only want to issue this warning once. */
int unsupported_script_warning_printed;
/* Non-zero if we've issued the warning about an auto-load script not being
found. We only want to issue this warning once. */
int script_not_found_warning_printed;
};
/* Objects of this type are stored in the loaded_script hash table. */
struct loaded_script
{
/* Name as provided by the objfile. */
const char *name;
/* Full path name or NULL if script wasn't found (or was otherwise
inaccessible), or NULL for loaded_script_texts. */
const char *full_path;
/* Non-zero if this script has been loaded. */
int loaded;
const struct extension_language_defn *language;
};
/* Per-program-space data key. */
static const struct program_space_data *auto_load_pspace_data;
static void
auto_load_pspace_data_cleanup (struct program_space *pspace, void *arg)
{
struct auto_load_pspace_info *info = arg;
if (info->loaded_script_files)
htab_delete (info->loaded_script_files);
if (info->loaded_script_texts)
htab_delete (info->loaded_script_texts);
xfree (info);
}
/* Get the current autoload data. If none is found yet, add it now. This
function always returns a valid object. */
static struct auto_load_pspace_info *
get_auto_load_pspace_data (struct program_space *pspace)
{
struct auto_load_pspace_info *info;
info = program_space_data (pspace, auto_load_pspace_data);
if (info == NULL)
{
info = XCNEW (struct auto_load_pspace_info);
set_program_space_data (pspace, auto_load_pspace_data, info);
}
return info;
}
/* Hash function for the loaded script hash. */
static hashval_t
hash_loaded_script_entry (const void *data)
{
const struct loaded_script *e = data;
return htab_hash_string (e->name) ^ htab_hash_pointer (e->language);
}
/* Equality function for the loaded script hash. */
static int
eq_loaded_script_entry (const void *a, const void *b)
{
const struct loaded_script *ea = a;
const struct loaded_script *eb = b;
return strcmp (ea->name, eb->name) == 0 && ea->language == eb->language;
}
/* Initialize the table to track loaded scripts.
Each entry is hashed by the full path name. */
static void
init_loaded_scripts_info (struct auto_load_pspace_info *pspace_info)
{
/* Choose 31 as the starting size of the hash table, somewhat arbitrarily.
Space for each entry is obtained with one malloc so we can free them
easily. */
pspace_info->loaded_script_files = htab_create (31,
hash_loaded_script_entry,
eq_loaded_script_entry,
xfree);
pspace_info->loaded_script_texts = htab_create (31,
hash_loaded_script_entry,
eq_loaded_script_entry,
xfree);
pspace_info->unsupported_script_warning_printed = FALSE;
pspace_info->script_not_found_warning_printed = FALSE;
}
/* Wrapper on get_auto_load_pspace_data to also allocate the hash table
for loading scripts. */
struct auto_load_pspace_info *
get_auto_load_pspace_data_for_loading (struct program_space *pspace)
{
struct auto_load_pspace_info *info;
info = get_auto_load_pspace_data (pspace);
if (info->loaded_script_files == NULL)
init_loaded_scripts_info (info);
return info;
}
/* Add script file NAME in LANGUAGE to hash table of PSPACE_INFO.
LOADED 1 if the script has been (is going to) be loaded, 0 otherwise
(such as if it has not been found).
FULL_PATH is NULL if the script wasn't found.
The result is true if the script was already in the hash table. */
static int
maybe_add_script_file (struct auto_load_pspace_info *pspace_info, int loaded,
const char *name, const char *full_path,
const struct extension_language_defn *language)
{
struct htab *htab = pspace_info->loaded_script_files;
struct loaded_script **slot, entry;
int in_hash_table;
entry.name = name;
entry.language = language;
slot = (struct loaded_script **) htab_find_slot (htab, &entry, INSERT);
in_hash_table = *slot != NULL;
/* If this script is not in the hash table, add it. */
if (!in_hash_table)
{
char *p;
/* Allocate all space in one chunk so it's easier to free. */
*slot = xmalloc (sizeof (**slot)
+ strlen (name) + 1
+ (full_path != NULL ? (strlen (full_path) + 1) : 0));
p = ((char*) *slot) + sizeof (**slot);
strcpy (p, name);
(*slot)->name = p;
if (full_path != NULL)
{
p += strlen (p) + 1;
strcpy (p, full_path);
(*slot)->full_path = p;
}
else
(*slot)->full_path = NULL;
(*slot)->loaded = loaded;
(*slot)->language = language;
}
return in_hash_table;
}
/* Add script contents NAME in LANGUAGE to hash table of PSPACE_INFO.
LOADED 1 if the script has been (is going to) be loaded, 0 otherwise
(such as if it has not been found).
The result is true if the script was already in the hash table. */
static int
maybe_add_script_text (struct auto_load_pspace_info *pspace_info,
int loaded, const char *name,
const struct extension_language_defn *language)
{
struct htab *htab = pspace_info->loaded_script_texts;
struct loaded_script **slot, entry;
int in_hash_table;
entry.name = name;
entry.language = language;
slot = (struct loaded_script **) htab_find_slot (htab, &entry, INSERT);
in_hash_table = *slot != NULL;
/* If this script is not in the hash table, add it. */
if (!in_hash_table)
{
char *p;
/* Allocate all space in one chunk so it's easier to free. */
*slot = xmalloc (sizeof (**slot) + strlen (name) + 1);
p = ((char*) *slot) + sizeof (**slot);
strcpy (p, name);
(*slot)->name = p;
(*slot)->full_path = NULL;
(*slot)->loaded = loaded;
(*slot)->language = language;
}
return in_hash_table;
}
/* Clear the table of loaded section scripts. */
static void
clear_section_scripts (void)
{
struct program_space *pspace = current_program_space;
struct auto_load_pspace_info *info;
info = program_space_data (pspace, auto_load_pspace_data);
if (info != NULL && info->loaded_script_files != NULL)
{
htab_delete (info->loaded_script_files);
htab_delete (info->loaded_script_texts);
info->loaded_script_files = NULL;
info->loaded_script_texts = NULL;
info->unsupported_script_warning_printed = FALSE;
info->script_not_found_warning_printed = FALSE;
}
}
/* Look for the auto-load script in LANGUAGE associated with OBJFILE where
OBJFILE's gdb_realpath is REALNAME and load it. Return 1 if we found any
matching script, return 0 otherwise. */
static int
auto_load_objfile_script_1 (struct objfile *objfile, const char *realname,
const struct extension_language_defn *language)
{
char *filename, *debugfile;
int len, retval;
FILE *input;
struct cleanup *cleanups;
const char *suffix = ext_lang_auto_load_suffix (language);
len = strlen (realname);
filename = xmalloc (len + strlen (suffix) + 1);
memcpy (filename, realname, len);
strcpy (filename + len, suffix);
cleanups = make_cleanup (xfree, filename);
input = gdb_fopen_cloexec (filename, "r");
debugfile = filename;
if (debug_auto_load)
fprintf_unfiltered (gdb_stdlog, _("auto-load: Attempted file \"%s\" %s.\n"),
debugfile, input ? _("exists") : _("does not exist"));
if (!input)
{
VEC (char_ptr) *vec;
int ix;
char *dir;
/* Also try the same file in a subdirectory of gdb's data
directory. */
vec = auto_load_expand_dir_vars (auto_load_dir);
make_cleanup_free_char_ptr_vec (vec);
if (debug_auto_load)
fprintf_unfiltered (gdb_stdlog, _("auto-load: Searching 'set auto-load "
"scripts-directory' path \"%s\".\n"),
auto_load_dir);
for (ix = 0; VEC_iterate (char_ptr, vec, ix, dir); ++ix)
{
debugfile = xmalloc (strlen (dir) + strlen (filename) + 1);
strcpy (debugfile, dir);
/* FILENAME is absolute, so we don't need a "/" here. */
strcat (debugfile, filename);
make_cleanup (xfree, debugfile);
input = gdb_fopen_cloexec (debugfile, "r");
if (debug_auto_load)
fprintf_unfiltered (gdb_stdlog, _("auto-load: Attempted file "
"\"%s\" %s.\n"),
debugfile,
input ? _("exists") : _("does not exist"));
if (input != NULL)
break;
}
}
if (input)
{
int is_safe;
struct auto_load_pspace_info *pspace_info;
make_cleanup_fclose (input);
is_safe
= file_is_auto_load_safe (debugfile,
_("auto-load: Loading %s script \"%s\""
" by extension for objfile \"%s\".\n"),
ext_lang_name (language),
debugfile, objfile_name (objfile));
/* Add this script to the hash table too so
"info auto-load ${lang}-scripts" can print it. */
pspace_info
= get_auto_load_pspace_data_for_loading (current_program_space);
maybe_add_script_file (pspace_info, is_safe, debugfile, debugfile,
language);
/* To preserve existing behaviour we don't check for whether the
script was already in the table, and always load it.
It's highly unlikely that we'd ever load it twice,
and these scripts are required to be idempotent under multiple
loads anyway. */
if (is_safe)
{
objfile_script_sourcer_func *sourcer
= ext_lang_objfile_script_sourcer (language);
/* We shouldn't get here if support for the language isn't
compiled in. And the extension language is required to implement
this function. */
gdb_assert (sourcer != NULL);
sourcer (language, objfile, input, debugfile);
}
retval = 1;
}
else
retval = 0;
do_cleanups (cleanups);
return retval;
}
/* Look for the auto-load script in LANGUAGE associated with OBJFILE and load
it. */
void
auto_load_objfile_script (struct objfile *objfile,
const struct extension_language_defn *language)
{
char *realname = gdb_realpath (objfile_name (objfile));
struct cleanup *cleanups = make_cleanup (xfree, realname);
if (!auto_load_objfile_script_1 (objfile, realname, language))
{
/* For Windows/DOS .exe executables, strip the .exe suffix, so that
FOO-gdb.gdb could be used for FOO.exe, and try again. */
size_t len = strlen (realname);
const size_t lexe = sizeof (".exe") - 1;
if (len > lexe && strcasecmp (realname + len - lexe, ".exe") == 0)
{
len -= lexe;
realname[len] = '\0';
if (debug_auto_load)
fprintf_unfiltered (gdb_stdlog, _("auto-load: Stripped .exe suffix, "
"retrying with \"%s\".\n"),
realname);
auto_load_objfile_script_1 (objfile, realname, language);
}
}
do_cleanups (cleanups);
}
/* Subroutine of source_section_scripts to simplify it.
Load FILE as a script in extension language LANGUAGE.
The script is from section SECTION_NAME in OBJFILE at offset OFFSET. */
static void
source_script_file (struct auto_load_pspace_info *pspace_info,
struct objfile *objfile,
const struct extension_language_defn *language,
const char *section_name, unsigned int offset,
const char *file)
{
FILE *stream;
char *full_path;
int opened, in_hash_table;
struct cleanup *cleanups;
objfile_script_sourcer_func *sourcer;
/* Skip this script if support is not compiled in. */
sourcer = ext_lang_objfile_script_sourcer (language);
if (sourcer == NULL)
{
/* We don't throw an error, the program is still debuggable. */
maybe_print_unsupported_script_warning (pspace_info, objfile, language,
section_name, offset);
/* We *could* still try to open it, but there's no point. */
maybe_add_script_file (pspace_info, 0, file, NULL, language);
return;
}
/* Skip this script if auto-loading it has been disabled. */
if (!ext_lang_auto_load_enabled (language))
{
/* No message is printed, just skip it. */
return;
}
opened = find_and_open_script (file, 1 /*search_path*/,
&stream, &full_path);
cleanups = make_cleanup (null_cleanup, NULL);
if (opened)
{
make_cleanup_fclose (stream);
make_cleanup (xfree, full_path);
if (!file_is_auto_load_safe (full_path,
_("auto-load: Loading %s script "
"\"%s\" from section \"%s\" of "
"objfile \"%s\".\n"),
ext_lang_name (language), full_path,
section_name, objfile_name (objfile)))
opened = 0;
}
else
{
full_path = NULL;
/* If one script isn't found it's not uncommon for more to not be
found either. We don't want to print a message for each script,
too much noise. Instead, we print the warning once and tell the
user how to find the list of scripts that weren't loaded.
We don't throw an error, the program is still debuggable.
IWBN if complaints.c were more general-purpose. */
maybe_print_script_not_found_warning (pspace_info, objfile, language,
section_name, offset);
}
in_hash_table = maybe_add_script_file (pspace_info, opened, file, full_path,
language);
/* If this file is not currently loaded, load it. */
if (opened && !in_hash_table)
sourcer (language, objfile, stream, full_path);
do_cleanups (cleanups);
}
/* Subroutine of source_section_scripts to simplify it.
Execute SCRIPT as a script in extension language LANG.
The script is from section SECTION_NAME in OBJFILE at offset OFFSET. */