bfd/libecoff.h

   1 /* BFD ECOFF object file private structure.
   2    Copyright 1993, 1994, 1995, 1996, 1999, 2001, 2002, 2003, 2004,
   3    2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
   4    Written by 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 #include "bfdlink.h"
  24
  25 #ifndef ECOFF_H
  26 #include "coff/ecoff.h"
  27 #endif
  28
  29 /* This is the backend information kept for ECOFF files.  This
  30    structure is constant for a particular backend.  The first element
  31    is the COFF backend data structure, so that ECOFF targets can use
  32    the generic COFF code.  */
  33
  34 #define ecoff_backend(abfd) \
  35   ((struct ecoff_backend_data *) (abfd)->xvec->backend_data)
  36
  37 struct ecoff_backend_data
  38 {
  39   /* COFF backend information.  This must be the first field.  */
  40   bfd_coff_backend_data coff;
  41   /* Supported architecture.  */
  42   enum bfd_architecture arch;
  43   /* Initial portion of armap string.  */
  44   const char *armap_start;
  45   /* The page boundary used to align sections in a demand-paged
  46      executable file.  E.g., 0x1000.  */
  47   bfd_vma round;
  48   /* TRUE if the .rdata section is part of the text segment, as on the
  49      Alpha.  FALSE if .rdata is part of the data segment, as on the
  50      MIPS.  */
  51   bfd_boolean rdata_in_text;
  52   /* Bitsize of constructor entries.  */
  53   unsigned int constructor_bitsize;
  54   /* Reloc to use for constructor entries.  */
  55   reloc_howto_type *constructor_reloc;
  56   /* How to swap debugging information.  */
  57   struct ecoff_debug_swap debug_swap;
  58   /* External reloc size.  */
  59   bfd_size_type external_reloc_size;
  60   /* Reloc swapping functions.  */
  61   void (*swap_reloc_in) (bfd *, void *, struct internal_reloc *);
  62   void (*swap_reloc_out) (bfd *, const struct internal_reloc *, void *);
  63   /* Backend reloc tweaking.  */
  64   void (*adjust_reloc_in)
  65     (bfd *, const struct internal_reloc *, arelent *);
  66   void (*adjust_reloc_out)
  67     (bfd *, const arelent *, struct internal_reloc *);
  68   /* Relocate section contents while linking.  */
  69   bfd_boolean (*relocate_section)
  70     (bfd *, struct bfd_link_info *, bfd *, asection *, bfd_byte *, void *);
  71   /* Do final adjustments to filehdr and aouthdr.  */
  72   bfd_boolean (*adjust_headers)
  73     (bfd *, struct internal_filehdr *, struct internal_aouthdr *);
  74   /* Read an element from an archive at a given file position.  This
  75      is needed because OSF/1 3.2 uses a weird archive format.  */
  76   bfd *(*get_elt_at_filepos) (bfd *, file_ptr);
  77 };
  78
  79 /* ECOFF targets don't support COFF long section names, so this
  80   macro is provided to use as an initialiser for the related
  81   members of the embedded bfd_coff_backend_data struct.  */
  82 #define ECOFF_NO_LONG_SECTION_NAMES (FALSE), _bfd_ecoff_no_long_sections
  83
  84 /* This is the target specific information kept for ECOFF files.  */
  85
  86 #define ecoff_data(abfd) ((abfd)->tdata.ecoff_obj_data)
  87
  88 typedef struct ecoff_tdata
  89 {
  90   /* The reloc file position, set by
  91      ecoff_compute_section_file_positions.  */
  92   file_ptr reloc_filepos;
  93
  94   /* The symbol table file position, set by _bfd_ecoff_mkobject_hook.  */
  95   file_ptr sym_filepos;
  96
  97   /* The start and end of the text segment.  Only valid for an
  98      existing file, not for one we are creating.  */
  99   unsigned long text_start;
 100   unsigned long text_end;
 101
 102   /* The cached gp value.  This is used when relocating.  */
 103   bfd_vma gp;
 104
 105   /* The maximum size of objects to optimize using gp.  This is
 106      typically set by the -G option to the compiler, assembler or
 107      linker.  */
 108   unsigned int gp_size;
 109
 110   /* The register masks.  When linking, all the masks found in the
 111      input files are combined into the masks of the output file.
 112      These are not all used for all targets, but that's OK, because
 113      the relevant ones are the only ones swapped in and out.  */
 114   unsigned long gprmask;
 115   unsigned long fprmask;
 116   unsigned long cprmask[4];
 117
 118   /* The ECOFF symbolic debugging information.  */
 119   struct ecoff_debug_info debug_info;
 120
 121   /* The unswapped ECOFF symbolic information.  */
 122   void * raw_syments;
 123
 124   /* The canonical BFD symbols.  */
 125   struct ecoff_symbol_struct *canonical_symbols;
 126
 127   /* A mapping from external symbol numbers to entries in the linker
 128      hash table, used when linking.  */
 129   struct ecoff_link_hash_entry **sym_hashes;
 130
 131   /* A mapping from reloc symbol indices to sections, used when
 132      linking.  */
 133   asection **symndx_to_section;
 134
 135   /* TRUE if this BFD was written by the backend linker.  */
 136   bfd_boolean linker;
 137
 138   /* TRUE if a warning that multiple global pointer values are
 139      needed in the output binary was issued already.  */
 140   bfd_boolean issued_multiple_gp_warning;
 141
 142   /* Used by find_nearest_line entry point.  The structure could be
 143      included directly in this one, but there's no point to wasting
 144      the memory just for the infrequently called find_nearest_line.  */
 145   struct ecoff_find_line *find_line_info;
 146
 147   /* Whether the .rdata section is in the text segment for this
 148      particular ECOFF file.  This is not valid until
 149      ecoff_compute_section_file_positions is called.  */
 150   bfd_boolean rdata_in_text;
 151
 152 } ecoff_data_type;
 153
 154 /* Each canonical asymbol really looks like this.  */
 155
 156 typedef struct ecoff_symbol_struct
 157 {
 158   /* The actual symbol which the rest of BFD works with */
 159   asymbol symbol;
 160
 161   /* The fdr for this symbol.  */
 162   FDR *fdr;
 163
 164   /* TRUE if this is a local symbol rather than an external one.  */
 165   bfd_boolean local;
 166
 167   /* A pointer to the unswapped hidden information for this symbol.
 168      This is either a struct sym_ext or a struct ext_ext, depending on
 169      the value of the local field above.  */
 170   void * native;
 171 } ecoff_symbol_type;
 172
 173 /* We take the address of the first element of an asymbol to ensure that the
 174    macro is only ever applied to an asymbol.  */
 175 #define ecoffsymbol(asymbol) ((ecoff_symbol_type *) (&((asymbol)->the_bfd)))
 176
 177 /* We need to save the index of an external symbol when we write it
 178    out so that can set the symbol index correctly when we write out
 179    the relocs.  */
 180 #define ecoff_get_sym_index(symbol) ((symbol)->udata.i)
 181 #define ecoff_set_sym_index(symbol, idx) ((symbol)->udata.i = (idx))
 182
 183 /* A pointer to this structure is put in the used_by_bfd pointer of
 184    a section to keep track of any per-section data.
 185    The user_by_bfd pointer will be NULL if the information was not
 186    needed.  */
 187
 188 struct ecoff_section_tdata
 189 {
 190   /* When producing an executable (i.e., final, non-relocatable link)
 191      on the Alpha, we may need to use multiple global pointer values
 192      to span the entire .lita section.  In essence, we allow each
 193      input .lita section to have its own gp value.  To support this,
 194      we need to keep track of the gp values that we picked for each
 195      input .lita section . */
 196   bfd_vma gp;
 197 };
 198
 199 /* An accessor macro for the ecoff_section_tdata structure.  */
 200 #define ecoff_section_data(abfd, sec) \
 201   ((struct ecoff_section_tdata *) (sec)->used_by_bfd)
 202
 203 /* ECOFF linker hash table entries.  */
 204
 205 struct ecoff_link_hash_entry
 206 {
 207   struct bfd_link_hash_entry root;
 208   /* Symbol index in output file.  */
 209   long indx;
 210   /* BFD that ext field value came from.  */
 211   bfd *abfd;
 212   /* ECOFF external symbol information.  */
 213   EXTR esym;
 214   /* Nonzero if this symbol has been written out.  */
 215   char written;
 216   /* Nonzero if this symbol was referred to as small undefined.  */
 217   char small;
 218 };
 219
 220 /* ECOFF linker hash table.  */
 221
 222 struct ecoff_link_hash_table
 223 {
 224   struct bfd_link_hash_table root;
 225 };
 226
 227 /* Make an ECOFF object.  */
 228 extern bfd_boolean _bfd_ecoff_mkobject (bfd *);
 229
 230 /* Read in the ECOFF symbolic debugging information.  */
 231 extern bfd_boolean _bfd_ecoff_slurp_symbolic_info
 232   (bfd *, asection *, struct ecoff_debug_info *);
 233
 234 /* Generic ECOFF BFD backend vectors.  */
 235
 236 extern bfd_boolean _bfd_ecoff_write_object_contents (bfd *);
 237
 238 #define _bfd_ecoff_close_and_cleanup _bfd_generic_close_and_cleanup
 239 #define _bfd_ecoff_bfd_free_cached_info _bfd_generic_bfd_free_cached_info
 240 extern bfd_boolean _bfd_ecoff_new_section_hook
 241   (bfd *, asection *);
 242 extern bfd_boolean _bfd_ecoff_get_section_contents
 243   (bfd *, asection *, void * location, file_ptr, bfd_size_type);
 244
 245 #define _bfd_ecoff_bfd_link_split_section _bfd_generic_link_split_section
 246
 247 extern bfd_boolean _bfd_ecoff_bfd_copy_private_bfd_data
 248   (bfd *, bfd *);
 249 #define _bfd_ecoff_bfd_copy_private_section_data \
 250   _bfd_generic_bfd_copy_private_section_data
 251
 252 #define _bfd_ecoff_bfd_copy_private_symbol_data \
 253   _bfd_generic_bfd_copy_private_symbol_data
 254
 255 #define _bfd_ecoff_bfd_copy_private_header_data \
 256   _bfd_generic_bfd_copy_private_header_data
 257
 258 #define _bfd_ecoff_bfd_print_private_bfd_data \
 259   _bfd_generic_bfd_print_private_bfd_data
 260
 261 #define _bfd_ecoff_bfd_merge_private_bfd_data \
 262   _bfd_generic_bfd_merge_private_bfd_data
 263
 264 #define _bfd_ecoff_bfd_set_private_flags _bfd_generic_bfd_set_private_flags
 265 extern bfd_boolean _bfd_ecoff_slurp_armap (bfd *);
 266 #define _bfd_ecoff_slurp_extended_name_table _bfd_slurp_extended_name_table
 267 #define _bfd_ecoff_construct_extended_name_table \
 268   _bfd_archive_bsd_construct_extended_name_table
 269 #define _bfd_ecoff_truncate_arname bfd_dont_truncate_arname
 270 extern bfd_boolean _bfd_ecoff_write_armap
 271   (bfd *, unsigned int, struct orl *, unsigned int, int);
 272 #define _bfd_ecoff_read_ar_hdr _bfd_generic_read_ar_hdr
 273 #define _bfd_ecoff_openr_next_archived_file \
 274   bfd_generic_openr_next_archived_file
 275 #define _bfd_ecoff_get_elt_at_index _bfd_generic_get_elt_at_index
 276 #define _bfd_ecoff_generic_stat_arch_elt bfd_generic_stat_arch_elt
 277 #define _bfd_ecoff_update_armap_timestamp bfd_true
 278 #define _bfd_ecoff_bfd_is_target_special_symbol  \
 279   ((bfd_boolean (*) (bfd *, asymbol *)) bfd_false)
 280
 281 extern long _bfd_ecoff_get_symtab_upper_bound (bfd *);
 282 extern long _bfd_ecoff_canonicalize_symtab (bfd *, asymbol **);
 283 extern asymbol *_bfd_ecoff_make_empty_symbol (bfd *);
 284 extern void _bfd_ecoff_print_symbol
 285   (bfd *, void *, asymbol *, bfd_print_symbol_type);
 286 extern void _bfd_ecoff_get_symbol_info
 287   (bfd *, asymbol *, symbol_info *);
 288 extern bfd_boolean _bfd_ecoff_bfd_is_local_label_name
 289   (bfd *, const char *);
 290 #define _bfd_ecoff_get_lineno _bfd_nosymbols_get_lineno
 291 extern bfd_boolean _bfd_ecoff_find_nearest_line
 292   (bfd *, asection *, asymbol **, bfd_vma, const char **, const char **,
 293    unsigned int *);
 294 #define _bfd_ecoff_bfd_make_debug_symbol _bfd_nosymbols_bfd_make_debug_symbol
 295 #define _bfd_ecoff_read_minisymbols _bfd_generic_read_minisymbols
 296 #define _bfd_ecoff_minisymbol_to_symbol _bfd_generic_minisymbol_to_symbol
 297 #define _bfd_ecoff_find_inliner_info _bfd_nosymbols_find_inliner_info
 298
 299 #define _bfd_ecoff_get_reloc_upper_bound coff_get_reloc_upper_bound
 300 extern long _bfd_ecoff_canonicalize_reloc
 301   (bfd *, asection *, arelent **, asymbol **symbols);
 302 /* ecoff_bfd_reloc_type_lookup defined by backend. */
 303
 304 extern bfd_boolean _bfd_ecoff_set_arch_mach
 305   (bfd *, enum bfd_architecture, unsigned long);
 306 extern bfd_boolean _bfd_ecoff_set_section_contents
 307   (bfd *, asection *, const void * location, file_ptr, bfd_size_type);
 308
 309 extern int _bfd_ecoff_sizeof_headers (bfd *, struct bfd_link_info *);
 310 /* ecoff_bfd_get_relocated_section_contents defined by backend.  */
 311 /* ecoff_bfd_relax_section defined by backend.  */
 312 extern struct bfd_link_hash_table *_bfd_ecoff_bfd_link_hash_table_create
 313   (bfd *);
 314 #define _bfd_ecoff_bfd_link_hash_table_free _bfd_generic_link_hash_table_free
 315 extern bfd_boolean _bfd_ecoff_bfd_link_add_symbols
 316   (bfd *, struct bfd_link_info *);
 317 #define _bfd_ecoff_bfd_link_just_syms _bfd_generic_link_just_syms
 318 extern bfd_boolean _bfd_ecoff_bfd_final_link
 319   (bfd *, struct bfd_link_info *);
 320
 321 /* Hook functions for the generic COFF section reading code.  */
 322
 323 extern void * _bfd_ecoff_mkobject_hook (bfd *, void *, void *);
 324 #define _bfd_ecoff_set_alignment_hook \
 325   ((void (*) (bfd *, asection *, void *)) bfd_void)
 326 extern bfd_boolean _bfd_ecoff_set_arch_mach_hook
 327   (bfd *, void *);
 328 extern bfd_boolean _bfd_ecoff_no_long_sections
 329   (bfd *abfd, int enable);
 330 extern bfd_boolean _bfd_ecoff_styp_to_sec_flags
 331   (bfd *, void *, const char *, asection *, flagword *);
 332 extern bfd_boolean _bfd_ecoff_slurp_symbol_table (bfd *);
 333
 334 /* ECOFF auxiliary information swapping routines.  These are the same
 335    for all ECOFF targets, so they are defined in ecofflink.c.  */
 336
 337 extern void _bfd_ecoff_swap_tir_in
 338   (int, const struct tir_ext *, TIR *);
 339 extern void _bfd_ecoff_swap_tir_out
 340   (int, const TIR *, struct tir_ext *);
 341 extern void _bfd_ecoff_swap_rndx_in
 342   (int, const struct rndx_ext *, RNDXR *);
 343 extern void _bfd_ecoff_swap_rndx_out
 344   (int, const RNDXR *, struct rndx_ext *);