fix printing of DWARF fixed-point type objects with format modifier
[binutils-gdb.git] / ld / ldlang.h
blob196debfa37e8ed15f2b1b67d57df05d8c9cf21f2
1 /* ldlang.h - linker command language support
2 Copyright (C) 1991-2020 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. */
21 #ifndef LDLANG_H
22 #define LDLANG_H
24 #define DEFAULT_MEMORY_REGION "*default*"
26 #define SECTION_NAME_MAP_LENGTH (16)
28 typedef enum
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;
38 struct _fill_type
40 size_t size;
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
52 const char * name;
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;
61 bfd_vma origin;
62 bfd_size_type length;
63 union etree_union *length_exp;
64 bfd_vma current;
65 union lang_statement_union *last_os;
66 flagword flags;
67 flagword not_flags;
68 bfd_boolean had_full_message;
69 } lang_memory_region_type;
71 enum statement_enum
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;
98 typedef struct
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;
107 const char *target;
108 } lang_target_statement_type;
110 typedef struct lang_output_statement_struct
112 lang_statement_header_type header;
113 const char *name;
114 } lang_output_statement_type;
116 /* Section types specified in a linker script. */
118 enum section_type
120 normal_section,
121 first_overlay_section,
122 overlay_section,
123 noload_section,
124 noalloc_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;
133 const char *name;
134 bfd_boolean used;
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;
143 const char *name;
144 asection *bfd_section;
145 lang_memory_region_type *region;
146 lang_memory_region_type *lma_region;
147 fill_type *fill;
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;
162 int constraint;
163 flagword flags;
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 } lang_output_section_statement_type;
178 typedef struct
180 lang_statement_header_type header;
181 fill_type *fill;
182 int size;
183 asection *output_section;
184 } lang_fill_statement_type;
186 typedef struct
188 lang_statement_header_type header;
189 unsigned int type;
190 union etree_union *exp;
191 bfd_vma value;
192 asection *output_section;
193 bfd_vma output_offset;
194 } lang_data_statement_type;
196 /* Generate a reloc in the output file. */
198 typedef struct
200 lang_statement_header_type header;
202 /* Reloc to generate. */
203 bfd_reloc_code_real_type reloc;
205 /* Reloc howto structure. */
206 reloc_howto_type *howto;
208 /* Section to generate reloc against.
209 Exactly one of section and name must be NULL. */
210 asection *section;
212 /* Name of symbol to generate reloc against.
213 Exactly one of section and name must be NULL. */
214 const char *name;
216 /* Expression for addend. */
217 union etree_union *addend_exp;
219 /* Resolved addend. */
220 bfd_vma addend_value;
222 /* Output section where reloc should be performed. */
223 asection *output_section;
225 /* Offset within output section. */
226 bfd_vma output_offset;
227 } lang_reloc_statement_type;
229 struct lang_input_statement_flags
231 /* 1 means this file was specified in a -l option. */
232 unsigned int maybe_archive : 1;
234 /* 1 means this file was specified in a -l:namespec option. */
235 unsigned int full_name_provided : 1;
237 /* 1 means search a set of directories for this file. */
238 unsigned int search_dirs : 1;
240 /* 1 means this was found when processing a script in the sysroot. */
241 unsigned int sysrooted : 1;
243 /* 1 means this is base file of incremental load.
244 Do not load this file's text or data.
245 Also default text_start to after this file's bss. */
246 unsigned int just_syms : 1;
248 /* Whether to search for this entry as a dynamic archive. */
249 unsigned int dynamic : 1;
251 /* Set if a DT_NEEDED tag should be added not just for the dynamic library
252 explicitly given by this entry but also for any dynamic libraries in
253 this entry's needed list. */
254 unsigned int add_DT_NEEDED_for_dynamic : 1;
256 /* Set if this entry should cause a DT_NEEDED tag only when some
257 regular file references its symbols (ie. --as-needed is in effect). */
258 unsigned int add_DT_NEEDED_for_regular : 1;
260 /* Whether to include the entire contents of an archive. */
261 unsigned int whole_archive : 1;
263 /* Set when bfd opening is successful. */
264 unsigned int loaded : 1;
266 unsigned int real : 1;
268 /* Set if the file does not exist. */
269 unsigned int missing_file : 1;
271 /* Set if reloading an archive or --as-needed lib. */
272 unsigned int reload : 1;
274 #if BFD_SUPPORTS_PLUGINS
275 /* Set if the file was claimed by a plugin. */
276 unsigned int claimed : 1;
278 /* Set if the file was claimed from an archive. */
279 unsigned int claim_archive : 1;
281 /* Set if added by the lto plugin add_input_file callback. */
282 unsigned int lto_output : 1;
283 #endif /* BFD_SUPPORTS_PLUGINS */
285 /* Head of list of pushed flags. */
286 struct lang_input_statement_flags *pushed;
289 typedef struct lang_input_statement_struct
291 lang_statement_header_type header;
292 /* Name of this file. */
293 const char *filename;
294 /* Name to use for the symbol giving address of text start.
295 Usually the same as filename, but for a file spec'd with
296 -l this is the -l switch itself rather than the filename. */
297 const char *local_sym_name;
298 /* Extra search path. Used to find a file relative to the
299 directory of the current linker script. */
300 const char *extra_search_path;
302 bfd *the_bfd;
304 ctf_archive_t *the_ctf;
306 struct flag_info *section_flag_list;
308 /* Next pointer for file_chain statement list. */
309 struct lang_input_statement_struct *next;
311 /* Next pointer for input_file_chain statement list. */
312 struct lang_input_statement_struct *next_real_file;
314 const char *target;
316 struct lang_input_statement_flags flags;
317 } lang_input_statement_type;
319 typedef struct
321 lang_statement_header_type header;
322 asection *section;
323 } lang_input_section_type;
325 struct map_symbol_def {
326 struct bfd_link_hash_entry *entry;
327 struct map_symbol_def *next;
330 /* For input sections, when writing a map file: head / tail of a linked
331 list of hash table entries for symbols defined in this section. */
332 typedef struct input_section_userdata_struct
334 struct map_symbol_def *map_symbol_def_head;
335 struct map_symbol_def **map_symbol_def_tail;
336 unsigned long map_symbol_def_count;
337 } input_section_userdata_type;
339 static inline bfd_boolean
340 bfd_input_just_syms (const bfd *abfd)
342 lang_input_statement_type *is = bfd_usrdata (abfd);
343 return is != NULL && is->flags.just_syms;
346 typedef struct lang_wild_statement_struct lang_wild_statement_type;
348 typedef void (*callback_t) (lang_wild_statement_type *, struct wildcard_list *,
349 asection *, struct flag_info *,
350 lang_input_statement_type *, void *);
352 typedef void (*walk_wild_section_handler_t) (lang_wild_statement_type *,
353 lang_input_statement_type *,
354 callback_t callback,
355 void *data);
357 typedef bfd_boolean (*lang_match_sec_type_func) (bfd *, const asection *,
358 bfd *, const asection *);
360 /* Binary search tree structure to efficiently sort sections by
361 name. */
362 typedef struct lang_section_bst
364 asection *section;
365 struct lang_section_bst *left;
366 struct lang_section_bst *right;
367 } lang_section_bst_type;
369 struct lang_wild_statement_struct
371 lang_statement_header_type header;
372 const char *filename;
373 bfd_boolean filenames_sorted;
374 struct wildcard_list *section_list;
375 bfd_boolean keep_sections;
376 lang_statement_list_type children;
377 struct name_list *exclude_name_list;
379 walk_wild_section_handler_t walk_wild_section_handler;
380 struct wildcard_list *handler_data[4];
381 lang_section_bst_type *tree;
382 struct flag_info *section_flag_list;
385 typedef struct lang_address_statement_struct
387 lang_statement_header_type header;
388 const char *section_name;
389 union etree_union *address;
390 const segment_type *segment;
391 } lang_address_statement_type;
393 typedef struct
395 lang_statement_header_type header;
396 bfd_vma output_offset;
397 bfd_size_type size;
398 asection *output_section;
399 fill_type *fill;
400 } lang_padding_statement_type;
402 /* A group statement collects a set of libraries together. The
403 libraries are searched multiple times, until no new undefined
404 symbols are found. The effect is to search a group of libraries as
405 though they were a single library. */
407 typedef struct
409 lang_statement_header_type header;
410 lang_statement_list_type children;
411 } lang_group_statement_type;
413 typedef struct
415 lang_statement_header_type header;
416 const char *where;
417 bfd_boolean is_before;
418 } lang_insert_statement_type;
420 typedef union lang_statement_union
422 lang_statement_header_type header;
423 lang_address_statement_type address_statement;
424 lang_assignment_statement_type assignment_statement;
425 lang_data_statement_type data_statement;
426 lang_fill_statement_type fill_statement;
427 lang_group_statement_type group_statement;
428 lang_input_section_type input_section;
429 lang_input_statement_type input_statement;
430 lang_insert_statement_type insert_statement;
431 lang_output_section_statement_type output_section_statement;
432 lang_output_statement_type output_statement;
433 lang_padding_statement_type padding_statement;
434 lang_reloc_statement_type reloc_statement;
435 lang_target_statement_type target_statement;
436 lang_wild_statement_type wild_statement;
437 } lang_statement_union_type;
439 /* This structure holds information about a program header, from the
440 PHDRS command in the linker script. */
442 struct lang_phdr
444 struct lang_phdr *next;
445 const char *name;
446 unsigned long type;
447 bfd_boolean filehdr;
448 bfd_boolean phdrs;
449 etree_type *at;
450 etree_type *flags;
453 /* This structure is used to hold a list of sections which may not
454 cross reference each other. */
456 typedef struct lang_nocrossref
458 struct lang_nocrossref *next;
459 const char *name;
460 } lang_nocrossref_type;
462 /* The list of nocrossref lists. */
464 struct lang_nocrossrefs
466 struct lang_nocrossrefs *next;
467 lang_nocrossref_type *list;
468 bfd_boolean onlyfirst;
471 /* This structure is used to hold a list of input section names which
472 will not match an output section in the linker script. */
474 struct unique_sections
476 struct unique_sections *next;
477 const char *name;
480 /* Used by place_orphan to keep track of orphan sections and statements. */
482 struct orphan_save
484 const char *name;
485 flagword flags;
486 lang_output_section_statement_type *os;
487 asection **section;
488 lang_statement_union_type **stmt;
489 lang_output_section_statement_type **os_tail;
492 struct asneeded_minfo
494 struct asneeded_minfo *next;
495 const char *soname;
496 bfd *ref;
497 const char *name;
500 extern struct lang_phdr *lang_phdr_list;
501 extern struct lang_nocrossrefs *nocrossref_list;
502 extern const char *output_target;
503 extern lang_output_section_statement_type *abs_output_section;
504 extern lang_statement_list_type lang_os_list;
505 extern struct lang_input_statement_flags input_flags;
506 extern bfd_boolean lang_has_input_file;
507 extern lang_statement_list_type *stat_ptr;
508 extern bfd_boolean delete_output_file_on_failure;
510 extern struct bfd_sym_chain entry_symbol;
511 extern const char *entry_section;
512 extern bfd_boolean entry_from_cmdline;
513 extern lang_statement_list_type file_chain;
514 extern lang_statement_list_type input_file_chain;
516 extern struct bfd_elf_dynamic_list **current_dynamic_list_p;
518 extern int lang_statement_iteration;
519 extern struct asneeded_minfo **asneeded_list_tail;
521 extern void (*output_bfd_hash_table_free_fn) (struct bfd_link_hash_table *);
523 extern void lang_init
524 (void);
525 extern void lang_finish
526 (void);
527 extern lang_memory_region_type * lang_memory_region_lookup
528 (const char * const, bfd_boolean);
529 extern void lang_memory_region_alias
530 (const char *, const char *);
531 extern void lang_map
532 (void);
533 extern void lang_set_flags
534 (lang_memory_region_type *, const char *, int);
535 extern void lang_add_output
536 (const char *, int from_script);
537 extern lang_output_section_statement_type *lang_enter_output_section_statement
538 (const char *, etree_type *, enum section_type, etree_type *, etree_type *,
539 etree_type *, int, int);
540 extern void lang_final
541 (void);
542 extern void lang_relax_sections
543 (bfd_boolean);
544 extern void lang_process
545 (void);
546 extern void lang_section_start
547 (const char *, union etree_union *, const segment_type *);
548 extern void lang_add_entry
549 (const char *, bfd_boolean);
550 extern void lang_default_entry
551 (const char *);
552 extern void lang_add_target
553 (const char *);
554 extern void lang_add_wild
555 (struct wildcard_spec *, struct wildcard_list *, bfd_boolean);
556 extern void lang_add_map
557 (const char *);
558 extern void lang_add_fill
559 (fill_type *);
560 extern lang_assignment_statement_type *lang_add_assignment
561 (union etree_union *);
562 extern void lang_add_attribute
563 (enum statement_enum);
564 extern void lang_startup
565 (const char *);
566 extern void lang_float
567 (bfd_boolean);
568 extern void lang_leave_output_section_statement
569 (fill_type *, const char *, lang_output_section_phdr_list *,
570 const char *);
571 extern void lang_for_each_input_file
572 (void (*dothis) (lang_input_statement_type *));
573 extern void lang_for_each_file
574 (void (*dothis) (lang_input_statement_type *));
575 extern void lang_reset_memory_regions
576 (void);
577 extern void lang_do_assignments
578 (lang_phase_type);
579 extern asection *section_for_dot
580 (void);
582 #define LANG_FOR_EACH_INPUT_STATEMENT(statement) \
583 lang_input_statement_type *statement; \
584 for (statement = (lang_input_statement_type *) file_chain.head; \
585 statement != NULL; \
586 statement = statement->next)
588 #define lang_output_section_find(NAME) \
589 lang_output_section_statement_lookup (NAME, 0, FALSE)
591 extern void lang_process
592 (void);
593 extern void ldlang_add_file
594 (lang_input_statement_type *);
595 extern lang_output_section_statement_type *lang_output_section_find_by_flags
596 (const asection *, flagword, lang_output_section_statement_type **,
597 lang_match_sec_type_func);
598 extern lang_output_section_statement_type *lang_insert_orphan
599 (asection *, const char *, int, lang_output_section_statement_type *,
600 struct orphan_save *, etree_type *, lang_statement_list_type *);
601 extern lang_input_statement_type *lang_add_input_file
602 (const char *, lang_input_file_enum_type, const char *);
603 extern void lang_add_keepsyms_file
604 (const char *);
605 extern lang_output_section_statement_type *lang_output_section_get
606 (const asection *);
607 extern lang_output_section_statement_type *lang_output_section_statement_lookup
608 (const char *, int, bfd_boolean);
609 extern lang_output_section_statement_type *next_matching_output_section_statement
610 (lang_output_section_statement_type *, int);
611 extern void ldlang_add_undef
612 (const char *const, bfd_boolean);
613 extern void ldlang_add_require_defined
614 (const char *const);
615 extern void lang_add_output_format
616 (const char *, const char *, const char *, int);
617 extern void lang_list_init
618 (lang_statement_list_type *);
619 extern void push_stat_ptr
620 (lang_statement_list_type *);
621 extern void pop_stat_ptr
622 (void);
623 extern void lang_add_data
624 (int type, union etree_union *);
625 extern void lang_add_reloc
626 (bfd_reloc_code_real_type, reloc_howto_type *, asection *, const char *,
627 union etree_union *);
628 extern void lang_for_each_statement
629 (void (*) (lang_statement_union_type *));
630 extern void lang_for_each_statement_worker
631 (void (*) (lang_statement_union_type *), lang_statement_union_type *);
632 extern void *stat_alloc
633 (size_t);
634 extern void strip_excluded_output_sections
635 (void);
636 extern void lang_clear_os_map
637 (void);
638 extern void dprint_statement
639 (lang_statement_union_type *, int);
640 extern void lang_size_sections
641 (bfd_boolean *, bfd_boolean);
642 extern void one_lang_size_sections_pass
643 (bfd_boolean *, bfd_boolean);
644 extern void lang_add_insert
645 (const char *, int);
646 extern void lang_enter_group
647 (void);
648 extern void lang_leave_group
649 (void);
650 extern void lang_add_section
651 (lang_statement_list_type *, asection *,
652 struct flag_info *, lang_output_section_statement_type *);
653 extern void lang_new_phdr
654 (const char *, etree_type *, bfd_boolean, bfd_boolean, etree_type *,
655 etree_type *);
656 extern void lang_add_nocrossref
657 (lang_nocrossref_type *);
658 extern void lang_add_nocrossref_to
659 (lang_nocrossref_type *);
660 extern void lang_enter_overlay
661 (etree_type *, etree_type *);
662 extern void lang_enter_overlay_section
663 (const char *);
664 extern void lang_leave_overlay_section
665 (fill_type *, lang_output_section_phdr_list *);
666 extern void lang_leave_overlay
667 (etree_type *, int, fill_type *, const char *,
668 lang_output_section_phdr_list *, const char *);
670 extern struct bfd_elf_version_expr *lang_new_vers_pattern
671 (struct bfd_elf_version_expr *, const char *, const char *, bfd_boolean);
672 extern struct bfd_elf_version_tree *lang_new_vers_node
673 (struct bfd_elf_version_expr *, struct bfd_elf_version_expr *);
674 extern struct bfd_elf_version_deps *lang_add_vers_depend
675 (struct bfd_elf_version_deps *, const char *);
676 extern void lang_register_vers_node
677 (const char *, struct bfd_elf_version_tree *, struct bfd_elf_version_deps *);
678 extern void lang_append_dynamic_list (struct bfd_elf_dynamic_list **,
679 struct bfd_elf_version_expr *);
680 extern void lang_append_dynamic_list_cpp_typeinfo (void);
681 extern void lang_append_dynamic_list_cpp_new (void);
682 extern void lang_add_unique
683 (const char *);
684 extern const char *lang_get_output_target
685 (void);
686 extern void add_excluded_libs (const char *);
687 extern bfd_boolean load_symbols
688 (lang_input_statement_type *, lang_statement_list_type *);
690 struct elf_sym_strtab;
691 struct elf_strtab_hash;
692 extern void ldlang_ctf_apply_strsym
693 (struct elf_sym_strtab *, bfd_size_type, struct elf_strtab_hash *);
694 extern void ldlang_write_ctf_late
695 (void);
696 extern bfd_boolean
697 ldlang_override_segment_assignment
698 (struct bfd_link_info *, bfd *, asection *, asection *, bfd_boolean);
700 extern void
701 lang_ld_feature (char *);
703 extern void
704 lang_print_memory_usage (void);
706 extern void
707 lang_add_gc_name (const char *);
709 extern bfd_boolean
710 print_one_symbol (struct bfd_link_hash_entry *hash_entry, void *ptr);
712 #endif