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 #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 /* Allow co-existing Linux 2.6.23+ Xen interface definitions. */
  54 #define DEFINE_GUEST_HANDLE_STRUCT(name) struct name
  55
  56 #if defined(__i386__)
  57 #include "xen-x86_32.h"
  58 #elif defined(__x86_64__)
  59 #include "xen-x86_64.h"
  60 #endif
  61
  62 #ifndef __ASSEMBLY__
  63 typedef unsigned long 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 legacy multi-processor guests. */
  81 #define XEN_LEGACY_MAX_VCPUS 32
  82
  83 #ifndef __ASSEMBLY__
  84
  85 typedef unsigned long xen_ulong_t;
  86
  87 /*
  88  * ` enum neg_errnoval
  89  * ` HYPERVISOR_set_trap_table(const struct trap_info traps[]);
  90  * `
  91  */
  92 /*
  93  * Send an array of these to HYPERVISOR_set_trap_table().
  94  * Terminate the array with a sentinel entry, with traps[].address==0.
  95  * The privilege level specifies which modes may enter a trap via a software
  96  * interrupt. On x86/64, since rings 1 and 2 are unavailable, we allocate
  97  * privilege levels as follows:
  98  *  Level == 0: Noone may enter
  99  *  Level == 1: Kernel may enter
 100  *  Level == 2: Kernel may enter
 101  *  Level == 3: Everyone may enter
 102  */
 103 #define TI_GET_DPL(_ti)      ((_ti)->flags & 3)
 104 #define TI_GET_IF(_ti)       ((_ti)->flags & 4)
 105 #define TI_SET_DPL(_ti,_dpl) ((_ti)->flags |= (_dpl))
 106 #define TI_SET_IF(_ti,_if)   ((_ti)->flags |= ((!!(_if))<<2))
 107 struct trap_info {
 108     uint8_t       vector;  /* exception vector                              */
 109     uint8_t       flags;   /* 0-3: privilege level; 4: clear event enable?  */
 110     uint16_t      cs;      /* code selector                                 */
 111     unsigned long address; /* code offset                                   */
 112 };
 113 typedef struct trap_info trap_info_t;
 114 DEFINE_XEN_GUEST_HANDLE(trap_info_t);
 115
 116 typedef uint64_t tsc_timestamp_t; /* RDTSC timestamp */
 117
 118 /*
 119  * The following is all CPU context. Note that the fpu_ctxt block is filled
 120  * in by FXSAVE if the CPU has feature FXSR; otherwise FSAVE is used.
 121  */
 122 struct vcpu_guest_context {
 123     /* FPU registers come first so they can be aligned for FXSAVE/FXRSTOR. */
 124     struct { char x[512]; } fpu_ctxt;       /* User-level FPU registers     */
 125 #define VGCF_I387_VALID                (1<<0)
 126 #define VGCF_IN_KERNEL                 (1<<2)
 127 #define _VGCF_i387_valid               0
 128 #define VGCF_i387_valid                (1<<_VGCF_i387_valid)
 129 #define _VGCF_in_kernel                2
 130 #define VGCF_in_kernel                 (1<<_VGCF_in_kernel)
 131 #define _VGCF_failsafe_disables_events 3
 132 #define VGCF_failsafe_disables_events  (1<<_VGCF_failsafe_disables_events)
 133 #define _VGCF_syscall_disables_events  4
 134 #define VGCF_syscall_disables_events   (1<<_VGCF_syscall_disables_events)
 135 #define _VGCF_online                   5
 136 #define VGCF_online                    (1<<_VGCF_online)
 137     unsigned long flags;                    /* VGCF_* flags                 */
 138     struct cpu_user_regs user_regs;         /* User-level CPU registers     */
 139     struct trap_info trap_ctxt[256];        /* Virtual IDT                  */
 140     unsigned long ldt_base, ldt_ents;       /* LDT (linear address, # ents) */
 141     unsigned long gdt_frames[16], gdt_ents; /* GDT (machine frames, # ents) */
 142     unsigned long kernel_ss, kernel_sp;     /* Virtual TSS (only SS1/SP1)   */
 143     /* NB. User pagetable on x86/64 is placed in ctrlreg[1]. */
 144     unsigned long ctrlreg[8];               /* CR0-CR7 (control registers)  */
 145     unsigned long debugreg[8];              /* DB0-DB7 (debug registers)    */
 146 #ifdef __i386__
 147     unsigned long event_callback_cs;        /* CS:EIP of event callback     */
 148     unsigned long event_callback_eip;
 149     unsigned long failsafe_callback_cs;     /* CS:EIP of failsafe callback  */
 150     unsigned long failsafe_callback_eip;
 151 #else
 152     unsigned long event_callback_eip;
 153     unsigned long failsafe_callback_eip;
 154 #ifdef __XEN__
 155     union {
 156         unsigned long syscall_callback_eip;
 157         struct {
 158             unsigned int event_callback_cs;    /* compat CS of event cb     */
 159             unsigned int failsafe_callback_cs; /* compat CS of failsafe cb  */
 160         };
 161     };
 162 #else
 163     unsigned long syscall_callback_eip;
 164 #endif
 165 #endif
 166     unsigned long vm_assist;                /* VMASST_TYPE_* bitmap */
 167 #ifdef __x86_64__
 168     /* Segment base addresses. */
 169     uint64_t      fs_base;
 170     uint64_t      gs_base_kernel;
 171     uint64_t      gs_base_user;
 172 #endif
 173 };
 174 typedef struct vcpu_guest_context vcpu_guest_context_t;
 175 DEFINE_XEN_GUEST_HANDLE(vcpu_guest_context_t);
 176
 177 struct arch_shared_info {
 178     unsigned long max_pfn;                  /* max pfn that appears in table */
 179     /* Frame containing list of mfns containing list of mfns containing p2m. */
 180     xen_pfn_t     pfn_to_mfn_frame_list_list;
 181     unsigned long nmi_reason;
 182     uint64_t pad[32];
 183 };
 184 typedef struct arch_shared_info arch_shared_info_t;
 185
 186 #endif /* !__ASSEMBLY__ */
 187
 188 /*
 189  * Prefix forces emulation of some non-trapping instructions.
 190  * Currently only CPUID.
 191  */
 192 #ifdef __ASSEMBLY__
 193 #define XEN_EMULATE_PREFIX .byte 0x0f,0x0b,0x78,0x65,0x6e ;
 194 #define XEN_CPUID          XEN_EMULATE_PREFIX cpuid
 195 #else
 196 #define XEN_EMULATE_PREFIX ".byte 0x0f,0x0b,0x78,0x65,0x6e ; "
 197 #define XEN_CPUID          XEN_EMULATE_PREFIX "cpuid"
 198 #endif
 199
 200 #endif /* __XEN_PUBLIC_ARCH_X86_XEN_H__ */
 201
 202 /*
 203  * Local variables:
 204  * mode: C
 205  * c-set-style: "BSD"
 206  * c-basic-offset: 4
 207  * tab-width: 4
 208  * indent-tabs-mode: nil
 209  * End:
 210  */