1 /* ldlang.h - linker command language support
2 Copyright (C) 1991-2019 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*"
28 lang_input_file_is_l_enum,
29 lang_input_file_is_symbols_only_enum,
30 lang_input_file_is_marker_enum,
31 lang_input_file_is_fake_enum,
32 lang_input_file_is_search_file_enum,
33 lang_input_file_is_file_enum
34 } lang_input_file_enum_type;
39 unsigned char data[1];
42 typedef struct statement_list
44 union lang_statement_union * head;
45 union lang_statement_union ** tail;
46 } lang_statement_list_type;
48 typedef struct memory_region_name_struct
51 struct memory_region_name_struct * next;
52 } lang_memory_region_name;
54 typedef struct memory_region_struct
56 lang_memory_region_name name_list;
57 struct memory_region_struct *next;
58 union etree_union *origin_exp;
61 union etree_union *length_exp;
63 union lang_statement_union *last_os;
66 bfd_boolean had_full_message;
67 } lang_memory_region_type;
71 lang_output_section_statement_enum,
72 lang_assignment_statement_enum,
73 lang_input_statement_enum,
74 lang_address_statement_enum,
75 lang_wild_statement_enum,
76 lang_input_section_enum,
77 lang_object_symbols_statement_enum,
78 lang_fill_statement_enum,
79 lang_data_statement_enum,
80 lang_reloc_statement_enum,
81 lang_target_statement_enum,
82 lang_output_statement_enum,
83 lang_padding_statement_enum,
84 lang_group_statement_enum,
85 lang_insert_statement_enum,
86 lang_constructors_statement_enum
89 typedef struct lang_statement_header_struct
91 /* Next pointer for statement_list statement list. */
92 union lang_statement_union *next;
93 enum statement_enum type;
94 } lang_statement_header_type;
98 lang_statement_header_type header;
99 union etree_union *exp;
100 } lang_assignment_statement_type;
102 typedef struct lang_target_statement_struct
104 lang_statement_header_type header;
106 } lang_target_statement_type;
108 typedef struct lang_output_statement_struct
110 lang_statement_header_type header;
112 } lang_output_statement_type;
114 /* Section types specified in a linker script. */
119 first_overlay_section,
125 /* This structure holds a list of program headers describing
126 segments in which this section should be placed. */
128 typedef struct lang_output_section_phdr_list
130 struct lang_output_section_phdr_list *next;
133 } lang_output_section_phdr_list;
135 typedef struct lang_output_section_statement_struct
137 lang_statement_header_type header;
138 lang_statement_list_type children;
139 struct lang_output_section_statement_struct *next;
140 struct lang_output_section_statement_struct *prev;
142 asection *bfd_section;
143 lang_memory_region_type *region;
144 lang_memory_region_type *lma_region;
146 union etree_union *addr_tree;
147 union etree_union *load_base;
148 union etree_union *section_alignment;
149 union etree_union *subsection_alignment;
151 /* If non-null, an expression to evaluate after setting the section's
152 size. The expression is evaluated inside REGION (above) with '.'
153 set to the end of the section. Used in the last overlay section
154 to move '.' past all the overlaid sections. */
155 union etree_union *update_dot_tree;
157 lang_output_section_phdr_list *phdrs;
159 unsigned int block_value;
162 enum section_type sectype;
163 unsigned int processed_vma : 1;
164 unsigned int processed_lma : 1;
165 unsigned int all_input_readonly : 1;
166 /* If this section should be ignored. */
167 unsigned int ignored : 1;
168 /* If this section should update "dot". Prevents section being ignored. */
169 unsigned int update_dot : 1;
170 /* If this section is after assignment to _end. */
171 unsigned int after_end : 1;
172 /* If this section uses the alignment of its input sections. */
173 unsigned int align_lma_with_input : 1;
174 } lang_output_section_statement_type;
178 lang_statement_header_type header;
179 } lang_common_statement_type;
183 lang_statement_header_type header;
184 } lang_object_symbols_statement_type;
188 lang_statement_header_type header;
191 asection *output_section;
192 } lang_fill_statement_type;
196 lang_statement_header_type header;
198 union etree_union *exp;
200 asection *output_section;
201 bfd_vma output_offset;
202 } lang_data_statement_type;
204 /* Generate a reloc in the output file. */
208 lang_statement_header_type header;
210 /* Reloc to generate. */
211 bfd_reloc_code_real_type reloc;
213 /* Reloc howto structure. */
214 reloc_howto_type *howto;
216 /* Section to generate reloc against.
217 Exactly one of section and name must be NULL. */
220 /* Name of symbol to generate reloc against.
221 Exactly one of section and name must be NULL. */
224 /* Expression for addend. */
225 union etree_union *addend_exp;
227 /* Resolved addend. */
228 bfd_vma addend_value;
230 /* Output section where reloc should be performed. */
231 asection *output_section;
233 /* Offset within output section. */
234 bfd_vma output_offset;
235 } lang_reloc_statement_type;
237 struct lang_input_statement_flags
239 /* 1 means this file was specified in a -l option. */
240 unsigned int maybe_archive : 1;
242 /* 1 means this file was specified in a -l:namespec option. */
243 unsigned int full_name_provided : 1;
245 /* 1 means search a set of directories for this file. */
246 unsigned int search_dirs : 1;
248 /* 1 means this was found when processing a script in the sysroot. */
249 unsigned int sysrooted : 1;
251 /* 1 means this is base file of incremental load.
252 Do not load this file's text or data.
253 Also default text_start to after this file's bss. */
254 unsigned int just_syms : 1;
256 /* Whether to search for this entry as a dynamic archive. */
257 unsigned int dynamic : 1;
259 /* Set if a DT_NEEDED tag should be added not just for the dynamic library
260 explicitly given by this entry but also for any dynamic libraries in
261 this entry's needed list. */
262 unsigned int add_DT_NEEDED_for_dynamic : 1;
264 /* Set if this entry should cause a DT_NEEDED tag only when some
265 regular file references its symbols (ie. --as-needed is in effect). */
266 unsigned int add_DT_NEEDED_for_regular : 1;
268 /* Whether to include the entire contents of an archive. */
269 unsigned int whole_archive : 1;
271 /* Set when bfd opening is successful. */
272 unsigned int loaded : 1;
274 unsigned int real : 1;
276 /* Set if the file does not exist. */
277 unsigned int missing_file : 1;
279 /* Set if reloading an archive or --as-needed lib. */
280 unsigned int reload : 1;
282 #ifdef ENABLE_PLUGINS
283 /* Set if the file was claimed by a plugin. */
284 unsigned int claimed : 1;
286 /* Set if the file was claimed from an archive. */
287 unsigned int claim_archive : 1;
289 /* Set if added by the lto plugin add_input_file callback. */
290 unsigned int lto_output : 1;
291 #endif /* ENABLE_PLUGINS */
293 /* Head of list of pushed flags. */
294 struct lang_input_statement_flags *pushed;
297 typedef struct lang_input_statement_struct
299 lang_statement_header_type header;
300 /* Name of this file. */
301 const char *filename;
302 /* Name to use for the symbol giving address of text start.
303 Usually the same as filename, but for a file spec'd with
304 -l this is the -l switch itself rather than the filename. */
305 const char *local_sym_name;
309 struct flag_info *section_flag_list;
311 /* Next pointer for file_chain statement list. */
312 union lang_statement_union *next;
314 /* Next pointer for input_file_chain statement list. */
315 union lang_statement_union *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 #define get_userdata(x) ((x)->userdata)
345 typedef struct lang_wild_statement_struct lang_wild_statement_type;
347 typedef void (*callback_t) (lang_wild_statement_type *, struct wildcard_list *,
348 asection *, struct flag_info *,
349 lang_input_statement_type *, void *);
351 typedef void (*walk_wild_section_handler_t) (lang_wild_statement_type *,
352 lang_input_statement_type *,
356 typedef bfd_boolean (*lang_match_sec_type_func) (bfd *, const asection *,
357 bfd *, const asection *);
359 /* Binary search tree structure to efficiently sort sections by
361 typedef struct lang_section_bst
364 struct lang_section_bst *left;
365 struct lang_section_bst *right;
366 } lang_section_bst_type;
368 struct lang_wild_statement_struct
370 lang_statement_header_type header;
371 const char *filename;
372 bfd_boolean filenames_sorted;
373 struct wildcard_list *section_list;
374 bfd_boolean keep_sections;
375 lang_statement_list_type children;
376 struct name_list *exclude_name_list;
378 walk_wild_section_handler_t walk_wild_section_handler;
379 struct wildcard_list *handler_data[4];
380 lang_section_bst_type *tree;
381 struct flag_info *section_flag_list;
384 typedef struct lang_address_statement_struct
386 lang_statement_header_type header;
387 const char *section_name;
388 union etree_union *address;
389 const segment_type *segment;
390 } lang_address_statement_type;
394 lang_statement_header_type header;
395 bfd_vma output_offset;
397 asection *output_section;
399 } lang_padding_statement_type;
401 /* A group statement collects a set of libraries together. The
402 libraries are searched multiple times, until no new undefined
403 symbols are found. The effect is to search a group of libraries as
404 though they were a single library. */
408 lang_statement_header_type header;
409 lang_statement_list_type children;
410 } lang_group_statement_type;
414 lang_statement_header_type header;
416 bfd_boolean is_before;
417 } lang_insert_statement_type;
419 typedef union lang_statement_union
421 lang_statement_header_type header;
422 lang_wild_statement_type wild_statement;
423 lang_data_statement_type data_statement;
424 lang_reloc_statement_type reloc_statement;
425 lang_address_statement_type address_statement;
426 lang_output_section_statement_type output_section_statement;
427 lang_assignment_statement_type assignment_statement;
428 lang_input_statement_type input_statement;
429 lang_target_statement_type target_statement;
430 lang_output_statement_type output_statement;
431 lang_input_section_type input_section;
432 lang_common_statement_type common_statement;
433 lang_object_symbols_statement_type object_symbols_statement;
434 lang_fill_statement_type fill_statement;
435 lang_padding_statement_type padding_statement;
436 lang_group_statement_type group_statement;
437 lang_insert_statement_type insert_statement;
438 } lang_statement_union_type;
440 /* This structure holds information about a program header, from the
441 PHDRS command in the linker script. */
445 struct lang_phdr *next;
454 /* This structure is used to hold a list of sections which may not
455 cross reference each other. */
457 typedef struct lang_nocrossref
459 struct lang_nocrossref *next;
461 } lang_nocrossref_type;
463 /* The list of nocrossref lists. */
465 struct lang_nocrossrefs
467 struct lang_nocrossrefs *next;
468 lang_nocrossref_type *list;
469 bfd_boolean onlyfirst;
472 /* This structure is used to hold a list of input section names which
473 will not match an output section in the linker script. */
475 struct unique_sections
477 struct unique_sections *next;
481 /* Used by place_orphan to keep track of orphan sections and statements. */
487 lang_output_section_statement_type *os;
489 lang_statement_union_type **stmt;
490 lang_output_section_statement_type **os_tail;
493 struct asneeded_minfo
495 struct asneeded_minfo *next;
501 extern struct lang_phdr *lang_phdr_list;
502 extern struct lang_nocrossrefs *nocrossref_list;
503 extern const char *output_target;
504 extern lang_output_section_statement_type *abs_output_section;
505 extern lang_statement_list_type lang_output_section_statement;
506 extern struct lang_input_statement_flags input_flags;
507 extern bfd_boolean lang_has_input_file;
508 extern lang_statement_list_type *stat_ptr;
509 extern bfd_boolean delete_output_file_on_failure;
511 extern struct bfd_sym_chain entry_symbol;
512 extern const char *entry_section;
513 extern bfd_boolean entry_from_cmdline;
514 extern lang_statement_list_type file_chain;
515 extern lang_statement_list_type input_file_chain;
517 extern int lang_statement_iteration;
518 extern struct asneeded_minfo **asneeded_list_tail;
520 extern void (*output_bfd_hash_table_free_fn) (struct bfd_link_hash_table *);
522 extern void lang_init
524 extern void lang_finish
526 extern lang_memory_region_type * lang_memory_region_lookup
527 (const char * const, bfd_boolean);
528 extern void lang_memory_region_alias
529 (const char *, const char *);
532 extern void lang_set_flags
533 (lang_memory_region_type *, const char *, int);
534 extern void lang_add_output
535 (const char *, int from_script);
536 extern lang_output_section_statement_type *lang_enter_output_section_statement
537 (const char *, etree_type *, enum section_type, etree_type *, etree_type *,
538 etree_type *, int, int);
539 extern void lang_final
541 extern void lang_relax_sections
543 extern void lang_process
545 extern void lang_section_start
546 (const char *, union etree_union *, const segment_type *);
547 extern void lang_add_entry
548 (const char *, bfd_boolean);
549 extern void lang_default_entry
551 extern void lang_add_target
553 extern void lang_add_wild
554 (struct wildcard_spec *, struct wildcard_list *, bfd_boolean);
555 extern void lang_add_map
557 extern void lang_add_fill
559 extern lang_assignment_statement_type *lang_add_assignment
560 (union etree_union *);
561 extern void lang_add_attribute
562 (enum statement_enum);
563 extern void lang_startup
565 extern void lang_float
567 extern void lang_leave_output_section_statement
568 (fill_type *, const char *, lang_output_section_phdr_list *,
570 extern void lang_statement_append
571 (lang_statement_list_type *, lang_statement_union_type *,
572 lang_statement_union_type **);
573 extern void lang_for_each_input_file
574 (void (*dothis) (lang_input_statement_type *));
575 extern void lang_for_each_file
576 (void (*dothis) (lang_input_statement_type *));
577 extern void lang_reset_memory_regions
579 extern void lang_do_assignments
581 extern asection *section_for_dot
584 #define LANG_FOR_EACH_INPUT_STATEMENT(statement) \
585 lang_input_statement_type *statement; \
586 for (statement = &file_chain.head->input_statement; \
588 statement = &statement->next->input_statement)
590 #define lang_output_section_find(NAME) \
591 lang_output_section_statement_lookup (NAME, 0, FALSE)
593 extern void lang_process
595 extern void ldlang_add_file
596 (lang_input_statement_type *);
597 extern lang_output_section_statement_type *lang_output_section_find_by_flags
598 (const asection *, flagword, lang_output_section_statement_type **,
599 lang_match_sec_type_func);
600 extern lang_output_section_statement_type *lang_insert_orphan
601 (asection *, const char *, int, lang_output_section_statement_type *,
602 struct orphan_save *, etree_type *, lang_statement_list_type *);
603 extern lang_input_statement_type *lang_add_input_file
604 (const char *, lang_input_file_enum_type, const char *);
605 extern void lang_add_keepsyms_file
607 extern lang_output_section_statement_type *lang_output_section_get
609 extern lang_output_section_statement_type *lang_output_section_statement_lookup
610 (const char *, int, bfd_boolean);
611 extern lang_output_section_statement_type *next_matching_output_section_statement
612 (lang_output_section_statement_type *, int);
613 extern void ldlang_add_undef
614 (const char *const, bfd_boolean);
615 extern void ldlang_add_require_defined
617 extern void lang_add_output_format
618 (const char *, const char *, const char *, int);
619 extern void lang_list_init
620 (lang_statement_list_type *);
621 extern void push_stat_ptr
622 (lang_statement_list_type *);
623 extern void pop_stat_ptr
625 extern void lang_add_data
626 (int type, union etree_union *);
627 extern void lang_add_reloc
628 (bfd_reloc_code_real_type, reloc_howto_type *, asection *, const char *,
629 union etree_union *);
630 extern void lang_for_each_statement
631 (void (*) (lang_statement_union_type *));
632 extern void lang_for_each_statement_worker
633 (void (*) (lang_statement_union_type *), lang_statement_union_type *);
634 extern void *stat_alloc
636 extern void strip_excluded_output_sections
638 extern void lang_clear_os_map
640 extern void dprint_statement
641 (lang_statement_union_type *, int);
642 extern void lang_size_sections
643 (bfd_boolean *, bfd_boolean);
644 extern void one_lang_size_sections_pass
645 (bfd_boolean *, bfd_boolean);
646 extern void lang_add_insert
648 extern void lang_enter_group
650 extern void lang_leave_group
652 extern void lang_add_section
653 (lang_statement_list_type *, asection *,
654 struct flag_info *, lang_output_section_statement_type *);
655 extern void lang_new_phdr
656 (const char *, etree_type *, bfd_boolean, bfd_boolean, etree_type *,
658 extern void lang_add_nocrossref
659 (lang_nocrossref_type *);
660 extern void lang_add_nocrossref_to
661 (lang_nocrossref_type *);
662 extern void lang_enter_overlay
663 (etree_type *, etree_type *);
664 extern void lang_enter_overlay_section
666 extern void lang_leave_overlay_section
667 (fill_type *, lang_output_section_phdr_list *);
668 extern void lang_leave_overlay
669 (etree_type *, int, fill_type *, const char *,
670 lang_output_section_phdr_list *, const char *);
672 extern struct bfd_elf_version_expr *lang_new_vers_pattern
673 (struct bfd_elf_version_expr *, const char *, const char *, bfd_boolean);
674 extern struct bfd_elf_version_tree *lang_new_vers_node
675 (struct bfd_elf_version_expr *, struct bfd_elf_version_expr *);
676 extern struct bfd_elf_version_deps *lang_add_vers_depend
677 (struct bfd_elf_version_deps *, const char *);
678 extern void lang_register_vers_node
679 (const char *, struct bfd_elf_version_tree *, struct bfd_elf_version_deps *);
680 extern void lang_append_dynamic_list (struct bfd_elf_version_expr *);
681 extern void lang_append_dynamic_list_cpp_typeinfo (void);
682 extern void lang_append_dynamic_list_cpp_new (void);
683 extern void lang_add_unique
685 extern const char *lang_get_output_target
687 extern void add_excluded_libs (const char *);
688 extern bfd_boolean load_symbols
689 (lang_input_statement_type *, lang_statement_list_type *);
692 ldlang_override_segment_assignment
693 (struct bfd_link_info *, bfd *, asection *, asection *, bfd_boolean);
696 lang_ld_feature (char *);
699 lang_print_memory_usage (void);
702 lang_add_gc_name (const char *);