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 coredump_writer;
49struct image_params;
50struct thread;
51struct vnode;
52struct note_info_list;
53struct sbuf;
54
55/*
56 * Structure used to pass information from the loader to the
57 * stack fixup routine.
58 */
59typedef struct {
60 Elf_Ssize execfd;
61 Elf_Size phdr;
62 Elf_Size phent;
63 Elf_Size phnum;
64 Elf_Size pagesz;
65 Elf_Size base;
66 Elf_Size flags;
67 Elf_Size entry;
68 Elf_Word hdr_eflags; /* e_flags field from ehdr */
69} __ElfN(Auxargs);
70
71typedef struct {
72 Elf_Note hdr;
73 const char * vendor;
74 int flags;
75 bool (*trans_osrel)(const Elf_Note *, int32_t *);
76#define BN_CAN_FETCH_OSREL 0x0001 /* Deprecated. */
77#define BN_TRANSLATE_OSREL 0x0002 /* Use trans_osrel to fetch osrel */
78 /* after checking the image ABI specification, if needed. */
79} Elf_Brandnote;
80
81typedef struct {
82 int brand;
83 int machine;
84 const char *compat_3_brand; /* pre Binutils 2.10 method (FBSD 3) */
85 const char *interp_path;
86 struct sysentvec *sysvec;
87 const char *interp_newpath;
88 int flags;
89 Elf_Brandnote *brand_note;
90 bool (*header_supported)(const struct image_params *,
91 const int32_t *, const uint32_t *);
92 /* High 8 bits of flags is private to the ABI */
93#define BI_CAN_EXEC_DYN 0x0001
94#define BI_BRAND_NOTE 0x0002 /* May have note.ABI-tag section. */
95#define BI_BRAND_NOTE_MANDATORY 0x0004 /* Must have note.ABI-tag section. */
96#define BI_BRAND_ONLY_STATIC 0x0008 /* Match only interp-less binaries. */
97} __ElfN(Brandinfo);
98
99__ElfType(Auxargs);
100__ElfType(Brandinfo);
101
102#define MAX_BRANDS 8
103#define FREEBSD_ABI_VENDOR "FreeBSD"
104#define GNU_ABI_VENDOR "GNU"
105
106typedef void (*outfunc_t)(void *, struct sbuf *, size_t *);
107
108/* Closure for __elfN(size_segments)(). */
109struct sseg_closure {
110 int count; /* Count of writable segments. */
111 size_t size; /* Total size of all writable segments. */
112};
113
114bool __elfN(brand_inuse)(Elf_Brandinfo *entry);
115int __elfN(insert_brand_entry)(Elf_Brandinfo *entry);
116int __elfN(remove_brand_entry)(Elf_Brandinfo *entry);
117int __elfN(freebsd_fixup)(uintptr_t *, struct image_params *);
118int __elfN(coredump)(struct thread *, struct coredump_writer *, off_t, int);
119size_t __elfN(populate_note)(int, void *, void *, size_t, void **);
120int __elfN(freebsd_copyout_auxargs)(struct image_params *, uintptr_t);
121void __elfN(puthdr)(struct thread *, void *, size_t, int, size_t, int);
122void __elfN(prepare_notes)(struct thread *, struct note_info_list *,
123 size_t *);
124void __elfN(size_segments)(struct thread *, struct sseg_closure *, int);
125size_t __elfN(register_note)(struct thread *, struct note_info_list *,
126 int, outfunc_t, void *);
127bool __elfN(parse_notes)(const struct image_params *, const Elf_Note *,
128 const char *, const Elf_Phdr *,
129 bool (*)(const Elf_Note *, void *, bool *), void *);
130
131/* Machine specific function to dump per-thread information. */
132void __elfN(dump_thread)(struct thread *, void *, size_t *);
133
134extern int __elfN(fallback_brand);
135extern Elf_Brandnote __elfN(freebsd_brandnote);
136extern Elf_Brandnote __elfN(kfreebsd_brandnote);
137#endif /* _KERNEL */
138
139#endif /* !_SYS_IMGACT_ELF_H_ */