[linux-2.6-block.git] / include / uapi / xen / privcmd.h

/* SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR MIT) */
/******************************************************************************
 * privcmd.h
 *
 * Interface to /proc/xen/privcmd.
 *
 * Copyright (c) 2003-2005, K A Fraser
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License version 2
 * as published by the Free Software Foundation; or, when distributed
 * separately from the Linux kernel or incorporated into other
 * software packages, subject to the following license:
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this source file (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use, copy, modify,
 * merge, publish, distribute, sublicense, and/or sell copies of the Software,
 * and to permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 */

#ifndef __LINUX_PUBLIC_PRIVCMD_H__
#define __LINUX_PUBLIC_PRIVCMD_H__

#include <linux/types.h>
#include <linux/compiler.h>
#include <xen/interface/xen.h>

struct privcmd_hypercall {
	__u64 op;
	__u64 arg[5];
};

struct privcmd_mmap_entry {
	__u64 va;
	/*
	 * This should be a GFN. It's not possible to change the name because
	 * it's exposed to the user-space.
	 */
	__u64 mfn;
	__u64 npages;
};

struct privcmd_mmap {
	int num;
	domid_t dom; /* target domain */
	struct privcmd_mmap_entry __user *entry;
};

struct privcmd_mmapbatch {
	int num;     /* number of pages to populate */
	domid_t dom; /* target domain */
	__u64 addr;  /* virtual address */
	xen_pfn_t __user *arr; /* array of mfns - or'd with
				  PRIVCMD_MMAPBATCH_*_ERROR on err */
};

#define PRIVCMD_MMAPBATCH_MFN_ERROR     0xf0000000U
#define PRIVCMD_MMAPBATCH_PAGED_ERROR   0x80000000U

struct privcmd_mmapbatch_v2 {
	unsigned int num; /* number of pages to populate */
	domid_t dom;      /* target domain */
	__u64 addr;       /* virtual address */
	const xen_pfn_t __user *arr; /* array of mfns */
	int __user *err;  /* array of error codes */
};

struct privcmd_dm_op_buf {
	void __user *uptr;
	size_t size;
};

struct privcmd_dm_op {
	domid_t dom;
	__u16 num;
	const struct privcmd_dm_op_buf __user *ubufs;
};

struct privcmd_mmap_resource {
	domid_t dom;
	__u32 type;
	__u32 id;
	__u32 idx;
	__u64 num;
	__u64 addr;
};

/*
 * @cmd: IOCTL_PRIVCMD_HYPERCALL
 * @arg: &privcmd_hypercall_t
 * Return: Value returned from execution of the specified hypercall.
 *
 * @cmd: IOCTL_PRIVCMD_MMAPBATCH_V2
 * @arg: &struct privcmd_mmapbatch_v2
 * Return: 0 on success (i.e., arg->err contains valid error codes for
 * each frame).  On an error other than a failed frame remap, -1 is
 * returned and errno is set to EINVAL, EFAULT etc.  As an exception,
 * if the operation was otherwise successful but any frame failed with
 * -ENOENT, then -1 is returned and errno is set to ENOENT.
 */
#define IOCTL_PRIVCMD_HYPERCALL					\
	_IOC(_IOC_NONE, 'P', 0, sizeof(struct privcmd_hypercall))
#define IOCTL_PRIVCMD_MMAP					\
	_IOC(_IOC_NONE, 'P', 2, sizeof(struct privcmd_mmap))
#define IOCTL_PRIVCMD_MMAPBATCH					\
	_IOC(_IOC_NONE, 'P', 3, sizeof(struct privcmd_mmapbatch))
#define IOCTL_PRIVCMD_MMAPBATCH_V2				\
	_IOC(_IOC_NONE, 'P', 4, sizeof(struct privcmd_mmapbatch_v2))
#define IOCTL_PRIVCMD_DM_OP					\
	_IOC(_IOC_NONE, 'P', 5, sizeof(struct privcmd_dm_op))
#define IOCTL_PRIVCMD_RESTRICT					\
	_IOC(_IOC_NONE, 'P', 6, sizeof(domid_t))
