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
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) \
39    {(pos)->a_type = (id); (pos)->a_un.a_val = (val); (pos)++;}
40#if (defined(__LP64__) && __ELF_WORD_SIZE == 32)
41#define	AUXARGS_ENTRY_PTR(pos, id, ptr) \
42    {(pos)->a_type = (id); (pos)->a_un.a_val = (uintptr_t)(ptr); (pos)++;}
43#else
44#define	AUXARGS_ENTRY_PTR(pos, id, ptr) \
45    {(pos)->a_type = (id); (pos)->a_un.a_ptr = (ptr); (pos)++;}
46#endif
47
48struct image_params;
49struct thread;
50struct vnode;
51struct note_info_list;
52struct sbuf;
53
54/*
55 * Structure used to pass information from the loader to the
56 * stack fixup routine.
57 */
58typedef 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
70typedef 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
80typedef struct {
81	int brand;
82	int machine;
83	const char *compat_3_brand;	/* pre Binutils 2.10 method (FBSD 3) */
84	const char *interp_path;
85	struct sysentvec *sysvec;
86	const char *interp_newpath;
87	int flags;
88	Elf_Brandnote *brand_note;
89	bool		(*header_supported)(const struct image_params *,
90	    const int32_t *, const uint32_t *);
91		/* High 8 bits of flags is private to the ABI */
92#define	BI_CAN_EXEC_DYN		0x0001
93#define	BI_BRAND_NOTE		0x0002	/* May have note.ABI-tag section. */
94#define	BI_BRAND_NOTE_MANDATORY	0x0004	/* Must have note.ABI-tag section. */
95#define	BI_BRAND_ONLY_STATIC	0x0008	/* Match only interp-less binaries. */
96} __ElfN(Brandinfo);
97
98__ElfType(Auxargs);
99__ElfType(Brandinfo);
100
101#define	MAX_BRANDS		8
102#define	FREEBSD_ABI_VENDOR	"FreeBSD"
103#define	GNU_ABI_VENDOR		"GNU"
104
105typedef void (*outfunc_t)(void *, struct sbuf *, size_t *);
106
107/* Closure for __elfN(size_segments)(). */
108struct sseg_closure {
109	int count;              /* Count of writable segments. */
110	size_t size;            /* Total size of all writable segments. */
111};
112
113bool	__elfN(brand_inuse)(Elf_Brandinfo *entry);
114int	__elfN(insert_brand_entry)(Elf_Brandinfo *entry);
115int	__elfN(remove_brand_entry)(Elf_Brandinfo *entry);
116int	__elfN(freebsd_fixup)(uintptr_t *, struct image_params *);
117int	__elfN(coredump)(struct thread *, struct vnode *, off_t, int);
118size_t	__elfN(populate_note)(int, void *, void *, size_t, void **);
119int	__elfN(freebsd_copyout_auxargs)(struct image_params *, uintptr_t);
120void	__elfN(puthdr)(struct thread *, void *, size_t, int, size_t, int);
121void	__elfN(prepare_notes)(struct thread *, struct note_info_list *,
122	    size_t *);
123void	__elfN(size_segments)(struct thread *, struct sseg_closure *, int);
124size_t	__elfN(register_note)(struct thread *, struct note_info_list *,
125	    int, outfunc_t, void *);
126bool	__elfN(parse_notes)(const struct image_params *, const Elf_Note *,
127	    const char *, const Elf_Phdr *,
128	    bool (*)(const Elf_Note *, void *, bool *), void *);
129
130/* Machine specific function to dump per-thread information. */
131void	__elfN(dump_thread)(struct thread *, void *, size_t *);
132
133extern int __elfN(fallback_brand);
134extern Elf_Brandnote __elfN(freebsd_brandnote);
135extern Elf_Brandnote __elfN(kfreebsd_brandnote);
136#endif /* _KERNEL */
137
138#endif /* !_SYS_IMGACT_ELF_H_ */
139