2 /* libbfd.h -- Declarations used by bfd library *implementation*.
3 (This include file is not for users of the library.)
4 Copyright (C) 1990-1991 Free Software Foundation, Inc.
5 Written by Cygnus Support.
7 This file is part of BFD, the Binary File Descriptor library.
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.
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.
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. */
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
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))
32 /* tdata for an archive. For an input archive, cache
33 needs to be free()'d. For an output archive, symdefs do. */
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 */
45 #define bfd_ardata(bfd) ((struct artdata *) ((bfd)->tdata))
47 /* Goes in bfd's arelt_data slot */
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 */
54 #define arelt_size(bfd) (((struct areltdata *)((bfd)->arelt_data))->parsed_size)
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 */
60 PROTO (char *, zalloc, (bfd_size_type size));
62 /* These routines allocate and free things on the BFD's obstack. Note
63 that realloc can never occur in place. */
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 PROTO(void, bfd_alloc_grow,(bfd *abfd, PTR thing, bfd_size_type size));
69 PROTO(PTR, bfd_alloc_finish,(bfd *abfd));
71 #define bfd_release(x,y) (void) obstack_free(&(x->memory),y)
74 PROTO (bfd_size_type, bfd_read, (PTR ptr, bfd_size_type size, bfd_size_type nitems, bfd *abfd));
75 PROTO (bfd_size_type, bfd_write, (CONST PTR ptr, bfd_size_type size, bfd_size_type nitems, bfd *abfd));
79 PROTO (int, bfd_seek,(bfd* abfd, file_ptr fp , int direction));
80 PROTO (long, bfd_tell, (bfd *abfd));
81 PROTO (bfd *, _bfd_create_empty_archive_element_shell, (bfd *obfd));
82 PROTO (bfd *, look_for_bfd_in_cache, (bfd *arch_bfd, file_ptr index));
83 PROTO (boolean, _bfd_generic_mkarchive, (bfd *abfd));
84 PROTO (struct areltdata *, snarf_ar_hdr, (bfd *abfd));
85 PROTO (bfd_target *, bfd_generic_archive_p, (bfd *abfd));
86 PROTO (boolean, bfd_slurp_bsd_armap, (bfd *abfd));
87 PROTO (boolean, bfd_slurp_coff_armap, (bfd *abfd));
88 PROTO (boolean, _bfd_slurp_extended_name_table, (bfd *abfd));
89 PROTO (boolean, _bfd_write_archive_contents, (bfd *abfd));
90 PROTO (bfd *, new_bfd, ());
92 #define DEFAULT_STRING_SPACE_SIZE 0x2000
93 PROTO (boolean, bfd_add_to_string_table, (char **table, char *new_string,
94 unsigned int *table_length,
96 PROTO (bfd_vma, _do_getb64, (unsigned char *addr));
97 PROTO (bfd_vma, _do_getl64, (unsigned char *addr));
98 PROTO (bfd_vma, _do_getb32, (unsigned char *addr));
99 PROTO (bfd_vma, _do_getl32, (unsigned char *addr));
100 PROTO (bfd_vma, _do_getb16, (unsigned char *addr));
101 PROTO (bfd_vma, _do_getl16, (unsigned char *addr));
102 PROTO (void, _do_putb64, (bfd_vma data, unsigned char *addr));
103 PROTO (void, _do_putl64, (bfd_vma data, unsigned char *addr));
104 PROTO (void, _do_putb32, (bfd_vma data, unsigned char *addr));
105 PROTO (void, _do_putl32, (bfd_vma data, unsigned char *addr));
106 PROTO (void, _do_putb16, (bfd_vma data, unsigned char *addr));
107 PROTO (void, _do_putl16, (bfd_vma data, unsigned char *addr));
109 PROTO (boolean, bfd_false, (bfd *ignore));
110 PROTO (boolean, bfd_true, (bfd *ignore));
111 PROTO (PTR, bfd_nullvoidptr, (bfd *ignore));
112 PROTO (int, bfd_0, (bfd *ignore));
113 PROTO (unsigned int, bfd_0u, (bfd *ignore));
114 PROTO (void, bfd_void, (bfd *ignore));
116 PROTO (bfd *,new_bfd_contained_in,(bfd *));
117 PROTO (boolean, _bfd_dummy_new_section_hook, (bfd *ignore, asection *newsect));
118 PROTO (char *, _bfd_dummy_core_file_failing_command, (bfd *abfd));
119 PROTO (int, _bfd_dummy_core_file_failing_signal, (bfd *abfd));
120 PROTO (boolean, _bfd_dummy_core_file_matches_executable_p, (bfd *core_bfd,
122 PROTO (bfd_target *, _bfd_dummy_target, (bfd *abfd));
124 PROTO (void, bfd_dont_truncate_arname, (bfd *abfd, CONST char *filename,
126 PROTO (void, bfd_bsd_truncate_arname, (bfd *abfd, CONST char *filename,
128 PROTO (void, bfd_gnu_truncate_arname, (bfd *abfd, CONST char *filename,
131 PROTO (boolean, bsd_write_armap, (bfd *arch, unsigned int elength,
132 struct orl *map, int orl_count, int stridx));
134 PROTO (boolean, coff_write_armap, (bfd *arch, unsigned int elength,
135 struct orl *map, int orl_count, int stridx));
137 PROTO (bfd *, bfd_generic_openr_next_archived_file, (bfd *archive,
140 PROTO(int, bfd_generic_stat_arch_elt, (bfd *, struct stat *));
142 PROTO(boolean, bfd_generic_get_section_contents,
143 (bfd *abfd, sec_ptr section, PTR location, file_ptr offset, bfd_size_type count));
145 /* Macros to tell if bfds are read or write enabled.
147 Note that bfds open for read may be scribbled into if the fd passed
148 to bfd_fdopenr is actually open both for read and write
149 simultaneously. However an output bfd will never be open for
150 read. Therefore sometimes you want to check bfd_read_p or
151 !bfd_read_p, and only sometimes bfd_write_p.
154 #define bfd_read_p(abfd) ((abfd)->direction == read_direction || (abfd)->direction == both_direction)
155 #define bfd_write_p(abfd) ((abfd)->direction == write_direction || (abfd)->direction == both_direction)
157 PROTO (void, bfd_assert,(char*,int));
158 #define BFD_ASSERT(x) \
159 { if (!(x)) bfd_assert(__FILE__,__LINE__); }
162 { bfd_assert(__FILE__,__LINE__); }
164 PROTO (FILE *, bfd_cache_lookup_worker, (bfd *));
166 extern bfd *bfd_last_cache;
168 /* Now Steve, what's the story here? */
173 #define itos(x) ((char*)(x))
174 #define stoi(x) ((int)(x))
177 /* Generic routine for close_and_cleanup is really just bfd_true. */
178 #define bfd_generic_close_and_cleanup bfd_true
180 /* THE FOLLOWING IS EXTRACTED FROM THE SOURCE*/