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

/*
 * Copyright (c) 2004-2005 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * The contents of this file constitute Original Code as defined in and
 * are subject to the Apple Public Source License Version 1.1 (the
 * "License").  You may not use this file except in compliance with the
 * License.  Please obtain a copy of the License at
 * http://www.apple.com/publicsource and read it before using this file.
 * 
 * This Original Code and all software distributed under the License are
 * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
 * License for the specific language governing rights and limitations
 * under the License.
 * 
 * @APPLE_LICENSE_HEADER_END@
 */
/*
 * 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>
#include <sys/cdefs.h>


/*
 * 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;
};

#ifdef KERNEL_PRIVATE

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

#endif /* KERNEL_PRIVATE */

/*
 * 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_int32_t )		/* set global option */
#define VNIOCGCLEAR	_IOWR('F', 3, u_int32_t )		/* reset --//-- */
#define VNIOCUSET	_IOWR('F', 4, u_int32_t )		/* set unit option */
#define VNIOCUCLEAR	_IOWR('F', 5, u_int32_t )		/* reset --//-- */
#define VNIOCSHADOW	_IOWR('F', 6, struct vn_ioctl)	/* attach shadow */
#ifdef KERNEL_PRIVATE
#define VNIOCATTACH64	_IOWR('F', 0, struct user_vn_ioctl)	/* attach file - LP64 */
#define VNIOCDETACH64	_IOWR('F', 1, struct user_vn_ioctl)	/* detach disk - LP64 */
#define VNIOCSHADOW64	_IOWR('F', 6, struct user_vn_ioctl)	/* attach shadow - LP64 */
#endif /* KERNEL_PRIVATE */

#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	/* _SYS_VNIOCTL_H_*/
Commit	Line	Data
91447636 A	1	/*
	2	* Copyright (c) 2004-2005 Apple Computer, Inc. All rights reserved.
	3	*
	4	* @APPLE_LICENSE_HEADER_START@
	5	*
37839358 A	6	* The contents of this file constitute Original Code as defined in and
	7	* are subject to the Apple Public Source License Version 1.1 (the
	8	* "License"). You may not use this file except in compliance with the
	9	* License. Please obtain a copy of the License at
	10	* http://www.apple.com/publicsource and read it before using this file.
91447636	11	*
37839358 A	12	* This Original Code and all software distributed under the License are
37839358 A	13	* distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
91447636 A	14	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
91447636 A	15	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
37839358 A	16	* FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. Please see the
	17	* License for the specific language governing rights and limitations
	18	* under the License.
91447636 A	19	*
	20	* @APPLE_LICENSE_HEADER_END@
	21	*/
1c79356b	22	/*
9bccf70c	23	* Copyright (c) 1988 University of Utah.
1c79356b A	24	* Copyright (c) 1990, 1993
	25	* The Regents of the University of California. All rights reserved.
	26	*
	27	* This code is derived from software contributed to Berkeley by
9bccf70c A	28	* the Systems Programming Group of the University of Utah Computer
9bccf70c A	29	* Science Department.
1c79356b A	30	*
	31	* Redistribution and use in source and binary forms, with or without
	32	* modification, are permitted provided that the following conditions
	33	* are met:
	34	* 1. Redistributions of source code must retain the above copyright
	35	* notice, this list of conditions and the following disclaimer.
	36	* 2. Redistributions in binary form must reproduce the above copyright
	37	* notice, this list of conditions and the following disclaimer in the
	38	* documentation and/or other materials provided with the distribution.
	39	* 3. All advertising materials mentioning features or use of this software
	40	* must display the following acknowledgement:
	41	* This product includes software developed by the University of
	42	* California, Berkeley and its contributors.
	43	* 4. Neither the name of the University nor the names of its contributors
	44	* may be used to endorse or promote products derived from this software
	45	* without specific prior written permission.
	46	*
	47	* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	48	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	49	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	50	* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	51	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	52	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	53	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	54	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	55	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	56	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	57	* SUCH DAMAGE.
	58	*
9bccf70c A	59	* from: Utah $Hdr: fdioctl.h 1.1 90/07/09$
	60	*
	61	* @(#)vnioctl.h 8.1 (Berkeley) 6/10/93
	62	*
	63	* $FreeBSD: src/sys/sys/vnioctl.h,v 1.4 1999/09/17 05:33:58 dillon Exp $
1c79356b A	64	*/
1c79356b A	65
9bccf70c A	66	#ifndef _SYS_VNIOCTL_H_
	67	#define _SYS_VNIOCTL_H_
	68
	69	#include <sys/appleapiopts.h>
