[gdb/testsuite] Fix DUPLICATEs in gdb.dwarf2/implptr-64bit.exp
[binutils-gdb.git] / ld / ldlang.h
1 /* ldlang.h - linker command language support
2 Copyright (C) 1991-2021 Free Software Foundation, Inc.
3
4 This file is part of the GNU Binutils.
5
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 3 of the License, or
9 (at your option) any later version.
10
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
19 MA 02110-1301, USA. */
20
21 #ifndef LDLANG_H
22 #define LDLANG_H
23
24 #define DEFAULT_MEMORY_REGION "*default*"
25
26 #define SECTION_NAME_MAP_LENGTH (16)
27
28 typedef enum
29 {
30 lang_input_file_is_l_enum,
31 lang_input_file_is_symbols_only_enum,
32 lang_input_file_is_marker_enum,
33 lang_input_file_is_fake_enum,
34 lang_input_file_is_search_file_enum,
35 lang_input_file_is_file_enum
36 } lang_input_file_enum_type;
37
38 struct _fill_type
39 {
40 size_t size;
41 unsigned char data[1];
42 };
43
44 typedef struct statement_list
45 {
46 union lang_statement_union * head;
47 union lang_statement_union ** tail;
48 } lang_statement_list_type;
49
50 typedef struct memory_region_name_struct
51 {
52 const char * name;
53 struct memory_region_name_struct * next;
54 } lang_memory_region_name;
55
56 typedef struct memory_region_struct
57 {
58 lang_memory_region_name name_list;
59 struct memory_region_struct *next;
60 union etree_union *origin_exp;
61 bfd_vma origin;
62 bfd_size_type length;
63 union etree_union *length_exp;
64 bfd_vma current;
65 union lang_statement_union *last_os;
66 flagword flags;
67 flagword not_flags;
68 bool had_full_message;
69 } lang_memory_region_type;
70
71 enum statement_enum
72 {
73 lang_address_statement_enum,
74 lang_assignment_statement_enum,
75 lang_data_statement_enum,
76 lang_fill_statement_enum,
77 lang_group_statement_enum,
78 lang_input_section_enum,
79 lang_input_statement_enum,
80 lang_insert_statement_enum,
81 lang_output_section_statement_enum,
82 lang_output_statement_enum,
83 lang_padding_statement_enum,
84 lang_reloc_statement_enum,
85 lang_target_statement_enum,
86 lang_wild_statement_enum,
87 lang_constructors_statement_enum,
88 lang_object_symbols_statement_enum
89 };
90
91 typedef struct lang_statement_header_struct
92 {
93 /* Next pointer for statement_list statement list. */
94 union lang_statement_union *next;
95 enum statement_enum type;
96 } lang_statement_header_type;
97
98 typedef struct
99 {
100 lang_statement_header_type header;
101 union etree_union *exp;
102 } lang_assignment_statement_type;
103
104 typedef struct lang_target_statement_struct
105 {
106 lang_statement_header_type header;
107 const char *target;
108 } lang_target_statement_type;
109
110 typedef struct lang_output_statement_struct
111 {
112 lang_statement_header_type header;
113 const char *name;
114 } lang_output_statement_type;
115
116 /* Section types specified in a linker script. */
117
118 enum section_type
119 {
120 normal_section,
121 first_overlay_section,
122 overlay_section,
123 noload_section,
124 noalloc_section,
125 readonly_section
126 };
127
128 /* This structure holds a list of program headers describing
129 segments in which this section should be placed. */
130
131 typedef struct lang_output_section_phdr_list
132 {
133 struct lang_output_section_phdr_list *next;
134 const char *name;
135 bool used;
136 } lang_output_section_phdr_list;
137
138 typedef struct lang_output_section_statement_struct
139 {
140 lang_statement_header_type header;
141 lang_statement_list_type children;
142 struct lang_output_section_statement_struct *next;
143 struct lang_output_section_statement_struct *prev;
144 const char *name;
145 asection *bfd_section;
146 lang_memory_region_type *region;
147 lang_memory_region_type *lma_region;
148 fill_type *fill;
149 union etree_union *addr_tree;
150 union etree_union *load_base;
151 union etree_union *section_alignment;
152 union etree_union *subsection_alignment;
153
154 /* If non-null, an expression to evaluate after setting the section's
155 size. The expression is evaluated inside REGION (above) with '.'
156 set to the end of the section. Used in the last overlay section
157 to move '.' past all the overlaid sections. */
158 union etree_union *update_dot_tree;
159
160 lang_output_section_phdr_list *phdrs;
161
162 /* Used by ELF SHF_LINK_ORDER sorting. */
163 void *data;
164
165 unsigned int block_value;
166 int constraint;
167 flagword flags;
168 enum section_type sectype;
169 unsigned int processed_vma : 1;
170 unsigned int processed_lma : 1;
171 unsigned int all_input_readonly : 1;
172 /* If this section should be ignored. */
173 unsigned int ignored : 1;
174 /* If this section should update "dot". Prevents section being ignored. */
175 unsigned int update_dot : 1;
176 /* If this section is after assignment to _end. */
177 unsigned int after_end : 1;
178 /* If this section uses the alignment of its input sections. */
179 unsigned int align_lma_with_input : 1;
180 /* If script has duplicate output section statements of the same name
181 create duplicate output sections. */
182 unsigned int dup_output : 1;
183 } lang_output_section_statement_type;
184
185 typedef struct
186 {
187 lang_statement_header_type header;
188 fill_type *fill;
189 int size;
190 asection *output_section;
191 } lang_fill_statement_type;
192
193 typedef struct
194 {
195 lang_statement_header_type header;
196 unsigned int type;
197 union etree_union *exp;
198 bfd_vma value;
199 asection *output_section;
200 bfd_vma output_offset;
201 } lang_data_statement_type;
202
203 /* Generate a reloc in the output file. */
204
205 typedef struct
206 {
207 lang_statement_header_type header;
208
209 /* Reloc to generate. */
210 bfd_reloc_code_real_type reloc;
211
212 /* Reloc howto structure. */
213 reloc_howto_type *howto;
214
215 /* Section to generate reloc against.
216 Exactly one of section and name must be NULL. */
217 asection *section;
218
219 /* Name of symbol to generate reloc against.
220 Exactly one of section and name must be NULL. */
221 const char *name;
222
223 /* Expression for addend. */
224 union etree_union *addend_exp;
225
226 /* Resolved addend. */
227 bfd_vma addend_value;
228
229 /* Output section where reloc should be performed. */
230 asection *output_section;
231
232 /* Offset within output section. */
233 bfd_vma output_offset;
234 } lang_reloc_statement_type;
235
236 struct lang_input_statement_flags
237 {
238 /* 1 means this file was specified in a -l option. */
239 unsigned int maybe_archive : 1;
240
241 /* 1 means this file was specified in a -l:namespec option. */
242 unsigned int full_name_provided : 1;
243
244 /* 1 means search a set of directories for this file. */
245 unsigned int search_dirs : 1;
246
247 /* 1 means this was found when processing a script in the sysroot. */
248 unsigned int sysrooted : 1;
249
250 /* 1 means this is base file of incremental load.
251 Do not load this file's text or data.
252 Also default text_start to after this file's bss. */
253 unsigned int just_syms : 1;
254
255 /* Whether to search for this entry as a dynamic archive. */
256 unsigned int dynamic : 1;
257
258 /* Set if a DT_NEEDED tag should be added not just for the dynamic library
259 explicitly given by this entry but also for any dynamic libraries in
260 this entry's needed list. */
261 unsigned int add_DT_NEEDED_for_dynamic : 1;
262
263 /* Set if this entry should cause a DT_NEEDED tag only when some
264 regular file references its symbols (ie. --as-needed is in effect). */
265 unsigned int add_DT_NEEDED_for_regular : 1;
266
267 /* Whether to include the entire contents of an archive. */
268 unsigned int whole_archive : 1;
269
270 /* Set when bfd opening is successful. */
271 unsigned int loaded : 1;
272
273 unsigned int real : 1;
274
275 /* Set if the file does not exist. */
276 unsigned int missing_file : 1;
277
278 /* Set if reloading an archive or --as-needed lib. */
279 unsigned int reload : 1;
280
281 #if BFD_SUPPORTS_PLUGINS
282 /* Set if the file was claimed by a plugin. */
283 unsigned int claimed : 1;
284
285 /* Set if the file was claimed from an archive. */
286 unsigned int claim_archive : 1;
287
288 /* Set if added by the lto plugin add_input_file callback. */
289 unsigned int lto_output : 1;
290 #endif /* BFD_SUPPORTS_PLUGINS */
291
292 /* Head of list of pushed flags. */
293 struct lang_input_statement_flags *pushed;
294 };
295
296 typedef struct lang_input_statement_struct
297 {
298 lang_statement_header_type header;
299 /* Name of this file. */
300 const char *filename;
301 /* Name to use for the symbol giving address of text start.
302 Usually the same as filename, but for a file spec'd with
303 -l this is the -l switch itself rather than the filename. */
304 const char *local_sym_name;
305 /* Extra search path. Used to find a file relative to the
306 directory of the current linker script. */
307 const char *extra_search_path;
308
309 bfd *the_bfd;
310
311 ctf_archive_t *the_ctf;
312
313 struct flag_info *section_flag_list;
314
315 /* Next pointer for file_chain statement list. */
316 struct lang_input_statement_struct *next;
317
318 /* Next pointer for input_file_chain statement list. */
319 struct lang_input_statement_struct *next_real_file;
320
321 const char *target;
322
323 struct lang_input_statement_flags flags;
324 } lang_input_statement_type;
325
326 typedef struct
327 {
328 lang_statement_header_type header;
329 asection *section;
330 void *pattern;
331 } lang_input_section_type;
332
333 struct map_symbol_def {
334 struct bfd_link_hash_entry *entry;
335 struct map_symbol_def *next;
336 };
337
338 /* For input sections, when writing a map file: head / tail of a linked
339 list of hash table entries for symbols defined in this section. */
340 typedef struct input_section_userdata_struct
341 {
342 struct map_symbol_def *map_symbol_def_head;
343 struct map_symbol_def **map_symbol_def_tail;
344 unsigned long map_symbol_def_count;
345 } input_section_userdata_type;
346
347 static inline bool
348 bfd_input_just_syms (const bfd *abfd)
349 {
350 lang_input_statement_type *is = bfd_usrdata (abfd);
351 return is != NULL && is->flags.just_syms;
352 }
353
354 typedef struct lang_wild_statement_struct lang_wild_statement_type;
355
356 typedef void (*callback_t) (lang_wild_statement_type *, struct wildcard_list *,
357 asection *, lang_input_statement_type *, void *);
358
359 typedef void (*walk_wild_section_handler_t) (lang_wild_statement_type *,
360 lang_input_statement_type *,
361 callback_t callback,
362 void *data);
363
364 typedef bool (*lang_match_sec_type_func) (bfd *, const asection *,
365 bfd *, const asection *);
366
367 /* Binary search tree structure to efficiently sort sections by
368 name. */
369 typedef struct lang_section_bst
370 {
371 asection *section;
372 void *pattern;
373 struct lang_section_bst *left;
374 struct lang_section_bst *right;
375 } lang_section_bst_type;
376
377 struct lang_wild_statement_struct
378 {
379 lang_statement_header_type header;
380 const char *filename;
381 bool filenames_sorted;
382 struct wildcard_list *section_list;
383 bool keep_sections;
384 lang_statement_list_type children;
385 struct name_list *exclude_name_list;
386
387 walk_wild_section_handler_t walk_wild_section_handler;
388 struct wildcard_list *handler_data[4];
389 lang_section_bst_type *tree;
390 struct flag_info *section_flag_list;
391 };
392
393 typedef struct lang_address_statement_struct
394 {
395 lang_statement_header_type header;
396 const char *section_name;
397 union etree_union *address;
398 const segment_type *segment;
399 } lang_address_statement_type;
400
401 typedef struct
402 {
403 lang_statement_header_type header;
404 bfd_vma output_offset;
405 bfd_size_type size;
406 asection *output_section;
407 fill_type *fill;
408 } lang_padding_statement_type;
409
410 /* A group statement collects a set of libraries together. The
411 libraries are searched multiple times, until no new undefined
412 symbols are found. The effect is to search a group of libraries as
413 though they were a single library. */
414
415 typedef struct
416 {
417 lang_statement_header_type header;
418 lang_statement_list_type children;
419 } lang_group_statement_type;
420
421 typedef struct
422 {
423 lang_statement_header_type header;
424 const char *where;
425 bool is_before;
426 } lang_insert_statement_type;
427
428 typedef union lang_statement_union
429 {
430 lang_statement_header_type header;
431 lang_address_statement_type address_statement;
432 lang_assignment_statement_type assignment_statement;
433 lang_data_statement_type data_statement;
434 lang_fill_statement_type fill_statement;
435 lang_group_statement_type group_statement;
436 lang_input_section_type input_section;
437 lang_input_statement_type input_statement;
438 lang_insert_statement_type insert_statement;
439 lang_output_section_statement_type output_section_statement;
440 lang_output_statement_type output_statement;
441 lang_padding_statement_type padding_statement;
442 lang_reloc_statement_type reloc_statement;
443 lang_target_statement_type target_statement;
444 lang_wild_statement_type wild_statement;
445 } lang_statement_union_type;
446
447 /* This structure holds information about a program header, from the
448 PHDRS command in the linker script. */
449
450 struct lang_phdr
451 {
452 struct lang_phdr *next;
453 const char *name;
454 unsigned long type;
455 bool filehdr;
456 bool phdrs;
457 etree_type *at;
458 etree_type *flags;
459 };
460
461 /* This structure is used to hold a list of sections which may not
462 cross reference each other. */
463
464 typedef struct lang_nocrossref
465 {
466 struct lang_nocrossref *next;
467 const char *name;
468 } lang_nocrossref_type;
469
470 /* The list of nocrossref lists. */
471
472 struct lang_nocrossrefs
473 {
474 struct lang_nocrossrefs *next;
475 lang_nocrossref_type *list;
476 bool onlyfirst;
477 };
478
479 /* This structure is used to hold a list of input section names which
480 will not match an output section in the linker script. */
481
482 struct unique_sections
483 {
484 struct unique_sections *next;
485 const char *name;
486 };
487
488 /* Used by place_orphan to keep track of orphan sections and statements. */
489
490 struct orphan_save
491 {
492 const char *name;
493 flagword flags;
494 lang_output_section_statement_type *os;
495 asection **section;
496 lang_statement_union_type **stmt;
497 lang_output_section_statement_type **os_tail;
498 };
499
500 struct asneeded_minfo
501 {
502 struct asneeded_minfo *next;
503 const char *soname;
504 bfd *ref;
505 const char *name;
506 };
507
508 extern struct lang_phdr *lang_phdr_list;
509 extern struct lang_nocrossrefs *nocrossref_list;
510 extern const char *output_target;
511 extern lang_output_section_statement_type *abs_output_section;
512 extern lang_statement_list_type lang_os_list;
513 extern struct lang_input_statement_flags input_flags;
514 extern bool lang_has_input_file;
515 extern lang_statement_list_type statement_list;
516 extern lang_statement_list_type *stat_ptr;
517 extern bool delete_output_file_on_failure;
518
519 extern struct bfd_sym_chain entry_symbol;
520 extern const char *entry_section;
521 extern bool entry_from_cmdline;
522 extern lang_statement_list_type file_chain;
523 extern lang_statement_list_type input_file_chain;
524
525 extern struct bfd_elf_dynamic_list **current_dynamic_list_p;
526
527 extern int lang_statement_iteration;
528 extern struct asneeded_minfo **asneeded_list_tail;
529
530 extern void (*output_bfd_hash_table_free_fn) (struct bfd_link_hash_table *);
531
532 extern void lang_init
533 (void);
534 extern void lang_finish
535 (void);
536 extern lang_memory_region_type * lang_memory_region_lookup
537 (const char * const, bool);
538 extern void lang_memory_region_alias
539 (const char *, const char *);
540 extern void lang_map
541 (void);
542 extern void lang_set_flags
543 (lang_memory_region_type *, const char *, int);
544 extern void lang_add_output
545 (const char *, int from_script);
546 extern lang_output_section_statement_type *lang_enter_output_section_statement
547 (const char *, etree_type *, enum section_type, etree_type *, etree_type *,
548 etree_type *, int, int);
549 extern void lang_final
550 (void);
551 extern void lang_relax_sections
552 (bool);
553 extern void lang_process
554 (void);
555 extern void lang_section_start
556 (const char *, union etree_union *, const segment_type *);
557 extern void lang_add_entry
558 (const char *, bool);
559 extern void lang_default_entry
560 (const char *);
561 extern void lang_add_target
562 (const char *);
563 extern void lang_add_wild
564 (struct wildcard_spec *, struct wildcard_list *, bool);
565 extern void lang_add_map
566 (const char *);
567 extern void lang_add_fill
568 (fill_type *);
569 extern lang_assignment_statement_type *lang_add_assignment
570 (union etree_union *);
571 extern void lang_add_attribute
572 (enum statement_enum);
573 extern void lang_startup
574 (const char *);
575 extern void lang_float
576 (bool);
577 extern void lang_leave_output_section_statement
578 (fill_type *, const char *, lang_output_section_phdr_list *,
579 const char *);
580 extern void lang_for_each_input_file
581 (void (*dothis) (lang_input_statement_type *));
582 extern void lang_for_each_file
583 (void (*dothis) (lang_input_statement_type *));
584 extern void lang_reset_memory_regions
585 (void);
586 extern void lang_do_assignments
587 (lang_phase_type);
588 extern asection *section_for_dot
589 (void);
590
591 #define LANG_FOR_EACH_INPUT_STATEMENT(statement) \
592 lang_input_statement_type *statement; \
593 for (statement = (lang_input_statement_type *) file_chain.head; \
594 statement != NULL; \
595 statement = statement->next)
596
597 #define lang_output_section_find(NAME) \
598 lang_output_section_statement_lookup (NAME, 0, 0)
599
600 extern void lang_process
601 (void);
602 extern void ldlang_add_file
603 (lang_input_statement_type *);
604 extern lang_output_section_statement_type *lang_output_section_find_by_flags
605 (const asection *, flagword, lang_output_section_statement_type **,
606 lang_match_sec_type_func);
607 extern lang_output_section_statement_type *lang_insert_orphan
608 (asection *, const char *, int, lang_output_section_statement_type *,
609 struct orphan_save *, etree_type *, lang_statement_list_type *);
610 extern lang_input_statement_type *lang_add_input_file
611 (const char *, lang_input_file_enum_type, const char *);
612 extern void lang_add_keepsyms_file
613 (const char *);
614 extern lang_output_section_statement_type *lang_output_section_get
615 (const asection *);
616 extern lang_output_section_statement_type *lang_output_section_statement_lookup
617 (const char *, int, int);
618 extern lang_output_section_statement_type *next_matching_output_section_statement
619 (lang_output_section_statement_type *, int);
620 extern void ldlang_add_undef
621 (const char *const, bool);
622 extern void ldlang_add_require_defined
623 (const char *const);
624 extern void lang_add_output_format
625 (const char *, const char *, const char *, int);
626 extern void lang_list_init
627 (lang_statement_list_type *);
628 extern void push_stat_ptr
629 (lang_statement_list_type *);
630 extern void pop_stat_ptr
631 (void);
632 extern void lang_add_data
633 (int type, union etree_union *);
634 extern void lang_add_reloc
635 (bfd_reloc_code_real_type, reloc_howto_type *, asection *, const char *,
636 union etree_union *);
637 extern void lang_for_each_statement
638 (void (*) (lang_statement_union_type *));
639 extern void lang_for_each_statement_worker
640 (void (*) (lang_statement_union_type *), lang_statement_union_type *);
641 extern void *stat_alloc
642 (size_t);
643 extern void strip_excluded_output_sections
644 (void);
645 extern void lang_clear_os_map
646 (void);
647 extern void dprint_statement
648 (lang_statement_union_type *, int);
649 extern void lang_size_sections
650 (bool *, bool);
651 extern void one_lang_size_sections_pass
652 (bool *, bool);
653 extern void lang_add_insert
654 (const char *, int);
655 extern void lang_enter_group
656 (void);
657 extern void lang_leave_group
658 (void);
659 extern void lang_add_section
660 (lang_statement_list_type *, asection *, struct wildcard_list *,
661 struct flag_info *, lang_output_section_statement_type *);
662 extern void lang_new_phdr
663 (const char *, etree_type *, bool, bool, etree_type *,
664 etree_type *);
665 extern void lang_add_nocrossref
666 (lang_nocrossref_type *);
667 extern void lang_add_nocrossref_to
668 (lang_nocrossref_type *);
669 extern void lang_enter_overlay
670 (etree_type *, etree_type *);
671 extern void lang_enter_overlay_section
672 (const char *);
673 extern void lang_leave_overlay_section
674 (fill_type *, lang_output_section_phdr_list *);
675 extern void lang_leave_overlay
676 (etree_type *, int, fill_type *, const char *,
677 lang_output_section_phdr_list *, const char *);
678
679 extern struct bfd_elf_version_expr *lang_new_vers_pattern
680 (struct bfd_elf_version_expr *, const char *, const char *, bool);
681 extern struct bfd_elf_version_tree *lang_new_vers_node
682 (struct bfd_elf_version_expr *, struct bfd_elf_version_expr *);
683 extern struct bfd_elf_version_deps *lang_add_vers_depend
684 (struct bfd_elf_version_deps *, const char *);
685 extern void lang_register_vers_node
686 (const char *, struct bfd_elf_version_tree *, struct bfd_elf_version_deps *);
687 extern void lang_append_dynamic_list (struct bfd_elf_dynamic_list **,
688 struct bfd_elf_version_expr *);
689 extern void lang_append_dynamic_list_cpp_typeinfo (void);
690 extern void lang_append_dynamic_list_cpp_new (void);
691 extern void lang_add_unique
692 (const char *);
693 extern const char *lang_get_output_target
694 (void);
695 extern void add_excluded_libs (const char *);
696 extern bool load_symbols
697 (lang_input_statement_type *, lang_statement_list_type *);
698
699 struct elf_sym_strtab;
700 struct elf_strtab_hash;
701 extern void ldlang_ctf_acquire_strings
702 (struct elf_strtab_hash *);
703 extern void ldlang_ctf_new_dynsym
704 (int symidx, struct elf_internal_sym *);
705 extern void ldlang_write_ctf_late
706 (void);
707 extern bool
708 ldlang_override_segment_assignment
709 (struct bfd_link_info *, bfd *, asection *, asection *, bool);
710
711 extern void
712 lang_ld_feature (char *);
713
714 extern void
715 lang_print_memory_usage (void);
716
717 extern void
718 lang_add_gc_name (const char *);
719
720 extern bool
721 print_one_symbol (struct bfd_link_hash_entry *hash_entry, void *ptr);
722
723 #endif