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 a large a.out header should be generated.  */
 130   boolean full_aouthdr;
 131
 132   /* TOC value.  */
 133   bfd_vma toc;
 134
 135   /* Index of section holding TOC.  */
 136   int sntoc;
 137
 138   /* Index of section holding entry point.  */
 139   int snentry;
 140
 141   /* .text alignment from optional header.  */
 142   int text_align_power;
 143
 144   /* .data alignment from optional header.  */
 145   int data_align_power;
 146
 147   /* modtype from optional header.  */
 148   short modtype;
 149
 150   /* cputype from optional header.  */
 151   short cputype;
 152
 153   /* maxdata from optional header.  */
 154   bfd_size_type maxdata;
 155
 156   /* maxstack from optional header.  */
 157   bfd_size_type maxstack;
 158
 159   /* Used by the XCOFF backend linker.  */
 160   asection **csects;
 161   unsigned long *debug_indices;
 162   unsigned int import_file_id;
 163 };
 164
 165 #define xcoff_data(abfd) ((abfd)->tdata.xcoff_obj_data)
 166
 167 /* We take the address of the first element of a asymbol to ensure that the
 168  * macro is only ever applied to an asymbol.  */
 169 #define coffsymbol(asymbol) ((coff_symbol_type *)(&((asymbol)->the_bfd)))
 170
 171 /* The used_by_bfd field of a section may be set to a pointer to this
 172    structure.  */
 173
 174 struct coff_section_tdata
 175 {
 176   /* The relocs, swapped into COFF internal form.  This may be NULL.  */
 177   struct internal_reloc *relocs;
 178   /* If this is true, the relocs entry may not be freed.  */
 179   boolean keep_relocs;
 180   /* The section contents.  This may be NULL.  */
 181   bfd_byte *contents;
 182   /* If this is true, the contents entry may not be freed.  */
 183   boolean keep_contents;
 184   /* Information cached by coff_find_nearest_line.  */
 185   bfd_vma offset;
 186   unsigned int i;
 187   const char *function;
 188   int line_base;
 189   /* A pointer used for .stab linking optimizations.  */
 190   PTR stab_info;
 191   /* Available for individual backends.  */
 192   PTR tdata;
 193 };
 194
 195 /* An accessor macro for the coff_section_tdata structure.  */
 196 #define coff_section_data(abfd, sec) \
 197   ((struct coff_section_tdata *) (sec)->used_by_bfd)
 198
 199 /* Tdata for sections in XCOFF files.  This is used by the linker.  */
 200
 201 struct xcoff_section_tdata
 202 {
 203   /* Used for XCOFF csects created by the linker; points to the real
 204      XCOFF section which contains this csect.  */
 205   asection *enclosing;
 206   /* The lineno_count field for the enclosing section, because we are
 207      going to clobber it there.  */
 208   unsigned int lineno_count;
 209   /* The first and one past the last symbol indices for symbols used
 210      by this csect.  */
 211   unsigned long first_symndx;
 212   unsigned long last_symndx;
 213 };
 214
 215 /* An accessor macro the xcoff_section_tdata structure.  */
 216 #define xcoff_section_data(abfd, sec) \
 217   ((struct xcoff_section_tdata *) coff_section_data ((abfd), (sec))->tdata)
 218
 219 /* Tdata for sections in PEI image files.  */
 220
 221 struct pei_section_tdata
 222 {
 223   /* The virtual size of the section.  */
 224   bfd_size_type virt_size;
 225 };
 226
 227 /* An accessor macro for the pei_section_tdata structure.  */
 228 #define pei_section_data(abfd, sec) \
 229   ((struct pei_section_tdata *) coff_section_data ((abfd), (sec))->tdata)
 230
 231 /* COFF linker hash table entries.  */
 232
 233 struct coff_link_hash_entry
 234 {
 235   struct bfd_link_hash_entry root;
 236
 237   /* Symbol index in output file.  Set to -1 initially.  Set to -2 if
 238      there is a reloc against this symbol.  */
 239   long indx;
 240
 241   /* Symbol type.  */
 242   unsigned short type;
 243
 244   /* Symbol class.  */
 245   unsigned char class;
 246
 247   /* Number of auxiliary entries.  */
 248   char numaux;
 249
 250   /* BFD to take auxiliary entries from.  */
 251   bfd *auxbfd;
 252
 253   /* Pointer to array of auxiliary entries, if any.  */
 254   union internal_auxent *aux;
 255
 256   /* Flag word; legal values follow.  */
 257   unsigned short coff_link_hash_flags;
 258   /* Symbol is a PE section symbol.  */
 259 #define COFF_LINK_HASH_PE_SECTION_SYMBOL (01)
 260 };
 261
 262 /* COFF linker hash table.  */
 263
 264 struct coff_link_hash_table
 265 {
 266   struct bfd_link_hash_table root;
 267   /* A pointer to information used to link stabs in sections.  */
 268   PTR stab_info;
 269 };
 270
 271 /* Look up an entry in a COFF linker hash table.  */
 272
 273 #define coff_link_hash_lookup(table, string, create, copy, follow)      \
 274   ((struct coff_link_hash_entry *)                                      \
 275    bfd_link_hash_lookup (&(table)->root, (string), (create),            \
 276                          (copy), (follow)))
 277
 278 /* Traverse a COFF linker hash table.  */
 279
 280 #define coff_link_hash_traverse(table, func, info)                      \
 281   (bfd_link_hash_traverse                                               \
 282    (&(table)->root,                                                     \
 283     (boolean (*) PARAMS ((struct bfd_link_hash_entry *, PTR))) (func),  \
 284     (info)))
 285
 286 /* Get the COFF linker hash table from a link_info structure.  */
 287
 288 #define coff_hash_table(p) ((struct coff_link_hash_table *) ((p)->hash))
 289
 290 /* Functions in coffgen.c.  */
 291 extern const bfd_target *coff_object_p PARAMS ((bfd *));
 292 extern struct sec *coff_section_from_bfd_index PARAMS ((bfd *, int));
 293 extern long coff_get_symtab_upper_bound PARAMS ((bfd *));
 294 extern long coff_get_symtab PARAMS ((bfd *, asymbol **));
 295 extern int coff_count_linenumbers PARAMS ((bfd *));
 296 extern struct coff_symbol_struct *coff_symbol_from PARAMS ((bfd *, asymbol *));
 297 extern boolean coff_renumber_symbols PARAMS ((bfd *, int *));
 298 extern void coff_mangle_symbols PARAMS ((bfd *));
 299 extern boolean coff_write_symbols PARAMS ((bfd *));
 300 extern boolean coff_write_linenumbers PARAMS ((bfd *));
 301 extern alent *coff_get_lineno PARAMS ((bfd *, asymbol *));
 302 extern asymbol *coff_section_symbol PARAMS ((bfd *, char *));
 303 extern boolean _bfd_coff_get_external_symbols PARAMS ((bfd *));
 304 extern const char *_bfd_coff_read_string_table PARAMS ((bfd *));
 305 extern boolean _bfd_coff_free_symbols PARAMS ((bfd *));
 306 extern struct coff_ptr_struct *coff_get_normalized_symtab PARAMS ((bfd *));
 307 extern long coff_get_reloc_upper_bound PARAMS ((bfd *, sec_ptr));
 308 extern asymbol *coff_make_empty_symbol PARAMS ((bfd *));
 309 extern void coff_print_symbol PARAMS ((bfd *, PTR filep, asymbol *,
 310                                        bfd_print_symbol_type how));
 311 extern void coff_get_symbol_info PARAMS ((bfd *, asymbol *,
 312                                           symbol_info *ret));
 313 extern boolean _bfd_coff_is_local_label_name PARAMS ((bfd *, const char *));
 314 extern asymbol *coff_bfd_make_debug_symbol PARAMS ((bfd *, PTR,
 315                                                     unsigned long));
 316 extern boolean coff_find_nearest_line PARAMS ((bfd *,
 317                                                asection *,
 318                                                asymbol **,
 319                                                bfd_vma offset,
 320                                                CONST char **filename_ptr,
 321                                                CONST char **functionname_ptr,
 322                                                unsigned int *line_ptr));
 323 extern int coff_sizeof_headers PARAMS ((bfd *, boolean reloc));
 324 extern boolean bfd_coff_reloc16_relax_section
 325   PARAMS ((bfd *, asection *, struct bfd_link_info *, boolean *));
 326 extern bfd_byte *bfd_coff_reloc16_get_relocated_section_contents
 327   PARAMS ((bfd *, struct bfd_link_info *, struct bfd_link_order *,
 328            bfd_byte *, boolean relocateable, asymbol **));
 329 extern bfd_vma bfd_coff_reloc16_get_value PARAMS ((arelent *,
 330                                                    struct bfd_link_info *,
 331                                                    asection *));
 332 extern void bfd_perform_slip PARAMS ((bfd *abfd, unsigned int slip,
 333                                       asection *input_section,
 334                                       bfd_vma val));
 335
 336 /* Functions and types in cofflink.c.  */
 337
 338 #define STRING_SIZE_SIZE (4)
 339
 340 /* We use a hash table to merge identical enum, struct, and union
 341    definitions in the linker.  */
 342
 343 /* Information we keep for a single element (an enum value, a
 344    structure or union field) in the debug merge hash table.  */
 345
 346 struct coff_debug_merge_element
 347 {
 348   /* Next element.  */
 349   struct coff_debug_merge_element *next;
 350
 351   /* Name.  */
 352   const char *name;
 353
 354   /* Type.  */
 355   unsigned int type;
 356
 357   /* Symbol index for complex type.  */
 358   long tagndx;
 359 };
 360
 361 /* A linked list of debug merge entries for a given name.  */
 362
 363 struct coff_debug_merge_type
 364 {
 365   /* Next type with the same name.  */
 366   struct coff_debug_merge_type *next;
 367
 368   /* Class of type.  */
 369   int class;
 370
 371   /* Symbol index where this type is defined.  */
 372   long indx;
 373
 374   /* List of elements.  */
 375   struct coff_debug_merge_element *elements;
 376 };
 377
 378 /* Information we store in the debug merge hash table.  */
 379
 380 struct coff_debug_merge_hash_entry
 381 {
 382   struct bfd_hash_entry root;
 383
 384   /* A list of types with this name.  */
 385   struct coff_debug_merge_type *types;
 386 };
 387
 388 /* The debug merge hash table.  */
 389
 390 struct coff_debug_merge_hash_table
 391 {
 392   struct bfd_hash_table root;
 393 };
 394
 395 /* Initialize a COFF debug merge hash table.  */
 396
 397 #define coff_debug_merge_hash_table_init(table) \
 398   (bfd_hash_table_init (&(table)->root, _bfd_coff_debug_merge_hash_newfunc))
 399
 400 /* Free a COFF debug merge hash table.  */
 401
 402 #define coff_debug_merge_hash_table_free(table) \
 403   (bfd_hash_table_free (&(table)->root))
 404
 405 /* Look up an entry in a COFF debug merge hash table.  */
 406
 407 #define coff_debug_merge_hash_lookup(table, string, create, copy) \
 408   ((struct coff_debug_merge_hash_entry *) \
 409    bfd_hash_lookup (&(table)->root, (string), (create), (copy)))
 410
 411 /* Information we keep for each section in the output file when doing
 412    a relocateable link.  */
 413
 414 struct coff_link_section_info
 415 {
 416   /* The relocs to be output.  */
 417   struct internal_reloc *relocs;
 418   /* For each reloc against a global symbol whose index was not known
 419      when the reloc was handled, the global hash table entry.  */
 420   struct coff_link_hash_entry **rel_hashes;
 421 };
 422
 423 /* Information that we pass around while doing the final link step.  */
 424
 425 struct coff_final_link_info
 426 {
 427   /* General link information.  */
 428   struct bfd_link_info *info;
 429   /* Output BFD.  */
 430   bfd *output_bfd;
 431   /* Used to indicate failure in traversal routine.  */
 432   boolean failed;
 433   /* If doing "task linking" set only during the time when we want the
 434      global symbol writer to convert the storage class of defined global
 435      symbols from global to static. */
 436   boolean global_to_static;
 437   /* Hash table for long symbol names.  */
 438   struct bfd_strtab_hash *strtab;
 439   /* When doing a relocateable link, an array of information kept for
 440      each output section, indexed by the target_index field.  */
 441   struct coff_link_section_info *section_info;
 442   /* Symbol index of last C_FILE symbol (-1 if none).  */
 443   long last_file_index;
 444   /* Contents of last C_FILE symbol.  */
 445   struct internal_syment last_file;
 446   /* Symbol index of first aux entry of last .bf symbol with an empty
 447      endndx field (-1 if none).  */
 448   long last_bf_index;
 449   /* Contents of last_bf_index aux entry.  */
 450   union internal_auxent last_bf;
 451   /* Hash table used to merge debug information.  */
 452   struct coff_debug_merge_hash_table debug_merge;
 453   /* Buffer large enough to hold swapped symbols of any input file.  */
 454   struct internal_syment *internal_syms;
 455   /* Buffer large enough to hold sections of symbols of any input file.  */
 456   asection **sec_ptrs;
 457   /* Buffer large enough to hold output indices of symbols of any
 458      input file.  */
 459   long *sym_indices;
 460   /* Buffer large enough to hold output symbols for any input file.  */
 461   bfd_byte *outsyms;
 462   /* Buffer large enough to hold external line numbers for any input
 463      section.  */
 464   bfd_byte *linenos;
 465   /* Buffer large enough to hold any input section.  */
 466   bfd_byte *contents;
 467   /* Buffer large enough to hold external relocs of any input section.  */
 468   bfd_byte *external_relocs;
 469   /* Buffer large enough to hold swapped relocs of any input section.  */
 470   struct internal_reloc *internal_relocs;
 471 };
 472
 473 /* Most COFF variants have no way to record the alignment of a
 474    section.  This struct is used to set a specific alignment based on
 475    the name of the section.  */
 476
 477 struct coff_section_alignment_entry
 478 {
 479   /* The section name.  */
 480   const char *name;
 481
 482   /* This is either (unsigned int) -1, indicating that the section
 483      name must match exactly, or it is the number of letters which
 484      must match at the start of the name.  */
 485   unsigned int comparison_length;
 486
 487   /* These macros may be used to fill in the first two fields in a
 488      structure initialization.  */
 489 #define COFF_SECTION_NAME_EXACT_MATCH(name) (name), ((unsigned int) -1)
 490 #define COFF_SECTION_NAME_PARTIAL_MATCH(name) (name), (sizeof (name) - 1)
 491
 492   /* Only use this entry if the default section alignment for this
 493      target is at least that much (as a power of two).  If this field
 494      is COFF_ALIGNMENT_FIELD_EMPTY, it should be ignored.  */
 495   unsigned int default_alignment_min;
 496
 497   /* Only use this entry if the default section alignment for this
 498      target is no greater than this (as a power of two).  If this
 499      field is COFF_ALIGNMENT_FIELD_EMPTY, it should be ignored.  */
 500   unsigned int default_alignment_max;
 501
 502 #define COFF_ALIGNMENT_FIELD_EMPTY ((unsigned int) -1)
 503
 504   /* The desired alignment for this section (as a power of two).  */
 505   unsigned int alignment_power;
 506 };
 507
 508 extern struct bfd_hash_entry *_bfd_coff_link_hash_newfunc
 509   PARAMS ((struct bfd_hash_entry *, struct bfd_hash_table *, const char *));
 510 extern boolean _bfd_coff_link_hash_table_init
 511   PARAMS ((struct coff_link_hash_table *, bfd *,
 512            struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
 513                                        struct bfd_hash_table *,
 514                                        const char *)));
 515 extern struct bfd_link_hash_table *_bfd_coff_link_hash_table_create
 516   PARAMS ((bfd *));
 517 extern const char *_bfd_coff_internal_syment_name
 518   PARAMS ((bfd *, const struct internal_syment *, char *));
 519 extern boolean _bfd_coff_link_add_symbols
 520   PARAMS ((bfd *, struct bfd_link_info *));
 521 extern boolean _bfd_coff_final_link
 522   PARAMS ((bfd *, struct bfd_link_info *));
 523 extern struct internal_reloc *_bfd_coff_read_internal_relocs
 524   PARAMS ((bfd *, asection *, boolean, bfd_byte *, boolean,
 525            struct internal_reloc *));
 526 extern boolean _bfd_coff_generic_relocate_section
 527   PARAMS ((bfd *, struct bfd_link_info *, bfd *, asection *, bfd_byte *,
 528            struct internal_reloc *, struct internal_syment *, asection **));
 529
 530 extern struct bfd_hash_entry *_bfd_coff_debug_merge_hash_newfunc
 531   PARAMS ((struct bfd_hash_entry *, struct bfd_hash_table *, const char *));
 532 extern boolean _bfd_coff_write_global_sym
 533   PARAMS ((struct coff_link_hash_entry *, PTR));
 534 extern boolean _bfd_coff_write_task_globals
 535   PARAMS ((struct coff_link_hash_entry *, PTR));
 536 extern boolean _bfd_coff_link_input_bfd
 537   PARAMS ((struct coff_final_link_info *, bfd *));
 538 extern boolean _bfd_coff_reloc_link_order
 539   PARAMS ((bfd *, struct coff_final_link_info *, asection *,
 540            struct bfd_link_order *));
 541
 542
 543 #define coff_get_section_contents_in_window \
 544   _bfd_generic_get_section_contents_in_window
 545
 546 /* Functions in xcofflink.c.  */
 547
 548 extern long _bfd_xcoff_get_dynamic_symtab_upper_bound PARAMS ((bfd *));
 549 extern long _bfd_xcoff_canonicalize_dynamic_symtab
 550   PARAMS ((bfd *, asymbol **));
 551 extern long _bfd_xcoff_get_dynamic_reloc_upper_bound PARAMS ((bfd *));
 552 extern long _bfd_xcoff_canonicalize_dynamic_reloc
 553   PARAMS ((bfd *, arelent **, asymbol **));
 554 extern struct bfd_link_hash_table *_bfd_xcoff_bfd_link_hash_table_create
 555   PARAMS ((bfd *));
 556 extern boolean _bfd_xcoff_bfd_link_add_symbols
 557   PARAMS ((bfd *, struct bfd_link_info *));
 558 extern boolean _bfd_xcoff_bfd_final_link
 559   PARAMS ((bfd *, struct bfd_link_info *));
 560 extern boolean _bfd_ppc_xcoff_relocate_section
 561   PARAMS ((bfd *, struct bfd_link_info *, bfd *, asection *, bfd_byte *,
 562            struct internal_reloc *, struct internal_syment *, asection **));
 563
 564 /* Functions in coff-ppc.c.  FIXME: These are called be pe.em in the
 565    linker, and so should start with bfd and be declared in bfd.h.  */
 566
 567 extern boolean ppc_allocate_toc_section PARAMS ((struct bfd_link_info *));
 568 extern boolean ppc_process_before_allocation
 569   PARAMS ((bfd *, struct bfd_link_info *));
 570
 571 /* And more taken from the source .. */
 572