1 /****************************************************************************** 2 * arch-x86/xen.h 3 * 4 * Guest OS interface to x86 Xen. 5 * 6 * Permission is hereby granted, free of charge, to any person obtaining a copy 7 * of this software and associated documentation files (the "Software"), to 8 * deal in the Software without restriction, including without limitation the 9 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or 10 * sell copies of the Software, and to permit persons to whom the Software is 11 * furnished to do so, subject to the following conditions: 12 * 13 * The above copyright notice and this permission notice shall be included in 14 * all copies or substantial portions of the Software. 15 * 16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 21 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 22 * DEALINGS IN THE SOFTWARE. 23 * 24 * Copyright (c) 2004-2006, K A Fraser 25 */ 26 27 #include "../xen.h" 28 29 #ifndef __XEN_PUBLIC_ARCH_X86_XEN_H__ 30 #define __XEN_PUBLIC_ARCH_X86_XEN_H__ 31 32 /* Structural guest handles introduced in 0x00030201. */ 33 #if __XEN_INTERFACE_VERSION__ >= 0x00030201 34 #define ___DEFINE_XEN_GUEST_HANDLE(name, type) \ 35 typedef struct { type *p; } __guest_handle_ ## name 36 #else 37 #define ___DEFINE_XEN_GUEST_HANDLE(name, type) \ 38 typedef type * __guest_handle_ ## name 39 #endif 40 41 #define __DEFINE_XEN_GUEST_HANDLE(name, type) \ 42 ___DEFINE_XEN_GUEST_HANDLE(name, type); \ 43 ___DEFINE_XEN_GUEST_HANDLE(const_##name, const type) 44 #define DEFINE_XEN_GUEST_HANDLE(name) __DEFINE_XEN_GUEST_HANDLE(name, name) 45 #define __XEN_GUEST_HANDLE(name) __guest_handle_ ## name 46 #define XEN_GUEST_HANDLE(name) __XEN_GUEST_HANDLE(name) 47 #define set_xen_guest_handle(hnd, val) do { (hnd).p = val; } while (0) 48 #ifdef __XEN_TOOLS__ 49 #define get_xen_guest_handle(val, hnd) do { val = (hnd).p; } while (0) 50 #endif 51 52 #if defined(__i386__) 53 #include "xen-x86_32.h" 54 #elif defined(__x86_64__) 55 #include "xen-x86_64.h" 56 #endif 57 58 #ifndef __ASSEMBLY__ 59 typedef unsigned long xen_pfn_t; 60 #define PRI_xen_pfn "lx" 61 #endif 62 63 /* 64 * SEGMENT DESCRIPTOR TABLES 65 */ 66 /* 67 * A number of GDT entries are reserved by Xen. These are not situated at the 68 * start of the GDT because some stupid OSes export hard-coded selector values 69 * in their ABI. These hard-coded values are always near the start of the GDT, 70 * so Xen places itself out of the way, at the far end of the GDT. 71 */ 72 #define FIRST_RESERVED_GDT_PAGE 14 73 #define FIRST_RESERVED_GDT_BYTE (FIRST_RESERVED_GDT_PAGE * 4096) 74 #define FIRST_RESERVED_GDT_ENTRY (FIRST_RESERVED_GDT_BYTE / 8) 75 76 /* Maximum number of virtual CPUs in multi-processor guests. */ 77 #define MAX_VIRT_CPUS 32 78 79 #ifndef __ASSEMBLY__ 80 81 typedef unsigned long xen_ulong_t; 82 83 /* 84 * Send an array of these to HYPERVISOR_set_trap_table(). 85 * The privilege level specifies which modes may enter a trap via a software 86 * interrupt. On x86/64, since rings 1 and 2 are unavailable, we allocate 87 * privilege levels as follows: 88 * Level == 0: Noone may enter 89 * Level == 1: Kernel may enter 90 * Level == 2: Kernel may enter 91 * Level == 3: Everyone may enter 92 */ 93 #define TI_GET_DPL(_ti) ((_ti)->flags & 3) 94 #define TI_GET_IF(_ti) ((_ti)->flags & 4) 95 #define TI_SET_DPL(_ti,_dpl) ((_ti)->flags |= (_dpl)) 96 #define TI_SET_IF(_ti,_if) ((_ti)->flags |= ((!!(_if))<<2)) 97 struct trap_info { 98 uint8_t vector; /* exception vector */ 99 uint8_t flags; /* 0-3: privilege level; 4: clear event enable? */ 100 uint16_t cs; /* code selector */ 101 unsigned long address; /* code offset */ 102 }; 103 typedef struct trap_info trap_info_t; 104 DEFINE_XEN_GUEST_HANDLE(trap_info_t); 105 106 typedef uint64_t tsc_timestamp_t; /* RDTSC timestamp */ 107 108 /* 109 * The following is all CPU context. Note that the fpu_ctxt block is filled 110 * in by FXSAVE if the CPU has feature FXSR; otherwise FSAVE is used. 111 */ 112 struct vcpu_guest_context { 113 /* FPU registers come first so they can be aligned for FXSAVE/FXRSTOR. */ 114 struct { char x[512]; } fpu_ctxt; /* User-level FPU registers */ 115 #define VGCF_I387_VALID (1<<0) 116 #define VGCF_IN_KERNEL (1<<2) 117 #define _VGCF_i387_valid 0 118 #define VGCF_i387_valid (1<<_VGCF_i387_valid) 119 #define _VGCF_in_kernel 2 120 #define VGCF_in_kernel (1<<_VGCF_in_kernel) 121 #define _VGCF_failsafe_disables_events 3 122 #define VGCF_failsafe_disables_events (1<<_VGCF_failsafe_disables_events) 123 #define _VGCF_syscall_disables_events 4 124 #define VGCF_syscall_disables_events (1<<_VGCF_syscall_disables_events) 125 #define _VGCF_online 5 126 #define VGCF_online (1<<_VGCF_online) 127 unsigned long flags; /* VGCF_* flags */ 128 struct cpu_user_regs user_regs; /* User-level CPU registers */ 129 struct trap_info trap_ctxt[256]; /* Virtual IDT */ 130 unsigned long ldt_base, ldt_ents; /* LDT (linear address, # ents) */ 131 unsigned long gdt_frames[16], gdt_ents; /* GDT (machine frames, # ents) */ 132 unsigned long kernel_ss, kernel_sp; /* Virtual TSS (only SS1/SP1) */ 133 /* NB. User pagetable on x86/64 is placed in ctrlreg[1]. */ 134 unsigned long ctrlreg[8]; /* CR0-CR7 (control registers) */ 135 unsigned long debugreg[8]; /* DB0-DB7 (debug registers) */ 136 #ifdef __i386__ 137 unsigned long event_callback_cs; /* CS:EIP of event callback */ 138 unsigned long event_callback_eip; 139 unsigned long failsafe_callback_cs; /* CS:EIP of failsafe callback */ 140 unsigned long failsafe_callback_eip; 141 #else 142 unsigned long event_callback_eip; 143 unsigned long failsafe_callback_eip; 144 #ifdef __XEN__ 145 union { 146 unsigned long syscall_callback_eip; 147 struct { 148 unsigned int event_callback_cs; /* compat CS of event cb */ 149 unsigned int failsafe_callback_cs; /* compat CS of failsafe cb */ 150 }; 151 }; 152 #else 153 unsigned long syscall_callback_eip; 154 #endif 155 #endif 156 unsigned long vm_assist; /* VMASST_TYPE_* bitmap */ 157 #ifdef __x86_64__ 158 /* Segment base addresses. */ 159 uint64_t fs_base; 160 uint64_t gs_base_kernel; 161 uint64_t gs_base_user; 162 #endif 163 }; 164 typedef struct vcpu_guest_context vcpu_guest_context_t; 165 DEFINE_XEN_GUEST_HANDLE(vcpu_guest_context_t); 166 167 struct arch_shared_info { 168 unsigned long max_pfn; /* max pfn that appears in table */ 169 /* Frame containing list of mfns containing list of mfns containing p2m. */ 170 xen_pfn_t pfn_to_mfn_frame_list_list; 171 unsigned long nmi_reason; 172 uint64_t pad[32]; 173 }; 174 typedef struct arch_shared_info arch_shared_info_t; 175 176 #define MCA_PANICDATA_MAGIC 0x5044 /* "PD" */ 177 #define MCA_PANICDATA_VERS 1 178 179 typedef struct xpv_mca_panic_data { 180 uint16_t mpd_magic; 181 uint16_t mpd_version; 182 int mpd_fwdptr_offset; 183 int mpd_revptr_offset; 184 int mpd_dataptr_offset; 185 void *mpd_urgent_processing; 186 void *mpd_urgent_dangling; 187 void *mpd_urgent_committed; 188 void *mpd_nonurgent_processing; 189 void *mpd_nonurgent_dangling; 190 void *mpd_nonurgent_committed; 191 } xpv_mca_panic_data_t; 192 193 typedef struct panic_regs panic_regs_t; 194 struct panic_info { 195 int pi_version; /* panic_info format version */ 196 panic_regs_t *pi_regs; /* register state */ 197 void *pi_apic; /* local APIC address */ 198 char *pi_panicstr; /* panic message */ 199 void *pi_ram_start; /* Start of all-RAM mapping region */ 200 void *pi_ram_end; /* End of all-RAM mapping region */ 201 void *pi_xen_start; /* Start of Xen's text/heap */ 202 void *pi_xen_end; /* End of Xen's text/heap */ 203 void *pi_stktop; /* Top of current Xen stack */ 204 struct domain *pi_domain; /* Panicking domain */ 205 struct vcpu *pi_vcpu; /* Panicking vcpu */ 206 int pi_dom0cpu; /* cpu number - if a dom0 panic */ 207 xpv_mca_panic_data_t pi_mca; /* Machine check error telemetry */ 208 }; 209 210 struct panic_frame { 211 unsigned long pf_fp; 212 unsigned long pf_pc; 213 }; 214 215 #define PANIC_INFO_VERSION 3 216 217 #endif /* !__ASSEMBLY__ */ 218 219 /* 220 * Prefix forces emulation of some non-trapping instructions. 221 * Currently only CPUID. 222 */ 223 #ifdef __ASSEMBLY__ 224 #define XEN_EMULATE_PREFIX .byte 0x0f,0x0b,0x78,0x65,0x6e ; 225 #define XEN_CPUID XEN_EMULATE_PREFIX cpuid 226 #else 227 #define XEN_EMULATE_PREFIX ".byte 0x0f,0x0b,0x78,0x65,0x6e ; " 228 #define XEN_CPUID XEN_EMULATE_PREFIX "cpuid" 229 #endif 230 231 #endif /* __XEN_PUBLIC_ARCH_X86_XEN_H__ */ 232 233 /* 234 * Local variables: 235 * mode: C 236 * c-set-style: "BSD" 237 * c-basic-offset: 4 238 * tab-width: 4 239 * indent-tabs-mode: nil 240 * End: 241 */ 242