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 */
27 /*
28 * Copyright (c) 2017 Joyent, Inc.
29 */
30
31 #ifndef _SYS_KOBJ_H
32 #define _SYS_KOBJ_H
33
34 #include <sys/modctl.h>
35 #include <sys/elf.h>
36 #include <sys/machelf.h>
37 #include <sys/vmem.h>
38 #include <sys/sdt.h>
39 #include <sys/bootstat.h>
40
41 #ifdef __cplusplus
42 extern "C" {
43 #endif
44
45 /*
46 * List of modules maintained by kobj.c
47 */
48 struct module_list {
49 struct module_list *next;
50 struct module *mp;
51 };
52
53 typedef struct hotinline_desc {
54 char *hid_symname; /* symbol name */
55 uintptr_t hid_instr_offset; /* offset of call in text */
56 struct hotinline_desc *hid_next; /* next hotinline */
57 } hotinline_desc_t;
58
59 typedef unsigned short symid_t; /* symbol table index */
60 typedef unsigned char *reloc_dest_t;
61
62 typedef void module_mach;
63
64 struct module {
65 int total_allocated;
66
67 Ehdr hdr;
68 char *shdrs;
69 Shdr *symhdr, *strhdr;
70
71 char *depends_on;
72
73 size_t symsize;
74 char *symspace; /* symbols + strings + hashtbl, or NULL */
75 int flags;
76
77 size_t text_size;
78 size_t data_size;
79 char *text;
80 char *data;
81
82 unsigned int symtbl_section;
83 /* pointers into symspace, or NULL */
84 char *symtbl;
85 char *strings;
86
87 unsigned int hashsize;
88 symid_t *buckets;
89 symid_t *chains;
90
91 unsigned int nsyms;
92
93 unsigned int bss_align;
94 size_t bss_size;
95 uintptr_t bss;
96
97 char *filename;
98
99 struct module_list *head, *tail;
100 reloc_dest_t destination;
101 module_mach * machdata;
102 char *ctfdata;
103 size_t ctfsize;
104
105 char *fbt_tab;
106 size_t fbt_size;
107 size_t fbt_nentries;
108 caddr_t textwin;
109 caddr_t textwin_base;
110
111 hotinline_desc_t *hi_calls;
112
113 sdt_probedesc_t *sdt_probes;
114 size_t sdt_nprobes;
115 char *sdt_tab;
116 size_t sdt_size;
117
118 char *sigdata;
119 size_t sigsize;
120 };
121
122 struct kobj_mem {
123 struct kobj_mem *km_next;
124 struct kobj_mem *km_prev;
125 uintptr_t km_addr;
126 size_t km_size;
127 uintptr_t km_alloc_addr;
128 size_t km_alloc_size;
129 };
130
131 struct _buf {
132 intptr_t _fd;
133 char *_ptr;
134 char *_base;
135 char *_name;
136 char *_dbuf;
137 int _size;
138 int _cnt;
139 int _off;
140 int _ln;
141 int _bsize;
142 int _iscmp;
143 int _dsize;
144 };
145
146
147 /*
148 * Statistical info.
149 */
150 typedef struct {
151 int nalloc;
152 int nfree;
153 int nalloc_calls;
154 int nfree_calls;
155 } kobj_stat_t;
156
157 #define kobj_filename(p) ((p)->_name)
158 #define kobj_linenum(p) ((p)->_ln)
159 #define kobj_newline(p) ((p)->_ln++)
160 #define kobj_getc(p) (--(p)->_cnt >= 0 ? ((int)*(p)->_ptr++):kobj_filbuf(p))
161 #define kobj_ungetc(p) (++(p)->_cnt > (p)->_size ? -1 : ((int)*(--(p)->_ptr)))
162 #define kobj_comphdr(p) ((struct comphdr *)(p)->_dbuf)
163
164 /* Offset into buffer */
165 #define B_OFFSET(file, off) (off % (file)->_bsize)
166
167 /* Start of page */
168 #define F_PAGE(file, off) (off - B_OFFSET(file, off))
169
170 #define F_BLKS(file, size) ((size / (file)->_bsize) * (file)->_bsize)
171
172 #if defined(_KERNEL) || defined(_FAKE_KERNEL)
173
174 extern int kobj_load_module(struct modctl *, int);
175 extern void kobj_unload_module(struct modctl *);
176 extern uintptr_t kobj_lookup(struct module *, const char *);
177 extern Sym *kobj_lookup_all(struct module *, char *, int);
178 extern int kobj_addrcheck(void *, caddr_t);
179 extern int kobj_module_to_id(void *);
180 extern void kobj_getmodinfo(void *, struct modinfo *);
181 extern int kobj_get_needed(void *, short *, int);
182 extern uintptr_t kobj_getsymvalue(char *, int);
183 extern char *kobj_getsymname(uintptr_t, ulong_t *);
184 extern char *kobj_searchsym(struct module *, uintptr_t, ulong_t *);
185
186 extern int kobj_fstat(intptr_t, struct bootstat *);
187 extern intptr_t kobj_open(char *);
188 extern int kobj_path_exists(char *, int);
189 extern struct _buf *kobj_open_path(char *, int, int);
190 extern int kobj_read(intptr_t, char *, unsigned int, unsigned int);
191 extern void kobj_close(intptr_t);
192 extern void *kobj_alloc(size_t, int);
193 extern void *kobj_zalloc(size_t, int);
194 extern void kobj_free(void *, size_t);
195 extern struct _buf *kobj_open_file(char *);
196 extern void kobj_close_file(struct _buf *);
197 extern int kobj_read_file(struct _buf *, char *, unsigned, unsigned);
198 extern int kobj_get_filesize(struct _buf *, uint64_t *size);
199 extern uintptr_t kobj_getelfsym(char *, void *, int *);
200 extern void kobj_set_ctf(struct module *, caddr_t data, size_t size);
201 extern void do_hotinlines(struct module *);
202
203 extern int kobj_filbuf(struct _buf *);
204 extern void kobj_sync(void);
205 #if defined(__i386) || defined(__sparc) || defined(__amd64)
206 extern void kobj_vmem_init(vmem_t **, vmem_t **);
207 #else
208 #error "ISA not supported"
209 #endif
210 extern caddr_t kobj_text_alloc(vmem_t *, size_t);
211 extern caddr_t kobj_texthole_alloc(caddr_t, size_t);
212 extern void kobj_texthole_free(caddr_t, size_t);
213 extern void kobj_stat_get(kobj_stat_t *);
214 extern void kobj_textwin_alloc(struct module *);
215 extern void kobj_textwin_free(struct module *);
216
217 #endif /* defined(_KERNEL) || defined(_FAKE_KERNEL) */
218
219 #ifdef __cplusplus
220 }
221 #endif
222
223 #endif /* !_SYS_KOBJ_H */