91447636	70	#include <sys/cdefs.h>
9bccf70c	71
9bccf70c	72
9bccf70c A	73	/*
	74	* Ioctl definitions for file (vnode) disk pseudo-device.
	75	*/
1c79356b	76
9bccf70c	77	#define _PATH_VNTAB "/etc/vntab" /* default config file */
1c79356b	78
9bccf70c	79	typedef enum {
55e303ae	80	vncontrol_readwrite_io_e = 0
9bccf70c	81	} vncontrol_t;
1c79356b	82
9bccf70c A	83	struct vn_ioctl {
9bccf70c A	84	char * vn_file; /* pathname of file to mount */
91447636	85	int vn_size; /* (returned) size of disk */
9bccf70c A	86	vncontrol_t vn_control;
9bccf70c A	87	};
1c79356b	88
91447636 A	89	#ifdef KERNEL_PRIVATE
91447636 A	90
91447636 A	91	struct user_vn_ioctl {
	92	u_int64_t vn_file; /* pathname of file to mount */
	93	int vn_size; /* (returned) size of disk */
	94	vncontrol_t vn_control;
	95	};
	96
91447636 A	97	#endif /* KERNEL_PRIVATE */
91447636 A	98
1c79356b	99	/*
9bccf70c A	100	* Before you can use a unit, it must be configured with VNIOCSET.
	101	* The configuration persists across opens and closes of the device;
	102	* an VNIOCCLR must be used to reset a configuration. An attempt to
	103	* VNIOCSET an already active unit will return EBUSY.
1c79356b	104	*/
9bccf70c A	105	#define VNIOCATTACH _IOWR('F', 0, struct vn_ioctl) /* attach file */
9bccf70c A	106	#define VNIOCDETACH _IOWR('F', 1, struct vn_ioctl) /* detach disk */
91447636 A	107	#define VNIOCGSET _IOWR('F', 2, u_int32_t ) /* set global option */
	108	#define VNIOCGCLEAR _IOWR('F', 3, u_int32_t ) /* reset --//-- */
	109	#define VNIOCUSET _IOWR('F', 4, u_int32_t ) /* set unit option */
	110	#define VNIOCUCLEAR _IOWR('F', 5, u_int32_t ) /* reset --//-- */
9bccf70c	111	#define VNIOCSHADOW _IOWR('F', 6, struct vn_ioctl) /* attach shadow */
91447636 A	112	#ifdef KERNEL_PRIVATE
	113	#define VNIOCATTACH64 _IOWR('F', 0, struct user_vn_ioctl) /* attach file - LP64 */
	114	#define VNIOCDETACH64 _IOWR('F', 1, struct user_vn_ioctl) /* detach disk - LP64 */
	115	#define VNIOCSHADOW64 _IOWR('F', 6, struct user_vn_ioctl) /* attach shadow - LP64 */
	116	#endif /* KERNEL_PRIVATE */
1c79356b	117
9bccf70c A	118	#define VN_LABELS 0x1 /* Use disk(/slice) labels */
	119	#define VN_FOLLOW 0x2 /* Debug flow in vn driver */
	120	#define VN_DEBUG 0x4 /* Debug data in vn driver */
	121	#define VN_IO 0x8 /* Debug I/O in vn driver */
	122	#define VN_DONTCLUSTER 0x10 /* Don't cluster */
	123	#define VN_RESERVE 0x20 /* Pre-reserve swap */
1c79356b	124
1c79356b	125
9bccf70c	126	#endif /* _SYS_VNIOCTL_H_*/