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