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>
42 #include <trace/events/xen.h>
45 #include <asm/pgtable.h>
47 #include <asm/nospec-branch.h>
49 #include <xen/interface/xen.h>
50 #include <xen/interface/sched.h>
51 #include <xen/interface/physdev.h>
52 #include <xen/interface/platform.h>
53 #include <xen/interface/xen-mca.h>
58 * The hypercall asms have to meet several constraints:
59 * - Work on 32- and 64-bit.
60 * The two architectures put their arguments in different sets of
63 * - Work around asm syntax quirks
64 * It isn't possible to specify one of the rNN registers in a
65 * constraint, so we use explicit register variables to get the
66 * args into the right place.
68 * - Mark all registers as potentially clobbered
69 * Even unused parameters can be clobbered by the hypervisor, so we
70 * need to make sure gcc knows it.
72 * - Avoid compiler bugs.
73 * This is the tricky part. Because x86_32 has such a constrained
74 * register set, gcc versions below 4.3 have trouble generating
75 * code when all the arg registers and memory are trashed by the
76 * asm. There are syntactically simpler ways of achieving the
77 * semantics below, but they cause the compiler to crash.
79 * The only combination I found which works is:
80 * - assign the __argX variables first
81 * - list all actually used parameters as "+r" (__argX)
84 * The result certainly isn't pretty, and it really shows up cpp's
85 * weakness as as macro language. Sorry. (But let's just give thanks
86 * there aren't more than 5 arguments...)
89 extern struct { char _entry[32]; } hypercall_page[];
91 #define __HYPERCALL "call hypercall_page+%c[offset]"
92 #define __HYPERCALL_ENTRY(x) \
93 [offset] "i" (__HYPERVISOR_##x * sizeof(hypercall_page[0]))
96 #define __HYPERCALL_RETREG "eax"
97 #define __HYPERCALL_ARG1REG "ebx"
98 #define __HYPERCALL_ARG2REG "ecx"
99 #define __HYPERCALL_ARG3REG "edx"
100 #define __HYPERCALL_ARG4REG "esi"
101 #define __HYPERCALL_ARG5REG "edi"
103 #define __HYPERCALL_RETREG "rax"
104 #define __HYPERCALL_ARG1REG "rdi"
105 #define __HYPERCALL_ARG2REG "rsi"
106 #define __HYPERCALL_ARG3REG "rdx"
107 #define __HYPERCALL_ARG4REG "r10"
108 #define __HYPERCALL_ARG5REG "r8"
111 #define __HYPERCALL_DECLS \
112 register unsigned long __res asm(__HYPERCALL_RETREG); \
113 register unsigned long __arg1 asm(__HYPERCALL_ARG1REG) = __arg1; \
114 register unsigned long __arg2 asm(__HYPERCALL_ARG2REG) = __arg2; \
115 register unsigned long __arg3 asm(__HYPERCALL_ARG3REG) = __arg3; \
116 register unsigned long __arg4 asm(__HYPERCALL_ARG4REG) = __arg4; \
117 register unsigned long __arg5 asm(__HYPERCALL_ARG5REG) = __arg5;
119 #define __HYPERCALL_0PARAM "=r" (__res), ASM_CALL_CONSTRAINT
120 #define __HYPERCALL_1PARAM __HYPERCALL_0PARAM, "+r" (__arg1)
121 #define __HYPERCALL_2PARAM __HYPERCALL_1PARAM, "+r" (__arg2)
122 #define __HYPERCALL_3PARAM __HYPERCALL_2PARAM, "+r" (__arg3)
123 #define __HYPERCALL_4PARAM __HYPERCALL_3PARAM, "+r" (__arg4)
124 #define __HYPERCALL_5PARAM __HYPERCALL_4PARAM, "+r" (__arg5)
126 #define __HYPERCALL_0ARG()
127 #define __HYPERCALL_1ARG(a1) \
128 __HYPERCALL_0ARG() __arg1 = (unsigned long)(a1);
129 #define __HYPERCALL_2ARG(a1,a2) \
130 __HYPERCALL_1ARG(a1) __arg2 = (unsigned long)(a2);
131 #define __HYPERCALL_3ARG(a1,a2,a3) \
132 __HYPERCALL_2ARG(a1,a2) __arg3 = (unsigned long)(a3);
133 #define __HYPERCALL_4ARG(a1,a2,a3,a4) \
134 __HYPERCALL_3ARG(a1,a2,a3) __arg4 = (unsigned long)(a4);
135 #define __HYPERCALL_5ARG(a1,a2,a3,a4,a5) \
136 __HYPERCALL_4ARG(a1,a2,a3,a4) __arg5 = (unsigned long)(a5);
138 #define __HYPERCALL_CLOBBER5 "memory"
139 #define __HYPERCALL_CLOBBER4 __HYPERCALL_CLOBBER5, __HYPERCALL_ARG5REG
140 #define __HYPERCALL_CLOBBER3 __HYPERCALL_CLOBBER4, __HYPERCALL_ARG4REG
141 #define __HYPERCALL_CLOBBER2 __HYPERCALL_CLOBBER3, __HYPERCALL_ARG3REG
142 #define __HYPERCALL_CLOBBER1 __HYPERCALL_CLOBBER2, __HYPERCALL_ARG2REG
143 #define __HYPERCALL_CLOBBER0 __HYPERCALL_CLOBBER1, __HYPERCALL_ARG1REG
145 #define _hypercall0(type, name) \
148 __HYPERCALL_0ARG(); \
149 asm volatile (__HYPERCALL \
150 : __HYPERCALL_0PARAM \
151 : __HYPERCALL_ENTRY(name) \
152 : __HYPERCALL_CLOBBER0); \
156 #define _hypercall1(type, name, a1) \
159 __HYPERCALL_1ARG(a1); \
160 asm volatile (__HYPERCALL \
161 : __HYPERCALL_1PARAM \
162 : __HYPERCALL_ENTRY(name) \
163 : __HYPERCALL_CLOBBER1); \
167 #define _hypercall2(type, name, a1, a2) \
170 __HYPERCALL_2ARG(a1, a2); \
171 asm volatile (__HYPERCALL \
172 : __HYPERCALL_2PARAM \
173 : __HYPERCALL_ENTRY(name) \
174 : __HYPERCALL_CLOBBER2); \
178 #define _hypercall3(type, name, a1, a2, a3) \
181 __HYPERCALL_3ARG(a1, a2, a3); \
182 asm volatile (__HYPERCALL \
183 : __HYPERCALL_3PARAM \
184 : __HYPERCALL_ENTRY(name) \
185 : __HYPERCALL_CLOBBER3); \
189 #define _hypercall4(type, name, a1, a2, a3, a4) \
192 __HYPERCALL_4ARG(a1, a2, a3, a4); \
193 asm volatile (__HYPERCALL \
194 : __HYPERCALL_4PARAM \
195 : __HYPERCALL_ENTRY(name) \
196 : __HYPERCALL_CLOBBER4); \
200 #define _hypercall5(type, name, a1, a2, a3, a4, a5) \
203 __HYPERCALL_5ARG(a1, a2, a3, a4, a5); \
204 asm volatile (__HYPERCALL \
205 : __HYPERCALL_5PARAM \
206 : __HYPERCALL_ENTRY(name) \
207 : __HYPERCALL_CLOBBER5); \
212 privcmd_call(unsigned call,
213 unsigned long a1, unsigned long a2,
214 unsigned long a3, unsigned long a4,
218 __HYPERCALL_5ARG(a1, a2, a3, a4, a5);
220 if (call >= PAGE_SIZE / sizeof(hypercall_page[0]))
224 asm volatile(CALL_NOSPEC
226 : [thunk_target] "a" (&hypercall_page[call])
227 : __HYPERCALL_CLOBBER5);
234 HYPERVISOR_set_trap_table(struct trap_info *table)
236 return _hypercall1(int, set_trap_table, table);
240 HYPERVISOR_mmu_update(struct mmu_update *req, int count,
241 int *success_count, domid_t domid)
243 return _hypercall4(int, mmu_update, req, count, success_count, domid);
247 HYPERVISOR_mmuext_op(struct mmuext_op *op, int count,
248 int *success_count, domid_t domid)
250 return _hypercall4(int, mmuext_op, op, count, success_count, domid);
254 HYPERVISOR_set_gdt(unsigned long *frame_list, int entries)
256 return _hypercall2(int, set_gdt, frame_list, entries);
260 HYPERVISOR_stack_switch(unsigned long ss, unsigned long esp)
262 return _hypercall2(int, stack_switch, ss, esp);
267 HYPERVISOR_set_callbacks(unsigned long event_selector,
268 unsigned long event_address,
269 unsigned long failsafe_selector,
270 unsigned long failsafe_address)
272 return _hypercall4(int, set_callbacks,
273 event_selector, event_address,
274 failsafe_selector, failsafe_address);
276 #else /* CONFIG_X86_64 */
278 HYPERVISOR_set_callbacks(unsigned long event_address,
279 unsigned long failsafe_address,
280 unsigned long syscall_address)
282 return _hypercall3(int, set_callbacks,
283 event_address, failsafe_address,
286 #endif /* CONFIG_X86_{32,64} */
289 HYPERVISOR_callback_op(int cmd, void *arg)
291 return _hypercall2(int, callback_op, cmd, arg);
295 HYPERVISOR_fpu_taskswitch(int set)
297 return _hypercall1(int, fpu_taskswitch, set);
301 HYPERVISOR_sched_op(int cmd, void *arg)
303 return _hypercall2(int, sched_op, cmd, arg);
307 HYPERVISOR_set_timer_op(u64 timeout)
309 unsigned long timeout_hi = (unsigned long)(timeout>>32);
310 unsigned long timeout_lo = (unsigned long)timeout;
311 return _hypercall2(long, set_timer_op, timeout_lo, timeout_hi);
315 HYPERVISOR_mca(struct xen_mc *mc_op)
317 mc_op->interface_version = XEN_MCA_INTERFACE_VERSION;
318 return _hypercall1(int, mca, mc_op);
322 HYPERVISOR_platform_op(struct xen_platform_op *op)
324 op->interface_version = XENPF_INTERFACE_VERSION;
325 return _hypercall1(int, platform_op, op);
329 HYPERVISOR_set_debugreg(int reg, unsigned long value)
331 return _hypercall2(int, set_debugreg, reg, value);
334 static inline unsigned long
335 HYPERVISOR_get_debugreg(int reg)
337 return _hypercall1(unsigned long, get_debugreg, reg);
341 HYPERVISOR_update_descriptor(u64 ma, u64 desc)
343 if (sizeof(u64) == sizeof(long))
344 return _hypercall2(int, update_descriptor, ma, desc);
345 return _hypercall4(int, update_descriptor, ma, ma>>32, desc, desc>>32);
349 HYPERVISOR_memory_op(unsigned int cmd, void *arg)
351 return _hypercall2(long, memory_op, cmd, arg);
355 HYPERVISOR_multicall(void *call_list, uint32_t nr_calls)
357 return _hypercall2(int, multicall, call_list, nr_calls);
361 HYPERVISOR_update_va_mapping(unsigned long va, pte_t new_val,
364 if (sizeof(new_val) == sizeof(long))
365 return _hypercall3(int, update_va_mapping, va,
368 return _hypercall4(int, update_va_mapping, va,
369 new_val.pte, new_val.pte >> 32, flags);
371 extern int __must_check xen_event_channel_op_compat(int, void *);
374 HYPERVISOR_event_channel_op(int cmd, void *arg)
376 int rc = _hypercall2(int, event_channel_op, cmd, arg);
377 if (unlikely(rc == -ENOSYS))
378 rc = xen_event_channel_op_compat(cmd, arg);
383 HYPERVISOR_xen_version(int cmd, void *arg)
385 return _hypercall2(int, xen_version, cmd, arg);
389 HYPERVISOR_console_io(int cmd, int count, char *str)
391 return _hypercall3(int, console_io, cmd, count, str);
394 extern int __must_check xen_physdev_op_compat(int, void *);
397 HYPERVISOR_physdev_op(int cmd, void *arg)
399 int rc = _hypercall2(int, physdev_op, cmd, arg);
400 if (unlikely(rc == -ENOSYS))
401 rc = xen_physdev_op_compat(cmd, arg);
406 HYPERVISOR_grant_table_op(unsigned int cmd, void *uop, unsigned int count)
408 return _hypercall3(int, grant_table_op, cmd, uop, count);
412 HYPERVISOR_update_va_mapping_otherdomain(unsigned long va, pte_t new_val,
413 unsigned long flags, domid_t domid)
415 if (sizeof(new_val) == sizeof(long))
416 return _hypercall4(int, update_va_mapping_otherdomain, va,
417 new_val.pte, flags, domid);
419 return _hypercall5(int, update_va_mapping_otherdomain, va,
420 new_val.pte, new_val.pte >> 32,
425 HYPERVISOR_vm_assist(unsigned int cmd, unsigned int type)
427 return _hypercall2(int, vm_assist, cmd, type);
431 HYPERVISOR_vcpu_op(int cmd, int vcpuid, void *extra_args)
433 return _hypercall3(int, vcpu_op, cmd, vcpuid, extra_args);
438 HYPERVISOR_set_segment_base(int reg, unsigned long value)
440 return _hypercall2(int, set_segment_base, reg, value);
445 HYPERVISOR_suspend(unsigned long start_info_mfn)
447 struct sched_shutdown r = { .reason = SHUTDOWN_suspend };
450 * For a PV guest the tools require that the start_info mfn be
451 * present in rdx/edx when the hypercall is made. Per the
452 * hypercall calling convention this is the third hypercall
453 * argument, which is start_info_mfn here.
455 return _hypercall3(int, sched_op, SCHEDOP_shutdown, &r, start_info_mfn);
459 HYPERVISOR_nmi_op(unsigned long op, unsigned long arg)
461 return _hypercall2(int, nmi_op, op, arg);
464 static inline unsigned long __must_check
465 HYPERVISOR_hvm_op(int op, void *arg)
467 return _hypercall2(unsigned long, hvm_op, op, arg);
474 return _hypercall1(int, tmem_op, op);
478 HYPERVISOR_xenpmu_op(unsigned int op, void *arg)
480 return _hypercall2(int, xenpmu_op, op, arg);
485 domid_t dom, unsigned int nr_bufs, struct xen_dm_op_buf *bufs)
489 ret = _hypercall3(int, dm_op, dom, nr_bufs, bufs);
495 MULTI_fpu_taskswitch(struct multicall_entry *mcl, int set)
497 mcl->op = __HYPERVISOR_fpu_taskswitch;
500 trace_xen_mc_entry(mcl, 1);
504 MULTI_update_va_mapping(struct multicall_entry *mcl, unsigned long va,
505 pte_t new_val, unsigned long flags)
507 mcl->op = __HYPERVISOR_update_va_mapping;
509 if (sizeof(new_val) == sizeof(long)) {
510 mcl->args[1] = new_val.pte;
511 mcl->args[2] = flags;
513 mcl->args[1] = new_val.pte;
514 mcl->args[2] = new_val.pte >> 32;
515 mcl->args[3] = flags;
518 trace_xen_mc_entry(mcl, sizeof(new_val) == sizeof(long) ? 3 : 4);
522 MULTI_grant_table_op(struct multicall_entry *mcl, unsigned int cmd,
523 void *uop, unsigned int count)
525 mcl->op = __HYPERVISOR_grant_table_op;
527 mcl->args[1] = (unsigned long)uop;
528 mcl->args[2] = count;
530 trace_xen_mc_entry(mcl, 3);
534 MULTI_update_va_mapping_otherdomain(struct multicall_entry *mcl, unsigned long va,
535 pte_t new_val, unsigned long flags,
538 mcl->op = __HYPERVISOR_update_va_mapping_otherdomain;
540 if (sizeof(new_val) == sizeof(long)) {
541 mcl->args[1] = new_val.pte;
542 mcl->args[2] = flags;
543 mcl->args[3] = domid;
545 mcl->args[1] = new_val.pte;
546 mcl->args[2] = new_val.pte >> 32;
547 mcl->args[3] = flags;
548 mcl->args[4] = domid;
551 trace_xen_mc_entry(mcl, sizeof(new_val) == sizeof(long) ? 4 : 5);
555 MULTI_update_descriptor(struct multicall_entry *mcl, u64 maddr,
556 struct desc_struct desc)
558 mcl->op = __HYPERVISOR_update_descriptor;
559 if (sizeof(maddr) == sizeof(long)) {
560 mcl->args[0] = maddr;
561 mcl->args[1] = *(unsigned long *)&desc;
563 u32 *p = (u32 *)&desc;
565 mcl->args[0] = maddr;
566 mcl->args[1] = maddr >> 32;
571 trace_xen_mc_entry(mcl, sizeof(maddr) == sizeof(long) ? 2 : 4);
575 MULTI_memory_op(struct multicall_entry *mcl, unsigned int cmd, void *arg)
577 mcl->op = __HYPERVISOR_memory_op;
579 mcl->args[1] = (unsigned long)arg;
581 trace_xen_mc_entry(mcl, 2);
585 MULTI_mmu_update(struct multicall_entry *mcl, struct mmu_update *req,
586 int count, int *success_count, domid_t domid)
588 mcl->op = __HYPERVISOR_mmu_update;
589 mcl->args[0] = (unsigned long)req;
590 mcl->args[1] = count;
591 mcl->args[2] = (unsigned long)success_count;
592 mcl->args[3] = domid;
594 trace_xen_mc_entry(mcl, 4);
598 MULTI_mmuext_op(struct multicall_entry *mcl, struct mmuext_op *op, int count,
599 int *success_count, domid_t domid)
601 mcl->op = __HYPERVISOR_mmuext_op;
602 mcl->args[0] = (unsigned long)op;
603 mcl->args[1] = count;
604 mcl->args[2] = (unsigned long)success_count;
605 mcl->args[3] = domid;
607 trace_xen_mc_entry(mcl, 4);
611 MULTI_set_gdt(struct multicall_entry *mcl, unsigned long *frames, int entries)
613 mcl->op = __HYPERVISOR_set_gdt;
614 mcl->args[0] = (unsigned long)frames;
615 mcl->args[1] = entries;
617 trace_xen_mc_entry(mcl, 2);
621 MULTI_stack_switch(struct multicall_entry *mcl,
622 unsigned long ss, unsigned long esp)
624 mcl->op = __HYPERVISOR_stack_switch;
628 trace_xen_mc_entry(mcl, 2);
631 #endif /* _ASM_X86_XEN_HYPERCALL_H */