bfd/libcoff-in.h

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