#define IOCTL_PRIVCMD_MMAP_RESOURCE				\
	_IOC(_IOC_NONE, 'P', 7, sizeof(struct privcmd_mmap_resource))

#endif /* __LINUX_PUBLIC_PRIVCMD_H__ */
Commit	Line	Data
e2be04c7	1	/* SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR MIT) */
1c5de193 JF	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>
744f9f10	38	#include <linux/compiler.h>
4d9310e3	39	#include <xen/interface/xen.h>
1c5de193	40
1c5de193 JF	41	struct privcmd_hypercall {
	42	__u64 op;
	43	__u64 arg[5];
	44	};
	45
	46	struct privcmd_mmap_entry {
	47	__u64 va;
a13d7201 JG	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	*/
1c5de193 JF	52	__u64 mfn;
	53	__u64 npages;
	54	};
	55
	56	struct privcmd_mmap {
	57	int num;
	58	domid_t dom; /* target domain */
	59	struct privcmd_mmap_entry __user *entry;
	60	};
	61
	62	struct privcmd_mmapbatch {
	63	int num; /* number of pages to populate */
	64	domid_t dom; /* target domain */
	65	__u64 addr; /* virtual address */
ceb90fa0 ALC	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
	73	struct 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 */
1c5de193 JF	79	};
1c5de193 JF	80
ab520be8 PD	81	struct privcmd_dm_op_buf {
	82	void __user *uptr;
	83	size_t size;
	84	};
	85
	86	struct privcmd_dm_op {
	87	domid_t dom;
	88	__u16 num;
	89	const struct privcmd_dm_op_buf __user *ubufs;
	90	};
	91
3ad08765 PD	92	struct privcmd_mmap_resource {
	93	domid_t dom;
	94	__u32 type;
	95	__u32 id;
	96	__u32 idx;
	97	__u64 num;
	98	__u64 addr;
	99	};
	100
1c5de193 JF	101	/*
	102	* @cmd: IOCTL_PRIVCMD_HYPERCALL
	103	* @arg: &privcmd_hypercall_t
	104	* Return: Value returned from execution of the specified hypercall.
ceb90fa0 ALC	105	*
	106	* @cmd: IOCTL_PRIVCMD_MMAPBATCH_V2
	107	* @arg: &struct privcmd_mmapbatch_v2
	108	* Return: 0 on success (i.e., arg->err contains valid error codes for
	109	* each frame). On an error other than a failed frame remap, -1 is
	110	* returned and errno is set to EINVAL, EFAULT etc. As an exception,
	111	* if the operation was otherwise successful but any frame failed with
	112	* -ENOENT, then -1 is returned and errno is set to ENOENT.
1c5de193 JF	113	*/
	114	#define IOCTL_PRIVCMD_HYPERCALL \
	115	_IOC(_IOC_NONE, 'P', 0, sizeof(struct privcmd_hypercall))
	116	#define IOCTL_PRIVCMD_MMAP \
	117	_IOC(_IOC_NONE, 'P', 2, sizeof(struct privcmd_mmap))
	118	#define IOCTL_PRIVCMD_MMAPBATCH \
	119	_IOC(_IOC_NONE, 'P', 3, sizeof(struct privcmd_mmapbatch))
ceb90fa0 ALC	120	#define IOCTL_PRIVCMD_MMAPBATCH_V2 \
ceb90fa0 ALC	121	_IOC(_IOC_NONE, 'P', 4, sizeof(struct privcmd_mmapbatch_v2))
ab520be8 PD	122	#define IOCTL_PRIVCMD_DM_OP \
ab520be8 PD	123	_IOC(_IOC_NONE, 'P', 5, sizeof(struct privcmd_dm_op))
4610d240 PD	124	#define IOCTL_PRIVCMD_RESTRICT \
4610d240 PD	125	_IOC(_IOC_NONE, 'P', 6, sizeof(domid_t))
3ad08765 PD	126	#define IOCTL_PRIVCMD_MMAP_RESOURCE \
3ad08765 PD	127	_IOC(_IOC_NONE, 'P', 7, sizeof(struct privcmd_mmap_resource))
1c5de193 JF	128
1c5de193 JF	129	#endif /* __LINUX_PUBLIC_PRIVCMD_H__ */