New file to hold ECOFF linking routines used by both ECOFF and MIPS ELF.
[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;
60 PTR any;
61 }
62 tc_data;
ee8cb548 63} elf_symbol_type;
7050286d 64
95469b02
ILT
65/* Constant information held for an ELF backend. */
66
268f94ac 67struct elf_backend_data
7050286d 68{
95469b02
ILT
69 /* Whether the backend uses REL or RELA relocations. FIXME: some
70 ELF backends use both. When we need to support one, this whole
71 approach will need to be changed. */
7050286d 72 int use_rela_p;
95469b02
ILT
73
74 /* Whether this backend is 64 bits or not. FIXME: Who cares? */
7050286d 75 int elf_64_p;
95469b02
ILT
76
77 /* The architecture for this backend. */
81187b54 78 enum bfd_architecture arch;
95469b02 79
a5ccdad1
ILT
80 /* The ELF machine code (EM_xxxx) for this backend. */
81 int elf_machine_code;
82
95469b02
ILT
83 /* The maximum page size for this backend. */
84 bfd_vma maxpagesize;
85
86 /* A function to translate an ELF RELA relocation to a BFD arelent
87 structure. */
7050286d 88 void (*elf_info_to_howto) PARAMS ((bfd *, arelent *,
268f94ac 89 Elf_Internal_Rela *));
95469b02
ILT
90
91 /* A function to translate an ELF REL relocation to a BFD arelent
92 structure. */
7050286d 93 void (*elf_info_to_howto_rel) PARAMS ((bfd *, arelent *,
268f94ac 94 Elf_Internal_Rel *));
db232882 95
643e9fc7
ILT
96 /* A function to determine whether a symbol is global when
97 partitioning the symbol table into local and global symbols.
98 This should be NULL for most targets, in which case the correct
99 thing will be done. MIPS ELF, at least on the Irix 5, has
100 special requirements. */
101 boolean (*elf_backend_sym_is_global) PARAMS ((bfd *, asymbol *));
102
95469b02
ILT
103 /* The remaining functions are hooks which are called only if they
104 are not NULL. */
105
a5ccdad1
ILT
106 /* A function to permit a backend specific check on whether a
107 particular BFD format is relevant for an object file, and to
108 permit the backend to set any global information it wishes. When
109 this is called elf_elfheader is set, but anything else should be
110 used with caution. If this returns false, the check_format
111 routine will return a wrong_format error. */
112 boolean (*elf_backend_object_p) PARAMS ((bfd *));
113
95469b02
ILT
114 /* A function to do additional symbol processing when reading the
115 ELF symbol table. This is where any processor-specific special
116 section indices are handled. */
e2a422b8 117 void (*elf_backend_symbol_processing) PARAMS ((bfd *, asymbol *));
95469b02
ILT
118
119 /* A function to do additional symbol processing after reading the
120 entire ELF symbol table. */
121 boolean (*elf_backend_symbol_table_processing) PARAMS ((bfd *,
122 elf_symbol_type *,
123 int));
124
125 /* A function to do additional processing on the ELF section header
126 just before writing it out. This is used to set the flags and
127 type fields for some sections, or to actually write out data for
128 unusual sections. */
129 boolean (*elf_backend_section_processing) PARAMS ((bfd *,
130 Elf32_Internal_Shdr *));
131
132 /* A function to handle unusual section types when creating BFD
133 sections from ELF sections. */
134 boolean (*elf_backend_section_from_shdr) PARAMS ((bfd *,
135 Elf32_Internal_Shdr *,
136 char *));
137
138 /* A function to set up the ELF section header for a BFD section in
139 preparation for writing it out. This is where the flags and type
140 fields are set for unusual sections. */
141 boolean (*elf_backend_fake_sections) PARAMS ((bfd *, Elf32_Internal_Shdr *,
142 asection *));
143
144 /* A function to get the ELF section index for a BFD section. If
145 this returns true, the section was found. If it is a normal ELF
146 section, *RETVAL should be left unchanged. If it is not a normal
147 ELF section *RETVAL should be set to the SHN_xxxx index. */
148 boolean (*elf_backend_section_from_bfd_section)
149 PARAMS ((bfd *, Elf32_Internal_Shdr *, asection *, int *retval));
150
643e9fc7
ILT
151 /* A function to do any final processing needed for the ELF file
152 before writing it out. */
153 void (*elf_backend_final_write_processing) PARAMS ((bfd *));
154
95469b02
ILT
155 /* The swapping table to use when dealing with ECOFF information.
156 Used for the MIPS ELF .mdebug section. */
157 const struct ecoff_debug_swap *elf_backend_ecoff_debug_swap;
81187b54
KR
158};
159
d24928c0
KR
160struct elf_sym_extra
161{
162 int elf_sym_num; /* sym# after locals/globals are reordered */
163};
164
165typedef struct elf_sym_extra Elf_Sym_Extra;
166
32090b8e
KR
167struct bfd_elf_section_data {
168 Elf_Internal_Shdr this_hdr;
169 Elf_Internal_Shdr rel_hdr;
170 int this_idx, rel_idx;
32090b8e
KR
171};
172#define elf_section_data(sec) ((struct bfd_elf_section_data*)sec->used_by_bfd)
173#define shdr_name(abfd,shdr) (elf_shstrtab (abfd)->tab + (shdr)->sh_name)
174
175#define get_elf_backend_data(abfd) \
176 ((struct elf_backend_data *) (abfd)->xvec->backend_data)
177
178struct strtab
179{
180 char *tab;
181 int nentries;
182 int length;
183};
184
185/* Some private data is stashed away for future use using the tdata pointer
186 in the bfd structure. */
187
188struct elf_obj_tdata
189{
190 Elf_Internal_Ehdr elf_header[1]; /* Actual data, but ref like ptr */
191 Elf_Internal_Shdr **elf_sect_ptr;
d79ab07c 192 Elf_Internal_Phdr *phdr;
32090b8e
KR
193 struct strtab *strtab_ptr;
194 int num_locals;
195 int num_globals;
32090b8e 196 Elf_Internal_Sym *internal_syms;
ee8cb548 197 elf_symbol_type *symbols; /* elf_symbol_type */
d24928c0
KR
198 Elf_Sym_Extra *sym_extra;
199 asymbol **section_syms; /* STT_SECTION symbols for each section */
200 int num_section_syms; /* number of section_syms allocated */
32090b8e
KR
201 Elf_Internal_Shdr symtab_hdr;
202 Elf_Internal_Shdr shstrtab_hdr;
203 Elf_Internal_Shdr strtab_hdr;
204 int symtab_section, shstrtab_section, strtab_section;
205 file_ptr next_file_pos;
206 void *prstatus; /* The raw /proc prstatus structure */
207 void *prpsinfo; /* The raw /proc prpsinfo structure */
d5a30a08
ILT
208 bfd_vma gp; /* The gp value (MIPS only, for now) */
209 int gp_size; /* The gp size (MIPS only, for now) */
32090b8e
KR
210};
211
212#define elf_tdata(bfd) ((bfd) -> tdata.elf_obj_data)
213#define elf_elfheader(bfd) (elf_tdata(bfd) -> elf_header)
214#define elf_elfsections(bfd) (elf_tdata(bfd) -> elf_sect_ptr)
215#define elf_shstrtab(bfd) (elf_tdata(bfd) -> strtab_ptr)
216#define elf_onesymtab(bfd) (elf_tdata(bfd) -> symtab_section)
217#define elf_num_locals(bfd) (elf_tdata(bfd) -> num_locals)
218#define elf_num_globals(bfd) (elf_tdata(bfd) -> num_globals)
d24928c0
KR
219#define elf_sym_extra(bfd) (elf_tdata(bfd) -> sym_extra)
220#define elf_section_syms(bfd) (elf_tdata(bfd) -> section_syms)
221#define elf_num_section_syms(bfd) (elf_tdata(bfd) -> num_section_syms)
32090b8e
KR
222#define core_prpsinfo(bfd) (elf_tdata(bfd) -> prpsinfo)
223#define core_prstatus(bfd) (elf_tdata(bfd) -> prstatus)
ee8cb548 224#define obj_symbols(bfd) (elf_tdata(bfd) -> symbols)
32090b8e 225#define obj_internal_syms(bfd) (elf_tdata(bfd) -> internal_syms)
d5a30a08
ILT
226#define elf_gp(bfd) (elf_tdata(bfd) -> gp)
227#define elf_gp_size(bfd) (elf_tdata(bfd) -> gp_size)
32090b8e
KR
228
229extern char * elf_string_from_elf_section PARAMS ((bfd *, unsigned, unsigned));
230extern char * elf_get_str_section PARAMS ((bfd *, unsigned));
231
232#define bfd_elf32_mkobject bfd_elf_mkobject
233#define bfd_elf64_mkobject bfd_elf_mkobject
234#define elf_mkobject bfd_elf_mkobject
235
153cb9ad 236extern unsigned long bfd_elf_hash PARAMS ((CONST unsigned char *));
7e37f9ff 237
32090b8e
KR
238extern bfd_reloc_status_type bfd_elf_generic_reloc PARAMS ((bfd *,
239 arelent *,
240 asymbol *,
241 PTR,
242 asection *,
243 bfd *));
998ce1e0 244extern boolean bfd_elf_mkobject PARAMS ((bfd *));
e2a422b8
KR
245extern Elf_Internal_Shdr *bfd_elf_find_section PARAMS ((bfd *, char *));
246
9942e684 247extern boolean bfd_elf32_write_object_contents PARAMS ((bfd *));
32090b8e
KR
248extern boolean bfd_elf64_write_object_contents PARAMS ((bfd *));
249
250extern bfd_target *bfd_elf32_object_p PARAMS ((bfd *));
251extern bfd_target *bfd_elf32_core_file_p PARAMS ((bfd *));
9942e684
KR
252extern char *bfd_elf32_core_file_failing_command PARAMS ((bfd *));
253extern int bfd_elf32_core_file_failing_signal PARAMS ((bfd *));
254extern boolean bfd_elf32_core_file_matches_executable_p PARAMS ((bfd *,
255 bfd *));
256extern boolean bfd_elf32_set_section_contents PARAMS ((bfd *, sec_ptr, PTR,
257 file_ptr,
258 bfd_size_type));
7050286d 259
9942e684
KR
260extern unsigned int bfd_elf32_get_symtab_upper_bound PARAMS ((bfd *));
261extern unsigned int bfd_elf32_get_symtab PARAMS ((bfd *, asymbol **));
262extern unsigned int bfd_elf32_get_reloc_upper_bound PARAMS ((bfd *, sec_ptr));
263extern unsigned int bfd_elf32_canonicalize_reloc PARAMS ((bfd *, sec_ptr,
264 arelent **,
265 asymbol **));
266extern asymbol *bfd_elf32_make_empty_symbol PARAMS ((bfd *));
267extern void bfd_elf32_print_symbol PARAMS ((bfd *, PTR, asymbol *,
268 bfd_print_symbol_type));
269extern void bfd_elf32_get_symbol_info PARAMS ((bfd *, asymbol *,
7050286d 270 symbol_info *));
9942e684
KR
271extern alent *bfd_elf32_get_lineno PARAMS ((bfd *, asymbol *));
272extern boolean bfd_elf32_set_arch_mach PARAMS ((bfd *, enum bfd_architecture,
273 unsigned long));
274extern boolean bfd_elf32_find_nearest_line PARAMS ((bfd *, asection *,
275 asymbol **,
276 bfd_vma, CONST char **,
277 CONST char **,
278 unsigned int *));
279extern int bfd_elf32_sizeof_headers PARAMS ((bfd *, boolean));
32090b8e 280extern void bfd_elf32__write_relocs PARAMS ((bfd *, asection *, PTR));
e6858d1b 281extern boolean bfd_elf32_new_section_hook PARAMS ((bfd *, asection *));
81187b54
KR
282
283/* If the target doesn't have reloc handling written yet: */
9942e684
KR
284extern void bfd_elf32_no_info_to_howto PARAMS ((bfd *, arelent *,
285 Elf32_Internal_Rela *));
db232882 286
7d9bb6da
KR
287extern bfd_target *bfd_elf64_object_p PARAMS ((bfd *));
288extern bfd_target *bfd_elf64_core_file_p PARAMS ((bfd *));
7d9bb6da
KR
289extern char *bfd_elf64_core_file_failing_command PARAMS ((bfd *));
290extern int bfd_elf64_core_file_failing_signal PARAMS ((bfd *));
291extern boolean bfd_elf64_core_file_matches_executable_p PARAMS ((bfd *,
292 bfd *));
293extern boolean bfd_elf64_set_section_contents PARAMS ((bfd *, sec_ptr, PTR,
294 file_ptr,
295 bfd_size_type));
296
297extern unsigned int bfd_elf64_get_symtab_upper_bound PARAMS ((bfd *));
298extern unsigned int bfd_elf64_get_symtab PARAMS ((bfd *, asymbol **));
299extern unsigned int bfd_elf64_get_reloc_upper_bound PARAMS ((bfd *, sec_ptr));
300extern unsigned int bfd_elf64_canonicalize_reloc PARAMS ((bfd *, sec_ptr,
301 arelent **,
302 asymbol **));
303extern asymbol *bfd_elf64_make_empty_symbol PARAMS ((bfd *));
304extern void bfd_elf64_print_symbol PARAMS ((bfd *, PTR, asymbol *,
305 bfd_print_symbol_type));
306extern void bfd_elf64_get_symbol_info PARAMS ((bfd *, asymbol *,
307 symbol_info *));
308extern alent *bfd_elf64_get_lineno PARAMS ((bfd *, asymbol *));
309extern boolean bfd_elf64_set_arch_mach PARAMS ((bfd *, enum bfd_architecture,
310 unsigned long));
311extern boolean bfd_elf64_find_nearest_line PARAMS ((bfd *, asection *,
312 asymbol **,
313 bfd_vma, CONST char **,
314 CONST char **,
315 unsigned int *));
316extern int bfd_elf64_sizeof_headers PARAMS ((bfd *, boolean));
32090b8e 317extern void bfd_elf64__write_relocs PARAMS ((bfd *, asection *, PTR));
7d9bb6da
KR
318extern boolean bfd_elf64_new_section_hook PARAMS ((bfd *, asection *));
319
320/* If the target doesn't have reloc handling written yet: */
321extern void bfd_elf64_no_info_to_howto PARAMS ((bfd *, arelent *,
322 Elf64_Internal_Rela *));
323
db232882 324#endif /* _LIBELF_H_ */
This page took 0.067289 seconds and 4 git commands to generate.