include/xen/interface/arch-x86/xen.h

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