bfd/libcoff-in.h

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