home *** CD-ROM | disk | FTP | other *** search
/ Frozen Fish 1: Amiga / FrozenFish-Apr94.iso / bbs / gnu / gdb-4.12.tar.gz / gdb-4.12.tar / gdb-4.12 / include / bfdlink.h < prev    next >
C/C++ Source or Header  |  1994-02-03  |  13KB  |  340 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., 675 Mass Ave, Cambridge, MA 02139, 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_weak,        /* Symbol is weak and undefined.  */
  50.   bfd_link_hash_defined,    /* Symbol is defined.  */
  51.   bfd_link_hash_common,        /* Symbol is common.  */
  52.   bfd_link_hash_indirect,    /* Symbol is an indirect link.  */
  53.   bfd_link_hash_warning        /* Like indirect, but warn if referenced.  */
  54. };
  55.  
  56. /* The linking routines use a hash table which uses this structure for
  57.    its elements.  */
  58.  
  59. struct bfd_link_hash_entry
  60. {
  61.   /* Base hash table entry structure.  */
  62.   struct bfd_hash_entry root;
  63.   /* Type of this entry.  */
  64.   enum bfd_link_hash_type type;
  65.   /* Whether this symbol has been written out.  */
  66.   boolean written;
  67.   /* Undefined and common entries 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.  Weak symbols are not kept on this
  76.      list.  */
  77.   struct bfd_link_hash_entry *next;
  78.   /* A union of information depending upon the type.  */
  79.   union
  80.     {
  81.       /* Nothing is kept for bfd_hash_new.  */
  82.       /* bfd_link_hash_undefined, bfd_link_hash_weak.  */
  83.       struct
  84.     {
  85.       bfd *abfd;        /* BFD symbol was found in.  */
  86.     } undef;
  87.       /* bfd_link_hash_defined.  */
  88.       struct
  89.     {
  90.       bfd_vma value;    /* Symbol value.  */
  91.       asection *section;    /* Symbol section.  */
  92.     } def;
  93.       /* bfd_link_hash_indirect, bfd_link_hash_warning.  */
  94.       struct
  95.     {
  96.       struct bfd_link_hash_entry *link;    /* Real symbol.  */
  97.       const char *warning;    /* Warning (bfd_link_hash_warning only).  */
  98.     } i;
  99.       /* bfd_link_hash_common.  */
  100.       struct
  101.     {
  102.       bfd_vma size;        /* Common symbol size.  */
  103.       asection *section;    /* Symbol section.  */
  104.     } c;
  105.     } u;
  106. };
  107.  
  108. /* This is the link hash table.  It is a derived class of
  109.    bfd_hash_table.  */
  110.  
  111. struct bfd_link_hash_table
  112. {
  113.   /* The hash table itself.  */
  114.   struct bfd_hash_table table;
  115.   /* The back end which created this hash table.  This indicates the
  116.      type of the entries in the hash table, which is sometimes
  117.      important information when linking object files of different
  118.      types together.  */
  119.   bfd_target *creator;
  120.   /* A linked list of undefined and common symbols, linked through the
  121.      next field in the bfd_link_hash_entry structure.  */
  122.   struct bfd_link_hash_entry *undefs;
  123.   /* Entries are added to the tail of the undefs list.  */
  124.   struct bfd_link_hash_entry *undefs_tail;
  125. };
  126.  
  127. /* Look up an entry in a link hash table.  If FOLLOW is true, this
  128.    follows bfd_link_hash_indirect and bfd_link_hash_warning links to
  129.    the real symbol.  */
  130. extern struct bfd_link_hash_entry *bfd_link_hash_lookup
  131.   PARAMS ((struct bfd_link_hash_table *, const char *, boolean create,
  132.        boolean copy, boolean follow));
  133.  
  134. /* Traverse a link hash table.  */
  135. extern void bfd_link_hash_traverse
  136.   PARAMS ((struct bfd_link_hash_table *,
  137.        boolean (*) (struct bfd_link_hash_entry *, PTR),
  138.        PTR));
  139.  
  140. /* Add an entry to the undefs list.  */
  141. extern void bfd_link_add_undef
  142.   PARAMS ((struct bfd_link_hash_table *, struct bfd_link_hash_entry *));
  143.  
  144. /* This structure holds all the information needed to communicate
  145.    between BFD and the linker when doing a link.  */
  146.  
  147. struct bfd_link_info
  148. {
  149.   /* Function callbacks.  */
  150.   const struct bfd_link_callbacks *callbacks;
  151.   /* true if BFD should generate a relocateable object file.  */
  152.   boolean relocateable;
  153.   /* Which symbols to strip.  */
  154.   enum bfd_link_strip strip;
  155.   /* Which local symbols to discard.  */
  156.   enum bfd_link_discard discard;
  157.   /* The local symbol prefix to discard if using discard_l.  */
  158.   unsigned int lprefix_len;
  159.   const char *lprefix;
  160.   /* true if symbols should be retained in memory, false if they
  161.      should be freed and reread.  */
  162.   boolean keep_memory;
  163.   /* The list of input BFD's involved in the link.  These are chained
  164.      together via the link_next field.  */
  165.   bfd *input_bfds;
  166.   /* If a symbol should be created for each input BFD, this is section
  167.      where those symbols should be placed.  It must be a section in
  168.      the output BFD.  It may be NULL, in which case no such symbols
  169.      will be created.  This is to support CREATE_OBJECT_SYMBOLS in the
  170.      linker command language.  */
  171.   asection *create_object_symbols_section;
  172.   /* Hash table handled by BFD.  */
  173.   struct bfd_link_hash_table *hash;
  174.   /* Hash table of symbols to keep.  This is NULL unless strip is
  175.      strip_some.  */
  176.   struct bfd_hash_table *keep_hash;
  177.   /* Hash table of symbols to report back via notice_callback.  If
  178.      this is NULL no symbols are reported back.  */
  179.   struct bfd_hash_table *notice_hash;
  180. };
  181.  
  182. /* This structures holds a set of callback functions.  These are
  183.    called by the BFD linker routines.  The first argument to each
  184.    callback function is the bfd_link_info structure being used.  Each
  185.    function returns a boolean value.  If the function returns false,
  186.    then the BFD function which called it will return with a failure
  187.    indication.  */
  188.  
  189. struct bfd_link_callbacks
  190. {
  191.   /* A function which is called when an object is added from an
  192.      archive.  ABFD is the archive element being added.  NAME is the
  193.      name of the symbol which caused the archive element to be pulled
  194.      in.  */
  195.   boolean (*add_archive_element) PARAMS ((struct bfd_link_info *,
  196.                       bfd *abfd,
  197.                       const char *name));
  198.   /* A function which is called when a symbol is found with multiple
  199.      definitions.  NAME is the symbol which is defined multiple times.
  200.      OBFD is the old BFD, OSEC is the old section, OVAL is the old
  201.      value, NBFD is the new BFD, NSEC is the new section, and NVAL is
  202.      the new value.  OBFD may be NULL.  OSEC and NSEC may be
  203.      bfd_com_section or bfd_ind_section.  */
  204.   boolean (*multiple_definition) PARAMS ((struct bfd_link_info *,
  205.                       const char *name,
  206.                       bfd *obfd,
  207.                       asection *osec,
  208.                       bfd_vma oval,
  209.                       bfd *nbfd,
  210.                       asection *nsec,
  211.                       bfd_vma nval));
  212.   /* A function which is called when a common symbol is defined
  213.      multiple times.  NAME is the symbol appearing multiple times.
  214.      OBFD is the BFD of the existing symbol.  OTYPE is the type of the
  215.      existing symbol, either bfd_link_hash_defined or
  216.      bfd_link_hash_common.  If OTYPE is bfd_link_hash_common, OSIZE is
  217.      the size of the existing symbol.  NBFD is the BFD of the new
  218.      symbol.  NTYPE is the type of the new symbol, either
  219.      bfd_link_hash_defined or bfd_link_hash_common.  If NTYPE is
  220.      bfd_link_hash_common, NSIZE is the size of the new symbol.  */
  221.   boolean (*multiple_common) PARAMS ((struct bfd_link_info *,
  222.                       const char *name,
  223.                       bfd *obfd,
  224.                       enum bfd_link_hash_type otype,
  225.                       bfd_vma osize,
  226.                       bfd *nbfd,
  227.                       enum bfd_link_hash_type ntype,
  228.                       bfd_vma nsize));
  229.   /* A function which is called to add a symbol to a set.  ENTRY is
  230.      the link hash table entry for the set itself (e.g.,
  231.      __CTOR_LIST__).  BITSIZE is the size in bits of an entry in the
  232.      set (typically 32 or 64).  ABFD, SEC and VALUE identify the value
  233.      to add to the set.  */
  234.   boolean (*add_to_set) PARAMS ((struct bfd_link_info *,
  235.                  struct bfd_link_hash_entry *entry,
  236.                  unsigned int bitsize,
  237.                  bfd *abfd, asection *sec, bfd_vma value));
  238.   /* A function which is called when the name of a g++ constructor or
  239.      destructor is found.  This is only called by some object file
  240.      formats.  CONSTRUCTOR is true for a constructor, false for a
  241.      destructor.  BITSIZE is the size in bits of a function pointer.
  242.      NAME is the name of the symbol found.  ABFD, SECTION and VALUE
  243.      are the value of the symbol.  */
  244.   boolean (*constructor) PARAMS ((struct bfd_link_info *,
  245.                   boolean constructor, unsigned int bitsize,
  246.                   const char *name, bfd *abfd, asection *sec,
  247.                   bfd_vma value));
  248.   /* A function which is called when there is a reference to a warning
  249.      symbol.  WARNING is the warning to be issued.  */
  250.   boolean (*warning) PARAMS ((struct bfd_link_info *,
  251.                   const char *warning));
  252.   /* A function which is called when a relocation is attempted against
  253.      an undefined symbol.  NAME is the symbol which is undefined.
  254.      ABFD, SECTION and ADDRESS identify the location from which the
  255.      reference is made.  */
  256.   boolean (*undefined_symbol) PARAMS ((struct bfd_link_info *,
  257.                        const char *name, bfd *abfd,
  258.                        asection *section, bfd_vma address));
  259.   /* A function which is called when a reloc overflow occurs.  ABFD,
  260.      SECTION and ADDRESS identify the location at which the overflow
  261.      occurs.  */
  262.   boolean (*reloc_overflow) PARAMS ((struct bfd_link_info *,
  263.                      bfd *abfd, asection *section,
  264.                      bfd_vma address));
  265.   /* A function which is called when a dangerous reloc is performed.
  266.      The canonical example is an a29k IHCONST reloc which does not
  267.      follow an IHIHALF reloc.  MESSAGE is an appropriate message.
  268.      ABFD, SECTION and ADDRESS identify the location at which the
  269.      problem occurred.  */
  270.   boolean (*reloc_dangerous) PARAMS ((struct bfd_link_info *,
  271.                       const char *message,
  272.                       bfd *abfd, asection *section,
  273.                       bfd_vma address));
  274.   /* A function which is called when a reloc is found to be attached
  275.      to a symbol which is not being written out.  NAME is the name of
  276.      the symbol.  ABFD, SECTION and ADDRESS identify the location of
  277.      the reloc.  */
  278.   boolean (*unattached_reloc) PARAMS ((struct bfd_link_info *,
  279.                        const char *name,
  280.                        bfd *abfd, asection *section,
  281.                        bfd_vma address));
  282.   /* A function which is called when a symbol in notice_hash is
  283.      defined or referenced.  NAME is the symbol.  ABFD, SECTION and
  284.      ADDRESS are the value of the symbol.  If SECTION is
  285.      bfd_und_section, this is a reference.  */
  286.   boolean (*notice) PARAMS ((struct bfd_link_info *, const char *name,
  287.                  bfd *abfd, asection *section, bfd_vma address));
  288. };
  289.  
  290. /* The linker builds link_order structures which tell the code how to
  291.    include input data in the output file.  */
  292.  
  293. /* These are the types of link_order structures.  */
  294.  
  295. enum bfd_link_order_type
  296. {
  297.   bfd_undefined_link_order,    /* Undefined.  */
  298.   bfd_indirect_link_order,    /* Built from a section.  */
  299.   bfd_fill_link_order        /* Fill with a 16 bit constant.  */
  300. };
  301.  
  302. /* This is the link_order structure itself.  These form a chain
  303.    attached to the section whose contents they are describing.  */
  304.  
  305. struct bfd_link_order 
  306. {
  307.   /* Next link_order in chain.  */
  308.   struct bfd_link_order *next;
  309.   /* Type of link_order.  */
  310.   enum bfd_link_order_type type;
  311.   /* Offset within output section.  */
  312.   bfd_vma offset;  
  313.   /* Size within output section.  */
  314.   bfd_size_type size;
  315.   /* Type specific information.  */
  316.   union 
  317.     {
  318.       struct 
  319.     {
  320.       /* Section to include.  If this is used, then
  321.          section->output_section must be the section the
  322.          link_order is attached to, section->output_offset must
  323.          equal the link_order offset field, and section->_raw_size
  324.          must equal the link_order size field.  Maybe these
  325.          restrictions should be relaxed someday.  */
  326.       asection *section;
  327.     } indirect;
  328.       struct
  329.     {
  330.       /* Value to fill with.  */
  331.       unsigned int value;
  332.     } fill;
  333.     } u;
  334. };
  335.  
  336. /* Allocate a new link_order for a section.  */
  337. extern struct bfd_link_order *bfd_new_link_order PARAMS ((bfd *, asection *));
  338.  
  339. #endif
  340.