Commit | Line | Data |
---|---|---|
00539ee3 JG |
1 | /* Main header file for the bfd library -- portable access to object files. |
2 | ==> The bfd.h file is generated from bfd-in.h and various .c files; if you | |
3 | ==> change it, your changes will probably be lost. | |
4 | Copyright 1990, 1991, 1992 Free Software Foundation, Inc. | |
63ffe5ef SC |
5 | Contributed by Cygnus Support. |
6 | ||
7 | This file is part of BFD, the Binary File Descriptor library. | |
8 | ||
9 | This program is free software; you can redistribute it and/or modify | |
10 | it under the terms of the GNU General Public License as published by | |
11 | the Free Software Foundation; either version 2 of the License, or | |
12 | (at your option) any later version. | |
13 | ||
14 | This program is distributed in the hope that it will be useful, | |
15 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
17 | GNU General Public License for more details. | |
18 | ||
19 | You should have received a copy of the GNU General Public License | |
20 | along with this program; if not, write to the Free Software | |
21 | Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */ | |
22 | ||
23 | /* bfd.h -- The only header file required by users of the bfd library | |
24 | ||
00539ee3 JG |
25 | The bfd.h file is generated from bfd-in.h and various .c files; if you |
26 | change it, your changes will probably be lost. | |
63ffe5ef SC |
27 | |
28 | All the prototypes and definitions following the comment "THE FOLLOWING | |
29 | IS EXTRACTED FROM THE SOURCE" are extracted from the source files for | |
30 | BFD. If you change it, someone oneday will extract it from the source | |
31 | again, and your changes will be lost. To save yourself from this bind, | |
32 | change the definitions in the source in the bfd directory. Type "make | |
33 | docs" and then "make headers" in that directory, and magically this file | |
34 | will change to reflect your changes. | |
35 | ||
36 | If you don't have the tools to perform the extraction, then you are | |
37 | safe from someone on your system trampling over your header files. | |
38 | You should still maintain the equivalence between the source and this | |
39 | file though; every change you make to the .c file should be reflected | |
40 | here. */ | |
41 | ||
42 | #ifndef __BFD_H_SEEN__ | |
43 | #define __BFD_H_SEEN__ | |
44 | ||
45 | #include "ansidecl.h" | |
46 | #include "obstack.h" | |
47 | ||
294eaca4 | 48 | #define BFD_VERSION "2.0" |
63ffe5ef SC |
49 | |
50 | /* forward declaration */ | |
51 | typedef struct _bfd bfd; | |
52 | ||
53 | /* General rules: functions which are boolean return true on success | |
54 | and false on failure (unless they're a predicate). -- bfd.doc */ | |
55 | /* I'm sure this is going to break something and someone is going to | |
56 | force me to change it. */ | |
f004165e JG |
57 | /* typedef enum boolean {false, true} boolean; */ |
58 | /* Yup, SVR4 has a "typedef enum boolean" in <sys/types.h> -fnf */ | |
59 | typedef enum bfd_boolean {false, true} boolean; | |
63ffe5ef | 60 | |
00539ee3 JG |
61 | /* A pointer to a position in a file. */ |
62 | /* FIXME: This should be using off_t from <sys/types.h>. | |
63 | For now, try to avoid breaking stuff by not including <sys/types.h> here. | |
64 | This will break on systems with 64-bit file offsets (e.g. 4.4BSD). | |
65 | Probably the best long-term answer is to avoid using file_ptr AND off_t | |
66 | in this header file, and to handle this in the BFD implementation | |
67 | rather than in its interface. */ | |
68 | /* typedef off_t file_ptr; */ | |
69 | typedef long int file_ptr; | |
63ffe5ef SC |
70 | |
71 | /* Support for different sizes of target format ints and addresses */ | |
72 | ||
73 | #ifdef HOST_64_BIT | |
74 | typedef HOST_64_BIT rawdata_offset; | |
75 | typedef HOST_64_BIT bfd_vma; | |
76 | typedef HOST_64_BIT bfd_word; | |
77 | typedef HOST_64_BIT bfd_offset; | |
78 | typedef HOST_64_BIT bfd_size_type; | |
79 | typedef HOST_64_BIT symvalue; | |
80 | typedef HOST_64_BIT bfd_64_type; | |
81 | #define fprintf_vma(s,x) \ | |
82 | fprintf(s,"%08x%08x", uint64_typeHIGH(x), uint64_typeLOW(x)) | |
63ffe5ef SC |
83 | #else |
84 | typedef struct {int a,b;} bfd_64_type; | |
85 | typedef unsigned long rawdata_offset; | |
86 | typedef unsigned long bfd_vma; | |
87 | typedef unsigned long bfd_offset; | |
88 | typedef unsigned long bfd_word; | |
89 | typedef unsigned long bfd_size; | |
90 | typedef unsigned long symvalue; | |
91 | typedef unsigned long bfd_size_type; | |
63ffe5ef SC |
92 | #define fprintf_vma(s,x) fprintf(s, "%08lx", x) |
93 | #endif | |
e98e6ec1 | 94 | #define printf_vma(x) fprintf_vma(stdout,x) |
63ffe5ef SC |
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 */ | |
294eaca4 SC |
109 | #define NO_FLAGS 0x00 |
110 | #define HAS_RELOC 0x01 | |
111 | #define EXEC_P 0x02 | |
112 | #define HAS_LINENO 0x04 | |
113 | #define HAS_DEBUG 0x08 | |
114 | #define HAS_SYMS 0x10 | |
115 | #define HAS_LOCALS 0x20 | |
116 | #define DYNAMIC 0x40 | |
117 | #define WP_TEXT 0x80 | |
118 | #define D_PAGED 0x100 | |
119 | #define BFD_IS_RELAXABLE 0x200 | |
63ffe5ef SC |
120 | \f |
121 | /* symbols and relocation */ | |
122 | ||
123 | typedef unsigned long symindex; | |
124 | ||
125 | #define BFD_NO_MORE_SYMBOLS ((symindex) ~0) | |
126 | ||
127 | typedef enum bfd_symclass { | |
128 | bfd_symclass_unknown = 0, | |
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 | ||
135 | ||
136 | typedef int symtype; /* Who knows, yet? */ | |
137 | ||
138 | ||
139 | /* general purpose part of a symbol; | |
140 | target specific parts will be found in libcoff.h, liba.out.h etc */ | |
141 | ||
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) | |
0c2fae09 | 146 | #define bfd_asymbol_base(x) ((x)->section->vma) |
63ffe5ef SC |
147 | #define bfd_asymbol_value(x) (bfd_asymbol_base(x) + x->value) |
148 | #define bfd_asymbol_name(x) ((x)->name) | |
0c2fae09 ILT |
149 | /*Perhaps future: #define bfd_asymbol_bfd(x) ((x)->section->owner)*/ |
150 | #define bfd_asymbol_bfd(x) ((x)->the_bfd) | |
151 | #define bfd_asymbol_flavour(x) (bfd_asymbol_bfd(x)->xvec->flavour) | |
63ffe5ef SC |
152 | |
153 | /* This is a type pun with struct ranlib on purpose! */ | |
154 | typedef struct carsym { | |
155 | char *name; | |
156 | file_ptr file_offset; /* look here to find the file */ | |
157 | } carsym; /* to make these you call a carsymogen */ | |
158 | ||
159 | ||
160 | /* Used in generating armaps. Perhaps just a forward definition would do? */ | |
161 | struct orl { /* output ranlib */ | |
162 | char **name; /* symbol name */ | |
163 | file_ptr pos; /* bfd* or file position */ | |
164 | int namidx; /* index into string table */ | |
165 | }; | |
166 | ||
167 | \f | |
168 | ||
169 | /* Linenumber stuff */ | |
170 | typedef struct lineno_cache_entry { | |
171 | unsigned int line_number; /* Linenumber from start of function*/ | |
172 | union { | |
173 | struct symbol_cache_entry *sym; /* Function name */ | |
174 | unsigned long offset; /* Offset into section */ | |
175 | } u; | |
176 | } alent; | |
177 | \f | |
178 | /* object and core file sections */ | |
179 | ||
180 | ||
181 | #define align_power(addr, align) \ | |
182 | ( ((addr) + ((1<<(align))-1)) & (-1 << (align))) | |
183 | ||
184 | typedef struct sec *sec_ptr; | |
185 | ||
294eaca4 SC |
186 | #define bfd_get_section_name(bfd, ptr) ((ptr)->name + 0) |
187 | #define bfd_get_section_vma(bfd, ptr) ((ptr)->vma + 0) | |
188 | #define bfd_get_section_alignment(bfd, ptr) ((ptr)->alignment_power + 0) | |
63ffe5ef | 189 | #define bfd_section_name(bfd, ptr) ((ptr)->name) |
e98e6ec1 | 190 | #define bfd_section_size(bfd, ptr) (bfd_get_section_size_before_reloc(ptr)) |
63ffe5ef SC |
191 | #define bfd_section_vma(bfd, ptr) ((ptr)->vma) |
192 | #define bfd_section_alignment(bfd, ptr) ((ptr)->alignment_power) | |
294eaca4 | 193 | #define bfd_get_section_flags(bfd, ptr) ((ptr)->flags + 0) |
63ffe5ef SC |
194 | #define bfd_get_section_userdata(bfd, ptr) ((ptr)->userdata) |
195 | ||
294eaca4 | 196 | #define bfd_set_section_vma(bfd, ptr, val) (((ptr)->vma = (val)), ((ptr)->user_set_vma = true), true) |
63ffe5ef SC |
197 | #define bfd_set_section_alignment(bfd, ptr, val) (((ptr)->alignment_power = (val)),true) |
198 | #define bfd_set_section_userdata(bfd, ptr, val) (((ptr)->userdata = (val)),true) | |
199 | ||
200 | typedef struct stat stat_type; | |
201 | \f | |
202 | /** Error handling */ | |
203 | ||
204 | typedef enum bfd_error { | |
205 | no_error = 0, system_call_error, invalid_target, | |
206 | wrong_format, invalid_operation, no_memory, | |
207 | no_symbols, no_relocation_info, | |
208 | no_more_archived_files, malformed_archive, | |
209 | symbol_not_found, file_not_recognized, | |
210 | file_ambiguously_recognized, no_contents, | |
cbdc7909 | 211 | bfd_error_nonrepresentable_section, |
294eaca4 | 212 | no_debug_section, bad_value, |
63ffe5ef SC |
213 | invalid_error_code} bfd_ec; |
214 | ||
215 | extern bfd_ec bfd_error; | |
e98e6ec1 | 216 | struct reloc_cache_entry; |
1093ee14 | 217 | struct bfd_seclet; |
e98e6ec1 | 218 | |
63ffe5ef SC |
219 | |
220 | typedef struct bfd_error_vector { | |
1093ee14 JG |
221 | void (* nonrepresentable_section ) PARAMS ((CONST bfd *CONST abfd, |
222 | CONST char *CONST name)); | |
223 | void (* undefined_symbol) PARAMS ((CONST struct reloc_cache_entry *rel, | |
224 | CONST struct bfd_seclet *sec)); | |
225 | void (* reloc_value_truncated) PARAMS ((CONST struct | |
e98e6ec1 | 226 | reloc_cache_entry *rel, |
1093ee14 | 227 | struct bfd_seclet *sec)); |
e98e6ec1 | 228 | |
1093ee14 JG |
229 | void (* reloc_dangerous) PARAMS ((CONST struct reloc_cache_entry *rel, |
230 | CONST struct bfd_seclet *sec)); | |
e98e6ec1 | 231 | |
63ffe5ef SC |
232 | } bfd_error_vector_type; |
233 | ||
1093ee14 JG |
234 | CONST char *bfd_errmsg PARAMS ((bfd_ec error_tag)); |
235 | void bfd_perror PARAMS ((CONST char *message)); | |
63ffe5ef SC |
236 | \f |
237 | ||
238 | typedef enum bfd_print_symbol | |
239 | { | |
cbdc7909 JG |
240 | bfd_print_symbol_name, |
241 | bfd_print_symbol_more, | |
e98e6ec1 | 242 | bfd_print_symbol_all, |
2cfd0562 | 243 | bfd_print_symbol_nm /* Pretty format suitable for nm program. */ |
cbdc7909 | 244 | } bfd_print_symbol_type; |
63ffe5ef SC |
245 | |
246 | \f | |
247 | \f | |
248 | /* The code that implements targets can initialize a jump table with this | |
249 | macro. It must name all its routines the same way (a prefix plus | |
250 | the standard routine suffix), or it must #define the routines that | |
251 | are not so named, before calling JUMP_TABLE in the initializer. */ | |
252 | ||
253 | /* Semi-portable string concatenation in cpp */ | |
254 | #ifndef CAT | |
255 | #ifdef __STDC__ | |
256 | #define CAT(a,b) a##b | |
257 | #else | |
258 | #define CAT(a,b) a/**/b | |
259 | #endif | |
260 | #endif | |
261 | ||
262 | #define JUMP_TABLE(NAME)\ | |
263 | CAT(NAME,_core_file_failing_command),\ | |
264 | CAT(NAME,_core_file_failing_signal),\ | |
265 | CAT(NAME,_core_file_matches_executable_p),\ | |
266 | CAT(NAME,_slurp_armap),\ | |
267 | CAT(NAME,_slurp_extended_name_table),\ | |
268 | CAT(NAME,_truncate_arname),\ | |
269 | CAT(NAME,_write_armap),\ | |
270 | CAT(NAME,_close_and_cleanup), \ | |
271 | CAT(NAME,_set_section_contents),\ | |
272 | CAT(NAME,_get_section_contents),\ | |
273 | CAT(NAME,_new_section_hook),\ | |
274 | CAT(NAME,_get_symtab_upper_bound),\ | |
275 | CAT(NAME,_get_symtab),\ | |
276 | CAT(NAME,_get_reloc_upper_bound),\ | |
277 | CAT(NAME,_canonicalize_reloc),\ | |
278 | CAT(NAME,_make_empty_symbol),\ | |
279 | CAT(NAME,_print_symbol),\ | |
280 | CAT(NAME,_get_lineno),\ | |
281 | CAT(NAME,_set_arch_mach),\ | |
282 | CAT(NAME,_openr_next_archived_file),\ | |
283 | CAT(NAME,_find_nearest_line),\ | |
284 | CAT(NAME,_generic_stat_arch_elt),\ | |
285 | CAT(NAME,_sizeof_headers),\ | |
286 | CAT(NAME,_bfd_debug_info_start),\ | |
287 | CAT(NAME,_bfd_debug_info_end),\ | |
e98e6ec1 | 288 | CAT(NAME,_bfd_debug_info_accumulate),\ |
2cfd0562 | 289 | CAT(NAME,_bfd_get_relocated_section_contents),\ |
0c2fae09 ILT |
290 | CAT(NAME,_bfd_relax_section),\ |
291 | CAT(NAME,_bfd_seclet_link) | |
cbdc7909 | 292 | |
0c2fae09 | 293 | #define COFF_SWAP_TABLE (PTR) &bfd_coff_std_swap_table |
cbdc7909 | 294 | |
63ffe5ef SC |
295 | \f |
296 | /* User program access to BFD facilities */ | |
297 | ||
298 | extern CONST short _bfd_host_big_endian; | |
299 | #define HOST_BYTE_ORDER_BIG_P (*(char *)&_bfd_host_big_endian) | |
300 | ||
301 | /* The bfd itself */ | |
302 | ||
303 | /* Cast from const char * to char * so that caller can assign to | |
304 | a char * without a warning. */ | |
305 | #define bfd_get_filename(abfd) ((char *) (abfd)->filename) | |
306 | #define bfd_get_format(abfd) ((abfd)->format) | |
307 | #define bfd_get_target(abfd) ((abfd)->xvec->name) | |
308 | #define bfd_get_file_flags(abfd) ((abfd)->flags) | |
309 | #define bfd_applicable_file_flags(abfd) ((abfd)->xvec->object_flags) | |
310 | #define bfd_applicable_section_flags(abfd) ((abfd)->xvec->section_flags) | |
e98e6ec1 | 311 | #define bfd_my_archive(abfd) ((abfd)->my_archive) |
63ffe5ef SC |
312 | #define bfd_has_map(abfd) ((abfd)->has_armap) |
313 | #define bfd_header_twiddle_required(abfd) \ | |
314 | ((((abfd)->xvec->header_byteorder_big_p) \ | |
315 | != (boolean)HOST_BYTE_ORDER_BIG_P) ? true:false) | |
316 | ||
317 | #define bfd_valid_reloc_types(abfd) ((abfd)->xvec->valid_reloc_types) | |
318 | #define bfd_usrdata(abfd) ((abfd)->usrdata) | |
319 | ||
320 | #define bfd_get_start_address(abfd) ((abfd)->start_address) | |
321 | #define bfd_get_symcount(abfd) ((abfd)->symcount) | |
322 | #define bfd_get_outsymbols(abfd) ((abfd)->outsymbols) | |
323 | #define bfd_count_sections(abfd) ((abfd)->section_count) | |
324 | #define bfd_get_architecture(abfd) ((abfd)->obj_arch) | |
325 | #define bfd_get_machine(abfd) ((abfd)->obj_machine) | |
326 | ||
294eaca4 | 327 | #define bfd_get_symbol_leading_char(abfd) ((abfd)->xvec->symbol_leading_char) |
63ffe5ef SC |
328 | |
329 | #define BYTE_SIZE 1 | |
330 | #define SHORT_SIZE 2 | |
331 | #define LONG_SIZE 4 | |
332 | ||
294eaca4 | 333 | /* And more from the source. */ |