xref: /freebsd/sys/nfsclient/nfsmount.h (revision dd41de95a84d979615a2ef11df6850622bf6184e)
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  *	@(#)nfsmount.h	8.3 (Berkeley) 3/30/95
35  * $FreeBSD$
36  */
37 
38 #ifndef _NFSCLIENT_NFSMOUNT_H_
39 #define _NFSCLIENT_NFSMOUNT_H_
40 
41 #include <sys/socket.h>
42 
43 #include <nfs/nfs_mountcommon.h>
44 
45 #include <rpc/types.h>
46 #include <rpc/auth.h>
47 #include <rpc/clnt.h>
48 #include <rpc/rpcsec_gss.h>
49 
50 /*
51  * Mount structure.
52  * One allocated on every NFS mount.
53  * Holds NFS specific information for mount.
54  */
55 struct	nfsmount {
56 	struct	nfsmount_common nm_com;	/* Common fields for nlm */
57 	int	nm_numgrps;		/* Max. size of groupslist */
58 	u_char	nm_fh[NFSX_V4FH];	/* File handle of root dir */
59 	int	nm_fhsize;		/* Size of root file handle */
60 	int	nm_sotype;		/* Type of socket */
61 	int	nm_soproto;		/* and protocol */
62 	int	nm_soflags;		/* pr_flags for socket protocol */
63 	struct	sockaddr *nm_nam;	/* Addr of server */
64 	int	nm_deadthresh;		/* Threshold of timeouts-->dead server*/
65 	int	nm_rsize;		/* Max size of read rpc */
66 	int	nm_wsize;		/* Max size of write rpc */
67 	int	nm_readdirsize;		/* Size of a readdir rpc */
68 	int	nm_readahead;		/* Num. of blocks to readahead */
69 	int	nm_wcommitsize;		/* Max size of commit for write */
70 	int	nm_acdirmin;		/* Directory attr cache min lifetime */
71 	int	nm_acdirmax;		/* Directory attr cache max lifetime */
72 	int	nm_acregmin;		/* Reg file attr cache min lifetime */
73 	int	nm_acregmax;		/* Reg file attr cache max lifetime */
74 	u_char	nm_verf[NFSX_V3WRITEVERF]; /* V3 write verifier */
75 	TAILQ_HEAD(, buf) nm_bufq;	/* async io buffer queue */
76 	short	nm_bufqlen;		/* number of buffers in queue */
77 	short	nm_bufqwant;		/* process wants to add to the queue */
78 	int	nm_bufqiods;		/* number of iods processing queue */
79 	u_int64_t nm_maxfilesize;	/* maximum file size */
80 	struct nfs_rpcops *nm_rpcops;
81 	int	nm_tprintf_initial_delay;	/* initial delay */
82 	int	nm_tprintf_delay;		/* interval for messages */
83 	int	nm_secflavor;		 /* auth flavor to use for rpc */
84 	struct __rpc_client *nm_client;
85 	struct rpc_timers nm_timers[NFS_MAX_TIMER]; /* RTT Timers for rpcs */
86 	char	nm_principal[MNAMELEN];	/* GSS-API principal of server */
87 	gss_OID	nm_mech_oid;		/* OID of selected GSS-API mechanism */
88 	int	nm_nametimeo;		/* timeout for +ve entries (sec) */
89 	int	nm_negnametimeo;	/* timeout for -ve entries (sec) */
90 
91 	/* NFSv4 */
92 	uint64_t nm_clientid;
93 	fsid_t	nm_fsid;
94 	u_int	nm_lease_time;
95 	time_t	nm_last_renewal;
96 };
97 
98 #define	nm_mtx		nm_com.nmcom_mtx
99 #define	nm_flag		nm_com.nmcom_flag
100 #define	nm_state	nm_com.nmcom_state
101 #define	nm_mountp	nm_com.nmcom_mountp
102 #define	nm_timeo	nm_com.nmcom_timeo
103 #define	nm_retry	nm_com.nmcom_retry
104 #define	nm_hostname	nm_com.nmcom_hostname
105 #define	nm_getinfo	nm_com.nmcom_getinfo
106 #define	nm_vinvalbuf	nm_com.nmcom_vinvalbuf
107 
108 #if defined(_KERNEL)
109 /*
110  * Convert mount ptr to nfsmount ptr.
111  */
112 #define VFSTONFS(mp)	((struct nfsmount *)((mp)->mnt_data))
113 
114 #ifndef NFS_TPRINTF_INITIAL_DELAY
115 #define NFS_TPRINTF_INITIAL_DELAY       12
116 #endif
117 
118 #ifndef NFS_TPRINTF_DELAY
119 #define NFS_TPRINTF_DELAY               30
120 #endif
121 
122 #ifndef NFS_DEFAULT_NAMETIMEO
123 #define NFS_DEFAULT_NAMETIMEO		60
124 #endif
125 
126 #ifndef NFS_DEFAULT_NEGNAMETIMEO
127 #define NFS_DEFAULT_NEGNAMETIMEO	60
128 #endif
129 
130 #endif
131 
132 #endif
133