1 /* 2 * CDDL HEADER START 3 * 4 * The contents of this file are subject to the terms of the 5 * Common Development and Distribution License (the "License"). 6 * You may not use this file except in compliance with the License. 7 * 8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9 * or http://www.opensolaris.org/os/licensing. 10 * See the License for the specific language governing permissions 11 * and limitations under the License. 12 * 13 * When distributing Covered Code, include this CDDL HEADER in each 14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15 * If applicable, add the following below this CDDL HEADER, with the 16 * fields enclosed by brackets "[]" replaced with your own identifying 17 * information: Portions Copyright [yyyy] [name of copyright owner] 18 * 19 * CDDL HEADER END 20 */ 21 /* 22 * Copyright 2007 Sun Microsystems, Inc. All rights reserved. 23 * Use is subject to license terms. 24 * 25 * Copyright 2017 RackTop Systems. 26 * Copyright (c) 2017 Joyent, Inc. 27 * Copyright 2025 MNX Cloud, Inc. 28 */ 29 30 #ifndef _SYS_KOBJ_H 31 #define _SYS_KOBJ_H 32 33 #include <sys/modctl.h> 34 #include <sys/elf.h> 35 #include <sys/machelf.h> 36 #include <sys/vmem.h> 37 #include <sys/sdt.h> 38 #include <sys/bootstat.h> 39 40 #ifdef __cplusplus 41 extern "C" { 42 #endif 43 44 /* 45 * List of modules maintained by kobj.c 46 */ 47 struct module_list { 48 struct module_list *next; 49 struct module *mp; 50 }; 51 52 typedef struct hotinline_desc { 53 char *hid_symname; /* symbol name */ 54 uintptr_t hid_instr_offset; /* offset of call in text */ 55 struct hotinline_desc *hid_next; /* next hotinline */ 56 } hotinline_desc_t; 57 58 typedef unsigned short symid_t; /* symbol table index */ 59 typedef unsigned char *reloc_dest_t; 60 61 typedef void module_mach; 62 63 struct module { 64 int total_allocated; 65 66 Ehdr hdr; 67 char *shdrs; 68 Shdr *symhdr, *strhdr; 69 70 char *depends_on; 71 72 size_t symsize; 73 char *symspace; /* symbols + strings + hashtbl, or NULL */ 74 int flags; 75 76 size_t text_size; 77 size_t data_size; 78 char *text; 79 char *data; 80 81 unsigned int symtbl_section; 82 /* pointers into symspace, or NULL */ 83 char *symtbl; 84 char *strings; 85 86 unsigned int hashsize; 87 symid_t *buckets; 88 symid_t *chains; 89 90 unsigned int nsyms; 91 92 unsigned int bss_align; 93 size_t bss_size; 94 uintptr_t bss; 95 96 char *filename; 97 98 struct module_list *head, *tail; 99 reloc_dest_t destination; 100 module_mach * machdata; 101 char *ctfdata; 102 size_t ctfsize; 103 104 char *fbt_tab; 105 size_t fbt_size; 106 size_t fbt_nentries; 107 caddr_t textwin; 108 caddr_t textwin_base; 109 110 hotinline_desc_t *hi_calls; 111 112 sdt_probedesc_t *sdt_probes; 113 size_t sdt_nprobes; 114 char *sdt_tab; 115 size_t sdt_size; 116 117 char *sigdata; 118 size_t sigsize; 119 }; 120 121 struct kobj_mem { 122 struct kobj_mem *km_next; 123 struct kobj_mem *km_prev; 124 uintptr_t km_addr; 125 size_t km_size; 126 uintptr_t km_alloc_addr; 127 size_t km_alloc_size; 128 }; 129 130 struct _buf { 131 intptr_t _fd; 132 char *_ptr; 133 char *_base; 134 char *_name; 135 char *_dbuf; 136 int _size; 137 int _cnt; 138 int _off; 139 int _ln; 140 int _bsize; 141 int _iscmp; 142 int _dsize; 143 }; 144 145 146 /* 147 * Statistical info. 148 */ 149 typedef struct { 150 int nalloc; 151 int nfree; 152 int nalloc_calls; 153 int nfree_calls; 154 } kobj_stat_t; 155 156 #define kobj_filename(p) ((p)->_name) 157 #define kobj_linenum(p) ((p)->_ln) 158 #define kobj_newline(p) ((p)->_ln++) 159 #define kobj_getc(p) (--(p)->_cnt >= 0 ? ((int)*(p)->_ptr++):kobj_filbuf(p)) 160 #define kobj_ungetc(p) (++(p)->_cnt > (p)->_size ? -1 : ((int)*(--(p)->_ptr))) 161 #define kobj_comphdr(p) ((struct comphdr *)(p)->_dbuf) 162 163 /* Offset into buffer */ 164 #define B_OFFSET(file, off) (off % (file)->_bsize) 165 166 /* Start of page */ 167 #define F_PAGE(file, off) (off - B_OFFSET(file, off)) 168 169 #define F_BLKS(file, size) ((size / (file)->_bsize) * (file)->_bsize) 170 171 #if defined(_KERNEL) || defined(_FAKE_KERNEL) 172 173 extern int kobj_load_module(struct modctl *, int); 174 extern void kobj_unload_module(struct modctl *); 175 extern uintptr_t kobj_lookup(struct module *, const char *); 176 extern Sym *kobj_lookup_all(struct module *, char *, int); 177 extern int kobj_addrcheck(void *, caddr_t); 178 extern int kobj_module_to_id(void *); 179 extern void kobj_getmodinfo(void *, struct modinfo *); 180 extern int kobj_get_needed(void *, short *, int); 181 extern uintptr_t kobj_getsymvalue(char *, int); 182 extern char *kobj_getsymname(uintptr_t, ulong_t *); 183 extern char *kobj_searchsym(struct module *, uintptr_t, ulong_t *); 184 185 extern int kobj_fstat(intptr_t, struct bootstat *); 186 extern intptr_t kobj_open(char *); 187 extern int kobj_path_exists(char *, int); 188 extern struct _buf *kobj_open_path(char *, int, int); 189 extern int kobj_read(intptr_t, char *, unsigned int, unsigned int); 190 extern void kobj_close(intptr_t); 191 extern void *kobj_alloc(size_t, int); 192 extern void *kobj_zalloc(size_t, int); 193 extern void kobj_free(void *, size_t); 194 extern struct _buf *kobj_open_file(char *); 195 extern void kobj_close_file(struct _buf *); 196 extern int kobj_read_file(struct _buf *, char *, unsigned, unsigned); 197 extern int kobj_get_filesize(struct _buf *, uint64_t *size); 198 extern uintptr_t kobj_getelfsym(char *, void *, int *); 199 extern void kobj_set_ctf(struct module *, caddr_t data, size_t size); 200 extern void do_hotinlines(struct module *); 201 202 extern int kobj_filbuf(struct _buf *); 203 extern void kobj_sync(void); 204 #if defined(__i386) || defined(__sparc) || defined(__amd64) 205 extern void kobj_vmem_init(vmem_t **, vmem_t **); 206 #else 207 #error "ISA not supported" 208 #endif 209 extern caddr_t kobj_text_alloc(vmem_t *, size_t); 210 extern caddr_t kobj_texthole_alloc(caddr_t, size_t); 211 extern void kobj_texthole_free(caddr_t, size_t); 212 extern void kobj_stat_get(kobj_stat_t *); 213 extern void kobj_textwin_alloc(struct module *); 214 extern void kobj_textwin_free(struct module *); 215 extern void kobj_printf(char *, ...) __KPRINTFLIKE(1); 216 217 #endif /* defined(_KERNEL) || defined(_FAKE_KERNEL) */ 218 219 #ifdef __cplusplus 220 } 221 #endif 222 223 #endif /* !_SYS_KOBJ_H */ 224