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