xref: /haiku/headers/os/kernel/elf.h (revision e705c841d784f0035a0ef3e9e96f6e017df16681)
1 /*
2  * Copyright 2002-2016 Haiku, Inc. All rights reserved.
3  * Distributed under the terms of the MIT License.
4  */
5 #ifndef _ELF_H
6 #define _ELF_H
7 
8 
9 #include <SupportDefs.h>
10 #include <ByteOrder.h>
11 
12 
13 typedef uint32 Elf32_Addr;
14 typedef uint16 Elf32_Half;
15 typedef uint32 Elf32_Off;
16 typedef int32 Elf32_Sword;
17 typedef uint32 Elf32_Word;
18 
19 typedef Elf32_Half Elf32_Versym;
20 
21 typedef uint64 Elf64_Addr;
22 typedef uint64 Elf64_Off;
23 typedef uint16 Elf64_Half;
24 typedef uint32 Elf64_Word;
25 typedef int32 Elf64_Sword;
26 typedef uint64 Elf64_Xword;
27 typedef int64 Elf64_Sxword;
28 
29 typedef Elf64_Half Elf64_Versym;
30 
31 
32 /*** ELF header ***/
33 
34 #define EI_NIDENT	16
35 
36 typedef struct {
37 	uint8		e_ident[EI_NIDENT];
38 	Elf32_Half	e_type;
39 	Elf32_Half	e_machine;
40 	Elf32_Word	e_version;
41 	Elf32_Addr	e_entry;
42 	Elf32_Off	e_phoff;
43 	Elf32_Off	e_shoff;
44 	Elf32_Word	e_flags;
45 	Elf32_Half	e_ehsize;
46 	Elf32_Half	e_phentsize;
47 	Elf32_Half	e_phnum;
48 	Elf32_Half	e_shentsize;
49 	Elf32_Half	e_shnum;
50 	Elf32_Half	e_shstrndx;
51 
52 #ifdef __cplusplus
53 	bool IsHostEndian() const;
54 #endif
55 } Elf32_Ehdr;
56 
57 typedef struct {
58 	uint8		e_ident[EI_NIDENT];
59 	Elf64_Half	e_type;
60 	Elf64_Half	e_machine;
61 	Elf64_Word	e_version;
62 	Elf64_Addr	e_entry;
63 	Elf64_Off	e_phoff;
64 	Elf64_Off	e_shoff;
65 	Elf64_Word	e_flags;
66 	Elf64_Half	e_ehsize;
67 	Elf64_Half	e_phentsize;
68 	Elf64_Half	e_phnum;
69 	Elf64_Half	e_shentsize;
70 	Elf64_Half	e_shnum;
71 	Elf64_Half	e_shstrndx;
72 
73 #ifdef __cplusplus
74 	bool IsHostEndian() const;
75 #endif
76 } Elf64_Ehdr;
77 
78 /* e_ident[] indices */
79 #define EI_MAG0		0
80 #define EI_MAG1		1
81 #define EI_MAG2		2
82 #define EI_MAG3		3
83 #define EI_CLASS	4
84 #define EI_DATA		5
85 #define EI_VERSION	6
86 #define EI_PAD		7
87 
88 /* Values for the magic number bytes. */
89 #define ELFMAG0		0x7f
90 #define ELFMAG1		'E'
91 #define ELFMAG2		'L'
92 #define ELFMAG3		'F'
93 #define ELFMAG		"\x7f""ELF"
94 #define SELFMAG		4
95 
96 /* e_type (Object file type) */
97 #define ET_NONE			0 /* No file type */
98 #define ET_REL			1 /* Relocatable file */
99 #define ET_EXEC			2 /* Executable file */
100 #define ET_DYN			3 /* Shared-object file */
101 #define ET_CORE			4 /* Core file */
102 #define ET_LOOS			0xfe00 /* OS-specific range start */
103 #define ET_HIOS			0xfeff /* OS-specific range end */
104 #define ET_LOPROC		0xff00 /* Processor-specific range start */
105 #define ET_HIPROC		0xffff /* Processor-specific range end */
106 
107 /* e_machine (Architecture) */
108 #define EM_NONE			0 /* No machine */
109 #define EM_M32			1 /* AT&T WE 32100 */
110 #define EM_SPARC		2 /* Sparc */
111 #define EM_386			3 /* Intel 80386 */
112 #define EM_68K			4 /* Motorola m68k family */
113 #define EM_88K			5 /* Motorola m88k family */
114 #define EM_486			6 /* Intel 80486, Reserved for future use */
115 #define EM_860			7 /* Intel 80860 */
116 #define EM_MIPS			8 /* MIPS R3000 (officially, big-endian only) */
117 #define EM_S370			9 /* IBM System/370 */
118 #define EM_MIPS_RS3_LE	10 /* MIPS R3000 little-endian, Deprecated */
119 #define EM_PARISC		15 /* HPPA */
120 #define EM_VPP550		17 /* Fujitsu VPP500 */
121 #define EM_SPARC32PLUS	18 /* Sun "v8plus" */
122 #define EM_960			19 /* Intel 80960 */
123 #define EM_PPC			20 /* PowerPC */
124 #define EM_PPC64		21 /* 64-bit PowerPC */
125 #define EM_S390			22 /* IBM S/390 */
126 #define EM_V800			36 /* NEC V800 series */
127 #define EM_FR20			37 /* Fujitsu FR20 */
128 #define EM_RH32			38 /* TRW RH32 */
129 #define EM_MCORE		39 /* Motorola M*Core */
130 #define EM_RCE			39 /* Old name for MCore */
131 #define EM_ARM			40 /* ARM */
132 #define EM_OLD_ALPHA	41 /* Digital Alpha */
133 #define EM_SH			42 /* Renesas / SuperH SH */
134 #define EM_SPARCV9		43 /* SPARC v9 64-bit */
135 #define EM_TRICORE		44 /* Siemens Tricore embedded processor */
136 #define EM_ARC			45 /* ARC Cores */
137 #define EM_H8_300		46 /* Renesas H8/300 */
138 #define EM_H8_300H		47 /* Renesas H8/300H */
139 #define EM_H8S			48 /* Renesas H8S */
140 #define EM_H8_500		49 /* Renesas H8/500 */
141 #define EM_IA_64		50 /* Intel IA-64 Processor */
142 #define EM_MIPS_X		51 /* Stanford MIPS-X */
143 #define EM_COLDFIRE		52 /* Motorola Coldfire */
144 #define EM_68HC12		53 /* Motorola M68HC12 */
145 #define EM_MMA			54 /* Fujitsu Multimedia Accelerator */
146 #define EM_PCP			55 /* Siemens PCP */
147 #define EM_NCPU			56 /* Sony nCPU embedded RISC processor */
148 #define EM_NDR1			57 /* Denso NDR1 microprocesspr */
149 #define EM_STARCORE		58 /* Motorola Star*Core processor */
150 #define EM_ME16			59 /* Toyota ME16 processor */
151 #define EM_ST100		60 /* STMicroelectronics ST100 processor */
152 #define EM_TINYJ		61 /* Advanced Logic Corp. TinyJ embedded processor */
153 #define EM_X86_64		62 /* Advanced Micro Devices X86-64 processor */
154 #define EM_PDSP			63 /* Sony DSP Processor */
155 #define EM_FX66			66 /* Siemens FX66 microcontroller */
156 #define EM_ST9PLUS		67 /* STMicroelectronics ST9+ 8/16 mc */
157 #define EM_ST7			68 /* STmicroelectronics ST7 8 bit mc */
158 #define EM_68HC16		69 /* Motorola MC68HC16 microcontroller */
159 #define EM_68HC11		70 /* Motorola MC68HC11 microcontroller */
160 #define EM_68HC08		71 /* Motorola MC68HC08 microcontroller */
161 #define EM_68HC05		72 /* Motorola MC68HC05 microcontroller */
162 #define EM_SVX			73 /* Silicon Graphics SVx */
163 #define EM_ST19			74 /* STMicroelectronics ST19 8 bit mc */
164 #define EM_VAX			75 /* Digital VAX */
165 #define EM_CRIS			76 /* Axis Communications 32-bit embedded processor */
166 #define EM_JAVELIN		77 /* Infineon Technologies 32-bit embedded processor */
167 #define EM_FIREPATH		78 /* Element 14 64-bit DSP Processor */
168 #define EM_ZSP			79 /* LSI Logic 16-bit DSP Processor */
169 #define EM_MMIX			80 /* Donald Knuth's educational 64-bit processor */
170 #define EM_HUANY		81 /* Harvard University machine-independent object files */
171 #define EM_PRISM		82 /* SiTera Prism */
172 #define EM_AVR			83 /* Atmel AVR 8-bit microcontroller */
173 #define EM_FR30			84 /* Fujitsu FR30 */
174 #define EM_D10V			85 /* Mitsubishi D10V */
175 #define EM_D30V			86 /* Mitsubishi D30V */
176 #define EM_V850			87 /* NEC v850 */
177 #define EM_M32R			88 /* Mitsubishi M32R */
178 #define EM_MN10300		89 /* Matsushita MN10300 */
179 #define EM_MN10200		90 /* Matsushita MN10200 */
180 #define EM_PJ			91 /* picoJava */
181 #define EM_OPENRISC		92 /* OpenRISC 32-bit embedded processor */
182 #define EM_ARC_A5		93 /* ARC Cores Tangent-A5 */
183 #define EM_XTENSA		94 /* Tensilica Xtensa Architecture */
184 #define EM_VIDCORE		95 /* Alphamosaic VideoCore */
185 #define EM_CR			103 /* Nat. Semi. CompactRISC microprocessor */
186 #define EM_BLACKFIN		106 /* Analog Devices Blackfin (DSP) processor */
187 #define EM_ARCA			109 /* Arca RISC Microprocessor */
188 #define EM_VIDCORE3		137 /* Broadcom VideoCore III */
189 #define EM_ARM64		183 /* ARM 64 bit */
190 #define EM_AARCH64		EM_ARM64
191 #define EM_AVR32		185 /* AVR-32 */
192 #define EM_STM8			186 /* ST STM8S */
193 #define EM_CUDA			190 /* Nvidia CUDA */
194 #define EM_VIDCORE5		198 /* Broadcom VideoCore V */
195 #define EM_NORC			218 /* Nanoradio Optimized RISC */
196 #define EM_AMDGPU		224 /* AMD GPU */
197 #define EM_RISCV		243 /* RISC-V */
198 #define EM_BPF			247 /* Linux kernel bpf virtual machine */
199 
200 /* architecture class (EI_CLASS) */
201 #define ELFCLASSNONE	0
202 #define ELFCLASS32		1
203 #define ELFCLASS64		2
204 
205 /* endian (EI_DATA) */
206 #define ELFDATANONE	0	/* invalid */
207 #define ELFDATA2LSB	1	/* little endian */
208 #define ELFDATA2MSB	2	/* big endian */
209 
210 /* ELF version (EI_VERSION) */
211 #define EV_NONE		0	/* invalid */
212 #define EV_CURRENT	1	/* current version */
213 
214 /*** section header ***/
215 
216 typedef struct {
217 	Elf32_Word	sh_name;
218 	Elf32_Word	sh_type;
219 	Elf32_Word	sh_flags;
220 	Elf32_Addr	sh_addr;
221 	Elf32_Off	sh_offset;
222 	Elf32_Word	sh_size;
223 	Elf32_Word	sh_link;
224 	Elf32_Word	sh_info;
225 	Elf32_Word	sh_addralign;
226 	Elf32_Word	sh_entsize;
227 } Elf32_Shdr;
228 
229 typedef struct {
230 	Elf64_Word	sh_name;
231 	Elf64_Word	sh_type;
232 	Elf64_Xword	sh_flags;
233 	Elf64_Addr	sh_addr;
234 	Elf64_Off	sh_offset;
235 	Elf64_Xword	sh_size;
236 	Elf64_Word	sh_link;
237 	Elf64_Word	sh_info;
238 	Elf64_Xword	sh_addralign;
239 	Elf64_Xword	sh_entsize;
240 } Elf64_Shdr;
241 
242 /* special section indices */
243 #define SHN_UNDEF		0
244 #define SHN_LORESERVE	0xff00
245 #define SHN_LOPROC		0xff00
246 #define SHN_HIPROC		0xff1f
247 #define SHN_ABS			0xfff1
248 #define SHN_COMMON		0xfff2
249 #define SHN_HIRESERVE	0xffff
250 
251 /* section header type */
252 #define SHT_NULL		0
253 #define SHT_PROGBITS	1
254 #define SHT_SYMTAB		2
255 #define SHT_STRTAB		3
256 #define SHT_RELA		4
257 #define SHT_HASH		5
258 #define SHT_DYNAMIC		6
259 #define SHT_NOTE		7
260 #define SHT_NOBITS		8
261 #define SHT_REL			9
262 #define SHT_SHLIB		10
263 #define SHT_DYNSYM		11
264 
265 #define SHT_GNU_verdef	0x6ffffffd    /* version definition section */
266 #define SHT_GNU_verneed	0x6ffffffe    /* version needs section */
267 #define SHT_GNU_versym	0x6fffffff    /* version symbol table */
268 
269 #define SHT_LOPROC		0x70000000
270 #define SHT_HIPROC		0x7fffffff
271 #define SHT_LOUSER		0x80000000
272 #define SHT_HIUSER		0xffffffff
273 
274 /* section header flags */
275 #define SHF_WRITE		1
276 #define SHF_ALLOC		2
277 #define SHF_EXECINSTR	4
278 
279 #define SHF_MASKPROC	0xf0000000
280 
281 
282 /*** program header ***/
283 
284 typedef struct {
285 	Elf32_Word	p_type;
286 	Elf32_Off	p_offset;	/* offset from the beginning of the file of the segment */
287 	Elf32_Addr	p_vaddr;	/* virtual address for the segment in memory */
288 	Elf32_Addr	p_paddr;
289 	Elf32_Word	p_filesz;	/* the size of the segment in the file */
290 	Elf32_Word	p_memsz;	/* the size of the segment in memory */
291 	Elf32_Word	p_flags;
292 	Elf32_Word	p_align;
293 
294 #ifdef __cplusplus
295 	bool IsReadWrite() const;
296 	bool IsExecutable() const;
297 #endif
298 } Elf32_Phdr;
299 
300 typedef struct {
301 	Elf64_Word	p_type;
302 	Elf64_Word	p_flags;
303 	Elf64_Off	p_offset;	/* offset from the beginning of the file of the segment */
304 	Elf64_Addr	p_vaddr;	/* virtual address for the segment in memory */
305 	Elf64_Addr	p_paddr;
306 	Elf64_Xword	p_filesz;	/* the size of the segment in the file */
307 	Elf64_Xword	p_memsz;	/* the size of the segment in memory */
308 	Elf64_Xword	p_align;
309 
310 #ifdef __cplusplus
311 	bool IsReadWrite() const;
312 	bool IsExecutable() const;
313 #endif
314 } Elf64_Phdr;
315 
316 /* program header segment types */
317 #define PT_NULL			0
318 #define PT_LOAD			1
319 #define PT_DYNAMIC		2
320 #define PT_INTERP		3
321 #define PT_NOTE			4
322 #define PT_SHLIB		5
323 #define PT_PHDR			6
324 #define PT_TLS			7
325 #define PT_EH_FRAME		0x6474e550
326 #define PT_STACK		0x6474e551
327 #define PT_RELRO		0x6474e552
328 
329 #define PT_LOPROC		0x70000000
330 #define PT_ARM_UNWIND	0x70000001
331 #define PT_HIPROC		0x7fffffff
332 
333 /* program header segment flags */
334 #define PF_EXECUTE	0x1
335 #define PF_WRITE	0x2
336 #define PF_READ		0x4
337 #define PF_PROTECTION_MASK (PF_EXECUTE | PF_WRITE | PF_READ)
338 
339 #define PF_MASKPROC	0xf0000000
340 
341 
342 /* symbol table entry */
343 
344 typedef struct {
345 	Elf32_Word	st_name;
346 	Elf32_Addr	st_value;
347 	Elf32_Word	st_size;
348 	uint8		st_info;
349 	uint8 		st_other;
350 	Elf32_Half	st_shndx;
351 
352 #ifdef __cplusplus
353 	uint8 Bind() const;
354 	uint8 Type() const;
355 	void SetInfo(uint8 bind, uint8 type);
356 #endif
357 } Elf32_Sym;
358 
359 typedef struct {
360 	Elf64_Word	st_name;
361 	uint8		st_info;
362 	uint8		st_other;
363 	Elf64_Half	st_shndx;
364 	Elf64_Addr	st_value;
365 	Elf64_Xword	st_size;
366 
367 #ifdef __cplusplus
368 	uint8 Bind() const;
369 	uint8 Type() const;
370 	void SetInfo(uint8 bind, uint8 type);
371 #endif
372 } Elf64_Sym;
373 
374 #define ELF32_ST_BIND(i) ((i) >> 4)
375 #define ELF32_ST_TYPE(i) ((i) & 0xf)
376 #define ELF32_ST_INFO(b, t) (((b) << 4) + ((t) & 0xf))
377 
378 #define ELF64_ST_BIND(i) ((i) >> 4)
379 #define ELF64_ST_TYPE(i) ((i) & 0xf)
380 #define ELF64_ST_INFO(b, t) (((b) << 4) + ((t) & 0xf))
381 
382 /* symbol types */
383 #define STT_NOTYPE 0
384 #define STT_OBJECT 1
385 #define STT_FUNC 2
386 #define STT_SECTION 3
387 #define STT_FILE 4
388 #define STT_TLS		6
389 #define STT_LOPROC 13
390 #define STT_HIPROC 15
391 
392 /* symbol binding */
393 #define STB_LOCAL 0
394 #define STB_GLOBAL 1
395 #define STB_WEAK 2
396 #define STB_LOPROC 13
397 #define STB_HIPROC 15
398 
399 /* special symbol indices */
400 #define STN_UNDEF 0
401 
402 
403 /* relocation table entry */
404 
405 typedef struct {
406 	Elf32_Addr r_offset;
407 	Elf32_Word r_info;
408 
409 #ifdef __cplusplus
410 	uint8 SymbolIndex() const;
411 	uint8 Type() const;
412 #endif
413 } Elf32_Rel;
414 
415 typedef struct {
416 	Elf64_Addr	r_offset;
417 	Elf64_Xword	r_info;
418 
419 #ifdef __cplusplus
420 	uint8 SymbolIndex() const;
421 	uint8 Type() const;
422 #endif
423 } Elf64_Rel;
424 
425 #ifdef __cplusplus
426 typedef struct Elf32_Rela : public Elf32_Rel {
427 #else
428 typedef struct {
429 	Elf32_Addr r_offset;
430 	Elf32_Word r_info;
431 #endif
432 	Elf32_Sword r_addend;
433 } Elf32_Rela;
434 
435 #ifdef __cplusplus
436 typedef struct Elf64_Rela : public Elf64_Rel {
437 #else
438 typedef struct {
439 	Elf64_Addr		r_offset;
440 	Elf64_Xword		r_info;
441 #endif
442 	Elf64_Sxword	r_addend;
443 } Elf64_Rela;
444 
445 #define ELF32_R_SYM(i) ((i) >> 8)
446 #define ELF32_R_TYPE(i) ((unsigned char)(i))
447 #define ELF32_R_INFO(s, t) (((s) << 8) + (unsigned char)(t))
448 
449 #define ELF64_R_SYM(i) ((i) >> 32)
450 #define ELF64_R_TYPE(i) ((i) & 0xffffffffL)
451 #define ELF64_R_INFO(s, t) ((((Elf64_Xword)(s)) << 32) + ((t) & 0xffffffffL))
452 
453 
454 /* dynamic section entry */
455 
456 typedef struct {
457 	Elf32_Sword d_tag;
458 	union {
459 		Elf32_Word d_val;
460 		Elf32_Addr d_ptr;
461 	} d_un;
462 } Elf32_Dyn;
463 
464 typedef struct {
465 	Elf64_Sxword d_tag;
466 	union {
467 		Elf64_Xword	d_val;
468 		Elf64_Addr	d_ptr;
469 	} d_un;
470 } Elf64_Dyn;
471 
472 /* dynamic entry type */
473 #define DT_NULL				0
474 #define DT_NEEDED			1
475 #define DT_PLTRELSZ			2
476 #define DT_PLTGOT			3
477 #define DT_HASH				4
478 #define DT_STRTAB			5
479 #define DT_SYMTAB			6
480 #define DT_RELA				7
481 #define DT_RELASZ			8
482 #define DT_RELAENT			9
483 #define DT_STRSZ			10
484 #define DT_SYMENT			11
485 #define DT_INIT				12
486 #define DT_FINI				13
487 #define DT_SONAME			14
488 #define DT_RPATH			15
489 #define DT_SYMBOLIC			16
490 #define DT_REL				17
491 #define DT_RELSZ			18
492 #define DT_RELENT			19
493 #define DT_PLTREL			20
494 #define DT_DEBUG			21
495 #define DT_TEXTREL			22
496 #define DT_JMPREL			23
497 #define DT_BIND_NOW			24	/* no lazy binding */
498 #define DT_INIT_ARRAY		25	/* init function array */
499 #define DT_FINI_ARRAY		26	/* termination function array */
500 #define DT_INIT_ARRAYSZ		27	/* init function array size */
501 #define DT_FINI_ARRAYSZ		28	/* termination function array size */
502 #define DT_RUNPATH			29	/* library search path (supersedes DT_RPATH) */
503 #define DT_FLAGS			30	/* flags (see below) */
504 #define DT_ENCODING			32
505 #define DT_PREINIT_ARRAY	32	/* preinitialization array */
506 #define DT_PREINIT_ARRAYSZ	33	/* preinitialization array size */
507 
508 #define DT_VERSYM       0x6ffffff0	/* symbol version table */
509 #define DT_VERDEF		0x6ffffffc	/* version definition table */
510 #define DT_VERDEFNUM	0x6ffffffd	/* number of version definitions */
511 #define DT_VERNEED		0x6ffffffe 	/* table with needed versions */
512 #define DT_VERNEEDNUM	0x6fffffff	/* number of needed versions */
513 
514 #define DT_LOPROC		0x70000000
515 #define DT_HIPROC		0x7fffffff
516 
517 /* DT_FLAGS values */
518 #define DF_ORIGIN		0x01
519 #define DF_SYMBOLIC		0x02
520 #define DF_TEXTREL		0x04
521 #define DF_BIND_NOW		0x08
522 #define DF_STATIC_TLS	0x10
523 
524 
525 /* version definition section */
526 
527 typedef struct {
528 	Elf32_Half	vd_version;		/* version revision */
529 	Elf32_Half	vd_flags;		/* version information flags */
530 	Elf32_Half	vd_ndx;			/* version index as specified in the
531 								   symbol version table */
532 	Elf32_Half	vd_cnt;			/* number of associated verdaux entries */
533 	Elf32_Word	vd_hash;		/* version name hash value */
534 	Elf32_Word	vd_aux;			/* byte offset to verdaux array */
535 	Elf32_Word	vd_next;		/* byte offset to next verdef entry */
536 } Elf32_Verdef;
537 
538 typedef struct {
539 	Elf64_Half	vd_version;		/* version revision */
540 	Elf64_Half	vd_flags;		/* version information flags */
541 	Elf64_Half	vd_ndx;			/* version index as specified in the
542 								   symbol version table */
543 	Elf64_Half	vd_cnt;			/* number of associated verdaux entries */
544 	Elf64_Word	vd_hash;		/* version name hash value */
545 	Elf64_Word	vd_aux;			/* byte offset to verdaux array */
546 	Elf64_Word	vd_next;		/* byte offset to next verdef entry */
547 } Elf64_Verdef;
548 
549 /* values for vd_version (version revision) */
550 #define VER_DEF_NONE		0		/* no version */
551 #define VER_DEF_CURRENT		1		/* current version */
552 #define VER_DEF_NUM			2		/* given version number */
553 
554 /* values for vd_flags (version information flags) */
555 #define VER_FLG_BASE		0x1		/* version definition of file itself */
556 #define VER_FLG_WEAK		0x2 	/* weak version identifier */
557 
558 /* values for versym symbol index */
559 #define VER_NDX_LOCAL		0		/* symbol is local */
560 #define VER_NDX_GLOBAL		1		/* symbol is global/unversioned */
561 #define VER_NDX_INITIAL		2		/* initial version -- that's the one given
562 									   to symbols when a library becomes
563 									   versioned; handled by the linker (and
564 									   runtime loader) similar to
565 									   VER_NDX_GLOBAL */
566 #define VER_NDX_LORESERVE	0xff00	/* beginning of reserved entries */
567 #define VER_NDX_ELIMINATE	0xff01	/* symbol is to be eliminated */
568 
569 #define VER_NDX_FLAG_HIDDEN	0x8000	/* flag: version is hidden */
570 #define VER_NDX_MASK		0x7fff	/* mask to get the actual version index */
571 #define VER_NDX(x)			((x) & VER_NDX_MASK)
572 
573 
574 /* auxiliary version information */
575 
576 typedef struct {
577 	Elf32_Word	vda_name;		/* string table offset to version or dependency
578 								   name */
579 	Elf32_Word	vda_next;		/* byte offset to next verdaux entry */
580 } Elf32_Verdaux;
581 
582 typedef struct {
583 	Elf64_Word	vda_name;		/* string table offset to version or dependency
584 								   name */
585 	Elf64_Word	vda_next;		/* byte offset to next verdaux entry */
586 } Elf64_Verdaux;
587 
588 
589 /* version dependency section */
590 
591 typedef struct {
592 	Elf32_Half	vn_version;		/* version of structure */
593 	Elf32_Half	vn_cnt;			/* number of associated vernaux entries */
594 	Elf32_Word	vn_file;		/* byte offset to file name for this
595 								   dependency */
596 	Elf32_Word	vn_aux;			/* byte offset to vernaux array */
597 	Elf32_Word	vn_next;		/* byte offset to next verneed entry */
598 } Elf32_Verneed;
599 
600 typedef struct {
601 	Elf64_Half	vn_version;		/* version of structure */
602 	Elf64_Half	vn_cnt;			/* number of associated vernaux entries */
603 	Elf64_Word	vn_file;		/* byte offset to file name for this
604 								   dependency */
605 	Elf64_Word	vn_aux;			/* byte offset to vernaux array */
606 	Elf64_Word	vn_next;		/* byte offset to next verneed entry */
607 } Elf64_Verneed;
608 
609 /* values for vn_version (version revision) */
610 #define VER_NEED_NONE		0	/* no version */
611 #define VER_NEED_CURRENT	1	/* current version */
612 #define VER_NEED_NUM		2	/* given version number */
613 
614 
615 /* auxiliary needed version information */
616 
617 typedef struct {
618 	Elf32_Word	vna_hash;		/* dependency name hash value */
619 	Elf32_Half	vna_flags;		/* dependency specific information flags */
620 	Elf32_Half	vna_other;		/* version index as specified in the symbol
621 								   version table */
622 	Elf32_Word	vna_name;		/* string table offset to dependency name */
623 	Elf32_Word	vna_next;		/* byte offset to next vernaux entry */
624 } Elf32_Vernaux;
625 
626 typedef struct {
627 	Elf64_Word	vna_hash;		/* dependency name hash value */
628 	Elf64_Half	vna_flags;		/* dependency specific information flags */
629 	Elf64_Half	vna_other;		/* version index as specified in the symbol
630 								   version table */
631 	Elf64_Word	vna_name;		/* string table offset to dependency name */
632 	Elf64_Word	vna_next;		/* byte offset to next vernaux entry */
633 } Elf64_Vernaux;
634 
635 /* values for vna_flags */
636 #define VER_FLG_WEAK	0x2		/* weak version identifier */
637 
638 
639 /*** core files ***/
640 
641 /* note section header */
642 
643 typedef struct {
644 	Elf32_Word n_namesz;		/* length of the note's name */
645 	Elf32_Word n_descsz;		/* length of the note's descriptor */
646 	Elf32_Word n_type;			/* note type */
647 } Elf32_Nhdr;
648 
649 typedef struct {
650 	Elf64_Word n_namesz;		/* length of the note's name */
651 	Elf64_Word n_descsz;		/* length of the note's descriptor */
652 	Elf64_Word n_type;			/* note type */
653 } Elf64_Nhdr;
654 
655 /* values for note name */
656 #define ELF_NOTE_CORE		"CORE"
657 #define ELF_NOTE_HAIKU		"Haiku"
658 
659 /* values for note type (n_type) */
660 /* ELF_NOTE_CORE/... */
661 #define NT_FILE				0x46494c45 /* mapped files */
662 
663 /* ELF_NOTE_HAIKU/... */
664 #define NT_TEAM				0x7465616d 	/* team */
665 #define NT_AREAS			0x61726561 	/* areas */
666 #define NT_IMAGES			0x696d6167 	/* images */
667 #define NT_THREADS			0x74687264 	/* threads */
668 #define NT_SYMBOLS			0x73796d73 	/* symbols */
669 
670 /* NT_TEAM: uint32 entrySize; Elf32_Note_Team; char[] args */
671 typedef struct {
672 	int32		nt_id;				/* team ID */
673 	int32		nt_uid;				/* team owner ID */
674 	int32		nt_gid;				/* team group ID */
675 } Elf32_Note_Team;
676 
677 typedef Elf32_Note_Team Elf64_Note_Team;
678 
679 /* NT_AREAS:
680  * uint32 count;
681  * uint32 entrySize;
682  * Elf32_Note_Area_Entry[count];
683  * char[] names
684  */
685 typedef struct {
686 	int32		na_id;				/* area ID */
687 	uint32		na_lock;			/* lock type (B_NO_LOCK, ...) */
688 	uint32		na_protection;		/* protection (B_READ_AREA | ...) */
689 	uint32		na_base;			/* area base address */
690 	uint32		na_size;			/* area size */
691 	uint32		na_ram_size;		/* physical memory used */
692 } Elf32_Note_Area_Entry;
693 
694 /* NT_AREAS:
695  * uint32 count;
696  * uint32 entrySize;
697  * Elf64_Note_Area_Entry[count];
698  * char[] names
699  */
700 typedef struct {
701 	int32		na_id;				/* area ID */
702 	uint32		na_lock;			/* lock type (B_NO_LOCK, ...) */
703 	uint32		na_protection;		/* protection (B_READ_AREA | ...) */
704 	uint32		na_pad1;
705 	uint64		na_base;			/* area base address */
706 	uint64		na_size;			/* area size */
707 	uint64		na_ram_size;		/* physical memory used */
708 } Elf64_Note_Area_Entry;
709 
710 /* NT_IMAGES:
711  * uint32 count;
712  * uint32 entrySize;
713  * Elf32_Note_Image_Entry[count];
714  * char[] names
715  */
716 typedef struct {
717 	int32		ni_id;				/* image ID */
718 	int32		ni_type;			/* image type (B_APP_IMAGE, ...) */
719 	uint32		ni_init_routine;	/* address of init function */
720 	uint32		ni_term_routine;	/* address of termination function */
721 	int32		ni_device;			/* device ID of mapped file */
722 	int64		ni_node;			/* node ID of mapped file */
723 	uint32		ni_text_base;		/* base address of text segment */
724 	uint32		ni_text_size;		/* size of text segment */
725 	int32		ni_text_delta;		/* delta of the text segment relative to
726 									   load address specified in the ELF file */
727 	uint32		ni_data_base;		/* base address of data segment */
728 	uint32		ni_data_size;		/* size of data segment */
729 	uint32		ni_symbol_table;	/* address of dynamic symbol table */
730 	uint32		ni_symbol_hash;		/* address of dynamic symbol hash */
731 	uint32		ni_string_table;	/* address of dynamic string table */
732 } Elf32_Note_Image_Entry;
733 
734 /* NT_IMAGES:
735  * uint32 count;
736  * uint32 entrySize;
737  * Elf64_Note_Image_Entry[count];
738  * char[] names
739  */
740 typedef struct {
741 	int32		ni_id;				/* image ID */
742 	int32		ni_type;			/* image type (B_APP_IMAGE, ...) */
743 	uint64		ni_init_routine;	/* address of init function */
744 	uint64		ni_term_routine;	/* address of termination function */
745 	uint32		ni_pad1;
746 	int32		ni_device;			/* device ID of mapped file */
747 	int64		ni_node;			/* node ID of mapped file */
748 	uint64		ni_text_base;		/* base address of text segment */
749 	uint64		ni_text_size;		/* size of text segment */
750 	int64		ni_text_delta;		/* delta of the text segment relative to
751 									   load address specified in the ELF file */
752 	uint64		ni_data_base;		/* base address of data segment */
753 	uint64		ni_data_size;		/* size of data segment */
754 	uint64		ni_symbol_table;	/* address of dynamic symbol table */
755 	uint64		ni_symbol_hash;		/* address of dynamic symbol hash */
756 	uint64		ni_string_table;	/* address of dynamic string table */
757 } Elf64_Note_Image_Entry;
758 
759 /* NT_THREADS:
760  * uint32 count;
761  * uint32 entrySize;
762  * uint32 cpuStateSize;
763  * {Elf32_Note_Thread_Entry, uint8[cpuStateSize] cpuState}[count];
764  * char[] names
765  */
766 typedef struct {
767 	int32		nth_id;				/* thread ID */
768 	int32		nth_state;			/* thread state (B_THREAD_RUNNING, ...) */
769 	int32		nth_priority;		/* thread priority */
770 	uint32		nth_stack_base;		/* thread stack base address */
771 	uint32		nth_stack_end;		/* thread stack end address */
772 } Elf32_Note_Thread_Entry;
773 
774 /* NT_THREADS:
775  * uint32 count;
776  * uint32 entrySize;
777  * uint32 cpuStateSize;
778  * {Elf64_Note_Thread_Entry, uint8[cpuStateSize] cpuState}[count];
779  * char[] names
780  */
781 typedef struct {
782 	int32		nth_id;				/* thread ID */
783 	int32		nth_state;			/* thread state (B_THREAD_RUNNING, ...) */
784 	int32		nth_priority;		/* thread priority */
785 	uint32		nth_pad1;
786 	uint64		nth_stack_base;		/* thread stack base address */
787 	uint64		nth_stack_end;		/* thread stack end address */
788 } Elf64_Note_Thread_Entry;
789 
790 /* NT_SYMBOLS:
791  * int32 imageId;
792  * uint32 symbolCount;
793  * uint32 entrySize;
794  * Elf{32,64}_Sym[count];
795  * char[] strings
796  */
797 
798 
799 /*** inline functions ***/
800 
801 #ifdef __cplusplus
802 
803 inline bool
804 Elf32_Ehdr::IsHostEndian() const
805 {
806 #if B_HOST_IS_LENDIAN
807 	return e_ident[EI_DATA] == ELFDATA2LSB;
808 #elif B_HOST_IS_BENDIAN
809 	return e_ident[EI_DATA] == ELFDATA2MSB;
810 #endif
811 }
812 
813 
814 inline bool
815 Elf64_Ehdr::IsHostEndian() const
816 {
817 #if B_HOST_IS_LENDIAN
818 	return e_ident[EI_DATA] == ELFDATA2LSB;
819 #elif B_HOST_IS_BENDIAN
820 	return e_ident[EI_DATA] == ELFDATA2MSB;
821 #endif
822 }
823 
824 
825 inline bool
826 Elf32_Phdr::IsReadWrite() const
827 {
828 	return !(~p_flags & (PF_READ | PF_WRITE));
829 }
830 
831 
832 inline bool
833 Elf32_Phdr::IsExecutable() const
834 {
835 	return (p_flags & PF_EXECUTE) != 0;
836 }
837 
838 
839 inline bool
840 Elf64_Phdr::IsReadWrite() const
841 {
842 	return !(~p_flags & (PF_READ | PF_WRITE));
843 }
844 
845 
846 inline bool
847 Elf64_Phdr::IsExecutable() const
848 {
849 	return (p_flags & PF_EXECUTE) != 0;
850 }
851 
852 
853 inline uint8
854 Elf32_Sym::Bind() const
855 {
856 	return ELF32_ST_BIND(st_info);
857 }
858 
859 
860 inline uint8
861 Elf32_Sym::Type() const
862 {
863 	return ELF32_ST_TYPE(st_info);
864 }
865 
866 
867 inline void
868 Elf32_Sym::SetInfo(uint8 bind, uint8 type)
869 {
870 	st_info = ELF32_ST_INFO(bind, type);
871 }
872 
873 
874 inline uint8
875 Elf64_Sym::Bind() const
876 {
877 	return ELF64_ST_BIND(st_info);
878 }
879 
880 
881 inline uint8
882 Elf64_Sym::Type() const
883 {
884 	return ELF64_ST_TYPE(st_info);
885 }
886 
887 
888 inline void
889 Elf64_Sym::SetInfo(uint8 bind, uint8 type)
890 {
891 	st_info = ELF64_ST_INFO(bind, type);
892 }
893 
894 
895 inline uint8
896 Elf32_Rel::SymbolIndex() const
897 {
898 	return ELF32_R_SYM(r_info);
899 }
900 
901 
902 inline uint8
903 Elf32_Rel::Type() const
904 {
905 	return ELF32_R_TYPE(r_info);
906 }
907 
908 
909 inline uint8
910 Elf64_Rel::SymbolIndex() const
911 {
912 	return ELF64_R_SYM(r_info);
913 }
914 
915 
916 inline uint8
917 Elf64_Rel::Type() const
918 {
919 	return ELF64_R_TYPE(r_info);
920 }
921 
922 #endif	/* __cplusplus */
923 
924 
925 #endif	/* _ELF_H */
926