ld/ldlang.h

   1 /* ldlang.h - linker command language support
   2    Copyright (C) 1991-2014 Free Software Foundation, Inc.
   3
   4    This file is part of the GNU Binutils.
   5
   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.
  10
  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.
  15
  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.  */
  20
  21 #ifndef LDLANG_H
  22 #define LDLANG_H
  23
  24 #define DEFAULT_MEMORY_REGION   "*default*"
  25
  26 typedef enum
  27 {
  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;
  35
  36 struct _fill_type
  37 {
  38   size_t size;
  39   unsigned char data[1];
  40 };
  41
  42 typedef struct statement_list
  43 {
  44   union lang_statement_union *  head;
  45   union lang_statement_union ** tail;
  46 } lang_statement_list_type;
  47
  48 typedef struct memory_region_name_struct
  49 {
  50   const char * name;
  51   struct memory_region_name_struct * next;
  52 } lang_memory_region_name;
  53
  54 typedef struct memory_region_struct
  55 {
  56   lang_memory_region_name name_list;
  57   struct memory_region_struct *next;
  58   bfd_vma origin;
  59   bfd_size_type length;
  60   bfd_vma current;
  61   union lang_statement_union *last_os;
  62   flagword flags;
  63   flagword not_flags;
  64   bfd_boolean had_full_message;
  65 } lang_memory_region_type;
  66
  67 enum statement_enum
  68 {
  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
  85 };
  86
  87 typedef struct lang_statement_header_struct
  88 {
  89   union lang_statement_union *next;
  90   enum statement_enum type;
  91 } lang_statement_header_type;
  92
  93 typedef struct
  94 {
  95   lang_statement_header_type header;
  96   union etree_union *exp;
  97 } lang_assignment_statement_type;
  98
  99 typedef struct lang_target_statement_struct
 100 {
 101   lang_statement_header_type header;
 102   const char *target;
 103 } lang_target_statement_type;
 104
 105 typedef struct lang_output_statement_struct
 106 {
 107   lang_statement_header_type header;
 108   const char *name;
 109 } lang_output_statement_type;
 110
 111 /* Section types specified in a linker script.  */
 112
 113 enum section_type
 114 {
 115   normal_section,
 116   overlay_section,
 117   noload_section,
 118   noalloc_section
 119 };
 120
 121 /* This structure holds a list of program headers describing
 122    segments in which this section should be placed.  */
 123
 124 typedef struct lang_output_section_phdr_list
 125 {
 126   struct lang_output_section_phdr_list *next;
 127   const char *name;
 128   bfd_boolean used;
 129 } lang_output_section_phdr_list;
 130
 131 typedef struct lang_output_section_statement_struct
 132 {
 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;
 137   const char *name;
 138   asection *bfd_section;
 139   lang_memory_region_type *region;
 140   lang_memory_region_type *lma_region;
 141   fill_type *fill;
 142   union etree_union *addr_tree;
 143   union etree_union *load_base;
 144
 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;
 150
 151   lang_output_section_phdr_list *phdrs;
 152
 153   unsigned int block_value;
 154   int subsection_alignment;     /* Alignment of components.  */
 155   int section_alignment;        /* Alignment of start of section.  */
 156   int constraint;
 157   flagword flags;
 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;
 171
 172 typedef struct
 173 {
 174   lang_statement_header_type header;
 175 } lang_common_statement_type;
 176
 177 typedef struct
 178 {
 179   lang_statement_header_type header;
 180 } lang_object_symbols_statement_type;
 181
 182 typedef struct
 183 {
 184   lang_statement_header_type header;
 185   fill_type *fill;
 186   int size;
 187   asection *output_section;
 188 } lang_fill_statement_type;
 189
 190 typedef struct
 191 {
 192   lang_statement_header_type header;
 193   unsigned int type;
 194   union etree_union *exp;
 195   bfd_vma value;
 196   asection *output_section;
 197   bfd_vma output_offset;
 198 } lang_data_statement_type;
 199
 200 /* Generate a reloc in the output file.  */
 201
 202 typedef struct
 203 {
 204   lang_statement_header_type header;
 205
 206   /* Reloc to generate.  */
 207   bfd_reloc_code_real_type reloc;
 208
 209   /* Reloc howto structure.  */
 210   reloc_howto_type *howto;
 211
 212   /* Section to generate reloc against.
 213      Exactly one of section and name must be NULL.  */
 214   asection *section;
 215
 216   /* Name of symbol to generate reloc against.
 217      Exactly one of section and name must be NULL.  */
 218   const char *name;
 219
 220   /* Expression for addend.  */
 221   union etree_union *addend_exp;
 222
 223   /* Resolved addend.  */
 224   bfd_vma addend_value;
 225
 226   /* Output section where reloc should be performed.  */
 227   asection *output_section;
 228
 229   /* Offset within output section.  */
 230   bfd_vma output_offset;
 231 } lang_reloc_statement_type;
 232
 233 struct lang_input_statement_flags
 234 {
 235   /* 1 means this file was specified in a -l option.  */
 236   unsigned int maybe_archive : 1;
 237
 238   /* 1 means this file was specified in a -l:namespec option.  */
 239   unsigned int full_name_provided : 1;
 240
 241   /* 1 means search a set of directories for this file.  */
 242   unsigned int search_dirs : 1;
 243
 244   /* 1 means this was found when processing a script in the sysroot.  */
 245   unsigned int sysrooted : 1;
 246
 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;
 251
 252   /* Whether to search for this entry as a dynamic archive.  */
 253   unsigned int dynamic : 1;
 254
 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;
 259
 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;
 263
 264   /* Whether to include the entire contents of an archive.  */
 265   unsigned int whole_archive : 1;
 266
 267   /* Set when bfd opening is successful.  */
 268   unsigned int loaded : 1;
 269
 270   unsigned int real : 1;
 271
 272   /* Set if the file does not exist.  */
 273   unsigned int missing_file : 1;
 274
 275 #ifdef ENABLE_PLUGINS
 276   /* Set if the file was claimed by a plugin.  */
 277   unsigned int claimed : 1;
 278
 279   /* Set if the file was claimed from an archive.  */
 280   unsigned int claim_archive : 1;
 281
 282   /* Set if reloading an --as-needed lib.  */
 283   unsigned int reload : 1;
 284 #endif /* ENABLE_PLUGINS */
 285 };
 286
 287 typedef struct lang_input_statement_struct
 288 {
 289   lang_statement_header_type header;
 290   /* Name of this file.  */
 291   const char *filename;
 292   /* Name to use for the symbol giving address of text start.
 293      Usually the same as filename, but for a file spec'd with
 294      -l this is the -l switch itself rather than the filename.  */
 295   const char *local_sym_name;
 296
 297   bfd *the_bfd;
 298
 299   struct flag_info *section_flag_list;
 300
 301   /* Point to the next file - whatever it is, wanders up and down
 302      archives */
 303   union lang_statement_union *next;
 304
 305   /* Point to the next file, but skips archive contents.  */
 306   union lang_statement_union *next_real_file;
 307
 308   const char *target;
 309
 310   struct lang_input_statement_flags flags;
 311 } lang_input_statement_type;
 312
 313 typedef struct
 314 {
 315   lang_statement_header_type header;
 316   asection *section;
 317 } lang_input_section_type;
 318
 319 struct map_symbol_def {
 320   struct bfd_link_hash_entry *entry;
 321   struct map_symbol_def *next;
 322 };
 323
 324 /* For input sections, when writing a map file: head / tail of a linked
 325    list of hash table entries for symbols defined in this section.  */
 326 typedef struct input_section_userdata_struct
 327 {
 328   struct map_symbol_def *map_symbol_def_head;
 329   struct map_symbol_def **map_symbol_def_tail;
 330   unsigned long map_symbol_def_count;
 331 } input_section_userdata_type;
 332
 333 #define get_userdata(x) ((x)->userdata)
 334
 335
 336 typedef struct lang_wild_statement_struct lang_wild_statement_type;
 337
 338 typedef void (*callback_t) (lang_wild_statement_type *, struct wildcard_list *,
 339                             asection *, struct flag_info *,
 340                             lang_input_statement_type *, void *);
 341
 342 typedef void (*walk_wild_section_handler_t) (lang_wild_statement_type *,
 343                                              lang_input_statement_type *,
 344                                              callback_t callback,
 345                                              void *data);
 346
 347 typedef bfd_boolean (*lang_match_sec_type_func) (bfd *, const asection *,
 348                                                  bfd *, const asection *);
 349
 350 /* Binary search tree structure to efficiently sort sections by
 351    name.  */
 352 typedef struct lang_section_bst
 353 {
 354   asection *section;
 355   struct lang_section_bst *left;
 356   struct lang_section_bst *right;
 357 } lang_section_bst_type;
 358
 359 struct lang_wild_statement_struct
 360 {
 361   lang_statement_header_type header;
 362   const char *filename;
 363   bfd_boolean filenames_sorted;
 364   struct wildcard_list *section_list;
 365   bfd_boolean keep_sections;
 366   lang_statement_list_type children;
 367
 368   walk_wild_section_handler_t walk_wild_section_handler;
 369   struct wildcard_list *handler_data[4];
 370   lang_section_bst_type *tree;
 371   struct flag_info *section_flag_list;
 372 };
 373
 374 typedef struct lang_address_statement_struct
 375 {
 376   lang_statement_header_type header;
 377   const char *section_name;
 378   union etree_union *address;
 379   const segment_type *segment;
 380 } lang_address_statement_type;
 381
 382 typedef struct
 383 {
 384   lang_statement_header_type header;
 385   bfd_vma output_offset;
 386   bfd_size_type size;
 387   asection *output_section;
 388   fill_type *fill;
 389 } lang_padding_statement_type;
 390
 391 /* A group statement collects a set of libraries together.  The
 392    libraries are searched multiple times, until no new undefined
 393    symbols are found.  The effect is to search a group of libraries as
 394    though they were a single library.  */
 395
 396 typedef struct
 397 {
 398   lang_statement_header_type header;
 399   lang_statement_list_type children;
 400 } lang_group_statement_type;
 401
 402 typedef struct
 403 {
 404   lang_statement_header_type header;
 405   const char *where;
 406   bfd_boolean is_before;
 407 } lang_insert_statement_type;
 408
 409 typedef union lang_statement_union
 410 {
 411   lang_statement_header_type header;
 412   lang_wild_statement_type wild_statement;
 413   lang_data_statement_type data_statement;
 414   lang_reloc_statement_type reloc_statement;
 415   lang_address_statement_type address_statement;
 416   lang_output_section_statement_type output_section_statement;
 417   lang_assignment_statement_type assignment_statement;
 418   lang_input_statement_type input_statement;
 419   lang_target_statement_type target_statement;
 420   lang_output_statement_type output_statement;
 421   lang_input_section_type input_section;
 422   lang_common_statement_type common_statement;
 423   lang_object_symbols_statement_type object_symbols_statement;
 424   lang_fill_statement_type fill_statement;
 425   lang_padding_statement_type padding_statement;
 426   lang_group_statement_type group_statement;
 427   lang_insert_statement_type insert_statement;
 428 } lang_statement_union_type;
 429
 430 /* This structure holds information about a program header, from the
 431    PHDRS command in the linker script.  */
 432
 433 struct lang_phdr
 434 {
 435   struct lang_phdr *next;
 436   const char *name;
 437   unsigned long type;
 438   bfd_boolean filehdr;
 439   bfd_boolean phdrs;
 440   etree_type *at;
 441   etree_type *flags;
 442 };
 443
 444 /* This structure is used to hold a list of sections which may not
 445    cross reference each other.  */
 446
 447 typedef struct lang_nocrossref
 448 {
 449   struct lang_nocrossref *next;
 450   const char *name;
 451 } lang_nocrossref_type;
 452
 453 /* The list of nocrossref lists.  */
 454
 455 struct lang_nocrossrefs
 456 {
 457   struct lang_nocrossrefs *next;
 458   lang_nocrossref_type *list;
 459 };
 460
 461 /* This structure is used to hold a list of input section names which
 462    will not match an output section in the linker script.  */
 463
 464 struct unique_sections
 465 {
 466   struct unique_sections *next;
 467   const char *name;
 468 };
 469
 470 /* This structure records symbols for which we need to keep track of
 471    definedness for use in the DEFINED () test.  */
 472
 473 struct lang_definedness_hash_entry
 474 {
 475   struct bfd_hash_entry root;
 476   unsigned int by_object : 1;
 477   unsigned int by_script : 1;
 478   unsigned int iteration : 1;
 479 };
 480
 481 /* Used by place_orphan to keep track of orphan sections and statements.  */
 482
 483 struct orphan_save
 484 {
 485   const char *name;
 486   flagword flags;
 487   lang_output_section_statement_type *os;
 488   asection **section;
 489   lang_statement_union_type **stmt;
 490   lang_output_section_statement_type **os_tail;
 491 };
 492
 493 struct asneeded_minfo
 494 {
 495   struct asneeded_minfo *next;
 496   const char *soname;
 497   bfd *ref;
 498   const char *name;
 499 };
 500
 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 etree_type *base;
 509 extern lang_statement_list_type *stat_ptr;
 510 extern bfd_boolean delete_output_file_on_failure;
 511
 512 extern struct bfd_sym_chain entry_symbol;
 513 extern const char *entry_section;
 514 extern bfd_boolean entry_from_cmdline;
 515 extern lang_statement_list_type file_chain;
 516 extern lang_statement_list_type input_file_chain;
 517
 518 extern int lang_statement_iteration;
 519 extern struct asneeded_minfo **asneeded_list_tail;
 520
 521 extern void lang_init
 522   (void);
 523 extern void lang_finish
 524   (void);
 525 extern lang_memory_region_type * lang_memory_region_lookup
 526   (const char * const, bfd_boolean);
 527 extern void lang_memory_region_alias
 528   (const char *, const char *);
 529 extern void lang_map
 530   (void);
 531 extern void lang_set_flags
 532   (lang_memory_region_type *, const char *, int);
 533 extern void lang_add_output
 534   (const char *, int from_script);
 535 extern lang_output_section_statement_type *lang_enter_output_section_statement
 536   (const char *, etree_type *, enum section_type, etree_type *, etree_type *,
 537    etree_type *, int, int);
 538 extern void lang_final
 539   (void);
 540 extern void lang_relax_sections
 541   (bfd_boolean);
 542 extern void lang_process
 543   (void);
 544 extern void lang_section_start
 545   (const char *, union etree_union *, const segment_type *);
 546 extern void lang_add_entry
 547   (const char *, bfd_boolean);
 548 extern void lang_default_entry
 549   (const char *);
 550 extern void lang_add_target
 551   (const char *);
 552 extern void lang_add_wild
 553   (struct wildcard_spec *, struct wildcard_list *, bfd_boolean);
 554 extern void lang_add_map
 555   (const char *);
 556 extern void lang_add_fill
 557   (fill_type *);
 558 extern lang_assignment_statement_type *lang_add_assignment
 559   (union etree_union *);
 560 extern void lang_add_attribute
 561   (enum statement_enum);
 562 extern void lang_startup
 563   (const char *);
 564 extern void lang_float
 565   (bfd_boolean);
 566 extern void lang_leave_output_section_statement
 567   (fill_type *, const char *, lang_output_section_phdr_list *,
 568    const char *);
 569 extern void lang_statement_append
 570   (lang_statement_list_type *, lang_statement_union_type *,
 571    lang_statement_union_type **);
 572 extern void lang_for_each_input_file
 573   (void (*dothis) (lang_input_statement_type *));
 574 extern void lang_for_each_file
 575   (void (*dothis) (lang_input_statement_type *));
 576 extern void lang_reset_memory_regions
 577   (void);
 578 extern void lang_do_assignments
 579   (lang_phase_type);
 580 extern asection *section_for_dot
 581   (void);
 582
 583 #define LANG_FOR_EACH_INPUT_STATEMENT(statement)                        \
 584   lang_input_statement_type *statement;                                 \
 585   for (statement = (lang_input_statement_type *) file_chain.head;       \
 586        statement != (lang_input_statement_type *) NULL;                 \
 587        statement = (lang_input_statement_type *) statement->next)       \
 588
 589 #define lang_output_section_find(NAME) \
 590   lang_output_section_statement_lookup (NAME, 0, FALSE)
 591
 592 extern void lang_process
 593   (void);
 594 extern void ldlang_add_file
 595   (lang_input_statement_type *);
 596 extern lang_output_section_statement_type *lang_output_section_find_by_flags
 597   (const asection *, lang_output_section_statement_type **,
 598    lang_match_sec_type_func);
 599 extern lang_output_section_statement_type *lang_insert_orphan
 600   (asection *, const char *, int, lang_output_section_statement_type *,
 601    struct orphan_save *, etree_type *, lang_statement_list_type *);
 602 extern lang_input_statement_type *lang_add_input_file
 603   (const char *, lang_input_file_enum_type, const char *);
 604 extern void lang_add_keepsyms_file
 605   (const char *);
 606 extern lang_output_section_statement_type *lang_output_section_get
 607   (const asection *);
 608 extern lang_output_section_statement_type *lang_output_section_statement_lookup
 609   (const char *, int, bfd_boolean);
 610 extern lang_output_section_statement_type *next_matching_output_section_statement
 611   (lang_output_section_statement_type *, int);
 612 extern void ldlang_add_undef
 613   (const char *const, bfd_boolean);
 614 extern void lang_add_output_format
 615   (const char *, const char *, const char *, int);
 616 extern void lang_list_init
 617   (lang_statement_list_type *);
 618 extern void push_stat_ptr
 619   (lang_statement_list_type *);
 620 extern void pop_stat_ptr
 621   (void);
 622 extern void lang_add_data
 623   (int type, union etree_union *);
 624 extern void lang_add_reloc
 625   (bfd_reloc_code_real_type, reloc_howto_type *, asection *, const char *,
 626    union etree_union *);
 627 extern void lang_for_each_statement
 628   (void (*) (lang_statement_union_type *));
 629 extern void lang_for_each_statement_worker
 630   (void (*) (lang_statement_union_type *), lang_statement_union_type *);
 631 extern void *stat_alloc
 632   (size_t);
 633 extern void strip_excluded_output_sections
 634   (void);
 635 extern void dprint_statement
 636   (lang_statement_union_type *, int);
 637 extern void lang_size_sections
 638   (bfd_boolean *, bfd_boolean);
 639 extern void one_lang_size_sections_pass
 640   (bfd_boolean *, bfd_boolean);
 641 extern void lang_add_insert
 642   (const char *, int);
 643 extern void lang_enter_group
 644   (void);
 645 extern void lang_leave_group
 646   (void);
 647 extern void lang_add_section
 648   (lang_statement_list_type *, asection *,
 649    struct flag_info *, lang_output_section_statement_type *);
 650 extern void lang_new_phdr
 651   (const char *, etree_type *, bfd_boolean, bfd_boolean, etree_type *,
 652    etree_type *);
 653 extern void lang_add_nocrossref
 654   (lang_nocrossref_type *);
 655 extern void lang_enter_overlay
 656   (etree_type *, etree_type *);
 657 extern void lang_enter_overlay_section
 658   (const char *);
 659 extern void lang_leave_overlay_section
 660   (fill_type *, lang_output_section_phdr_list *);
 661 extern void lang_leave_overlay
 662   (etree_type *, int, fill_type *, const char *,
 663    lang_output_section_phdr_list *, const char *);
 664
 665 extern struct bfd_elf_version_expr *lang_new_vers_pattern
 666   (struct bfd_elf_version_expr *, const char *, const char *, bfd_boolean);
 667 extern struct bfd_elf_version_tree *lang_new_vers_node
 668   (struct bfd_elf_version_expr *, struct bfd_elf_version_expr *);
 669 extern struct bfd_elf_version_deps *lang_add_vers_depend
 670   (struct bfd_elf_version_deps *, const char *);
 671 extern void lang_register_vers_node
 672   (const char *, struct bfd_elf_version_tree *, struct bfd_elf_version_deps *);
 673 extern void lang_append_dynamic_list (struct bfd_elf_version_expr *);
 674 extern void lang_append_dynamic_list_cpp_typeinfo (void);
 675 extern void lang_append_dynamic_list_cpp_new (void);
 676 extern void lang_add_unique
 677   (const char *);
 678 extern const char *lang_get_output_target
 679   (void);
 680 extern struct lang_definedness_hash_entry *lang_symbol_defined (const char *);
 681 extern void lang_update_definedness
 682   (const char *, struct bfd_link_hash_entry *);
 683
 684 extern void add_excluded_libs (const char *);
 685 extern bfd_boolean load_symbols
 686   (lang_input_statement_type *, lang_statement_list_type *);
 687
 688 extern bfd_boolean
 689 ldlang_override_segment_assignment
 690   (struct bfd_link_info *, bfd *, asection *, asection *, bfd_boolean);
 691
 692 extern void
 693 lang_ld_feature (char *);
 694
 695 #endif