bfd/libcoff-in.h

   1 /* BFD COFF object file private structure.
   2    Copyright (C) 1990, 91, 92, 93, 94, 1995 Free Software Foundation, Inc.
   3    Written by 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 /* Object file tdata; access macros */
  24
  25 #define coff_data(bfd)          ((bfd)->tdata.coff_obj_data)
  26 #define exec_hdr(bfd)           (coff_data(bfd)->hdr)
  27 #define obj_pe(bfd)             (coff_data(bfd)->pe)
  28 #define obj_symbols(bfd)        (coff_data(bfd)->symbols)
  29 #define obj_sym_filepos(bfd)    (coff_data(bfd)->sym_filepos)
  30
  31 #define obj_relocbase(bfd)      (coff_data(bfd)->relocbase)
  32 #define obj_raw_syments(bfd)    (coff_data(bfd)->raw_syments)
  33 #define obj_raw_syment_count(bfd)       (coff_data(bfd)->raw_syment_count)
  34 #define obj_convert(bfd)        (coff_data(bfd)->conversion_table)
  35 #define obj_conv_table_size(bfd) (coff_data(bfd)->conv_table_size)
  36
  37 #define obj_coff_external_syms(bfd) (coff_data (bfd)->external_syms)
  38 #define obj_coff_keep_syms(bfd) (coff_data (bfd)->keep_syms)
  39 #define obj_coff_strings(bfd)   (coff_data (bfd)->strings)
  40 #define obj_coff_keep_strings(bfd) (coff_data (bfd)->keep_strings)
  41 #define obj_coff_sym_hashes(bfd) (coff_data (bfd)->sym_hashes)
  42
  43 #define obj_coff_local_toc_table(bfd) (coff_data(bfd)->local_toc_sym_map)
  44
  45 /* `Tdata' information kept for COFF files.  */
  46
  47 typedef struct coff_tdata
  48 {
  49   struct   coff_symbol_struct *symbols; /* symtab for input bfd */
  50   unsigned int *conversion_table;
  51   int conv_table_size;
  52   file_ptr sym_filepos;
  53
  54   struct coff_ptr_struct *raw_syments;
  55   unsigned int raw_syment_count;
  56
  57   /* These are only valid once writing has begun */
  58   long int relocbase;
  59
  60   /* These members communicate important constants about the symbol table
  61      to GDB's symbol-reading code.  These `constants' unfortunately vary
  62      from coff implementation to implementation...  */
  63   unsigned local_n_btmask;
  64   unsigned local_n_btshft;
  65   unsigned local_n_tmask;
  66   unsigned local_n_tshift;
  67   unsigned local_symesz;
  68   unsigned local_auxesz;
  69   unsigned local_linesz;
  70
  71   /* The unswapped external symbols.  May be NULL.  Read by
  72      _bfd_coff_get_external_symbols.  */
  73   PTR external_syms;
  74   /* If this is true, the external_syms may not be freed.  */
  75   boolean keep_syms;
  76
  77   /* The string table.  May be NULL.  Read by
  78      _bfd_coff_read_string_table.  */
  79   char *strings;
  80   /* If this is true, the strings may not be freed.  */
  81   boolean keep_strings;
  82
  83   /* is this a PE format coff file */
  84   int pe;
  85   /* Used by the COFF backend linker.  */
  86   struct coff_link_hash_entry **sym_hashes;
  87
  88   /* used by the pe linker for PowerPC */
  89   int *local_toc_sym_map;
  90
  91   struct bfd_link_info *link_info;
  92
  93   /* Used by coff_find_nearest_line.  */
  94   PTR line_info;
  95 } coff_data_type;
  96
  97 /* Tdata for pe image files. */
  98 typedef struct pe_tdata
  99 {
 100   coff_data_type coff;
 101   struct internal_extra_pe_aouthdr pe_opthdr;
 102   int dll;
 103   int has_reloc_section;
 104   boolean (*in_reloc_p) PARAMS((bfd *, reloc_howto_type *));
 105   flagword real_flags;
 106 } pe_data_type;
 107
 108 #define pe_data(bfd)            ((bfd)->tdata.pe_obj_data)
 109
 110 /* Tdata for XCOFF files.  */
 111
 112 struct xcoff_tdata
 113 {
 114   /* Basic COFF information.  */
 115   coff_data_type coff;
 116
 117   /* True if a large a.out header should be generated.  */
 118   boolean full_aouthdr;
 119
 120   /* TOC value.  */
 121   bfd_vma toc;
 122
 123   /* Index of section holding TOC.  */
 124   int sntoc;
 125
 126   /* Index of section holding entry point.  */
 127   int snentry;
 128
 129   /* .text alignment from optional header.  */
 130   int text_align_power;
 131
 132   /* .data alignment from optional header.  */
 133   int data_align_power;
 134
 135   /* modtype from optional header.  */
 136   short modtype;
 137
 138   /* cputype from optional header.  */
 139   short cputype;
 140
 141   /* maxdata from optional header.  */
 142   bfd_size_type maxdata;
 143
 144   /* maxstack from optional header.  */
 145   bfd_size_type maxstack;
 146
 147   /* Used by the XCOFF backend linker.  */
 148   asection **csects;
 149   unsigned long *debug_indices;
 150   unsigned int import_file_id;
 151 };
 152
 153 #define xcoff_data(abfd) ((abfd)->tdata.xcoff_obj_data)
 154
 155 /* We take the address of the first element of a asymbol to ensure that the
 156  * macro is only ever applied to an asymbol.  */
 157 #define coffsymbol(asymbol) ((coff_symbol_type *)(&((asymbol)->the_bfd)))
 158
 159 /* The used_by_bfd field of a section may be set to a pointer to this
 160    structure.  */
 161
 162 struct coff_section_tdata
 163 {
 164   /* The relocs, swapped into COFF internal form.  This may be NULL.  */
 165   struct internal_reloc *relocs;
 166   /* If this is true, the relocs entry may not be freed.  */
 167   boolean keep_relocs;
 168   /* The section contents.  This may be NULL.  */
 169   bfd_byte *contents;
 170   /* If this is true, the contents entry may not be freed.  */
 171   boolean keep_contents;
 172   /* Information cached by coff_find_nearest_line.  */
 173   bfd_vma offset;
 174   unsigned int i;
 175   const char *function;
 176   int line_base;
 177   /* Available for individual backends.  */
 178   PTR tdata;
 179 };
 180
 181 /* An accessor macro for the coff_section_tdata structure.  */
 182 #define coff_section_data(abfd, sec) \
 183   ((struct coff_section_tdata *) (sec)->used_by_bfd)
 184
 185 /* Tdata for sections in XCOFF files.  This is used by the linker.  */
 186
 187 struct xcoff_section_tdata
 188 {
 189   /* Used for XCOFF csects created by the linker; points to the real
 190      XCOFF section which contains this csect.  */
 191   asection *enclosing;
 192   /* The lineno_count field for the enclosing section, because we are
 193      going to clobber it there.  */
 194   unsigned int lineno_count;
 195   /* The first and one past the last symbol indices for symbols used
 196      by this csect.  */
 197   unsigned long first_symndx;
 198   unsigned long last_symndx;
 199 };
 200
 201 /* An accessor macro the xcoff_section_tdata structure.  */
 202 #define xcoff_section_data(abfd, sec) \
 203   ((struct xcoff_section_tdata *) coff_section_data ((abfd), (sec))->tdata)
 204
 205 /* COFF linker hash table entries.  */
 206
 207 struct coff_link_hash_entry
 208 {
 209   struct bfd_link_hash_entry root;
 210
 211   /* Symbol index in output file.  Set to -1 initially.  Set to -2 if
 212      there is a reloc against this symbol.  */
 213   long indx;
 214
 215   /* Symbol type.  */
 216   unsigned short type;
 217
 218   /* Symbol class.  */
 219   unsigned char class;
 220
 221   /* Number of auxiliary entries.  */
 222   char numaux;
 223
 224   /* BFD to take auxiliary entries from.  */
 225   bfd *auxbfd;
 226
 227   /* Pointer to array of auxiliary entries, if any.  */
 228   union internal_auxent *aux;
 229 };
 230
 231 /* COFF linker hash table.  */
 232
 233 struct coff_link_hash_table
 234 {
 235   struct bfd_link_hash_table root;
 236 };
 237
 238 /* Look up an entry in a COFF linker hash table.  */
 239
 240 #define coff_link_hash_lookup(table, string, create, copy, follow)      \
 241   ((struct coff_link_hash_entry *)                                      \
 242    bfd_link_hash_lookup (&(table)->root, (string), (create),            \
 243                          (copy), (follow)))
 244
 245 /* Traverse a COFF linker hash table.  */
 246
 247 #define coff_link_hash_traverse(table, func, info)                      \
 248   (bfd_link_hash_traverse                                               \
 249    (&(table)->root,                                                     \
 250     (boolean (*) PARAMS ((struct bfd_link_hash_entry *, PTR))) (func),  \
 251     (info)))
 252
 253 /* Get the COFF linker hash table from a link_info structure.  */
 254
 255 #define coff_hash_table(p) ((struct coff_link_hash_table *) ((p)->hash))
 256
 257 /* Functions in coffgen.c.  */
 258 extern const bfd_target *coff_object_p PARAMS ((bfd *));
 259 extern struct sec *coff_section_from_bfd_index PARAMS ((bfd *, int));
 260 extern long coff_get_symtab_upper_bound PARAMS ((bfd *));
 261 extern long coff_get_symtab PARAMS ((bfd *, asymbol **));
 262 extern int coff_count_linenumbers PARAMS ((bfd *));
 263 extern struct coff_symbol_struct *coff_symbol_from PARAMS ((bfd *, asymbol *));
 264 extern boolean coff_renumber_symbols PARAMS ((bfd *, int *));
 265 extern void coff_mangle_symbols PARAMS ((bfd *));
 266 extern boolean coff_write_symbols PARAMS ((bfd *));
 267 extern boolean coff_write_linenumbers PARAMS ((bfd *));
 268 extern alent *coff_get_lineno PARAMS ((bfd *, asymbol *));
 269 extern asymbol *coff_section_symbol PARAMS ((bfd *, char *));
 270 extern boolean _bfd_coff_get_external_symbols PARAMS ((bfd *));
 271 extern const char *_bfd_coff_read_string_table PARAMS ((bfd *));
 272 extern boolean _bfd_coff_free_symbols PARAMS ((bfd *));
 273 extern struct coff_ptr_struct *coff_get_normalized_symtab PARAMS ((bfd *));
 274 extern long coff_get_reloc_upper_bound PARAMS ((bfd *, sec_ptr));
 275 extern asymbol *coff_make_empty_symbol PARAMS ((bfd *));
 276 extern void coff_print_symbol PARAMS ((bfd *, PTR filep, asymbol *,
 277                                        bfd_print_symbol_type how));
 278 extern void coff_get_symbol_info PARAMS ((bfd *, asymbol *,
 279                                           symbol_info *ret));
 280 extern asymbol *coff_bfd_make_debug_symbol PARAMS ((bfd *, PTR,
 281                                                     unsigned long));
 282 extern boolean coff_find_nearest_line PARAMS ((bfd *,
 283                                                asection *,
 284                                                asymbol **,
 285                                                bfd_vma offset,
 286                                                CONST char **filename_ptr,
 287                                                CONST char **functionname_ptr,
 288                                                unsigned int *line_ptr));
 289 extern int coff_sizeof_headers PARAMS ((bfd *, boolean reloc));
 290 extern boolean bfd_coff_reloc16_relax_section
 291   PARAMS ((bfd *, asection *, struct bfd_link_info *, boolean *));
 292 extern bfd_byte *bfd_coff_reloc16_get_relocated_section_contents
 293   PARAMS ((bfd *, struct bfd_link_info *, struct bfd_link_order *,
 294            bfd_byte *, boolean relocateable, asymbol **));
 295 extern bfd_vma bfd_coff_reloc16_get_value PARAMS ((arelent *,
 296                                                    struct bfd_link_info *,
 297                                                    asection *));
 298 extern void bfd_perform_slip PARAMS ((bfd *abfd, unsigned int slip,
 299                                       asection *input_section,
 300                                       bfd_vma val));
 301
 302 /* Functions and types in cofflink.c.  */
 303
 304 #define STRING_SIZE_SIZE (4)
 305 #define POWERPC_LE_PE
 306 /* We use a hash table to merge identical enum, struct, and union
 307    definitions in the linker.  */
 308
 309 /* Information we keep for a single element (an enum value, a
 310    structure or union field) in the debug merge hash table.  */
 311
 312 struct coff_debug_merge_element
 313 {
 314   /* Next element.  */
 315   struct coff_debug_merge_element *next;
 316
 317   /* Name.  */
 318   const char *name;
 319
 320   /* Type.  */
 321   unsigned int type;
 322
 323   /* Symbol index for complex type.  */
 324   long tagndx;
 325 };
 326
 327 /* A linked list of debug merge entries for a given name.  */
 328
 329 struct coff_debug_merge_type
 330 {
 331   /* Next type with the same name.  */
 332   struct coff_debug_merge_type *next;
 333
 334   /* Class of type.  */
 335   int class;
 336
 337   /* Symbol index where this type is defined.  */
 338   long indx;
 339
 340   /* List of elements.  */
 341   struct coff_debug_merge_element *elements;
 342 };
 343
 344 /* Information we store in the debug merge hash table.  */
 345
 346 struct coff_debug_merge_hash_entry
 347 {
 348   struct bfd_hash_entry root;
 349
 350   /* A list of types with this name.  */
 351   struct coff_debug_merge_type *types;
 352 };
 353
 354 /* The debug merge hash table.  */
 355
 356 struct coff_debug_merge_hash_table
 357 {
 358   struct bfd_hash_table root;
 359 };
 360
 361 /* Initialize a COFF debug merge hash table.  */
 362
 363 #define coff_debug_merge_hash_table_init(table) \
 364   (bfd_hash_table_init (&(table)->root, coff_debug_merge_hash_newfunc))
 365
 366 /* Free a COFF debug merge hash table.  */
 367
 368 #define coff_debug_merge_hash_table_free(table) \
 369   (bfd_hash_table_free (&(table)->root))
 370
 371 /* Look up an entry in a COFF debug merge hash table.  */
 372
 373 #define coff_debug_merge_hash_lookup(table, string, create, copy) \
 374   ((struct coff_debug_merge_hash_entry *) \
 375    bfd_hash_lookup (&(table)->root, (string), (create), (copy)))
 376
 377 /* Information we keep for each section in the output file when doing
 378    a relocateable link.  */
 379
 380 struct coff_link_section_info
 381 {
 382   /* The relocs to be output.  */
 383   struct internal_reloc *relocs;
 384   /* For each reloc against a global symbol whose index was not known
 385      when the reloc was handled, the global hash table entry.  */
 386   struct coff_link_hash_entry **rel_hashes;
 387 };
 388
 389 /* Information that we pass around while doing the final link step.  */
 390
 391 struct coff_final_link_info
 392 {
 393   /* General link information.  */
 394   struct bfd_link_info *info;
 395   /* Output BFD.  */
 396   bfd *output_bfd;
 397   /* Used to indicate failure in traversal routine.  */
 398   boolean failed;
 399   /* Hash table for long symbol names.  */
 400   struct bfd_strtab_hash *strtab;
 401   /* When doing a relocateable link, an array of information kept for
 402      each output section, indexed by the target_index field.  */
 403   struct coff_link_section_info *section_info;
 404   /* Symbol index of last C_FILE symbol (-1 if none).  */
 405   long last_file_index;
 406   /* Contents of last C_FILE symbol.  */
 407   struct internal_syment last_file;
 408   /* Hash table used to merge debug information.  */
 409   struct coff_debug_merge_hash_table debug_merge;
 410   /* Buffer large enough to hold swapped symbols of any input file.  */
 411   struct internal_syment *internal_syms;
 412   /* Buffer large enough to hold sections of symbols of any input file.  */
 413   asection **sec_ptrs;
 414   /* Buffer large enough to hold output indices of symbols of any
 415      input file.  */
 416   long *sym_indices;
 417   /* Buffer large enough to hold output symbols for any input file.  */
 418   bfd_byte *outsyms;
 419   /* Buffer large enough to hold external line numbers for any input
 420      section.  */
 421   bfd_byte *linenos;
 422   /* Buffer large enough to hold any input section.  */
 423   bfd_byte *contents;
 424   /* Buffer large enough to hold external relocs of any input section.  */
 425   bfd_byte *external_relocs;
 426   /* Buffer large enough to hold swapped relocs of any input section.  */
 427   struct internal_reloc *internal_relocs;
 428 };
 429
 430 extern struct bfd_hash_entry *_bfd_coff_link_hash_newfunc
 431   PARAMS ((struct bfd_hash_entry *, struct bfd_hash_table *, const char *));
 432 extern boolean _bfd_coff_link_hash_table_init
 433   PARAMS ((struct coff_link_hash_table *, bfd *,
 434            struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
 435                                        struct bfd_hash_table *,
 436                                        const char *)));
 437 extern struct bfd_link_hash_table *_bfd_coff_link_hash_table_create
 438   PARAMS ((bfd *));
 439 extern const char *_bfd_coff_internal_syment_name
 440   PARAMS ((bfd *, const struct internal_syment *, char *));
 441 extern boolean _bfd_coff_link_add_symbols
 442   PARAMS ((bfd *, struct bfd_link_info *));
 443 extern boolean _bfd_coff_final_link
 444   PARAMS ((bfd *, struct bfd_link_info *));
 445 extern struct internal_reloc *_bfd_coff_read_internal_relocs
 446   PARAMS ((bfd *, asection *, boolean, bfd_byte *, boolean,
 447            struct internal_reloc *));
 448 extern boolean _bfd_coff_generic_relocate_section
 449   PARAMS ((bfd *, struct bfd_link_info *, bfd *, asection *, bfd_byte *,
 450            struct internal_reloc *, struct internal_syment *, asection **));
 451
 452 extern struct bfd_hash_entry *coff_debug_merge_hash_newfunc
 453   PARAMS ((struct bfd_hash_entry *, struct bfd_hash_table *, const char *));
 454 extern boolean coff_write_global_sym
 455   PARAMS ((struct coff_link_hash_entry *, PTR));
 456 extern boolean coff_link_input_bfd
 457   PARAMS ((struct coff_final_link_info *, bfd *));
 458 extern boolean coff_reloc_link_order
 459   PARAMS ((bfd *, struct coff_final_link_info *, asection *,
 460            struct bfd_link_order *));
 461
 462
 463 #define coff_get_section_contents_in_window \
 464   _bfd_generic_get_section_contents_in_window
 465
 466 /* Functions in xcofflink.c.  */
 467
 468 extern struct bfd_link_hash_table *_bfd_xcoff_bfd_link_hash_table_create
 469   PARAMS ((bfd *));
 470 extern boolean _bfd_xcoff_bfd_link_add_symbols
 471   PARAMS ((bfd *, struct bfd_link_info *));
 472 extern boolean _bfd_xcoff_bfd_final_link
 473   PARAMS ((bfd *, struct bfd_link_info *));
 474 extern boolean _bfd_ppc_xcoff_relocate_section
 475   PARAMS ((bfd *, struct bfd_link_info *, bfd *, asection *, bfd_byte *,
 476            struct internal_reloc *, struct internal_syment *, asection **));
 477
 478 /* And more taken from the source .. */
 479