2 * Copyright (c) 2011 NetApp, Inc.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY NETAPP, INC ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL NETAPP, INC OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
32 #include <sys/param.h>
33 #include <sys/kernel.h>
34 #include <sys/queue.h>
36 #include <sys/mutex.h>
37 #include <sys/malloc.h>
39 #include <sys/sysctl.h>
40 #include <sys/libkern.h>
41 #include <sys/ioccom.h>
47 #include <vm/vm_map.h>
49 #include <machine/pmap.h>
50 #include <machine/vmparam.h>
52 #include <machine/vmm.h>
53 #include "vmm_lapic.h"
57 #include <machine/vmm_dev.h>
60 struct vm *vm; /* vm instance cookie */
62 SLIST_ENTRY(vmmdev_softc) link;
64 static SLIST_HEAD(, vmmdev_softc) head;
66 static struct mtx vmmdev_mtx;
68 static MALLOC_DEFINE(M_VMMDEV, "vmmdev", "vmmdev");
72 static struct vmmdev_softc *
73 vmmdev_lookup(const char *name)
75 struct vmmdev_softc *sc;
77 #ifdef notyet /* XXX kernel is not compiled with invariants */
78 mtx_assert(&vmmdev_mtx, MA_OWNED);
81 SLIST_FOREACH(sc, &head, link) {
82 if (strcmp(name, vm_name(sc->vm)) == 0)
89 static struct vmmdev_softc *
90 vmmdev_lookup2(struct cdev *cdev)
93 return (cdev->si_drv1);
97 vmmdev_rw(struct cdev *cdev, struct uio *uio, int flags)
99 int error, off, c, prot;
102 struct vmmdev_softc *sc;
104 static char zerobuf[PAGE_SIZE];
107 mtx_lock(&vmmdev_mtx);
108 sc = vmmdev_lookup2(cdev);
112 prot = (uio->uio_rw == UIO_WRITE ? VM_PROT_WRITE : VM_PROT_READ);
113 while (uio->uio_resid > 0 && error == 0) {
114 gpa = uio->uio_offset;
115 off = gpa & PAGE_MASK;
116 c = min(uio->uio_resid, PAGE_SIZE - off);
119 * The VM has a hole in its physical memory map. If we want to
120 * use 'dd' to inspect memory beyond the hole we need to
121 * provide bogus data for memory that lies in the hole.
123 * Since this device does not support lseek(2), dd(1) will
124 * read(2) blocks of data to simulate the lseek(2).
126 hpa = vm_gpa_hold(sc->vm, gpa, c, prot, &cookie);
128 if (uio->uio_rw == UIO_READ)
129 error = uiomove(zerobuf, c, uio);
133 error = uiomove(hpa, c, uio);
134 vm_gpa_release(cookie);
138 mtx_unlock(&vmmdev_mtx);
143 vmmdev_ioctl(struct cdev *cdev, u_long cmd, caddr_t data, int fflag,
146 int error, vcpu, state_changed;
147 struct vmmdev_softc *sc;
148 struct vm_memory_segment *seg;
149 struct vm_register *vmreg;
150 struct vm_seg_desc* vmsegdesc;
151 struct vm_run *vmrun;
152 struct vm_event *vmevent;
153 struct vm_lapic_irq *vmirq;
154 struct vm_capability *vmcap;
155 struct vm_pptdev *pptdev;
156 struct vm_pptdev_mmio *pptmmio;
157 struct vm_pptdev_msi *pptmsi;
158 struct vm_pptdev_msix *pptmsix;
159 struct vm_nmi *vmnmi;
160 struct vm_stats *vmstats;
161 struct vm_stat_desc *statdesc;
162 struct vm_x2apic *x2apic;
163 struct vm_gpa_pte *gpapte;
165 sc = vmmdev_lookup2(cdev);
173 * Some VMM ioctls can operate only on vcpus that are not running.
177 case VM_GET_REGISTER:
178 case VM_SET_REGISTER:
179 case VM_GET_SEGMENT_DESCRIPTOR:
180 case VM_SET_SEGMENT_DESCRIPTOR:
181 case VM_INJECT_EVENT:
182 case VM_GET_CAPABILITY:
183 case VM_SET_CAPABILITY:
186 case VM_SET_X2APIC_STATE:
188 * XXX fragile, handle with care
189 * Assumes that the first field of the ioctl data is the vcpu.
192 if (vcpu < 0 || vcpu >= VM_MAXCPU) {
197 error = vcpu_set_state(sc->vm, vcpu, VCPU_FROZEN);
204 case VM_MAP_PPTDEV_MMIO:
206 case VM_UNBIND_PPTDEV:
209 * ioctls that operate on the entire virtual machine must
210 * prevent all vcpus from running.
213 for (vcpu = 0; vcpu < VM_MAXCPU; vcpu++) {
214 error = vcpu_set_state(sc->vm, vcpu, VCPU_FROZEN);
221 vcpu_set_state(sc->vm, vcpu, VCPU_IDLE);
234 vmrun = (struct vm_run *)data;
235 error = vm_run(sc->vm, vmrun);
238 statdesc = (struct vm_stat_desc *)data;
239 error = vmm_stat_desc_copy(statdesc->index,
240 statdesc->desc, sizeof(statdesc->desc));
244 CTASSERT(MAX_VM_STATS >= MAX_VMM_STAT_ELEMS);
245 vmstats = (struct vm_stats *)data;
246 getmicrotime(&vmstats->tv);
247 error = vmm_stat_copy(sc->vm, vmstats->cpuid,
248 &vmstats->num_entries, vmstats->statbuf);
252 pptmsi = (struct vm_pptdev_msi *)data;
253 error = ppt_setup_msi(sc->vm, pptmsi->vcpu,
254 pptmsi->bus, pptmsi->slot, pptmsi->func,
255 pptmsi->destcpu, pptmsi->vector,
259 pptmsix = (struct vm_pptdev_msix *)data;
260 error = ppt_setup_msix(sc->vm, pptmsix->vcpu,
261 pptmsix->bus, pptmsix->slot,
262 pptmsix->func, pptmsix->idx,
263 pptmsix->msg, pptmsix->vector_control,
266 case VM_MAP_PPTDEV_MMIO:
267 pptmmio = (struct vm_pptdev_mmio *)data;
268 error = ppt_map_mmio(sc->vm, pptmmio->bus, pptmmio->slot,
269 pptmmio->func, pptmmio->gpa, pptmmio->len,
273 pptdev = (struct vm_pptdev *)data;
274 error = vm_assign_pptdev(sc->vm, pptdev->bus, pptdev->slot,
277 case VM_UNBIND_PPTDEV:
278 pptdev = (struct vm_pptdev *)data;
279 error = vm_unassign_pptdev(sc->vm, pptdev->bus, pptdev->slot,
282 case VM_INJECT_EVENT:
283 vmevent = (struct vm_event *)data;
284 error = vm_inject_event(sc->vm, vmevent->cpuid, vmevent->type,
287 vmevent->error_code_valid);
290 vmnmi = (struct vm_nmi *)data;
291 error = vm_inject_nmi(sc->vm, vmnmi->cpuid);
294 vmirq = (struct vm_lapic_irq *)data;
295 error = lapic_set_intr(sc->vm, vmirq->cpuid, vmirq->vector);
298 seg = (struct vm_memory_segment *)data;
299 error = vm_malloc(sc->vm, seg->gpa, seg->len);
301 case VM_GET_MEMORY_SEG:
302 seg = (struct vm_memory_segment *)data;
304 (void)vm_gpabase2memseg(sc->vm, seg->gpa, seg);
307 case VM_GET_REGISTER:
308 vmreg = (struct vm_register *)data;
309 error = vm_get_register(sc->vm, vmreg->cpuid, vmreg->regnum,
312 case VM_SET_REGISTER:
313 vmreg = (struct vm_register *)data;
314 error = vm_set_register(sc->vm, vmreg->cpuid, vmreg->regnum,
317 case VM_SET_SEGMENT_DESCRIPTOR:
318 vmsegdesc = (struct vm_seg_desc *)data;
319 error = vm_set_seg_desc(sc->vm, vmsegdesc->cpuid,
323 case VM_GET_SEGMENT_DESCRIPTOR:
324 vmsegdesc = (struct vm_seg_desc *)data;
325 error = vm_get_seg_desc(sc->vm, vmsegdesc->cpuid,
329 case VM_GET_CAPABILITY:
330 vmcap = (struct vm_capability *)data;
331 error = vm_get_capability(sc->vm, vmcap->cpuid,
335 case VM_SET_CAPABILITY:
336 vmcap = (struct vm_capability *)data;
337 error = vm_set_capability(sc->vm, vmcap->cpuid,
341 case VM_SET_X2APIC_STATE:
342 x2apic = (struct vm_x2apic *)data;
343 error = vm_set_x2apic_state(sc->vm,
344 x2apic->cpuid, x2apic->state);
346 case VM_GET_X2APIC_STATE:
347 x2apic = (struct vm_x2apic *)data;
348 error = vm_get_x2apic_state(sc->vm,
349 x2apic->cpuid, &x2apic->state);
351 case VM_GET_GPA_PMAP:
352 gpapte = (struct vm_gpa_pte *)data;
353 pmap_get_mapping(vmspace_pmap(vm_get_vmspace(sc->vm)),
354 gpapte->gpa, gpapte->pte, &gpapte->ptenum);
362 if (state_changed == 1) {
363 vcpu_set_state(sc->vm, vcpu, VCPU_IDLE);
364 } else if (state_changed == 2) {
365 for (vcpu = 0; vcpu < VM_MAXCPU; vcpu++)
366 vcpu_set_state(sc->vm, vcpu, VCPU_IDLE);
370 /* Make sure that no handler returns a bogus value like ERESTART */
371 KASSERT(error >= 0, ("vmmdev_ioctl: invalid error return %d", error));
376 vmmdev_mmap_single(struct cdev *cdev, vm_ooffset_t *offset,
377 vm_size_t size, struct vm_object **object, int nprot)
380 struct vmmdev_softc *sc;
382 mtx_lock(&vmmdev_mtx);
384 sc = vmmdev_lookup2(cdev);
385 if (sc != NULL && (nprot & PROT_EXEC) == 0)
386 error = vm_get_memobj(sc->vm, *offset, size, offset, object);
390 mtx_unlock(&vmmdev_mtx);
396 vmmdev_destroy(struct vmmdev_softc *sc, boolean_t unlink)
400 * XXX must stop virtual machine instances that may be still
401 * running and cleanup their state.
404 destroy_dev(sc->cdev);
410 mtx_lock(&vmmdev_mtx);
411 SLIST_REMOVE(&head, sc, vmmdev_softc, link);
412 mtx_unlock(&vmmdev_mtx);
419 sysctl_vmm_destroy(SYSCTL_HANDLER_ARGS)
422 char buf[VM_MAX_NAMELEN];
423 struct vmmdev_softc *sc;
425 strlcpy(buf, "beavis", sizeof(buf));
426 error = sysctl_handle_string(oidp, buf, sizeof(buf), req);
427 if (error != 0 || req->newptr == NULL)
431 * XXX TODO if any process has this device open then fail
434 mtx_lock(&vmmdev_mtx);
435 sc = vmmdev_lookup(buf);
437 mtx_unlock(&vmmdev_mtx);
441 sc->cdev->si_drv1 = NULL;
442 mtx_unlock(&vmmdev_mtx);
444 vmmdev_destroy(sc, TRUE);
448 SYSCTL_PROC(_hw_vmm, OID_AUTO, destroy, CTLTYPE_STRING | CTLFLAG_RW,
449 NULL, 0, sysctl_vmm_destroy, "A", NULL);
451 static struct cdevsw vmmdevsw = {
453 .d_version = D_VERSION,
454 .d_ioctl = vmmdev_ioctl,
455 .d_mmap_single = vmmdev_mmap_single,
457 .d_write = vmmdev_rw,
461 sysctl_vmm_create(SYSCTL_HANDLER_ARGS)
465 struct vmmdev_softc *sc, *sc2;
466 char buf[VM_MAX_NAMELEN];
468 strlcpy(buf, "beavis", sizeof(buf));
469 error = sysctl_handle_string(oidp, buf, sizeof(buf), req);
470 if (error != 0 || req->newptr == NULL)
473 mtx_lock(&vmmdev_mtx);
474 sc = vmmdev_lookup(buf);
475 mtx_unlock(&vmmdev_mtx);
479 error = vm_create(buf, &vm);
483 sc = malloc(sizeof(struct vmmdev_softc), M_VMMDEV, M_WAITOK | M_ZERO);
487 * Lookup the name again just in case somebody sneaked in when we
490 mtx_lock(&vmmdev_mtx);
491 sc2 = vmmdev_lookup(buf);
493 SLIST_INSERT_HEAD(&head, sc, link);
494 mtx_unlock(&vmmdev_mtx);
497 vmmdev_destroy(sc, FALSE);
501 error = make_dev_p(MAKEDEV_CHECKNAME, &sc->cdev, &vmmdevsw, NULL,
502 UID_ROOT, GID_WHEEL, 0600, "vmm/%s", buf);
504 vmmdev_destroy(sc, TRUE);
507 sc->cdev->si_drv1 = sc;
511 SYSCTL_PROC(_hw_vmm, OID_AUTO, create, CTLTYPE_STRING | CTLFLAG_RW,
512 NULL, 0, sysctl_vmm_create, "A", NULL);
517 mtx_init(&vmmdev_mtx, "vmm device mutex", NULL, MTX_DEF);
525 if (SLIST_EMPTY(&head))