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