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