1 /******************************************************************************
4 * Linux-specific hypervisor handling.
6 * Copyright (c) 2002-2004, K A Fraser
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License version 2
10 * as published by the Free Software Foundation; or, when distributed
11 * separately from the Linux kernel or incorporated into other
12 * software packages, subject to the following license:
14 * Permission is hereby granted, free of charge, to any person obtaining a copy
15 * of this source file (the "Software"), to deal in the Software without
16 * restriction, including without limitation the rights to use, copy, modify,
17 * merge, publish, distribute, sublicense, and/or sell copies of the Software,
18 * and to permit persons to whom the Software is furnished to do so, subject to
19 * the following conditions:
21 * The above copyright notice and this permission notice shall be included in
22 * all copies or substantial portions of the Software.
24 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
25 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
26 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
27 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
28 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
29 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
33 #ifndef _ASM_X86_XEN_HYPERCALL_H
34 #define _ASM_X86_XEN_HYPERCALL_H
36 #include <linux/kernel.h>
37 #include <linux/spinlock.h>
38 #include <linux/errno.h>
39 #include <linux/string.h>
40 #include <linux/types.h>
43 #include <asm/pgtable.h>
45 #include <xen/interface/xen.h>
46 #include <xen/interface/sched.h>
47 #include <xen/interface/physdev.h>
48 #include <xen/interface/platform.h>
51 * The hypercall asms have to meet several constraints:
52 * - Work on 32- and 64-bit.
53 * The two architectures put their arguments in different sets of
56 * - Work around asm syntax quirks
57 * It isn't possible to specify one of the rNN registers in a
58 * constraint, so we use explicit register variables to get the
59 * args into the right place.
61 * - Mark all registers as potentially clobbered
62 * Even unused parameters can be clobbered by the hypervisor, so we
63 * need to make sure gcc knows it.
65 * - Avoid compiler bugs.
66 * This is the tricky part. Because x86_32 has such a constrained
67 * register set, gcc versions below 4.3 have trouble generating
68 * code when all the arg registers and memory are trashed by the
69 * asm. There are syntactically simpler ways of achieving the
70 * semantics below, but they cause the compiler to crash.
72 * The only combination I found which works is:
73 * - assign the __argX variables first
74 * - list all actually used parameters as "+r" (__argX)
77 * The result certainly isn't pretty, and it really shows up cpp's
78 * weakness as as macro language. Sorry. (But let's just give thanks
79 * there aren't more than 5 arguments...)
82 extern struct { char _entry[32]; } hypercall_page[];
84 #define __HYPERCALL "call hypercall_page+%c[offset]"
85 #define __HYPERCALL_ENTRY(x) \
86 [offset] "i" (__HYPERVISOR_##x * sizeof(hypercall_page[0]))
89 #define __HYPERCALL_RETREG "eax"
90 #define __HYPERCALL_ARG1REG "ebx"
91 #define __HYPERCALL_ARG2REG "ecx"
92 #define __HYPERCALL_ARG3REG "edx"
93 #define __HYPERCALL_ARG4REG "esi"
94 #define __HYPERCALL_ARG5REG "edi"
96 #define __HYPERCALL_RETREG "rax"
97 #define __HYPERCALL_ARG1REG "rdi"
98 #define __HYPERCALL_ARG2REG "rsi"
99 #define __HYPERCALL_ARG3REG "rdx"
100 #define __HYPERCALL_ARG4REG "r10"
101 #define __HYPERCALL_ARG5REG "r8"
104 #define __HYPERCALL_DECLS \
105 register unsigned long __res asm(__HYPERCALL_RETREG); \
106 register unsigned long __arg1 asm(__HYPERCALL_ARG1REG) = __arg1; \
107 register unsigned long __arg2 asm(__HYPERCALL_ARG2REG) = __arg2; \
108 register unsigned long __arg3 asm(__HYPERCALL_ARG3REG) = __arg3; \
109 register unsigned long __arg4 asm(__HYPERCALL_ARG4REG) = __arg4; \
110 register unsigned long __arg5 asm(__HYPERCALL_ARG5REG) = __arg5;
112 #define __HYPERCALL_0PARAM "=r" (__res)
113 #define __HYPERCALL_1PARAM __HYPERCALL_0PARAM, "+r" (__arg1)
114 #define __HYPERCALL_2PARAM __HYPERCALL_1PARAM, "+r" (__arg2)
115 #define __HYPERCALL_3PARAM __HYPERCALL_2PARAM, "+r" (__arg3)
116 #define __HYPERCALL_4PARAM __HYPERCALL_3PARAM, "+r" (__arg4)
117 #define __HYPERCALL_5PARAM __HYPERCALL_4PARAM, "+r" (__arg5)
119 #define __HYPERCALL_0ARG()
120 #define __HYPERCALL_1ARG(a1) \
121 __HYPERCALL_0ARG() __arg1 = (unsigned long)(a1);
122 #define __HYPERCALL_2ARG(a1,a2) \
123 __HYPERCALL_1ARG(a1) __arg2 = (unsigned long)(a2);
124 #define __HYPERCALL_3ARG(a1,a2,a3) \
125 __HYPERCALL_2ARG(a1,a2) __arg3 = (unsigned long)(a3);
126 #define __HYPERCALL_4ARG(a1,a2,a3,a4) \
127 __HYPERCALL_3ARG(a1,a2,a3) __arg4 = (unsigned long)(a4);
128 #define __HYPERCALL_5ARG(a1,a2,a3,a4,a5) \
129 __HYPERCALL_4ARG(a1,a2,a3,a4) __arg5 = (unsigned long)(a5);
131 #define __HYPERCALL_CLOBBER5 "memory"
132 #define __HYPERCALL_CLOBBER4 __HYPERCALL_CLOBBER5, __HYPERCALL_ARG5REG
133 #define __HYPERCALL_CLOBBER3 __HYPERCALL_CLOBBER4, __HYPERCALL_ARG4REG
134 #define __HYPERCALL_CLOBBER2 __HYPERCALL_CLOBBER3, __HYPERCALL_ARG3REG
135 #define __HYPERCALL_CLOBBER1 __HYPERCALL_CLOBBER2, __HYPERCALL_ARG2REG
136 #define __HYPERCALL_CLOBBER0 __HYPERCALL_CLOBBER1, __HYPERCALL_ARG1REG
138 #define _hypercall0(type, name) \
141 __HYPERCALL_0ARG(); \
142 asm volatile (__HYPERCALL \
143 : __HYPERCALL_0PARAM \
144 : __HYPERCALL_ENTRY(name) \
145 : __HYPERCALL_CLOBBER0); \
149 #define _hypercall1(type, name, a1) \
152 __HYPERCALL_1ARG(a1); \
153 asm volatile (__HYPERCALL \
154 : __HYPERCALL_1PARAM \
155 : __HYPERCALL_ENTRY(name) \
156 : __HYPERCALL_CLOBBER1); \
160 #define _hypercall2(type, name, a1, a2) \
163 __HYPERCALL_2ARG(a1, a2); \
164 asm volatile (__HYPERCALL \
165 : __HYPERCALL_2PARAM \
166 : __HYPERCALL_ENTRY(name) \
167 : __HYPERCALL_CLOBBER2); \
171 #define _hypercall3(type, name, a1, a2, a3) \
174 __HYPERCALL_3ARG(a1, a2, a3); \
175 asm volatile (__HYPERCALL \
176 : __HYPERCALL_3PARAM \
177 : __HYPERCALL_ENTRY(name) \
178 : __HYPERCALL_CLOBBER3); \
182 #define _hypercall4(type, name, a1, a2, a3, a4) \
185 __HYPERCALL_4ARG(a1, a2, a3, a4); \
186 asm volatile (__HYPERCALL \
187 : __HYPERCALL_4PARAM \
188 : __HYPERCALL_ENTRY(name) \
189 : __HYPERCALL_CLOBBER4); \
193 #define _hypercall5(type, name, a1, a2, a3, a4, a5) \
196 __HYPERCALL_5ARG(a1, a2, a3, a4, a5); \
197 asm volatile (__HYPERCALL \
198 : __HYPERCALL_5PARAM \
199 : __HYPERCALL_ENTRY(name) \
200 : __HYPERCALL_CLOBBER5); \
205 privcmd_call(unsigned call,
206 unsigned long a1, unsigned long a2,
207 unsigned long a3, unsigned long a4,
211 __HYPERCALL_5ARG(a1, a2, a3, a4, a5);
213 asm volatile("call *%[call]"
215 : [call] "a" (&hypercall_page[call])
216 : __HYPERCALL_CLOBBER5);
222 HYPERVISOR_set_trap_table(struct trap_info *table)
224 return _hypercall1(int, set_trap_table, table);
228 HYPERVISOR_mmu_update(struct mmu_update *req, int count,
229 int *success_count, domid_t domid)
231 return _hypercall4(int, mmu_update, req, count, success_count, domid);
235 HYPERVISOR_mmuext_op(struct mmuext_op *op, int count,
236 int *success_count, domid_t domid)
238 return _hypercall4(int, mmuext_op, op, count, success_count, domid);
242 HYPERVISOR_set_gdt(unsigned long *frame_list, int entries)
244 return _hypercall2(int, set_gdt, frame_list, entries);
248 HYPERVISOR_stack_switch(unsigned long ss, unsigned long esp)
250 return _hypercall2(int, stack_switch, ss, esp);
255 HYPERVISOR_set_callbacks(unsigned long event_selector,
256 unsigned long event_address,
257 unsigned long failsafe_selector,
258 unsigned long failsafe_address)
260 return _hypercall4(int, set_callbacks,
261 event_selector, event_address,
262 failsafe_selector, failsafe_address);
264 #else /* CONFIG_X86_64 */
266 HYPERVISOR_set_callbacks(unsigned long event_address,
267 unsigned long failsafe_address,
268 unsigned long syscall_address)
270 return _hypercall3(int, set_callbacks,
271 event_address, failsafe_address,
274 #endif /* CONFIG_X86_{32,64} */
277 HYPERVISOR_callback_op(int cmd, void *arg)
279 return _hypercall2(int, callback_op, cmd, arg);
283 HYPERVISOR_fpu_taskswitch(int set)
285 return _hypercall1(int, fpu_taskswitch, set);
289 HYPERVISOR_sched_op(int cmd, void *arg)
291 return _hypercall2(int, sched_op, cmd, arg);
295 HYPERVISOR_set_timer_op(u64 timeout)
297 unsigned long timeout_hi = (unsigned long)(timeout>>32);
298 unsigned long timeout_lo = (unsigned long)timeout;
299 return _hypercall2(long, set_timer_op, timeout_lo, timeout_hi);
303 HYPERVISOR_dom0_op(struct xen_platform_op *platform_op)
305 platform_op->interface_version = XENPF_INTERFACE_VERSION;
306 return _hypercall1(int, dom0_op, platform_op);
310 HYPERVISOR_set_debugreg(int reg, unsigned long value)
312 return _hypercall2(int, set_debugreg, reg, value);
315 static inline unsigned long
316 HYPERVISOR_get_debugreg(int reg)
318 return _hypercall1(unsigned long, get_debugreg, reg);
322 HYPERVISOR_update_descriptor(u64 ma, u64 desc)
324 if (sizeof(u64) == sizeof(long))
325 return _hypercall2(int, update_descriptor, ma, desc);
326 return _hypercall4(int, update_descriptor, ma, ma>>32, desc, desc>>32);
330 HYPERVISOR_memory_op(unsigned int cmd, void *arg)
332 return _hypercall2(int, memory_op, cmd, arg);
336 HYPERVISOR_multicall(void *call_list, int nr_calls)
338 return _hypercall2(int, multicall, call_list, nr_calls);
342 HYPERVISOR_update_va_mapping(unsigned long va, pte_t new_val,
345 if (sizeof(new_val) == sizeof(long))
346 return _hypercall3(int, update_va_mapping, va,
349 return _hypercall4(int, update_va_mapping, va,
350 new_val.pte, new_val.pte >> 32, flags);
354 HYPERVISOR_event_channel_op(int cmd, void *arg)
356 int rc = _hypercall2(int, event_channel_op, cmd, arg);
357 if (unlikely(rc == -ENOSYS)) {
360 memcpy(&op.u, arg, sizeof(op.u));
361 rc = _hypercall1(int, event_channel_op_compat, &op);
362 memcpy(arg, &op.u, sizeof(op.u));
368 HYPERVISOR_xen_version(int cmd, void *arg)
370 return _hypercall2(int, xen_version, cmd, arg);
374 HYPERVISOR_console_io(int cmd, int count, char *str)
376 return _hypercall3(int, console_io, cmd, count, str);
380 HYPERVISOR_physdev_op(int cmd, void *arg)
382 int rc = _hypercall2(int, physdev_op, cmd, arg);
383 if (unlikely(rc == -ENOSYS)) {
384 struct physdev_op op;
386 memcpy(&op.u, arg, sizeof(op.u));
387 rc = _hypercall1(int, physdev_op_compat, &op);
388 memcpy(arg, &op.u, sizeof(op.u));
394 HYPERVISOR_grant_table_op(unsigned int cmd, void *uop, unsigned int count)
396 return _hypercall3(int, grant_table_op, cmd, uop, count);
400 HYPERVISOR_update_va_mapping_otherdomain(unsigned long va, pte_t new_val,
401 unsigned long flags, domid_t domid)
403 if (sizeof(new_val) == sizeof(long))
404 return _hypercall4(int, update_va_mapping_otherdomain, va,
405 new_val.pte, flags, domid);
407 return _hypercall5(int, update_va_mapping_otherdomain, va,
408 new_val.pte, new_val.pte >> 32,
413 HYPERVISOR_vm_assist(unsigned int cmd, unsigned int type)
415 return _hypercall2(int, vm_assist, cmd, type);
419 HYPERVISOR_vcpu_op(int cmd, int vcpuid, void *extra_args)
421 return _hypercall3(int, vcpu_op, cmd, vcpuid, extra_args);
426 HYPERVISOR_set_segment_base(int reg, unsigned long value)
428 return _hypercall2(int, set_segment_base, reg, value);
433 HYPERVISOR_suspend(unsigned long start_info_mfn)
435 struct sched_shutdown r = { .reason = SHUTDOWN_suspend };
438 * For a PV guest the tools require that the start_info mfn be
439 * present in rdx/edx when the hypercall is made. Per the
440 * hypercall calling convention this is the third hypercall
441 * argument, which is start_info_mfn here.
443 return _hypercall3(int, sched_op, SCHEDOP_shutdown, &r, start_info_mfn);
447 HYPERVISOR_nmi_op(unsigned long op, unsigned long arg)
449 return _hypercall2(int, nmi_op, op, arg);
452 static inline unsigned long __must_check
453 HYPERVISOR_hvm_op(int op, void *arg)
455 return _hypercall2(unsigned long, hvm_op, op, arg);
462 return _hypercall1(int, tmem_op, op);
466 MULTI_fpu_taskswitch(struct multicall_entry *mcl, int set)
468 mcl->op = __HYPERVISOR_fpu_taskswitch;
473 MULTI_update_va_mapping(struct multicall_entry *mcl, unsigned long va,
474 pte_t new_val, unsigned long flags)
476 mcl->op = __HYPERVISOR_update_va_mapping;
478 if (sizeof(new_val) == sizeof(long)) {
479 mcl->args[1] = new_val.pte;
480 mcl->args[2] = flags;
482 mcl->args[1] = new_val.pte;
483 mcl->args[2] = new_val.pte >> 32;
484 mcl->args[3] = flags;
489 MULTI_grant_table_op(struct multicall_entry *mcl, unsigned int cmd,
490 void *uop, unsigned int count)
492 mcl->op = __HYPERVISOR_grant_table_op;
494 mcl->args[1] = (unsigned long)uop;
495 mcl->args[2] = count;
499 MULTI_update_va_mapping_otherdomain(struct multicall_entry *mcl, unsigned long va,
500 pte_t new_val, unsigned long flags,
503 mcl->op = __HYPERVISOR_update_va_mapping_otherdomain;
505 if (sizeof(new_val) == sizeof(long)) {
506 mcl->args[1] = new_val.pte;
507 mcl->args[2] = flags;
508 mcl->args[3] = domid;
510 mcl->args[1] = new_val.pte;
511 mcl->args[2] = new_val.pte >> 32;
512 mcl->args[3] = flags;
513 mcl->args[4] = domid;
518 MULTI_update_descriptor(struct multicall_entry *mcl, u64 maddr,
519 struct desc_struct desc)
521 mcl->op = __HYPERVISOR_update_descriptor;
522 if (sizeof(maddr) == sizeof(long)) {
523 mcl->args[0] = maddr;
524 mcl->args[1] = *(unsigned long *)&desc;
526 mcl->args[0] = maddr;
527 mcl->args[1] = maddr >> 32;
528 mcl->args[2] = desc.a;
529 mcl->args[3] = desc.b;
534 MULTI_memory_op(struct multicall_entry *mcl, unsigned int cmd, void *arg)
536 mcl->op = __HYPERVISOR_memory_op;
538 mcl->args[1] = (unsigned long)arg;
542 MULTI_mmu_update(struct multicall_entry *mcl, struct mmu_update *req,
543 int count, int *success_count, domid_t domid)
545 mcl->op = __HYPERVISOR_mmu_update;
546 mcl->args[0] = (unsigned long)req;
547 mcl->args[1] = count;
548 mcl->args[2] = (unsigned long)success_count;
549 mcl->args[3] = domid;
553 MULTI_mmuext_op(struct multicall_entry *mcl, struct mmuext_op *op, int count,
554 int *success_count, domid_t domid)
556 mcl->op = __HYPERVISOR_mmuext_op;
557 mcl->args[0] = (unsigned long)op;
558 mcl->args[1] = count;
559 mcl->args[2] = (unsigned long)success_count;
560 mcl->args[3] = domid;
564 MULTI_set_gdt(struct multicall_entry *mcl, unsigned long *frames, int entries)
566 mcl->op = __HYPERVISOR_set_gdt;
567 mcl->args[0] = (unsigned long)frames;
568 mcl->args[1] = entries;
572 MULTI_stack_switch(struct multicall_entry *mcl,
573 unsigned long ss, unsigned long esp)
575 mcl->op = __HYPERVISOR_stack_switch;
580 #endif /* _ASM_X86_XEN_HYPERCALL_H */