bfd/libcoff-in.h

   1 /* BFD COFF object file private structure.
   2    Copyright 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
   3    2000, 2001, 2002, 2003, 2004, 2005
   4    Free Software Foundation, Inc.
   5    Written by Cygnus Support.
   6
   7    This file is part of BFD, the Binary File Descriptor library.
   8
   9    This program is free software; you can redistribute it and/or modify
  10    it under the terms of the GNU General Public License as published by
  11    the Free Software Foundation; either version 2 of the License, or
  12    (at your option) any later version.
  13
  14    This program is distributed in the hope that it will be useful,
  15    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17    GNU General Public License for more details.
  18
  19    You should have received a copy of the GNU General Public License
  20    along with this program; if not, write to the Free Software
  21    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
  22
  23 #include "bfdlink.h"
  24
  25 /* Object file tdata; access macros.  */
  26
  27 #define coff_data(bfd)                ((bfd)->tdata.coff_obj_data)
  28 #define exec_hdr(bfd)                 (coff_data (bfd)->hdr)
  29 #define obj_pe(bfd)                   (coff_data (bfd)->pe)
  30 #define obj_symbols(bfd)              (coff_data (bfd)->symbols)
  31 #define obj_sym_filepos(bfd)          (coff_data (bfd)->sym_filepos)
  32 #define obj_relocbase(bfd)            (coff_data (bfd)->relocbase)
  33 #define obj_raw_syments(bfd)          (coff_data (bfd)->raw_syments)
  34 #define obj_raw_syment_count(bfd)     (coff_data (bfd)->raw_syment_count)
  35 #define obj_convert(bfd)              (coff_data (bfd)->conversion_table)
  36 #define obj_conv_table_size(bfd)      (coff_data (bfd)->conv_table_size)
  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 #define obj_coff_strings_written(bfd) (coff_data (bfd)->strings_written)
  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 long 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   void * external_syms;
  74   /* If this is TRUE, the external_syms may not be freed.  */
  75   bfd_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   bfd_boolean keep_strings;
  82   /* If this is TRUE, the strings have been written out already.  */
  83   bfd_boolean strings_written;
  84
  85   /* Is this a PE format coff file?  */
  86   int pe;
  87   /* Used by the COFF backend linker.  */
  88   struct coff_link_hash_entry **sym_hashes;
  89
  90   /* Used by the pe linker for PowerPC.  */
  91   int *local_toc_sym_map;
  92
  93   struct bfd_link_info *link_info;
  94
  95   /* Used by coff_find_nearest_line.  */
  96   void * line_info;
  97
  98   /* A place to stash dwarf2 info for this bfd.  */
  99   void * dwarf2_find_line_info;
 100
 101   /* The timestamp from the COFF file header.  */
 102   long timestamp;
 103
 104   /* Copy of some of the f_flags bits in the COFF filehdr structure,
 105      used by ARM code.  */
 106   flagword flags;
 107
 108 } coff_data_type;
 109
 110 /* Tdata for pe image files.  */
 111 typedef struct pe_tdata
 112 {
 113   coff_data_type coff;
 114   struct internal_extra_pe_aouthdr pe_opthdr;
 115   int dll;
 116   int has_reloc_section;
 117   bfd_boolean (*in_reloc_p) (bfd *, reloc_howto_type *);
 118   flagword real_flags;
 119   int target_subsystem;
 120   bfd_boolean force_minimum_alignment;
 121 } pe_data_type;
 122
 123 #define pe_data(bfd)            ((bfd)->tdata.pe_obj_data)
 124
 125 /* Tdata for XCOFF files.  */
 126
 127 struct xcoff_tdata
 128 {
 129   /* Basic COFF information.  */
 130   coff_data_type coff;
 131
 132   /* TRUE if this is an XCOFF64 file. */
 133   bfd_boolean xcoff64;
 134
 135   /* TRUE if a large a.out header should be generated.  */
 136   bfd_boolean full_aouthdr;
 137
 138   /* TOC value.  */
 139   bfd_vma toc;
 140
 141   /* Index of section holding TOC.  */
 142   int sntoc;
 143
 144   /* Index of section holding entry point.  */
 145   int snentry;
 146
 147   /* .text alignment from optional header.  */
 148   int text_align_power;
 149
 150   /* .data alignment from optional header.  */
 151   int data_align_power;
 152
 153   /* modtype from optional header.  */
 154   short modtype;
 155
 156   /* cputype from optional header.  */
 157   short cputype;
 158
 159   /* maxdata from optional header.  */
 160   bfd_vma maxdata;
 161
 162   /* maxstack from optional header.  */
 163   bfd_vma maxstack;
 164
 165   /* Used by the XCOFF backend linker.  */
 166   asection **csects;
 167   unsigned long *debug_indices;
 168   unsigned int import_file_id;
 169 };
 170
 171 #define xcoff_data(abfd) ((abfd)->tdata.xcoff_obj_data)
 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 coffsymbol(asymbol) ((coff_symbol_type *)(&((asymbol)->the_bfd)))
 176
 177 /* The used_by_bfd field of a section may be set to a pointer to this
 178    structure.  */
 179
 180 struct coff_section_tdata
 181 {
 182   /* The relocs, swapped into COFF internal form.  This may be NULL.  */
 183   struct internal_reloc *relocs;
 184   /* If this is TRUE, the relocs entry may not be freed.  */
 185   bfd_boolean keep_relocs;
 186   /* The section contents.  This may be NULL.  */
 187   bfd_byte *contents;
 188   /* If this is TRUE, the contents entry may not be freed.  */
 189   bfd_boolean keep_contents;
 190   /* Information cached by coff_find_nearest_line.  */
 191   bfd_vma offset;
 192   unsigned int i;
 193   const char *function;
 194   /* Optional information about a COMDAT entry; NULL if not COMDAT. */
 195   struct coff_comdat_info *comdat;
 196   int line_base;
 197   /* A pointer used for .stab linking optimizations.  */
 198   void * stab_info;
 199   /* Available for individual backends.  */
 200   void * tdata;
 201 };
 202
 203 /* An accessor macro for the coff_section_tdata structure.  */
 204 #define coff_section_data(abfd, sec) \
 205   ((struct coff_section_tdata *) (sec)->used_by_bfd)
 206
 207 /* Tdata for sections in XCOFF files.  This is used by the linker.  */
 208
 209 struct xcoff_section_tdata
 210 {
 211   /* Used for XCOFF csects created by the linker; points to the real
 212      XCOFF section which contains this csect.  */
 213   asection *enclosing;
 214   /* The lineno_count field for the enclosing section, because we are
 215      going to clobber it there.  */
 216   unsigned int lineno_count;
 217   /* The first and one past the last symbol indices for symbols used
 218      by this csect.  */
 219   unsigned long first_symndx;
 220   unsigned long last_symndx;
 221 };
 222
 223 /* An accessor macro the xcoff_section_tdata structure.  */
 224 #define xcoff_section_data(abfd, sec) \
 225   ((struct xcoff_section_tdata *) coff_section_data ((abfd), (sec))->tdata)
 226
 227 /* Tdata for sections in PE files.  */
 228
 229 struct pei_section_tdata
 230 {
 231   /* The virtual size of the section.  */
 232   bfd_size_type virt_size;
 233   /* The PE section flags.  */
 234   long pe_flags;
 235 };
 236
 237 /* An accessor macro for the pei_section_tdata structure.  */
 238 #define pei_section_data(abfd, sec) \
 239   ((struct pei_section_tdata *) coff_section_data ((abfd), (sec))->tdata)
 240
 241 /* COFF linker hash table entries.  */
 242
 243 struct coff_link_hash_entry
 244 {
 245   struct bfd_link_hash_entry root;
 246
 247   /* Symbol index in output file.  Set to -1 initially.  Set to -2 if
 248      there is a reloc against this symbol.  */
 249   long indx;
 250
 251   /* Symbol type.  */
 252   unsigned short type;
 253
 254   /* Symbol class.  */
 255   unsigned char class;
 256
 257   /* Number of auxiliary entries.  */
 258   char numaux;
 259
 260   /* BFD to take auxiliary entries from.  */
 261   bfd *auxbfd;
 262
 263   /* Pointer to array of auxiliary entries, if any.  */
 264   union internal_auxent *aux;
 265
 266   /* Flag word; legal values follow.  */
 267   unsigned short coff_link_hash_flags;
 268   /* Symbol is a PE section symbol.  */
 269 #define COFF_LINK_HASH_PE_SECTION_SYMBOL (01)
 270 };
 271
 272 /* COFF linker hash table.  */
 273
 274 struct coff_link_hash_table
 275 {
 276   struct bfd_link_hash_table root;
 277   /* A pointer to information used to link stabs in sections.  */
 278   struct stab_info stab_info;
 279 };
 280
 281 /* Look up an entry in a COFF linker hash table.  */
 282
 283 #define coff_link_hash_lookup(table, string, create, copy, follow)      \
 284   ((struct coff_link_hash_entry *)                                      \
 285    bfd_link_hash_lookup (&(table)->root, (string), (create),            \
 286                          (copy), (follow)))
 287
 288 /* Traverse a COFF linker hash table.  */
 289
 290 #define coff_link_hash_traverse(table, func, info)                      \
 291   (bfd_link_hash_traverse                                               \
 292    (&(table)->root,                                                     \
 293     (bfd_boolean (*) (struct bfd_link_hash_entry *, void *)) (func), \
 294     (info)))
 295
 296 /* Get the COFF linker hash table from a link_info structure.  */
 297
 298 #define coff_hash_table(p) ((struct coff_link_hash_table *) ((p)->hash))
 299
 300 /* Functions in coffgen.c.  */
 301 extern const bfd_target *coff_object_p
 302   (bfd *);
 303 extern struct bfd_section *coff_section_from_bfd_index
 304   (bfd *, int);
 305 extern long coff_get_symtab_upper_bound
 306   (bfd *);
 307 extern long coff_canonicalize_symtab
 308   (bfd *, asymbol **);
 309 extern int coff_count_linenumbers
 310   (bfd *);
 311 extern struct coff_symbol_struct *coff_symbol_from
 312   (bfd *, asymbol *);
 313 extern bfd_boolean coff_renumber_symbols
 314   (bfd *, int *);
 315 extern void coff_mangle_symbols
 316   (bfd *);
 317 extern bfd_boolean coff_write_symbols
 318   (bfd *);
 319 extern bfd_boolean coff_write_linenumbers
 320   (bfd *);
 321 extern alent *coff_get_lineno
 322   (bfd *, asymbol *);
 323 extern asymbol *coff_section_symbol
 324   (bfd *, char *);
 325 extern bfd_boolean _bfd_coff_get_external_symbols
 326   (bfd *);
 327 extern const char *_bfd_coff_read_string_table
 328   (bfd *);
 329 extern bfd_boolean _bfd_coff_free_symbols
 330   (bfd *);
 331 extern struct coff_ptr_struct *coff_get_normalized_symtab
 332   (bfd *);
 333 extern long coff_get_reloc_upper_bound
 334   (bfd *, sec_ptr);
 335 extern asymbol *coff_make_empty_symbol
 336   (bfd *);
 337 extern void coff_print_symbol
 338   (bfd *, void * filep, asymbol *, bfd_print_symbol_type);
 339 extern void coff_get_symbol_info
 340   (bfd *, asymbol *, symbol_info *ret);
 341 extern bfd_boolean _bfd_coff_is_local_label_name
 342   (bfd *, const char *);
 343 extern asymbol *coff_bfd_make_debug_symbol
 344   (bfd *, void *, unsigned long);
 345 extern bfd_boolean coff_find_nearest_line
 346   (bfd *, asection *, asymbol **, bfd_vma, const char **,
 347    const char **, unsigned int *);
 348 extern int coff_sizeof_headers
 349   (bfd *, bfd_boolean);
 350 extern bfd_boolean bfd_coff_reloc16_relax_section
 351   (bfd *, asection *, struct bfd_link_info *, bfd_boolean *);
 352 extern bfd_byte *bfd_coff_reloc16_get_relocated_section_contents
 353   (bfd *, struct bfd_link_info *, struct bfd_link_order *,
 354    bfd_byte *, bfd_boolean, asymbol **);
 355 extern bfd_vma bfd_coff_reloc16_get_value
 356   (arelent *, struct bfd_link_info *, asection *);
 357 extern void bfd_perform_slip
 358   (bfd *, unsigned int, asection *, bfd_vma);
 359
 360 /* Functions and types in cofflink.c.  */
 361
 362 #define STRING_SIZE_SIZE 4
 363
 364 /* We use a hash table to merge identical enum, struct, and union
 365    definitions in the linker.  */
 366
 367 /* Information we keep for a single element (an enum value, a
 368    structure or union field) in the debug merge hash table.  */
 369
 370 struct coff_debug_merge_element
 371 {
 372   /* Next element.  */
 373   struct coff_debug_merge_element *next;
 374
 375   /* Name.  */
 376   const char *name;
 377
 378   /* Type.  */
 379   unsigned int type;
 380
 381   /* Symbol index for complex type.  */
 382   long tagndx;
 383 };
 384
 385 /* A linked list of debug merge entries for a given name.  */
 386
 387 struct coff_debug_merge_type
 388 {
 389   /* Next type with the same name.  */
 390   struct coff_debug_merge_type *next;
 391
 392   /* Class of type.  */
 393   int class;
 394
 395   /* Symbol index where this type is defined.  */
 396   long indx;
 397
 398   /* List of elements.  */
 399   struct coff_debug_merge_element *elements;
 400 };
 401
 402 /* Information we store in the debug merge hash table.  */
 403
 404 struct coff_debug_merge_hash_entry
 405 {
 406   struct bfd_hash_entry root;
 407
 408   /* A list of types with this name.  */
 409   struct coff_debug_merge_type *types;
 410 };
 411
 412 /* The debug merge hash table.  */
 413
 414 struct coff_debug_merge_hash_table
 415 {
 416   struct bfd_hash_table root;
 417 };
 418
 419 /* Initialize a COFF debug merge hash table.  */
 420
 421 #define coff_debug_merge_hash_table_init(table) \
 422   (bfd_hash_table_init (&(table)->root, _bfd_coff_debug_merge_hash_newfunc))
 423
 424 /* Free a COFF debug merge hash table.  */
 425
 426 #define coff_debug_merge_hash_table_free(table) \
 427   (bfd_hash_table_free (&(table)->root))
 428
 429 /* Look up an entry in a COFF debug merge hash table.  */
 430
 431 #define coff_debug_merge_hash_lookup(table, string, create, copy) \
 432   ((struct coff_debug_merge_hash_entry *) \
 433    bfd_hash_lookup (&(table)->root, (string), (create), (copy)))
 434
 435 /* Information we keep for each section in the output file when doing
 436    a relocatable link.  */
 437
 438 struct coff_link_section_info
 439 {
 440   /* The relocs to be output.  */
 441   struct internal_reloc *relocs;
 442   /* For each reloc against a global symbol whose index was not known
 443      when the reloc was handled, the global hash table entry.  */
 444   struct coff_link_hash_entry **rel_hashes;
 445 };
 446
 447 /* Information that we pass around while doing the final link step.  */
 448
 449 struct coff_final_link_info
 450 {
 451   /* General link information.  */
 452   struct bfd_link_info *info;
 453   /* Output BFD.  */
 454   bfd *output_bfd;
 455   /* Used to indicate failure in traversal routine.  */
 456   bfd_boolean failed;
 457   /* If doing "task linking" set only during the time when we want the
 458      global symbol writer to convert the storage class of defined global
 459      symbols from global to static. */
 460   bfd_boolean global_to_static;
 461   /* Hash table for long symbol names.  */
 462   struct bfd_strtab_hash *strtab;
 463   /* When doing a relocatable link, an array of information kept for
 464      each output section, indexed by the target_index field.  */
 465   struct coff_link_section_info *section_info;
 466   /* Symbol index of last C_FILE symbol (-1 if none).  */
 467   long last_file_index;
 468   /* Contents of last C_FILE symbol.  */
 469   struct internal_syment last_file;
 470   /* Symbol index of first aux entry of last .bf symbol with an empty
 471      endndx field (-1 if none).  */
 472   long last_bf_index;
 473   /* Contents of last_bf_index aux entry.  */
 474   union internal_auxent last_bf;
 475   /* Hash table used to merge debug information.  */
 476   struct coff_debug_merge_hash_table debug_merge;
 477   /* Buffer large enough to hold swapped symbols of any input file.  */
 478   struct internal_syment *internal_syms;
 479   /* Buffer large enough to hold sections of symbols of any input file.  */
 480   asection **sec_ptrs;
 481   /* Buffer large enough to hold output indices of symbols of any
 482      input file.  */
 483   long *sym_indices;
 484   /* Buffer large enough to hold output symbols for any input file.  */
 485   bfd_byte *outsyms;
 486   /* Buffer large enough to hold external line numbers for any input
 487      section.  */
 488   bfd_byte *linenos;
 489   /* Buffer large enough to hold any input section.  */
 490   bfd_byte *contents;
 491   /* Buffer large enough to hold external relocs of any input section.  */
 492   bfd_byte *external_relocs;
 493   /* Buffer large enough to hold swapped relocs of any input section.  */
 494   struct internal_reloc *internal_relocs;
 495 };
 496
 497 /* Most COFF variants have no way to record the alignment of a
 498    section.  This struct is used to set a specific alignment based on
 499    the name of the section.  */
 500
 501 struct coff_section_alignment_entry
 502 {
 503   /* The section name.  */
 504   const char *name;
 505
 506   /* This is either (unsigned int) -1, indicating that the section
 507      name must match exactly, or it is the number of letters which
 508      must match at the start of the name.  */
 509   unsigned int comparison_length;
 510
 511   /* These macros may be used to fill in the first two fields in a
 512      structure initialization.  */
 513 #define COFF_SECTION_NAME_EXACT_MATCH(name) (name), ((unsigned int) -1)
 514 #define COFF_SECTION_NAME_PARTIAL_MATCH(name) (name), (sizeof (name) - 1)
 515
 516   /* Only use this entry if the default section alignment for this
 517      target is at least that much (as a power of two).  If this field
 518      is COFF_ALIGNMENT_FIELD_EMPTY, it should be ignored.  */
 519   unsigned int default_alignment_min;
 520
 521   /* Only use this entry if the default section alignment for this
 522      target is no greater than this (as a power of two).  If this
 523      field is COFF_ALIGNMENT_FIELD_EMPTY, it should be ignored.  */
 524   unsigned int default_alignment_max;
 525
 526 #define COFF_ALIGNMENT_FIELD_EMPTY ((unsigned int) -1)
 527
 528   /* The desired alignment for this section (as a power of two).  */
 529   unsigned int alignment_power;
 530 };
 531
 532 extern struct bfd_hash_entry *_bfd_coff_link_hash_newfunc
 533   (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
 534 extern bfd_boolean _bfd_coff_link_hash_table_init
 535   (struct coff_link_hash_table *, bfd *,
 536    struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
 537                                struct bfd_hash_table *,
 538                                const char *));
 539 extern struct bfd_link_hash_table *_bfd_coff_link_hash_table_create
 540   (bfd *);
 541 extern const char *_bfd_coff_internal_syment_name
 542   (bfd *, const struct internal_syment *, char *);
 543 extern bfd_boolean _bfd_coff_link_add_symbols
 544   (bfd *, struct bfd_link_info *);
 545 extern bfd_boolean _bfd_coff_final_link
 546   (bfd *, struct bfd_link_info *);
 547 extern struct internal_reloc *_bfd_coff_read_internal_relocs
 548   (bfd *, asection *, bfd_boolean, bfd_byte *, bfd_boolean,
 549    struct internal_reloc *);
 550 extern bfd_boolean _bfd_coff_generic_relocate_section
 551   (bfd *, struct bfd_link_info *, bfd *, asection *, bfd_byte *,
 552    struct internal_reloc *, struct internal_syment *, asection **);
 553 extern struct bfd_hash_entry *_bfd_coff_debug_merge_hash_newfunc
 554   (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
 555 extern bfd_boolean _bfd_coff_write_global_sym
 556   (struct coff_link_hash_entry *, void *);
 557 extern bfd_boolean _bfd_coff_write_task_globals
 558   (struct coff_link_hash_entry *, void *);
 559 extern bfd_boolean _bfd_coff_link_input_bfd
 560   (struct coff_final_link_info *, bfd *);
 561 extern bfd_boolean _bfd_coff_reloc_link_order
 562   (bfd *, struct coff_final_link_info *, asection *,
 563    struct bfd_link_order *);
 564
 565
 566 #define coff_get_section_contents_in_window \
 567   _bfd_generic_get_section_contents_in_window
 568
 569 /* Functions in xcofflink.c.  */
 570
 571 extern long _bfd_xcoff_get_dynamic_symtab_upper_bound
 572   (bfd *);
 573 extern long _bfd_xcoff_canonicalize_dynamic_symtab
 574   (bfd *, asymbol **);
 575 extern long _bfd_xcoff_get_dynamic_reloc_upper_bound
 576   (bfd *);
 577 extern long _bfd_xcoff_canonicalize_dynamic_reloc
 578   (bfd *, arelent **, asymbol **);
 579 extern struct bfd_link_hash_table *_bfd_xcoff_bfd_link_hash_table_create
 580   (bfd *);
 581 extern void _bfd_xcoff_bfd_link_hash_table_free
 582   (struct bfd_link_hash_table *);
 583 extern bfd_boolean _bfd_xcoff_bfd_link_add_symbols
 584   (bfd *, struct bfd_link_info *);
 585 extern bfd_boolean _bfd_xcoff_bfd_final_link
 586   (bfd *, struct bfd_link_info *);
 587 extern bfd_boolean _bfd_ppc_xcoff_relocate_section
 588   (bfd *, struct bfd_link_info *, bfd *, asection *, bfd_byte *,
 589    struct internal_reloc *, struct internal_syment *, asection **);
 590
 591 /* Functions in coff-ppc.c.  FIXME: These are called be pe.em in the
 592    linker, and so should start with bfd and be declared in bfd.h.  */
 593
 594 extern bfd_boolean ppc_allocate_toc_section
 595   (struct bfd_link_info *);
 596 extern bfd_boolean ppc_process_before_allocation
 597   (bfd *, struct bfd_link_info *);
 598