Thu Aug 19 09:45:51 1993 David J. Mackenzie (djm@thepub.cygnus.com)
[external/binutils.git] / bfd / targets.c
1 /* Generic target-file-type support for the BFD library.
2    Copyright 1990, 1991, 1992, 1993 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         These macros are used to dispatch to functions through the
94         bfd_target vector. They are used in a number of macros further
95         down in @file{bfd.h}, and are also used when calling various
96         routines by hand inside the BFD implementation.  The "arglist"
97         argument must be parenthesized; it contains all the arguments
98         to the called function. 
99
100         They make the documentation (more) unpleasant to read, so if
101         someone wants to fix this and not break the above, please do.
102
103 .#define BFD_SEND(bfd, message, arglist) \
104 .               ((*((bfd)->xvec->message)) arglist)
105
106         For operations which index on the BFD format 
107
108 .#define BFD_SEND_FMT(bfd, message, arglist) \
109 .            (((bfd)->xvec->message[(int)((bfd)->format)]) arglist)
110
111         This is the struct which defines the type of BFD this is.  The
112         <<xvec>> member of the struct <<bfd>> itself points here.  Each
113         module that implements access to a different target under BFD,
114         defines one of these.
115
116
117         FIXME, these names should be rationalised with the names of
118         the entry points which call them. Too bad we can't have one
119         macro to define them both! 
120
121 .typedef struct bfd_target
122 .{
123
124 Identifies the kind of target, eg SunOS4, Ultrix, etc.
125
126 .  char *name;
127
128 The "flavour" of a back end is a general indication about the contents
129 of a file.
130
131 .  enum target_flavour {
132 .    bfd_target_unknown_flavour,
133 .    bfd_target_aout_flavour,
134 .    bfd_target_coff_flavour,
135 .    bfd_target_ecoff_flavour,
136 .    bfd_target_elf_flavour,
137 .    bfd_target_ieee_flavour,
138 .    bfd_target_nlm_flavour,
139 .    bfd_target_oasys_flavour,
140 .    bfd_target_tekhex_flavour,
141 .    bfd_target_srec_flavour,
142 .    bfd_target_hppa_flavour} flavour;
143
144 The order of bytes within the data area of a file.
145
146 .  boolean byteorder_big_p;
147
148 The order of bytes within the header parts of a file.
149
150 .  boolean header_byteorder_big_p;
151
152 This is a mask of all the flags which an executable may have set -
153 from the set <<NO_FLAGS>>, <<HAS_RELOC>>, ...<<D_PAGED>>.
154
155 .  flagword object_flags;       
156
157 This is a mask of all the flags which a section may have set - from
158 the set <<SEC_NO_FLAGS>>, <<SEC_ALLOC>>, ...<<SET_NEVER_LOAD>>.
159
160 .  flagword section_flags;
161
162 The character normally found at the front of a symbol 
163 (if any), perhaps _.
164
165 .  char symbol_leading_char;
166
167 The pad character for filenames within an archive header.
168
169 .  char ar_pad_char;            
170
171 The maximum number of characters in an archive header.
172
173 .  unsigned short ar_max_namelen;
174
175 The minimum alignment restriction for any section.
176
177 .  unsigned int align_power_min;
178
179 Entries for byte swapping for data. These are different to the other
180 entry points, since they don't take BFD as first arg.  Certain other handlers
181 could do the same.
182
183 .  bfd_vma      (*bfd_getx64) PARAMS ((bfd_byte *));
184 .  bfd_signed_vma (*bfd_getx_signed_64) PARAMS ((bfd_byte *));
185 .  void         (*bfd_putx64) PARAMS ((bfd_vma, bfd_byte *));
186 .  bfd_vma      (*bfd_getx32) PARAMS ((bfd_byte *));
187 .  bfd_signed_vma (*bfd_getx_signed_32) PARAMS ((bfd_byte *));
188 .  void         (*bfd_putx32) PARAMS ((bfd_vma, bfd_byte *));
189 .  bfd_vma      (*bfd_getx16) PARAMS ((bfd_byte *));
190 .  bfd_signed_vma (*bfd_getx_signed_16) PARAMS ((bfd_byte *));
191 .  void         (*bfd_putx16) PARAMS ((bfd_vma, bfd_byte *));
192
193 Byte swapping for the headers
194
195 .  bfd_vma      (*bfd_h_getx64) PARAMS ((bfd_byte *));
196 .  bfd_signed_vma (*bfd_h_getx_signed_64) PARAMS ((bfd_byte *));
197 .  void         (*bfd_h_putx64) PARAMS ((bfd_vma, bfd_byte *));
198 .  bfd_vma      (*bfd_h_getx32) PARAMS ((bfd_byte *));
199 .  bfd_signed_vma (*bfd_h_getx_signed_32) PARAMS ((bfd_byte *));
200 .  void         (*bfd_h_putx32) PARAMS ((bfd_vma, bfd_byte *));
201 .  bfd_vma      (*bfd_h_getx16) PARAMS ((bfd_byte *));
202 .  bfd_signed_vma (*bfd_h_getx_signed_16) PARAMS ((bfd_byte *));
203 .  void         (*bfd_h_putx16) PARAMS ((bfd_vma, bfd_byte *));
204
205 Format dependent routines: these are vectors of entry points
206 within the target vector structure, one for each format to check.
207
208 Check the format of a file being read.  Return bfd_target * or zero. 
209
210 .  struct bfd_target * (*_bfd_check_format[bfd_type_end]) PARAMS ((bfd *));
211
212 Set the format of a file being written.  
213
214 .  boolean             (*_bfd_set_format[bfd_type_end]) PARAMS ((bfd *));
215
216 Write cached information into a file being written, at bfd_close. 
217
218 .  boolean             (*_bfd_write_contents[bfd_type_end]) PARAMS ((bfd *));
219
220 The following functions are defined in <<JUMP_TABLE>>. The idea is
221 that the back end writer of <<foo>> names all the routines
222 <<foo_>>@var{entry_point}, <<JUMP_TABLE>> will built the entries
223 in this structure in the right order.
224
225 Core file entry points
226
227 .  char *   (*_core_file_failing_command) PARAMS ((bfd *));
228 .  int      (*_core_file_failing_signal) PARAMS ((bfd *));
229 .  boolean  (*_core_file_matches_executable_p) PARAMS ((bfd *, bfd *));
230
231 Archive entry points
232
233 .  boolean  (*_bfd_slurp_armap) PARAMS ((bfd *));
234 .  boolean  (*_bfd_slurp_extended_name_table) PARAMS ((bfd *));
235 .  void     (*_bfd_truncate_arname) PARAMS ((bfd *, CONST char *, char *));
236 .  boolean  (*write_armap) PARAMS ((bfd *arch, 
237 .                              unsigned int elength,
238 .                              struct orl *map,
239 .                              unsigned int orl_count, 
240 .                              int stridx));
241
242 Standard stuff.
243
244 .  boolean       (*_close_and_cleanup) PARAMS ((bfd *));
245 .  boolean       (*_bfd_set_section_contents) PARAMS ((bfd *, sec_ptr, PTR,
246 .                                            file_ptr, bfd_size_type));
247 .  boolean       (*_bfd_get_section_contents) PARAMS ((bfd *, sec_ptr, PTR, 
248 .                                            file_ptr, bfd_size_type));
249 .  boolean       (*_new_section_hook) PARAMS ((bfd *, sec_ptr));
250
251 Symbols and relocations
252
253 .  unsigned int  (*_get_symtab_upper_bound) PARAMS ((bfd *));
254 .  unsigned int  (*_bfd_canonicalize_symtab) PARAMS ((bfd *,
255 .                                              struct symbol_cache_entry **));
256 .  unsigned int  (*_get_reloc_upper_bound) PARAMS ((bfd *, sec_ptr));
257 .  unsigned int  (*_bfd_canonicalize_reloc) PARAMS ((bfd *, sec_ptr, arelent **,
258 .                                              struct symbol_cache_entry **));
259 .  struct symbol_cache_entry  *
260 .                (*_bfd_make_empty_symbol) PARAMS ((bfd *));
261 .  void          (*_bfd_print_symbol) PARAMS ((bfd *, PTR,
262 .                                      struct symbol_cache_entry *,
263 .                                      bfd_print_symbol_type));
264 .#define bfd_print_symbol(b,p,s,e) BFD_SEND(b, _bfd_print_symbol, (b,p,s,e))
265 .  void          (*_bfd_get_symbol_info) PARAMS ((bfd *,
266 .                                      struct symbol_cache_entry *,
267 .                                      symbol_info *));
268 .#define bfd_get_symbol_info(b,p,e) BFD_SEND(b, _bfd_get_symbol_info, (b,p,e))
269
270 .  alent *    (*_get_lineno) PARAMS ((bfd *, struct symbol_cache_entry *));
271 .
272 .  boolean    (*_bfd_set_arch_mach) PARAMS ((bfd *, enum bfd_architecture,
273 .                    unsigned long));
274 .
275 .  bfd *      (*openr_next_archived_file) PARAMS ((bfd *arch, bfd *prev));
276
277 .  boolean    (*_bfd_find_nearest_line) PARAMS ((bfd *abfd,
278 .                    struct sec *section, struct symbol_cache_entry **symbols,
279 .                    bfd_vma offset, CONST char **file, CONST char **func,
280 .                    unsigned int *line));
281
282 .  int        (*_bfd_stat_arch_elt) PARAMS ((bfd *, struct stat *));
283 .
284 .  int        (*_bfd_sizeof_headers) PARAMS ((bfd *, boolean));
285 .
286 .  void       (*_bfd_debug_info_start) PARAMS ((bfd *));
287 .  void       (*_bfd_debug_info_end) PARAMS ((bfd *));
288 .  void       (*_bfd_debug_info_accumulate) PARAMS ((bfd *, struct sec *));
289 .
290 .  bfd_byte * (*_bfd_get_relocated_section_contents) PARAMS ((bfd *,
291 .                    struct bfd_seclet *, bfd_byte *data,
292 .                    boolean relocateable));
293 .
294 .  boolean    (*_bfd_relax_section) PARAMS ((bfd *, struct sec *,
295 .                    struct symbol_cache_entry **));
296 .
297 .  boolean    (*_bfd_seclet_link) PARAMS ((bfd *, PTR data,
298 .                     boolean relocateable));
299
300 . {* See documentation on reloc types.  *}
301 . CONST struct reloc_howto_struct *
302 .       (*reloc_type_lookup) PARAMS ((bfd *abfd,
303 .                                     bfd_reloc_code_real_type code));
304 .
305 . {* Back-door to allow format-aware applications to create debug symbols
306 .    while using BFD for everything else.  Currently used by the assembler
307 .    when creating COFF files.  *}
308 . asymbol *  (*_bfd_make_debug_symbol) PARAMS ((
309 .       bfd *abfd,
310 .       void *ptr,
311 .       unsigned long size));
312
313 Data for use by back-end routines, which isn't generic enough to belong
314 in this structure.
315
316 . PTR backend_data;
317 .} bfd_target;
318
319 */
320
321 /* All known xvecs (even those that don't compile on all systems).
322    Alphabetized for easy reference.
323    They are listed a second time below, since
324    we can't intermix extern's and initializers.  */
325 extern bfd_target a29kcoff_big_vec;
326 extern bfd_target a_out_adobe_vec;
327 extern bfd_target aout_mips_big_vec;
328 extern bfd_target aout_mips_little_vec;
329 extern bfd_target b_out_vec_big_host;
330 extern bfd_target b_out_vec_little_host;
331 extern bfd_target bfd_elf32_big_generic_vec;
332 extern bfd_target bfd_elf32_bigmips_vec;
333 extern bfd_target bfd_elf32_hppa_vec;
334 extern bfd_target bfd_elf32_i386_vec;
335 extern bfd_target bfd_elf32_i860_vec;
336 extern bfd_target bfd_elf32_little_generic_vec;
337 extern bfd_target bfd_elf32_littlemips_vec;
338 extern bfd_target bfd_elf32_m68k_vec;
339 extern bfd_target bfd_elf32_m88k_vec;
340 extern bfd_target bfd_elf32_sparc_vec;
341 extern bfd_target bfd_elf64_big_generic_vec;
342 extern bfd_target bfd_elf64_little_generic_vec;
343 /* start-sanitize-v9 */
344 extern bfd_target bfd_elf64_sparc_vec;
345 /* end-sanitize-v9 */
346 extern bfd_target demo_64_vec;
347 extern bfd_target ecoff_big_vec;
348 extern bfd_target ecoff_little_vec;
349 extern bfd_target ecoffalpha_little_vec;
350 extern bfd_target h8300coff_vec;
351 extern bfd_target h8500coff_vec;
352 extern bfd_target host_aout_vec;
353 extern bfd_target hp300bsd_vec;
354 extern bfd_target hp300hpux_vec;
355 extern bfd_target hppa_vec;
356 extern bfd_target i386aout_vec;
357 extern bfd_target i386bsd_vec;
358 extern bfd_target i386coff_vec;
359 extern bfd_target i386linux_vec;
360 extern bfd_target i386lynx_vec;
361 extern bfd_target icoff_big_vec;
362 extern bfd_target icoff_little_vec;
363 extern bfd_target ieee_vec;
364 extern bfd_target m68kcoff_vec;
365 extern bfd_target m68kcoffun_vec;
366 extern bfd_target m88kbcs_vec;
367 extern bfd_target newsos3_vec;
368 extern bfd_target nlm32_big_generic_vec;
369 extern bfd_target nlm32_i386_vec;
370 extern bfd_target nlm32_little_generic_vec;
371 extern bfd_target nlm64_big_generic_vec;
372 extern bfd_target nlm64_little_generic_vec;
373 extern bfd_target oasys_vec;
374 extern bfd_target rs6000coff_vec;
375 extern bfd_target shcoff_vec;
376 extern bfd_target sunos_big_vec;
377 extern bfd_target tekhex_vec;
378 extern bfd_target we32kcoff_vec;
379 extern bfd_target z8kcoff_vec;
380
381 /* srec is always included.  */
382 extern bfd_target srec_vec;
383 extern bfd_target symbolsrec_vec;
384
385 /* All of the xvecs for core files.  */
386 extern bfd_target aix386_core_vec;
387 extern bfd_target hpux_core_vec;
388 extern bfd_target sco_core_vec;
389 extern bfd_target trad_core_vec;
390
391 bfd_target *target_vector[] = {
392
393 #ifdef SELECT_VECS
394
395         SELECT_VECS,
396
397 #else /* not SELECT_VECS */
398
399 #ifdef DEFAULT_VECTOR
400         &DEFAULT_VECTOR,
401 #endif
402         /* This list is alphabetized to make it easy to compare
403            with other vector lists -- the decls above and
404            the case statement in configure.in.
405            Vectors that don't compile on all systems, or aren't finished,
406            should have an entry here with #if 0 around it, to show that
407            it wasn't omitted by mistake.  */
408         &a29kcoff_big_vec,
409         &a_out_adobe_vec,
410 #if 0                           /* No one seems to use this.  */
411         &aout_mips_big_vec,
412 #endif
413         &aout_mips_little_vec,
414         &b_out_vec_big_host,
415         &b_out_vec_little_host,
416 #if 0                           /* No one seems to use this.  */
417         &bfd_elf32_big_generic_vec,
418         &bfd_elf32_bigmips_vec,
419 #endif
420 #if 0
421         &bfd_elf32_hppa_vec,
422 #endif
423         &bfd_elf32_i386_vec,
424         &bfd_elf32_i860_vec,
425 #if 0                           /* No one seems to use this.  */
426         &bfd_elf32_little_generic_vec,
427         &bfd_elf32_littlemips_vec,
428 #endif
429         &bfd_elf32_m68k_vec,
430         &bfd_elf32_m88k_vec,
431         &bfd_elf32_sparc_vec,
432 #ifdef BFD64                    /* No one seems to use this.  */
433         &bfd_elf64_big_generic_vec,
434         &bfd_elf64_little_generic_vec,
435 #endif
436 /* start-sanitize-v9 */
437 #if 0
438         &bfd_elf64_sparc_vec,
439 #endif
440 /* end-sanitize-v9 */
441 #ifdef BFD64
442         &demo_64_vec,   /* Only compiled if host has long-long support */
443 #endif
444         &ecoff_big_vec,
445         &ecoff_little_vec,
446 #if 0
447         &ecoffalpha_little_vec,
448 #endif
449         &h8300coff_vec,
450         &h8500coff_vec,
451 #if 0
452         &host_aout_vec,
453 #endif
454         &hp300bsd_vec,
455         &hp300hpux_vec,
456 #if defined (HOST_HPPAHPUX) || defined (HOST_HPPABSD)
457         &hppa_vec,
458 #endif
459         &i386aout_vec,
460         &i386bsd_vec,
461         &i386coff_vec,
462 #if 0
463         &i386linux_vec,
464 #endif
465         &i386lynx_vec,
466         &icoff_big_vec,
467         &icoff_little_vec,
468         &ieee_vec,
469         &m68kcoff_vec,
470         &m68kcoffun_vec,
471         &m88kbcs_vec,
472         &newsos3_vec,
473 #if 0                           /* No one seems to use this.  */
474         &nlm32_big_generic_vec,
475 #endif
476         &nlm32_i386_vec,
477 #if 0                           /* No one seems to use this.  */
478         &nlm32_little_generic_vec,
479 #endif
480 #ifdef BFD64
481         &nlm64_big_generic_vec,
482         &nlm64_little_generic_vec,
483 #endif
484 #if 0
485         /* We have no oasys tools anymore, so we can't test any of this
486            anymore. If you want to test the stuff yourself, go ahead...
487            steve@cygnus.com
488            Worse, since there is no magic number for archives, there
489            can be annoying target mis-matches.  */
490         &oasys_vec,
491 #endif
492         &rs6000coff_vec,
493         &shcoff_vec,
494         &sunos_big_vec,
495 #if 0
496         &tekhex_vec,
497 #endif
498         &we32kcoff_vec,
499         &z8kcoff_vec,
500
501 #endif /* not SELECT_VECS */
502
503 /* Always support S-records, for convenience.  */
504         &srec_vec,
505         &symbolsrec_vec,
506
507 /* Add any required traditional-core-file-handler.  */
508
509 #ifdef AIX386_CORE
510         &aix386_core_vec,
511 #endif
512 #ifdef HPUX_CORE
513         &hpux_core_vec,
514 #endif
515 #ifdef  SCO_CORE
516         &sco_core_vec,
517 #endif
518 #ifdef  TRAD_CORE
519         &trad_core_vec,
520 #endif
521
522         NULL /* end of list marker */
523 };
524
525 /* default_vector[0] contains either the address of the default vector,
526    if there is one, or zero if there isn't.  */
527
528 bfd_target *default_vector[] = {
529 #ifdef DEFAULT_VECTOR
530         &DEFAULT_VECTOR,
531 #endif
532         NULL
533 };
534
535
536
537
538 /*
539 FUNCTION
540         bfd_find_target
541
542 DESCRIPTION
543         Returns a pointer to the transfer vector for the object target
544         named target_name.  If target_name is NULL, chooses the one in
545         the environment variable GNUTARGET; if that is null or not
546         defined thenthe first entry in the target list is chosen.
547         Passing in the string "default" or setting the environment
548         variable to "default" will cause the first entry in the target
549         list to be returned, and "target_defaulted" will be set in the
550         BFD.  This causes <<bfd_check_format>> to loop over all the
551         targets to find the one that matches the file being read.   
552
553 SYNOPSIS
554         bfd_target *bfd_find_target(CONST char *, bfd *);
555 */
556
557 bfd_target *
558 DEFUN(bfd_find_target,(target_name, abfd),
559       CONST char *target_name AND
560       bfd *abfd)
561 {
562   bfd_target **target;
563   extern char *getenv ();
564   CONST char *targname = (target_name ? target_name : 
565                           (CONST char *) getenv ("GNUTARGET"));
566
567   /* This is safe; the vector cannot be null */
568   if (targname == NULL || !strcmp (targname, "default")) {
569     abfd->target_defaulted = true;
570     return abfd->xvec = target_vector[0];
571   }
572
573   abfd->target_defaulted = false;
574
575   for (target = &target_vector[0]; *target != NULL; target++) {
576     if (!strcmp (targname, (*target)->name))
577       return abfd->xvec = *target;
578   }
579
580   bfd_error = invalid_target;
581   return NULL;
582 }
583
584
585 /*
586 FUNCTION
587         bfd_target_list
588
589 DESCRIPTION
590         This function returns a freshly malloced NULL-terminated
591         vector of the names of all the valid BFD targets. Do not
592         modify the names 
593
594 SYNOPSIS
595         CONST char **bfd_target_list(void);
596
597 */
598
599 CONST char **
600 DEFUN_VOID(bfd_target_list)
601 {
602   int vec_length= 0;
603 #ifdef NATIVE_HPPAHPUX_COMPILER
604   /* The native compiler on the HP9000/700 has a bug which causes it
605      to loop endlessly when compiling this file.  This avoids it.  */
606   volatile
607 #endif
608     bfd_target **target;
609   CONST  char **name_list, **name_ptr;
610
611   for (target = &target_vector[0]; *target != NULL; target++)
612     vec_length++;
613
614   name_ptr = 
615     name_list = (CONST char **) zalloc ((vec_length + 1) * sizeof (char **));
616
617   if (name_list == NULL) {
618     bfd_error = no_memory;
619     return NULL;
620   }
621
622   for (target = &target_vector[0]; *target != NULL; target++)
623     *(name_ptr++) = (*target)->name;
624
625   return name_list;
626 }