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