allow overrides of armap defaults
[deliverable/binutils-gdb.git] / bfd / libaout.h
CommitLineData
69ebee86 1/* BFD back-end data structures for a.out (and similar) files.
1f29e30b 2 Copyright 1990, 1991, 1992 Free Software Foundation, Inc.
9e2dad8e 3 Written by Cygnus Support.
69ebee86 4
9e2dad8e 5This file is part of BFD, the Binary File Descriptor library.
69ebee86 6
9e2dad8e 7This program is free software; you can redistribute it and/or modify
4a81b561 8it under the terms of the GNU General Public License as published by
9e2dad8e
JG
9the Free Software Foundation; either version 2 of the License, or
10(at your option) any later version.
4a81b561 11
9e2dad8e 12This program is distributed in the hope that it will be useful,
4a81b561
DHW
13but WITHOUT ANY WARRANTY; without even the implied warranty of
14MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15GNU General Public License for more details.
16
17You should have received a copy of the GNU General Public License
9e2dad8e
JG
18along with this program; if not, write to the Free Software
19Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
20
21/* We try to encapsulate the differences in the various a.out file
22 variants in a few routines, and otherwise share large masses of code.
23 This means we only have to fix bugs in one place, most of the time. */
4a81b561 24
c0e5039e
JG
25#ifdef __STDC__
26#define CAT3(a,b,c) a##b##c
27#else
28#define CAT3(a,b,c) a/**/b/**/c
29#endif
30
359f1dee
JG
31/* Parameterize the a.out code based on whether it is being built
32 for a 32-bit architecture or a 64-bit architecture. */
c0e5039e
JG
33#if ARCH_SIZE==64
34#define GET_WORD bfd_h_get_64
35#define GET_SWORD (int64_type)GET_WORD
36#define PUT_WORD bfd_h_put_64
37#define NAME(x,y) CAT3(x,_64_,y)
38#define JNAME(x) CAT(x,_64)
39#define BYTES_IN_WORD 8
40#else
41#define GET_WORD bfd_h_get_32
42#define GET_SWORD (int32_type)GET_WORD
43#define PUT_WORD bfd_h_put_32
44#define NAME(x,y) CAT3(x,_32_,y)
45#define JNAME(x) CAT(x,_32)
46#define BYTES_IN_WORD 4
47#endif
48
9e2dad8e
JG
49/* Declare these types at file level, since they are used in parameter
50 lists, which have wierd scope. */
51struct external_exec;
52struct internal_exec;
53
ce07dd7c
KR
54/* Back-end information for various a.out targets. */
55struct aout_backend_data
56{
57 /* Are ZMAGIC files mapped contiguously? If so, the text section may
58 need more padding, if the segment size (granularity for memory access
59 control) is larger than the page size. */
7f90aa8b 60 unsigned char zmagic_mapped_contiguous;
ce07dd7c
KR
61 /* If this flag is set, ZMAGIC/NMAGIC file headers get mapped in with the
62 text section, which starts immediately after the file header.
63 If not, the text section starts on the next page. */
7f90aa8b 64 unsigned char text_includes_header;
ce07dd7c
KR
65
66 /* If the text section VMA isn't specified, and we need an absolute
67 address, use this as the default. If we're producing a relocatable
68 file, zero is always used. */
69 /* ?? Perhaps a callback would be a better choice? Will this do anything
70 reasonable for a format that handles multiple CPUs with different
71 load addresses for each? */
72 bfd_vma default_text_vma;
7f90aa8b
ME
73
74 /* Callback for setting the page and segment sizes, if they can't be
75 trivially determined from the architecture. */
76 boolean (*set_sizes) PARAMS ((bfd *));
77
78 /* zmagic files only. For go32, the length of the exec header contributes
79 to the size of the text section in the file for alignment purposes but
80 does *not* get counted in the length of the text section. */
81 unsigned char exec_header_not_counted;
ce07dd7c
KR
82};
83#define aout_backend_info(abfd) \
84 ((CONST struct aout_backend_data *)((abfd)->xvec->backend_data))
85
0fa4f690
JG
86/* This is the layout in memory of a "struct exec" while we process it.
87 All 'lengths' are given as a number of bytes.
88 All 'alignments' are for relinkable files only; an alignment of
89 'n' indicates the corresponding segment must begin at an
90 address that is a multiple of (2**n). */
91
92struct internal_exec
93{
94 long a_info; /* Magic number and flags, packed */
95 bfd_vma a_text; /* length of text, in bytes */
96 bfd_vma a_data; /* length of data, in bytes */
97 bfd_vma a_bss; /* length of uninitialized data area in mem */
98 bfd_vma a_syms; /* length of symbol table data in file */
99 bfd_vma a_entry; /* start address */
100 bfd_vma a_trsize; /* length of text's relocation info, in bytes */
101 bfd_vma a_drsize; /* length of data's relocation info, in bytes */
102 /* Added for i960 */
103 bfd_vma a_tload; /* Text runtime load address */
104 bfd_vma a_dload; /* Data runtime load address */
105 unsigned char a_talign; /* Alignment of text segment */
106 unsigned char a_dalign; /* Alignment of data segment */
107 unsigned char a_balign; /* Alignment of bss segment */
7f90aa8b 108 char a_relaxable; /* Enough info for linker relax */
0fa4f690
JG
109};
110
111/* Magic number is written
112< MSB >
1133130292827262524232221201918171615141312111009080706050403020100
114< FLAGS >< MACHINE TYPE >< MAGIC NUMBER >
115*/
116enum machine_type {
117 M_UNKNOWN = 0,
118 M_68010 = 1,
119 M_68020 = 2,
120 M_SPARC = 3,
121 /* skip a bunch so we dont run into any of suns numbers */
122 M_386 = 100,
123 M_29K = 101,
124 M_HP200 = 200, /* HP 200 (68010) BSD binary */
125 M_HP300 = (300 % 256), /* HP 300 (68020+68881) BSD binary */
ce07dd7c 126 M_HPUX = (0x20c % 256)/* HP 200/300 HPUX binary */
0fa4f690
JG
127};
128
129#define N_DYNAMIC(exec) ((exec).a_info & 0x8000000)
130
131#define N_MAGIC(exec) ((exec).a_info & 0xffff)
132#define N_MACHTYPE(exec) ((enum machine_type)(((exec).a_info >> 16) & 0xff))
133#define N_FLAGS(exec) (((exec).a_info >> 24) & 0xff)
134#define N_SET_INFO(exec, magic, type, flags) \
135((exec).a_info = ((magic) & 0xffff) \
136 | (((int)(type) & 0xff) << 16) \
137 | (((flags) & 0xff) << 24))
138
139#define N_SET_MAGIC(exec, magic) \
140((exec).a_info = (((exec).a_info & 0xffff0000) | ((magic) & 0xffff)))
141
142#define N_SET_MACHTYPE(exec, machtype) \
143((exec).a_info = \
144 ((exec).a_info&0xff00ffff) | ((((int)(machtype))&0xff) << 16))
145
146#define N_SET_FLAGS(exec, flags) \
147((exec).a_info = \
148 ((exec).a_info&0x00ffffff) | (((flags) & 0xff) << 24))
149
69ebee86 150typedef struct aout_symbol {
4a81b561
DHW
151 asymbol symbol;
152 short desc;
69ebee86
JG
153 char other;
154 unsigned char type;
4a81b561
DHW
155} aout_symbol_type;
156
0fa4f690
JG
157/* The `tdata' struct for all a.out-like object file formats.
158 Various things depend on this struct being around any time an a.out
159 file is being handled. An example is dbxread.c in GDB. */
160
69ebee86 161struct aoutdata {
0fa4f690 162 struct internal_exec *hdr; /* exec file header */
4a81b561 163 aout_symbol_type *symbols; /* symtab for input bfd */
4a81b561
DHW
164
165 /* For ease, we do this */
166 asection *textsec;
167 asection *datasec;
168 asection *bsssec;
169
170 /* We remember these offsets so that after check_file_format, we have
171 no dependencies on the particular format of the exec_hdr. */
172 file_ptr sym_filepos;
173 file_ptr str_filepos;
4a81b561 174
0fa4f690 175 /* Size of a relocation entry in external form */
69ebee86 176 unsigned reloc_entry_size;
4a81b561 177
0fa4f690
JG
178 /* Size of a symbol table entry in external form */
179 unsigned symbol_entry_size;
4a81b561 180
0fa4f690
JG
181 /* Page size - needed for alignment of demand paged files. */
182 unsigned long page_size;
4a81b561 183
0fa4f690
JG
184 /* Segment size - needed for alignment of demand paged files. */
185 unsigned long segment_size;
4a81b561 186
0fa4f690 187 unsigned exec_bytes_size;
ce07dd7c
KR
188 unsigned vma_adjusted : 1;
189
190 enum {
191 undecided_magic = 0,
192 z_magic,
193 o_magic,
194 n_magic } magic;
0fa4f690 195};
4a81b561 196
ce07dd7c
KR
197struct aout_data_struct {
198 struct aoutdata a;
199 struct internal_exec e;
200};
201
202#define adata(bfd) ((bfd)->tdata.aout_data->a)
203#define exec_hdr(bfd) (adata(bfd).hdr)
204#define obj_aout_symbols(bfd) (adata(bfd).symbols)
205#define obj_textsec(bfd) (adata(bfd).textsec)
206#define obj_datasec(bfd) (adata(bfd).datasec)
207#define obj_bsssec(bfd) (adata(bfd).bsssec)
208#define obj_sym_filepos(bfd) (adata(bfd).sym_filepos)
209#define obj_str_filepos(bfd) (adata(bfd).str_filepos)
210#define obj_reloc_entry_size(bfd) (adata(bfd).reloc_entry_size)
211#define obj_symbol_entry_size(bfd) (adata(bfd).symbol_entry_size)
69ebee86 212
0fa4f690
JG
213/* We take the address of the first element of an asymbol to ensure that the
214 macro is only ever applied to an asymbol */
215#define aout_symbol(asymbol) ((aout_symbol_type *)(&(asymbol)->the_bfd))
69ebee86 216
c0e5039e 217/* Prototype declarations for functions defined in aoutx.h */
69ebee86 218
1f29e30b
JG
219boolean
220NAME(aout,squirt_out_relocs) PARAMS ((bfd *abfd, asection *section));
69ebee86 221
1f29e30b
JG
222bfd_target *
223NAME(aout,some_aout_object_p) PARAMS ((bfd *abfd,
224 struct internal_exec *execp,
225 bfd_target * (*callback)(bfd *)));
69ebee86 226
1f29e30b
JG
227boolean
228NAME(aout,mkobject) PARAMS ((bfd *abfd));
229
230enum machine_type
231NAME(aout,machine_type) PARAMS ((enum bfd_architecture arch,
232 unsigned long machine));
233
234boolean
235NAME(aout,set_arch_mach) PARAMS ((bfd *abfd, enum bfd_architecture arch,
236 unsigned long machine));
237
238boolean
239NAME(aout,new_section_hook) PARAMS ((bfd *abfd, asection *newsect));
240
241boolean
242NAME(aout,set_section_contents) PARAMS ((bfd *abfd, sec_ptr section,
c0e5039e
JG
243 PTR location, file_ptr offset, bfd_size_type count));
244
1f29e30b
JG
245asymbol *
246NAME(aout,make_empty_symbol) PARAMS ((bfd *abfd));
247
248boolean
249NAME(aout,slurp_symbol_table) PARAMS ((bfd *abfd));
250
251void
252NAME(aout,write_syms) PARAMS ((bfd *abfd));
253
254void
255NAME(aout,reclaim_symbol_table) PARAMS ((bfd *abfd));
256
257unsigned int
258NAME(aout,get_symtab_upper_bound) PARAMS ((bfd *abfd));
259
260unsigned int
261NAME(aout,get_symtab) PARAMS ((bfd *abfd, asymbol **location));
262
263boolean
264NAME(aout,slurp_reloc_table) PARAMS ((bfd *abfd, sec_ptr asect,
265 asymbol **symbols));
266
267unsigned int
268NAME(aout,canonicalize_reloc) PARAMS ((bfd *abfd, sec_ptr section,
269 arelent **relptr, asymbol **symbols));
270
271unsigned int
272NAME(aout,get_reloc_upper_bound) PARAMS ((bfd *abfd, sec_ptr asect));
273
274void
275NAME(aout,reclaim_reloc) PARAMS ((bfd *ignore_abfd, sec_ptr ignore));
276
277alent *
278NAME(aout,get_lineno) PARAMS ((bfd *ignore_abfd, asymbol *ignore_symbol));
279
280void
281NAME(aout,print_symbol) PARAMS ((bfd *ignore_abfd, PTR file,
9e2dad8e 282 asymbol *symbol, bfd_print_symbol_type how));
1f29e30b
JG
283
284boolean
285NAME(aout,close_and_cleanup) PARAMS ((bfd *abfd));
286
287boolean
288NAME(aout,find_nearest_line) PARAMS ((bfd *abfd, asection *section,
69ebee86
JG
289 asymbol **symbols, bfd_vma offset, CONST char **filename_ptr,
290 CONST char **functionname_ptr, unsigned int *line_ptr));
69ebee86 291
1f29e30b
JG
292int
293NAME(aout,sizeof_headers) PARAMS ((bfd *abfd, boolean exec));
294
295boolean
296NAME(aout,adjust_sizes_and_vmas) PARAMS ((bfd *abfd,
297 bfd_size_type *text_size, file_ptr *text_end));
298
299void
300NAME(aout,swap_exec_header_in) PARAMS ((bfd *abfd,
301 struct external_exec *raw_bytes, struct internal_exec *execp));
69ebee86 302
1f29e30b
JG
303void
304NAME(aout,swap_exec_header_out) PARAMS ((bfd *abfd,
305 struct internal_exec *execp, struct external_exec *raw_bytes));
69ebee86 306
7de245d3
PB
307/* Prototypes for functions in stab-syms.c. */
308
1f29e30b
JG
309char *
310aout_stab_name PARAMS ((int code));
7de245d3 311
69ebee86
JG
312/* A.out uses the generic versions of these routines... */
313
c0e5039e
JG
314#define aout_32_get_section_contents bfd_generic_get_section_contents
315#define aout_32_close_and_cleanup bfd_generic_close_and_cleanup
316
317#define aout_64_get_section_contents bfd_generic_get_section_contents
318#define aout_64_close_and_cleanup bfd_generic_close_and_cleanup
ce07dd7c
KR
319#ifndef NO_WRITE_HEADER_KLUDGE
320#define NO_WRITE_HEADER_KLUDGE 0
321#endif
c0e5039e 322
ce07dd7c 323#ifndef WRITE_HEADERS
c0e5039e
JG
324#define WRITE_HEADERS(abfd, execp) \
325 { \
ce07dd7c
KR
326 bfd_size_type text_size; /* dummy vars */ \
327 file_ptr text_end; \
328 if (adata(abfd).magic == undecided_magic) \
329 NAME(aout,adjust_sizes_and_vmas) (abfd, &text_size, &text_end); \
c0e5039e 330 \
0fa4f690 331 execp->a_syms = bfd_get_symcount (abfd) * EXTERNAL_NLIST_SIZE; \
c0e5039e
JG
332 execp->a_entry = bfd_get_start_address (abfd); \
333 \
334 execp->a_trsize = ((obj_textsec (abfd)->reloc_count) * \
335 obj_reloc_entry_size (abfd)); \
336 execp->a_drsize = ((obj_datasec (abfd)->reloc_count) * \
337 obj_reloc_entry_size (abfd)); \
338 NAME(aout,swap_exec_header_out) (abfd, execp, &exec_bytes); \
339 \
f8e01940 340 bfd_seek (abfd, (file_ptr) 0, SEEK_SET); \
c0e5039e
JG
341 bfd_write ((PTR) &exec_bytes, 1, EXEC_BYTES_SIZE, abfd); \
342 /* Now write out reloc info, followed by syms and strings */ \
343 \
344 if (bfd_get_symcount (abfd) != 0) \
345 { \
f8e01940 346 bfd_seek (abfd, (file_ptr)(N_SYMOFF(*execp)), SEEK_SET); \
c0e5039e
JG
347 \
348 NAME(aout,write_syms)(abfd); \
349 \
f8e01940 350 bfd_seek (abfd, (file_ptr)(N_TRELOFF(*execp)), SEEK_SET); \
c0e5039e
JG
351 \
352 if (!NAME(aout,squirt_out_relocs) (abfd, obj_textsec (abfd))) return false; \
f8e01940 353 bfd_seek (abfd, (file_ptr)(N_DRELOFF(*execp)), SEEK_SET); \
c0e5039e
JG
354 \
355 if (!NAME(aout,squirt_out_relocs)(abfd, obj_datasec (abfd))) return false; \
356 } \
357 }
ce07dd7c 358#endif
This page took 0.084331 seconds and 4 git commands to generate.