1 /* ldlang.h - linker command language support
2 Copyright (C) 1991-2015 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;
61 union lang_statement_union *last_os;
64 bfd_boolean had_full_message;
65 } lang_memory_region_type;
69 lang_output_section_statement_enum,
70 lang_assignment_statement_enum,
71 lang_input_statement_enum,
72 lang_address_statement_enum,
73 lang_wild_statement_enum,
74 lang_input_section_enum,
75 lang_object_symbols_statement_enum,
76 lang_fill_statement_enum,
77 lang_data_statement_enum,
78 lang_reloc_statement_enum,
79 lang_target_statement_enum,
80 lang_output_statement_enum,
81 lang_padding_statement_enum,
82 lang_group_statement_enum,
83 lang_insert_statement_enum,
84 lang_constructors_statement_enum
87 typedef struct lang_statement_header_struct
89 union lang_statement_union *next;
90 enum statement_enum type;
91 } lang_statement_header_type;
95 lang_statement_header_type header;
96 union etree_union *exp;
97 } lang_assignment_statement_type;
99 typedef struct lang_target_statement_struct
101 lang_statement_header_type header;
103 } lang_target_statement_type;
105 typedef struct lang_output_statement_struct
107 lang_statement_header_type header;
109 } lang_output_statement_type;
111 /* Section types specified in a linker script. */
121 /* This structure holds a list of program headers describing
122 segments in which this section should be placed. */
124 typedef struct lang_output_section_phdr_list
126 struct lang_output_section_phdr_list *next;
129 } lang_output_section_phdr_list;
131 typedef struct lang_output_section_statement_struct
133 lang_statement_header_type header;
134 lang_statement_list_type children;
135 struct lang_output_section_statement_struct *next;
136 struct lang_output_section_statement_struct *prev;
138 asection *bfd_section;
139 lang_memory_region_type *region;
140 lang_memory_region_type *lma_region;
142 union etree_union *addr_tree;
143 union etree_union *load_base;
145 /* If non-null, an expression to evaluate after setting the section's
146 size. The expression is evaluated inside REGION (above) with '.'
147 set to the end of the section. Used in the last overlay section
148 to move '.' past all the overlaid sections. */
149 union etree_union *update_dot_tree;
151 lang_output_section_phdr_list *phdrs;
153 unsigned int block_value;
154 int subsection_alignment; /* Alignment of components. */
155 int section_alignment; /* Alignment of start of section. */
158 enum section_type sectype;
159 unsigned int processed_vma : 1;
160 unsigned int processed_lma : 1;
161 unsigned int all_input_readonly : 1;
162 /* If this section should be ignored. */
163 unsigned int ignored : 1;
164 /* If this section should update "dot". Prevents section being ignored. */
165 unsigned int update_dot : 1;
166 /* If this section is after assignment to _end. */
167 unsigned int after_end : 1;
168 /* If this section uses the alignment of its input sections. */
169 unsigned int align_lma_with_input : 1;
170 } lang_output_section_statement_type;
174 lang_statement_header_type header;
175 } lang_common_statement_type;
179 lang_statement_header_type header;
180 } lang_object_symbols_statement_type;
184 lang_statement_header_type header;
187 asection *output_section;
188 } lang_fill_statement_type;
192 lang_statement_header_type header;
194 union etree_union *exp;
196 asection *output_section;
197 bfd_vma output_offset;
198 } lang_data_statement_type;
200 /* Generate a reloc in the output file. */
204 lang_statement_header_type header;
206 /* Reloc to generate. */
207 bfd_reloc_code_real_type reloc;
209 /* Reloc howto structure. */
210 reloc_howto_type *howto;
212 /* Section to generate reloc against.
213 Exactly one of section and name must be NULL. */
216 /* Name of symbol to generate reloc against.
217 Exactly one of section and name must be NULL. */
220 /* Expression for addend. */
221 union etree_union *addend_exp;
223 /* Resolved addend. */
224 bfd_vma addend_value;
226 /* Output section where reloc should be performed. */
227 asection *output_section;
229 /* Offset within output section. */
230 bfd_vma output_offset;
231 } lang_reloc_statement_type;
233 struct lang_input_statement_flags
235 /* 1 means this file was specified in a -l option. */
236 unsigned int maybe_archive : 1;
238 /* 1 means this file was specified in a -l:namespec option. */
239 unsigned int full_name_provided : 1;
241 /* 1 means search a set of directories for this file. */
242 unsigned int search_dirs : 1;
244 /* 1 means this was found when processing a script in the sysroot. */
245 unsigned int sysrooted : 1;
247 /* 1 means this is base file of incremental load.
248 Do not load this file's text or data.
249 Also default text_start to after this file's bss. */
250 unsigned int just_syms : 1;
252 /* Whether to search for this entry as a dynamic archive. */
253 unsigned int dynamic : 1;
255 /* Set if a DT_NEEDED tag should be added not just for the dynamic library
256 explicitly given by this entry but also for any dynamic libraries in
257 this entry's needed list. */
258 unsigned int add_DT_NEEDED_for_dynamic : 1;
260 /* Set if this entry should cause a DT_NEEDED tag only when some
261 regular file references its symbols (ie. --as-needed is in effect). */
262 unsigned int add_DT_NEEDED_for_regular : 1;
264 /* Whether to include the entire contents of an archive. */
265 unsigned int whole_archive : 1;
267 /* Set when bfd opening is successful. */
268 unsigned int loaded : 1;
270 unsigned int real : 1;
272 /* Set if the file does not exist. */
273 unsigned int missing_file : 1;
275 /* Set if reloading an archive or --as-needed lib. */
276 unsigned int reload : 1;
278 #ifdef ENABLE_PLUGINS
279 /* Set if the file was claimed by a plugin. */
280 unsigned int claimed : 1;
282 /* Set if the file was claimed from an archive. */
283 unsigned int claim_archive : 1;
284 #endif /* ENABLE_PLUGINS */
286 /* Head of list of pushed flags. */
287 struct lang_input_statement_flags *pushed;
290 typedef struct lang_input_statement_struct
292 lang_statement_header_type header;
293 /* Name of this file. */
294 const char *filename;
295 /* Name to use for the symbol giving address of text start.
296 Usually the same as filename, but for a file spec'd with
297 -l this is the -l switch itself rather than the filename. */
298 const char *local_sym_name;
302 struct flag_info *section_flag_list;
304 /* Point to the next file - whatever it is, wanders up and down
306 union lang_statement_union *next;
308 /* Point to the next file, but skips archive contents. */
309 union lang_statement_union *next_real_file;
313 struct lang_input_statement_flags flags;
314 } lang_input_statement_type;
318 lang_statement_header_type header;
320 } lang_input_section_type;
322 struct map_symbol_def {
323 struct bfd_link_hash_entry *entry;
324 struct map_symbol_def *next;
327 /* For input sections, when writing a map file: head / tail of a linked
328 list of hash table entries for symbols defined in this section. */
329 typedef struct input_section_userdata_struct
331 struct map_symbol_def *map_symbol_def_head;
332 struct map_symbol_def **map_symbol_def_tail;
333 unsigned long map_symbol_def_count;
334 } input_section_userdata_type;
336 #define get_userdata(x) ((x)->userdata)
339 typedef struct lang_wild_statement_struct lang_wild_statement_type;
341 typedef void (*callback_t) (lang_wild_statement_type *, struct wildcard_list *,
342 asection *, struct flag_info *,
343 lang_input_statement_type *, void *);
345 typedef void (*walk_wild_section_handler_t) (lang_wild_statement_type *,
346 lang_input_statement_type *,
350 typedef bfd_boolean (*lang_match_sec_type_func) (bfd *, const asection *,
351 bfd *, const asection *);
353 /* Binary search tree structure to efficiently sort sections by
355 typedef struct lang_section_bst
358 struct lang_section_bst *left;
359 struct lang_section_bst *right;
360 } lang_section_bst_type;
362 struct lang_wild_statement_struct
364 lang_statement_header_type header;
365 const char *filename;
366 bfd_boolean filenames_sorted;
367 struct wildcard_list *section_list;
368 bfd_boolean keep_sections;
369 lang_statement_list_type children;
371 walk_wild_section_handler_t walk_wild_section_handler;
372 struct wildcard_list *handler_data[4];
373 lang_section_bst_type *tree;
374 struct flag_info *section_flag_list;
377 typedef struct lang_address_statement_struct
379 lang_statement_header_type header;
380 const char *section_name;
381 union etree_union *address;
382 const segment_type *segment;
383 } lang_address_statement_type;
387 lang_statement_header_type header;
388 bfd_vma output_offset;
390 asection *output_section;
392 } lang_padding_statement_type;
394 /* A group statement collects a set of libraries together. The
395 libraries are searched multiple times, until no new undefined
396 symbols are found. The effect is to search a group of libraries as
397 though they were a single library. */
401 lang_statement_header_type header;
402 lang_statement_list_type children;
403 } lang_group_statement_type;
407 lang_statement_header_type header;
409 bfd_boolean is_before;
410 } lang_insert_statement_type;
412 typedef union lang_statement_union
414 lang_statement_header_type header;
415 lang_wild_statement_type wild_statement;
416 lang_data_statement_type data_statement;
417 lang_reloc_statement_type reloc_statement;
418 lang_address_statement_type address_statement;
419 lang_output_section_statement_type output_section_statement;
420 lang_assignment_statement_type assignment_statement;
421 lang_input_statement_type input_statement;
422 lang_target_statement_type target_statement;
423 lang_output_statement_type output_statement;
424 lang_input_section_type input_section;
425 lang_common_statement_type common_statement;
426 lang_object_symbols_statement_type object_symbols_statement;
427 lang_fill_statement_type fill_statement;
428 lang_padding_statement_type padding_statement;
429 lang_group_statement_type group_statement;
430 lang_insert_statement_type insert_statement;
431 } lang_statement_union_type;
433 /* This structure holds information about a program header, from the
434 PHDRS command in the linker script. */
438 struct lang_phdr *next;
447 /* This structure is used to hold a list of sections which may not
448 cross reference each other. */
450 typedef struct lang_nocrossref
452 struct lang_nocrossref *next;
454 } lang_nocrossref_type;
456 /* The list of nocrossref lists. */
458 struct lang_nocrossrefs
460 struct lang_nocrossrefs *next;
461 lang_nocrossref_type *list;
464 /* This structure is used to hold a list of input section names which
465 will not match an output section in the linker script. */
467 struct unique_sections
469 struct unique_sections *next;
473 /* Used by place_orphan to keep track of orphan sections and statements. */
479 lang_output_section_statement_type *os;
481 lang_statement_union_type **stmt;
482 lang_output_section_statement_type **os_tail;
485 struct asneeded_minfo
487 struct asneeded_minfo *next;
493 extern struct lang_phdr *lang_phdr_list;
494 extern struct lang_nocrossrefs *nocrossref_list;
495 extern const char *output_target;
496 extern lang_output_section_statement_type *abs_output_section;
497 extern lang_statement_list_type lang_output_section_statement;
498 extern struct lang_input_statement_flags input_flags;
499 extern bfd_boolean lang_has_input_file;
500 extern lang_statement_list_type *stat_ptr;
501 extern bfd_boolean delete_output_file_on_failure;
503 extern struct bfd_sym_chain entry_symbol;
504 extern const char *entry_section;
505 extern bfd_boolean entry_from_cmdline;
506 extern lang_statement_list_type file_chain;
507 extern lang_statement_list_type input_file_chain;
509 extern int lang_statement_iteration;
510 extern struct asneeded_minfo **asneeded_list_tail;
512 extern void (*output_bfd_hash_table_free_fn) (struct bfd_link_hash_table *);
514 extern void lang_init
516 extern void lang_finish
518 extern lang_memory_region_type * lang_memory_region_lookup
519 (const char * const, bfd_boolean);
520 extern void lang_memory_region_alias
521 (const char *, const char *);
524 extern void lang_set_flags
525 (lang_memory_region_type *, const char *, int);
526 extern void lang_add_output
527 (const char *, int from_script);
528 extern lang_output_section_statement_type *lang_enter_output_section_statement
529 (const char *, etree_type *, enum section_type, etree_type *, etree_type *,
530 etree_type *, int, int);
531 extern void lang_final
533 extern void lang_relax_sections
535 extern void lang_process
537 extern void lang_section_start
538 (const char *, union etree_union *, const segment_type *);
539 extern void lang_add_entry
540 (const char *, bfd_boolean);
541 extern void lang_default_entry
543 extern void lang_add_target
545 extern void lang_add_wild
546 (struct wildcard_spec *, struct wildcard_list *, bfd_boolean);
547 extern void lang_add_map
549 extern void lang_add_fill
551 extern lang_assignment_statement_type *lang_add_assignment
552 (union etree_union *);
553 extern void lang_add_attribute
554 (enum statement_enum);
555 extern void lang_startup
557 extern void lang_float
559 extern void lang_leave_output_section_statement
560 (fill_type *, const char *, lang_output_section_phdr_list *,
562 extern void lang_statement_append
563 (lang_statement_list_type *, lang_statement_union_type *,
564 lang_statement_union_type **);
565 extern void lang_for_each_input_file
566 (void (*dothis) (lang_input_statement_type *));
567 extern void lang_for_each_file
568 (void (*dothis) (lang_input_statement_type *));
569 extern void lang_reset_memory_regions
571 extern void lang_do_assignments
573 extern asection *section_for_dot
576 #define LANG_FOR_EACH_INPUT_STATEMENT(statement) \
577 lang_input_statement_type *statement; \
578 for (statement = (lang_input_statement_type *) file_chain.head; \
579 statement != (lang_input_statement_type *) NULL; \
580 statement = (lang_input_statement_type *) statement->next) \
582 #define lang_output_section_find(NAME) \
583 lang_output_section_statement_lookup (NAME, 0, FALSE)
585 extern void lang_process
587 extern void ldlang_add_file
588 (lang_input_statement_type *);
589 extern lang_output_section_statement_type *lang_output_section_find_by_flags
590 (const asection *, lang_output_section_statement_type **,
591 lang_match_sec_type_func);
592 extern lang_output_section_statement_type *lang_insert_orphan
593 (asection *, const char *, int, lang_output_section_statement_type *,
594 struct orphan_save *, etree_type *, lang_statement_list_type *);
595 extern lang_input_statement_type *lang_add_input_file
596 (const char *, lang_input_file_enum_type, const char *);
597 extern void lang_add_keepsyms_file
599 extern lang_output_section_statement_type *lang_output_section_get
601 extern lang_output_section_statement_type *lang_output_section_statement_lookup
602 (const char *, int, bfd_boolean);
603 extern lang_output_section_statement_type *next_matching_output_section_statement
604 (lang_output_section_statement_type *, int);
605 extern void ldlang_add_undef
606 (const char *const, bfd_boolean);
607 extern void lang_add_output_format
608 (const char *, const char *, const char *, int);
609 extern void lang_list_init
610 (lang_statement_list_type *);
611 extern void push_stat_ptr
612 (lang_statement_list_type *);
613 extern void pop_stat_ptr
615 extern void lang_add_data
616 (int type, union etree_union *);
617 extern void lang_add_reloc
618 (bfd_reloc_code_real_type, reloc_howto_type *, asection *, const char *,
619 union etree_union *);
620 extern void lang_for_each_statement
621 (void (*) (lang_statement_union_type *));
622 extern void lang_for_each_statement_worker
623 (void (*) (lang_statement_union_type *), lang_statement_union_type *);
624 extern void *stat_alloc
626 extern void strip_excluded_output_sections
628 extern void lang_clear_os_map
630 extern void dprint_statement
631 (lang_statement_union_type *, int);
632 extern void lang_size_sections
633 (bfd_boolean *, bfd_boolean);
634 extern void one_lang_size_sections_pass
635 (bfd_boolean *, bfd_boolean);
636 extern void lang_add_insert
638 extern void lang_enter_group
640 extern void lang_leave_group
642 extern void lang_add_section
643 (lang_statement_list_type *, asection *,
644 struct flag_info *, lang_output_section_statement_type *);
645 extern void lang_new_phdr
646 (const char *, etree_type *, bfd_boolean, bfd_boolean, etree_type *,
648 extern void lang_add_nocrossref
649 (lang_nocrossref_type *);
650 extern void lang_enter_overlay
651 (etree_type *, etree_type *);
652 extern void lang_enter_overlay_section
654 extern void lang_leave_overlay_section
655 (fill_type *, lang_output_section_phdr_list *);
656 extern void lang_leave_overlay
657 (etree_type *, int, fill_type *, const char *,
658 lang_output_section_phdr_list *, const char *);
660 extern struct bfd_elf_version_expr *lang_new_vers_pattern
661 (struct bfd_elf_version_expr *, const char *, const char *, bfd_boolean);
662 extern struct bfd_elf_version_tree *lang_new_vers_node
663 (struct bfd_elf_version_expr *, struct bfd_elf_version_expr *);
664 extern struct bfd_elf_version_deps *lang_add_vers_depend
665 (struct bfd_elf_version_deps *, const char *);
666 extern void lang_register_vers_node
667 (const char *, struct bfd_elf_version_tree *, struct bfd_elf_version_deps *);
668 extern void lang_append_dynamic_list (struct bfd_elf_version_expr *);
669 extern void lang_append_dynamic_list_cpp_typeinfo (void);
670 extern void lang_append_dynamic_list_cpp_new (void);
671 extern void lang_add_unique
673 extern const char *lang_get_output_target
675 extern void add_excluded_libs (const char *);
676 extern bfd_boolean load_symbols
677 (lang_input_statement_type *, lang_statement_list_type *);
680 ldlang_override_segment_assignment
681 (struct bfd_link_info *, bfd *, asection *, asection *, bfd_boolean);
684 lang_ld_feature (char *);