xref: /freebsd-12.1/sys/sys/imgact_elf.h (revision 052d3c12)
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) {suword(pos++, id); suword(pos++, val);}
41 
42 struct image_params;
43 struct thread;
44 struct vnode;
45 
46 /*
47  * Structure used to pass information from the loader to the
48  * stack fixup routine.
49  */
50 typedef struct {
51 	Elf_Ssize	execfd;
52 	Elf_Size	phdr;
53 	Elf_Size	phent;
54 	Elf_Size	phnum;
55 	Elf_Size	pagesz;
56 	Elf_Size	base;
57 	Elf_Size	flags;
58 	Elf_Size	entry;
59 	Elf_Word	hdr_eflags;		/* e_flags field from ehdr */
60 } __ElfN(Auxargs);
61 
62 typedef struct {
63 	Elf_Note	hdr;
64 	const char *	vendor;
65 	int		flags;
66 	bool		(*trans_osrel)(const Elf_Note *, int32_t *);
67 #define	BN_CAN_FETCH_OSREL	0x0001	/* Deprecated. */
68 #define	BN_TRANSLATE_OSREL	0x0002	/* Use trans_osrel to fetch osrel */
69 		/* after checking the image ABI specification, if needed. */
70 } Elf_Brandnote;
71 
72 typedef struct {
73 	int brand;
74 	int machine;
75 	const char *compat_3_brand;	/* pre Binutils 2.10 method (FBSD 3) */
76 	const char *emul_path;
77 	const char *interp_path;
78 	struct sysentvec *sysvec;
79 	const char *interp_newpath;
80 	int flags;
81 	Elf_Brandnote *brand_note;
82 	boolean_t	(*header_supported)(struct image_params *);
83 #define	BI_CAN_EXEC_DYN		0x0001
84 #define	BI_BRAND_NOTE		0x0002	/* May have note.ABI-tag section. */
85 #define	BI_BRAND_NOTE_MANDATORY	0x0004	/* Must have note.ABI-tag section. */
86 #define	BI_BRAND_ONLY_STATIC	0x0008	/* Match only interp-less binaries. */
87 } __ElfN(Brandinfo);
88 
89 __ElfType(Auxargs);
90 __ElfType(Brandinfo);
91 
92 #define	MAX_BRANDS	8
93 
94 int	__elfN(brand_inuse)(Elf_Brandinfo *entry);
95 int	__elfN(insert_brand_entry)(Elf_Brandinfo *entry);
96 int	__elfN(remove_brand_entry)(Elf_Brandinfo *entry);
97 int	__elfN(freebsd_fixup)(register_t **, struct image_params *);
98 int	__elfN(coredump)(struct thread *, struct vnode *, off_t, int);
99 size_t	__elfN(populate_note)(int, void *, void *, size_t, void **);
100 
101 /* Machine specific function to dump per-thread information. */
102 void	__elfN(dump_thread)(struct thread *, void *, size_t *);
103 
104 extern int __elfN(fallback_brand);
105 extern Elf_Brandnote __elfN(freebsd_brandnote);
106 extern Elf_Brandnote __elfN(kfreebsd_brandnote);
107 #endif /* _KERNEL */
108 
109 #endif /* !_SYS_IMGACT_ELF_H_ */
110