xref: /onnv-gate/usr/src/uts/common/sys/lofi.h (revision 0:68f95e015346)
1*0Sstevel@tonic-gate /*
2*0Sstevel@tonic-gate  * CDDL HEADER START
3*0Sstevel@tonic-gate  *
4*0Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
5*0Sstevel@tonic-gate  * Common Development and Distribution License, Version 1.0 only
6*0Sstevel@tonic-gate  * (the "License").  You may not use this file except in compliance
7*0Sstevel@tonic-gate  * with the License.
8*0Sstevel@tonic-gate  *
9*0Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10*0Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
11*0Sstevel@tonic-gate  * See the License for the specific language governing permissions
12*0Sstevel@tonic-gate  * and limitations under the License.
13*0Sstevel@tonic-gate  *
14*0Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
15*0Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16*0Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
17*0Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
18*0Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
19*0Sstevel@tonic-gate  *
20*0Sstevel@tonic-gate  * CDDL HEADER END
21*0Sstevel@tonic-gate  */
22*0Sstevel@tonic-gate /*
23*0Sstevel@tonic-gate  * Copyright 2004 Sun Microsystems, Inc.  All rights reserved.
24*0Sstevel@tonic-gate  * Use is subject to license terms.
25*0Sstevel@tonic-gate  */
26*0Sstevel@tonic-gate 
27*0Sstevel@tonic-gate 
28*0Sstevel@tonic-gate #ifndef	_SYS_LOFI_H
29*0Sstevel@tonic-gate #define	_SYS_LOFI_H
30*0Sstevel@tonic-gate 
31*0Sstevel@tonic-gate #pragma ident	"%Z%%M%	%I%	%E% SMI"
32*0Sstevel@tonic-gate 
33*0Sstevel@tonic-gate #include <sys/types.h>
34*0Sstevel@tonic-gate #include <sys/time.h>
35*0Sstevel@tonic-gate #include <sys/taskq.h>
36*0Sstevel@tonic-gate #include <sys/vtoc.h>
37*0Sstevel@tonic-gate #include <sys/dkio.h>
38*0Sstevel@tonic-gate #include <sys/vnode.h>
39*0Sstevel@tonic-gate 
40*0Sstevel@tonic-gate #ifdef	__cplusplus
41*0Sstevel@tonic-gate extern "C" {
42*0Sstevel@tonic-gate #endif
43*0Sstevel@tonic-gate 
44*0Sstevel@tonic-gate /*
45*0Sstevel@tonic-gate  * /dev names:
46*0Sstevel@tonic-gate  *	/dev/lofictl	- master control device
47*0Sstevel@tonic-gate  *	/dev/lofi	- block devices, named by minor number
48*0Sstevel@tonic-gate  *	/dev/rlofi	- character devices, named by minor number
49*0Sstevel@tonic-gate  */
50*0Sstevel@tonic-gate #define	LOFI_DRIVER_NAME	"lofi"
51*0Sstevel@tonic-gate #define	LOFI_CTL_NODE		"ctl"
52*0Sstevel@tonic-gate #define	LOFI_CTL_NAME		LOFI_DRIVER_NAME LOFI_CTL_NODE
53*0Sstevel@tonic-gate #define	LOFI_BLOCK_NAME		LOFI_DRIVER_NAME
54*0Sstevel@tonic-gate #define	LOFI_CHAR_NAME		"r" LOFI_DRIVER_NAME
55*0Sstevel@tonic-gate 
56*0Sstevel@tonic-gate /*
57*0Sstevel@tonic-gate  *
58*0Sstevel@tonic-gate  * Use is:
59*0Sstevel@tonic-gate  *	ld = open("/dev/lofictl", O_RDWR | O_EXCL);
60*0Sstevel@tonic-gate  *
61*0Sstevel@tonic-gate  * lofi must be opened exclusively. Access is controlled by permissions on
62*0Sstevel@tonic-gate  * the device, which is 644 by default. Write-access is required for ioctls
63*0Sstevel@tonic-gate  * that change state, but only read-access is required for the ioctls that
64*0Sstevel@tonic-gate  * return information. Basically, only root can add and remove files, but
65*0Sstevel@tonic-gate  * non-root can look at the current lists.
66*0Sstevel@tonic-gate  *
67*0Sstevel@tonic-gate  * ioctl usage:
68*0Sstevel@tonic-gate  *
69*0Sstevel@tonic-gate  * kernel ioctls
70*0Sstevel@tonic-gate  *
71*0Sstevel@tonic-gate  *	strcpy(li.li_filename, "somefilename");
72*0Sstevel@tonic-gate  *	ioctl(ld, LOFI_MAP_FILE, &li);
73*0Sstevel@tonic-gate  *	newminor = li.li_minor;
74*0Sstevel@tonic-gate  *
75*0Sstevel@tonic-gate  *	strcpy(li.li_filename, "somefilename");
76*0Sstevel@tonic-gate  *	ioctl(ld, LOFI_UNMAP_FILE, &li);
77*0Sstevel@tonic-gate  *
78*0Sstevel@tonic-gate  *	strcpy(li.li_filename, "somefilename");
79*0Sstevel@tonic-gate  *	li.li_minor = minor_number;
80*0Sstevel@tonic-gate  *	ioctl(ld, LOFI_MAP_FILE_MINOR, &li);
81*0Sstevel@tonic-gate  *
82*0Sstevel@tonic-gate  *	li.li_minor = minor_number;
83*0Sstevel@tonic-gate  *	ioctl(ld, LOFI_UNMAP_FILE_MINOR, &li);
84*0Sstevel@tonic-gate  *
85*0Sstevel@tonic-gate  *	li.li_minor = minor_number;
86*0Sstevel@tonic-gate  *	ioctl(ld, LOFI_GET_FILENAME, &li);
87*0Sstevel@tonic-gate  *
88*0Sstevel@tonic-gate  *	strcpy(li.li_filename, "somefilename");
89*0Sstevel@tonic-gate  *	ioctl(ld, LOFI_GET_MINOR, &li);
90*0Sstevel@tonic-gate  *
91*0Sstevel@tonic-gate  *	li.li_minor = 0;
92*0Sstevel@tonic-gate  *	ioctl(ld, LOFI_GET_MAXMINOR, &li);
93*0Sstevel@tonic-gate  *	maxminor = li.li_minor;
94*0Sstevel@tonic-gate  *
95*0Sstevel@tonic-gate  * Oh, and last but not least: these ioctls are totally private and only
96*0Sstevel@tonic-gate  * for use by lofiadm(1M).
97*0Sstevel@tonic-gate  *
98*0Sstevel@tonic-gate  */
99*0Sstevel@tonic-gate 
100*0Sstevel@tonic-gate struct lofi_ioctl {
101*0Sstevel@tonic-gate 	uint32_t li_minor;
102*0Sstevel@tonic-gate 	char	li_filename[MAXPATHLEN + 1];
103*0Sstevel@tonic-gate };
104*0Sstevel@tonic-gate 
105*0Sstevel@tonic-gate #define	LOFI_IOC_BASE		(('L' << 16) | ('F' << 8))
106*0Sstevel@tonic-gate 
107*0Sstevel@tonic-gate #define	LOFI_MAP_FILE		(LOFI_IOC_BASE | 0x01)
108*0Sstevel@tonic-gate #define	LOFI_MAP_FILE_MINOR	(LOFI_IOC_BASE | 0x02)
109*0Sstevel@tonic-gate #define	LOFI_UNMAP_FILE		(LOFI_IOC_BASE | 0x03)
110*0Sstevel@tonic-gate #define	LOFI_UNMAP_FILE_MINOR	(LOFI_IOC_BASE | 0x04)
111*0Sstevel@tonic-gate #define	LOFI_GET_FILENAME	(LOFI_IOC_BASE | 0x05)
112*0Sstevel@tonic-gate #define	LOFI_GET_MINOR		(LOFI_IOC_BASE | 0x06)
113*0Sstevel@tonic-gate #define	LOFI_GET_MAXMINOR	(LOFI_IOC_BASE | 0x07)
114*0Sstevel@tonic-gate 
115*0Sstevel@tonic-gate /*
116*0Sstevel@tonic-gate  * file types that might be usable with lofi, maybe. Only regular
117*0Sstevel@tonic-gate  * files are documented though.
118*0Sstevel@tonic-gate  */
119*0Sstevel@tonic-gate #define	S_ISLOFIABLE(mode) \
120*0Sstevel@tonic-gate 	(S_ISREG(mode) || S_ISBLK(mode) || S_ISCHR(mode))
121*0Sstevel@tonic-gate 
122*0Sstevel@tonic-gate #if defined(_KERNEL)
123*0Sstevel@tonic-gate 
124*0Sstevel@tonic-gate /*
125*0Sstevel@tonic-gate  * We limit the maximum number of active lofi devices to 128, which seems very
126*0Sstevel@tonic-gate  * large. You can tune this by changing lofi_max_files in /etc/system.
127*0Sstevel@tonic-gate  * If you change it dynamically, which you probably shouldn't do, make sure
128*0Sstevel@tonic-gate  * to only _increase_ it.
129*0Sstevel@tonic-gate  */
130*0Sstevel@tonic-gate #define	LOFI_MAX_FILES	128
131*0Sstevel@tonic-gate extern uint32_t lofi_max_files;
132*0Sstevel@tonic-gate 
133*0Sstevel@tonic-gate #define	V_ISLOFIABLE(vtype) \
134*0Sstevel@tonic-gate 	((vtype == VREG) || (vtype == VBLK) || (vtype == VCHR))
135*0Sstevel@tonic-gate 
136*0Sstevel@tonic-gate struct lofi_state {
137*0Sstevel@tonic-gate 	char	*ls_filename;	/* filename to open */
138*0Sstevel@tonic-gate 	size_t	ls_filename_sz;
139*0Sstevel@tonic-gate 	struct vnode	*ls_vp; /* open vnode */
140*0Sstevel@tonic-gate 	u_offset_t	ls_vp_size;
141*0Sstevel@tonic-gate 	uint32_t	ls_blk_open;
142*0Sstevel@tonic-gate 	uint32_t	ls_chr_open;
143*0Sstevel@tonic-gate 	uint32_t	ls_lyr_open_count;
144*0Sstevel@tonic-gate 	int		ls_openflag;
145*0Sstevel@tonic-gate 	taskq_t		*ls_taskq;
146*0Sstevel@tonic-gate 	kstat_t		*ls_kstat;
147*0Sstevel@tonic-gate 	kmutex_t	ls_kstat_lock;
148*0Sstevel@tonic-gate 	struct dk_geom	ls_dkg;
149*0Sstevel@tonic-gate 	struct vtoc	ls_vtoc;
150*0Sstevel@tonic-gate 	struct dk_cinfo	ls_ci;
151*0Sstevel@tonic-gate };
152*0Sstevel@tonic-gate 
153*0Sstevel@tonic-gate #endif
154*0Sstevel@tonic-gate 
155*0Sstevel@tonic-gate #ifdef	__cplusplus
156*0Sstevel@tonic-gate }
157*0Sstevel@tonic-gate #endif
158*0Sstevel@tonic-gate 
159*0Sstevel@tonic-gate #endif	/* _SYS_LOFI_H */
160