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 #ifndef __XEN_PUBLIC_ARCH_X86_XEN_H__ 28 #define __XEN_PUBLIC_ARCH_X86_XEN_H__ 29 30 /* Structural guest handles introduced in 0x00030201. */ 31 #if __XEN_INTERFACE_VERSION__ >= 0x00030201 32 #define __DEFINE_XEN_GUEST_HANDLE(name, type) \ 33 typedef struct { type *p; } __guest_handle_ ## name 34 #else 35 #define __DEFINE_XEN_GUEST_HANDLE(name, type) \ 36 typedef type * __guest_handle_ ## name 37 #endif 38 39 #define DEFINE_XEN_GUEST_HANDLE(name) __DEFINE_XEN_GUEST_HANDLE(name, name) 40 #define __XEN_GUEST_HANDLE(name) __guest_handle_ ## name 41 #define XEN_GUEST_HANDLE(name) __XEN_GUEST_HANDLE(name) 42 #if !defined(__GNUC__) && defined(__i386__) 43 #define set_xen_guest_handle_u(hnd, val) do { (hnd).u.p = val; } while (0) 44 #define get_xen_guest_handle_u(val, hnd) do { val = (hnd).u.p; } while (0) 45 #else 46 #define set_xen_guest_handle_u(hnd, val) do { (hnd).p = val; } while (0) 47 #define get_xen_guest_handle_u(val, hnd) do { val = (hnd).p; } while (0) 48 #endif 49 #define set_xen_guest_handle(hnd, val) do { (hnd).p = val; } while (0) 50 #define get_xen_guest_handle(val, hnd) do { val = (hnd).p; } while (0) 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 /* Guest handles for primitive C types. */ 60 __DEFINE_XEN_GUEST_HANDLE(uchar, unsigned char); 61 __DEFINE_XEN_GUEST_HANDLE(uint, unsigned int); 62 __DEFINE_XEN_GUEST_HANDLE(ulong, unsigned long); 63 DEFINE_XEN_GUEST_HANDLE(char); 64 DEFINE_XEN_GUEST_HANDLE(int); 65 DEFINE_XEN_GUEST_HANDLE(long); 66 DEFINE_XEN_GUEST_HANDLE(void); 67 68 typedef unsigned long xen_pfn_t; 69 DEFINE_XEN_GUEST_HANDLE(xen_pfn_t); 70 #define PRI_xen_pfn "lx" 71 #endif 72 73 /* 74 * SEGMENT DESCRIPTOR TABLES 75 */ 76 /* 77 * A number of GDT entries are reserved by Xen. These are not situated at the 78 * start of the GDT because some stupid OSes export hard-coded selector values 79 * in their ABI. These hard-coded values are always near the start of the GDT, 80 * so Xen places itself out of the way, at the far end of the GDT. 81 */ 82 #define FIRST_RESERVED_GDT_PAGE 14 83 #define FIRST_RESERVED_GDT_BYTE (FIRST_RESERVED_GDT_PAGE * 4096) 84 #define FIRST_RESERVED_GDT_ENTRY (FIRST_RESERVED_GDT_BYTE / 8) 85 86 /* Maximum number of virtual CPUs in multi-processor guests. */ 87 #define MAX_VIRT_CPUS 32 88 89 #ifndef __ASSEMBLY__ 90 91 typedef unsigned long xen_ulong_t; 92 93 /* 94 * Send an array of these to HYPERVISOR_set_trap_table(). 95 * The privilege level specifies which modes may enter a trap via a software 96 * interrupt. On x86/64, since rings 1 and 2 are unavailable, we allocate 97 * privilege levels as follows: 98 * Level == 0: Noone may enter 99 * Level == 1: Kernel may enter 100 * Level == 2: Kernel may enter 101 * Level == 3: Everyone may enter 102 */ 103 #define TI_GET_DPL(_ti) ((_ti)->flags & 3) 104 #define TI_GET_IF(_ti) ((_ti)->flags & 4) 105 #define TI_SET_DPL(_ti,_dpl) ((_ti)->flags |= (_dpl)) 106 #define TI_SET_IF(_ti,_if) ((_ti)->flags |= ((!!(_if))<<2)) 107 struct trap_info { 108 uint8_t vector; /* exception vector */ 109 uint8_t flags; /* 0-3: privilege level; 4: clear event enable? */ 110 uint16_t cs; /* code selector */ 111 unsigned long address; /* code offset */ 112 }; 113 typedef struct trap_info trap_info_t; 114 DEFINE_XEN_GUEST_HANDLE(trap_info_t); 115 116 typedef uint64_t tsc_timestamp_t; /* RDTSC timestamp */ 117 118 /* 119 * The following is all CPU context. Note that the fpu_ctxt block is filled 120 * in by FXSAVE if the CPU has feature FXSR; otherwise FSAVE is used. 121 */ 122 struct vcpu_guest_context { 123 /* FPU registers come first so they can be aligned for FXSAVE/FXRSTOR. */ 124 struct { char x[512]; } fpu_ctxt; /* User-level FPU registers */ 125 #define VGCF_I387_VALID (1<<0) 126 #define VGCF_IN_KERNEL (1<<2) 127 #define _VGCF_i387_valid 0 128 #define VGCF_i387_valid (1<<_VGCF_i387_valid) 129 #define _VGCF_in_kernel 2 130 #define VGCF_in_kernel (1<<_VGCF_in_kernel) 131 #define _VGCF_failsafe_disables_events 3 132 #define VGCF_failsafe_disables_events (1<<_VGCF_failsafe_disables_events) 133 #define _VGCF_syscall_disables_events 4 134 #define VGCF_syscall_disables_events (1<<_VGCF_syscall_disables_events) 135 #define _VGCF_online 5 136 #define VGCF_online (1<<_VGCF_online) 137 unsigned long flags; /* VGCF_* flags */ 138 struct cpu_user_regs user_regs; /* User-level CPU registers */ 139 struct trap_info trap_ctxt[256]; /* Virtual IDT */ 140 unsigned long ldt_base, ldt_ents; /* LDT (linear address, # ents) */ 141 unsigned long gdt_frames[16], gdt_ents; /* GDT (machine frames, # ents) */ 142 unsigned long kernel_ss, kernel_sp; /* Virtual TSS (only SS1/SP1) */ 143 /* NB. User pagetable on x86/64 is placed in ctrlreg[1]. */ 144 unsigned long ctrlreg[8]; /* CR0-CR7 (control registers) */ 145 unsigned long debugreg[8]; /* DB0-DB7 (debug registers) */ 146 #ifdef __i386__ 147 unsigned long event_callback_cs; /* CS:EIP of event callback */ 148 unsigned long event_callback_eip; 149 unsigned long failsafe_callback_cs; /* CS:EIP of failsafe callback */ 150 unsigned long failsafe_callback_eip; 151 #else 152 unsigned long event_callback_eip; 153 unsigned long failsafe_callback_eip; 154 #ifdef __XEN__ 155 union { 156 unsigned long syscall_callback_eip; 157 struct { 158 unsigned int event_callback_cs; /* compat CS of event cb */ 159 unsigned int failsafe_callback_cs; /* compat CS of failsafe cb */ 160 }; 161 }; 162 #else 163 unsigned long syscall_callback_eip; 164 #endif 165 #endif 166 unsigned long vm_assist; /* VMASST_TYPE_* bitmap */ 167 #ifdef __x86_64__ 168 /* Segment base addresses. */ 169 uint64_t fs_base; 170 uint64_t gs_base_kernel; 171 uint64_t gs_base_user; 172 #endif 173 }; 174 typedef struct vcpu_guest_context vcpu_guest_context_t; 175 DEFINE_XEN_GUEST_HANDLE(vcpu_guest_context_t); 176 177 struct arch_shared_info { 178 unsigned long max_pfn; /* max pfn that appears in table */ 179 /* Frame containing list of mfns containing list of mfns containing p2m. */ 180 xen_pfn_t pfn_to_mfn_frame_list_list; 181 unsigned long nmi_reason; 182 uint64_t pad[32]; 183 }; 184 typedef struct arch_shared_info arch_shared_info_t; 185 186 typedef struct panic_regs panic_regs_t; 187 struct panic_info { 188 int pi_version; /* panic_info format version */ 189 panic_regs_t *pi_regs; /* register state */ 190 void *pi_apic; /* local APIC address */ 191 char *pi_panicstr; /* panic message */ 192 void *pi_ram_start; /* Start of all-RAM mapping region */ 193 void *pi_ram_end; /* End of all-RAM mapping region */ 194 void *pi_xen_start; /* Start of Xen's text/heap */ 195 void *pi_xen_end; /* End of Xen's text/heap */ 196 void *pi_stktop; /* Top of current Xen stack */ 197 struct domain *pi_domain; /* Panicking domain */ 198 struct vcpu *pi_vcpu; /* Panicking vcpu */ 199 int pi_dom0cpu; /* cpu number - if a dom0 panic */ 200 }; 201 202 struct panic_frame { 203 unsigned long pf_fp; 204 unsigned long pf_pc; 205 }; 206 207 #define PANIC_INFO_VERSION 2 208 209 #endif /* !__ASSEMBLY__ */ 210 211 /* 212 * Prefix forces emulation of some non-trapping instructions. 213 * Currently only CPUID. 214 */ 215 #ifdef __ASSEMBLY__ 216 #define XEN_EMULATE_PREFIX .byte 0x0f,0x0b,0x78,0x65,0x6e ; 217 #define XEN_CPUID XEN_EMULATE_PREFIX cpuid 218 #else 219 #define XEN_EMULATE_PREFIX ".byte 0x0f,0x0b,0x78,0x65,0x6e ; " 220 #define XEN_CPUID XEN_EMULATE_PREFIX "cpuid" 221 #endif 222 223 #endif /* __XEN_PUBLIC_ARCH_X86_XEN_H__ */ 224 225 /* 226 * Local variables: 227 * mode: C 228 * c-set-style: "BSD" 229 * c-basic-offset: 4 230 * tab-width: 4 231 * indent-tabs-mode: nil 232 * End: 233 */ 234