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