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