1/*-
2 * Copyright (c) 2011 NetApp, Inc.
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
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.
13 *
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
24 * SUCH DAMAGE.
25 *
26 * $FreeBSD$
27 */
28
29#include <sys/cdefs.h>
30__FBSDID("$FreeBSD$");
31
32#include <sys/types.h>
33#include <sys/mman.h>
34#include <sys/time.h>
35
36#include <machine/atomic.h>
37#include <machine/segments.h>
38
39#include <stdio.h>
40#include <stdlib.h>
41#include <string.h>
42#include <err.h>
43#include <libgen.h>
44#include <unistd.h>
45#include <assert.h>
46#include <errno.h>
47#include <pthread.h>
48#include <pthread_np.h>
49#include <sysexits.h>
50#include <stdbool.h>
51
52#include <machine/vmm.h>
53#include <vmmapi.h>
54
55#include "bhyverun.h"
56#include "acpi.h"
57#include "inout.h"
58#include "dbgport.h"
59#include "fwctl.h"
60#include "ioapic.h"
61#include "mem.h"
62#include "mevent.h"
63#include "mptbl.h"
64#include "pci_emul.h"
65#include "pci_irq.h"
66#include "pci_lpc.h"
67#include "smbiostbl.h"
68#include "xmsr.h"
69#include "spinup_ap.h"
70#include "rtc.h"
71
72#define GUEST_NIO_PORT		0x488	/* guest upcalls via i/o port */
73
74#define MB		(1024UL * 1024)
75#define GB		(1024UL * MB)
76
77typedef int (*vmexit_handler_t)(struct vmctx *, struct vm_exit *, int *vcpu);
78extern int vmexit_task_switch(struct vmctx *, struct vm_exit *, int *vcpu);
79
80char *vmname;
81
82int guest_ncpus;
83char *guest_uuid_str;
84
85static int guest_vmexit_on_hlt, guest_vmexit_on_pause;
86static int virtio_msix = 1;
87static int x2apic_mode = 0;	/* default is xAPIC */
88
89static int strictio;
90static int strictmsr = 1;
91
92static int acpi;
93
94static char *progname;
95static const int BSP = 0;
96
97static cpuset_t cpumask;
98
99static void vm_loop(struct vmctx *ctx, int vcpu, uint64_t rip);
100
101static struct vm_exit vmexit[VM_MAXCPU];
102
103struct bhyvestats {
104        uint64_t        vmexit_bogus;
105	uint64_t	vmexit_reqidle;
106        uint64_t        vmexit_hlt;
107        uint64_t        vmexit_pause;
108        uint64_t        vmexit_mtrap;
109        uint64_t        vmexit_inst_emul;
110        uint64_t        cpu_switch_rotate;
111        uint64_t        cpu_switch_direct;
112} stats;
113
114struct mt_vmm_info {
115	pthread_t	mt_thr;
116	struct vmctx	*mt_ctx;
117	int		mt_vcpu;
118} mt_vmm_info[VM_MAXCPU];
119
120static cpuset_t *vcpumap[VM_MAXCPU] = { NULL };
121
122static void
123usage(int code)
124{
125
126        fprintf(stderr,
127                "Usage: %s [-abehuwxACHPSWY] [-c vcpus] [-g <gdb port>] [-l <lpc>]\n"
128		"       %*s [-m mem] [-p vcpu:hostcpu] [-s <pci>] [-U uuid] <vm>\n"
129		"       -a: local apic is in xAPIC mode (deprecated)\n"
130		"       -A: create ACPI tables\n"
131		"       -c: # cpus (default 1)\n"
132		"       -C: include guest memory in core file\n"
133		"       -e: exit on unhandled I/O access\n"
134		"       -g: gdb port\n"
135		"       -h: help\n"
136		"       -H: vmexit from the guest on hlt\n"
137		"       -l: LPC device configuration\n"
138		"       -m: memory size in MB\n"
139		"       -p: pin 'vcpu' to 'hostcpu'\n"
140		"       -P: vmexit from the guest on pause\n"
141		"       -s: <slot,driver,configinfo> PCI slot config\n"
142		"       -S: guest memory cannot be swapped\n"
143		"       -u: RTC keeps UTC time\n"
144		"       -U: uuid\n"
145		"       -w: ignore unimplemented MSRs\n"
146		"       -W: force virtio to use single-vector MSI\n"
147		"       -x: local apic is in x2APIC mode\n"
148		"       -Y: disable MPtable generation\n",
149		progname, (int)strlen(progname), "");
150
151	exit(code);
152}
153
154static int
155pincpu_parse(const char *opt)
156{
157	int vcpu, pcpu;
158
159	if (sscanf(opt, "%d:%d", &vcpu, &pcpu) != 2) {
160		fprintf(stderr, "invalid format: %s\n", opt);
161		return (-1);
162	}
163
164	if (vcpu < 0 || vcpu >= VM_MAXCPU) {
165		fprintf(stderr, "vcpu '%d' outside valid range from 0 to %d\n",
166		    vcpu, VM_MAXCPU - 1);
167		return (-1);
168	}
169
170	if (pcpu < 0 || pcpu >= CPU_SETSIZE) {
171		fprintf(stderr, "hostcpu '%d' outside valid range from "
172		    "0 to %d\n", pcpu, CPU_SETSIZE - 1);
173		return (-1);
174	}
175
176	if (vcpumap[vcpu] == NULL) {
177		if ((vcpumap[vcpu] = malloc(sizeof(cpuset_t))) == NULL) {
178			perror("malloc");
179			return (-1);
180		}
181		CPU_ZERO(vcpumap[vcpu]);
182	}
183	CPU_SET(pcpu, vcpumap[vcpu]);
184	return (0);
185}
186
187void
188vm_inject_fault(void *arg, int vcpu, int vector, int errcode_valid,
189    int errcode)
190{
191	struct vmctx *ctx;
192	int error, restart_instruction;
193
194	ctx = arg;
195	restart_instruction = 1;
196
197	error = vm_inject_exception(ctx, vcpu, vector, errcode_valid, errcode,
198	    restart_instruction);
199	assert(error == 0);
200}
201
202void *
203paddr_guest2host(struct vmctx *ctx, uintptr_t gaddr, size_t len)
204{
205
206	return (vm_map_gpa(ctx, gaddr, len));
207}
208
209int
210fbsdrun_vmexit_on_pause(void)
211{
212
213	return (guest_vmexit_on_pause);
214}
215
216int
217fbsdrun_vmexit_on_hlt(void)
218{
219
220	return (guest_vmexit_on_hlt);
221}
222
223int
224fbsdrun_virtio_msix(void)
225{
226
227	return (virtio_msix);
228}
229
230static void *
231fbsdrun_start_thread(void *param)
232{
233	char tname[MAXCOMLEN + 1];
234	struct mt_vmm_info *mtp;
235	int vcpu;
236
237	mtp = param;
238	vcpu = mtp->mt_vcpu;
239
240	snprintf(tname, sizeof(tname), "vcpu %d", vcpu);
241	pthread_set_name_np(mtp->mt_thr, tname);
242
243	vm_loop(mtp->mt_ctx, vcpu, vmexit[vcpu].rip);
244
245	/* not reached */
246	exit(1);
247	return (NULL);
248}
249
250void
251fbsdrun_addcpu(struct vmctx *ctx, int fromcpu, int newcpu, uint64_t rip)
252{
253	int error;
254
255	assert(fromcpu == BSP);
256
257	/*
258	 * The 'newcpu' must be activated in the context of 'fromcpu'. If
259	 * vm_activate_cpu() is delayed until newcpu's pthread starts running
260	 * then vmm.ko is out-of-sync with bhyve and this can create a race
261	 * with vm_suspend().
262	 */
263	error = vm_activate_cpu(ctx, newcpu);
264	if (error != 0)
265		err(EX_OSERR, "could not activate CPU %d", newcpu);
266
267	CPU_SET_ATOMIC(newcpu, &cpumask);
268
269	/*
270	 * Set up the vmexit struct to allow execution to start
271	 * at the given RIP
272	 */
273	vmexit[newcpu].rip = rip;
274	vmexit[newcpu].inst_length = 0;
275
276	mt_vmm_info[newcpu].mt_ctx = ctx;
277	mt_vmm_info[newcpu].mt_vcpu = newcpu;
278
279	error = pthread_create(&mt_vmm_info[newcpu].mt_thr, NULL,
280	    fbsdrun_start_thread, &mt_vmm_info[newcpu]);
281	assert(error == 0);
282}
283
284static int
285fbsdrun_deletecpu(struct vmctx *ctx, int vcpu)
286{
287
288	if (!CPU_ISSET(vcpu, &cpumask)) {
289		fprintf(stderr, "Attempting to delete unknown cpu %d\n", vcpu);
290		exit(1);
291	}
292
293	CPU_CLR_ATOMIC(vcpu, &cpumask);
294	return (CPU_EMPTY(&cpumask));
295}
296
297static int
298vmexit_handle_notify(struct vmctx *ctx, struct vm_exit *vme, int *pvcpu,
299		     uint32_t eax)
300{
301#if BHYVE_DEBUG
302	/*
303	 * put guest-driven debug here
304	 */
305#endif
306        return (VMEXIT_CONTINUE);
307}
308
309static int
310vmexit_inout(struct vmctx *ctx, struct vm_exit *vme, int *pvcpu)
311{
312	int error;
313	int bytes, port, in, out;
314	int vcpu;
315
316	vcpu = *pvcpu;
317
318	port = vme->u.inout.port;
319	bytes = vme->u.inout.bytes;
320	in = vme->u.inout.in;
321	out = !in;
322
323        /* Extra-special case of host notifications */
324        if (out && port == GUEST_NIO_PORT) {
325                error = vmexit_handle_notify(ctx, vme, pvcpu, vme->u.inout.eax);
326		return (error);
327	}
328
329	error = emulate_inout(ctx, vcpu, vme, strictio);
330	if (error) {
331		fprintf(stderr, "Unhandled %s%c 0x%04x at 0x%lx\n",
332		    in ? "in" : "out",
333		    bytes == 1 ? 'b' : (bytes == 2 ? 'w' : 'l'),
334		    port, vmexit->rip);
335		return (VMEXIT_ABORT);
336	} else {
337		return (VMEXIT_CONTINUE);
338	}
339}
340
341static int
342vmexit_rdmsr(struct vmctx *ctx, struct vm_exit *vme, int *pvcpu)
343{
344	uint64_t val;
345	uint32_t eax, edx;
346	int error;
347
348	val = 0;
349	error = emulate_rdmsr(ctx, *pvcpu, vme->u.msr.code, &val);
350	if (error != 0) {
351		fprintf(stderr, "rdmsr to register %#x on vcpu %d\n",
352		    vme->u.msr.code, *pvcpu);
353		if (strictmsr) {
354			vm_inject_gp(ctx, *pvcpu);
355			return (VMEXIT_CONTINUE);
356		}
357	}
358
359	eax = val;
360	error = vm_set_register(ctx, *pvcpu, VM_REG_GUEST_RAX, eax);
361	assert(error == 0);
362
363	edx = val >> 32;
364	error = vm_set_register(ctx, *pvcpu, VM_REG_GUEST_RDX, edx);
365	assert(error == 0);
366
367	return (VMEXIT_CONTINUE);
368}
369
370static int
371vmexit_wrmsr(struct vmctx *ctx, struct vm_exit *vme, int *pvcpu)
372{
373	int error;
374
375	error = emulate_wrmsr(ctx, *pvcpu, vme->u.msr.code, vme->u.msr.wval);
376	if (error != 0) {
377		fprintf(stderr, "wrmsr to register %#x(%#lx) on vcpu %d\n",
378		    vme->u.msr.code, vme->u.msr.wval, *pvcpu);
379		if (strictmsr) {
380			vm_inject_gp(ctx, *pvcpu);
381			return (VMEXIT_CONTINUE);
382		}
383	}
384	return (VMEXIT_CONTINUE);
385}
386
387static int
388vmexit_spinup_ap(struct vmctx *ctx, struct vm_exit *vme, int *pvcpu)
389{
390
391	(void)spinup_ap(ctx, *pvcpu,
392		    vme->u.spinup_ap.vcpu, vme->u.spinup_ap.rip);
393
394	return (VMEXIT_CONTINUE);
395}
396
397#define	DEBUG_EPT_MISCONFIG
398#ifdef DEBUG_EPT_MISCONFIG
399#define	EXIT_REASON_EPT_MISCONFIG	49
400#define	VMCS_GUEST_PHYSICAL_ADDRESS	0x00002400
401#define	VMCS_IDENT(x)			((x) | 0x80000000)
402
403static uint64_t ept_misconfig_gpa, ept_misconfig_pte[4];
404static int ept_misconfig_ptenum;
405#endif
406
407static int
408vmexit_vmx(struct vmctx *ctx, struct vm_exit *vmexit, int *pvcpu)
409{
410
411	fprintf(stderr, "vm exit[%d]\n", *pvcpu);
412	fprintf(stderr, "\treason\t\tVMX\n");
413	fprintf(stderr, "\trip\t\t0x%016lx\n", vmexit->rip);
414	fprintf(stderr, "\tinst_length\t%d\n", vmexit->inst_length);
415	fprintf(stderr, "\tstatus\t\t%d\n", vmexit->u.vmx.status);
416	fprintf(stderr, "\texit_reason\t%u\n", vmexit->u.vmx.exit_reason);
417	fprintf(stderr, "\tqualification\t0x%016lx\n",
418	    vmexit->u.vmx.exit_qualification);
419	fprintf(stderr, "\tinst_type\t\t%d\n", vmexit->u.vmx.inst_type);
420	fprintf(stderr, "\tinst_error\t\t%d\n", vmexit->u.vmx.inst_error);
421#ifdef DEBUG_EPT_MISCONFIG
422	if (vmexit->u.vmx.exit_reason == EXIT_REASON_EPT_MISCONFIG) {
423		vm_get_register(ctx, *pvcpu,
424		    VMCS_IDENT(VMCS_GUEST_PHYSICAL_ADDRESS),
425		    &ept_misconfig_gpa);
426		vm_get_gpa_pmap(ctx, ept_misconfig_gpa, ept_misconfig_pte,
427		    &ept_misconfig_ptenum);
428		fprintf(stderr, "\tEPT misconfiguration:\n");
429		fprintf(stderr, "\t\tGPA: %#lx\n", ept_misconfig_gpa);
430		fprintf(stderr, "\t\tPTE(%d): %#lx %#lx %#lx %#lx\n",
431		    ept_misconfig_ptenum, ept_misconfig_pte[0],
432		    ept_misconfig_pte[1], ept_misconfig_pte[2],
433		    ept_misconfig_pte[3]);
434	}
435#endif	/* DEBUG_EPT_MISCONFIG */
436	return (VMEXIT_ABORT);
437}
438
439static int
440vmexit_svm(struct vmctx *ctx, struct vm_exit *vmexit, int *pvcpu)
441{
442
443	fprintf(stderr, "vm exit[%d]\n", *pvcpu);
444	fprintf(stderr, "\treason\t\tSVM\n");
445	fprintf(stderr, "\trip\t\t0x%016lx\n", vmexit->rip);
446	fprintf(stderr, "\tinst_length\t%d\n", vmexit->inst_length);
447	fprintf(stderr, "\texitcode\t%#lx\n", vmexit->u.svm.exitcode);
448	fprintf(stderr, "\texitinfo1\t%#lx\n", vmexit->u.svm.exitinfo1);
449	fprintf(stderr, "\texitinfo2\t%#lx\n", vmexit->u.svm.exitinfo2);
450	return (VMEXIT_ABORT);
451}
452
453static int
454vmexit_bogus(struct vmctx *ctx, struct vm_exit *vmexit, int *pvcpu)
455{
456
457	assert(vmexit->inst_length == 0);
458
459	stats.vmexit_bogus++;
460
461	return (VMEXIT_CONTINUE);
462}
463
464static int
465vmexit_reqidle(struct vmctx *ctx, struct vm_exit *vmexit, int *pvcpu)
466{
467
468	assert(vmexit->inst_length == 0);
469
470	stats.vmexit_reqidle++;
471
472	return (VMEXIT_CONTINUE);
473}
474
475static int
476vmexit_hlt(struct vmctx *ctx, struct vm_exit *vmexit, int *pvcpu)
477{
478
479	stats.vmexit_hlt++;
480
481	/*
482	 * Just continue execution with the next instruction. We use
483	 * the HLT VM exit as a way to be friendly with the host
484	 * scheduler.
485	 */
486	return (VMEXIT_CONTINUE);
487}
488
489static int
490vmexit_pause(struct vmctx *ctx, struct vm_exit *vmexit, int *pvcpu)
491{
492
493	stats.vmexit_pause++;
494
495	return (VMEXIT_CONTINUE);
496}
497
498static int
499vmexit_mtrap(struct vmctx *ctx, struct vm_exit *vmexit, int *pvcpu)
500{
501
502	assert(vmexit->inst_length == 0);
503
504	stats.vmexit_mtrap++;
505
506	return (VMEXIT_CONTINUE);
507}
508
509static int
510vmexit_inst_emul(struct vmctx *ctx, struct vm_exit *vmexit, int *pvcpu)
511{
512	int err, i;
513	struct vie *vie;
514
515	stats.vmexit_inst_emul++;
516
517	vie = &vmexit->u.inst_emul.vie;
518	err = emulate_mem(ctx, *pvcpu, vmexit->u.inst_emul.gpa,
519	    vie, &vmexit->u.inst_emul.paging);
520
521	if (err) {
522		if (err == ESRCH) {
523			fprintf(stderr, "Unhandled memory access to 0x%lx\n",
524			    vmexit->u.inst_emul.gpa);
525		}
526
527		fprintf(stderr, "Failed to emulate instruction [");
528		for (i = 0; i < vie->num_valid; i++) {
529			fprintf(stderr, "0x%02x%s", vie->inst[i],
530			    i != (vie->num_valid - 1) ? " " : "");
531		}
532		fprintf(stderr, "] at 0x%lx\n", vmexit->rip);
533		return (VMEXIT_ABORT);
534	}
535
536	return (VMEXIT_CONTINUE);
537}
538
539static pthread_mutex_t resetcpu_mtx = PTHREAD_MUTEX_INITIALIZER;
540static pthread_cond_t resetcpu_cond = PTHREAD_COND_INITIALIZER;
541
542static int
543vmexit_suspend(struct vmctx *ctx, struct vm_exit *vmexit, int *pvcpu)
544{
545	enum vm_suspend_how how;
546
547	how = vmexit->u.suspended.how;
548
549	fbsdrun_deletecpu(ctx, *pvcpu);
550
551	if (*pvcpu != BSP) {
552		pthread_mutex_lock(&resetcpu_mtx);
553		pthread_cond_signal(&resetcpu_cond);
554		pthread_mutex_unlock(&resetcpu_mtx);
555		pthread_exit(NULL);
556	}
557
558	pthread_mutex_lock(&resetcpu_mtx);
559	while (!CPU_EMPTY(&cpumask)) {
560		pthread_cond_wait(&resetcpu_cond, &resetcpu_mtx);
561	}
562	pthread_mutex_unlock(&resetcpu_mtx);
563
564	switch (how) {
565	case VM_SUSPEND_RESET:
566		exit(0);
567	case VM_SUSPEND_POWEROFF:
568		exit(1);
569	case VM_SUSPEND_HALT:
570		exit(2);
571	case VM_SUSPEND_TRIPLEFAULT:
572		exit(3);
573	default:
574		fprintf(stderr, "vmexit_suspend: invalid reason %d\n", how);
575		exit(100);
576	}
577	return (0);	/* NOTREACHED */
578}
579
580static vmexit_handler_t handler[VM_EXITCODE_MAX] = {
581	[VM_EXITCODE_INOUT]  = vmexit_inout,
582	[VM_EXITCODE_INOUT_STR]  = vmexit_inout,
583	[VM_EXITCODE_VMX]    = vmexit_vmx,
584	[VM_EXITCODE_SVM]    = vmexit_svm,
585	[VM_EXITCODE_BOGUS]  = vmexit_bogus,
586	[VM_EXITCODE_REQIDLE] = vmexit_reqidle,
587	[VM_EXITCODE_RDMSR]  = vmexit_rdmsr,
588	[VM_EXITCODE_WRMSR]  = vmexit_wrmsr,
589	[VM_EXITCODE_MTRAP]  = vmexit_mtrap,
590	[VM_EXITCODE_INST_EMUL] = vmexit_inst_emul,
591	[VM_EXITCODE_SPINUP_AP] = vmexit_spinup_ap,
592	[VM_EXITCODE_SUSPENDED] = vmexit_suspend,
593	[VM_EXITCODE_TASK_SWITCH] = vmexit_task_switch,
594};
595
596static void
597vm_loop(struct vmctx *ctx, int vcpu, uint64_t startrip)
598{
599	int error, rc;
600	enum vm_exitcode exitcode;
601	cpuset_t active_cpus;
602
603	if (vcpumap[vcpu] != NULL) {
604		error = pthread_setaffinity_np(pthread_self(),
605		    sizeof(cpuset_t), vcpumap[vcpu]);
606		assert(error == 0);
607	}
608
609	error = vm_active_cpus(ctx, &active_cpus);
610	assert(CPU_ISSET(vcpu, &active_cpus));
611
612	error = vm_set_register(ctx, vcpu, VM_REG_GUEST_RIP, startrip);
613	assert(error == 0);
614
615	while (1) {
616		error = vm_run(ctx, vcpu, &vmexit[vcpu]);
617		if (error != 0)
618			break;
619
620		exitcode = vmexit[vcpu].exitcode;
621		if (exitcode >= VM_EXITCODE_MAX || handler[exitcode] == NULL) {
622			fprintf(stderr, "vm_loop: unexpected exitcode 0x%x\n",
623			    exitcode);
624			exit(1);
625		}
626
627                rc = (*handler[exitcode])(ctx, &vmexit[vcpu], &vcpu);
628
629		switch (rc) {
630		case VMEXIT_CONTINUE:
631			break;
632		case VMEXIT_ABORT:
633			abort();
634		default:
635			exit(1);
636		}
637	}
638	fprintf(stderr, "vm_run error %d, errno %d\n", error, errno);
639}
640
641static int
642num_vcpus_allowed(struct vmctx *ctx)
643{
644	int tmp, error;
645
646	error = vm_get_capability(ctx, BSP, VM_CAP_UNRESTRICTED_GUEST, &tmp);
647
648	/*
649	 * The guest is allowed to spinup more than one processor only if the
650	 * UNRESTRICTED_GUEST capability is available.
651	 */
652	if (error == 0)
653		return (VM_MAXCPU);
654	else
655		return (1);
656}
657
658void
659fbsdrun_set_capabilities(struct vmctx *ctx, int cpu)
660{
661	int err, tmp;
662
663	if (fbsdrun_vmexit_on_hlt()) {
664		err = vm_get_capability(ctx, cpu, VM_CAP_HALT_EXIT, &tmp);
665		if (err < 0) {
666			fprintf(stderr, "VM exit on HLT not supported\n");
667			exit(1);
668		}
669		vm_set_capability(ctx, cpu, VM_CAP_HALT_EXIT, 1);
670		if (cpu == BSP)
671			handler[VM_EXITCODE_HLT] = vmexit_hlt;
672	}
673
674        if (fbsdrun_vmexit_on_pause()) {
675		/*
676		 * pause exit support required for this mode
677		 */
678		err = vm_get_capability(ctx, cpu, VM_CAP_PAUSE_EXIT, &tmp);
679		if (err < 0) {
680			fprintf(stderr,
681			    "SMP mux requested, no pause support\n");
682			exit(1);
683		}
684		vm_set_capability(ctx, cpu, VM_CAP_PAUSE_EXIT, 1);
685		if (cpu == BSP)
686			handler[VM_EXITCODE_PAUSE] = vmexit_pause;
687        }
688
689	if (x2apic_mode)
690		err = vm_set_x2apic_state(ctx, cpu, X2APIC_ENABLED);
691	else
692		err = vm_set_x2apic_state(ctx, cpu, X2APIC_DISABLED);
693
694	if (err) {
695		fprintf(stderr, "Unable to set x2apic state (%d)\n", err);
696		exit(1);
697	}
698
699	vm_set_capability(ctx, cpu, VM_CAP_ENABLE_INVPCID, 1);
700}
701
702static struct vmctx *
703do_open(const char *vmname)
704{
705	struct vmctx *ctx;
706	int error;
707	bool reinit, romboot;
708
709	reinit = romboot = false;
710
711	if (lpc_bootrom())
712		romboot = true;
713
714	error = vm_create(vmname);
715	if (error) {
716		if (errno == EEXIST) {
717			if (romboot) {
718				reinit = true;
719			} else {
720				/*
721				 * The virtual machine has been setup by the
722				 * userspace bootloader.
723				 */
724			}
725		} else {
726			perror("vm_create");
727			exit(1);
728		}
729	} else {
730		if (!romboot) {
731			/*
732			 * If the virtual machine was just created then a
733			 * bootrom must be configured to boot it.
734			 */
735			fprintf(stderr, "virtual machine cannot be booted\n");
736			exit(1);
737		}
738	}
739
740	ctx = vm_open(vmname);
741	if (ctx == NULL) {
742		perror("vm_open");
743		exit(1);
744	}
745
746	if (reinit) {
747		error = vm_reinit(ctx);
748		if (error) {
749			perror("vm_reinit");
750			exit(1);
751		}
752	}
753	return (ctx);
754}
755
756int
757main(int argc, char *argv[])
758{
759	int c, error, gdb_port, err, bvmcons;
760	int max_vcpus, mptgen, memflags;
761	int rtc_localtime;
762	struct vmctx *ctx;
763	uint64_t rip;
764	size_t memsize;
765	char *optstr;
766
767	bvmcons = 0;
768	progname = basename(argv[0]);
769	gdb_port = 0;
770	guest_ncpus = 1;
771	memsize = 256 * MB;
772	mptgen = 1;
773	rtc_localtime = 1;
774	memflags = 0;
775
776	optstr = "abehuwxACHIPSWYp:g:c:s:m:l:U:";
777	while ((c = getopt(argc, argv, optstr)) != -1) {
778		switch (c) {
779		case 'a':
780			x2apic_mode = 0;
781			break;
782		case 'A':
783			acpi = 1;
784			break;
785		case 'b':
786			bvmcons = 1;
787			break;
788		case 'p':
789                        if (pincpu_parse(optarg) != 0) {
790                            errx(EX_USAGE, "invalid vcpu pinning "
791                                 "configuration '%s'", optarg);
792                        }
793			break;
794                case 'c':
795			guest_ncpus = atoi(optarg);
796			break;
797		case 'C':
798			memflags |= VM_MEM_F_INCORE;
799			break;
800		case 'g':
801			gdb_port = atoi(optarg);
802			break;
803		case 'l':
804			if (lpc_device_parse(optarg) != 0) {
805				errx(EX_USAGE, "invalid lpc device "
806				    "configuration '%s'", optarg);
807			}
808			break;
809		case 's':
810			if (pci_parse_slot(optarg) != 0)
811				exit(1);
812			else
813				break;
814		case 'S':
815			memflags |= VM_MEM_F_WIRED;
816			break;
817                case 'm':
818			error = vm_parse_memsize(optarg, &memsize);
819			if (error)
820				errx(EX_USAGE, "invalid memsize '%s'", optarg);
821			break;
822		case 'H':
823			guest_vmexit_on_hlt = 1;
824			break;
825		case 'I':
826			/*
827			 * The "-I" option was used to add an ioapic to the
828			 * virtual machine.
829			 *
830			 * An ioapic is now provided unconditionally for each
831			 * virtual machine and this option is now deprecated.
832			 */
833			break;
834		case 'P':
835			guest_vmexit_on_pause = 1;
836			break;
837		case 'e':
838			strictio = 1;
839			break;
840		case 'u':
841			rtc_localtime = 0;
842			break;
843		case 'U':
844			guest_uuid_str = optarg;
845			break;
846		case 'w':
847			strictmsr = 0;
848			break;
849		case 'W':
850			virtio_msix = 0;
851			break;
852		case 'x':
853			x2apic_mode = 1;
854			break;
855		case 'Y':
856			mptgen = 0;
857			break;
858		case 'h':
859			usage(0);
860		default:
861			usage(1);
862		}
863	}
864	argc -= optind;
865	argv += optind;
866
867	if (argc != 1)
868		usage(1);
869
870	vmname = argv[0];
871	ctx = do_open(vmname);
872
873	if (guest_ncpus < 1) {
874		fprintf(stderr, "Invalid guest vCPUs (%d)\n", guest_ncpus);
875		exit(1);
876	}
877
878	max_vcpus = num_vcpus_allowed(ctx);
879	if (guest_ncpus > max_vcpus) {
880		fprintf(stderr, "%d vCPUs requested but only %d available\n",
881			guest_ncpus, max_vcpus);
882		exit(1);
883	}
884
885	fbsdrun_set_capabilities(ctx, BSP);
886
887	vm_set_memflags(ctx, memflags);
888	err = vm_setup_memory(ctx, memsize, VM_MMAP_ALL);
889	if (err) {
890		fprintf(stderr, "Unable to setup memory (%d)\n", errno);
891		exit(1);
892	}
893
894	error = init_msr();
895	if (error) {
896		fprintf(stderr, "init_msr error %d", error);
897		exit(1);
898	}
899
900	init_mem();
901	init_inout();
902	pci_irq_init(ctx);
903	ioapic_init(ctx);
904
905	rtc_init(ctx, rtc_localtime);
906	sci_init(ctx);
907
908	/*
909	 * Exit if a device emulation finds an error in it's initilization
910	 */
911	if (init_pci(ctx) != 0)
912		exit(1);
913
914	if (gdb_port != 0)
915		init_dbgport(gdb_port);
916
917	if (bvmcons)
918		init_bvmcons();
919
920	if (lpc_bootrom()) {
921		if (vm_set_capability(ctx, BSP, VM_CAP_UNRESTRICTED_GUEST, 1)) {
922			fprintf(stderr, "ROM boot failed: unrestricted guest "
923			    "capability not available\n");
924			exit(1);
925		}
926		error = vcpu_reset(ctx, BSP);
927		assert(error == 0);
928	}
929
930	error = vm_get_register(ctx, BSP, VM_REG_GUEST_RIP, &rip);
931	assert(error == 0);
932
933	/*
934	 * build the guest tables, MP etc.
935	 */
936	if (mptgen) {
937		error = mptable_build(ctx, guest_ncpus);
938		if (error)
939			exit(1);
940	}
941
942	error = smbios_build(ctx);
943	assert(error == 0);
944
945	if (acpi) {
946		error = acpi_build(ctx, guest_ncpus);
947		assert(error == 0);
948	}
949
950	if (lpc_bootrom())
951		fwctl_init();
952
953	/*
954	 * Change the proc title to include the VM name.
955	 */
956	setproctitle("%s", vmname);
957
958	/*
959	 * Add CPU 0
960	 */
961	fbsdrun_addcpu(ctx, BSP, BSP, rip);
962
963	/*
964	 * Head off to the main event dispatch loop
965	 */
966	mevent_dispatch();
967
968	exit(1);
969}
970