bhyverun.c revision 256072 
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: head/usr.sbin/bhyve/bhyverun.c 256072 2013-10-05 21:22:35Z neel $
27 */
28
29#include <sys/cdefs.h>
30__FBSDID("$FreeBSD: head/usr.sbin/bhyve/bhyverun.c 256072 2013-10-05 21:22:35Z neel $");
31
32#include <sys/types.h>
33#include <sys/mman.h>
34#include <sys/time.h>
35
36#include <machine/segments.h>
37
38#include <stdio.h>
39#include <stdlib.h>
40#include <libgen.h>
41#include <unistd.h>
42#include <assert.h>
43#include <errno.h>
44#include <pthread.h>
45#include <pthread_np.h>
46
47#include <machine/vmm.h>
48#include <vmmapi.h>
49
50#include "bhyverun.h"
51#include "acpi.h"
52#include "inout.h"
53#include "dbgport.h"
54#include "mem.h"
55#include "mevent.h"
56#include "mptbl.h"
57#include "pci_emul.h"
58#include "xmsr.h"
59#include "ioapic.h"
60#include "spinup_ap.h"
61#include "rtc.h"
62
63#define GUEST_NIO_PORT		0x488	/* guest upcalls via i/o port */
64
65#define	VMEXIT_SWITCH		0	/* force vcpu switch in mux mode */
66#define	VMEXIT_CONTINUE		1	/* continue from next instruction */
67#define	VMEXIT_RESTART		2	/* restart current instruction */
68#define	VMEXIT_ABORT		3	/* abort the vm run loop */
69#define	VMEXIT_RESET		4	/* guest machine has reset */
70
71#define MB		(1024UL * 1024)
72#define GB		(1024UL * MB)
73
74typedef int (*vmexit_handler_t)(struct vmctx *, struct vm_exit *, int *vcpu);
75
76char *vmname;
77
78int guest_ncpus;
79
80static int pincpu = -1;
81static int guest_vmexit_on_hlt, guest_vmexit_on_pause, disable_x2apic;
82
83static int foundcpus;
84
85static int strictio;
86
87static int acpi;
88
89static char *progname;
90static const int BSP = 0;
91
92static int cpumask;
93
94static void vm_loop(struct vmctx *ctx, int vcpu, uint64_t rip);
95
96struct vm_exit vmexit[VM_MAXCPU];
97
98struct bhyvestats {
99        uint64_t        vmexit_bogus;
100        uint64_t        vmexit_bogus_switch;
101        uint64_t        vmexit_hlt;
102        uint64_t        vmexit_pause;
103        uint64_t        vmexit_mtrap;
104        uint64_t        vmexit_inst_emul;
105        uint64_t        cpu_switch_rotate;
106        uint64_t        cpu_switch_direct;
107        int             io_reset;
108} stats;
109
110struct mt_vmm_info {
111	pthread_t	mt_thr;
112	struct vmctx	*mt_ctx;
113	int		mt_vcpu;
114} mt_vmm_info[VM_MAXCPU];
115
116static void
117usage(int code)
118{
119
120        fprintf(stderr,
121                "Usage: %s [-aehAHIP][-g <gdb port>][-s <pci>][-S <pci>]"
122		"[-c vcpus][-p pincpu][-m mem]"
123		" <vmname>\n"
124		"       -a: local apic is in XAPIC mode (default is X2APIC)\n"
125		"       -A: create an ACPI table\n"
126		"       -g: gdb port (default is %d and 0 means don't open)\n"
127		"       -c: # cpus (default 1)\n"
128		"       -p: pin vcpu 'n' to host cpu 'pincpu + n'\n"
129		"       -H: vmexit from the guest on hlt\n"
130		"       -I: present an ioapic to the guest\n"
131		"       -P: vmexit from the guest on pause\n"
132		"	-e: exit on unhandled i/o access\n"
133		"       -h: help\n"
134		"       -s: <slot,driver,configinfo> PCI slot config\n"
135		"       -S: <slot,driver,configinfo> legacy PCI slot config\n"
136		"       -m: memory size in MB\n",
137		progname, DEFAULT_GDB_PORT);
138
139	exit(code);
140}
141
142void *
143paddr_guest2host(struct vmctx *ctx, uintptr_t gaddr, size_t len)
144{
145
146	return (vm_map_gpa(ctx, gaddr, len));
147}
148
149int
150fbsdrun_disable_x2apic(void)
151{
152
153	return (disable_x2apic);
154}
155
156int
157fbsdrun_vmexit_on_pause(void)
158{
159
160	return (guest_vmexit_on_pause);
161}
162
163int
164fbsdrun_vmexit_on_hlt(void)
165{
166
167	return (guest_vmexit_on_hlt);
168}
169
170static void *
171fbsdrun_start_thread(void *param)
172{
173	char tname[MAXCOMLEN + 1];
174	struct mt_vmm_info *mtp;
175	int vcpu;
176
177	mtp = param;
178	vcpu = mtp->mt_vcpu;
179
180	snprintf(tname, sizeof(tname), "%s vcpu %d", vmname, vcpu);
181	pthread_set_name_np(mtp->mt_thr, tname);
182
183	vm_loop(mtp->mt_ctx, vcpu, vmexit[vcpu].rip);
184
185	/* not reached */
186	exit(1);
187	return (NULL);
188}
189
190void
191fbsdrun_addcpu(struct vmctx *ctx, int vcpu, uint64_t rip)
192{
193	int error;
194
195	if (cpumask & (1 << vcpu)) {
196		fprintf(stderr, "addcpu: attempting to add existing cpu %d\n",
197		    vcpu);
198		exit(1);
199	}
200
201	cpumask |= 1 << vcpu;
202	foundcpus++;
203
204	/*
205	 * Set up the vmexit struct to allow execution to start
206	 * at the given RIP
207	 */
208	vmexit[vcpu].rip = rip;
209	vmexit[vcpu].inst_length = 0;
210
211	mt_vmm_info[vcpu].mt_ctx = ctx;
212	mt_vmm_info[vcpu].mt_vcpu = vcpu;
213
214	error = pthread_create(&mt_vmm_info[vcpu].mt_thr, NULL,
215	    fbsdrun_start_thread, &mt_vmm_info[vcpu]);
216	assert(error == 0);
217}
218
219static int
220fbsdrun_get_next_cpu(int curcpu)
221{
222
223	/*
224	 * Get the next available CPU. Assumes they arrive
225	 * in ascending order with no gaps.
226	 */
227	return ((curcpu + 1) % foundcpus);
228}
229
230static int
231vmexit_catch_reset(void)
232{
233        stats.io_reset++;
234        return (VMEXIT_RESET);
235}
236
237static int
238vmexit_catch_inout(void)
239{
240	return (VMEXIT_ABORT);
241}
242
243static int
244vmexit_handle_notify(struct vmctx *ctx, struct vm_exit *vme, int *pvcpu,
245		     uint32_t eax)
246{
247#if BHYVE_DEBUG
248	/*
249	 * put guest-driven debug here
250	 */
251#endif
252        return (VMEXIT_CONTINUE);
253}
254
255static int
256vmexit_inout(struct vmctx *ctx, struct vm_exit *vme, int *pvcpu)
257{
258	int error;
259	int bytes, port, in, out;
260	uint32_t eax;
261	int vcpu;
262
263	vcpu = *pvcpu;
264
265	port = vme->u.inout.port;
266	bytes = vme->u.inout.bytes;
267	eax = vme->u.inout.eax;
268	in = vme->u.inout.in;
269	out = !in;
270
271	/* We don't deal with these */
272	if (vme->u.inout.string || vme->u.inout.rep)
273		return (VMEXIT_ABORT);
274
275	/* Special case of guest reset */
276	if (out && port == 0x64 && (uint8_t)eax == 0xFE)
277		return (vmexit_catch_reset());
278
279        /* Extra-special case of host notifications */
280        if (out && port == GUEST_NIO_PORT)
281                return (vmexit_handle_notify(ctx, vme, pvcpu, eax));
282
283	error = emulate_inout(ctx, vcpu, in, port, bytes, &eax, strictio);
284	if (error == 0 && in)
285		error = vm_set_register(ctx, vcpu, VM_REG_GUEST_RAX, eax);
286
287	if (error == 0)
288		return (VMEXIT_CONTINUE);
289	else {
290		fprintf(stderr, "Unhandled %s%c 0x%04x\n",
291			in ? "in" : "out",
292			bytes == 1 ? 'b' : (bytes == 2 ? 'w' : 'l'), port);
293		return (vmexit_catch_inout());
294	}
295}
296
297static int
298vmexit_rdmsr(struct vmctx *ctx, struct vm_exit *vme, int *pvcpu)
299{
300	fprintf(stderr, "vm exit rdmsr 0x%x, cpu %d\n", vme->u.msr.code,
301	    *pvcpu);
302	return (VMEXIT_ABORT);
303}
304
305static int
306vmexit_wrmsr(struct vmctx *ctx, struct vm_exit *vme, int *pvcpu)
307{
308	int newcpu;
309	int retval = VMEXIT_CONTINUE;
310
311	newcpu = emulate_wrmsr(ctx, *pvcpu, vme->u.msr.code,vme->u.msr.wval);
312
313        return (retval);
314}
315
316static int
317vmexit_spinup_ap(struct vmctx *ctx, struct vm_exit *vme, int *pvcpu)
318{
319	int newcpu;
320	int retval = VMEXIT_CONTINUE;
321
322	newcpu = spinup_ap(ctx, *pvcpu,
323			   vme->u.spinup_ap.vcpu, vme->u.spinup_ap.rip);
324
325	return (retval);
326}
327
328static int
329vmexit_vmx(struct vmctx *ctx, struct vm_exit *vmexit, int *pvcpu)
330{
331
332	fprintf(stderr, "vm exit[%d]\n", *pvcpu);
333	fprintf(stderr, "\treason\t\tVMX\n");
334	fprintf(stderr, "\trip\t\t0x%016lx\n", vmexit->rip);
335	fprintf(stderr, "\tinst_length\t%d\n", vmexit->inst_length);
336	fprintf(stderr, "\terror\t\t%d\n", vmexit->u.vmx.error);
337	fprintf(stderr, "\texit_reason\t%u\n", vmexit->u.vmx.exit_reason);
338	fprintf(stderr, "\tqualification\t0x%016lx\n",
339	    vmexit->u.vmx.exit_qualification);
340
341	return (VMEXIT_ABORT);
342}
343
344static int
345vmexit_bogus(struct vmctx *ctx, struct vm_exit *vmexit, int *pvcpu)
346{
347
348	stats.vmexit_bogus++;
349
350	return (VMEXIT_RESTART);
351}
352
353static int
354vmexit_hlt(struct vmctx *ctx, struct vm_exit *vmexit, int *pvcpu)
355{
356
357	stats.vmexit_hlt++;
358
359	/*
360	 * Just continue execution with the next instruction. We use
361	 * the HLT VM exit as a way to be friendly with the host
362	 * scheduler.
363	 */
364	return (VMEXIT_CONTINUE);
365}
366
367static int
368vmexit_pause(struct vmctx *ctx, struct vm_exit *vmexit, int *pvcpu)
369{
370
371	stats.vmexit_pause++;
372
373	return (VMEXIT_CONTINUE);
374}
375
376static int
377vmexit_mtrap(struct vmctx *ctx, struct vm_exit *vmexit, int *pvcpu)
378{
379
380	stats.vmexit_mtrap++;
381
382	return (VMEXIT_RESTART);
383}
384
385static int
386vmexit_inst_emul(struct vmctx *ctx, struct vm_exit *vmexit, int *pvcpu)
387{
388	int err;
389	stats.vmexit_inst_emul++;
390
391	err = emulate_mem(ctx, *pvcpu, vmexit->u.inst_emul.gpa,
392			  &vmexit->u.inst_emul.vie);
393
394	if (err) {
395		if (err == EINVAL) {
396			fprintf(stderr,
397			    "Failed to emulate instruction at 0x%lx\n",
398			    vmexit->rip);
399		} else if (err == ESRCH) {
400			fprintf(stderr, "Unhandled memory access to 0x%lx\n",
401			    vmexit->u.inst_emul.gpa);
402		}
403
404		return (VMEXIT_ABORT);
405	}
406
407	return (VMEXIT_CONTINUE);
408}
409
410static vmexit_handler_t handler[VM_EXITCODE_MAX] = {
411	[VM_EXITCODE_INOUT]  = vmexit_inout,
412	[VM_EXITCODE_VMX]    = vmexit_vmx,
413	[VM_EXITCODE_BOGUS]  = vmexit_bogus,
414	[VM_EXITCODE_RDMSR]  = vmexit_rdmsr,
415	[VM_EXITCODE_WRMSR]  = vmexit_wrmsr,
416	[VM_EXITCODE_MTRAP]  = vmexit_mtrap,
417	[VM_EXITCODE_INST_EMUL] = vmexit_inst_emul,
418	[VM_EXITCODE_SPINUP_AP] = vmexit_spinup_ap,
419};
420
421static void
422vm_loop(struct vmctx *ctx, int vcpu, uint64_t rip)
423{
424	cpuset_t mask;
425	int error, rc, prevcpu;
426	enum vm_exitcode exitcode;
427
428	if (pincpu >= 0) {
429		CPU_ZERO(&mask);
430		CPU_SET(pincpu + vcpu, &mask);
431		error = pthread_setaffinity_np(pthread_self(),
432					       sizeof(mask), &mask);
433		assert(error == 0);
434	}
435
436	while (1) {
437		error = vm_run(ctx, vcpu, rip, &vmexit[vcpu]);
438		if (error != 0) {
439			/*
440			 * It is possible that 'vmmctl' or some other process
441			 * has transitioned the vcpu to CANNOT_RUN state right
442			 * before we tried to transition it to RUNNING.
443			 *
444			 * This is expected to be temporary so just retry.
445			 */
446			if (errno == EBUSY)
447				continue;
448			else
449				break;
450		}
451
452		prevcpu = vcpu;
453
454		exitcode = vmexit[vcpu].exitcode;
455		if (exitcode >= VM_EXITCODE_MAX || handler[exitcode] == NULL) {
456			fprintf(stderr, "vm_loop: unexpected exitcode 0x%x\n",
457			    exitcode);
458			exit(1);
459		}
460
461                rc = (*handler[exitcode])(ctx, &vmexit[vcpu], &vcpu);
462
463		switch (rc) {
464		case VMEXIT_CONTINUE:
465                        rip = vmexit[vcpu].rip + vmexit[vcpu].inst_length;
466			break;
467		case VMEXIT_RESTART:
468                        rip = vmexit[vcpu].rip;
469			break;
470		case VMEXIT_RESET:
471			exit(0);
472		default:
473			exit(1);
474		}
475	}
476	fprintf(stderr, "vm_run error %d, errno %d\n", error, errno);
477}
478
479static int
480num_vcpus_allowed(struct vmctx *ctx)
481{
482	int tmp, error;
483
484	error = vm_get_capability(ctx, BSP, VM_CAP_UNRESTRICTED_GUEST, &tmp);
485
486	/*
487	 * The guest is allowed to spinup more than one processor only if the
488	 * UNRESTRICTED_GUEST capability is available.
489	 */
490	if (error == 0)
491		return (VM_MAXCPU);
492	else
493		return (1);
494}
495
496int
497main(int argc, char *argv[])
498{
499	int c, error, gdb_port, tmp, err, ioapic, bvmcons;
500	int max_vcpus;
501	struct vmctx *ctx;
502	uint64_t rip;
503	size_t memsize;
504
505	bvmcons = 0;
506	progname = basename(argv[0]);
507	gdb_port = DEFAULT_GDB_PORT;
508	guest_ncpus = 1;
509	ioapic = 0;
510	memsize = 256 * MB;
511
512	while ((c = getopt(argc, argv, "abehAHIPp:g:c:s:S:m:")) != -1) {
513		switch (c) {
514		case 'a':
515			disable_x2apic = 1;
516			break;
517		case 'A':
518			acpi = 1;
519			break;
520		case 'b':
521			bvmcons = 1;
522			break;
523		case 'p':
524			pincpu = atoi(optarg);
525			break;
526                case 'c':
527			guest_ncpus = atoi(optarg);
528			break;
529		case 'g':
530			gdb_port = atoi(optarg);
531			break;
532		case 's':
533			if (pci_parse_slot(optarg, 0) != 0)
534				exit(1);
535			else
536				break;
537		case 'S':
538			if (pci_parse_slot(optarg, 1) != 0)
539				exit(1);
540			else
541				break;
542                case 'm':
543			memsize = strtoul(optarg, NULL, 0) * MB;
544			break;
545		case 'H':
546			guest_vmexit_on_hlt = 1;
547			break;
548		case 'I':
549			ioapic = 1;
550			break;
551		case 'P':
552			guest_vmexit_on_pause = 1;
553			break;
554		case 'e':
555			strictio = 1;
556			break;
557		case 'h':
558			usage(0);
559		default:
560			usage(1);
561		}
562	}
563	argc -= optind;
564	argv += optind;
565
566	if (argc != 1)
567		usage(1);
568
569	vmname = argv[0];
570
571	ctx = vm_open(vmname);
572	if (ctx == NULL) {
573		perror("vm_open");
574		exit(1);
575	}
576
577	max_vcpus = num_vcpus_allowed(ctx);
578	if (guest_ncpus > max_vcpus) {
579		fprintf(stderr, "%d vCPUs requested but only %d available\n",
580			guest_ncpus, max_vcpus);
581		exit(1);
582	}
583
584	if (fbsdrun_vmexit_on_hlt()) {
585		err = vm_get_capability(ctx, BSP, VM_CAP_HALT_EXIT, &tmp);
586		if (err < 0) {
587			fprintf(stderr, "VM exit on HLT not supported\n");
588			exit(1);
589		}
590		vm_set_capability(ctx, BSP, VM_CAP_HALT_EXIT, 1);
591		handler[VM_EXITCODE_HLT] = vmexit_hlt;
592	}
593
594        if (fbsdrun_vmexit_on_pause()) {
595		/*
596		 * pause exit support required for this mode
597		 */
598		err = vm_get_capability(ctx, BSP, VM_CAP_PAUSE_EXIT, &tmp);
599		if (err < 0) {
600			fprintf(stderr,
601			    "SMP mux requested, no pause support\n");
602			exit(1);
603		}
604		vm_set_capability(ctx, BSP, VM_CAP_PAUSE_EXIT, 1);
605		handler[VM_EXITCODE_PAUSE] = vmexit_pause;
606        }
607
608	if (fbsdrun_disable_x2apic())
609		err = vm_set_x2apic_state(ctx, BSP, X2APIC_DISABLED);
610	else
611		err = vm_set_x2apic_state(ctx, BSP, X2APIC_ENABLED);
612
613	if (err) {
614		fprintf(stderr, "Unable to set x2apic state (%d)\n", err);
615		exit(1);
616	}
617
618	err = vm_setup_memory(ctx, memsize, VM_MMAP_ALL);
619	if (err) {
620		fprintf(stderr, "Unable to setup memory (%d)\n", err);
621		exit(1);
622	}
623
624	init_mem();
625	init_inout();
626
627	rtc_init(ctx);
628
629	/*
630	 * Exit if a device emulation finds an error in it's initilization
631	 */
632	if (init_pci(ctx) != 0)
633		exit(1);
634
635	if (ioapic)
636		ioapic_init(0);
637
638	if (gdb_port != 0)
639		init_dbgport(gdb_port);
640
641	if (bvmcons)
642		init_bvmcons();
643
644	error = vm_get_register(ctx, BSP, VM_REG_GUEST_RIP, &rip);
645	assert(error == 0);
646
647	/*
648	 * build the guest tables, MP etc.
649	 */
650	mptable_build(ctx, guest_ncpus, ioapic);
651
652	if (acpi) {
653		error = acpi_build(ctx, guest_ncpus, ioapic);
654		assert(error == 0);
655	}
656
657	/*
658	 * Add CPU 0
659	 */
660	fbsdrun_addcpu(ctx, BSP, rip);
661
662	/*
663	 * Head off to the main event dispatch loop
664	 */
665	mevent_dispatch();
666
667	exit(1);
668}
669