sys/xen/interface/arch-x86/xen-x86_32.h

   1 /******************************************************************************
   2  * xen-x86_32.h
   3  *
   4  * Guest OS interface to x86 32-bit 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-2007, K A Fraser
  25  */
  26
  27 #include <sys/param.h>
  28 #include <sys/types.h>
  29
  30 #ifndef __XEN_PUBLIC_ARCH_X86_XEN_X86_32_H__
  31 #define __XEN_PUBLIC_ARCH_X86_XEN_X86_32_H__
  32
  33 /*
  34  * Hypercall interface:
  35  *  Input:  %ebx, %ecx, %edx, %esi, %edi (arguments 1-5)
  36  *  Output: %eax
  37  * Access is via hypercall page (set up by guest loader or via a Xen MSR):
  38  *  call hypercall_page + hypercall-number * 32
  39  * Clobbered: Argument registers (e.g., 2-arg hypercall clobbers %ebx,%ecx)
  40  */
  41
  42 #if __XEN_INTERFACE_VERSION__ < 0x00030203
  43 /*
  44  * Legacy hypercall interface:
  45  * As above, except the entry sequence to the hypervisor is:
  46  *  mov $hypercall-number*32,%eax ; int $0x82
  47  */
  48 #define TRAP_INSTR "int $0x82"
  49 #endif
  50
  51 /*
  52  * These flat segments are in the Xen-private section of every GDT. Since these
  53  * are also present in the initial GDT, many OSes will be able to avoid
  54  * installing their own GDT.
  55  */
  56 #define FLAT_RING1_CS 0xe019    /* GDT index 259 */
  57 #define FLAT_RING1_DS 0xe021    /* GDT index 260 */
  58 #define FLAT_RING1_SS 0xe021    /* GDT index 260 */
  59 #define FLAT_RING3_CS 0xe02b    /* GDT index 261 */
  60 #define FLAT_RING3_DS 0xe033    /* GDT index 262 */
  61 #define FLAT_RING3_SS 0xe033    /* GDT index 262 */
  62
  63 #define FLAT_KERNEL_CS FLAT_RING1_CS
  64 #define FLAT_KERNEL_DS FLAT_RING1_DS
  65 #define FLAT_KERNEL_SS FLAT_RING1_SS
  66 #define FLAT_USER_CS    FLAT_RING3_CS
  67 #define FLAT_USER_DS    FLAT_RING3_DS
  68 #define FLAT_USER_SS    FLAT_RING3_SS
  69
  70 #define __HYPERVISOR_VIRT_START_PAE    0xF5800000
  71 #define __MACH2PHYS_VIRT_START_PAE     0xF5800000
  72 #define __MACH2PHYS_VIRT_END_PAE       0xF6800000
  73 #define HYPERVISOR_VIRT_START_PAE      \
  74     mk_unsigned_long(__HYPERVISOR_VIRT_START_PAE)
  75 #define MACH2PHYS_VIRT_START_PAE       \
  76     mk_unsigned_long(__MACH2PHYS_VIRT_START_PAE)
  77 #define MACH2PHYS_VIRT_END_PAE         \
  78     mk_unsigned_long(__MACH2PHYS_VIRT_END_PAE)
  79
  80 /* Non-PAE bounds are obsolete. */
  81 #define __HYPERVISOR_VIRT_START_NONPAE 0xFC000000
  82 #define __MACH2PHYS_VIRT_START_NONPAE  0xFC000000
  83 #define __MACH2PHYS_VIRT_END_NONPAE    0xFC400000
  84 #define HYPERVISOR_VIRT_START_NONPAE   \
  85     mk_unsigned_long(__HYPERVISOR_VIRT_START_NONPAE)
  86 #define MACH2PHYS_VIRT_START_NONPAE    \
  87     mk_unsigned_long(__MACH2PHYS_VIRT_START_NONPAE)
  88 #define MACH2PHYS_VIRT_END_NONPAE      \
  89     mk_unsigned_long(__MACH2PHYS_VIRT_END_NONPAE)
  90
  91 #define __HYPERVISOR_VIRT_START __HYPERVISOR_VIRT_START_PAE
  92 #define __MACH2PHYS_VIRT_START  __MACH2PHYS_VIRT_START_PAE
  93 #define __MACH2PHYS_VIRT_END    __MACH2PHYS_VIRT_END_PAE
  94
  95 #ifndef HYPERVISOR_VIRT_START
  96 #define HYPERVISOR_VIRT_START mk_unsigned_long(__HYPERVISOR_VIRT_START)
  97 #endif
  98
  99 #define MACH2PHYS_VIRT_START  mk_unsigned_long(__MACH2PHYS_VIRT_START)
 100 #define MACH2PHYS_VIRT_END    mk_unsigned_long(__MACH2PHYS_VIRT_END)
 101 #define MACH2PHYS_NR_ENTRIES  ((MACH2PHYS_VIRT_END-MACH2PHYS_VIRT_START)>>2)
 102 #ifndef machine_to_phys_mapping
 103 #define machine_to_phys_mapping ((unsigned long *)MACH2PHYS_VIRT_START)
 104 #endif
 105
 106 /* 32-/64-bit invariability for control interfaces (domctl/sysctl). */
 107 #if defined(__XEN__) || defined(__XEN_TOOLS__)
 108 #undef ___DEFINE_XEN_GUEST_HANDLE
 109 #define ___DEFINE_XEN_GUEST_HANDLE(name, type)                  \
 110     typedef struct { type *p; }                                 \
 111         __guest_handle_ ## name;                                \
 112     typedef struct { union { type *p; uint64_aligned_t q; }; }  \
 113         __guest_handle_64_ ## name
 114 #undef set_xen_guest_handle
 115 #define set_xen_guest_handle(hnd, val)                      \
 116     do { if ( sizeof(hnd) == 8 ) *(uint64_t *)&(hnd) = 0;   \
 117          (hnd).p = val;                                     \
 118     } while ( 0 )
 119 #define uint64_aligned_t uint64_t __attribute__((aligned(8)))
 120 #define __XEN_GUEST_HANDLE_64(name) __guest_handle_64_ ## name
 121 #define XEN_GUEST_HANDLE_64(name) __XEN_GUEST_HANDLE_64(name)
 122 #endif
 123
 124 #ifndef __ASSEMBLY__
 125
 126 struct cpu_user_regs {
 127     uint32_t ebx;
 128     uint32_t ecx;
 129     uint32_t edx;
 130     uint32_t esi;
 131     uint32_t edi;
 132     uint32_t ebp;
 133     uint32_t eax;
 134     uint16_t error_code;    /* private */
 135     uint16_t entry_vector;  /* private */
 136     uint32_t eip;
 137     uint16_t cs;
 138     uint8_t  saved_upcall_mask;
 139     uint8_t  _pad0;
 140     uint32_t eflags;        /* eflags.IF == !saved_upcall_mask */
 141     uint32_t esp;
 142     uint16_t ss, _pad1;
 143     uint16_t es, _pad2;
 144     uint16_t ds, _pad3;
 145     uint16_t fs, _pad4;
 146     uint16_t gs, _pad5;
 147 };
 148 typedef struct cpu_user_regs cpu_user_regs_t;
 149 DEFINE_XEN_GUEST_HANDLE(cpu_user_regs_t);
 150
 151 /*
 152  * Page-directory addresses above 4GB do not fit into architectural %cr3.
 153  * When accessing %cr3, or equivalent field in vcpu_guest_context, guests
 154  * must use the following accessor macros to pack/unpack valid MFNs.
 155  */
 156 #define xen_pfn_to_cr3(pfn) (((unsigned)(pfn) << 12) | ((unsigned)(pfn) >> 20))
 157 #define xen_cr3_to_pfn(cr3) (((unsigned)(cr3) >> 12) | ((unsigned)(cr3) << 20))
 158
 159 struct arch_vcpu_info {
 160     unsigned long cr2;
 161     unsigned long pad[5]; /* sizeof(vcpu_info_t) == 64 */
 162 };
 163 typedef struct arch_vcpu_info arch_vcpu_info_t;
 164
 165 struct xen_callback {
 166     unsigned long cs;
 167     unsigned long eip;
 168 };
 169 typedef struct xen_callback xen_callback_t;
 170
 171 #endif /* !__ASSEMBLY__ */
 172
 173 #endif /* __XEN_PUBLIC_ARCH_X86_XEN_X86_32_H__ */
 174
 175 /*
 176  * Local variables:
 177  * mode: C
 178  * c-set-style: "BSD"
 179  * c-basic-offset: 4
 180  * tab-width: 4
 181  * indent-tabs-mode: nil
 182  * End:
 183  */