Loading...
1/* SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR MIT) */
2/******************************************************************************
3 * privcmd.h
4 *
5 * Interface to /proc/xen/privcmd.
6 *
7 * Copyright (c) 2003-2005, K A Fraser
8 *
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License version 2
11 * as published by the Free Software Foundation; or, when distributed
12 * separately from the Linux kernel or incorporated into other
13 * software packages, subject to the following license:
14 *
15 * Permission is hereby granted, free of charge, to any person obtaining a copy
16 * of this source file (the "Software"), to deal in the Software without
17 * restriction, including without limitation the rights to use, copy, modify,
18 * merge, publish, distribute, sublicense, and/or sell copies of the Software,
19 * and to permit persons to whom the Software is furnished to do so, subject to
20 * the following conditions:
21 *
22 * The above copyright notice and this permission notice shall be included in
23 * all copies or substantial portions of the Software.
24 *
25 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
26 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
27 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
28 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
29 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
30 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
31 * IN THE SOFTWARE.
32 */
33
34#ifndef __LINUX_PUBLIC_PRIVCMD_H__
35#define __LINUX_PUBLIC_PRIVCMD_H__
36
37#include <linux/types.h>
38#include <linux/compiler.h>
39#include <xen/interface/xen.h>
40
41struct privcmd_hypercall {
42 __u64 op;
43 __u64 arg[5];
44};
45
46struct privcmd_mmap_entry {
47 __u64 va;
48 /*
49 * This should be a GFN. It's not possible to change the name because
50 * it's exposed to the user-space.
51 */
52 __u64 mfn;
53 __u64 npages;
54};
55
56struct privcmd_mmap {
57 int num;
58 domid_t dom; /* target domain */
59 struct privcmd_mmap_entry __user *entry;
60};
61
62struct privcmd_mmapbatch {
63 int num; /* number of pages to populate */
64 domid_t dom; /* target domain */
65 __u64 addr; /* virtual address */
66 xen_pfn_t __user *arr; /* array of mfns - or'd with
67 PRIVCMD_MMAPBATCH_*_ERROR on err */
68};
69
70#define PRIVCMD_MMAPBATCH_MFN_ERROR 0xf0000000U
71#define PRIVCMD_MMAPBATCH_PAGED_ERROR 0x80000000U
72
73struct privcmd_mmapbatch_v2 {
74 unsigned int num; /* number of pages to populate */
75 domid_t dom; /* target domain */
76 __u64 addr; /* virtual address */
77 const xen_pfn_t __user *arr; /* array of mfns */
78 int __user *err; /* array of error codes */
79};
80
81struct privcmd_dm_op_buf {
82 void __user *uptr;
83 size_t size;
84};
85
86struct privcmd_dm_op {
87 domid_t dom;
88 __u16 num;
89 const struct privcmd_dm_op_buf __user *ubufs;
90};
91
92/*
93 * @cmd: IOCTL_PRIVCMD_HYPERCALL
94 * @arg: &privcmd_hypercall_t
95 * Return: Value returned from execution of the specified hypercall.
96 *
97 * @cmd: IOCTL_PRIVCMD_MMAPBATCH_V2
98 * @arg: &struct privcmd_mmapbatch_v2
99 * Return: 0 on success (i.e., arg->err contains valid error codes for
100 * each frame). On an error other than a failed frame remap, -1 is
101 * returned and errno is set to EINVAL, EFAULT etc. As an exception,
102 * if the operation was otherwise successful but any frame failed with
103 * -ENOENT, then -1 is returned and errno is set to ENOENT.
104 */
105#define IOCTL_PRIVCMD_HYPERCALL \
106 _IOC(_IOC_NONE, 'P', 0, sizeof(struct privcmd_hypercall))
107#define IOCTL_PRIVCMD_MMAP \
108 _IOC(_IOC_NONE, 'P', 2, sizeof(struct privcmd_mmap))
109#define IOCTL_PRIVCMD_MMAPBATCH \
110 _IOC(_IOC_NONE, 'P', 3, sizeof(struct privcmd_mmapbatch))
111#define IOCTL_PRIVCMD_MMAPBATCH_V2 \
112 _IOC(_IOC_NONE, 'P', 4, sizeof(struct privcmd_mmapbatch_v2))
113#define IOCTL_PRIVCMD_DM_OP \
114 _IOC(_IOC_NONE, 'P', 5, sizeof(struct privcmd_dm_op))
115#define IOCTL_PRIVCMD_RESTRICT \
116 _IOC(_IOC_NONE, 'P', 6, sizeof(domid_t))
117
118#endif /* __LINUX_PUBLIC_PRIVCMD_H__ */
1/******************************************************************************
2 * privcmd.h
3 *
4 * Interface to /proc/xen/privcmd.
5 *
6 * Copyright (c) 2003-2005, 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 __LINUX_PUBLIC_PRIVCMD_H__
34#define __LINUX_PUBLIC_PRIVCMD_H__
35
36#include <linux/types.h>
37#include <linux/compiler.h>
38#include <xen/interface/xen.h>
39
40struct privcmd_hypercall {
41 __u64 op;
42 __u64 arg[5];
43};
44
45struct privcmd_mmap_entry {
46 __u64 va;
47 /*
48 * This should be a GFN. It's not possible to change the name because
49 * it's exposed to the user-space.
50 */
51 __u64 mfn;
52 __u64 npages;
53};
54
55struct privcmd_mmap {
56 int num;
57 domid_t dom; /* target domain */
58 struct privcmd_mmap_entry __user *entry;
59};
60
61struct privcmd_mmapbatch {
62 int num; /* number of pages to populate */
63 domid_t dom; /* target domain */
64 __u64 addr; /* virtual address */
65 xen_pfn_t __user *arr; /* array of mfns - or'd with
66 PRIVCMD_MMAPBATCH_*_ERROR on err */
67};
68
69#define PRIVCMD_MMAPBATCH_MFN_ERROR 0xf0000000U
70#define PRIVCMD_MMAPBATCH_PAGED_ERROR 0x80000000U
71
72struct privcmd_mmapbatch_v2 {
73 unsigned int num; /* number of pages to populate */
74 domid_t dom; /* target domain */
75 __u64 addr; /* virtual address */
76 const xen_pfn_t __user *arr; /* array of mfns */
77 int __user *err; /* array of error codes */
78};
79
80/*
81 * @cmd: IOCTL_PRIVCMD_HYPERCALL
82 * @arg: &privcmd_hypercall_t
83 * Return: Value returned from execution of the specified hypercall.
84 *
85 * @cmd: IOCTL_PRIVCMD_MMAPBATCH_V2
86 * @arg: &struct privcmd_mmapbatch_v2
87 * Return: 0 on success (i.e., arg->err contains valid error codes for
88 * each frame). On an error other than a failed frame remap, -1 is
89 * returned and errno is set to EINVAL, EFAULT etc. As an exception,
90 * if the operation was otherwise successful but any frame failed with
91 * -ENOENT, then -1 is returned and errno is set to ENOENT.
92 */
93#define IOCTL_PRIVCMD_HYPERCALL \
94 _IOC(_IOC_NONE, 'P', 0, sizeof(struct privcmd_hypercall))
95#define IOCTL_PRIVCMD_MMAP \
96 _IOC(_IOC_NONE, 'P', 2, sizeof(struct privcmd_mmap))
97#define IOCTL_PRIVCMD_MMAPBATCH \
98 _IOC(_IOC_NONE, 'P', 3, sizeof(struct privcmd_mmapbatch))
99#define IOCTL_PRIVCMD_MMAPBATCH_V2 \
100 _IOC(_IOC_NONE, 'P', 4, sizeof(struct privcmd_mmapbatch_v2))
101
102#endif /* __LINUX_PUBLIC_PRIVCMD_H__ */