xen-x86_64.h revision 181624
1/****************************************************************************** 2 * xen-x86_64.h 3 * 4 * Guest OS interface to x86 64-bit 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_X86_64_H__ 28#define __XEN_PUBLIC_ARCH_X86_XEN_X86_64_H__ 29 30/* 31 * Hypercall interface: 32 * Input: %rdi, %rsi, %rdx, %r10, %r8 (arguments 1-5) 33 * Output: %rax 34 * Access is via hypercall page (set up by guest loader or via a Xen MSR): 35 * call hypercall_page + hypercall-number * 32 36 * Clobbered: argument registers (e.g., 2-arg hypercall clobbers %rdi,%rsi) 37 */ 38 39#if __XEN_INTERFACE_VERSION__ < 0x00030203 40/* 41 * Legacy hypercall interface: 42 * As above, except the entry sequence to the hypervisor is: 43 * mov $hypercall-number*32,%eax ; syscall 44 * Clobbered: %rcx, %r11, argument registers (as above) 45 */ 46#define TRAP_INSTR "syscall" 47#endif 48 49/* 50 * 64-bit segment selectors 51 * These flat segments are in the Xen-private section of every GDT. Since these 52 * are also present in the initial GDT, many OSes will be able to avoid 53 * installing their own GDT. 54 */ 55 56#define FLAT_RING3_CS32 0xe023 /* GDT index 260 */ 57#define FLAT_RING3_CS64 0xe033 /* GDT index 261 */ 58#define FLAT_RING3_DS32 0xe02b /* GDT index 262 */ 59#define FLAT_RING3_DS64 0x0000 /* NULL selector */ 60#define FLAT_RING3_SS32 0xe02b /* GDT index 262 */ 61#define FLAT_RING3_SS64 0xe02b /* GDT index 262 */ 62 63#define FLAT_KERNEL_DS64 FLAT_RING3_DS64 64#define FLAT_KERNEL_DS32 FLAT_RING3_DS32 65#define FLAT_KERNEL_DS FLAT_KERNEL_DS64 66#define FLAT_KERNEL_CS64 FLAT_RING3_CS64 67#define FLAT_KERNEL_CS32 FLAT_RING3_CS32 68#define FLAT_KERNEL_CS FLAT_KERNEL_CS64 69#define FLAT_KERNEL_SS64 FLAT_RING3_SS64 70#define FLAT_KERNEL_SS32 FLAT_RING3_SS32 71#define FLAT_KERNEL_SS FLAT_KERNEL_SS64 72 73#define FLAT_USER_DS64 FLAT_RING3_DS64 74#define FLAT_USER_DS32 FLAT_RING3_DS32 75#define FLAT_USER_DS FLAT_USER_DS64 76#define FLAT_USER_CS64 FLAT_RING3_CS64 77#define FLAT_USER_CS32 FLAT_RING3_CS32 78#define FLAT_USER_CS FLAT_USER_CS64 79#define FLAT_USER_SS64 FLAT_RING3_SS64 80#define FLAT_USER_SS32 FLAT_RING3_SS32 81#define FLAT_USER_SS FLAT_USER_SS64 82 83#define __HYPERVISOR_VIRT_START 0xFFFF800000000000 84#define __HYPERVISOR_VIRT_END 0xFFFF880000000000 85#define __MACH2PHYS_VIRT_START 0xFFFF800000000000 86#define __MACH2PHYS_VIRT_END 0xFFFF804000000000 87 88#ifndef HYPERVISOR_VIRT_START 89#define HYPERVISOR_VIRT_START mk_unsigned_long(__HYPERVISOR_VIRT_START) 90#define HYPERVISOR_VIRT_END mk_unsigned_long(__HYPERVISOR_VIRT_END) 91#endif 92 93#define MACH2PHYS_VIRT_START mk_unsigned_long(__MACH2PHYS_VIRT_START) 94#define MACH2PHYS_VIRT_END mk_unsigned_long(__MACH2PHYS_VIRT_END) 95#define MACH2PHYS_NR_ENTRIES ((MACH2PHYS_VIRT_END-MACH2PHYS_VIRT_START)>>3) 96#ifndef machine_to_phys_mapping 97#define machine_to_phys_mapping ((unsigned long *)HYPERVISOR_VIRT_START) 98#endif 99 100#ifndef __ASSEMBLY__ 101 102/* 103 * int HYPERVISOR_set_segment_base(unsigned int which, unsigned long base) 104 * @which == SEGBASE_* ; @base == 64-bit base address 105 * Returns 0 on success. 106 */ 107#define SEGBASE_FS 0 108#define SEGBASE_GS_USER 1 109#define SEGBASE_GS_KERNEL 2 110#define SEGBASE_GS_USER_SEL 3 /* Set user %gs specified in base[15:0] */ 111 112/* 113 * int HYPERVISOR_iret(void) 114 * All arguments are on the kernel stack, in the following format. 115 * Never returns if successful. Current kernel context is lost. 116 * The saved CS is mapped as follows: 117 * RING0 -> RING3 kernel mode. 118 * RING1 -> RING3 kernel mode. 119 * RING2 -> RING3 kernel mode. 120 * RING3 -> RING3 user mode. 121 * However RING0 indicates that the guest kernel should return to iteself 122 * directly with 123 * orb $3,1*8(%rsp) 124 * iretq 125 * If flags contains VGCF_in_syscall: 126 * Restore RAX, RIP, RFLAGS, RSP. 127 * Discard R11, RCX, CS, SS. 128 * Otherwise: 129 * Restore RAX, R11, RCX, CS:RIP, RFLAGS, SS:RSP. 130 * All other registers are saved on hypercall entry and restored to user. 131 */ 132/* Guest exited in SYSCALL context? Return to guest with SYSRET? */ 133#define _VGCF_in_syscall 8 134#define VGCF_in_syscall (1<<_VGCF_in_syscall) 135#define VGCF_IN_SYSCALL VGCF_in_syscall 136struct iret_context { 137 /* Top of stack (%rsp at point of hypercall). */ 138 uint64_t rax, r11, rcx, flags, rip, cs, rflags, rsp, ss; 139 /* Bottom of iret stack frame. */ 140}; 141 142#ifdef __GNUC__ 143/* Anonymous union includes both 32- and 64-bit names (e.g., eax/rax). */ 144#define __DECL_REG(name) union { \ 145 uint64_t r ## name, e ## name; \ 146 uint32_t _e ## name; \ 147} 148#else 149/* Non-gcc sources must always use the proper 64-bit name (e.g., rax). */ 150#define __DECL_REG(name) uint64_t r ## name 151#endif 152 153struct cpu_user_regs { 154 uint64_t r15; 155 uint64_t r14; 156 uint64_t r13; 157 uint64_t r12; 158 __DECL_REG(bp); 159 __DECL_REG(bx); 160 uint64_t r11; 161 uint64_t r10; 162 uint64_t r9; 163 uint64_t r8; 164 __DECL_REG(ax); 165 __DECL_REG(cx); 166 __DECL_REG(dx); 167 __DECL_REG(si); 168 __DECL_REG(di); 169 uint32_t error_code; /* private */ 170 uint32_t entry_vector; /* private */ 171 __DECL_REG(ip); 172 uint16_t cs, _pad0[1]; 173 uint8_t saved_upcall_mask; 174 uint8_t _pad1[3]; 175 __DECL_REG(flags); /* rflags.IF == !saved_upcall_mask */ 176 __DECL_REG(sp); 177 uint16_t ss, _pad2[3]; 178 uint16_t es, _pad3[3]; 179 uint16_t ds, _pad4[3]; 180 uint16_t fs, _pad5[3]; /* Non-zero => takes precedence over fs_base. */ 181 uint16_t gs, _pad6[3]; /* Non-zero => takes precedence over gs_base_usr. */ 182}; 183typedef struct cpu_user_regs cpu_user_regs_t; 184DEFINE_XEN_GUEST_HANDLE(cpu_user_regs_t); 185 186#undef __DECL_REG 187 188#define xen_pfn_to_cr3(pfn) ((unsigned long)(pfn) << 12) 189#define xen_cr3_to_pfn(cr3) ((unsigned long)(cr3) >> 12) 190 191struct arch_vcpu_info { 192 unsigned long cr2; 193 unsigned long pad; /* sizeof(vcpu_info_t) == 64 */ 194}; 195typedef struct arch_vcpu_info arch_vcpu_info_t; 196 197typedef unsigned long xen_callback_t; 198 199#endif /* !__ASSEMBLY__ */ 200 201#endif /* __XEN_PUBLIC_ARCH_X86_XEN_X86_64_H__ */ 202 203/* 204 * Local variables: 205 * mode: C 206 * c-set-style: "BSD" 207 * c-basic-offset: 4 208 * tab-width: 4 209 * indent-tabs-mode: nil 210 * End: 211 */ 212