toolchain/binutils/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
   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, 59 Temple Place - Suite 330, Boston, MA
  21    02111-1307, 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   union etree_union *addr_tree;
 132   lang_statement_list_type children;
 133   const char *memspec;
 134   union lang_statement_union *next;
 135   const char *name;
 136
 137   int processed;
 138
 139   asection *bfd_section;
 140   flagword flags;               /* Or together of all input sections.  */
 141   enum section_type sectype;
 142   lang_memory_region_type *region;
 143   lang_memory_region_type *lma_region;
 144   size_t block_value;
 145   fill_type *fill;
 146
 147   int subsection_alignment;     /* Alignment of components.  */
 148   int section_alignment;        /* Alignment of start of section.  */
 149
 150   union etree_union *load_base;
 151
 152   /* If non-null, an expression to evaluate after setting the section's
 153      size.  The expression is evaluated inside REGION (above) with '.'
 154      set to the end of the section.  Used in the last overlay section
 155      to move '.' past all the overlaid sections.  */
 156   union etree_union *update_dot_tree;
 157
 158   lang_output_section_phdr_list *phdrs;
 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_vma;
 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   /* VMA within output section.  */
 219   bfd_vma output_vma;
 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   bfd_boolean closed;
 235   file_ptr passive_position;
 236
 237   /* Symbol table of the file.  */
 238   asymbol **asymbols;
 239   unsigned int symbol_count;
 240
 241   /* Point to the next file - whatever it is, wanders up and down
 242      archives */
 243   union lang_statement_union *next;
 244
 245   /* Point to the next file, but skips archive contents.  */
 246   union lang_statement_union *next_real_file;
 247
 248   bfd_boolean is_archive;
 249
 250   /* 1 means search a set of directories for this file.  */
 251   bfd_boolean search_dirs_flag;
 252
 253   /* 1 means this was found in a search directory marked as sysrooted,
 254      if search_dirs_flag is false, otherwise, that it should be
 255      searched in ld_sysroot before any other location, as long as it
 256      starts with a slash.  */
 257   bfd_boolean sysrooted;
 258
 259   /* 1 means this is base file of incremental load.
 260      Do not load this file's text or data.
 261      Also default text_start to after this file's bss.  */
 262   bfd_boolean just_syms_flag;
 263
 264   /* Whether to search for this entry as a dynamic archive.  */
 265   bfd_boolean dynamic;
 266
 267   /* Whether this entry should cause a DT_NEEDED tag only when
 268      satisfying references from regular files, or always.  */
 269   bfd_boolean as_needed;
 270
 271   /* Whether to include the entire contents of an archive.  */
 272   bfd_boolean whole_archive;
 273
 274   bfd_boolean loaded;
 275
 276 #if 0
 277   unsigned int globals_in_this_file;
 278 #endif
 279   const char *target;
 280   bfd_boolean real;
 281 } lang_input_statement_type;
 282
 283 typedef struct
 284 {
 285   lang_statement_header_type header;
 286   asection *section;
 287   lang_input_statement_type *ifile;
 288
 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
 299 {
 300   lang_statement_header_type header;
 301   const char *filename;
 302   bfd_boolean filenames_sorted;
 303   struct wildcard_list *section_list;
 304   bfd_boolean keep_sections;
 305   lang_statement_list_type children;
 306 } lang_wild_statement_type;
 307
 308 typedef struct lang_address_statement_struct
 309 {
 310   lang_statement_header_type header;
 311   const char *section_name;
 312   union etree_union *address;
 313 } lang_address_statement_type;
 314
 315 typedef struct
 316 {
 317   lang_statement_header_type header;
 318   bfd_vma output_offset;
 319   size_t size;
 320   asection *output_section;
 321   fill_type *fill;
 322 } lang_padding_statement_type;
 323
 324 /* A group statement collects a set of libraries together.  The
 325    libraries are searched multiple times, until no new undefined
 326    symbols are found.  The effect is to search a group of libraries as
 327    though they were a single library.  */
 328
 329 typedef struct
 330 {
 331   lang_statement_header_type header;
 332   lang_statement_list_type children;
 333 } lang_group_statement_type;
 334
 335 typedef union lang_statement_union
 336 {
 337   lang_statement_header_type header;
 338   lang_wild_statement_type wild_statement;
 339   lang_data_statement_type data_statement;
 340   lang_reloc_statement_type reloc_statement;
 341   lang_address_statement_type address_statement;
 342   lang_output_section_statement_type output_section_statement;
 343   lang_afile_asection_pair_statement_type afile_asection_pair_statement;
 344   lang_assignment_statement_type assignment_statement;
 345   lang_input_statement_type input_statement;
 346   lang_target_statement_type target_statement;
 347   lang_output_statement_type output_statement;
 348   lang_input_section_type input_section;
 349   lang_common_statement_type common_statement;
 350   lang_object_symbols_statement_type object_symbols_statement;
 351   lang_fill_statement_type fill_statement;
 352   lang_padding_statement_type padding_statement;
 353   lang_group_statement_type group_statement;
 354 } lang_statement_union_type;
 355
 356 /* This structure holds information about a program header, from the
 357    PHDRS command in the linker script.  */
 358
 359 struct lang_phdr
 360 {
 361   struct lang_phdr *next;
 362   const char *name;
 363   unsigned long type;
 364   bfd_boolean filehdr;
 365   bfd_boolean phdrs;
 366   etree_type *at;
 367   etree_type *flags;
 368 };
 369
 370 /* This structure is used to hold a list of sections which may not
 371    cross reference each other.  */
 372
 373 typedef struct lang_nocrossref
 374 {
 375   struct lang_nocrossref *next;
 376   const char *name;
 377 } lang_nocrossref_type;
 378
 379 /* The list of nocrossref lists.  */
 380
 381 struct lang_nocrossrefs
 382 {
 383   struct lang_nocrossrefs *next;
 384   lang_nocrossref_type *list;
 385 };
 386
 387 extern struct lang_nocrossrefs *nocrossref_list;
 388
 389 /* This structure is used to hold a list of input section names which
 390    will not match an output section in the linker script.  */
 391
 392 struct unique_sections
 393 {
 394   struct unique_sections *next;
 395   const char *name;
 396 };
 397
 398 /* This structure records symbols for which we need to keep track of
 399    definedness for use in the DEFINED () test.  */
 400
 401 struct lang_definedness_hash_entry
 402 {
 403   struct bfd_hash_entry root;
 404   int iteration;
 405 };
 406
 407 extern struct unique_sections *unique_section_list;
 408
 409 extern lang_output_section_statement_type *abs_output_section;
 410 extern lang_statement_list_type lang_output_section_statement;
 411 extern bfd_boolean lang_has_input_file;
 412 extern etree_type *base;
 413 extern lang_statement_list_type *stat_ptr;
 414 extern bfd_boolean delete_output_file_on_failure;
 415
 416 extern struct bfd_sym_chain entry_symbol;
 417 extern const char *entry_section;
 418 extern bfd_boolean entry_from_cmdline;
 419 extern lang_statement_list_type file_chain;
 420
 421 extern int lang_statement_iteration;
 422
 423 extern void lang_init
 424   (void);
 425 extern lang_memory_region_type *lang_memory_region_lookup
 426   (const char *const, bfd_boolean);
 427 extern lang_memory_region_type *lang_memory_region_default
 428   (asection *);
 429 extern void lang_map
 430   (void);
 431 extern void lang_set_flags
 432   (lang_memory_region_type *, const char *, int);
 433 extern void lang_add_output
 434   (const char *, int from_script);
 435 extern lang_output_section_statement_type *lang_enter_output_section_statement
 436   (const char *output_section_statement_name,
 437    etree_type *address_exp,
 438    enum section_type sectype,
 439    etree_type *align,
 440    etree_type *subalign,
 441    etree_type *);
 442 extern void lang_final
 443   (void);
 444 extern void lang_process
 445   (void);
 446 extern void lang_section_start
 447   (const char *, union etree_union *);
 448 extern void lang_add_entry
 449   (const char *, bfd_boolean);
 450 extern void lang_add_target
 451   (const char *);
 452 extern void lang_add_wild
 453   (struct wildcard_spec *, struct wildcard_list *, bfd_boolean);
 454 extern void lang_add_map
 455   (const char *);
 456 extern void lang_add_fill
 457   (fill_type *);
 458 extern lang_assignment_statement_type *lang_add_assignment
 459   (union etree_union *);
 460 extern void lang_add_attribute
 461   (enum statement_enum);
 462 extern void lang_startup
 463   (const char *);
 464 extern void lang_float
 465   (bfd_boolean);
 466 extern void lang_leave_output_section_statement
 467   (fill_type *, const char *, lang_output_section_phdr_list *,
 468    const char *);
 469 extern void lang_abs_symbol_at_end_of
 470   (const char *, const char *);
 471 extern void lang_abs_symbol_at_beginning_of
 472   (const char *, const char *);
 473 extern void lang_statement_append
 474   (lang_statement_list_type *, lang_statement_union_type *,
 475    lang_statement_union_type **);
 476 extern void lang_for_each_input_file
 477   (void (*dothis) (lang_input_statement_type *));
 478 extern void lang_for_each_file
 479   (void (*dothis) (lang_input_statement_type *));
 480 extern void lang_reset_memory_regions
 481   (void);
 482 extern void lang_do_assignments
 483   (lang_statement_union_type *, lang_output_section_statement_type *,
 484    fill_type *, bfd_vma);
 485
 486 #define LANG_FOR_EACH_INPUT_STATEMENT(statement)                        \
 487   lang_input_statement_type *statement;                                 \
 488   for (statement = (lang_input_statement_type *) file_chain.head;       \
 489        statement != (lang_input_statement_type *) NULL;                 \
 490        statement = (lang_input_statement_type *) statement->next)       \
 491
 492 extern void lang_process
 493   (void);
 494 extern void ldlang_add_file
 495   (lang_input_statement_type *);
 496 extern lang_output_section_statement_type *lang_output_section_find
 497   (const char * const);
 498 extern lang_input_statement_type *lang_add_input_file
 499   (const char *, lang_input_file_enum_type, const char *);
 500 extern void lang_add_keepsyms_file
 501   (const char *);
 502 extern lang_output_section_statement_type *
 503   lang_output_section_statement_lookup
 504   (const char *const);
 505 extern void ldlang_add_undef
 506   (const char *const);
 507 extern void lang_add_output_format
 508   (const char *, const char *, const char *, int);
 509 extern void lang_list_init
 510   (lang_statement_list_type *);
 511 extern void lang_add_data
 512   (int type, union etree_union *);
 513 extern void lang_add_reloc
 514   (bfd_reloc_code_real_type, reloc_howto_type *, asection *, const char *,
 515    union etree_union *);
 516 extern void lang_for_each_statement
 517   (void (*) (lang_statement_union_type *));
 518 extern void *stat_alloc
 519   (size_t);
 520 extern void dprint_statement
 521   (lang_statement_union_type *, int);
 522 extern bfd_vma lang_size_sections
 523   (lang_statement_union_type *, lang_output_section_statement_type *,
 524    lang_statement_union_type **, fill_type *, bfd_vma, bfd_boolean *,
 525    bfd_boolean);
 526 extern void lang_enter_group
 527   (void);
 528 extern void lang_leave_group
 529   (void);
 530 extern void lang_add_section
 531   (lang_statement_list_type *, asection *,
 532    lang_output_section_statement_type *, lang_input_statement_type *);
 533 extern void lang_new_phdr
 534   (const char *, etree_type *, bfd_boolean, bfd_boolean, etree_type *,
 535    etree_type *);
 536 extern void lang_add_nocrossref
 537   (lang_nocrossref_type *);
 538 extern void lang_enter_overlay
 539   (etree_type *, etree_type *);
 540 extern void lang_enter_overlay_section
 541   (const char *);
 542 extern void lang_leave_overlay_section
 543   (fill_type *, lang_output_section_phdr_list *);
 544 extern void lang_leave_overlay
 545   (etree_type *, int, fill_type *, const char *,
 546    lang_output_section_phdr_list *, const char *);
 547
 548 extern struct bfd_elf_version_tree *lang_elf_version_info;
 549
 550 extern struct bfd_elf_version_expr *lang_new_vers_pattern
 551   (struct bfd_elf_version_expr *, const char *, const char *);
 552 extern struct bfd_elf_version_tree *lang_new_vers_node
 553   (struct bfd_elf_version_expr *, struct bfd_elf_version_expr *);
 554 extern struct bfd_elf_version_deps *lang_add_vers_depend
 555   (struct bfd_elf_version_deps *, const char *);
 556 extern void lang_register_vers_node
 557   (const char *, struct bfd_elf_version_tree *, struct bfd_elf_version_deps *);
 558 bfd_boolean unique_section_p
 559   (const char *);
 560 extern void lang_add_unique
 561   (const char *);
 562 extern const char *lang_get_output_target
 563   (void);
 564 extern void lang_track_definedness (const char *);
 565 extern int lang_symbol_definition_iteration (const char *);
 566 extern void lang_update_definedness
 567   (const char *, struct bfd_link_hash_entry *);
 568
 569 #endif