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