xref: /freebsd/sys/nfsclient/nfsmount.h (revision dc60165b73e4c4d829a2cb9fed5cce585e93d9a9)
1 /*-
2  * Copyright (c) 1989, 1993
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * This code is derived from software contributed to Berkeley by
6  * Rick Macklem at The University of Guelph.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 4. Neither the name of the University nor the names of its contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  *
32  *	@(#)nfsmount.h	8.3 (Berkeley) 3/30/95
33  * $FreeBSD$
34  */
35 
36 #ifndef _NFSCLIENT_NFSMOUNT_H_
37 #define _NFSCLIENT_NFSMOUNT_H_
38 
39 #ifndef NFS_LEGACYRPC
40 
41 #undef RPC_SUCCESS
42 #undef RPC_PROGUNAVAIL
43 #undef RPC_PROCUNAVAIL
44 #undef AUTH_OK
45 #undef AUTH_BADCRED
46 #undef AUTH_BADVERF
47 #undef AUTH_TOOWEAK
48 
49 #include <rpc/types.h>
50 #include <rpc/auth.h>
51 #include <rpc/clnt.h>
52 #include <rpc/rpcsec_gss.h>
53 
54 #endif
55 
56 #ifdef NFS_LEGACYRPC
57 
58 struct nfs_tcp_mountstate {
59  	int rpcresid;
60 #define NFS_TCP_EXPECT_RPCMARKER 	0x0001 /* Expect to see a RPC/TCP marker next */
61 #define NFS_TCP_FORCE_RECONNECT 	0x0002 /* Force a TCP reconnect */
62 #define NFS_TCP_WAIT_WRITE_DRAIN 	0x0004 /* Waiting for socket writers to finish */
63  	int flags;
64 	int sock_send_inprog;
65 };
66 
67 #endif
68 
69 /*
70  * Mount structure.
71  * One allocated on every NFS mount.
72  * Holds NFS specific information for mount.
73  */
74 struct	nfsmount {
75 	struct mtx	nm_mtx;
76 	int	nm_flag;		/* Flags for soft/hard... */
77 	int	nm_state;		/* Internal state flags */
78 	struct	mount *nm_mountp;	/* Vfs structure for this filesystem */
79 	int	nm_numgrps;		/* Max. size of groupslist */
80 	u_char	nm_fh[NFSX_V4FH];	/* File handle of root dir */
81 	int	nm_fhsize;		/* Size of root file handle */
82 	struct	rpcclnt nm_rpcclnt;	/* rpc state */
83 #ifdef NFS_LEGACYRPC
84 	struct	socket *nm_so;		/* Rpc socket */
85 #endif
86 	int	nm_sotype;		/* Type of socket */
87 	int	nm_soproto;		/* and protocol */
88 	int	nm_soflags;		/* pr_flags for socket protocol */
89 	struct	sockaddr *nm_nam;	/* Addr of server */
90 	int	nm_timeo;		/* Init timer for NFSMNT_DUMBTIMR */
91 	int	nm_retry;		/* Max retries */
92 #ifdef NFS_LEGACYRPC
93 	int	nm_srtt[NFS_MAX_TIMER],	/* RTT Timers for rpcs */
94 		nm_sdrtt[NFS_MAX_TIMER];
95 	int	nm_sent;		/* Request send count */
96 	int	nm_cwnd;		/* Request send window */
97 	int	nm_timeouts;		/* Request timeouts */
98 #endif
99 	int	nm_deadthresh;		/* Threshold of timeouts-->dead server*/
100 	int	nm_rsize;		/* Max size of read rpc */
101 	int	nm_wsize;		/* Max size of write rpc */
102 	int	nm_readdirsize;		/* Size of a readdir rpc */
103 	int	nm_readahead;		/* Num. of blocks to readahead */
104 	int	nm_wcommitsize;		/* Max size of commit for write */
105 	int	nm_acdirmin;		/* Directory attr cache min lifetime */
106 	int	nm_acdirmax;		/* Directory attr cache max lifetime */
107 	int	nm_acregmin;		/* Reg file attr cache min lifetime */
108 	int	nm_acregmax;		/* Reg file attr cache max lifetime */
109 	u_char	nm_verf[NFSX_V3WRITEVERF]; /* V3 write verifier */
110 	TAILQ_HEAD(, buf) nm_bufq;	/* async io buffer queue */
111 	short	nm_bufqlen;		/* number of buffers in queue */
112 	short	nm_bufqwant;		/* process wants to add to the queue */
113 	int	nm_bufqiods;		/* number of iods processing queue */
114 	u_int64_t nm_maxfilesize;	/* maximum file size */
115 	struct nfs_rpcops *nm_rpcops;
116 	int	nm_tprintf_initial_delay;	/* initial delay */
117 	int	nm_tprintf_delay;		/* interval for messages */
118 #ifdef NFS_LEGACYRPC
119 	struct nfs_tcp_mountstate nm_nfstcpstate;
120 #endif
121 	char	nm_hostname[MNAMELEN];	 /* server's name */
122 #ifndef NFS_LEGACYRPC
123 	int	nm_secflavor;		 /* auth flavor to use for rpc */
124 	struct __rpc_client *nm_client;
125 	struct rpc_timers nm_timers[NFS_MAX_TIMER]; /* RTT Timers for rpcs */
126 	char	nm_principal[MNAMELEN];	/* GSS-API principal of server */
127 	gss_OID	nm_mech_oid;		/* OID of selected GSS-API mechanism */
128 #endif
129 
130 	/* NFSv4 */
131 	uint64_t nm_clientid;
132 	fsid_t	nm_fsid;
133 	u_int	nm_lease_time;
134 	time_t	nm_last_renewal;
135 };
136 
137 #if defined(_KERNEL)
138 /*
139  * Convert mount ptr to nfsmount ptr.
140  */
141 #define VFSTONFS(mp)	((struct nfsmount *)((mp)->mnt_data))
142 
143 #ifndef NFS_TPRINTF_INITIAL_DELAY
144 #define NFS_TPRINTF_INITIAL_DELAY       12
145 #endif
146 
147 #ifndef NFS_TPRINTF_DELAY
148 #define NFS_TPRINTF_DELAY               30
149 #endif
150 
151 #endif
152 
153 #endif
154