libcoff-in.h revision 60484
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 9This file is part of BFD, the Binary File Descriptor library. 10 11This program is free software; you can redistribute it and/or modify 12it under the terms of the GNU General Public License as published by 13the Free Software Foundation; either version 2 of the License, or 14(at your option) any later version. 15 16This program is distributed in the hope that it will be useful, 17but WITHOUT ANY WARRANTY; without even the implied warranty of 18MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 19GNU General Public License for more details. 20 21You should have received a copy of the GNU General Public License 22along with this program; if not, write to the Free Software 23Foundation, 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 51typedef 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. */ 110typedef 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 124struct 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 174struct 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 201struct 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 PE files. */ 220 221struct pei_section_tdata 222{ 223 /* The virtual size of the section. */ 224 bfd_size_type virt_size; 225 /* The PE section flags. */ 226 long pe_flags; 227}; 228 229/* An accessor macro for the pei_section_tdata structure. */ 230#define pei_section_data(abfd, sec) \ 231 ((struct pei_section_tdata *) coff_section_data ((abfd), (sec))->tdata) 232 233/* COFF linker hash table entries. */ 234 235struct coff_link_hash_entry 236{ 237 struct bfd_link_hash_entry root; 238 239 /* Symbol index in output file. Set to -1 initially. Set to -2 if 240 there is a reloc against this symbol. */ 241 long indx; 242 243 /* Symbol type. */ 244 unsigned short type; 245 246 /* Symbol class. */ 247 unsigned char class; 248 249 /* Number of auxiliary entries. */ 250 char numaux; 251 252 /* BFD to take auxiliary entries from. */ 253 bfd *auxbfd; 254 255 /* Pointer to array of auxiliary entries, if any. */ 256 union internal_auxent *aux; 257 258 /* Flag word; legal values follow. */ 259 unsigned short coff_link_hash_flags; 260 /* Symbol is a PE section symbol. */ 261#define COFF_LINK_HASH_PE_SECTION_SYMBOL (01) 262}; 263 264/* COFF linker hash table. */ 265 266struct coff_link_hash_table 267{ 268 struct bfd_link_hash_table root; 269 /* A pointer to information used to link stabs in sections. */ 270 PTR stab_info; 271}; 272 273/* Look up an entry in a COFF linker hash table. */ 274 275#define coff_link_hash_lookup(table, string, create, copy, follow) \ 276 ((struct coff_link_hash_entry *) \ 277 bfd_link_hash_lookup (&(table)->root, (string), (create), \ 278 (copy), (follow))) 279 280/* Traverse a COFF linker hash table. */ 281 282#define coff_link_hash_traverse(table, func, info) \ 283 (bfd_link_hash_traverse \ 284 (&(table)->root, \ 285 (boolean (*) PARAMS ((struct bfd_link_hash_entry *, PTR))) (func), \ 286 (info))) 287 288/* Get the COFF linker hash table from a link_info structure. */ 289 290#define coff_hash_table(p) ((struct coff_link_hash_table *) ((p)->hash)) 291 292/* Functions in coffgen.c. */ 293extern const bfd_target *coff_object_p PARAMS ((bfd *)); 294extern struct sec *coff_section_from_bfd_index PARAMS ((bfd *, int)); 295extern long coff_get_symtab_upper_bound PARAMS ((bfd *)); 296extern long coff_get_symtab PARAMS ((bfd *, asymbol **)); 297extern int coff_count_linenumbers PARAMS ((bfd *)); 298extern struct coff_symbol_struct *coff_symbol_from PARAMS ((bfd *, asymbol *)); 299extern boolean coff_renumber_symbols PARAMS ((bfd *, int *)); 300extern void coff_mangle_symbols PARAMS ((bfd *)); 301extern boolean coff_write_symbols PARAMS ((bfd *)); 302extern boolean coff_write_linenumbers PARAMS ((bfd *)); 303extern alent *coff_get_lineno PARAMS ((bfd *, asymbol *)); 304extern asymbol *coff_section_symbol PARAMS ((bfd *, char *)); 305extern boolean _bfd_coff_get_external_symbols PARAMS ((bfd *)); 306extern const char *_bfd_coff_read_string_table PARAMS ((bfd *)); 307extern boolean _bfd_coff_free_symbols PARAMS ((bfd *)); 308extern struct coff_ptr_struct *coff_get_normalized_symtab PARAMS ((bfd *)); 309extern long coff_get_reloc_upper_bound PARAMS ((bfd *, sec_ptr)); 310extern asymbol *coff_make_empty_symbol PARAMS ((bfd *)); 311extern void coff_print_symbol PARAMS ((bfd *, PTR filep, asymbol *, 312 bfd_print_symbol_type how)); 313extern void coff_get_symbol_info PARAMS ((bfd *, asymbol *, 314 symbol_info *ret)); 315extern boolean _bfd_coff_is_local_label_name PARAMS ((bfd *, const char *)); 316extern asymbol *coff_bfd_make_debug_symbol PARAMS ((bfd *, PTR, 317 unsigned long)); 318extern boolean coff_find_nearest_line PARAMS ((bfd *, 319 asection *, 320 asymbol **, 321 bfd_vma offset, 322 CONST char **filename_ptr, 323 CONST char **functionname_ptr, 324 unsigned int *line_ptr)); 325extern int coff_sizeof_headers PARAMS ((bfd *, boolean reloc)); 326extern boolean bfd_coff_reloc16_relax_section 327 PARAMS ((bfd *, asection *, struct bfd_link_info *, boolean *)); 328extern bfd_byte *bfd_coff_reloc16_get_relocated_section_contents 329 PARAMS ((bfd *, struct bfd_link_info *, struct bfd_link_order *, 330 bfd_byte *, boolean relocateable, asymbol **)); 331extern bfd_vma bfd_coff_reloc16_get_value PARAMS ((arelent *, 332 struct bfd_link_info *, 333 asection *)); 334extern void bfd_perform_slip PARAMS ((bfd *abfd, unsigned int slip, 335 asection *input_section, 336 bfd_vma val)); 337 338/* Functions and types in cofflink.c. */ 339 340#define STRING_SIZE_SIZE (4) 341 342/* We use a hash table to merge identical enum, struct, and union 343 definitions in the linker. */ 344 345/* Information we keep for a single element (an enum value, a 346 structure or union field) in the debug merge hash table. */ 347 348struct coff_debug_merge_element 349{ 350 /* Next element. */ 351 struct coff_debug_merge_element *next; 352 353 /* Name. */ 354 const char *name; 355 356 /* Type. */ 357 unsigned int type; 358 359 /* Symbol index for complex type. */ 360 long tagndx; 361}; 362 363/* A linked list of debug merge entries for a given name. */ 364 365struct coff_debug_merge_type 366{ 367 /* Next type with the same name. */ 368 struct coff_debug_merge_type *next; 369 370 /* Class of type. */ 371 int class; 372 373 /* Symbol index where this type is defined. */ 374 long indx; 375 376 /* List of elements. */ 377 struct coff_debug_merge_element *elements; 378}; 379 380/* Information we store in the debug merge hash table. */ 381 382struct coff_debug_merge_hash_entry 383{ 384 struct bfd_hash_entry root; 385 386 /* A list of types with this name. */ 387 struct coff_debug_merge_type *types; 388}; 389 390/* The debug merge hash table. */ 391 392struct coff_debug_merge_hash_table 393{ 394 struct bfd_hash_table root; 395}; 396 397/* Initialize a COFF debug merge hash table. */ 398 399#define coff_debug_merge_hash_table_init(table) \ 400 (bfd_hash_table_init (&(table)->root, _bfd_coff_debug_merge_hash_newfunc)) 401 402/* Free a COFF debug merge hash table. */ 403 404#define coff_debug_merge_hash_table_free(table) \ 405 (bfd_hash_table_free (&(table)->root)) 406 407/* Look up an entry in a COFF debug merge hash table. */ 408 409#define coff_debug_merge_hash_lookup(table, string, create, copy) \ 410 ((struct coff_debug_merge_hash_entry *) \ 411 bfd_hash_lookup (&(table)->root, (string), (create), (copy))) 412 413/* Information we keep for each section in the output file when doing 414 a relocateable link. */ 415 416struct coff_link_section_info 417{ 418 /* The relocs to be output. */ 419 struct internal_reloc *relocs; 420 /* For each reloc against a global symbol whose index was not known 421 when the reloc was handled, the global hash table entry. */ 422 struct coff_link_hash_entry **rel_hashes; 423}; 424 425/* Information that we pass around while doing the final link step. */ 426 427struct coff_final_link_info 428{ 429 /* General link information. */ 430 struct bfd_link_info *info; 431 /* Output BFD. */ 432 bfd *output_bfd; 433 /* Used to indicate failure in traversal routine. */ 434 boolean failed; 435 /* If doing "task linking" set only during the time when we want the 436 global symbol writer to convert the storage class of defined global 437 symbols from global to static. */ 438 boolean global_to_static; 439 /* Hash table for long symbol names. */ 440 struct bfd_strtab_hash *strtab; 441 /* When doing a relocateable link, an array of information kept for 442 each output section, indexed by the target_index field. */ 443 struct coff_link_section_info *section_info; 444 /* Symbol index of last C_FILE symbol (-1 if none). */ 445 long last_file_index; 446 /* Contents of last C_FILE symbol. */ 447 struct internal_syment last_file; 448 /* Symbol index of first aux entry of last .bf symbol with an empty 449 endndx field (-1 if none). */ 450 long last_bf_index; 451 /* Contents of last_bf_index aux entry. */ 452 union internal_auxent last_bf; 453 /* Hash table used to merge debug information. */ 454 struct coff_debug_merge_hash_table debug_merge; 455 /* Buffer large enough to hold swapped symbols of any input file. */ 456 struct internal_syment *internal_syms; 457 /* Buffer large enough to hold sections of symbols of any input file. */ 458 asection **sec_ptrs; 459 /* Buffer large enough to hold output indices of symbols of any 460 input file. */ 461 long *sym_indices; 462 /* Buffer large enough to hold output symbols for any input file. */ 463 bfd_byte *outsyms; 464 /* Buffer large enough to hold external line numbers for any input 465 section. */ 466 bfd_byte *linenos; 467 /* Buffer large enough to hold any input section. */ 468 bfd_byte *contents; 469 /* Buffer large enough to hold external relocs of any input section. */ 470 bfd_byte *external_relocs; 471 /* Buffer large enough to hold swapped relocs of any input section. */ 472 struct internal_reloc *internal_relocs; 473}; 474 475/* Most COFF variants have no way to record the alignment of a 476 section. This struct is used to set a specific alignment based on 477 the name of the section. */ 478 479struct coff_section_alignment_entry 480{ 481 /* The section name. */ 482 const char *name; 483 484 /* This is either (unsigned int) -1, indicating that the section 485 name must match exactly, or it is the number of letters which 486 must match at the start of the name. */ 487 unsigned int comparison_length; 488 489 /* These macros may be used to fill in the first two fields in a 490 structure initialization. */ 491#define COFF_SECTION_NAME_EXACT_MATCH(name) (name), ((unsigned int) -1) 492#define COFF_SECTION_NAME_PARTIAL_MATCH(name) (name), (sizeof (name) - 1) 493 494 /* Only use this entry if the default section alignment for this 495 target is at least that much (as a power of two). If this field 496 is COFF_ALIGNMENT_FIELD_EMPTY, it should be ignored. */ 497 unsigned int default_alignment_min; 498 499 /* Only use this entry if the default section alignment for this 500 target is no greater than this (as a power of two). If this 501 field is COFF_ALIGNMENT_FIELD_EMPTY, it should be ignored. */ 502 unsigned int default_alignment_max; 503 504#define COFF_ALIGNMENT_FIELD_EMPTY ((unsigned int) -1) 505 506 /* The desired alignment for this section (as a power of two). */ 507 unsigned int alignment_power; 508}; 509 510extern struct bfd_hash_entry *_bfd_coff_link_hash_newfunc 511 PARAMS ((struct bfd_hash_entry *, struct bfd_hash_table *, const char *)); 512extern boolean _bfd_coff_link_hash_table_init 513 PARAMS ((struct coff_link_hash_table *, bfd *, 514 struct bfd_hash_entry *(*) (struct bfd_hash_entry *, 515 struct bfd_hash_table *, 516 const char *))); 517extern struct bfd_link_hash_table *_bfd_coff_link_hash_table_create 518 PARAMS ((bfd *)); 519extern const char *_bfd_coff_internal_syment_name 520 PARAMS ((bfd *, const struct internal_syment *, char *)); 521extern boolean _bfd_coff_link_add_symbols 522 PARAMS ((bfd *, struct bfd_link_info *)); 523extern boolean _bfd_coff_final_link 524 PARAMS ((bfd *, struct bfd_link_info *)); 525extern struct internal_reloc *_bfd_coff_read_internal_relocs 526 PARAMS ((bfd *, asection *, boolean, bfd_byte *, boolean, 527 struct internal_reloc *)); 528extern boolean _bfd_coff_generic_relocate_section 529 PARAMS ((bfd *, struct bfd_link_info *, bfd *, asection *, bfd_byte *, 530 struct internal_reloc *, struct internal_syment *, asection **)); 531 532extern struct bfd_hash_entry *_bfd_coff_debug_merge_hash_newfunc 533 PARAMS ((struct bfd_hash_entry *, struct bfd_hash_table *, const char *)); 534extern boolean _bfd_coff_write_global_sym 535 PARAMS ((struct coff_link_hash_entry *, PTR)); 536extern boolean _bfd_coff_write_task_globals 537 PARAMS ((struct coff_link_hash_entry *, PTR)); 538extern boolean _bfd_coff_link_input_bfd 539 PARAMS ((struct coff_final_link_info *, bfd *)); 540extern boolean _bfd_coff_reloc_link_order 541 PARAMS ((bfd *, struct coff_final_link_info *, asection *, 542 struct bfd_link_order *)); 543 544 545#define coff_get_section_contents_in_window \ 546 _bfd_generic_get_section_contents_in_window 547 548/* Functions in xcofflink.c. */ 549 550extern long _bfd_xcoff_get_dynamic_symtab_upper_bound PARAMS ((bfd *)); 551extern long _bfd_xcoff_canonicalize_dynamic_symtab 552 PARAMS ((bfd *, asymbol **)); 553extern long _bfd_xcoff_get_dynamic_reloc_upper_bound PARAMS ((bfd *)); 554extern long _bfd_xcoff_canonicalize_dynamic_reloc 555 PARAMS ((bfd *, arelent **, asymbol **)); 556extern struct bfd_link_hash_table *_bfd_xcoff_bfd_link_hash_table_create 557 PARAMS ((bfd *)); 558extern boolean _bfd_xcoff_bfd_link_add_symbols 559 PARAMS ((bfd *, struct bfd_link_info *)); 560extern boolean _bfd_xcoff_bfd_final_link 561 PARAMS ((bfd *, struct bfd_link_info *)); 562extern boolean _bfd_ppc_xcoff_relocate_section 563 PARAMS ((bfd *, struct bfd_link_info *, bfd *, asection *, bfd_byte *, 564 struct internal_reloc *, struct internal_syment *, asection **)); 565 566/* Functions in coff-ppc.c. FIXME: These are called be pe.em in the 567 linker, and so should start with bfd and be declared in bfd.h. */ 568 569extern boolean ppc_allocate_toc_section PARAMS ((struct bfd_link_info *)); 570extern boolean ppc_process_before_allocation 571 PARAMS ((bfd *, struct bfd_link_info *)); 572 573/* And more taken from the source .. */ 574 575