xref: /onnv-gate/usr/src/uts/common/sys/lockfs.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 1998 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 #ifndef _SYS_LOCKFS_H
28*0Sstevel@tonic-gate #define	_SYS_LOCKFS_H
29*0Sstevel@tonic-gate 
30*0Sstevel@tonic-gate #pragma ident	"%Z%%M%	%I%	%E% SMI"
31*0Sstevel@tonic-gate 
32*0Sstevel@tonic-gate #ifdef	__cplusplus
33*0Sstevel@tonic-gate extern "C" {
34*0Sstevel@tonic-gate #endif
35*0Sstevel@tonic-gate 
36*0Sstevel@tonic-gate #ifdef _SYSCALL32
37*0Sstevel@tonic-gate /*
38*0Sstevel@tonic-gate  * ILP32 version of lockfs, used in ufs_ioctl() to support 32-bit app in
39*0Sstevel@tonic-gate  * LP64 kernel
40*0Sstevel@tonic-gate  */
41*0Sstevel@tonic-gate struct lockfs32 {
42*0Sstevel@tonic-gate 	uint32_t	lf_lock;	/* desired lock */
43*0Sstevel@tonic-gate 	uint32_t	lf_flags;	/* misc flags */
44*0Sstevel@tonic-gate 	uint32_t	lf_key;		/* lock key */
45*0Sstevel@tonic-gate 	uint32_t	lf_comlen;	/* length of comment */
46*0Sstevel@tonic-gate 	uint32_t	lf_comment;	/* address of comment */
47*0Sstevel@tonic-gate };
48*0Sstevel@tonic-gate #endif /* _SYSCALL32 */
49*0Sstevel@tonic-gate 
50*0Sstevel@tonic-gate struct lockfs {
51*0Sstevel@tonic-gate 	ulong_t		lf_lock;	/* desired lock */
52*0Sstevel@tonic-gate 	ulong_t		lf_flags;	/* misc flags */
53*0Sstevel@tonic-gate 	ulong_t		lf_key;		/* lock key */
54*0Sstevel@tonic-gate 	ulong_t		lf_comlen;	/* length of comment */
55*0Sstevel@tonic-gate 	caddr_t		lf_comment;	/* address of comment */
56*0Sstevel@tonic-gate };
57*0Sstevel@tonic-gate 
58*0Sstevel@tonic-gate /*
59*0Sstevel@tonic-gate  * lf_lock and lf_locking
60*0Sstevel@tonic-gate  */
61*0Sstevel@tonic-gate #define	LOCKFS_ULOCK	0	/* unlock */
62*0Sstevel@tonic-gate #define	LOCKFS_WLOCK	1	/* write  lock */
63*0Sstevel@tonic-gate #define	LOCKFS_NLOCK	2	/* name   lock */
64*0Sstevel@tonic-gate #define	LOCKFS_DLOCK	3	/* delete lock */
65*0Sstevel@tonic-gate #define	LOCKFS_HLOCK	4	/* hard   lock */
66*0Sstevel@tonic-gate #define	LOCKFS_ELOCK	5	/* error  lock */
67*0Sstevel@tonic-gate #define	LOCKFS_ROELOCK	6	/* error  lock (read-only) - unimplemented */
68*0Sstevel@tonic-gate #define	LOCKFS_MAXLOCK	6	/* maximum lock number */
69*0Sstevel@tonic-gate 
70*0Sstevel@tonic-gate /*
71*0Sstevel@tonic-gate  * lf_flags
72*0Sstevel@tonic-gate  */
73*0Sstevel@tonic-gate #define	LOCKFS_BUSY	0x00000001	/* lock is being set */
74*0Sstevel@tonic-gate #define	LOCKFS_MOD	0x00000002	/* file system modified */
75*0Sstevel@tonic-gate 
76*0Sstevel@tonic-gate #define	LOCKFS_MAXCOMMENTLEN	1024	/* maximum comment length */
77*0Sstevel@tonic-gate 
78*0Sstevel@tonic-gate /*
79*0Sstevel@tonic-gate  * some nice checking macros
80*0Sstevel@tonic-gate  */
81*0Sstevel@tonic-gate 
82*0Sstevel@tonic-gate #define	LOCKFS_IS_BUSY(LF)	((LF)->lf_flags & LOCKFS_BUSY)
83*0Sstevel@tonic-gate #define	LOCKFS_IS_MOD(LF)	((LF)->lf_flags & LOCKFS_MOD)
84*0Sstevel@tonic-gate 
85*0Sstevel@tonic-gate #define	LOCKFS_CLR_BUSY(LF)	((LF)->lf_flags &= ~LOCKFS_BUSY)
86*0Sstevel@tonic-gate #define	LOCKFS_CLR_MOD(LF)	((LF)->lf_flags &= ~LOCKFS_MOD)
87*0Sstevel@tonic-gate 
88*0Sstevel@tonic-gate #define	LOCKFS_SET_MOD(LF)	((LF)->lf_flags |= LOCKFS_MOD)
89*0Sstevel@tonic-gate #define	LOCKFS_SET_BUSY(LF)	((LF)->lf_flags |= LOCKFS_BUSY)
90*0Sstevel@tonic-gate 
91*0Sstevel@tonic-gate #define	LOCKFS_IS_WLOCK(LF)	((LF)->lf_lock == LOCKFS_WLOCK)
92*0Sstevel@tonic-gate #define	LOCKFS_IS_HLOCK(LF)	((LF)->lf_lock == LOCKFS_HLOCK)
93*0Sstevel@tonic-gate #define	LOCKFS_IS_ROELOCK(LF)	((LF)->lf_lock == LOCKFS_ROELOCK)
94*0Sstevel@tonic-gate #define	LOCKFS_IS_ELOCK(LF)	((LF)->lf_lock == LOCKFS_ELOCK)
95*0Sstevel@tonic-gate #define	LOCKFS_IS_ULOCK(LF)	((LF)->lf_lock == LOCKFS_ULOCK)
96*0Sstevel@tonic-gate #define	LOCKFS_IS_NLOCK(LF)	((LF)->lf_lock == LOCKFS_NLOCK)
97*0Sstevel@tonic-gate #define	LOCKFS_IS_DLOCK(LF)	((LF)->lf_lock == LOCKFS_DLOCK)
98*0Sstevel@tonic-gate 
99*0Sstevel@tonic-gate #ifdef	__cplusplus
100*0Sstevel@tonic-gate }
101*0Sstevel@tonic-gate #endif
102*0Sstevel@tonic-gate 
103*0Sstevel@tonic-gate #endif	/* _SYS_LOCKFS_H */
104