Add changes from customer since last work.
[platform/upstream/binutils.git] / bfd / libaout.h
1 /* BFD back-end data structures for a.out (and similar) files.
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 #ifndef LIBAOUT_H
22 #define LIBAOUT_H
23
24 /* We try to encapsulate the differences in the various a.out file
25    variants in a few routines, and otherwise share large masses of code.
26    This means we only have to fix bugs in one place, most of the time.  */
27
28 #include "bfdlink.h"
29
30 /* Parameterize the a.out code based on whether it is being built
31    for a 32-bit architecture or a 64-bit architecture.  */
32 #if ARCH_SIZE==64
33 #define GET_WORD bfd_h_get_64
34 #define GET_SWORD bfd_h_get_signed_64
35 #define PUT_WORD bfd_h_put_64
36 #ifndef NAME
37 #define NAME(x,y) CAT3(x,_64_,y)
38 #endif
39 #define JNAME(x) CAT(x,_64)
40 #define BYTES_IN_WORD 8
41 #else /* ARCH_SIZE == 32 */
42 #define GET_WORD bfd_h_get_32
43 #define GET_SWORD bfd_h_get_signed_32
44 #define PUT_WORD bfd_h_put_32
45 #ifndef NAME
46 #define NAME(x,y) CAT3(x,_32_,y)
47 #endif
48 #define JNAME(x) CAT(x,_32)
49 #define BYTES_IN_WORD 4
50 #endif /* ARCH_SIZE==32 */
51
52 /* Declare at file level, since used in parameter lists, which have
53    weird scope.  */
54 struct external_exec;
55 struct external_nlist;
56 struct reloc_ext_external;
57 struct reloc_std_external;
58 \f
59 /* a.out backend linker hash table entries.  */
60
61 struct aout_link_hash_entry
62 {
63   struct bfd_link_hash_entry root;
64   /* Whether this symbol has been written out.  */
65   boolean written;
66   /* Symbol index in output file.  */
67   int indx;
68 };
69
70 /* a.out backend linker hash table.  */
71
72 struct aout_link_hash_table
73 {
74   struct bfd_link_hash_table root;
75 };
76
77 /* Look up an entry in an a.out link hash table.  */
78
79 #define aout_link_hash_lookup(table, string, create, copy, follow) \
80   ((struct aout_link_hash_entry *) \
81    bfd_link_hash_lookup (&(table)->root, (string), (create), (copy), (follow)))
82
83 /* Traverse an a.out link hash table.  */
84
85 #define aout_link_hash_traverse(table, func, info)                      \
86   (bfd_link_hash_traverse                                               \
87    (&(table)->root,                                                     \
88     (boolean (*) PARAMS ((struct bfd_link_hash_entry *, PTR))) (func),  \
89     (info)))
90
91 /* Get the a.out link hash table from the info structure.  This is
92    just a cast.  */
93
94 #define aout_hash_table(p) ((struct aout_link_hash_table *) ((p)->hash))
95 \f
96 /* Back-end information for various a.out targets.  */
97 struct aout_backend_data
98 {
99   /* Are ZMAGIC files mapped contiguously?  If so, the text section may
100      need more padding, if the segment size (granularity for memory access
101      control) is larger than the page size.  */
102   unsigned char zmagic_mapped_contiguous;
103   /* If this flag is set, ZMAGIC/NMAGIC file headers get mapped in with the
104      text section, which starts immediately after the file header.
105      If not, the text section starts on the next page.  */
106   unsigned char text_includes_header;
107
108   /* The value to pass to N_SET_FLAGS.  */
109   unsigned char exec_hdr_flags;
110
111   /* If the text section VMA isn't specified, and we need an absolute
112      address, use this as the default.  If we're producing a relocatable
113      file, zero is always used.  */
114   /* ?? Perhaps a callback would be a better choice?  Will this do anything
115      reasonable for a format that handles multiple CPUs with different
116      load addresses for each?  */
117   bfd_vma default_text_vma;
118
119   /* Callback for setting the page and segment sizes, if they can't be
120      trivially determined from the architecture.  */
121   boolean (*set_sizes) PARAMS ((bfd *));
122
123   /* zmagic files only. For go32, the length of the exec header contributes
124      to the size of the text section in the file for alignment purposes but
125      does *not* get counted in the length of the text section. */
126   unsigned char exec_header_not_counted;
127
128   /* Callback from the add symbols phase of the linker code to handle
129      a dynamic object.  */
130   boolean (*add_dynamic_symbols) PARAMS ((bfd *, struct bfd_link_info *));
131
132   /* Callback from the add symbols phase of the linker code to handle
133      adding a single symbol to the global linker hash table.  */
134   boolean (*add_one_symbol) PARAMS ((struct bfd_link_info *, bfd *,
135                                      const char *, flagword, asection *,
136                                      bfd_vma, const char *, boolean,
137                                      boolean,
138                                      struct bfd_link_hash_entry **));
139
140   /* Called to handle linking a dynamic object.  */
141   boolean (*link_dynamic_object) PARAMS ((struct bfd_link_info *, bfd *));
142
143   /* Called for each global symbol being written out by the linker.
144      This should write out the dynamic symbol information.  */
145   boolean (*write_dynamic_symbol) PARAMS ((bfd *, struct bfd_link_info *,
146                                            struct aout_link_hash_entry *));
147
148   /* This callback is called by the linker for each reloc against an
149      external symbol.  RELOC is a pointer to the unswapped reloc.  If
150      *SKIP is set to true, the reloc will be skipped.  */
151   boolean (*check_dynamic_reloc) PARAMS ((struct bfd_link_info *info,
152                                           bfd *input_bfd,
153                                           asection *input_section,
154                                           struct aout_link_hash_entry *h,
155                                           PTR reloc, boolean *skip));
156
157   /* Called at the end of a link to finish up any dynamic linking
158      information.  */
159   boolean (*finish_dynamic_link) PARAMS ((bfd *, struct bfd_link_info *));
160 };
161 #define aout_backend_info(abfd) \
162         ((CONST struct aout_backend_data *)((abfd)->xvec->backend_data))
163
164 /* This is the layout in memory of a "struct exec" while we process it.
165    All 'lengths' are given as a number of bytes.
166    All 'alignments' are for relinkable files only;  an alignment of
167         'n' indicates the corresponding segment must begin at an
168         address that is a multiple of (2**n).  */
169
170 struct internal_exec
171 {
172     long a_info;                /* Magic number and flags, packed */
173     bfd_vma a_text;             /* length of text, in bytes  */
174     bfd_vma a_data;             /* length of data, in bytes  */
175     bfd_vma a_bss;              /* length of uninitialized data area in mem */
176     bfd_vma a_syms;             /* length of symbol table data in file */
177     bfd_vma a_entry;            /* start address */
178     bfd_vma a_trsize;           /* length of text's relocation info, in bytes */
179     bfd_vma a_drsize;           /* length of data's relocation info, in bytes */
180     /* Added for i960 */
181     bfd_vma a_tload;            /* Text runtime load address */
182     bfd_vma a_dload;            /* Data runtime load address */
183     unsigned char a_talign;     /* Alignment of text segment */
184     unsigned char a_dalign;     /* Alignment of data segment */
185     unsigned char a_balign;     /* Alignment of bss segment */
186     char a_relaxable;           /* Enough info for linker relax */
187 };
188
189 /* Magic number is written 
190 < MSB        >
191 3130292827262524232221201918171615141312111009080706050403020100
192 < FLAGS      >< MACHINE TYPE ><  MAGIC NUMBER                  >
193 */
194 /* Magic number for NetBSD is
195 <MSB         >
196 3130292827262524232221201918171615141312111009080706050403020100
197 < FLAGS    ><                  ><  MAGIC NUMBER                >
198 */
199
200 enum machine_type {
201   M_UNKNOWN = 0,
202   M_68010 = 1,
203   M_68020 = 2,
204   M_SPARC = 3,
205   /* skip a bunch so we don't run into any of suns numbers */
206   /* make these up for the ns32k*/
207   M_NS32032 = (64),             /* ns32032 running ? */
208   M_NS32532 = (64 + 5),         /* ns32532 running mach */
209
210   M_386 = 100,
211   M_29K = 101,          /* AMD 29000 */
212   M_386_DYNIX = 102,    /* Sequent running dynix */
213   M_ARM = 103,          /* Advanced Risc Machines ARM */
214   M_386_NETBSD = 134,   /* NetBSD/i386 binary */
215   M_68K_NETBSD = 135,   /* NetBSD/m68k binary */
216   M_532_NETBSD = 137,   /* NetBSD/ns32k binary */
217   M_SPARC_NETBSD = 138, /* NetBSD/sparc binary */
218   M_MIPS1 = 151,        /* MIPS R2000/R3000 binary */
219   M_MIPS2 = 152,        /* MIPS R4000/R6000 binary */
220   M_HP200 = 200,        /* HP 200 (68010) BSD binary */
221   M_HP300 = (300 % 256), /* HP 300 (68020+68881) BSD binary */
222   M_HPUX = (0x20c % 256)/* HP 200/300 HPUX binary */
223 /* start-sanitize-rce */
224   M_RCE = 155,          /* Motorola RCE binary */
225 /* end-sanitize-rce */
226 };
227
228 #define N_DYNAMIC(exec) ((exec).a_info & 0x80000000)
229
230 #ifndef N_MAGIC
231 # define N_MAGIC(exec) ((exec).a_info & 0xffff)
232 #endif
233
234 #ifndef N_MACHTYPE
235 # define N_MACHTYPE(exec) ((enum machine_type)(((exec).a_info >> 16) & 0xff))
236 #endif
237
238 #ifndef N_FLAGS
239 # define N_FLAGS(exec) (((exec).a_info >> 24) & 0xff)
240 #endif
241
242 #ifndef N_SET_INFO
243 # define N_SET_INFO(exec, magic, type, flags) \
244 ((exec).a_info = ((magic) & 0xffff) \
245  | (((int)(type) & 0xff) << 16) \
246  | (((flags) & 0xff) << 24))
247 #endif
248
249 #ifndef N_SET_DYNAMIC
250 # define N_SET_DYNAMIC(exec, dynamic) \
251 ((exec).a_info = (dynamic) ? ((exec).a_info | 0x80000000) : \
252 ((exec).a_info & 0x7fffffff))
253 #endif
254
255 #ifndef N_SET_MAGIC
256 # define N_SET_MAGIC(exec, magic) \
257 ((exec).a_info = (((exec).a_info & 0xffff0000) | ((magic) & 0xffff)))
258 #endif
259
260 #ifndef N_SET_MACHTYPE
261 # define N_SET_MACHTYPE(exec, machtype) \
262 ((exec).a_info = \
263  ((exec).a_info&0xff00ffff) | ((((int)(machtype))&0xff) << 16))
264 #endif
265
266 #ifndef N_SET_FLAGS
267 # define N_SET_FLAGS(exec, flags) \
268 ((exec).a_info = \
269  ((exec).a_info&0x00ffffff) | (((flags) & 0xff) << 24))
270 #endif
271
272 typedef struct aout_symbol {
273   asymbol symbol;
274   short desc;
275   char other;
276   unsigned char type;
277 } aout_symbol_type;
278
279 /* The `tdata' struct for all a.out-like object file formats.
280    Various things depend on this struct being around any time an a.out
281    file is being handled.  An example is dbxread.c in GDB.  */
282
283 struct aoutdata {
284   struct internal_exec *hdr;            /* exec file header */
285   aout_symbol_type *symbols;            /* symtab for input bfd */
286   
287   /* For ease, we do this */
288   asection *textsec;
289   asection *datasec;
290   asection *bsssec;
291
292   /* We remember these offsets so that after check_file_format, we have
293      no dependencies on the particular format of the exec_hdr.  */
294   file_ptr sym_filepos;
295   file_ptr str_filepos;
296
297   /* Size of a relocation entry in external form */
298   unsigned reloc_entry_size;
299
300   /* Size of a symbol table entry in external form */
301   unsigned symbol_entry_size;
302
303   /* Page size - needed for alignment of demand paged files. */
304   unsigned long page_size;
305
306   /* Segment size - needed for alignment of demand paged files. */
307   unsigned long segment_size;
308
309   /* Zmagic disk block size - need to align the start of the text
310      section in ZMAGIC binaries.  Normally the same as page_size.  */
311   unsigned long zmagic_disk_block_size;
312
313   unsigned exec_bytes_size;
314   unsigned vma_adjusted : 1;
315
316   /* used when a bfd supports several highly similar formats */
317   enum
318     {
319       default_format = 0,
320       /* Used on HP 9000/300 running HP/UX.  See hp300hpux.c.  */
321       gnu_encap_format,
322       /* Used on Linux, 386BSD, etc.  See include/aout/aout64.h.  */
323       q_magic_format
324     } subformat;
325
326   enum
327     {
328       undecided_magic = 0,
329       z_magic,
330       o_magic,
331       n_magic
332     } magic;
333
334   /* The external symbol information.  */
335   struct external_nlist *external_syms;
336   bfd_size_type external_sym_count;
337   char *external_strings;
338   bfd_size_type external_string_size;
339   struct aout_link_hash_entry **sym_hashes;
340
341   /* A pointer for shared library information.  */
342   PTR dynamic_info;
343 };
344
345 struct  aout_data_struct {
346     struct aoutdata a;
347     struct internal_exec e;
348 };
349
350 #define adata(bfd)              ((bfd)->tdata.aout_data->a)
351 #define exec_hdr(bfd)           (adata(bfd).hdr)
352 #define obj_aout_symbols(bfd)   (adata(bfd).symbols)
353 #define obj_textsec(bfd)        (adata(bfd).textsec)
354 #define obj_datasec(bfd)        (adata(bfd).datasec)
355 #define obj_bsssec(bfd)         (adata(bfd).bsssec)
356 #define obj_sym_filepos(bfd)    (adata(bfd).sym_filepos)
357 #define obj_str_filepos(bfd)    (adata(bfd).str_filepos)
358 #define obj_reloc_entry_size(bfd) (adata(bfd).reloc_entry_size)
359 #define obj_symbol_entry_size(bfd) (adata(bfd).symbol_entry_size)
360 #define obj_aout_subformat(bfd) (adata(bfd).subformat)
361 #define obj_aout_external_syms(bfd) (adata(bfd).external_syms)
362 #define obj_aout_external_sym_count(bfd) (adata(bfd).external_sym_count)
363 #define obj_aout_external_strings(bfd) (adata(bfd).external_strings)
364 #define obj_aout_external_string_size(bfd) (adata(bfd).external_string_size)
365 #define obj_aout_sym_hashes(bfd) (adata(bfd).sym_hashes)
366 #define obj_aout_dynamic_info(bfd) (adata(bfd).dynamic_info)
367
368 /* We take the address of the first element of an asymbol to ensure that the
369    macro is only ever applied to an asymbol */
370 #define aout_symbol(asymbol) ((aout_symbol_type *)(&(asymbol)->the_bfd))
371
372 /* Information we keep for each a.out section.  This is currently only
373    used by the a.out backend linker.  */
374
375 struct aout_section_data_struct
376 {
377   /* The unswapped relocation entries for this section.  */
378   PTR relocs;
379 };
380
381 #define aout_section_data(s) \
382   ((struct aout_section_data_struct *) (s)->used_by_bfd)
383
384 /* Prototype declarations for functions defined in aoutx.h  */
385
386 boolean
387 NAME(aout,squirt_out_relocs) PARAMS ((bfd *abfd, asection *section));
388
389 boolean
390 NAME(aout,make_sections) PARAMS ((bfd *));
391
392 const bfd_target *
393 NAME(aout,some_aout_object_p) PARAMS ((bfd *abfd,
394                                        struct internal_exec *execp,
395                                        const bfd_target *(*callback)(bfd *)));
396
397 boolean
398 NAME(aout,mkobject) PARAMS ((bfd *abfd));
399
400 enum machine_type
401 NAME(aout,machine_type) PARAMS ((enum bfd_architecture arch,
402                                  unsigned long machine,
403                                  boolean *unknown));
404
405 boolean
406 NAME(aout,set_arch_mach) PARAMS ((bfd *abfd, enum bfd_architecture arch,
407                                   unsigned long machine));
408
409 boolean
410 NAME(aout,new_section_hook) PARAMS ((bfd *abfd, asection *newsect));
411
412 boolean
413 NAME(aout,set_section_contents) PARAMS ((bfd *abfd, sec_ptr section,
414                          PTR location, file_ptr offset, bfd_size_type count));
415
416 asymbol *
417 NAME(aout,make_empty_symbol) PARAMS ((bfd *abfd));
418
419 boolean
420 NAME(aout,translate_symbol_table) PARAMS ((bfd *, aout_symbol_type *,
421                                            struct external_nlist *,
422                                            bfd_size_type, char *,
423                                            bfd_size_type,
424                                            boolean dynamic));
425
426 boolean
427 NAME(aout,slurp_symbol_table) PARAMS ((bfd *abfd));
428
429 boolean
430 NAME(aout,write_syms) PARAMS ((bfd *abfd));
431
432 void
433 NAME(aout,reclaim_symbol_table) PARAMS ((bfd *abfd));
434
435 long
436 NAME(aout,get_symtab_upper_bound) PARAMS ((bfd *abfd));
437
438 long
439 NAME(aout,get_symtab) PARAMS ((bfd *abfd, asymbol **location));
440
441 void
442 NAME(aout,swap_ext_reloc_in) PARAMS ((bfd *, struct reloc_ext_external *,
443                                       arelent *, asymbol **));
444 void
445 NAME(aout,swap_std_reloc_in) PARAMS ((bfd *, struct reloc_std_external *,
446                                       arelent *, asymbol **));
447
448 boolean
449 NAME(aout,slurp_reloc_table) PARAMS ((bfd *abfd, sec_ptr asect,
450                                       asymbol **symbols));
451
452 long
453 NAME(aout,canonicalize_reloc) PARAMS ((bfd *abfd, sec_ptr section,
454                                        arelent **relptr, asymbol **symbols));
455
456 long
457 NAME(aout,get_reloc_upper_bound) PARAMS ((bfd *abfd, sec_ptr asect));
458
459 void
460 NAME(aout,reclaim_reloc) PARAMS ((bfd *ignore_abfd, sec_ptr ignore));
461
462 alent *
463 NAME(aout,get_lineno) PARAMS ((bfd *ignore_abfd, asymbol *ignore_symbol));
464
465 void
466 NAME(aout,print_symbol) PARAMS ((bfd *ignore_abfd, PTR file,
467                             asymbol *symbol, bfd_print_symbol_type how));
468
469 void
470 NAME(aout,get_symbol_info) PARAMS ((bfd *ignore_abfd,
471                            asymbol *symbol, symbol_info *ret));
472
473 boolean
474 NAME(aout,find_nearest_line) PARAMS ((bfd *abfd, asection *section,
475       asymbol **symbols, bfd_vma offset, CONST char **filename_ptr,
476       CONST char **functionname_ptr, unsigned int *line_ptr));
477
478 int
479 NAME(aout,sizeof_headers) PARAMS ((bfd *abfd, boolean exec));
480
481 boolean
482 NAME(aout,adjust_sizes_and_vmas) PARAMS ((bfd *abfd,
483        bfd_size_type *text_size, file_ptr *text_end));
484
485 void
486 NAME(aout,swap_exec_header_in) PARAMS ((bfd *abfd,
487        struct external_exec *raw_bytes, struct internal_exec *execp));
488
489 void
490 NAME(aout,swap_exec_header_out) PARAMS ((bfd *abfd,
491        struct internal_exec *execp, struct external_exec *raw_bytes));
492
493 struct bfd_hash_entry *
494 NAME(aout,link_hash_newfunc)
495   PARAMS ((struct bfd_hash_entry *, struct bfd_hash_table *, const char *));
496
497 boolean
498 NAME(aout,link_hash_table_init)
499      PARAMS ((struct aout_link_hash_table *, bfd *,
500               struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
501                                           struct bfd_hash_table *,
502                                           const char *)));
503
504 struct bfd_link_hash_table *
505 NAME(aout,link_hash_table_create) PARAMS ((bfd *));
506
507 boolean
508 NAME(aout,link_add_symbols) PARAMS ((bfd *, struct bfd_link_info *));
509
510 boolean
511 NAME(aout,final_link) PARAMS ((bfd *, struct bfd_link_info *,
512                                void (*) (bfd *, file_ptr *, file_ptr *,
513                                          file_ptr *)));
514
515 boolean
516 NAME(aout,bfd_free_cached_info) PARAMS ((bfd *));
517
518 /* Prototypes for functions in stab-syms.c. */
519
520 CONST char *
521 aout_stab_name PARAMS ((int code));
522
523 /* A.out uses the generic versions of these routines... */
524
525 #define aout_32_get_section_contents    _bfd_generic_get_section_contents
526
527 #define aout_64_get_section_contents    _bfd_generic_get_section_contents
528 #ifndef NO_WRITE_HEADER_KLUDGE
529 #define NO_WRITE_HEADER_KLUDGE 0
530 #endif
531
532 #ifndef aout_32_bfd_is_local_label
533 #define aout_32_bfd_is_local_label bfd_generic_is_local_label
534 #endif
535
536 #ifndef WRITE_HEADERS
537 #define WRITE_HEADERS(abfd, execp)                                            \
538       {                                                                       \
539         bfd_size_type text_size; /* dummy vars */                             \
540         file_ptr text_end;                                                    \
541         if (adata(abfd).magic == undecided_magic)                             \
542           NAME(aout,adjust_sizes_and_vmas) (abfd, &text_size, &text_end);     \
543                                                                               \
544         execp->a_syms = bfd_get_symcount (abfd) * EXTERNAL_NLIST_SIZE;        \
545         execp->a_entry = bfd_get_start_address (abfd);                        \
546                                                                               \
547         execp->a_trsize = ((obj_textsec (abfd)->reloc_count) *                \
548                            obj_reloc_entry_size (abfd));                      \
549         execp->a_drsize = ((obj_datasec (abfd)->reloc_count) *                \
550                            obj_reloc_entry_size (abfd));                      \
551         NAME(aout,swap_exec_header_out) (abfd, execp, &exec_bytes);           \
552                                                                               \
553         if (bfd_seek (abfd, (file_ptr) 0, SEEK_SET) != 0) return false;       \
554         if (bfd_write ((PTR) &exec_bytes, 1, EXEC_BYTES_SIZE, abfd)           \
555             != EXEC_BYTES_SIZE)                                               \
556           return false;                                                       \
557         /* Now write out reloc info, followed by syms and strings */          \
558                                                                               \
559         if (bfd_get_outsymbols (abfd) != (asymbol **) NULL                    \
560             && bfd_get_symcount (abfd) != 0)                                  \
561             {                                                                 \
562               if (bfd_seek (abfd, (file_ptr)(N_SYMOFF(*execp)), SEEK_SET)     \
563                   != 0)                                                       \
564                 return false;                                                 \
565                                                                               \
566               if (! NAME(aout,write_syms)(abfd)) return false;                \
567                                                                               \
568               if (bfd_seek (abfd, (file_ptr)(N_TRELOFF(*execp)), SEEK_SET)    \
569                   != 0)                                                       \
570                 return false;                                                 \
571                                                                               \
572               if (!NAME(aout,squirt_out_relocs) (abfd, obj_textsec (abfd)))   \
573                 return false;                                                 \
574               if (bfd_seek (abfd, (file_ptr)(N_DRELOFF(*execp)), SEEK_SET)    \
575                   != 0)                                                       \
576                 return false;                                                 \
577                                                                               \
578               if (!NAME(aout,squirt_out_relocs)(abfd, obj_datasec (abfd)))    \
579                 return false;                                                 \
580             }                                                                 \
581       }                                                                       
582 #endif
583
584 #endif /* ! defined (LIBAOUT_H) */