contrib/binutils-2.17/ld/ldlang.h

   1 /* ldlang.h - linker command language support
   2    Copyright 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
   3    2001, 2002, 2003, 2004, 2005
   4    Free Software Foundation, Inc.
   5
   6    This file is part of GLD, the Gnu Linker.
   7
   8    GLD is free software; you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 2, or (at your option)
  11    any later version.
  12
  13    GLD is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with GLD; see the file COPYING.  If not, write to the Free
  20    Software Foundation, 51 Franklin Street - Fifth Floor, Boston, MA
  21    02110-1301, USA.  */
  22
  23 #ifndef LDLANG_H
  24 #define LDLANG_H
  25
  26 #define DEFAULT_MEMORY_REGION   "*default*"
  27
  28 typedef enum
  29 {
  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;
  37
  38 struct _fill_type
  39 {
  40   size_t size;
  41   unsigned char data[1];
  42 };
  43
  44 typedef struct statement_list
  45 {
  46   union lang_statement_union *head;
  47   union lang_statement_union **tail;
  48 } lang_statement_list_type;
  49
  50 typedef struct memory_region_struct
  51 {
  52   char *name;
  53   struct memory_region_struct *next;
  54   bfd_vma origin;
  55   bfd_size_type length;
  56   bfd_vma current;
  57   bfd_size_type old_length;
  58   flagword flags;
  59   flagword not_flags;
  60   bfd_boolean had_full_message;
  61 } lang_memory_region_type;
  62
  63 typedef struct lang_statement_header_struct
  64 {
  65   union lang_statement_union *next;
  66   enum statement_enum
  67   {
  68     lang_output_section_statement_enum,
  69     lang_assignment_statement_enum,
  70     lang_input_statement_enum,
  71     lang_address_statement_enum,
  72     lang_wild_statement_enum,
  73     lang_input_section_enum,
  74     lang_object_symbols_statement_enum,
  75     lang_fill_statement_enum,
  76     lang_data_statement_enum,
  77     lang_reloc_statement_enum,
  78     lang_target_statement_enum,
  79     lang_output_statement_enum,
  80     lang_padding_statement_enum,
  81     lang_group_statement_enum,
  82
  83     lang_afile_asection_pair_statement_enum,
  84     lang_constructors_statement_enum
  85   } type;
  86 } lang_statement_header_type;
  87
  88 typedef struct
  89 {
  90   lang_statement_header_type header;
  91   union etree_union *exp;
  92 } lang_assignment_statement_type;
  93
  94 typedef struct lang_target_statement_struct
  95 {
  96   lang_statement_header_type header;
  97   const char *target;
  98 } lang_target_statement_type;
  99
 100 typedef struct lang_output_statement_struct
 101 {
 102   lang_statement_header_type header;
 103   const char *name;
 104 } lang_output_statement_type;
 105
 106 /* Section types specified in a linker script.  */
 107
 108 enum section_type
 109 {
 110   normal_section,
 111   dsect_section,
 112   copy_section,
 113   noload_section,
 114   info_section,
 115   overlay_section
 116 };
 117
 118 /* This structure holds a list of program headers describing
 119    segments in which this section should be placed.  */
 120
 121 typedef struct lang_output_section_phdr_list
 122 {
 123   struct lang_output_section_phdr_list *next;
 124   const char *name;
 125   bfd_boolean used;
 126 } lang_output_section_phdr_list;
 127
 128 typedef struct lang_output_section_statement_struct
 129 {
 130   lang_statement_header_type header;
 131   lang_statement_list_type children;
 132   struct lang_output_section_statement_struct *next;
 133   struct lang_output_section_statement_struct *prev;
 134   const char *name;
 135   asection *bfd_section;
 136   lang_memory_region_type *region;
 137   lang_memory_region_type *lma_region;
 138   fill_type *fill;
 139   union etree_union *addr_tree;
 140   union etree_union *load_base;
 141
 142   /* If non-null, an expression to evaluate after setting the section's
 143      size.  The expression is evaluated inside REGION (above) with '.'
 144      set to the end of the section.  Used in the last overlay section
 145      to move '.' past all the overlaid sections.  */
 146   union etree_union *update_dot_tree;
 147
 148   lang_output_section_phdr_list *phdrs;
 149
 150   unsigned int block_value;
 151   int subsection_alignment;     /* Alignment of components.  */
 152   int section_alignment;        /* Alignment of start of section.  */
 153   int constraint;
 154   flagword flags;
 155   enum section_type sectype;
 156   unsigned int processed : 1;
 157   unsigned int all_input_readonly : 1;
 158   unsigned int ignored : 1;
 159 } lang_output_section_statement_type;
 160
 161 typedef struct
 162 {
 163   lang_statement_header_type header;
 164 } lang_common_statement_type;
 165
 166 typedef struct
 167 {
 168   lang_statement_header_type header;
 169 } lang_object_symbols_statement_type;
 170
 171 typedef struct
 172 {
 173   lang_statement_header_type header;
 174   fill_type *fill;
 175   int size;
 176   asection *output_section;
 177 } lang_fill_statement_type;
 178
 179 typedef struct
 180 {
 181   lang_statement_header_type header;
 182   unsigned int type;
 183   union etree_union *exp;
 184   bfd_vma value;
 185   asection *output_section;
 186   bfd_vma output_offset;
 187 } lang_data_statement_type;
 188
 189 /* Generate a reloc in the output file.  */
 190
 191 typedef struct
 192 {
 193   lang_statement_header_type header;
 194
 195   /* Reloc to generate.  */
 196   bfd_reloc_code_real_type reloc;
 197
 198   /* Reloc howto structure.  */
 199   reloc_howto_type *howto;
 200
 201   /* Section to generate reloc against.
 202      Exactly one of section and name must be NULL.  */
 203   asection *section;
 204
 205   /* Name of symbol to generate reloc against.
 206      Exactly one of section and name must be NULL.  */
 207   const char *name;
 208
 209   /* Expression for addend.  */
 210   union etree_union *addend_exp;
 211
 212   /* Resolved addend.  */
 213   bfd_vma addend_value;
 214
 215   /* Output section where reloc should be performed.  */
 216   asection *output_section;
 217
 218   /* Offset within output section.  */
 219   bfd_vma output_offset;
 220 } lang_reloc_statement_type;
 221
 222 typedef struct lang_input_statement_struct
 223 {
 224   lang_statement_header_type header;
 225   /* Name of this file.  */
 226   const char *filename;
 227   /* Name to use for the symbol giving address of text start.
 228      Usually the same as filename, but for a file spec'd with
 229      -l this is the -l switch itself rather than the filename.  */
 230   const char *local_sym_name;
 231
 232   bfd *the_bfd;
 233
 234   file_ptr passive_position;
 235
 236   /* Symbol table of the file.  */
 237   asymbol **asymbols;
 238   unsigned int symbol_count;
 239
 240   /* Point to the next file - whatever it is, wanders up and down
 241      archives */
 242   union lang_statement_union *next;
 243
 244   /* Point to the next file, but skips archive contents.  */
 245   union lang_statement_union *next_real_file;
 246
 247   const char *target;
 248
 249   unsigned int closed : 1;
 250   unsigned int is_archive : 1;
 251
 252   /* 1 means search a set of directories for this file.  */
 253   unsigned int search_dirs_flag : 1;
 254
 255   /* 1 means this was found in a search directory marked as sysrooted,
 256      if search_dirs_flag is false, otherwise, that it should be
 257      searched in ld_sysroot before any other location, as long as it
 258      starts with a slash.  */
 259   unsigned int sysrooted : 1;
 260
 261   /* 1 means this is base file of incremental load.
 262      Do not load this file's text or data.
 263      Also default text_start to after this file's bss.  */
 264   unsigned int just_syms_flag : 1;
 265
 266   /* Whether to search for this entry as a dynamic archive.  */
 267   unsigned int dynamic : 1;
 268
 269   /* Whether DT_NEEDED tags should be added for dynamic libraries in
 270      DT_NEEDED tags from this entry.  */
 271   unsigned int add_needed : 1;
 272
 273   /* Whether this entry should cause a DT_NEEDED tag only when
 274      satisfying references from regular files, or always.  */
 275   unsigned int as_needed : 1;
 276
 277   /* Whether to include the entire contents of an archive.  */
 278   unsigned int whole_archive : 1;
 279
 280   unsigned int loaded : 1;
 281
 282   unsigned int real : 1;
 283 } lang_input_statement_type;
 284
 285 typedef struct
 286 {
 287   lang_statement_header_type header;
 288   asection *section;
 289 } lang_input_section_type;
 290
 291 typedef struct
 292 {
 293   lang_statement_header_type header;
 294   asection *section;
 295   union lang_statement_union *file;
 296 } lang_afile_asection_pair_statement_type;
 297
 298 typedef struct lang_wild_statement_struct lang_wild_statement_type;
 299
 300 typedef void (*callback_t) (lang_wild_statement_type *, struct wildcard_list *,
 301                             asection *, lang_input_statement_type *, void *);
 302
 303 typedef void (*walk_wild_section_handler_t) (lang_wild_statement_type *,
 304                                              lang_input_statement_type *,
 305                                              callback_t callback,
 306                                              void *data);
 307
 308 typedef bfd_boolean (*lang_match_sec_type_func) (bfd *, const asection *,
 309                                                  bfd *, const asection *);
 310
 311 struct lang_wild_statement_struct
 312 {
 313   lang_statement_header_type header;
 314   const char *filename;
 315   bfd_boolean filenames_sorted;
 316   struct wildcard_list *section_list;
 317   bfd_boolean keep_sections;
 318   lang_statement_list_type children;
 319
 320   walk_wild_section_handler_t walk_wild_section_handler;
 321   struct wildcard_list *handler_data[4];
 322 };
 323
 324 typedef struct lang_address_statement_struct
 325 {
 326   lang_statement_header_type header;
 327   const char *section_name;
 328   union etree_union *address;
 329   const segment_type *segment;
 330 } lang_address_statement_type;
 331
 332 typedef struct
 333 {
 334   lang_statement_header_type header;
 335   bfd_vma output_offset;
 336   size_t size;
 337   asection *output_section;
 338   fill_type *fill;
 339 } lang_padding_statement_type;
 340
 341 /* A group statement collects a set of libraries together.  The
 342    libraries are searched multiple times, until no new undefined
 343    symbols are found.  The effect is to search a group of libraries as
 344    though they were a single library.  */
 345
 346 typedef struct
 347 {
 348   lang_statement_header_type header;
 349   lang_statement_list_type children;
 350 } lang_group_statement_type;
 351
 352 typedef union lang_statement_union
 353 {
 354   lang_statement_header_type header;
 355   lang_wild_statement_type wild_statement;
 356   lang_data_statement_type data_statement;
 357   lang_reloc_statement_type reloc_statement;
 358   lang_address_statement_type address_statement;
 359   lang_output_section_statement_type output_section_statement;
 360   lang_afile_asection_pair_statement_type afile_asection_pair_statement;
 361   lang_assignment_statement_type assignment_statement;
 362   lang_input_statement_type input_statement;
 363   lang_target_statement_type target_statement;
 364   lang_output_statement_type output_statement;
 365   lang_input_section_type input_section;
 366   lang_common_statement_type common_statement;
 367   lang_object_symbols_statement_type object_symbols_statement;
 368   lang_fill_statement_type fill_statement;
 369   lang_padding_statement_type padding_statement;
 370   lang_group_statement_type group_statement;
 371 } lang_statement_union_type;
 372
 373 /* This structure holds information about a program header, from the
 374    PHDRS command in the linker script.  */
 375
 376 struct lang_phdr
 377 {
 378   struct lang_phdr *next;
 379   const char *name;
 380   unsigned long type;
 381   bfd_boolean filehdr;
 382   bfd_boolean phdrs;
 383   etree_type *at;
 384   etree_type *flags;
 385 };
 386
 387 /* This structure is used to hold a list of sections which may not
 388    cross reference each other.  */
 389
 390 typedef struct lang_nocrossref
 391 {
 392   struct lang_nocrossref *next;
 393   const char *name;
 394 } lang_nocrossref_type;
 395
 396 /* The list of nocrossref lists.  */
 397
 398 struct lang_nocrossrefs
 399 {
 400   struct lang_nocrossrefs *next;
 401   lang_nocrossref_type *list;
 402 };
 403
 404 extern struct lang_nocrossrefs *nocrossref_list;
 405
 406 /* This structure is used to hold a list of input section names which
 407    will not match an output section in the linker script.  */
 408
 409 struct unique_sections
 410 {
 411   struct unique_sections *next;
 412   const char *name;
 413 };
 414
 415 /* This structure records symbols for which we need to keep track of
 416    definedness for use in the DEFINED () test.  */
 417
 418 struct lang_definedness_hash_entry
 419 {
 420   struct bfd_hash_entry root;
 421   int iteration;
 422 };
 423
 424 /* Used by place_orphan to keep track of orphan sections and statements.  */
 425
 426 struct orphan_save {
 427   const char *name;
 428   flagword flags;
 429   lang_output_section_statement_type *os;
 430   asection **section;
 431   lang_statement_union_type **stmt;
 432   lang_output_section_statement_type **os_tail;
 433 };
 434
 435 extern lang_output_section_statement_type *abs_output_section;
 436 extern lang_statement_list_type lang_output_section_statement;
 437 extern bfd_boolean lang_has_input_file;
 438 extern etree_type *base;
 439 extern lang_statement_list_type *stat_ptr;
 440 extern bfd_boolean delete_output_file_on_failure;
 441
 442 extern struct bfd_sym_chain entry_symbol;
 443 extern const char *entry_section;
 444 extern bfd_boolean entry_from_cmdline;
 445 extern lang_statement_list_type file_chain;
 446
 447 extern int lang_statement_iteration;
 448
 449 extern void lang_init
 450   (void);
 451 extern void lang_finish
 452   (void);
 453 extern lang_memory_region_type *lang_memory_region_lookup
 454   (const char *const, bfd_boolean);
 455 extern lang_memory_region_type *lang_memory_region_default
 456   (asection *);
 457 extern void lang_map
 458   (void);
 459 extern void lang_set_flags
 460   (lang_memory_region_type *, const char *, int);
 461 extern void lang_add_output
 462   (const char *, int from_script);
 463 extern lang_output_section_statement_type *lang_enter_output_section_statement
 464   (const char *output_section_statement_name,
 465    etree_type *address_exp,
 466    enum section_type sectype,
 467    etree_type *align,
 468    etree_type *subalign,
 469    etree_type *, int);
 470 extern void lang_final
 471   (void);
 472 extern void lang_process
 473   (void);
 474 extern void lang_section_start
 475   (const char *, union etree_union *, const segment_type *);
 476 extern void lang_add_entry
 477   (const char *, bfd_boolean);
 478 extern void lang_default_entry
 479   (const char *);
 480 extern void lang_add_target
 481   (const char *);
 482 extern void lang_add_wild
 483   (struct wildcard_spec *, struct wildcard_list *, bfd_boolean);
 484 extern void lang_add_map
 485   (const char *);
 486 extern void lang_add_fill
 487   (fill_type *);
 488 extern lang_assignment_statement_type *lang_add_assignment
 489   (union etree_union *);
 490 extern void lang_add_attribute
 491   (enum statement_enum);
 492 extern void lang_startup
 493   (const char *);
 494 extern void lang_float
 495   (bfd_boolean);
 496 extern void lang_leave_output_section_statement
 497   (fill_type *, const char *, lang_output_section_phdr_list *,
 498    const char *);
 499 extern void lang_abs_symbol_at_end_of
 500   (const char *, const char *);
 501 extern void lang_abs_symbol_at_beginning_of
 502   (const char *, const char *);
 503 extern void lang_statement_append
 504   (lang_statement_list_type *, lang_statement_union_type *,
 505    lang_statement_union_type **);
 506 extern void lang_for_each_input_file
 507   (void (*dothis) (lang_input_statement_type *));
 508 extern void lang_for_each_file
 509   (void (*dothis) (lang_input_statement_type *));
 510 extern void lang_reset_memory_regions
 511   (void);
 512 extern void lang_do_assignments
 513   (void);
 514
 515 #define LANG_FOR_EACH_INPUT_STATEMENT(statement)                        \
 516   lang_input_statement_type *statement;                                 \
 517   for (statement = (lang_input_statement_type *) file_chain.head;       \
 518        statement != (lang_input_statement_type *) NULL;                 \
 519        statement = (lang_input_statement_type *) statement->next)       \
 520
 521 extern void lang_process
 522   (void);
 523 extern void ldlang_add_file
 524   (lang_input_statement_type *);
 525 extern lang_output_section_statement_type *lang_output_section_find
 526   (const char * const);
 527 extern lang_output_section_statement_type *lang_output_section_find_by_flags
 528   (const asection *, lang_output_section_statement_type **,
 529    lang_match_sec_type_func);
 530 extern lang_output_section_statement_type *lang_insert_orphan
 531   (asection *, const char *, lang_output_section_statement_type *,
 532    struct orphan_save *, etree_type *, lang_statement_list_type *);
 533 extern lang_input_statement_type *lang_add_input_file
 534   (const char *, lang_input_file_enum_type, const char *);
 535 extern void lang_add_keepsyms_file
 536   (const char *);
 537 extern lang_output_section_statement_type *
 538   lang_output_section_statement_lookup
 539   (const char *const);
 540 extern void ldlang_add_undef
 541   (const char *const);
 542 extern void lang_add_output_format
 543   (const char *, const char *, const char *, int);
 544 extern void lang_list_init
 545   (lang_statement_list_type *);
 546 extern void lang_add_data
 547   (int type, union etree_union *);
 548 extern void lang_add_reloc
 549   (bfd_reloc_code_real_type, reloc_howto_type *, asection *, const char *,
 550    union etree_union *);
 551 extern void lang_for_each_statement
 552   (void (*) (lang_statement_union_type *));
 553 extern void *stat_alloc
 554   (size_t);
 555 extern void strip_excluded_output_sections
 556   (void);
 557 extern void dprint_statement
 558   (lang_statement_union_type *, int);
 559 extern void lang_size_sections
 560   (bfd_boolean *, bfd_boolean);
 561 extern void one_lang_size_sections_pass
 562   (bfd_boolean *, bfd_boolean);
 563 extern void lang_enter_group
 564   (void);
 565 extern void lang_leave_group
 566   (void);
 567 extern void lang_add_section
 568   (lang_statement_list_type *, asection *,
 569    lang_output_section_statement_type *);
 570 extern void lang_new_phdr
 571   (const char *, etree_type *, bfd_boolean, bfd_boolean, etree_type *,
 572    etree_type *);
 573 extern void lang_add_nocrossref
 574   (lang_nocrossref_type *);
 575 extern void lang_enter_overlay
 576   (etree_type *, etree_type *);
 577 extern void lang_enter_overlay_section
 578   (const char *);
 579 extern void lang_leave_overlay_section
 580   (fill_type *, lang_output_section_phdr_list *);
 581 extern void lang_leave_overlay
 582   (etree_type *, int, fill_type *, const char *,
 583    lang_output_section_phdr_list *, const char *);
 584
 585 extern struct bfd_elf_version_tree *lang_elf_version_info;
 586
 587 extern struct bfd_elf_version_expr *lang_new_vers_pattern
 588   (struct bfd_elf_version_expr *, const char *, const char *, bfd_boolean);
 589 extern struct bfd_elf_version_tree *lang_new_vers_node
 590   (struct bfd_elf_version_expr *, struct bfd_elf_version_expr *);
 591 extern struct bfd_elf_version_deps *lang_add_vers_depend
 592   (struct bfd_elf_version_deps *, const char *);
 593 extern void lang_register_vers_node
 594   (const char *, struct bfd_elf_version_tree *, struct bfd_elf_version_deps *);
 595 bfd_boolean unique_section_p
 596   (const asection *);
 597 extern void lang_add_unique
 598   (const char *);
 599 extern const char *lang_get_output_target
 600   (void);
 601 extern void lang_track_definedness (const char *);
 602 extern int lang_symbol_definition_iteration (const char *);
 603 extern void lang_update_definedness
 604   (const char *, struct bfd_link_hash_entry *);
 605
 606 extern void add_excluded_libs (const char *);
 607
 608 #endif