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 bfd_boolean 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
,
127 /* This structure holds a list of program headers describing
128 segments in which this section should be placed. */
130 typedef struct lang_output_section_phdr_list
132 struct lang_output_section_phdr_list
*next
;
135 } lang_output_section_phdr_list
;
137 typedef struct lang_output_section_statement_struct
139 lang_statement_header_type header
;
140 lang_statement_list_type children
;
141 struct lang_output_section_statement_struct
*next
;
142 struct lang_output_section_statement_struct
*prev
;
144 asection
*bfd_section
;
145 lang_memory_region_type
*region
;
146 lang_memory_region_type
*lma_region
;
148 union etree_union
*addr_tree
;
149 union etree_union
*load_base
;
150 union etree_union
*section_alignment
;
151 union etree_union
*subsection_alignment
;
153 /* If non-null, an expression to evaluate after setting the section's
154 size. The expression is evaluated inside REGION (above) with '.'
155 set to the end of the section. Used in the last overlay section
156 to move '.' past all the overlaid sections. */
157 union etree_union
*update_dot_tree
;
159 lang_output_section_phdr_list
*phdrs
;
161 unsigned int block_value
;
164 enum section_type sectype
;
165 unsigned int processed_vma
: 1;
166 unsigned int processed_lma
: 1;
167 unsigned int all_input_readonly
: 1;
168 /* If this section should be ignored. */
169 unsigned int ignored
: 1;
170 /* If this section should update "dot". Prevents section being ignored. */
171 unsigned int update_dot
: 1;
172 /* If this section is after assignment to _end. */
173 unsigned int after_end
: 1;
174 /* If this section uses the alignment of its input sections. */
175 unsigned int align_lma_with_input
: 1;
176 /* If script has duplicate output section statements of the same name
177 create duplicate output sections. */
178 unsigned int dup_output
: 1;
179 } lang_output_section_statement_type
;
183 lang_statement_header_type header
;
186 asection
*output_section
;
187 } lang_fill_statement_type
;
191 lang_statement_header_type header
;
193 union etree_union
*exp
;
195 asection
*output_section
;
196 bfd_vma output_offset
;
197 } lang_data_statement_type
;
199 /* Generate a reloc in the output file. */
203 lang_statement_header_type header
;
205 /* Reloc to generate. */
206 bfd_reloc_code_real_type reloc
;
208 /* Reloc howto structure. */
209 reloc_howto_type
*howto
;
211 /* Section to generate reloc against.
212 Exactly one of section and name must be NULL. */
215 /* Name of symbol to generate reloc against.
216 Exactly one of section and name must be NULL. */
219 /* Expression for addend. */
220 union etree_union
*addend_exp
;
222 /* Resolved addend. */
223 bfd_vma addend_value
;
225 /* Output section where reloc should be performed. */
226 asection
*output_section
;
228 /* Offset within output section. */
229 bfd_vma output_offset
;
230 } lang_reloc_statement_type
;
232 struct lang_input_statement_flags
234 /* 1 means this file was specified in a -l option. */
235 unsigned int maybe_archive
: 1;
237 /* 1 means this file was specified in a -l:namespec option. */
238 unsigned int full_name_provided
: 1;
240 /* 1 means search a set of directories for this file. */
241 unsigned int search_dirs
: 1;
243 /* 1 means this was found when processing a script in the sysroot. */
244 unsigned int sysrooted
: 1;
246 /* 1 means this is base file of incremental load.
247 Do not load this file's text or data.
248 Also default text_start to after this file's bss. */
249 unsigned int just_syms
: 1;
251 /* Whether to search for this entry as a dynamic archive. */
252 unsigned int dynamic
: 1;
254 /* Set if a DT_NEEDED tag should be added not just for the dynamic library
255 explicitly given by this entry but also for any dynamic libraries in
256 this entry's needed list. */
257 unsigned int add_DT_NEEDED_for_dynamic
: 1;
259 /* Set if this entry should cause a DT_NEEDED tag only when some
260 regular file references its symbols (ie. --as-needed is in effect). */
261 unsigned int add_DT_NEEDED_for_regular
: 1;
263 /* Whether to include the entire contents of an archive. */
264 unsigned int whole_archive
: 1;
266 /* Set when bfd opening is successful. */
267 unsigned int loaded
: 1;
269 unsigned int real
: 1;
271 /* Set if the file does not exist. */
272 unsigned int missing_file
: 1;
274 /* Set if reloading an archive or --as-needed lib. */
275 unsigned int reload
: 1;
277 #if BFD_SUPPORTS_PLUGINS
278 /* Set if the file was claimed by a plugin. */
279 unsigned int claimed
: 1;
281 /* Set if the file was claimed from an archive. */
282 unsigned int claim_archive
: 1;
284 /* Set if added by the lto plugin add_input_file callback. */
285 unsigned int lto_output
: 1;
286 #endif /* BFD_SUPPORTS_PLUGINS */
288 /* Head of list of pushed flags. */
289 struct lang_input_statement_flags
*pushed
;
292 typedef struct lang_input_statement_struct
294 lang_statement_header_type header
;
295 /* Name of this file. */
296 const char *filename
;
297 /* Name to use for the symbol giving address of text start.
298 Usually the same as filename, but for a file spec'd with
299 -l this is the -l switch itself rather than the filename. */
300 const char *local_sym_name
;
301 /* Extra search path. Used to find a file relative to the
302 directory of the current linker script. */
303 const char *extra_search_path
;
307 ctf_archive_t
*the_ctf
;
309 struct flag_info
*section_flag_list
;
311 /* Next pointer for file_chain statement list. */
312 struct lang_input_statement_struct
*next
;
314 /* Next pointer for input_file_chain statement list. */
315 struct lang_input_statement_struct
*next_real_file
;
319 struct lang_input_statement_flags flags
;
320 } lang_input_statement_type
;
324 lang_statement_header_type header
;
326 } lang_input_section_type
;
328 struct map_symbol_def
{
329 struct bfd_link_hash_entry
*entry
;
330 struct map_symbol_def
*next
;
333 /* For input sections, when writing a map file: head / tail of a linked
334 list of hash table entries for symbols defined in this section. */
335 typedef struct input_section_userdata_struct
337 struct map_symbol_def
*map_symbol_def_head
;
338 struct map_symbol_def
**map_symbol_def_tail
;
339 unsigned long map_symbol_def_count
;
340 } input_section_userdata_type
;
342 static inline bfd_boolean
343 bfd_input_just_syms (const bfd
*abfd
)
345 lang_input_statement_type
*is
= bfd_usrdata (abfd
);
346 return is
!= NULL
&& is
->flags
.just_syms
;
349 typedef struct lang_wild_statement_struct lang_wild_statement_type
;
351 typedef void (*callback_t
) (lang_wild_statement_type
*, struct wildcard_list
*,
352 asection
*, struct flag_info
*,
353 lang_input_statement_type
*, void *);
355 typedef void (*walk_wild_section_handler_t
) (lang_wild_statement_type
*,
356 lang_input_statement_type
*,
360 typedef bfd_boolean (*lang_match_sec_type_func
) (bfd
*, const asection
*,
361 bfd
*, const asection
*);
363 /* Binary search tree structure to efficiently sort sections by
365 typedef struct lang_section_bst
368 struct lang_section_bst
*left
;
369 struct lang_section_bst
*right
;
370 } lang_section_bst_type
;
372 struct lang_wild_statement_struct
374 lang_statement_header_type header
;
375 const char *filename
;
376 bfd_boolean filenames_sorted
;
377 struct wildcard_list
*section_list
;
378 bfd_boolean keep_sections
;
379 lang_statement_list_type children
;
380 struct name_list
*exclude_name_list
;
382 walk_wild_section_handler_t walk_wild_section_handler
;
383 struct wildcard_list
*handler_data
[4];
384 lang_section_bst_type
*tree
;
385 struct flag_info
*section_flag_list
;
388 typedef struct lang_address_statement_struct
390 lang_statement_header_type header
;
391 const char *section_name
;
392 union etree_union
*address
;
393 const segment_type
*segment
;
394 } lang_address_statement_type
;
398 lang_statement_header_type header
;
399 bfd_vma output_offset
;
401 asection
*output_section
;
403 } lang_padding_statement_type
;
405 /* A group statement collects a set of libraries together. The
406 libraries are searched multiple times, until no new undefined
407 symbols are found. The effect is to search a group of libraries as
408 though they were a single library. */
412 lang_statement_header_type header
;
413 lang_statement_list_type children
;
414 } lang_group_statement_type
;
418 lang_statement_header_type header
;
420 bfd_boolean is_before
;
421 } lang_insert_statement_type
;
423 typedef union lang_statement_union
425 lang_statement_header_type header
;
426 lang_address_statement_type address_statement
;
427 lang_assignment_statement_type assignment_statement
;
428 lang_data_statement_type data_statement
;
429 lang_fill_statement_type fill_statement
;
430 lang_group_statement_type group_statement
;
431 lang_input_section_type input_section
;
432 lang_input_statement_type input_statement
;
433 lang_insert_statement_type insert_statement
;
434 lang_output_section_statement_type output_section_statement
;
435 lang_output_statement_type output_statement
;
436 lang_padding_statement_type padding_statement
;
437 lang_reloc_statement_type reloc_statement
;
438 lang_target_statement_type target_statement
;
439 lang_wild_statement_type wild_statement
;
440 } lang_statement_union_type
;
442 /* This structure holds information about a program header, from the
443 PHDRS command in the linker script. */
447 struct lang_phdr
*next
;
456 /* This structure is used to hold a list of sections which may not
457 cross reference each other. */
459 typedef struct lang_nocrossref
461 struct lang_nocrossref
*next
;
463 } lang_nocrossref_type
;
465 /* The list of nocrossref lists. */
467 struct lang_nocrossrefs
469 struct lang_nocrossrefs
*next
;
470 lang_nocrossref_type
*list
;
471 bfd_boolean onlyfirst
;
474 /* This structure is used to hold a list of input section names which
475 will not match an output section in the linker script. */
477 struct unique_sections
479 struct unique_sections
*next
;
483 /* Used by place_orphan to keep track of orphan sections and statements. */
489 lang_output_section_statement_type
*os
;
491 lang_statement_union_type
**stmt
;
492 lang_output_section_statement_type
**os_tail
;
495 struct asneeded_minfo
497 struct asneeded_minfo
*next
;
503 extern struct lang_phdr
*lang_phdr_list
;
504 extern struct lang_nocrossrefs
*nocrossref_list
;
505 extern const char *output_target
;
506 extern lang_output_section_statement_type
*abs_output_section
;
507 extern lang_statement_list_type lang_os_list
;
508 extern struct lang_input_statement_flags input_flags
;
509 extern bfd_boolean lang_has_input_file
;
510 extern lang_statement_list_type
*stat_ptr
;
511 extern bfd_boolean delete_output_file_on_failure
;
513 extern struct bfd_sym_chain entry_symbol
;
514 extern const char *entry_section
;
515 extern bfd_boolean entry_from_cmdline
;
516 extern lang_statement_list_type file_chain
;
517 extern lang_statement_list_type input_file_chain
;
519 extern struct bfd_elf_dynamic_list
**current_dynamic_list_p
;
521 extern int lang_statement_iteration
;
522 extern struct asneeded_minfo
**asneeded_list_tail
;
524 extern void (*output_bfd_hash_table_free_fn
) (struct bfd_link_hash_table
*);
526 extern void lang_init
528 extern void lang_finish
530 extern lang_memory_region_type
* lang_memory_region_lookup
531 (const char * const, bfd_boolean
);
532 extern void lang_memory_region_alias
533 (const char *, const char *);
536 extern void lang_set_flags
537 (lang_memory_region_type
*, const char *, int);
538 extern void lang_add_output
539 (const char *, int from_script
);
540 extern lang_output_section_statement_type
*lang_enter_output_section_statement
541 (const char *, etree_type
*, enum section_type
, etree_type
*, etree_type
*,
542 etree_type
*, int, int);
543 extern void lang_final
545 extern void lang_relax_sections
547 extern void lang_process
549 extern void lang_section_start
550 (const char *, union etree_union
*, const segment_type
*);
551 extern void lang_add_entry
552 (const char *, bfd_boolean
);
553 extern void lang_default_entry
555 extern void lang_add_target
557 extern void lang_add_wild
558 (struct wildcard_spec
*, struct wildcard_list
*, bfd_boolean
);
559 extern void lang_add_map
561 extern void lang_add_fill
563 extern lang_assignment_statement_type
*lang_add_assignment
564 (union etree_union
*);
565 extern void lang_add_attribute
566 (enum statement_enum
);
567 extern void lang_startup
569 extern void lang_float
571 extern void lang_leave_output_section_statement
572 (fill_type
*, const char *, lang_output_section_phdr_list
*,
574 extern void lang_for_each_input_file
575 (void (*dothis
) (lang_input_statement_type
*));
576 extern void lang_for_each_file
577 (void (*dothis
) (lang_input_statement_type
*));
578 extern void lang_reset_memory_regions
580 extern void lang_do_assignments
582 extern asection
*section_for_dot
585 #define LANG_FOR_EACH_INPUT_STATEMENT(statement) \
586 lang_input_statement_type *statement; \
587 for (statement = (lang_input_statement_type *) file_chain.head; \
589 statement = statement->next)
591 #define lang_output_section_find(NAME) \
592 lang_output_section_statement_lookup (NAME, 0, 0)
594 extern void lang_process
596 extern void ldlang_add_file
597 (lang_input_statement_type
*);
598 extern lang_output_section_statement_type
*lang_output_section_find_by_flags
599 (const asection
*, flagword
, lang_output_section_statement_type
**,
600 lang_match_sec_type_func
);
601 extern lang_output_section_statement_type
*lang_insert_orphan
602 (asection
*, const char *, int, lang_output_section_statement_type
*,
603 struct orphan_save
*, etree_type
*, lang_statement_list_type
*);
604 extern lang_input_statement_type
*lang_add_input_file
605 (const char *, lang_input_file_enum_type
, const char *);
606 extern void lang_add_keepsyms_file
608 extern lang_output_section_statement_type
*lang_output_section_get
610 extern lang_output_section_statement_type
*lang_output_section_statement_lookup
611 (const char *, int, int);
612 extern lang_output_section_statement_type
*next_matching_output_section_statement
613 (lang_output_section_statement_type
*, int);
614 extern void ldlang_add_undef
615 (const char *const, bfd_boolean
);
616 extern void ldlang_add_require_defined
618 extern void lang_add_output_format
619 (const char *, const char *, const char *, int);
620 extern void lang_list_init
621 (lang_statement_list_type
*);
622 extern void push_stat_ptr
623 (lang_statement_list_type
*);
624 extern void pop_stat_ptr
626 extern void lang_add_data
627 (int type
, union etree_union
*);
628 extern void lang_add_reloc
629 (bfd_reloc_code_real_type
, reloc_howto_type
*, asection
*, const char *,
630 union etree_union
*);
631 extern void lang_for_each_statement
632 (void (*) (lang_statement_union_type
*));
633 extern void lang_for_each_statement_worker
634 (void (*) (lang_statement_union_type
*), lang_statement_union_type
*);
635 extern void *stat_alloc
637 extern void strip_excluded_output_sections
639 extern void lang_clear_os_map
641 extern void dprint_statement
642 (lang_statement_union_type
*, int);
643 extern void lang_size_sections
644 (bfd_boolean
*, bfd_boolean
);
645 extern void one_lang_size_sections_pass
646 (bfd_boolean
*, bfd_boolean
);
647 extern void lang_add_insert
649 extern void lang_enter_group
651 extern void lang_leave_group
653 extern void lang_add_section
654 (lang_statement_list_type
*, asection
*,
655 struct flag_info
*, lang_output_section_statement_type
*);
656 extern void lang_new_phdr
657 (const char *, etree_type
*, bfd_boolean
, bfd_boolean
, etree_type
*,
659 extern void lang_add_nocrossref
660 (lang_nocrossref_type
*);
661 extern void lang_add_nocrossref_to
662 (lang_nocrossref_type
*);
663 extern void lang_enter_overlay
664 (etree_type
*, etree_type
*);
665 extern void lang_enter_overlay_section
667 extern void lang_leave_overlay_section
668 (fill_type
*, lang_output_section_phdr_list
*);
669 extern void lang_leave_overlay
670 (etree_type
*, int, fill_type
*, const char *,
671 lang_output_section_phdr_list
*, const char *);
673 extern struct bfd_elf_version_expr
*lang_new_vers_pattern
674 (struct bfd_elf_version_expr
*, const char *, const char *, bfd_boolean
);
675 extern struct bfd_elf_version_tree
*lang_new_vers_node
676 (struct bfd_elf_version_expr
*, struct bfd_elf_version_expr
*);
677 extern struct bfd_elf_version_deps
*lang_add_vers_depend
678 (struct bfd_elf_version_deps
*, const char *);
679 extern void lang_register_vers_node
680 (const char *, struct bfd_elf_version_tree
*, struct bfd_elf_version_deps
*);
681 extern void lang_append_dynamic_list (struct bfd_elf_dynamic_list
**,
682 struct bfd_elf_version_expr
*);
683 extern void lang_append_dynamic_list_cpp_typeinfo (void);
684 extern void lang_append_dynamic_list_cpp_new (void);
685 extern void lang_add_unique
687 extern const char *lang_get_output_target
689 extern void add_excluded_libs (const char *);
690 extern bfd_boolean load_symbols
691 (lang_input_statement_type
*, lang_statement_list_type
*);
693 struct elf_sym_strtab
;
694 struct elf_strtab_hash
;
695 extern void ldlang_ctf_acquire_strings
696 (struct elf_strtab_hash
*);
697 extern void ldlang_ctf_new_dynsym
698 (int symidx
, struct elf_internal_sym
*);
699 extern void ldlang_write_ctf_late
702 ldlang_override_segment_assignment
703 (struct bfd_link_info
*, bfd
*, asection
*, asection
*, bfd_boolean
);
706 lang_ld_feature (char *);
709 lang_print_memory_usage (void);
712 lang_add_gc_name (const char *);
715 print_one_symbol (struct bfd_link_hash_entry
*hash_entry
, void *ptr
);