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
   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 typedef enum {
  27   lang_input_file_is_l_enum,
  28   lang_input_file_is_symbols_only_enum,
  29   lang_input_file_is_marker_enum,
  30   lang_input_file_is_fake_enum,
  31   lang_input_file_is_search_file_enum,
  32   lang_input_file_is_file_enum
  33 } lang_input_file_enum_type;
  34
  35 struct _fill_type {
  36   size_t size;
  37   unsigned char data[1];
  38 };
  39
  40 typedef struct statement_list {
  41   union lang_statement_union *head;
  42   union lang_statement_union **tail;
  43 } lang_statement_list_type;
  44
  45 typedef struct memory_region_struct {
  46   char *name;
  47   struct memory_region_struct *next;
  48   bfd_vma origin;
  49   bfd_size_type length;
  50   bfd_vma current;
  51   bfd_size_type old_length;
  52   flagword flags;
  53   flagword not_flags;
  54   boolean had_full_message;
  55 } lang_memory_region_type;
  56
  57 typedef struct lang_statement_header_struct {
  58   union lang_statement_union *next;
  59   enum statement_enum {
  60     lang_output_section_statement_enum,
  61     lang_assignment_statement_enum,
  62     lang_input_statement_enum,
  63     lang_address_statement_enum,
  64     lang_wild_statement_enum,
  65     lang_input_section_enum,
  66     lang_object_symbols_statement_enum,
  67     lang_fill_statement_enum,
  68     lang_data_statement_enum,
  69     lang_reloc_statement_enum,
  70     lang_target_statement_enum,
  71     lang_output_statement_enum,
  72     lang_padding_statement_enum,
  73     lang_group_statement_enum,
  74
  75     lang_afile_asection_pair_statement_enum,
  76     lang_constructors_statement_enum
  77   } type;
  78 } lang_statement_header_type;
  79
  80 typedef struct {
  81   lang_statement_header_type header;
  82   union etree_union *exp;
  83 } lang_assignment_statement_type;
  84
  85 typedef struct lang_target_statement_struct {
  86   lang_statement_header_type header;
  87   const char *target;
  88 } lang_target_statement_type;
  89
  90 typedef struct lang_output_statement_struct {
  91   lang_statement_header_type header;
  92   const char *name;
  93 } lang_output_statement_type;
  94
  95 /* Section types specified in a linker script.  */
  96
  97 enum section_type {
  98   normal_section,
  99   dsect_section,
 100   copy_section,
 101   noload_section,
 102   info_section,
 103   overlay_section
 104 };
 105
 106 /* This structure holds a list of program headers describing segments
 107    in which this section should be placed.  */
 108
 109 struct lang_output_section_phdr_list {
 110   struct lang_output_section_phdr_list *next;
 111   const char *name;
 112   boolean used;
 113 };
 114
 115 typedef struct lang_output_section_statement_struct {
 116   lang_statement_header_type header;
 117   union etree_union *addr_tree;
 118   lang_statement_list_type children;
 119   const char *memspec;
 120   union lang_statement_union *next;
 121   const char *name;
 122
 123   boolean processed;
 124
 125   asection *bfd_section;
 126   flagword flags;               /* Or together of all input sections */
 127   enum section_type sectype;
 128   struct memory_region_struct *region;
 129   struct memory_region_struct *lma_region;
 130   size_t block_value;
 131   fill_type *fill;
 132
 133   int subsection_alignment;     /* alignment of components */
 134   int section_alignment;        /* alignment of start of section */
 135
 136   union etree_union *load_base;
 137
 138   struct lang_output_section_phdr_list *phdrs;
 139 } lang_output_section_statement_type;
 140
 141 typedef struct {
 142   lang_statement_header_type header;
 143 } lang_common_statement_type;
 144
 145 typedef struct {
 146   lang_statement_header_type header;
 147 } lang_object_symbols_statement_type;
 148
 149 typedef struct {
 150   lang_statement_header_type header;
 151   fill_type *fill;
 152   int size;
 153   asection *output_section;
 154 } lang_fill_statement_type;
 155
 156 typedef struct {
 157   lang_statement_header_type header;
 158   unsigned int type;
 159   union etree_union *exp;
 160   bfd_vma value;
 161   asection *output_section;
 162   bfd_vma output_vma;
 163 } lang_data_statement_type;
 164
 165 /* Generate a reloc in the output file.  */
 166
 167 typedef struct {
 168   lang_statement_header_type header;
 169
 170   /* Reloc to generate.  */
 171   bfd_reloc_code_real_type reloc;
 172
 173   /* Reloc howto structure.  */
 174   reloc_howto_type *howto;
 175
 176   /* Section to generate reloc against.  Exactly one of section and
 177      name must be NULL.  */
 178   asection *section;
 179
 180   /* Name of symbol to generate reloc against.  Exactly one of section
 181      and name must be NULL.  */
 182   const char *name;
 183
 184   /* Expression for addend.  */
 185   union etree_union *addend_exp;
 186
 187   /* Resolved addend.  */
 188   bfd_vma addend_value;
 189
 190   /* Output section where reloc should be performed.  */
 191   asection *output_section;
 192
 193   /* VMA within output section.  */
 194   bfd_vma output_vma;
 195 } lang_reloc_statement_type;
 196
 197 typedef struct lang_input_statement_struct {
 198   lang_statement_header_type header;
 199   /* Name of this file.  */
 200   const char *filename;
 201   /* Name to use for the symbol giving address of text start */
 202   /* Usually the same as filename, but for a file spec'd with -l
 203      this is the -l switch itself rather than the filename.  */
 204   const char *local_sym_name;
 205
 206   bfd *the_bfd;
 207
 208   boolean closed;
 209   file_ptr passive_position;
 210
 211   /* Symbol table of the file.  */
 212   asymbol **asymbols;
 213   unsigned int symbol_count;
 214
 215   /* Point to the next file - whatever it is, wanders up and down
 216      archives */
 217
 218   union lang_statement_union *next;
 219   /* Point to the next file, but skips archive contents */
 220   union lang_statement_union *next_real_file;
 221
 222   boolean is_archive;
 223
 224   /* 1 means search a set of directories for this file.  */
 225   boolean search_dirs_flag;
 226
 227   /* 1 means this is base file of incremental load.
 228      Do not load this file's text or data.
 229      Also default text_start to after this file's bss.  */
 230
 231   boolean just_syms_flag;
 232
 233   /* Whether to search for this entry as a dynamic archive.  */
 234   boolean dynamic;
 235
 236   /* Whether to include the entire contents of an archive.  */
 237   boolean whole_archive;
 238
 239   boolean loaded;
 240
 241 #if 0
 242   unsigned int globals_in_this_file;
 243 #endif
 244   const char *target;
 245   boolean real;
 246 } lang_input_statement_type;
 247
 248 typedef struct {
 249   lang_statement_header_type header;
 250   asection *section;
 251   lang_input_statement_type *ifile;
 252
 253 } lang_input_section_type;
 254
 255 typedef struct {
 256   lang_statement_header_type header;
 257   asection *section;
 258   union lang_statement_union *file;
 259 } lang_afile_asection_pair_statement_type;
 260
 261 typedef struct lang_wild_statement_struct {
 262   lang_statement_header_type header;
 263   const char *filename;
 264   boolean filenames_sorted;
 265   struct wildcard_list *section_list;
 266   boolean keep_sections;
 267   lang_statement_list_type children;
 268 } lang_wild_statement_type;
 269
 270 typedef struct lang_address_statement_struct {
 271   lang_statement_header_type header;
 272   const char *section_name;
 273   union etree_union *address;
 274 } lang_address_statement_type;
 275
 276 typedef struct {
 277   lang_statement_header_type header;
 278   bfd_vma output_offset;
 279   size_t size;
 280   asection *output_section;
 281   fill_type *fill;
 282 } lang_padding_statement_type;
 283
 284 /* A group statement collects a set of libraries together.  The
 285    libraries are searched multiple times, until no new undefined
 286    symbols are found.  The effect is to search a group of libraries as
 287    though they were a single library.  */
 288
 289 typedef struct {
 290   lang_statement_header_type header;
 291   lang_statement_list_type children;
 292 } lang_group_statement_type;
 293
 294 typedef union lang_statement_union {
 295   lang_statement_header_type header;
 296   lang_wild_statement_type wild_statement;
 297   lang_data_statement_type data_statement;
 298   lang_reloc_statement_type reloc_statement;
 299   lang_address_statement_type address_statement;
 300   lang_output_section_statement_type output_section_statement;
 301   lang_afile_asection_pair_statement_type afile_asection_pair_statement;
 302   lang_assignment_statement_type assignment_statement;
 303   lang_input_statement_type input_statement;
 304   lang_target_statement_type target_statement;
 305   lang_output_statement_type output_statement;
 306   lang_input_section_type input_section;
 307   lang_common_statement_type common_statement;
 308   lang_object_symbols_statement_type object_symbols_statement;
 309   lang_fill_statement_type fill_statement;
 310   lang_padding_statement_type padding_statement;
 311   lang_group_statement_type group_statement;
 312 } lang_statement_union_type;
 313
 314 /* This structure holds information about a program header, from the
 315    PHDRS command in the linker script.  */
 316
 317 struct lang_phdr {
 318   struct lang_phdr *next;
 319   const char *name;
 320   unsigned long type;
 321   boolean filehdr;
 322   boolean phdrs;
 323   etree_type *at;
 324   etree_type *flags;
 325 };
 326
 327 /* This structure is used to hold a list of sections which may not
 328    cross reference each other.  */
 329
 330 struct lang_nocrossref {
 331   struct lang_nocrossref *next;
 332   const char *name;
 333 };
 334
 335 /* The list of nocrossref lists.  */
 336
 337 struct lang_nocrossrefs {
 338   struct lang_nocrossrefs *next;
 339   struct lang_nocrossref *list;
 340 };
 341
 342 extern struct lang_nocrossrefs *nocrossref_list;
 343
 344 /* This structure is used to hold a list of input section names which
 345    will not match an output section in the linker script.  */
 346
 347 struct unique_sections {
 348   struct unique_sections *next;
 349   const char *name;
 350 };
 351
 352 extern struct unique_sections *unique_section_list;
 353
 354 extern lang_output_section_statement_type *abs_output_section;
 355 extern lang_statement_list_type lang_output_section_statement;
 356 extern boolean lang_has_input_file;
 357 extern etree_type *base;
 358 extern lang_statement_list_type *stat_ptr;
 359 extern boolean delete_output_file_on_failure;
 360
 361 extern const char *entry_symbol;
 362 extern const char *entry_section;
 363 extern boolean entry_from_cmdline;
 364 extern lang_statement_list_type file_chain;
 365
 366 extern void lang_init PARAMS ((void));
 367 extern struct memory_region_struct *lang_memory_region_lookup
 368   PARAMS ((const char *const));
 369 extern struct memory_region_struct *lang_memory_region_default
 370   PARAMS ((asection *));
 371 extern void lang_map PARAMS ((void));
 372 extern void lang_set_flags PARAMS ((lang_memory_region_type *, const char *,
 373                                     int));
 374 extern void lang_add_output PARAMS ((const char *, int from_script));
 375 extern lang_output_section_statement_type *lang_enter_output_section_statement
 376   PARAMS ((const char *output_section_statement_name,
 377            etree_type * address_exp,
 378            enum section_type sectype,
 379            bfd_vma block_value,
 380            etree_type *align,
 381            etree_type *subalign,
 382            etree_type *));
 383 extern void lang_final PARAMS ((void));
 384 extern void lang_process PARAMS ((void));
 385 extern void lang_section_start PARAMS ((const char *, union etree_union *));
 386 extern void lang_add_entry PARAMS ((const char *, boolean));
 387 extern void lang_add_target PARAMS ((const char *));
 388 extern void lang_add_wild
 389   PARAMS ((struct wildcard_spec *, struct wildcard_list *, boolean));
 390 extern void lang_add_map PARAMS ((const char *));
 391 extern void lang_add_fill PARAMS ((fill_type *));
 392 extern lang_assignment_statement_type * lang_add_assignment PARAMS ((union etree_union *));
 393 extern void lang_add_attribute PARAMS ((enum statement_enum));
 394 extern void lang_startup PARAMS ((const char *));
 395 extern void lang_float PARAMS ((enum bfd_boolean));
 396 extern void lang_leave_output_section_statement
 397   PARAMS ((fill_type *, const char *, struct lang_output_section_phdr_list *,
 398            const char *));
 399 extern void lang_abs_symbol_at_end_of PARAMS ((const char *, const char *));
 400 extern void lang_abs_symbol_at_beginning_of PARAMS ((const char *,
 401                                                      const char *));
 402 extern void lang_statement_append PARAMS ((struct statement_list *,
 403                                            union lang_statement_union *,
 404                                            union lang_statement_union **));
 405 extern void lang_for_each_input_file
 406   PARAMS ((void (*dothis) (lang_input_statement_type *)));
 407 extern void lang_for_each_file
 408   PARAMS ((void (*dothis) (lang_input_statement_type *)));
 409 extern void lang_reset_memory_regions PARAMS ((void));
 410 extern bfd_vma lang_do_assignments
 411   PARAMS ((lang_statement_union_type * s,
 412            lang_output_section_statement_type *output_section_statement,
 413            fill_type *fill,
 414            bfd_vma dot));
 415
 416 #define LANG_FOR_EACH_INPUT_STATEMENT(statement)                \
 417   lang_input_statement_type *statement;                         \
 418   for (statement = (lang_input_statement_type *)file_chain.head;\
 419        statement != (lang_input_statement_type *)NULL;          \
 420        statement = (lang_input_statement_type *)statement->next)\
 421
 422 extern void lang_process PARAMS ((void));
 423 extern void ldlang_add_file PARAMS ((lang_input_statement_type *));
 424 extern lang_output_section_statement_type *lang_output_section_find
 425   PARAMS ((const char * const));
 426 extern lang_input_statement_type *lang_add_input_file
 427   PARAMS ((const char *name, lang_input_file_enum_type file_type,
 428            const char *target));
 429 extern void lang_add_keepsyms_file PARAMS ((const char *filename));
 430 extern lang_output_section_statement_type *
 431   lang_output_section_statement_lookup PARAMS ((const char * const name));
 432 extern void ldlang_add_undef PARAMS ((const char *const name));
 433 extern void lang_add_output_format PARAMS ((const char *, const char *,
 434                                             const char *, int from_script));
 435 extern void lang_list_init PARAMS ((lang_statement_list_type*));
 436 extern void lang_add_data PARAMS ((int type, union etree_union *));
 437 extern void lang_add_reloc
 438   PARAMS ((bfd_reloc_code_real_type reloc, reloc_howto_type *howto,
 439            asection *section, const char *name, union etree_union *addend));
 440 extern void lang_for_each_statement
 441   PARAMS ((void (*func) (lang_statement_union_type *)));
 442 extern PTR stat_alloc PARAMS ((size_t size));
 443 extern void dprint_statement PARAMS ((lang_statement_union_type *, int));
 444 extern bfd_vma lang_size_sections
 445   PARAMS ((lang_statement_union_type *s,
 446            lang_output_section_statement_type *output_section_statement,
 447            lang_statement_union_type **prev, fill_type *fill,
 448            bfd_vma dot, boolean *relax));
 449 extern void lang_enter_group PARAMS ((void));
 450 extern void lang_leave_group PARAMS ((void));
 451 extern void lang_add_section
 452   PARAMS ((lang_statement_list_type *ptr, asection *section,
 453            lang_output_section_statement_type *output,
 454            lang_input_statement_type *file));
 455 extern void lang_new_phdr
 456   PARAMS ((const char *, etree_type *, boolean, boolean, etree_type *,
 457            etree_type *));
 458 extern void lang_add_nocrossref PARAMS ((struct lang_nocrossref *));
 459 extern void lang_enter_overlay PARAMS ((etree_type *, etree_type *, int));
 460 extern void lang_enter_overlay_section PARAMS ((const char *));
 461 extern void lang_leave_overlay_section
 462   PARAMS ((fill_type *, struct lang_output_section_phdr_list *));
 463 extern void lang_leave_overlay
 464   PARAMS ((fill_type *, const char *, struct lang_output_section_phdr_list *,
 465            const char *));
 466
 467 extern struct bfd_elf_version_tree *lang_elf_version_info;
 468
 469 extern struct bfd_elf_version_expr *lang_new_vers_pattern
 470   PARAMS ((struct bfd_elf_version_expr *, const char *, const char *));
 471 extern struct bfd_elf_version_tree *lang_new_vers_node
 472   PARAMS ((struct bfd_elf_version_expr *, struct bfd_elf_version_expr *));
 473 extern struct bfd_elf_version_deps *lang_add_vers_depend
 474   PARAMS ((struct bfd_elf_version_deps *, const char *));
 475 extern void lang_register_vers_node
 476   PARAMS ((const char *, struct bfd_elf_version_tree *,
 477            struct bfd_elf_version_deps *));
 478 boolean unique_section_p PARAMS ((const char *));
 479 extern void lang_add_unique PARAMS ((const char *));
 480
 481 #endif