xref: /dragonfly/sys/sys/vnioctl.h (revision 36a3d1d6)
1 /*
2  * Copyright (c) 1988 University of Utah.
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
7  * the Systems Programming Group of the University of Utah Computer
8  * Science Department.
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  *
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 $
43  * $DragonFly: src/sys/sys/vnioctl.h,v 1.4 2008/01/30 11:46:33 cat Exp $
44  */
45 
46 #ifndef _SYS_VNIOCTL_H_
47 #define _SYS_VNIOCTL_H_
48 
49 #ifndef _SYS_IOCCOM_H_
50 #include <sys/ioccom.h>
51 #endif
52 #ifndef _SYS_PARAMH_H_
53 #include <sys/param.h>		/* PATH_MAX */
54 #endif
55 
56 /*
57  * Ioctl definitions for file (vnode) disk pseudo-device.
58  */
59 
60 #define _PATH_VNTAB	"/etc/vntab"	/* default config file */
61 
62 struct vn_ioctl {
63 	char	*vn_file;	/* pathname of file to mount */
64 	int64_t	vn_size;	/* (returned) size of disk */
65 };
66 
67 /*
68  * Structure used by userland to query vn devices.
69  *
70  * In file-backed configurations, vnu_file will contain the full path to
71  * the backing file, with vnu_dev and vnu_ino pointing to the appropriate
72  * filesystem entries for that file.
73  *
74  * In swap-backed configurations, vnu_file will contain the token "swap",
75  * with vnu_size and vnu_secsize indicating the portion of virtual memory
76  * in use by the vnode disk.
77  *
78  * Todo: verify vnu_file within a jail - path disclosure problem ?
79  */
80 
81 
82 struct vn_user {
83         int     	vnu_unit;		/* vn unit */
84         char    	vnu_file[PATH_MAX];	/* vn description */
85 #define _VN_USER_SWAP	"swap"			/* indicates swap-backed vn */
86 	union {
87 	        dev_t   	dev;		/* vn device */
88 		u_int64_t	size;		/* size per vnu_secsize */
89 	} data1;
90 	union {
91         	ino_t   	ino;		/* vn inode */
92 		int		secsize;	/* sector size */
93 	} data2;
94 };
95 #define vnu_dev		data1.dev
96 #define vnu_size	data1.size
97 #define vnu_ino		data2.ino
98 #define vnu_secsize	data2.secsize
99 
100 /*
101  * Before you can use a unit, it must be configured with VNIOCSET.
102  * The configuration persists across opens and closes of the device;
103  * an VNIOCCLR must be used to reset a configuration.  An attempt to
104  * VNIOCSET an already active unit will return EBUSY.
105  */
106 #define VNIOCATTACH	_IOWR('F', 0, struct vn_ioctl)	/* attach file */
107 #define VNIOCDETACH	_IOWR('F', 1, struct vn_ioctl)	/* detach disk */
108 #define VNIOCGSET	_IOWR('F', 2, u_long )		/* set global option */
109 #define VNIOCGCLEAR	_IOWR('F', 3, u_long )		/* reset --//-- */
110 #define VNIOCUSET	_IOWR('F', 4, u_long )		/* set unit option */
111 #define VNIOCUCLEAR	_IOWR('F', 5, u_long )		/* reset --//-- */
112 #define VNIOCGET	_IOWR('F', 6, struct vn_user)	/* get disk info */
113 
114 #define VN_FOLLOW	0x2	/* Debug flow in vn driver */
115 #define VN_DEBUG	0x4	/* Debug data in vn driver */
116 #define VN_IO		0x8	/* Debug I/O in vn driver */
117 #define VN_DONTCLUSTER	0x10	/* Don't cluster */
118 #define VN_RESERVE	0x20	/* Pre-reserve swap */
119 
120 #endif	/* _SYS_VNIOCTL_H_*/
121