xref: /netbsd/sys/rump/librump/rumpkern/emul.c (revision e4255408)
1 /*	$NetBSD: emul.c,v 1.193 2019/12/16 22:47:55 ad Exp $	*/
2 
3 /*
4  * Copyright (c) 2007-2011 Antti Kantee.  All Rights Reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
16  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
17  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18  * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
21  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  */
27 
28 #include <sys/cdefs.h>
29 __KERNEL_RCSID(0, "$NetBSD: emul.c,v 1.193 2019/12/16 22:47:55 ad Exp $");
30 
31 #include <sys/param.h>
32 #include <sys/cprng.h>
33 #include <sys/filedesc.h>
34 #include <sys/fstrans.h>
35 #include <sys/kauth.h>
36 #include <sys/module.h>
37 #include <sys/reboot.h>
38 #include <sys/syscall.h>
39 #include <sys/pserialize.h>
40 #ifdef LOCKDEBUG
41 #include <sys/sleepq.h>
42 #endif
43 
44 #include <dev/cons.h>
45 
46 #include <rump-sys/kern.h>
47 
48 #include <rump/rumpuser.h>
49 
50 void (*rump_vfs_fini)(void) = (void *)nullop;
51 
52 /*
53  * physmem is largely unused (except for nmbcluster calculations),
54  * so pick a default value which suits ZFS.  if an application wants
55  * a very small memory footprint, it can still adjust this before
56  * calling rump_init()
57  */
58 #define PHYSMEM 512*256
59 psize_t physmem = PHYSMEM;
60 int nkmempages = PHYSMEM/2; /* from le chapeau */
61 #undef PHYSMEM
62 
63 struct vnode *rootvp;
64 dev_t rootdev = NODEV;
65 
66 const int schedppq = 1;
67 struct timespec boottime;
68 int cold = 1;
69 int boothowto = AB_SILENT;
70 struct tty *constty;
71 
72 const struct bdevsw *bdevsw0[255];
73 const struct bdevsw **bdevsw = bdevsw0;
74 const int sys_cdevsws = 255;
75 int max_cdevsws = 255;
76 
77 const struct cdevsw *cdevsw0[255];
78 const struct cdevsw **cdevsw = cdevsw0;
79 const int sys_bdevsws = 255;
80 int max_bdevsws = 255;
81 
82 int mem_no = 2;
83 
84 device_t booted_device;
85 device_t booted_wedge;
86 int booted_partition;
87 const char *booted_method;
88 
89 /* XXX: unused */
90 kmutex_t tty_lock;
91 krwlock_t exec_lock;
92 
93 /* sparc doesn't sport constant page size, pretend we have 4k pages */
94 #ifdef __sparc__
95 int nbpg = 4096;
96 int pgofset = 4096-1;
97 int pgshift = 12;
98 #endif
99 
100 /* on sun3 VM_MAX_ADDRESS is a const variable */
101 /* XXX: should be moved into rump.c and initialize for sun3 and sun3x? */
102 #ifdef sun3
103 const vaddr_t kernbase = KERNBASE3;
104 #endif
105 
106 struct loadavg averunnable = {
107 	{ 0 * FSCALE,
108 	  1 * FSCALE,
109 	  11 * FSCALE, },
110 	FSCALE,
111 };
112 
113 /*
114  * Include the autogenerated list of auto-loadable syscalls
115  */
116 #include <kern/syscalls_autoload.c>
117 
118 struct emul emul_netbsd = {
119 	.e_name = "netbsd-rump",
120 	.e_sysent = rump_sysent,
121 	.e_nomodbits = rump_sysent_nomodbits,
122 #ifndef __HAVE_MINIMAL_EMUL
123 	.e_nsysent = SYS_NSYSENT,
124 #endif
125 	.e_vm_default_addr = uvm_default_mapaddr,
126 #ifdef __HAVE_SYSCALL_INTERN
127 	.e_syscall_intern = syscall_intern,
128 #endif
129 	.e_sc_autoload = netbsd_syscalls_autoload,
130 };
131 
132 cprng_strong_t *kern_cprng;
133 
134 /* not used, but need the symbols for pointer comparisons */
135 syncobj_t mutex_syncobj, rw_syncobj;
136 
137 int
138 kpause(const char *wmesg, bool intr, int timeo, kmutex_t *mtx)
139 {
140 	extern int hz;
141 	int rv __diagused;
142 	uint64_t sec, nsec;
143 
144 	if (mtx)
145 		mutex_exit(mtx);
146 
147 	sec = timeo / hz;
148 	nsec = (timeo % hz) * (1000000000 / hz);
149 	rv = rumpuser_clock_sleep(RUMPUSER_CLOCK_RELWALL, sec, nsec);
150 	KASSERT(rv == 0);
151 
152 	if (mtx)
153 		mutex_enter(mtx);
154 
155 	return 0;
156 }
157 
158 vaddr_t
159 calc_cache_size(vsize_t vasz, int pct, int va_pct)
160 {
161 	paddr_t t;
162 
163 	t = (paddr_t)physmem * pct / 100 * PAGE_SIZE;
164 	if ((vaddr_t)t != t) {
165 		panic("%s: needs tweak", __func__);
166 	}
167 	return t;
168 }
169 
170 #define	RETURN_ADDRESS	(uintptr_t)__builtin_return_address(0)
171 
172 void
173 assert_sleepable(void)
174 {
175 	const char *reason = NULL;
176 
177 	/* always sleepable, although we should improve this */
178 
179 	if (!pserialize_not_in_read_section()) {
180 		reason = "pserialize";
181 	}
182 
183 	if (reason) {
184 		panic("%s: %s caller=%p", __func__, reason,
185 		    (void *)RETURN_ADDRESS);
186 	}
187 }
188 
189 void
190 module_init_md(void)
191 {
192 
193 	/*
194 	 * Nothing for now.  However, we should load the librump
195 	 * symbol table.
196 	 */
197 }
198 
199 /*
200  * Try to emulate all the MD definitions of DELAY() / delay().
201  * Would be nice to fix the #defines in MD headers, but this quicker.
202  *
203  * XXX: we'd need a rumpuser_clock_sleep_nowrap() here.  Since we
204  * don't have it in the current hypercall revision, busyloop.
205  * Note that rather than calibrate a loop delay and work with that,
206  * get call gettime (which does not block) in a loop to make sure
207  * we didn't get virtual ghosttime.  That might be slightly inaccurate
208  * for very small delays ...
209  *
210  * The other option would be to run a thread in the hypervisor which
211  * sleeps for us and we can wait for it using rumpuser_cv_wait_nowrap()
212  * Probably too fussy.  Better just wait for hypercall rev 18 ;)
213  */
214 static void
215 rump_delay(unsigned int us)
216 {
217 	struct timespec target, tmp;
218 	uint64_t sec, sec_ini, sec_now;
219 	long nsec, nsec_ini, nsec_now;
220 	int loops;
221 
222 	rumpuser_clock_gettime(RUMPUSER_CLOCK_ABSMONO, &sec_ini, &nsec_ini);
223 
224 #ifdef __mac68k__
225 	sec = us / 1000;
226 	nsec = (us % 1000) * 1000000;
227 #else
228 	sec = us / 1000000;
229 	nsec = (us % 1000000) * 1000;
230 #endif
231 
232 	target.tv_sec = sec_ini;
233 	tmp.tv_sec = sec;
234 	target.tv_nsec = nsec_ini;
235 	tmp.tv_nsec = nsec;
236 	timespecadd(&target, &tmp, &target);
237 
238 	if (__predict_false(sec != 0))
239 		printf("WARNING: over 1s delay\n");
240 
241 	for (loops = 0; loops < 1000*1000*100; loops++) {
242 		struct timespec cur;
243 
244 		rumpuser_clock_gettime(RUMPUSER_CLOCK_ABSMONO,
245 		    &sec_now, &nsec_now);
246 		cur.tv_sec = sec_now;
247 		cur.tv_nsec = nsec_now;
248 		if (timespeccmp(&cur, &target, >=)) {
249 			return;
250 		}
251 	}
252 	printf("WARNING: DELAY ESCAPED\n");
253 }
254 void (*delay_func)(unsigned int) = rump_delay;
255 __strong_alias(delay,rump_delay);
256 __strong_alias(_delay,rump_delay);
257 
258 /* Weak alias for getcwd_common to be used unless librumpvfs is present. */
259 
260 int rump_getcwd_common(struct vnode *, struct vnode *, char **, char *,
261     int, int, struct lwp *);
262 int
263 rump_getcwd_common(struct vnode *lvp, struct vnode *rvp, char **bpp, char *bufp,
264     int limit, int flags, struct lwp *l)
265 {
266 
267 	return ENOENT;
268 }
269 __weak_alias(getcwd_common,rump_getcwd_common);
270 
271 /* Weak alias for vnode_to_path to be used unless librumpvfs is present. */
272 
273 int rump_vnode_to_path(char *, size_t, struct vnode *, struct lwp *,
274     struct proc *);
275 int
276 rump_vnode_to_path(char *path, size_t len, struct vnode *vp, struct lwp *curl,
277     struct proc *p)
278 {
279 
280 	return ENOENT; /* pretend getcwd_common() failed. */
281 }
282 __weak_alias(vnode_to_path,rump_vnode_to_path);
283 
284 
285 /* Weak aliases for fstrans to be used unless librumpvfs is present. */
286 
287 void rump_fstrans_start(struct mount *);
288 void
289 rump_fstrans_start(struct mount *mp)
290 {
291 
292 }
293 __weak_alias(fstrans_start,rump_fstrans_start);
294 
295 int rump_fstrans_start_nowait(struct mount *);
296 int
297 rump_fstrans_start_nowait(struct mount *mp)
298 {
299 
300 	return 0;
301 }
302 __weak_alias(fstrans_start_nowait,rump_fstrans_start_nowait);
303 
304 void rump_fstrans_start_lazy(struct mount *);
305 void
306 rump_fstrans_start_lazy(struct mount *mp)
307 {
308 
309 }
310 __weak_alias(fstrans_start_lazy,rump_fstrans_start_lazy);
311 
312 
313 void rump_fstrans_done(struct mount *);
314 void
315 rump_fstrans_done(struct mount *mp)
316 {
317 
318 }
319 __weak_alias(fstrans_done,rump_fstrans_done);
320 
321 
322 void rump_fstrans_lwp_dtor(struct lwp *);
323 void
324 rump_fstrans_lwp_dtor(struct lwp *l)
325 {
326 
327 }
328 __weak_alias(fstrans_lwp_dtor,rump_fstrans_lwp_dtor);
329 
330 /*
331  * Provide weak aliases for tty routines used by printf.
332  * They will be used unless the rumpkern_tty component is present.
333  */
334 
335 int rump_ttycheckoutq(struct tty *, int);
336 int
337 rump_ttycheckoutq(struct tty *tp, int wait)
338 {
339 
340 	return 1;
341 }
342 __weak_alias(ttycheckoutq,rump_ttycheckoutq);
343 
344 int rump_tputchar(int, int, struct tty *);
345 int
346 rump_tputchar(int c, int flags, struct tty *tp)
347 {
348 
349 	cnputc(c);
350 	return 0;
351 }
352 __weak_alias(tputchar,rump_tputchar);
353 
354 void
355 cnputc(int c)
356 {
357 
358 	rumpuser_putchar(c);
359 }
360 
361 void
362 cnflush(void)
363 {
364 
365 	/* done */
366 }
367 
368 void
369 resettodr(void)
370 {
371 
372 	/* setting clocks is not in the jurisdiction of rump kernels */
373 }
374 
375 #ifdef __HAVE_SYSCALL_INTERN
376 void
377 syscall_intern(struct proc *p)
378 {
379 
380 	p->p_emuldata = NULL;
381 }
382 #endif
383 
384 #ifdef LOCKDEBUG
385 void
386 turnstile_print(volatile void *obj, void (*pr)(const char *, ...))
387 {
388 
389 	/* nada */
390 }
391 #endif
392 
393 void
394 cpu_reboot(int howto, char *bootstr)
395 {
396 	int ruhow = 0;
397 	void *finiarg;
398 
399 	printf("rump kernel halting...\n");
400 
401 	if (!RUMP_LOCALPROC_P(curproc))
402 		finiarg = RUMP_SPVM2CTL(curproc->p_vmspace);
403 	else
404 		finiarg = NULL;
405 
406 	/* dump means we really take the dive here */
407 	if ((howto & RB_DUMP) || panicstr) {
408 		ruhow = RUMPUSER_PANIC;
409 		goto out;
410 	}
411 
412 	/* try to sync */
413 	if (!((howto & RB_NOSYNC) || panicstr)) {
414 		rump_vfs_fini();
415 	}
416 
417 	doshutdownhooks();
418 
419 	/* your wish is my command */
420 	if (howto & RB_HALT) {
421 		printf("rump kernel halted (with RB_HALT, not exiting)\n");
422 		rump_sysproxy_fini(finiarg);
423 		for (;;) {
424 			rumpuser_clock_sleep(RUMPUSER_CLOCK_RELWALL, 10, 0);
425 		}
426 	}
427 
428 	/* this function is __dead, we must exit */
429  out:
430 	rump_sysproxy_fini(finiarg);
431 	rumpuser_exit(ruhow);
432 }
433