nfsmount.h revision 1.23 1 /* $NetBSD: nfsmount.h,v 1.23 2003/04/09 14:21:24 yamt Exp $ */
2
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. All advertising materials mentioning features or use of this software
19 * must display the following acknowledgement:
20 * This product includes software developed by the University of
21 * California, Berkeley and its contributors.
22 * 4. Neither the name of the University nor the names of its contributors
23 * may be used to endorse or promote products derived from this software
24 * without specific prior written permission.
25 *
26 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
27 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
30 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36 * SUCH DAMAGE.
37 *
38 * @(#)nfsmount.h 8.3 (Berkeley) 3/30/95
39 */
40
41
42 #ifndef _NFS_NFSMOUNT_H_
43 #define _NFS_NFSMOUNT_H_
44
45 /*
46 * Arguments to mount NFS
47 */
48 #define NFS_ARGSVERSION 3 /* change when nfs_args changes */
49 struct nfs_args {
50 int version; /* args structure version number */
51 struct sockaddr *addr; /* file server address */
52 int addrlen; /* length of address */
53 int sotype; /* Socket type */
54 int proto; /* and Protocol */
55 u_char *fh; /* File handle to be mounted */
56 int fhsize; /* Size, in bytes, of fh */
57 int flags; /* flags */
58 int wsize; /* write size in bytes */
59 int rsize; /* read size in bytes */
60 int readdirsize; /* readdir size in bytes */
61 int timeo; /* initial timeout in .1 secs */
62 int retrans; /* times to retry send */
63 int maxgrouplist; /* Max. size of group list */
64 int readahead; /* # of blocks to readahead */
65 int leaseterm; /* Term (sec) of lease */
66 int deadthresh; /* Retrans threshold */
67 char *hostname; /* server's name */
68 };
69
70 /*
71 * NFS mount option flags (nm_flag)
72 */
73 #define NFSMNT_SOFT 0x00000001 /* soft mount (hard is default) */
74 #define NFSMNT_WSIZE 0x00000002 /* set write size */
75 #define NFSMNT_RSIZE 0x00000004 /* set read size */
76 #define NFSMNT_TIMEO 0x00000008 /* set initial timeout */
77 #define NFSMNT_RETRANS 0x00000010 /* set number of request retries */
78 #define NFSMNT_MAXGRPS 0x00000020 /* set maximum grouplist size */
79 #define NFSMNT_INT 0x00000040 /* allow interrupts on hard mount */
80 #define NFSMNT_NOCONN 0x00000080 /* Don't Connect the socket */
81 #define NFSMNT_NQNFS 0x00000100 /* Use Nqnfs protocol */
82 #define NFSMNT_NFSV3 0x00000200 /* Use NFS Version 3 protocol */
83 #define NFSMNT_KERB 0x00000400 /* Use Kerberos authentication */
84 #define NFSMNT_DUMBTIMR 0x00000800 /* Don't estimate rtt dynamically */
85 #define NFSMNT_LEASETERM 0x00001000 /* set lease term (nqnfs) */
86 #define NFSMNT_READAHEAD 0x00002000 /* set read ahead */
87 #define NFSMNT_DEADTHRESH 0x00004000 /* set dead server retry thresh */
88 #define NFSMNT_RESVPORT 0x00008000 /* Allocate a reserved port */
89 #define NFSMNT_RDIRPLUS 0x00010000 /* Use Readdirplus for V3 */
90 #define NFSMNT_READDIRSIZE 0x00020000 /* Set readdir size */
91 #define NFSMNT_XLATECOOKIE 0x00040000 /* 32<->64 dir cookie xlation */
92
93 #define NFSMNT_BITS "\177\20" \
94 "b\00soft\0b\01wsize\0b\02rsize\0b\03timeo\0" \
95 "b\04retrans\0b\05maxgrps\0b\06intr\0b\07noconn\0" \
96 "b\10nqnfs\0b\11nfsv3\0b\12kerb\0b\13dumbtimr\0" \
97 "b\14leaseterm\0b\15readahead\0b\16deadthresh\0b\17resvport\0" \
98 "b\20rdirplus\0b\21readdirsize\0b\22xlatecookie"
99
100 /*
101 * NFS internal flags (nm_iflag) */
102
103 #define NFSMNT_HASWRITEVERF 0x00000001 /* Has write verifier for V3 */
104 #define NFSMNT_GOTPATHCONF 0x00000002 /* Got the V3 pathconf info */
105 #define NFSMNT_GOTFSINFO 0x00000004 /* Got the V3 fsinfo */
106 #define NFSMNT_MNTD 0x00000008 /* Mnt server for mnt point */
107 #define NFSMNT_DISMINPROG 0x00000010 /* Dismount in progress */
108 #define NFSMNT_DISMNT 0x00000020 /* Dismounted */
109 #define NFSMNT_SNDLOCK 0x00000040 /* Send socket lock */
110 #define NFSMNT_WANTSND 0x00000080 /* Want above */
111 #define NFSMNT_RCVLOCK 0x00000100 /* Rcv socket lock */
112 #define NFSMNT_WANTRCV 0x00000200 /* Want above */
113 #define NFSMNT_WAITAUTH 0x00000400 /* Wait for authentication */
114 #define NFSMNT_HASAUTH 0x00000800 /* Has authenticator */
115 #define NFSMNT_WANTAUTH 0x00001000 /* Wants an authenticator */
116 #define NFSMNT_AUTHERR 0x00002000 /* Authentication error */
117 #define NFSMNT_SWAPCOOKIE 0x00004000 /* XDR encode dir cookies */
118
119 #ifdef _KERNEL
120 /*
121 * Mount structure.
122 * One allocated on every NFS mount.
123 * Holds NFS specific information for mount.
124 */
125 struct nfsmount {
126 int nm_flag; /* Flags for soft/hard... */
127 struct mount *nm_mountp; /* Vfs structure for this filesystem */
128 int nm_numgrps; /* Max. size of groupslist */
129 struct vnode *nm_vnode;
130 struct socket *nm_so; /* Rpc socket */
131 int nm_sotype; /* Type of socket */
132 int nm_soproto; /* and protocol */
133 int nm_soflags; /* pr_flags for socket protocol */
134 struct mbuf *nm_nam; /* Addr of server */
135 int nm_timeo; /* Init timer for NFSMNT_DUMBTIMR */
136 int nm_retry; /* Max retries */
137 int nm_srtt[4]; /* Timers for rpcs */
138 int nm_sdrtt[4];
139 int nm_sent; /* Request send count */
140 int nm_cwnd; /* Request send window */
141 int nm_timeouts; /* Request timeouts */
142 int nm_deadthresh; /* Threshold of timeouts-->dead server*/
143 int nm_rsize; /* Max size of read rpc */
144 int nm_wsize; /* Max size of write rpc */
145 int nm_readdirsize; /* Size of a readdir rpc */
146 int nm_readahead; /* Num. of blocks to readahead */
147 int nm_leaseterm; /* Term (sec) for NQNFS lease */
148 CIRCLEQ_HEAD(, nfsnode) nm_timerhead; /* Head of lease timer queue */
149 struct vnode *nm_inprog; /* Vnode in prog by nqnfs_clientd() */
150 uid_t nm_authuid; /* Uid for authenticator */
151 int nm_authtype; /* Authenticator type */
152 int nm_authlen; /* and length */
153 char *nm_authstr; /* Authenticator string */
154 char *nm_verfstr; /* and the verifier */
155 int nm_verflen;
156 u_char nm_writeverf[NFSX_V3WRITEVERF]; /* V3 write verifier */
157 NFSKERBKEY_T nm_key; /* and the session key */
158 int nm_numuids; /* Number of nfsuid mappings */
159 TAILQ_HEAD(, nfsuid) nm_uidlruhead; /* Lists of nfsuid mappings */
160 LIST_HEAD(, nfsuid) nm_uidhashtbl[NFS_MUIDHASHSIZ];
161 TAILQ_HEAD(, buf) nm_bufq; /* async io buffer queue */
162 short nm_bufqlen; /* number of buffers in queue */
163 short nm_bufqwant; /* process wants to add to the queue */
164 int nm_bufqiods; /* number of iods processing queue */
165 u_int64_t nm_maxfilesize; /* maximum file size */
166 int nm_iflag; /* internal flags */
167 int nm_waiters; /* number of waiting listeners.. */
168 };
169
170 /*
171 * Convert mount ptr to nfsmount ptr.
172 */
173 #define VFSTONFS(mp) ((struct nfsmount *)((mp)->mnt_data))
174
175 /*
176 * Prototypes for NFS mount operations
177 */
178 int nfs_mount __P((struct mount *mp, const char *path, void *data,
179 struct nameidata *ndp, struct proc *p));
180 int mountnfs __P((struct nfs_args *argp, struct mount *mp,
181 struct mbuf *nam, const char *pth, const char *hst,
182 struct vnode **vpp, struct proc *p));
183 int nfs_mountroot __P((void));
184 void nfs_decode_args __P((struct nfsmount *, struct nfs_args *));
185 int nfs_start __P((struct mount *mp, int flags, struct proc *p));
186 int nfs_unmount __P((struct mount *mp, int mntflags, struct proc *p));
187 int nfs_root __P((struct mount *mp, struct vnode **vpp));
188 int nfs_quotactl __P((struct mount *mp, int cmds, uid_t uid, caddr_t arg,
189 struct proc *p));
190 int nfs_statfs __P((struct mount *mp, struct statfs *sbp, struct proc *p));
191 int nfs_sync __P((struct mount *mp, int waitfor, struct ucred *cred,
192 struct proc *p));
193 int nfs_vget __P((struct mount *, ino_t, struct vnode **));
194 int nfs_fhtovp __P((struct mount *mp, struct fid *fhp, struct vnode **vpp));
195 int nfs_checkexp __P((struct mount *mp, struct mbuf *nam, int *exflagsp,
196 struct ucred **credanonp));
197 int nfs_vptofh __P((struct vnode *vp, struct fid *fhp));
198 int nfs_fsinfo __P((struct nfsmount *, struct vnode *, struct ucred *,
199 struct proc *));
200 void nfs_vfs_init __P((void));
201 void nfs_vfs_reinit __P((void));
202 void nfs_vfs_done __P((void));
203
204 /*
205 * Prototypes for miscellaneous exported NFS functions.
206 */
207 void nfs_init __P((void));
208
209 #endif /* _KERNEL */
210
211 #endif
212