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