xref: /netbsd/sys/fs/nfs/common/nfscl.h (revision 9012e0ed)
1 /*	$NetBSD: nfscl.h,v 1.1.1.1 2013/09/30 07:19:39 dholland Exp $	*/
2 /*-
3  * Copyright (c) 2009 Rick Macklem, University of Guelph
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  *
27  * FreeBSD: head/sys/fs/nfs/nfscl.h 244042 2012-12-08 22:52:39Z rmacklem
28  * $NetBSD: nfscl.h,v 1.1.1.1 2013/09/30 07:19:39 dholland Exp $
29  */
30 
31 #ifndef	_NFS_NFSCL_H
32 #define	_NFS_NFSCL_H
33 
34 /*
35  * Extra stuff for a NFSv4 nfsnode.
36  * MALLOC'd to the correct length for the name and file handle.
37  * n4_data has the file handle, followed by the file name.
38  * The macro NFS4NODENAME() returns a pointer to the start of the
39  * name.
40  */
41 struct nfsv4node {
42 	u_int16_t	n4_fhlen;
43 	u_int16_t	n4_namelen;
44 	u_int8_t	n4_data[1];
45 };
46 
47 #define	NFS4NODENAME(n)	(&((n)->n4_data[(n)->n4_fhlen]))
48 
49 /*
50  * Just a macro to convert the nfscl_reqstart arguments.
51  */
52 #define	NFSCL_REQSTART(n, p, v) 					\
53 	nfscl_reqstart((n), (p), VFSTONFS((v)->v_mount), 		\
54 	    VTONFS(v)->n_fhp->nfh_fh, VTONFS(v)->n_fhp->nfh_len, NULL, NULL)
55 
56 /*
57  * These two macros convert between a lease duration and renew interval.
58  * For now, just make the renew interval 1/2 the lease duration.
59  * (They should be inverse operators.)
60  */
61 #define	NFSCL_RENEW(l)	(((l) < 2) ? 1 : ((l) / 2))
62 #define	NFSCL_LEASE(r)	((r) * 2)
63 
64 /*
65  * These flag bits are used for the argument to nfscl_fillsattr() to
66  * indicate special handling of the attributes.
67  */
68 #define	NFSSATTR_FULL		0x1
69 #define	NFSSATTR_SIZE0		0x2
70 #define	NFSSATTR_SIZENEG1	0x4
71 #define	NFSSATTR_SIZERDEV	0x8
72 
73 /* Use this macro for debug printfs. */
74 #define	NFSCL_DEBUG(level, ...)	do {					\
75 		if (nfscl_debuglevel >= (level))			\
76 			printf(__VA_ARGS__);				\
77 	} while (0)
78 
79 #endif	/* _NFS_NFSCL_H */
80