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