1 /* ldlang.h - linker command language support
2 Copyright 1991-2013 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 search a set of directories for this file. */
239 unsigned int search_dirs : 1;
241 /* 1 means this was found when processing a script in the sysroot. */
242 unsigned int sysrooted : 1;
244 /* 1 means this is base file of incremental load.
245 Do not load this file's text or data.
246 Also default text_start to after this file's bss. */
247 unsigned int just_syms : 1;
249 /* Whether to search for this entry as a dynamic archive. */
250 unsigned int dynamic : 1;
252 /* Set if a DT_NEEDED tag should be added not just for the dynamic library
253 explicitly given by this entry but also for any dynamic libraries in
254 this entry's needed list. */
255 unsigned int add_DT_NEEDED_for_dynamic : 1;
257 /* Set if this entry should cause a DT_NEEDED tag only when some
258 regular file references its symbols (ie. --as-needed is in effect). */
259 unsigned int add_DT_NEEDED_for_regular : 1;
261 /* Whether to include the entire contents of an archive. */
262 unsigned int whole_archive : 1;
264 /* Set when bfd opening is successful. */
265 unsigned int loaded : 1;
267 unsigned int real : 1;
269 /* Set if the file does not exist. */
270 unsigned int missing_file : 1;
272 #ifdef ENABLE_PLUGINS
273 /* Set if the file was claimed by a plugin. */
274 unsigned int claimed : 1;
276 /* Set if the file was claimed from an archive. */
277 unsigned int claim_archive : 1;
279 /* Set if reloading an --as-needed lib. */
280 unsigned int reload : 1;
281 #endif /* ENABLE_PLUGINS */
284 typedef struct lang_input_statement_struct
286 lang_statement_header_type header;
287 /* Name of this file. */
288 const char *filename;
289 /* Name to use for the symbol giving address of text start.
290 Usually the same as filename, but for a file spec'd with
291 -l this is the -l switch itself rather than the filename. */
292 const char *local_sym_name;
296 struct flag_info *section_flag_list;
298 /* Point to the next file - whatever it is, wanders up and down
300 union lang_statement_union *next;
302 /* Point to the next file, but skips archive contents. */
303 union lang_statement_union *next_real_file;
307 struct lang_input_statement_flags flags;
308 } lang_input_statement_type;
312 lang_statement_header_type header;
314 } lang_input_section_type;
316 /* For input sections, when writing a map file: head / tail of a linked
317 list of hash table entries for symbols defined in this section. */
318 typedef struct input_section_userdata_struct
320 struct map_symbol_def *map_symbol_def_head;
321 struct map_symbol_def **map_symbol_def_tail;
322 unsigned long map_symbol_def_count;
323 } input_section_userdata_type;
325 #define get_userdata(x) ((x)->userdata)
328 typedef struct lang_wild_statement_struct lang_wild_statement_type;
330 typedef void (*callback_t) (lang_wild_statement_type *, struct wildcard_list *,
331 asection *, struct flag_info *,
332 lang_input_statement_type *, void *);
334 typedef void (*walk_wild_section_handler_t) (lang_wild_statement_type *,
335 lang_input_statement_type *,
339 typedef bfd_boolean (*lang_match_sec_type_func) (bfd *, const asection *,
340 bfd *, const asection *);
342 /* Binary search tree structure to efficiently sort sections by
344 typedef struct lang_section_bst
347 struct lang_section_bst *left;
348 struct lang_section_bst *right;
349 } lang_section_bst_type;
351 struct lang_wild_statement_struct
353 lang_statement_header_type header;
354 const char *filename;
355 bfd_boolean filenames_sorted;
356 struct wildcard_list *section_list;
357 bfd_boolean keep_sections;
358 lang_statement_list_type children;
360 walk_wild_section_handler_t walk_wild_section_handler;
361 struct wildcard_list *handler_data[4];
362 lang_section_bst_type *tree;
363 struct flag_info *section_flag_list;
366 typedef struct lang_address_statement_struct
368 lang_statement_header_type header;
369 const char *section_name;
370 union etree_union *address;
371 const segment_type *segment;
372 } lang_address_statement_type;
376 lang_statement_header_type header;
377 bfd_vma output_offset;
379 asection *output_section;
381 } lang_padding_statement_type;
383 /* A group statement collects a set of libraries together. The
384 libraries are searched multiple times, until no new undefined
385 symbols are found. The effect is to search a group of libraries as
386 though they were a single library. */
390 lang_statement_header_type header;
391 lang_statement_list_type children;
392 } lang_group_statement_type;
396 lang_statement_header_type header;
398 bfd_boolean is_before;
399 } lang_insert_statement_type;
401 typedef union lang_statement_union
403 lang_statement_header_type header;
404 lang_wild_statement_type wild_statement;
405 lang_data_statement_type data_statement;
406 lang_reloc_statement_type reloc_statement;
407 lang_address_statement_type address_statement;
408 lang_output_section_statement_type output_section_statement;
409 lang_assignment_statement_type assignment_statement;
410 lang_input_statement_type input_statement;
411 lang_target_statement_type target_statement;
412 lang_output_statement_type output_statement;
413 lang_input_section_type input_section;
414 lang_common_statement_type common_statement;
415 lang_object_symbols_statement_type object_symbols_statement;
416 lang_fill_statement_type fill_statement;
417 lang_padding_statement_type padding_statement;
418 lang_group_statement_type group_statement;
419 lang_insert_statement_type insert_statement;
420 } lang_statement_union_type;
422 /* This structure holds information about a program header, from the
423 PHDRS command in the linker script. */
427 struct lang_phdr *next;
436 /* This structure is used to hold a list of sections which may not
437 cross reference each other. */
439 typedef struct lang_nocrossref
441 struct lang_nocrossref *next;
443 } lang_nocrossref_type;
445 /* The list of nocrossref lists. */
447 struct lang_nocrossrefs
449 struct lang_nocrossrefs *next;
450 lang_nocrossref_type *list;
453 /* This structure is used to hold a list of input section names which
454 will not match an output section in the linker script. */
456 struct unique_sections
458 struct unique_sections *next;
462 /* This structure records symbols for which we need to keep track of
463 definedness for use in the DEFINED () test. */
465 struct lang_definedness_hash_entry
467 struct bfd_hash_entry root;
471 /* Used by place_orphan to keep track of orphan sections and statements. */
477 lang_output_section_statement_type *os;
479 lang_statement_union_type **stmt;
480 lang_output_section_statement_type **os_tail;
483 extern struct lang_phdr *lang_phdr_list;
484 extern struct lang_nocrossrefs *nocrossref_list;
485 extern const char *output_target;
486 extern lang_output_section_statement_type *abs_output_section;
487 extern lang_statement_list_type lang_output_section_statement;
488 extern struct lang_input_statement_flags input_flags;
489 extern bfd_boolean lang_has_input_file;
490 extern etree_type *base;
491 extern lang_statement_list_type *stat_ptr;
492 extern bfd_boolean delete_output_file_on_failure;
494 extern struct bfd_sym_chain entry_symbol;
495 extern const char *entry_section;
496 extern bfd_boolean entry_from_cmdline;
497 extern lang_statement_list_type file_chain;
498 extern lang_statement_list_type input_file_chain;
500 extern int lang_statement_iteration;
502 extern void lang_init
504 extern void lang_finish
506 extern lang_memory_region_type * lang_memory_region_lookup
507 (const char * const, bfd_boolean);
508 extern void lang_memory_region_alias
509 (const char *, const char *);
512 extern void lang_set_flags
513 (lang_memory_region_type *, const char *, int);
514 extern void lang_add_output
515 (const char *, int from_script);
516 extern lang_output_section_statement_type *lang_enter_output_section_statement
517 (const char *, etree_type *, enum section_type, etree_type *, etree_type *,
518 etree_type *, int, int);
519 extern void lang_final
521 extern void lang_relax_sections
523 extern void lang_process
525 extern void lang_section_start
526 (const char *, union etree_union *, const segment_type *);
527 extern void lang_add_entry
528 (const char *, bfd_boolean);
529 extern void lang_default_entry
531 extern void lang_add_target
533 extern void lang_add_wild
534 (struct wildcard_spec *, struct wildcard_list *, bfd_boolean);
535 extern void lang_add_map
537 extern void lang_add_fill
539 extern lang_assignment_statement_type *lang_add_assignment
540 (union etree_union *);
541 extern void lang_add_attribute
542 (enum statement_enum);
543 extern void lang_startup
545 extern void lang_float
547 extern void lang_leave_output_section_statement
548 (fill_type *, const char *, lang_output_section_phdr_list *,
550 extern void lang_statement_append
551 (lang_statement_list_type *, lang_statement_union_type *,
552 lang_statement_union_type **);
553 extern void lang_for_each_input_file
554 (void (*dothis) (lang_input_statement_type *));
555 extern void lang_for_each_file
556 (void (*dothis) (lang_input_statement_type *));
557 extern void lang_reset_memory_regions
559 extern void lang_do_assignments
561 extern asection *section_for_dot
564 #define LANG_FOR_EACH_INPUT_STATEMENT(statement) \
565 lang_input_statement_type *statement; \
566 for (statement = (lang_input_statement_type *) file_chain.head; \
567 statement != (lang_input_statement_type *) NULL; \
568 statement = (lang_input_statement_type *) statement->next) \
570 #define lang_output_section_find(NAME) \
571 lang_output_section_statement_lookup (NAME, 0, FALSE)
573 extern void lang_process
575 extern void ldlang_add_file
576 (lang_input_statement_type *);
577 extern lang_output_section_statement_type *lang_output_section_find_by_flags
578 (const asection *, lang_output_section_statement_type **,
579 lang_match_sec_type_func);
580 extern lang_output_section_statement_type *lang_insert_orphan
581 (asection *, const char *, int, lang_output_section_statement_type *,
582 struct orphan_save *, etree_type *, lang_statement_list_type *);
583 extern lang_input_statement_type *lang_add_input_file
584 (const char *, lang_input_file_enum_type, const char *);
585 extern void lang_add_keepsyms_file
587 extern lang_output_section_statement_type *lang_output_section_statement_lookup
588 (const char *, int, bfd_boolean);
589 extern lang_output_section_statement_type *next_matching_output_section_statement
590 (lang_output_section_statement_type *, int);
591 extern void ldlang_add_undef
592 (const char *const, bfd_boolean);
593 extern void lang_add_output_format
594 (const char *, const char *, const char *, int);
595 extern void lang_list_init
596 (lang_statement_list_type *);
597 extern void push_stat_ptr
598 (lang_statement_list_type *);
599 extern void pop_stat_ptr
601 extern void lang_add_data
602 (int type, union etree_union *);
603 extern void lang_add_reloc
604 (bfd_reloc_code_real_type, reloc_howto_type *, asection *, const char *,
605 union etree_union *);
606 extern void lang_for_each_statement
607 (void (*) (lang_statement_union_type *));
608 extern void lang_for_each_statement_worker
609 (void (*) (lang_statement_union_type *), lang_statement_union_type *);
610 extern void *stat_alloc
612 extern void strip_excluded_output_sections
614 extern void dprint_statement
615 (lang_statement_union_type *, int);
616 extern void lang_size_sections
617 (bfd_boolean *, bfd_boolean);
618 extern void one_lang_size_sections_pass
619 (bfd_boolean *, bfd_boolean);
620 extern void lang_add_insert
622 extern void lang_enter_group
624 extern void lang_leave_group
626 extern void lang_add_section
627 (lang_statement_list_type *, asection *,
628 struct flag_info *, lang_output_section_statement_type *);
629 extern void lang_new_phdr
630 (const char *, etree_type *, bfd_boolean, bfd_boolean, etree_type *,
632 extern void lang_add_nocrossref
633 (lang_nocrossref_type *);
634 extern void lang_enter_overlay
635 (etree_type *, etree_type *);
636 extern void lang_enter_overlay_section
638 extern void lang_leave_overlay_section
639 (fill_type *, lang_output_section_phdr_list *);
640 extern void lang_leave_overlay
641 (etree_type *, int, fill_type *, const char *,
642 lang_output_section_phdr_list *, const char *);
644 extern struct bfd_elf_version_expr *lang_new_vers_pattern
645 (struct bfd_elf_version_expr *, const char *, const char *, bfd_boolean);
646 extern struct bfd_elf_version_tree *lang_new_vers_node
647 (struct bfd_elf_version_expr *, struct bfd_elf_version_expr *);
648 extern struct bfd_elf_version_deps *lang_add_vers_depend
649 (struct bfd_elf_version_deps *, const char *);
650 extern void lang_register_vers_node
651 (const char *, struct bfd_elf_version_tree *, struct bfd_elf_version_deps *);
652 extern void lang_append_dynamic_list (struct bfd_elf_version_expr *);
653 extern void lang_append_dynamic_list_cpp_typeinfo (void);
654 extern void lang_append_dynamic_list_cpp_new (void);
655 extern void lang_add_unique
657 extern const char *lang_get_output_target
659 extern void lang_track_definedness (const char *);
660 extern int lang_symbol_definition_iteration (const char *);
661 extern void lang_update_definedness
662 (const char *, struct bfd_link_hash_entry *);
664 extern void add_excluded_libs (const char *);
665 extern bfd_boolean load_symbols
666 (lang_input_statement_type *, lang_statement_list_type *);
669 ldlang_override_segment_assignment
670 (struct bfd_link_info *, bfd *, asection *, asection *, bfd_boolean);
673 lang_ld_feature (char *);