include/bfdlink.h

   1 /* bfdlink.h -- header file for BFD link routines
   2    Copyright 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002,
   3    2003, 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
   4    Written by Steve Chamberlain and Ian Lance Taylor, Cygnus Support.
   5
   6    This file is part of BFD, the Binary File Descriptor library.
   7
   8    This program 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 3 of the License, or
  11    (at your option) any later version.
  12
  13    This program 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 this program; if not, write to the Free Software
  20    Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
  21    MA 02110-1301, USA.  */
  22
  23 #ifndef BFDLINK_H
  24 #define BFDLINK_H
  25
  26 /* Which symbols to strip during a link.  */
  27 enum bfd_link_strip
  28 {
  29   strip_none,           /* Don't strip any symbols.  */
  30   strip_debugger,       /* Strip debugging symbols.  */
  31   strip_some,           /* keep_hash is the list of symbols to keep.  */
  32   strip_all             /* Strip all symbols.  */
  33 };
  34
  35 /* Which local symbols to discard during a link.  This is irrelevant
  36    if strip_all is used.  */
  37 enum bfd_link_discard
  38 {
  39   discard_sec_merge,    /* Discard local temporary symbols in SEC_MERGE
  40                            sections.  */
  41   discard_none,         /* Don't discard any locals.  */
  42   discard_l,            /* Discard local temporary symbols.  */
  43   discard_all           /* Discard all locals.  */
  44 };
  45
  46 /* Describes the type of hash table entry structure being used.
  47    Different hash table structure have different fields and so
  48    support different linking features.  */
  49 enum bfd_link_hash_table_type
  50   {
  51     bfd_link_generic_hash_table,
  52     bfd_link_elf_hash_table
  53   };
  54 \f
  55 /* These are the possible types of an entry in the BFD link hash
  56    table.  */
  57
  58 enum bfd_link_hash_type
  59 {
  60   bfd_link_hash_new,            /* Symbol is new.  */
  61   bfd_link_hash_undefined,      /* Symbol seen before, but undefined.  */
  62   bfd_link_hash_undefweak,      /* Symbol is weak and undefined.  */
  63   bfd_link_hash_defined,        /* Symbol is defined.  */
  64   bfd_link_hash_defweak,        /* Symbol is weak and defined.  */
  65   bfd_link_hash_common,         /* Symbol is common.  */
  66   bfd_link_hash_indirect,       /* Symbol is an indirect link.  */
  67   bfd_link_hash_warning         /* Like indirect, but warn if referenced.  */
  68 };
  69
  70 enum bfd_link_common_skip_ar_aymbols
  71 {
  72   bfd_link_common_skip_none,
  73   bfd_link_common_skip_text,
  74   bfd_link_common_skip_data,
  75   bfd_link_common_skip_all
  76 };
  77
  78 /* The linking routines use a hash table which uses this structure for
  79    its elements.  */
  80
  81 struct bfd_link_hash_entry
  82 {
  83   /* Base hash table entry structure.  */
  84   struct bfd_hash_entry root;
  85
  86   /* Type of this entry.  */
  87   enum bfd_link_hash_type type;
  88
  89   /* A union of information depending upon the type.  */
  90   union
  91     {
  92       /* Nothing is kept for bfd_hash_new.  */
  93       /* bfd_link_hash_undefined, bfd_link_hash_undefweak.  */
  94       struct
  95         {
  96           /* Undefined and common symbols are kept in a linked list through
  97              this field.  This field is present in all of the union element
  98              so that we don't need to remove entries from the list when we
  99              change their type.  Removing entries would either require the
 100              list to be doubly linked, which would waste more memory, or
 101              require a traversal.  When an undefined or common symbol is
 102              created, it should be added to this list, the head of which is in
 103              the link hash table itself.  As symbols are defined, they need
 104              not be removed from the list; anything which reads the list must
 105              doublecheck the symbol type.
 106
 107              Weak symbols are not kept on this list.
 108
 109              Defined and defweak symbols use this field as a reference marker.
 110              If the field is not NULL, or this structure is the tail of the
 111              undefined symbol list, the symbol has been referenced.  If the
 112              symbol is undefined and becomes defined, this field will
 113              automatically be non-NULL since the symbol will have been on the
 114              undefined symbol list.  */
 115           struct bfd_link_hash_entry *next;
 116           bfd *abfd;            /* BFD symbol was found in.  */
 117           bfd *weak;            /* BFD weak symbol was found in.  */
 118         } undef;
 119       /* bfd_link_hash_defined, bfd_link_hash_defweak.  */
 120       struct
 121         {
 122           struct bfd_link_hash_entry *next;
 123           asection *section;    /* Symbol section.  */
 124           bfd_vma value;        /* Symbol value.  */
 125         } def;
 126       /* bfd_link_hash_indirect, bfd_link_hash_warning.  */
 127       struct
 128         {
 129           struct bfd_link_hash_entry *next;
 130           struct bfd_link_hash_entry *link;     /* Real symbol.  */
 131           const char *warning;  /* Warning (bfd_link_hash_warning only).  */
 132         } i;
 133       /* bfd_link_hash_common.  */
 134       struct
 135         {
 136           struct bfd_link_hash_entry *next;
 137           /* The linker needs to know three things about common
 138              symbols: the size, the alignment, and the section in
 139              which the symbol should be placed.  We store the size
 140              here, and we allocate a small structure to hold the
 141              section and the alignment.  The alignment is stored as a
 142              power of two.  We don't store all the information
 143              directly because we don't want to increase the size of
 144              the union; this structure is a major space user in the
 145              linker.  */
 146           struct bfd_link_hash_common_entry
 147             {
 148               unsigned int alignment_power;     /* Alignment.  */
 149               asection *section;                /* Symbol section.  */
 150             } *p;
 151           bfd_size_type size;   /* Common symbol size.  */
 152         } c;
 153     } u;
 154 };
 155
 156 /* This is the link hash table.  It is a derived class of
 157    bfd_hash_table.  */
 158
 159 struct bfd_link_hash_table
 160 {
 161   /* The hash table itself.  */
 162   struct bfd_hash_table table;
 163   /* A linked list of undefined and common symbols, linked through the
 164      next field in the bfd_link_hash_entry structure.  */
 165   struct bfd_link_hash_entry *undefs;
 166   /* Entries are added to the tail of the undefs list.  */
 167   struct bfd_link_hash_entry *undefs_tail;
 168   /* The type of the link hash table.  */
 169   enum bfd_link_hash_table_type type;
 170 };
 171
 172 /* Look up an entry in a link hash table.  If FOLLOW is TRUE, this
 173    follows bfd_link_hash_indirect and bfd_link_hash_warning links to
 174    the real symbol.  */
 175 extern struct bfd_link_hash_entry *bfd_link_hash_lookup
 176   (struct bfd_link_hash_table *, const char *, bfd_boolean create,
 177    bfd_boolean copy, bfd_boolean follow);
 178
 179 /* Look up an entry in the main linker hash table if the symbol might
 180    be wrapped.  This should only be used for references to an
 181    undefined symbol, not for definitions of a symbol.  */
 182
 183 extern struct bfd_link_hash_entry *bfd_wrapped_link_hash_lookup
 184   (bfd *, struct bfd_link_info *, const char *, bfd_boolean,
 185    bfd_boolean, bfd_boolean);
 186
 187 /* Traverse a link hash table.  */
 188 extern void bfd_link_hash_traverse
 189   (struct bfd_link_hash_table *,
 190     bfd_boolean (*) (struct bfd_link_hash_entry *, void *),
 191     void *);
 192
 193 /* Add an entry to the undefs list.  */
 194 extern void bfd_link_add_undef
 195   (struct bfd_link_hash_table *, struct bfd_link_hash_entry *);
 196
 197 /* Remove symbols from the undefs list that don't belong there.  */
 198 extern void bfd_link_repair_undef_list
 199   (struct bfd_link_hash_table *table);
 200
 201 /* Read symbols and cache symbol pointer array in outsymbols.  */
 202 extern bfd_boolean bfd_generic_link_read_symbols (bfd *);
 203
 204 struct bfd_sym_chain
 205 {
 206   struct bfd_sym_chain *next;
 207   const char *name;
 208 };
 209 \f
 210 /* How to handle unresolved symbols.
 211    There are four possibilities which are enumerated below:  */
 212 enum report_method
 213 {
 214   /* This is the initial value when then link_info structure is created.
 215      It allows the various stages of the linker to determine whether they
 216      allowed to set the value.  */
 217   RM_NOT_YET_SET = 0,
 218   RM_IGNORE,
 219   RM_GENERATE_WARNING,
 220   RM_GENERATE_ERROR
 221 };
 222
 223 struct bfd_elf_dynamic_list;
 224
 225 /* This structure holds all the information needed to communicate
 226    between BFD and the linker when doing a link.  */
 227
 228 struct bfd_link_info
 229 {
 230   /* TRUE if BFD should generate a relocatable object file.  */
 231   unsigned int relocatable: 1;
 232
 233   /* TRUE if BFD should generate relocation information in the final
 234      executable.  */
 235   unsigned int emitrelocations: 1;
 236
 237   /* TRUE if BFD should generate a "task linked" object file,
 238      similar to relocatable but also with globals converted to
 239      statics.  */
 240   unsigned int task_link: 1;
 241
 242   /* TRUE if BFD should generate a shared object.  */
 243   unsigned int shared: 1;
 244
 245   /* TRUE if BFD should pre-bind symbols in a shared object.  */
 246   unsigned int symbolic: 1;
 247
 248   /* TRUE if BFD should export all symbols in the dynamic symbol table
 249      of an executable, rather than only those used.  */
 250   unsigned int export_dynamic: 1;
 251
 252   /* TRUE if shared objects should be linked directly, not shared.  */
 253   unsigned int static_link: 1;
 254
 255   /* TRUE if the output file should be in a traditional format.  This
 256      is equivalent to the setting of the BFD_TRADITIONAL_FORMAT flag
 257      on the output file, but may be checked when reading the input
 258      files.  */
 259   unsigned int traditional_format: 1;
 260
 261   /* TRUE if we want to produced optimized output files.  This might
 262      need much more time and therefore must be explicitly selected.  */
 263   unsigned int optimize: 1;
 264
 265   /* TRUE if ok to have multiple definition.  */
 266   unsigned int allow_multiple_definition: 1;
 267
 268   /* TRUE if ok to have version with no definition.  */
 269   unsigned int allow_undefined_version: 1;
 270
 271   /* TRUE if a default symbol version should be created and used for
 272      exported symbols.  */
 273   unsigned int create_default_symver: 1;
 274
 275   /* TRUE if a default symbol version should be created and used for
 276      imported symbols.  */
 277   unsigned int default_imported_symver: 1;
 278
 279   /* TRUE if symbols should be retained in memory, FALSE if they
 280      should be freed and reread.  */
 281   unsigned int keep_memory: 1;
 282
 283   /* TRUE if every symbol should be reported back via the notice
 284      callback.  */
 285   unsigned int notice_all: 1;
 286
 287   /* TRUE if executable should not contain copy relocs.
 288      Setting this true may result in a non-sharable text segment.  */
 289   unsigned int nocopyreloc: 1;
 290
 291   /* TRUE if the new ELF dynamic tags are enabled. */
 292   unsigned int new_dtags: 1;
 293
 294   /* TRUE if non-PLT relocs should be merged into one reloc section
 295      and sorted so that relocs against the same symbol come together.  */
 296   unsigned int combreloc: 1;
 297
 298   /* TRUE if .eh_frame_hdr section and PT_GNU_EH_FRAME ELF segment
 299      should be created.  */
 300   unsigned int eh_frame_hdr: 1;
 301
 302   /* TRUE if global symbols in discarded sections should be stripped.  */
 303   unsigned int strip_discarded: 1;
 304
 305   /* TRUE if generating a position independent executable.  */
 306   unsigned int pie: 1;
 307
 308   /* TRUE if generating an executable, position independent or not.  */
 309   unsigned int executable : 1;
 310
 311   /* TRUE if PT_GNU_STACK segment should be created with PF_R|PF_W|PF_X
 312      flags.  */
 313   unsigned int execstack: 1;
 314
 315   /* TRUE if PT_GNU_STACK segment should be created with PF_R|PF_W
 316      flags.  */
 317   unsigned int noexecstack: 1;
 318
 319   /* TRUE if PT_GNU_RELRO segment should be created.  */
 320   unsigned int relro: 1;
 321
 322   /* TRUE if we should warn when adding a DT_TEXTREL to a shared object.  */
 323   unsigned int warn_shared_textrel: 1;
 324
 325   /* TRUE if we should warn alternate ELF machine code.  */
 326   unsigned int warn_alternate_em: 1;
 327
 328   /* TRUE if unreferenced sections should be removed.  */
 329   unsigned int gc_sections: 1;
 330
 331   /* TRUE if user shoudl be informed of removed unreferenced sections.  */
 332   unsigned int print_gc_sections: 1;
 333
 334   /* TRUE if .hash section should be created.  */
 335   unsigned int emit_hash: 1;
 336
 337   /* TRUE if .gnu.hash section should be created.  */
 338   unsigned int emit_gnu_hash: 1;
 339
 340   /* If TRUE reduce memory overheads, at the expense of speed. This will
 341      cause map file generation to use an O(N^2) algorithm and disable
 342      caching ELF symbol buffer.  */
 343   unsigned int reduce_memory_overheads: 1;
 344
 345   /* TRUE if all data symbols should be dynamic.  */
 346    unsigned int dynamic_data: 1;
 347
 348   /* TRUE if some symbols have to be dynamic, controlled by
 349      --dynamic-list command line options.  */
 350   unsigned int dynamic: 1;
 351
 352   /* Non-NULL if .note.gnu.build-id section should be created.  */
 353   char *emit_note_gnu_build_id;
 354
 355   /* What to do with unresolved symbols in an object file.
 356      When producing executables the default is GENERATE_ERROR.
 357      When producing shared libraries the default is IGNORE.  The
 358      assumption with shared libraries is that the reference will be
 359      resolved at load/execution time.  */
 360   enum report_method unresolved_syms_in_objects;
 361
 362   /* What to do with unresolved symbols in a shared library.
 363      The same defaults apply.  */
 364   enum report_method unresolved_syms_in_shared_libs;
 365
 366   /* Which symbols to strip.  */
 367   enum bfd_link_strip strip;
 368
 369   /* Which local symbols to discard.  */
 370   enum bfd_link_discard discard;
 371
 372   /* Criteria for skipping symbols when detemining
 373      whether to include an object from an archive. */
 374   enum bfd_link_common_skip_ar_aymbols common_skip_ar_aymbols;
 375
 376   /* Char that may appear as the first char of a symbol, but should be
 377      skipped (like symbol_leading_char) when looking up symbols in
 378      wrap_hash.  Used by PowerPC Linux for 'dot' symbols.  */
 379   char wrap_char;
 380
 381   /* Separator between archive and filename in linker script filespecs.  */
 382   char path_separator;
 383
 384   /* Function callbacks.  */
 385   const struct bfd_link_callbacks *callbacks;
 386
 387   /* Hash table handled by BFD.  */
 388   struct bfd_link_hash_table *hash;
 389
 390   /* Hash table of symbols to keep.  This is NULL unless strip is
 391      strip_some.  */
 392   struct bfd_hash_table *keep_hash;
 393
 394   /* Hash table of symbols to report back via the notice callback.  If
 395      this is NULL, and notice_all is FALSE, then no symbols are
 396      reported back.  */
 397   struct bfd_hash_table *notice_hash;
 398
 399   /* Hash table of symbols which are being wrapped (the --wrap linker
 400      option).  If this is NULL, no symbols are being wrapped.  */
 401   struct bfd_hash_table *wrap_hash;
 402
 403   /* The output BFD.  */
 404   bfd *output_bfd;
 405
 406   /* The list of input BFD's involved in the link.  These are chained
 407      together via the link_next field.  */
 408   bfd *input_bfds;
 409   bfd **input_bfds_tail;
 410
 411   /* If a symbol should be created for each input BFD, this is section
 412      where those symbols should be placed.  It must be a section in
 413      the output BFD.  It may be NULL, in which case no such symbols
 414      will be created.  This is to support CREATE_OBJECT_SYMBOLS in the
 415      linker command language.  */
 416   asection *create_object_symbols_section;
 417
 418   /* List of global symbol names that are starting points for marking
 419      sections against garbage collection.  */
 420   struct bfd_sym_chain *gc_sym_list;
 421
 422   /* If a base output file is wanted, then this points to it */
 423   void *base_file;
 424
 425   /* The function to call when the executable or shared object is
 426      loaded.  */
 427   const char *init_function;
 428
 429   /* The function to call when the executable or shared object is
 430      unloaded.  */
 431   const char *fini_function;
 432
 433   /* Number of relaxation passes.  Usually only one relaxation pass
 434      is needed.  But a backend can have as many relaxation passes as
 435      necessary.  During bfd_relax_section call, it is set to the
 436      current pass, starting from 0.  */
 437   int relax_pass;
 438
 439   /* Number of relaxation trips.  This number is incremented every
 440      time the relaxation pass is restarted due to a previous
 441      relaxation returning true in *AGAIN.  */
 442   int relax_trip;
 443
 444   /* Non-zero if auto-import thunks for DATA items in pei386 DLLs
 445      should be generated/linked against.  Set to 1 if this feature
 446      is explicitly requested by the user, -1 if enabled by default.  */
 447   int pei386_auto_import;
 448
 449   /* Non-zero if runtime relocs for DATA items with non-zero addends
 450      in pei386 DLLs should be generated.  Set to 1 if this feature
 451      is explicitly requested by the user, -1 if enabled by default.  */
 452   int pei386_runtime_pseudo_reloc;
 453
 454   /* How many spare .dynamic DT_NULL entries should be added?  */
 455   unsigned int spare_dynamic_tags;
 456
 457   /* May be used to set DT_FLAGS for ELF. */
 458   bfd_vma flags;
 459
 460   /* May be used to set DT_FLAGS_1 for ELF. */
 461   bfd_vma flags_1;
 462
 463   /* Start and end of RELRO region.  */
 464   bfd_vma relro_start, relro_end;
 465
 466   /* List of symbols should be dynamic.  */
 467   struct bfd_elf_dynamic_list *dynamic_list;
 468 };
 469
 470 /* This structures holds a set of callback functions.  These are called
 471    by the BFD linker routines.  Except for the info functions, the first
 472    argument to each callback function is the bfd_link_info structure
 473    being used and each function returns a boolean value.  If the
 474    function returns FALSE, then the BFD function which called it should
 475    return with a failure indication.  */
 476
 477 struct bfd_link_callbacks
 478 {
 479   /* A function which is called when an object is added from an
 480      archive.  ABFD is the archive element being added.  NAME is the
 481      name of the symbol which caused the archive element to be pulled
 482      in.  */
 483   bfd_boolean (*add_archive_element)
 484     (struct bfd_link_info *, bfd *abfd, const char *name);
 485   /* A function which is called when a symbol is found with multiple
 486      definitions.  NAME is the symbol which is defined multiple times.
 487      OBFD is the old BFD, OSEC is the old section, OVAL is the old
 488      value, NBFD is the new BFD, NSEC is the new section, and NVAL is
 489      the new value.  OBFD may be NULL.  OSEC and NSEC may be
 490      bfd_com_section or bfd_ind_section.  */
 491   bfd_boolean (*multiple_definition)
 492     (struct bfd_link_info *, const char *name,
 493      bfd *obfd, asection *osec, bfd_vma oval,
 494      bfd *nbfd, asection *nsec, bfd_vma nval);
 495   /* A function which is called when a common symbol is defined
 496      multiple times.  NAME is the symbol appearing multiple times.
 497      OBFD is the BFD of the existing symbol; it may be NULL if this is
 498      not known.  OTYPE is the type of the existing symbol, which may
 499      be bfd_link_hash_defined, bfd_link_hash_defweak,
 500      bfd_link_hash_common, or bfd_link_hash_indirect.  If OTYPE is
 501      bfd_link_hash_common, OSIZE is the size of the existing symbol.
 502      NBFD is the BFD of the new symbol.  NTYPE is the type of the new
 503      symbol, one of bfd_link_hash_defined, bfd_link_hash_common, or
 504      bfd_link_hash_indirect.  If NTYPE is bfd_link_hash_common, NSIZE
 505      is the size of the new symbol.  */
 506   bfd_boolean (*multiple_common)
 507     (struct bfd_link_info *, const char *name,
 508      bfd *obfd, enum bfd_link_hash_type otype, bfd_vma osize,
 509      bfd *nbfd, enum bfd_link_hash_type ntype, bfd_vma nsize);
 510   /* A function which is called to add a symbol to a set.  ENTRY is
 511      the link hash table entry for the set itself (e.g.,
 512      __CTOR_LIST__).  RELOC is the relocation to use for an entry in
 513      the set when generating a relocatable file, and is also used to
 514      get the size of the entry when generating an executable file.
 515      ABFD, SEC and VALUE identify the value to add to the set.  */
 516   bfd_boolean (*add_to_set)
 517     (struct bfd_link_info *, struct bfd_link_hash_entry *entry,
 518      bfd_reloc_code_real_type reloc, bfd *abfd, asection *sec, bfd_vma value);
 519   /* A function which is called when the name of a g++ constructor or
 520      destructor is found.  This is only called by some object file
 521      formats.  CONSTRUCTOR is TRUE for a constructor, FALSE for a
 522      destructor.  This will use BFD_RELOC_CTOR when generating a
 523      relocatable file.  NAME is the name of the symbol found.  ABFD,
 524      SECTION and VALUE are the value of the symbol.  */
 525   bfd_boolean (*constructor)
 526     (struct bfd_link_info *, bfd_boolean constructor, const char *name,
 527      bfd *abfd, asection *sec, bfd_vma value);
 528   /* A function which is called to issue a linker warning.  For
 529      example, this is called when there is a reference to a warning
 530      symbol.  WARNING is the warning to be issued.  SYMBOL is the name
 531      of the symbol which triggered the warning; it may be NULL if
 532      there is none.  ABFD, SECTION and ADDRESS identify the location
 533      which trigerred the warning; either ABFD or SECTION or both may
 534      be NULL if the location is not known.  */
 535   bfd_boolean (*warning)
 536     (struct bfd_link_info *, const char *warning, const char *symbol,
 537      bfd *abfd, asection *section, bfd_vma address);
 538   /* A function which is called when a relocation is attempted against
 539      an undefined symbol.  NAME is the symbol which is undefined.
 540      ABFD, SECTION and ADDRESS identify the location from which the
 541      reference is made. FATAL indicates whether an undefined symbol is
 542      a fatal error or not. In some cases SECTION may be NULL.  */
 543   bfd_boolean (*undefined_symbol)
 544     (struct bfd_link_info *, const char *name, bfd *abfd,
 545      asection *section, bfd_vma address, bfd_boolean fatal);
 546   /* A function which is called when a reloc overflow occurs. ENTRY is
 547      the link hash table entry for the symbol the reloc is against.
 548      NAME is the name of the local symbol or section the reloc is
 549      against, RELOC_NAME is the name of the relocation, and ADDEND is
 550      any addend that is used.  ABFD, SECTION and ADDRESS identify the
 551      location at which the overflow occurs; if this is the result of a
 552      bfd_section_reloc_link_order or bfd_symbol_reloc_link_order, then
 553      ABFD will be NULL.  */
 554   bfd_boolean (*reloc_overflow)
 555     (struct bfd_link_info *, struct bfd_link_hash_entry *entry,
 556      const char *name, const char *reloc_name, bfd_vma addend,
 557      bfd *abfd, asection *section, bfd_vma address);
 558   /* A function which is called when a dangerous reloc is performed.
 559      MESSAGE is an appropriate message.
 560      ABFD, SECTION and ADDRESS identify the location at which the
 561      problem occurred; if this is the result of a
 562      bfd_section_reloc_link_order or bfd_symbol_reloc_link_order, then
 563      ABFD will be NULL.  */
 564   bfd_boolean (*reloc_dangerous)
 565     (struct bfd_link_info *, const char *message,
 566      bfd *abfd, asection *section, bfd_vma address);
 567   /* A function which is called when a reloc is found to be attached
 568      to a symbol which is not being written out.  NAME is the name of
 569      the symbol.  ABFD, SECTION and ADDRESS identify the location of
 570      the reloc; if this is the result of a
 571      bfd_section_reloc_link_order or bfd_symbol_reloc_link_order, then
 572      ABFD will be NULL.  */
 573   bfd_boolean (*unattached_reloc)
 574     (struct bfd_link_info *, const char *name,
 575      bfd *abfd, asection *section, bfd_vma address);
 576   /* A function which is called when a symbol in notice_hash is
 577      defined or referenced.  NAME is the symbol.  ABFD, SECTION and
 578      ADDRESS are the value of the symbol.  If SECTION is
 579      bfd_und_section, this is a reference.  */
 580   bfd_boolean (*notice)
 581     (struct bfd_link_info *, const char *name,
 582      bfd *abfd, asection *section, bfd_vma address);
 583   /* Error or warning link info message.  */
 584   void (*einfo)
 585     (const char *fmt, ...);
 586   /* General link info message.  */
 587   void (*info)
 588     (const char *fmt, ...);
 589   /* Message to be printed in linker map file.  */
 590   void (*minfo)
 591     (const char *fmt, ...);
 592   /* This callback provides a chance for users of the BFD library to
 593      override its decision about whether to place two adjacent sections
 594      into the same segment.  */
 595   bfd_boolean (*override_segment_assignment)
 596     (struct bfd_link_info *, bfd * abfd,
 597      asection * current_section, asection * previous_section,
 598      bfd_boolean new_segment);
 599 };
 600 \f
 601 /* The linker builds link_order structures which tell the code how to
 602    include input data in the output file.  */
 603
 604 /* These are the types of link_order structures.  */
 605
 606 enum bfd_link_order_type
 607 {
 608   bfd_undefined_link_order,     /* Undefined.  */
 609   bfd_indirect_link_order,      /* Built from a section.  */
 610   bfd_data_link_order,          /* Set to explicit data.  */
 611   bfd_section_reloc_link_order, /* Relocate against a section.  */
 612   bfd_symbol_reloc_link_order   /* Relocate against a symbol.  */
 613 };
 614
 615 /* This is the link_order structure itself.  These form a chain
 616    attached to the output section whose contents they are describing.  */
 617
 618 struct bfd_link_order
 619 {
 620   /* Next link_order in chain.  */
 621   struct bfd_link_order *next;
 622   /* Type of link_order.  */
 623   enum bfd_link_order_type type;
 624   /* Offset within output section.  */
 625   bfd_vma offset;
 626   /* Size within output section.  */
 627   bfd_size_type size;
 628   /* Type specific information.  */
 629   union
 630     {
 631       struct
 632         {
 633           /* Section to include.  If this is used, then
 634              section->output_section must be the section the
 635              link_order is attached to, section->output_offset must
 636              equal the link_order offset field, and section->size
 637              must equal the link_order size field.  Maybe these
 638              restrictions should be relaxed someday.  */
 639           asection *section;
 640         } indirect;
 641       struct
 642         {
 643           /* Size of contents, or zero when contents size == size
 644              within output section.
 645              A non-zero value allows filling of the output section
 646              with an arbitrary repeated pattern.  */
 647           unsigned int size;
 648           /* Data to put into file.  */
 649           bfd_byte *contents;
 650         } data;
 651       struct
 652         {
 653           /* Description of reloc to generate.  Used for
 654              bfd_section_reloc_link_order and
 655              bfd_symbol_reloc_link_order.  */
 656           struct bfd_link_order_reloc *p;
 657         } reloc;
 658     } u;
 659 };
 660
 661 /* A linker order of type bfd_section_reloc_link_order or
 662    bfd_symbol_reloc_link_order means to create a reloc against a
 663    section or symbol, respectively.  This is used to implement -Ur to
 664    generate relocs for the constructor tables.  The
 665    bfd_link_order_reloc structure describes the reloc that BFD should
 666    create.  It is similar to a arelent, but I didn't use arelent
 667    because the linker does not know anything about most symbols, and
 668    any asymbol structure it creates will be partially meaningless.
 669    This information could logically be in the bfd_link_order struct,
 670    but I didn't want to waste the space since these types of relocs
 671    are relatively rare.  */
 672
 673 struct bfd_link_order_reloc
 674 {
 675   /* Reloc type.  */
 676   bfd_reloc_code_real_type reloc;
 677
 678   union
 679     {
 680       /* For type bfd_section_reloc_link_order, this is the section
 681          the reloc should be against.  This must be a section in the
 682          output BFD, not any of the input BFDs.  */
 683       asection *section;
 684       /* For type bfd_symbol_reloc_link_order, this is the name of the
 685          symbol the reloc should be against.  */
 686       const char *name;
 687     } u;
 688
 689   /* Addend to use.  The object file should contain zero.  The BFD
 690      backend is responsible for filling in the contents of the object
 691      file correctly.  For some object file formats (e.g., COFF) the
 692      addend must be stored into in the object file, and for some
 693      (e.g., SPARC a.out) it is kept in the reloc.  */
 694   bfd_vma addend;
 695 };
 696
 697 /* Allocate a new link_order for a section.  */
 698 extern struct bfd_link_order *bfd_new_link_order (bfd *, asection *);
 699
 700 /* These structures are used to describe version information for the
 701    ELF linker.  These structures could be manipulated entirely inside
 702    BFD, but it would be a pain.  Instead, the regular linker sets up
 703    these structures, and then passes them into BFD.  */
 704
 705 /* Glob pattern for a version.  */
 706
 707 struct bfd_elf_version_expr
 708 {
 709   /* Next glob pattern for this version.  */
 710   struct bfd_elf_version_expr *next;
 711   /* Glob pattern.  */
 712   const char *pattern;
 713   /* Set if pattern is not a glob.  */
 714   unsigned int literal : 1;
 715   /* Defined by ".symver".  */
 716   unsigned int symver : 1;
 717   /* Defined by version script.  */
 718   unsigned int script : 1;
 719   /* Pattern type.  */
 720 #define BFD_ELF_VERSION_C_TYPE          1
 721 #define BFD_ELF_VERSION_CXX_TYPE        2
 722 #define BFD_ELF_VERSION_JAVA_TYPE       4
 723   unsigned int mask : 3;
 724 };
 725
 726 struct bfd_elf_version_expr_head
 727 {
 728   /* List of all patterns, both wildcards and non-wildcards.  */
 729   struct bfd_elf_version_expr *list;
 730   /* Hash table for non-wildcards.  */
 731   void *htab;
 732   /* Remaining patterns.  */
 733   struct bfd_elf_version_expr *remaining;
 734   /* What kind of pattern types are present in list (bitmask).  */
 735   unsigned int mask;
 736 };
 737
 738 /* Version dependencies.  */
 739
 740 struct bfd_elf_version_deps
 741 {
 742   /* Next dependency for this version.  */
 743   struct bfd_elf_version_deps *next;
 744   /* The version which this version depends upon.  */
 745   struct bfd_elf_version_tree *version_needed;
 746 };
 747
 748 /* A node in the version tree.  */
 749
 750 struct bfd_elf_version_tree
 751 {
 752   /* Next version.  */
 753   struct bfd_elf_version_tree *next;
 754   /* Name of this version.  */
 755   const char *name;
 756   /* Version number.  */
 757   unsigned int vernum;
 758   /* Regular expressions for global symbols in this version.  */
 759   struct bfd_elf_version_expr_head globals;
 760   /* Regular expressions for local symbols in this version.  */
 761   struct bfd_elf_version_expr_head locals;
 762   /* List of versions which this version depends upon.  */
 763   struct bfd_elf_version_deps *deps;
 764   /* Index of the version name.  This is used within BFD.  */
 765   unsigned int name_indx;
 766   /* Whether this version tree was used.  This is used within BFD.  */
 767   int used;
 768   /* Matching hook.  */
 769   struct bfd_elf_version_expr *(*match)
 770     (struct bfd_elf_version_expr_head *head,
 771      struct bfd_elf_version_expr *prev, const char *sym);
 772 };
 773
 774 struct bfd_elf_dynamic_list
 775 {
 776   struct bfd_elf_version_expr_head head;
 777   struct bfd_elf_version_expr *(*match)
 778     (struct bfd_elf_version_expr_head *head,
 779      struct bfd_elf_version_expr *prev, const char *sym);
 780 };
 781
 782 #endif