2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2008, 2013 Citrix Systems, Inc.
5 * Copyright (c) 2012 Spectra Logic Corporation
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following 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.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
33 #include <sys/param.h>
35 #include <sys/kernel.h>
36 #include <sys/malloc.h>
39 #include <sys/systm.h>
43 #include <vm/vm_param.h>
45 #include <dev/pci/pcivar.h>
47 #include <machine/cpufunc.h>
48 #include <machine/cpu.h>
49 #include <machine/smp.h>
51 #include <x86/apicreg.h>
53 #include <xen/xen-os.h>
54 #include <xen/features.h>
55 #include <xen/gnttab.h>
56 #include <xen/hypervisor.h>
58 #include <xen/xen_intr.h>
60 #include <xen/interface/arch-x86/cpuid.h>
61 #include <xen/interface/hvm/params.h>
62 #include <xen/interface/vcpu.h>
64 /*--------------------------- Forward Declarations ---------------------------*/
65 static void xen_hvm_cpu_init(void);
67 /*-------------------------------- Global Data -------------------------------*/
68 enum xen_domain_type xen_domain_type = XEN_NATIVE;
71 struct cpu_ops xen_hvm_cpu_ops = {
72 .cpu_init = xen_hvm_cpu_init,
73 .cpu_resume = xen_hvm_cpu_init
77 static MALLOC_DEFINE(M_XENHVM, "xen_hvm", "Xen HVM PV Support");
80 * If non-zero, the hypervisor has been configured to use a direct
81 * IDT event callback for interrupt injection.
83 int xen_vector_callback_enabled;
86 * Start info flags. ATM this only used to store the initial domain flag for
87 * PVHv2, and it's always empty for HVM guests.
89 uint32_t hvm_start_flags;
91 /*------------------------------- Per-CPU Data -------------------------------*/
92 DPCPU_DEFINE(struct vcpu_info, vcpu_local_info);
93 DPCPU_DEFINE(struct vcpu_info *, vcpu_info);
95 /*------------------ Hypervisor Access Shared Memory Regions -----------------*/
96 shared_info_t *HYPERVISOR_shared_info;
98 /*------------------------------ Sysctl tunables -----------------------------*/
99 int xen_disable_pv_disks = 0;
100 int xen_disable_pv_nics = 0;
101 TUNABLE_INT("hw.xen.disable_pv_disks", &xen_disable_pv_disks);
102 TUNABLE_INT("hw.xen.disable_pv_nics", &xen_disable_pv_nics);
104 /*---------------------- XEN Hypervisor Probe and Setup ----------------------*/
106 static uint32_t cpuid_base;
109 xen_hvm_cpuid_base(void)
111 uint32_t base, regs[4];
113 for (base = 0x40000000; base < 0x40010000; base += 0x100) {
114 do_cpuid(base, regs);
115 if (!memcmp("XenVMMXenVMM", ®s[1], 12)
116 && (regs[0] - base) >= 2)
123 hypervisor_quirks(unsigned int major, unsigned int minor)
126 if (((major < 4) || (major == 4 && minor <= 5)) &&
127 msix_disable_migration == -1) {
129 * Xen hypervisors prior to 4.6.0 do not properly
130 * handle updates to enabled MSI-X table entries,
131 * so disable MSI-X interrupt migration in that
136 "Disabling MSI-X interrupt migration due to Xen hypervisor bug.\n"
137 "Set machdep.msix_disable_migration=0 to forcefully enable it.\n");
138 msix_disable_migration = 1;
144 hypervisor_version(void)
149 do_cpuid(cpuid_base + 1, regs);
151 major = regs[0] >> 16;
152 minor = regs[0] & 0xffff;
153 printf("XEN: Hypervisor version %d.%d detected.\n", major, minor);
155 hypervisor_quirks(major, minor);
159 * Allocate and fill in the hypcall page.
162 xen_hvm_init_hypercall_stubs(enum xen_hvm_init_type init_type)
166 if (xen_domain() && init_type == XEN_HVM_INIT_LATE) {
168 * If the domain type is already set we can assume that the
169 * hypercall page has been populated too, so just print the
170 * version (and apply any quirks) and exit.
172 hypervisor_version();
176 cpuid_base = xen_hvm_cpuid_base();
180 if (init_type == XEN_HVM_INIT_LATE)
181 hypervisor_version();
184 * Find the hypercall pages.
186 do_cpuid(cpuid_base + 2, regs);
190 wrmsr(regs[1], (init_type == XEN_HVM_INIT_EARLY)
191 ? ((vm_paddr_t)&hypercall_page - KERNBASE)
192 : vtophys(&hypercall_page));
198 xen_hvm_init_shared_info_page(void)
200 struct xen_add_to_physmap xatp;
202 if (xen_pv_domain()) {
204 * Already setup in the PV case, shared_info is passed inside
205 * of the start_info struct at start of day.
210 if (HYPERVISOR_shared_info == NULL) {
211 HYPERVISOR_shared_info = malloc(PAGE_SIZE, M_XENHVM, M_NOWAIT);
212 if (HYPERVISOR_shared_info == NULL)
213 panic("Unable to allocate Xen shared info page");
216 xatp.domid = DOMID_SELF;
218 xatp.space = XENMAPSPACE_shared_info;
219 xatp.gpfn = vtophys(HYPERVISOR_shared_info) >> PAGE_SHIFT;
220 if (HYPERVISOR_memory_op(XENMEM_add_to_physmap, &xatp))
221 panic("HYPERVISOR_memory_op failed");
225 * Tell the hypervisor how to contact us for event channel callbacks.
228 xen_hvm_set_callback(device_t dev)
230 struct xen_hvm_param xhp;
233 if (xen_vector_callback_enabled)
236 xhp.domid = DOMID_SELF;
237 xhp.index = HVM_PARAM_CALLBACK_IRQ;
238 if (xen_feature(XENFEAT_hvm_callback_vector) != 0) {
241 xhp.value = HVM_CALLBACK_VECTOR(IDT_EVTCHN);
242 error = HYPERVISOR_hvm_op(HVMOP_set_param, &xhp);
244 xen_vector_callback_enabled = 1;
247 printf("Xen HVM callback vector registration failed (%d). "
248 "Falling back to emulated device interrupt\n", error);
250 xen_vector_callback_enabled = 0;
253 * Called from early boot or resume.
254 * xenpci will invoke us again later.
259 irq = pci_get_irq(dev);
261 xhp.value = HVM_CALLBACK_GSI(irq);
266 slot = pci_get_slot(dev);
267 pin = pci_get_intpin(dev) - 1;
268 xhp.value = HVM_CALLBACK_PCI_INTX(slot, pin);
271 if (HYPERVISOR_hvm_op(HVMOP_set_param, &xhp) != 0)
272 panic("Can't set evtchn callback");
275 #define XEN_MAGIC_IOPORT 0x10
278 XMI_UNPLUG_IDE_DISKS = 0x01,
279 XMI_UNPLUG_NICS = 0x02,
280 XMI_UNPLUG_IDE_EXCEPT_PRI_MASTER = 0x04
284 xen_hvm_disable_emulated_devices(void)
286 u_short disable_devs = 0;
288 if (xen_pv_domain()) {
290 * No emulated devices in the PV case, so no need to unplug
293 if (xen_disable_pv_disks != 0 || xen_disable_pv_nics != 0)
294 printf("PV devices cannot be disabled in PV guests\n");
298 if (inw(XEN_MAGIC_IOPORT) != XMI_MAGIC)
301 if (xen_disable_pv_disks == 0) {
303 printf("XEN: disabling emulated disks\n");
304 disable_devs |= XMI_UNPLUG_IDE_DISKS;
306 if (xen_disable_pv_nics == 0) {
308 printf("XEN: disabling emulated nics\n");
309 disable_devs |= XMI_UNPLUG_NICS;
312 if (disable_devs != 0)
313 outw(XEN_MAGIC_IOPORT, disable_devs);
317 xen_hvm_init(enum xen_hvm_init_type init_type)
322 if (init_type == XEN_HVM_INIT_CANCELLED_SUSPEND)
325 error = xen_hvm_init_hypercall_stubs(init_type);
328 case XEN_HVM_INIT_LATE:
333 * If xen_domain_type is not set at this point
334 * it means we are inside a (PV)HVM guest, because
335 * for PVH the guest type is set much earlier
336 * (see hammer_time_xen).
339 xen_domain_type = XEN_HVM_DOMAIN;
340 vm_guest = VM_GUEST_XEN;
343 setup_xen_features();
345 cpu_ops = xen_hvm_cpu_ops;
348 case XEN_HVM_INIT_RESUME:
350 panic("Unable to init Xen hypercall stubs on resume");
352 /* Clear stale vcpu_info. */
354 DPCPU_ID_SET(i, vcpu_info, NULL);
357 panic("Unsupported HVM initialization type");
360 xen_vector_callback_enabled = 0;
361 xen_hvm_set_callback(NULL);
364 * On (PV)HVM domains we need to request the hypervisor to
365 * fill the shared info page, for PVH guest the shared_info page
366 * is passed inside the start_info struct and is already set, so this
367 * functions are no-ops.
369 xen_hvm_init_shared_info_page();
370 xen_hvm_disable_emulated_devices();
374 xen_hvm_suspend(void)
379 xen_hvm_resume(bool suspend_cancelled)
382 xen_hvm_init(suspend_cancelled ?
383 XEN_HVM_INIT_CANCELLED_SUSPEND : XEN_HVM_INIT_RESUME);
385 /* Register vcpu_info area for CPU#0. */
390 xen_hvm_sysinit(void *arg __unused)
392 xen_hvm_init(XEN_HVM_INIT_LATE);
394 SYSINIT(xen_hvm_init, SI_SUB_HYPERVISOR, SI_ORDER_FIRST, xen_hvm_sysinit, NULL);
397 xen_hvm_cpu_init(void)
399 struct vcpu_register_vcpu_info info;
400 struct vcpu_info *vcpu_info;
407 if (DPCPU_GET(vcpu_info) != NULL) {
409 * vcpu_info is already set. We're resuming
410 * from a failed migration and our pre-suspend
411 * configuration is still valid.
417 * Set vCPU ID. If available fetch the ID from CPUID, if not just use
420 KASSERT(cpuid_base != 0, ("Invalid base Xen CPUID leaf"));
421 cpuid_count(cpuid_base + 4, 0, regs);
422 PCPU_SET(vcpu_id, (regs[0] & XEN_HVM_CPUID_VCPU_ID_PRESENT) ?
423 regs[1] : PCPU_GET(acpi_id));
428 * NB: the vCPU info for vCPUs < 32 can be fetched from the shared info
429 * page, but in order to make sure the mapping code is correct always
430 * attempt to map the vCPU info at a custom place.
432 vcpu_info = DPCPU_PTR(vcpu_local_info);
433 cpu = PCPU_GET(vcpu_id);
434 info.mfn = vtophys(vcpu_info) >> PAGE_SHIFT;
435 info.offset = vtophys(vcpu_info) - trunc_page(vtophys(vcpu_info));
437 rc = HYPERVISOR_vcpu_op(VCPUOP_register_vcpu_info, cpu, &info);
439 DPCPU_SET(vcpu_info, &HYPERVISOR_shared_info->vcpu_info[cpu]);
441 DPCPU_SET(vcpu_info, vcpu_info);
443 SYSINIT(xen_hvm_cpu_init, SI_SUB_INTR, SI_ORDER_FIRST, xen_hvm_cpu_init, NULL);
445 /* HVM/PVH start_info accessors */
447 hvm_get_xenstore_mfn(void)
450 return (hvm_get_parameter(HVM_PARAM_STORE_PFN));
454 hvm_get_xenstore_evtchn(void)
457 return (hvm_get_parameter(HVM_PARAM_STORE_EVTCHN));
461 hvm_get_console_mfn(void)
464 return (hvm_get_parameter(HVM_PARAM_CONSOLE_PFN));
468 hvm_get_console_evtchn(void)
471 return (hvm_get_parameter(HVM_PARAM_CONSOLE_EVTCHN));
475 hvm_get_start_flags(void)
478 return (hvm_start_flags);
481 struct hypervisor_info hypervisor_info = {
482 .get_xenstore_mfn = hvm_get_xenstore_mfn,
483 .get_xenstore_evtchn = hvm_get_xenstore_evtchn,
484 .get_console_mfn = hvm_get_console_mfn,
485 .get_console_evtchn = hvm_get_console_evtchn,
486 .get_start_flags = hvm_get_start_flags,