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