xref: /minix/sys/dev/vndvar.h (revision 84d9c625)
1 /*	$NetBSD: vndvar.h,v 1.33 2013/06/03 16:42:32 christos Exp $	*/
2 
3 /*-
4  * Copyright (c) 1996, 1997, 1998 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Jason R. Thorpe.
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  *
19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 /*
33  * Copyright (c) 1988 University of Utah.
34  * Copyright (c) 1990, 1993
35  *	The Regents of the University of California.  All rights reserved.
36  *
37  * This code is derived from software contributed to Berkeley by
38  * the Systems Programming Group of the University of Utah Computer
39  * Science Department.
40  *
41  * Redistribution and use in source and binary forms, with or without
42  * modification, are permitted provided that the following conditions
43  * are met:
44  * 1. Redistributions of source code must retain the above copyright
45  *    notice, this list of conditions and the following disclaimer.
46  * 2. Redistributions in binary form must reproduce the above copyright
47  *    notice, this list of conditions and the following disclaimer in the
48  *    documentation and/or other materials provided with the distribution.
49  * 3. Neither the name of the University nor the names of its contributors
50  *    may be used to endorse or promote products derived from this software
51  *    without specific prior written permission.
52  *
53  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
54  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
55  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
56  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
57  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
58  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
59  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
60  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
61  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
62  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
63  * SUCH DAMAGE.
64  *
65  * from: Utah $Hdr: fdioctl.h 1.1 90/07/09$
66  *
67  *	@(#)vnioctl.h	8.1 (Berkeley) 6/10/93
68  */
69 
70 #ifndef _SYS_DEV_VNDVAR_H_
71 #define _SYS_DEV_VNDVAR_H_
72 
73 #if !defined(__minix)
74 #include <sys/pool.h>
75 #endif /* defined(__minix) */
76 
77 /*
78  * Vnode disk pseudo-geometry information.
79  */
80 struct vndgeom {
81 	u_int32_t	vng_secsize;	/* # bytes per sector */
82 	u_int32_t	vng_nsectors;	/* # data sectors per track */
83 	u_int32_t	vng_ntracks;	/* # tracks per cylinder */
84 	u_int32_t	vng_ncylinders;	/* # cylinders per unit */
85 };
86 
87 /*
88  * Ioctl definitions for file (vnode) disk pseudo-device.
89  */
90 struct vnd_ioctl {
91 #if !defined(__minix)
92 	char		*vnd_file;	/* pathname of file to mount */
93 #else
94 	int		vnd_fildes;	/* file descriptor of file to mount */
95 #endif /* !defined(__minix)*/
96 	int		vnd_flags;	/* flags; see below */
97 	struct vndgeom	vnd_geom;	/* geometry to emulate */
98 #if !defined(__minix)
99 	unsigned int	vnd_osize;	/* (returned) size of disk */
100 #endif /* !defined(__minix)*/
101 	uint64_t	vnd_size;	/* (returned) size of disk */
102 };
103 
104 /* vnd_flags */
105 #define	VNDIOF_HASGEOM	0x01		/* use specified geometry */
106 #define	VNDIOF_READONLY	0x02		/* as read-only device */
107 #define	VNDIOF_FORCE	0x04		/* force close */
108 
109 #if !defined(__minix)
110 #ifdef _KERNEL
111 
112 struct vnode;
113 
114 /*
115  * A vnode disk's state information.
116  */
117 struct vnd_softc {
118 	device_t         sc_dev;
119 	int		 sc_flags;	/* flags */
120 	uint64_t	 sc_size;	/* size of vnd */
121 	struct vnode	*sc_vp;		/* vnode */
122 	kauth_cred_t	 sc_cred;	/* credentials */
123 	int		 sc_maxactive;	/* max # of active requests */
124 	struct bufq_state *sc_tab;	/* transfer queue */
125 	int		 sc_pending;	/* number of pending transfers */
126 	int		 sc_active;	/* number of active transfers */
127 	struct disk	 sc_dkdev;	/* generic disk device info */
128 	struct vndgeom	 sc_geom;	/* virtual geometry */
129 	struct pool	 sc_vxpool;	/* vndxfer pool */
130 	struct pool	 sc_vbpool;	/* vndbuf pool */
131 	struct lwp 	*sc_kthread;	/* kernel thread */
132 	u_int32_t	 sc_comp_blksz;	/* precompressed block size */
133 	u_int32_t	 sc_comp_numoffs;/* count of compressed block offsets */
134 	u_int64_t	*sc_comp_offsets;/* file idx's to compressed blocks */
135 	unsigned char	*sc_comp_buff;	/* compressed data buffer */
136 	unsigned char	*sc_comp_decombuf;/* decompressed data buffer */
137 	int32_t		 sc_comp_buffblk;/*current decompressed block */
138 	z_stream	 sc_comp_stream;/* decompress descriptor */
139 };
140 #endif
141 
142 /* sc_flags */
143 #define	VNF_INITED	0x001	/* unit has been initialized */
144 #define	VNF_WLABEL	0x002	/* label area is writable */
145 #define	VNF_LABELLING	0x004	/* unit is currently being labelled */
146 #define	VNF_WANTED	0x008	/* someone is waiting to obtain a lock */
147 #define	VNF_LOCKED	0x010	/* unit is locked */
148 #define	VNF_READONLY	0x020	/* unit is read-only */
149 #define	VNF_KLABEL	0x040	/* keep label on close */
150 #define	VNF_VLABEL	0x080	/* label is valid */
151 #define	VNF_KTHREAD	0x100	/* thread is running */
152 #define	VNF_VUNCONF	0x200	/* device is unconfiguring */
153 #define VNF_COMP	0x400	/* file is compressed */
154 #define VNF_CLEARING	0x800	/* unit is being torn down */
155 #define VNF_USE_VN_RDWR	0x1000	/* have to use vn_rdwr() */
156 
157 /* structure of header in a compressed file */
158 struct vnd_comp_header
159 {
160 	char preamble[128];
161 	u_int32_t block_size;
162 	u_int32_t num_blocks;
163 };
164 #endif /* !defined(__minix) */
165 
166 /*
167  * A simple structure for describing which vnd units are in use.
168  */
169 
170 struct vnd_user {
171 	int		vnu_unit;	/* which vnd unit */
172 	dev_t		vnu_dev;	/* file is on this device... */
173 	ino_t		vnu_ino;	/* ...at this inode */
174 };
175 
176 /*
177  * Before you can use a unit, it must be configured with VNDIOCSET.
178  * The configuration persists across opens and closes of the device;
179  * an VNDIOCCLR must be used to reset a configuration.  An attempt to
180  * VNDIOCSET an already active unit will return EBUSY.
181  */
182 #define VNDIOCSET	_IOWR('F', 0, struct vnd_ioctl)	/* enable disk */
183 #define VNDIOCCLR	_IOW('F', 1, struct vnd_ioctl)	/* disable disk */
184 #define VNDIOCGET	_IOWR('F', 3, struct vnd_user)	/* get list */
185 
186 #ifdef _KERNEL
187 /*
188  * Everything else is kernel-private, mostly exported for compat/netbsd32.
189  *
190  * NetBSD 3.0 had a 32-bit value for vnu_ino.
191  *
192  * NetBSD 5.0 had a 32-bit value for vnu_dev, and vnd_size.
193  */
194 struct vnd_user30 {
195 	int		vnu_unit;	/* which vnd unit */
196 	uint32_t	vnu_dev;	/* file is on this device... */
197 	uint32_t	vnu_ino;	/* ...at this inode */
198 };
199 #define VNDIOCGET30	_IOWR('F', 2, struct vnd_user30)	/* get list */
200 
201 struct vnd_user50 {
202 	int		vnu_unit;	/* which vnd unit */
203 	uint32_t	vnu_dev;	/* file is on this device... */
204 	ino_t		vnu_ino;	/* ...at this inode */
205 };
206 #define VNDIOCGET50	_IOWR('F', 3, struct vnd_user50)	/* get list */
207 
208 struct vnd_ioctl50 {
209 	char		*vnd_file;	/* pathname of file to mount */
210 	int		vnd_flags;	/* flags; see below */
211 	struct vndgeom	vnd_geom;	/* geometry to emulate */
212 	unsigned int	vnd_size;	/* (returned) size of disk */
213 };
214 #define VNDIOCSET50	_IOWR('F', 0, struct vnd_ioctl50)
215 #define VNDIOCCLR50	_IOW('F', 1, struct vnd_ioctl50)
216 
217 #endif /* _KERNEL */
218 
219 #endif /* _SYS_DEV_VNDVAR_H_ */
220