2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2011 NetApp, Inc.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY NETAPP, INC ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL NETAPP, INC OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 #include <sys/cdefs.h>
32 __FBSDID("$FreeBSD$");
34 #include "opt_bhyve_snapshot.h"
36 #include <sys/param.h>
37 #include <sys/kernel.h>
39 #include <sys/queue.h>
41 #include <sys/mutex.h>
42 #include <sys/malloc.h>
44 #include <sys/sysctl.h>
45 #include <sys/libkern.h>
46 #include <sys/ioccom.h>
53 #include <vm/vm_map.h>
54 #include <vm/vm_object.h>
56 #include <machine/vmparam.h>
57 #include <machine/vmm.h>
58 #include <machine/vmm_dev.h>
59 #include <machine/vmm_instruction_emul.h>
60 #include <machine/vmm_snapshot.h>
61 #include <x86/apicreg.h>
63 #include "vmm_lapic.h"
67 #include "io/vatpic.h"
68 #include "io/vioapic.h"
72 #ifdef COMPAT_FREEBSD13
75 int num_entries; /* out */
77 uint64_t statbuf[MAX_VM_STATS];
80 #define VM_STATS_OLD \
81 _IOWR('v', IOCNUM_VM_STATS, struct vm_stats_old)
88 struct vmmdev_softc *sc;
89 SLIST_ENTRY(devmem_softc) link;
93 struct vm *vm; /* vm instance cookie */
96 SLIST_ENTRY(vmmdev_softc) link;
97 SLIST_HEAD(, devmem_softc) devmem;
100 #define VSC_LINKED 0x01
102 static SLIST_HEAD(, vmmdev_softc) head;
104 static unsigned pr_allow_flag;
105 static struct mtx vmmdev_mtx;
107 static MALLOC_DEFINE(M_VMMDEV, "vmmdev", "vmmdev");
109 SYSCTL_DECL(_hw_vmm);
111 static int vmm_priv_check(struct ucred *ucred);
112 static int devmem_create_cdev(const char *vmname, int id, char *devmem);
113 static void devmem_destroy(void *arg);
116 vmm_priv_check(struct ucred *ucred)
120 !(ucred->cr_prison->pr_allow & pr_allow_flag))
127 vcpu_lock_one(struct vmmdev_softc *sc, int vcpu)
131 if (vcpu < 0 || vcpu >= vm_get_maxcpus(sc->vm))
134 error = vcpu_set_state(sc->vm, vcpu, VCPU_FROZEN, true);
139 vcpu_unlock_one(struct vmmdev_softc *sc, int vcpu)
141 enum vcpu_state state;
143 state = vcpu_get_state(sc->vm, vcpu, NULL);
144 if (state != VCPU_FROZEN) {
145 panic("vcpu %s(%d) has invalid state %d", vm_name(sc->vm),
149 vcpu_set_state(sc->vm, vcpu, VCPU_IDLE, false);
153 vcpu_lock_all(struct vmmdev_softc *sc)
158 maxcpus = vm_get_maxcpus(sc->vm);
159 for (vcpu = 0; vcpu < maxcpus; vcpu++) {
160 error = vcpu_lock_one(sc, vcpu);
167 vcpu_unlock_one(sc, vcpu);
174 vcpu_unlock_all(struct vmmdev_softc *sc)
179 maxcpus = vm_get_maxcpus(sc->vm);
180 for (vcpu = 0; vcpu < maxcpus; vcpu++)
181 vcpu_unlock_one(sc, vcpu);
184 static struct vmmdev_softc *
185 vmmdev_lookup(const char *name)
187 struct vmmdev_softc *sc;
189 #ifdef notyet /* XXX kernel is not compiled with invariants */
190 mtx_assert(&vmmdev_mtx, MA_OWNED);
193 SLIST_FOREACH(sc, &head, link) {
194 if (strcmp(name, vm_name(sc->vm)) == 0)
201 if (cr_cansee(curthread->td_ucred, sc->ucred))
207 static struct vmmdev_softc *
208 vmmdev_lookup2(struct cdev *cdev)
211 return (cdev->si_drv1);
215 vmmdev_rw(struct cdev *cdev, struct uio *uio, int flags)
217 int error, off, c, prot;
218 vm_paddr_t gpa, maxaddr;
220 struct vmmdev_softc *sc;
223 error = vmm_priv_check(curthread->td_ucred);
227 sc = vmmdev_lookup2(cdev);
232 * Get a read lock on the guest memory map by freezing any vcpu.
234 lastcpu = vm_get_maxcpus(sc->vm) - 1;
235 error = vcpu_lock_one(sc, lastcpu);
239 prot = (uio->uio_rw == UIO_WRITE ? VM_PROT_WRITE : VM_PROT_READ);
240 maxaddr = vmm_sysmem_maxaddr(sc->vm);
241 while (uio->uio_resid > 0 && error == 0) {
242 gpa = uio->uio_offset;
243 off = gpa & PAGE_MASK;
244 c = min(uio->uio_resid, PAGE_SIZE - off);
247 * The VM has a hole in its physical memory map. If we want to
248 * use 'dd' to inspect memory beyond the hole we need to
249 * provide bogus data for memory that lies in the hole.
251 * Since this device does not support lseek(2), dd(1) will
252 * read(2) blocks of data to simulate the lseek(2).
254 hpa = vm_gpa_hold(sc->vm, lastcpu, gpa, c,
257 if (uio->uio_rw == UIO_READ && gpa < maxaddr)
258 error = uiomove(__DECONST(void *, zero_region),
263 error = uiomove(hpa, c, uio);
264 vm_gpa_release(cookie);
267 vcpu_unlock_one(sc, lastcpu);
271 CTASSERT(sizeof(((struct vm_memseg *)0)->name) >= VM_MAX_SUFFIXLEN + 1);
274 get_memseg(struct vmmdev_softc *sc, struct vm_memseg *mseg, size_t len)
276 struct devmem_softc *dsc;
280 error = vm_get_memseg(sc->vm, mseg->segid, &mseg->len, &sysmem, NULL);
281 if (error || mseg->len == 0)
285 SLIST_FOREACH(dsc, &sc->devmem, link) {
286 if (dsc->segid == mseg->segid)
289 KASSERT(dsc != NULL, ("%s: devmem segment %d not found",
290 __func__, mseg->segid));
291 error = copystr(dsc->name, mseg->name, len, NULL);
293 bzero(mseg->name, len);
300 alloc_memseg(struct vmmdev_softc *sc, struct vm_memseg *mseg, size_t len)
311 * The allocation is lengthened by 1 to hold a terminating NUL. It'll
312 * by stripped off when devfs processes the full string.
314 if (VM_MEMSEG_NAME(mseg)) {
316 name = malloc(len, M_VMMDEV, M_WAITOK);
317 error = copystr(mseg->name, name, len, NULL);
322 error = vm_alloc_memseg(sc->vm, mseg->segid, mseg->len, sysmem);
326 if (VM_MEMSEG_NAME(mseg)) {
327 error = devmem_create_cdev(vm_name(sc->vm), mseg->segid, name);
329 vm_free_memseg(sc->vm, mseg->segid);
331 name = NULL; /* freed when 'cdev' is destroyed */
334 free(name, M_VMMDEV);
339 vm_get_register_set(struct vm *vm, int vcpu, unsigned int count, int *regnum,
345 for (i = 0; i < count; i++) {
346 error = vm_get_register(vm, vcpu, regnum[i], ®val[i]);
354 vm_set_register_set(struct vm *vm, int vcpu, unsigned int count, int *regnum,
360 for (i = 0; i < count; i++) {
361 error = vm_set_register(vm, vcpu, regnum[i], regval[i]);
369 vmmdev_ioctl(struct cdev *cdev, u_long cmd, caddr_t data, int fflag,
372 int error, vcpu, state_changed, size;
374 struct vmmdev_softc *sc;
375 struct vm_register *vmreg;
376 struct vm_seg_desc *vmsegdesc;
377 struct vm_register_set *vmregset;
378 struct vm_run *vmrun;
379 struct vm_exception *vmexc;
380 struct vm_lapic_irq *vmirq;
381 struct vm_lapic_msi *vmmsi;
382 struct vm_ioapic_irq *ioapic_irq;
383 struct vm_isa_irq *isa_irq;
384 struct vm_isa_irq_trigger *isa_irq_trigger;
385 struct vm_capability *vmcap;
386 struct vm_pptdev *pptdev;
387 struct vm_pptdev_mmio *pptmmio;
388 struct vm_pptdev_msi *pptmsi;
389 struct vm_pptdev_msix *pptmsix;
390 struct vm_nmi *vmnmi;
391 #ifdef COMPAT_FREEBSD13
392 struct vm_stats_old *vmstats_old;
394 struct vm_stats *vmstats;
395 struct vm_stat_desc *statdesc;
396 struct vm_x2apic *x2apic;
397 struct vm_gpa_pte *gpapte;
398 struct vm_suspend *vmsuspend;
399 struct vm_gla2gpa *gg;
400 struct vm_activate_cpu *vac;
401 struct vm_cpuset *vm_cpuset;
402 struct vm_intinfo *vmii;
403 struct vm_rtc_time *rtctime;
404 struct vm_rtc_data *rtcdata;
405 struct vm_memmap *mm;
406 struct vm_munmap *mu;
407 struct vm_cpu_topology *topology;
408 struct vm_readwrite_kernemu_device *kernemu;
411 #ifdef BHYVE_SNAPSHOT
412 struct vm_snapshot_meta *snapshot_meta;
415 error = vmm_priv_check(curthread->td_ucred);
419 sc = vmmdev_lookup2(cdev);
427 * Some VMM ioctls can operate only on vcpus that are not running.
431 case VM_GET_REGISTER:
432 case VM_SET_REGISTER:
433 case VM_GET_SEGMENT_DESCRIPTOR:
434 case VM_SET_SEGMENT_DESCRIPTOR:
435 case VM_GET_REGISTER_SET:
436 case VM_SET_REGISTER_SET:
437 case VM_INJECT_EXCEPTION:
438 case VM_GET_CAPABILITY:
439 case VM_SET_CAPABILITY:
442 case VM_SET_X2APIC_STATE:
444 case VM_GLA2GPA_NOFAULT:
445 case VM_ACTIVATE_CPU:
448 case VM_RESTART_INSTRUCTION:
450 * XXX fragile, handle with care
451 * Assumes that the first field of the ioctl data is the vcpu.
454 error = vcpu_lock_one(sc, vcpu);
460 case VM_MAP_PPTDEV_MMIO:
461 case VM_UNMAP_PPTDEV_MMIO:
463 case VM_UNBIND_PPTDEV:
464 #ifdef COMPAT_FREEBSD12
465 case VM_ALLOC_MEMSEG_FBSD12:
467 case VM_ALLOC_MEMSEG:
469 case VM_MUNMAP_MEMSEG:
472 * ioctls that operate on the entire virtual machine must
473 * prevent all vcpus from running.
475 error = vcpu_lock_all(sc);
481 #ifdef COMPAT_FREEBSD12
482 case VM_GET_MEMSEG_FBSD12:
485 case VM_MMAP_GETNEXT:
487 * Lock a vcpu to make sure that the memory map cannot be
488 * modified while it is being inspected.
490 vcpu = vm_get_maxcpus(sc->vm) - 1;
491 error = vcpu_lock_one(sc, vcpu);
503 vmrun = (struct vm_run *)data;
504 error = vm_run(sc->vm, vmrun);
507 vmsuspend = (struct vm_suspend *)data;
508 error = vm_suspend(sc->vm, vmsuspend->how);
511 error = vm_reinit(sc->vm);
514 statdesc = (struct vm_stat_desc *)data;
515 error = vmm_stat_desc_copy(statdesc->index,
516 statdesc->desc, sizeof(statdesc->desc));
519 #ifdef COMPAT_FREEBSD13
521 vmstats_old = (struct vm_stats_old *)data;
522 getmicrotime(&vmstats_old->tv);
523 error = vmm_stat_copy(sc->vm, vmstats_old->cpuid, 0,
524 nitems(vmstats_old->statbuf),
525 &vmstats_old->num_entries,
526 vmstats_old->statbuf);
530 vmstats = (struct vm_stats *)data;
531 getmicrotime(&vmstats->tv);
532 error = vmm_stat_copy(sc->vm, vmstats->cpuid, vmstats->index,
533 nitems(vmstats->statbuf),
534 &vmstats->num_entries, vmstats->statbuf);
538 pptmsi = (struct vm_pptdev_msi *)data;
539 error = ppt_setup_msi(sc->vm, pptmsi->vcpu,
540 pptmsi->bus, pptmsi->slot, pptmsi->func,
541 pptmsi->addr, pptmsi->msg,
545 pptmsix = (struct vm_pptdev_msix *)data;
546 error = ppt_setup_msix(sc->vm, pptmsix->vcpu,
547 pptmsix->bus, pptmsix->slot,
548 pptmsix->func, pptmsix->idx,
549 pptmsix->addr, pptmsix->msg,
550 pptmsix->vector_control);
552 case VM_PPTDEV_DISABLE_MSIX:
553 pptdev = (struct vm_pptdev *)data;
554 error = ppt_disable_msix(sc->vm, pptdev->bus, pptdev->slot,
557 case VM_MAP_PPTDEV_MMIO:
558 pptmmio = (struct vm_pptdev_mmio *)data;
559 error = ppt_map_mmio(sc->vm, pptmmio->bus, pptmmio->slot,
560 pptmmio->func, pptmmio->gpa, pptmmio->len,
563 case VM_UNMAP_PPTDEV_MMIO:
564 pptmmio = (struct vm_pptdev_mmio *)data;
565 error = ppt_unmap_mmio(sc->vm, pptmmio->bus, pptmmio->slot,
566 pptmmio->func, pptmmio->gpa, pptmmio->len);
569 pptdev = (struct vm_pptdev *)data;
570 error = vm_assign_pptdev(sc->vm, pptdev->bus, pptdev->slot,
573 case VM_UNBIND_PPTDEV:
574 pptdev = (struct vm_pptdev *)data;
575 error = vm_unassign_pptdev(sc->vm, pptdev->bus, pptdev->slot,
578 case VM_INJECT_EXCEPTION:
579 vmexc = (struct vm_exception *)data;
580 error = vm_inject_exception(sc->vm, vmexc->cpuid,
581 vmexc->vector, vmexc->error_code_valid, vmexc->error_code,
582 vmexc->restart_instruction);
585 vmnmi = (struct vm_nmi *)data;
586 error = vm_inject_nmi(sc->vm, vmnmi->cpuid);
589 vmirq = (struct vm_lapic_irq *)data;
590 error = lapic_intr_edge(sc->vm, vmirq->cpuid, vmirq->vector);
592 case VM_LAPIC_LOCAL_IRQ:
593 vmirq = (struct vm_lapic_irq *)data;
594 error = lapic_set_local_intr(sc->vm, vmirq->cpuid,
598 vmmsi = (struct vm_lapic_msi *)data;
599 error = lapic_intr_msi(sc->vm, vmmsi->addr, vmmsi->msg);
601 case VM_IOAPIC_ASSERT_IRQ:
602 ioapic_irq = (struct vm_ioapic_irq *)data;
603 error = vioapic_assert_irq(sc->vm, ioapic_irq->irq);
605 case VM_IOAPIC_DEASSERT_IRQ:
606 ioapic_irq = (struct vm_ioapic_irq *)data;
607 error = vioapic_deassert_irq(sc->vm, ioapic_irq->irq);
609 case VM_IOAPIC_PULSE_IRQ:
610 ioapic_irq = (struct vm_ioapic_irq *)data;
611 error = vioapic_pulse_irq(sc->vm, ioapic_irq->irq);
613 case VM_IOAPIC_PINCOUNT:
614 *(int *)data = vioapic_pincount(sc->vm);
616 case VM_SET_KERNEMU_DEV:
617 case VM_GET_KERNEMU_DEV: {
618 mem_region_write_t mwrite;
619 mem_region_read_t mread;
622 kernemu = (void *)data;
624 if (kernemu->access_width > 0)
625 size = (1u << kernemu->access_width);
629 if (kernemu->gpa >= DEFAULT_APIC_BASE && kernemu->gpa < DEFAULT_APIC_BASE + PAGE_SIZE) {
630 mread = lapic_mmio_read;
631 mwrite = lapic_mmio_write;
632 } else if (kernemu->gpa >= VIOAPIC_BASE && kernemu->gpa < VIOAPIC_BASE + VIOAPIC_SIZE) {
633 mread = vioapic_mmio_read;
634 mwrite = vioapic_mmio_write;
635 } else if (kernemu->gpa >= VHPET_BASE && kernemu->gpa < VHPET_BASE + VHPET_SIZE) {
636 mread = vhpet_mmio_read;
637 mwrite = vhpet_mmio_write;
643 if (cmd == VM_SET_KERNEMU_DEV)
644 error = mwrite(sc->vm, kernemu->vcpuid, kernemu->gpa,
645 kernemu->value, size, &arg);
647 error = mread(sc->vm, kernemu->vcpuid, kernemu->gpa,
648 &kernemu->value, size, &arg);
651 case VM_ISA_ASSERT_IRQ:
652 isa_irq = (struct vm_isa_irq *)data;
653 error = vatpic_assert_irq(sc->vm, isa_irq->atpic_irq);
654 if (error == 0 && isa_irq->ioapic_irq != -1)
655 error = vioapic_assert_irq(sc->vm,
656 isa_irq->ioapic_irq);
658 case VM_ISA_DEASSERT_IRQ:
659 isa_irq = (struct vm_isa_irq *)data;
660 error = vatpic_deassert_irq(sc->vm, isa_irq->atpic_irq);
661 if (error == 0 && isa_irq->ioapic_irq != -1)
662 error = vioapic_deassert_irq(sc->vm,
663 isa_irq->ioapic_irq);
665 case VM_ISA_PULSE_IRQ:
666 isa_irq = (struct vm_isa_irq *)data;
667 error = vatpic_pulse_irq(sc->vm, isa_irq->atpic_irq);
668 if (error == 0 && isa_irq->ioapic_irq != -1)
669 error = vioapic_pulse_irq(sc->vm, isa_irq->ioapic_irq);
671 case VM_ISA_SET_IRQ_TRIGGER:
672 isa_irq_trigger = (struct vm_isa_irq_trigger *)data;
673 error = vatpic_set_irq_trigger(sc->vm,
674 isa_irq_trigger->atpic_irq, isa_irq_trigger->trigger);
676 case VM_MMAP_GETNEXT:
677 mm = (struct vm_memmap *)data;
678 error = vm_mmap_getnext(sc->vm, &mm->gpa, &mm->segid,
679 &mm->segoff, &mm->len, &mm->prot, &mm->flags);
682 mm = (struct vm_memmap *)data;
683 error = vm_mmap_memseg(sc->vm, mm->gpa, mm->segid, mm->segoff,
684 mm->len, mm->prot, mm->flags);
686 case VM_MUNMAP_MEMSEG:
687 mu = (struct vm_munmap *)data;
688 error = vm_munmap_memseg(sc->vm, mu->gpa, mu->len);
690 #ifdef COMPAT_FREEBSD12
691 case VM_ALLOC_MEMSEG_FBSD12:
692 error = alloc_memseg(sc, (struct vm_memseg *)data,
693 sizeof(((struct vm_memseg_fbsd12 *)0)->name));
696 case VM_ALLOC_MEMSEG:
697 error = alloc_memseg(sc, (struct vm_memseg *)data,
698 sizeof(((struct vm_memseg *)0)->name));
700 #ifdef COMPAT_FREEBSD12
701 case VM_GET_MEMSEG_FBSD12:
702 error = get_memseg(sc, (struct vm_memseg *)data,
703 sizeof(((struct vm_memseg_fbsd12 *)0)->name));
707 error = get_memseg(sc, (struct vm_memseg *)data,
708 sizeof(((struct vm_memseg *)0)->name));
710 case VM_GET_REGISTER:
711 vmreg = (struct vm_register *)data;
712 error = vm_get_register(sc->vm, vmreg->cpuid, vmreg->regnum,
715 case VM_SET_REGISTER:
716 vmreg = (struct vm_register *)data;
717 error = vm_set_register(sc->vm, vmreg->cpuid, vmreg->regnum,
720 case VM_SET_SEGMENT_DESCRIPTOR:
721 vmsegdesc = (struct vm_seg_desc *)data;
722 error = vm_set_seg_desc(sc->vm, vmsegdesc->cpuid,
726 case VM_GET_SEGMENT_DESCRIPTOR:
727 vmsegdesc = (struct vm_seg_desc *)data;
728 error = vm_get_seg_desc(sc->vm, vmsegdesc->cpuid,
732 case VM_GET_REGISTER_SET:
733 vmregset = (struct vm_register_set *)data;
734 if (vmregset->count > VM_REG_LAST) {
738 regvals = malloc(sizeof(regvals[0]) * vmregset->count, M_VMMDEV,
740 regnums = malloc(sizeof(regnums[0]) * vmregset->count, M_VMMDEV,
742 error = copyin(vmregset->regnums, regnums, sizeof(regnums[0]) *
745 error = vm_get_register_set(sc->vm, vmregset->cpuid,
746 vmregset->count, regnums, regvals);
748 error = copyout(regvals, vmregset->regvals,
749 sizeof(regvals[0]) * vmregset->count);
750 free(regvals, M_VMMDEV);
751 free(regnums, M_VMMDEV);
753 case VM_SET_REGISTER_SET:
754 vmregset = (struct vm_register_set *)data;
755 if (vmregset->count > VM_REG_LAST) {
759 regvals = malloc(sizeof(regvals[0]) * vmregset->count, M_VMMDEV,
761 regnums = malloc(sizeof(regnums[0]) * vmregset->count, M_VMMDEV,
763 error = copyin(vmregset->regnums, regnums, sizeof(regnums[0]) *
766 error = copyin(vmregset->regvals, regvals,
767 sizeof(regvals[0]) * vmregset->count);
769 error = vm_set_register_set(sc->vm, vmregset->cpuid,
770 vmregset->count, regnums, regvals);
771 free(regvals, M_VMMDEV);
772 free(regnums, M_VMMDEV);
774 case VM_GET_CAPABILITY:
775 vmcap = (struct vm_capability *)data;
776 error = vm_get_capability(sc->vm, vmcap->cpuid,
780 case VM_SET_CAPABILITY:
781 vmcap = (struct vm_capability *)data;
782 error = vm_set_capability(sc->vm, vmcap->cpuid,
786 case VM_SET_X2APIC_STATE:
787 x2apic = (struct vm_x2apic *)data;
788 error = vm_set_x2apic_state(sc->vm,
789 x2apic->cpuid, x2apic->state);
791 case VM_GET_X2APIC_STATE:
792 x2apic = (struct vm_x2apic *)data;
793 error = vm_get_x2apic_state(sc->vm,
794 x2apic->cpuid, &x2apic->state);
796 case VM_GET_GPA_PMAP:
797 gpapte = (struct vm_gpa_pte *)data;
798 pmap_get_mapping(vmspace_pmap(vm_get_vmspace(sc->vm)),
799 gpapte->gpa, gpapte->pte, &gpapte->ptenum);
802 case VM_GET_HPET_CAPABILITIES:
803 error = vhpet_getcap((struct vm_hpet_cap *)data);
806 CTASSERT(PROT_READ == VM_PROT_READ);
807 CTASSERT(PROT_WRITE == VM_PROT_WRITE);
808 CTASSERT(PROT_EXEC == VM_PROT_EXECUTE);
809 gg = (struct vm_gla2gpa *)data;
810 error = vm_gla2gpa(sc->vm, gg->vcpuid, &gg->paging, gg->gla,
811 gg->prot, &gg->gpa, &gg->fault);
812 KASSERT(error == 0 || error == EFAULT,
813 ("%s: vm_gla2gpa unknown error %d", __func__, error));
816 case VM_GLA2GPA_NOFAULT:
817 gg = (struct vm_gla2gpa *)data;
818 error = vm_gla2gpa_nofault(sc->vm, gg->vcpuid, &gg->paging,
819 gg->gla, gg->prot, &gg->gpa, &gg->fault);
820 KASSERT(error == 0 || error == EFAULT,
821 ("%s: vm_gla2gpa unknown error %d", __func__, error));
823 case VM_ACTIVATE_CPU:
824 vac = (struct vm_activate_cpu *)data;
825 error = vm_activate_cpu(sc->vm, vac->vcpuid);
829 vm_cpuset = (struct vm_cpuset *)data;
830 size = vm_cpuset->cpusetsize;
831 if (size < sizeof(cpuset_t) || size > CPU_MAXSIZE / NBBY) {
835 cpuset = malloc(size, M_TEMP, M_WAITOK | M_ZERO);
836 if (vm_cpuset->which == VM_ACTIVE_CPUS)
837 *cpuset = vm_active_cpus(sc->vm);
838 else if (vm_cpuset->which == VM_SUSPENDED_CPUS)
839 *cpuset = vm_suspended_cpus(sc->vm);
840 else if (vm_cpuset->which == VM_DEBUG_CPUS)
841 *cpuset = vm_debug_cpus(sc->vm);
845 error = copyout(cpuset, vm_cpuset->cpus, size);
846 free(cpuset, M_TEMP);
849 vac = (struct vm_activate_cpu *)data;
850 error = vm_suspend_cpu(sc->vm, vac->vcpuid);
853 vac = (struct vm_activate_cpu *)data;
854 error = vm_resume_cpu(sc->vm, vac->vcpuid);
857 vmii = (struct vm_intinfo *)data;
858 error = vm_exit_intinfo(sc->vm, vmii->vcpuid, vmii->info1);
861 vmii = (struct vm_intinfo *)data;
862 error = vm_get_intinfo(sc->vm, vmii->vcpuid, &vmii->info1,
866 rtcdata = (struct vm_rtc_data *)data;
867 error = vrtc_nvram_write(sc->vm, rtcdata->offset,
871 rtcdata = (struct vm_rtc_data *)data;
872 error = vrtc_nvram_read(sc->vm, rtcdata->offset,
876 rtctime = (struct vm_rtc_time *)data;
877 error = vrtc_set_time(sc->vm, rtctime->secs);
881 rtctime = (struct vm_rtc_time *)data;
882 rtctime->secs = vrtc_get_time(sc->vm);
884 case VM_RESTART_INSTRUCTION:
885 error = vm_restart_instruction(sc->vm, vcpu);
887 case VM_SET_TOPOLOGY:
888 topology = (struct vm_cpu_topology *)data;
889 error = vm_set_topology(sc->vm, topology->sockets,
890 topology->cores, topology->threads, topology->maxcpus);
892 case VM_GET_TOPOLOGY:
893 topology = (struct vm_cpu_topology *)data;
894 vm_get_topology(sc->vm, &topology->sockets, &topology->cores,
895 &topology->threads, &topology->maxcpus);
898 #ifdef BHYVE_SNAPSHOT
899 case VM_SNAPSHOT_REQ:
900 snapshot_meta = (struct vm_snapshot_meta *)data;
901 error = vm_snapshot_req(sc->vm, snapshot_meta);
903 case VM_RESTORE_TIME:
904 error = vm_restore_time(sc->vm);
912 if (state_changed == 1)
913 vcpu_unlock_one(sc, vcpu);
914 else if (state_changed == 2)
919 * Make sure that no handler returns a kernel-internal
920 * error value to userspace.
922 KASSERT(error == ERESTART || error >= 0,
923 ("vmmdev_ioctl: invalid error return %d", error));
928 vmmdev_mmap_single(struct cdev *cdev, vm_ooffset_t *offset, vm_size_t mapsize,
929 struct vm_object **objp, int nprot)
931 struct vmmdev_softc *sc;
934 vm_ooffset_t segoff, first, last;
935 int error, found, segid;
939 error = vmm_priv_check(curthread->td_ucred);
944 last = first + mapsize;
945 if ((nprot & PROT_EXEC) || first < 0 || first >= last)
948 sc = vmmdev_lookup2(cdev);
950 /* virtual machine is in the process of being created */
955 * Get a read lock on the guest memory map by freezing any vcpu.
957 lastcpu = vm_get_maxcpus(sc->vm) - 1;
958 error = vcpu_lock_one(sc, lastcpu);
965 error = vm_mmap_getnext(sc->vm, &gpa, &segid, &segoff, &len,
970 if (first >= gpa && last <= gpa + len)
977 error = vm_get_memseg(sc->vm, segid, &len, &sysmem, objp);
978 KASSERT(error == 0 && *objp != NULL,
979 ("%s: invalid memory segment %d", __func__, segid));
981 vm_object_reference(*objp);
982 *offset = segoff + (first - gpa);
987 vcpu_unlock_one(sc, lastcpu);
992 vmmdev_destroy(void *arg)
994 struct vmmdev_softc *sc = arg;
995 struct devmem_softc *dsc;
996 int error __diagused;
998 error = vcpu_lock_all(sc);
999 KASSERT(error == 0, ("%s: error %d freezing vcpus", __func__, error));
1001 while ((dsc = SLIST_FIRST(&sc->devmem)) != NULL) {
1002 KASSERT(dsc->cdev == NULL, ("%s: devmem not free", __func__));
1003 SLIST_REMOVE_HEAD(&sc->devmem, link);
1004 free(dsc->name, M_VMMDEV);
1005 free(dsc, M_VMMDEV);
1008 if (sc->cdev != NULL)
1009 destroy_dev(sc->cdev);
1014 if (sc->ucred != NULL)
1017 if ((sc->flags & VSC_LINKED) != 0) {
1018 mtx_lock(&vmmdev_mtx);
1019 SLIST_REMOVE(&head, sc, vmmdev_softc, link);
1020 mtx_unlock(&vmmdev_mtx);
1027 sysctl_vmm_destroy(SYSCTL_HANDLER_ARGS)
1029 struct devmem_softc *dsc;
1030 struct vmmdev_softc *sc;
1035 error = vmm_priv_check(req->td->td_ucred);
1039 buflen = VM_MAX_NAMELEN + 1;
1040 buf = malloc(buflen, M_VMMDEV, M_WAITOK | M_ZERO);
1041 strlcpy(buf, "beavis", buflen);
1042 error = sysctl_handle_string(oidp, buf, buflen, req);
1043 if (error != 0 || req->newptr == NULL)
1046 mtx_lock(&vmmdev_mtx);
1047 sc = vmmdev_lookup(buf);
1048 if (sc == NULL || sc->cdev == NULL) {
1049 mtx_unlock(&vmmdev_mtx);
1055 * Setting 'sc->cdev' to NULL is used to indicate that the VM
1056 * is scheduled for destruction.
1060 mtx_unlock(&vmmdev_mtx);
1063 * Destroy all cdevs:
1065 * - any new operations on the 'cdev' will return an error (ENXIO).
1067 * - the 'devmem' cdevs are destroyed before the virtual machine 'cdev'
1069 SLIST_FOREACH(dsc, &sc->devmem, link) {
1070 KASSERT(dsc->cdev != NULL, ("devmem cdev already destroyed"));
1071 destroy_dev(dsc->cdev);
1072 devmem_destroy(dsc);
1079 free(buf, M_VMMDEV);
1082 SYSCTL_PROC(_hw_vmm, OID_AUTO, destroy,
1083 CTLTYPE_STRING | CTLFLAG_RW | CTLFLAG_PRISON | CTLFLAG_MPSAFE,
1084 NULL, 0, sysctl_vmm_destroy, "A",
1087 static struct cdevsw vmmdevsw = {
1089 .d_version = D_VERSION,
1090 .d_ioctl = vmmdev_ioctl,
1091 .d_mmap_single = vmmdev_mmap_single,
1092 .d_read = vmmdev_rw,
1093 .d_write = vmmdev_rw,
1097 sysctl_vmm_create(SYSCTL_HANDLER_ARGS)
1101 struct vmmdev_softc *sc, *sc2;
1105 error = vmm_priv_check(req->td->td_ucred);
1109 buflen = VM_MAX_NAMELEN + 1;
1110 buf = malloc(buflen, M_VMMDEV, M_WAITOK | M_ZERO);
1111 strlcpy(buf, "beavis", buflen);
1112 error = sysctl_handle_string(oidp, buf, buflen, req);
1113 if (error != 0 || req->newptr == NULL)
1116 mtx_lock(&vmmdev_mtx);
1117 sc = vmmdev_lookup(buf);
1118 mtx_unlock(&vmmdev_mtx);
1124 error = vm_create(buf, &vm);
1128 sc = malloc(sizeof(struct vmmdev_softc), M_VMMDEV, M_WAITOK | M_ZERO);
1129 sc->ucred = crhold(curthread->td_ucred);
1131 SLIST_INIT(&sc->devmem);
1134 * Lookup the name again just in case somebody sneaked in when we
1137 mtx_lock(&vmmdev_mtx);
1138 sc2 = vmmdev_lookup(buf);
1140 SLIST_INSERT_HEAD(&head, sc, link);
1141 sc->flags |= VSC_LINKED;
1143 mtx_unlock(&vmmdev_mtx);
1151 error = make_dev_p(MAKEDEV_CHECKNAME, &cdev, &vmmdevsw, sc->ucred,
1152 UID_ROOT, GID_WHEEL, 0600, "vmm/%s", buf);
1158 mtx_lock(&vmmdev_mtx);
1160 sc->cdev->si_drv1 = sc;
1161 mtx_unlock(&vmmdev_mtx);
1164 free(buf, M_VMMDEV);
1167 SYSCTL_PROC(_hw_vmm, OID_AUTO, create,
1168 CTLTYPE_STRING | CTLFLAG_RW | CTLFLAG_PRISON | CTLFLAG_MPSAFE,
1169 NULL, 0, sysctl_vmm_create, "A",
1175 mtx_init(&vmmdev_mtx, "vmm device mutex", NULL, MTX_DEF);
1176 pr_allow_flag = prison_add_allow(NULL, "vmm", NULL,
1177 "Allow use of vmm in a jail.");
1181 vmmdev_cleanup(void)
1185 if (SLIST_EMPTY(&head))
1194 devmem_mmap_single(struct cdev *cdev, vm_ooffset_t *offset, vm_size_t len,
1195 struct vm_object **objp, int nprot)
1197 struct devmem_softc *dsc;
1198 vm_ooffset_t first, last;
1204 dsc = cdev->si_drv1;
1206 /* 'cdev' has been created but is not ready for use */
1211 last = *offset + len;
1212 if ((nprot & PROT_EXEC) || first < 0 || first >= last)
1215 lastcpu = vm_get_maxcpus(dsc->sc->vm) - 1;
1216 error = vcpu_lock_one(dsc->sc, lastcpu);
1220 error = vm_get_memseg(dsc->sc->vm, dsc->segid, &seglen, &sysmem, objp);
1221 KASSERT(error == 0 && !sysmem && *objp != NULL,
1222 ("%s: invalid devmem segment %d", __func__, dsc->segid));
1224 vcpu_unlock_one(dsc->sc, lastcpu);
1226 if (seglen >= last) {
1227 vm_object_reference(*objp);
1234 static struct cdevsw devmemsw = {
1236 .d_version = D_VERSION,
1237 .d_mmap_single = devmem_mmap_single,
1241 devmem_create_cdev(const char *vmname, int segid, char *devname)
1243 struct devmem_softc *dsc;
1244 struct vmmdev_softc *sc;
1248 error = make_dev_p(MAKEDEV_CHECKNAME, &cdev, &devmemsw, NULL,
1249 UID_ROOT, GID_WHEEL, 0600, "vmm.io/%s.%s", vmname, devname);
1253 dsc = malloc(sizeof(struct devmem_softc), M_VMMDEV, M_WAITOK | M_ZERO);
1255 mtx_lock(&vmmdev_mtx);
1256 sc = vmmdev_lookup(vmname);
1257 KASSERT(sc != NULL, ("%s: vm %s softc not found", __func__, vmname));
1258 if (sc->cdev == NULL) {
1259 /* virtual machine is being created or destroyed */
1260 mtx_unlock(&vmmdev_mtx);
1261 free(dsc, M_VMMDEV);
1262 destroy_dev_sched_cb(cdev, NULL, 0);
1267 dsc->name = devname;
1270 SLIST_INSERT_HEAD(&sc->devmem, dsc, link);
1271 mtx_unlock(&vmmdev_mtx);
1273 /* The 'cdev' is ready for use after 'si_drv1' is initialized */
1274 cdev->si_drv1 = dsc;
1279 devmem_destroy(void *arg)
1281 struct devmem_softc *dsc = arg;
1283 KASSERT(dsc->cdev, ("%s: devmem cdev already destroyed", __func__));