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