xen.h revision ad09f8b827db90c9a0093f0b6382803fa64a5fd1
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross/******************************************************************************
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross * Guest OS interface to x86 Xen.
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross * Permission is hereby granted, free of charge, to any person obtaining a copy
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross * of this software and associated documentation files (the "Software"), to
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross * deal in the Software without restriction, including without limitation the
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross * sell copies of the Software, and to permit persons to whom the Software is
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross * furnished to do so, subject to the following conditions:
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross * The above copyright notice and this permission notice shall be included in
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross * all copies or substantial portions of the Software.
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross * DEALINGS IN THE SOFTWARE.
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross * Copyright (c) 2004-2006, K A Fraser
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross#include "../xen.h"
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross/* Structural guest handles introduced in 0x00030201. */
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross typedef struct { type *p; } __guest_handle_ ## name
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross ___DEFINE_XEN_GUEST_HANDLE(const_##name, const type)
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross#define DEFINE_XEN_GUEST_HANDLE(name) __DEFINE_XEN_GUEST_HANDLE(name, name)
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross#define __XEN_GUEST_HANDLE(name) __guest_handle_ ## name
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross#define XEN_GUEST_HANDLE(name) __XEN_GUEST_HANDLE(name)
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross#define set_xen_guest_handle(hnd, val) do { (hnd).p = val; } while (0)
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross#define get_xen_guest_handle(val, hnd) do { val = (hnd).p; } while (0)
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Rosstypedef unsigned long xen_pfn_t;
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross * SEGMENT DESCRIPTOR TABLES
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross * A number of GDT entries are reserved by Xen. These are not situated at the
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross * start of the GDT because some stupid OSes export hard-coded selector values
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross * in their ABI. These hard-coded values are always near the start of the GDT,
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross * so Xen places itself out of the way, at the far end of the GDT.
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross#define FIRST_RESERVED_GDT_BYTE (FIRST_RESERVED_GDT_PAGE * 4096)
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross#define FIRST_RESERVED_GDT_ENTRY (FIRST_RESERVED_GDT_BYTE / 8)
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross/* Maximum number of virtual CPUs in multi-processor guests. */
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Rosstypedef unsigned long xen_ulong_t;
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross * Send an array of these to HYPERVISOR_set_trap_table().
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross * The privilege level specifies which modes may enter a trap via a software
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross * interrupt. On x86/64, since rings 1 and 2 are unavailable, we allocate
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross * privilege levels as follows:
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross * Level == 0: Noone may enter
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross * Level == 1: Kernel may enter
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross * Level == 2: Kernel may enter
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross * Level == 3: Everyone may enter
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross#define TI_SET_DPL(_ti,_dpl) ((_ti)->flags |= (_dpl))
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross#define TI_SET_IF(_ti,_if) ((_ti)->flags |= ((!!(_if))<<2))
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross uint8_t flags; /* 0-3: privilege level; 4: clear event enable? */
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Rosstypedef uint64_t tsc_timestamp_t; /* RDTSC timestamp */
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross * The following is all CPU context. Note that the fpu_ctxt block is filled
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross * in by FXSAVE if the CPU has feature FXSR; otherwise FSAVE is used.
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross /* FPU registers come first so they can be aligned for FXSAVE/FXRSTOR. */
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross struct { char x[512]; } fpu_ctxt; /* User-level FPU registers */
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross#define VGCF_failsafe_disables_events (1<<_VGCF_failsafe_disables_events)
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross#define VGCF_syscall_disables_events (1<<_VGCF_syscall_disables_events)
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross struct cpu_user_regs user_regs; /* User-level CPU registers */
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross struct trap_info trap_ctxt[256]; /* Virtual IDT */
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross unsigned long ldt_base, ldt_ents; /* LDT (linear address, # ents) */
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross unsigned long gdt_frames[16], gdt_ents; /* GDT (machine frames, # ents) */
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross unsigned long kernel_ss, kernel_sp; /* Virtual TSS (only SS1/SP1) */
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross /* NB. User pagetable on x86/64 is placed in ctrlreg[1]. */
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross unsigned long ctrlreg[8]; /* CR0-CR7 (control registers) */
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross unsigned long debugreg[8]; /* DB0-DB7 (debug registers) */
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross unsigned long event_callback_cs; /* CS:EIP of event callback */
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross unsigned long failsafe_callback_cs; /* CS:EIP of failsafe callback */
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross unsigned int event_callback_cs; /* compat CS of event cb */
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross unsigned int failsafe_callback_cs; /* compat CS of failsafe cb */
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross unsigned long vm_assist; /* VMASST_TYPE_* bitmap */
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross /* Segment base addresses. */
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Rosstypedef struct vcpu_guest_context vcpu_guest_context_t;
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross unsigned long max_pfn; /* max pfn that appears in table */
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross /* Frame containing list of mfns containing list of mfns containing p2m. */
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross unsigned long nmi_reason;
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Rosstypedef struct arch_shared_info arch_shared_info_t;
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross void *pi_ram_start; /* Start of all-RAM mapping region */
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross void *pi_ram_end; /* End of all-RAM mapping region */
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross void *pi_xen_start; /* Start of Xen's text/heap */
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross struct domain *pi_domain; /* Panicking domain */
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross int pi_dom0cpu; /* cpu number - if a dom0 panic */
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross xpv_mca_panic_data_t pi_mca; /* Machine check error telemetry */
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross unsigned long pf_fp;
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross unsigned long pf_pc;
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross#endif /* !__ASSEMBLY__ */
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross * Prefix forces emulation of some non-trapping instructions.
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross * Currently only CPUID.
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross#define XEN_EMULATE_PREFIX .byte 0x0f,0x0b,0x78,0x65,0x6e ;
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross#define XEN_EMULATE_PREFIX ".byte 0x0f,0x0b,0x78,0x65,0x6e ; "
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross#endif /* __XEN_PUBLIC_ARCH_X86_XEN_H__ */
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross * Local variables:
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross * c-set-style: "BSD"
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross * c-basic-offset: 4
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross * tab-width: 4
b3700b074e637f8c6991b70754c88a2cfffb246bGordon Ross * indent-tabs-mode: nil