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 to include the entire contents of an archive.  */
 268   bfd_boolean whole_archive;
 269
 270   bfd_boolean loaded;
 271
 272 #if 0
 273   unsigned int globals_in_this_file;
 274 #endif
 275   const char *target;
 276   bfd_boolean real;
 277 } lang_input_statement_type;
 278
 279 typedef struct
 280 {
 281   lang_statement_header_type header;
 282   asection *section;
 283   lang_input_statement_type *ifile;
 284
 285 } lang_input_section_type;
 286
 287 typedef struct
 288 {
 289   lang_statement_header_type header;
 290   asection *section;
 291   union lang_statement_union *file;
 292 } lang_afile_asection_pair_statement_type;
 293
 294 typedef struct lang_wild_statement_struct
 295 {
 296   lang_statement_header_type header;
 297   const char *filename;
 298   bfd_boolean filenames_sorted;
 299   struct wildcard_list *section_list;
 300   bfd_boolean keep_sections;
 301   lang_statement_list_type children;
 302 } lang_wild_statement_type;
 303
 304 typedef struct lang_address_statement_struct
 305 {
 306   lang_statement_header_type header;
 307   const char *section_name;
 308   union etree_union *address;
 309 } lang_address_statement_type;
 310
 311 typedef struct
 312 {
 313   lang_statement_header_type header;
 314   bfd_vma output_offset;
 315   size_t size;
 316   asection *output_section;
 317   fill_type *fill;
 318 } lang_padding_statement_type;
 319
 320 /* A group statement collects a set of libraries together.  The
 321    libraries are searched multiple times, until no new undefined
 322    symbols are found.  The effect is to search a group of libraries as
 323    though they were a single library.  */
 324
 325 typedef struct
 326 {
 327   lang_statement_header_type header;
 328   lang_statement_list_type children;
 329 } lang_group_statement_type;
 330
 331 typedef union lang_statement_union
 332 {
 333   lang_statement_header_type header;
 334   lang_wild_statement_type wild_statement;
 335   lang_data_statement_type data_statement;
 336   lang_reloc_statement_type reloc_statement;
 337   lang_address_statement_type address_statement;
 338   lang_output_section_statement_type output_section_statement;
 339   lang_afile_asection_pair_statement_type afile_asection_pair_statement;
 340   lang_assignment_statement_type assignment_statement;
 341   lang_input_statement_type input_statement;
 342   lang_target_statement_type target_statement;
 343   lang_output_statement_type output_statement;
 344   lang_input_section_type input_section;
 345   lang_common_statement_type common_statement;
 346   lang_object_symbols_statement_type object_symbols_statement;
 347   lang_fill_statement_type fill_statement;
 348   lang_padding_statement_type padding_statement;
 349   lang_group_statement_type group_statement;
 350 } lang_statement_union_type;
 351
 352 /* This structure holds information about a program header, from the
 353    PHDRS command in the linker script.  */
 354
 355 struct lang_phdr
 356 {
 357   struct lang_phdr *next;
 358   const char *name;
 359   unsigned long type;
 360   bfd_boolean filehdr;
 361   bfd_boolean phdrs;
 362   etree_type *at;
 363   etree_type *flags;
 364 };
 365
 366 /* This structure is used to hold a list of sections which may not
 367    cross reference each other.  */
 368
 369 typedef struct lang_nocrossref
 370 {
 371   struct lang_nocrossref *next;
 372   const char *name;
 373 } lang_nocrossref_type;
 374
 375 /* The list of nocrossref lists.  */
 376
 377 struct lang_nocrossrefs
 378 {
 379   struct lang_nocrossrefs *next;
 380   lang_nocrossref_type *list;
 381 };
 382
 383 extern struct lang_nocrossrefs *nocrossref_list;
 384
 385 /* This structure is used to hold a list of input section names which
 386    will not match an output section in the linker script.  */
 387
 388 struct unique_sections
 389 {
 390   struct unique_sections *next;
 391   const char *name;
 392 };
 393
 394 /* This structure records symbols for which we need to keep track of
 395    definedness for use in the DEFINED () test.  */
 396
 397 struct lang_definedness_hash_entry
 398 {
 399   struct bfd_hash_entry root;
 400   int iteration;
 401 };
 402
 403 extern struct unique_sections *unique_section_list;
 404
 405 extern lang_output_section_statement_type *abs_output_section;
 406 extern lang_statement_list_type lang_output_section_statement;
 407 extern bfd_boolean lang_has_input_file;
 408 extern etree_type *base;
 409 extern lang_statement_list_type *stat_ptr;
 410 extern bfd_boolean delete_output_file_on_failure;
 411
 412 extern struct bfd_sym_chain entry_symbol;
 413 extern const char *entry_section;
 414 extern bfd_boolean entry_from_cmdline;
 415 extern lang_statement_list_type file_chain;
 416
 417 extern int lang_statement_iteration;
 418
 419 extern void lang_init
 420   (void);
 421 extern lang_memory_region_type *lang_memory_region_lookup
 422   (const char *const, bfd_boolean);
 423 extern lang_memory_region_type *lang_memory_region_default
 424   (asection *);
 425 extern void lang_map
 426   (void);
 427 extern void lang_set_flags
 428   (lang_memory_region_type *, const char *, int);
 429 extern void lang_add_output
 430   (const char *, int from_script);
 431 extern lang_output_section_statement_type *lang_enter_output_section_statement
 432   (const char *output_section_statement_name,
 433    etree_type *address_exp,
 434    enum section_type sectype,
 435    etree_type *align,
 436    etree_type *subalign,
 437    etree_type *);
 438 extern void lang_final
 439   (void);
 440 extern void lang_process
 441   (void);
 442 extern void lang_section_start
 443   (const char *, union etree_union *);
 444 extern void lang_add_entry
 445   (const char *, bfd_boolean);
 446 extern void lang_add_target
 447   (const char *);
 448 extern void lang_add_wild
 449   (struct wildcard_spec *, struct wildcard_list *, bfd_boolean);
 450 extern void lang_add_map
 451   (const char *);
 452 extern void lang_add_fill
 453   (fill_type *);
 454 extern lang_assignment_statement_type *lang_add_assignment
 455   (union etree_union *);
 456 extern void lang_add_attribute
 457   (enum statement_enum);
 458 extern void lang_startup
 459   (const char *);
 460 extern void lang_float
 461   (bfd_boolean);
 462 extern void lang_leave_output_section_statement
 463   (fill_type *, const char *, lang_output_section_phdr_list *,
 464    const char *);
 465 extern void lang_abs_symbol_at_end_of
 466   (const char *, const char *);
 467 extern void lang_abs_symbol_at_beginning_of
 468   (const char *, const char *);
 469 extern void lang_statement_append
 470   (lang_statement_list_type *, lang_statement_union_type *,
 471    lang_statement_union_type **);
 472 extern void lang_for_each_input_file
 473   (void (*dothis) (lang_input_statement_type *));
 474 extern void lang_for_each_file
 475   (void (*dothis) (lang_input_statement_type *));
 476 extern void lang_reset_memory_regions
 477   (void);
 478 extern void lang_do_assignments
 479   (lang_statement_union_type *, lang_output_section_statement_type *,
 480    fill_type *, bfd_vma);
 481
 482 #define LANG_FOR_EACH_INPUT_STATEMENT(statement)                        \
 483   lang_input_statement_type *statement;                                 \
 484   for (statement = (lang_input_statement_type *) file_chain.head;       \
 485        statement != (lang_input_statement_type *) NULL;                 \
 486        statement = (lang_input_statement_type *) statement->next)       \
 487
 488 extern void lang_process
 489   (void);
 490 extern void ldlang_add_file
 491   (lang_input_statement_type *);
 492 extern lang_output_section_statement_type *lang_output_section_find
 493   (const char * const);
 494 extern lang_input_statement_type *lang_add_input_file
 495   (const char *, lang_input_file_enum_type, const char *);
 496 extern void lang_add_keepsyms_file
 497   (const char *);
 498 extern lang_output_section_statement_type *
 499   lang_output_section_statement_lookup
 500   (const char *const);
 501 extern void ldlang_add_undef
 502   (const char *const);
 503 extern void lang_add_output_format
 504   (const char *, const char *, const char *, int);
 505 extern void lang_list_init
 506   (lang_statement_list_type *);
 507 extern void lang_add_data
 508   (int type, union etree_union *);
 509 extern void lang_add_reloc
 510   (bfd_reloc_code_real_type, reloc_howto_type *, asection *, const char *,
 511    union etree_union *);
 512 extern void lang_for_each_statement
 513   (void (*) (lang_statement_union_type *));
 514 extern void *stat_alloc
 515   (size_t);
 516 extern void dprint_statement
 517   (lang_statement_union_type *, int);
 518 extern bfd_vma lang_size_sections
 519   (lang_statement_union_type *, lang_output_section_statement_type *,
 520    lang_statement_union_type **, fill_type *, bfd_vma, bfd_boolean *,
 521    bfd_boolean);
 522 extern void lang_enter_group
 523   (void);
 524 extern void lang_leave_group
 525   (void);
 526 extern void lang_add_section
 527   (lang_statement_list_type *, asection *,
 528    lang_output_section_statement_type *, lang_input_statement_type *);
 529 extern void lang_new_phdr
 530   (const char *, etree_type *, bfd_boolean, bfd_boolean, etree_type *,
 531    etree_type *);
 532 extern void lang_add_nocrossref
 533   (lang_nocrossref_type *);
 534 extern void lang_enter_overlay
 535   (etree_type *, etree_type *);
 536 extern void lang_enter_overlay_section
 537   (const char *);
 538 extern void lang_leave_overlay_section
 539   (fill_type *, lang_output_section_phdr_list *);
 540 extern void lang_leave_overlay
 541   (etree_type *, int, fill_type *, const char *,
 542    lang_output_section_phdr_list *, const char *);
 543
 544 extern struct bfd_elf_version_tree *lang_elf_version_info;
 545
 546 extern struct bfd_elf_version_expr *lang_new_vers_pattern
 547   (struct bfd_elf_version_expr *, const char *, const char *);
 548 extern struct bfd_elf_version_tree *lang_new_vers_node
 549   (struct bfd_elf_version_expr *, struct bfd_elf_version_expr *);
 550 extern struct bfd_elf_version_deps *lang_add_vers_depend
 551   (struct bfd_elf_version_deps *, const char *);
 552 extern void lang_register_vers_node
 553   (const char *, struct bfd_elf_version_tree *, struct bfd_elf_version_deps *);
 554 bfd_boolean unique_section_p
 555   (const char *);
 556 extern void lang_add_unique
 557   (const char *);
 558 extern const char *lang_get_output_target
 559   (void);
 560 extern void lang_track_definedness (const char *);
 561 extern int lang_symbol_definition_iteration (const char *);
 562 extern void lang_update_definedness
 563   (const char *, struct bfd_link_hash_entry *);
 564
 565 #endif