1 /* ldlang.h - linker command language support
2 Copyright (C) 1991-2021 Free Software Foundation, Inc.
4 This file is part of the GNU Binutils.
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.
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.
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. */
24 #define DEFAULT_MEMORY_REGION "*default*"
26 #define SECTION_NAME_MAP_LENGTH (16)
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
;
41 unsigned char data
[1];
44 typedef struct statement_list
46 union lang_statement_union
* head
;
47 union lang_statement_union
** tail
;
48 } lang_statement_list_type
;
50 typedef struct memory_region_name_struct
53 struct memory_region_name_struct
* next
;
54 } lang_memory_region_name
;
56 typedef struct memory_region_struct
58 lang_memory_region_name name_list
;
59 struct memory_region_struct
*next
;
60 union etree_union
*origin_exp
;
63 union etree_union
*length_exp
;
65 union lang_statement_union
*last_os
;
68 bool had_full_message
;
69 } lang_memory_region_type
;
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
91 typedef struct lang_statement_header_struct
93 /* Next pointer for statement_list statement list. */
94 union lang_statement_union
*next
;
95 enum statement_enum type
;
96 } lang_statement_header_type
;
100 lang_statement_header_type header
;
101 union etree_union
*exp
;
102 } lang_assignment_statement_type
;
104 typedef struct lang_target_statement_struct
106 lang_statement_header_type header
;
108 } lang_target_statement_type
;
110 typedef struct lang_output_statement_struct
112 lang_statement_header_type header
;
114 } lang_output_statement_type
;
116 /* Section types specified in a linker script. */
121 first_overlay_section
,
128 /* This structure holds a list of program headers describing
129 segments in which this section should be placed. */
131 typedef struct lang_output_section_phdr_list
133 struct lang_output_section_phdr_list
*next
;
136 } lang_output_section_phdr_list
;
138 typedef struct lang_output_section_statement_struct
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
;
145 asection
*bfd_section
;
146 lang_memory_region_type
*region
;
147 lang_memory_region_type
*lma_region
;
149 union etree_union
*addr_tree
;
150 union etree_union
*load_base
;
151 union etree_union
*section_alignment
;
152 union etree_union
*subsection_alignment
;
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
;
160 lang_output_section_phdr_list
*phdrs
;
162 /* Used by ELF SHF_LINK_ORDER sorting. */
165 unsigned int block_value
;
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
;
187 lang_statement_header_type header
;
190 asection
*output_section
;
191 } lang_fill_statement_type
;
195 lang_statement_header_type header
;
197 union etree_union
*exp
;
199 asection
*output_section
;
200 bfd_vma output_offset
;
201 } lang_data_statement_type
;
203 /* Generate a reloc in the output file. */
207 lang_statement_header_type header
;
209 /* Reloc to generate. */
210 bfd_reloc_code_real_type reloc
;
212 /* Reloc howto structure. */
213 reloc_howto_type
*howto
;
215 /* Section to generate reloc against.
216 Exactly one of section and name must be NULL. */
219 /* Name of symbol to generate reloc against.
220 Exactly one of section and name must be NULL. */
223 /* Expression for addend. */
224 union etree_union
*addend_exp
;
226 /* Resolved addend. */
227 bfd_vma addend_value
;
229 /* Output section where reloc should be performed. */
230 asection
*output_section
;
232 /* Offset within output section. */
233 bfd_vma output_offset
;
234 } lang_reloc_statement_type
;
236 struct lang_input_statement_flags
238 /* 1 means this file was specified in a -l option. */
239 unsigned int maybe_archive
: 1;
241 /* 1 means this file was specified in a -l:namespec option. */
242 unsigned int full_name_provided
: 1;
244 /* 1 means search a set of directories for this file. */
245 unsigned int search_dirs
: 1;
247 /* 1 means this was found when processing a script in the sysroot. */
248 unsigned int sysrooted
: 1;
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;
255 /* Whether to search for this entry as a dynamic archive. */
256 unsigned int dynamic
: 1;
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;
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;
267 /* Whether to include the entire contents of an archive. */
268 unsigned int whole_archive
: 1;
270 /* Set when bfd opening is successful. */
271 unsigned int loaded
: 1;
273 unsigned int real
: 1;
275 /* Set if the file does not exist. */
276 unsigned int missing_file
: 1;
278 /* Set if reloading an archive or --as-needed lib. */
279 unsigned int reload
: 1;
281 #if BFD_SUPPORTS_PLUGINS
282 /* Set if the file was claimed by a plugin. */
283 unsigned int claimed
: 1;
285 /* Set if the file was claimed from an archive. */
286 unsigned int claim_archive
: 1;
288 /* Set if added by the lto plugin add_input_file callback. */
289 unsigned int lto_output
: 1;
290 #endif /* BFD_SUPPORTS_PLUGINS */
292 /* Head of list of pushed flags. */
293 struct lang_input_statement_flags
*pushed
;
296 typedef struct lang_input_statement_struct
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
;
311 ctf_archive_t
*the_ctf
;
313 struct flag_info
*section_flag_list
;
315 /* Next pointer for file_chain statement list. */
316 struct lang_input_statement_struct
*next
;
318 /* Next pointer for input_file_chain statement list. */
319 struct lang_input_statement_struct
*next_real_file
;
323 struct lang_input_statement_flags flags
;
324 } lang_input_statement_type
;
328 lang_statement_header_type header
;
331 } lang_input_section_type
;
333 struct map_symbol_def
{
334 struct bfd_link_hash_entry
*entry
;
335 struct map_symbol_def
*next
;
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
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
;
348 bfd_input_just_syms (const bfd
*abfd
)
350 lang_input_statement_type
*is
= bfd_usrdata (abfd
);
351 return is
!= NULL
&& is
->flags
.just_syms
;
354 typedef struct lang_wild_statement_struct lang_wild_statement_type
;
356 typedef void (*callback_t
) (lang_wild_statement_type
*, struct wildcard_list
*,
357 asection
*, lang_input_statement_type
*, void *);
359 typedef void (*walk_wild_section_handler_t
) (lang_wild_statement_type
*,
360 lang_input_statement_type
*,
364 typedef bool (*lang_match_sec_type_func
) (bfd
*, const asection
*,
365 bfd
*, const asection
*);
367 /* Binary search tree structure to efficiently sort sections by
369 typedef struct lang_section_bst
373 struct lang_section_bst
*left
;
374 struct lang_section_bst
*right
;
375 } lang_section_bst_type
;
377 struct lang_wild_statement_struct
379 lang_statement_header_type header
;
380 const char *filename
;
381 bool filenames_sorted
;
382 struct wildcard_list
*section_list
;
384 lang_statement_list_type children
;
385 struct name_list
*exclude_name_list
;
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
;
393 typedef struct lang_address_statement_struct
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
;
403 lang_statement_header_type header
;
404 bfd_vma output_offset
;
406 asection
*output_section
;
408 } lang_padding_statement_type
;
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. */
417 lang_statement_header_type header
;
418 lang_statement_list_type children
;
419 } lang_group_statement_type
;
423 lang_statement_header_type header
;
426 } lang_insert_statement_type
;
428 typedef union lang_statement_union
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
;
447 /* This structure holds information about a program header, from the
448 PHDRS command in the linker script. */
452 struct lang_phdr
*next
;
461 /* This structure is used to hold a list of sections which may not
462 cross reference each other. */
464 typedef struct lang_nocrossref
466 struct lang_nocrossref
*next
;
468 } lang_nocrossref_type
;
470 /* The list of nocrossref lists. */
472 struct lang_nocrossrefs
474 struct lang_nocrossrefs
*next
;
475 lang_nocrossref_type
*list
;
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. */
482 struct unique_sections
484 struct unique_sections
*next
;
488 /* Used by place_orphan to keep track of orphan sections and statements. */
494 lang_output_section_statement_type
*os
;
496 lang_statement_union_type
**stmt
;
497 lang_output_section_statement_type
**os_tail
;
500 struct asneeded_minfo
502 struct asneeded_minfo
*next
;
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
;
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
;
525 extern struct bfd_elf_dynamic_list
**current_dynamic_list_p
;
527 extern int lang_statement_iteration
;
528 extern struct asneeded_minfo
**asneeded_list_tail
;
530 extern void (*output_bfd_hash_table_free_fn
) (struct bfd_link_hash_table
*);
532 extern void lang_init
534 extern void lang_finish
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 *);
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
551 extern void lang_relax_sections
553 extern void lang_process
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
561 extern void lang_add_target
563 extern void lang_add_wild
564 (struct wildcard_spec
*, struct wildcard_list
*, bool);
565 extern void lang_add_map
567 extern void lang_add_fill
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
575 extern void lang_float
577 extern void lang_leave_output_section_statement
578 (fill_type
*, const char *, lang_output_section_phdr_list
*,
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
586 extern void lang_do_assignments
588 extern asection
*section_for_dot
591 #define LANG_FOR_EACH_INPUT_STATEMENT(statement) \
592 lang_input_statement_type *statement; \
593 for (statement = (lang_input_statement_type *) file_chain.head; \
595 statement = statement->next)
597 #define lang_output_section_find(NAME) \
598 lang_output_section_statement_lookup (NAME, 0, 0)
600 extern void lang_process
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
614 extern lang_output_section_statement_type
*lang_output_section_get
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
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
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
643 extern void strip_excluded_output_sections
645 extern void lang_clear_os_map
647 extern void dprint_statement
648 (lang_statement_union_type
*, int);
649 extern void lang_size_sections
651 extern void one_lang_size_sections_pass
653 extern void lang_add_insert
655 extern void lang_enter_group
657 extern void lang_leave_group
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
*,
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
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 *);
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
693 extern const char *lang_get_output_target
695 extern void add_excluded_libs (const char *);
696 extern bool load_symbols
697 (lang_input_statement_type
*, lang_statement_list_type
*);
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
708 ldlang_override_segment_assignment
709 (struct bfd_link_info
*, bfd
*, asection
*, asection
*, bool);
712 lang_ld_feature (char *);
715 lang_print_memory_usage (void);
718 lang_add_gc_name (const char *);
721 print_one_symbol (struct bfd_link_hash_entry
*hash_entry
, void *ptr
);