include/xen/interface/vcpu.h

   1 /******************************************************************************
   2  * vcpu.h
   3  *
   4  * VCPU initialisation, query, and hotplug.
   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) 2005, Keir Fraser <keir@xensource.com>
  25  */
  26
  27 #ifndef __XEN_PUBLIC_VCPU_H__
  28 #define __XEN_PUBLIC_VCPU_H__
  29
  30 #include "xen.h"
  31
  32 /*
  33  * Prototype for this hypercall is:
  34  *      int vcpu_op(int cmd, int vcpuid, void *extra_args)
  35  * @cmd            == VCPUOP_??? (VCPU operation).
  36  * @vcpuid         == VCPU to operate on.
  37  * @extra_args == Operation-specific extra arguments (NULL if none).
  38  */
  39
  40 /*
  41  * Initialise a VCPU. Each VCPU can be initialised only once. A
  42  * newly-initialised VCPU will not run until it is brought up by VCPUOP_up.
  43  *
  44  * @extra_arg == pointer to vcpu_guest_context structure containing initial
  45  *                               state for the VCPU.
  46  */
  47 #define VCPUOP_initialise                        0
  48
  49 /*
  50  * Bring up a VCPU. This makes the VCPU runnable. This operation will fail
  51  * if the VCPU has not been initialised (VCPUOP_initialise).
  52  */
  53 #define VCPUOP_up                                        1
  54
  55 /*
  56  * Bring down a VCPU (i.e., make it non-runnable).
  57  * There are a few caveats that callers should observe:
  58  *      1. This operation may return, and VCPU_is_up may return false, before the
  59  *         VCPU stops running (i.e., the command is asynchronous). It is a good
  60  *         idea to ensure that the VCPU has entered a non-critical loop before
  61  *         bringing it down. Alternatively, this operation is guaranteed
  62  *         synchronous if invoked by the VCPU itself.
  63  *      2. After a VCPU is initialised, there is currently no way to drop all its
  64  *         references to domain memory. Even a VCPU that is down still holds
  65  *         memory references via its pagetable base pointer and GDT. It is good
  66  *         practise to move a VCPU onto an 'idle' or default page table, LDT and
  67  *         GDT before bringing it down.
  68  */
  69 #define VCPUOP_down                                      2
  70
  71 /* Returns 1 if the given VCPU is up. */
  72 #define VCPUOP_is_up                             3
  73
  74 /*
  75  * Return information about the state and running time of a VCPU.
  76  * @extra_arg == pointer to vcpu_runstate_info structure.
  77  */
  78 #define VCPUOP_get_runstate_info         4
  79 struct vcpu_runstate_info {
  80                 /* VCPU's current state (RUNSTATE_*). */
  81                 int              state;
  82                 /* When was current state entered (system time, ns)? */
  83                 uint64_t state_entry_time;
  84                 /*
  85                  * Time spent in each RUNSTATE_* (ns). The sum of these times is
  86                  * guaranteed not to drift from system time.
  87                  */
  88                 uint64_t time[4];
  89 };
  90 DEFINE_GUEST_HANDLE_STRUCT(vcpu_runstate_info);
  91 typedef struct vcpu_runstate_info vcpu_runstate_info_t;
  92 DEFINE_XEN_GUEST_HANDLE(vcpu_runstate_info_t);
  93
  94 /* VCPU is currently running on a physical CPU. */
  95 #define RUNSTATE_running  0
  96
  97 /* VCPU is runnable, but not currently scheduled on any physical CPU. */
  98 #define RUNSTATE_runnable 1
  99
 100 /* VCPU is blocked (a.k.a. idle). It is therefore not runnable. */
 101 #define RUNSTATE_blocked  2
 102
 103 /*
 104  * VCPU is not runnable, but it is not blocked.
 105  * This is a 'catch all' state for things like hotplug and pauses by the
 106  * system administrator (or for critical sections in the hypervisor).
 107  * RUNSTATE_blocked dominates this state (it is the preferred state).
 108  */
 109 #define RUNSTATE_offline  3
 110
 111 /*
 112  * Register a shared memory area from which the guest may obtain its own
 113  * runstate information without needing to execute a hypercall.
 114  * Notes:
 115  *      1. The registered address may be virtual or physical, depending on the
 116  *         platform. The virtual address should be registered on x86 systems.
 117  *      2. Only one shared area may be registered per VCPU. The shared area is
 118  *         updated by the hypervisor each time the VCPU is scheduled. Thus
 119  *         runstate.state will always be RUNSTATE_running and
 120  *         runstate.state_entry_time will indicate the system time at which the
 121  *         VCPU was last scheduled to run.
 122  * @extra_arg == pointer to vcpu_register_runstate_memory_area structure.
 123  */
 124 #define VCPUOP_register_runstate_memory_area 5
 125 struct vcpu_register_runstate_memory_area {
 126                 union {
 127                                 XEN_GUEST_HANDLE(vcpu_runstate_info_t) h;
 128                                 struct vcpu_runstate_info *v;
 129                                 uint64_t p;
 130                 } addr;
 131 };
 132 typedef struct vcpu_register_runstate_memory_area vcpu_register_runstate_memory_area_t;
 133 DEFINE_XEN_GUEST_HANDLE(vcpu_register_runstate_memory_area_t);
 134
 135 /*
 136  * Set or stop a VCPU's periodic timer. Every VCPU has one periodic timer
 137  * which can be set via these commands. Periods smaller than one millisecond
 138  * may not be supported.
 139  */
 140 #define VCPUOP_set_periodic_timer        6 /* arg == vcpu_set_periodic_timer_t */
 141 #define VCPUOP_stop_periodic_timer       7 /* arg == NULL */
 142 struct vcpu_set_periodic_timer {
 143                 uint64_t period_ns;
 144 };
 145 DEFINE_GUEST_HANDLE_STRUCT(vcpu_set_periodic_timer);
 146 typedef struct vcpu_set_periodic_timer vcpu_set_periodic_timer_t;
 147 DEFINE_XEN_GUEST_HANDLE(vcpu_set_periodic_timer_t);
 148
 149 /*
 150  * Set or stop a VCPU's single-shot timer. Every VCPU has one single-shot
 151  * timer which can be set via these commands.
 152  */
 153 #define VCPUOP_set_singleshot_timer      8 /* arg == vcpu_set_singleshot_timer_t */
 154 #define VCPUOP_stop_singleshot_timer 9 /* arg == NULL */
 155 struct vcpu_set_singleshot_timer {
 156                 uint64_t timeout_abs_ns;
 157                 uint32_t flags;                    /* VCPU_SSHOTTMR_??? */
 158 };
 159 DEFINE_GUEST_HANDLE_STRUCT(vcpu_set_singleshot_timer);
 160 typedef struct vcpu_set_singleshot_timer vcpu_set_singleshot_timer_t;
 161 DEFINE_XEN_GUEST_HANDLE(vcpu_set_singleshot_timer_t);
 162
 163 /* Flags to VCPUOP_set_singleshot_timer. */
 164  /* Require the timeout to be in the future (return -ETIME if it's passed). */
 165 #define _VCPU_SSHOTTMR_future (0)
 166 #define VCPU_SSHOTTMR_future  (1U << _VCPU_SSHOTTMR_future)
 167
 168 /*
 169  * Register a memory location in the guest address space for the
 170  * vcpu_info structure.  This allows the guest to place the vcpu_info
 171  * structure in a convenient place, such as in a per-cpu data area.
 172  * The pointer need not be page aligned, but the structure must not
 173  * cross a page boundary.
 174  *
 175  * This may be called only once per vcpu.
 176  */
 177 #define VCPUOP_register_vcpu_info   10  /* arg == struct vcpu_info */
 178 struct vcpu_register_vcpu_info {
 179     uint64_t mfn;    /* mfn of page to place vcpu_info */
 180     uint32_t offset; /* offset within page */
 181     uint32_t rsvd;   /* unused */
 182 };
 183 DEFINE_GUEST_HANDLE_STRUCT(vcpu_register_vcpu_info);
 184 typedef struct vcpu_register_vcpu_info vcpu_register_vcpu_info_t;
 185 DEFINE_XEN_GUEST_HANDLE(vcpu_register_vcpu_info_t);
 186
 187 /* Send an NMI to the specified VCPU. @extra_arg == NULL. */
 188 #define VCPUOP_send_nmi             11
 189
 190 /*
 191  * Get the physical ID information for a pinned vcpu's underlying physical
 192  * processor.  The physical ID informmation is architecture-specific.
 193  * On x86: id[31:0]=apic_id, id[63:32]=acpi_id.
 194  * This command returns -EINVAL if it is not a valid operation for this VCPU.
 195  */
 196 #define VCPUOP_get_physid           12 /* arg == vcpu_get_physid_t */
 197 struct vcpu_get_physid {
 198     uint64_t phys_id;
 199 };
 200 typedef struct vcpu_get_physid vcpu_get_physid_t;
 201 DEFINE_XEN_GUEST_HANDLE(vcpu_get_physid_t);
 202 #define xen_vcpu_physid_to_x86_apicid(physid) ((uint32_t)(physid))
 203 #define xen_vcpu_physid_to_x86_acpiid(physid) ((uint32_t)((physid) >> 32))
 204
 205 /*
 206  * Register a memory location to get a secondary copy of the vcpu time
 207  * parameters.  The master copy still exists as part of the vcpu shared
 208  * memory area, and this secondary copy is updated whenever the master copy
 209  * is updated (and using the same versioning scheme for synchronisation).
 210  *
 211  * The intent is that this copy may be mapped (RO) into userspace so
 212  * that usermode can compute system time using the time info and the
 213  * tsc.  Usermode will see an array of vcpu_time_info structures, one
 214  * for each vcpu, and choose the right one by an existing mechanism
 215  * which allows it to get the current vcpu number (such as via a
 216  * segment limit).  It can then apply the normal algorithm to compute
 217  * system time from the tsc.
 218  *
 219  * @extra_arg == pointer to vcpu_register_time_info_memory_area structure.
 220  */
 221 #define VCPUOP_register_vcpu_time_memory_area   13
 222 DEFINE_XEN_GUEST_HANDLE(vcpu_time_info_t);
 223 struct vcpu_register_time_memory_area {
 224     union {
 225         XEN_GUEST_HANDLE(vcpu_time_info_t) h;
 226         struct vcpu_time_info *v;
 227         uint64_t p;
 228     } addr;
 229 };
 230 typedef struct vcpu_register_time_memory_area vcpu_register_time_memory_area_t;
 231 DEFINE_XEN_GUEST_HANDLE(vcpu_register_time_memory_area_t);
 232
 233 #endif /* __XEN_PUBLIC_VCPU_H__ */