1 /******************************************************************************
4 * Guest OS interface to x86 Xen.
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:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
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.
24 * Copyright (c) 2004-2006, K A Fraser
27 #ifndef __XEN_PUBLIC_ARCH_X86_XEN_H__
28 #define __XEN_PUBLIC_ARCH_X86_XEN_H__
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
35 #error "using old handle"
36 #define ___DEFINE_XEN_GUEST_HANDLE(name, type) \
37 typedef type * __guest_handle_ ## name
40 #define __DEFINE_XEN_GUEST_HANDLE(name, type) \
41 ___DEFINE_XEN_GUEST_HANDLE(name, type); \
42 ___DEFINE_XEN_GUEST_HANDLE(const_##name, const type)
43 #define DEFINE_XEN_GUEST_HANDLE(name) __DEFINE_XEN_GUEST_HANDLE(name, name)
44 #define __XEN_GUEST_HANDLE(name) __guest_handle_ ## name
45 #define XEN_GUEST_HANDLE(name) __XEN_GUEST_HANDLE(name)
46 #define set_xen_guest_handle(hnd, val) do { (hnd).p = val; } while (0)
48 #define get_xen_guest_handle(val, hnd) do { val = (hnd).p; } while (0)
52 #include <xen/interface/arch-x86/xen-x86_32.h>
53 #elif defined(__x86_64__)
54 #include <xen/interface/arch-x86/xen-x86_64.h>
58 typedef unsigned long xen_pfn_t;
59 #define PRI_xen_pfn "lx"
63 * SEGMENT DESCRIPTOR TABLES
66 * A number of GDT entries are reserved by Xen. These are not situated at the
67 * start of the GDT because some stupid OSes export hard-coded selector values
68 * in their ABI. These hard-coded values are always near the start of the GDT,
69 * so Xen places itself out of the way, at the far end of the GDT.
71 #define FIRST_RESERVED_GDT_PAGE 14
72 #define FIRST_RESERVED_GDT_BYTE (FIRST_RESERVED_GDT_PAGE * 4096)
73 #define FIRST_RESERVED_GDT_ENTRY (FIRST_RESERVED_GDT_BYTE / 8)
75 /* Maximum number of virtual CPUs in multi-processor guests. */
76 #define MAX_VIRT_CPUS 32
80 typedef unsigned long xen_ulong_t;
83 * Send an array of these to HYPERVISOR_set_trap_table().
84 * The privilege level specifies which modes may enter a trap via a software
85 * interrupt. On x86/64, since rings 1 and 2 are unavailable, we allocate
86 * privilege levels as follows:
87 * Level == 0: Noone may enter
88 * Level == 1: Kernel may enter
89 * Level == 2: Kernel may enter
90 * Level == 3: Everyone may enter
92 #define TI_GET_DPL(_ti) ((_ti)->flags & 3)
93 #define TI_GET_IF(_ti) ((_ti)->flags & 4)
94 #define TI_SET_DPL(_ti,_dpl) ((_ti)->flags |= (_dpl))
95 #define TI_SET_IF(_ti,_if) ((_ti)->flags |= ((!!(_if))<<2))
97 uint8_t vector; /* exception vector */
98 uint8_t flags; /* 0-3: privilege level; 4: clear event enable? */
99 uint16_t cs; /* code selector */
100 unsigned long address; /* code offset */
102 typedef struct trap_info trap_info_t;
103 DEFINE_XEN_GUEST_HANDLE(trap_info_t);
105 typedef uint64_t tsc_timestamp_t; /* RDTSC timestamp */
108 * The following is all CPU context. Note that the fpu_ctxt block is filled
109 * in by FXSAVE if the CPU has feature FXSR; otherwise FSAVE is used.
111 struct vcpu_guest_context {
112 /* FPU registers come first so they can be aligned for FXSAVE/FXRSTOR. */
113 struct { char x[512]; } fpu_ctxt; /* User-level FPU registers */
114 #define VGCF_I387_VALID (1<<0)
115 #define VGCF_IN_KERNEL (1<<2)
116 #define _VGCF_i387_valid 0
117 #define VGCF_i387_valid (1<<_VGCF_i387_valid)
118 #define _VGCF_in_kernel 2
119 #define VGCF_in_kernel (1<<_VGCF_in_kernel)
120 #define _VGCF_failsafe_disables_events 3
121 #define VGCF_failsafe_disables_events (1<<_VGCF_failsafe_disables_events)
122 #define _VGCF_syscall_disables_events 4
123 #define VGCF_syscall_disables_events (1<<_VGCF_syscall_disables_events)
124 #define _VGCF_online 5
125 #define VGCF_online (1<<_VGCF_online)
126 unsigned long flags; /* VGCF_* flags */
127 struct cpu_user_regs user_regs; /* User-level CPU registers */
128 struct trap_info trap_ctxt[256]; /* Virtual IDT */
129 unsigned long ldt_base, ldt_ents; /* LDT (linear address, # ents) */
130 unsigned long gdt_frames[16], gdt_ents; /* GDT (machine frames, # ents) */
131 unsigned long kernel_ss, kernel_sp; /* Virtual TSS (only SS1/SP1) */
132 /* NB. User pagetable on x86/64 is placed in ctrlreg[1]. */
133 unsigned long ctrlreg[8]; /* CR0-CR7 (control registers) */
134 unsigned long debugreg[8]; /* DB0-DB7 (debug registers) */
136 unsigned long event_callback_cs; /* CS:EIP of event callback */
137 unsigned long event_callback_eip;
138 unsigned long failsafe_callback_cs; /* CS:EIP of failsafe callback */
139 unsigned long failsafe_callback_eip;
141 unsigned long event_callback_eip;
142 unsigned long failsafe_callback_eip;
145 unsigned long syscall_callback_eip;
147 unsigned int event_callback_cs; /* compat CS of event cb */
148 unsigned int failsafe_callback_cs; /* compat CS of failsafe cb */
152 unsigned long syscall_callback_eip;
155 unsigned long vm_assist; /* VMASST_TYPE_* bitmap */
157 /* Segment base addresses. */
159 uint64_t gs_base_kernel;
160 uint64_t gs_base_user;
163 typedef struct vcpu_guest_context vcpu_guest_context_t;
164 DEFINE_XEN_GUEST_HANDLE(vcpu_guest_context_t);
166 struct arch_shared_info {
167 unsigned long max_pfn; /* max pfn that appears in table */
168 /* Frame containing list of mfns containing list of mfns containing p2m. */
169 xen_pfn_t pfn_to_mfn_frame_list_list;
170 unsigned long nmi_reason;
173 typedef struct arch_shared_info arch_shared_info_t;
175 #endif /* !__ASSEMBLY__ */
178 * Prefix forces emulation of some non-trapping instructions.
179 * Currently only CPUID.
182 #define XEN_EMULATE_PREFIX .byte 0x0f,0x0b,0x78,0x65,0x6e ;
183 #define XEN_CPUID XEN_EMULATE_PREFIX cpuid
185 #define XEN_EMULATE_PREFIX ".byte 0x0f,0x0b,0x78,0x65,0x6e ; "
186 #define XEN_CPUID XEN_EMULATE_PREFIX "cpuid"
189 #endif /* __XEN_PUBLIC_ARCH_X86_XEN_H__ */
197 * indent-tabs-mode: nil