bfd/targets.c

   1 /* Generic target-file-type support for the BFD library.
   2    Copyright 1990, 1991, 1992 Free Software Foundation, Inc.
   3    Written by Cygnus Support.
   4
   5 This file is part of BFD, the Binary File Descriptor library.
   6
   7 This program is free software; you can redistribute it and/or modify
   8 it under the terms of the GNU General Public License as published by
   9 the Free Software Foundation; either version 2 of the License, or
  10 (at your option) any later version.
  11
  12 This program is distributed in the hope that it will be useful,
  13 but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 GNU General Public License for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with this program; if not, write to the Free Software
  19 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.  */
  20
  21 #include "bfd.h"
  22 #include "sysdep.h"
  23 #include "libbfd.h"
  24
  25 /*
  26 SECTION
  27         Targets
  28
  29 DESCRIPTION
  30         Each port of BFD to a different machine requries the creation
  31         of a target back end. All the back end provides to the root
  32         part of BFD is a structure containing pointers to functions
  33         which perform certain low level operations on files. BFD
  34         translates the applications's requests through a pointer into
  35         calls to the back end routines.
  36
  37         When a file is opened with <<bfd_openr>>, its format and
  38         target are unknown. BFD uses various mechanisms to determine
  39         how to interpret the file. The operations performed are:
  40
  41         o First a BFD is created by calling the internal routine
  42         <<new_bfd>>, then <<bfd_find_target>> is called with the
  43         target string supplied to <<bfd_openr>> and the new BFD pointer.
  44
  45         o If a null target string was provided to <<bfd_find_target>>,
  46         it looks up the environment variable <<GNUTARGET>> and uses
  47         that as the target string.
  48
  49         o If the target string is still NULL, or the target string is
  50         <<default>>, then the first item in the target vector is used
  51         as the target type, and <<target_defaulted>> is set to
  52         cause <<bfd_check_format>> to loop through all the targets.
  53         @xref{bfd_target}.  @xref{Formats}.
  54
  55         o Otherwise, the elements in the target vector are inspected
  56         one by one, until a match on target name is found. When found,
  57         that is used.
  58
  59         o Otherwise the error <<invalid_target>> is returned to
  60         <<bfd_openr>>.
  61
  62         o <<bfd_openr>> attempts to open the file using
  63         <<bfd_open_file>>, and returns the BFD.
  64
  65         Once the BFD has been opened and the target selected, the file
  66         format may be determined. This is done by calling
  67         <<bfd_check_format>> on the BFD with a suggested format.
  68         If <<target_defaulted>> has been set, each possible target
  69         type is tried to see if it recognizes the specified format.  The
  70         routine returns <<true>> when the application guesses right.
  71 @menu
  72 @* bfd_target::
  73 @end menu
  74 */
  75
  76
  77 /*
  78
  79 INODE
  80         bfd_target,  , Targets, Targets
  81 DOCDD
  82 SUBSECTION
  83         bfd_target
  84
  85 DESCRIPTION
  86         This structure contains everything that BFD knows about a
  87         target. It includes things like its byte order, name, what
  88         routines to call to do various operations, etc.
  89
  90         Every BFD points to a target structure with its <<xvec>>
  91         member.
  92
  93         Shortcut for declaring fields which are prototyped function
  94         pointers, while avoiding anguish on compilers that don't
  95         support protos.
  96
  97 .#define SDEF(ret, name, arglist) \
  98 .                PROTO(ret,(*name),arglist)
  99 .#define SDEF_FMT(ret, name, arglist) \
 100 .                PROTO(ret,(*name[bfd_type_end]),arglist)
 101
 102         These macros are used to dispatch to functions through the
 103         bfd_target vector. They are used in a number of macros further
 104         down in @file{bfd.h}, and are also used when calling various
 105         routines by hand inside the BFD implementation.  The "arglist"
 106         argument must be parenthesized; it contains all the arguments
 107         to the called function.
 108
 109         They make the documentation (more) unpleasant to read, so if
 110         someone wants to fix this and not break the above, please do.
 111
 112 .#define BFD_SEND(bfd, message, arglist) \
 113 .               ((*((bfd)->xvec->message)) arglist)
 114
 115         For operations which index on the BFD format
 116
 117 .#define BFD_SEND_FMT(bfd, message, arglist) \
 118 .            (((bfd)->xvec->message[(int)((bfd)->format)]) arglist)
 119
 120         This is the struct which defines the type of BFD this is.  The
 121         <<xvec>> member of the struct <<bfd>> itself points here.  Each
 122         module that implements access to a different target under BFD,
 123         defines one of these.
 124
 125
 126         FIXME, these names should be rationalised with the names of
 127         the entry points which call them. Too bad we can't have one
 128         macro to define them both!
 129
 130 .typedef struct bfd_target
 131 .{
 132
 133 Identifies the kind of target, eg SunOS4, Ultrix, etc.
 134
 135 .  char *name;
 136
 137 The "flavour" of a back end is a general indication about the contents
 138 of a file.
 139
 140 .  enum target_flavour {
 141 .    bfd_target_unknown_flavour,
 142 .    bfd_target_aout_flavour,
 143 .    bfd_target_coff_flavour,
 144 .    bfd_target_elf_flavour,
 145 .    bfd_target_ieee_flavour,
 146 .    bfd_target_oasys_flavour,
 147 .    bfd_target_tekhex_flavour,
 148 .    bfd_target_srec_flavour,
 149 .    bfd_target_hppa_flavour} flavour;
 150
 151 The order of bytes within the data area of a file.
 152
 153 .  boolean byteorder_big_p;
 154
 155 The order of bytes within the header parts of a file.
 156
 157 .  boolean header_byteorder_big_p;
 158
 159 This is a mask of all the flags which an executable may have set -
 160 from the set <<NO_FLAGS>>, <<HAS_RELOC>>, ...<<D_PAGED>>.
 161
 162 .  flagword object_flags;
 163
 164 This is a mask of all the flags which a section may have set - from
 165 the set <<SEC_NO_FLAGS>>, <<SEC_ALLOC>>, ...<<SET_NEVER_LOAD>>.
 166
 167 .  flagword section_flags;
 168
 169 The character normally found at the front of a symbol
 170 (if any), perhaps _.
 171
 172 .  char symbol_leading_char;
 173
 174 The pad character for filenames within an archive header.
 175
 176 .  char ar_pad_char;
 177
 178 The maximum number of characters in an archive header.
 179
 180 . unsigned short ar_max_namelen;
 181
 182 The minimum alignment restriction for any section.
 183
 184 .  unsigned int align_power_min;
 185
 186 Entries for byte swapping for data. These are different to the other
 187 entry points, since they don't take BFD as first arg.  Certain other handlers
 188 could do the same.
 189
 190 .  SDEF (bfd_vma,      bfd_getx64, (bfd_byte *));
 191 .  SDEF (void,         bfd_putx64, (bfd_vma, bfd_byte *));
 192 .  SDEF (bfd_vma, bfd_getx32, (bfd_byte *));
 193 .  SDEF (void,         bfd_putx32, (bfd_vma, bfd_byte *));
 194 .  SDEF (bfd_vma, bfd_getx16, (bfd_byte *));
 195 .  SDEF (void,         bfd_putx16, (bfd_vma, bfd_byte *));
 196
 197 Byte swapping for the headers
 198
 199 .  SDEF (bfd_vma,   bfd_h_getx64, (bfd_byte *));
 200 .  SDEF (void,          bfd_h_putx64, (bfd_vma, bfd_byte *));
 201 .  SDEF (bfd_vma,  bfd_h_getx32, (bfd_byte *));
 202 .  SDEF (void,          bfd_h_putx32, (bfd_vma, bfd_byte *));
 203 .  SDEF (bfd_vma,  bfd_h_getx16, (bfd_byte *));
 204 .  SDEF (void,          bfd_h_putx16, (bfd_vma, bfd_byte *));
 205
 206 Format dependent routines, these turn into vectors of entry points
 207 within the target vector structure; one for each format to check.
 208
 209 Check the format of a file being read.  Return bfd_target * or zero.
 210
 211 .  SDEF_FMT (struct bfd_target *, _bfd_check_format, (bfd *));
 212
 213 Set the format of a file being written.
 214
 215 .  SDEF_FMT (boolean,            _bfd_set_format, (bfd *));
 216
 217 Write cached information into a file being written, at bfd_close.
 218
 219 .  SDEF_FMT (boolean,            _bfd_write_contents, (bfd *));
 220
 221 The following functions are defined in <<JUMP_TABLE>>. The idea is
 222 that the back end writer of <<foo>> names all the routines
 223 <<foo_>>@var{entry_point}, <<JUMP_TABLE>> will built the entries
 224 in this structure in the right order.
 225
 226 Core file entry points
 227
 228 .  SDEF (char *, _core_file_failing_command, (bfd *));
 229 .  SDEF (int,    _core_file_failing_signal, (bfd *));
 230 .  SDEF (boolean, _core_file_matches_executable_p, (bfd *, bfd *));
 231
 232 Archive entry points
 233
 234 . SDEF (boolean, _bfd_slurp_armap, (bfd *));
 235 . SDEF (boolean, _bfd_slurp_extended_name_table, (bfd *));
 236 . SDEF (void,   _bfd_truncate_arname, (bfd *, CONST char *, char *));
 237 . SDEF (boolean, write_armap, (bfd *arch,
 238 .                              unsigned int elength,
 239 .                              struct orl *map,
 240 .                              unsigned int orl_count,
 241 .                              int stridx));
 242
 243 Standard stuff.
 244
 245 .  SDEF (boolean, _close_and_cleanup, (bfd *));
 246 .  SDEF (boolean, _bfd_set_section_contents, (bfd *, sec_ptr, PTR,
 247 .                                            file_ptr, bfd_size_type));
 248 .  SDEF (boolean, _bfd_get_section_contents, (bfd *, sec_ptr, PTR,
 249 .                                            file_ptr, bfd_size_type));
 250 .  SDEF (boolean, _new_section_hook, (bfd *, sec_ptr));
 251
 252 Symbols and relocations
 253
 254 .  SDEF (unsigned int, _get_symtab_upper_bound, (bfd *));
 255 .  SDEF (unsigned int, _bfd_canonicalize_symtab,
 256 .           (bfd *, struct symbol_cache_entry **));
 257 .  SDEF (unsigned int, _get_reloc_upper_bound, (bfd *, sec_ptr));
 258 .  SDEF (unsigned int, _bfd_canonicalize_reloc, (bfd *, sec_ptr, arelent **,
 259 .                                               struct symbol_cache_entry**));
 260 .  SDEF (struct symbol_cache_entry  *, _bfd_make_empty_symbol, (bfd *));
 261 .  SDEF (void,     _bfd_print_symbol, (bfd *, PTR, struct symbol_cache_entry  *,
 262 .                                      bfd_print_symbol_type));
 263 .#define bfd_print_symbol(b,p,s,e) BFD_SEND(b, _bfd_print_symbol, (b,p,s,e))
 264 .  SDEF (alent *,   _get_lineno, (bfd *, struct symbol_cache_entry  *));
 265 .
 266 .  SDEF (boolean,   _bfd_set_arch_mach, (bfd *, enum bfd_architecture,
 267 .                                       unsigned long));
 268 .
 269 .  SDEF (bfd *,  openr_next_archived_file, (bfd *arch, bfd *prev));
 270 .  SDEF (boolean, _bfd_find_nearest_line,
 271 .        (bfd *abfd, struct sec  *section,
 272 .         struct symbol_cache_entry  **symbols,bfd_vma offset,
 273 .        CONST char **file, CONST char **func, unsigned int *line));
 274 .  SDEF (int,    _bfd_stat_arch_elt, (bfd *, struct stat *));
 275 .
 276 .  SDEF (int,    _bfd_sizeof_headers, (bfd *, boolean));
 277 .
 278 .  SDEF (void, _bfd_debug_info_start, (bfd *));
 279 .  SDEF (void, _bfd_debug_info_end, (bfd *));
 280 .  SDEF (void, _bfd_debug_info_accumulate, (bfd *, struct sec  *));
 281 .  SDEF (bfd_byte *, _bfd_get_relocated_section_contents, (bfd*,struct bfd_seclet *, bfd_byte *data));
 282 .  SDEF (boolean,_bfd_relax_section,(bfd *, struct sec *, struct symbol_cache_entry **));
 283 Special entry points for gdb to swap in coff symbol table parts
 284
 285 .  SDEF(void, _bfd_coff_swap_aux_in,(
 286 .       bfd            *abfd ,
 287 .       PTR             ext,
 288 .       int             type,
 289 .       int             class ,
 290 .       PTR             in));
 291 .
 292 .  SDEF(void, _bfd_coff_swap_sym_in,(
 293 .       bfd            *abfd ,
 294 .       PTR             ext,
 295 .       PTR             in));
 296 .
 297 .  SDEF(void, _bfd_coff_swap_lineno_in,  (
 298 .       bfd            *abfd,
 299 .       PTR            ext,
 300 .       PTR             in));
 301 .
 302
 303 Special entry points for gas to swap coff parts
 304
 305 . SDEF(unsigned int, _bfd_coff_swap_aux_out,(
 306 .       bfd     *abfd,
 307 .       PTR     in,
 308 .       int     type,
 309 .       int     class,
 310 .       PTR     ext));
 311 .
 312 . SDEF(unsigned int, _bfd_coff_swap_sym_out,(
 313 .      bfd      *abfd,
 314 .      PTR      in,
 315 .      PTR      ext));
 316 .
 317 . SDEF(unsigned int, _bfd_coff_swap_lineno_out,(
 318 .       bfd     *abfd,
 319 .       PTR     in,
 320 .       PTR     ext));
 321 .
 322 . SDEF(unsigned int, _bfd_coff_swap_reloc_out,(
 323 .       bfd     *abfd,
 324 .       PTR     src,
 325 .       PTR     dst));
 326 .
 327 . SDEF(unsigned int, _bfd_coff_swap_filehdr_out,(
 328 .       bfd     *abfd,
 329 .       PTR     in,
 330 .       PTR     out));
 331 .
 332 . SDEF(unsigned int, _bfd_coff_swap_aouthdr_out,(
 333 .       bfd     *abfd,
 334 .       PTR     in,
 335 .       PTR     out));
 336 .
 337 . SDEF(unsigned int, _bfd_coff_swap_scnhdr_out,(
 338 .       bfd     *abfd,
 339 .       PTR     in,
 340 .       PTR     out));
 341 .
 342 . {* See documentation on reloc types.  *}
 343 . SDEF (CONST struct reloc_howto_struct *,
 344 .       reloc_type_lookup,
 345 .       (bfd *abfd, bfd_reloc_code_real_type code));
 346 .
 347 . {* Complete and utter crock, currently used for the assembler
 348 .    when creating COFF files.  *}
 349 . SDEF (asymbol *, _bfd_make_debug_symbol, (
 350 .       bfd *abfd,
 351 .       void *ptr,
 352 .       unsigned long size));
 353
 354 Data for use by back-end routines; e.g., for a.out, includes whether
 355 this particular target maps ZMAGIC files contiguously or with text and
 356 data separated.  Could perhaps also be used to eliminate some of the
 357 above COFF-specific fields.
 358
 359 . PTR backend_data;
 360 .} bfd_target;
 361
 362 */
 363
 364 /* The default is to define a target_vector containing all the targets.
 365    By setting MINIMIZE=1 on the "make" command line, the user can change this
 366    to a vector containing just DEFAULT_VECTOR and any required
 367    traditional-core-file handler.  (This is to save space in the executables.)
 368    The config files can also override the default large vector by giving an
 369    explicit SELECT_VECS macro.  */
 370
 371 #if MINIMIZE && defined(DEFAULT_VECTOR) && !defined(SELECT_VECS)
 372 #ifdef TRAD_CORE
 373 #define SELECT_VECS &DEFAULT_VECTOR,&trad_core_vec
 374 #else
 375 #define SELECT_VECS &DEFAULT_VECTOR
 376 #endif
 377 #endif
 378
 379 /* All known xvecs.  They are listed a second time below, since
 380    we can't intermix extern's and initializers.  */
 381 extern bfd_target ecoff_little_vec;
 382 extern bfd_target ecoff_big_vec;
 383 extern bfd_target sunos_big_vec;
 384 extern bfd_target demo_64_vec;
 385 extern bfd_target srec_vec;
 386 extern bfd_target tekhex_vec;
 387 extern bfd_target a_out_adobe_vec;
 388 extern bfd_target b_out_vec_little_host;
 389 extern bfd_target b_out_vec_big_host;
 390 extern bfd_target icoff_little_vec;
 391 extern bfd_target icoff_big_vec;
 392 extern bfd_target elf_little_vec;
 393 extern bfd_target elf_big_vec;
 394 extern bfd_target ieee_vec;
 395 extern bfd_target oasys_vec;
 396 extern bfd_target m88kbcs_vec;
 397 extern bfd_target m68kcoff_vec;
 398 extern bfd_target i386coff_vec;
 399 extern bfd_target i386aout_vec;
 400 extern bfd_target i386linux_vec;
 401 extern bfd_target a29kcoff_big_vec;
 402 extern bfd_target trad_core_vec;
 403 extern bfd_target rs6000coff_vec;
 404 extern bfd_target h8300coff_vec;
 405 extern bfd_target z8kcoff_vec;
 406 extern bfd_target we32kcoff_vec;
 407 #ifdef hp9000s800
 408 extern bfd_target hppa_vec;
 409 #endif
 410
 411 #ifdef DEFAULT_VECTOR
 412 extern bfd_target DEFAULT_VECTOR;
 413 #endif
 414
 415 #ifdef SELECT_VECS
 416
 417 bfd_target *target_vector[] = {
 418         SELECT_VECS,
 419         0
 420 };
 421
 422 #else
 423
 424 bfd_target *target_vector[] = {
 425
 426 #ifdef DEFAULT_VECTOR
 427         &DEFAULT_VECTOR,
 428 #endif
 429
 430         &i386coff_vec,
 431         &i386aout_vec,
 432         &ecoff_little_vec,
 433         &ecoff_big_vec,
 434         &ieee_vec,
 435 #if 0
 436         /* We have no oasys tools anymore, so we can't test any of this
 437            anymore. If you want to test the stuff yourself, go ahead...
 438            steve@cygnus.com
 439            Worse, since there is no magic number for archives, there
 440            can annoying target mis-matches.  */
 441         &oasys_vec,
 442 #endif
 443         &sunos_big_vec,
 444 #ifdef HOST_64_BIT
 445         &demo_64_vec,   /* Only compiled if host has long-long support */
 446 #endif
 447         &h8300coff_vec,
 448         &z8kcoff_vec,
 449         &m88kbcs_vec,
 450         &srec_vec,
 451 /*      &tekhex_vec,*/
 452         &icoff_little_vec,
 453         &icoff_big_vec,
 454         &elf_little_vec,
 455         &elf_big_vec,
 456         &a_out_adobe_vec,
 457         &b_out_vec_little_host,
 458         &b_out_vec_big_host,
 459         &m68kcoff_vec,
 460         &a29kcoff_big_vec,
 461         &rs6000coff_vec,
 462 #ifdef hp9000s800
 463         &hppa_vec,
 464 #endif
 465         &we32kcoff_vec,
 466
 467 #ifdef  TRAD_CORE
 468         &trad_core_vec,
 469 #endif
 470         NULL, /* end of list marker */
 471 };
 472
 473 #endif
 474
 475 /* default_vector[0] contains either the address of the default vector,
 476    if there is one, or zero if there isn't.  */
 477
 478 bfd_target *default_vector[] = {
 479 #ifdef DEFAULT_VECTOR
 480         &DEFAULT_VECTOR,
 481 #endif
 482         0,
 483 };
 484
 485
 486
 487
 488 /*
 489 FUNCTION
 490         bfd_find_target
 491
 492 DESCRIPTION
 493         Returns a pointer to the transfer vector for the object target
 494         named target_name.  If target_name is NULL, chooses the one in
 495         the environment variable GNUTARGET; if that is null or not
 496         defined thenthe first entry in the target list is chosen.
 497         Passing in the string "default" or setting the environment
 498         variable to "default" will cause the first entry in the target
 499         list to be returned, and "target_defaulted" will be set in the
 500         BFD.  This causes <<bfd_check_format>> to loop over all the
 501         targets to find the one that matches the file being read.
 502
 503 SYNOPSIS
 504         bfd_target *bfd_find_target(CONST char *, bfd *);
 505 */
 506
 507 bfd_target *
 508 DEFUN(bfd_find_target,(target_name, abfd),
 509       CONST char *target_name AND
 510       bfd *abfd)
 511 {
 512   bfd_target **target;
 513   extern char *getenv ();
 514   CONST char *targname = (target_name ? target_name :
 515                           (CONST char *) getenv ("GNUTARGET"));
 516
 517   /* This is safe; the vector cannot be null */
 518   if (targname == NULL || !strcmp (targname, "default")) {
 519     abfd->target_defaulted = true;
 520     return abfd->xvec = target_vector[0];
 521   }
 522
 523   abfd->target_defaulted = false;
 524
 525   for (target = &target_vector[0]; *target != NULL; target++) {
 526     if (!strcmp (targname, (*target)->name))
 527       return abfd->xvec = *target;
 528   }
 529
 530   bfd_error = invalid_target;
 531   return NULL;
 532 }
 533
 534
 535 /*
 536 FUNCTION
 537         bfd_target_list
 538
 539 DESCRIPTION
 540         This function returns a freshly malloced NULL-terminated
 541         vector of the names of all the valid BFD targets. Do not
 542         modify the names
 543
 544 SYNOPSIS
 545         CONST char **bfd_target_list(void);
 546
 547 */
 548
 549 CONST char **
 550 DEFUN_VOID(bfd_target_list)
 551 {
 552   int vec_length= 0;
 553 #ifdef NATIVE_HPPAHPUX_COMPILER
 554   /* The native compiler on the HP9000/700 has a bug which causes it
 555      to loop endlessly when compiling this file.  This avoids it.  */
 556   volatile
 557 #endif
 558     bfd_target **target;
 559   CONST  char **name_list, **name_ptr;
 560
 561   for (target = &target_vector[0]; *target != NULL; target++)
 562     vec_length++;
 563
 564   name_ptr =
 565     name_list = (CONST char **) zalloc ((vec_length + 1) * sizeof (char **));
 566
 567   if (name_list == NULL) {
 568     bfd_error = no_memory;
 569     return NULL;
 570   }
 571
 572   for (target = &target_vector[0]; *target != NULL; target++)
 573     *(name_ptr++) = (*target)->name;
 574
 575   return name_list;
 576 }