xref: /kernel/linux/linux-5.10/include/uapi/linux/elf.h (revision 8c2ecf20)
1/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
2#ifndef _UAPI_LINUX_ELF_H
3#define _UAPI_LINUX_ELF_H
4
5#include <linux/types.h>
6#include <linux/elf-em.h>
7
8/* 32-bit ELF base types. */
9typedef __u32	Elf32_Addr;
10typedef __u16	Elf32_Half;
11typedef __u32	Elf32_Off;
12typedef __s32	Elf32_Sword;
13typedef __u32	Elf32_Word;
14
15/* 64-bit ELF base types. */
16typedef __u64	Elf64_Addr;
17typedef __u16	Elf64_Half;
18typedef __s16	Elf64_SHalf;
19typedef __u64	Elf64_Off;
20typedef __s32	Elf64_Sword;
21typedef __u32	Elf64_Word;
22typedef __u64	Elf64_Xword;
23typedef __s64	Elf64_Sxword;
24
25/* These constants are for the segment types stored in the image headers */
26#define PT_NULL    0
27#define PT_LOAD    1
28#define PT_DYNAMIC 2
29#define PT_INTERP  3
30#define PT_NOTE    4
31#define PT_SHLIB   5
32#define PT_PHDR    6
33#define PT_TLS     7               /* Thread local storage segment */
34#define PT_LOOS    0x60000000      /* OS-specific */
35#define PT_HIOS    0x6fffffff      /* OS-specific */
36#define PT_LOPROC  0x70000000
37#define PT_HIPROC  0x7fffffff
38#define PT_GNU_EH_FRAME		0x6474e550
39#define PT_GNU_PROPERTY		0x6474e553
40
41#define PT_OHOS_RANDOMDATA  0x6788fc60	/* ohos-specific segment */
42#define PT_OHOS_RANDOMDATA_SIZE_LIMIT  1024 * 128
43
44#define PT_GNU_STACK	(PT_LOOS + 0x474e551)
45
46/*
47 * Extended Numbering
48 *
49 * If the real number of program header table entries is larger than
50 * or equal to PN_XNUM(0xffff), it is set to sh_info field of the
51 * section header at index 0, and PN_XNUM is set to e_phnum
52 * field. Otherwise, the section header at index 0 is zero
53 * initialized, if it exists.
54 *
55 * Specifications are available in:
56 *
57 * - Oracle: Linker and Libraries.
58 *   Part No: 817–1984–19, August 2011.
59 *   https://docs.oracle.com/cd/E18752_01/pdf/817-1984.pdf
60 *
61 * - System V ABI AMD64 Architecture Processor Supplement
62 *   Draft Version 0.99.4,
63 *   January 13, 2010.
64 *   http://www.cs.washington.edu/education/courses/cse351/12wi/supp-docs/abi.pdf
65 */
66#define PN_XNUM 0xffff
67
68/* These constants define the different elf file types */
69#define ET_NONE   0
70#define ET_REL    1
71#define ET_EXEC   2
72#define ET_DYN    3
73#define ET_CORE   4
74#define ET_LOPROC 0xff00
75#define ET_HIPROC 0xffff
76
77/* This is the info that is needed to parse the dynamic section of the file */
78#define DT_NULL		0
79#define DT_NEEDED	1
80#define DT_PLTRELSZ	2
81#define DT_PLTGOT	3
82#define DT_HASH		4
83#define DT_STRTAB	5
84#define DT_SYMTAB	6
85#define DT_RELA		7
86#define DT_RELASZ	8
87#define DT_RELAENT	9
88#define DT_STRSZ	10
89#define DT_SYMENT	11
90#define DT_INIT		12
91#define DT_FINI		13
92#define DT_SONAME	14
93#define DT_RPATH 	15
94#define DT_SYMBOLIC	16
95#define DT_REL	        17
96#define DT_RELSZ	18
97#define DT_RELENT	19
98#define DT_PLTREL	20
99#define DT_DEBUG	21
100#define DT_TEXTREL	22
101#define DT_JMPREL	23
102#define DT_ENCODING	32
103#define OLD_DT_LOOS	0x60000000
104#define DT_LOOS		0x6000000d
105#define DT_HIOS		0x6ffff000
106#define DT_VALRNGLO	0x6ffffd00
107#define DT_VALRNGHI	0x6ffffdff
108#define DT_ADDRRNGLO	0x6ffffe00
109#define DT_ADDRRNGHI	0x6ffffeff
110#define DT_VERSYM	0x6ffffff0
111#define DT_RELACOUNT	0x6ffffff9
112#define DT_RELCOUNT	0x6ffffffa
113#define DT_FLAGS_1	0x6ffffffb
114#define DT_VERDEF	0x6ffffffc
115#define	DT_VERDEFNUM	0x6ffffffd
116#define DT_VERNEED	0x6ffffffe
117#define	DT_VERNEEDNUM	0x6fffffff
118#define OLD_DT_HIOS     0x6fffffff
119#define DT_LOPROC	0x70000000
120#define DT_HIPROC	0x7fffffff
121
122/* This info is needed when parsing the symbol table */
123#define STB_LOCAL  0
124#define STB_GLOBAL 1
125#define STB_WEAK   2
126
127#define STT_NOTYPE  0
128#define STT_OBJECT  1
129#define STT_FUNC    2
130#define STT_SECTION 3
131#define STT_FILE    4
132#define STT_COMMON  5
133#define STT_TLS     6
134
135#define ELF_ST_BIND(x)		((x) >> 4)
136#define ELF_ST_TYPE(x)		(((unsigned int) x) & 0xf)
137#define ELF32_ST_BIND(x)	ELF_ST_BIND(x)
138#define ELF32_ST_TYPE(x)	ELF_ST_TYPE(x)
139#define ELF64_ST_BIND(x)	ELF_ST_BIND(x)
140#define ELF64_ST_TYPE(x)	ELF_ST_TYPE(x)
141
142typedef struct dynamic{
143  Elf32_Sword d_tag;
144  union{
145    Elf32_Sword	d_val;
146    Elf32_Addr	d_ptr;
147  } d_un;
148} Elf32_Dyn;
149
150typedef struct {
151  Elf64_Sxword d_tag;		/* entry tag value */
152  union {
153    Elf64_Xword d_val;
154    Elf64_Addr d_ptr;
155  } d_un;
156} Elf64_Dyn;
157
158/* The following are used with relocations */
159#define ELF32_R_SYM(x) ((x) >> 8)
160#define ELF32_R_TYPE(x) ((x) & 0xff)
161
162#define ELF64_R_SYM(i)			((i) >> 32)
163#define ELF64_R_TYPE(i)			((i) & 0xffffffff)
164
165typedef struct elf32_rel {
166  Elf32_Addr	r_offset;
167  Elf32_Word	r_info;
168} Elf32_Rel;
169
170typedef struct elf64_rel {
171  Elf64_Addr r_offset;	/* Location at which to apply the action */
172  Elf64_Xword r_info;	/* index and type of relocation */
173} Elf64_Rel;
174
175typedef struct elf32_rela{
176  Elf32_Addr	r_offset;
177  Elf32_Word	r_info;
178  Elf32_Sword	r_addend;
179} Elf32_Rela;
180
181typedef struct elf64_rela {
182  Elf64_Addr r_offset;	/* Location at which to apply the action */
183  Elf64_Xword r_info;	/* index and type of relocation */
184  Elf64_Sxword r_addend;	/* Constant addend used to compute value */
185} Elf64_Rela;
186
187typedef struct elf32_sym{
188  Elf32_Word	st_name;
189  Elf32_Addr	st_value;
190  Elf32_Word	st_size;
191  unsigned char	st_info;
192  unsigned char	st_other;
193  Elf32_Half	st_shndx;
194} Elf32_Sym;
195
196typedef struct elf64_sym {
197  Elf64_Word st_name;		/* Symbol name, index in string tbl */
198  unsigned char	st_info;	/* Type and binding attributes */
199  unsigned char	st_other;	/* No defined meaning, 0 */
200  Elf64_Half st_shndx;		/* Associated section index */
201  Elf64_Addr st_value;		/* Value of the symbol */
202  Elf64_Xword st_size;		/* Associated symbol size */
203} Elf64_Sym;
204
205
206#define EI_NIDENT	16
207
208typedef struct elf32_hdr{
209  unsigned char	e_ident[EI_NIDENT];
210  Elf32_Half	e_type;
211  Elf32_Half	e_machine;
212  Elf32_Word	e_version;
213  Elf32_Addr	e_entry;  /* Entry point */
214  Elf32_Off	e_phoff;
215  Elf32_Off	e_shoff;
216  Elf32_Word	e_flags;
217  Elf32_Half	e_ehsize;
218  Elf32_Half	e_phentsize;
219  Elf32_Half	e_phnum;
220  Elf32_Half	e_shentsize;
221  Elf32_Half	e_shnum;
222  Elf32_Half	e_shstrndx;
223} Elf32_Ehdr;
224
225typedef struct elf64_hdr {
226  unsigned char	e_ident[EI_NIDENT];	/* ELF "magic number" */
227  Elf64_Half e_type;
228  Elf64_Half e_machine;
229  Elf64_Word e_version;
230  Elf64_Addr e_entry;		/* Entry point virtual address */
231  Elf64_Off e_phoff;		/* Program header table file offset */
232  Elf64_Off e_shoff;		/* Section header table file offset */
233  Elf64_Word e_flags;
234  Elf64_Half e_ehsize;
235  Elf64_Half e_phentsize;
236  Elf64_Half e_phnum;
237  Elf64_Half e_shentsize;
238  Elf64_Half e_shnum;
239  Elf64_Half e_shstrndx;
240} Elf64_Ehdr;
241
242/* These constants define the permissions on sections in the program
243   header, p_flags. */
244#define PF_R		0x4
245#define PF_W		0x2
246#define PF_X		0x1
247
248typedef struct elf32_phdr{
249  Elf32_Word	p_type;
250  Elf32_Off	p_offset;
251  Elf32_Addr	p_vaddr;
252  Elf32_Addr	p_paddr;
253  Elf32_Word	p_filesz;
254  Elf32_Word	p_memsz;
255  Elf32_Word	p_flags;
256  Elf32_Word	p_align;
257} Elf32_Phdr;
258
259typedef struct elf64_phdr {
260  Elf64_Word p_type;
261  Elf64_Word p_flags;
262  Elf64_Off p_offset;		/* Segment file offset */
263  Elf64_Addr p_vaddr;		/* Segment virtual address */
264  Elf64_Addr p_paddr;		/* Segment physical address */
265  Elf64_Xword p_filesz;		/* Segment size in file */
266  Elf64_Xword p_memsz;		/* Segment size in memory */
267  Elf64_Xword p_align;		/* Segment alignment, file & memory */
268} Elf64_Phdr;
269
270/* sh_type */
271#define SHT_NULL	0
272#define SHT_PROGBITS	1
273#define SHT_SYMTAB	2
274#define SHT_STRTAB	3
275#define SHT_RELA	4
276#define SHT_HASH	5
277#define SHT_DYNAMIC	6
278#define SHT_NOTE	7
279#define SHT_NOBITS	8
280#define SHT_REL		9
281#define SHT_SHLIB	10
282#define SHT_DYNSYM	11
283#define SHT_NUM		12
284#define SHT_LOPROC	0x70000000
285#define SHT_HIPROC	0x7fffffff
286#define SHT_LOUSER	0x80000000
287#define SHT_HIUSER	0xffffffff
288
289/* sh_flags */
290#define SHF_WRITE		0x1
291#define SHF_ALLOC		0x2
292#define SHF_EXECINSTR		0x4
293#define SHF_RELA_LIVEPATCH	0x00100000
294#define SHF_RO_AFTER_INIT	0x00200000
295#define SHF_MASKPROC		0xf0000000
296
297/* special section indexes */
298#define SHN_UNDEF	0
299#define SHN_LORESERVE	0xff00
300#define SHN_LOPROC	0xff00
301#define SHN_HIPROC	0xff1f
302#define SHN_LIVEPATCH	0xff20
303#define SHN_ABS		0xfff1
304#define SHN_COMMON	0xfff2
305#define SHN_HIRESERVE	0xffff
306
307typedef struct elf32_shdr {
308  Elf32_Word	sh_name;
309  Elf32_Word	sh_type;
310  Elf32_Word	sh_flags;
311  Elf32_Addr	sh_addr;
312  Elf32_Off	sh_offset;
313  Elf32_Word	sh_size;
314  Elf32_Word	sh_link;
315  Elf32_Word	sh_info;
316  Elf32_Word	sh_addralign;
317  Elf32_Word	sh_entsize;
318} Elf32_Shdr;
319
320typedef struct elf64_shdr {
321  Elf64_Word sh_name;		/* Section name, index in string tbl */
322  Elf64_Word sh_type;		/* Type of section */
323  Elf64_Xword sh_flags;		/* Miscellaneous section attributes */
324  Elf64_Addr sh_addr;		/* Section virtual addr at execution */
325  Elf64_Off sh_offset;		/* Section file offset */
326  Elf64_Xword sh_size;		/* Size of section in bytes */
327  Elf64_Word sh_link;		/* Index of another section */
328  Elf64_Word sh_info;		/* Additional section information */
329  Elf64_Xword sh_addralign;	/* Section alignment */
330  Elf64_Xword sh_entsize;	/* Entry size if section holds table */
331} Elf64_Shdr;
332
333#define	EI_MAG0		0		/* e_ident[] indexes */
334#define	EI_MAG1		1
335#define	EI_MAG2		2
336#define	EI_MAG3		3
337#define	EI_CLASS	4
338#define	EI_DATA		5
339#define	EI_VERSION	6
340#define	EI_OSABI	7
341#define	EI_PAD		8
342
343#define	ELFMAG0		0x7f		/* EI_MAG */
344#define	ELFMAG1		'E'
345#define	ELFMAG2		'L'
346#define	ELFMAG3		'F'
347#define	ELFMAG		"\177ELF"
348#define	SELFMAG		4
349
350#define	ELFCLASSNONE	0		/* EI_CLASS */
351#define	ELFCLASS32	1
352#define	ELFCLASS64	2
353#define	ELFCLASSNUM	3
354
355#define ELFDATANONE	0		/* e_ident[EI_DATA] */
356#define ELFDATA2LSB	1
357#define ELFDATA2MSB	2
358
359#define EV_NONE		0		/* e_version, EI_VERSION */
360#define EV_CURRENT	1
361#define EV_NUM		2
362
363#define ELFOSABI_NONE	0
364#define ELFOSABI_LINUX	3
365
366#ifndef ELF_OSABI
367#define ELF_OSABI ELFOSABI_NONE
368#endif
369
370/*
371 * Notes used in ET_CORE. Architectures export some of the arch register sets
372 * using the corresponding note types via the PTRACE_GETREGSET and
373 * PTRACE_SETREGSET requests.
374 * The note name for all these is "LINUX".
375 */
376#define NT_PRSTATUS	1
377#define NT_PRFPREG	2
378#define NT_PRPSINFO	3
379#define NT_TASKSTRUCT	4
380#define NT_AUXV		6
381/*
382 * Note to userspace developers: size of NT_SIGINFO note may increase
383 * in the future to accomodate more fields, don't assume it is fixed!
384 */
385#define NT_SIGINFO      0x53494749
386#define NT_FILE         0x46494c45
387#define NT_PRXFPREG     0x46e62b7f      /* copied from gdb5.1/include/elf/common.h */
388#define NT_PPC_VMX	0x100		/* PowerPC Altivec/VMX registers */
389#define NT_PPC_SPE	0x101		/* PowerPC SPE/EVR registers */
390#define NT_PPC_VSX	0x102		/* PowerPC VSX registers */
391#define NT_PPC_TAR	0x103		/* Target Address Register */
392#define NT_PPC_PPR	0x104		/* Program Priority Register */
393#define NT_PPC_DSCR	0x105		/* Data Stream Control Register */
394#define NT_PPC_EBB	0x106		/* Event Based Branch Registers */
395#define NT_PPC_PMU	0x107		/* Performance Monitor Registers */
396#define NT_PPC_TM_CGPR	0x108		/* TM checkpointed GPR Registers */
397#define NT_PPC_TM_CFPR	0x109		/* TM checkpointed FPR Registers */
398#define NT_PPC_TM_CVMX	0x10a		/* TM checkpointed VMX Registers */
399#define NT_PPC_TM_CVSX	0x10b		/* TM checkpointed VSX Registers */
400#define NT_PPC_TM_SPR	0x10c		/* TM Special Purpose Registers */
401#define NT_PPC_TM_CTAR	0x10d		/* TM checkpointed Target Address Register */
402#define NT_PPC_TM_CPPR	0x10e		/* TM checkpointed Program Priority Register */
403#define NT_PPC_TM_CDSCR	0x10f		/* TM checkpointed Data Stream Control Register */
404#define NT_PPC_PKEY	0x110		/* Memory Protection Keys registers */
405#define NT_386_TLS	0x200		/* i386 TLS slots (struct user_desc) */
406#define NT_386_IOPERM	0x201		/* x86 io permission bitmap (1=deny) */
407#define NT_X86_XSTATE	0x202		/* x86 extended state using xsave */
408#define NT_S390_HIGH_GPRS	0x300	/* s390 upper register halves */
409#define NT_S390_TIMER	0x301		/* s390 timer register */
410#define NT_S390_TODCMP	0x302		/* s390 TOD clock comparator register */
411#define NT_S390_TODPREG	0x303		/* s390 TOD programmable register */
412#define NT_S390_CTRS	0x304		/* s390 control registers */
413#define NT_S390_PREFIX	0x305		/* s390 prefix register */
414#define NT_S390_LAST_BREAK	0x306	/* s390 breaking event address */
415#define NT_S390_SYSTEM_CALL	0x307	/* s390 system call restart data */
416#define NT_S390_TDB	0x308		/* s390 transaction diagnostic block */
417#define NT_S390_VXRS_LOW	0x309	/* s390 vector registers 0-15 upper half */
418#define NT_S390_VXRS_HIGH	0x30a	/* s390 vector registers 16-31 */
419#define NT_S390_GS_CB	0x30b		/* s390 guarded storage registers */
420#define NT_S390_GS_BC	0x30c		/* s390 guarded storage broadcast control block */
421#define NT_S390_RI_CB	0x30d		/* s390 runtime instrumentation */
422#define NT_ARM_VFP	0x400		/* ARM VFP/NEON registers */
423#define NT_ARM_TLS	0x401		/* ARM TLS register */
424#define NT_ARM_HW_BREAK	0x402		/* ARM hardware breakpoint registers */
425#define NT_ARM_HW_WATCH	0x403		/* ARM hardware watchpoint registers */
426#define NT_ARM_SYSTEM_CALL	0x404	/* ARM system call number */
427#define NT_ARM_SVE	0x405		/* ARM Scalable Vector Extension registers */
428#define NT_ARM_PAC_MASK		0x406	/* ARM pointer authentication code masks */
429#define NT_ARM_PACA_KEYS	0x407	/* ARM pointer authentication address keys */
430#define NT_ARM_PACG_KEYS	0x408	/* ARM pointer authentication generic key */
431#define NT_ARM_TAGGED_ADDR_CTRL	0x409	/* arm64 tagged address control (prctl()) */
432#define NT_ARC_V2	0x600		/* ARCv2 accumulator/extra registers */
433#define NT_VMCOREDD	0x700		/* Vmcore Device Dump Note */
434#define NT_MIPS_DSP	0x800		/* MIPS DSP ASE registers */
435#define NT_MIPS_FP_MODE	0x801		/* MIPS floating-point mode */
436#define NT_MIPS_MSA	0x802		/* MIPS SIMD registers */
437#define NT_LOONGARCH_CPUCFG	0xa00	/* LoongArch CPU config registers */
438#define NT_LOONGARCH_CSR	0xa01	/* LoongArch control and status registers */
439#define NT_LOONGARCH_LSX	0xa02	/* LoongArch Loongson SIMD Extension registers */
440#define NT_LOONGARCH_LASX	0xa03	/* LoongArch Loongson Advanced SIMD Extension registers */
441#define NT_LOONGARCH_LBT	0xa04	/* LoongArch Loongson Binary Translation registers */
442
443/* Note types with note name "GNU" */
444#define NT_GNU_PROPERTY_TYPE_0	5
445
446/* Note header in a PT_NOTE section */
447typedef struct elf32_note {
448  Elf32_Word	n_namesz;	/* Name size */
449  Elf32_Word	n_descsz;	/* Content size */
450  Elf32_Word	n_type;		/* Content type */
451} Elf32_Nhdr;
452
453/* Note header in a PT_NOTE section */
454typedef struct elf64_note {
455  Elf64_Word n_namesz;	/* Name size */
456  Elf64_Word n_descsz;	/* Content size */
457  Elf64_Word n_type;	/* Content type */
458} Elf64_Nhdr;
459
460/* .note.gnu.property types for EM_AARCH64: */
461#define GNU_PROPERTY_AARCH64_FEATURE_1_AND	0xc0000000
462
463/* Bits for GNU_PROPERTY_AARCH64_FEATURE_1_BTI */
464#define GNU_PROPERTY_AARCH64_FEATURE_1_BTI	(1U << 0)
465
466#endif /* _UAPI_LINUX_ELF_H */
467