Commit | Line | Data |
---|---|---|
fc723380 JG |
1 | /* libbfd.h -- Declarations used by bfd library implementation. |
2 | This include file is not for users of the library */ | |
3 | ||
4a81b561 DHW |
4 | /* Copyright (C) 1990, 1991 Free Software Foundation, Inc. |
5 | ||
6 | This file is part of BFD, the Binary File Diddler. | |
7 | ||
8 | BFD is free software; you can redistribute it and/or modify | |
9 | it under the terms of the GNU General Public License as published by | |
10 | the Free Software Foundation; either version 1, or (at your option) | |
11 | any later version. | |
12 | ||
13 | BFD is distributed in the hope that it will be useful, | |
14 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
15 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
16 | GNU General Public License for more details. | |
17 | ||
18 | You should have received a copy of the GNU General Public License | |
19 | along with BFD; see the file COPYING. If not, write to | |
20 | the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */ | |
21 | ||
22 | /* $Id$ */ | |
23 | ||
4a81b561 DHW |
24 | /* If you want to read and write large blocks, you might want to do it |
25 | in quanta of this amount */ | |
26 | #define DEFAULT_BUFFERSIZE 8192 | |
27 | ||
fc723380 JG |
28 | /* Set a tdata field. Can't use the other macros for this, since they |
29 | do casts, and casting to the left of assignment isn't portable. */ | |
30 | #define set_tdata(bfd, v) ((bfd)->tdata = (PTR) (v)) | |
31 | ||
32 | /* tdata for an archive. For an input archive, cache | |
33 | needs to be free()'d. For an output archive, symdefs do. */ | |
4a81b561 DHW |
34 | |
35 | struct artdata { | |
36 | file_ptr first_file_filepos; | |
37 | /* Speed up searching the armap */ | |
38 | struct ar_cache *cache; | |
39 | bfd *archive_head; /* Only interesting in output routines */ | |
40 | carsym *symdefs; /* the symdef entries */ | |
41 | symindex symdef_count; /* how many there are */ | |
42 | char *extended_names; /* clever intel extension */ | |
43 | }; | |
44 | ||
45 | #define bfd_ardata(bfd) ((struct artdata *) ((bfd)->tdata)) | |
4a81b561 DHW |
46 | |
47 | /* Goes in bfd's arelt_data slot */ | |
48 | struct areltdata { | |
49 | char * arch_header; /* it's actually a string */ | |
50 | unsigned int parsed_size; /* octets of filesize not including ar_hdr */ | |
51 | char *filename; /* null-terminated */ | |
52 | }; | |
53 | ||
54 | #define arelt_size(bfd) (((struct areltdata *)((bfd)->arelt_data))->parsed_size) | |
55 | ||
56 | /* FIXME -- a lot of my code allocates a large block and subdivides it. | |
57 | This can't always work, because of alignment restrictions. We should change | |
58 | it before it becomes a problem -- Gumby */ | |
59 | ||
fc723380 | 60 | PROTO (char *, zalloc, (bfd_size_type size)); |
9846338e | 61 | |
fc723380 JG |
62 | /* These routines allocate and free things on the BFD's obstack. Note |
63 | that realloc can never occur in place. */ | |
4a81b561 | 64 | |
fc723380 JG |
65 | PROTO(PTR, bfd_alloc, (bfd *abfd, bfd_size_type size)); |
66 | PROTO(PTR, bfd_zalloc,(bfd *abfd, bfd_size_type size)); | |
67 | PROTO(PTR, bfd_realloc,(bfd *abfd, PTR orig, bfd_size_type new)); | |
68 | #define bfd_release(x,y) (void) obstack_free(&(x->memory),y) | |
4a81b561 | 69 | |
c0e5039e | 70 | PROTO (bfd_target *, bfd_find_target, (CONST char *target_name, bfd *)); |
fc723380 JG |
71 | PROTO (bfd_size_type, bfd_read, (PTR ptr, bfd_size_type size, bfd_size_type nitems, bfd *abfd)); |
72 | PROTO (bfd_size_type, bfd_write, (PTR ptr, bfd_size_type size, bfd_size_type nitems, bfd *abfd)); | |
4a81b561 DHW |
73 | |
74 | PROTO (FILE *, bfd_cache_lookup, (bfd *)); | |
75 | PROTO (void, bfd_cache_close, (bfd *)); | |
9846338e | 76 | PROTO (int, bfd_seek,(bfd* abfd, file_ptr fp , int direction)); |
4a81b561 DHW |
77 | PROTO (long, bfd_tell, (bfd *abfd)); |
78 | PROTO (bfd *, _bfd_create_empty_archive_element_shell, (bfd *obfd)); | |
79 | PROTO (bfd *, look_for_bfd_in_cache, (bfd *arch_bfd, file_ptr index)); | |
80 | PROTO (boolean, _bfd_generic_mkarchive, (bfd *abfd)); | |
81 | PROTO (struct areltdata *, snarf_ar_hdr, (bfd *abfd)); | |
82 | PROTO (bfd_target *, bfd_generic_archive_p, (bfd *abfd)); | |
83 | PROTO (boolean, bfd_slurp_bsd_armap, (bfd *abfd)); | |
84 | PROTO (boolean, bfd_slurp_coff_armap, (bfd *abfd)); | |
85 | PROTO (boolean, _bfd_slurp_extended_name_table, (bfd *abfd)); | |
86 | PROTO (boolean, _bfd_write_archive_contents, (bfd *abfd)); | |
87 | PROTO (bfd *, new_bfd, ()); | |
88 | ||
89 | #define DEFAULT_STRING_SPACE_SIZE 0x2000 | |
90 | PROTO (boolean, bfd_add_to_string_table, (char **table, char *new_string, | |
91 | unsigned int *table_length, | |
92 | char **free_ptr)); | |
7ed4093a SC |
93 | PROTO (bfd_64_type, _do_getb64, (unsigned char *addr)); |
94 | PROTO (bfd_64_type, _do_getl64, (unsigned char *addr)); | |
95 | PROTO (unsigned int, _do_getb32, (unsigned char *addr)); | |
96 | PROTO (unsigned int, _do_getl32, (unsigned char *addr)); | |
97 | PROTO (unsigned int, _do_getb16, (unsigned char *addr)); | |
98 | PROTO (unsigned int, _do_getl16, (unsigned char *addr)); | |
99 | PROTO (void, _do_putb64, (bfd_64_type data, unsigned char *addr)); | |
100 | PROTO (void, _do_putl64, (bfd_64_type data, unsigned char *addr)); | |
101 | PROTO (void, _do_putb32, (unsigned long data, unsigned char *addr)); | |
102 | PROTO (void, _do_putl32, (unsigned long data, unsigned char *addr)); | |
103 | PROTO (void, _do_putb16, (int data, unsigned char *addr)); | |
104 | PROTO (void, _do_putl16, (int data, unsigned char *addr)); | |
4a81b561 DHW |
105 | |
106 | PROTO (boolean, bfd_false, (bfd *ignore)); | |
107 | PROTO (boolean, bfd_true, (bfd *ignore)); | |
a0ad3035 | 108 | PROTO (PTR, bfd_nullvoidptr, (bfd *ignore)); |
4a81b561 DHW |
109 | PROTO (int, bfd_0, (bfd *ignore)); |
110 | PROTO (unsigned int, bfd_0u, (bfd *ignore)); | |
111 | PROTO (void, bfd_void, (bfd *ignore)); | |
112 | ||
4a81b561 DHW |
113 | PROTO (bfd *,new_bfd_contained_in,(bfd *)); |
114 | PROTO (boolean, _bfd_dummy_new_section_hook, (bfd *ignore, asection *newsect)); | |
115 | PROTO (char *, _bfd_dummy_core_file_failing_command, (bfd *abfd)); | |
116 | PROTO (int, _bfd_dummy_core_file_failing_signal, (bfd *abfd)); | |
117 | PROTO (boolean, _bfd_dummy_core_file_matches_executable_p, (bfd *core_bfd, | |
118 | bfd *exec_bfd)); | |
119 | PROTO (bfd_target *, _bfd_dummy_target, (bfd *abfd)); | |
120 | ||
69ebee86 JG |
121 | PROTO (void, bfd_dont_truncate_arname, (bfd *abfd, CONST char *filename, |
122 | char *hdr)); | |
123 | PROTO (void, bfd_bsd_truncate_arname, (bfd *abfd, CONST char *filename, | |
124 | char *hdr)); | |
125 | PROTO (void, bfd_gnu_truncate_arname, (bfd *abfd, CONST char *filename, | |
126 | char *hdr)); | |
4a81b561 DHW |
127 | |
128 | PROTO (boolean, bsd_write_armap, (bfd *arch, unsigned int elength, | |
129 | struct orl *map, int orl_count, int stridx)); | |
130 | ||
131 | PROTO (boolean, coff_write_armap, (bfd *arch, unsigned int elength, | |
132 | struct orl *map, int orl_count, int stridx)); | |
133 | ||
2203f786 JG |
134 | PROTO (bfd *, bfd_generic_openr_next_archived_file, (bfd *archive, |
135 | bfd *last_file)); | |
4a81b561 DHW |
136 | |
137 | PROTO(int, bfd_generic_stat_arch_elt, (bfd *, struct stat *)); | |
fc723380 | 138 | |
2203f786 | 139 | PROTO(boolean, bfd_generic_get_section_contents, |
7ed4093a | 140 | (bfd *abfd, sec_ptr section, PTR location, file_ptr offset, bfd_size_type count)); |
2203f786 | 141 | |
4a81b561 DHW |
142 | /* Macros to tell if bfds are read or write enabled. |
143 | ||
144 | Note that bfds open for read may be scribbled into if the fd passed | |
145 | to bfd_fdopenr is actually open both for read and write | |
146 | simultaneously. However an output bfd will never be open for | |
147 | read. Therefore sometimes you want to check bfd_read_p or | |
148 | !bfd_read_p, and only sometimes bfd_write_p. | |
149 | */ | |
150 | ||
151 | #define bfd_read_p(abfd) ((abfd)->direction == read_direction || (abfd)->direction == both_direction) | |
152 | #define bfd_write_p(abfd) ((abfd)->direction == write_direction || (abfd)->direction == both_direction) | |
153 | ||
154 | PROTO (void, bfd_assert,(char*,int)); | |
155 | #define BFD_ASSERT(x) \ | |
156 | { if (!(x)) bfd_assert(__FILE__,__LINE__); } | |
157 | ||
158 | #define BFD_FAIL() \ | |
159 | { bfd_assert(__FILE__,__LINE__); } | |
160 | ||
161 | PROTO (FILE *, bfd_cache_lookup_worker, (bfd *)); | |
162 | ||
163 | extern bfd *bfd_last_cache; | |
164 | #define bfd_cache_lookup(x) \ | |
165 | (x==bfd_last_cache?(FILE*)(bfd_last_cache->iostream):bfd_cache_lookup_worker(x)) | |
166 | ||
167 | /* Now Steve, what's the story here? */ | |
168 | #ifdef lint | |
169 | #define itos(x) "l" | |
170 | #define stoi(x) 1 | |
171 | #else | |
172 | #define itos(x) ((char*)(x)) | |
173 | #define stoi(x) ((int)(x)) | |
174 | #endif | |
69ebee86 JG |
175 | |
176 | /* Generic routine for close_and_cleanup is really just bfd_true. */ | |
177 | #define bfd_generic_close_and_cleanup bfd_true |