* elfread.c (elf_symtab_read): Change storage_needed,
[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
359f1dee
JG
25/* Parameterize the a.out code based on whether it is being built
26 for a 32-bit architecture or a 64-bit architecture. */
c0e5039e
JG
27#if ARCH_SIZE==64
28#define GET_WORD bfd_h_get_64
4c3721d5 29#define GET_SWORD bfd_h_get_signed_64
c0e5039e 30#define PUT_WORD bfd_h_put_64
c2623b7d 31#ifndef NAME
c0e5039e 32#define NAME(x,y) CAT3(x,_64_,y)
c2623b7d 33#endif
c0e5039e
JG
34#define JNAME(x) CAT(x,_64)
35#define BYTES_IN_WORD 8
c2623b7d 36#else /* ARCH_SIZE == 32 */
c0e5039e 37#define GET_WORD bfd_h_get_32
4c3721d5 38#define GET_SWORD bfd_h_get_signed_32
c0e5039e 39#define PUT_WORD bfd_h_put_32
c2623b7d 40#ifndef NAME
c0e5039e 41#define NAME(x,y) CAT3(x,_32_,y)
c2623b7d 42#endif
c0e5039e
JG
43#define JNAME(x) CAT(x,_32)
44#define BYTES_IN_WORD 4
c2623b7d 45#endif /* ARCH_SIZE==32 */
c0e5039e 46
728472f1
ILT
47/* Declare at file level, since it isused in parameter lists, which
48 have weird scope. */
9e2dad8e 49struct external_exec;
9e2dad8e 50
ce07dd7c
KR
51/* Back-end information for various a.out targets. */
52struct aout_backend_data
53{
54 /* Are ZMAGIC files mapped contiguously? If so, the text section may
55 need more padding, if the segment size (granularity for memory access
56 control) is larger than the page size. */
7f90aa8b 57 unsigned char zmagic_mapped_contiguous;
ce07dd7c
KR
58 /* If this flag is set, ZMAGIC/NMAGIC file headers get mapped in with the
59 text section, which starts immediately after the file header.
60 If not, the text section starts on the next page. */
7f90aa8b 61 unsigned char text_includes_header;
ce07dd7c
KR
62
63 /* If the text section VMA isn't specified, and we need an absolute
64 address, use this as the default. If we're producing a relocatable
65 file, zero is always used. */
66 /* ?? Perhaps a callback would be a better choice? Will this do anything
67 reasonable for a format that handles multiple CPUs with different
68 load addresses for each? */
69 bfd_vma default_text_vma;
7f90aa8b
ME
70
71 /* Callback for setting the page and segment sizes, if they can't be
72 trivially determined from the architecture. */
73 boolean (*set_sizes) PARAMS ((bfd *));
74
75 /* zmagic files only. For go32, the length of the exec header contributes
76 to the size of the text section in the file for alignment purposes but
77 does *not* get counted in the length of the text section. */
78 unsigned char exec_header_not_counted;
ce07dd7c
KR
79};
80#define aout_backend_info(abfd) \
81 ((CONST struct aout_backend_data *)((abfd)->xvec->backend_data))
82
0fa4f690
JG
83/* This is the layout in memory of a "struct exec" while we process it.
84 All 'lengths' are given as a number of bytes.
85 All 'alignments' are for relinkable files only; an alignment of
86 'n' indicates the corresponding segment must begin at an
87 address that is a multiple of (2**n). */
88
89struct internal_exec
90{
91 long a_info; /* Magic number and flags, packed */
92 bfd_vma a_text; /* length of text, in bytes */
93 bfd_vma a_data; /* length of data, in bytes */
94 bfd_vma a_bss; /* length of uninitialized data area in mem */
95 bfd_vma a_syms; /* length of symbol table data in file */
96 bfd_vma a_entry; /* start address */
97 bfd_vma a_trsize; /* length of text's relocation info, in bytes */
98 bfd_vma a_drsize; /* length of data's relocation info, in bytes */
99 /* Added for i960 */
100 bfd_vma a_tload; /* Text runtime load address */
101 bfd_vma a_dload; /* Data runtime load address */
102 unsigned char a_talign; /* Alignment of text segment */
103 unsigned char a_dalign; /* Alignment of data segment */
104 unsigned char a_balign; /* Alignment of bss segment */
7f90aa8b 105 char a_relaxable; /* Enough info for linker relax */
0fa4f690
JG
106};
107
108/* Magic number is written
109< MSB >
1103130292827262524232221201918171615141312111009080706050403020100
111< FLAGS >< MACHINE TYPE >< MAGIC NUMBER >
112*/
4c3721d5
ILT
113/* Magic number for NetBSD is
114<MSB >
1153130292827262524232221201918171615141312111009080706050403020100
116< FLAGS >< >< MAGIC NUMBER >
117*/
118
0fa4f690
JG
119enum machine_type {
120 M_UNKNOWN = 0,
121 M_68010 = 1,
122 M_68020 = 2,
123 M_SPARC = 3,
9eb73722 124 /* skip a bunch so we don't run into any of suns numbers */
0fa4f690 125 M_386 = 100,
9eb73722 126 M_29K = 101, /* AMD 29000 */
4c3721d5
ILT
127 M_386_DYNIX = 102, /* Sequent running dynix */
128 M_386_NETBSD = 134, /* NetBSD/386 binary */
9eb73722
KR
129 M_MIPS1 = 151, /* MIPS R2000/R3000 binary */
130 M_MIPS2 = 152, /* MIPS R4000/R6000 binary */
0fa4f690
JG
131 M_HP200 = 200, /* HP 200 (68010) BSD binary */
132 M_HP300 = (300 % 256), /* HP 300 (68020+68881) BSD binary */
ce07dd7c 133 M_HPUX = (0x20c % 256)/* HP 200/300 HPUX binary */
0fa4f690
JG
134};
135
136#define N_DYNAMIC(exec) ((exec).a_info & 0x8000000)
137
4c3721d5
ILT
138#ifndef N_MAGIC
139# define N_MAGIC(exec) ((exec).a_info & 0xffff)
140#endif
141
142#ifndef N_MACHTYPE
143# define N_MACHTYPE(exec) ((enum machine_type)(((exec).a_info >> 16) & 0xff))
144#endif
145
146#ifndef N_FLAGS
147# define N_FLAGS(exec) (((exec).a_info >> 24) & 0xff)
148#endif
149
150#ifndef N_SET_INFO
151# define N_SET_INFO(exec, magic, type, flags) \
0fa4f690
JG
152((exec).a_info = ((magic) & 0xffff) \
153 | (((int)(type) & 0xff) << 16) \
154 | (((flags) & 0xff) << 24))
4c3721d5 155#endif
0fa4f690 156
4c3721d5
ILT
157#ifndef N_SET_MAGIC
158# define N_SET_MAGIC(exec, magic) \
0fa4f690 159((exec).a_info = (((exec).a_info & 0xffff0000) | ((magic) & 0xffff)))
4c3721d5 160#endif
0fa4f690 161
4c3721d5
ILT
162#ifndef N_SET_MACHTYPE
163# define N_SET_MACHTYPE(exec, machtype) \
0fa4f690
JG
164((exec).a_info = \
165 ((exec).a_info&0xff00ffff) | ((((int)(machtype))&0xff) << 16))
4c3721d5 166#endif
0fa4f690 167
4c3721d5
ILT
168#ifndef N_SET_FLAGS
169# define N_SET_FLAGS(exec, flags) \
0fa4f690
JG
170((exec).a_info = \
171 ((exec).a_info&0x00ffffff) | (((flags) & 0xff) << 24))
4c3721d5 172#endif
0fa4f690 173
69ebee86 174typedef struct aout_symbol {
4a81b561
DHW
175 asymbol symbol;
176 short desc;
69ebee86
JG
177 char other;
178 unsigned char type;
4a81b561
DHW
179} aout_symbol_type;
180
0fa4f690
JG
181/* The `tdata' struct for all a.out-like object file formats.
182 Various things depend on this struct being around any time an a.out
183 file is being handled. An example is dbxread.c in GDB. */
184
69ebee86 185struct aoutdata {
0fa4f690 186 struct internal_exec *hdr; /* exec file header */
4a81b561 187 aout_symbol_type *symbols; /* symtab for input bfd */
4a81b561
DHW
188
189 /* For ease, we do this */
190 asection *textsec;
191 asection *datasec;
192 asection *bsssec;
193
194 /* We remember these offsets so that after check_file_format, we have
195 no dependencies on the particular format of the exec_hdr. */
196 file_ptr sym_filepos;
197 file_ptr str_filepos;
4a81b561 198
0fa4f690 199 /* Size of a relocation entry in external form */
69ebee86 200 unsigned reloc_entry_size;
4a81b561 201
0fa4f690
JG
202 /* Size of a symbol table entry in external form */
203 unsigned symbol_entry_size;
4a81b561 204
0fa4f690
JG
205 /* Page size - needed for alignment of demand paged files. */
206 unsigned long page_size;
4a81b561 207
0fa4f690
JG
208 /* Segment size - needed for alignment of demand paged files. */
209 unsigned long segment_size;
4a81b561 210
0fa4f690 211 unsigned exec_bytes_size;
ce07dd7c
KR
212 unsigned vma_adjusted : 1;
213
9eb73722
KR
214 /* used when a bfd supports several highly similar formats */
215 enum {
216 default_format = 0,
217 gnu_encap_format } subformat;
218
ce07dd7c
KR
219 enum {
220 undecided_magic = 0,
221 z_magic,
222 o_magic,
223 n_magic } magic;
4c3721d5
ILT
224
225 /* The external symbol information. */
226 struct external_nlist *external_syms;
227 bfd_size_type external_sym_count;
228 char *external_strings;
229 struct aout_link_hash_entry **sym_hashes;
0fa4f690 230};
4a81b561 231
ce07dd7c
KR
232struct aout_data_struct {
233 struct aoutdata a;
234 struct internal_exec e;
235};
236
237#define adata(bfd) ((bfd)->tdata.aout_data->a)
238#define exec_hdr(bfd) (adata(bfd).hdr)
239#define obj_aout_symbols(bfd) (adata(bfd).symbols)
240#define obj_textsec(bfd) (adata(bfd).textsec)
241#define obj_datasec(bfd) (adata(bfd).datasec)
242#define obj_bsssec(bfd) (adata(bfd).bsssec)
243#define obj_sym_filepos(bfd) (adata(bfd).sym_filepos)
244#define obj_str_filepos(bfd) (adata(bfd).str_filepos)
245#define obj_reloc_entry_size(bfd) (adata(bfd).reloc_entry_size)
246#define obj_symbol_entry_size(bfd) (adata(bfd).symbol_entry_size)
9eb73722 247#define obj_aout_subformat(bfd) (adata(bfd).subformat)
4c3721d5
ILT
248#define obj_aout_external_syms(bfd) (adata(bfd).external_syms)
249#define obj_aout_external_sym_count(bfd) (adata(bfd).external_sym_count)
250#define obj_aout_external_strings(bfd) (adata(bfd).external_strings)
251#define obj_aout_sym_hashes(bfd) (adata(bfd).sym_hashes)
69ebee86 252
0fa4f690
JG
253/* We take the address of the first element of an asymbol to ensure that the
254 macro is only ever applied to an asymbol */
255#define aout_symbol(asymbol) ((aout_symbol_type *)(&(asymbol)->the_bfd))
69ebee86 256
c0e5039e 257/* Prototype declarations for functions defined in aoutx.h */
69ebee86 258
1f29e30b
JG
259boolean
260NAME(aout,squirt_out_relocs) PARAMS ((bfd *abfd, asection *section));
69ebee86 261
1f29e30b
JG
262bfd_target *
263NAME(aout,some_aout_object_p) PARAMS ((bfd *abfd,
264 struct internal_exec *execp,
265 bfd_target * (*callback)(bfd *)));
69ebee86 266
1f29e30b
JG
267boolean
268NAME(aout,mkobject) PARAMS ((bfd *abfd));
269
270enum machine_type
271NAME(aout,machine_type) PARAMS ((enum bfd_architecture arch,
272 unsigned long machine));
273
274boolean
275NAME(aout,set_arch_mach) PARAMS ((bfd *abfd, enum bfd_architecture arch,
276 unsigned long machine));
277
278boolean
279NAME(aout,new_section_hook) PARAMS ((bfd *abfd, asection *newsect));
280
281boolean
282NAME(aout,set_section_contents) PARAMS ((bfd *abfd, sec_ptr section,
c0e5039e
JG
283 PTR location, file_ptr offset, bfd_size_type count));
284
1f29e30b
JG
285asymbol *
286NAME(aout,make_empty_symbol) PARAMS ((bfd *abfd));
287
288boolean
289NAME(aout,slurp_symbol_table) PARAMS ((bfd *abfd));
290
4c3721d5 291boolean
1f29e30b
JG
292NAME(aout,write_syms) PARAMS ((bfd *abfd));
293
294void
295NAME(aout,reclaim_symbol_table) PARAMS ((bfd *abfd));
296
297unsigned int
298NAME(aout,get_symtab_upper_bound) PARAMS ((bfd *abfd));
299
300unsigned int
301NAME(aout,get_symtab) PARAMS ((bfd *abfd, asymbol **location));
302
303boolean
304NAME(aout,slurp_reloc_table) PARAMS ((bfd *abfd, sec_ptr asect,
305 asymbol **symbols));
306
307unsigned int
308NAME(aout,canonicalize_reloc) PARAMS ((bfd *abfd, sec_ptr section,
309 arelent **relptr, asymbol **symbols));
310
311unsigned int
312NAME(aout,get_reloc_upper_bound) PARAMS ((bfd *abfd, sec_ptr asect));
313
314void
315NAME(aout,reclaim_reloc) PARAMS ((bfd *ignore_abfd, sec_ptr ignore));
316
317alent *
318NAME(aout,get_lineno) PARAMS ((bfd *ignore_abfd, asymbol *ignore_symbol));
319
320void
321NAME(aout,print_symbol) PARAMS ((bfd *ignore_abfd, PTR file,
9e2dad8e 322 asymbol *symbol, bfd_print_symbol_type how));
1f29e30b 323
c2623b7d
KR
324void
325NAME(aout,get_symbol_info) PARAMS ((bfd *ignore_abfd,
326 asymbol *symbol, symbol_info *ret));
327
1f29e30b
JG
328boolean
329NAME(aout,close_and_cleanup) PARAMS ((bfd *abfd));
330
331boolean
332NAME(aout,find_nearest_line) PARAMS ((bfd *abfd, asection *section,
69ebee86
JG
333 asymbol **symbols, bfd_vma offset, CONST char **filename_ptr,
334 CONST char **functionname_ptr, unsigned int *line_ptr));
69ebee86 335
1f29e30b
JG
336int
337NAME(aout,sizeof_headers) PARAMS ((bfd *abfd, boolean exec));
338
339boolean
340NAME(aout,adjust_sizes_and_vmas) PARAMS ((bfd *abfd,
341 bfd_size_type *text_size, file_ptr *text_end));
342
343void
344NAME(aout,swap_exec_header_in) PARAMS ((bfd *abfd,
345 struct external_exec *raw_bytes, struct internal_exec *execp));
69ebee86 346
1f29e30b
JG
347void
348NAME(aout,swap_exec_header_out) PARAMS ((bfd *abfd,
349 struct internal_exec *execp, struct external_exec *raw_bytes));
69ebee86 350
4c3721d5
ILT
351struct bfd_link_hash_table *
352NAME(aout,link_hash_table_create) PARAMS ((bfd *));
353
354boolean
355NAME(aout,link_add_symbols) PARAMS ((bfd *, struct bfd_link_info *));
356
357boolean
358NAME(aout,final_link) PARAMS ((bfd *, struct bfd_link_info *,
359 void (*) (bfd *, file_ptr *, file_ptr *,
360 file_ptr *)));
361
7de245d3
PB
362/* Prototypes for functions in stab-syms.c. */
363
9eb73722 364CONST char *
1f29e30b 365aout_stab_name PARAMS ((int code));
7de245d3 366
69ebee86
JG
367/* A.out uses the generic versions of these routines... */
368
c0e5039e
JG
369#define aout_32_get_section_contents bfd_generic_get_section_contents
370#define aout_32_close_and_cleanup bfd_generic_close_and_cleanup
371
372#define aout_64_get_section_contents bfd_generic_get_section_contents
373#define aout_64_close_and_cleanup bfd_generic_close_and_cleanup
ce07dd7c
KR
374#ifndef NO_WRITE_HEADER_KLUDGE
375#define NO_WRITE_HEADER_KLUDGE 0
376#endif
c0e5039e 377
ce07dd7c 378#ifndef WRITE_HEADERS
c0e5039e
JG
379#define WRITE_HEADERS(abfd, execp) \
380 { \
ce07dd7c
KR
381 bfd_size_type text_size; /* dummy vars */ \
382 file_ptr text_end; \
383 if (adata(abfd).magic == undecided_magic) \
384 NAME(aout,adjust_sizes_and_vmas) (abfd, &text_size, &text_end); \
c0e5039e 385 \
0fa4f690 386 execp->a_syms = bfd_get_symcount (abfd) * EXTERNAL_NLIST_SIZE; \
c0e5039e
JG
387 execp->a_entry = bfd_get_start_address (abfd); \
388 \
389 execp->a_trsize = ((obj_textsec (abfd)->reloc_count) * \
390 obj_reloc_entry_size (abfd)); \
391 execp->a_drsize = ((obj_datasec (abfd)->reloc_count) * \
392 obj_reloc_entry_size (abfd)); \
393 NAME(aout,swap_exec_header_out) (abfd, execp, &exec_bytes); \
394 \
f8e01940 395 bfd_seek (abfd, (file_ptr) 0, SEEK_SET); \
c0e5039e
JG
396 bfd_write ((PTR) &exec_bytes, 1, EXEC_BYTES_SIZE, abfd); \
397 /* Now write out reloc info, followed by syms and strings */ \
398 \
4c3721d5
ILT
399 if (bfd_get_outsymbols (abfd) != (asymbol **) NULL \
400 && bfd_get_symcount (abfd) != 0) \
c0e5039e 401 { \
f8e01940 402 bfd_seek (abfd, (file_ptr)(N_SYMOFF(*execp)), SEEK_SET); \
c0e5039e 403 \
4c3721d5 404 if (! NAME(aout,write_syms)(abfd)) return false; \
c0e5039e 405 \
f8e01940 406 bfd_seek (abfd, (file_ptr)(N_TRELOFF(*execp)), SEEK_SET); \
c0e5039e
JG
407 \
408 if (!NAME(aout,squirt_out_relocs) (abfd, obj_textsec (abfd))) return false; \
f8e01940 409 bfd_seek (abfd, (file_ptr)(N_DRELOFF(*execp)), SEEK_SET); \
c0e5039e
JG
410 \
411 if (!NAME(aout,squirt_out_relocs)(abfd, obj_datasec (abfd))) return false; \
412 } \
413 }
ce07dd7c 414#endif
This page took 0.124275 seconds and 4 git commands to generate.