13a9fd824SRoger Pau Monné /****************************************************************************** 23a9fd824SRoger Pau Monné * xen-x86_64.h 33a9fd824SRoger Pau Monné * 43a9fd824SRoger Pau Monné * Guest OS interface to x86 64-bit Xen. 53a9fd824SRoger Pau Monné * 63a9fd824SRoger Pau Monné * Permission is hereby granted, free of charge, to any person obtaining a copy 73a9fd824SRoger Pau Monné * of this software and associated documentation files (the "Software"), to 83a9fd824SRoger Pau Monné * deal in the Software without restriction, including without limitation the 93a9fd824SRoger Pau Monné * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or 103a9fd824SRoger Pau Monné * sell copies of the Software, and to permit persons to whom the Software is 113a9fd824SRoger Pau Monné * furnished to do so, subject to the following conditions: 123a9fd824SRoger Pau Monné * 133a9fd824SRoger Pau Monné * The above copyright notice and this permission notice shall be included in 143a9fd824SRoger Pau Monné * all copies or substantial portions of the Software. 153a9fd824SRoger Pau Monné * 163a9fd824SRoger Pau Monné * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 173a9fd824SRoger Pau Monné * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 183a9fd824SRoger Pau Monné * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 193a9fd824SRoger Pau Monné * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 203a9fd824SRoger Pau Monné * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 213a9fd824SRoger Pau Monné * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 223a9fd824SRoger Pau Monné * DEALINGS IN THE SOFTWARE. 233a9fd824SRoger Pau Monné * 243a9fd824SRoger Pau Monné * Copyright (c) 2004-2006, K A Fraser 253a9fd824SRoger Pau Monné */ 263a9fd824SRoger Pau Monné 273a9fd824SRoger Pau Monné #ifndef __XEN_PUBLIC_ARCH_X86_XEN_X86_64_H__ 283a9fd824SRoger Pau Monné #define __XEN_PUBLIC_ARCH_X86_XEN_X86_64_H__ 293a9fd824SRoger Pau Monné 303a9fd824SRoger Pau Monné /* 313a9fd824SRoger Pau Monné * Hypercall interface: 323a9fd824SRoger Pau Monné * Input: %rdi, %rsi, %rdx, %r10, %r8, %r9 (arguments 1-6) 333a9fd824SRoger Pau Monné * Output: %rax 343a9fd824SRoger Pau Monné * Access is via hypercall page (set up by guest loader or via a Xen MSR): 353a9fd824SRoger Pau Monné * call hypercall_page + hypercall-number * 32 363a9fd824SRoger Pau Monné * Clobbered: argument registers (e.g., 2-arg hypercall clobbers %rdi,%rsi) 373a9fd824SRoger Pau Monné */ 383a9fd824SRoger Pau Monné 393a9fd824SRoger Pau Monné /* 403a9fd824SRoger Pau Monné * 64-bit segment selectors 413a9fd824SRoger Pau Monné * These flat segments are in the Xen-private section of every GDT. Since these 423a9fd824SRoger Pau Monné * are also present in the initial GDT, many OSes will be able to avoid 433a9fd824SRoger Pau Monné * installing their own GDT. 443a9fd824SRoger Pau Monné */ 453a9fd824SRoger Pau Monné 463a9fd824SRoger Pau Monné #define FLAT_RING3_CS32 0xe023 /* GDT index 260 */ 473a9fd824SRoger Pau Monné #define FLAT_RING3_CS64 0xe033 /* GDT index 262 */ 483a9fd824SRoger Pau Monné #define FLAT_RING3_DS32 0xe02b /* GDT index 261 */ 493a9fd824SRoger Pau Monné #define FLAT_RING3_DS64 0x0000 /* NULL selector */ 503a9fd824SRoger Pau Monné #define FLAT_RING3_SS32 0xe02b /* GDT index 261 */ 513a9fd824SRoger Pau Monné #define FLAT_RING3_SS64 0xe02b /* GDT index 261 */ 523a9fd824SRoger Pau Monné 533a9fd824SRoger Pau Monné #define FLAT_KERNEL_DS64 FLAT_RING3_DS64 543a9fd824SRoger Pau Monné #define FLAT_KERNEL_DS32 FLAT_RING3_DS32 553a9fd824SRoger Pau Monné #define FLAT_KERNEL_DS FLAT_KERNEL_DS64 563a9fd824SRoger Pau Monné #define FLAT_KERNEL_CS64 FLAT_RING3_CS64 573a9fd824SRoger Pau Monné #define FLAT_KERNEL_CS32 FLAT_RING3_CS32 583a9fd824SRoger Pau Monné #define FLAT_KERNEL_CS FLAT_KERNEL_CS64 593a9fd824SRoger Pau Monné #define FLAT_KERNEL_SS64 FLAT_RING3_SS64 603a9fd824SRoger Pau Monné #define FLAT_KERNEL_SS32 FLAT_RING3_SS32 613a9fd824SRoger Pau Monné #define FLAT_KERNEL_SS FLAT_KERNEL_SS64 623a9fd824SRoger Pau Monné 633a9fd824SRoger Pau Monné #define FLAT_USER_DS64 FLAT_RING3_DS64 643a9fd824SRoger Pau Monné #define FLAT_USER_DS32 FLAT_RING3_DS32 653a9fd824SRoger Pau Monné #define FLAT_USER_DS FLAT_USER_DS64 663a9fd824SRoger Pau Monné #define FLAT_USER_CS64 FLAT_RING3_CS64 673a9fd824SRoger Pau Monné #define FLAT_USER_CS32 FLAT_RING3_CS32 683a9fd824SRoger Pau Monné #define FLAT_USER_CS FLAT_USER_CS64 693a9fd824SRoger Pau Monné #define FLAT_USER_SS64 FLAT_RING3_SS64 703a9fd824SRoger Pau Monné #define FLAT_USER_SS32 FLAT_RING3_SS32 713a9fd824SRoger Pau Monné #define FLAT_USER_SS FLAT_USER_SS64 723a9fd824SRoger Pau Monné 733a9fd824SRoger Pau Monné #define __HYPERVISOR_VIRT_START 0xFFFF800000000000 743a9fd824SRoger Pau Monné #define __HYPERVISOR_VIRT_END 0xFFFF880000000000 753a9fd824SRoger Pau Monné #define __MACH2PHYS_VIRT_START 0xFFFF800000000000 763a9fd824SRoger Pau Monné #define __MACH2PHYS_VIRT_END 0xFFFF804000000000 773a9fd824SRoger Pau Monné 783a9fd824SRoger Pau Monné #ifndef HYPERVISOR_VIRT_START 793a9fd824SRoger Pau Monné #define HYPERVISOR_VIRT_START xen_mk_ulong(__HYPERVISOR_VIRT_START) 803a9fd824SRoger Pau Monné #define HYPERVISOR_VIRT_END xen_mk_ulong(__HYPERVISOR_VIRT_END) 813a9fd824SRoger Pau Monné #endif 823a9fd824SRoger Pau Monné 833a9fd824SRoger Pau Monné #define MACH2PHYS_VIRT_START xen_mk_ulong(__MACH2PHYS_VIRT_START) 843a9fd824SRoger Pau Monné #define MACH2PHYS_VIRT_END xen_mk_ulong(__MACH2PHYS_VIRT_END) 853a9fd824SRoger Pau Monné #define MACH2PHYS_NR_ENTRIES ((MACH2PHYS_VIRT_END-MACH2PHYS_VIRT_START)>>3) 863a9fd824SRoger Pau Monné #ifndef machine_to_phys_mapping 873a9fd824SRoger Pau Monné #define machine_to_phys_mapping ((unsigned long *)HYPERVISOR_VIRT_START) 883a9fd824SRoger Pau Monné #endif 893a9fd824SRoger Pau Monné 903a9fd824SRoger Pau Monné /* 913a9fd824SRoger Pau Monné * int HYPERVISOR_set_segment_base(unsigned int which, unsigned long base) 923a9fd824SRoger Pau Monné * @which == SEGBASE_* ; @base == 64-bit base address 933a9fd824SRoger Pau Monné * Returns 0 on success. 943a9fd824SRoger Pau Monné */ 953a9fd824SRoger Pau Monné #define SEGBASE_FS 0 963a9fd824SRoger Pau Monné #define SEGBASE_GS_USER 1 973a9fd824SRoger Pau Monné #define SEGBASE_GS_KERNEL 2 983a9fd824SRoger Pau Monné #define SEGBASE_GS_USER_SEL 3 /* Set user %gs specified in base[15:0] */ 993a9fd824SRoger Pau Monné 1003a9fd824SRoger Pau Monné /* 1013a9fd824SRoger Pau Monné * int HYPERVISOR_iret(void) 1023a9fd824SRoger Pau Monné * All arguments are on the kernel stack, in the following format. 1033a9fd824SRoger Pau Monné * Never returns if successful. Current kernel context is lost. 1043a9fd824SRoger Pau Monné * The saved CS is mapped as follows: 1053a9fd824SRoger Pau Monné * RING0 -> RING3 kernel mode. 1063a9fd824SRoger Pau Monné * RING1 -> RING3 kernel mode. 1073a9fd824SRoger Pau Monné * RING2 -> RING3 kernel mode. 1083a9fd824SRoger Pau Monné * RING3 -> RING3 user mode. 1093a9fd824SRoger Pau Monné * However RING0 indicates that the guest kernel should return to iteself 1103a9fd824SRoger Pau Monné * directly with 1113a9fd824SRoger Pau Monné * orb $3,1*8(%rsp) 1123a9fd824SRoger Pau Monné * iretq 1133a9fd824SRoger Pau Monné * If flags contains VGCF_in_syscall: 1143a9fd824SRoger Pau Monné * Restore RAX, RIP, RFLAGS, RSP. 1153a9fd824SRoger Pau Monné * Discard R11, RCX, CS, SS. 1163a9fd824SRoger Pau Monné * Otherwise: 1173a9fd824SRoger Pau Monné * Restore RAX, R11, RCX, CS:RIP, RFLAGS, SS:RSP. 1183a9fd824SRoger Pau Monné * All other registers are saved on hypercall entry and restored to user. 1193a9fd824SRoger Pau Monné */ 1203a9fd824SRoger Pau Monné /* Guest exited in SYSCALL context? Return to guest with SYSRET? */ 1213a9fd824SRoger Pau Monné #define _VGCF_in_syscall 8 1223a9fd824SRoger Pau Monné #define VGCF_in_syscall (1<<_VGCF_in_syscall) 1233a9fd824SRoger Pau Monné #define VGCF_IN_SYSCALL VGCF_in_syscall 1243a9fd824SRoger Pau Monné 1253a9fd824SRoger Pau Monné #ifndef __ASSEMBLY__ 1263a9fd824SRoger Pau Monné 1273a9fd824SRoger Pau Monné struct iret_context { 1283a9fd824SRoger Pau Monné /* Top of stack (%rsp at point of hypercall). */ 1293a9fd824SRoger Pau Monné uint64_t rax, r11, rcx, flags, rip, cs, rflags, rsp, ss; 1303a9fd824SRoger Pau Monné /* Bottom of iret stack frame. */ 1313a9fd824SRoger Pau Monné }; 1323a9fd824SRoger Pau Monné 1333a9fd824SRoger Pau Monné #if defined(__XEN__) || defined(__XEN_TOOLS__) 1343a9fd824SRoger Pau Monné /* Anonymous unions include all permissible names (e.g., al/ah/ax/eax/rax). */ 1353a9fd824SRoger Pau Monné #define __DECL_REG_LOHI(which) union { \ 1363a9fd824SRoger Pau Monné uint64_t r ## which ## x; \ 1373a9fd824SRoger Pau Monné uint32_t e ## which ## x; \ 1383a9fd824SRoger Pau Monné uint16_t which ## x; \ 1393a9fd824SRoger Pau Monné struct { \ 1403a9fd824SRoger Pau Monné uint8_t which ## l; \ 1413a9fd824SRoger Pau Monné uint8_t which ## h; \ 1423a9fd824SRoger Pau Monné }; \ 1433a9fd824SRoger Pau Monné } 1443a9fd824SRoger Pau Monné #define __DECL_REG_LO8(name) union { \ 1453a9fd824SRoger Pau Monné uint64_t r ## name; \ 1463a9fd824SRoger Pau Monné uint32_t e ## name; \ 1473a9fd824SRoger Pau Monné uint16_t name; \ 1483a9fd824SRoger Pau Monné uint8_t name ## l; \ 1493a9fd824SRoger Pau Monné } 1503a9fd824SRoger Pau Monné #define __DECL_REG_LO16(name) union { \ 1513a9fd824SRoger Pau Monné uint64_t r ## name; \ 1523a9fd824SRoger Pau Monné uint32_t e ## name; \ 1533a9fd824SRoger Pau Monné uint16_t name; \ 1543a9fd824SRoger Pau Monné } 1553a9fd824SRoger Pau Monné #define __DECL_REG_HI(num) union { \ 1563a9fd824SRoger Pau Monné uint64_t r ## num; \ 1573a9fd824SRoger Pau Monné uint32_t r ## num ## d; \ 1583a9fd824SRoger Pau Monné uint16_t r ## num ## w; \ 1593a9fd824SRoger Pau Monné uint8_t r ## num ## b; \ 1603a9fd824SRoger Pau Monné } 1613a9fd824SRoger Pau Monné #elif defined(__GNUC__) && !defined(__STRICT_ANSI__) 1623a9fd824SRoger Pau Monné /* Anonymous union includes both 32- and 64-bit names (e.g., eax/rax). */ 1633a9fd824SRoger Pau Monné #define __DECL_REG(name) union { \ 1643a9fd824SRoger Pau Monné uint64_t r ## name, e ## name; \ 1653a9fd824SRoger Pau Monné uint32_t _e ## name; \ 1663a9fd824SRoger Pau Monné } 1673a9fd824SRoger Pau Monné #else 1683a9fd824SRoger Pau Monné /* Non-gcc sources must always use the proper 64-bit name (e.g., rax). */ 1693a9fd824SRoger Pau Monné #define __DECL_REG(name) uint64_t r ## name 1703a9fd824SRoger Pau Monné #endif 1713a9fd824SRoger Pau Monné 1723a9fd824SRoger Pau Monné #ifndef __DECL_REG_LOHI 1733a9fd824SRoger Pau Monné #define __DECL_REG_LOHI(name) __DECL_REG(name ## x) 1743a9fd824SRoger Pau Monné #define __DECL_REG_LO8 __DECL_REG 1753a9fd824SRoger Pau Monné #define __DECL_REG_LO16 __DECL_REG 1763a9fd824SRoger Pau Monné #define __DECL_REG_HI(num) uint64_t r ## num 1773a9fd824SRoger Pau Monné #endif 1783a9fd824SRoger Pau Monné 1793a9fd824SRoger Pau Monné struct cpu_user_regs { 1803a9fd824SRoger Pau Monné __DECL_REG_HI(15); 1813a9fd824SRoger Pau Monné __DECL_REG_HI(14); 1823a9fd824SRoger Pau Monné __DECL_REG_HI(13); 1833a9fd824SRoger Pau Monné __DECL_REG_HI(12); 1843a9fd824SRoger Pau Monné __DECL_REG_LO8(bp); 1853a9fd824SRoger Pau Monné __DECL_REG_LOHI(b); 1863a9fd824SRoger Pau Monné __DECL_REG_HI(11); 1873a9fd824SRoger Pau Monné __DECL_REG_HI(10); 1883a9fd824SRoger Pau Monné __DECL_REG_HI(9); 1893a9fd824SRoger Pau Monné __DECL_REG_HI(8); 1903a9fd824SRoger Pau Monné __DECL_REG_LOHI(a); 1913a9fd824SRoger Pau Monné __DECL_REG_LOHI(c); 1923a9fd824SRoger Pau Monné __DECL_REG_LOHI(d); 1933a9fd824SRoger Pau Monné __DECL_REG_LO8(si); 1943a9fd824SRoger Pau Monné __DECL_REG_LO8(di); 1953a9fd824SRoger Pau Monné uint32_t error_code; /* private */ 1963a9fd824SRoger Pau Monné uint32_t entry_vector; /* private */ 1973a9fd824SRoger Pau Monné __DECL_REG_LO16(ip); 1983a9fd824SRoger Pau Monné uint16_t cs, _pad0[1]; 1993a9fd824SRoger Pau Monné uint8_t saved_upcall_mask; 2003a9fd824SRoger Pau Monné uint8_t _pad1[3]; 2013a9fd824SRoger Pau Monné __DECL_REG_LO16(flags); /* rflags.IF == !saved_upcall_mask */ 2023a9fd824SRoger Pau Monné __DECL_REG_LO8(sp); 2033a9fd824SRoger Pau Monné uint16_t ss, _pad2[3]; 2043a9fd824SRoger Pau Monné uint16_t es, _pad3[3]; 2053a9fd824SRoger Pau Monné uint16_t ds, _pad4[3]; 2063a9fd824SRoger Pau Monné uint16_t fs, _pad5[3]; 2073a9fd824SRoger Pau Monné uint16_t gs, _pad6[3]; 2083a9fd824SRoger Pau Monné }; 2093a9fd824SRoger Pau Monné typedef struct cpu_user_regs cpu_user_regs_t; 2103a9fd824SRoger Pau Monné DEFINE_XEN_GUEST_HANDLE(cpu_user_regs_t); 2113a9fd824SRoger Pau Monné 2123a9fd824SRoger Pau Monné #undef __DECL_REG 2133a9fd824SRoger Pau Monné #undef __DECL_REG_LOHI 2143a9fd824SRoger Pau Monné #undef __DECL_REG_LO8 2153a9fd824SRoger Pau Monné #undef __DECL_REG_LO16 2163a9fd824SRoger Pau Monné #undef __DECL_REG_HI 2173a9fd824SRoger Pau Monné 2183a9fd824SRoger Pau Monné #define xen_pfn_to_cr3(pfn) ((unsigned long)(pfn) << 12) 2193a9fd824SRoger Pau Monné #define xen_cr3_to_pfn(cr3) ((unsigned long)(cr3) >> 12) 2203a9fd824SRoger Pau Monné 2213a9fd824SRoger Pau Monné struct arch_vcpu_info { 2223a9fd824SRoger Pau Monné unsigned long cr2; 2233a9fd824SRoger Pau Monné unsigned long pad; /* sizeof(vcpu_info_t) == 64 */ 2243a9fd824SRoger Pau Monné }; 2253a9fd824SRoger Pau Monné typedef struct arch_vcpu_info arch_vcpu_info_t; 2263a9fd824SRoger Pau Monné 2273a9fd824SRoger Pau Monné typedef unsigned long xen_callback_t; 2283a9fd824SRoger Pau Monné 2293a9fd824SRoger Pau Monné #endif /* !__ASSEMBLY__ */ 2303a9fd824SRoger Pau Monné 2313a9fd824SRoger Pau Monné #endif /* __XEN_PUBLIC_ARCH_X86_XEN_X86_64_H__ */ 2323a9fd824SRoger Pau Monné 2333a9fd824SRoger Pau Monné /* 2343a9fd824SRoger Pau Monné * Local variables: 2353a9fd824SRoger Pau Monné * mode: C 2363a9fd824SRoger Pau Monné * c-file-style: "BSD" 2373a9fd824SRoger Pau Monné * c-basic-offset: 4 2383a9fd824SRoger Pau Monné * tab-width: 4 2393a9fd824SRoger Pau Monné * indent-tabs-mode: nil 2403a9fd824SRoger Pau Monné * End: 2413a9fd824SRoger Pau Monné */ 242