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   int constraint;
 150   bfd_boolean all_input_readonly;
 151
 152   union etree_union *load_base;
 153
 154   /* If non-null, an expression to evaluate after setting the section's
 155      size.  The expression is evaluated inside REGION (above) with '.'
 156      set to the end of the section.  Used in the last overlay section
 157      to move '.' past all the overlaid sections.  */
 158   union etree_union *update_dot_tree;
 159
 160   lang_output_section_phdr_list *phdrs;
 161 } lang_output_section_statement_type;
 162
 163 typedef struct
 164 {
 165   lang_statement_header_type header;
 166 } lang_common_statement_type;
 167
 168 typedef struct
 169 {
 170   lang_statement_header_type header;
 171 } lang_object_symbols_statement_type;
 172
 173 typedef struct
 174 {
 175   lang_statement_header_type header;
 176   fill_type *fill;
 177   int size;
 178   asection *output_section;
 179 } lang_fill_statement_type;
 180
 181 typedef struct
 182 {
 183   lang_statement_header_type header;
 184   unsigned int type;
 185   union etree_union *exp;
 186   bfd_vma value;
 187   asection *output_section;
 188   bfd_vma output_vma;
 189 } lang_data_statement_type;
 190
 191 /* Generate a reloc in the output file.  */
 192
 193 typedef struct
 194 {
 195   lang_statement_header_type header;
 196
 197   /* Reloc to generate.  */
 198   bfd_reloc_code_real_type reloc;
 199
 200   /* Reloc howto structure.  */
 201   reloc_howto_type *howto;
 202
 203   /* Section to generate reloc against.
 204      Exactly one of section and name must be NULL.  */
 205   asection *section;
 206
 207   /* Name of symbol to generate reloc against.
 208      Exactly one of section and name must be NULL.  */
 209   const char *name;
 210
 211   /* Expression for addend.  */
 212   union etree_union *addend_exp;
 213
 214   /* Resolved addend.  */
 215   bfd_vma addend_value;
 216
 217   /* Output section where reloc should be performed.  */
 218   asection *output_section;
 219
 220   /* VMA within output section.  */
 221   bfd_vma output_vma;
 222 } lang_reloc_statement_type;
 223
 224 typedef struct lang_input_statement_struct
 225 {
 226   lang_statement_header_type header;
 227   /* Name of this file.  */
 228   const char *filename;
 229   /* Name to use for the symbol giving address of text start.
 230      Usually the same as filename, but for a file spec'd with
 231      -l this is the -l switch itself rather than the filename.  */
 232   const char *local_sym_name;
 233
 234   bfd *the_bfd;
 235
 236   bfd_boolean closed;
 237   file_ptr passive_position;
 238
 239   /* Symbol table of the file.  */
 240   asymbol **asymbols;
 241   unsigned int symbol_count;
 242
 243   /* Point to the next file - whatever it is, wanders up and down
 244      archives */
 245   union lang_statement_union *next;
 246
 247   /* Point to the next file, but skips archive contents.  */
 248   union lang_statement_union *next_real_file;
 249
 250   bfd_boolean is_archive;
 251
 252   /* 1 means search a set of directories for this file.  */
 253   bfd_boolean search_dirs_flag;
 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   bfd_boolean sysrooted;
 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   bfd_boolean just_syms_flag;
 265
 266   /* Whether to search for this entry as a dynamic archive.  */
 267   bfd_boolean dynamic;
 268
 269   /* Whether DT_NEEDED tags should be added for dynamic libraries in
 270      DT_NEEDED tags from this entry.  */
 271   bfd_boolean add_needed;
 272
 273   /* Whether this entry should cause a DT_NEEDED tag only when
 274      satisfying references from regular files, or always.  */
 275   bfd_boolean as_needed;
 276
 277   /* Whether to include the entire contents of an archive.  */
 278   bfd_boolean whole_archive;
 279
 280   bfd_boolean loaded;
 281
 282 #if 0
 283   unsigned int globals_in_this_file;
 284 #endif
 285   const char *target;
 286   bfd_boolean real;
 287 } lang_input_statement_type;
 288
 289 typedef struct
 290 {
 291   lang_statement_header_type header;
 292   asection *section;
 293   lang_input_statement_type *ifile;
 294
 295 } lang_input_section_type;
 296
 297 typedef struct
 298 {
 299   lang_statement_header_type header;
 300   asection *section;
 301   union lang_statement_union *file;
 302 } lang_afile_asection_pair_statement_type;
 303
 304 typedef struct lang_wild_statement_struct
 305 {
 306   lang_statement_header_type header;
 307   const char *filename;
 308   bfd_boolean filenames_sorted;
 309   struct wildcard_list *section_list;
 310   bfd_boolean keep_sections;
 311   lang_statement_list_type children;
 312 } lang_wild_statement_type;
 313
 314 typedef struct lang_address_statement_struct
 315 {
 316   lang_statement_header_type header;
 317   const char *section_name;
 318   union etree_union *address;
 319 } lang_address_statement_type;
 320
 321 typedef struct
 322 {
 323   lang_statement_header_type header;
 324   bfd_vma output_offset;
 325   size_t size;
 326   asection *output_section;
 327   fill_type *fill;
 328 } lang_padding_statement_type;
 329
 330 /* A group statement collects a set of libraries together.  The
 331    libraries are searched multiple times, until no new undefined
 332    symbols are found.  The effect is to search a group of libraries as
 333    though they were a single library.  */
 334
 335 typedef struct
 336 {
 337   lang_statement_header_type header;
 338   lang_statement_list_type children;
 339 } lang_group_statement_type;
 340
 341 typedef union lang_statement_union
 342 {
 343   lang_statement_header_type header;
 344   lang_wild_statement_type wild_statement;
 345   lang_data_statement_type data_statement;
 346   lang_reloc_statement_type reloc_statement;
 347   lang_address_statement_type address_statement;
 348   lang_output_section_statement_type output_section_statement;
 349   lang_afile_asection_pair_statement_type afile_asection_pair_statement;
 350   lang_assignment_statement_type assignment_statement;
 351   lang_input_statement_type input_statement;
 352   lang_target_statement_type target_statement;
 353   lang_output_statement_type output_statement;
 354   lang_input_section_type input_section;
 355   lang_common_statement_type common_statement;
 356   lang_object_symbols_statement_type object_symbols_statement;
 357   lang_fill_statement_type fill_statement;
 358   lang_padding_statement_type padding_statement;
 359   lang_group_statement_type group_statement;
 360 } lang_statement_union_type;
 361
 362 /* This structure holds information about a program header, from the
 363    PHDRS command in the linker script.  */
 364
 365 struct lang_phdr
 366 {
 367   struct lang_phdr *next;
 368   const char *name;
 369   unsigned long type;
 370   bfd_boolean filehdr;
 371   bfd_boolean phdrs;
 372   etree_type *at;
 373   etree_type *flags;
 374 };
 375
 376 /* This structure is used to hold a list of sections which may not
 377    cross reference each other.  */
 378
 379 typedef struct lang_nocrossref
 380 {
 381   struct lang_nocrossref *next;
 382   const char *name;
 383 } lang_nocrossref_type;
 384
 385 /* The list of nocrossref lists.  */
 386
 387 struct lang_nocrossrefs
 388 {
 389   struct lang_nocrossrefs *next;
 390   lang_nocrossref_type *list;
 391 };
 392
 393 extern struct lang_nocrossrefs *nocrossref_list;
 394
 395 /* This structure is used to hold a list of input section names which
 396    will not match an output section in the linker script.  */
 397
 398 struct unique_sections
 399 {
 400   struct unique_sections *next;
 401   const char *name;
 402 };
 403
 404 /* This structure records symbols for which we need to keep track of
 405    definedness for use in the DEFINED () test.  */
 406
 407 struct lang_definedness_hash_entry
 408 {
 409   struct bfd_hash_entry root;
 410   int iteration;
 411 };
 412
 413 extern struct unique_sections *unique_section_list;
 414
 415 extern lang_output_section_statement_type *abs_output_section;
 416 extern lang_statement_list_type lang_output_section_statement;
 417 extern bfd_boolean lang_has_input_file;
 418 extern etree_type *base;
 419 extern lang_statement_list_type *stat_ptr;
 420 extern bfd_boolean delete_output_file_on_failure;
 421
 422 extern struct bfd_sym_chain entry_symbol;
 423 extern const char *entry_section;
 424 extern bfd_boolean entry_from_cmdline;
 425 extern lang_statement_list_type file_chain;
 426
 427 extern int lang_statement_iteration;
 428
 429 extern void lang_init
 430   (void);
 431 extern lang_memory_region_type *lang_memory_region_lookup
 432   (const char *const, bfd_boolean);
 433 extern lang_memory_region_type *lang_memory_region_default
 434   (asection *);
 435 extern void lang_map
 436   (void);
 437 extern void lang_set_flags
 438   (lang_memory_region_type *, const char *, int);
 439 extern void lang_add_output
 440   (const char *, int from_script);
 441 extern lang_output_section_statement_type *lang_enter_output_section_statement
 442   (const char *output_section_statement_name,
 443    etree_type *address_exp,
 444    enum section_type sectype,
 445    etree_type *align,
 446    etree_type *subalign,
 447    etree_type *, int);
 448 extern void lang_final
 449   (void);
 450 extern void lang_process
 451   (void);
 452 extern void lang_section_start
 453   (const char *, union etree_union *);
 454 extern void lang_add_entry
 455   (const char *, bfd_boolean);
 456 extern void lang_add_target
 457   (const char *);
 458 extern void lang_add_wild
 459   (struct wildcard_spec *, struct wildcard_list *, bfd_boolean);
 460 extern void lang_add_map
 461   (const char *);
 462 extern void lang_add_fill
 463   (fill_type *);
 464 extern lang_assignment_statement_type *lang_add_assignment
 465   (union etree_union *);
 466 extern void lang_add_attribute
 467   (enum statement_enum);
 468 extern void lang_startup
 469   (const char *);
 470 extern void lang_float
 471   (bfd_boolean);
 472 extern void lang_leave_output_section_statement
 473   (fill_type *, const char *, lang_output_section_phdr_list *,
 474    const char *);
 475 extern void lang_abs_symbol_at_end_of
 476   (const char *, const char *);
 477 extern void lang_abs_symbol_at_beginning_of
 478   (const char *, const char *);
 479 extern void lang_statement_append
 480   (lang_statement_list_type *, lang_statement_union_type *,
 481    lang_statement_union_type **);
 482 extern void lang_for_each_input_file
 483   (void (*dothis) (lang_input_statement_type *));
 484 extern void lang_for_each_file
 485   (void (*dothis) (lang_input_statement_type *));
 486 extern void lang_reset_memory_regions
 487   (void);
 488 extern void lang_do_assignments
 489   (lang_statement_union_type *, lang_output_section_statement_type *,
 490    fill_type *, bfd_vma);
 491
 492 #define LANG_FOR_EACH_INPUT_STATEMENT(statement)                        \
 493   lang_input_statement_type *statement;                                 \
 494   for (statement = (lang_input_statement_type *) file_chain.head;       \
 495        statement != (lang_input_statement_type *) NULL;                 \
 496        statement = (lang_input_statement_type *) statement->next)       \
 497
 498 extern void lang_process
 499   (void);
 500 extern void ldlang_add_file
 501   (lang_input_statement_type *);
 502 extern lang_output_section_statement_type *lang_output_section_find
 503   (const char * const);
 504 extern lang_input_statement_type *lang_add_input_file
 505   (const char *, lang_input_file_enum_type, const char *);
 506 extern void lang_add_keepsyms_file
 507   (const char *);
 508 extern lang_output_section_statement_type *
 509   lang_output_section_statement_lookup
 510   (const char *const);
 511 extern void ldlang_add_undef
 512   (const char *const);
 513 extern void lang_add_output_format
 514   (const char *, const char *, const char *, int);
 515 extern void lang_list_init
 516   (lang_statement_list_type *);
 517 extern void lang_add_data
 518   (int type, union etree_union *);
 519 extern void lang_add_reloc
 520   (bfd_reloc_code_real_type, reloc_howto_type *, asection *, const char *,
 521    union etree_union *);
 522 extern void lang_for_each_statement
 523   (void (*) (lang_statement_union_type *));
 524 extern void *stat_alloc
 525   (size_t);
 526 extern void dprint_statement
 527   (lang_statement_union_type *, int);
 528 extern bfd_vma lang_size_sections
 529   (lang_statement_union_type *, lang_output_section_statement_type *,
 530    lang_statement_union_type **, fill_type *, bfd_vma, bfd_boolean *,
 531    bfd_boolean);
 532 extern void lang_enter_group
 533   (void);
 534 extern void lang_leave_group
 535   (void);
 536 extern void lang_add_section
 537   (lang_statement_list_type *, asection *,
 538    lang_output_section_statement_type *, lang_input_statement_type *);
 539 extern void lang_new_phdr
 540   (const char *, etree_type *, bfd_boolean, bfd_boolean, etree_type *,
 541    etree_type *);
 542 extern void lang_add_nocrossref
 543   (lang_nocrossref_type *);
 544 extern void lang_enter_overlay
 545   (etree_type *, etree_type *);
 546 extern void lang_enter_overlay_section
 547   (const char *);
 548 extern void lang_leave_overlay_section
 549   (fill_type *, lang_output_section_phdr_list *);
 550 extern void lang_leave_overlay
 551   (etree_type *, int, fill_type *, const char *,
 552    lang_output_section_phdr_list *, const char *);
 553
 554 extern struct bfd_elf_version_tree *lang_elf_version_info;
 555
 556 extern struct bfd_elf_version_expr *lang_new_vers_pattern
 557   (struct bfd_elf_version_expr *, const char *, const char *);
 558 extern struct bfd_elf_version_tree *lang_new_vers_node
 559   (struct bfd_elf_version_expr *, struct bfd_elf_version_expr *);
 560 extern struct bfd_elf_version_deps *lang_add_vers_depend
 561   (struct bfd_elf_version_deps *, const char *);
 562 extern void lang_register_vers_node
 563   (const char *, struct bfd_elf_version_tree *, struct bfd_elf_version_deps *);
 564 bfd_boolean unique_section_p
 565   (const asection *);
 566 extern void lang_add_unique
 567   (const char *);
 568 extern const char *lang_get_output_target
 569   (void);
 570 extern void lang_track_definedness (const char *);
 571 extern int lang_symbol_definition_iteration (const char *);
 572 extern void lang_update_definedness
 573   (const char *, struct bfd_link_hash_entry *);
 574
 575 #endif