GNU Linux-libre 4.4.288-gnu1
[releases.git] / arch / x86 / include / asm / xen / hypercall.h
1 /******************************************************************************
2  * hypercall.h
3  *
4  * Linux-specific hypervisor handling.
5  *
6  * Copyright (c) 2002-2004, K A Fraser
7  *
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:
13  *
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:
20  *
21  * The above copyright notice and this permission notice shall be included in
22  * all copies or substantial portions of the Software.
23  *
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
30  * IN THE SOFTWARE.
31  */
32
33 #ifndef _ASM_X86_XEN_HYPERCALL_H
34 #define _ASM_X86_XEN_HYPERCALL_H
35
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>
41
42 #include <trace/events/xen.h>
43
44 #include <asm/page.h>
45 #include <asm/pgtable.h>
46 #include <asm/smap.h>
47 #include <asm/nospec-branch.h>
48
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>
54
55 /*
56  * The hypercall asms have to meet several constraints:
57  * - Work on 32- and 64-bit.
58  *    The two architectures put their arguments in different sets of
59  *    registers.
60  *
61  * - Work around asm syntax quirks
62  *    It isn't possible to specify one of the rNN registers in a
63  *    constraint, so we use explicit register variables to get the
64  *    args into the right place.
65  *
66  * - Mark all registers as potentially clobbered
67  *    Even unused parameters can be clobbered by the hypervisor, so we
68  *    need to make sure gcc knows it.
69  *
70  * - Avoid compiler bugs.
71  *    This is the tricky part.  Because x86_32 has such a constrained
72  *    register set, gcc versions below 4.3 have trouble generating
73  *    code when all the arg registers and memory are trashed by the
74  *    asm.  There are syntactically simpler ways of achieving the
75  *    semantics below, but they cause the compiler to crash.
76  *
77  *    The only combination I found which works is:
78  *     - assign the __argX variables first
79  *     - list all actually used parameters as "+r" (__argX)
80  *     - clobber the rest
81  *
82  * The result certainly isn't pretty, and it really shows up cpp's
83  * weakness as as macro language.  Sorry.  (But let's just give thanks
84  * there aren't more than 5 arguments...)
85  */
86
87 extern struct { char _entry[32]; } hypercall_page[];
88
89 #define __HYPERCALL             "call hypercall_page+%c[offset]"
90 #define __HYPERCALL_ENTRY(x)                                            \
91         [offset] "i" (__HYPERVISOR_##x * sizeof(hypercall_page[0]))
92
93 #ifdef CONFIG_X86_32
94 #define __HYPERCALL_RETREG      "eax"
95 #define __HYPERCALL_ARG1REG     "ebx"
96 #define __HYPERCALL_ARG2REG     "ecx"
97 #define __HYPERCALL_ARG3REG     "edx"
98 #define __HYPERCALL_ARG4REG     "esi"
99 #define __HYPERCALL_ARG5REG     "edi"
100 #else
101 #define __HYPERCALL_RETREG      "rax"
102 #define __HYPERCALL_ARG1REG     "rdi"
103 #define __HYPERCALL_ARG2REG     "rsi"
104 #define __HYPERCALL_ARG3REG     "rdx"
105 #define __HYPERCALL_ARG4REG     "r10"
106 #define __HYPERCALL_ARG5REG     "r8"
107 #endif
108
109 #define __HYPERCALL_DECLS                                               \
110         register unsigned long __res  asm(__HYPERCALL_RETREG);          \
111         register unsigned long __arg1 asm(__HYPERCALL_ARG1REG) = __arg1; \
112         register unsigned long __arg2 asm(__HYPERCALL_ARG2REG) = __arg2; \
113         register unsigned long __arg3 asm(__HYPERCALL_ARG3REG) = __arg3; \
114         register unsigned long __arg4 asm(__HYPERCALL_ARG4REG) = __arg4; \
115         register unsigned long __arg5 asm(__HYPERCALL_ARG5REG) = __arg5;
116
117 #define __HYPERCALL_0PARAM      "=r" (__res)
118 #define __HYPERCALL_1PARAM      __HYPERCALL_0PARAM, "+r" (__arg1)
119 #define __HYPERCALL_2PARAM      __HYPERCALL_1PARAM, "+r" (__arg2)
120 #define __HYPERCALL_3PARAM      __HYPERCALL_2PARAM, "+r" (__arg3)
121 #define __HYPERCALL_4PARAM      __HYPERCALL_3PARAM, "+r" (__arg4)
122 #define __HYPERCALL_5PARAM      __HYPERCALL_4PARAM, "+r" (__arg5)
123
124 #define __HYPERCALL_0ARG()
125 #define __HYPERCALL_1ARG(a1)                                            \
126         __HYPERCALL_0ARG()              __arg1 = (unsigned long)(a1);
127 #define __HYPERCALL_2ARG(a1,a2)                                         \
128         __HYPERCALL_1ARG(a1)            __arg2 = (unsigned long)(a2);
129 #define __HYPERCALL_3ARG(a1,a2,a3)                                      \
130         __HYPERCALL_2ARG(a1,a2)         __arg3 = (unsigned long)(a3);
131 #define __HYPERCALL_4ARG(a1,a2,a3,a4)                                   \
132         __HYPERCALL_3ARG(a1,a2,a3)      __arg4 = (unsigned long)(a4);
133 #define __HYPERCALL_5ARG(a1,a2,a3,a4,a5)                                \
134         __HYPERCALL_4ARG(a1,a2,a3,a4)   __arg5 = (unsigned long)(a5);
135
136 #define __HYPERCALL_CLOBBER5    "memory"
137 #define __HYPERCALL_CLOBBER4    __HYPERCALL_CLOBBER5, __HYPERCALL_ARG5REG
138 #define __HYPERCALL_CLOBBER3    __HYPERCALL_CLOBBER4, __HYPERCALL_ARG4REG
139 #define __HYPERCALL_CLOBBER2    __HYPERCALL_CLOBBER3, __HYPERCALL_ARG3REG
140 #define __HYPERCALL_CLOBBER1    __HYPERCALL_CLOBBER2, __HYPERCALL_ARG2REG
141 #define __HYPERCALL_CLOBBER0    __HYPERCALL_CLOBBER1, __HYPERCALL_ARG1REG
142
143 #define _hypercall0(type, name)                                         \
144 ({                                                                      \
145         __HYPERCALL_DECLS;                                              \
146         __HYPERCALL_0ARG();                                             \
147         asm volatile (__HYPERCALL                                       \
148                       : __HYPERCALL_0PARAM                              \
149                       : __HYPERCALL_ENTRY(name)                         \
150                       : __HYPERCALL_CLOBBER0);                          \
151         (type)__res;                                                    \
152 })
153
154 #define _hypercall1(type, name, a1)                                     \
155 ({                                                                      \
156         __HYPERCALL_DECLS;                                              \
157         __HYPERCALL_1ARG(a1);                                           \
158         asm volatile (__HYPERCALL                                       \
159                       : __HYPERCALL_1PARAM                              \
160                       : __HYPERCALL_ENTRY(name)                         \
161                       : __HYPERCALL_CLOBBER1);                          \
162         (type)__res;                                                    \
163 })
164
165 #define _hypercall2(type, name, a1, a2)                                 \
166 ({                                                                      \
167         __HYPERCALL_DECLS;                                              \
168         __HYPERCALL_2ARG(a1, a2);                                       \
169         asm volatile (__HYPERCALL                                       \
170                       : __HYPERCALL_2PARAM                              \
171                       : __HYPERCALL_ENTRY(name)                         \
172                       : __HYPERCALL_CLOBBER2);                          \
173         (type)__res;                                                    \
174 })
175
176 #define _hypercall3(type, name, a1, a2, a3)                             \
177 ({                                                                      \
178         __HYPERCALL_DECLS;                                              \
179         __HYPERCALL_3ARG(a1, a2, a3);                                   \
180         asm volatile (__HYPERCALL                                       \
181                       : __HYPERCALL_3PARAM                              \
182                       : __HYPERCALL_ENTRY(name)                         \
183                       : __HYPERCALL_CLOBBER3);                          \
184         (type)__res;                                                    \
185 })
186
187 #define _hypercall4(type, name, a1, a2, a3, a4)                         \
188 ({                                                                      \
189         __HYPERCALL_DECLS;                                              \
190         __HYPERCALL_4ARG(a1, a2, a3, a4);                               \
191         asm volatile (__HYPERCALL                                       \
192                       : __HYPERCALL_4PARAM                              \
193                       : __HYPERCALL_ENTRY(name)                         \
194                       : __HYPERCALL_CLOBBER4);                          \
195         (type)__res;                                                    \
196 })
197
198 #define _hypercall5(type, name, a1, a2, a3, a4, a5)                     \
199 ({                                                                      \
200         __HYPERCALL_DECLS;                                              \
201         __HYPERCALL_5ARG(a1, a2, a3, a4, a5);                           \
202         asm volatile (__HYPERCALL                                       \
203                       : __HYPERCALL_5PARAM                              \
204                       : __HYPERCALL_ENTRY(name)                         \
205                       : __HYPERCALL_CLOBBER5);                          \
206         (type)__res;                                                    \
207 })
208
209 static inline long
210 privcmd_call(unsigned call,
211              unsigned long a1, unsigned long a2,
212              unsigned long a3, unsigned long a4,
213              unsigned long a5)
214 {
215         __HYPERCALL_DECLS;
216         __HYPERCALL_5ARG(a1, a2, a3, a4, a5);
217
218         if (call >= PAGE_SIZE / sizeof(hypercall_page[0]))
219                 return -EINVAL;
220
221         stac();
222         asm volatile(CALL_NOSPEC
223                      : __HYPERCALL_5PARAM
224                      : [thunk_target] "a" (&hypercall_page[call])
225                      : __HYPERCALL_CLOBBER5);
226         clac();
227
228         return (long)__res;
229 }
230
231 static inline int
232 HYPERVISOR_set_trap_table(struct trap_info *table)
233 {
234         return _hypercall1(int, set_trap_table, table);
235 }
236
237 static inline int
238 HYPERVISOR_mmu_update(struct mmu_update *req, int count,
239                       int *success_count, domid_t domid)
240 {
241         return _hypercall4(int, mmu_update, req, count, success_count, domid);
242 }
243
244 static inline int
245 HYPERVISOR_mmuext_op(struct mmuext_op *op, int count,
246                      int *success_count, domid_t domid)
247 {
248         return _hypercall4(int, mmuext_op, op, count, success_count, domid);
249 }
250
251 static inline int
252 HYPERVISOR_set_gdt(unsigned long *frame_list, int entries)
253 {
254         return _hypercall2(int, set_gdt, frame_list, entries);
255 }
256
257 static inline int
258 HYPERVISOR_stack_switch(unsigned long ss, unsigned long esp)
259 {
260         return _hypercall2(int, stack_switch, ss, esp);
261 }
262
263 #ifdef CONFIG_X86_32
264 static inline int
265 HYPERVISOR_set_callbacks(unsigned long event_selector,
266                          unsigned long event_address,
267                          unsigned long failsafe_selector,
268                          unsigned long failsafe_address)
269 {
270         return _hypercall4(int, set_callbacks,
271                            event_selector, event_address,
272                            failsafe_selector, failsafe_address);
273 }
274 #else  /* CONFIG_X86_64 */
275 static inline int
276 HYPERVISOR_set_callbacks(unsigned long event_address,
277                         unsigned long failsafe_address,
278                         unsigned long syscall_address)
279 {
280         return _hypercall3(int, set_callbacks,
281                            event_address, failsafe_address,
282                            syscall_address);
283 }
284 #endif  /* CONFIG_X86_{32,64} */
285
286 static inline int
287 HYPERVISOR_callback_op(int cmd, void *arg)
288 {
289         return _hypercall2(int, callback_op, cmd, arg);
290 }
291
292 static inline int
293 HYPERVISOR_fpu_taskswitch(int set)
294 {
295         return _hypercall1(int, fpu_taskswitch, set);
296 }
297
298 static inline int
299 HYPERVISOR_sched_op(int cmd, void *arg)
300 {
301         return _hypercall2(int, sched_op, cmd, arg);
302 }
303
304 static inline long
305 HYPERVISOR_set_timer_op(u64 timeout)
306 {
307         unsigned long timeout_hi = (unsigned long)(timeout>>32);
308         unsigned long timeout_lo = (unsigned long)timeout;
309         return _hypercall2(long, set_timer_op, timeout_lo, timeout_hi);
310 }
311
312 static inline int
313 HYPERVISOR_mca(struct xen_mc *mc_op)
314 {
315         mc_op->interface_version = XEN_MCA_INTERFACE_VERSION;
316         return _hypercall1(int, mca, mc_op);
317 }
318
319 static inline int
320 HYPERVISOR_dom0_op(struct xen_platform_op *platform_op)
321 {
322         platform_op->interface_version = XENPF_INTERFACE_VERSION;
323         return _hypercall1(int, dom0_op, platform_op);
324 }
325
326 static inline int
327 HYPERVISOR_set_debugreg(int reg, unsigned long value)
328 {
329         return _hypercall2(int, set_debugreg, reg, value);
330 }
331
332 static inline unsigned long
333 HYPERVISOR_get_debugreg(int reg)
334 {
335         return _hypercall1(unsigned long, get_debugreg, reg);
336 }
337
338 static inline int
339 HYPERVISOR_update_descriptor(u64 ma, u64 desc)
340 {
341         if (sizeof(u64) == sizeof(long))
342                 return _hypercall2(int, update_descriptor, ma, desc);
343         return _hypercall4(int, update_descriptor, ma, ma>>32, desc, desc>>32);
344 }
345
346 static inline long
347 HYPERVISOR_memory_op(unsigned int cmd, void *arg)
348 {
349         return _hypercall2(long, memory_op, cmd, arg);
350 }
351
352 static inline int
353 HYPERVISOR_multicall(void *call_list, uint32_t nr_calls)
354 {
355         return _hypercall2(int, multicall, call_list, nr_calls);
356 }
357
358 static inline int
359 HYPERVISOR_update_va_mapping(unsigned long va, pte_t new_val,
360                              unsigned long flags)
361 {
362         if (sizeof(new_val) == sizeof(long))
363                 return _hypercall3(int, update_va_mapping, va,
364                                    new_val.pte, flags);
365         else
366                 return _hypercall4(int, update_va_mapping, va,
367                                    new_val.pte, new_val.pte >> 32, flags);
368 }
369 extern int __must_check xen_event_channel_op_compat(int, void *);
370
371 static inline int
372 HYPERVISOR_event_channel_op(int cmd, void *arg)
373 {
374         int rc = _hypercall2(int, event_channel_op, cmd, arg);
375         if (unlikely(rc == -ENOSYS))
376                 rc = xen_event_channel_op_compat(cmd, arg);
377         return rc;
378 }
379
380 static inline int
381 HYPERVISOR_xen_version(int cmd, void *arg)
382 {
383         return _hypercall2(int, xen_version, cmd, arg);
384 }
385
386 static inline int
387 HYPERVISOR_console_io(int cmd, int count, char *str)
388 {
389         return _hypercall3(int, console_io, cmd, count, str);
390 }
391
392 extern int __must_check xen_physdev_op_compat(int, void *);
393
394 static inline int
395 HYPERVISOR_physdev_op(int cmd, void *arg)
396 {
397         int rc = _hypercall2(int, physdev_op, cmd, arg);
398         if (unlikely(rc == -ENOSYS))
399                 rc = xen_physdev_op_compat(cmd, arg);
400         return rc;
401 }
402
403 static inline int
404 HYPERVISOR_grant_table_op(unsigned int cmd, void *uop, unsigned int count)
405 {
406         return _hypercall3(int, grant_table_op, cmd, uop, count);
407 }
408
409 static inline int
410 HYPERVISOR_update_va_mapping_otherdomain(unsigned long va, pte_t new_val,
411                                          unsigned long flags, domid_t domid)
412 {
413         if (sizeof(new_val) == sizeof(long))
414                 return _hypercall4(int, update_va_mapping_otherdomain, va,
415                                    new_val.pte, flags, domid);
416         else
417                 return _hypercall5(int, update_va_mapping_otherdomain, va,
418                                    new_val.pte, new_val.pte >> 32,
419                                    flags, domid);
420 }
421
422 static inline int
423 HYPERVISOR_vm_assist(unsigned int cmd, unsigned int type)
424 {
425         return _hypercall2(int, vm_assist, cmd, type);
426 }
427
428 static inline int
429 HYPERVISOR_vcpu_op(int cmd, int vcpuid, void *extra_args)
430 {
431         return _hypercall3(int, vcpu_op, cmd, vcpuid, extra_args);
432 }
433
434 #ifdef CONFIG_X86_64
435 static inline int
436 HYPERVISOR_set_segment_base(int reg, unsigned long value)
437 {
438         return _hypercall2(int, set_segment_base, reg, value);
439 }
440 #endif
441
442 static inline int
443 HYPERVISOR_suspend(unsigned long start_info_mfn)
444 {
445         struct sched_shutdown r = { .reason = SHUTDOWN_suspend };
446
447         /*
448          * For a PV guest the tools require that the start_info mfn be
449          * present in rdx/edx when the hypercall is made. Per the
450          * hypercall calling convention this is the third hypercall
451          * argument, which is start_info_mfn here.
452          */
453         return _hypercall3(int, sched_op, SCHEDOP_shutdown, &r, start_info_mfn);
454 }
455
456 static inline int
457 HYPERVISOR_nmi_op(unsigned long op, unsigned long arg)
458 {
459         return _hypercall2(int, nmi_op, op, arg);
460 }
461
462 static inline unsigned long __must_check
463 HYPERVISOR_hvm_op(int op, void *arg)
464 {
465        return _hypercall2(unsigned long, hvm_op, op, arg);
466 }
467
468 static inline int
469 HYPERVISOR_tmem_op(
470         struct tmem_op *op)
471 {
472         return _hypercall1(int, tmem_op, op);
473 }
474
475 static inline int
476 HYPERVISOR_xenpmu_op(unsigned int op, void *arg)
477 {
478         return _hypercall2(int, xenpmu_op, op, arg);
479 }
480
481 static inline void
482 MULTI_fpu_taskswitch(struct multicall_entry *mcl, int set)
483 {
484         mcl->op = __HYPERVISOR_fpu_taskswitch;
485         mcl->args[0] = set;
486
487         trace_xen_mc_entry(mcl, 1);
488 }
489
490 static inline void
491 MULTI_update_va_mapping(struct multicall_entry *mcl, unsigned long va,
492                         pte_t new_val, unsigned long flags)
493 {
494         mcl->op = __HYPERVISOR_update_va_mapping;
495         mcl->args[0] = va;
496         if (sizeof(new_val) == sizeof(long)) {
497                 mcl->args[1] = new_val.pte;
498                 mcl->args[2] = flags;
499         } else {
500                 mcl->args[1] = new_val.pte;
501                 mcl->args[2] = new_val.pte >> 32;
502                 mcl->args[3] = flags;
503         }
504
505         trace_xen_mc_entry(mcl, sizeof(new_val) == sizeof(long) ? 3 : 4);
506 }
507
508 static inline void
509 MULTI_grant_table_op(struct multicall_entry *mcl, unsigned int cmd,
510                      void *uop, unsigned int count)
511 {
512         mcl->op = __HYPERVISOR_grant_table_op;
513         mcl->args[0] = cmd;
514         mcl->args[1] = (unsigned long)uop;
515         mcl->args[2] = count;
516
517         trace_xen_mc_entry(mcl, 3);
518 }
519
520 static inline void
521 MULTI_update_va_mapping_otherdomain(struct multicall_entry *mcl, unsigned long va,
522                                     pte_t new_val, unsigned long flags,
523                                     domid_t domid)
524 {
525         mcl->op = __HYPERVISOR_update_va_mapping_otherdomain;
526         mcl->args[0] = va;
527         if (sizeof(new_val) == sizeof(long)) {
528                 mcl->args[1] = new_val.pte;
529                 mcl->args[2] = flags;
530                 mcl->args[3] = domid;
531         } else {
532                 mcl->args[1] = new_val.pte;
533                 mcl->args[2] = new_val.pte >> 32;
534                 mcl->args[3] = flags;
535                 mcl->args[4] = domid;
536         }
537
538         trace_xen_mc_entry(mcl, sizeof(new_val) == sizeof(long) ? 4 : 5);
539 }
540
541 static inline void
542 MULTI_update_descriptor(struct multicall_entry *mcl, u64 maddr,
543                         struct desc_struct desc)
544 {
545         mcl->op = __HYPERVISOR_update_descriptor;
546         if (sizeof(maddr) == sizeof(long)) {
547                 mcl->args[0] = maddr;
548                 mcl->args[1] = *(unsigned long *)&desc;
549         } else {
550                 mcl->args[0] = maddr;
551                 mcl->args[1] = maddr >> 32;
552                 mcl->args[2] = desc.a;
553                 mcl->args[3] = desc.b;
554         }
555
556         trace_xen_mc_entry(mcl, sizeof(maddr) == sizeof(long) ? 2 : 4);
557 }
558
559 static inline void
560 MULTI_memory_op(struct multicall_entry *mcl, unsigned int cmd, void *arg)
561 {
562         mcl->op = __HYPERVISOR_memory_op;
563         mcl->args[0] = cmd;
564         mcl->args[1] = (unsigned long)arg;
565
566         trace_xen_mc_entry(mcl, 2);
567 }
568
569 static inline void
570 MULTI_mmu_update(struct multicall_entry *mcl, struct mmu_update *req,
571                  int count, int *success_count, domid_t domid)
572 {
573         mcl->op = __HYPERVISOR_mmu_update;
574         mcl->args[0] = (unsigned long)req;
575         mcl->args[1] = count;
576         mcl->args[2] = (unsigned long)success_count;
577         mcl->args[3] = domid;
578
579         trace_xen_mc_entry(mcl, 4);
580 }
581
582 static inline void
583 MULTI_mmuext_op(struct multicall_entry *mcl, struct mmuext_op *op, int count,
584                 int *success_count, domid_t domid)
585 {
586         mcl->op = __HYPERVISOR_mmuext_op;
587         mcl->args[0] = (unsigned long)op;
588         mcl->args[1] = count;
589         mcl->args[2] = (unsigned long)success_count;
590         mcl->args[3] = domid;
591
592         trace_xen_mc_entry(mcl, 4);
593 }
594
595 static inline void
596 MULTI_set_gdt(struct multicall_entry *mcl, unsigned long *frames, int entries)
597 {
598         mcl->op = __HYPERVISOR_set_gdt;
599         mcl->args[0] = (unsigned long)frames;
600         mcl->args[1] = entries;
601
602         trace_xen_mc_entry(mcl, 2);
603 }
604
605 static inline void
606 MULTI_stack_switch(struct multicall_entry *mcl,
607                    unsigned long ss, unsigned long esp)
608 {
609         mcl->op = __HYPERVISOR_stack_switch;
610         mcl->args[0] = ss;
611         mcl->args[1] = esp;
612
613         trace_xen_mc_entry(mcl, 2);
614 }
615
616 #endif /* _ASM_X86_XEN_HYPERCALL_H */