bfd/libecoff.h

   1 /* BFD ECOFF object file private structure.
   2    Copyright (C) 1993 Free Software Foundation, Inc.
   3    Written by 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 #include "bfdlink.h"
  22
  23 #ifndef ECOFF_H
  24 #include "coff/ecoff.h"
  25 #endif
  26
  27 /* This is the backend information kept for ECOFF files.  This
  28    structure is constant for a particular backend.  The first element
  29    is the COFF backend data structure, so that ECOFF targets can use
  30    the generic COFF code.  */
  31
  32 #define ecoff_backend(abfd) \
  33   ((struct ecoff_backend_data *) (abfd)->xvec->backend_data)
  34
  35 struct ecoff_backend_data
  36 {
  37   /* COFF backend information.  This must be the first field.  */
  38   bfd_coff_backend_data coff;
  39   /* Supported architecture.  */
  40   enum bfd_architecture arch;
  41   /* Initial portion of armap string.  */
  42   const char *armap_start;
  43   /* The page boundary used to align sections in a demand-paged
  44      executable file.  E.g., 0x1000.  */
  45   bfd_vma round;
  46   /* True if the .rdata section is part of the text segment, as on the
  47      Alpha.  False if .rdata is part of the data segment, as on the
  48      MIPS.  */
  49   boolean rdata_in_text;
  50   /* Bitsize of constructor entries.  */
  51   unsigned int constructor_bitsize;
  52   /* Reloc to use for constructor entries.  */
  53   reloc_howto_type *constructor_reloc;
  54   /* How to swap debugging information.  */
  55   struct ecoff_debug_swap debug_swap;
  56   /* External reloc size.  */
  57   bfd_size_type external_reloc_size;
  58   /* Reloc swapping functions.  */
  59   void (*swap_reloc_in) PARAMS ((bfd *, PTR, struct internal_reloc *));
  60   void (*swap_reloc_out) PARAMS ((bfd *, const struct internal_reloc *, PTR));
  61   /* Backend reloc tweaking.  */
  62   void (*adjust_reloc_in) PARAMS ((bfd *, const struct internal_reloc *,
  63                                    arelent *));
  64   void (*adjust_reloc_out) PARAMS ((bfd *, const arelent *,
  65                                     struct internal_reloc *));
  66   /* Relocate section contents while linking.  */
  67   boolean (*relocate_section) PARAMS ((bfd *output_bfd, struct bfd_link_info *,
  68                                        bfd *input_bfd, asection *input_section,
  69                                        bfd_byte *contents,
  70                                        PTR external_relocs));
  71 };
  72
  73 /* This is the target specific information kept for ECOFF files.  */
  74
  75 #define ecoff_data(abfd) ((abfd)->tdata.ecoff_obj_data)
  76
  77 typedef struct ecoff_tdata
  78 {
  79   /* The reloc file position, set by
  80      ecoff_compute_section_file_positions.  */
  81   file_ptr reloc_filepos;
  82
  83   /* The symbol table file position, set by _bfd_ecoff_mkobject_hook.  */
  84   file_ptr sym_filepos;
  85
  86   /* The start and end of the text segment.  Only valid for an
  87      existing file, not for one we are creating.  */
  88   unsigned long text_start;
  89   unsigned long text_end;
  90
  91   /* The cached gp value.  This is used when relocating.  */
  92   bfd_vma gp;
  93
  94   /* The maximum size of objects to optimize using gp.  This is
  95      typically set by the -G option to the compiler, assembler or
  96      linker.  */
  97   int gp_size;
  98
  99   /* The register masks.  When linking, all the masks found in the
 100      input files are combined into the masks of the output file.
 101      These are not all used for all targets, but that's OK, because
 102      the relevant ones are the only ones swapped in and out.  */
 103   unsigned long gprmask;
 104   unsigned long fprmask;
 105   unsigned long cprmask[4];
 106
 107   /* The ECOFF symbolic debugging information.  */
 108   struct ecoff_debug_info debug_info;
 109
 110   /* The unswapped ECOFF symbolic information.  */
 111   PTR raw_syments;
 112
 113   /* The canonical BFD symbols.  */
 114   struct ecoff_symbol_struct *canonical_symbols;
 115
 116   /* A mapping from external symbol numbers to entries in the linker
 117      hash table, used when linking.  */
 118   struct ecoff_link_hash_entry **sym_hashes;
 119
 120   /* A mapping from reloc symbol indices to sections, used when
 121      linking.  */
 122   asection **symndx_to_section;
 123
 124   /* True if this BFD was written by the backend linker.  */
 125   boolean linker;
 126
 127   /* Used by find_nearest_line entry point.  The structure could be
 128      included directly in this one, but there's no point to wasting
 129      the memory just for the infrequently called find_nearest_line.  */
 130   struct ecoff_find_line *find_line_info;
 131
 132 } ecoff_data_type;
 133
 134 /* Each canonical asymbol really looks like this.  */
 135
 136 typedef struct ecoff_symbol_struct
 137 {
 138   /* The actual symbol which the rest of BFD works with */
 139   asymbol symbol;
 140
 141   /* The fdr for this symbol.  */
 142   FDR *fdr;
 143
 144   /* true if this is a local symbol rather than an external one.  */
 145   boolean local;
 146
 147   /* A pointer to the unswapped hidden information for this symbol.
 148      This is either a struct sym_ext or a struct ext_ext, depending on
 149      the value of the local field above.  */
 150   PTR native;
 151 } ecoff_symbol_type;
 152
 153 /* We take the address of the first element of a asymbol to ensure that the
 154    macro is only ever applied to an asymbol.  */
 155 #define ecoffsymbol(asymbol) ((ecoff_symbol_type *) (&((asymbol)->the_bfd)))
 156
 157 /* We need to save the index of an external symbol when we write it
 158    out so that can set the symbol index correctly when we write out
 159    the relocs.  */
 160 #define ecoff_get_sym_index(symbol) ((symbol)->udata.i)
 161 #define ecoff_set_sym_index(symbol, idx) ((symbol)->udata.i = (idx))
 162
 163 /* When generating MIPS embedded PIC code, the linker relaxes the code
 164    to turn PC relative branches into longer code sequences when the PC
 165    relative branch is out of range.  This involves reading the relocs
 166    in bfd_relax_section as well as in bfd_final_link, and requires the
 167    code to keep track of which relocs have been expanded.  A pointer
 168    to this structure is put in the used_by_bfd pointer of a section to
 169    keep track of this information.  The user_by_bfd pointer will be
 170    NULL if the information was not needed.  */
 171
 172 struct ecoff_section_tdata
 173 {
 174   /* The unswapped relocs for this section.  These are stored in
 175      memory so the input file does not have to be read twice.  */
 176   PTR external_relocs;
 177
 178   /* The contents of the section.  These bytes may or may not be saved
 179      in memory, but if it is this is a pointer to them.  */
 180   bfd_byte *contents;
 181
 182   /* Offset adjustments for PC relative branches.  A number other than
 183      1 is an addend for a PC relative branch, or a switch table entry
 184      which is the difference of two .text locations; this addend
 185      arises because the branch or difference crosses one or more
 186      branches which were expanded into a larger code sequence.  A 1
 187      means that this branch was itself expanded into a larger code
 188      sequence.  1 is not a possible offset, since all offsets must be
 189      multiples of the instruction size, which is 4; also, the only
 190      relocs with non-zero offsets will be PC relative branches or
 191      switch table entries within the same object file.  If this field
 192      is NULL, no branches were expanded and no offsets are required.
 193      Otherwise there are as many entries as there are relocs in the
 194      section, and the entry for any reloc that is not PC relative is
 195      zero.  */
 196   long *offsets;
 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 boolean _bfd_ecoff_mkobject PARAMS ((bfd *));
 229
 230 /* Read in the ECOFF symbolic debugging information.  */
 231 extern boolean _bfd_ecoff_slurp_symbolic_info
 232   PARAMS ((bfd *, asection *, struct ecoff_debug_info *));
 233
 234 /* Generic ECOFF BFD backend vectors.  */
 235
 236 extern boolean _bfd_ecoff_write_object_contents PARAMS ((bfd *abfd));
 237 extern const bfd_target *_bfd_ecoff_archive_p PARAMS ((bfd *abfd));
 238
 239 #define _bfd_ecoff_close_and_cleanup _bfd_generic_close_and_cleanup
 240 #define _bfd_ecoff_bfd_free_cached_info _bfd_generic_bfd_free_cached_info
 241 extern boolean _bfd_ecoff_new_section_hook
 242   PARAMS ((bfd *, asection *));
 243 extern boolean _bfd_ecoff_get_section_contents
 244   PARAMS ((bfd *, asection *, PTR location, file_ptr, bfd_size_type));
 245
 246 #define _bfd_ecoff_bfd_link_split_section _bfd_generic_link_split_section
 247
 248 extern boolean _bfd_ecoff_bfd_copy_private_bfd_data PARAMS ((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_print_private_bfd_data \
 256   _bfd_generic_bfd_pritn_private_bfd_data
 257
 258 #define _bfd_ecoff_bfd_merge_private_bfd_data \
 259   _bfd_generic_bfd_merge_private_bfd_data
 260
 261 #define _bfd_ecoff_bfd_set_private_flags _bfd_generic_bfd_set_private_flags
 262 extern boolean _bfd_ecoff_slurp_armap PARAMS ((bfd *abfd));
 263 #define _bfd_ecoff_slurp_extended_name_table _bfd_slurp_extended_name_table
 264 #define _bfd_ecoff_construct_extended_name_table \
 265   _bfd_archive_bsd_construct_extended_name_table
 266 #define _bfd_ecoff_truncate_arname bfd_dont_truncate_arname
 267 extern boolean _bfd_ecoff_write_armap
 268   PARAMS ((bfd *, unsigned int, struct orl *, unsigned int, int));
 269 #define _bfd_ecoff_openr_next_archived_file \
 270   bfd_generic_openr_next_archived_file
 271 #define _bfd_ecoff_generic_stat_arch_elt bfd_generic_stat_arch_elt
 272 #define _bfd_ecoff_update_armap_timestamp bfd_true
 273
 274 extern long _bfd_ecoff_get_symtab_upper_bound PARAMS ((bfd *abfd));
 275 extern long _bfd_ecoff_get_symtab PARAMS ((bfd *abfd, asymbol **alocation));
 276 extern asymbol *_bfd_ecoff_make_empty_symbol PARAMS ((bfd *abfd));
 277 extern void _bfd_ecoff_print_symbol
 278   PARAMS ((bfd *, PTR filep, asymbol *, bfd_print_symbol_type));
 279 extern void _bfd_ecoff_get_symbol_info
 280   PARAMS ((bfd *, asymbol *, symbol_info *));
 281 extern boolean _bfd_ecoff_bfd_is_local_label
 282   PARAMS ((bfd *, asymbol *));
 283 #define _bfd_ecoff_get_lineno _bfd_nosymbols_get_lineno
 284 extern boolean _bfd_ecoff_find_nearest_line
 285   PARAMS ((bfd *, asection *, asymbol **, bfd_vma offset,
 286            const char **filename_ptr, const char **fnname_ptr,
 287            unsigned int *retline_ptr));
 288 #define _bfd_ecoff_bfd_make_debug_symbol _bfd_nosymbols_bfd_make_debug_symbol
 289 #define _bfd_ecoff_read_minisymbols _bfd_generic_read_minisymbols
 290 #define _bfd_ecoff_minisymbol_to_symbol _bfd_generic_minisymbol_to_symbol
 291
 292 #define _bfd_ecoff_get_reloc_upper_bound coff_get_reloc_upper_bound
 293 extern long _bfd_ecoff_canonicalize_reloc
 294   PARAMS ((bfd *, asection *, arelent **, asymbol **symbols));
 295 /* ecoff_bfd_reloc_type_lookup defined by backend. */
 296
 297 extern boolean _bfd_ecoff_set_arch_mach
 298   PARAMS ((bfd *, enum bfd_architecture, unsigned long machine));
 299 extern boolean _bfd_ecoff_set_section_contents
 300   PARAMS ((bfd *, asection *, PTR location, file_ptr, bfd_size_type));
 301
 302 extern int _bfd_ecoff_sizeof_headers PARAMS ((bfd *abfd, boolean reloc));
 303 /* ecoff_bfd_get_relocated_section_contents defined by backend.  */
 304 /* ecoff_bfd_relax_section defined by backend.  */
 305 extern struct bfd_link_hash_table *_bfd_ecoff_bfd_link_hash_table_create
 306   PARAMS ((bfd *));
 307 extern boolean _bfd_ecoff_bfd_link_add_symbols
 308   PARAMS ((bfd *, struct bfd_link_info *));
 309 extern boolean _bfd_ecoff_bfd_final_link
 310   PARAMS ((bfd *, struct bfd_link_info *));
 311
 312 /* Hook functions for the generic COFF section reading code.  */
 313
 314 extern PTR _bfd_ecoff_mkobject_hook PARAMS ((bfd *, PTR filehdr, PTR aouthdr));
 315 extern asection *_bfd_ecoff_make_section_hook PARAMS ((bfd *abfd, char *name));
 316 #define _bfd_ecoff_set_alignment_hook \
 317   ((void (*) PARAMS ((bfd *, asection *, PTR))) bfd_void)
 318 extern boolean _bfd_ecoff_set_arch_mach_hook PARAMS ((bfd *abfd, PTR filehdr));
 319 extern flagword _bfd_ecoff_styp_to_sec_flags
 320   PARAMS ((bfd *abfd, PTR hdr, const char *name));
 321 extern boolean _bfd_ecoff_slurp_symbol_table PARAMS ((bfd *abfd));
 322
 323 /* ECOFF auxiliary information swapping routines.  These are the same
 324    for all ECOFF targets, so they are defined in ecofflink.c.  */
 325
 326 extern void _bfd_ecoff_swap_tir_in
 327   PARAMS ((int, const struct tir_ext *, TIR *));
 328 extern void _bfd_ecoff_swap_tir_out
 329   PARAMS ((int, const TIR *, struct tir_ext *));
 330 extern void _bfd_ecoff_swap_rndx_in
 331   PARAMS ((int, const struct rndx_ext *, RNDXR *));
 332 extern void _bfd_ecoff_swap_rndx_out
 333   PARAMS ((int, const RNDXR *, struct rndx_ext *));