nfsmount.h revision 336899 
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 * $FreeBSD: stable/10/sys/fs/nfsclient/nfsmount.h 336899 2018-07-30 12:17:10Z rmacklem $
33 */
34
35#ifndef _NFSCLIENT_NFSMOUNT_H_
36#define	_NFSCLIENT_NFSMOUNT_H_
37
38#include <nfs/nfs_mountcommon.h>
39
40/*
41 * Mount structure.
42 * One allocated on every NFS mount.
43 * Holds NFS specific information for mount.
44 */
45struct	nfsmount {
46	struct	nfsmount_common nm_com;	/* Common fields for nlm */
47	int	nm_numgrps;		/* Max. size of groupslist */
48	u_char	nm_fh[NFSX_FHMAX];	/* File handle of root dir */
49	int	nm_fhsize;		/* Size of root file handle */
50	struct	nfssockreq nm_sockreq;	/* Socket Info */
51	int	nm_timeouts;		/* Request timeouts */
52	int	nm_rsize;		/* Max size of read rpc */
53	int	nm_wsize;		/* Max size of write rpc */
54	int	nm_readdirsize;		/* Size of a readdir rpc */
55	int	nm_readahead;		/* Num. of blocks to readahead */
56	int	nm_wcommitsize;		/* Max size of commit for write */
57	int	nm_acdirmin;		/* Directory attr cache min lifetime */
58	int	nm_acdirmax;		/* Directory attr cache max lifetime */
59	int	nm_acregmin;		/* Reg file attr cache min lifetime */
60	int	nm_acregmax;		/* Reg file attr cache max lifetime */
61	u_char	nm_verf[NFSX_VERF];	/* write verifier */
62	TAILQ_HEAD(, buf) nm_bufq;	/* async io buffer queue */
63	short	nm_bufqlen;		/* number of buffers in queue */
64	short	nm_bufqwant;		/* process wants to add to the queue */
65	int	nm_bufqiods;		/* number of iods processing queue */
66	u_int64_t nm_maxfilesize;	/* maximum file size */
67	int	nm_tprintf_initial_delay; /* initial delay */
68	int	nm_tprintf_delay;	/* interval for messages */
69	int	nm_nametimeo;		/* timeout for +ve entries (sec) */
70	int	nm_negnametimeo;	/* timeout for -ve entries (sec) */
71
72	/* Newnfs additions */
73	TAILQ_HEAD(, nfsclds) nm_sess;	/* Session(s) for NFSv4.1. */
74	struct	nfsclclient *nm_clp;
75	uid_t	nm_uid;			/* Uid for SetClientID etc. */
76	u_int64_t nm_clval;		/* identifies which clientid */
77	u_int64_t nm_fsid[2];		/* NFSv4 fsid */
78	int	nm_minorvers;		/* Minor version # for NFSv4 */
79	u_int16_t nm_krbnamelen;	/* Krb5 host principal, if any */
80	u_int16_t nm_dirpathlen;	/* and mount dirpath, for V4 */
81	u_int16_t nm_srvkrbnamelen;	/* and the server's target name */
82	u_char	nm_name[1];	/* malloc'd actual len of krbname + dirpath */
83};
84
85#define	nm_nam		nm_sockreq.nr_nam
86#define	nm_sotype	nm_sockreq.nr_sotype
87#define	nm_so		nm_sockreq.nr_so
88#define	nm_soflags	nm_sockreq.nr_soflags
89#define	nm_soproto	nm_sockreq.nr_soproto
90#define	nm_client	nm_sockreq.nr_client
91#define	nm_krbname	nm_name
92#define	nm_mtx		nm_com.nmcom_mtx
93#define	nm_flag		nm_com.nmcom_flag
94#define	nm_state	nm_com.nmcom_state
95#define	nm_mountp	nm_com.nmcom_mountp
96#define	nm_timeo	nm_com.nmcom_timeo
97#define	nm_retry	nm_com.nmcom_retry
98#define	nm_hostname	nm_com.nmcom_hostname
99#define	nm_getinfo	nm_com.nmcom_getinfo
100#define	nm_vinvalbuf	nm_com.nmcom_vinvalbuf
101
102#define	NFSMNT_DIRPATH(m)	(&((m)->nm_name[(m)->nm_krbnamelen + 1]))
103#define	NFSMNT_SRVKRBNAME(m)						\
104	(&((m)->nm_name[(m)->nm_krbnamelen + (m)->nm_dirpathlen + 2]))
105
106#if defined(_KERNEL)
107/*
108 * Convert mount ptr to nfsmount ptr.
109 */
110#define	VFSTONFS(mp)	((struct nfsmount *)((mp)->mnt_data))
111
112/*
113 * Get a pointer to the MDS session, which is always the first element
114 * in the list.
115 * This macro can only be safely used when the NFSLOCKMNT() lock is held.
116 * The inline function can be used when the lock isn't held.
117 */
118#define	NFSMNT_MDSSESSION(m)	(&(TAILQ_FIRST(&((m)->nm_sess))->nfsclds_sess))
119
120static __inline struct nfsclsession *
121nfsmnt_mdssession(struct nfsmount *nmp)
122{
123	struct nfsclsession *tsep;
124
125	tsep = NULL;
126	mtx_lock(&nmp->nm_mtx);
127	if (TAILQ_FIRST(&nmp->nm_sess) != NULL)
128		tsep = NFSMNT_MDSSESSION(nmp);
129	mtx_unlock(&nmp->nm_mtx);
130	return (tsep);
131}
132
133#ifndef NFS_DEFAULT_NAMETIMEO
134#define NFS_DEFAULT_NAMETIMEO		60
135#endif
136
137#ifndef NFS_DEFAULT_NEGNAMETIMEO
138#define NFS_DEFAULT_NEGNAMETIMEO	60
139#endif
140
141#endif	/* _KERNEL */
142
143#endif	/* _NFSCLIENT_NFSMOUNT_H_ */
144