Add startswith function and use it instead of CONST_STRNEQ.
[deliverable/binutils-gdb.git] / bfd / bfd-in.h
1 /* Main header file for the bfd library -- portable access to object files.
2
3 Copyright (C) 1990-2021 Free Software Foundation, Inc.
4
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 3 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., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA. */
22
23 #ifndef __BFD_H_SEEN__
24 #define __BFD_H_SEEN__
25
26 /* PR 14072: Ensure that config.h is included first. */
27 #if !defined PACKAGE && !defined PACKAGE_VERSION
28 #error config.h must be included before this header
29 #endif
30
31 #ifdef __cplusplus
32 extern "C" {
33 #endif
34
35 #include "ansidecl.h"
36 #include "symcat.h"
37 #include "bfd_stdint.h"
38 #include "diagnostics.h"
39 #include <stdarg.h>
40 #include <sys/stat.h>
41
42 #if defined (__STDC__) || defined (ALMOST_STDC) || defined (HAVE_STRINGIZE)
43 #ifndef SABER
44 /* This hack is to avoid a problem with some strict ANSI C preprocessors.
45 The problem is, "32_" is not a valid preprocessing token, and we don't
46 want extra underscores (e.g., "nlm_32_"). The XCONCAT2 macro will
47 cause the inner CONCAT2 macros to be evaluated first, producing
48 still-valid pp-tokens. Then the final concatenation can be done. */
49 #undef CONCAT4
50 #define CONCAT4(a,b,c,d) XCONCAT2(CONCAT2(a,b),CONCAT2(c,d))
51 #endif
52 #endif
53
54 /* This is a utility macro to handle the situation where the code
55 wants to place a constant string into the code, followed by a
56 comma and then the length of the string. Doing this by hand
57 is error prone, so using this macro is safer. */
58 #define STRING_COMMA_LEN(STR) (STR), (sizeof (STR) - 1)
59
60 /* strcpy() can have a similar problem, but since we know we are
61 copying a constant string, we can use memcpy which will be faster
62 since there is no need to check for a NUL byte inside STR. We
63 can also save time if we do not need to copy the terminating NUL. */
64 #define LITMEMCPY(DEST,STR2) memcpy ((DEST), (STR2), sizeof (STR2) - 1)
65 #define LITSTRCPY(DEST,STR2) memcpy ((DEST), (STR2), sizeof (STR2))
66
67 #define BFD_SUPPORTS_PLUGINS @supports_plugins@
68
69 /* The word size used by BFD on the host. This may be 64 with a 32
70 bit target if the host is 64 bit, or if other 64 bit targets have
71 been selected with --enable-targets, or if --enable-64-bit-bfd. */
72 #define BFD_ARCH_SIZE @wordsize@
73
74 /* The word size of the default bfd target. */
75 #define BFD_DEFAULT_TARGET_SIZE @bfd_default_target_size@
76
77 #define BFD_HOST_64BIT_LONG @BFD_HOST_64BIT_LONG@
78 #define BFD_HOST_64BIT_LONG_LONG @BFD_HOST_64BIT_LONG_LONG@
79 #if @BFD_HOST_64_BIT_DEFINED@
80 #define BFD_HOST_64_BIT @BFD_HOST_64_BIT@
81 #define BFD_HOST_U_64_BIT @BFD_HOST_U_64_BIT@
82 typedef BFD_HOST_64_BIT bfd_int64_t;
83 typedef BFD_HOST_U_64_BIT bfd_uint64_t;
84 #endif
85
86 #ifdef HAVE_INTTYPES_H
87 # include <inttypes.h>
88 #else
89 # if BFD_HOST_64BIT_LONG
90 # define BFD_PRI64 "l"
91 # elif defined (__MSVCRT__)
92 # define BFD_PRI64 "I64"
93 # else
94 # define BFD_PRI64 "ll"
95 # endif
96 # undef PRId64
97 # define PRId64 BFD_PRI64 "d"
98 # undef PRIu64
99 # define PRIu64 BFD_PRI64 "u"
100 # undef PRIx64
101 # define PRIx64 BFD_PRI64 "x"
102 #endif
103
104 #if BFD_ARCH_SIZE >= 64
105 #define BFD64
106 #endif
107
108 #ifndef INLINE
109 #if __GNUC__ >= 2
110 #define INLINE __inline__
111 #else
112 #define INLINE
113 #endif
114 #endif
115
116 /* Declaring a type wide enough to hold a host long and a host pointer. */
117 #define BFD_HOSTPTR_T @BFD_HOSTPTR_T@
118 typedef BFD_HOSTPTR_T bfd_hostptr_t;
119
120 /* Forward declaration. */
121 typedef struct bfd bfd;
122
123 /* Boolean type used in bfd. Too many systems define their own
124 versions of "boolean" for us to safely typedef a "boolean" of
125 our own. Using an enum for "bfd_boolean" has its own set of
126 problems, with strange looking casts required to avoid warnings
127 on some older compilers. Thus we just use an int.
128
129 General rule: Functions which are bfd_boolean return TRUE on
130 success and FALSE on failure (unless they're a predicate). */
131
132 typedef int bfd_boolean;
133 #undef FALSE
134 #undef TRUE
135 #define FALSE 0
136 #define TRUE 1
137
138 #ifdef BFD64
139
140 #ifndef BFD_HOST_64_BIT
141 #error No 64 bit integer type available
142 #endif /* ! defined (BFD_HOST_64_BIT) */
143
144 typedef BFD_HOST_U_64_BIT bfd_vma;
145 typedef BFD_HOST_64_BIT bfd_signed_vma;
146 typedef BFD_HOST_U_64_BIT bfd_size_type;
147 typedef BFD_HOST_U_64_BIT symvalue;
148
149 #if BFD_HOST_64BIT_LONG
150 #define BFD_VMA_FMT "l"
151 #elif defined (__MSVCRT__)
152 #define BFD_VMA_FMT "I64"
153 #else
154 #define BFD_VMA_FMT "ll"
155 #endif
156
157 #ifndef fprintf_vma
158 #define sprintf_vma(s,x) sprintf (s, "%016" BFD_VMA_FMT "x", x)
159 #define fprintf_vma(f,x) fprintf (f, "%016" BFD_VMA_FMT "x", x)
160 #endif
161
162 #else /* not BFD64 */
163
164 /* Represent a target address. Also used as a generic unsigned type
165 which is guaranteed to be big enough to hold any arithmetic types
166 we need to deal with. */
167 typedef unsigned long bfd_vma;
168
169 /* A generic signed type which is guaranteed to be big enough to hold any
170 arithmetic types we need to deal with. Can be assumed to be compatible
171 with bfd_vma in the same way that signed and unsigned ints are compatible
172 (as parameters, in assignment, etc). */
173 typedef long bfd_signed_vma;
174
175 typedef unsigned long symvalue;
176 typedef unsigned long bfd_size_type;
177
178 /* Print a bfd_vma x on stream s. */
179 #define BFD_VMA_FMT "l"
180 #define fprintf_vma(s,x) fprintf (s, "%08" BFD_VMA_FMT "x", x)
181 #define sprintf_vma(s,x) sprintf (s, "%08" BFD_VMA_FMT "x", x)
182
183 #endif /* not BFD64 */
184
185 #define HALF_BFD_SIZE_TYPE \
186 (((bfd_size_type) 1) << (8 * sizeof (bfd_size_type) / 2))
187
188 #ifndef BFD_HOST_64_BIT
189 /* Fall back on a 32 bit type. The idea is to make these types always
190 available for function return types, but in the case that
191 BFD_HOST_64_BIT is undefined such a function should abort or
192 otherwise signal an error. */
193 typedef bfd_signed_vma bfd_int64_t;
194 typedef bfd_vma bfd_uint64_t;
195 #endif
196
197 /* An offset into a file. BFD always uses the largest possible offset
198 based on the build time availability of fseek, fseeko, or fseeko64. */
199 typedef @bfd_file_ptr@ file_ptr;
200 typedef unsigned @bfd_file_ptr@ ufile_ptr;
201
202 extern void bfd_sprintf_vma (bfd *, char *, bfd_vma);
203 extern void bfd_fprintf_vma (bfd *, void *, bfd_vma);
204
205 #define printf_vma(x) fprintf_vma(stdout,x)
206 #define bfd_printf_vma(abfd,x) bfd_fprintf_vma (abfd,stdout,x)
207
208 typedef unsigned int flagword; /* 32 bits of flags */
209 typedef unsigned char bfd_byte;
210 \f
211 /* File formats. */
212
213 typedef enum bfd_format
214 {
215 bfd_unknown = 0, /* File format is unknown. */
216 bfd_object, /* Linker/assembler/compiler output. */
217 bfd_archive, /* Object archive file. */
218 bfd_core, /* Core dump. */
219 bfd_type_end /* Marks the end; don't use it! */
220 }
221 bfd_format;
222 \f
223 /* Symbols and relocation. */
224
225 /* A count of carsyms (canonical archive symbols). */
226 typedef unsigned long symindex;
227
228 #define BFD_NO_MORE_SYMBOLS ((symindex) ~0)
229
230 /* A canonical archive symbol. */
231 /* This is a type pun with struct ranlib on purpose! */
232 typedef struct carsym
233 {
234 const char *name;
235 file_ptr file_offset; /* Look here to find the file. */
236 }
237 carsym; /* To make these you call a carsymogen. */
238
239 /* Used in generating armaps (archive tables of contents).
240 Perhaps just a forward definition would do? */
241 struct orl /* Output ranlib. */
242 {
243 char **name; /* Symbol name. */
244 union
245 {
246 file_ptr pos;
247 bfd *abfd;
248 } u; /* bfd* or file position. */
249 int namidx; /* Index into string table. */
250 };
251
252 /* Linenumber stuff. */
253 typedef struct lineno_cache_entry
254 {
255 unsigned int line_number; /* Linenumber from start of function. */
256 union
257 {
258 struct bfd_symbol *sym; /* Function name. */
259 bfd_vma offset; /* Offset into section. */
260 } u;
261 }
262 alent;
263 \f
264 /* Object and core file sections. */
265 typedef struct bfd_section *sec_ptr;
266
267 #define align_power(addr, align) \
268 (((addr) + ((bfd_vma) 1 << (align)) - 1) & (-((bfd_vma) 1 << (align))))
269
270 /* Align an address upward to a boundary, expressed as a number of bytes.
271 E.g. align to an 8-byte boundary with argument of 8. Take care never
272 to wrap around if the address is within boundary-1 of the end of the
273 address space. */
274 #define BFD_ALIGN(this, boundary) \
275 ((((bfd_vma) (this) + (boundary) - 1) >= (bfd_vma) (this)) \
276 ? (((bfd_vma) (this) + ((boundary) - 1)) & ~ (bfd_vma) ((boundary)-1)) \
277 : ~ (bfd_vma) 0)
278 \f
279 typedef enum bfd_print_symbol
280 {
281 bfd_print_symbol_name,
282 bfd_print_symbol_more,
283 bfd_print_symbol_all
284 } bfd_print_symbol_type;
285
286 /* Information about a symbol that nm needs. */
287
288 typedef struct _symbol_info
289 {
290 symvalue value;
291 char type;
292 const char *name; /* Symbol name. */
293 unsigned char stab_type; /* Stab type. */
294 char stab_other; /* Stab other. */
295 short stab_desc; /* Stab desc. */
296 const char *stab_name; /* String for stab type. */
297 } symbol_info;
298
299 /* Get the name of a stabs type code. */
300
301 extern const char *bfd_get_stab_name (int);
302 \f
303 /* Hash table routines. There is no way to free up a hash table. */
304
305 /* An element in the hash table. Most uses will actually use a larger
306 structure, and an instance of this will be the first field. */
307
308 struct bfd_hash_entry
309 {
310 /* Next entry for this hash code. */
311 struct bfd_hash_entry *next;
312 /* String being hashed. */
313 const char *string;
314 /* Hash code. This is the full hash code, not the index into the
315 table. */
316 unsigned long hash;
317 };
318
319 /* A hash table. */
320
321 struct bfd_hash_table
322 {
323 /* The hash array. */
324 struct bfd_hash_entry **table;
325 /* A function used to create new elements in the hash table. The
326 first entry is itself a pointer to an element. When this
327 function is first invoked, this pointer will be NULL. However,
328 having the pointer permits a hierarchy of method functions to be
329 built each of which calls the function in the superclass. Thus
330 each function should be written to allocate a new block of memory
331 only if the argument is NULL. */
332 struct bfd_hash_entry *(*newfunc)
333 (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
334 /* An objalloc for this hash table. This is a struct objalloc *,
335 but we use void * to avoid requiring the inclusion of objalloc.h. */
336 void *memory;
337 /* The number of slots in the hash table. */
338 unsigned int size;
339 /* The number of entries in the hash table. */
340 unsigned int count;
341 /* The size of elements. */
342 unsigned int entsize;
343 /* If non-zero, don't grow the hash table. */
344 unsigned int frozen:1;
345 };
346
347 /* Initialize a hash table. */
348 extern bfd_boolean bfd_hash_table_init
349 (struct bfd_hash_table *,
350 struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
351 struct bfd_hash_table *,
352 const char *),
353 unsigned int);
354
355 /* Initialize a hash table specifying a size. */
356 extern bfd_boolean bfd_hash_table_init_n
357 (struct bfd_hash_table *,
358 struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
359 struct bfd_hash_table *,
360 const char *),
361 unsigned int, unsigned int);
362
363 /* Free up a hash table. */
364 extern void bfd_hash_table_free
365 (struct bfd_hash_table *);
366
367 /* Look up a string in a hash table. If CREATE is TRUE, a new entry
368 will be created for this string if one does not already exist. The
369 COPY argument must be TRUE if this routine should copy the string
370 into newly allocated memory when adding an entry. */
371 extern struct bfd_hash_entry *bfd_hash_lookup
372 (struct bfd_hash_table *, const char *, bfd_boolean create,
373 bfd_boolean copy);
374
375 /* Insert an entry in a hash table. */
376 extern struct bfd_hash_entry *bfd_hash_insert
377 (struct bfd_hash_table *, const char *, unsigned long);
378
379 /* Rename an entry in a hash table. */
380 extern void bfd_hash_rename
381 (struct bfd_hash_table *, const char *, struct bfd_hash_entry *);
382
383 /* Replace an entry in a hash table. */
384 extern void bfd_hash_replace
385 (struct bfd_hash_table *, struct bfd_hash_entry *old,
386 struct bfd_hash_entry *nw);
387
388 /* Base method for creating a hash table entry. */
389 extern struct bfd_hash_entry *bfd_hash_newfunc
390 (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
391
392 /* Grab some space for a hash table entry. */
393 extern void *bfd_hash_allocate
394 (struct bfd_hash_table *, unsigned int);
395
396 /* Traverse a hash table in a random order, calling a function on each
397 element. If the function returns FALSE, the traversal stops. The
398 INFO argument is passed to the function. */
399 extern void bfd_hash_traverse
400 (struct bfd_hash_table *,
401 bfd_boolean (*) (struct bfd_hash_entry *, void *),
402 void *info);
403
404 /* Allows the default size of a hash table to be configured. New hash
405 tables allocated using bfd_hash_table_init will be created with
406 this size. */
407 extern unsigned long bfd_hash_set_default_size (unsigned long);
408
409 /* Types of compressed DWARF debug sections. We currently support
410 zlib. */
411 enum compressed_debug_section_type
412 {
413 COMPRESS_DEBUG_NONE = 0,
414 COMPRESS_DEBUG = 1 << 0,
415 COMPRESS_DEBUG_GNU_ZLIB = COMPRESS_DEBUG | 1 << 1,
416 COMPRESS_DEBUG_GABI_ZLIB = COMPRESS_DEBUG | 1 << 2
417 };
418
419 /* This structure is used to keep track of stabs in sections
420 information while linking. */
421
422 struct stab_info
423 {
424 /* A hash table used to hold stabs strings. */
425 struct bfd_strtab_hash *strings;
426 /* The header file hash table. */
427 struct bfd_hash_table includes;
428 /* The first .stabstr section. */
429 struct bfd_section *stabstr;
430 };
431
432 #define COFF_SWAP_TABLE (void *) &bfd_coff_std_swap_table
433
434 /* User program access to BFD facilities. */
435
436 /* Direct I/O routines, for programs which know more about the object
437 file than BFD does. Use higher level routines if possible. */
438
439 extern bfd_size_type bfd_bread (void *, bfd_size_type, bfd *);
440 extern bfd_size_type bfd_bwrite (const void *, bfd_size_type, bfd *);
441 extern int bfd_seek (bfd *, file_ptr, int);
442 extern file_ptr bfd_tell (bfd *);
443 extern int bfd_flush (bfd *);
444 extern int bfd_stat (bfd *, struct stat *);
445
446 /* Deprecated old routines. */
447 #if __GNUC__
448 #define bfd_read(BUF, ELTSIZE, NITEMS, ABFD) \
449 (_bfd_warn_deprecated ("bfd_read", __FILE__, __LINE__, __FUNCTION__), \
450 bfd_bread ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
451 #define bfd_write(BUF, ELTSIZE, NITEMS, ABFD) \
452 (_bfd_warn_deprecated ("bfd_write", __FILE__, __LINE__, __FUNCTION__), \
453 bfd_bwrite ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
454 #else
455 #define bfd_read(BUF, ELTSIZE, NITEMS, ABFD) \
456 (_bfd_warn_deprecated ("bfd_read", (const char *) 0, 0, (const char *) 0), \
457 bfd_bread ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
458 #define bfd_write(BUF, ELTSIZE, NITEMS, ABFD) \
459 (_bfd_warn_deprecated ("bfd_write", (const char *) 0, 0, (const char *) 0),\
460 bfd_bwrite ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
461 #endif
462 extern void _bfd_warn_deprecated (const char *, const char *, int, const char *);
463
464 extern bfd_boolean bfd_cache_close
465 (bfd *abfd);
466 /* NB: This declaration should match the autogenerated one in libbfd.h. */
467
468 extern bfd_boolean bfd_cache_close_all (void);
469
470 extern bfd_boolean bfd_record_phdr
471 (bfd *, unsigned long, bfd_boolean, flagword, bfd_boolean, bfd_vma,
472 bfd_boolean, bfd_boolean, unsigned int, struct bfd_section **);
473
474 /* Byte swapping routines. */
475
476 bfd_uint64_t bfd_getb64 (const void *);
477 bfd_uint64_t bfd_getl64 (const void *);
478 bfd_int64_t bfd_getb_signed_64 (const void *);
479 bfd_int64_t bfd_getl_signed_64 (const void *);
480 bfd_vma bfd_getb32 (const void *);
481 bfd_vma bfd_getl32 (const void *);
482 bfd_signed_vma bfd_getb_signed_32 (const void *);
483 bfd_signed_vma bfd_getl_signed_32 (const void *);
484 bfd_vma bfd_getb16 (const void *);
485 bfd_vma bfd_getl16 (const void *);
486 bfd_signed_vma bfd_getb_signed_16 (const void *);
487 bfd_signed_vma bfd_getl_signed_16 (const void *);
488 void bfd_putb64 (bfd_uint64_t, void *);
489 void bfd_putl64 (bfd_uint64_t, void *);
490 void bfd_putb32 (bfd_vma, void *);
491 void bfd_putl32 (bfd_vma, void *);
492 void bfd_putb24 (bfd_vma, void *);
493 void bfd_putl24 (bfd_vma, void *);
494 void bfd_putb16 (bfd_vma, void *);
495 void bfd_putl16 (bfd_vma, void *);
496
497 /* Byte swapping routines which take size and endiannes as arguments. */
498
499 bfd_uint64_t bfd_get_bits (const void *, int, bfd_boolean);
500 void bfd_put_bits (bfd_uint64_t, void *, int, bfd_boolean);
501
502
503 /* mmap hacks */
504
505 struct _bfd_window_internal;
506 typedef struct _bfd_window_internal bfd_window_internal;
507
508 typedef struct _bfd_window
509 {
510 /* What the user asked for. */
511 void *data;
512 bfd_size_type size;
513 /* The actual window used by BFD. Small user-requested read-only
514 regions sharing a page may share a single window into the object
515 file. Read-write versions shouldn't until I've fixed things to
516 keep track of which portions have been claimed by the
517 application; don't want to give the same region back when the
518 application wants two writable copies! */
519 struct _bfd_window_internal *i;
520 }
521 bfd_window;
522
523 extern void bfd_init_window
524 (bfd_window *);
525 extern void bfd_free_window
526 (bfd_window *);
527 extern bfd_boolean bfd_get_file_window
528 (bfd *, file_ptr, bfd_size_type, bfd_window *, bfd_boolean);
529 \f
530 /* Externally visible ELF routines. */
531
532 /* Create a new BFD as if by bfd_openr. Rather than opening a file,
533 reconstruct an ELF file by reading the segments out of remote
534 memory based on the ELF file header at EHDR_VMA and the ELF program
535 headers it points to. If non-zero, SIZE is the known extent of the
536 object. If not null, *LOADBASEP is filled in with the difference
537 between the VMAs from which the segments were read, and the VMAs
538 the file headers (and hence BFD's idea of each section's VMA) put
539 them at.
540
541 The function TARGET_READ_MEMORY is called to copy LEN bytes from
542 the remote memory at target address VMA into the local buffer at
543 MYADDR; it should return zero on success or an `errno' code on
544 failure. TEMPL must be a BFD for a target with the word size and
545 byte order found in the remote memory. */
546 extern bfd *bfd_elf_bfd_from_remote_memory
547 (bfd *templ, bfd_vma ehdr_vma, bfd_size_type size, bfd_vma *loadbasep,
548 int (*target_read_memory) (bfd_vma vma, bfd_byte *myaddr,
549 bfd_size_type len));
550
551 /* Forward declarations. */
552 struct ecoff_debug_info;
553 struct ecoff_debug_swap;
554 struct ecoff_extr;
555 struct bfd_link_info;
556 struct bfd_link_hash_entry;
557
558 /* Return TRUE if the start of STR matches PREFIX, FALSE otherwise. */
559
560 static inline bfd_boolean
561 startswith (const char *str, const char *prefix)
562 {
563 return strncmp (str, prefix, strlen (prefix)) == 0;
564 }
This page took 0.040163 seconds and 4 git commands to generate.