1 /*- 2 * Copyright (c) 2009-2012,2016-2017 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 /** 30 * Implements low-level interactions with Hypver-V/Azure 31 */ 32 #include <sys/cdefs.h> 33 __FBSDID("$FreeBSD$"); 34 35 #include <sys/param.h> 36 #include <sys/kernel.h> 37 #include <sys/malloc.h> 38 #include <sys/systm.h> 39 #include <sys/timetc.h> 40 41 #include <vm/vm.h> 42 #include <vm/vm_extern.h> 43 #include <vm/vm_kern.h> 44 #include <vm/pmap.h> 45 46 #include <dev/hyperv/include/hyperv.h> 47 #include <dev/hyperv/include/hyperv_busdma.h> 48 #include <dev/hyperv/vmbus/hyperv_machdep.h> 49 #include <dev/hyperv/vmbus/hyperv_reg.h> 50 #include <dev/hyperv/vmbus/hyperv_var.h> 51 52 #define HYPERV_FREEBSD_BUILD 0ULL 53 #define HYPERV_FREEBSD_VERSION ((uint64_t)__FreeBSD_version) 54 #define HYPERV_FREEBSD_OSID 0ULL 55 56 #define MSR_HV_GUESTID_BUILD_FREEBSD \ 57 (HYPERV_FREEBSD_BUILD & MSR_HV_GUESTID_BUILD_MASK) 58 #define MSR_HV_GUESTID_VERSION_FREEBSD \ 59 ((HYPERV_FREEBSD_VERSION << MSR_HV_GUESTID_VERSION_SHIFT) & \ 60 MSR_HV_GUESTID_VERSION_MASK) 61 #define MSR_HV_GUESTID_OSID_FREEBSD \ 62 ((HYPERV_FREEBSD_OSID << MSR_HV_GUESTID_OSID_SHIFT) & \ 63 MSR_HV_GUESTID_OSID_MASK) 64 65 #define MSR_HV_GUESTID_FREEBSD \ 66 (MSR_HV_GUESTID_BUILD_FREEBSD | \ 67 MSR_HV_GUESTID_VERSION_FREEBSD | \ 68 MSR_HV_GUESTID_OSID_FREEBSD | \ 69 MSR_HV_GUESTID_OSTYPE_FREEBSD) 70 71 struct hypercall_ctx { 72 void *hc_addr; 73 vm_paddr_t hc_paddr; 74 }; 75 76 static u_int hyperv_get_timecount(struct timecounter *); 77 static bool hyperv_identify(void); 78 static void hypercall_memfree(void); 79 80 u_int hyperv_features; 81 u_int hyperv_recommends; 82 83 static u_int hyperv_pm_features; 84 static u_int hyperv_features3; 85 86 hyperv_tc64_t hyperv_tc64; 87 88 static struct timecounter hyperv_timecounter = { 89 .tc_get_timecount = hyperv_get_timecount, 90 .tc_poll_pps = NULL, 91 .tc_counter_mask = 0xffffffff, 92 .tc_frequency = HYPERV_TIMER_FREQ, 93 .tc_name = "Hyper-V", 94 .tc_quality = 2000, 95 .tc_flags = 0, 96 .tc_priv = NULL 97 }; 98 99 static struct hypercall_ctx hypercall_context; 100 101 static u_int 102 hyperv_get_timecount(struct timecounter *tc __unused) 103 { 104 return rdmsr(MSR_HV_TIME_REF_COUNT); 105 } 106 107 static uint64_t 108 hyperv_tc64_rdmsr(void) 109 { 110 111 return (rdmsr(MSR_HV_TIME_REF_COUNT)); 112 } 113 114 uint64_t 115 hypercall_post_message(bus_addr_t msg_paddr) 116 { 117 return hypercall_md(hypercall_context.hc_addr, 118 HYPERCALL_POST_MESSAGE, msg_paddr, 0); 119 } 120 121 uint64_t 122 hypercall_signal_event(bus_addr_t monprm_paddr) 123 { 124 return hypercall_md(hypercall_context.hc_addr, 125 HYPERCALL_SIGNAL_EVENT, monprm_paddr, 0); 126 } 127 128 int 129 hyperv_guid2str(const struct hyperv_guid *guid, char *buf, size_t sz) 130 { 131 const uint8_t *d = guid->hv_guid; 132 133 return snprintf(buf, sz, "%02x%02x%02x%02x-" 134 "%02x%02x-%02x%02x-%02x%02x-" 135 "%02x%02x%02x%02x%02x%02x", 136 d[3], d[2], d[1], d[0], 137 d[5], d[4], d[7], d[6], d[8], d[9], 138 d[10], d[11], d[12], d[13], d[14], d[15]); 139 } 140 141 static bool 142 hyperv_identify(void) 143 { 144 u_int regs[4]; 145 unsigned int maxleaf; 146 147 if (vm_guest != VM_GUEST_HV) 148 return (false); 149 150 do_cpuid(CPUID_LEAF_HV_MAXLEAF, regs); 151 maxleaf = regs[0]; 152 if (maxleaf < CPUID_LEAF_HV_LIMITS) 153 return (false); 154 155 do_cpuid(CPUID_LEAF_HV_INTERFACE, regs); 156 if (regs[0] != CPUID_HV_IFACE_HYPERV) 157 return (false); 158 159 do_cpuid(CPUID_LEAF_HV_FEATURES, regs); 160 if ((regs[0] & CPUID_HV_MSR_HYPERCALL) == 0) { 161 /* 162 * Hyper-V w/o Hypercall is impossible; someone 163 * is faking Hyper-V. 164 */ 165 return (false); 166 } 167 hyperv_features = regs[0]; 168 hyperv_pm_features = regs[2]; 169 hyperv_features3 = regs[3]; 170 171 do_cpuid(CPUID_LEAF_HV_IDENTITY, regs); 172 printf("Hyper-V Version: %d.%d.%d [SP%d]\n", 173 regs[1] >> 16, regs[1] & 0xffff, regs[0], regs[2]); 174 175 printf(" Features=0x%b\n", hyperv_features, 176 "\020" 177 "\001VPRUNTIME" /* MSR_HV_VP_RUNTIME */ 178 "\002TMREFCNT" /* MSR_HV_TIME_REF_COUNT */ 179 "\003SYNIC" /* MSRs for SynIC */ 180 "\004SYNTM" /* MSRs for SynTimer */ 181 "\005APIC" /* MSR_HV_{EOI,ICR,TPR} */ 182 "\006HYPERCALL" /* MSR_HV_{GUEST_OS_ID,HYPERCALL} */ 183 "\007VPINDEX" /* MSR_HV_VP_INDEX */ 184 "\010RESET" /* MSR_HV_RESET */ 185 "\011STATS" /* MSR_HV_STATS_ */ 186 "\012REFTSC" /* MSR_HV_REFERENCE_TSC */ 187 "\013IDLE" /* MSR_HV_GUEST_IDLE */ 188 "\014TMFREQ" /* MSR_HV_{TSC,APIC}_FREQUENCY */ 189 "\015DEBUG"); /* MSR_HV_SYNTH_DEBUG_ */ 190 printf(" PM Features=0x%b [C%u]\n", 191 (hyperv_pm_features & ~CPUPM_HV_CSTATE_MASK), 192 "\020" 193 "\005C3HPET", /* HPET is required for C3 state */ 194 CPUPM_HV_CSTATE(hyperv_pm_features)); 195 printf(" Features3=0x%b\n", hyperv_features3, 196 "\020" 197 "\001MWAIT" /* MWAIT */ 198 "\002DEBUG" /* guest debug support */ 199 "\003PERFMON" /* performance monitor */ 200 "\004PCPUDPE" /* physical CPU dynamic partition event */ 201 "\005XMMHC" /* hypercall input through XMM regs */ 202 "\006IDLE" /* guest idle support */ 203 "\007SLEEP" /* hypervisor sleep support */ 204 "\010NUMA" /* NUMA distance query support */ 205 "\011TMFREQ" /* timer frequency query (TSC, LAPIC) */ 206 "\012SYNCMC" /* inject synthetic machine checks */ 207 "\013CRASH" /* MSRs for guest crash */ 208 "\014DEBUGMSR" /* MSRs for guest debug */ 209 "\015NPIEP" /* NPIEP */ 210 "\016HVDIS"); /* disabling hypervisor */ 211 212 do_cpuid(CPUID_LEAF_HV_RECOMMENDS, regs); 213 hyperv_recommends = regs[0]; 214 if (bootverbose) 215 printf(" Recommends: %08x %08x\n", regs[0], regs[1]); 216 217 do_cpuid(CPUID_LEAF_HV_LIMITS, regs); 218 if (bootverbose) { 219 printf(" Limits: Vcpu:%d Lcpu:%d Int:%d\n", 220 regs[0], regs[1], regs[2]); 221 } 222 223 if (maxleaf >= CPUID_LEAF_HV_HWFEATURES) { 224 do_cpuid(CPUID_LEAF_HV_HWFEATURES, regs); 225 if (bootverbose) { 226 printf(" HW Features: %08x, AMD: %08x\n", 227 regs[0], regs[3]); 228 } 229 } 230 231 return (true); 232 } 233 234 static void 235 hyperv_init(void *dummy __unused) 236 { 237 if (!hyperv_identify()) { 238 /* Not Hyper-V; reset guest id to the generic one. */ 239 if (vm_guest == VM_GUEST_HV) 240 vm_guest = VM_GUEST_VM; 241 return; 242 } 243 244 /* Set guest id */ 245 wrmsr(MSR_HV_GUEST_OS_ID, MSR_HV_GUESTID_FREEBSD); 246 247 if (hyperv_features & CPUID_HV_MSR_TIME_REFCNT) { 248 /* Register Hyper-V timecounter */ 249 tc_init(&hyperv_timecounter); 250 251 /* 252 * Install 64 bits timecounter method for other modules 253 * to use. 254 */ 255 hyperv_tc64 = hyperv_tc64_rdmsr; 256 } 257 } 258 SYSINIT(hyperv_initialize, SI_SUB_HYPERVISOR, SI_ORDER_FIRST, hyperv_init, 259 NULL); 260 261 static void 262 hypercall_memfree(void) 263 { 264 kmem_free(kernel_arena, (vm_offset_t)hypercall_context.hc_addr, 265 PAGE_SIZE); 266 hypercall_context.hc_addr = NULL; 267 } 268 269 static void 270 hypercall_create(void *arg __unused) 271 { 272 uint64_t hc, hc_orig; 273 274 if (vm_guest != VM_GUEST_HV) 275 return; 276 277 /* 278 * NOTE: 279 * - busdma(9), i.e. hyperv_dmamem APIs, can _not_ be used due to 280 * the NX bit. 281 * - Assume kmem_malloc() returns properly aligned memory. 282 */ 283 hypercall_context.hc_addr = (void *)kmem_malloc(kernel_arena, PAGE_SIZE, 284 M_WAITOK); 285 hypercall_context.hc_paddr = vtophys(hypercall_context.hc_addr); 286 287 /* Get the 'reserved' bits, which requires preservation. */ 288 hc_orig = rdmsr(MSR_HV_HYPERCALL); 289 290 /* 291 * Setup the Hypercall page. 292 * 293 * NOTE: 'reserved' bits MUST be preserved. 294 */ 295 hc = ((hypercall_context.hc_paddr >> PAGE_SHIFT) << 296 MSR_HV_HYPERCALL_PGSHIFT) | 297 (hc_orig & MSR_HV_HYPERCALL_RSVD_MASK) | 298 MSR_HV_HYPERCALL_ENABLE; 299 wrmsr(MSR_HV_HYPERCALL, hc); 300 301 /* 302 * Confirm that Hypercall page did get setup. 303 */ 304 hc = rdmsr(MSR_HV_HYPERCALL); 305 if ((hc & MSR_HV_HYPERCALL_ENABLE) == 0) { 306 printf("hyperv: Hypercall setup failed\n"); 307 hypercall_memfree(); 308 /* Can't perform any Hyper-V specific actions */ 309 vm_guest = VM_GUEST_VM; 310 return; 311 } 312 if (bootverbose) 313 printf("hyperv: Hypercall created\n"); 314 } 315 SYSINIT(hypercall_ctor, SI_SUB_DRIVERS, SI_ORDER_FIRST, hypercall_create, NULL); 316 317 static void 318 hypercall_destroy(void *arg __unused) 319 { 320 uint64_t hc; 321 322 if (hypercall_context.hc_addr == NULL) 323 return; 324 325 /* Disable Hypercall */ 326 hc = rdmsr(MSR_HV_HYPERCALL); 327 wrmsr(MSR_HV_HYPERCALL, (hc & MSR_HV_HYPERCALL_RSVD_MASK)); 328 hypercall_memfree(); 329 330 if (bootverbose) 331 printf("hyperv: Hypercall destroyed\n"); 332 } 333 SYSUNINIT(hypercall_dtor, SI_SUB_DRIVERS, SI_ORDER_FIRST, hypercall_destroy, 334 NULL); 335