home *** CD-ROM | disk | FTP | other *** search
/ Geek Gadgets 1 / ADE-1.bin / ade-dist / binutils-2.7-bin.lha / include / bfdlink.h < prev    next >
C/C++ Source or Header  |  1996-10-12  |  19KB  |  453 lines
  1. /* bfdlink.h -- header file for BFD link routines
  2.    Copyright 1993 Free Software Foundation, Inc.
  3.    Written by Steve Chamberlain and Ian Lance Taylor, Cygnus Support.
  4.  
  5. This file is part of BFD, the Binary File Descriptor library.
  6.  
  7. This program is free software; you can redistribute it and/or modify
  8. it under the terms of the GNU General Public License as published by
  9. the Free Software Foundation; either version 2 of the License, or
  10. (at your option) any later version.
  11.  
  12. This program is distributed in the hope that it will be useful,
  13. but WITHOUT ANY WARRANTY; without even the implied warranty of
  14. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15. GNU General Public License for more details.
  16.  
  17. You should have received a copy of the GNU General Public License
  18. along with this program; if not, write to the Free Software
  19. Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
  20.  
  21. #ifndef BFDLINK_H
  22. #define BFDLINK_H
  23.  
  24. /* Which symbols to strip during a link.  */
  25. enum bfd_link_strip
  26. {
  27.   strip_none,        /* Don't strip any symbols.  */
  28.   strip_debugger,    /* Strip debugging symbols.  */
  29.   strip_some,        /* keep_hash is the list of symbols to keep.  */
  30.   strip_all        /* Strip all symbols.  */
  31. };
  32.  
  33. /* Which local symbols to discard during a link.  This is irrelevant
  34.    if strip_all is used.  */
  35. enum bfd_link_discard
  36. {
  37.   discard_none,        /* Don't discard any locals.  */
  38.   discard_l,        /* Discard locals with a certain prefix.  */
  39.   discard_all        /* Discard all locals.  */
  40. };
  41.  
  42. /* These are the possible types of an entry in the BFD link hash
  43.    table.  */
  44.  
  45. enum bfd_link_hash_type
  46. {
  47.   bfd_link_hash_new,        /* Symbol is new.  */
  48.   bfd_link_hash_undefined,    /* Symbol seen before, but undefined.  */
  49.   bfd_link_hash_undefweak,    /* Symbol is weak and undefined.  */
  50.   bfd_link_hash_defined,    /* Symbol is defined.  */
  51.   bfd_link_hash_defweak,    /* Symbol is weak and defined.  */
  52.   bfd_link_hash_common,        /* Symbol is common.  */
  53.   bfd_link_hash_indirect,    /* Symbol is an indirect link.  */
  54.   bfd_link_hash_warning        /* Like indirect, but warn if referenced.  */
  55. };
  56.  
  57. /* The linking routines use a hash table which uses this structure for
  58.    its elements.  */
  59.  
  60. struct bfd_link_hash_entry
  61. {
  62.   /* Base hash table entry structure.  */
  63.   struct bfd_hash_entry root;
  64.   /* Type of this entry.  */
  65.   enum bfd_link_hash_type type;
  66.  
  67.   /* Undefined and common symbols are kept in a linked list through
  68.      this field.  This field is not in the union because that would
  69.      force us to remove entries from the list when we changed their
  70.      type, which would force the list to be doubly linked, which would
  71.      waste more memory.  When an undefined or common symbol is
  72.      created, it should be added to this list, the head of which is in
  73.      the link hash table itself.  As symbols are defined, they need
  74.      not be removed from the list; anything which reads the list must
  75.      doublecheck the symbol type.
  76.  
  77.      Weak symbols are not kept on this list.
  78.  
  79.      Defined and defweak symbols use this field as a reference marker.
  80.      If the field is not NULL, or this structure is the tail of the
  81.      undefined symbol list, the symbol has been referenced.  If the
  82.      symbol is undefined and becomes defined, this field will
  83.      automatically be non-NULL since the symbol will have been on the
  84.      undefined symbol list.  */
  85.   struct bfd_link_hash_entry *next;
  86.   /* A union of information depending upon the type.  */
  87.   union
  88.     {
  89.       /* Nothing is kept for bfd_hash_new.  */
  90.       /* bfd_link_hash_undefined, bfd_link_hash_undefweak.  */
  91.       struct
  92.     {
  93.       bfd *abfd;        /* BFD symbol was found in.  */
  94.     } undef;
  95.       /* bfd_link_hash_defined, bfd_link_hash_defweak.  */
  96.       struct
  97.     {
  98.       bfd_vma value;    /* Symbol value.  */
  99.       asection *section;    /* Symbol section.  */
  100.     } def;
  101.       /* bfd_link_hash_indirect, bfd_link_hash_warning.  */
  102.       struct
  103.     {
  104.       struct bfd_link_hash_entry *link;    /* Real symbol.  */
  105.       const char *warning;    /* Warning (bfd_link_hash_warning only).  */
  106.     } i;
  107.       /* bfd_link_hash_common.  */
  108.       struct
  109.     {
  110.       /* The linker needs to know three things about common
  111.              symbols: the size, the alignment, and the section in
  112.              which the symbol should be placed.  We store the size
  113.              here, and we allocate a small structure to hold the
  114.              section and the alignment.  The alignment is stored as a
  115.              power of two.  We don't store all the information
  116.              directly because we don't want to increase the size of
  117.              the union; this structure is a major space user in the
  118.              linker.  */
  119.       bfd_size_type size;    /* Common symbol size.  */
  120.       struct bfd_link_hash_common_entry
  121.         {
  122.           unsigned int alignment_power;    /* Alignment.  */
  123.           asection *section;        /* Symbol section.  */
  124.         } *p;
  125.     } c;
  126.     } u;
  127. };
  128.  
  129. /* This is the link hash table.  It is a derived class of
  130.    bfd_hash_table.  */
  131.  
  132. struct bfd_link_hash_table
  133. {
  134.   /* The hash table itself.  */
  135.   struct bfd_hash_table table;
  136.   /* The back end which created this hash table.  This indicates the
  137.      type of the entries in the hash table, which is sometimes
  138.      important information when linking object files of different
  139.      types together.  */
  140.   const bfd_target *creator;
  141.   /* A linked list of undefined and common symbols, linked through the
  142.      next field in the bfd_link_hash_entry structure.  */
  143.   struct bfd_link_hash_entry *undefs;
  144.   /* Entries are added to the tail of the undefs list.  */
  145.   struct bfd_link_hash_entry *undefs_tail;
  146. };
  147.  
  148. /* Look up an entry in a link hash table.  If FOLLOW is true, this
  149.    follows bfd_link_hash_indirect and bfd_link_hash_warning links to
  150.    the real symbol.  */
  151. extern struct bfd_link_hash_entry *bfd_link_hash_lookup
  152.   PARAMS ((struct bfd_link_hash_table *, const char *, boolean create,
  153.        boolean copy, boolean follow));
  154.  
  155. /* Look up an entry in the main linker hash table if the symbol might
  156.    be wrapped.  This should only be used for references to an
  157.    undefined symbol, not for definitions of a symbol.  */
  158.  
  159. extern struct bfd_link_hash_entry *bfd_wrapped_link_hash_lookup
  160.   PARAMS ((bfd *, struct bfd_link_info *, const char *, boolean, boolean,
  161.        boolean));
  162.  
  163. /* Traverse a link hash table.  */
  164. extern void bfd_link_hash_traverse
  165.   PARAMS ((struct bfd_link_hash_table *,
  166.        boolean (*) (struct bfd_link_hash_entry *, PTR),
  167.        PTR));
  168.  
  169. /* Add an entry to the undefs list.  */
  170. extern void bfd_link_add_undef
  171.   PARAMS ((struct bfd_link_hash_table *, struct bfd_link_hash_entry *));
  172.  
  173. /* This structure holds all the information needed to communicate
  174.    between BFD and the linker when doing a link.  */
  175.  
  176. struct bfd_link_info
  177. {
  178.   /* Function callbacks.  */
  179.   const struct bfd_link_callbacks *callbacks;
  180.   /* true if BFD should generate a relocateable object file.  */
  181.   boolean relocateable;
  182.   /* true if BFD should generate a shared object.  */
  183.   boolean shared;
  184.   /* true if BFD should pre-bind symbols in a shared object.  */
  185.   boolean symbolic;
  186.   /* true if shared objects should be linked directly, not shared.  */
  187.   boolean static_link;
  188.   /* Which symbols to strip.  */
  189.   enum bfd_link_strip strip;
  190.   /* Which local symbols to discard.  */
  191.   enum bfd_link_discard discard;
  192.   /* The local symbol prefix to discard if using discard_l.  */
  193.   unsigned int lprefix_len;
  194.   const char *lprefix;
  195.   /* true if symbols should be retained in memory, false if they
  196.      should be freed and reread.  */
  197.   boolean keep_memory;
  198.   /* The list of input BFD's involved in the link.  These are chained
  199.      together via the link_next field.  */
  200.   bfd *input_bfds;
  201.   /* If a symbol should be created for each input BFD, this is section
  202.      where those symbols should be placed.  It must be a section in
  203.      the output BFD.  It may be NULL, in which case no such symbols
  204.      will be created.  This is to support CREATE_OBJECT_SYMBOLS in the
  205.      linker command language.  */
  206.   asection *create_object_symbols_section;
  207.   /* Hash table handled by BFD.  */
  208.   struct bfd_link_hash_table *hash;
  209.   /* Hash table of symbols to keep.  This is NULL unless strip is
  210.      strip_some.  */
  211.   struct bfd_hash_table *keep_hash;
  212.   /* Hash table of symbols to report back via notice_callback.  If
  213.      this is NULL no symbols are reported back.  */
  214.   struct bfd_hash_table *notice_hash;
  215.   /* Hash table of symbols which are being wrapped (the --wrap linker
  216.      option).  If this is NULL, no symbols are being wrapped.  */
  217.   struct bfd_hash_table *wrap_hash;
  218.  
  219.   /* If a base output file is wanted, then this points to it */
  220.   PTR base_file;
  221. };
  222.  
  223. /* This structures holds a set of callback functions.  These are
  224.    called by the BFD linker routines.  The first argument to each
  225.    callback function is the bfd_link_info structure being used.  Each
  226.    function returns a boolean value.  If the function returns false,
  227.    then the BFD function which called it will return with a failure
  228.    indication.  */
  229.  
  230. struct bfd_link_callbacks
  231. {
  232.   /* A function which is called when an object is added from an
  233.      archive.  ABFD is the archive element being added.  NAME is the
  234.      name of the symbol which caused the archive element to be pulled
  235.      in.  */
  236.   boolean (*add_archive_element) PARAMS ((struct bfd_link_info *,
  237.                       bfd *abfd,
  238.                       const char *name));
  239.   /* A function which is called when a symbol is found with multiple
  240.      definitions.  NAME is the symbol which is defined multiple times.
  241.      OBFD is the old BFD, OSEC is the old section, OVAL is the old
  242.      value, NBFD is the new BFD, NSEC is the new section, and NVAL is
  243.      the new value.  OBFD may be NULL.  OSEC and NSEC may be
  244.      bfd_com_section or bfd_ind_section.  */
  245.   boolean (*multiple_definition) PARAMS ((struct bfd_link_info *,
  246.                       const char *name,
  247.                       bfd *obfd,
  248.                       asection *osec,
  249.                       bfd_vma oval,
  250.                       bfd *nbfd,
  251.                       asection *nsec,
  252.                       bfd_vma nval));
  253.   /* A function which is called when a common symbol is defined
  254.      multiple times.  NAME is the symbol appearing multiple times.
  255.      OBFD is the BFD of the existing symbol; it may be NULL if this is
  256.      not known.  OTYPE is the type of the existing symbol, which may
  257.      be bfd_link_hash_defined, bfd_link_hash_defweak,
  258.      bfd_link_hash_common, or bfd_link_hash_indirect.  If OTYPE is
  259.      bfd_link_hash_common, OSIZE is the size of the existing symbol.
  260.      NBFD is the BFD of the new symbol.  NTYPE is the type of the new
  261.      symbol, one of bfd_link_hash_defined, bfd_link_hash_common, or
  262.      bfd_link_hash_indirect.  If NTYPE is bfd_link_hash_common, NSIZE
  263.      is the size of the new symbol.  */
  264.   boolean (*multiple_common) PARAMS ((struct bfd_link_info *,
  265.                       const char *name,
  266.                       bfd *obfd,
  267.                       enum bfd_link_hash_type otype,
  268.                       bfd_vma osize,
  269.                       bfd *nbfd,
  270.                       enum bfd_link_hash_type ntype,
  271.                       bfd_vma nsize));
  272.   /* A function which is called to add a symbol to a set.  ENTRY is
  273.      the link hash table entry for the set itself (e.g.,
  274.      __CTOR_LIST__).  RELOC is the relocation to use for an entry in
  275.      the set when generating a relocateable file, and is also used to
  276.      get the size of the entry when generating an executable file.
  277.      ABFD, SEC and VALUE identify the value to add to the set.  */
  278.   boolean (*add_to_set) PARAMS ((struct bfd_link_info *,
  279.                  struct bfd_link_hash_entry *entry,
  280.                  bfd_reloc_code_real_type reloc,
  281.                  bfd *abfd, asection *sec, bfd_vma value));
  282.   /* A function which is called when the name of a g++ constructor or
  283.      destructor is found.  This is only called by some object file
  284.      formats.  CONSTRUCTOR is true for a constructor, false for a
  285.      destructor.  This will use BFD_RELOC_CTOR when generating a
  286.      relocateable file.  NAME is the name of the symbol found.  ABFD,
  287.      SECTION and VALUE are the value of the symbol.  */
  288.   boolean (*constructor) PARAMS ((struct bfd_link_info *,
  289.                   boolean constructor,
  290.                   const char *name, bfd *abfd, asection *sec,
  291.                   bfd_vma value));
  292.   /* A function which is called to issue a linker warning.  For
  293.      example, this is called when there is a reference to a warning
  294.      symbol.  WARNING is the warning to be issued.  SYMBOL is the name
  295.      of the symbol which triggered the warning; it may be NULL if
  296.      there is none.  ABFD, SECTION and ADDRESS identify the location
  297.      which trigerred the warning; either ABFD or SECTION or both may
  298.      be NULL if the location is not known.  */
  299.   boolean (*warning) PARAMS ((struct bfd_link_info *,
  300.                   const char *warning, const char *symbol,
  301.                   bfd *abfd, asection *section,
  302.                   bfd_vma address));
  303.   /* A function which is called when a relocation is attempted against
  304.      an undefined symbol.  NAME is the symbol which is undefined.
  305.      ABFD, SECTION and ADDRESS identify the location from which the
  306.      reference is made.  In some cases SECTION may be NULL.  */
  307.   boolean (*undefined_symbol) PARAMS ((struct bfd_link_info *,
  308.                        const char *name, bfd *abfd,
  309.                        asection *section, bfd_vma address));
  310.   /* A function which is called when a reloc overflow occurs.  NAME is
  311.      the name of the symbol or section the reloc is against,
  312.      RELOC_NAME is the name of the relocation, and ADDEND is any
  313.      addend that is used.  ABFD, SECTION and ADDRESS identify the
  314.      location at which the overflow occurs; if this is the result of a
  315.      bfd_section_reloc_link_order or bfd_symbol_reloc_link_order, then
  316.      ABFD will be NULL.  */
  317.   boolean (*reloc_overflow) PARAMS ((struct bfd_link_info *,
  318.                      const char *name,
  319.                      const char *reloc_name, bfd_vma addend,
  320.                      bfd *abfd, asection *section,
  321.                      bfd_vma address));
  322.   /* A function which is called when a dangerous reloc is performed.
  323.      The canonical example is an a29k IHCONST reloc which does not
  324.      follow an IHIHALF reloc.  MESSAGE is an appropriate message.
  325.      ABFD, SECTION and ADDRESS identify the location at which the
  326.      problem occurred; if this is the result of a
  327.      bfd_section_reloc_link_order or bfd_symbol_reloc_link_order, then
  328.      ABFD will be NULL.  */
  329.   boolean (*reloc_dangerous) PARAMS ((struct bfd_link_info *,
  330.                       const char *message,
  331.                       bfd *abfd, asection *section,
  332.                       bfd_vma address));
  333.   /* A function which is called when a reloc is found to be attached
  334.      to a symbol which is not being written out.  NAME is the name of
  335.      the symbol.  ABFD, SECTION and ADDRESS identify the location of
  336.      the reloc; if this is the result of a
  337.      bfd_section_reloc_link_order or bfd_symbol_reloc_link_order, then
  338.      ABFD will be NULL.  */
  339.   boolean (*unattached_reloc) PARAMS ((struct bfd_link_info *,
  340.                        const char *name,
  341.                        bfd *abfd, asection *section,
  342.                        bfd_vma address));
  343.   /* A function which is called when a symbol in notice_hash is
  344.      defined or referenced.  NAME is the symbol.  ABFD, SECTION and
  345.      ADDRESS are the value of the symbol.  If SECTION is
  346.      bfd_und_section, this is a reference.  */
  347.   boolean (*notice) PARAMS ((struct bfd_link_info *, const char *name,
  348.                  bfd *abfd, asection *section, bfd_vma address));
  349. };
  350.  
  351. /* The linker builds link_order structures which tell the code how to
  352.    include input data in the output file.  */
  353.  
  354. /* These are the types of link_order structures.  */
  355.  
  356. enum bfd_link_order_type
  357. {
  358.   bfd_undefined_link_order,    /* Undefined.  */
  359.   bfd_indirect_link_order,    /* Built from a section.  */
  360.   bfd_fill_link_order,        /* Fill with a 16 bit constant.  */
  361.   bfd_data_link_order,        /* Set to explicit data.  */
  362.   bfd_section_reloc_link_order,    /* Relocate against a section.  */
  363.   bfd_symbol_reloc_link_order    /* Relocate against a symbol.  */
  364. };
  365.  
  366. /* This is the link_order structure itself.  These form a chain
  367.    attached to the section whose contents they are describing.  */
  368.  
  369. struct bfd_link_order 
  370. {
  371.   /* Next link_order in chain.  */
  372.   struct bfd_link_order *next;
  373.   /* Type of link_order.  */
  374.   enum bfd_link_order_type type;
  375.   /* Offset within output section.  */
  376.   bfd_vma offset;  
  377.   /* Size within output section.  */
  378.   bfd_size_type size;
  379.   /* Type specific information.  */
  380.   union 
  381.     {
  382.       struct 
  383.     {
  384.       /* Section to include.  If this is used, then
  385.          section->output_section must be the section the
  386.          link_order is attached to, section->output_offset must
  387.          equal the link_order offset field, and section->_raw_size
  388.          must equal the link_order size field.  Maybe these
  389.          restrictions should be relaxed someday.  */
  390.       asection *section;
  391.     } indirect;
  392.       struct
  393.     {
  394.       /* Value to fill with.  */
  395.       unsigned int value;
  396.     } fill;
  397.       struct
  398.     {
  399.       /* Data to put into file.  The size field gives the number
  400.          of bytes which this field points to.  */
  401.       bfd_byte *contents;
  402.     } data;
  403.       struct
  404.     {
  405.       /* Description of reloc to generate.  Used for
  406.          bfd_section_reloc_link_order and
  407.          bfd_symbol_reloc_link_order.  */
  408.       struct bfd_link_order_reloc *p;
  409.     } reloc;
  410.     } u;
  411. };
  412.  
  413. /* A linker order of type bfd_section_reloc_link_order or
  414.    bfd_symbol_reloc_link_order means to create a reloc against a
  415.    section or symbol, respectively.  This is used to implement -Ur to
  416.    generate relocs for the constructor tables.  The
  417.    bfd_link_order_reloc structure describes the reloc that BFD should
  418.    create.  It is similar to a arelent, but I didn't use arelent
  419.    because the linker does not know anything about most symbols, and
  420.    any asymbol structure it creates will be partially meaningless.
  421.    This information could logically be in the bfd_link_order struct,
  422.    but I didn't want to waste the space since these types of relocs
  423.    are relatively rare.  */
  424.  
  425. struct bfd_link_order_reloc
  426. {
  427.   /* Reloc type.  */
  428.   bfd_reloc_code_real_type reloc;
  429.  
  430.   union
  431.     {
  432.       /* For type bfd_section_reloc_link_order, this is the section
  433.      the reloc should be against.  This must be a section in the
  434.      output BFD, not any of the input BFDs.  */
  435.       asection *section;
  436.       /* For type bfd_symbol_reloc_link_order, this is the name of the
  437.      symbol the reloc should be against.  */
  438.       const char *name;
  439.     } u;
  440.  
  441.   /* Addend to use.  The object file should contain zero.  The BFD
  442.      backend is responsible for filling in the contents of the object
  443.      file correctly.  For some object file formats (e.g., COFF) the
  444.      addend must be stored into in the object file, and for some
  445.      (e.g., SPARC a.out) it is kept in the reloc.  */
  446.   bfd_vma addend;
  447. };
  448.  
  449. /* Allocate a new link_order for a section.  */
  450. extern struct bfd_link_order *bfd_new_link_order PARAMS ((bfd *, asection *));
  451.  
  452. #endif
  453.