xref: /dragonfly/sys/vfs/nfs/nfsmount.h (revision ae24b5e0)
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  * 3. 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: src/sys/nfs/nfsmount.h,v 1.17 1999/12/29 04:54:54 peter Exp $
34  * $DragonFly: src/sys/vfs/nfs/nfsmount.h,v 1.8 2006/04/07 06:38:33 dillon Exp $
35  */
36 
37 
38 #ifndef _NFS_NFSMOUNT_H_
39 #define _NFS_NFSMOUNT_H_
40 
41 #include <sys/mutex.h>
42 #include <sys/thread.h>	/* token */
43 
44 enum nfssvc_state {
45 	NFSSVC_INIT,
46 	NFSSVC_WAITING,
47 	NFSSVC_PENDING,
48 	NFSSVC_STOPPING,
49 	NFSSVC_DONE
50 };
51 
52 /*
53  * Mount structure.
54  * One allocated on every NFS mount.
55  * Holds NFS specific information for mount.
56  */
57 struct	nfsmount {
58 	int	nm_flag;		/* Flags for soft/hard... */
59 	int	nm_state;		/* Internal state flags */
60 	TAILQ_ENTRY(nfsmount) nm_entry;	/* entry in nfsmountq */
61 	struct mtx    nm_rxlock;	/* receive socket lock */
62 	struct mtx    nm_txlock;	/* send socket lock */
63 	thread_t nm_rxthread;
64 	thread_t nm_txthread;
65 	enum nfssvc_state nm_rxstate;
66 	enum nfssvc_state nm_txstate;
67 	struct	mount *nm_mountp;	/* Vfs structure for this filesystem */
68 	int	nm_numgrps;		/* Max. size of groupslist */
69 	u_char	nm_fh[NFSX_V3FHMAX];	/* File handle of root dir */
70 	int	nm_fhsize;		/* Size of root file handle */
71 	struct	socket *nm_so;		/* Rpc socket */
72 	int	nm_sotype;		/* Type of socket */
73 	int	nm_soproto;		/* and protocol */
74 	int	nm_soflags;		/* pr_flags for socket protocol */
75 	struct	sockaddr *nm_nam;	/* Addr of server */
76 	int	nm_timeo;		/* Init timer for NFSMNT_DUMBTIMR */
77 	int	nm_retry;		/* Max retries */
78 	int	nm_srtt[6];		/* Timers for rpcs (see proct[]) */
79 	int	nm_sdrtt[6];
80 	int	nm_maxasync_scaled;	/* Used to control congestion */
81 	int	nm_timeouts;		/* Request timeouts */
82 	int	nm_deadthresh;		/* Threshold of timeouts-->dead server*/
83 	u_int32_t nm_lastreprocnum;	/* Last resent procnum for dup detect */
84 	int	nm_rsize;		/* Max size of read rpc */
85 	int	nm_wsize;		/* Max size of write rpc */
86 	int	nm_readdirsize;		/* Size of a readdir rpc */
87 	int	nm_readahead;		/* Num. of blocks to readahead */
88 	int	nm_unused01;		/* Term (sec) for NQNFS lease */
89 	int	nm_acdirmin;		/* Directory attr cache min lifetime */
90 	int	nm_acdirmax;		/* Directory attr cache max lifetime */
91 	int	nm_acregmin;		/* Reg file attr cache min lifetime */
92 	int	nm_acregmax;		/* Reg file attr cache max lifetime */
93 	uid_t	nm_authuid;		/* Uid for authenticator */
94 	int	nm_authtype;		/* Authenticator type */
95 	int	nm_authlen;		/* and length */
96 	char	*nm_authstr;		/* Authenticator string */
97 	char	*nm_verfstr;		/* and the verifier */
98 	int	nm_verflen;
99 	u_char	nm_verf[NFSX_V3WRITEVERF]; /* V3 write verifier */
100 	NFSKERBKEY_T nm_key;		/* and the session key */
101 	int	nm_numuids;		/* Number of nfsuid mappings */
102 	TAILQ_HEAD(, nfsuid) nm_uidlruhead; /* Lists of nfsuid mappings */
103 	LIST_HEAD(, nfsuid) nm_uidhashtbl[NFS_MUIDHASHSIZ];
104 	TAILQ_HEAD(, bio) nm_bioq;	/* async io buffer queue */
105 	TAILQ_HEAD(, nfsreq) nm_reqtxq;	/* nfsreq queue - tx processing */
106 	TAILQ_HEAD(, nfsreq) nm_reqrxq;	/* nfsreq queue - rx processing */
107 	TAILQ_HEAD(, nfsreq) nm_reqq;	/* nfsreq queue - pending */
108 	int	nm_bioqlen;		/* number of buffers in queue */
109 	int	nm_reqqlen;		/* number of nfsreqs in queue */
110 	u_int64_t nm_maxfilesize;	/* maximum file size */
111 	struct ucred *nm_cred;		/* 'root' credential */
112 	struct lwkt_token nm_token;	/* protective token */
113 };
114 
115 
116 #if defined(_KERNEL)
117 /*
118  * Convert mount ptr to nfsmount ptr.
119  */
120 #define VFSTONFS(mp)	((struct nfsmount *)((mp)->mnt_data))
121 extern void nfs_free_mount(struct nfsmount *nmp);
122 extern void nfs_setvtype(struct vnode *, enum vtype);
123 
124 #endif
125 
126 #endif
127