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