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 /* Used by ELF SHF_LINK_ORDER sorting. */
164 unsigned int block_value
;
167 enum section_type sectype
;
168 unsigned int processed_vma
: 1;
169 unsigned int processed_lma
: 1;
170 unsigned int all_input_readonly
: 1;
171 /* If this section should be ignored. */
172 unsigned int ignored
: 1;
173 /* If this section should update "dot". Prevents section being ignored. */
174 unsigned int update_dot
: 1;
175 /* If this section is after assignment to _end. */
176 unsigned int after_end
: 1;
177 /* If this section uses the alignment of its input sections. */
178 unsigned int align_lma_with_input
: 1;
179 /* If script has duplicate output section statements of the same name
180 create duplicate output sections. */
181 unsigned int dup_output
: 1;
182 } lang_output_section_statement_type
;
186 lang_statement_header_type header
;
189 asection
*output_section
;
190 } lang_fill_statement_type
;
194 lang_statement_header_type header
;
196 union etree_union
*exp
;
198 asection
*output_section
;
199 bfd_vma output_offset
;
200 } lang_data_statement_type
;
202 /* Generate a reloc in the output file. */
206 lang_statement_header_type header
;
208 /* Reloc to generate. */
209 bfd_reloc_code_real_type reloc
;
211 /* Reloc howto structure. */
212 reloc_howto_type
*howto
;
214 /* Section to generate reloc against.
215 Exactly one of section and name must be NULL. */
218 /* Name of symbol to generate reloc against.
219 Exactly one of section and name must be NULL. */
222 /* Expression for addend. */
223 union etree_union
*addend_exp
;
225 /* Resolved addend. */
226 bfd_vma addend_value
;
228 /* Output section where reloc should be performed. */
229 asection
*output_section
;
231 /* Offset within output section. */
232 bfd_vma output_offset
;
233 } lang_reloc_statement_type
;
235 struct lang_input_statement_flags
237 /* 1 means this file was specified in a -l option. */
238 unsigned int maybe_archive
: 1;
240 /* 1 means this file was specified in a -l:namespec option. */
241 unsigned int full_name_provided
: 1;
243 /* 1 means search a set of directories for this file. */
244 unsigned int search_dirs
: 1;
246 /* 1 means this was found when processing a script in the sysroot. */
247 unsigned int sysrooted
: 1;
249 /* 1 means this is base file of incremental load.
250 Do not load this file's text or data.
251 Also default text_start to after this file's bss. */
252 unsigned int just_syms
: 1;
254 /* Whether to search for this entry as a dynamic archive. */
255 unsigned int dynamic
: 1;
257 /* Set if a DT_NEEDED tag should be added not just for the dynamic library
258 explicitly given by this entry but also for any dynamic libraries in
259 this entry's needed list. */
260 unsigned int add_DT_NEEDED_for_dynamic
: 1;
262 /* Set if this entry should cause a DT_NEEDED tag only when some
263 regular file references its symbols (ie. --as-needed is in effect). */
264 unsigned int add_DT_NEEDED_for_regular
: 1;
266 /* Whether to include the entire contents of an archive. */
267 unsigned int whole_archive
: 1;
269 /* Set when bfd opening is successful. */
270 unsigned int loaded
: 1;
272 unsigned int real
: 1;
274 /* Set if the file does not exist. */
275 unsigned int missing_file
: 1;
277 /* Set if reloading an archive or --as-needed lib. */
278 unsigned int reload
: 1;
280 #if BFD_SUPPORTS_PLUGINS
281 /* Set if the file was claimed by a plugin. */
282 unsigned int claimed
: 1;
284 /* Set if the file was claimed from an archive. */
285 unsigned int claim_archive
: 1;
287 /* Set if added by the lto plugin add_input_file callback. */
288 unsigned int lto_output
: 1;
289 #endif /* BFD_SUPPORTS_PLUGINS */
291 /* Head of list of pushed flags. */
292 struct lang_input_statement_flags
*pushed
;
295 typedef struct lang_input_statement_struct
297 lang_statement_header_type header
;
298 /* Name of this file. */
299 const char *filename
;
300 /* Name to use for the symbol giving address of text start.
301 Usually the same as filename, but for a file spec'd with
302 -l this is the -l switch itself rather than the filename. */
303 const char *local_sym_name
;
304 /* Extra search path. Used to find a file relative to the
305 directory of the current linker script. */
306 const char *extra_search_path
;
310 ctf_archive_t
*the_ctf
;
312 struct flag_info
*section_flag_list
;
314 /* Next pointer for file_chain statement list. */
315 struct lang_input_statement_struct
*next
;
317 /* Next pointer for input_file_chain statement list. */
318 struct lang_input_statement_struct
*next_real_file
;
322 struct lang_input_statement_flags flags
;
323 } lang_input_statement_type
;
327 lang_statement_header_type header
;
330 } lang_input_section_type
;
332 struct map_symbol_def
{
333 struct bfd_link_hash_entry
*entry
;
334 struct map_symbol_def
*next
;
337 /* For input sections, when writing a map file: head / tail of a linked
338 list of hash table entries for symbols defined in this section. */
339 typedef struct input_section_userdata_struct
341 struct map_symbol_def
*map_symbol_def_head
;
342 struct map_symbol_def
**map_symbol_def_tail
;
343 unsigned long map_symbol_def_count
;
344 } input_section_userdata_type
;
346 static inline bfd_boolean
347 bfd_input_just_syms (const bfd
*abfd
)
349 lang_input_statement_type
*is
= bfd_usrdata (abfd
);
350 return is
!= NULL
&& is
->flags
.just_syms
;
353 typedef struct lang_wild_statement_struct lang_wild_statement_type
;
355 typedef void (*callback_t
) (lang_wild_statement_type
*, struct wildcard_list
*,
356 asection
*, lang_input_statement_type
*, void *);
358 typedef void (*walk_wild_section_handler_t
) (lang_wild_statement_type
*,
359 lang_input_statement_type
*,
363 typedef bfd_boolean (*lang_match_sec_type_func
) (bfd
*, const asection
*,
364 bfd
*, const asection
*);
366 /* Binary search tree structure to efficiently sort sections by
368 typedef struct lang_section_bst
372 struct lang_section_bst
*left
;
373 struct lang_section_bst
*right
;
374 } lang_section_bst_type
;
376 struct lang_wild_statement_struct
378 lang_statement_header_type header
;
379 const char *filename
;
380 bfd_boolean filenames_sorted
;
381 struct wildcard_list
*section_list
;
382 bfd_boolean keep_sections
;
383 lang_statement_list_type children
;
384 struct name_list
*exclude_name_list
;
386 walk_wild_section_handler_t walk_wild_section_handler
;
387 struct wildcard_list
*handler_data
[4];
388 lang_section_bst_type
*tree
;
389 struct flag_info
*section_flag_list
;
392 typedef struct lang_address_statement_struct
394 lang_statement_header_type header
;
395 const char *section_name
;
396 union etree_union
*address
;
397 const segment_type
*segment
;
398 } lang_address_statement_type
;
402 lang_statement_header_type header
;
403 bfd_vma output_offset
;
405 asection
*output_section
;
407 } lang_padding_statement_type
;
409 /* A group statement collects a set of libraries together. The
410 libraries are searched multiple times, until no new undefined
411 symbols are found. The effect is to search a group of libraries as
412 though they were a single library. */
416 lang_statement_header_type header
;
417 lang_statement_list_type children
;
418 } lang_group_statement_type
;
422 lang_statement_header_type header
;
424 bfd_boolean is_before
;
425 } lang_insert_statement_type
;
427 typedef union lang_statement_union
429 lang_statement_header_type header
;
430 lang_address_statement_type address_statement
;
431 lang_assignment_statement_type assignment_statement
;
432 lang_data_statement_type data_statement
;
433 lang_fill_statement_type fill_statement
;
434 lang_group_statement_type group_statement
;
435 lang_input_section_type input_section
;
436 lang_input_statement_type input_statement
;
437 lang_insert_statement_type insert_statement
;
438 lang_output_section_statement_type output_section_statement
;
439 lang_output_statement_type output_statement
;
440 lang_padding_statement_type padding_statement
;
441 lang_reloc_statement_type reloc_statement
;
442 lang_target_statement_type target_statement
;
443 lang_wild_statement_type wild_statement
;
444 } lang_statement_union_type
;
446 /* This structure holds information about a program header, from the
447 PHDRS command in the linker script. */
451 struct lang_phdr
*next
;
460 /* This structure is used to hold a list of sections which may not
461 cross reference each other. */
463 typedef struct lang_nocrossref
465 struct lang_nocrossref
*next
;
467 } lang_nocrossref_type
;
469 /* The list of nocrossref lists. */
471 struct lang_nocrossrefs
473 struct lang_nocrossrefs
*next
;
474 lang_nocrossref_type
*list
;
475 bfd_boolean onlyfirst
;
478 /* This structure is used to hold a list of input section names which
479 will not match an output section in the linker script. */
481 struct unique_sections
483 struct unique_sections
*next
;
487 /* Used by place_orphan to keep track of orphan sections and statements. */
493 lang_output_section_statement_type
*os
;
495 lang_statement_union_type
**stmt
;
496 lang_output_section_statement_type
**os_tail
;
499 struct asneeded_minfo
501 struct asneeded_minfo
*next
;
507 extern struct lang_phdr
*lang_phdr_list
;
508 extern struct lang_nocrossrefs
*nocrossref_list
;
509 extern const char *output_target
;
510 extern lang_output_section_statement_type
*abs_output_section
;
511 extern lang_statement_list_type lang_os_list
;
512 extern struct lang_input_statement_flags input_flags
;
513 extern bfd_boolean lang_has_input_file
;
514 extern lang_statement_list_type statement_list
;
515 extern lang_statement_list_type
*stat_ptr
;
516 extern bfd_boolean delete_output_file_on_failure
;
518 extern struct bfd_sym_chain entry_symbol
;
519 extern const char *entry_section
;
520 extern bfd_boolean entry_from_cmdline
;
521 extern lang_statement_list_type file_chain
;
522 extern lang_statement_list_type input_file_chain
;
524 extern struct bfd_elf_dynamic_list
**current_dynamic_list_p
;
526 extern int lang_statement_iteration
;
527 extern struct asneeded_minfo
**asneeded_list_tail
;
529 extern void (*output_bfd_hash_table_free_fn
) (struct bfd_link_hash_table
*);
531 extern void lang_init
533 extern void lang_finish
535 extern lang_memory_region_type
* lang_memory_region_lookup
536 (const char * const, bfd_boolean
);
537 extern void lang_memory_region_alias
538 (const char *, const char *);
541 extern void lang_set_flags
542 (lang_memory_region_type
*, const char *, int);
543 extern void lang_add_output
544 (const char *, int from_script
);
545 extern lang_output_section_statement_type
*lang_enter_output_section_statement
546 (const char *, etree_type
*, enum section_type
, etree_type
*, etree_type
*,
547 etree_type
*, int, int);
548 extern void lang_final
550 extern void lang_relax_sections
552 extern void lang_process
554 extern void lang_section_start
555 (const char *, union etree_union
*, const segment_type
*);
556 extern void lang_add_entry
557 (const char *, bfd_boolean
);
558 extern void lang_default_entry
560 extern void lang_add_target
562 extern void lang_add_wild
563 (struct wildcard_spec
*, struct wildcard_list
*, bfd_boolean
);
564 extern void lang_add_map
566 extern void lang_add_fill
568 extern lang_assignment_statement_type
*lang_add_assignment
569 (union etree_union
*);
570 extern void lang_add_attribute
571 (enum statement_enum
);
572 extern void lang_startup
574 extern void lang_float
576 extern void lang_leave_output_section_statement
577 (fill_type
*, const char *, lang_output_section_phdr_list
*,
579 extern void lang_for_each_input_file
580 (void (*dothis
) (lang_input_statement_type
*));
581 extern void lang_for_each_file
582 (void (*dothis
) (lang_input_statement_type
*));
583 extern void lang_reset_memory_regions
585 extern void lang_do_assignments
587 extern asection
*section_for_dot
590 #define LANG_FOR_EACH_INPUT_STATEMENT(statement) \
591 lang_input_statement_type *statement; \
592 for (statement = (lang_input_statement_type *) file_chain.head; \
594 statement = statement->next)
596 #define lang_output_section_find(NAME) \
597 lang_output_section_statement_lookup (NAME, 0, 0)
599 extern void lang_process
601 extern void ldlang_add_file
602 (lang_input_statement_type
*);
603 extern lang_output_section_statement_type
*lang_output_section_find_by_flags
604 (const asection
*, flagword
, lang_output_section_statement_type
**,
605 lang_match_sec_type_func
);
606 extern lang_output_section_statement_type
*lang_insert_orphan
607 (asection
*, const char *, int, lang_output_section_statement_type
*,
608 struct orphan_save
*, etree_type
*, lang_statement_list_type
*);
609 extern lang_input_statement_type
*lang_add_input_file
610 (const char *, lang_input_file_enum_type
, const char *);
611 extern void lang_add_keepsyms_file
613 extern lang_output_section_statement_type
*lang_output_section_get
615 extern lang_output_section_statement_type
*lang_output_section_statement_lookup
616 (const char *, int, int);
617 extern lang_output_section_statement_type
*next_matching_output_section_statement
618 (lang_output_section_statement_type
*, int);
619 extern void ldlang_add_undef
620 (const char *const, bfd_boolean
);
621 extern void ldlang_add_require_defined
623 extern void lang_add_output_format
624 (const char *, const char *, const char *, int);
625 extern void lang_list_init
626 (lang_statement_list_type
*);
627 extern void push_stat_ptr
628 (lang_statement_list_type
*);
629 extern void pop_stat_ptr
631 extern void lang_add_data
632 (int type
, union etree_union
*);
633 extern void lang_add_reloc
634 (bfd_reloc_code_real_type
, reloc_howto_type
*, asection
*, const char *,
635 union etree_union
*);
636 extern void lang_for_each_statement
637 (void (*) (lang_statement_union_type
*));
638 extern void lang_for_each_statement_worker
639 (void (*) (lang_statement_union_type
*), lang_statement_union_type
*);
640 extern void *stat_alloc
642 extern void strip_excluded_output_sections
644 extern void lang_clear_os_map
646 extern void dprint_statement
647 (lang_statement_union_type
*, int);
648 extern void lang_size_sections
649 (bfd_boolean
*, bfd_boolean
);
650 extern void one_lang_size_sections_pass
651 (bfd_boolean
*, bfd_boolean
);
652 extern void lang_add_insert
654 extern void lang_enter_group
656 extern void lang_leave_group
658 extern void lang_add_section
659 (lang_statement_list_type
*, asection
*, struct wildcard_list
*,
660 struct flag_info
*, lang_output_section_statement_type
*);
661 extern void lang_new_phdr
662 (const char *, etree_type
*, bfd_boolean
, bfd_boolean
, etree_type
*,
664 extern void lang_add_nocrossref
665 (lang_nocrossref_type
*);
666 extern void lang_add_nocrossref_to
667 (lang_nocrossref_type
*);
668 extern void lang_enter_overlay
669 (etree_type
*, etree_type
*);
670 extern void lang_enter_overlay_section
672 extern void lang_leave_overlay_section
673 (fill_type
*, lang_output_section_phdr_list
*);
674 extern void lang_leave_overlay
675 (etree_type
*, int, fill_type
*, const char *,
676 lang_output_section_phdr_list
*, const char *);
678 extern struct bfd_elf_version_expr
*lang_new_vers_pattern
679 (struct bfd_elf_version_expr
*, const char *, const char *, bfd_boolean
);
680 extern struct bfd_elf_version_tree
*lang_new_vers_node
681 (struct bfd_elf_version_expr
*, struct bfd_elf_version_expr
*);
682 extern struct bfd_elf_version_deps
*lang_add_vers_depend
683 (struct bfd_elf_version_deps
*, const char *);
684 extern void lang_register_vers_node
685 (const char *, struct bfd_elf_version_tree
*, struct bfd_elf_version_deps
*);
686 extern void lang_append_dynamic_list (struct bfd_elf_dynamic_list
**,
687 struct bfd_elf_version_expr
*);
688 extern void lang_append_dynamic_list_cpp_typeinfo (void);
689 extern void lang_append_dynamic_list_cpp_new (void);
690 extern void lang_add_unique
692 extern const char *lang_get_output_target
694 extern void add_excluded_libs (const char *);
695 extern bfd_boolean load_symbols
696 (lang_input_statement_type
*, lang_statement_list_type
*);
698 struct elf_sym_strtab
;
699 struct elf_strtab_hash
;
700 extern void ldlang_ctf_acquire_strings
701 (struct elf_strtab_hash
*);
702 extern void ldlang_ctf_new_dynsym
703 (int symidx
, struct elf_internal_sym
*);
704 extern void ldlang_write_ctf_late
707 ldlang_override_segment_assignment
708 (struct bfd_link_info
*, bfd
*, asection
*, asection
*, bfd_boolean
);
711 lang_ld_feature (char *);
714 lang_print_memory_usage (void);
717 lang_add_gc_name (const char *);
720 print_one_symbol (struct bfd_link_hash_entry
*hash_entry
, void *ptr
);