xref: /freebsd/sys/sys/imgact_elf.h (revision a3557ef0)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1995-1996 Søren Schmidt
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer
12  *    in this position and unchanged.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. The name of the author may not be used to endorse or promote products
17  *    derived from this software without specific prior written permission
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
20  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
21  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
22  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
23  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
24  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  *
30  * $FreeBSD$
31  */
32 
33 #ifndef _SYS_IMGACT_ELF_H_
34 #define	_SYS_IMGACT_ELF_H_
35 
36 #include <machine/elf.h>
37 
38 #ifdef _KERNEL
39 
40 #define	AUXARGS_ENTRY(pos, id, val) \
41     {(pos)->a_type = (id); (pos)->a_un.a_val = (val); (pos)++;}
42 #if (defined(__LP64__) && __ELF_WORD_SIZE == 32)
43 #define	AUXARGS_ENTRY_PTR(pos, id, ptr) \
44     {(pos)->a_type = (id); (pos)->a_un.a_val = (uintptr_t)(ptr); (pos)++;}
45 #else
46 #define	AUXARGS_ENTRY_PTR(pos, id, ptr) \
47     {(pos)->a_type = (id); (pos)->a_un.a_ptr = (ptr); (pos)++;}
48 #endif
49 
50 struct image_params;
51 struct thread;
52 struct vnode;
53 
54 /*
55  * Structure used to pass information from the loader to the
56  * stack fixup routine.
57  */
58 typedef struct {
59 	Elf_Ssize	execfd;
60 	Elf_Size	phdr;
61 	Elf_Size	phent;
62 	Elf_Size	phnum;
63 	Elf_Size	pagesz;
64 	Elf_Size	base;
65 	Elf_Size	flags;
66 	Elf_Size	entry;
67 	Elf_Word	hdr_eflags;		/* e_flags field from ehdr */
68 } __ElfN(Auxargs);
69 
70 typedef struct {
71 	Elf_Note	hdr;
72 	const char *	vendor;
73 	int		flags;
74 	bool		(*trans_osrel)(const Elf_Note *, int32_t *);
75 #define	BN_CAN_FETCH_OSREL	0x0001	/* Deprecated. */
76 #define	BN_TRANSLATE_OSREL	0x0002	/* Use trans_osrel to fetch osrel */
77 		/* after checking the image ABI specification, if needed. */
78 } Elf_Brandnote;
79 
80 typedef struct {
81 	int brand;
82 	int machine;
83 	const char *compat_3_brand;	/* pre Binutils 2.10 method (FBSD 3) */
84 	const char *emul_path;
85 	const char *interp_path;
86 	struct sysentvec *sysvec;
87 	const char *interp_newpath;
88 	int flags;
89 	Elf_Brandnote *brand_note;
90 	boolean_t	(*header_supported)(struct image_params *);
91 #define	BI_CAN_EXEC_DYN		0x0001
92 #define	BI_BRAND_NOTE		0x0002	/* May have note.ABI-tag section. */
93 #define	BI_BRAND_NOTE_MANDATORY	0x0004	/* Must have note.ABI-tag section. */
94 #define	BI_BRAND_ONLY_STATIC	0x0008	/* Match only interp-less binaries. */
95 } __ElfN(Brandinfo);
96 
97 __ElfType(Auxargs);
98 __ElfType(Brandinfo);
99 
100 #define	MAX_BRANDS	8
101 
102 int	__elfN(brand_inuse)(Elf_Brandinfo *entry);
103 int	__elfN(insert_brand_entry)(Elf_Brandinfo *entry);
104 int	__elfN(remove_brand_entry)(Elf_Brandinfo *entry);
105 int	__elfN(freebsd_fixup)(uintptr_t *, struct image_params *);
106 int	__elfN(coredump)(struct thread *, struct vnode *, off_t, int);
107 size_t	__elfN(populate_note)(int, void *, void *, size_t, void **);
108 void	__elfN(stackgap)(struct image_params *, uintptr_t *);
109 int	__elfN(freebsd_copyout_auxargs)(struct image_params *, uintptr_t);
110 
111 /* Machine specific function to dump per-thread information. */
112 void	__elfN(dump_thread)(struct thread *, void *, size_t *);
113 
114 extern int __elfN(fallback_brand);
115 extern Elf_Brandnote __elfN(freebsd_brandnote);
116 extern Elf_Brandnote __elfN(kfreebsd_brandnote);
117 #endif /* _KERNEL */
118 
119 #endif /* !_SYS_IMGACT_ELF_H_ */
120