2 * Copyright (c) 1989, 1993, 1995
3 * The Regents of the University of California. All rights reserved.
5 * This code is derived from software contributed to Berkeley by
6 * Rick Macklem at The University of Guelph.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
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.
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
32 * @(#)nfs.h 8.4 (Berkeley) 5/1/95
36 #ifndef _NFSSERVER_NFS_H_
37 #define _NFSSERVER_NFS_H_
44 * Tunable constants for nfs
47 #define NFS_TICKINTVL 10 /* Desired time for a tick (msec) */
48 #define NFS_HZ (hz / nfs_ticks) /* Ticks/sec */
49 #define NFS_TIMEO (1 * NFS_HZ) /* Default timeout = 1 second */
50 #define NFS_MINTIMEO (1 * NFS_HZ) /* Min timeout to use */
51 #define NFS_MAXTIMEO (60 * NFS_HZ) /* Max timeout to backoff to */
52 #define NFS_MINIDEMTIMEO (5 * NFS_HZ) /* Min timeout for non-idempotent ops*/
53 #define NFS_MAXUIDHASH 64 /* Max. # of hashed uid entries/mp */
54 #ifndef NFS_GATHERDELAY
55 #define NFS_GATHERDELAY 10 /* Default write gather delay (msec) */
58 #define DIRBLKSIZ 512 /* XXX we used to use ufs's DIRBLKSIZ */
64 #define NFS_SRVMAXDATA(n) \
65 (((n)->nd_flag & ND_NFSV3) ? (((n)->nd_nam2) ? \
66 NFS_MAXDGRAMDATA : NFS_MAXDATA) : NFS_V2MAXDATA)
70 * The B_INVAFTERWRITE flag should be set to whatever is required by the
71 * buffer cache code to say "Invalidate the block after it is written back".
73 #define B_INVAFTERWRITE B_NOCACHE
76 * The IO_METASYNC flag should be implemented for local filesystems.
77 * (Until then, it is nothin at all.)
84 /* NFS state flags XXX -Wunused */
85 #define NFSRV_SNDLOCK 0x01000000 /* Send socket lock */
86 #define NFSRV_WANTSND 0x02000000 /* Want above */
89 * Structures for the nfssvc(2) syscall. Not that anyone but nfsd and mount_nfs
90 * should ever try and use it.
93 int sock; /* Socket to serve */
94 caddr_t name; /* Client addr for connection based sockets */
95 int namelen; /* Length of name */
99 * XXX to allow amd to include nfs.h without nfsproto.h
102 #include <nfsserver/nfsrvstats.h>
106 * Flags for nfssvc() system call.
108 #define NFSSVC_NFSD 0x004
109 #define NFSSVC_ADDSOCK 0x008
112 * vfs.nfsrv sysctl(3) identifiers
114 #define NFS_NFSRVSTATS 1 /* struct: struct nfsrvstats */
115 #define NFS_NFSPRIVPORT 2 /* int: prohibit nfs to resvports */
119 extern struct mtx nfsd_mtx;
120 #define NFSD_LOCK_ASSERT() mtx_assert(&nfsd_mtx, MA_OWNED)
121 #define NFSD_UNLOCK_ASSERT() mtx_assert(&nfsd_mtx, MA_NOTOWNED)
122 #define NFSD_LOCK_DONTCARE()
123 #define NFSD_LOCK() mtx_lock(&nfsd_mtx)
124 #define NFSD_UNLOCK() mtx_unlock(&nfsd_mtx)
126 #ifdef MALLOC_DECLARE
127 MALLOC_DECLARE(M_NFSRVDESC);
128 MALLOC_DECLARE(M_NFSD);
131 /* Forward declarations */
133 struct nfsrv_descript;
138 extern struct callout nfsrv_callout;
139 extern struct nfsrvstats nfsrvstats;
141 extern int nfsrv_ticks;
142 extern int nfsrvw_procrastinate;
143 extern int nfsrvw_procrastinate_v3;
144 extern int nfsrv_numnfsd;
146 /* Various values converted to XDR form. */
147 extern u_int32_t nfsrv_nfs_false, nfsrv_nfs_true, nfsrv_nfs_xdrneg1,
149 extern u_int32_t nfsrv_rpc_reply, nfsrv_rpc_msgdenied, nfsrv_rpc_mismatch,
151 extern u_int32_t nfsrv_rpc_auth_unix, nfsrv_rpc_msgaccepted, nfsrv_rpc_call,
154 /* Procedure table data */
155 extern const int nfsrvv2_procid[NFS_NPROCS];
156 extern const int nfsrv_nfsv3_procid[NFS_NPROCS];
157 extern int32_t (*nfsrv3_procs[NFS_NPROCS])(struct nfsrv_descript *nd,
158 struct nfssvc_sock *slp, struct mbuf **mreqp);
161 * A list of nfssvc_sock structures is maintained with all the sockets
162 * that require service by the nfsd.
164 #ifndef NFS_WDELAYHASHSIZ
165 #define NFS_WDELAYHASHSIZ 16 /* and with this */
167 #define NWDELAYHASH(sock, f) \
168 (&(sock)->ns_wdelayhashtbl[(*((u_int32_t *)(f))) % NFS_WDELAYHASHSIZ])
171 * Network address hash list element
174 u_int32_t had_inetaddr;
175 struct sockaddr *had_nam;
179 STAILQ_ENTRY(nfsrv_rec) nr_link;
180 struct sockaddr *nr_address;
181 struct mbuf *nr_packet;
185 TAILQ_ENTRY(nfssvc_sock) ns_chain; /* List of all nfssvc_sock's */
187 struct socket *ns_so;
188 struct sockaddr *ns_nam;
190 struct mbuf *ns_rawend;
191 STAILQ_HEAD(, nfsrv_rec) ns_rec;
192 struct mbuf *ns_frag;
198 LIST_HEAD(, nfsrv_descript) ns_tq; /* Write gather lists */
199 LIST_HEAD(nfsrvw_delayhash, nfsrv_descript) ns_wdelayhashtbl[NFS_WDELAYHASHSIZ];
202 /* Bits for "ns_flag" */
203 #define SLP_VALID 0x01 /* Socket valid for use (XXX) */
204 #define SLP_DOREC 0x02 /* Socket ready for processing */
205 #define SLP_NEEDQ 0x04 /* Socket has request queued */
206 #define SLP_DISCONN 0x08 /* Error received from stream socket */
207 #define SLP_GETSTREAM 0x10 /* nfsrv_getstream in prog on sock */
208 #define SLP_LASTFRAG 0x20 /* Socket received end-of-record */
209 #define SLP_ALLFLAGS 0xff
211 extern TAILQ_HEAD(nfssvc_sockhead, nfssvc_sock) nfssvc_sockhead;
212 extern int nfssvc_sockhead_flag;
213 #define SLP_INIT 0x01
214 #define SLP_WANTINIT 0x02
217 * One of these structures is allocated for each nfsd.
220 TAILQ_ENTRY(nfsd) nfsd_chain; /* List of all nfsd's */
221 int nfsd_flag; /* NFSD_ flags */
222 struct nfssvc_sock *nfsd_slp; /* Current socket */
223 int nfsd_authlen; /* Authenticator len */
224 u_char nfsd_authstr[RPCAUTH_MAXSIZ]; /* Authenticator data */
225 int nfsd_verflen; /* and the Verifier */
226 u_char nfsd_verfstr[RPCVERF_MAXSIZ];
227 struct nfsrv_descript *nfsd_nd; /* Associated nfsrv_descript */
230 /* Bits for "nfsd_flag" */
231 #define NFSD_WAITING 0x01
232 #define NFSD_REQINPROG 0x02
235 * This structure is used by the server for describing each request.
236 * Some fields are used only when write request gathering is performed.
238 struct nfsrv_descript {
239 u_quad_t nd_time; /* Write deadline (usec) */
240 off_t nd_off; /* Start byte offset */
241 off_t nd_eoff; /* and end byte offset */
242 LIST_ENTRY(nfsrv_descript) nd_hash; /* Hash list */
243 LIST_ENTRY(nfsrv_descript) nd_tq; /* and timer list */
244 LIST_HEAD(, nfsrv_descript) nd_coalesce;/* coalesced writes */
245 struct mbuf *nd_mrep; /* Request mbuf list */
246 struct mbuf *nd_md; /* Current dissect mbuf */
247 struct mbuf *nd_mreq; /* Reply mbuf list */
248 struct sockaddr *nd_nam; /* and socket addr */
249 struct sockaddr *nd_nam2; /* return socket addr */
250 caddr_t nd_dpos; /* Current dissect pos */
251 u_int32_t nd_procnum; /* RPC # */
252 int nd_stable; /* storage type */
253 int nd_flag; /* nd_flag */
254 int nd_len; /* Length of this write */
255 int nd_repstat; /* Reply status */
256 u_int32_t nd_retxid; /* Reply xid */
257 struct timeval nd_starttime; /* Time RPC initiated */
258 fhandle_t nd_fh; /* File handle */
259 struct ucred *nd_cr; /* Credentials */
262 /* Bits for "nd_flag" */
263 #define ND_NFSV3 0x08
265 extern TAILQ_HEAD(nfsd_head, nfsd) nfsd_head;
266 extern int nfsd_head_flag;
267 #define NFSD_CHECKSLP 0x01
270 * These macros compare nfsrv_descript structures.
272 #define NFSW_CONTIG(o, n) \
273 ((o)->nd_eoff >= (n)->nd_off && \
274 !bcmp((caddr_t)&(o)->nd_fh, (caddr_t)&(n)->nd_fh, NFSX_V3FH))
280 #define WEBNFS_ESC_CHAR '%'
281 #define WEBNFS_SPECCHAR_START 0x80
283 #define WEBNFS_NATIVE_CHAR 0x80
286 * Possibly more here in the future.
290 * Macro for converting escape characters in WebNFS pathnames.
291 * Should really be in libkern.
295 ((c) >= 'a' ? ((c) - ('a' - 10)) : \
296 ((c) >= 'A' ? ((c) - ('A' - 10)) : ((c) - '0')))
297 #define HEXSTRTOI(p) \
298 ((HEXTOC(p[0]) << 4) + HEXTOC(p[1]))
302 extern int nfs_debug;
303 #define NFS_DEBUG_ASYNCIO 1 /* asynchronous i/o */
304 #define NFS_DEBUG_WG 2 /* server write gathering */
305 #define NFS_DEBUG_RC 4 /* server request caching */
307 #define NFS_DPF(cat, args) \
309 if (nfs_debug & NFS_DEBUG_##cat) printf args; \
314 #define NFS_DPF(cat, args)
318 int nfs_getreq(struct nfsrv_descript *, struct nfsd *, int);
319 int nfsrv_send(struct socket *, struct sockaddr *, struct mbuf *);
320 struct mbuf *nfs_rephead(int, struct nfsrv_descript *, int, struct mbuf **,
322 int nfs_slplock(struct nfssvc_sock *, int);
323 void nfs_slpunlock(struct nfssvc_sock *);
324 void nfsm_srvfattr(struct nfsrv_descript *, struct vattr *,
326 void nfsm_srvwcc(struct nfsrv_descript *, int, struct vattr *, int,
327 struct vattr *, struct mbuf **, char **);
328 void nfsm_srvpostopattr(struct nfsrv_descript *, int, struct vattr *,
329 struct mbuf **, char **);
330 int netaddr_match(int, union nethostaddr *, struct sockaddr *);
331 int nfs_namei(struct nameidata *, fhandle_t *, int,
332 struct nfssvc_sock *, struct sockaddr *, struct mbuf **,
333 caddr_t *, struct vnode **, int, struct vattr *, int *, int);
334 void nfsm_adj(struct mbuf *, int, int);
335 int nfsm_mbuftouio(struct mbuf **, struct uio *, int, caddr_t *);
336 void nfsrv_initcache(void);
337 void nfsrv_destroycache(void);
338 void nfsrv_timer(void *);
339 int nfsrv_dorec(struct nfssvc_sock *, struct nfsd *,
340 struct nfsrv_descript **);
341 int nfsrv_getcache(struct nfsrv_descript *, struct mbuf **);
342 void nfsrv_updatecache(struct nfsrv_descript *, int, struct mbuf *);
343 void nfsrv_cleancache(void);
344 void nfsrv_init(int);
345 int nfsrv_errmap(struct nfsrv_descript *, int);
346 void nfsrvw_sort(gid_t *, int);
347 void nfsrv_wakenfsd(struct nfssvc_sock *slp);
348 int nfsrv_writegather(struct nfsrv_descript **, struct nfssvc_sock *,
351 int nfsrv3_access(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
353 int nfsrv_commit(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
355 int nfsrv_create(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
357 int nfsrv_fhtovp(fhandle_t *, int, struct vnode **, int *, struct ucred *,
358 struct nfssvc_sock *, struct sockaddr *, int *, int);
359 int nfsrv_setpublicfs(struct mount *, struct netexport *,
360 struct export_args *);
361 int nfs_ispublicfh(fhandle_t *);
362 int nfsrv_fsinfo(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
364 int nfsrv_getattr(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
366 int nfsrv_link(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
368 int nfsrv_lookup(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
370 int nfsrv_mkdir(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
372 int nfsrv_mknod(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
374 int nfsrv_noop(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
376 int nfsrv_null(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
378 int nfsrv_pathconf(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
380 int nfsrv_read(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
382 int nfsrv_readdir(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
384 int nfsrv_readdirplus(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
386 int nfsrv_readlink(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
388 int nfsrv_remove(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
390 int nfsrv_rename(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
392 int nfsrv_rmdir(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
394 int nfsrv_setattr(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
396 int nfsrv_statfs(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
398 int nfsrv_symlink(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
400 int nfsrv_write(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
402 void nfsrv_rcv(struct socket *so, void *arg, int waitflag);
403 void nfsrv_slpderef(struct nfssvc_sock *slp);