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