Commit | Line | Data |
---|---|---|
095c7223 JG |
1 | /* A -*- C -*- header file for the bfd library |
2 | Copyright 1990, 1991 Free Software Foundation, Inc. | |
3 | Contributed by Cygnus Support. | |
a07cc613 | 4 | |
2c346475 | 5 | This file is part of BFD, the Binary File Descriptor library. |
a07cc613 | 6 | |
095c7223 | 7 | This program is free software; you can redistribute it and/or modify |
a07cc613 | 8 | it under the terms of the GNU General Public License as published by |
095c7223 JG |
9 | the Free Software Foundation; either version 2 of the License, or |
10 | (at your option) any later version. | |
a07cc613 | 11 | |
095c7223 | 12 | This program is distributed in the hope that it will be useful, |
a07cc613 JG |
13 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
15 | GNU General Public License for more details. | |
16 | ||
17 | You should have received a copy of the GNU General Public License | |
095c7223 JG |
18 | along with this program; if not, write to the Free Software |
19 | Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */ | |
20 | ||
21 | /* bfd.h -- The only header file required by users of the bfd library | |
22 | ||
23 | This file is generated from various .c files, if you change it, your | |
24 | bits may be lost. | |
25 | ||
26 | All the prototypes and definitions following the comment "THE FOLLOWING | |
27 | IS EXTRACTED FROM THE SOURCE" are extracted from the source files for | |
28 | BFD. If you change it, someone oneday will extract it from the source | |
29 | again, and your changes will be lost. To save yourself from this bind, | |
30 | change the definitions in the source in the bfd directory. Type "make | |
31 | docs" and then "make headers" in that directory, and magically this file | |
32 | will change to reflect your changes. | |
33 | ||
34 | If you don't have the tools to perform the extraction, then you are | |
35 | safe from someone on your system trampling over your header files. | |
36 | You should still maintain the equivalence between the source and this | |
37 | file though; every change you make to the .c file should be reflected | |
38 | here. */ | |
a07cc613 | 39 | |
a07cc613 JG |
40 | #ifndef __BFD_H_SEEN__ |
41 | #define __BFD_H_SEEN__ | |
42 | ||
43 | #include "ansidecl.h" | |
44 | #include "obstack.h" | |
45 | ||
46 | /* Make it easier to declare prototypes (puts conditional here) */ | |
47 | #ifndef PROTO | |
48 | # if __STDC__ | |
49 | # define PROTO(type, name, arglist) type name arglist | |
50 | # else | |
51 | # define PROTO(type, name, arglist) type name () | |
52 | # endif | |
53 | #endif | |
54 | ||
40a08432 | 55 | #define BFD_VERSION "0.18" |
ec08b077 | 56 | |
a07cc613 | 57 | /* forward declaration */ |
9c6a9c92 | 58 | typedef struct _bfd bfd; |
a07cc613 | 59 | |
ec08b077 JG |
60 | /* General rules: functions which are boolean return true on success |
61 | and false on failure (unless they're a predicate). -- bfd.doc */ | |
a07cc613 JG |
62 | /* I'm sure this is going to break something and someone is going to |
63 | force me to change it. */ | |
f7cfc4a6 JG |
64 | /* typedef enum boolean {false, true} boolean; */ |
65 | /* Yup, SVR4 has a "typedef enum boolean" in <sys/types.h> -fnf */ | |
66 | typedef enum bfd_boolean {false, true} boolean; | |
a07cc613 JG |
67 | |
68 | /* Try to avoid breaking stuff */ | |
69 | typedef long int file_ptr; | |
70 | ||
9b9c5c39 | 71 | /* Support for different sizes of target format ints and addresses */ |
19b03b7a | 72 | |
9b9c5c39 | 73 | #ifdef HOST_64_BIT |
7ed4093a SC |
74 | typedef HOST_64_BIT rawdata_offset; |
75 | typedef HOST_64_BIT bfd_vma; | |
76 | typedef HOST_64_BIT bfd_word; | |
77 | typedef HOST_64_BIT bfd_offset; | |
78 | typedef HOST_64_BIT bfd_size_type; | |
9b9c5c39 | 79 | typedef HOST_64_BIT symvalue; |
7ed4093a | 80 | typedef HOST_64_BIT bfd_64_type; |
9b9c5c39 JG |
81 | #define fprintf_vma(s,x) \ |
82 | fprintf(s,"%08x%08x", uint64_typeHIGH(x), uint64_typeLOW(x)) | |
83 | #define printf_vma(x) \ | |
84 | printf( "%08x%08x", uint64_typeHIGH(x), uint64_typeLOW(x)) | |
19b03b7a | 85 | #else |
9b9c5c39 JG |
86 | typedef struct {int a,b;} bfd_64_type; |
87 | typedef unsigned long rawdata_offset; | |
a07cc613 JG |
88 | typedef unsigned long bfd_vma; |
89 | typedef unsigned long bfd_offset; | |
19b03b7a SC |
90 | typedef unsigned long bfd_word; |
91 | typedef unsigned long bfd_size; | |
92 | typedef unsigned long symvalue; | |
93 | typedef unsigned long bfd_size_type; | |
a737c70b SC |
94 | #define printf_vma(x) printf( "%08lx", x) |
95 | #define fprintf_vma(s,x) fprintf(s, "%08lx", x) | |
19b03b7a | 96 | #endif |
a07cc613 JG |
97 | |
98 | typedef unsigned int flagword; /* 32 bits of flags */ | |
99 | \f | |
100 | /** File formats */ | |
101 | ||
102 | typedef enum bfd_format { | |
103 | bfd_unknown = 0, /* file format is unknown */ | |
104 | bfd_object, /* linker/assember/compiler output */ | |
105 | bfd_archive, /* object archive file */ | |
106 | bfd_core, /* core dump */ | |
107 | bfd_type_end} /* marks the end; don't use it! */ | |
108 | bfd_format; | |
109 | ||
110 | /* Object file flag values */ | |
9b9c5c39 | 111 | #define NO_FLAGS 0 |
a07cc613 JG |
112 | #define HAS_RELOC 001 |
113 | #define EXEC_P 002 | |
114 | #define HAS_LINENO 004 | |
115 | #define HAS_DEBUG 010 | |
116 | #define HAS_SYMS 020 | |
117 | #define HAS_LOCALS 040 | |
118 | #define DYNAMIC 0100 | |
119 | #define WP_TEXT 0200 | |
120 | #define D_PAGED 0400 | |
121 | ||
a07cc613 JG |
122 | \f |
123 | /* symbols and relocation */ | |
124 | ||
125 | typedef unsigned long symindex; | |
126 | ||
127 | #define BFD_NO_MORE_SYMBOLS ((symindex) ~0) | |
128 | ||
fb3ee1c0 JG |
129 | typedef enum bfd_symclass { |
130 | bfd_symclass_unknown = 0, | |
a07cc613 JG |
131 | bfd_symclass_fcommon, /* fortran common symbols */ |
132 | bfd_symclass_global, /* global symbol, what a surprise */ | |
133 | bfd_symclass_debugger, /* some debugger symbol */ | |
134 | bfd_symclass_undefined /* none known */ | |
135 | } symclass; | |
136 | ||
19b03b7a | 137 | |
a07cc613 | 138 | typedef int symtype; /* Who knows, yet? */ |
19b03b7a | 139 | |
a07cc613 | 140 | |
9b9c5c39 JG |
141 | /* general purpose part of a symbol; |
142 | target specific parts will be found in libcoff.h, liba.out.h etc */ | |
7a276b09 | 143 | |
a07cc613 JG |
144 | |
145 | #define bfd_get_section(x) ((x)->section) | |
146 | #define bfd_get_output_section(x) ((x)->section->output_section) | |
147 | #define bfd_set_section(x,y) ((x)->section) = (y) | |
148 | #define bfd_asymbol_base(x) ((x)->section?((x)->section->vma):0) | |
149 | #define bfd_asymbol_value(x) (bfd_asymbol_base(x) + x->value) | |
150 | #define bfd_asymbol_name(x) ((x)->name) | |
151 | ||
a07cc613 | 152 | /* This is a type pun with struct ranlib on purpose! */ |
9c6a9c92 | 153 | typedef struct carsym { |
a07cc613 JG |
154 | char *name; |
155 | file_ptr file_offset; /* look here to find the file */ | |
156 | } carsym; /* to make these you call a carsymogen */ | |
157 | ||
a07cc613 JG |
158 | |
159 | /* Used in generating armaps. Perhaps just a forward definition would do? */ | |
160 | struct orl { /* output ranlib */ | |
161 | char **name; /* symbol name */ | |
c93e2c55 | 162 | file_ptr pos; /* bfd* or file position */ |
a07cc613 JG |
163 | int namidx; /* index into string table */ |
164 | }; | |
165 | ||
166 | \f | |
167 | ||
168 | /* Linenumber stuff */ | |
169 | typedef struct lineno_cache_entry { | |
170 | unsigned int line_number; /* Linenumber from start of function*/ | |
171 | union { | |
7a276b09 | 172 | struct symbol_cache_entry *sym; /* Function name */ |
a07cc613 JG |
173 | unsigned long offset; /* Offset into section */ |
174 | } u; | |
175 | } alent; | |
176 | \f | |
177 | /* object and core file sections */ | |
178 | ||
a07cc613 JG |
179 | |
180 | #define align_power(addr, align) \ | |
181 | ( ((addr) + ((1<<(align))-1)) & (-1 << (align))) | |
182 | ||
9c6a9c92 | 183 | typedef struct sec *sec_ptr; |
a07cc613 JG |
184 | |
185 | #define bfd_section_name(bfd, ptr) ((ptr)->name) | |
186 | #define bfd_section_size(bfd, ptr) ((ptr)->size) | |
187 | #define bfd_section_vma(bfd, ptr) ((ptr)->vma) | |
188 | #define bfd_section_alignment(bfd, ptr) ((ptr)->alignment_power) | |
189 | #define bfd_get_section_flags(bfd, ptr) ((ptr)->flags) | |
190 | #define bfd_get_section_userdata(bfd, ptr) ((ptr)->userdata) | |
191 | ||
192 | #define bfd_set_section_vma(bfd, ptr, val) (((ptr)->vma = (val)), true) | |
193 | #define bfd_set_section_alignment(bfd, ptr, val) (((ptr)->alignment_power = (val)),true) | |
194 | #define bfd_set_section_userdata(bfd, ptr, val) (((ptr)->userdata = (val)),true) | |
4322f04d SC |
195 | |
196 | typedef struct stat stat_type; | |
a07cc613 JG |
197 | \f |
198 | /** Error handling */ | |
199 | ||
fb3ee1c0 JG |
200 | typedef enum bfd_error { |
201 | no_error = 0, system_call_error, invalid_target, | |
a07cc613 JG |
202 | wrong_format, invalid_operation, no_memory, |
203 | no_symbols, no_relocation_info, | |
204 | no_more_archived_files, malformed_archive, | |
205 | symbol_not_found, file_not_recognized, | |
206 | file_ambiguously_recognized, no_contents, | |
207 | bfd_error_nonrepresentable_section, | |
208 | invalid_error_code} bfd_ec; | |
209 | ||
210 | extern bfd_ec bfd_error; | |
211 | ||
9c6a9c92 | 212 | typedef struct bfd_error_vector { |
a07cc613 JG |
213 | PROTO(void,(* nonrepresentable_section ),(CONST bfd *CONST abfd, |
214 | CONST char *CONST name)); | |
215 | } bfd_error_vector_type; | |
216 | ||
217 | PROTO (char *, bfd_errmsg, ()); | |
218 | PROTO (void, bfd_perror, (CONST char *message)); | |
219 | \f | |
220 | ||
9b9c5c39 | 221 | typedef enum bfd_print_symbol |
a07cc613 JG |
222 | { |
223 | bfd_print_symbol_name_enum, | |
224 | bfd_print_symbol_type_enum, | |
19b03b7a | 225 | bfd_print_symbol_all_enum |
9b9c5c39 | 226 | } bfd_print_symbol_enum_type; |
a07cc613 JG |
227 | |
228 | \f | |
a07cc613 JG |
229 | \f |
230 | /* The code that implements targets can initialize a jump table with this | |
231 | macro. It must name all its routines the same way (a prefix plus | |
232 | the standard routine suffix), or it must #define the routines that | |
233 | are not so named, before calling JUMP_TABLE in the initializer. */ | |
234 | ||
235 | /* Semi-portable string concatenation in cpp */ | |
236 | #ifndef CAT | |
237 | #ifdef __STDC__ | |
238 | #define CAT(a,b) a##b | |
239 | #else | |
240 | #define CAT(a,b) a/**/b | |
241 | #endif | |
242 | #endif | |
243 | ||
244 | #define JUMP_TABLE(NAME)\ | |
245 | CAT(NAME,_core_file_failing_command),\ | |
246 | CAT(NAME,_core_file_failing_signal),\ | |
247 | CAT(NAME,_core_file_matches_executable_p),\ | |
248 | CAT(NAME,_slurp_armap),\ | |
249 | CAT(NAME,_slurp_extended_name_table),\ | |
250 | CAT(NAME,_truncate_arname),\ | |
251 | CAT(NAME,_write_armap),\ | |
252 | CAT(NAME,_close_and_cleanup), \ | |
253 | CAT(NAME,_set_section_contents),\ | |
254 | CAT(NAME,_get_section_contents),\ | |
255 | CAT(NAME,_new_section_hook),\ | |
256 | CAT(NAME,_get_symtab_upper_bound),\ | |
257 | CAT(NAME,_get_symtab),\ | |
258 | CAT(NAME,_get_reloc_upper_bound),\ | |
259 | CAT(NAME,_canonicalize_reloc),\ | |
260 | CAT(NAME,_make_empty_symbol),\ | |
261 | CAT(NAME,_print_symbol),\ | |
262 | CAT(NAME,_get_lineno),\ | |
263 | CAT(NAME,_set_arch_mach),\ | |
264 | CAT(NAME,_openr_next_archived_file),\ | |
265 | CAT(NAME,_find_nearest_line),\ | |
266 | CAT(NAME,_generic_stat_arch_elt),\ | |
7a276b09 SC |
267 | CAT(NAME,_sizeof_headers),\ |
268 | CAT(NAME,_bfd_debug_info_start),\ | |
269 | CAT(NAME,_bfd_debug_info_end),\ | |
270 | CAT(NAME,_bfd_debug_info_accumulate) | |
2700c3c7 SC |
271 | |
272 | #define COFF_SWAP_TABLE coff_swap_aux_in, coff_swap_sym_in, coff_swap_lineno_in, | |
a07cc613 JG |
273 | \f |
274 | /* User program access to BFD facilities */ | |
275 | ||
276 | extern CONST short _bfd_host_big_endian; | |
277 | #define HOST_BYTE_ORDER_BIG_P (*(char *)&_bfd_host_big_endian) | |
278 | ||
279 | /* The bfd itself */ | |
280 | ||
8c01a0ea JK |
281 | /* Cast from const char * to char * so that caller can assign to |
282 | a char * without a warning. */ | |
283 | #define bfd_get_filename(abfd) ((char *) (abfd)->filename) | |
a07cc613 JG |
284 | #define bfd_get_format(abfd) ((abfd)->format) |
285 | #define bfd_get_target(abfd) ((abfd)->xvec->name) | |
286 | #define bfd_get_file_flags(abfd) ((abfd)->flags) | |
287 | #define bfd_applicable_file_flags(abfd) ((abfd)->xvec->object_flags) | |
288 | #define bfd_applicable_section_flags(abfd) ((abfd)->xvec->section_flags) | |
289 | #define bfd_my_archive(abfd) ((abfd)->my_archive); | |
290 | #define bfd_has_map(abfd) ((abfd)->has_armap) | |
291 | #define bfd_header_twiddle_required(abfd) \ | |
292 | ((((abfd)->xvec->header_byteorder_big_p) \ | |
293 | != (boolean)HOST_BYTE_ORDER_BIG_P) ? true:false) | |
294 | ||
295 | #define bfd_valid_reloc_types(abfd) ((abfd)->xvec->valid_reloc_types) | |
296 | #define bfd_usrdata(abfd) ((abfd)->usrdata) | |
297 | ||
298 | #define bfd_get_start_address(abfd) ((abfd)->start_address) | |
299 | #define bfd_get_symcount(abfd) ((abfd)->symcount) | |
300 | #define bfd_get_outsymbols(abfd) ((abfd)->outsymbols) | |
301 | #define bfd_count_sections(abfd) ((abfd)->section_count) | |
302 | #define bfd_get_architecture(abfd) ((abfd)->obj_arch) | |
303 | #define bfd_get_machine(abfd) ((abfd)->obj_machine) | |
304 | ||
a07cc613 | 305 | |
a07cc613 | 306 | |
7a276b09 SC |
307 | #define BYTE_SIZE 1 |
308 | #define SHORT_SIZE 2 | |
309 | #define LONG_SIZE 4 | |
310 | ||
311 | ||
312 | ||
313 | /*THE FOLLOWING IS EXTRACTED FROM THE SOURCE */ | |
314 | ||
b39096a4 SC |
315 | |
316 | /*:init.c*/ | |
317 | /* bfd_init | |
318 | ||
319 | This routine must be called before any other bfd function to initialize | |
320 | magical internal data structures. | |
321 | */ | |
322 | ||
323 | void EXFUN(bfd_init,(void)); | |
324 | ||
325 | /* | |
326 | */ | |
327 | ||
1ac2d1f2 RP |
328 | /*:opncls.c*/ |
329 | /* *i bfd_openr | |
2f60a880 RP |
330 | Opens the file supplied (using @code{fopen}) with the target supplied, it |
331 | returns a pointer to the created BFD. | |
7a276b09 SC |
332 | |
333 | If NULL is returned then an error has occured. | |
334 | Possible errors are no_memory, invalid_target or system_call error. | |
335 | */ | |
bded7de2 SC |
336 | PROTO(bfd*, bfd_openr, (CONST char *filename,CONST char*target)); |
337 | ||
338 | /* | |
339 | ||
340 | *i bfd_fdopenr | |
2f60a880 | 341 | bfd_fdopenr is to bfd_fopenr much like fdopen is to fopen. It opens a BFD on |
7a276b09 SC |
342 | a file already described by the @var{fd} supplied. |
343 | ||
344 | Possible errors are no_memory, invalid_target and system_call error. | |
345 | */ | |
bded7de2 | 346 | PROTO(bfd *, bfd_fdopenr, |
7a276b09 | 347 | (CONST char *filename, CONST char *target, int fd)); |
bded7de2 SC |
348 | |
349 | /* | |
350 | ||
351 | bfd_openw | |
2f60a880 | 352 | Creates a BFD, associated with file @var{filename}, using the file |
7a276b09 SC |
353 | format @var{target}, and returns a pointer to it. |
354 | ||
355 | Possible errors are system_call_error, no_memory, invalid_target. | |
356 | */ | |
bded7de2 SC |
357 | PROTO(bfd *, bfd_openw, (CONST char *filename, CONST char *target)); |
358 | ||
359 | /* | |
360 | ||
361 | bfd_close | |
2f60a880 | 362 | This function closes a BFD. If the BFD was open for writing, then |
7a276b09 SC |
363 | pending operations are completed and the file written out and closed. |
364 | If the created file is executable, then @code{chmod} is called to mark | |
365 | it as such. | |
366 | ||
2f60a880 | 367 | All memory attached to the BFD's obstacks is released. |
7a276b09 SC |
368 | |
369 | @code{true} is returned if all is ok, otherwise @code{false}. | |
370 | */ | |
bded7de2 SC |
371 | PROTO(boolean, bfd_close,(bfd *)); |
372 | ||
373 | /* | |
374 | ||
375 | bfd_create | |
2f60a880 RP |
376 | This routine creates a new BFD in the manner of @code{bfd_openw}, but without |
377 | opening a file. The new BFD takes the target from the target used by | |
7a276b09 | 378 | @var{template}. The format is always set to @code{bfd_object}. |
7a276b09 | 379 | */ |
bded7de2 SC |
380 | |
381 | PROTO(bfd *, bfd_create, (CONST char *filename, bfd *template)); | |
382 | ||
383 | /* | |
384 | ||
385 | bfd_alloc_size | |
386 | Return the number of bytes in the obstacks connected to the supplied | |
2f60a880 | 387 | BFD. |
7a276b09 | 388 | */ |
bded7de2 SC |
389 | PROTO(bfd_size_type,bfd_alloc_size,(bfd *abfd)); |
390 | ||
391 | /* | |
1ac2d1f2 | 392 | */ |
bded7de2 | 393 | |
7a276b09 | 394 | |
1ac2d1f2 RP |
395 | /*:libbfd.c*/ |
396 | /* *i bfd_put_size | |
bded7de2 SC |
397 | *i bfd_get_size |
398 | These macros as used for reading and writing raw data in sections; | |
7a276b09 | 399 | each access (except for bytes) is vectored through the target format |
2f60a880 | 400 | of the BFD and mangled accordingly. The mangling performs any |
7a276b09 SC |
401 | necessary endian translations and removes alignment restrictions. |
402 | */ | |
403 | #define bfd_put_8(abfd, val, ptr) \ | |
404 | (*((char *)ptr) = (char)val) | |
405 | #define bfd_get_8(abfd, ptr) \ | |
406 | (*((char *)ptr)) | |
407 | #define bfd_put_16(abfd, val, ptr) \ | |
408 | BFD_SEND(abfd, bfd_putx16, (val,ptr)) | |
409 | #define bfd_get_16(abfd, ptr) \ | |
410 | BFD_SEND(abfd, bfd_getx16, (ptr)) | |
411 | #define bfd_put_32(abfd, val, ptr) \ | |
412 | BFD_SEND(abfd, bfd_putx32, (val,ptr)) | |
413 | #define bfd_get_32(abfd, ptr) \ | |
414 | BFD_SEND(abfd, bfd_getx32, (ptr)) | |
415 | #define bfd_put_64(abfd, val, ptr) \ | |
416 | BFD_SEND(abfd, bfd_putx64, (val, ptr)) | |
417 | #define bfd_get_64(abfd, ptr) \ | |
418 | BFD_SEND(abfd, bfd_getx64, (ptr)) | |
bded7de2 SC |
419 | /* *i bfd_h_put_size |
420 | *i bfd_h_get_size | |
421 | These macros have the same function as their @code{bfd_get_x} | |
7a276b09 SC |
422 | bretherin, except that they are used for removing information for the |
423 | header records of object files. Believe it or not, some object files | |
424 | keep their header records in big endian order, and their data in little | |
425 | endan order. | |
426 | */ | |
427 | #define bfd_h_put_8(abfd, val, ptr) \ | |
428 | (*((char *)ptr) = (char)val) | |
429 | #define bfd_h_get_8(abfd, ptr) \ | |
430 | (*((char *)ptr)) | |
431 | #define bfd_h_put_16(abfd, val, ptr) \ | |
432 | BFD_SEND(abfd, bfd_h_putx16,(val,ptr)) | |
433 | #define bfd_h_get_16(abfd, ptr) \ | |
434 | BFD_SEND(abfd, bfd_h_getx16,(ptr)) | |
435 | #define bfd_h_put_32(abfd, val, ptr) \ | |
436 | BFD_SEND(abfd, bfd_h_putx32,(val,ptr)) | |
437 | #define bfd_h_get_32(abfd, ptr) \ | |
438 | BFD_SEND(abfd, bfd_h_getx32,(ptr)) | |
439 | #define bfd_h_put_64(abfd, val, ptr) \ | |
440 | BFD_SEND(abfd, bfd_h_putx64,(val, ptr)) | |
441 | #define bfd_h_get_64(abfd, ptr) \ | |
442 | BFD_SEND(abfd, bfd_h_getx64,(ptr)) | |
7a276b09 | 443 | |
1ac2d1f2 RP |
444 | /*:section.c*/ |
445 | /* The shape of a section struct: | |
7a276b09 | 446 | */ |
bded7de2 | 447 | |
7a276b09 SC |
448 | typedef struct sec { |
449 | ||
bded7de2 SC |
450 | /* |
451 | The name of the section, the name isn't a copy, the pointer is | |
452 | the same as that passed to bfd_make_section. | |
453 | */ | |
454 | ||
7a276b09 SC |
455 | CONST char *name; |
456 | ||
bded7de2 | 457 | /* |
2f60a880 | 458 | The next section in the list belonging to the BFD, or NULL. |
bded7de2 SC |
459 | */ |
460 | ||
7a276b09 SC |
461 | struct sec *next; |
462 | ||
bded7de2 SC |
463 | /* |
464 | The field flags contains attributes of the section. Some of these | |
465 | flags are read in from the object file, and some are synthesized from | |
466 | other information. | |
467 | */ | |
468 | ||
7a276b09 | 469 | flagword flags; |
bded7de2 SC |
470 | |
471 | /* | |
472 | */ | |
473 | ||
7a276b09 SC |
474 | #define SEC_NO_FLAGS 0x000 |
475 | ||
bded7de2 SC |
476 | /* |
477 | Tells the OS to allocate space for this section when loaded. | |
478 | This would clear for a section containing debug information only. | |
479 | */ | |
480 | ||
7a276b09 SC |
481 | #define SEC_ALLOC 0x001 |
482 | ||
bded7de2 SC |
483 | /* |
484 | Tells the OS to load the section from the file when loading. | |
485 | This would be clear for a .bss section | |
486 | */ | |
487 | ||
7a276b09 SC |
488 | #define SEC_LOAD 0x002 |
489 | ||
bded7de2 SC |
490 | /* |
491 | The section contains data still to be relocated, so there will be some | |
492 | relocation information too. | |
493 | */ | |
494 | ||
7a276b09 SC |
495 | #define SEC_RELOC 0x004 |
496 | ||
bded7de2 SC |
497 | /* |
498 | Obsolete ? | |
499 | */ | |
500 | ||
7a276b09 SC |
501 | #define SEC_BALIGN 0x008 |
502 | ||
bded7de2 SC |
503 | /* |
504 | A signal to the OS that the section contains read only data. | |
505 | */ | |
506 | ||
7a276b09 SC |
507 | #define SEC_READONLY 0x010 |
508 | ||
bded7de2 SC |
509 | /* |
510 | The section contains code only. | |
511 | */ | |
512 | ||
7a276b09 SC |
513 | #define SEC_CODE 0x020 |
514 | ||
bded7de2 SC |
515 | /* |
516 | The section contains data only. | |
517 | */ | |
518 | ||
7a276b09 SC |
519 | #define SEC_DATA 0x040 |
520 | ||
bded7de2 SC |
521 | /* |
522 | The section will reside in ROM. | |
523 | */ | |
524 | ||
7a276b09 SC |
525 | #define SEC_ROM 0x080 |
526 | ||
bded7de2 SC |
527 | /* |
528 | The section contains constructor information. This section type is | |
529 | used by the linker to create lists of constructors and destructors | |
530 | used by @code{g++}. When a back end sees a symbol which should be used | |
531 | in a constructor list, it creates a new section for the type of name | |
2f60a880 | 532 | (eg @code{__CTOR_LIST__}), attaches the symbol to it and builds a |
bded7de2 SC |
533 | relocation. To build the lists of constructors, all the linker has to |
534 | to is catenate all the sections called @code{__CTOR_LIST__} and | |
535 | relocte the data contained within - exactly the operations it would | |
536 | peform on standard data. | |
537 | */ | |
538 | ||
7a276b09 SC |
539 | #define SEC_CONSTRUCTOR 0x100 |
540 | ||
bded7de2 SC |
541 | /* |
542 | The section is a constuctor, and should be placed at the end of the .. | |
543 | */ | |
544 | ||
1c6c6598 | 545 | #define SEC_CONSTRUCTOR_TEXT 0x1100 |
bded7de2 SC |
546 | |
547 | /* | |
548 | */ | |
1c6c6598 | 549 | #define SEC_CONSTRUCTOR_DATA 0x2100 |
bded7de2 SC |
550 | |
551 | /* | |
552 | */ | |
1c6c6598 SC |
553 | #define SEC_CONSTRUCTOR_BSS 0x3100 |
554 | ||
bded7de2 SC |
555 | /* |
556 | ||
557 | The section has contents - a bss section could be | |
558 | @code{SEC_ALLOC} | @code{SEC_HAS_CONTENTS}, a debug section could be | |
559 | @code{SEC_HAS_CONTENTS} | |
560 | */ | |
561 | ||
7a276b09 SC |
562 | #define SEC_HAS_CONTENTS 0x200 |
563 | ||
bded7de2 SC |
564 | /* |
565 | An instruction to the linker not to output sections containing | |
566 | this flag even if they have information which would normally be written. | |
567 | */ | |
568 | ||
7a276b09 SC |
569 | #define SEC_NEVER_LOAD 0x400 |
570 | ||
bded7de2 SC |
571 | /* |
572 | ||
573 | The base address of the section in the address space of the target. | |
574 | */ | |
575 | ||
7a276b09 SC |
576 | bfd_vma vma; |
577 | ||
bded7de2 SC |
578 | /* |
579 | The size of the section in bytes of the loaded section. This contains | |
580 | a value even if the section has no contents (eg, the size of @code{.bss}). | |
581 | */ | |
582 | ||
7a276b09 SC |
583 | bfd_size_type size; |
584 | ||
bded7de2 SC |
585 | /* |
586 | If this section is going to be output, then this value is the | |
587 | offset into the output section of the first byte in the input | |
588 | section. Eg, if this was going to start at the 100th byte in the | |
589 | output section, this value would be 100. | |
590 | */ | |
591 | ||
7a276b09 SC |
592 | bfd_vma output_offset; |
593 | ||
bded7de2 SC |
594 | /* |
595 | The output section through which to map on output. | |
596 | */ | |
597 | ||
7a276b09 SC |
598 | struct sec *output_section; |
599 | ||
bded7de2 SC |
600 | /* |
601 | The alignment requirement of the section, as an exponent - eg 3 | |
602 | aligns to 2^3 (or 8) | |
603 | */ | |
604 | ||
7a276b09 SC |
605 | unsigned int alignment_power; |
606 | ||
bded7de2 SC |
607 | /* |
608 | If an input section, a pointer to a vector of relocation records for | |
609 | the data in this section. | |
610 | */ | |
611 | ||
7a276b09 SC |
612 | struct reloc_cache_entry *relocation; |
613 | ||
bded7de2 SC |
614 | /* |
615 | If an output section, a pointer to a vector of pointers to | |
616 | relocation records for the data in this section. | |
617 | */ | |
618 | ||
7a276b09 SC |
619 | struct reloc_cache_entry **orelocation; |
620 | ||
bded7de2 SC |
621 | /* |
622 | The number of relocation records in one of the above | |
623 | */ | |
624 | ||
7a276b09 SC |
625 | unsigned reloc_count; |
626 | ||
bded7de2 SC |
627 | /* |
628 | Which section is it 0..nth | |
629 | */ | |
630 | ||
7a276b09 SC |
631 | int index; |
632 | ||
bded7de2 SC |
633 | /* |
634 | Information below is back end specific - and not always used or | |
635 | updated | |
636 | ||
637 | File position of section data | |
638 | */ | |
639 | ||
7a276b09 | 640 | file_ptr filepos; |
bded7de2 SC |
641 | /* File position of relocation info |
642 | */ | |
7a276b09 | 643 | |
7a276b09 SC |
644 | file_ptr rel_filepos; |
645 | ||
bded7de2 SC |
646 | /* |
647 | File position of line data | |
648 | */ | |
649 | ||
7a276b09 SC |
650 | file_ptr line_filepos; |
651 | ||
bded7de2 SC |
652 | /* |
653 | Pointer to data for applications | |
654 | */ | |
655 | ||
7a276b09 | 656 | PTR userdata; |
bded7de2 SC |
657 | |
658 | /* | |
659 | */ | |
7a276b09 SC |
660 | struct lang_output_section *otheruserdata; |
661 | ||
bded7de2 SC |
662 | /* |
663 | Attached line number information | |
664 | */ | |
665 | ||
7a276b09 | 666 | alent *lineno; |
bded7de2 SC |
667 | /* Number of line number records |
668 | */ | |
7a276b09 | 669 | |
7a276b09 SC |
670 | unsigned int lineno_count; |
671 | ||
bded7de2 SC |
672 | /* |
673 | When a section is being output, this value changes as more | |
674 | linenumbers are written out | |
675 | */ | |
676 | ||
7a276b09 SC |
677 | file_ptr moving_line_filepos; |
678 | ||
bded7de2 SC |
679 | /* |
680 | what the section number is in the target world | |
681 | */ | |
682 | ||
7a276b09 | 683 | unsigned int target_index; |
bded7de2 SC |
684 | |
685 | /* | |
686 | */ | |
7a276b09 SC |
687 | PTR used_by_bfd; |
688 | ||
bded7de2 SC |
689 | /* |
690 | If this is a constructor section then here is a list of the | |
691 | relocations created to relocate items within it. | |
692 | */ | |
693 | ||
7a276b09 SC |
694 | struct relent_chain *constructor_chain; |
695 | ||
bded7de2 | 696 | /* |
2f60a880 | 697 | The BFD which owns the section. |
bded7de2 SC |
698 | */ |
699 | ||
7a276b09 | 700 | bfd *owner; |
bded7de2 SC |
701 | |
702 | /* | |
703 | */ | |
7a276b09 SC |
704 | } asection ; |
705 | ||
bded7de2 | 706 | /* |
7a276b09 | 707 | |
bded7de2 SC |
708 | bfd_get_section_by_name |
709 | Runs through the provided @var{abfd} and returns the @code{asection} | |
710 | who's name matches that provided, otherwise NULL. @xref{Sections}, for more information. | |
7a276b09 | 711 | */ |
bded7de2 SC |
712 | |
713 | PROTO(asection *, bfd_get_section_by_name, | |
7a276b09 | 714 | (bfd *abfd, CONST char *name)); |
bded7de2 SC |
715 | |
716 | /* | |
717 | ||
718 | bfd_make_section | |
2f60a880 RP |
719 | This function creates a new empty section called @var{name} and attaches it |
720 | to the end of the chain of sections for the BFD supplied. An attempt to | |
7a276b09 SC |
721 | create a section with a name which is already in use, returns the old |
722 | section by that name instead. | |
723 | ||
724 | Possible errors are: | |
725 | @table @code | |
726 | @item invalid_operation | |
2f60a880 | 727 | If output has already started for this BFD. |
7a276b09 SC |
728 | @item no_memory |
729 | If obstack alloc fails. | |
730 | @end table | |
7a276b09 | 731 | */ |
bded7de2 SC |
732 | |
733 | PROTO(asection *, bfd_make_section, (bfd *, CONST char *name)); | |
734 | ||
735 | /* | |
736 | ||
737 | bfd_set_section_flags | |
2f60a880 | 738 | Attempts to set the attributes of the section named in the BFD |
7a276b09 SC |
739 | supplied to the value. Returns true on success, false on error. |
740 | Possible error returns are: | |
741 | @table @code | |
742 | @item invalid operation | |
743 | The section cannot have one or more of the attributes requested. For | |
744 | example, a .bss section in @code{a.out} may not have the | |
745 | @code{SEC_HAS_CONTENTS} field set. | |
746 | @end table | |
7a276b09 | 747 | */ |
bded7de2 SC |
748 | |
749 | PROTO(boolean, bfd_set_section_flags, | |
7a276b09 | 750 | (bfd *, asection *, flagword)); |
bded7de2 SC |
751 | |
752 | /* | |
753 | ||
754 | bfd_map_over_sections | |
2f60a880 RP |
755 | Calls the provided function @var{func} for each section attached to |
756 | the BFD @var{abfd}, passing @var{obj} as an argument. The function | |
7a276b09 SC |
757 | will be called as if by |
758 | ||
759 | @example | |
760 | func(abfd, the_section, obj); | |
761 | @end example | |
7a276b09 | 762 | */ |
bded7de2 SC |
763 | |
764 | PROTO(void, bfd_map_over_sections, | |
7a276b09 | 765 | (bfd *abfd, void (*func)(), PTR obj)); |
bded7de2 SC |
766 | |
767 | /* | |
768 | ||
769 | This is the prefered method for iterating over sections, an | |
7a276b09 SC |
770 | alternative would be to use a loop: |
771 | ||
772 | @example | |
773 | section *p; | |
774 | for (p = abfd->sections; p != NULL; p = p->next) | |
775 | func(abfd, p, ...) | |
bded7de2 | 776 | @end example |
7a276b09 | 777 | |
bded7de2 SC |
778 | bfd_set_section_size |
779 | Sets @var{section} to the size @var{val}. If the operation is ok, then | |
7a276b09 SC |
780 | @code{true} is returned, else @code{false}. |
781 | ||
782 | Possible error returns: | |
783 | @table @code | |
784 | @item invalid_operation | |
2f60a880 | 785 | Writing has started to the BFD, so setting the size is invalid |
7a276b09 | 786 | @end table |
7a276b09 | 787 | */ |
bded7de2 SC |
788 | |
789 | PROTO(boolean, bfd_set_section_size, | |
7a276b09 | 790 | (bfd *, asection *, bfd_size_type val)); |
bded7de2 SC |
791 | |
792 | /* | |
793 | ||
794 | bfd_set_section_contents | |
2f60a880 | 795 | Sets the contents of the section @var{section} in BFD @var{abfd} to |
7a276b09 SC |
796 | the data starting in memory at @var{data}. The data is written to the |
797 | output section starting at offset @var{offset} for @var{count} bytes. | |
798 | ||
799 | Normally @code{true} is returned, else @code{false}. Possible error | |
800 | returns are: | |
801 | @table @code | |
802 | @item no_contents | |
803 | The output section does not have the @code{SEC_HAS_CONTENTS} | |
804 | attribute, so nothing can be written to it. | |
805 | @item and some more too | |
806 | @end table | |
807 | This routine is front end to the back end function @code{_bfd_set_section_contents}. | |
7a276b09 | 808 | */ |
bded7de2 SC |
809 | |
810 | PROTO(boolean, bfd_set_section_contents, | |
7a276b09 SC |
811 | (bfd *abfd, |
812 | asection *section, | |
813 | PTR data, | |
814 | file_ptr offset, | |
815 | bfd_size_type count)); | |
bded7de2 SC |
816 | |
817 | /* | |
818 | ||
819 | bfd_get_section_contents | |
2f60a880 | 820 | This function reads data from @var{section} in BFD @var{abfd} into |
7a276b09 SC |
821 | memory starting at @var{location}. The data is read at an offset of |
822 | @var{offset} from the start of the input section, and is read for | |
823 | @var{count} bytes. | |
824 | ||
825 | If the contents of a constuctor with the @code{SEC_CONSTUCTOR} flag | |
826 | set are requested, then the @var{location} is filled with zeroes. | |
827 | ||
828 | If no errors occur, @code{true} is returned, else @code{false}. | |
829 | Possible errors are: | |
830 | ||
831 | @table @code | |
832 | @item unknown yet | |
833 | @end table | |
7a276b09 | 834 | */ |
bded7de2 SC |
835 | |
836 | PROTO(boolean, bfd_get_section_contents, | |
7a276b09 SC |
837 | (bfd *abfd, asection *section, PTR location, |
838 | file_ptr offset, bfd_size_type count)); | |
7a276b09 | 839 | |
bded7de2 | 840 | /* |
1ac2d1f2 | 841 | */ |
bded7de2 | 842 | |
bded7de2 | 843 | |
b39096a4 SC |
844 | |
845 | /*:archures.c*/ | |
846 | /* bfd_architecture | |
847 | This enum gives the object file's CPU | |
848 | architecture, in a global sense. E.g. what processor family does it | |
849 | belong to? There is another field, which indicates what processor | |
850 | within the family is in use. The machine gives a number which | |
851 | distingushes different versions of the architecture, containing for | |
852 | example 2 and 3 for Intel i960 KA and i960 KB, and 68020 and 68030 for | |
853 | Motorola 68020 and 68030. | |
7a276b09 | 854 | */ |
bded7de2 | 855 | |
b39096a4 | 856 | enum bfd_architecture |
7a276b09 | 857 | { |
b39096a4 SC |
858 | bfd_arch_unknown, /* File arch not known */ |
859 | bfd_arch_obscure, /* Arch known, not one of these */ | |
860 | bfd_arch_m68k, /* Motorola 68xxx */ | |
861 | bfd_arch_vax, /* DEC Vax */ | |
862 | bfd_arch_i960, /* Intel 960 */ | |
863 | /* The order of the following is important. | |
864 | lower number indicates a machine type that | |
865 | only accepts a subset of the instructions | |
866 | available to machines with higher numbers. | |
867 | The exception is the "ca", which is | |
868 | incompatible with all other machines except | |
869 | "core". */ | |
7a276b09 | 870 | |
b39096a4 SC |
871 | #define bfd_mach_i960_core 1 |
872 | #define bfd_mach_i960_ka_sa 2 | |
873 | #define bfd_mach_i960_kb_sb 3 | |
874 | #define bfd_mach_i960_mc 4 | |
875 | #define bfd_mach_i960_xa 5 | |
876 | #define bfd_mach_i960_ca 6 | |
877 | ||
878 | bfd_arch_a29k, /* AMD 29000 */ | |
879 | bfd_arch_sparc, /* SPARC */ | |
880 | bfd_arch_mips, /* MIPS Rxxxx */ | |
881 | bfd_arch_i386, /* Intel 386 */ | |
882 | bfd_arch_ns32k, /* National Semiconductor 32xxx */ | |
883 | bfd_arch_tahoe, /* CCI/Harris Tahoe */ | |
884 | bfd_arch_i860, /* Intel 860 */ | |
885 | bfd_arch_romp, /* IBM ROMP RS/6000 */ | |
886 | bfd_arch_alliant, /* Alliant */ | |
887 | bfd_arch_convex, /* Convex */ | |
888 | bfd_arch_m88k, /* Motorola 88xxx */ | |
889 | bfd_arch_pyramid, /* Pyramid Technology */ | |
890 | bfd_arch_h8300, /* Hitachi H8/300 */ | |
891 | bfd_arch_last | |
892 | }; | |
7a276b09 | 893 | |
bded7de2 | 894 | /* |
b39096a4 SC |
895 | stuff |
896 | ||
897 | bfd_arch_info_struct | |
898 | This structure contains information on architectures. | |
bded7de2 | 899 | */ |
b39096a4 | 900 | typedef int bfd_reloc_code_enum_type; |
bded7de2 | 901 | |
b39096a4 SC |
902 | typedef struct bfd_arch_info_struct |
903 | { | |
904 | int bits_per_word; | |
905 | int bits_per_address; | |
906 | int bits_per_byte; | |
907 | enum bfd_architecture arch; | |
908 | long mach; | |
909 | char *arch_name; | |
910 | CONST char *printable_name; | |
911 | /* true if this is the default machine for the architecture */ | |
912 | boolean the_default; | |
913 | CONST struct bfd_arch_info_struct * EXFUN((*compatible),(CONST struct bfd_arch_info_struct *a, | |
914 | CONST struct bfd_arch_info_struct *b)); | |
915 | ||
916 | ||
917 | boolean EXFUN((*scan),(CONST struct bfd_arch_info_struct *,CONST char *)); | |
918 | unsigned int EXFUN((*disassemble),(bfd_vma addr, CONST char *data, | |
919 | PTR stream)); | |
de7e640d SC |
920 | CONST struct reloc_howto_struct *EXFUN((*reloc_type_lookup), (CONST struct |
921 | bfd_arch_info_struct *, | |
922 | bfd_reloc_code_enum_type code)); | |
b39096a4 SC |
923 | |
924 | struct bfd_arch_info_struct *next; | |
925 | ||
926 | } bfd_arch_info_struct_type; | |
927 | ||
928 | /* | |
b39096a4 | 929 | bfd_printable_name |
7a276b09 | 930 | |
b39096a4 SC |
931 | Return a printable string representing the architecture and machine |
932 | from the pointer to the arch info structure | |
bded7de2 SC |
933 | */ |
934 | ||
b39096a4 | 935 | CONST char *EXFUN(bfd_printable_name,(bfd *abfd)); |
7a276b09 | 936 | |
bded7de2 | 937 | /* |
b39096a4 SC |
938 | |
939 | *i bfd_scan_arch | |
940 | This routine is provided with a string and tries to work out if bfd | |
941 | supports any cpu which could be described with the name provided. The | |
942 | routine returns a pointer to an arch_info structure if a machine is | |
943 | found, otherwise NULL. | |
bded7de2 SC |
944 | */ |
945 | ||
b39096a4 | 946 | bfd_arch_info_struct_type *EXFUN(bfd_scan_arch,(CONST char *)); |
7a276b09 | 947 | |
bded7de2 | 948 | /* |
b39096a4 SC |
949 | |
950 | bfd_arch_get_compatible | |
951 | This routine is used to determine whether two BFDs' architectures and | |
952 | machine types are compatible. It calculates the lowest common | |
953 | denominator between the two architectures and machine types implied by | |
954 | the BFDs and returns a pointer to an arch_info structure describing | |
955 | the compatible machine. | |
bded7de2 SC |
956 | */ |
957 | ||
b39096a4 SC |
958 | CONST bfd_arch_info_struct_type *EXFUN(bfd_arch_get_compatible, |
959 | (CONST bfd *abfd, | |
960 | CONST bfd *bbfd)); | |
7a276b09 | 961 | |
bded7de2 | 962 | /* |
b39096a4 SC |
963 | |
964 | bfd_set_arch_info | |
bded7de2 SC |
965 | */ |
966 | ||
b39096a4 | 967 | void EXFUN(bfd_set_arch_info,(bfd *, bfd_arch_info_struct_type *)); |
7a276b09 | 968 | |
bded7de2 | 969 | /* |
b39096a4 SC |
970 | |
971 | bfd_get_arch | |
972 | ||
973 | Returns the enumerated type which describes the supplied bfd's | |
974 | architecture | |
bded7de2 SC |
975 | */ |
976 | ||
b39096a4 | 977 | enum bfd_architecture EXFUN(bfd_get_arch, (bfd *abfd)); |
7a276b09 | 978 | |
bded7de2 | 979 | /* |
b39096a4 SC |
980 | |
981 | bfd_get_mach | |
982 | ||
983 | Returns the long type which describes the supplied bfd's | |
984 | machine | |
bded7de2 SC |
985 | */ |
986 | ||
b39096a4 | 987 | unsigned long EXFUN(bfd_get_mach, (bfd *abfd)); |
7a276b09 | 988 | |
bded7de2 | 989 | /* |
bded7de2 | 990 | |
b39096a4 SC |
991 | bfd_arch_bits_per_byte |
992 | ||
993 | Returns the number of bits in one of the architectures bytes | |
bded7de2 SC |
994 | */ |
995 | ||
b39096a4 | 996 | unsigned int EXFUN(bfd_arch_bits_per_byte, (bfd *abfd)); |
7a276b09 | 997 | |
bded7de2 | 998 | /* |
b39096a4 SC |
999 | |
1000 | bfd_arch_bits_per_address | |
1001 | ||
1002 | Returns the number of bits in one of the architectures addresses | |
bded7de2 SC |
1003 | */ |
1004 | ||
b39096a4 | 1005 | unsigned int EXFUN(bfd_arch_bits_per_address, (bfd *abfd)); |
7a276b09 | 1006 | |
bded7de2 | 1007 | /* |
b39096a4 SC |
1008 | |
1009 | bfd_get_arch_info | |
bded7de2 SC |
1010 | */ |
1011 | ||
b39096a4 | 1012 | bfd_arch_info_struct_type * EXFUN(bfd_get_arch_info,(bfd *)); |
7a276b09 | 1013 | |
bded7de2 | 1014 | /* |
7a276b09 | 1015 | |
de7e640d SC |
1016 | bfd_lookup_arch |
1017 | ||
bded7de2 | 1018 | */ |
de7e640d SC |
1019 | bfd_arch_info_struct_type * EXFUN(bfd_lookup_arch,(enum |
1020 | bfd_architecture arch,long machine)); | |
7a276b09 | 1021 | |
bded7de2 | 1022 | /* |
1c6c6598 | 1023 | |
de7e640d SC |
1024 | Look for the architecure info struct which matches the arguments |
1025 | given. A machine of 0 will match the machine/architecture structure which | |
1026 | marks itself as the default. | |
bded7de2 | 1027 | |
de7e640d SC |
1028 | bfd_printable_arch_mach |
1029 | Return a printable string representing the architecture and machine | |
1030 | type. | |
1c6c6598 | 1031 | |
de7e640d | 1032 | NB. The use of this routine is depreciated. |
bded7de2 SC |
1033 | */ |
1034 | ||
de7e640d SC |
1035 | PROTO(CONST char *,bfd_printable_arch_mach, |
1036 | (enum bfd_architecture arch, unsigned long machine)); | |
1c6c6598 | 1037 | |
bded7de2 | 1038 | /* |
bded7de2 SC |
1039 | */ |
1040 | ||
b39096a4 SC |
1041 | /*:reloc.c*/ |
1042 | /* bfd_perform_relocation | |
1043 | The relocation routine returns as a status an enumerated type: | |
1044 | */ | |
7a276b09 | 1045 | |
b39096a4 SC |
1046 | typedef enum bfd_reloc_status { |
1047 | /* No errors detected | |
bded7de2 SC |
1048 | */ |
1049 | ||
b39096a4 | 1050 | bfd_reloc_ok, |
7a276b09 | 1051 | |
bded7de2 | 1052 | /* |
b39096a4 | 1053 | The relocation was performed, but there was an overflow. |
bded7de2 SC |
1054 | */ |
1055 | ||
b39096a4 | 1056 | bfd_reloc_overflow, |
7a276b09 | 1057 | |
bded7de2 | 1058 | /* |
b39096a4 | 1059 | The address to relocate was not within the section supplied |
7a276b09 | 1060 | */ |
7a276b09 | 1061 | |
b39096a4 | 1062 | bfd_reloc_outofrange, |
bded7de2 | 1063 | |
b39096a4 SC |
1064 | /* |
1065 | Used by special functions | |
7a276b09 | 1066 | */ |
bded7de2 | 1067 | |
b39096a4 | 1068 | bfd_reloc_continue, |
7a276b09 | 1069 | |
bded7de2 | 1070 | /* |
b39096a4 | 1071 | Unused |
7a276b09 | 1072 | */ |
7a276b09 | 1073 | |
b39096a4 | 1074 | bfd_reloc_notsupported, |
bded7de2 SC |
1075 | |
1076 | /* | |
b39096a4 SC |
1077 | Unsupported relocation size requested. |
1078 | */ | |
bded7de2 | 1079 | |
b39096a4 SC |
1080 | bfd_reloc_other, |
1081 | ||
1082 | /* | |
1083 | The symbol to relocate against was undefined. | |
7a276b09 | 1084 | */ |
bded7de2 | 1085 | |
b39096a4 | 1086 | bfd_reloc_undefined, |
bded7de2 SC |
1087 | |
1088 | /* | |
b39096a4 SC |
1089 | The relocation was performed, but may not be ok - presently generated |
1090 | only when linking i960 coff files with i960 b.out symbols. | |
1091 | */ | |
bded7de2 | 1092 | |
b39096a4 SC |
1093 | bfd_reloc_dangerous |
1094 | } | |
1095 | bfd_reloc_status_enum_type; | |
7a276b09 | 1096 | |
b39096a4 | 1097 | /* |
7a276b09 | 1098 | */ |
7a276b09 | 1099 | |
b39096a4 SC |
1100 | typedef struct reloc_cache_entry |
1101 | { | |
7a276b09 | 1102 | |
b39096a4 SC |
1103 | /* |
1104 | A pointer into the canonical table of pointers | |
1105 | */ | |
7a276b09 | 1106 | |
b39096a4 SC |
1107 | struct symbol_cache_entry **sym_ptr_ptr; |
1108 | ||
1109 | /* | |
1110 | offset in section | |
7a276b09 | 1111 | */ |
bded7de2 | 1112 | |
b39096a4 SC |
1113 | rawdata_offset address; |
1114 | ||
1115 | /* | |
1116 | addend for relocation value | |
bded7de2 | 1117 | */ |
7a276b09 | 1118 | |
b39096a4 | 1119 | bfd_vma addend; |
7a276b09 | 1120 | |
bded7de2 | 1121 | /* |
b39096a4 | 1122 | if sym is null this is the section |
bded7de2 SC |
1123 | */ |
1124 | ||
b39096a4 SC |
1125 | struct sec *section; |
1126 | ||
1127 | /* | |
1128 | Pointer to how to perform the required relocation | |
1129 | */ | |
1130 | ||
1131 | CONST struct reloc_howto_struct *howto; | |
1132 | } arelent; | |
7a276b09 | 1133 | |
bded7de2 SC |
1134 | /* |
1135 | ||
b39096a4 SC |
1136 | reloc_howto_type |
1137 | The @code{reloc_howto_type} is a structure which contains all the | |
1138 | information that BFD needs to know to tie up a back end's data. | |
1139 | */ | |
bded7de2 | 1140 | |
b39096a4 SC |
1141 | typedef CONST struct reloc_howto_struct |
1142 | { | |
1143 | /* The type field has mainly a documetary use - the back end can to what | |
1144 | it wants with it, though the normally the back end's external idea of | |
1145 | what a reloc number would be would be stored in this field. For | |
1146 | example, the a PC relative word relocation in a coff environment would | |
1147 | have the type 023 - because that's what the outside world calls a | |
1148 | R_PCRWORD reloc. | |
bded7de2 SC |
1149 | */ |
1150 | ||
b39096a4 | 1151 | unsigned int type; |
7a276b09 | 1152 | |
bded7de2 | 1153 | /* |
b39096a4 SC |
1154 | The value the final relocation is shifted right by. This drops |
1155 | unwanted data from the relocation. | |
bded7de2 SC |
1156 | */ |
1157 | ||
b39096a4 | 1158 | unsigned int rightshift; |
7a276b09 | 1159 | |
bded7de2 | 1160 | /* |
b39096a4 SC |
1161 | The size of the item to be relocated - 0, is one byte, 1 is 2 bytes, 3 |
1162 | is four bytes. | |
bded7de2 SC |
1163 | */ |
1164 | ||
b39096a4 | 1165 | unsigned int size; |
7a276b09 | 1166 | |
bded7de2 | 1167 | /* |
b39096a4 | 1168 | Now obsolete |
bded7de2 SC |
1169 | */ |
1170 | ||
b39096a4 | 1171 | unsigned int bitsize; |
7a276b09 | 1172 | |
bded7de2 | 1173 | /* |
b39096a4 SC |
1174 | Notes that the relocation is relative to the location in the data |
1175 | section of the addend. The relocation function will subtract from the | |
1176 | relocation value the address of the location being relocated. | |
bded7de2 SC |
1177 | */ |
1178 | ||
b39096a4 | 1179 | boolean pc_relative; |
7a276b09 | 1180 | |
bded7de2 | 1181 | /* |
b39096a4 | 1182 | Now obsolete |
bded7de2 SC |
1183 | */ |
1184 | ||
b39096a4 | 1185 | unsigned int bitpos; |
bded7de2 SC |
1186 | |
1187 | /* | |
b39096a4 | 1188 | Now obsolete |
bded7de2 | 1189 | */ |
b39096a4 SC |
1190 | |
1191 | boolean absolute; | |
1192 | ||
1193 | /* | |
1194 | Causes the relocation routine to return an error if overflow is | |
1195 | detected when relocating. | |
bded7de2 | 1196 | */ |
7a276b09 | 1197 | |
b39096a4 | 1198 | boolean complain_on_overflow; |
7a276b09 | 1199 | |
bded7de2 | 1200 | /* |
b39096a4 SC |
1201 | If this field is non null, then the supplied function is called rather |
1202 | than the normal function. This allows really strange relocation | |
1203 | methods to be accomodated (eg, i960 callj instructions). | |
bded7de2 SC |
1204 | */ |
1205 | ||
b39096a4 | 1206 | bfd_reloc_status_enum_type (*special_function)(); |
7a276b09 | 1207 | |
bded7de2 | 1208 | /* |
b39096a4 | 1209 | The textual name of the relocation type. |
bded7de2 SC |
1210 | */ |
1211 | ||
b39096a4 | 1212 | char *name; |
a07cc613 | 1213 | |
bded7de2 | 1214 | /* |
b39096a4 SC |
1215 | When performing a partial link, some formats must modify the |
1216 | relocations rather than the data - this flag signals this. | |
bded7de2 SC |
1217 | */ |
1218 | ||
b39096a4 | 1219 | boolean partial_inplace; |
7a276b09 | 1220 | |
bded7de2 | 1221 | /* |
b39096a4 SC |
1222 | The src_mask is used to select what parts of the read in data are to |
1223 | be used in the relocation sum. Eg, if this was an 8 bit bit of data | |
1224 | which we read and relocated, this would be 0x000000ff. When we have | |
1225 | relocs which have an addend, such as sun4 extended relocs, the value | |
1226 | in the offset part of a relocating field is garbage so we never use | |
1227 | it. In this case the mask would be 0x00000000. | |
bded7de2 SC |
1228 | */ |
1229 | ||
b39096a4 SC |
1230 | bfd_word src_mask; |
1231 | /* The dst_mask is what parts of the instruction are replaced into the | |
1232 | instruction. In most cases src_mask == dst_mask, except in the above | |
1233 | special case, where dst_mask would be 0x000000ff, and src_mask would | |
1234 | be 0x00000000. | |
1235 | */ | |
1236 | ||
1237 | bfd_word dst_mask; | |
7a276b09 | 1238 | |
bded7de2 | 1239 | /* |
b39096a4 SC |
1240 | When some formats create PC relative instructions, they leave the |
1241 | value of the pc of the place being relocated in the offset slot of the | |
1242 | instruction, so that a PC relative relocation can be made just by | |
1243 | adding in an ordinary offset (eg sun3 a.out). Some formats leave the | |
1244 | displacement part of an instruction empty (eg m88k bcs), this flag | |
1245 | signals the fact. | |
bded7de2 SC |
1246 | */ |
1247 | ||
b39096a4 SC |
1248 | boolean pcrel_offset; |
1249 | } reloc_howto_type; | |
7a276b09 | 1250 | |
bded7de2 | 1251 | /* |
b39096a4 SC |
1252 | |
1253 | HOWTO | |
1254 | The HOWTO define is horrible and will go away. | |
bded7de2 | 1255 | */ |
b39096a4 SC |
1256 | #define HOWTO(C, R,S,B, P, BI, ABS, O, SF, NAME, INPLACE, MASKSRC, MASKDST, PC) \ |
1257 | {(unsigned)C,R,S,B, P, BI, ABS,O,SF,NAME,INPLACE,MASKSRC,MASKDST,PC} | |
bded7de2 | 1258 | |
b39096a4 SC |
1259 | /* |
1260 | And will be replaced with the totally magic way. But for the moment, | |
1261 | we are compatible, so do it this way.. | |
1262 | */ | |
1263 | ||
1264 | #define NEWHOWTO( FUNCTION, NAME,SIZE,REL) HOWTO(0,0,SIZE,0,REL,0,false,false,FUNCTION, NAME,false,0,0,false) | |
7a276b09 | 1265 | |
bded7de2 | 1266 | /* |
b39096a4 | 1267 | Helper routine to turn a symbol into a relocation value. |
bded7de2 SC |
1268 | */ |
1269 | ||
b39096a4 SC |
1270 | |
1271 | #define HOWTO_PREPARE(relocation, symbol) \ | |
1272 | { \ | |
1273 | if (symbol != (asymbol *)NULL) { \ | |
1274 | if (symbol->flags & BSF_FORT_COMM) { \ | |
1275 | relocation = 0; \ | |
1276 | } \ | |
1277 | else { \ | |
1278 | relocation = symbol->value; \ | |
1279 | } \ | |
1280 | } \ | |
1281 | if (symbol->section != (asection *)NULL) { \ | |
1282 | relocation += symbol->section->output_section->vma + \ | |
1283 | symbol->section->output_offset; \ | |
1284 | } \ | |
1285 | } | |
7a276b09 | 1286 | |
bded7de2 | 1287 | /* |
b39096a4 | 1288 | reloc_chain |
bded7de2 | 1289 | */ |
b39096a4 | 1290 | typedef unsigned char bfd_byte; |
bded7de2 | 1291 | |
b39096a4 SC |
1292 | typedef struct relent_chain { |
1293 | arelent relent; | |
1294 | struct relent_chain *next; | |
1295 | } arelent_chain; | |
1296 | ||
1297 | /* | |
1298 | ||
1299 | If an output_bfd is supplied to this function the generated image | |
1300 | will be relocatable, the relocations are copied to the output file | |
1301 | after they have been changed to reflect the new state of the world. | |
1302 | There are two ways of reflecting the results of partial linkage in an | |
1303 | output file; by modifying the output data in place, and by modifying | |
1304 | the relocation record. Some native formats (eg basic a.out and basic | |
1305 | coff) have no way of specifying an addend in the relocation type, so | |
1306 | the addend has to go in the output data. This is no big deal since in | |
1307 | these formats the output data slot will always be big enough for the | |
1308 | addend. Complex reloc types with addends were invented to solve just | |
1309 | this problem. | |
1310 | */ | |
1311 | PROTO(bfd_reloc_status_enum_type, | |
1312 | bfd_perform_relocation, | |
1313 | (bfd * abfd, | |
1314 | arelent *reloc_entry, | |
1315 | PTR data, | |
1316 | asection *input_section, | |
1317 | bfd *output_bfd)); | |
7a276b09 | 1318 | |
de7e640d SC |
1319 | /* |
1320 | ||
1321 | bfd_reloc_code_enum_type | |
1322 | */ | |
1323 | ||
1324 | typedef enum | |
1325 | { | |
1326 | ||
1327 | /* | |
1328 | 16 bits wide, simple reloc | |
1329 | */ | |
1330 | ||
1331 | BFD_RELOC_16, | |
1332 | ||
1333 | /* | |
1334 | 8 bits wide, but used to form an address like 0xffnn | |
1335 | */ | |
1336 | ||
1337 | BFD_RELOC_8_FFnn, | |
1338 | ||
1339 | /* | |
1340 | 8 bits wide, simple | |
1341 | */ | |
1342 | ||
1343 | BFD_RELOC_8, | |
1344 | ||
1345 | /* | |
1346 | 8 bits wide, pc relative | |
1347 | */ | |
1348 | ||
1349 | BFD_RELOC_8_PCREL | |
1350 | } bfd_reloc_code_enum_real_type; | |
1351 | ||
1352 | /* | |
1353 | ||
1354 | bfd_reloc_type_lookup | |
1355 | This routine returns a pointer to a howto struct which when invoked, | |
1356 | will perform the supplied relocation on data from the architecture | |
1357 | noted. | |
1358 | ||
1359 | [Note] This function will go away. | |
1360 | */ | |
1361 | ||
1362 | PROTO(CONST struct reloc_howto_struct *, | |
1363 | bfd_reloc_type_lookup, | |
1364 | (CONST bfd_arch_info_struct_type *arch, bfd_reloc_code_enum_type code)); | |
1365 | ||
bded7de2 | 1366 | /* |
bded7de2 SC |
1367 | */ |
1368 | ||
b39096a4 SC |
1369 | /*:syms.c*/ |
1370 | /* @subsection typedef asymbol | |
1371 | An @code{asymbol} has the form: | |
bded7de2 | 1372 | */ |
7a276b09 | 1373 | |
b39096a4 SC |
1374 | typedef struct symbol_cache_entry |
1375 | { | |
1376 | /* A pointer to the BFD which owns the symbol. This information is | |
1377 | necessary so that a back end can work out what additional (invisible to | |
1378 | the application writer) information is carried with the symbol. | |
bded7de2 | 1379 | */ |
7a276b09 | 1380 | |
b39096a4 | 1381 | struct _bfd *the_bfd; |
7a276b09 | 1382 | |
bded7de2 | 1383 | /* |
b39096a4 SC |
1384 | The text of the symbol. The name is left alone, and not copied - the |
1385 | application may not alter it. | |
bded7de2 SC |
1386 | */ |
1387 | ||
b39096a4 | 1388 | CONST char *name; |
7a276b09 | 1389 | |
bded7de2 | 1390 | /* |
b39096a4 | 1391 | The value of the symbol. |
bded7de2 SC |
1392 | */ |
1393 | ||
b39096a4 | 1394 | symvalue value; |
7a276b09 | 1395 | |
bded7de2 | 1396 | /* |
b39096a4 | 1397 | Attributes of a symbol: |
bded7de2 SC |
1398 | */ |
1399 | ||
b39096a4 | 1400 | #define BSF_NO_FLAGS 0x00 |
7a276b09 | 1401 | |
bded7de2 | 1402 | /* |
b39096a4 SC |
1403 | The symbol has local scope; @code{static} in @code{C}. The value is |
1404 | the offset into the section of the data. | |
bded7de2 SC |
1405 | */ |
1406 | ||
b39096a4 | 1407 | #define BSF_LOCAL 0x01 |
7a276b09 | 1408 | |
bded7de2 | 1409 | /* |
b39096a4 SC |
1410 | The symbol has global scope; initialized data in @code{C}. The value |
1411 | is the offset into the section of the data. | |
bded7de2 SC |
1412 | */ |
1413 | ||
b39096a4 | 1414 | #define BSF_GLOBAL 0x02 |
7a276b09 | 1415 | |
bded7de2 | 1416 | /* |
b39096a4 | 1417 | Obsolete |
bded7de2 SC |
1418 | */ |
1419 | ||
b39096a4 | 1420 | #define BSF_IMPORT 0x04 |
a07cc613 | 1421 | |
bded7de2 | 1422 | /* |
b39096a4 SC |
1423 | The symbol has global scope, and is exported. The value is the offset |
1424 | into the section of the data. | |
1425 | */ | |
7a276b09 | 1426 | |
b39096a4 | 1427 | #define BSF_EXPORT 0x08 |
bded7de2 | 1428 | |
b39096a4 SC |
1429 | /* |
1430 | The symbol is undefined. @code{extern} in @code{C}. The value has no meaning. | |
7a276b09 | 1431 | */ |
bded7de2 | 1432 | |
b39096a4 | 1433 | #define BSF_UNDEFINED 0x10 |
bded7de2 SC |
1434 | |
1435 | /* | |
b39096a4 SC |
1436 | The symbol is common, initialized to zero; default in @code{C}. The |
1437 | value is the size of the object in bytes. | |
1438 | */ | |
bded7de2 | 1439 | |
b39096a4 | 1440 | #define BSF_FORT_COMM 0x20 |
bded7de2 | 1441 | |
b39096a4 SC |
1442 | /* |
1443 | A normal @code{C} symbol would be one of: | |
1444 | @code{BSF_LOCAL}, @code{BSF_FORT_COMM}, @code{BSF_UNDEFINED} or @code{BSF_EXPORT|BSD_GLOBAL} | |
1445 | ||
1446 | The symbol is a debugging record. The value has an arbitary meaning. | |
bded7de2 SC |
1447 | */ |
1448 | ||
b39096a4 | 1449 | #define BSF_DEBUGGING 0x40 |
a07cc613 | 1450 | |
bded7de2 | 1451 | /* |
b39096a4 SC |
1452 | The symbol has no section attached, any value is the actual value and |
1453 | is not a relative offset to a section. | |
1454 | */ | |
bded7de2 | 1455 | |
b39096a4 SC |
1456 | #define BSF_ABSOLUTE 0x80 |
1457 | ||
1458 | /* | |
1459 | Used by the linker | |
7a276b09 | 1460 | */ |
bded7de2 | 1461 | |
b39096a4 SC |
1462 | #define BSF_KEEP 0x10000 |
1463 | #define BSF_KEEP_G 0x80000 | |
bded7de2 | 1464 | |
b39096a4 SC |
1465 | /* |
1466 | Unused | |
1467 | */ | |
a07cc613 | 1468 | |
b39096a4 SC |
1469 | #define BSF_WEAK 0x100000 |
1470 | #define BSF_CTOR 0x200000 | |
1471 | #define BSF_FAKE 0x400000 | |
a07cc613 | 1472 | |
b39096a4 SC |
1473 | /* |
1474 | The symbol used to be a common symbol, but now it is allocated. | |
1475 | */ | |
a07cc613 | 1476 | |
b39096a4 | 1477 | #define BSF_OLD_COMMON 0x800000 |
7a276b09 | 1478 | |
b39096a4 SC |
1479 | /* |
1480 | The default value for common data. | |
1481 | */ | |
7a276b09 | 1482 | |
b39096a4 | 1483 | #define BFD_FORT_COMM_DEFAULT_VALUE 0 |
a07cc613 | 1484 | |
b39096a4 SC |
1485 | /* |
1486 | In some files the type of a symbol sometimes alters its location | |
1487 | in an output file - ie in coff a @code{ISFCN} symbol which is also @code{C_EXT} | |
1488 | symbol appears where it was declared and not at the end of a section. | |
1489 | This bit is set by the target BFD part to convey this information. | |
1490 | */ | |
e8929c8d | 1491 | |
b39096a4 | 1492 | #define BSF_NOT_AT_END 0x40000 |
e8929c8d | 1493 | |
b39096a4 SC |
1494 | /* |
1495 | Signal that the symbol is the label of constructor section. | |
1496 | */ | |
1497 | ||
1498 | #define BSF_CONSTRUCTOR 0x1000000 | |
e8929c8d | 1499 | |
bded7de2 | 1500 | /* |
b39096a4 SC |
1501 | Signal that the symbol is a warning symbol. If the symbol is a warning |
1502 | symbol, then the value field (I know this is tacky) will point to the | |
1503 | asymbol which when referenced will cause the warning. | |
1ac2d1f2 | 1504 | */ |
bded7de2 | 1505 | |
b39096a4 SC |
1506 | #define BSF_WARNING 0x2000000 |
1507 | ||
1508 | /* | |
1509 | Signal that the symbol is indirect. The value of the symbol is a | |
1510 | pointer to an undefined asymbol which contains the name to use | |
1511 | instead. | |
7a276b09 | 1512 | */ |
b39096a4 SC |
1513 | |
1514 | #define BSF_INDIRECT 0x4000000 | |
bded7de2 SC |
1515 | |
1516 | /* | |
b39096a4 SC |
1517 | */ |
1518 | flagword flags; | |
bded7de2 | 1519 | |
b39096a4 SC |
1520 | /* |
1521 | A pointer to the section to which this symbol is relative, or 0 if the | |
1522 | symbol is absolute or undefined. Note that it is not sufficient to set | |
1523 | this location to 0 to mark a symbol as absolute - the flag | |
1524 | @code{BSF_ABSOLUTE} must be set also. | |
1525 | */ | |
2c346475 | 1526 | |
b39096a4 SC |
1527 | struct sec *section; |
1528 | ||
1529 | /* | |
1530 | Back end special data. This is being phased out in favour of making | |
1531 | this a union. | |
7a276b09 | 1532 | */ |
2c346475 | 1533 | |
b39096a4 SC |
1534 | PTR udata; |
1535 | } asymbol; | |
bded7de2 SC |
1536 | |
1537 | /* | |
1538 | ||
b39096a4 SC |
1539 | get_symtab_upper_bound |
1540 | Returns the number of bytes required in a vector of pointers to | |
1541 | @code{asymbols} for all the symbols in the supplied BFD, including a | |
1542 | terminal NULL pointer. If there are no symbols in the BFD, then 0 is | |
1543 | returned. | |
bded7de2 | 1544 | */ |
b39096a4 SC |
1545 | #define get_symtab_upper_bound(abfd) \ |
1546 | BFD_SEND (abfd, _get_symtab_upper_bound, (abfd)) | |
bded7de2 SC |
1547 | |
1548 | /* | |
1549 | ||
b39096a4 SC |
1550 | bfd_canonicalize_symtab |
1551 | Supplied a BFD and a pointer to an uninitialized vector of pointers. | |
1552 | This reads in the symbols from the BFD, and fills in the table with | |
1553 | pointers to the symbols, and a trailing NULL. The routine returns the | |
1554 | actual number of symbol pointers not including the NULL. | |
7a276b09 | 1555 | */ |
bded7de2 | 1556 | |
b39096a4 SC |
1557 | #define bfd_canonicalize_symtab(abfd, location) \ |
1558 | BFD_SEND (abfd, _bfd_canonicalize_symtab,\ | |
1559 | (abfd, location)) | |
a737c70b | 1560 | |
bded7de2 | 1561 | /* |
b39096a4 SC |
1562 | bfd_set_symtab |
1563 | Provided a table of pointers to to symbols and a count, writes to the | |
1564 | output BFD the symbols when closed. | |
1ac2d1f2 | 1565 | */ |
a737c70b | 1566 | |
b39096a4 | 1567 | PROTO(boolean, bfd_set_symtab, (bfd *, asymbol **, unsigned int )); |
2700c3c7 | 1568 | |
b39096a4 SC |
1569 | /* |
1570 | ||
1571 | bfd_print_symbol_vandf | |
1572 | Prints the value and flags of the symbol supplied to the stream file. | |
2f60a880 RP |
1573 | */ |
1574 | ||
b39096a4 | 1575 | PROTO(void, bfd_print_symbol_vandf, (PTR file, asymbol *symbol)); |
2f60a880 RP |
1576 | |
1577 | /* | |
1578 | ||
b39096a4 SC |
1579 | bfd_make_empty_symbol |
1580 | This function creates a new @code{asymbol} structure for the BFD, and | |
1581 | returns a pointer to it. | |
1582 | ||
1583 | This routine is necessary, since each back end has private information | |
1584 | surrounding the @code{asymbol}. Building your own @code{asymbol} and | |
1585 | pointing to it will not create the private information, and will cause | |
1586 | problems later on. | |
2f60a880 | 1587 | */ |
b39096a4 SC |
1588 | #define bfd_make_empty_symbol(abfd) \ |
1589 | BFD_SEND (abfd, _bfd_make_empty_symbol, (abfd)) | |
2f60a880 | 1590 | |
b39096a4 SC |
1591 | /*:bfd.c*/ |
1592 | /* @section @code{typedef bfd} | |
2f60a880 | 1593 | |
b39096a4 SC |
1594 | A BFD is has type @code{bfd}; objects of this type are the cornerstone |
1595 | of any application using @code{libbfd}. References though the BFD and | |
1596 | to data in the BFD give the entire BFD functionality. | |
2f60a880 | 1597 | |
b39096a4 SC |
1598 | Here is the struct used to define the type @code{bfd}. This contains |
1599 | the major data about the file, and contains pointers to the rest of | |
1600 | the data. | |
2f60a880 | 1601 | */ |
b39096a4 SC |
1602 | |
1603 | struct _bfd | |
1604 | { | |
1605 | /* The filename the application opened the BFD with. | |
1606 | */ | |
1607 | ||
1608 | CONST char *filename; | |
2f60a880 RP |
1609 | |
1610 | /* | |
b39096a4 | 1611 | A pointer to the target jump table. |
1ac2d1f2 | 1612 | */ |
2f60a880 | 1613 | |
b39096a4 SC |
1614 | struct bfd_target *xvec; |
1615 | ||
1616 | /* | |
1617 | ||
1618 | To avoid dragging too many header files into every file that | |
1619 | includes @file{bfd.h}, IOSTREAM has been declared as a "char *", and MTIME | |
1620 | as a "long". Their correct types, to which they are cast when used, | |
1621 | are "FILE *" and "time_t". | |
1622 | ||
1623 | The iostream is the result of an fopen on the filename. | |
7a276b09 | 1624 | */ |
bded7de2 | 1625 | |
b39096a4 SC |
1626 | char *iostream; |
1627 | ||
1628 | /* | |
1629 | Is the file being cached @xref{File Caching}. | |
bded7de2 | 1630 | */ |
a07cc613 | 1631 | |
b39096a4 | 1632 | boolean cacheable; |
a07cc613 | 1633 | |
bded7de2 | 1634 | /* |
b39096a4 SC |
1635 | Marks whether there was a default target specified when the BFD was |
1636 | opened. This is used to select what matching algorithm to use to chose | |
1637 | the back end. | |
bded7de2 SC |
1638 | */ |
1639 | ||
b39096a4 | 1640 | boolean target_defaulted; |
a07cc613 | 1641 | |
bded7de2 | 1642 | /* |
b39096a4 SC |
1643 | The caching routines use these to maintain a least-recently-used list of |
1644 | BFDs (@pxref{File Caching}). | |
bded7de2 SC |
1645 | */ |
1646 | ||
b39096a4 | 1647 | struct _bfd *lru_prev, *lru_next; |
a07cc613 | 1648 | |
bded7de2 | 1649 | /* |
b39096a4 SC |
1650 | When a file is closed by the caching routines, BFD retains state |
1651 | information on the file here: | |
bded7de2 SC |
1652 | */ |
1653 | ||
b39096a4 | 1654 | file_ptr where; |
a07cc613 | 1655 | |
bded7de2 | 1656 | /* |
b39096a4 | 1657 | and here: |
bded7de2 SC |
1658 | */ |
1659 | ||
b39096a4 | 1660 | boolean opened_once; |
7a276b09 | 1661 | |
bded7de2 | 1662 | /* |
b39096a4 SC |
1663 | */ |
1664 | boolean mtime_set; | |
1665 | /* File modified time | |
bded7de2 SC |
1666 | */ |
1667 | ||
b39096a4 | 1668 | long mtime; |
7a276b09 | 1669 | |
bded7de2 | 1670 | /* |
b39096a4 | 1671 | Reserved for an unimplemented file locking extension. |
bded7de2 SC |
1672 | */ |
1673 | ||
b39096a4 | 1674 | int ifd; |
7a276b09 | 1675 | |
bded7de2 | 1676 | /* |
b39096a4 | 1677 | The format which belongs to the BFD. |
bded7de2 SC |
1678 | */ |
1679 | ||
b39096a4 | 1680 | bfd_format format; |
bded7de2 SC |
1681 | |
1682 | /* | |
b39096a4 | 1683 | The direction the BFD was opened with |
bded7de2 SC |
1684 | */ |
1685 | ||
b39096a4 SC |
1686 | enum bfd_direction {no_direction = 0, |
1687 | read_direction = 1, | |
1688 | write_direction = 2, | |
1689 | both_direction = 3} direction; | |
7a276b09 | 1690 | |
bded7de2 | 1691 | /* |
b39096a4 | 1692 | Format_specific flags |
bded7de2 SC |
1693 | */ |
1694 | ||
b39096a4 | 1695 | flagword flags; |
7a276b09 | 1696 | |
bded7de2 | 1697 | /* |
b39096a4 SC |
1698 | Currently my_archive is tested before adding origin to anything. I |
1699 | believe that this can become always an add of origin, with origin set | |
1700 | to 0 for non archive files. | |
bded7de2 SC |
1701 | */ |
1702 | ||
b39096a4 | 1703 | file_ptr origin; |
7a276b09 | 1704 | |
bded7de2 | 1705 | /* |
b39096a4 | 1706 | Remember when output has begun, to stop strange things happening. |
bded7de2 SC |
1707 | */ |
1708 | ||
b39096a4 | 1709 | boolean output_has_begun; |
7a276b09 | 1710 | |
bded7de2 | 1711 | /* |
b39096a4 | 1712 | Pointer to linked list of sections |
bded7de2 SC |
1713 | */ |
1714 | ||
b39096a4 | 1715 | struct sec *sections; |
7a276b09 | 1716 | |
bded7de2 | 1717 | /* |
b39096a4 | 1718 | The number of sections |
bded7de2 SC |
1719 | */ |
1720 | ||
b39096a4 | 1721 | unsigned int section_count; |
7a276b09 | 1722 | |
bded7de2 | 1723 | /* |
b39096a4 SC |
1724 | Stuff only useful for object files: |
1725 | The start address. | |
1726 | */ | |
7a276b09 | 1727 | |
b39096a4 SC |
1728 | bfd_vma start_address; |
1729 | /* Used for input and output | |
7a276b09 | 1730 | */ |
bded7de2 | 1731 | |
b39096a4 SC |
1732 | unsigned int symcount; |
1733 | /* Symbol table for output BFD | |
bded7de2 | 1734 | */ |
19b03b7a | 1735 | |
b39096a4 | 1736 | struct symbol_cache_entry **outsymbols; |
a07cc613 | 1737 | |
bded7de2 | 1738 | /* |
b39096a4 | 1739 | Pointer to structure which contains architecture information |
bded7de2 SC |
1740 | */ |
1741 | ||
b39096a4 | 1742 | struct bfd_arch_info_struct *arch_info; |
a07cc613 | 1743 | |
bded7de2 | 1744 | /* |
b39096a4 | 1745 | Stuff only useful for archives: |
bded7de2 SC |
1746 | */ |
1747 | ||
b39096a4 SC |
1748 | PTR arelt_data; |
1749 | struct _bfd *my_archive; | |
1750 | struct _bfd *next; | |
1751 | struct _bfd *archive_head; | |
1752 | boolean has_armap; | |
9b9c5c39 | 1753 | |
bded7de2 | 1754 | /* |
b39096a4 | 1755 | Used by the back end to hold private data. |
bded7de2 SC |
1756 | */ |
1757 | ||
b39096a4 | 1758 | PTR tdata; |
a07cc613 | 1759 | |
bded7de2 | 1760 | /* |
b39096a4 | 1761 | Used by the application to hold private data |
bded7de2 SC |
1762 | */ |
1763 | ||
b39096a4 | 1764 | PTR usrdata; |
a07cc613 | 1765 | |
bded7de2 | 1766 | /* |
b39096a4 | 1767 | Where all the allocated stuff under this BFD goes (@pxref{Memory Usage}). |
bded7de2 SC |
1768 | */ |
1769 | ||
b39096a4 SC |
1770 | struct obstack memory; |
1771 | }; | |
a07cc613 | 1772 | |
bded7de2 | 1773 | /* |
b39096a4 SC |
1774 | |
1775 | bfd_set_start_address | |
1776 | ||
1777 | Marks the entry point of an output BFD. Returns @code{true} on | |
1778 | success, @code{false} otherwise. | |
bded7de2 SC |
1779 | */ |
1780 | ||
b39096a4 | 1781 | PROTO(boolean, bfd_set_start_address,(bfd *, bfd_vma)); |
19b03b7a | 1782 | |
bded7de2 | 1783 | /* |
b39096a4 SC |
1784 | |
1785 | bfd_get_mtime | |
1786 | ||
1787 | Return cached file modification time (e.g. as read from archive header | |
1788 | for archive members, or from file system if we have been called | |
1789 | before); else determine modify time, cache it, and return it. | |
bded7de2 SC |
1790 | */ |
1791 | ||
b39096a4 | 1792 | PROTO(long, bfd_get_mtime, (bfd *)); |
a07cc613 | 1793 | |
bded7de2 | 1794 | /* |
b39096a4 SC |
1795 | |
1796 | stuff | |
bded7de2 SC |
1797 | */ |
1798 | ||
b39096a4 SC |
1799 | |
1800 | #define bfd_sizeof_headers(abfd, reloc) \ | |
1801 | BFD_SEND (abfd, _bfd_sizeof_headers, (abfd, reloc)) | |
1802 | ||
1803 | #define bfd_find_nearest_line(abfd, section, symbols, offset, filename_ptr, func, line_ptr) \ | |
1804 | BFD_SEND (abfd, _bfd_find_nearest_line, (abfd, section, symbols, offset, filename_ptr, func, line_ptr)) | |
1805 | ||
1806 | #define bfd_debug_info_start(abfd) \ | |
1807 | BFD_SEND (abfd, _bfd_debug_info_start, (abfd)) | |
1808 | ||
1809 | #define bfd_debug_info_end(abfd) \ | |
1810 | BFD_SEND (abfd, _bfd_debug_info_end, (abfd)) | |
1811 | ||
1812 | #define bfd_debug_info_accumulate(abfd, section) \ | |
1813 | BFD_SEND (abfd, _bfd_debug_info_accumulate, (abfd, section)) | |
1814 | ||
1815 | #define bfd_stat_arch_elt(abfd, stat) \ | |
1816 | BFD_SEND (abfd, _bfd_stat_arch_elt,(abfd, stat)) | |
1817 | ||
1818 | #define bfd_coff_swap_aux_in(a,e,t,c,i) \ | |
1819 | BFD_SEND (a, _bfd_coff_swap_aux_in, (a,e,t,c,i)) | |
1820 | ||
1821 | #define bfd_coff_swap_sym_in(a,e,i) \ | |
1822 | BFD_SEND (a, _bfd_coff_swap_sym_in, (a,e,i)) | |
1823 | ||
1824 | #define bfd_coff_swap_lineno_in(a,e,i) \ | |
1825 | BFD_SEND ( a, _bfd_coff_swap_lineno_in, (a,e,i)) | |
1826 | ||
1827 | #define bfd_set_arch_mach(abfd, arch, mach)\ | |
1828 | BFD_SEND ( abfd, _bfd_set_arch_mach, (abfd, arch, mach)) | |
7f3d9f46 | 1829 | |
bded7de2 | 1830 | /* |
bded7de2 SC |
1831 | */ |
1832 | ||
b39096a4 SC |
1833 | /*:archive.c*/ |
1834 | /* bfd_get_next_mapent | |
1835 | What this does | |
1836 | */ | |
1837 | PROTO(symindex, bfd_get_next_mapent, (bfd *, symindex, carsym **)); | |
7f3d9f46 | 1838 | |
bded7de2 | 1839 | /* |
b39096a4 SC |
1840 | |
1841 | bfd_set_archive_head | |
1842 | ||
1843 | Used whilst processing archives. Sets the head of the chain of BFDs | |
1844 | contained in an archive to @var{new_head}. (see chapter on archives) | |
bded7de2 SC |
1845 | */ |
1846 | ||
b39096a4 | 1847 | PROTO(boolean, bfd_set_archive_head, (bfd *output, bfd *new_head)); |
7a276b09 | 1848 | |
bded7de2 | 1849 | /* |
bded7de2 | 1850 | |
b39096a4 SC |
1851 | bfd_get_elt_at_index |
1852 | Return the sub bfd contained within the archive at archive index n. | |
bded7de2 | 1853 | */ |
7a276b09 | 1854 | |
b39096a4 | 1855 | PROTO(bfd *, bfd_get_elt_at_index, (bfd *, int)); |
7a276b09 | 1856 | |
bded7de2 | 1857 | /* |
b39096a4 SC |
1858 | |
1859 | bfd_openr_next_archived_file | |
1860 | Initially provided a BFD containing an archive and NULL, opens a BFD | |
1861 | on the first contained element and returns that. Subsequent calls to | |
1862 | bfd_openr_next_archived_file should pass the archive and the previous | |
1863 | return value to return a created BFD to the next contained element. | |
1864 | NULL is returned when there are no more. | |
bded7de2 SC |
1865 | */ |
1866 | ||
b39096a4 SC |
1867 | PROTO(bfd*, bfd_openr_next_archived_file, |
1868 | (bfd *archive, bfd *previous)); | |
7a276b09 | 1869 | |
bded7de2 | 1870 | /* |
b39096a4 | 1871 | */ |
bded7de2 | 1872 | |
b39096a4 SC |
1873 | |
1874 | /*:core.c*/ | |
1875 | /* bfd_core_file_failing_command | |
1876 | Returns a read-only string explaining what program was running when | |
1877 | it failed and produced the core file being read | |
4322f04d | 1878 | */ |
b39096a4 SC |
1879 | |
1880 | PROTO(CONST char *, bfd_core_file_failing_command, (bfd *)); | |
bded7de2 SC |
1881 | |
1882 | /* | |
1883 | ||
b39096a4 SC |
1884 | bfd_core_file_failing_signal |
1885 | Returns the signal number which caused the core dump which generated | |
1886 | the file the BFD is attached to. | |
bded7de2 | 1887 | */ |
a07cc613 | 1888 | |
b39096a4 | 1889 | PROTO(int, bfd_core_file_failing_signal, (bfd *)); |
a07cc613 | 1890 | |
bded7de2 | 1891 | /* |
7f3d9f46 | 1892 | |
b39096a4 SC |
1893 | core_file_matches_executable_p |
1894 | Returns @code{true} if the core file attached to @var{core_bfd} was | |
1895 | generated by a run of the executable file attached to @var{exec_bfd}, | |
1896 | or else @code{false}. | |
7a276b09 | 1897 | */ |
b39096a4 SC |
1898 | PROTO(boolean, core_file_matches_executable_p, |
1899 | (bfd *core_bfd, bfd *exec_bfd)); | |
bded7de2 SC |
1900 | |
1901 | /* | |
1ac2d1f2 | 1902 | */ |
bded7de2 | 1903 | |
1ac2d1f2 RP |
1904 | /*:targets.c*/ |
1905 | /* bfd_target | |
bded7de2 | 1906 | @node bfd_target |
a737c70b | 1907 | @subsection bfd_target |
7a276b09 SC |
1908 | This structure contains everything that BFD knows about a target. |
1909 | It includes things like its byte order, name, what routines to call | |
1910 | to do various operations, etc. | |
1911 | ||
1912 | Every BFD points to a target structure with its "xvec" member. | |
1913 | ||
7a276b09 SC |
1914 | Shortcut for declaring fields which are prototyped function pointers, |
1915 | while avoiding anguish on compilers that don't support protos. | |
1916 | */ | |
bded7de2 | 1917 | |
7a276b09 SC |
1918 | #define SDEF(ret, name, arglist) \ |
1919 | PROTO(ret,(*name),arglist) | |
1920 | #define SDEF_FMT(ret, name, arglist) \ | |
1921 | PROTO(ret,(*name[bfd_type_end]),arglist) | |
a07cc613 | 1922 | |
bded7de2 SC |
1923 | /* |
1924 | These macros are used to dispatch to functions through the bfd_target | |
2f60a880 RP |
1925 | vector. They are used in a number of macros further down in @file{bfd.h}, and |
1926 | are also used when calling various routines by hand inside the BFD | |
7a276b09 SC |
1927 | implementation. The "arglist" argument must be parenthesized; it |
1928 | contains all the arguments to the called function. | |
1929 | */ | |
bded7de2 | 1930 | |
7a276b09 SC |
1931 | #define BFD_SEND(bfd, message, arglist) \ |
1932 | ((*((bfd)->xvec->message)) arglist) | |
a07cc613 | 1933 | |
bded7de2 | 1934 | /* |
2f60a880 | 1935 | For operations which index on the BFD format |
7a276b09 | 1936 | */ |
bded7de2 | 1937 | |
7a276b09 SC |
1938 | #define BFD_SEND_FMT(bfd, message, arglist) \ |
1939 | (((bfd)->xvec->message[(int)((bfd)->format)]) arglist) | |
a07cc613 | 1940 | |
bded7de2 SC |
1941 | /* |
1942 | This is the struct which defines the type of BFD this is. The | |
2f60a880 | 1943 | "xvec" member of the struct @code{bfd} itself points here. Each module |
7a276b09 SC |
1944 | that implements access to a different target under BFD, defines |
1945 | one of these. | |
a07cc613 | 1946 | |
7a276b09 SC |
1947 | FIXME, these names should be rationalised with the names of the |
1948 | entry points which call them. Too bad we can't have one macro to | |
1949 | define them both! | |
7a276b09 | 1950 | */ |
bded7de2 | 1951 | |
7a276b09 SC |
1952 | typedef struct bfd_target |
1953 | { | |
a07cc613 | 1954 | |
bded7de2 SC |
1955 | /* |
1956 | identifies the kind of target, eg SunOS4, Ultrix, etc | |
1957 | */ | |
1958 | ||
7a276b09 SC |
1959 | char *name; |
1960 | ||
bded7de2 SC |
1961 | /* |
1962 | The "flavour" of a back end is a general indication about the contents | |
1963 | of a file. | |
1964 | */ | |
1965 | ||
7a276b09 SC |
1966 | enum target_flavour_enum { |
1967 | bfd_target_aout_flavour_enum, | |
1968 | bfd_target_coff_flavour_enum, | |
927edea6 | 1969 | bfd_target_elf_flavour_enum, |
7a276b09 SC |
1970 | bfd_target_ieee_flavour_enum, |
1971 | bfd_target_oasys_flavour_enum, | |
1972 | bfd_target_srec_flavour_enum} flavour; | |
1973 | ||
bded7de2 SC |
1974 | /* |
1975 | The order of bytes within the data area of a file. | |
1976 | */ | |
1977 | ||
7a276b09 SC |
1978 | boolean byteorder_big_p; |
1979 | ||
bded7de2 SC |
1980 | /* |
1981 | The order of bytes within the header parts of a file. | |
1982 | */ | |
1983 | ||
7a276b09 SC |
1984 | boolean header_byteorder_big_p; |
1985 | ||
bded7de2 SC |
1986 | /* |
1987 | This is a mask of all the flags which an executable may have set - | |
1988 | from the set @code{NO_FLAGS}, @code{HAS_RELOC}, ...@code{D_PAGED}. | |
1989 | */ | |
1990 | ||
7a276b09 SC |
1991 | flagword object_flags; |
1992 | ||
bded7de2 SC |
1993 | /* |
1994 | This is a mask of all the flags which a section may have set - from | |
1995 | the set @code{SEC_NO_FLAGS}, @code{SEC_ALLOC}, ...@code{SET_NEVER_LOAD}. | |
1996 | */ | |
1997 | ||
7a276b09 SC |
1998 | flagword section_flags; |
1999 | ||
bded7de2 SC |
2000 | /* |
2001 | The pad character for filenames within an archive header. | |
2002 | */ | |
2003 | ||
7a276b09 SC |
2004 | char ar_pad_char; |
2005 | ||
bded7de2 SC |
2006 | /* |
2007 | The maximum number of characters in an archive header. | |
2008 | */ | |
2009 | ||
7a276b09 SC |
2010 | unsigned short ar_max_namelen; |
2011 | ||
bded7de2 SC |
2012 | /* |
2013 | The minimum alignment restriction for any section. | |
2014 | */ | |
2015 | ||
7a276b09 SC |
2016 | unsigned int align_power_min; |
2017 | ||
bded7de2 SC |
2018 | /* |
2019 | Entries for byte swapping for data. These are different to the other | |
2f60a880 | 2020 | entry points, since they don't take BFD as first arg. Certain other handlers |
bded7de2 SC |
2021 | could do the same. |
2022 | */ | |
2023 | ||
fcc654cb SC |
2024 | SDEF (bfd_vma, bfd_getx64, (bfd_byte *)); |
2025 | SDEF (void, bfd_putx64, (bfd_vma, bfd_byte *)); | |
2026 | SDEF (bfd_vma, bfd_getx32, (bfd_byte *)); | |
2027 | SDEF (void, bfd_putx32, (bfd_vma, bfd_byte *)); | |
2028 | SDEF (bfd_vma, bfd_getx16, (bfd_byte *)); | |
2029 | SDEF (void, bfd_putx16, (bfd_vma, bfd_byte *)); | |
7a276b09 | 2030 | |
bded7de2 SC |
2031 | /* |
2032 | Byte swapping for the headers | |
2033 | */ | |
2034 | ||
fcc654cb SC |
2035 | SDEF (bfd_vma, bfd_h_getx64, (bfd_byte *)); |
2036 | SDEF (void, bfd_h_putx64, (bfd_vma, bfd_byte *)); | |
2037 | SDEF (bfd_vma, bfd_h_getx32, (bfd_byte *)); | |
2038 | SDEF (void, bfd_h_putx32, (bfd_vma, bfd_byte *)); | |
2039 | SDEF (bfd_vma, bfd_h_getx16, (bfd_byte *)); | |
2040 | SDEF (void, bfd_h_putx16, (bfd_vma, bfd_byte *)); | |
7a276b09 | 2041 | |
bded7de2 SC |
2042 | /* |
2043 | Format dependent routines, these turn into vectors of entry points | |
2044 | within the target vector structure; one for each format to check. | |
2045 | ||
2046 | Check the format of a file being read. Return bfd_target * or zero. | |
2047 | */ | |
2048 | ||
7a276b09 SC |
2049 | SDEF_FMT (struct bfd_target *, _bfd_check_format, (bfd *)); |
2050 | ||
bded7de2 SC |
2051 | /* |
2052 | Set the format of a file being written. | |
2053 | */ | |
2054 | ||
7a276b09 SC |
2055 | SDEF_FMT (boolean, _bfd_set_format, (bfd *)); |
2056 | ||
bded7de2 SC |
2057 | /* |
2058 | Write cached information into a file being written, at bfd_close. | |
2059 | */ | |
2060 | ||
7a276b09 SC |
2061 | SDEF_FMT (boolean, _bfd_write_contents, (bfd *)); |
2062 | ||
bded7de2 SC |
2063 | /* |
2064 | The following functions are defined in @code{JUMP_TABLE}. The idea is | |
2065 | that the back end writer of @code{foo} names all the routines | |
2066 | @code{foo_}@var{entry_point}, @code{JUMP_TABLE} will built the entries | |
2067 | in this structure in the right order. | |
2068 | ||
2069 | Core file entry points | |
2070 | */ | |
2071 | ||
7a276b09 SC |
2072 | SDEF (char *, _core_file_failing_command, (bfd *)); |
2073 | SDEF (int, _core_file_failing_signal, (bfd *)); | |
2074 | SDEF (boolean, _core_file_matches_executable_p, (bfd *, bfd *)); | |
2075 | ||
bded7de2 SC |
2076 | /* |
2077 | Archive entry points | |
2078 | */ | |
2079 | ||
7a276b09 SC |
2080 | SDEF (boolean, _bfd_slurp_armap, (bfd *)); |
2081 | SDEF (boolean, _bfd_slurp_extended_name_table, (bfd *)); | |
2082 | SDEF (void, _bfd_truncate_arname, (bfd *, CONST char *, char *)); | |
2083 | SDEF (boolean, write_armap, (bfd *arch, | |
2084 | unsigned int elength, | |
2085 | struct orl *map, | |
2086 | int orl_count, | |
2087 | int stridx)); | |
2088 | ||
bded7de2 SC |
2089 | /* |
2090 | Standard stuff. | |
2091 | */ | |
2092 | ||
7a276b09 SC |
2093 | SDEF (boolean, _close_and_cleanup, (bfd *)); |
2094 | SDEF (boolean, _bfd_set_section_contents, (bfd *, sec_ptr, PTR, | |
2095 | file_ptr, bfd_size_type)); | |
2096 | SDEF (boolean, _bfd_get_section_contents, (bfd *, sec_ptr, PTR, | |
2097 | file_ptr, bfd_size_type)); | |
2098 | SDEF (boolean, _new_section_hook, (bfd *, sec_ptr)); | |
2099 | ||
bded7de2 SC |
2100 | /* |
2101 | Symbols and reloctions | |
2102 | */ | |
2103 | ||
de7e640d | 2104 | SDEF (unsigned int, _get_symtab_upper_bound, (bfd *)); |
7a276b09 SC |
2105 | SDEF (unsigned int, _bfd_canonicalize_symtab, |
2106 | (bfd *, struct symbol_cache_entry **)); | |
2107 | SDEF (unsigned int, _get_reloc_upper_bound, (bfd *, sec_ptr)); | |
2108 | SDEF (unsigned int, _bfd_canonicalize_reloc, (bfd *, sec_ptr, arelent **, | |
2109 | struct symbol_cache_entry**)); | |
2110 | SDEF (struct symbol_cache_entry *, _bfd_make_empty_symbol, (bfd *)); | |
2111 | SDEF (void, _bfd_print_symbol, (bfd *, PTR, struct symbol_cache_entry *, | |
2112 | bfd_print_symbol_enum_type)); | |
2113 | #define bfd_print_symbol(b,p,s,e) BFD_SEND(b, _bfd_print_symbol, (b,p,s,e)) | |
2114 | SDEF (alent *, _get_lineno, (bfd *, struct symbol_cache_entry *)); | |
2115 | ||
2116 | SDEF (boolean, _bfd_set_arch_mach, (bfd *, enum bfd_architecture, | |
2117 | unsigned long)); | |
2118 | ||
2119 | SDEF (bfd *, openr_next_archived_file, (bfd *arch, bfd *prev)); | |
2120 | SDEF (boolean, _bfd_find_nearest_line, | |
2121 | (bfd *abfd, struct sec *section, | |
2122 | struct symbol_cache_entry **symbols,bfd_vma offset, | |
2123 | CONST char **file, CONST char **func, unsigned int *line)); | |
2124 | SDEF (int, _bfd_stat_arch_elt, (bfd *, struct stat *)); | |
2125 | ||
2126 | SDEF (int, _bfd_sizeof_headers, (bfd *, boolean)); | |
2127 | ||
2128 | SDEF (void, _bfd_debug_info_start, (bfd *)); | |
2129 | SDEF (void, _bfd_debug_info_end, (bfd *)); | |
2130 | SDEF (void, _bfd_debug_info_accumulate, (bfd *, struct sec *)); | |
2131 | ||
bded7de2 SC |
2132 | /* |
2133 | Special entry points for gdb to swap in coff symbol table parts | |
2134 | */ | |
2135 | ||
7a276b09 SC |
2136 | SDEF(void, _bfd_coff_swap_aux_in,( |
2137 | bfd *abfd , | |
2138 | PTR ext, | |
2139 | int type, | |
2140 | int class , | |
2141 | PTR in)); | |
2142 | ||
2143 | SDEF(void, _bfd_coff_swap_sym_in,( | |
2144 | bfd *abfd , | |
2145 | PTR ext, | |
2146 | PTR in)); | |
2147 | ||
2148 | SDEF(void, _bfd_coff_swap_lineno_in, ( | |
2149 | bfd *abfd, | |
2150 | PTR ext, | |
2151 | PTR in)); | |
2152 | ||
2153 | } bfd_target; | |
2154 | ||
bded7de2 SC |
2155 | /* |
2156 | ||
2157 | *i bfd_find_target | |
2158 | Returns a pointer to the transfer vector for the object target | |
7a276b09 SC |
2159 | named target_name. If target_name is NULL, chooses the one in the |
2160 | environment variable GNUTARGET; if that is null or not defined then | |
2161 | the first entry in the target list is chosen. Passing in the | |
2162 | string "default" or setting the environment variable to "default" | |
2163 | will cause the first entry in the target list to be returned, | |
2f60a880 RP |
2164 | and "target_defaulted" will be set in the BFD. This causes |
2165 | @code{bfd_check_format} to loop over all the targets to find the one | |
7a276b09 SC |
2166 | that matches the file being read. |
2167 | */ | |
bded7de2 SC |
2168 | PROTO(bfd_target *, bfd_find_target,(CONST char *, bfd *)); |
2169 | ||
2170 | /* | |
2171 | ||
2172 | *i bfd_target_list | |
2173 | This function returns a freshly malloced NULL-terminated vector of the | |
2f60a880 | 2174 | names of all the valid BFD targets. Do not modify the names |
7a276b09 | 2175 | */ |
bded7de2 SC |
2176 | PROTO(CONST char **,bfd_target_list,()); |
2177 | ||
2178 | /* | |
1ac2d1f2 | 2179 | */ |
bded7de2 | 2180 | |
bded7de2 | 2181 | |
1ac2d1f2 RP |
2182 | /*:format.c*/ |
2183 | /* *i bfd_check_format | |
2f60a880 RP |
2184 | This routine is supplied a BFD and a format. It attempts to verify if |
2185 | the file attached to the BFD is indeed compatible with the format | |
7a276b09 SC |
2186 | specified (ie, one of @code{bfd_object}, @code{bfd_archive} or |
2187 | @code{bfd_core}). | |
2188 | ||
2f60a880 | 2189 | If the BFD has been set to a specific @var{target} before the call, |
7a276b09 SC |
2190 | only the named target and format combination will be checked. If the |
2191 | target has not been set, or has been set to @code{default} then all | |
2192 | the known target backends will be interrogated to determine a match. | |
2193 | ||
2194 | The function returns @code{true} on success, otherwise @code{false} | |
2195 | with one of the following error codes: | |
2196 | @table @code | |
2197 | @item | |
2198 | invalid_operation | |
2199 | if @code{format} is not one of @code{bfd_object}, @code{bfd_archive} | |
2200 | or @code{bfd_core}. | |
2201 | @item system_call_error | |
2202 | if an error occured during a read - even some file mismatches can | |
2203 | cause system_call_errros | |
2204 | @item file_not_recognised | |
2205 | none of the backends recognised the file format | |
2206 | @item file_ambiguously_recognized | |
2207 | more than one backend recognised the file format. | |
2208 | @end table | |
2209 | */ | |
bded7de2 SC |
2210 | PROTO(boolean, bfd_check_format, (bfd *abfd, bfd_format format)); |
2211 | ||
2212 | /* | |
2213 | ||
2214 | *i bfd_set_format | |
2f60a880 RP |
2215 | This function sets the file format of the supplied BFD to the format |
2216 | requested. If the target set in the BFD does not support the format | |
2217 | requested, the format is illegal or the BFD is not open for writing | |
7a276b09 SC |
2218 | than an error occurs. |
2219 | */ | |
bded7de2 SC |
2220 | PROTO(boolean,bfd_set_format,(bfd *, bfd_format)); |
2221 | ||
2222 | /* | |
2223 | ||
2224 | *i bfd_format_string | |
2225 | This function takes one argument, and enumerated type (bfd_format) and | |
7a276b09 SC |
2226 | returns a pointer to a const string "invalid", "object", "archive", |
2227 | "core" or "unknown" depending upon the value of the enumeration. | |
2228 | */ | |
bded7de2 | 2229 | PROTO(CONST char *, bfd_format_string, (bfd_format)); |
a07cc613 | 2230 | |
bded7de2 | 2231 | /* |
1ac2d1f2 | 2232 | */ |
bded7de2 SC |
2233 | |
2234 | #endif | |
b39096a4 SC |
2235 | |
2236 | ||
2237 | ||
2238 | ||
2239 |