bfd/libcoff-in.h

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