Commit | Line | Data |
---|---|---|
a07cc613 JG |
1 | /* A -*- C -*- header file for the bfd library */ |
2 | ||
7a276b09 SC |
3 | /* bfd.h -- The only header file required by users of the bfd library |
4 | */ | |
5 | ||
6 | /* WARNING: | |
7 | This file is generated from various .c files, if you change it, your | |
8 | bits may be lost | |
9 | */ | |
a07cc613 JG |
10 | |
11 | /* Copyright (C) 1990, 1991 Free Software Foundation, Inc. | |
12 | ||
13 | This file is part of BFD, the Binary File Diddler. | |
14 | ||
15 | BFD is free software; you can redistribute it and/or modify | |
16 | it under the terms of the GNU General Public License as published by | |
17 | the Free Software Foundation; either version 1, or (at your option) | |
18 | any later version. | |
19 | ||
20 | BFD is distributed in the hope that it will be useful, | |
21 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
22 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
23 | GNU General Public License for more details. | |
24 | ||
25 | You should have received a copy of the GNU General Public License | |
26 | along with BFD; see the file COPYING. If not, write to | |
27 | the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */ | |
28 | ||
a07cc613 JG |
29 | #ifndef __BFD_H_SEEN__ |
30 | #define __BFD_H_SEEN__ | |
31 | ||
32 | #include "ansidecl.h" | |
33 | #include "obstack.h" | |
34 | ||
35 | /* Make it easier to declare prototypes (puts conditional here) */ | |
36 | #ifndef PROTO | |
37 | # if __STDC__ | |
38 | # define PROTO(type, name, arglist) type name arglist | |
39 | # else | |
40 | # define PROTO(type, name, arglist) type name () | |
41 | # endif | |
42 | #endif | |
43 | ||
ea017097 | 44 | #define BFD_VERSION "1.15" |
ec08b077 | 45 | |
a07cc613 | 46 | /* forward declaration */ |
9c6a9c92 | 47 | typedef struct _bfd bfd; |
a07cc613 | 48 | |
ec08b077 JG |
49 | /* General rules: functions which are boolean return true on success |
50 | and false on failure (unless they're a predicate). -- bfd.doc */ | |
a07cc613 JG |
51 | /* I'm sure this is going to break something and someone is going to |
52 | force me to change it. */ | |
53 | typedef enum boolean {false, true} boolean; | |
a07cc613 JG |
54 | |
55 | /* Try to avoid breaking stuff */ | |
56 | typedef long int file_ptr; | |
57 | ||
9b9c5c39 | 58 | /* Support for different sizes of target format ints and addresses */ |
19b03b7a | 59 | |
9b9c5c39 | 60 | #ifdef HOST_64_BIT |
7ed4093a SC |
61 | typedef HOST_64_BIT rawdata_offset; |
62 | typedef HOST_64_BIT bfd_vma; | |
63 | typedef HOST_64_BIT bfd_word; | |
64 | typedef HOST_64_BIT bfd_offset; | |
65 | typedef HOST_64_BIT bfd_size_type; | |
9b9c5c39 | 66 | typedef HOST_64_BIT symvalue; |
7ed4093a | 67 | typedef HOST_64_BIT bfd_64_type; |
9b9c5c39 JG |
68 | #define fprintf_vma(s,x) \ |
69 | fprintf(s,"%08x%08x", uint64_typeHIGH(x), uint64_typeLOW(x)) | |
70 | #define printf_vma(x) \ | |
71 | printf( "%08x%08x", uint64_typeHIGH(x), uint64_typeLOW(x)) | |
19b03b7a | 72 | #else |
9b9c5c39 JG |
73 | typedef struct {int a,b;} bfd_64_type; |
74 | typedef unsigned long rawdata_offset; | |
a07cc613 JG |
75 | typedef unsigned long bfd_vma; |
76 | typedef unsigned long bfd_offset; | |
19b03b7a SC |
77 | typedef unsigned long bfd_word; |
78 | typedef unsigned long bfd_size; | |
79 | typedef unsigned long symvalue; | |
80 | typedef unsigned long bfd_size_type; | |
a737c70b SC |
81 | #define printf_vma(x) printf( "%08lx", x) |
82 | #define fprintf_vma(s,x) fprintf(s, "%08lx", x) | |
19b03b7a | 83 | #endif |
a07cc613 JG |
84 | |
85 | typedef unsigned int flagword; /* 32 bits of flags */ | |
86 | \f | |
87 | /** File formats */ | |
88 | ||
89 | typedef enum bfd_format { | |
90 | bfd_unknown = 0, /* file format is unknown */ | |
91 | bfd_object, /* linker/assember/compiler output */ | |
92 | bfd_archive, /* object archive file */ | |
93 | bfd_core, /* core dump */ | |
94 | bfd_type_end} /* marks the end; don't use it! */ | |
95 | bfd_format; | |
96 | ||
97 | /* Object file flag values */ | |
9b9c5c39 | 98 | #define NO_FLAGS 0 |
a07cc613 JG |
99 | #define HAS_RELOC 001 |
100 | #define EXEC_P 002 | |
101 | #define HAS_LINENO 004 | |
102 | #define HAS_DEBUG 010 | |
103 | #define HAS_SYMS 020 | |
104 | #define HAS_LOCALS 040 | |
105 | #define DYNAMIC 0100 | |
106 | #define WP_TEXT 0200 | |
107 | #define D_PAGED 0400 | |
108 | ||
a07cc613 JG |
109 | \f |
110 | /* symbols and relocation */ | |
111 | ||
112 | typedef unsigned long symindex; | |
113 | ||
114 | #define BFD_NO_MORE_SYMBOLS ((symindex) ~0) | |
115 | ||
116 | typedef enum {bfd_symclass_unknown = 0, | |
117 | bfd_symclass_fcommon, /* fortran common symbols */ | |
118 | bfd_symclass_global, /* global symbol, what a surprise */ | |
119 | bfd_symclass_debugger, /* some debugger symbol */ | |
120 | bfd_symclass_undefined /* none known */ | |
121 | } symclass; | |
122 | ||
19b03b7a | 123 | |
a07cc613 | 124 | typedef int symtype; /* Who knows, yet? */ |
19b03b7a | 125 | |
a07cc613 | 126 | |
9b9c5c39 JG |
127 | /* general purpose part of a symbol; |
128 | target specific parts will be found in libcoff.h, liba.out.h etc */ | |
7a276b09 | 129 | |
a07cc613 JG |
130 | |
131 | #define bfd_get_section(x) ((x)->section) | |
132 | #define bfd_get_output_section(x) ((x)->section->output_section) | |
133 | #define bfd_set_section(x,y) ((x)->section) = (y) | |
134 | #define bfd_asymbol_base(x) ((x)->section?((x)->section->vma):0) | |
135 | #define bfd_asymbol_value(x) (bfd_asymbol_base(x) + x->value) | |
136 | #define bfd_asymbol_name(x) ((x)->name) | |
137 | ||
a07cc613 | 138 | /* This is a type pun with struct ranlib on purpose! */ |
9c6a9c92 | 139 | typedef struct carsym { |
a07cc613 JG |
140 | char *name; |
141 | file_ptr file_offset; /* look here to find the file */ | |
142 | } carsym; /* to make these you call a carsymogen */ | |
143 | ||
a07cc613 JG |
144 | |
145 | /* Used in generating armaps. Perhaps just a forward definition would do? */ | |
146 | struct orl { /* output ranlib */ | |
147 | char **name; /* symbol name */ | |
c93e2c55 | 148 | file_ptr pos; /* bfd* or file position */ |
a07cc613 JG |
149 | int namidx; /* index into string table */ |
150 | }; | |
151 | ||
152 | \f | |
153 | ||
154 | /* Linenumber stuff */ | |
155 | typedef struct lineno_cache_entry { | |
156 | unsigned int line_number; /* Linenumber from start of function*/ | |
157 | union { | |
7a276b09 | 158 | struct symbol_cache_entry *sym; /* Function name */ |
a07cc613 JG |
159 | unsigned long offset; /* Offset into section */ |
160 | } u; | |
161 | } alent; | |
162 | \f | |
163 | /* object and core file sections */ | |
164 | ||
a07cc613 JG |
165 | |
166 | #define align_power(addr, align) \ | |
167 | ( ((addr) + ((1<<(align))-1)) & (-1 << (align))) | |
168 | ||
9c6a9c92 | 169 | typedef struct sec *sec_ptr; |
a07cc613 JG |
170 | |
171 | #define bfd_section_name(bfd, ptr) ((ptr)->name) | |
172 | #define bfd_section_size(bfd, ptr) ((ptr)->size) | |
173 | #define bfd_section_vma(bfd, ptr) ((ptr)->vma) | |
174 | #define bfd_section_alignment(bfd, ptr) ((ptr)->alignment_power) | |
175 | #define bfd_get_section_flags(bfd, ptr) ((ptr)->flags) | |
176 | #define bfd_get_section_userdata(bfd, ptr) ((ptr)->userdata) | |
177 | ||
178 | #define bfd_set_section_vma(bfd, ptr, val) (((ptr)->vma = (val)), true) | |
179 | #define bfd_set_section_alignment(bfd, ptr, val) (((ptr)->alignment_power = (val)),true) | |
180 | #define bfd_set_section_userdata(bfd, ptr, val) (((ptr)->userdata = (val)),true) | |
4322f04d SC |
181 | |
182 | typedef struct stat stat_type; | |
a07cc613 JG |
183 | \f |
184 | /** Error handling */ | |
185 | ||
186 | typedef enum {no_error = 0, system_call_error, invalid_target, | |
187 | wrong_format, invalid_operation, no_memory, | |
188 | no_symbols, no_relocation_info, | |
189 | no_more_archived_files, malformed_archive, | |
190 | symbol_not_found, file_not_recognized, | |
191 | file_ambiguously_recognized, no_contents, | |
192 | bfd_error_nonrepresentable_section, | |
193 | invalid_error_code} bfd_ec; | |
194 | ||
195 | extern bfd_ec bfd_error; | |
196 | ||
9c6a9c92 | 197 | typedef struct bfd_error_vector { |
a07cc613 JG |
198 | PROTO(void,(* nonrepresentable_section ),(CONST bfd *CONST abfd, |
199 | CONST char *CONST name)); | |
200 | } bfd_error_vector_type; | |
201 | ||
202 | PROTO (char *, bfd_errmsg, ()); | |
203 | PROTO (void, bfd_perror, (CONST char *message)); | |
204 | \f | |
205 | ||
9b9c5c39 | 206 | typedef enum bfd_print_symbol |
a07cc613 JG |
207 | { |
208 | bfd_print_symbol_name_enum, | |
209 | bfd_print_symbol_type_enum, | |
19b03b7a | 210 | bfd_print_symbol_all_enum |
9b9c5c39 | 211 | } bfd_print_symbol_enum_type; |
a07cc613 JG |
212 | |
213 | \f | |
a07cc613 JG |
214 | \f |
215 | /* The code that implements targets can initialize a jump table with this | |
216 | macro. It must name all its routines the same way (a prefix plus | |
217 | the standard routine suffix), or it must #define the routines that | |
218 | are not so named, before calling JUMP_TABLE in the initializer. */ | |
219 | ||
220 | /* Semi-portable string concatenation in cpp */ | |
221 | #ifndef CAT | |
222 | #ifdef __STDC__ | |
223 | #define CAT(a,b) a##b | |
224 | #else | |
225 | #define CAT(a,b) a/**/b | |
226 | #endif | |
227 | #endif | |
228 | ||
229 | #define JUMP_TABLE(NAME)\ | |
230 | CAT(NAME,_core_file_failing_command),\ | |
231 | CAT(NAME,_core_file_failing_signal),\ | |
232 | CAT(NAME,_core_file_matches_executable_p),\ | |
233 | CAT(NAME,_slurp_armap),\ | |
234 | CAT(NAME,_slurp_extended_name_table),\ | |
235 | CAT(NAME,_truncate_arname),\ | |
236 | CAT(NAME,_write_armap),\ | |
237 | CAT(NAME,_close_and_cleanup), \ | |
238 | CAT(NAME,_set_section_contents),\ | |
239 | CAT(NAME,_get_section_contents),\ | |
240 | CAT(NAME,_new_section_hook),\ | |
241 | CAT(NAME,_get_symtab_upper_bound),\ | |
242 | CAT(NAME,_get_symtab),\ | |
243 | CAT(NAME,_get_reloc_upper_bound),\ | |
244 | CAT(NAME,_canonicalize_reloc),\ | |
245 | CAT(NAME,_make_empty_symbol),\ | |
246 | CAT(NAME,_print_symbol),\ | |
247 | CAT(NAME,_get_lineno),\ | |
248 | CAT(NAME,_set_arch_mach),\ | |
249 | CAT(NAME,_openr_next_archived_file),\ | |
250 | CAT(NAME,_find_nearest_line),\ | |
251 | CAT(NAME,_generic_stat_arch_elt),\ | |
7a276b09 SC |
252 | CAT(NAME,_sizeof_headers),\ |
253 | CAT(NAME,_bfd_debug_info_start),\ | |
254 | CAT(NAME,_bfd_debug_info_end),\ | |
255 | CAT(NAME,_bfd_debug_info_accumulate) | |
2700c3c7 SC |
256 | |
257 | #define COFF_SWAP_TABLE coff_swap_aux_in, coff_swap_sym_in, coff_swap_lineno_in, | |
a07cc613 JG |
258 | \f |
259 | /* User program access to BFD facilities */ | |
260 | ||
261 | extern CONST short _bfd_host_big_endian; | |
262 | #define HOST_BYTE_ORDER_BIG_P (*(char *)&_bfd_host_big_endian) | |
263 | ||
264 | /* The bfd itself */ | |
265 | ||
8c01a0ea JK |
266 | /* Cast from const char * to char * so that caller can assign to |
267 | a char * without a warning. */ | |
268 | #define bfd_get_filename(abfd) ((char *) (abfd)->filename) | |
a07cc613 JG |
269 | #define bfd_get_format(abfd) ((abfd)->format) |
270 | #define bfd_get_target(abfd) ((abfd)->xvec->name) | |
271 | #define bfd_get_file_flags(abfd) ((abfd)->flags) | |
272 | #define bfd_applicable_file_flags(abfd) ((abfd)->xvec->object_flags) | |
273 | #define bfd_applicable_section_flags(abfd) ((abfd)->xvec->section_flags) | |
274 | #define bfd_my_archive(abfd) ((abfd)->my_archive); | |
275 | #define bfd_has_map(abfd) ((abfd)->has_armap) | |
276 | #define bfd_header_twiddle_required(abfd) \ | |
277 | ((((abfd)->xvec->header_byteorder_big_p) \ | |
278 | != (boolean)HOST_BYTE_ORDER_BIG_P) ? true:false) | |
279 | ||
280 | #define bfd_valid_reloc_types(abfd) ((abfd)->xvec->valid_reloc_types) | |
281 | #define bfd_usrdata(abfd) ((abfd)->usrdata) | |
282 | ||
283 | #define bfd_get_start_address(abfd) ((abfd)->start_address) | |
284 | #define bfd_get_symcount(abfd) ((abfd)->symcount) | |
285 | #define bfd_get_outsymbols(abfd) ((abfd)->outsymbols) | |
286 | #define bfd_count_sections(abfd) ((abfd)->section_count) | |
287 | #define bfd_get_architecture(abfd) ((abfd)->obj_arch) | |
288 | #define bfd_get_machine(abfd) ((abfd)->obj_machine) | |
289 | ||
a07cc613 | 290 | |
a07cc613 | 291 | |
7a276b09 SC |
292 | #define BYTE_SIZE 1 |
293 | #define SHORT_SIZE 2 | |
294 | #define LONG_SIZE 4 | |
295 | ||
296 | ||
297 | ||
298 | /*THE FOLLOWING IS EXTRACTED FROM THE SOURCE */ | |
299 | ||
300 | /* Opens the file supplied (using fopen) with the target supplied, it | |
301 | returns a pointer to the created bfd. | |
302 | ||
303 | If NULL is returned then an error has occured. | |
304 | Possible errors are no_memory, invalid_target or system_call error. | |
305 | */ | |
306 | PROTO(bfd*, bfd_openr, (CONST char *filename,CONST char*target)); | |
307 | /* bfd_fdopenr is to bfd_fopenr much like fdopen is to fopen. It opens a bfd on | |
308 | a file already described by the @var{fd} supplied. | |
309 | ||
310 | Possible errors are no_memory, invalid_target and system_call error. | |
311 | */ | |
312 | PROTO(bfd *, bfd_fdopenr, | |
313 | (CONST char *filename, CONST char *target, int fd)); | |
314 | /* Creates a bfd, associated with file @var{filename}, using the file | |
315 | format @var{target}, and returns a pointer to it. | |
316 | ||
317 | Possible errors are system_call_error, no_memory, invalid_target. | |
318 | */ | |
319 | PROTO(bfd *, bfd_openw, (CONST char *filename, CONST char *target)); | |
320 | /* This function closes a bfd. If the bfd was open for writing, then | |
321 | pending operations are completed and the file written out and closed. | |
322 | If the created file is executable, then @code{chmod} is called to mark | |
323 | it as such. | |
324 | ||
325 | All memory attatched to the bfd's obstacks is released. | |
326 | ||
327 | @code{true} is returned if all is ok, otherwise @code{false}. | |
328 | */ | |
329 | PROTO(boolean, bfd_close,(bfd *)); | |
330 | /* This routine creates a new bfd in the manner of bfd_openw, but without | |
331 | opening a file. The new bfd takes the target from the target used by | |
332 | @var{template}. The format is always set to @code{bfd_object}. | |
333 | ||
334 | */ | |
335 | PROTO(bfd *, bfd_create, (CONST char *filename, bfd *template)); | |
336 | /* Return the number of bytes in the obstacks connected to the supplied | |
337 | bfd. | |
338 | */ | |
339 | PROTO(bfd_size_type,bfd_alloc_size,(bfd *abfd)); | |
340 | /* This enum gives the object file's CPU | |
341 | architecture, in a global sense. E.g. what processor family does it | |
342 | belong to? There is another field, which indicates what processor | |
343 | within the family is in use. The machine gives a number which | |
344 | distingushes different versions of the architecture, containing for | |
345 | example 2 and 3 for Intel i960 KA and i960 KB, and 68020 and 68030 for | |
346 | Motorola 68020 and 68030. | |
347 | ||
348 | */ | |
349 | enum bfd_architecture | |
350 | { | |
351 | bfd_arch_unknown, /* File arch not known */ | |
352 | bfd_arch_obscure, /* Arch known, not one of these */ | |
353 | bfd_arch_m68k, /* Motorola 68xxx */ | |
354 | bfd_arch_vax, /* DEC Vax */ | |
355 | bfd_arch_i960, /* Intel 960 */ | |
356 | /* The order of the following is important. | |
357 | lower number indicates a machine type that | |
358 | only accepts a subset of the instructions | |
359 | available to machines with higher numbers. | |
360 | The exception is the "ca", which is | |
361 | incompatible with all other machines except | |
362 | "core". */ | |
363 | ||
364 | #define bfd_mach_i960_core 1 | |
365 | #define bfd_mach_i960_ka_sa 2 | |
366 | #define bfd_mach_i960_kb_sb 3 | |
367 | #define bfd_mach_i960_mc 4 | |
368 | #define bfd_mach_i960_xa 5 | |
369 | #define bfd_mach_i960_ca 6 | |
370 | ||
371 | bfd_arch_a29k, /* AMD 29000 */ | |
372 | bfd_arch_sparc, /* SPARC */ | |
373 | bfd_arch_mips, /* MIPS Rxxxx */ | |
374 | bfd_arch_i386, /* Intel 386 */ | |
375 | bfd_arch_ns32k, /* National Semiconductor 32xxx */ | |
376 | bfd_arch_tahoe, /* CCI/Harris Tahoe */ | |
377 | bfd_arch_i860, /* Intel 860 */ | |
378 | bfd_arch_romp, /* IBM ROMP RS/6000 */ | |
379 | bfd_arch_alliant, /* Alliant */ | |
380 | bfd_arch_convex, /* Convex */ | |
381 | bfd_arch_m88k, /* Motorola 88xxx */ | |
382 | bfd_arch_pyramid, /* Pyramid Technology */ | |
383 | bfd_arch_h8_300, /* Hitachi H8/300 */ | |
384 | bfd_arch_last | |
385 | }; | |
386 | ||
387 | /* stuff | |
388 | */ | |
389 | ||
390 | /* Return a printable string representing the architecture and machine | |
391 | type. The result is only good until the next call to | |
392 | bfd_printable_arch_mach. | |
393 | */ | |
394 | PROTO(CONST char *,bfd_printable_arch_mach, | |
395 | (enum bfd_architecture arch, unsigned long machine)); | |
396 | /* Scan a string and attempt to turn it into an archive and machine type combination. | |
397 | */ | |
398 | PROTO(boolean, bfd_scan_arch_mach, | |
399 | (CONST char *, enum bfd_architecture *, unsigned long *)); | |
400 | /* This routine is used to determine whether two BFDs' architectures and machine types are | |
401 | compatible. It calculates the lowest common denominator between the | |
402 | two architectures and machine types implied by the bfds and sets the | |
403 | objects pointed at by @var{archp} and @var{machine} if non NULL. | |
404 | ||
405 | This routine returns @code{true} if the bfds are of compatible type, | |
406 | otherwise @code{false}. | |
407 | */ | |
408 | PROTO(boolean, bfd_arch_compatible, | |
409 | (bfd *abfd, | |
410 | bfd *bbfd, | |
411 | enum bfd_architecture *archp, | |
412 | unsigned long *machinep)); | |
413 | /* Set atch mach | |
414 | */ | |
415 | #define bfd_set_arch_mach(abfd, arch, mach) \ | |
416 | BFD_SEND (abfd, _bfd_set_arch_mach,\ | |
417 | (abfd, arch, mach)) | |
418 | ||
419 | /* These macros as used for reading and writing raw data in sections; | |
420 | each access (except for bytes) is vectored through the target format | |
421 | of the bfd and mangled accordingly. The mangling performs any | |
422 | necessary endian translations and removes alignment restrictions. | |
423 | */ | |
424 | #define bfd_put_8(abfd, val, ptr) \ | |
425 | (*((char *)ptr) = (char)val) | |
426 | #define bfd_get_8(abfd, ptr) \ | |
427 | (*((char *)ptr)) | |
428 | #define bfd_put_16(abfd, val, ptr) \ | |
429 | BFD_SEND(abfd, bfd_putx16, (val,ptr)) | |
430 | #define bfd_get_16(abfd, ptr) \ | |
431 | BFD_SEND(abfd, bfd_getx16, (ptr)) | |
432 | #define bfd_put_32(abfd, val, ptr) \ | |
433 | BFD_SEND(abfd, bfd_putx32, (val,ptr)) | |
434 | #define bfd_get_32(abfd, ptr) \ | |
435 | BFD_SEND(abfd, bfd_getx32, (ptr)) | |
436 | #define bfd_put_64(abfd, val, ptr) \ | |
437 | BFD_SEND(abfd, bfd_putx64, (val, ptr)) | |
438 | #define bfd_get_64(abfd, ptr) \ | |
439 | BFD_SEND(abfd, bfd_getx64, (ptr)) | |
440 | ||
441 | /* These macros have the same function as their @code{bfd_get_x} | |
442 | bretherin, except that they are used for removing information for the | |
443 | header records of object files. Believe it or not, some object files | |
444 | keep their header records in big endian order, and their data in little | |
445 | endan order. | |
446 | */ | |
447 | #define bfd_h_put_8(abfd, val, ptr) \ | |
448 | (*((char *)ptr) = (char)val) | |
449 | #define bfd_h_get_8(abfd, ptr) \ | |
450 | (*((char *)ptr)) | |
451 | #define bfd_h_put_16(abfd, val, ptr) \ | |
452 | BFD_SEND(abfd, bfd_h_putx16,(val,ptr)) | |
453 | #define bfd_h_get_16(abfd, ptr) \ | |
454 | BFD_SEND(abfd, bfd_h_getx16,(ptr)) | |
455 | #define bfd_h_put_32(abfd, val, ptr) \ | |
456 | BFD_SEND(abfd, bfd_h_putx32,(val,ptr)) | |
457 | #define bfd_h_get_32(abfd, ptr) \ | |
458 | BFD_SEND(abfd, bfd_h_getx32,(ptr)) | |
459 | #define bfd_h_put_64(abfd, val, ptr) \ | |
460 | BFD_SEND(abfd, bfd_h_putx64,(val, ptr)) | |
461 | #define bfd_h_get_64(abfd, ptr) \ | |
462 | BFD_SEND(abfd, bfd_h_getx64,(ptr)) | |
463 | ||
464 | /* The shape of a section struct: | |
465 | ||
466 | */ | |
467 | typedef struct sec { | |
468 | ||
469 | /* The name of the section, the name isn't a copy, the pointer is | |
470 | the same as that passed to bfd_make_section. | |
471 | */ | |
472 | CONST char *name; | |
473 | ||
474 | /* The next section in the list belonging to the bfd, or NULL. | |
475 | */ | |
476 | struct sec *next; | |
477 | ||
478 | /* The field flags contains attributes of the section. Some of these | |
479 | flags are read in from the object file, and some are synthesized from | |
480 | other information. | |
481 | */ | |
482 | flagword flags; | |
483 | #define SEC_NO_FLAGS 0x000 | |
484 | ||
485 | /* Tells the OS to allocate space for this section when loaded. | |
486 | This would clear for a section containing debug information only. | |
487 | */ | |
488 | #define SEC_ALLOC 0x001 | |
489 | ||
490 | /* Tells the OS to load the section from the file when loading. | |
491 | This would be clear for a .bss section | |
492 | */ | |
493 | #define SEC_LOAD 0x002 | |
494 | ||
495 | /* The section contains data still to be relocated, so there will be some | |
496 | relocation information too. | |
497 | */ | |
498 | #define SEC_RELOC 0x004 | |
499 | ||
500 | /* Obsolete ? | |
501 | */ | |
502 | #define SEC_BALIGN 0x008 | |
503 | ||
504 | /* A signal to the OS that the section contains read only data. | |
505 | */ | |
506 | #define SEC_READONLY 0x010 | |
507 | ||
508 | /* The section contains code only. | |
509 | */ | |
510 | #define SEC_CODE 0x020 | |
511 | ||
512 | /* The section contains data only. | |
513 | */ | |
514 | #define SEC_DATA 0x040 | |
515 | ||
516 | /* The section will reside in ROM. | |
517 | */ | |
518 | #define SEC_ROM 0x080 | |
519 | ||
520 | /* The section contains constructor information. This section type is | |
521 | used by the linker to create lists of constructors and destructors | |
522 | used by @code{g++}. When a back end sees a symbol which should be used | |
523 | in a constructor list, it creates a new section for the type of name | |
524 | (eg @code{__CTOR_LIST__}), attatches the symbol to it and builds a | |
525 | relocation. To build the lists of constructors, all the linker has to | |
526 | to is catenate all the sections called @code{__CTOR_LIST__} and | |
527 | relocte the data contained within - exactly the operations it would | |
528 | peform on standard data. | |
529 | */ | |
530 | #define SEC_CONSTRUCTOR 0x100 | |
531 | ||
532 | /* The section has contents - a bss section could be | |
533 | @code{SEC_ALLOC} | @code{SEC_HAS_CONTENTS}, a debug section could be | |
534 | @code{SEC_HAS_CONTENTS} | |
535 | */ | |
536 | #define SEC_HAS_CONTENTS 0x200 | |
537 | ||
538 | /* An instruction to the linker not to output sections containing | |
539 | this flag even if they have information which would normally be written. | |
540 | */ | |
541 | #define SEC_NEVER_LOAD 0x400 | |
542 | ||
543 | /* The base address of the section in the address space of the target. | |
544 | */ | |
545 | bfd_vma vma; | |
546 | ||
547 | /* The size of the section in bytes of the loaded section. This contains | |
548 | a value even if the section has no contents (eg, the size of @code{.bss}). | |
549 | */ | |
550 | bfd_size_type size; | |
551 | ||
552 | /* If this section is going to be output, then this value is the | |
553 | offset into the output section of the first byte in the input | |
554 | section. Eg, if this was going to start at the 100th byte in the | |
555 | output section, this value would be 100. | |
556 | */ | |
557 | bfd_vma output_offset; | |
558 | ||
559 | /* The output section through which to map on output. | |
560 | */ | |
561 | struct sec *output_section; | |
562 | ||
563 | /* The alignment requirement of the section, as an exponent - eg 3 | |
564 | aligns to 2^3 (or 8) | |
565 | */ | |
566 | unsigned int alignment_power; | |
567 | ||
568 | /* If an input section, a pointer to a vector of relocation records for | |
569 | the data in this section. | |
570 | */ | |
571 | struct reloc_cache_entry *relocation; | |
572 | ||
573 | /* If an output section, a pointer to a vector of pointers to | |
574 | relocation records for the data in this section. | |
575 | */ | |
576 | struct reloc_cache_entry **orelocation; | |
577 | ||
578 | /* The number of relocation records in one of the above | |
579 | */ | |
580 | unsigned reloc_count; | |
581 | ||
582 | /* Which section is it 0..nth | |
583 | */ | |
584 | int index; | |
585 | ||
586 | /* Information below is back end specific - and not always used or | |
587 | updated | |
588 | ||
589 | File position of section data | |
590 | */ | |
591 | file_ptr filepos; | |
592 | ||
593 | /* File position of relocation info | |
594 | */ | |
595 | file_ptr rel_filepos; | |
596 | ||
597 | /* File position of line data | |
598 | */ | |
599 | file_ptr line_filepos; | |
600 | ||
601 | /* Pointer to data for applications | |
602 | */ | |
603 | PTR userdata; | |
604 | struct lang_output_section *otheruserdata; | |
605 | ||
606 | /* Attached line number information | |
607 | */ | |
608 | alent *lineno; | |
609 | ||
610 | /* Number of line number records | |
611 | */ | |
612 | unsigned int lineno_count; | |
613 | ||
614 | /* When a section is being output, this value changes as more | |
615 | linenumbers are written out | |
616 | */ | |
617 | file_ptr moving_line_filepos; | |
618 | ||
619 | /* what the section number is in the target world | |
620 | */ | |
621 | unsigned int target_index; | |
622 | PTR used_by_bfd; | |
623 | ||
624 | /* If this is a constructor section then here is a list of the | |
625 | relocations created to relocate items within it. | |
626 | */ | |
627 | struct relent_chain *constructor_chain; | |
628 | ||
629 | /* The bfd which owns the section. | |
630 | */ | |
631 | bfd *owner; | |
632 | } asection ; | |
633 | ||
634 | /* Runs through the provided @var{abfd} and returns the @code{asection} | |
635 | who's name matches that provided, otherwise NULL. @xref{Sections}, for more information. | |
636 | ||
637 | */ | |
638 | PROTO(asection *, bfd_get_section_by_name, | |
639 | (bfd *abfd, CONST char *name)); | |
640 | /* This function creates a new empty section called @var{name} and attatches it | |
641 | to the end of the chain of sections for @var{bfd}. An attempt to | |
642 | create a section with a name which is already in use, returns the old | |
643 | section by that name instead. | |
644 | ||
645 | Possible errors are: | |
646 | @table @code | |
647 | @item invalid_operation | |
648 | If output has already started for this bfd. | |
649 | @item no_memory | |
650 | If obstack alloc fails. | |
651 | @end table | |
652 | ||
653 | */ | |
654 | PROTO(asection *, bfd_make_section, (bfd *, CONST char *name)); | |
655 | /* Attempts to set the attributes of the section named in the bfd | |
656 | supplied to the value. Returns true on success, false on error. | |
657 | Possible error returns are: | |
658 | @table @code | |
659 | @item invalid operation | |
660 | The section cannot have one or more of the attributes requested. For | |
661 | example, a .bss section in @code{a.out} may not have the | |
662 | @code{SEC_HAS_CONTENTS} field set. | |
663 | @end table | |
664 | ||
665 | */ | |
666 | PROTO(boolean, bfd_set_section_flags, | |
667 | (bfd *, asection *, flagword)); | |
668 | /* Calls the provided function @var{func} for each section attatched to | |
669 | the bfd @var{abfd}, passing @var{obj} as an argument. The function | |
670 | will be called as if by | |
671 | ||
672 | @example | |
673 | func(abfd, the_section, obj); | |
674 | @end example | |
675 | ||
676 | ||
677 | */ | |
678 | PROTO(void, bfd_map_over_sections, | |
679 | (bfd *abfd, void (*func)(), PTR obj)); | |
680 | /* This is the prefered method for iterating over sections, an | |
681 | alternative would be to use a loop: | |
682 | ||
683 | @example | |
684 | section *p; | |
685 | for (p = abfd->sections; p != NULL; p = p->next) | |
686 | func(abfd, p, ...) | |
687 | @end example*/ | |
688 | ||
689 | /* Sets @var{section} to the size @var{val}. If the operation is ok, then | |
690 | @code{true} is returned, else @code{false}. | |
691 | ||
692 | Possible error returns: | |
693 | @table @code | |
694 | @item invalid_operation | |
695 | Writing has started to the bfd, so setting the size is invalid | |
696 | @end table | |
697 | ||
698 | */ | |
699 | PROTO(boolean, bfd_set_section_size, | |
700 | (bfd *, asection *, bfd_size_type val)); | |
701 | /* Sets the contents of the section @var{section} in bfd @var{abfd} to | |
702 | the data starting in memory at @var{data}. The data is written to the | |
703 | output section starting at offset @var{offset} for @var{count} bytes. | |
704 | ||
705 | Normally @code{true} is returned, else @code{false}. Possible error | |
706 | returns are: | |
707 | @table @code | |
708 | @item no_contents | |
709 | The output section does not have the @code{SEC_HAS_CONTENTS} | |
710 | attribute, so nothing can be written to it. | |
711 | @item and some more too | |
712 | @end table | |
713 | This routine is front end to the back end function @code{_bfd_set_section_contents}. | |
714 | ||
715 | */ | |
716 | PROTO(boolean, bfd_set_section_contents, | |
717 | (bfd *abfd, | |
718 | asection *section, | |
719 | PTR data, | |
720 | file_ptr offset, | |
721 | bfd_size_type count)); | |
722 | /* This function reads data from @var{section} in bfd @var{abfd} into | |
723 | memory starting at @var{location}. The data is read at an offset of | |
724 | @var{offset} from the start of the input section, and is read for | |
725 | @var{count} bytes. | |
726 | ||
727 | If the contents of a constuctor with the @code{SEC_CONSTUCTOR} flag | |
728 | set are requested, then the @var{location} is filled with zeroes. | |
729 | ||
730 | If no errors occur, @code{true} is returned, else @code{false}. | |
731 | Possible errors are: | |
732 | ||
733 | @table @code | |
734 | @item unknown yet | |
735 | @end table | |
736 | ||
737 | */ | |
738 | PROTO(boolean, bfd_get_section_contents, | |
739 | (bfd *abfd, asection *section, PTR location, | |
740 | file_ptr offset, bfd_size_type count)); | |
741 | /* @subsection typedef asymbol | |
742 | An @code{asymbol} has the form: | |
743 | ||
744 | */ | |
745 | typedef struct symbol_cache_entry | |
746 | { | |
747 | ||
748 | /* A pointer to the bfd which owns the symbol. This information is | |
749 | necessary so that a back end can work out what additional (invisible to | |
750 | the application writer) information is carried with the symbol. | |
751 | */ | |
752 | struct _bfd *the_bfd; | |
753 | ||
754 | /* The text of the symbol. The name is left alone, and not copied - the | |
755 | application may not alter it. | |
756 | */ | |
757 | CONST char *name; | |
758 | ||
759 | /* The value of the symbol. | |
760 | */ | |
761 | symvalue value; | |
762 | ||
763 | /* Attributes of a symbol: | |
764 | */ | |
765 | #define BSF_NO_FLAGS 0x00 | |
766 | ||
767 | /* The symbol has local scope; @code{static} in @code{C}. The value is | |
768 | the offset into the section of the data. | |
769 | */ | |
770 | #define BSF_LOCAL 0x01 | |
771 | ||
772 | /* The symbol has global scope; initialized data in @code{C}. The value | |
773 | is the offset into the section of the data. | |
774 | */ | |
775 | #define BSF_GLOBAL 0x02 | |
776 | ||
777 | /* Obsolete | |
778 | */ | |
779 | #define BSF_IMPORT 0x04 | |
780 | ||
781 | /* The symbol has global scope, and is exported. The value is the offset | |
782 | into the section of the data. | |
783 | */ | |
784 | #define BSF_EXPORT 0x08 | |
785 | ||
786 | /* The symbol is undefined. @code{extern} in @code{C}. The value has no meaning. | |
787 | */ | |
788 | #define BSF_UNDEFINED 0x10 | |
789 | ||
790 | /* The symbol is common, initialized to zero; default in @code{C}. The | |
791 | value is the size of the object in bytes. | |
792 | */ | |
793 | #define BSF_FORT_COMM 0x20 | |
794 | ||
795 | /* A normal @code{C} symbol would be one of: | |
796 | @code{BSF_LOCAL}, @code{BSF_FORT_COMM}, @code{BSF_UNDEFINED} or @code{BSF_EXPORT|BSD_GLOBAL} | |
797 | ||
798 | The symbol is a debugging record. The value has an arbitary meaning. | |
799 | */ | |
800 | #define BSF_DEBUGGING 0x40 | |
801 | ||
802 | /* The symbol has no section attached, any value is the actual value and | |
803 | is not a relative offset to a section. | |
804 | */ | |
805 | #define BSF_ABSOLUTE 0x80 | |
806 | ||
807 | /* Used by the linker | |
808 | */ | |
809 | #define BSF_KEEP 0x10000 | |
810 | #define BSF_WARNING 0x20000 | |
811 | #define BSF_KEEP_G 0x80000 | |
812 | ||
813 | /* Unused | |
814 | */ | |
815 | #define BSF_WEAK 0x100000 | |
816 | #define BSF_CTOR 0x200000 | |
817 | #define BSF_FAKE 0x400000 | |
818 | ||
819 | /* The symbol used to be a common symbol, but now it is allocated. | |
820 | */ | |
821 | #define BSF_OLD_COMMON 0x800000 | |
822 | ||
823 | /* The default value for common data. | |
824 | */ | |
825 | #define BFD_FORT_COMM_DEFAULT_VALUE 0 | |
826 | ||
827 | /* In some files the type of a symbol sometimes alters its location | |
828 | in an output file - ie in coff a @code{ISFCN} symbol which is also @code{C_EXT} | |
829 | symbol appears where it was declared and not at the end of a section. | |
830 | This bit is set by the target bfd part to convey this information. | |
831 | */ | |
832 | #define BSF_NOT_AT_END 0x40000 | |
833 | flagword flags; | |
834 | ||
835 | /* Aointer to the section to which this symbol is relative, or 0 if the | |
836 | symbol is absolute or undefined. Note that it is not sufficient to set | |
837 | this location to 0 to mark a symbol as absolute - the flag | |
838 | @code{BSF_ABSOLUTE} must be set also. | |
839 | */ | |
840 | struct sec *section; | |
841 | ||
842 | /* Back end special data. This is being phased out in favour of making | |
843 | this a union. | |
844 | */ | |
845 | PTR udata; | |
846 | } asymbol; | |
847 | ||
848 | /* Returns the number of bytes required in a vector of pointers to | |
849 | @code{asymbols} for all the symbols in the supplied bfd, including a | |
850 | terminal NULL pointer. If there are no symbols in the bfd, then 0 is | |
851 | returned. | |
852 | */ | |
853 | #define get_symtab_upper_bound(abfd) \ | |
854 | BFD_SEND (abfd, _get_symtab_upper_bound, (abfd)) | |
855 | ||
856 | /* Supplied a bfd and a pointer to an uninitialized vector of pointers. | |
857 | This reads in the symbols from the bfd, and fills in the table with | |
858 | pointers to the symbols, and a trailing NULL. The routine returns the | |
859 | actual number of symbol pointers not including the NULL. | |
860 | ||
861 | */ | |
862 | #define bfd_canonicalize_symtab(abfd, location) \ | |
863 | BFD_SEND (abfd, _bfd_canonicalize_symtab,\ | |
864 | (abfd, location)) | |
865 | ||
866 | ||
867 | /* Provided a table of pointers to to symbols and a count, writes to the | |
868 | output bfd the symbols when closed. | |
869 | ||
870 | */ | |
871 | PROTO(boolean, bfd_set_symtab, (bfd *, asymbol **, unsigned int )); | |
872 | /* Prints the value and flags of the symbol supplied to the stream file. | |
873 | ||
874 | */ | |
875 | PROTO(void, bfd_print_symbol_vandf, (PTR file, asymbol *symbol)); | |
876 | /* This function creates a new @code{asymbol} structure for the bfd, and | |
877 | returns a pointer to it. | |
878 | ||
879 | This routine is necessary, since each back end has private information | |
880 | surrounding the @code{asymbol}. Building your own @code{asymbol} and | |
881 | pointing to it will not create the private information, and will cause | |
882 | problems later on. | |
883 | */ | |
884 | #define bfd_make_empty_symbol(abfd) \ | |
885 | BFD_SEND (abfd, _bfd_make_empty_symbol, (abfd)) | |
886 | ||
887 | /* @section typedef bfd | |
888 | ||
889 | Pointers to bfd structs are the cornerstone of any application using | |
890 | libbfd. References though the bfd and to data in the bfd give the | |
891 | entire bfd functionality. | |
892 | ||
893 | Finally! The BFD struct itself. This contains the major data about | |
894 | the file, and contains pointers to the rest of the data. | |
895 | ||
896 | */ | |
9c6a9c92 | 897 | struct _bfd |
a07cc613 | 898 | { |
7a276b09 SC |
899 | |
900 | /* The filename the application opened the bfd with. | |
901 | */ | |
902 | CONST char *filename; | |
903 | ||
904 | /* A pointer to the target jump table. | |
905 | */ | |
906 | struct bfd_target *xvec; | |
907 | ||
908 | /* To avoid dragging too many header files into every file that | |
909 | includes bfd.h, IOSTREAM has been declared as a "char *", and MTIME | |
910 | as a "long". Their correct types, to which they are cast when used, | |
911 | are "FILE *" and "time_t". | |
912 | ||
913 | The iostream is the result of an fopen on the filename. | |
914 | */ | |
915 | char *iostream; | |
916 | ||
a737c70b | 917 | /* Is the file being cached @xref{File Caching}. |
7a276b09 SC |
918 | */ |
919 | boolean cacheable; | |
920 | ||
921 | /* Marks whether there was a default target specified when the bfd was | |
922 | opened. This is used to select what matching algorithm to use to chose | |
923 | the back end. | |
924 | */ | |
925 | boolean target_defaulted; | |
926 | ||
927 | /* The caching routines use these to maintain an LRU list of bfds. | |
928 | */ | |
929 | struct _bfd *lru_prev, *lru_next; | |
930 | ||
931 | /* When a file is closed by the caching routines, it retains the state | |
932 | here: | |
933 | */ | |
934 | file_ptr where; | |
935 | ||
936 | /* and here: | |
937 | */ | |
a07cc613 | 938 | boolean opened_once; |
7a276b09 SC |
939 | boolean mtime_set; |
940 | ||
941 | /* File modified time | |
942 | */ | |
943 | long mtime; | |
944 | ||
945 | /* For output files, channel we locked (is this used?). | |
946 | */ | |
947 | int ifd; | |
948 | ||
949 | /* The format which belongs to the bfd. | |
950 | */ | |
a07cc613 | 951 | bfd_format format; |
a07cc613 | 952 | |
7a276b09 SC |
953 | /* The direction the bfd was opened with |
954 | */ | |
955 | enum bfd_direction {no_direction = 0, | |
956 | read_direction = 1, | |
957 | write_direction = 2, | |
958 | both_direction = 3} direction; | |
959 | ||
960 | /* Format_specific flags | |
961 | */ | |
962 | flagword flags; | |
963 | ||
964 | /* Currently my_archive is tested before adding origin to anything. I | |
965 | believe that this can become always an add of origin, with origin set | |
966 | to 0 for non archive files. | |
967 | */ | |
968 | file_ptr origin; | |
969 | ||
970 | /* Remember when output has begun, to stop strange things happening. | |
971 | */ | |
972 | boolean output_has_begun; | |
973 | ||
974 | /* Pointer to linked list of sections | |
975 | */ | |
976 | struct sec *sections; | |
977 | ||
978 | /* The number of sections | |
979 | */ | |
980 | unsigned int section_count; | |
981 | ||
982 | /* Stuff only usefull for object files: | |
983 | The start address. | |
984 | */ | |
985 | bfd_vma start_address; | |
986 | ||
987 | /* Used for input and output | |
988 | */ | |
989 | unsigned int symcount; | |
990 | ||
991 | /* Symtab for output bfd | |
992 | */ | |
993 | struct symbol_cache_entry **outsymbols; | |
994 | ||
995 | /* Architecture of object machine, eg m68k | |
996 | */ | |
997 | enum bfd_architecture obj_arch; | |
998 | ||
999 | /* Particular machine within arch, e.g. 68010 | |
1000 | */ | |
1001 | unsigned long obj_machine; | |
1002 | ||
1003 | /* Stuff only usefull for archives: | |
1004 | */ | |
1005 | PTR arelt_data; | |
1006 | struct _bfd *my_archive; | |
1007 | struct _bfd *next; | |
1008 | struct _bfd *archive_head; | |
1009 | boolean has_armap; | |
1010 | ||
1011 | /* Used by the back end to hold private data. | |
1012 | */ | |
1013 | PTR tdata; | |
1014 | ||
1015 | /* Used by the application to hold private data | |
1016 | */ | |
1017 | PTR usrdata; | |
1018 | ||
1019 | /* Where all the allocated stuff under this BFD goes | |
1020 | */ | |
a07cc613 JG |
1021 | struct obstack memory; |
1022 | }; | |
a07cc613 | 1023 | |
7a276b09 SC |
1024 | /* Marks the entry point of an output bfd. Returns @code{true} on |
1025 | success, @code{false} otherwise. | |
1026 | ||
1027 | */ | |
1028 | PROTO(boolean, bfd_set_start_address,(bfd *, bfd_vma)); | |
1029 | /* Return cached file modification time (e.g. as read from archive header | |
1030 | for archive members, or from file system if we have been called | |
1031 | before); else determine modify time, cache it, and return it. | |
a07cc613 | 1032 | |
7a276b09 | 1033 | */ |
e8929c8d | 1034 | PROTO(long, bfd_get_mtime, (bfd *));#define bfd_sizeof_headers(abfd, reloc) \ |
a07cc613 JG |
1035 | BFD_SEND (abfd, _bfd_sizeof_headers, (abfd, reloc)) |
1036 | ||
7a276b09 SC |
1037 | #define bfd_find_nearest_line(abfd, section, symbols, offset, filename_ptr, func, line_ptr) \ |
1038 | BFD_SEND (abfd, _bfd_find_nearest_line, (abfd, section, symbols, offset, filename_ptr, func, line_ptr)) | |
a07cc613 | 1039 | |
7a276b09 SC |
1040 | #define bfd_debug_info_start(abfd) \ |
1041 | BFD_SEND (abfd, _bfd_debug_info_start, (abfd)) | |
a07cc613 | 1042 | |
7a276b09 SC |
1043 | #define bfd_debug_info_end(abfd) \ |
1044 | BFD_SEND (abfd, _bfd_debug_info_end, (abfd)) | |
1045 | ||
1046 | #define bfd_debug_info_accumulate(abfd, section) \ | |
1047 | BFD_SEND (abfd, _bfd_debug_info_accumulate, (abfd, section)) | |
1048 | ||
1049 | #define bfd_stat_arch_elt(abfd, stat) \ | |
1050 | BFD_SEND (abfd, _bfd_stat_arch_elt,(abfd, stat)) | |
a07cc613 | 1051 | |
e8929c8d SC |
1052 | #define bfd_coff_swap_aux_in(a,e,t,c,i) \ |
1053 | BFD_SEND (a, _bfd_coff_swap_aux_in, (a,e,t,c,i)) | |
1054 | ||
1055 | #define bfd_coff_swap_sym_in(a,e,i) \ | |
1056 | BFD_SEND (a, _bfd_coff_swap_sym_in, (a,e,i)) | |
1057 | ||
1058 | #define bfd_coff_swap_lineno_in(a,e,i) \ | |
1059 | BFD_SEND ( a, _bfd_coff_swap_lineno_in, (a,e,i)) | |
1060 | ||
7a276b09 SC |
1061 | /* What this does |
1062 | */ | |
1063 | PROTO(symindex, bfd_get_next_mapent, (bfd *, symindex, carsym **)); | |
1064 | /* Used whilst processing archives. Sets the head of the chain of bfds | |
1065 | contained in an archive to @var{new_head}. (see chapter on archives) | |
e8929c8d | 1066 | |
7a276b09 SC |
1067 | */ |
1068 | PROTO(boolean, bfd_set_archive_head, (bfd *output, bfd *new_head)); | |
e8929c8d SC |
1069 | /* Hmm |
1070 | ||
1071 | */ | |
1072 | PROTO(bfd *, bfd_get_elt_at_index, (bfd *, int)); | |
7a276b09 SC |
1073 | /* Initially provided a bfd containing an archive and NULL, opens a bfd |
1074 | on the first contained element and returns that. Subsequent calls to | |
1075 | bfd_openr_next_archived_file should pass the archive and the previous | |
1076 | return value to return a created bfd to the next contained element. | |
1077 | NULL is returned when there are no more. | |
2700c3c7 | 1078 | |
7a276b09 SC |
1079 | */ |
1080 | PROTO(bfd*, bfd_openr_next_archived_file, | |
1081 | (bfd *archive, bfd *previous)); | |
a737c70b SC |
1082 | /* Returns a read-only string explaining what program was running when |
1083 | it failed and produced the core file being read | |
1084 | ||
1085 | */ | |
1086 | PROTO(CONST char *, bfd_core_file_failing_command, (bfd *)); | |
1087 | /* Returns the signal number which caused the core dump which generated | |
1088 | the file the bfd is attatched to. | |
1089 | ||
1090 | */ | |
1091 | PROTO(int, bfd_core_file_failing_signal, (bfd *)); | |
1092 | /* Returns @code{true} if the core file attatched to @var{core_bfd} was | |
1093 | generated by a run of the executable file attatched to @var{exec_bfd}, | |
1094 | or else @code{false}. | |
1095 | */ | |
1096 | PROTO(boolean, core_file_matches_executable_p, | |
1097 | (bfd *core_bfd, bfd *exec_bfd)); | |
7a276b09 | 1098 | /* The relocation routine returns as a status an enumerated type: |
2700c3c7 | 1099 | |
7a276b09 SC |
1100 | */ |
1101 | typedef enum bfd_reloc_status { | |
a07cc613 | 1102 | |
7a276b09 SC |
1103 | /* No errors detected |
1104 | */ | |
1105 | bfd_reloc_ok, | |
a07cc613 | 1106 | |
7a276b09 SC |
1107 | /* The relocation was performed, but there was an overflow. |
1108 | */ | |
1109 | bfd_reloc_overflow, | |
a07cc613 | 1110 | |
7a276b09 SC |
1111 | /* The address to relocate was not within the section supplied |
1112 | */ | |
1113 | bfd_reloc_outofrange, | |
a07cc613 | 1114 | |
7a276b09 SC |
1115 | /* Used by special functions |
1116 | */ | |
1117 | bfd_reloc_continue, | |
a07cc613 | 1118 | |
7a276b09 SC |
1119 | /* Unused |
1120 | */ | |
1121 | bfd_reloc_notsupported, | |
1122 | ||
1123 | /* Unsupported relocation size requested. | |
1124 | */ | |
1125 | bfd_reloc_other, | |
1126 | ||
1127 | /* The symbol to relocate against was undefined. | |
1128 | */ | |
1129 | bfd_reloc_undefined, | |
1130 | ||
1131 | /* The relocaction was performed, but may not be ok - presently generated | |
1132 | only when linking i960 coff files with i960 b.out symbols. | |
1133 | */ | |
1134 | bfd_reloc_dangerous | |
1135 | } | |
1136 | bfd_reloc_status_enum_type; | |
1137 | typedef struct reloc_cache_entry | |
1138 | { | |
1139 | ||
1140 | /* A pointer into the canonical table of pointers | |
1141 | */ | |
1142 | struct symbol_cache_entry **sym_ptr_ptr; | |
1143 | ||
1144 | /* offset in section | |
1145 | */ | |
1146 | rawdata_offset address; | |
1147 | ||
1148 | /* addend for relocation value | |
1149 | */ | |
1150 | bfd_vma addend; | |
1151 | ||
1152 | /* if sym is null this is the section | |
1153 | */ | |
1154 | struct sec *section; | |
1155 | ||
1156 | /* Pointer to how to perform the required relocation | |
1157 | */ | |
a737c70b | 1158 | CONST struct reloc_howto_struct *howto; |
7a276b09 SC |
1159 | } arelent; |
1160 | ||
1161 | /* The @code{reloc_howto_type} is a structure which contains all the | |
1162 | information that bfd needs to know to tie up a back end's data. | |
1163 | ||
1164 | */ | |
1165 | typedef CONST struct reloc_howto_struct | |
1166 | { | |
19b03b7a | 1167 | |
7a276b09 SC |
1168 | /* The type field has mainly a documetary use - the back end can to what |
1169 | it wants with it, though the normally the back end's external idea of | |
1170 | what a reloc number would be would be stored in this field. For | |
1171 | example, the a PC relative word relocation in a coff environment would | |
1172 | have the type 023 - because that's what the outside world calls a | |
1173 | R_PCRWORD reloc. | |
1174 | */ | |
1175 | unsigned int type; | |
a07cc613 | 1176 | |
7a276b09 SC |
1177 | /* The value the final relocation is shifted right by. This drops |
1178 | unwanted data from the relocation. | |
1179 | */ | |
1180 | unsigned int rightshift; | |
a07cc613 | 1181 | |
7a276b09 SC |
1182 | /* The size of the item to be relocated - 0, is one byte, 1 is 2 bytes, 3 |
1183 | is four bytes. | |
1184 | */ | |
1185 | unsigned int size; | |
9b9c5c39 | 1186 | |
7a276b09 SC |
1187 | /* Now obsolete |
1188 | */ | |
1189 | unsigned int bitsize; | |
a07cc613 | 1190 | |
7a276b09 SC |
1191 | /* Notes that the relocation is relative to the location in the data |
1192 | section of the addend. The relocation function will subtract from the | |
1193 | relocation value the address of the location being relocated. | |
1194 | */ | |
1195 | boolean pc_relative; | |
a07cc613 | 1196 | |
7a276b09 SC |
1197 | /* Now obsolete |
1198 | */ | |
1199 | unsigned int bitpos; | |
a07cc613 | 1200 | |
7a276b09 SC |
1201 | /* Now obsolete |
1202 | */ | |
1203 | boolean absolute; | |
19b03b7a | 1204 | |
7a276b09 SC |
1205 | /* Causes the relocation routine to return an error if overflow is |
1206 | detected when relocating. | |
1207 | */ | |
1208 | boolean complain_on_overflow; | |
a07cc613 | 1209 | |
7a276b09 SC |
1210 | /* If this field is non null, then the supplied function is called rather |
1211 | than the normal function. This allows really strange relocation | |
1212 | methods to be accomodated (eg, i960 callj instructions). | |
1213 | */ | |
1214 | bfd_reloc_status_enum_type (*special_function)(); | |
7f3d9f46 | 1215 | |
7a276b09 SC |
1216 | /* The textual name of the relocation type. |
1217 | */ | |
1218 | char *name; | |
7f3d9f46 | 1219 | |
7a276b09 SC |
1220 | /* When performing a partial link, some formats must modify the |
1221 | relocations rather than the data - this flag signals this. | |
1222 | */ | |
1223 | boolean partial_inplace; | |
1224 | ||
1225 | /* The src_mask is used to select what parts of the read in data are to | |
1226 | be used in the relocation sum. Eg, if this was an 8 bit bit of data | |
1227 | which we read and relocated, this would be 0x000000ff. When we have | |
1228 | relocs which have an addend, such as sun4 extended relocs, the value | |
1229 | in the offset part of a relocating field is garbage so we never use | |
1230 | it. In this case the mask would be 0x00000000. | |
1231 | */ | |
1232 | bfd_word src_mask; | |
1233 | ||
1234 | /* The dst_mask is what parts of the instruction are replaced into the | |
1235 | instruction. In most cases src_mask == dst_mask, except in the above | |
1236 | special case, where dst_mask would be 0x000000ff, and src_mask would | |
1237 | be 0x00000000. | |
1238 | */ | |
1239 | bfd_word dst_mask; | |
1240 | ||
1241 | /* When some formats create PC relative instructions, they leave the | |
1242 | value of the pc of the place being relocated in the offset slot of the | |
1243 | instruction, so that a PC relative relocation can be made just by | |
1244 | adding in an ordinary offset (eg sun3 a.out). Some formats leave the | |
1245 | displacement part of an instruction empty (eg m88k bcs), this flag | |
1246 | signals the fact. | |
1247 | */ | |
1248 | boolean pcrel_offset; | |
1249 | } reloc_howto_type; | |
1250 | ||
1251 | /* The HOWTO define is horrible and will go away. | |
4322f04d | 1252 | */ |
7a276b09 SC |
1253 | #define HOWTO(C, R,S,B, P, BI, ABS, O, SF, NAME, INPLACE, MASKSRC, MASKDST, PC) \ |
1254 | {(unsigned)C,R,S,B, P, BI, ABS,O,SF,NAME,INPLACE,MASKSRC,MASKDST,PC} | |
1255 | typedef unsigned char bfd_byte; | |
a07cc613 | 1256 | |
7a276b09 SC |
1257 | typedef struct relent_chain { |
1258 | arelent relent; | |
1259 | struct relent_chain *next; | |
1260 | } arelent_chain; | |
a07cc613 | 1261 | |
7f3d9f46 | 1262 | |
7a276b09 SC |
1263 | /* If an output_bfd is supplied to this function the generated image |
1264 | will be relocatable, the relocations are copied to the output file | |
1265 | after they have been changed to reflect the new state of the world. | |
1266 | There are two ways of reflecting the results of partial linkage in an | |
1267 | output file; by modifying the output data in place, and by modifying | |
1268 | the relocation record. Some native formats (eg basic a.out and basic | |
1269 | coff) have no way of specifying an addend in the relocation type, so | |
1270 | the addend has to go in the output data. This is no big deal since in | |
1271 | these formats the output data slot will always be big enough for the | |
1272 | addend. Complex reloc types with addends were invented to solve just | |
1273 | this problem. | |
1274 | */ | |
1275 | PROTO(bfd_reloc_status_enum_type, | |
1276 | bfd_perform_relocation, | |
1277 | (bfd * abfd, | |
1278 | arelent *reloc_entry, | |
1279 | PTR data, | |
1280 | asection *input_section, | |
1281 | bfd *output_bfd)); | |
1282 | /* @node bfd_target | |
a737c70b | 1283 | @subsection bfd_target |
7a276b09 SC |
1284 | This structure contains everything that BFD knows about a target. |
1285 | It includes things like its byte order, name, what routines to call | |
1286 | to do various operations, etc. | |
1287 | ||
1288 | Every BFD points to a target structure with its "xvec" member. | |
1289 | ||
1290 | ||
1291 | Shortcut for declaring fields which are prototyped function pointers, | |
1292 | while avoiding anguish on compilers that don't support protos. | |
1293 | */ | |
1294 | #define SDEF(ret, name, arglist) \ | |
1295 | PROTO(ret,(*name),arglist) | |
1296 | #define SDEF_FMT(ret, name, arglist) \ | |
1297 | PROTO(ret,(*name[bfd_type_end]),arglist) | |
a07cc613 | 1298 | |
7a276b09 SC |
1299 | /* These macros are used to dispatch to functions through the bfd_target |
1300 | vector. They are used in a number of macros further down in bfd.h, and | |
1301 | are also used when calling various routines by hand inside the bfd | |
1302 | implementation. The "arglist" argument must be parenthesized; it | |
1303 | contains all the arguments to the called function. | |
1304 | */ | |
1305 | #define BFD_SEND(bfd, message, arglist) \ | |
1306 | ((*((bfd)->xvec->message)) arglist) | |
a07cc613 | 1307 | |
7a276b09 SC |
1308 | /* For operations which index on the bfd format |
1309 | */ | |
1310 | #define BFD_SEND_FMT(bfd, message, arglist) \ | |
1311 | (((bfd)->xvec->message[(int)((bfd)->format)]) arglist) | |
a07cc613 | 1312 | |
7a276b09 SC |
1313 | /* This is the struct which defines the type of BFD this is. The |
1314 | "xvec" member of the struct bfd itself points here. Each module | |
1315 | that implements access to a different target under BFD, defines | |
1316 | one of these. | |
a07cc613 | 1317 | |
7a276b09 SC |
1318 | FIXME, these names should be rationalised with the names of the |
1319 | entry points which call them. Too bad we can't have one macro to | |
1320 | define them both! | |
a07cc613 | 1321 | |
7a276b09 SC |
1322 | */ |
1323 | typedef struct bfd_target | |
1324 | { | |
a07cc613 | 1325 | |
7a276b09 SC |
1326 | /* identifies the kind of target, eg SunOS4, Ultrix, etc |
1327 | */ | |
1328 | char *name; | |
1329 | ||
1330 | /* The "flavour" of a back end is a general indication about the contents | |
1331 | of a file. | |
1332 | */ | |
1333 | enum target_flavour_enum { | |
1334 | bfd_target_aout_flavour_enum, | |
1335 | bfd_target_coff_flavour_enum, | |
1336 | bfd_target_ieee_flavour_enum, | |
1337 | bfd_target_oasys_flavour_enum, | |
1338 | bfd_target_srec_flavour_enum} flavour; | |
1339 | ||
1340 | /* The order of bytes within the data area of a file. | |
1341 | */ | |
1342 | boolean byteorder_big_p; | |
1343 | ||
1344 | /* The order of bytes within the header parts of a file. | |
1345 | */ | |
1346 | boolean header_byteorder_big_p; | |
1347 | ||
1348 | /* This is a mask of all the flags which an executable may have set - | |
1349 | from the set @code{NO_FLAGS}, @code{HAS_RELOC}, ...@code{D_PAGED}. | |
1350 | */ | |
1351 | flagword object_flags; | |
1352 | ||
1353 | /* This is a mask of all the flags which a section may have set - from | |
1354 | the set @code{SEC_NO_FLAGS}, @code{SEC_ALLOC}, ...@code{SET_NEVER_LOAD}. | |
1355 | */ | |
1356 | flagword section_flags; | |
1357 | ||
1358 | /* The pad character for filenames within an archive header. | |
1359 | */ | |
1360 | char ar_pad_char; | |
1361 | ||
1362 | /* The maximum number of characters in an archive header. | |
1363 | */ | |
1364 | unsigned short ar_max_namelen; | |
1365 | ||
1366 | /* The minimum alignment restriction for any section. | |
1367 | */ | |
1368 | unsigned int align_power_min; | |
1369 | ||
1370 | /* Entries for byte swapping for data. These are different to the other | |
1371 | entry points, since they don't take bfd as first arg. Certain other handlers | |
1372 | could do the same. | |
1373 | */ | |
1374 | SDEF (bfd_64_type, bfd_getx64, (bfd_byte *)); | |
1375 | SDEF (void, bfd_putx64, (bfd_64_type, bfd_byte *)); | |
1376 | SDEF (unsigned int, bfd_getx32, (bfd_byte *)); | |
1377 | SDEF (void, bfd_putx32, (unsigned long, bfd_byte *)); | |
1378 | SDEF (unsigned int, bfd_getx16, (bfd_byte *)); | |
1379 | SDEF (void, bfd_putx16, (int, bfd_byte *)); | |
1380 | ||
1381 | /* Byte swapping for the headers | |
1382 | */ | |
1383 | SDEF (bfd_64_type, bfd_h_getx64, (bfd_byte *)); | |
1384 | SDEF (void, bfd_h_putx64, (bfd_64_type, bfd_byte *)); | |
1385 | SDEF (unsigned int, bfd_h_getx32, (bfd_byte *)); | |
1386 | SDEF (void, bfd_h_putx32, (unsigned long, bfd_byte *)); | |
1387 | SDEF (unsigned int, bfd_h_getx16, (bfd_byte *)); | |
1388 | SDEF (void, bfd_h_putx16, (int, bfd_byte *)); | |
1389 | ||
1390 | /* Format dependent routines, these turn into vectors of entry points | |
1391 | within the target vector structure; one for each format to check. | |
1392 | ||
1393 | Check the format of a file being read. Return bfd_target * or zero. | |
1394 | */ | |
1395 | SDEF_FMT (struct bfd_target *, _bfd_check_format, (bfd *)); | |
1396 | ||
1397 | /* Set the format of a file being written. | |
1398 | */ | |
1399 | SDEF_FMT (boolean, _bfd_set_format, (bfd *)); | |
1400 | ||
1401 | /* Write cached information into a file being written, at bfd_close. | |
1402 | */ | |
1403 | SDEF_FMT (boolean, _bfd_write_contents, (bfd *)); | |
1404 | ||
1405 | /* The following functions are defined in @code{JUMP_TABLE}. The idea is | |
1406 | that the back end writer of @code{foo} names all the routines | |
1407 | @code{foo_}@var{entry_point}, @code{JUMP_TABLE} will built the entries | |
1408 | in this structure in the right order. | |
1409 | ||
1410 | Core file entry points | |
1411 | */ | |
1412 | SDEF (char *, _core_file_failing_command, (bfd *)); | |
1413 | SDEF (int, _core_file_failing_signal, (bfd *)); | |
1414 | SDEF (boolean, _core_file_matches_executable_p, (bfd *, bfd *)); | |
1415 | ||
1416 | /* Archive entry points | |
1417 | */ | |
1418 | SDEF (boolean, _bfd_slurp_armap, (bfd *)); | |
1419 | SDEF (boolean, _bfd_slurp_extended_name_table, (bfd *)); | |
1420 | SDEF (void, _bfd_truncate_arname, (bfd *, CONST char *, char *)); | |
1421 | SDEF (boolean, write_armap, (bfd *arch, | |
1422 | unsigned int elength, | |
1423 | struct orl *map, | |
1424 | int orl_count, | |
1425 | int stridx)); | |
1426 | ||
1427 | /* Standard stuff. | |
1428 | */ | |
1429 | SDEF (boolean, _close_and_cleanup, (bfd *)); | |
1430 | SDEF (boolean, _bfd_set_section_contents, (bfd *, sec_ptr, PTR, | |
1431 | file_ptr, bfd_size_type)); | |
1432 | SDEF (boolean, _bfd_get_section_contents, (bfd *, sec_ptr, PTR, | |
1433 | file_ptr, bfd_size_type)); | |
1434 | SDEF (boolean, _new_section_hook, (bfd *, sec_ptr)); | |
1435 | ||
1436 | /* Symbols and reloctions | |
1437 | */ | |
1438 | SDEF (unsigned int, _get_symtab_upper_bound, (bfd *)); | |
1439 | SDEF (unsigned int, _bfd_canonicalize_symtab, | |
1440 | (bfd *, struct symbol_cache_entry **)); | |
1441 | SDEF (unsigned int, _get_reloc_upper_bound, (bfd *, sec_ptr)); | |
1442 | SDEF (unsigned int, _bfd_canonicalize_reloc, (bfd *, sec_ptr, arelent **, | |
1443 | struct symbol_cache_entry**)); | |
1444 | SDEF (struct symbol_cache_entry *, _bfd_make_empty_symbol, (bfd *)); | |
1445 | SDEF (void, _bfd_print_symbol, (bfd *, PTR, struct symbol_cache_entry *, | |
1446 | bfd_print_symbol_enum_type)); | |
1447 | #define bfd_print_symbol(b,p,s,e) BFD_SEND(b, _bfd_print_symbol, (b,p,s,e)) | |
1448 | SDEF (alent *, _get_lineno, (bfd *, struct symbol_cache_entry *)); | |
1449 | ||
1450 | SDEF (boolean, _bfd_set_arch_mach, (bfd *, enum bfd_architecture, | |
1451 | unsigned long)); | |
1452 | ||
1453 | SDEF (bfd *, openr_next_archived_file, (bfd *arch, bfd *prev)); | |
1454 | SDEF (boolean, _bfd_find_nearest_line, | |
1455 | (bfd *abfd, struct sec *section, | |
1456 | struct symbol_cache_entry **symbols,bfd_vma offset, | |
1457 | CONST char **file, CONST char **func, unsigned int *line)); | |
1458 | SDEF (int, _bfd_stat_arch_elt, (bfd *, struct stat *)); | |
1459 | ||
1460 | SDEF (int, _bfd_sizeof_headers, (bfd *, boolean)); | |
1461 | ||
1462 | SDEF (void, _bfd_debug_info_start, (bfd *)); | |
1463 | SDEF (void, _bfd_debug_info_end, (bfd *)); | |
1464 | SDEF (void, _bfd_debug_info_accumulate, (bfd *, struct sec *)); | |
1465 | ||
1466 | /* Special entry points for gdb to swap in coff symbol table parts | |
1467 | */ | |
1468 | SDEF(void, _bfd_coff_swap_aux_in,( | |
1469 | bfd *abfd , | |
1470 | PTR ext, | |
1471 | int type, | |
1472 | int class , | |
1473 | PTR in)); | |
1474 | ||
1475 | SDEF(void, _bfd_coff_swap_sym_in,( | |
1476 | bfd *abfd , | |
1477 | PTR ext, | |
1478 | PTR in)); | |
1479 | ||
1480 | SDEF(void, _bfd_coff_swap_lineno_in, ( | |
1481 | bfd *abfd, | |
1482 | PTR ext, | |
1483 | PTR in)); | |
1484 | ||
1485 | } bfd_target; | |
1486 | ||
1487 | /* Returns a pointer to the transfer vector for the object target | |
1488 | named target_name. If target_name is NULL, chooses the one in the | |
1489 | environment variable GNUTARGET; if that is null or not defined then | |
1490 | the first entry in the target list is chosen. Passing in the | |
1491 | string "default" or setting the environment variable to "default" | |
1492 | will cause the first entry in the target list to be returned, | |
1493 | and "target_defaulted" will be set in the bfd. This causes | |
1494 | bfd_check_format to loop over all the targets to find the one | |
1495 | that matches the file being read. | |
1496 | */ | |
1497 | PROTO(bfd_target *, bfd_find_target,(CONST char *, bfd *)); | |
1498 | /* This function returns a freshly malloced NULL-terminated vector of the | |
1499 | names of all the valid bfd targets. Do not modify the names | |
1500 | */ | |
1501 | PROTO(CONST char **,bfd_target_list,()); | |
1502 | /* This routine is supplied a bfd and a format. It attempts to verify if | |
1503 | the file attatched to the bfd is indeed compatible with the format | |
1504 | specified (ie, one of @code{bfd_object}, @code{bfd_archive} or | |
1505 | @code{bfd_core}). | |
1506 | ||
1507 | If the bfd has been set to a specific @var{target} before the call, | |
1508 | only the named target and format combination will be checked. If the | |
1509 | target has not been set, or has been set to @code{default} then all | |
1510 | the known target backends will be interrogated to determine a match. | |
1511 | ||
1512 | The function returns @code{true} on success, otherwise @code{false} | |
1513 | with one of the following error codes: | |
1514 | @table @code | |
1515 | @item | |
1516 | invalid_operation | |
1517 | if @code{format} is not one of @code{bfd_object}, @code{bfd_archive} | |
1518 | or @code{bfd_core}. | |
1519 | @item system_call_error | |
1520 | if an error occured during a read - even some file mismatches can | |
1521 | cause system_call_errros | |
1522 | @item file_not_recognised | |
1523 | none of the backends recognised the file format | |
1524 | @item file_ambiguously_recognized | |
1525 | more than one backend recognised the file format. | |
1526 | @end table | |
1527 | */ | |
1528 | PROTO(boolean, bfd_check_format, (bfd *abfd, bfd_format format)); | |
1529 | /* This function sets the file format of the supplied bfd to the format | |
1530 | requested. If the target set in the bfd does not support the format | |
1531 | requested, the format is illegal or the bfd is not open for writing | |
1532 | than an error occurs. | |
1533 | */ | |
1534 | PROTO(boolean,bfd_set_format,(bfd *, bfd_format)); | |
1535 | /* This function takes one argument, and enumerated type (bfd_format) and | |
1536 | returns a pointer to a const string "invalid", "object", "archive", | |
1537 | "core" or "unknown" depending upon the value of the enumeration. | |
1538 | */ | |
1539 | PROTO(CONST char *, bfd_format_string, (bfd_format)); | |
1540 | #endif | |
a07cc613 | 1541 |