kern_subr.c revision 1.126 1 /* $NetBSD: kern_subr.c,v 1.126 2006/03/01 12:38:21 yamt Exp $ */
2
3 /*-
4 * Copyright (c) 1997, 1998, 1999, 2002 The NetBSD Foundation, Inc.
5 * All rights reserved.
6 *
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
9 * NASA Ames Research Center, and by Luke Mewburn.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 * 3. All advertising materials mentioning features or use of this software
20 * must display the following acknowledgement:
21 * This product includes software developed by the NetBSD
22 * Foundation, Inc. and its contributors.
23 * 4. Neither the name of The NetBSD Foundation nor the names of its
24 * contributors may be used to endorse or promote products derived
25 * from this software without specific prior written permission.
26 *
27 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
28 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
29 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
31 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
32 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
33 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
34 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
35 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
36 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
37 * POSSIBILITY OF SUCH DAMAGE.
38 */
39
40 /*
41 * Copyright (c) 1982, 1986, 1991, 1993
42 * The Regents of the University of California. All rights reserved.
43 * (c) UNIX System Laboratories, Inc.
44 * All or some portions of this file are derived from material licensed
45 * to the University of California by American Telephone and Telegraph
46 * Co. or Unix System Laboratories, Inc. and are reproduced herein with
47 * the permission of UNIX System Laboratories, Inc.
48 *
49 * Copyright (c) 1992, 1993
50 * The Regents of the University of California. All rights reserved.
51 *
52 * This software was developed by the Computer Systems Engineering group
53 * at Lawrence Berkeley Laboratory under DARPA contract BG 91-66 and
54 * contributed to Berkeley.
55 *
56 * All advertising materials mentioning features or use of this software
57 * must display the following acknowledgement:
58 * This product includes software developed by the University of
59 * California, Lawrence Berkeley Laboratory.
60 *
61 * Redistribution and use in source and binary forms, with or without
62 * modification, are permitted provided that the following conditions
63 * are met:
64 * 1. Redistributions of source code must retain the above copyright
65 * notice, this list of conditions and the following disclaimer.
66 * 2. Redistributions in binary form must reproduce the above copyright
67 * notice, this list of conditions and the following disclaimer in the
68 * documentation and/or other materials provided with the distribution.
69 * 3. Neither the name of the University nor the names of its contributors
70 * may be used to endorse or promote products derived from this software
71 * without specific prior written permission.
72 *
73 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
74 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
75 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
76 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
77 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
78 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
79 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
80 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
81 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
82 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
83 * SUCH DAMAGE.
84 *
85 * @(#)kern_subr.c 8.4 (Berkeley) 2/14/95
86 */
87
88 #include <sys/cdefs.h>
89 __KERNEL_RCSID(0, "$NetBSD: kern_subr.c,v 1.126 2006/03/01 12:38:21 yamt Exp $");
90
91 #include "opt_ddb.h"
92 #include "opt_md.h"
93 #include "opt_syscall_debug.h"
94 #include "opt_ktrace.h"
95 #include "opt_systrace.h"
96
97 #include <sys/param.h>
98 #include <sys/systm.h>
99 #include <sys/proc.h>
100 #include <sys/malloc.h>
101 #include <sys/mount.h>
102 #include <sys/device.h>
103 #include <sys/reboot.h>
104 #include <sys/conf.h>
105 #include <sys/disklabel.h>
106 #include <sys/queue.h>
107 #include <sys/systrace.h>
108 #include <sys/ktrace.h>
109 #include <sys/fcntl.h>
110
111 #include <uvm/uvm_extern.h>
112
113 #include <dev/cons.h>
114
115 #include <net/if.h>
116
117 /* XXX these should eventually move to subr_autoconf.c */
118 static struct device *finddevice(const char *);
119 static struct device *getdisk(char *, int, int, dev_t *, int);
120 static struct device *parsedisk(char *, int, int, dev_t *);
121
122 /*
123 * A generic linear hook.
124 */
125 struct hook_desc {
126 LIST_ENTRY(hook_desc) hk_list;
127 void (*hk_fn)(void *);
128 void *hk_arg;
129 };
130 typedef LIST_HEAD(, hook_desc) hook_list_t;
131
132 MALLOC_DEFINE(M_IOV, "iov", "large iov's");
133
134 void
135 uio_setup_sysspace(struct uio *uio)
136 {
137
138 uio->uio_vmspace = vmspace_kernel();
139 }
140
141 int
142 uiomove(void *buf, size_t n, struct uio *uio)
143 {
144 struct vmspace *vm = uio->uio_vmspace;
145 struct iovec *iov;
146 u_int cnt;
147 int error = 0;
148 char *cp = buf;
149 int hold_count;
150
151 hold_count = KERNEL_LOCK_RELEASE_ALL();
152
153 #ifdef LOCKDEBUG
154 spinlock_switchcheck();
155 simple_lock_only_held(NULL, "uiomove");
156 #endif
157
158 #ifdef DIAGNOSTIC
159 if (uio->uio_rw != UIO_READ && uio->uio_rw != UIO_WRITE)
160 panic("uiomove: mode");
161 #endif
162 while (n > 0 && uio->uio_resid) {
163 iov = uio->uio_iov;
164 cnt = iov->iov_len;
165 if (cnt == 0) {
166 KASSERT(uio->uio_iovcnt > 0);
167 uio->uio_iov++;
168 uio->uio_iovcnt--;
169 continue;
170 }
171 if (cnt > n)
172 cnt = n;
173 if (!VMSPACE_IS_KERNEL_P(vm)) {
174 if (curcpu()->ci_schedstate.spc_flags &
175 SPCF_SHOULDYIELD)
176 preempt(1);
177 }
178
179 if (uio->uio_rw == UIO_READ) {
180 error = copyout_vmspace(vm, cp, iov->iov_base,
181 cnt);
182 } else {
183 error = copyin_vmspace(vm, iov->iov_base, cp,
184 cnt);
185 }
186 if (error) {
187 break;
188 }
189 iov->iov_base = (caddr_t)iov->iov_base + cnt;
190 iov->iov_len -= cnt;
191 uio->uio_resid -= cnt;
192 uio->uio_offset += cnt;
193 cp += cnt;
194 KDASSERT(cnt <= n);
195 n -= cnt;
196 }
197 KERNEL_LOCK_ACQUIRE_COUNT(hold_count);
198 return (error);
199 }
200
201 /*
202 * Wrapper for uiomove() that validates the arguments against a known-good
203 * kernel buffer.
204 */
205 int
206 uiomove_frombuf(void *buf, size_t buflen, struct uio *uio)
207 {
208 size_t offset;
209
210 if (uio->uio_offset < 0 || uio->uio_resid < 0 ||
211 (offset = uio->uio_offset) != uio->uio_offset)
212 return (EINVAL);
213 if (offset >= buflen)
214 return (0);
215 return (uiomove((char *)buf + offset, buflen - offset, uio));
216 }
217
218 /*
219 * Give next character to user as result of read.
220 */
221 int
222 ureadc(int c, struct uio *uio)
223 {
224 struct iovec *iov;
225
226 if (uio->uio_resid <= 0)
227 panic("ureadc: non-positive resid");
228 again:
229 if (uio->uio_iovcnt <= 0)
230 panic("ureadc: non-positive iovcnt");
231 iov = uio->uio_iov;
232 if (iov->iov_len <= 0) {
233 uio->uio_iovcnt--;
234 uio->uio_iov++;
235 goto again;
236 }
237 if (!VMSPACE_IS_KERNEL_P(uio->uio_vmspace)) {
238 if (subyte(iov->iov_base, c) < 0)
239 return (EFAULT);
240 } else {
241 *(char *)iov->iov_base = c;
242 }
243 iov->iov_base = (caddr_t)iov->iov_base + 1;
244 iov->iov_len--;
245 uio->uio_resid--;
246 uio->uio_offset++;
247 return (0);
248 }
249
250 /*
251 * Like copyin(), but operates on an arbitrary vmspace.
252 */
253 int
254 copyin_vmspace(struct vmspace *vm, const void *uaddr, void *kaddr, size_t len)
255 {
256 struct iovec iov;
257 struct uio uio;
258 int error;
259
260 if (len == 0)
261 return (0);
262
263 if (VMSPACE_IS_KERNEL_P(vm)) {
264 return kcopy(uaddr, kaddr, len);
265 }
266 if (__predict_true(vm == curproc->p_vmspace)) {
267 return copyin(uaddr, kaddr, len);
268 }
269
270 iov.iov_base = kaddr;
271 iov.iov_len = len;
272 uio.uio_iov = &iov;
273 uio.uio_iovcnt = 1;
274 uio.uio_offset = (off_t)(intptr_t)uaddr;
275 uio.uio_resid = len;
276 uio.uio_rw = UIO_READ;
277 uio.uio_vmspace = vm;
278 error = uvm_io(&vm->vm_map, &uio);
279
280 return (error);
281 }
282
283 /*
284 * Like copyout(), but operates on an arbitrary vmspace.
285 */
286 int
287 copyout_vmspace(struct vmspace *vm, const void *kaddr, void *uaddr, size_t len)
288 {
289 struct iovec iov;
290 struct uio uio;
291 int error;
292
293 if (len == 0)
294 return (0);
295
296 if (VMSPACE_IS_KERNEL_P(vm)) {
297 return kcopy(kaddr, uaddr, len);
298 }
299 if (__predict_true(vm == curproc->p_vmspace)) {
300 return copyout(kaddr, uaddr, len);
301 }
302
303 iov.iov_base = __UNCONST(kaddr); /* XXXUNCONST cast away const */
304 iov.iov_len = len;
305 uio.uio_iov = &iov;
306 uio.uio_iovcnt = 1;
307 uio.uio_offset = (off_t)(intptr_t)uaddr;
308 uio.uio_resid = len;
309 uio.uio_rw = UIO_WRITE;
310 uio.uio_vmspace = vm;
311 error = uvm_io(&vm->vm_map, &uio);
312
313 return (error);
314 }
315
316 /*
317 * Like copyin(), but operates on an arbitrary process.
318 */
319 int
320 copyin_proc(struct proc *p, const void *uaddr, void *kaddr, size_t len)
321 {
322 struct vmspace *vm;
323 int error;
324
325 error = proc_vmspace_getref(p, &vm);
326 if (error) {
327 return error;
328 }
329 error = copyin_vmspace(vm, uaddr, kaddr, len);
330 uvmspace_free(vm);
331
332 return error;
333 }
334
335 /*
336 * Like copyout(), but operates on an arbitrary process.
337 */
338 int
339 copyout_proc(struct proc *p, const void *kaddr, void *uaddr, size_t len)
340 {
341 struct vmspace *vm;
342 int error;
343
344 error = proc_vmspace_getref(p, &vm);
345 if (error) {
346 return error;
347 }
348 error = copyin_vmspace(vm, kaddr, uaddr, len);
349 uvmspace_free(vm);
350
351 return error;
352 }
353
354 /*
355 * Like copyin(), except it operates on kernel addresses when the FKIOCTL
356 * flag is passed in `ioctlflags' from the ioctl call.
357 */
358 int
359 ioctl_copyin(int ioctlflags, const void *src, void *dst, size_t len)
360 {
361 if (ioctlflags & FKIOCTL)
362 return kcopy(src, dst, len);
363 return copyin(src, dst, len);
364 }
365
366 /*
367 * Like copyout(), except it operates on kernel addresses when the FKIOCTL
368 * flag is passed in `ioctlflags' from the ioctl call.
369 */
370 int
371 ioctl_copyout(int ioctlflags, const void *src, void *dst, size_t len)
372 {
373 if (ioctlflags & FKIOCTL)
374 return kcopy(src, dst, len);
375 return copyout(src, dst, len);
376 }
377
378 /*
379 * General routine to allocate a hash table.
380 * Allocate enough memory to hold at least `elements' list-head pointers.
381 * Return a pointer to the allocated space and set *hashmask to a pattern
382 * suitable for masking a value to use as an index into the returned array.
383 */
384 void *
385 hashinit(u_int elements, enum hashtype htype, struct malloc_type *mtype,
386 int mflags, u_long *hashmask)
387 {
388 u_long hashsize, i;
389 LIST_HEAD(, generic) *hashtbl_list;
390 TAILQ_HEAD(, generic) *hashtbl_tailq;
391 size_t esize;
392 void *p;
393
394 if (elements == 0)
395 panic("hashinit: bad cnt");
396 for (hashsize = 1; hashsize < elements; hashsize <<= 1)
397 continue;
398
399 switch (htype) {
400 case HASH_LIST:
401 esize = sizeof(*hashtbl_list);
402 break;
403 case HASH_TAILQ:
404 esize = sizeof(*hashtbl_tailq);
405 break;
406 default:
407 #ifdef DIAGNOSTIC
408 panic("hashinit: invalid table type");
409 #else
410 return NULL;
411 #endif
412 }
413
414 if ((p = malloc(hashsize * esize, mtype, mflags)) == NULL)
415 return (NULL);
416
417 switch (htype) {
418 case HASH_LIST:
419 hashtbl_list = p;
420 for (i = 0; i < hashsize; i++)
421 LIST_INIT(&hashtbl_list[i]);
422 break;
423 case HASH_TAILQ:
424 hashtbl_tailq = p;
425 for (i = 0; i < hashsize; i++)
426 TAILQ_INIT(&hashtbl_tailq[i]);
427 break;
428 }
429 *hashmask = hashsize - 1;
430 return (p);
431 }
432
433 /*
434 * Free memory from hash table previosly allocated via hashinit().
435 */
436 void
437 hashdone(void *hashtbl, struct malloc_type *mtype)
438 {
439
440 free(hashtbl, mtype);
441 }
442
443
444 static void *
445 hook_establish(hook_list_t *list, void (*fn)(void *), void *arg)
446 {
447 struct hook_desc *hd;
448
449 hd = malloc(sizeof(*hd), M_DEVBUF, M_NOWAIT);
450 if (hd == NULL)
451 return (NULL);
452
453 hd->hk_fn = fn;
454 hd->hk_arg = arg;
455 LIST_INSERT_HEAD(list, hd, hk_list);
456
457 return (hd);
458 }
459
460 static void
461 hook_disestablish(hook_list_t *list, void *vhook)
462 {
463 #ifdef DIAGNOSTIC
464 struct hook_desc *hd;
465
466 LIST_FOREACH(hd, list, hk_list) {
467 if (hd == vhook)
468 break;
469 }
470
471 if (hd == NULL)
472 panic("hook_disestablish: hook %p not established", vhook);
473 #endif
474 LIST_REMOVE((struct hook_desc *)vhook, hk_list);
475 free(vhook, M_DEVBUF);
476 }
477
478 static void
479 hook_destroy(hook_list_t *list)
480 {
481 struct hook_desc *hd;
482
483 while ((hd = LIST_FIRST(list)) != NULL) {
484 LIST_REMOVE(hd, hk_list);
485 free(hd, M_DEVBUF);
486 }
487 }
488
489 static void
490 hook_proc_run(hook_list_t *list, struct proc *p)
491 {
492 struct hook_desc *hd;
493
494 for (hd = LIST_FIRST(list); hd != NULL; hd = LIST_NEXT(hd, hk_list)) {
495 ((void (*)(struct proc *, void *))*hd->hk_fn)(p,
496 hd->hk_arg);
497 }
498 }
499
500 /*
501 * "Shutdown hook" types, functions, and variables.
502 *
503 * Should be invoked immediately before the
504 * system is halted or rebooted, i.e. after file systems unmounted,
505 * after crash dump done, etc.
506 *
507 * Each shutdown hook is removed from the list before it's run, so that
508 * it won't be run again.
509 */
510
511 static hook_list_t shutdownhook_list;
512
513 void *
514 shutdownhook_establish(void (*fn)(void *), void *arg)
515 {
516 return hook_establish(&shutdownhook_list, fn, arg);
517 }
518
519 void
520 shutdownhook_disestablish(void *vhook)
521 {
522 hook_disestablish(&shutdownhook_list, vhook);
523 }
524
525 /*
526 * Run shutdown hooks. Should be invoked immediately before the
527 * system is halted or rebooted, i.e. after file systems unmounted,
528 * after crash dump done, etc.
529 *
530 * Each shutdown hook is removed from the list before it's run, so that
531 * it won't be run again.
532 */
533 void
534 doshutdownhooks(void)
535 {
536 struct hook_desc *dp;
537
538 while ((dp = LIST_FIRST(&shutdownhook_list)) != NULL) {
539 LIST_REMOVE(dp, hk_list);
540 (*dp->hk_fn)(dp->hk_arg);
541 #if 0
542 /*
543 * Don't bother freeing the hook structure,, since we may
544 * be rebooting because of a memory corruption problem,
545 * and this might only make things worse. It doesn't
546 * matter, anyway, since the system is just about to
547 * reboot.
548 */
549 free(dp, M_DEVBUF);
550 #endif
551 }
552 }
553
554 /*
555 * "Mountroot hook" types, functions, and variables.
556 */
557
558 static hook_list_t mountroothook_list;
559
560 void *
561 mountroothook_establish(void (*fn)(struct device *), struct device *dev)
562 {
563 return hook_establish(&mountroothook_list, (void (*)(void *))fn, dev);
564 }
565
566 void
567 mountroothook_disestablish(void *vhook)
568 {
569 hook_disestablish(&mountroothook_list, vhook);
570 }
571
572 void
573 mountroothook_destroy(void)
574 {
575 hook_destroy(&mountroothook_list);
576 }
577
578 void
579 domountroothook(void)
580 {
581 struct hook_desc *hd;
582
583 LIST_FOREACH(hd, &mountroothook_list, hk_list) {
584 if (hd->hk_arg == (void *)root_device) {
585 (*hd->hk_fn)(hd->hk_arg);
586 return;
587 }
588 }
589 }
590
591 static hook_list_t exechook_list;
592
593 void *
594 exechook_establish(void (*fn)(struct proc *, void *), void *arg)
595 {
596 return hook_establish(&exechook_list, (void (*)(void *))fn, arg);
597 }
598
599 void
600 exechook_disestablish(void *vhook)
601 {
602 hook_disestablish(&exechook_list, vhook);
603 }
604
605 /*
606 * Run exec hooks.
607 */
608 void
609 doexechooks(struct proc *p)
610 {
611 hook_proc_run(&exechook_list, p);
612 }
613
614 static hook_list_t exithook_list;
615
616 void *
617 exithook_establish(void (*fn)(struct proc *, void *), void *arg)
618 {
619 return hook_establish(&exithook_list, (void (*)(void *))fn, arg);
620 }
621
622 void
623 exithook_disestablish(void *vhook)
624 {
625 hook_disestablish(&exithook_list, vhook);
626 }
627
628 /*
629 * Run exit hooks.
630 */
631 void
632 doexithooks(struct proc *p)
633 {
634 hook_proc_run(&exithook_list, p);
635 }
636
637 static hook_list_t forkhook_list;
638
639 void *
640 forkhook_establish(void (*fn)(struct proc *, struct proc *))
641 {
642 return hook_establish(&forkhook_list, (void (*)(void *))fn, NULL);
643 }
644
645 void
646 forkhook_disestablish(void *vhook)
647 {
648 hook_disestablish(&forkhook_list, vhook);
649 }
650
651 /*
652 * Run fork hooks.
653 */
654 void
655 doforkhooks(struct proc *p2, struct proc *p1)
656 {
657 struct hook_desc *hd;
658
659 LIST_FOREACH(hd, &forkhook_list, hk_list) {
660 ((void (*)(struct proc *, struct proc *))*hd->hk_fn)
661 (p2, p1);
662 }
663 }
664
665 /*
666 * "Power hook" types, functions, and variables.
667 * The list of power hooks is kept ordered with the last registered hook
668 * first.
669 * When running the hooks on power down the hooks are called in reverse
670 * registration order, when powering up in registration order.
671 */
672 struct powerhook_desc {
673 CIRCLEQ_ENTRY(powerhook_desc) sfd_list;
674 void (*sfd_fn)(int, void *);
675 void *sfd_arg;
676 };
677
678 static CIRCLEQ_HEAD(, powerhook_desc) powerhook_list =
679 CIRCLEQ_HEAD_INITIALIZER(powerhook_list);
680
681 void *
682 powerhook_establish(void (*fn)(int, void *), void *arg)
683 {
684 struct powerhook_desc *ndp;
685
686 ndp = (struct powerhook_desc *)
687 malloc(sizeof(*ndp), M_DEVBUF, M_NOWAIT);
688 if (ndp == NULL)
689 return (NULL);
690
691 ndp->sfd_fn = fn;
692 ndp->sfd_arg = arg;
693 CIRCLEQ_INSERT_HEAD(&powerhook_list, ndp, sfd_list);
694
695 return (ndp);
696 }
697
698 void
699 powerhook_disestablish(void *vhook)
700 {
701 #ifdef DIAGNOSTIC
702 struct powerhook_desc *dp;
703
704 CIRCLEQ_FOREACH(dp, &powerhook_list, sfd_list)
705 if (dp == vhook)
706 goto found;
707 panic("powerhook_disestablish: hook %p not established", vhook);
708 found:
709 #endif
710
711 CIRCLEQ_REMOVE(&powerhook_list, (struct powerhook_desc *)vhook,
712 sfd_list);
713 free(vhook, M_DEVBUF);
714 }
715
716 /*
717 * Run power hooks.
718 */
719 void
720 dopowerhooks(int why)
721 {
722 struct powerhook_desc *dp;
723
724 if (why == PWR_RESUME || why == PWR_SOFTRESUME) {
725 CIRCLEQ_FOREACH_REVERSE(dp, &powerhook_list, sfd_list) {
726 (*dp->sfd_fn)(why, dp->sfd_arg);
727 }
728 } else {
729 CIRCLEQ_FOREACH(dp, &powerhook_list, sfd_list) {
730 (*dp->sfd_fn)(why, dp->sfd_arg);
731 }
732 }
733 }
734
735 /*
736 * Determine the root device and, if instructed to, the root file system.
737 */
738
739 #include "md.h"
740 #if NMD == 0
741 #undef MEMORY_DISK_HOOKS
742 #endif
743
744 #ifdef MEMORY_DISK_HOOKS
745 static struct device fakemdrootdev[NMD];
746 #endif
747
748 #ifdef MEMORY_DISK_IS_ROOT
749 #define BOOT_FROM_MEMORY_HOOKS 1
750 #endif
751
752 #include "raid.h"
753 #if NRAID == 1
754 #define BOOT_FROM_RAID_HOOKS 1
755 #endif
756
757 #ifdef BOOT_FROM_RAID_HOOKS
758 extern int numraid;
759 extern struct device *raidrootdev;
760 #endif
761
762 /*
763 * The device and wedge that we booted from. If booted_wedge is NULL,
764 * the we might consult booted_partition.
765 */
766 struct device *booted_device;
767 struct device *booted_wedge;
768 int booted_partition;
769
770 /*
771 * Use partition letters if it's a disk class but not a wedge.
772 * XXX Check for wedge is kinda gross.
773 */
774 #define DEV_USES_PARTITIONS(dv) \
775 (device_class((dv)) == DV_DISK && \
776 !device_is_a((dv), "dk"))
777
778 void
779 setroot(struct device *bootdv, int bootpartition)
780 {
781 struct device *dv;
782 int len;
783 #ifdef MEMORY_DISK_HOOKS
784 int i;
785 #endif
786 dev_t nrootdev;
787 dev_t ndumpdev = NODEV;
788 char buf[128];
789 const char *rootdevname;
790 const char *dumpdevname;
791 struct device *rootdv = NULL; /* XXX gcc -Wuninitialized */
792 struct device *dumpdv = NULL;
793 struct ifnet *ifp;
794 const char *deffsname;
795 struct vfsops *vops;
796
797 #ifdef MEMORY_DISK_HOOKS
798 for (i = 0; i < NMD; i++) {
799 fakemdrootdev[i].dv_class = DV_DISK;
800 fakemdrootdev[i].dv_cfdata = NULL;
801 fakemdrootdev[i].dv_unit = i;
802 fakemdrootdev[i].dv_parent = NULL;
803 snprintf(fakemdrootdev[i].dv_xname,
804 sizeof(fakemdrootdev[i].dv_xname), "md%d", i);
805 }
806 #endif /* MEMORY_DISK_HOOKS */
807
808 #ifdef MEMORY_DISK_IS_ROOT
809 bootdv = &fakemdrootdev[0];
810 bootpartition = 0;
811 #endif
812
813 /*
814 * If NFS is specified as the file system, and we found
815 * a DV_DISK boot device (or no boot device at all), then
816 * find a reasonable network interface for "rootspec".
817 */
818 vops = vfs_getopsbyname("nfs");
819 if (vops != NULL && vops->vfs_mountroot == mountroot &&
820 rootspec == NULL &&
821 (bootdv == NULL || device_class(bootdv) != DV_IFNET)) {
822 IFNET_FOREACH(ifp) {
823 if ((ifp->if_flags &
824 (IFF_LOOPBACK|IFF_POINTOPOINT)) == 0)
825 break;
826 }
827 if (ifp == NULL) {
828 /*
829 * Can't find a suitable interface; ask the
830 * user.
831 */
832 boothowto |= RB_ASKNAME;
833 } else {
834 /*
835 * Have a suitable interface; behave as if
836 * the user specified this interface.
837 */
838 rootspec = (const char *)ifp->if_xname;
839 }
840 }
841
842 /*
843 * If wildcarded root and we the boot device wasn't determined,
844 * ask the user.
845 */
846 if (rootspec == NULL && bootdv == NULL)
847 boothowto |= RB_ASKNAME;
848
849 top:
850 if (boothowto & RB_ASKNAME) {
851 struct device *defdumpdv;
852
853 for (;;) {
854 printf("root device");
855 if (bootdv != NULL) {
856 printf(" (default %s", bootdv->dv_xname);
857 if (DEV_USES_PARTITIONS(bootdv))
858 printf("%c", bootpartition + 'a');
859 printf(")");
860 }
861 printf(": ");
862 len = cngetsn(buf, sizeof(buf));
863 if (len == 0 && bootdv != NULL) {
864 strlcpy(buf, bootdv->dv_xname, sizeof(buf));
865 len = strlen(buf);
866 }
867 if (len > 0 && buf[len - 1] == '*') {
868 buf[--len] = '\0';
869 dv = getdisk(buf, len, 1, &nrootdev, 0);
870 if (dv != NULL) {
871 rootdv = dv;
872 break;
873 }
874 }
875 dv = getdisk(buf, len, bootpartition, &nrootdev, 0);
876 if (dv != NULL) {
877 rootdv = dv;
878 break;
879 }
880 }
881
882 /*
883 * Set up the default dump device. If root is on
884 * a network device, there is no default dump
885 * device, since we don't support dumps to the
886 * network.
887 */
888 if (DEV_USES_PARTITIONS(rootdv) == 0)
889 defdumpdv = NULL;
890 else
891 defdumpdv = rootdv;
892
893 for (;;) {
894 printf("dump device");
895 if (defdumpdv != NULL) {
896 /*
897 * Note, we know it's a disk if we get here.
898 */
899 printf(" (default %sb)", defdumpdv->dv_xname);
900 }
901 printf(": ");
902 len = cngetsn(buf, sizeof(buf));
903 if (len == 0) {
904 if (defdumpdv != NULL) {
905 ndumpdev = MAKEDISKDEV(major(nrootdev),
906 DISKUNIT(nrootdev), 1);
907 }
908 dumpdv = defdumpdv;
909 break;
910 }
911 if (len == 4 && strcmp(buf, "none") == 0) {
912 dumpdv = NULL;
913 break;
914 }
915 dv = getdisk(buf, len, 1, &ndumpdev, 1);
916 if (dv != NULL) {
917 dumpdv = dv;
918 break;
919 }
920 }
921
922 rootdev = nrootdev;
923 dumpdev = ndumpdev;
924
925 for (vops = LIST_FIRST(&vfs_list); vops != NULL;
926 vops = LIST_NEXT(vops, vfs_list)) {
927 if (vops->vfs_mountroot != NULL &&
928 vops->vfs_mountroot == mountroot)
929 break;
930 }
931
932 if (vops == NULL) {
933 mountroot = NULL;
934 deffsname = "generic";
935 } else
936 deffsname = vops->vfs_name;
937
938 for (;;) {
939 printf("file system (default %s): ", deffsname);
940 len = cngetsn(buf, sizeof(buf));
941 if (len == 0)
942 break;
943 if (len == 4 && strcmp(buf, "halt") == 0)
944 cpu_reboot(RB_HALT, NULL);
945 else if (len == 6 && strcmp(buf, "reboot") == 0)
946 cpu_reboot(0, NULL);
947 #if defined(DDB)
948 else if (len == 3 && strcmp(buf, "ddb") == 0) {
949 console_debugger();
950 }
951 #endif
952 else if (len == 7 && strcmp(buf, "generic") == 0) {
953 mountroot = NULL;
954 break;
955 }
956 vops = vfs_getopsbyname(buf);
957 if (vops == NULL || vops->vfs_mountroot == NULL) {
958 printf("use one of: generic");
959 for (vops = LIST_FIRST(&vfs_list);
960 vops != NULL;
961 vops = LIST_NEXT(vops, vfs_list)) {
962 if (vops->vfs_mountroot != NULL)
963 printf(" %s", vops->vfs_name);
964 }
965 #if defined(DDB)
966 printf(" ddb");
967 #endif
968 printf(" halt reboot\n");
969 } else {
970 mountroot = vops->vfs_mountroot;
971 break;
972 }
973 }
974
975 } else if (rootspec == NULL) {
976 int majdev;
977
978 /*
979 * Wildcarded root; use the boot device.
980 */
981 rootdv = bootdv;
982
983 majdev = devsw_name2blk(bootdv->dv_xname, NULL, 0);
984 if (majdev >= 0) {
985 /*
986 * Root is on a disk. `bootpartition' is root,
987 * unless the device does not use partitions.
988 */
989 if (DEV_USES_PARTITIONS(bootdv))
990 rootdev = MAKEDISKDEV(majdev, bootdv->dv_unit,
991 bootpartition);
992 else
993 rootdev = makedev(majdev, bootdv->dv_unit);
994 }
995 } else {
996
997 /*
998 * `root on <dev> ...'
999 */
1000
1001 /*
1002 * If it's a network interface, we can bail out
1003 * early.
1004 */
1005 dv = finddevice(rootspec);
1006 if (dv != NULL && device_class(dv) == DV_IFNET) {
1007 rootdv = dv;
1008 goto haveroot;
1009 }
1010
1011 rootdevname = devsw_blk2name(major(rootdev));
1012 if (rootdevname == NULL) {
1013 printf("unknown device major 0x%x\n", rootdev);
1014 boothowto |= RB_ASKNAME;
1015 goto top;
1016 }
1017 memset(buf, 0, sizeof(buf));
1018 snprintf(buf, sizeof(buf), "%s%d", rootdevname,
1019 DISKUNIT(rootdev));
1020
1021 rootdv = finddevice(buf);
1022 if (rootdv == NULL) {
1023 printf("device %s (0x%x) not configured\n",
1024 buf, rootdev);
1025 boothowto |= RB_ASKNAME;
1026 goto top;
1027 }
1028 }
1029
1030 haveroot:
1031
1032 root_device = rootdv;
1033
1034 switch (device_class(rootdv)) {
1035 case DV_IFNET:
1036 aprint_normal("root on %s", rootdv->dv_xname);
1037 break;
1038
1039 case DV_DISK:
1040 aprint_normal("root on %s%c", rootdv->dv_xname,
1041 DISKPART(rootdev) + 'a');
1042 break;
1043
1044 default:
1045 printf("can't determine root device\n");
1046 boothowto |= RB_ASKNAME;
1047 goto top;
1048 }
1049
1050 /*
1051 * Now configure the dump device.
1052 *
1053 * If we haven't figured out the dump device, do so, with
1054 * the following rules:
1055 *
1056 * (a) We already know dumpdv in the RB_ASKNAME case.
1057 *
1058 * (b) If dumpspec is set, try to use it. If the device
1059 * is not available, punt.
1060 *
1061 * (c) If dumpspec is not set, the dump device is
1062 * wildcarded or unspecified. If the root device
1063 * is DV_IFNET, punt. Otherwise, use partition b
1064 * of the root device.
1065 */
1066
1067 if (boothowto & RB_ASKNAME) { /* (a) */
1068 if (dumpdv == NULL)
1069 goto nodumpdev;
1070 } else if (dumpspec != NULL) { /* (b) */
1071 if (strcmp(dumpspec, "none") == 0 || dumpdev == NODEV) {
1072 /*
1073 * Operator doesn't want a dump device.
1074 * Or looks like they tried to pick a network
1075 * device. Oops.
1076 */
1077 goto nodumpdev;
1078 }
1079
1080 dumpdevname = devsw_blk2name(major(dumpdev));
1081 if (dumpdevname == NULL)
1082 goto nodumpdev;
1083 memset(buf, 0, sizeof(buf));
1084 snprintf(buf, sizeof(buf), "%s%d", dumpdevname,
1085 DISKUNIT(dumpdev));
1086
1087 dumpdv = finddevice(buf);
1088 if (dumpdv == NULL) {
1089 /*
1090 * Device not configured.
1091 */
1092 goto nodumpdev;
1093 }
1094 } else { /* (c) */
1095 if (DEV_USES_PARTITIONS(rootdv) == 0)
1096 goto nodumpdev;
1097 else {
1098 dumpdv = rootdv;
1099 dumpdev = MAKEDISKDEV(major(rootdev),
1100 dumpdv->dv_unit, 1);
1101 }
1102 }
1103
1104 aprint_normal(" dumps on %s%c\n", dumpdv->dv_xname,
1105 DISKPART(dumpdev) + 'a');
1106 return;
1107
1108 nodumpdev:
1109 dumpdev = NODEV;
1110 aprint_normal("\n");
1111 }
1112
1113 static struct device *
1114 finddevice(const char *name)
1115 {
1116 struct device *dv;
1117 #if defined(BOOT_FROM_RAID_HOOKS) || defined(BOOT_FROM_MEMORY_HOOKS)
1118 int j;
1119 #endif /* BOOT_FROM_RAID_HOOKS || BOOT_FROM_MEMORY_HOOKS */
1120
1121 #ifdef BOOT_FROM_RAID_HOOKS
1122 for (j = 0; j < numraid; j++) {
1123 if (strcmp(name, raidrootdev[j].dv_xname) == 0) {
1124 dv = &raidrootdev[j];
1125 return (dv);
1126 }
1127 }
1128 #endif /* BOOT_FROM_RAID_HOOKS */
1129
1130 #ifdef BOOT_FROM_MEMORY_HOOKS
1131 for (j = 0; j < NMD; j++) {
1132 if (strcmp(name, fakemdrootdev[j].dv_xname) == 0) {
1133 dv = &fakemdrootdev[j];
1134 return (dv);
1135 }
1136 }
1137 #endif /* BOOT_FROM_MEMORY_HOOKS */
1138
1139 for (dv = TAILQ_FIRST(&alldevs); dv != NULL;
1140 dv = TAILQ_NEXT(dv, dv_list))
1141 if (strcmp(dv->dv_xname, name) == 0)
1142 break;
1143 return (dv);
1144 }
1145
1146 static struct device *
1147 getdisk(char *str, int len, int defpart, dev_t *devp, int isdump)
1148 {
1149 struct device *dv;
1150 #ifdef MEMORY_DISK_HOOKS
1151 int i;
1152 #endif
1153 #ifdef BOOT_FROM_RAID_HOOKS
1154 int j;
1155 #endif
1156
1157 if ((dv = parsedisk(str, len, defpart, devp)) == NULL) {
1158 printf("use one of:");
1159 #ifdef MEMORY_DISK_HOOKS
1160 if (isdump == 0)
1161 for (i = 0; i < NMD; i++)
1162 printf(" %s[a-%c]", fakemdrootdev[i].dv_xname,
1163 'a' + MAXPARTITIONS - 1);
1164 #endif
1165 #ifdef BOOT_FROM_RAID_HOOKS
1166 if (isdump == 0)
1167 for (j = 0; j < numraid; j++)
1168 printf(" %s[a-%c]", raidrootdev[j].dv_xname,
1169 'a' + MAXPARTITIONS - 1);
1170 #endif
1171 TAILQ_FOREACH(dv, &alldevs, dv_list) {
1172 if (DEV_USES_PARTITIONS(dv))
1173 printf(" %s[a-%c]", dv->dv_xname,
1174 'a' + MAXPARTITIONS - 1);
1175 else if (device_class(dv) == DV_DISK)
1176 printf(" %s", dv->dv_xname);
1177 if (isdump == 0 && device_class(dv) == DV_IFNET)
1178 printf(" %s", dv->dv_xname);
1179 }
1180 if (isdump)
1181 printf(" none");
1182 #if defined(DDB)
1183 printf(" ddb");
1184 #endif
1185 printf(" halt reboot\n");
1186 }
1187 return (dv);
1188 }
1189
1190 static struct device *
1191 parsedisk(char *str, int len, int defpart, dev_t *devp)
1192 {
1193 struct device *dv;
1194 char *cp, c;
1195 int majdev, part;
1196 #ifdef MEMORY_DISK_HOOKS
1197 int i;
1198 #endif
1199 if (len == 0)
1200 return (NULL);
1201
1202 if (len == 4 && strcmp(str, "halt") == 0)
1203 cpu_reboot(RB_HALT, NULL);
1204 else if (len == 6 && strcmp(str, "reboot") == 0)
1205 cpu_reboot(0, NULL);
1206 #if defined(DDB)
1207 else if (len == 3 && strcmp(str, "ddb") == 0)
1208 console_debugger();
1209 #endif
1210
1211 cp = str + len - 1;
1212 c = *cp;
1213 if (c >= 'a' && c <= ('a' + MAXPARTITIONS - 1)) {
1214 part = c - 'a';
1215 *cp = '\0';
1216 } else
1217 part = defpart;
1218
1219 #ifdef MEMORY_DISK_HOOKS
1220 for (i = 0; i < NMD; i++)
1221 if (strcmp(str, fakemdrootdev[i].dv_xname) == 0) {
1222 dv = &fakemdrootdev[i];
1223 goto gotdisk;
1224 }
1225 #endif
1226
1227 dv = finddevice(str);
1228 if (dv != NULL) {
1229 if (device_class(dv) == DV_DISK) {
1230 #ifdef MEMORY_DISK_HOOKS
1231 gotdisk:
1232 #endif
1233 majdev = devsw_name2blk(dv->dv_xname, NULL, 0);
1234 if (majdev < 0)
1235 panic("parsedisk");
1236 if (DEV_USES_PARTITIONS(dv))
1237 *devp = MAKEDISKDEV(majdev, dv->dv_unit, part);
1238 else
1239 *devp = makedev(majdev, dv->dv_unit);
1240 }
1241
1242 if (device_class(dv) == DV_IFNET)
1243 *devp = NODEV;
1244 }
1245
1246 *cp = c;
1247 return (dv);
1248 }
1249
1250 /*
1251 * snprintf() `bytes' into `buf', reformatting it so that the number,
1252 * plus a possible `x' + suffix extension) fits into len bytes (including
1253 * the terminating NUL).
1254 * Returns the number of bytes stored in buf, or -1 if there was a problem.
1255 * E.g, given a len of 9 and a suffix of `B':
1256 * bytes result
1257 * ----- ------
1258 * 99999 `99999 B'
1259 * 100000 `97 kB'
1260 * 66715648 `65152 kB'
1261 * 252215296 `240 MB'
1262 */
1263 int
1264 humanize_number(char *buf, size_t len, uint64_t bytes, const char *suffix,
1265 int divisor)
1266 {
1267 /* prefixes are: (none), kilo, Mega, Giga, Tera, Peta, Exa */
1268 const char *prefixes;
1269 int r;
1270 uint64_t umax;
1271 size_t i, suffixlen;
1272
1273 if (buf == NULL || suffix == NULL)
1274 return (-1);
1275 if (len > 0)
1276 buf[0] = '\0';
1277 suffixlen = strlen(suffix);
1278 /* check if enough room for `x y' + suffix + `\0' */
1279 if (len < 4 + suffixlen)
1280 return (-1);
1281
1282 if (divisor == 1024) {
1283 /*
1284 * binary multiplies
1285 * XXX IEC 60027-2 recommends Ki, Mi, Gi...
1286 */
1287 prefixes = " KMGTPE";
1288 } else
1289 prefixes = " kMGTPE"; /* SI for decimal multiplies */
1290
1291 umax = 1;
1292 for (i = 0; i < len - suffixlen - 3; i++)
1293 umax *= 10;
1294 for (i = 0; bytes >= umax && prefixes[i + 1]; i++)
1295 bytes /= divisor;
1296
1297 r = snprintf(buf, len, "%qu%s%c%s", (unsigned long long)bytes,
1298 i == 0 ? "" : " ", prefixes[i], suffix);
1299
1300 return (r);
1301 }
1302
1303 int
1304 format_bytes(char *buf, size_t len, uint64_t bytes)
1305 {
1306 int rv;
1307 size_t nlen;
1308
1309 rv = humanize_number(buf, len, bytes, "B", 1024);
1310 if (rv != -1) {
1311 /* nuke the trailing ` B' if it exists */
1312 nlen = strlen(buf) - 2;
1313 if (strcmp(&buf[nlen], " B") == 0)
1314 buf[nlen] = '\0';
1315 }
1316 return (rv);
1317 }
1318
1319 /*
1320 * Start trace of particular system call. If process is being traced,
1321 * this routine is called by MD syscall dispatch code just before
1322 * a system call is actually executed.
1323 * MD caller guarantees the passed 'code' is within the supported
1324 * system call number range for emulation the process runs under.
1325 */
1326 int
1327 trace_enter(struct lwp *l, register_t code,
1328 register_t realcode, const struct sysent *callp, void *args)
1329 {
1330 #if defined(KTRACE) || defined(SYSTRACE)
1331 struct proc *p = l->l_proc;
1332 #endif
1333
1334 #ifdef SYSCALL_DEBUG
1335 scdebug_call(l, code, args);
1336 #endif /* SYSCALL_DEBUG */
1337
1338 #ifdef KTRACE
1339 if (KTRPOINT(p, KTR_SYSCALL))
1340 ktrsyscall(l, code, realcode, callp, args);
1341 #endif /* KTRACE */
1342
1343 #ifdef SYSTRACE
1344 if (ISSET(p->p_flag, P_SYSTRACE))
1345 return systrace_enter(p, code, args);
1346 #endif
1347 return 0;
1348 }
1349
1350 /*
1351 * End trace of particular system call. If process is being traced,
1352 * this routine is called by MD syscall dispatch code just after
1353 * a system call finishes.
1354 * MD caller guarantees the passed 'code' is within the supported
1355 * system call number range for emulation the process runs under.
1356 */
1357 void
1358 trace_exit(struct lwp *l, register_t code, void *args, register_t rval[],
1359 int error)
1360 {
1361 #if defined(KTRACE) || defined(SYSTRACE)
1362 struct proc *p = l->l_proc;
1363 #endif
1364
1365 #ifdef SYSCALL_DEBUG
1366 scdebug_ret(l, code, error, rval);
1367 #endif /* SYSCALL_DEBUG */
1368
1369 #ifdef KTRACE
1370 if (KTRPOINT(p, KTR_SYSRET)) {
1371 KERNEL_PROC_LOCK(l);
1372 ktrsysret(l, code, error, rval);
1373 KERNEL_PROC_UNLOCK(l);
1374 }
1375 #endif /* KTRACE */
1376
1377 #ifdef SYSTRACE
1378 if (ISSET(p->p_flag, P_SYSTRACE)) {
1379 KERNEL_PROC_LOCK(l);
1380 systrace_exit(p, code, args, rval, error);
1381 KERNEL_PROC_UNLOCK(l);
1382 }
1383 #endif
1384 }
1385