* bfd.c (bfd_get_error, bfd_set_error): New functions.
[deliverable/binutils-gdb.git] / bfd / libelf.h
CommitLineData
db232882
KR
1/* BFD back-end data structures for ELF files.
2 Copyright (C) 1992, 1993 Free Software Foundation, Inc.
3 Written by Cygnus Support.
4
5This file is part of BFD, the Binary File Descriptor library.
6
7This program is free software; you can redistribute it and/or modify
8it under the terms of the GNU General Public License as published by
9the Free Software Foundation; either version 2 of the License, or
10(at your option) any later version.
11
12This program is distributed in the hope that it will be useful,
13but WITHOUT ANY WARRANTY; without even the implied warranty of
14MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15GNU General Public License for more details.
16
17You should have received a copy of the GNU General Public License
18along with this program; if not, write to the Free Software
19Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
20
21#ifndef _LIBELF_H_
22#define _LIBELF_H_ 1
23
81187b54
KR
24#include "elf/common.h"
25#include "elf/internal.h"
26#include "elf/external.h"
27
998ce1e0 28/* If size isn't specified as 64 or 32, NAME macro should fail. */
9942e684 29#ifndef NAME
7050286d 30#if ARCH_SIZE==64
638616ca 31#define NAME(x,y) CAT4(x,64,_,y)
998ce1e0
KR
32#endif
33#if ARCH_SIZE==32
638616ca 34#define NAME(x,y) CAT4(x,32,_,y)
9942e684
KR
35#endif
36#endif
37
153cb9ad
KR
38#ifndef NAME
39#define NAME(x,y) CAT4(x,NOSIZE,_,y)
40#endif
41
638616ca
KR
42#define ElfNAME(X) NAME(Elf,X)
43#define elfNAME(X) NAME(elf,X)
44
95469b02
ILT
45/* Information held for an ELF symbol. The first field is the
46 corresponding asymbol. Every symbol is an ELF file is actually a
47 pointer to this structure, although it is often handled as a
48 pointer to an asymbol. */
49
db232882
KR
50typedef struct
51{
95469b02 52 /* The BFD symbol. */
db232882 53 asymbol symbol;
95469b02 54 /* ELF symbol information. */
268f94ac 55 Elf_Internal_Sym internal_elf_sym;
95469b02 56 /* Backend specific information. */
7050286d
KR
57 union
58 {
59 unsigned int hppa_arg_reloc;
cf286547 60 PTR mips_extr;
7050286d
KR
61 PTR any;
62 }
63 tc_data;
ee8cb548 64} elf_symbol_type;
7050286d 65
95469b02
ILT
66/* Constant information held for an ELF backend. */
67
268f94ac 68struct elf_backend_data
7050286d 69{
95469b02
ILT
70 /* Whether the backend uses REL or RELA relocations. FIXME: some
71 ELF backends use both. When we need to support one, this whole
72 approach will need to be changed. */
7050286d 73 int use_rela_p;
95469b02
ILT
74
75 /* Whether this backend is 64 bits or not. FIXME: Who cares? */
7050286d 76 int elf_64_p;
95469b02
ILT
77
78 /* The architecture for this backend. */
81187b54 79 enum bfd_architecture arch;
95469b02 80
a5ccdad1
ILT
81 /* The ELF machine code (EM_xxxx) for this backend. */
82 int elf_machine_code;
83
95469b02
ILT
84 /* The maximum page size for this backend. */
85 bfd_vma maxpagesize;
86
87 /* A function to translate an ELF RELA relocation to a BFD arelent
88 structure. */
7050286d 89 void (*elf_info_to_howto) PARAMS ((bfd *, arelent *,
268f94ac 90 Elf_Internal_Rela *));
95469b02
ILT
91
92 /* A function to translate an ELF REL relocation to a BFD arelent
93 structure. */
7050286d 94 void (*elf_info_to_howto_rel) PARAMS ((bfd *, arelent *,
268f94ac 95 Elf_Internal_Rel *));
db232882 96
643e9fc7
ILT
97 /* A function to determine whether a symbol is global when
98 partitioning the symbol table into local and global symbols.
99 This should be NULL for most targets, in which case the correct
100 thing will be done. MIPS ELF, at least on the Irix 5, has
101 special requirements. */
102 boolean (*elf_backend_sym_is_global) PARAMS ((bfd *, asymbol *));
103
95469b02
ILT
104 /* The remaining functions are hooks which are called only if they
105 are not NULL. */
106
a5ccdad1
ILT
107 /* A function to permit a backend specific check on whether a
108 particular BFD format is relevant for an object file, and to
109 permit the backend to set any global information it wishes. When
110 this is called elf_elfheader is set, but anything else should be
111 used with caution. If this returns false, the check_format
d1ad85a6 112 routine will return a bfd_error_wrong_format error. */
a5ccdad1
ILT
113 boolean (*elf_backend_object_p) PARAMS ((bfd *));
114
95469b02
ILT
115 /* A function to do additional symbol processing when reading the
116 ELF symbol table. This is where any processor-specific special
117 section indices are handled. */
e2a422b8 118 void (*elf_backend_symbol_processing) PARAMS ((bfd *, asymbol *));
95469b02
ILT
119
120 /* A function to do additional symbol processing after reading the
121 entire ELF symbol table. */
122 boolean (*elf_backend_symbol_table_processing) PARAMS ((bfd *,
123 elf_symbol_type *,
124 int));
125
126 /* A function to do additional processing on the ELF section header
127 just before writing it out. This is used to set the flags and
128 type fields for some sections, or to actually write out data for
129 unusual sections. */
130 boolean (*elf_backend_section_processing) PARAMS ((bfd *,
131 Elf32_Internal_Shdr *));
132
133 /* A function to handle unusual section types when creating BFD
134 sections from ELF sections. */
135 boolean (*elf_backend_section_from_shdr) PARAMS ((bfd *,
136 Elf32_Internal_Shdr *,
137 char *));
138
139 /* A function to set up the ELF section header for a BFD section in
140 preparation for writing it out. This is where the flags and type
141 fields are set for unusual sections. */
142 boolean (*elf_backend_fake_sections) PARAMS ((bfd *, Elf32_Internal_Shdr *,
143 asection *));
144
145 /* A function to get the ELF section index for a BFD section. If
146 this returns true, the section was found. If it is a normal ELF
147 section, *RETVAL should be left unchanged. If it is not a normal
148 ELF section *RETVAL should be set to the SHN_xxxx index. */
149 boolean (*elf_backend_section_from_bfd_section)
150 PARAMS ((bfd *, Elf32_Internal_Shdr *, asection *, int *retval));
151
643e9fc7
ILT
152 /* A function to do any final processing needed for the ELF file
153 before writing it out. */
154 void (*elf_backend_final_write_processing) PARAMS ((bfd *));
155
95469b02
ILT
156 /* The swapping table to use when dealing with ECOFF information.
157 Used for the MIPS ELF .mdebug section. */
158 const struct ecoff_debug_swap *elf_backend_ecoff_debug_swap;
81187b54
KR
159};
160
d24928c0
KR
161struct elf_sym_extra
162{
163 int elf_sym_num; /* sym# after locals/globals are reordered */
164};
165
166typedef struct elf_sym_extra Elf_Sym_Extra;
167
32090b8e
KR
168struct bfd_elf_section_data {
169 Elf_Internal_Shdr this_hdr;
170 Elf_Internal_Shdr rel_hdr;
171 int this_idx, rel_idx;
32090b8e
KR
172};
173#define elf_section_data(sec) ((struct bfd_elf_section_data*)sec->used_by_bfd)
174#define shdr_name(abfd,shdr) (elf_shstrtab (abfd)->tab + (shdr)->sh_name)
175
176#define get_elf_backend_data(abfd) \
177 ((struct elf_backend_data *) (abfd)->xvec->backend_data)
178
179struct strtab
180{
181 char *tab;
182 int nentries;
183 int length;
184};
185
186/* Some private data is stashed away for future use using the tdata pointer
187 in the bfd structure. */
188
189struct elf_obj_tdata
190{
191 Elf_Internal_Ehdr elf_header[1]; /* Actual data, but ref like ptr */
192 Elf_Internal_Shdr **elf_sect_ptr;
d79ab07c 193 Elf_Internal_Phdr *phdr;
32090b8e
KR
194 struct strtab *strtab_ptr;
195 int num_locals;
196 int num_globals;
32090b8e 197 Elf_Internal_Sym *internal_syms;
ee8cb548 198 elf_symbol_type *symbols; /* elf_symbol_type */
d24928c0
KR
199 Elf_Sym_Extra *sym_extra;
200 asymbol **section_syms; /* STT_SECTION symbols for each section */
201 int num_section_syms; /* number of section_syms allocated */
32090b8e
KR
202 Elf_Internal_Shdr symtab_hdr;
203 Elf_Internal_Shdr shstrtab_hdr;
204 Elf_Internal_Shdr strtab_hdr;
205 int symtab_section, shstrtab_section, strtab_section;
206 file_ptr next_file_pos;
207 void *prstatus; /* The raw /proc prstatus structure */
208 void *prpsinfo; /* The raw /proc prpsinfo structure */
d5a30a08
ILT
209 bfd_vma gp; /* The gp value (MIPS only, for now) */
210 int gp_size; /* The gp size (MIPS only, for now) */
32090b8e
KR
211};
212
213#define elf_tdata(bfd) ((bfd) -> tdata.elf_obj_data)
214#define elf_elfheader(bfd) (elf_tdata(bfd) -> elf_header)
215#define elf_elfsections(bfd) (elf_tdata(bfd) -> elf_sect_ptr)
216#define elf_shstrtab(bfd) (elf_tdata(bfd) -> strtab_ptr)
217#define elf_onesymtab(bfd) (elf_tdata(bfd) -> symtab_section)
218#define elf_num_locals(bfd) (elf_tdata(bfd) -> num_locals)
219#define elf_num_globals(bfd) (elf_tdata(bfd) -> num_globals)
d24928c0
KR
220#define elf_sym_extra(bfd) (elf_tdata(bfd) -> sym_extra)
221#define elf_section_syms(bfd) (elf_tdata(bfd) -> section_syms)
222#define elf_num_section_syms(bfd) (elf_tdata(bfd) -> num_section_syms)
32090b8e
KR
223#define core_prpsinfo(bfd) (elf_tdata(bfd) -> prpsinfo)
224#define core_prstatus(bfd) (elf_tdata(bfd) -> prstatus)
ee8cb548 225#define obj_symbols(bfd) (elf_tdata(bfd) -> symbols)
32090b8e 226#define obj_internal_syms(bfd) (elf_tdata(bfd) -> internal_syms)
d5a30a08
ILT
227#define elf_gp(bfd) (elf_tdata(bfd) -> gp)
228#define elf_gp_size(bfd) (elf_tdata(bfd) -> gp_size)
32090b8e
KR
229
230extern char * elf_string_from_elf_section PARAMS ((bfd *, unsigned, unsigned));
231extern char * elf_get_str_section PARAMS ((bfd *, unsigned));
232
233#define bfd_elf32_mkobject bfd_elf_mkobject
234#define bfd_elf64_mkobject bfd_elf_mkobject
235#define elf_mkobject bfd_elf_mkobject
236
153cb9ad 237extern unsigned long bfd_elf_hash PARAMS ((CONST unsigned char *));
7e37f9ff 238
32090b8e
KR
239extern bfd_reloc_status_type bfd_elf_generic_reloc PARAMS ((bfd *,
240 arelent *,
241 asymbol *,
242 PTR,
243 asection *,
4c3721d5
ILT
244 bfd *,
245 char **));
998ce1e0 246extern boolean bfd_elf_mkobject PARAMS ((bfd *));
e2a422b8
KR
247extern Elf_Internal_Shdr *bfd_elf_find_section PARAMS ((bfd *, char *));
248
9942e684 249extern boolean bfd_elf32_write_object_contents PARAMS ((bfd *));
32090b8e
KR
250extern boolean bfd_elf64_write_object_contents PARAMS ((bfd *));
251
252extern bfd_target *bfd_elf32_object_p PARAMS ((bfd *));
253extern bfd_target *bfd_elf32_core_file_p PARAMS ((bfd *));
9942e684
KR
254extern char *bfd_elf32_core_file_failing_command PARAMS ((bfd *));
255extern int bfd_elf32_core_file_failing_signal PARAMS ((bfd *));
256extern boolean bfd_elf32_core_file_matches_executable_p PARAMS ((bfd *,
257 bfd *));
258extern boolean bfd_elf32_set_section_contents PARAMS ((bfd *, sec_ptr, PTR,
259 file_ptr,
260 bfd_size_type));
7050286d 261
9942e684
KR
262extern unsigned int bfd_elf32_get_symtab_upper_bound PARAMS ((bfd *));
263extern unsigned int bfd_elf32_get_symtab PARAMS ((bfd *, asymbol **));
264extern unsigned int bfd_elf32_get_reloc_upper_bound PARAMS ((bfd *, sec_ptr));
265extern unsigned int bfd_elf32_canonicalize_reloc PARAMS ((bfd *, sec_ptr,
266 arelent **,
267 asymbol **));
268extern asymbol *bfd_elf32_make_empty_symbol PARAMS ((bfd *));
269extern void bfd_elf32_print_symbol PARAMS ((bfd *, PTR, asymbol *,
270 bfd_print_symbol_type));
271extern void bfd_elf32_get_symbol_info PARAMS ((bfd *, asymbol *,
7050286d 272 symbol_info *));
9942e684
KR
273extern alent *bfd_elf32_get_lineno PARAMS ((bfd *, asymbol *));
274extern boolean bfd_elf32_set_arch_mach PARAMS ((bfd *, enum bfd_architecture,
275 unsigned long));
276extern boolean bfd_elf32_find_nearest_line PARAMS ((bfd *, asection *,
277 asymbol **,
278 bfd_vma, CONST char **,
279 CONST char **,
280 unsigned int *));
281extern int bfd_elf32_sizeof_headers PARAMS ((bfd *, boolean));
32090b8e 282extern void bfd_elf32__write_relocs PARAMS ((bfd *, asection *, PTR));
e6858d1b 283extern boolean bfd_elf32_new_section_hook PARAMS ((bfd *, asection *));
81187b54
KR
284
285/* If the target doesn't have reloc handling written yet: */
9942e684
KR
286extern void bfd_elf32_no_info_to_howto PARAMS ((bfd *, arelent *,
287 Elf32_Internal_Rela *));
db232882 288
7d9bb6da
KR
289extern bfd_target *bfd_elf64_object_p PARAMS ((bfd *));
290extern bfd_target *bfd_elf64_core_file_p PARAMS ((bfd *));
7d9bb6da
KR
291extern char *bfd_elf64_core_file_failing_command PARAMS ((bfd *));
292extern int bfd_elf64_core_file_failing_signal PARAMS ((bfd *));
293extern boolean bfd_elf64_core_file_matches_executable_p PARAMS ((bfd *,
294 bfd *));
295extern boolean bfd_elf64_set_section_contents PARAMS ((bfd *, sec_ptr, PTR,
296 file_ptr,
297 bfd_size_type));
298
299extern unsigned int bfd_elf64_get_symtab_upper_bound PARAMS ((bfd *));
300extern unsigned int bfd_elf64_get_symtab PARAMS ((bfd *, asymbol **));
301extern unsigned int bfd_elf64_get_reloc_upper_bound PARAMS ((bfd *, sec_ptr));
302extern unsigned int bfd_elf64_canonicalize_reloc PARAMS ((bfd *, sec_ptr,
303 arelent **,
304 asymbol **));
305extern asymbol *bfd_elf64_make_empty_symbol PARAMS ((bfd *));
306extern void bfd_elf64_print_symbol PARAMS ((bfd *, PTR, asymbol *,
307 bfd_print_symbol_type));
308extern void bfd_elf64_get_symbol_info PARAMS ((bfd *, asymbol *,
309 symbol_info *));
310extern alent *bfd_elf64_get_lineno PARAMS ((bfd *, asymbol *));
311extern boolean bfd_elf64_set_arch_mach PARAMS ((bfd *, enum bfd_architecture,
312 unsigned long));
313extern boolean bfd_elf64_find_nearest_line PARAMS ((bfd *, asection *,
314 asymbol **,
315 bfd_vma, CONST char **,
316 CONST char **,
317 unsigned int *));
318extern int bfd_elf64_sizeof_headers PARAMS ((bfd *, boolean));
32090b8e 319extern void bfd_elf64__write_relocs PARAMS ((bfd *, asection *, PTR));
7d9bb6da
KR
320extern boolean bfd_elf64_new_section_hook PARAMS ((bfd *, asection *));
321
322/* If the target doesn't have reloc handling written yet: */
323extern void bfd_elf64_no_info_to_howto PARAMS ((bfd *, arelent *,
324 Elf64_Internal_Rela *));
325
db232882 326#endif /* _LIBELF_H_ */
This page took 0.095953 seconds and 4 git commands to generate.