xref: /freebsd/sys/nfsclient/nfsmount.h (revision 2e3f49888ec8851bafb22011533217487764fdb0)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1989, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * This code is derived from software contributed to Berkeley by
8  * Rick Macklem at The University of Guelph.
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  * 3. Neither the name of the University nor the names of its contributors
19  *    may be used to endorse or promote products derived from this software
20  *    without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  */
34 
35 #ifndef _NFSCLIENT_NFSMOUNT_H_
36 #define _NFSCLIENT_NFSMOUNT_H_
37 
38 #include <sys/socket.h>
39 
40 #include <nfs/nfs_mountcommon.h>
41 
42 #include <rpc/types.h>
43 #include <rpc/auth.h>
44 #include <rpc/clnt.h>
45 #include <rpc/rpcsec_gss.h>
46 
47 /*
48  * Mount structure.
49  * One allocated on every NFS mount.
50  * Holds NFS specific information for mount.
51  */
52 struct	nfsmount {
53 	struct	nfsmount_common nm_com;	/* Common fields for nlm */
54 	int	nm_numgrps;		/* Max. size of groupslist */
55 	u_char	nm_fh[NFSX_V4FH];	/* File handle of root dir */
56 	int	nm_fhsize;		/* Size of root file handle */
57 	int	nm_sotype;		/* Type of socket */
58 	int	nm_soproto;		/* and protocol */
59 	int	nm_soflags;		/* pr_flags for socket protocol */
60 	struct	sockaddr *nm_nam;	/* Addr of server */
61 	int	nm_deadthresh;		/* Threshold of timeouts-->dead server*/
62 	int	nm_rsize;		/* Max size of read rpc */
63 	int	nm_wsize;		/* Max size of write rpc */
64 	int	nm_readdirsize;		/* Size of a readdir rpc */
65 	int	nm_readahead;		/* Num. of blocks to readahead */
66 	int	nm_wcommitsize;		/* Max size of commit for write */
67 	int	nm_acdirmin;		/* Directory attr cache min lifetime */
68 	int	nm_acdirmax;		/* Directory attr cache max lifetime */
69 	int	nm_acregmin;		/* Reg file attr cache min lifetime */
70 	int	nm_acregmax;		/* Reg file attr cache max lifetime */
71 	u_char	nm_verf[NFSX_V3WRITEVERF]; /* V3 write verifier */
72 	TAILQ_HEAD(, buf) nm_bufq;	/* async io buffer queue */
73 	short	nm_bufqlen;		/* number of buffers in queue */
74 	short	nm_bufqwant;		/* process wants to add to the queue */
75 	int	nm_bufqiods;		/* number of iods processing queue */
76 	u_int64_t nm_maxfilesize;	/* maximum file size */
77 	struct nfs_rpcops *nm_rpcops;
78 	int	nm_tprintf_initial_delay;	/* initial delay */
79 	int	nm_tprintf_delay;		/* interval for messages */
80 	int	nm_secflavor;		 /* auth flavor to use for rpc */
81 	struct __rpc_client *nm_client;
82 	struct rpc_timers nm_timers[NFS_MAX_TIMER]; /* RTT Timers for rpcs */
83 	char	nm_principal[MNAMELEN];	/* GSS-API principal of server */
84 	gss_OID	nm_mech_oid;		/* OID of selected GSS-API mechanism */
85 	int	nm_nametimeo;		/* timeout for +ve entries (sec) */
86 	int	nm_negnametimeo;	/* timeout for -ve entries (sec) */
87 
88 	/* NFSv4 */
89 	uint64_t nm_clientid;
90 	fsid_t	nm_fsid;
91 	u_int	nm_lease_time;
92 	time_t	nm_last_renewal;
93 };
94 
95 #define	nm_mtx		nm_com.nmcom_mtx
96 #define	nm_flag		nm_com.nmcom_flag
97 #define	nm_state	nm_com.nmcom_state
98 #define	nm_mountp	nm_com.nmcom_mountp
99 #define	nm_timeo	nm_com.nmcom_timeo
100 #define	nm_retry	nm_com.nmcom_retry
101 #define	nm_hostname	nm_com.nmcom_hostname
102 #define	nm_getinfo	nm_com.nmcom_getinfo
103 #define	nm_vinvalbuf	nm_com.nmcom_vinvalbuf
104 
105 #if defined(_KERNEL)
106 /*
107  * Convert mount ptr to nfsmount ptr.
108  */
109 #define VFSTONFS(mp)	((struct nfsmount *)((mp)->mnt_data))
110 
111 #ifndef NFS_TPRINTF_INITIAL_DELAY
112 #define NFS_TPRINTF_INITIAL_DELAY       12
113 #endif
114 
115 #ifndef NFS_TPRINTF_DELAY
116 #define NFS_TPRINTF_DELAY               30
117 #endif
118 
119 #ifndef NFS_DEFAULT_NAMETIMEO
120 #define NFS_DEFAULT_NAMETIMEO		60
121 #endif
122 
123 #ifndef NFS_DEFAULT_NEGNAMETIMEO
124 #define NFS_DEFAULT_NEGNAMETIMEO	60
125 #endif
126 
127 #endif
128 
129 #endif
130