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