usr.sbin/bhyve/bhyverun.c

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