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 <sys/types.h>
35 #ifndef WITHOUT_CAPSICUM
36 #include <sys/capsicum.h>
40 #include <sys/socket.h>
48 #include <amd64/vmm/intel/vmcs.h>
50 #include <machine/atomic.h>
51 #include <machine/segments.h>
53 #ifndef WITHOUT_CAPSICUM
54 #include <capsicum_helpers.h>
68 #include <pthread_np.h>
79 #include <machine/vmm.h>
80 #ifndef WITHOUT_CAPSICUM
81 #include <machine/vmm_dev.h>
83 #include <machine/vmm_instruction_emul.h>
96 #include "kernemu_dev.h"
100 #include "pci_emul.h"
103 #include "smbiostbl.h"
104 #ifdef BHYVE_SNAPSHOT
105 #include "snapshot.h"
108 #include "spinup_ap.h"
112 #define GUEST_NIO_PORT 0x488 /* guest upcalls via i/o port */
114 #define MB (1024UL * 1024)
115 #define GB (1024UL * MB)
117 static const char * const vmx_exit_reason_desc[] = {
118 [EXIT_REASON_EXCEPTION] = "Exception or non-maskable interrupt (NMI)",
119 [EXIT_REASON_EXT_INTR] = "External interrupt",
120 [EXIT_REASON_TRIPLE_FAULT] = "Triple fault",
121 [EXIT_REASON_INIT] = "INIT signal",
122 [EXIT_REASON_SIPI] = "Start-up IPI (SIPI)",
123 [EXIT_REASON_IO_SMI] = "I/O system-management interrupt (SMI)",
124 [EXIT_REASON_SMI] = "Other SMI",
125 [EXIT_REASON_INTR_WINDOW] = "Interrupt window",
126 [EXIT_REASON_NMI_WINDOW] = "NMI window",
127 [EXIT_REASON_TASK_SWITCH] = "Task switch",
128 [EXIT_REASON_CPUID] = "CPUID",
129 [EXIT_REASON_GETSEC] = "GETSEC",
130 [EXIT_REASON_HLT] = "HLT",
131 [EXIT_REASON_INVD] = "INVD",
132 [EXIT_REASON_INVLPG] = "INVLPG",
133 [EXIT_REASON_RDPMC] = "RDPMC",
134 [EXIT_REASON_RDTSC] = "RDTSC",
135 [EXIT_REASON_RSM] = "RSM",
136 [EXIT_REASON_VMCALL] = "VMCALL",
137 [EXIT_REASON_VMCLEAR] = "VMCLEAR",
138 [EXIT_REASON_VMLAUNCH] = "VMLAUNCH",
139 [EXIT_REASON_VMPTRLD] = "VMPTRLD",
140 [EXIT_REASON_VMPTRST] = "VMPTRST",
141 [EXIT_REASON_VMREAD] = "VMREAD",
142 [EXIT_REASON_VMRESUME] = "VMRESUME",
143 [EXIT_REASON_VMWRITE] = "VMWRITE",
144 [EXIT_REASON_VMXOFF] = "VMXOFF",
145 [EXIT_REASON_VMXON] = "VMXON",
146 [EXIT_REASON_CR_ACCESS] = "Control-register accesses",
147 [EXIT_REASON_DR_ACCESS] = "MOV DR",
148 [EXIT_REASON_INOUT] = "I/O instruction",
149 [EXIT_REASON_RDMSR] = "RDMSR",
150 [EXIT_REASON_WRMSR] = "WRMSR",
151 [EXIT_REASON_INVAL_VMCS] =
152 "VM-entry failure due to invalid guest state",
153 [EXIT_REASON_INVAL_MSR] = "VM-entry failure due to MSR loading",
154 [EXIT_REASON_MWAIT] = "MWAIT",
155 [EXIT_REASON_MTF] = "Monitor trap flag",
156 [EXIT_REASON_MONITOR] = "MONITOR",
157 [EXIT_REASON_PAUSE] = "PAUSE",
158 [EXIT_REASON_MCE_DURING_ENTRY] =
159 "VM-entry failure due to machine-check event",
160 [EXIT_REASON_TPR] = "TPR below threshold",
161 [EXIT_REASON_APIC_ACCESS] = "APIC access",
162 [EXIT_REASON_VIRTUALIZED_EOI] = "Virtualized EOI",
163 [EXIT_REASON_GDTR_IDTR] = "Access to GDTR or IDTR",
164 [EXIT_REASON_LDTR_TR] = "Access to LDTR or TR",
165 [EXIT_REASON_EPT_FAULT] = "EPT violation",
166 [EXIT_REASON_EPT_MISCONFIG] = "EPT misconfiguration",
167 [EXIT_REASON_INVEPT] = "INVEPT",
168 [EXIT_REASON_RDTSCP] = "RDTSCP",
169 [EXIT_REASON_VMX_PREEMPT] = "VMX-preemption timer expired",
170 [EXIT_REASON_INVVPID] = "INVVPID",
171 [EXIT_REASON_WBINVD] = "WBINVD",
172 [EXIT_REASON_XSETBV] = "XSETBV",
173 [EXIT_REASON_APIC_WRITE] = "APIC write",
174 [EXIT_REASON_RDRAND] = "RDRAND",
175 [EXIT_REASON_INVPCID] = "INVPCID",
176 [EXIT_REASON_VMFUNC] = "VMFUNC",
177 [EXIT_REASON_ENCLS] = "ENCLS",
178 [EXIT_REASON_RDSEED] = "RDSEED",
179 [EXIT_REASON_PM_LOG_FULL] = "Page-modification log full",
180 [EXIT_REASON_XSAVES] = "XSAVES",
181 [EXIT_REASON_XRSTORS] = "XRSTORS"
184 typedef int (*vmexit_handler_t)(struct vmctx *, struct vm_exit *, int *vcpu);
185 extern int vmexit_task_switch(struct vmctx *, struct vm_exit *, int *vcpu);
188 uint16_t cores, maxcpus, sockets, threads;
192 static char *progname;
193 static const int BSP = 0;
195 static cpuset_t cpumask;
197 static void vm_loop(struct vmctx *ctx, int vcpu, uint64_t rip);
199 static struct vm_exit *vmexit;
201 static struct bhyvestats {
202 uint64_t vmexit_bogus;
203 uint64_t vmexit_reqidle;
205 uint64_t vmexit_pause;
206 uint64_t vmexit_mtrap;
207 uint64_t vmexit_inst_emul;
208 uint64_t cpu_switch_rotate;
209 uint64_t cpu_switch_direct;
212 static struct mt_vmm_info {
214 struct vmctx *mt_ctx;
218 static cpuset_t **vcpumap;
225 "Usage: %s [-AaCDeHhPSuWwxY]\n"
226 " %*s [-c [[cpus=]numcpus][,sockets=n][,cores=n][,threads=n]]\n"
227 " %*s [-G port] [-k config_file] [-l lpc] [-m mem] [-o var=value]\n"
228 " %*s [-p vcpu:hostcpu] [-r file] [-s pci] [-U uuid] vmname\n"
229 " -A: create ACPI tables\n"
230 " -a: local apic is in xAPIC mode (deprecated)\n"
231 " -C: include guest memory in core file\n"
232 " -c: number of CPUs and/or topology specification\n"
233 " -D: destroy on power-off\n"
234 " -e: exit on unhandled I/O access\n"
235 " -G: start a debug server\n"
236 " -H: vmexit from the guest on HLT\n"
238 " -k: key=value flat config file\n"
239 " -K: PS2 keyboard layout\n"
240 " -l: LPC device configuration\n"
242 " -o: set config 'var' to 'value'\n"
243 " -P: vmexit from the guest on pause\n"
244 " -p: pin 'vcpu' to 'hostcpu'\n"
245 #ifdef BHYVE_SNAPSHOT
246 " -r: path to checkpoint file\n"
248 " -S: guest memory cannot be swapped\n"
249 " -s: <slot,driver,configinfo> PCI slot config\n"
251 " -u: RTC keeps UTC time\n"
252 " -W: force virtio to use single-vector MSI\n"
253 " -w: ignore unimplemented MSRs\n"
254 " -x: local APIC is in x2APIC mode\n"
255 " -Y: disable MPtable generation\n",
256 progname, (int)strlen(progname), "", (int)strlen(progname), "",
257 (int)strlen(progname), "");
263 * XXX This parser is known to have the following issues:
264 * 1. It accepts null key=value tokens ",," as setting "cpus" to an
267 * The acceptance of a null specification ('-c ""') is by design to match the
268 * manual page syntax specification, this results in a topology of 1 vCPU.
271 topology_parse(const char *opt)
273 char *cp, *str, *tofree;
276 set_config_value("sockets", "1");
277 set_config_value("cores", "1");
278 set_config_value("threads", "1");
279 set_config_value("cpus", "1");
283 tofree = str = strdup(opt);
285 errx(4, "Failed to allocate memory");
287 while ((cp = strsep(&str, ",")) != NULL) {
288 if (strncmp(cp, "cpus=", strlen("cpus=")) == 0)
289 set_config_value("cpus", cp + strlen("cpus="));
290 else if (strncmp(cp, "sockets=", strlen("sockets=")) == 0)
291 set_config_value("sockets", cp + strlen("sockets="));
292 else if (strncmp(cp, "cores=", strlen("cores=")) == 0)
293 set_config_value("cores", cp + strlen("cores="));
294 else if (strncmp(cp, "threads=", strlen("threads=")) == 0)
295 set_config_value("threads", cp + strlen("threads="));
296 #ifdef notyet /* Do not expose this until vmm.ko implements it */
297 else if (strncmp(cp, "maxcpus=", strlen("maxcpus=")) == 0)
298 set_config_value("maxcpus", cp + strlen("maxcpus="));
300 else if (strchr(cp, '=') != NULL)
303 set_config_value("cpus", cp);
314 parse_int_value(const char *key, const char *value, int minval, int maxval)
320 lval = strtol(value, &cp, 0);
321 if (errno != 0 || *cp != '\0' || cp == value || lval < minval ||
323 errx(4, "Invalid value for %s: '%s'", key, value);
328 * Set the sockets, cores, threads, and guest_cpus variables based on
329 * the configured topology.
331 * The limits of UINT16_MAX are due to the types passed to
332 * vm_set_topology(). vmm.ko may enforce tighter limits.
341 value = get_config_value("cpus");
343 guest_ncpus = parse_int_value("cpus", value, 1, UINT16_MAX);
344 explicit_cpus = true;
347 explicit_cpus = false;
349 value = get_config_value("cores");
351 cores = parse_int_value("cores", value, 1, UINT16_MAX);
354 value = get_config_value("threads");
356 threads = parse_int_value("threads", value, 1, UINT16_MAX);
359 value = get_config_value("sockets");
361 sockets = parse_int_value("sockets", value, 1, UINT16_MAX);
363 sockets = guest_ncpus;
366 * Compute sockets * cores * threads avoiding overflow. The
367 * range check above insures these are 16 bit values.
369 ncpus = (uint64_t)sockets * cores * threads;
370 if (ncpus > UINT16_MAX)
371 errx(4, "Computed number of vCPUs too high: %ju",
375 if (guest_ncpus != ncpus)
376 errx(4, "Topology (%d sockets, %d cores, %d threads) "
377 "does not match %d vCPUs", sockets, cores, threads,
384 pincpu_parse(const char *opt)
391 if (sscanf(opt, "%d:%d", &vcpu, &pcpu) != 2) {
392 fprintf(stderr, "invalid format: %s\n", opt);
397 fprintf(stderr, "invalid vcpu '%d'\n", vcpu);
401 if (pcpu < 0 || pcpu >= CPU_SETSIZE) {
402 fprintf(stderr, "hostcpu '%d' outside valid range from "
403 "0 to %d\n", pcpu, CPU_SETSIZE - 1);
407 snprintf(key, sizeof(key), "vcpu.%d.cpuset", vcpu);
408 value = get_config_value(key);
410 if (asprintf(&newval, "%s%s%d", value != NULL ? value : "",
411 value != NULL ? "," : "", pcpu) == -1) {
412 perror("failed to build new cpuset string");
416 set_config_value(key, newval);
422 parse_cpuset(int vcpu, const char *list, cpuset_t *set)
429 token = __DECONST(char *, list);
431 pcpu = strtoul(token, &cp, 0);
433 errx(4, "invalid cpuset for vcpu %d: '%s'", vcpu, list);
434 if (pcpu < 0 || pcpu >= CPU_SETSIZE)
435 errx(4, "hostcpu '%d' outside valid range from 0 to %d",
436 pcpu, CPU_SETSIZE - 1);
442 errx(4, "Invalid hostcpu range %d-%d",
444 while (start < pcpu) {
445 CPU_SET(start, vcpumap[vcpu]);
450 CPU_SET(pcpu, vcpumap[vcpu]);
454 errx(4, "invalid cpuset for vcpu %d: '%s'",
459 errx(4, "invalid cpuset for vcpu %d: '%s'", vcpu, list);
474 vcpumap = calloc(guest_ncpus, sizeof(*vcpumap));
475 for (vcpu = 0; vcpu < guest_ncpus; vcpu++) {
476 snprintf(key, sizeof(key), "vcpu.%d.cpuset", vcpu);
477 value = get_config_value(key);
480 vcpumap[vcpu] = malloc(sizeof(cpuset_t));
481 if (vcpumap[vcpu] == NULL)
482 err(4, "Failed to allocate cpuset for vcpu %d", vcpu);
483 parse_cpuset(vcpu, value, vcpumap[vcpu]);
488 vm_inject_fault(void *arg, int vcpu, int vector, int errcode_valid,
492 int error, restart_instruction;
495 restart_instruction = 1;
497 error = vm_inject_exception(ctx, vcpu, vector, errcode_valid, errcode,
498 restart_instruction);
503 paddr_guest2host(struct vmctx *ctx, uintptr_t gaddr, size_t len)
506 return (vm_map_gpa(ctx, gaddr, len));
509 #ifdef BHYVE_SNAPSHOT
511 paddr_host2guest(struct vmctx *ctx, void *addr)
513 return (vm_rev_map_gpa(ctx, addr));
518 fbsdrun_virtio_msix(void)
521 return (get_config_bool_default("virtio_msix", true));
525 fbsdrun_start_thread(void *param)
527 char tname[MAXCOMLEN + 1];
528 struct mt_vmm_info *mtp;
534 snprintf(tname, sizeof(tname), "vcpu %d", vcpu);
535 pthread_set_name_np(mtp->mt_thr, tname);
537 #ifdef BHYVE_SNAPSHOT
538 checkpoint_cpu_add(vcpu);
542 vm_loop(mtp->mt_ctx, vcpu, vmexit[vcpu].rip);
550 fbsdrun_addcpu(struct vmctx *ctx, int newcpu, uint64_t rip, bool suspend)
555 * The 'newcpu' must be activated in the context of 'fromcpu'. If
556 * vm_activate_cpu() is delayed until newcpu's pthread starts running
557 * then vmm.ko is out-of-sync with bhyve and this can create a race
560 error = vm_activate_cpu(ctx, newcpu);
562 err(EX_OSERR, "could not activate CPU %d", newcpu);
564 CPU_SET_ATOMIC(newcpu, &cpumask);
567 vm_suspend_cpu(ctx, newcpu);
570 * Set up the vmexit struct to allow execution to start
573 vmexit[newcpu].rip = rip;
574 vmexit[newcpu].inst_length = 0;
576 mt_vmm_info[newcpu].mt_ctx = ctx;
577 mt_vmm_info[newcpu].mt_vcpu = newcpu;
579 error = pthread_create(&mt_vmm_info[newcpu].mt_thr, NULL,
580 fbsdrun_start_thread, &mt_vmm_info[newcpu]);
585 fbsdrun_deletecpu(int vcpu)
588 if (!CPU_ISSET(vcpu, &cpumask)) {
589 fprintf(stderr, "Attempting to delete unknown cpu %d\n", vcpu);
593 CPU_CLR_ATOMIC(vcpu, &cpumask);
594 return (CPU_EMPTY(&cpumask));
598 vmexit_handle_notify(struct vmctx *ctx __unused, struct vm_exit *vme __unused,
599 int *pvcpu __unused, uint32_t eax __unused)
603 * put guest-driven debug here
606 return (VMEXIT_CONTINUE);
610 vmexit_inout(struct vmctx *ctx, struct vm_exit *vme, int *pvcpu)
613 int bytes, port, in, out;
618 port = vme->u.inout.port;
619 bytes = vme->u.inout.bytes;
620 in = vme->u.inout.in;
623 /* Extra-special case of host notifications */
624 if (out && port == GUEST_NIO_PORT) {
625 error = vmexit_handle_notify(ctx, vme, pvcpu, vme->u.inout.eax);
629 error = emulate_inout(ctx, vcpu, vme);
631 fprintf(stderr, "Unhandled %s%c 0x%04x at 0x%lx\n",
633 bytes == 1 ? 'b' : (bytes == 2 ? 'w' : 'l'),
635 return (VMEXIT_ABORT);
637 return (VMEXIT_CONTINUE);
642 vmexit_rdmsr(struct vmctx *ctx, struct vm_exit *vme, int *pvcpu)
649 error = emulate_rdmsr(ctx, *pvcpu, vme->u.msr.code, &val);
651 fprintf(stderr, "rdmsr to register %#x on vcpu %d\n",
652 vme->u.msr.code, *pvcpu);
653 if (get_config_bool("x86.strictmsr")) {
654 vm_inject_gp(ctx, *pvcpu);
655 return (VMEXIT_CONTINUE);
660 error = vm_set_register(ctx, *pvcpu, VM_REG_GUEST_RAX, eax);
664 error = vm_set_register(ctx, *pvcpu, VM_REG_GUEST_RDX, edx);
667 return (VMEXIT_CONTINUE);
671 vmexit_wrmsr(struct vmctx *ctx, struct vm_exit *vme, int *pvcpu)
675 error = emulate_wrmsr(ctx, *pvcpu, vme->u.msr.code, vme->u.msr.wval);
677 fprintf(stderr, "wrmsr to register %#x(%#lx) on vcpu %d\n",
678 vme->u.msr.code, vme->u.msr.wval, *pvcpu);
679 if (get_config_bool("x86.strictmsr")) {
680 vm_inject_gp(ctx, *pvcpu);
681 return (VMEXIT_CONTINUE);
684 return (VMEXIT_CONTINUE);
688 vmexit_spinup_ap(struct vmctx *ctx, struct vm_exit *vme, int *pvcpu __unused)
691 (void)spinup_ap(ctx, vme->u.spinup_ap.vcpu, vme->u.spinup_ap.rip);
693 return (VMEXIT_CONTINUE);
696 #define DEBUG_EPT_MISCONFIG
697 #ifdef DEBUG_EPT_MISCONFIG
698 #define VMCS_GUEST_PHYSICAL_ADDRESS 0x00002400
700 static uint64_t ept_misconfig_gpa, ept_misconfig_pte[4];
701 static int ept_misconfig_ptenum;
705 vmexit_vmx_desc(uint32_t exit_reason)
708 if (exit_reason >= nitems(vmx_exit_reason_desc) ||
709 vmx_exit_reason_desc[exit_reason] == NULL)
711 return (vmx_exit_reason_desc[exit_reason]);
715 vmexit_vmx(struct vmctx *ctx, struct vm_exit *vme, int *pvcpu)
718 fprintf(stderr, "vm exit[%d]\n", *pvcpu);
719 fprintf(stderr, "\treason\t\tVMX\n");
720 fprintf(stderr, "\trip\t\t0x%016lx\n", vme->rip);
721 fprintf(stderr, "\tinst_length\t%d\n", vme->inst_length);
722 fprintf(stderr, "\tstatus\t\t%d\n", vme->u.vmx.status);
723 fprintf(stderr, "\texit_reason\t%u (%s)\n", vme->u.vmx.exit_reason,
724 vmexit_vmx_desc(vme->u.vmx.exit_reason));
725 fprintf(stderr, "\tqualification\t0x%016lx\n",
726 vme->u.vmx.exit_qualification);
727 fprintf(stderr, "\tinst_type\t\t%d\n", vme->u.vmx.inst_type);
728 fprintf(stderr, "\tinst_error\t\t%d\n", vme->u.vmx.inst_error);
729 #ifdef DEBUG_EPT_MISCONFIG
730 if (vme->u.vmx.exit_reason == EXIT_REASON_EPT_MISCONFIG) {
731 vm_get_register(ctx, *pvcpu,
732 VMCS_IDENT(VMCS_GUEST_PHYSICAL_ADDRESS),
734 vm_get_gpa_pmap(ctx, ept_misconfig_gpa, ept_misconfig_pte,
735 &ept_misconfig_ptenum);
736 fprintf(stderr, "\tEPT misconfiguration:\n");
737 fprintf(stderr, "\t\tGPA: %#lx\n", ept_misconfig_gpa);
738 fprintf(stderr, "\t\tPTE(%d): %#lx %#lx %#lx %#lx\n",
739 ept_misconfig_ptenum, ept_misconfig_pte[0],
740 ept_misconfig_pte[1], ept_misconfig_pte[2],
741 ept_misconfig_pte[3]);
743 #endif /* DEBUG_EPT_MISCONFIG */
744 return (VMEXIT_ABORT);
748 vmexit_svm(struct vmctx *ctx __unused, struct vm_exit *vme, int *pvcpu)
751 fprintf(stderr, "vm exit[%d]\n", *pvcpu);
752 fprintf(stderr, "\treason\t\tSVM\n");
753 fprintf(stderr, "\trip\t\t0x%016lx\n", vme->rip);
754 fprintf(stderr, "\tinst_length\t%d\n", vme->inst_length);
755 fprintf(stderr, "\texitcode\t%#lx\n", vme->u.svm.exitcode);
756 fprintf(stderr, "\texitinfo1\t%#lx\n", vme->u.svm.exitinfo1);
757 fprintf(stderr, "\texitinfo2\t%#lx\n", vme->u.svm.exitinfo2);
758 return (VMEXIT_ABORT);
762 vmexit_bogus(struct vmctx *ctx __unused, struct vm_exit *vme,
766 assert(vme->inst_length == 0);
768 stats.vmexit_bogus++;
770 return (VMEXIT_CONTINUE);
774 vmexit_reqidle(struct vmctx *ctx __unused, struct vm_exit *vme,
778 assert(vme->inst_length == 0);
780 stats.vmexit_reqidle++;
782 return (VMEXIT_CONTINUE);
786 vmexit_hlt(struct vmctx *ctx __unused, struct vm_exit *vme __unused,
793 * Just continue execution with the next instruction. We use
794 * the HLT VM exit as a way to be friendly with the host
797 return (VMEXIT_CONTINUE);
801 vmexit_pause(struct vmctx *ctx __unused, struct vm_exit *vme __unused,
805 stats.vmexit_pause++;
807 return (VMEXIT_CONTINUE);
811 vmexit_mtrap(struct vmctx *ctx __unused, struct vm_exit *vme, int *pvcpu)
814 assert(vme->inst_length == 0);
816 stats.vmexit_mtrap++;
818 #ifdef BHYVE_SNAPSHOT
819 checkpoint_cpu_suspend(*pvcpu);
821 gdb_cpu_mtrap(*pvcpu);
822 #ifdef BHYVE_SNAPSHOT
823 checkpoint_cpu_resume(*pvcpu);
826 return (VMEXIT_CONTINUE);
830 vmexit_inst_emul(struct vmctx *ctx, struct vm_exit *vme, int *pvcpu)
834 enum vm_cpu_mode mode;
836 stats.vmexit_inst_emul++;
838 vie = &vme->u.inst_emul.vie;
841 * Attempt to decode in userspace as a fallback. This allows
842 * updating instruction decode in bhyve without rebooting the
843 * kernel (rapid prototyping), albeit with much slower
847 mode = vme->u.inst_emul.paging.cpu_mode;
848 cs_d = vme->u.inst_emul.cs_d;
849 if (vmm_decode_instruction(mode, cs_d, vie) != 0)
851 if (vm_set_register(ctx, *pvcpu, VM_REG_GUEST_RIP,
852 vme->rip + vie->num_processed) != 0)
856 err = emulate_mem(ctx, *pvcpu, vme->u.inst_emul.gpa,
857 vie, &vme->u.inst_emul.paging);
860 EPRINTLN("Unhandled memory access to 0x%lx\n",
861 vme->u.inst_emul.gpa);
866 return (VMEXIT_CONTINUE);
869 fprintf(stderr, "Failed to emulate instruction sequence [ ");
870 for (i = 0; i < vie->num_valid; i++)
871 fprintf(stderr, "%02x", vie->inst[i]);
872 FPRINTLN(stderr, " ] at 0x%lx", vme->rip);
873 return (VMEXIT_ABORT);
876 static pthread_mutex_t resetcpu_mtx = PTHREAD_MUTEX_INITIALIZER;
877 static pthread_cond_t resetcpu_cond = PTHREAD_COND_INITIALIZER;
880 vmexit_suspend(struct vmctx *ctx, struct vm_exit *vme, int *pvcpu)
882 enum vm_suspend_how how;
884 how = vme->u.suspended.how;
886 fbsdrun_deletecpu(*pvcpu);
889 pthread_mutex_lock(&resetcpu_mtx);
890 pthread_cond_signal(&resetcpu_cond);
891 pthread_mutex_unlock(&resetcpu_mtx);
895 pthread_mutex_lock(&resetcpu_mtx);
896 while (!CPU_EMPTY(&cpumask)) {
897 pthread_cond_wait(&resetcpu_cond, &resetcpu_mtx);
899 pthread_mutex_unlock(&resetcpu_mtx);
902 case VM_SUSPEND_RESET:
904 case VM_SUSPEND_POWEROFF:
905 if (get_config_bool_default("destroy_on_poweroff", false))
908 case VM_SUSPEND_HALT:
910 case VM_SUSPEND_TRIPLEFAULT:
913 fprintf(stderr, "vmexit_suspend: invalid reason %d\n", how);
916 return (0); /* NOTREACHED */
920 vmexit_debug(struct vmctx *ctx __unused, struct vm_exit *vme __unused,
924 #ifdef BHYVE_SNAPSHOT
925 checkpoint_cpu_suspend(*pvcpu);
927 gdb_cpu_suspend(*pvcpu);
928 #ifdef BHYVE_SNAPSHOT
929 checkpoint_cpu_resume(*pvcpu);
931 return (VMEXIT_CONTINUE);
935 vmexit_breakpoint(struct vmctx *ctx __unused, struct vm_exit *vme, int *pvcpu)
938 gdb_cpu_breakpoint(*pvcpu, vme);
939 return (VMEXIT_CONTINUE);
942 static vmexit_handler_t handler[VM_EXITCODE_MAX] = {
943 [VM_EXITCODE_INOUT] = vmexit_inout,
944 [VM_EXITCODE_INOUT_STR] = vmexit_inout,
945 [VM_EXITCODE_VMX] = vmexit_vmx,
946 [VM_EXITCODE_SVM] = vmexit_svm,
947 [VM_EXITCODE_BOGUS] = vmexit_bogus,
948 [VM_EXITCODE_REQIDLE] = vmexit_reqidle,
949 [VM_EXITCODE_RDMSR] = vmexit_rdmsr,
950 [VM_EXITCODE_WRMSR] = vmexit_wrmsr,
951 [VM_EXITCODE_MTRAP] = vmexit_mtrap,
952 [VM_EXITCODE_INST_EMUL] = vmexit_inst_emul,
953 [VM_EXITCODE_SPINUP_AP] = vmexit_spinup_ap,
954 [VM_EXITCODE_SUSPENDED] = vmexit_suspend,
955 [VM_EXITCODE_TASK_SWITCH] = vmexit_task_switch,
956 [VM_EXITCODE_DEBUG] = vmexit_debug,
957 [VM_EXITCODE_BPT] = vmexit_breakpoint,
961 vm_loop(struct vmctx *ctx, int vcpu, uint64_t startrip)
964 enum vm_exitcode exitcode;
965 cpuset_t active_cpus;
967 if (vcpumap[vcpu] != NULL) {
968 error = pthread_setaffinity_np(pthread_self(),
969 sizeof(cpuset_t), vcpumap[vcpu]);
973 error = vm_active_cpus(ctx, &active_cpus);
974 assert(CPU_ISSET(vcpu, &active_cpus));
976 error = vm_set_register(ctx, vcpu, VM_REG_GUEST_RIP, startrip);
980 error = vm_run(ctx, vcpu, &vmexit[vcpu]);
984 exitcode = vmexit[vcpu].exitcode;
985 if (exitcode >= VM_EXITCODE_MAX || handler[exitcode] == NULL) {
986 fprintf(stderr, "vm_loop: unexpected exitcode 0x%x\n",
991 rc = (*handler[exitcode])(ctx, &vmexit[vcpu], &vcpu);
994 case VMEXIT_CONTINUE:
1002 fprintf(stderr, "vm_run error %d, errno %d\n", error, errno);
1006 num_vcpus_allowed(struct vmctx *ctx)
1008 uint16_t sockets, cores, threads, maxcpus;
1012 * The guest is allowed to spinup more than one processor only if the
1013 * UNRESTRICTED_GUEST capability is available.
1015 error = vm_get_capability(ctx, BSP, VM_CAP_UNRESTRICTED_GUEST, &tmp);
1019 error = vm_get_topology(ctx, &sockets, &cores, &threads, &maxcpus);
1027 fbsdrun_set_capabilities(struct vmctx *ctx, int cpu)
1031 if (get_config_bool_default("x86.vmexit_on_hlt", false)) {
1032 err = vm_get_capability(ctx, cpu, VM_CAP_HALT_EXIT, &tmp);
1034 fprintf(stderr, "VM exit on HLT not supported\n");
1037 vm_set_capability(ctx, cpu, VM_CAP_HALT_EXIT, 1);
1039 handler[VM_EXITCODE_HLT] = vmexit_hlt;
1042 if (get_config_bool_default("x86.vmexit_on_pause", false)) {
1044 * pause exit support required for this mode
1046 err = vm_get_capability(ctx, cpu, VM_CAP_PAUSE_EXIT, &tmp);
1049 "SMP mux requested, no pause support\n");
1052 vm_set_capability(ctx, cpu, VM_CAP_PAUSE_EXIT, 1);
1054 handler[VM_EXITCODE_PAUSE] = vmexit_pause;
1057 if (get_config_bool_default("x86.x2apic", false))
1058 err = vm_set_x2apic_state(ctx, cpu, X2APIC_ENABLED);
1060 err = vm_set_x2apic_state(ctx, cpu, X2APIC_DISABLED);
1063 fprintf(stderr, "Unable to set x2apic state (%d)\n", err);
1067 vm_set_capability(ctx, cpu, VM_CAP_ENABLE_INVPCID, 1);
1070 static struct vmctx *
1071 do_open(const char *vmname)
1075 bool reinit, romboot;
1076 #ifndef WITHOUT_CAPSICUM
1077 cap_rights_t rights;
1078 const cap_ioctl_t *cmds;
1082 reinit = romboot = false;
1087 error = vm_create(vmname);
1089 if (errno == EEXIST) {
1094 * The virtual machine has been setup by the
1095 * userspace bootloader.
1099 perror("vm_create");
1105 * If the virtual machine was just created then a
1106 * bootrom must be configured to boot it.
1108 fprintf(stderr, "virtual machine cannot be booted\n");
1113 ctx = vm_open(vmname);
1119 #ifndef WITHOUT_CAPSICUM
1120 cap_rights_init(&rights, CAP_IOCTL, CAP_MMAP_RW);
1121 if (caph_rights_limit(vm_get_device_fd(ctx), &rights) == -1)
1122 errx(EX_OSERR, "Unable to apply rights for sandbox");
1123 vm_get_ioctls(&ncmds);
1124 cmds = vm_get_ioctls(NULL);
1126 errx(EX_OSERR, "out of memory");
1127 if (caph_ioctls_limit(vm_get_device_fd(ctx), cmds, ncmds) == -1)
1128 errx(EX_OSERR, "Unable to apply rights for sandbox");
1129 free((cap_ioctl_t *)cmds);
1133 error = vm_reinit(ctx);
1135 perror("vm_reinit");
1139 error = vm_set_topology(ctx, sockets, cores, threads, maxcpus);
1141 errx(EX_OSERR, "vm_set_topology");
1146 spinup_vcpu(struct vmctx *ctx, int vcpu, bool suspend)
1151 error = vm_get_register(ctx, vcpu, VM_REG_GUEST_RIP, &rip);
1154 fbsdrun_set_capabilities(ctx, vcpu);
1155 error = vm_set_capability(ctx, vcpu, VM_CAP_UNRESTRICTED_GUEST, 1);
1158 fbsdrun_addcpu(ctx, vcpu, rip, suspend);
1162 parse_config_option(const char *option)
1167 value = strchr(option, '=');
1168 if (value == NULL || value[1] == '\0')
1170 path = strndup(option, value - option);
1172 err(4, "Failed to allocate memory");
1173 set_config_value(path, value + 1);
1178 parse_simple_config_file(const char *path)
1183 unsigned int lineno;
1185 fp = fopen(path, "r");
1187 err(4, "Failed to open configuration file %s", path);
1191 for (lineno = 1; getline(&line, &linecap, fp) > 0; lineno++) {
1192 if (*line == '#' || *line == '\n')
1194 cp = strchr(line, '\n');
1197 if (!parse_config_option(line))
1198 errx(4, "%s line %u: invalid config option '%s'", path,
1206 parse_gdb_options(const char *opt)
1211 if (opt[0] == 'w') {
1212 set_config_bool("gdb.wait", true);
1216 colon = strrchr(opt, ':');
1217 if (colon == NULL) {
1223 set_config_value("gdb.address", opt);
1226 set_config_value("gdb.port", sport);
1233 set_config_bool("acpi_tables", false);
1234 set_config_value("memory.size", "256M");
1235 set_config_bool("x86.strictmsr", true);
1239 main(int argc, char *argv[])
1242 int max_vcpus, memflags;
1246 const char *optstr, *value, *vmname;
1247 #ifdef BHYVE_SNAPSHOT
1249 struct restore_state rstate;
1251 restore_file = NULL;
1256 progname = basename(argv[0]);
1258 #ifdef BHYVE_SNAPSHOT
1259 optstr = "aehuwxACDHIPSWYk:o:p:G:c:s:m:l:K:U:r:";
1261 optstr = "aehuwxACDHIPSWYk:o:p:G:c:s:m:l:K:U:";
1263 while ((c = getopt(argc, argv, optstr)) != -1) {
1266 set_config_bool("x86.x2apic", false);
1269 set_config_bool("acpi_tables", true);
1272 set_config_bool("destroy_on_poweroff", true);
1275 if (pincpu_parse(optarg) != 0) {
1276 errx(EX_USAGE, "invalid vcpu pinning "
1277 "configuration '%s'", optarg);
1281 if (topology_parse(optarg) != 0) {
1282 errx(EX_USAGE, "invalid cpu topology "
1287 set_config_bool("memory.guest_in_core", true);
1290 parse_gdb_options(optarg);
1293 parse_simple_config_file(optarg);
1296 set_config_value("keyboard.layout", optarg);
1299 if (strncmp(optarg, "help", strlen(optarg)) == 0) {
1300 lpc_print_supported_devices();
1302 } else if (lpc_device_parse(optarg) != 0) {
1303 errx(EX_USAGE, "invalid lpc device "
1304 "configuration '%s'", optarg);
1307 #ifdef BHYVE_SNAPSHOT
1309 restore_file = optarg;
1313 if (strncmp(optarg, "help", strlen(optarg)) == 0) {
1314 pci_print_supported_devices();
1316 } else if (pci_parse_slot(optarg) != 0)
1321 set_config_bool("memory.wired", true);
1324 set_config_value("memory.size", optarg);
1327 if (!parse_config_option(optarg))
1328 errx(EX_USAGE, "invalid configuration option '%s'", optarg);
1331 set_config_bool("x86.vmexit_on_hlt", true);
1335 * The "-I" option was used to add an ioapic to the
1338 * An ioapic is now provided unconditionally for each
1339 * virtual machine and this option is now deprecated.
1343 set_config_bool("x86.vmexit_on_pause", true);
1346 set_config_bool("x86.strictio", true);
1349 set_config_bool("rtc.use_localtime", false);
1352 set_config_value("uuid", optarg);
1355 set_config_bool("x86.strictmsr", false);
1358 set_config_bool("virtio_msix", false);
1361 set_config_bool("x86.x2apic", true);
1364 set_config_bool("x86.mptable", false);
1378 #ifdef BHYVE_SNAPSHOT
1379 if (restore_file != NULL) {
1380 error = load_restore_file(restore_file, &rstate);
1382 fprintf(stderr, "Failed to read checkpoint info from "
1383 "file: '%s'.\n", restore_file);
1386 vmname = lookup_vmname(&rstate);
1388 set_config_value("name", vmname);
1393 set_config_value("name", argv[0]);
1395 vmname = get_config_value("name");
1399 if (get_config_bool_default("config.dump", false)) {
1407 value = get_config_value("memory.size");
1408 error = vm_parse_memsize(value, &memsize);
1410 errx(EX_USAGE, "invalid memsize '%s'", value);
1412 ctx = do_open(vmname);
1414 #ifdef BHYVE_SNAPSHOT
1415 if (restore_file != NULL) {
1416 guest_ncpus = lookup_guest_ncpus(&rstate);
1417 memflags = lookup_memflags(&rstate);
1418 memsize = lookup_memsize(&rstate);
1421 if (guest_ncpus < 1) {
1422 fprintf(stderr, "Invalid guest vCPUs (%d)\n", guest_ncpus);
1427 max_vcpus = num_vcpus_allowed(ctx);
1428 if (guest_ncpus > max_vcpus) {
1429 fprintf(stderr, "%d vCPUs requested but only %d available\n",
1430 guest_ncpus, max_vcpus);
1434 fbsdrun_set_capabilities(ctx, BSP);
1437 if (get_config_bool_default("memory.wired", false))
1438 memflags |= VM_MEM_F_WIRED;
1439 if (get_config_bool_default("memory.guest_in_core", false))
1440 memflags |= VM_MEM_F_INCORE;
1441 vm_set_memflags(ctx, memflags);
1442 err = vm_setup_memory(ctx, memsize, VM_MMAP_ALL);
1444 fprintf(stderr, "Unable to setup memory (%d)\n", errno);
1450 fprintf(stderr, "init_msr error %d", error);
1454 init_mem(guest_ncpus);
1466 * Exit if a device emulation finds an error in its initilization
1468 if (init_pci(ctx) != 0) {
1469 perror("device emulation initialization error");
1474 * Initialize after PCI, to allow a bootrom file to reserve the high
1477 if (get_config_bool("acpi_tables"))
1482 if (lpc_bootrom()) {
1483 if (vm_set_capability(ctx, BSP, VM_CAP_UNRESTRICTED_GUEST, 1)) {
1484 fprintf(stderr, "ROM boot failed: unrestricted guest "
1485 "capability not available\n");
1488 error = vcpu_reset(ctx, BSP);
1492 #ifdef BHYVE_SNAPSHOT
1493 if (restore_file != NULL) {
1494 fprintf(stdout, "Pausing pci devs...\r\n");
1495 if (vm_pause_user_devs(ctx) != 0) {
1496 fprintf(stderr, "Failed to pause PCI device state.\n");
1500 fprintf(stdout, "Restoring vm mem...\r\n");
1501 if (restore_vm_mem(ctx, &rstate) != 0) {
1502 fprintf(stderr, "Failed to restore VM memory.\n");
1506 fprintf(stdout, "Restoring pci devs...\r\n");
1507 if (vm_restore_user_devs(ctx, &rstate) != 0) {
1508 fprintf(stderr, "Failed to restore PCI device state.\n");
1512 fprintf(stdout, "Restoring kernel structs...\r\n");
1513 if (vm_restore_kern_structs(ctx, &rstate) != 0) {
1514 fprintf(stderr, "Failed to restore kernel structs.\n");
1518 fprintf(stdout, "Resuming pci devs...\r\n");
1519 if (vm_resume_user_devs(ctx) != 0) {
1520 fprintf(stderr, "Failed to resume PCI device state.\n");
1526 error = vm_get_register(ctx, BSP, VM_REG_GUEST_RIP, &rip);
1530 * build the guest tables, MP etc.
1532 if (get_config_bool_default("x86.mptable", true)) {
1533 error = mptable_build(ctx, guest_ncpus);
1535 perror("error to build the guest tables");
1540 error = smbios_build(ctx);
1544 if (get_config_bool("acpi_tables")) {
1545 error = acpi_build(ctx, guest_ncpus);
1553 * Change the proc title to include the VM name.
1555 setproctitle("%s", vmname);
1557 #ifndef WITHOUT_CAPSICUM
1558 caph_cache_catpages();
1560 if (caph_limit_stdout() == -1 || caph_limit_stderr() == -1)
1561 errx(EX_OSERR, "Unable to apply rights for sandbox");
1563 if (caph_enter() == -1)
1564 errx(EX_OSERR, "cap_enter() failed");
1567 #ifdef BHYVE_SNAPSHOT
1568 if (restore_file != NULL)
1569 destroy_restore_state(&rstate);
1571 /* initialize mutex/cond variables */
1575 * checkpointing thread for communication with bhyvectl
1577 if (init_checkpoint_thread(ctx) < 0)
1578 printf("Failed to start checkpoint thread!\r\n");
1580 if (restore_file != NULL)
1581 vm_restore_time(ctx);
1584 /* Allocate per-VCPU resources. */
1585 vmexit = calloc(guest_ncpus, sizeof(*vmexit));
1586 mt_vmm_info = calloc(guest_ncpus, sizeof(*mt_vmm_info));
1591 for (int vcpu = 0; vcpu < guest_ncpus; vcpu++) {
1592 bool suspend = (vcpu != BSP);
1593 #ifdef BHYVE_SNAPSHOT
1594 if (restore_file != NULL)
1597 spinup_vcpu(ctx, vcpu, suspend);
1601 * Head off to the main event dispatch loop