[apple/xnu.git] / bsd / sys / vnioctl.h

/*
 * Copyright (c) 1988 University of Utah.
 * Copyright (c) 1990, 1993
 *	The Regents of the University of California.  All rights reserved.
 *
 * This code is derived from software contributed to Berkeley by
 * the Systems Programming Group of the University of Utah Computer
 * Science Department.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *	This product includes software developed by the University of
 *	California, Berkeley and its contributors.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * from: Utah $Hdr: fdioctl.h 1.1 90/07/09$
 *
 *	@(#)vnioctl.h	8.1 (Berkeley) 6/10/93
 *
 * $FreeBSD: src/sys/sys/vnioctl.h,v 1.4 1999/09/17 05:33:58 dillon Exp $
 */

#ifndef _SYS_VNIOCTL_H_
#define _SYS_VNIOCTL_H_

#include <sys/appleapiopts.h>

#ifdef KERNEL_PRIVATE

#ifdef __APPLE_API_PRIVATE
/*
 * Ioctl definitions for file (vnode) disk pseudo-device.
 */

#define _PATH_VNTAB	"/etc/vntab"	/* default config file */

typedef enum {
	vncontrol_readwrite_io_e = 0,
} vncontrol_t;

struct vn_ioctl {
	char *		vn_file;	/* pathname of file to mount */
	int		vn_size;	/* (returned) size of disk */
	vncontrol_t	vn_control;
};

/*
 * Before you can use a unit, it must be configured with VNIOCSET.
 * The configuration persists across opens and closes of the device;
 * an VNIOCCLR must be used to reset a configuration.  An attempt to
 * VNIOCSET an already active unit will return EBUSY.
 */
#define VNIOCATTACH	_IOWR('F', 0, struct vn_ioctl)	/* attach file */
#define VNIOCDETACH	_IOWR('F', 1, struct vn_ioctl)	/* detach disk */
#define VNIOCGSET	_IOWR('F', 2, u_long )		/* set global option */
#define VNIOCGCLEAR	_IOWR('F', 3, u_long )		/* reset --//-- */
#define VNIOCUSET	_IOWR('F', 4, u_long )		/* set unit option */
#define VNIOCUCLEAR	_IOWR('F', 5, u_long )		/* reset --//-- */
#define VNIOCSHADOW	_IOWR('F', 6, struct vn_ioctl)	/* attach shadow */

#define VN_LABELS	0x1	/* Use disk(/slice) labels */
#define VN_FOLLOW	0x2	/* Debug flow in vn driver */
#define VN_DEBUG	0x4	/* Debug data in vn driver */
#define VN_IO		0x8	/* Debug I/O in vn driver */
#define VN_DONTCLUSTER	0x10	/* Don't cluster */
#define VN_RESERVE	0x20	/* Pre-reserve swap */

#endif /* __APPLE_API_PRIVATE */

#endif /* KERNEL_PRIVATE */

#endif	/* _SYS_VNIOCTL_H_*/
Commit	Line	Data
1c79356b	1	/*
9bccf70c	2	* Copyright (c) 1988 University of Utah.
1c79356b A	3	* Copyright (c) 1990, 1993
	4	* The Regents of the University of California. All rights reserved.
	5	*
	6	* This code is derived from software contributed to Berkeley by
9bccf70c A	7	* the Systems Programming Group of the University of Utah Computer
9bccf70c A	8	* Science Department.
1c79356b A	9	*
	10	* Redistribution and use in source and binary forms, with or without
	11	* modification, are permitted provided that the following conditions
	12	* are met:
	13	* 1. Redistributions of source code must retain the above copyright
	14	* notice, this list of conditions and the following disclaimer.
	15	* 2. Redistributions in binary form must reproduce the above copyright
	16	* notice, this list of conditions and the following disclaimer in the
	17	* documentation and/or other materials provided with the distribution.
	18	* 3. All advertising materials mentioning features or use of this software
	19	* must display the following acknowledgement:
	20	* This product includes software developed by the University of
	21	* California, Berkeley and its contributors.
	22	* 4. Neither the name of the University nor the names of its contributors
	23	* may be used to endorse or promote products derived from this software
	24	* without specific prior written permission.
	25	*
	26	* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	27	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	28	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	29	* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	30	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	31	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	32	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	33	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	34	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	35	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	36	* SUCH DAMAGE.
	37	*
9bccf70c A	38	* from: Utah $Hdr: fdioctl.h 1.1 90/07/09$
	39	*
	40	* @(#)vnioctl.h 8.1 (Berkeley) 6/10/93
	41	*
	42	* $FreeBSD: src/sys/sys/vnioctl.h,v 1.4 1999/09/17 05:33:58 dillon Exp $
1c79356b A	43	*/
1c79356b A	44
9bccf70c A	45	#ifndef _SYS_VNIOCTL_H_
	46	#define _SYS_VNIOCTL_H_
	47
	48	#include <sys/appleapiopts.h>
	49
	50	#ifdef KERNEL_PRIVATE
	51
	52	#ifdef __APPLE_API_PRIVATE
	53	/*
	54	* Ioctl definitions for file (vnode) disk pseudo-device.
	55	*/
1c79356b	56
9bccf70c	57	#define _PATH_VNTAB "/etc/vntab" /* default config file */
1c79356b	58
9bccf70c A	59	typedef enum {
	60	vncontrol_readwrite_io_e = 0,
	61	} vncontrol_t;
1c79356b	62
9bccf70c A	63	struct vn_ioctl {
	64	char * vn_file; /* pathname of file to mount */
	65	int vn_size; /* (returned) size of disk */
	66	vncontrol_t vn_control;
	67	};
1c79356b A	68
1c79356b A	69	/*
9bccf70c A	70	* Before you can use a unit, it must be configured with VNIOCSET.
	71	* The configuration persists across opens and closes of the device;
	72	* an VNIOCCLR must be used to reset a configuration. An attempt to
	73	* VNIOCSET an already active unit will return EBUSY.
1c79356b	74	*/
9bccf70c A	75	#define VNIOCATTACH _IOWR('F', 0, struct vn_ioctl) /* attach file */
	76	#define VNIOCDETACH _IOWR('F', 1, struct vn_ioctl) /* detach disk */
	77	#define VNIOCGSET _IOWR('F', 2, u_long ) /* set global option */
	78	#define VNIOCGCLEAR _IOWR('F', 3, u_long ) /* reset --//-- */
	79	#define VNIOCUSET _IOWR('F', 4, u_long ) /* set unit option */
	80	#define VNIOCUCLEAR _IOWR('F', 5, u_long ) /* reset --//-- */
	81	#define VNIOCSHADOW _IOWR('F', 6, struct vn_ioctl) /* attach shadow */
1c79356b	82
9bccf70c A	83	#define VN_LABELS 0x1 /* Use disk(/slice) labels */
	84	#define VN_FOLLOW 0x2 /* Debug flow in vn driver */
	85	#define VN_DEBUG 0x4 /* Debug data in vn driver */
	86	#define VN_IO 0x8 /* Debug I/O in vn driver */
	87	#define VN_DONTCLUSTER 0x10 /* Don't cluster */
	88	#define VN_RESERVE 0x20 /* Pre-reserve swap */
1c79356b	89
9bccf70c	90	#endif /* __APPLE_API_PRIVATE */
1c79356b	91
d7e50217	92	#endif /* KERNEL_PRIVATE */
1c79356b	93
9bccf70c	94	#endif /* _SYS_VNIOCTL_H_*/