sys/dev/virtual/hyperv/vmbus/hyperv.c

   1 /*-
   2  * Copyright (c) 2009-2012,2016 Microsoft Corp.
   3  * Copyright (c) 2012 NetApp Inc.
   4  * Copyright (c) 2012 Citrix Inc.
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice unmodified, this list of conditions, and the following
  12  *    disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 #include <sys/param.h>
  30 #include <sys/kernel.h>
  31 #include <sys/systimer.h>
  32 #include <sys/systm.h>
  33
  34 #include <machine/cpufunc.h>
  35
  36 #include <dev/virtual/hyperv/hyperv_busdma.h>
  37 #include <dev/virtual/hyperv/vmbus/hyperv_machdep.h>
  38 #include <dev/virtual/hyperv/vmbus/hyperv_reg.h>
  39 #include <dev/virtual/hyperv/vmbus/hyperv_var.h>
  40
  41 #define HYPERV_DRAGONFLY_BUILD          0ULL
  42 #define HYPERV_DRAGONFLY_VERSION        ((uint64_t)__DragonFly_version)
  43 #define HYPERV_DRAGONFLY_OSID           0ULL
  44
  45 #define MSR_HV_GUESTID_BUILD_DRAGONFLY  \
  46         (HYPERV_DRAGONFLY_BUILD & MSR_HV_GUESTID_BUILD_MASK)
  47 #define MSR_HV_GUESTID_VERSION_DRAGONFLY \
  48         ((HYPERV_DRAGONFLY_VERSION << MSR_HV_GUESTID_VERSION_SHIFT) & \
  49          MSR_HV_GUESTID_VERSION_MASK)
  50 #define MSR_HV_GUESTID_OSID_DRAGONFLY   \
  51         ((HYPERV_DRAGONFLY_OSID << MSR_HV_GUESTID_OSID_SHIFT) & \
  52          MSR_HV_GUESTID_OSID_MASK)
  53
  54 #define MSR_HV_GUESTID_DRAGONFLY        \
  55         (MSR_HV_GUESTID_BUILD_DRAGONFLY | \
  56          MSR_HV_GUESTID_VERSION_DRAGONFLY | \
  57          MSR_HV_GUESTID_OSID_DRAGONFLY | \
  58          MSR_HV_GUESTID_OSTYPE_FREEBSD)
  59
  60 struct hypercall_ctx {
  61         void                    *hc_addr;
  62         struct hyperv_dma       hc_dma;
  63 };
  64
  65 static void             hyperv_cputimer_construct(struct cputimer *,
  66                             sysclock_t);
  67 static sysclock_t       hyperv_cputimer_count(void);
  68 static boolean_t        hyperv_identify(void);
  69 static int              hypercall_create(void);
  70 static void             hypercall_destroy(void);
  71 static void             hypercall_memfree(void);
  72
  73 u_int                   hyperv_features;
  74 static u_int            hyperv_recommends;
  75
  76 static u_int            hyperv_pm_features;
  77 static u_int            hyperv_features3;
  78
  79 static struct cputimer  hyperv_cputimer = {
  80         SLIST_ENTRY_INITIALIZER,
  81         "Hyper-V",
  82         CPUTIMER_PRI_VMM,
  83         CPUTIMER_VMM,
  84         hyperv_cputimer_count,
  85         cputimer_default_fromhz,
  86         cputimer_default_fromus,
  87         hyperv_cputimer_construct,
  88         cputimer_default_destruct,
  89         HYPERV_TIMER_FREQ,
  90         0, 0, 0
  91 };
  92
  93 static struct hypercall_ctx     hypercall_context;
  94
  95 uint64_t
  96 hypercall_post_message(bus_addr_t msg_paddr)
  97 {
  98         return hypercall_md(hypercall_context.hc_addr,
  99             HYPERCALL_POST_MESSAGE, msg_paddr, 0);
 100 }
 101
 102 static void
 103 hyperv_cputimer_construct(struct cputimer *timer, sysclock_t oldclock)
 104 {
 105         timer->base = 0;
 106         timer->base = oldclock - timer->count();
 107 }
 108
 109 static sysclock_t
 110 hyperv_cputimer_count(void)
 111 {
 112         uint64_t val;
 113
 114         val = rdmsr(MSR_HV_TIME_REF_COUNT);
 115         return (val + hyperv_cputimer.base);
 116 }
 117
 118 static void
 119 hypercall_memfree(void)
 120 {
 121         hyperv_dmamem_free(&hypercall_context.hc_dma,
 122             hypercall_context.hc_addr);
 123         hypercall_context.hc_addr = NULL;
 124 }
 125
 126 static int
 127 hypercall_create(void)
 128 {
 129         uint64_t hc, hc_orig;
 130
 131         hypercall_context.hc_addr = hyperv_dmamem_alloc(NULL, PAGE_SIZE, 0,
 132             PAGE_SIZE, &hypercall_context.hc_dma, BUS_DMA_WAITOK);
 133         if (hypercall_context.hc_addr == NULL) {
 134                 kprintf("hyperv: Hypercall page allocation failed\n");
 135                 return ENOMEM;
 136         }
 137
 138         /* Get the 'reserved' bits, which requires preservation. */
 139         hc_orig = rdmsr(MSR_HV_HYPERCALL);
 140
 141         /*
 142          * Setup the Hypercall page.
 143          *
 144          * NOTE: 'reserved' bits MUST be preserved.
 145          */
 146         hc = ((hypercall_context.hc_dma.hv_paddr >> PAGE_SHIFT) <<
 147             MSR_HV_HYPERCALL_PGSHIFT) |
 148             (hc_orig & MSR_HV_HYPERCALL_RSVD_MASK) |
 149             MSR_HV_HYPERCALL_ENABLE;
 150         wrmsr(MSR_HV_HYPERCALL, hc);
 151
 152         /*
 153          * Confirm that Hypercall page did get setup.
 154          */
 155         hc = rdmsr(MSR_HV_HYPERCALL);
 156         if ((hc & MSR_HV_HYPERCALL_ENABLE) == 0) {
 157                 kprintf("hyperv: Hypercall setup failed\n");
 158                 hypercall_memfree();
 159                 return EIO;
 160         }
 161         if (bootverbose)
 162                 kprintf("hyperv: Hypercall created\n");
 163
 164         return 0;
 165 }
 166
 167 static void
 168 hypercall_destroy(void)
 169 {
 170         uint64_t hc;
 171
 172         if (hypercall_context.hc_addr == NULL)
 173                 return;
 174
 175         /* Disable Hypercall */
 176         hc = rdmsr(MSR_HV_HYPERCALL);
 177         wrmsr(MSR_HV_HYPERCALL, (hc & MSR_HV_HYPERCALL_RSVD_MASK));
 178         hypercall_memfree();
 179
 180         if (bootverbose)
 181                 kprintf("hyperv: Hypercall destroyed\n");
 182 }
 183
 184 static boolean_t
 185 hyperv_identify(void)
 186 {
 187         u_int regs[4];
 188         unsigned int maxleaf;
 189
 190         if (vmm_guest != VMM_GUEST_HYPERV)
 191                 return (FALSE);
 192
 193         do_cpuid(CPUID_LEAF_HV_MAXLEAF, regs);
 194         maxleaf = regs[0];
 195         if (maxleaf < CPUID_LEAF_HV_LIMITS)
 196                 return (FALSE);
 197
 198         do_cpuid(CPUID_LEAF_HV_INTERFACE, regs);
 199         if (regs[0] != CPUID_HV_IFACE_HYPERV)
 200                 return (FALSE);
 201
 202         do_cpuid(CPUID_LEAF_HV_FEATURES, regs);
 203         if ((regs[0] & CPUID_HV_MSR_HYPERCALL) == 0) {
 204                 /*
 205                  * Hyper-V w/o Hypercall is impossible; someone
 206                  * is faking Hyper-V.
 207                  */
 208                 return (FALSE);
 209         }
 210         hyperv_features = regs[0];
 211         hyperv_pm_features = regs[2];
 212         hyperv_features3 = regs[3];
 213
 214         do_cpuid(CPUID_LEAF_HV_IDENTITY, regs);
 215         kprintf("Hyper-V Version: %d.%d.%d [SP%d]\n",
 216             regs[1] >> 16, regs[1] & 0xffff, regs[0], regs[2]);
 217
 218         kprintf("  Features=0x%b\n", hyperv_features,
 219             "\020"
 220             "\001VPRUNTIME"     /* MSR_HV_VP_RUNTIME */
 221             "\002TMREFCNT"      /* MSR_HV_TIME_REF_COUNT */
 222             "\003SYNIC"         /* MSRs for SynIC */
 223             "\004SYNTM"         /* MSRs for SynTimer */
 224             "\005APIC"          /* MSR_HV_{EOI,ICR,TPR} */
 225             "\006HYPERCALL"     /* MSR_HV_{GUEST_OS_ID,HYPERCALL} */
 226             "\007VPINDEX"       /* MSR_HV_VP_INDEX */
 227             "\010RESET"         /* MSR_HV_RESET */
 228             "\011STATS"         /* MSR_HV_STATS_ */
 229             "\012REFTSC"        /* MSR_HV_REFERENCE_TSC */
 230             "\013IDLE"          /* MSR_HV_GUEST_IDLE */
 231             "\014TMFREQ"        /* MSR_HV_{TSC,APIC}_FREQUENCY */
 232             "\015DEBUG");       /* MSR_HV_SYNTH_DEBUG_ */
 233         kprintf("  PM Features=0x%b [C%u]\n",
 234             (hyperv_pm_features & ~CPUPM_HV_CSTATE_MASK),
 235             "\020"
 236             "\005C3HPET",       /* HPET is required for C3 state */
 237             CPUPM_HV_CSTATE(hyperv_pm_features));
 238         kprintf("  Features3=0x%b\n", hyperv_features3,
 239             "\020"
 240             "\001MWAIT"         /* MWAIT */
 241             "\002DEBUG"         /* guest debug support */
 242             "\003PERFMON"       /* performance monitor */
 243             "\004PCPUDPE"       /* physical CPU dynamic partition event */
 244             "\005XMMHC"         /* hypercall input through XMM regs */
 245             "\006IDLE"          /* guest idle support */
 246             "\007SLEEP"         /* hypervisor sleep support */
 247             "\010NUMA"          /* NUMA distance query support */
 248             "\011TMFREQ"        /* timer frequency query (TSC, LAPIC) */
 249             "\012SYNCMC"        /* inject synthetic machine checks */
 250             "\013CRASH"         /* MSRs for guest crash */
 251             "\014DEBUGMSR"      /* MSRs for guest debug */
 252             "\015NPIEP"         /* NPIEP */
 253             "\016HVDIS");       /* disabling hypervisor */
 254
 255         do_cpuid(CPUID_LEAF_HV_RECOMMENDS, regs);
 256         hyperv_recommends = regs[0];
 257         if (bootverbose)
 258                 kprintf("  Recommends: %08x %08x\n", regs[0], regs[1]);
 259
 260         do_cpuid(CPUID_LEAF_HV_LIMITS, regs);
 261         if (bootverbose) {
 262                 kprintf("  Limits: Vcpu:%d Lcpu:%d Int:%d\n",
 263                     regs[0], regs[1], regs[2]);
 264         }
 265
 266         if (maxleaf >= CPUID_LEAF_HV_HWFEATURES) {
 267                 do_cpuid(CPUID_LEAF_HV_HWFEATURES, regs);
 268                 if (bootverbose) {
 269                         kprintf("  HW Features: %08x, AMD: %08x\n",
 270                             regs[0], regs[3]);
 271                 }
 272         }
 273
 274         return (TRUE);
 275 }
 276
 277 static void
 278 hyperv_init(void *dummy __unused)
 279 {
 280         int error;
 281
 282         if (!hyperv_identify()) {
 283                 /* Not Hyper-V; reset guest id to the generic one. */
 284                 if (vmm_guest == VMM_GUEST_HYPERV)
 285                         vmm_guest = VMM_GUEST_UNKNOWN;
 286                 return;
 287         }
 288
 289         /* Set guest id */
 290         wrmsr(MSR_HV_GUEST_OS_ID, MSR_HV_GUESTID_DRAGONFLY);
 291
 292         if (hyperv_features & CPUID_HV_MSR_TIME_REFCNT) {
 293                 /* Register Hyper-V systimer */
 294                 cputimer_register(&hyperv_cputimer);
 295                 cputimer_select(&hyperv_cputimer, 0);
 296         }
 297
 298         error = hypercall_create();
 299         if (error) {
 300                 /* Can't perform any Hyper-V specific actions */
 301                 vmm_guest = VMM_GUEST_UNKNOWN;
 302         }
 303
 304         /* Machine dependent initialization. */
 305         hyperv_md_init();
 306 }
 307 SYSINIT(hyperv_initialize, SI_SUB_PRE_DRIVERS, SI_ORDER_FIRST,
 308     hyperv_init, NULL);
 309
 310 static void
 311 hyperv_uninit(void *dummy __unused)
 312 {
 313         /* Machine dependent uninitialization. */
 314         hyperv_md_uninit();
 315
 316         if (hyperv_features & CPUID_HV_MSR_TIME_REFCNT) {
 317                 /* Deregister Hyper-V systimer */
 318                 cputimer_deregister(&hyperv_cputimer);
 319         }
 320         hypercall_destroy();
 321 }
 322 SYSUNINIT(hyperv_uninitialize, SI_SUB_PRE_DRIVERS, SI_ORDER_FIRST,
 323     hyperv_uninit, NULL);