1 /* Internal interfaces for libelf.
2 Copyright (C) 1998-2010 Red Hat, Inc.
3 This file is part of Red Hat elfutils.
4 Contributed by Ulrich Drepper <drepper@redhat.com>, 1998.
6 Red Hat elfutils is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by the
8 Free Software Foundation; version 2 of the License.
10 Red Hat elfutils is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License along
16 with Red Hat elfutils; if not, write to the Free Software Foundation,
17 Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301 USA.
19 In addition, as a special exception, Red Hat, Inc. gives You the
20 additional right to link the code of Red Hat elfutils with code licensed
21 under any Open Source Initiative certified open source license
22 (http://www.opensource.org/licenses/index.php) which requires the
23 distribution of source code with any binary distribution and to
24 distribute linked combinations of the two. Non-GPL Code permitted under
25 this exception must only link to the code of Red Hat elfutils through
26 those well defined interfaces identified in the file named EXCEPTION
27 found in the source code files (the "Approved Interfaces"). The files
28 of Non-GPL Code may instantiate templates or use macros or inline
29 functions from the Approved Interfaces without causing the resulting
30 work to be covered by the GNU General Public License. Only Red Hat,
31 Inc. may make changes or additions to the list of Approved Interfaces.
32 Red Hat's grant of this exception is conditioned upon your not adding
33 any new exceptions. If you wish to add a new Approved Interface or
34 exception, please contact Red Hat. You must obey the GNU General Public
35 License in all respects for all of the Red Hat elfutils code and other
36 code used in conjunction with Red Hat elfutils except the Non-GPL Code
37 covered by this exception. If you modify this file, you may extend this
38 exception to your version of the file, but you are not obligated to do
39 so. If you do not wish to provide this exception without modification,
40 you must delete this exception statement from your version and license
41 this file solely under the GPL without exception.
43 Red Hat elfutils is an included package of the Open Invention Network.
44 An included package of the Open Invention Network is a package for which
45 Open Invention Network licensees cross-license their patents. No patent
46 license is granted, either expressly or impliedly, by designation as an
47 included package. Should you wish to participate in the Open Invention
48 Network licensing program, please visit www.openinventionnetwork.com
49 <http://www.openinventionnetwork.com>. */
66 /* gettext helper macros. */
67 #define _(Str) dgettext ("elfutils", Str)
70 /* Helper Macros to write 32 bit and 64 bit functions. */
71 #define __elfw2_(Bits, Name) __elf##Bits##_##Name
72 #define elfw2_(Bits, Name) elf##Bits##_##Name
73 #define ElfW2_(Bits, Name) Elf##Bits##_##Name
74 #define ELFW2_(Bits, Name) ELF##Bits##_##Name
75 #define ELFW_(Name, Bits) Name##Bits
76 #define __elfw2(Bits, Name) __elfw2_(Bits, Name)
77 #define elfw2(Bits, Name) elfw2_(Bits, Name)
78 #define ElfW2(Bits, Name) ElfW2_(Bits, Name)
79 #define ELFW2(Bits, Name) ELFW2_(Bits, Name)
80 #define ELFW(Name, Bits) ELFW_(Name, Bits)
83 /* Sizes of the external types, for 32 bits objects. */
84 #define ELF32_FSZ_ADDR 4
85 #define ELF32_FSZ_OFF 4
86 #define ELF32_FSZ_HALF 2
87 #define ELF32_FSZ_WORD 4
88 #define ELF32_FSZ_SWORD 4
89 #define ELF32_FSZ_XWORD 8
90 #define ELF32_FSZ_SXWORD 8
92 /* Same for 64 bits objects. */
93 #define ELF64_FSZ_ADDR 8
94 #define ELF64_FSZ_OFF 8
95 #define ELF64_FSZ_HALF 2
96 #define ELF64_FSZ_WORD 4
97 #define ELF64_FSZ_SWORD 4
98 #define ELF64_FSZ_XWORD 8
99 #define ELF64_FSZ_SXWORD 8
102 /* This is an extension of the ELF_F_* enumeration. The values here are
103 not part of the library interface, they are only used internally. */
106 ELF_F_MMAPPED = 0x40,
107 ELF_F_MALLOCED = 0x80,
108 ELF_F_FILEDATA = 0x100
112 /* Get definition of all the external types. */
113 #include "exttypes.h"
121 ELF_E_UNKNOWN_VERSION,
123 ELF_E_INVALID_HANDLE,
126 ELF_E_INVALID_ENCODING,
134 ELF_E_INVALID_ARCHIVE,
141 ELF_E_INVALID_OPERAND,
142 ELF_E_INVALID_SECTION,
143 ELF_E_INVALID_COMMAND,
144 ELF_E_WRONG_ORDER_EHDR,
148 ELF_E_NOT_NUL_SECTION,
150 ELF_E_INVALID_SECTION_HEADER,
153 ELF_E_SECTION_TOO_SMALL,
155 ELF_E_INVALID_SHENTSIZE,
161 ELF_E_INVALID_OFFSET,
162 /* Keep this as the last entry. */
167 /* The visible `Elf_Data' type is not sufficent for some operations due
168 to a misdesigned interface. Extend it for internal purposes. */
176 /* List of `Elf_Data' descriptors. This is what makes up the section
178 typedef struct Elf_Data_List
180 /* `data' *must* be the first element in the struct. */
182 struct Elf_Data_List *next;
187 /* Descriptor for ELF section. */
190 /* We have to distinguish several different situations:
192 1. the section is user created. Therefore there is no file or memory
193 region to read the data from. Here we have two different subcases:
195 a) data was not yet added (before the first `elf_newdata' call)
197 b) at least one data set is available
199 2. this is a section from a file/memory region. We have to read the
200 current content in one data block if we have to. But we don't
201 read the data until it is necessary. So we have the subcases:
203 a) the section in the file has size zero (for whatever reason)
205 b) the data of the file is not (yet) read
207 c) the data is read and available.
209 In addition to this we have different data sets, the raw and the converted
210 data. This distinction only exists for the data read from the file.
211 All user-added data set (all but the first when read from the file or
212 all of them for user-create sections) are the same in both formats.
213 We don't create the converted data before it is necessary.
215 The `data_read' element signals whether data is available in the
218 If there is data from the file/memory region or if read one data
219 set is added the `rawdata_list_read' pointer in non-NULL and points
220 to the last filled data set. `raw_datalist_rear' is therefore NULL
221 only if there is no data set at all.
223 This so far allows to distinguish all but two cases (given that the
224 `rawdata_list' and `data_list' entries are initialized to zero) is
225 between not yet loaded data from the file/memory region and a section
226 with zero size and type ELF_T_BYTE. */
227 Elf_Data_List data_list; /* List of data buffers. */
228 Elf_Data_List *data_list_rear; /* Pointer to the rear of the data list. */
230 Elf_Data_Scn rawdata; /* Uninterpreted data of the section. */
232 int data_read; /* Nonzero if the section was created by the
233 user or if the data from the file/memory
235 int shndx_index; /* Index of the extended section index
236 table for this symbol table (if this
237 section is a symbol table). */
239 size_t index; /* Index of this section. */
240 struct Elf *elf; /* The underlying ELF file. */
244 Elf32_Shdr *e32; /* Pointer to 32bit section header. */
245 Elf64_Shdr *e64; /* Pointer to 64bit section header. */
248 unsigned int shdr_flags; /* Section header modified? */
249 unsigned int flags; /* Section changed in size? */
251 char *rawdata_base; /* The unmodified data of the section. */
252 char *data_base; /* The converted data of the section. */
254 struct Elf_ScnList *list; /* Pointer to the section list element the
259 /* List of section. */
260 typedef struct Elf_ScnList
262 unsigned int cnt; /* Number of elements of 'data' used. */
263 unsigned int max; /* Number of elements of 'data' allocated. */
264 struct Elf_ScnList *next; /* Next block of sections. */
265 struct Elf_Scn data[0]; /* Section data. */
269 /* elf_getdata_rawchunk result. */
270 typedef struct Elf_Data_Chunk
276 struct Elf_Data_Chunk *next;
281 /* The ELF descriptor. */
284 /* Address to which the file was mapped. NULL if not mapped. */
287 /* When created for an archive member this points to the descriptor
290 Elf *next; /* Used in list of archive descriptors. */
292 /* What kind of file is underneath (ELF file, archive...). */
295 /* Command used to create this descriptor. */
298 /* The binary class. */
301 /* The used file descriptor. -1 if not available anymore. */
304 /* Offset in the archive this file starts or zero. */
307 /* Size of the file in the archive or the entire file size, or ~0
308 for an (yet) unknown size. */
311 /* Describes the way the memory was allocated and if the dirty bit is
312 signalled it means that the whole file has to be rewritten since
313 the layout changed. */
316 /* Reference counting for the descriptor. */
319 /* Lock to handle multithreaded programs. */
320 rwlock_define (,lock);
326 /* The next fields are only useful when testing for ==/!= NULL. */
331 Elf_ScnList *scns_last; /* Last element in the section list.
332 If NULL the data has not yet been
333 read from the file. */
334 Elf_Data_Chunk *rawchunks; /* List of elf_getdata_rawchunk results. */
335 unsigned int scnincr; /* Number of sections allocate the last
337 int ehdr_flags; /* Flags (dirty) for ELF header. */
338 int phdr_flags; /* Flags (dirty|malloc) for program header. */
339 int shdr_malloced; /* Nonzero if shdr array was allocated. */
340 off64_t sizestr_offset; /* Offset of the size string in the parent
341 if this is an archive member. */
346 Elf32_Ehdr *ehdr; /* Pointer to the ELF header. This is
348 Elf32_Shdr *shdr; /* Used when reading from a file. */
349 Elf32_Phdr *phdr; /* Pointer to the program header array. */
350 Elf_ScnList *scns_last; /* Last element in the section list.
351 If NULL the data has not yet been
352 read from the file. */
353 Elf_Data_Chunk *rawchunks; /* List of elf_getdata_rawchunk results. */
354 unsigned int scnincr; /* Number of sections allocate the last
356 int ehdr_flags; /* Flags (dirty) for ELF header. */
357 int phdr_flags; /* Flags (dirty|malloc) for program header. */
358 int shdr_malloced; /* Nonzero if shdr array was allocated. */
359 off64_t sizestr_offset; /* Offset of the size string in the parent
360 if this is an archive member. */
361 Elf32_Ehdr ehdr_mem; /* Memory used for ELF header when not
363 char __e32scnspad[sizeof (Elf64_Ehdr) - sizeof (Elf32_Ehdr)];
365 /* The section array. */
371 Elf64_Ehdr *ehdr; /* Pointer to the ELF header. This is
373 Elf64_Shdr *shdr; /* Used when reading from a file. */
374 Elf64_Phdr *phdr; /* Pointer to the program header array. */
375 Elf_ScnList *scns_last; /* Last element in the section list.
376 If NULL the data has not yet been
377 read from the file. */
378 Elf_Data_Chunk *rawchunks; /* List of elf_getdata_rawchunk results. */
379 unsigned int scnincr; /* Number of sections allocate the last
381 int ehdr_flags; /* Flags (dirty) for ELF header. */
382 int phdr_flags; /* Flags (dirty|malloc) for program header. */
383 int shdr_malloced; /* Nonzero if shdr array was allocated. */
384 off64_t sizestr_offset; /* Offset of the size string in the parent
385 if this is an archive member. */
386 Elf64_Ehdr ehdr_mem; /* Memory used for ELF header when not
389 /* The section array. */
395 Elf *children; /* List of all descriptors for this archive. */
396 Elf_Arsym *ar_sym; /* Symbol table returned by elf_getarsym. */
397 size_t ar_sym_num; /* Number of entries in `ar_sym'. */
398 char *long_names; /* If no index is available but long names
399 are used this elements points to the data.*/
400 size_t long_names_len; /* Length of the long name table. */
401 off_t offset; /* Offset in file we are currently at.
402 elf_next() advances this to the next
403 member of the archive. */
404 Elf_Arhdr elf_ar_hdr; /* Structure returned by 'elf_getarhdr'. */
405 struct ar_hdr ar_hdr; /* Header read from file. */
406 char ar_name[16]; /* NUL terminated ar_name of elf_ar_hdr. */
407 char raw_name[17]; /* This is a buffer for the NUL terminated
408 named raw_name used in the elf_ar_hdr. */
412 /* There absolutely never must be anything following the union. */
415 /* Type of the conversion functions. These functions will convert the
417 typedef void (*xfct_t) (void *, const void *, size_t, int);
419 /* The table with the function pointers. */
420 extern const xfct_t __elf_xfctstom[EV_NUM - 1][EV_NUM - 1][ELFCLASSNUM - 1][ELF_T_NUM] attribute_hidden;
421 extern const xfct_t __elf_xfctstof[EV_NUM - 1][EV_NUM - 1][ELFCLASSNUM - 1][ELF_T_NUM] attribute_hidden;
424 /* Array with sizes of the external types indexed by ELF version, binary
426 extern const size_t __libelf_type_sizes[EV_NUM - 1][ELFCLASSNUM - 1][ELF_T_NUM] attribute_hidden;
427 /* We often have to access the size for a type in the current version. */
429 # define elf_typesize(class,type,n) \
430 elfw2(class,fsize) (type, n, __libelf_version)
432 # define elf_typesize(class,type,n) \
433 (__libelf_type_sizes[EV_CURRENT - 1][ELFW(ELFCLASS,class) - 1][type] * n)
436 /* Currently selected version of the ELF specification. */
437 extern unsigned int __libelf_version attribute_hidden;
439 /* The byte value used for filling gaps. */
440 extern int __libelf_fill_byte attribute_hidden;
442 /* Nonzero if the version was set. */
443 extern int __libelf_version_initialized attribute_hidden;
445 /* Index for __libelf_type_sizes et al. */
447 # define LIBELF_EV_IDX 0
449 # define LIBELF_EV_IDX (__libelf_version - 1)
453 /* Array with alignment requirements of the internal types indexed by ELF
454 version, binary class, and type. */
455 extern const uint_fast8_t __libelf_type_aligns[EV_NUM - 1][ELFCLASSNUM - 1][ELF_T_NUM] attribute_hidden;
456 # define __libelf_type_align(class, type) \
457 (__libelf_type_aligns[LIBELF_EV_IDX][class - 1][type] ?: 1)
459 # define __libelf_type_align(class, type) 1
462 /* The libelf API does not have such a function but it is still useful.
463 Get the memory size for the given type.
465 These functions cannot be marked internal since they are aliases
466 of the export elfXX_fsize functions.*/
467 extern size_t __elf32_msize (Elf_Type __type, size_t __count,
468 unsigned int __version);
469 extern size_t __elf64_msize (Elf_Type __type, size_t __count,
470 unsigned int __version);
473 /* Create Elf descriptor from memory image. */
474 extern Elf *__libelf_read_mmaped_file (int fildes, void *map_address,
475 off_t offset, size_t maxsize,
476 Elf_Cmd cmd, Elf *parent)
479 /* Set error value. */
480 extern void __libelf_seterrno (int value) internal_function;
482 /* Get the next archive header. */
483 extern int __libelf_next_arhdr_wrlock (Elf *elf) internal_function;
485 /* Read all of the file associated with the descriptor. */
486 extern char *__libelf_readall (Elf *elf) internal_function;
488 /* Read the complete section table and convert the byte order if necessary. */
489 extern int __libelf_readsections (Elf *elf) internal_function;
491 /* Store the information for the raw data in the `rawdata_list' element. */
492 extern int __libelf_set_rawdata (Elf_Scn *scn) internal_function;
493 extern int __libelf_set_rawdata_wrlock (Elf_Scn *scn) internal_function;
496 /* Helper functions for elf_update. */
497 extern off_t __elf32_updatenull_wrlock (Elf *elf, int *change_bop,
498 size_t shnum) internal_function;
499 extern off_t __elf64_updatenull_wrlock (Elf *elf, int *change_bop,
500 size_t shnum) internal_function;
502 extern int __elf32_updatemmap (Elf *elf, int change_bo, size_t shnum)
504 extern int __elf64_updatemmap (Elf *elf, int change_bo, size_t shnum)
506 extern int __elf32_updatefile (Elf *elf, int change_bo, size_t shnum)
508 extern int __elf64_updatefile (Elf *elf, int change_bo, size_t shnum)
512 /* Alias for exported functions to avoid PLT entries, and
513 rdlock/wrlock variants of these functions. */
514 extern int __elf_end_internal (Elf *__elf) attribute_hidden;
515 extern Elf *__elf_begin_internal (int __fildes, Elf_Cmd __cmd, Elf *__ref)
517 extern Elf32_Ehdr *__elf32_getehdr_wrlock (Elf *__elf) internal_function;
518 extern Elf64_Ehdr *__elf64_getehdr_wrlock (Elf *__elf) internal_function;
519 extern Elf32_Ehdr *__elf32_newehdr_internal (Elf *__elf) attribute_hidden;
520 extern Elf64_Ehdr *__elf64_newehdr_internal (Elf *__elf) attribute_hidden;
521 extern Elf32_Phdr *__elf32_getphdr_internal (Elf *__elf) attribute_hidden;
522 extern Elf64_Phdr *__elf64_getphdr_internal (Elf *__elf) attribute_hidden;
523 extern Elf32_Phdr *__elf32_getphdr_wrlock (Elf *__elf) attribute_hidden;
524 extern Elf64_Phdr *__elf64_getphdr_wrlock (Elf *__elf) attribute_hidden;
525 extern Elf32_Phdr *__elf32_newphdr_internal (Elf *__elf, size_t __cnt)
527 extern Elf64_Phdr *__elf64_newphdr_internal (Elf *__elf, size_t __cnt)
529 extern Elf_Scn *__elf32_offscn_internal (Elf *__elf, Elf32_Off __offset)
531 extern Elf_Scn *__elf64_offscn_internal (Elf *__elf, Elf64_Off __offset)
533 extern int __elf_getphdrnum_rdlock (Elf *__elf, size_t *__dst)
535 extern int __elf_getshdrnum_rdlock (Elf *__elf, size_t *__dst)
537 extern int __elf_getshdrstrndx_internal (Elf *__elf, size_t *__dst)
539 extern Elf32_Shdr *__elf32_getshdr_rdlock (Elf_Scn *__scn) internal_function;
540 extern Elf64_Shdr *__elf64_getshdr_rdlock (Elf_Scn *__scn) internal_function;
541 extern Elf32_Shdr *__elf32_getshdr_wrlock (Elf_Scn *__scn) internal_function;
542 extern Elf64_Shdr *__elf64_getshdr_wrlock (Elf_Scn *__scn) internal_function;
543 extern Elf_Scn *__elf_getscn_internal (Elf *__elf, size_t __index)
545 extern Elf_Scn *__elf_nextscn_internal (Elf *__elf, Elf_Scn *__scn)
547 extern int __elf_scnshndx_internal (Elf_Scn *__scn) attribute_hidden;
548 extern Elf_Data *__elf_getdata_internal (Elf_Scn *__scn, Elf_Data *__data)
550 extern Elf_Data *__elf_getdata_rdlock (Elf_Scn *__scn, Elf_Data *__data)
552 extern Elf_Data *__elf_rawdata_internal (Elf_Scn *__scn, Elf_Data *__data)
554 extern char *__elf_strptr_internal (Elf *__elf, size_t __index,
555 size_t __offset) attribute_hidden;
556 extern Elf_Data *__elf32_xlatetom_internal (Elf_Data *__dest,
557 const Elf_Data *__src,
558 unsigned int __encode)
560 extern Elf_Data *__elf64_xlatetom_internal (Elf_Data *__dest,
561 const Elf_Data *__src,
562 unsigned int __encode)
564 extern Elf_Data *__elf32_xlatetof_internal (Elf_Data *__dest,
565 const Elf_Data *__src,
566 unsigned int __encode)
568 extern Elf_Data *__elf64_xlatetof_internal (Elf_Data *__dest,
569 const Elf_Data *__src,
570 unsigned int __encode)
572 extern unsigned int __elf_version_internal (unsigned int __version)
574 extern unsigned long int __elf_hash_internal (const char *__string)
575 __attribute__ ((__pure__, visibility ("hidden")));
576 extern long int __elf32_checksum_internal (Elf *__elf) attribute_hidden;
577 extern long int __elf64_checksum_internal (Elf *__elf) attribute_hidden;
580 extern GElf_Ehdr *__gelf_getehdr_rdlock (Elf *__elf, GElf_Ehdr *__dest)
582 extern size_t __gelf_fsize_internal (Elf *__elf, Elf_Type __type,
583 size_t __count, unsigned int __version)
585 extern GElf_Shdr *__gelf_getshdr_internal (Elf_Scn *__scn, GElf_Shdr *__dst)
587 extern GElf_Sym *__gelf_getsym_internal (Elf_Data *__data, int __ndx,
588 GElf_Sym *__dst) attribute_hidden;
591 extern uint32_t __libelf_crc32 (uint32_t crc, unsigned char *buf, size_t len)
595 /* We often have to update a flag iff a value changed. Make this
597 #define update_if_changed(var, exp, flag) \
599 __typeof__ (var) *_var = &(var); \
600 __typeof__ (exp) _exp = (exp); \
604 (flag) |= ELF_F_DIRTY; \
608 /* Align offset to 4 bytes as needed for note name and descriptor data. */
609 #define NOTE_ALIGN(n) (((n) + 3) & -4U)
611 #endif /* libelfP.h */