xref: /freebsd/sys/fs/nfsclient/nfsmount.h (revision f5463265955b829775bbb32e1fd0bc11dafc36ce)
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 <nfs/nfs_mountcommon.h>
39 
40 /* Maximum value for nm_nconnect. */
41 #define	NFS_MAXNCONN	16
42 
43 /*
44  * Mount structure.
45  * One allocated on every NFS mount.
46  * Holds NFS specific information for mount.
47  */
48 struct	nfsmount {
49 	struct	nfsmount_common nm_com;	/* Common fields for nlm */
50 	uint32_t nm_privflag;		/* Private flags */
51 	uint32_t nm_newflag;		/* New mount flags */
52 	int	nm_numgrps;		/* Max. size of groupslist */
53 	u_char	nm_fh[NFSX_FHMAX];	/* File handle of root dir */
54 	int	nm_fhsize;		/* Size of root file handle */
55 	struct	nfssockreq nm_sockreq;	/* Socket Info */
56 	int	nm_timeouts;		/* Request timeouts */
57 	int	nm_rsize;		/* Max size of read rpc */
58 	int	nm_wsize;		/* Max size of write rpc */
59 	int	nm_readdirsize;		/* Size of a readdir rpc */
60 	int	nm_readahead;		/* Num. of blocks to readahead */
61 	int	nm_wcommitsize;		/* Max size of commit for write */
62 	int	nm_acdirmin;		/* Directory attr cache min lifetime */
63 	int	nm_acdirmax;		/* Directory attr cache max lifetime */
64 	int	nm_acregmin;		/* Reg file attr cache min lifetime */
65 	int	nm_acregmax;		/* Reg file attr cache max lifetime */
66 	u_char	nm_verf[NFSX_VERF];	/* write verifier */
67 	TAILQ_HEAD(, buf) nm_bufq;	/* async io buffer queue */
68 	short	nm_bufqlen;		/* number of buffers in queue */
69 	short	nm_bufqwant;		/* process wants to add to the queue */
70 	int	nm_bufqiods;		/* number of iods processing queue */
71 	u_int64_t nm_maxfilesize;	/* maximum file size */
72 	int	nm_tprintf_initial_delay; /* initial delay */
73 	int	nm_tprintf_delay;	/* interval for messages */
74 	int	nm_nametimeo;		/* timeout for +ve entries (sec) */
75 	int	nm_negnametimeo;	/* timeout for -ve entries (sec) */
76 
77 	/* Newnfs additions */
78 	TAILQ_HEAD(, nfsclds) nm_sess;	/* Session(s) for NFSv4.1. */
79 	struct	nfsclclient *nm_clp;
80 	char	*nm_tlscertname;	/* TLS certificate file name */
81 	uid_t	nm_uid;			/* Uid for SetClientID etc. */
82 	u_int64_t nm_clval;		/* identifies which clientid */
83 	u_int64_t nm_fsid[2];		/* NFSv4 fsid */
84 	int	nm_minorvers;		/* Minor version # for NFSv4 */
85 	u_int	nm_aconnect;		/* additional TCP connections */
86 	u_int	nm_nextaconn;		/* Next nm_aconn[] to use */
87 					/* unclipped, wraps to 0 */
88 	struct __rpc_client *nm_aconn[NFS_MAXNCONN - 1]; /* Additional nconn */
89 					/* Locked via nm_sockreq.nr_mtx */
90 	u_int16_t nm_krbnamelen;	/* Krb5 host principal, if any */
91 	u_int16_t nm_dirpathlen;	/* and mount dirpath, for V4 */
92 	u_int16_t nm_srvkrbnamelen;	/* and the server's target name */
93 	u_char	nm_name[1];	/* malloc'd actual len of krbname + dirpath */
94 };
95 
96 #define	nm_nam		nm_sockreq.nr_nam
97 #define	nm_sotype	nm_sockreq.nr_sotype
98 #define	nm_so		nm_sockreq.nr_so
99 #define	nm_soflags	nm_sockreq.nr_soflags
100 #define	nm_soproto	nm_sockreq.nr_soproto
101 #define	nm_client	nm_sockreq.nr_client
102 #define	nm_krbname	nm_name
103 #define	nm_mtx		nm_com.nmcom_mtx
104 #define	nm_flag		nm_com.nmcom_flag
105 #define	nm_state	nm_com.nmcom_state
106 #define	nm_mountp	nm_com.nmcom_mountp
107 #define	nm_timeo	nm_com.nmcom_timeo
108 #define	nm_retry	nm_com.nmcom_retry
109 #define	nm_hostname	nm_com.nmcom_hostname
110 #define	nm_getinfo	nm_com.nmcom_getinfo
111 #define	nm_vinvalbuf	nm_com.nmcom_vinvalbuf
112 
113 /* Private flags. */
114 #define	NFSMNTP_FORCEDISM	0x00000001
115 #define	NFSMNTP_CANCELRPCS	0x00000002
116 #define	NFSMNTP_IOADVISETHRUMDS	0x00000004
117 #define	NFSMNTP_NOCOPY		0x00000008
118 #define	NFSMNTP_NOCONSECUTIVE	0x00000010
119 #define	NFSMNTP_SEEK		0x00000020
120 #define	NFSMNTP_SEEKTESTED	0x00000040
121 #define	NFSMNTP_NOXATTR		0x00000080
122 #define	NFSMNTP_NOADVISE	0x00000100
123 #define	NFSMNTP_NOALLOCATE	0x00000200
124 #define	NFSMNTP_DELEGISSUED	0x00000400
125 #define	NFSMNTP_NODEALLOCATE	0x00000800
126 #define	NFSMNTP_FAKEROOTFH	0x00001000
127 #define	NFSMNTP_BUGGYFBSDSRV	0x00002000
128 
129 /* New mount flags only used by the kernel via nmount(2). */
130 #define	NFSMNT_TLS		0x00000001
131 #define	NFSMNT_SYSKRB5		0x00000002
132 
133 #define	NFSMNT_DIRPATH(m)	(&((m)->nm_name[(m)->nm_krbnamelen + 1]))
134 #define	NFSMNT_SRVKRBNAME(m)						\
135 	(&((m)->nm_name[(m)->nm_krbnamelen + (m)->nm_dirpathlen + 2]))
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_DEFAULT_NAMETIMEO
144 #define NFS_DEFAULT_NAMETIMEO		60
145 #endif
146 
147 #ifndef NFS_DEFAULT_NEGNAMETIMEO
148 #define NFS_DEFAULT_NEGNAMETIMEO	60
149 #endif
150 
151 #endif	/* _KERNEL */
152 
153 #endif	/* _NFSCLIENT_NFSMOUNT_H_ */
154