2 * Copyright (c) 1989, 1993
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
34 #include <sys/cdefs.h>
35 __FBSDID("$FreeBSD$");
38 * These functions support the macros and help fiddle mbuf chains for
39 * the nfs op functions. They do things like create the rpc header and
40 * copy data between mbuf chains and uio lists.
43 #include <fs/nfs/nfsport.h>
45 extern struct nfsstats newnfsstats;
46 extern struct nfsv4_opflag nfsv4_opflag[NFSV4OP_NOPS];
47 extern int ncl_mbuf_mlen;
48 extern enum vtype newnv2tov_type[8];
49 extern enum vtype nv34tov_type[8];
51 #endif /* !APPLEKEXT */
53 static nfsuint64 nfs_nullcookie = {{ 0, 0 }};
59 } nfsv4_opmap[NFS_NPROCS] = {
61 { NFSV4OP_GETATTR, 1, "Getattr", 7, },
62 { NFSV4OP_SETATTR, 2, "Setattr", 7, },
63 { NFSV4OP_LOOKUP, 3, "Lookup", 6, },
64 { NFSV4OP_ACCESS, 2, "Access", 6, },
65 { NFSV4OP_READLINK, 2, "Readlink", 8, },
66 { NFSV4OP_READ, 1, "Read", 4, },
67 { NFSV4OP_WRITE, 2, "Write", 5, },
68 { NFSV4OP_OPEN, 3, "Open", 4, },
69 { NFSV4OP_CREATE, 3, "Create", 6, },
70 { NFSV4OP_CREATE, 1, "Create", 6, },
71 { NFSV4OP_CREATE, 3, "Create", 6, },
72 { NFSV4OP_REMOVE, 1, "Remove", 6, },
73 { NFSV4OP_REMOVE, 1, "Remove", 6, },
74 { NFSV4OP_SAVEFH, 5, "Rename", 6, },
75 { NFSV4OP_SAVEFH, 4, "Link", 4, },
76 { NFSV4OP_READDIR, 2, "Readdir", 7, },
77 { NFSV4OP_READDIR, 2, "Readdir", 7, },
78 { NFSV4OP_GETATTR, 1, "Getattr", 7, },
79 { NFSV4OP_GETATTR, 1, "Getattr", 7, },
80 { NFSV4OP_GETATTR, 1, "Getattr", 7, },
81 { NFSV4OP_COMMIT, 2, "Commit", 6, },
82 { NFSV4OP_LOOKUPP, 3, "Lookupp", 7, },
83 { NFSV4OP_SETCLIENTID, 1, "SetClientID", 11, },
84 { NFSV4OP_SETCLIENTIDCFRM, 1, "SetClientIDConfirm", 18, },
85 { NFSV4OP_LOCK, 1, "Lock", 4, },
86 { NFSV4OP_LOCKU, 1, "LockU", 5, },
87 { NFSV4OP_OPEN, 2, "Open", 4, },
88 { NFSV4OP_CLOSE, 1, "Close", 5, },
89 { NFSV4OP_OPENCONFIRM, 1, "Openconfirm", 11, },
90 { NFSV4OP_LOCKT, 1, "LockT", 5, },
91 { NFSV4OP_OPENDOWNGRADE, 1, "Opendowngrade", 13, },
92 { NFSV4OP_RENEW, 1, "Renew", 5, },
93 { NFSV4OP_PUTROOTFH, 1, "Dirpath", 7, },
94 { NFSV4OP_RELEASELCKOWN, 1, "Rellckown", 9, },
95 { NFSV4OP_DELEGRETURN, 1, "Delegret", 8, },
96 { NFSV4OP_DELEGRETURN, 3, "DelegRemove", 11, },
97 { NFSV4OP_DELEGRETURN, 7, "DelegRename1", 12, },
98 { NFSV4OP_DELEGRETURN, 9, "DelegRename2", 12, },
99 { NFSV4OP_GETATTR, 1, "Getacl", 6, },
100 { NFSV4OP_SETATTR, 1, "Setacl", 6, },
105 * NFS RPCS that have large request message size.
107 static int nfs_bigrequest[NFS_NPROCS] = {
108 0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
109 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
113 * Start building a request. Mostly just put the first file handle in
117 nfscl_reqstart(struct nfsrv_descript *nd, int procnum, struct nfsmount *nmp,
118 u_int8_t *nfhp, int fhlen, u_int32_t **opcntpp)
123 nfsattrbit_t attrbits;
126 * First, fill in some of the fields of nd.
128 if (NFSHASNFSV4(nmp))
129 nd->nd_flag = ND_NFSV4;
130 else if (NFSHASNFSV3(nmp))
131 nd->nd_flag = ND_NFSV3;
133 nd->nd_flag = ND_NFSV2;
134 nd->nd_procnum = procnum;
138 * Get the first mbuf for the request.
140 if (nfs_bigrequest[procnum])
141 NFSMCLGET(mb, M_WAIT);
145 nd->nd_mreq = nd->nd_mb = mb;
146 nd->nd_bpos = NFSMTOD(mb, caddr_t);
149 * And fill the first file handle into the request.
151 if (nd->nd_flag & ND_NFSV4) {
152 opcnt = nfsv4_opmap[procnum].opcnt +
153 nfsv4_opflag[nfsv4_opmap[procnum].op].needscfh;
155 * What should the tag really be?
157 (void) nfsm_strtom(nd, nfsv4_opmap[procnum].tag,
158 nfsv4_opmap[procnum].taglen);
159 NFSM_BUILD(tl, u_int32_t *, 3 * NFSX_UNSIGNED);
160 *tl++ = txdr_unsigned(NFSV4_MINORVERSION);
163 *tl++ = txdr_unsigned(opcnt);
164 if (nfsv4_opflag[nfsv4_opmap[procnum].op].needscfh > 0) {
165 *tl = txdr_unsigned(NFSV4OP_PUTFH);
166 (void) nfsm_fhtom(nd, nfhp, fhlen, 0);
167 if (nfsv4_opflag[nfsv4_opmap[procnum].op].needscfh==2){
168 NFSM_BUILD(tl, u_int32_t *, NFSX_UNSIGNED);
169 *tl = txdr_unsigned(NFSV4OP_GETATTR);
170 NFSWCCATTR_ATTRBIT(&attrbits);
171 (void) nfsrv_putattrbit(nd, &attrbits);
172 nd->nd_flag |= ND_V4WCCATTR;
174 NFSM_BUILD(tl, u_int32_t *, NFSX_UNSIGNED);
176 *tl = txdr_unsigned(nfsv4_opmap[procnum].op);
178 (void) nfsm_fhtom(nd, nfhp, fhlen, 0);
180 NFSINCRGLOBAL(newnfsstats.rpccnt[procnum]);
185 * copies a uio scatter/gather list to an mbuf chain.
186 * NOTE: can ony handle iovcnt == 1
189 nfsm_uiombuf(struct nfsrv_descript *nd, struct uio *uiop, int siz)
192 struct mbuf *mp, *mp2;
193 int xfer, left, mlen;
194 int uiosiz, clflg, rem;
197 KASSERT(uiop->uio_iovcnt == 1, ("nfsm_uiotombuf: iovcnt != 1"));
199 if (siz > ncl_mbuf_mlen) /* or should it >= MCLBYTES ?? */
203 rem = NFSM_RNDUP(siz) - siz;
204 mp = mp2 = nd->nd_mb;
206 left = uiop->uio_iov->iov_len;
207 uiocp = uiop->uio_iov->iov_base;
212 mlen = M_TRAILINGSPACE(mp);
215 NFSMCLGET(mp, M_WAIT);
219 mbuf_setnext(mp2, mp);
221 mlen = M_TRAILINGSPACE(mp);
223 xfer = (left > mlen) ? mlen : left;
226 if (uiop->uio_iov->iov_op != NULL)
227 (*(uiop->uio_iov->iov_op))
228 (uiocp, NFSMTOD(mp, caddr_t) + mbuf_len(mp),
232 if (uiop->uio_segflg == UIO_SYSSPACE)
233 NFSBCOPY(uiocp, NFSMTOD(mp, caddr_t) + mbuf_len(mp),
236 copyin(CAST_USER_ADDR_T(uiocp), NFSMTOD(mp, caddr_t)
237 + mbuf_len(mp), xfer);
238 mbuf_setlen(mp, mbuf_len(mp) + xfer);
241 uiop->uio_offset += xfer;
242 uiop->uio_resid -= xfer;
244 tcp = (char *)uiop->uio_iov->iov_base;
246 uiop->uio_iov->iov_base = (void *)tcp;
247 uiop->uio_iov->iov_len -= uiosiz;
251 if (rem > M_TRAILINGSPACE(mp)) {
254 mbuf_setnext(mp2, mp);
256 cp = NFSMTOD(mp, caddr_t) + mbuf_len(mp);
257 for (left = 0; left < rem; left++)
259 mbuf_setlen(mp, mbuf_len(mp) + rem);
262 nd->nd_bpos = NFSMTOD(mp, caddr_t) + mbuf_len(mp);
268 * Load vnode attributes from the xdr file attributes.
269 * Returns EBADRPC if they can't be parsed, 0 otherwise.
272 nfsm_loadattr(struct nfsrv_descript *nd, struct nfsvattr *nap)
274 struct nfs_fattr *fp;
277 if (nd->nd_flag & ND_NFSV4) {
278 error = nfsv4_loadattr(nd, NULL, nap, NULL, NULL, 0, NULL,
279 NULL, NULL, NULL, NULL, 0, NULL, NULL, NULL, NULL, NULL);
280 } else if (nd->nd_flag & ND_NFSV3) {
281 NFSM_DISSECT(fp, struct nfs_fattr *, NFSX_V3FATTR);
282 nap->na_type = nfsv34tov_type(fp->fa_type);
283 nap->na_mode = fxdr_unsigned(u_short, fp->fa_mode);
284 nap->na_rdev = makedev(fxdr_unsigned(u_char, fp->fa3_rdev.specdata1),
285 fxdr_unsigned(u_char, fp->fa3_rdev.specdata2));
286 nap->na_nlink = fxdr_unsigned(u_short, fp->fa_nlink);
287 nap->na_uid = fxdr_unsigned(uid_t, fp->fa_uid);
288 nap->na_gid = fxdr_unsigned(gid_t, fp->fa_gid);
289 nap->na_size = fxdr_hyper(&fp->fa3_size);
290 nap->na_blocksize = NFS_FABLKSIZE;
291 nap->na_bytes = fxdr_hyper(&fp->fa3_used);
292 nap->na_fileid = fxdr_unsigned(int32_t,
293 fp->fa3_fileid.nfsuquad[1]);
294 fxdr_nfsv3time(&fp->fa3_atime, &nap->na_atime);
295 fxdr_nfsv3time(&fp->fa3_ctime, &nap->na_ctime);
296 fxdr_nfsv3time(&fp->fa3_mtime, &nap->na_mtime);
300 NFSM_DISSECT(fp, struct nfs_fattr *, NFSX_V2FATTR);
301 nap->na_type = nfsv2tov_type(fp->fa_type);
302 nap->na_mode = fxdr_unsigned(u_short, fp->fa_mode);
303 if (nap->na_type == VNON || nap->na_type == VREG)
304 nap->na_type = IFTOVT(nap->na_mode);
305 nap->na_rdev = fxdr_unsigned(dev_t, fp->fa2_rdev);
308 * Really ugly NFSv2 kludge.
310 if (nap->na_type == VCHR && nap->na_rdev == ((dev_t)-1))
311 nap->na_type = VFIFO;
312 nap->na_nlink = fxdr_unsigned(u_short, fp->fa_nlink);
313 nap->na_uid = fxdr_unsigned(uid_t, fp->fa_uid);
314 nap->na_gid = fxdr_unsigned(gid_t, fp->fa_gid);
315 nap->na_size = fxdr_unsigned(u_int32_t, fp->fa2_size);
316 nap->na_blocksize = fxdr_unsigned(int32_t, fp->fa2_blocksize);
318 (u_quad_t)fxdr_unsigned(int32_t, fp->fa2_blocks) *
320 nap->na_fileid = fxdr_unsigned(int32_t, fp->fa2_fileid);
321 fxdr_nfsv2time(&fp->fa2_atime, &nap->na_atime);
322 fxdr_nfsv2time(&fp->fa2_mtime, &nap->na_mtime);
324 nap->na_ctime.tv_sec = fxdr_unsigned(u_int32_t,
325 fp->fa2_ctime.nfsv2_sec);
326 nap->na_ctime.tv_nsec = 0;
327 nap->na_gen = fxdr_unsigned(u_int32_t,fp->fa2_ctime.nfsv2_usec);
335 * This function finds the directory cookie that corresponds to the
336 * logical byte offset given.
338 APPLESTATIC nfsuint64 *
339 nfscl_getcookie(struct nfsnode *np, off_t off, int add)
341 struct nfsdmap *dp, *dp2;
344 pos = off / NFS_DIRBLKSIZ;
346 KASSERT(!add, ("nfs getcookie add at 0"));
347 return (&nfs_nullcookie);
350 dp = LIST_FIRST(&np->n_cookies);
353 MALLOC(dp, struct nfsdmap *, sizeof (struct nfsdmap),
354 M_NFSDIROFF, M_WAITOK);
355 dp->ndm_eocookie = 0;
356 LIST_INSERT_HEAD(&np->n_cookies, dp, ndm_list);
360 while (pos >= NFSNUMCOOKIES) {
361 pos -= NFSNUMCOOKIES;
362 if (LIST_NEXT(dp, ndm_list) != NULL) {
363 if (!add && dp->ndm_eocookie < NFSNUMCOOKIES &&
364 pos >= dp->ndm_eocookie)
366 dp = LIST_NEXT(dp, ndm_list);
368 MALLOC(dp2, struct nfsdmap *, sizeof (struct nfsdmap),
369 M_NFSDIROFF, M_WAITOK);
370 dp2->ndm_eocookie = 0;
371 LIST_INSERT_AFTER(dp, dp2, ndm_list);
376 if (pos >= dp->ndm_eocookie) {
378 dp->ndm_eocookie = pos + 1;
382 return (&dp->ndm_cookies[pos]);
386 * Gets a file handle out of an nfs reply sent to the client and returns
387 * the file handle and the file's attributes.
388 * For V4, it assumes that Getfh and Getattr Op's results are here.
391 nfscl_mtofh(struct nfsrv_descript *nd, struct nfsfh **nfhpp,
392 struct nfsvattr *nap, int *attrflagp)
395 int error = 0, flag = 1;
400 * First get the file handle and vnode.
402 if (nd->nd_flag & ND_NFSV3) {
403 NFSM_DISSECT(tl, u_int32_t *, NFSX_UNSIGNED);
404 flag = fxdr_unsigned(int, *tl);
405 } else if (nd->nd_flag & ND_NFSV4) {
406 NFSM_DISSECT(tl, u_int32_t *, 2 * NFSX_UNSIGNED);
409 error = nfsm_getfh(nd, nfhpp);
415 * Now, get the attributes.
417 if (nd->nd_flag & ND_NFSV4) {
418 NFSM_DISSECT(tl, u_int32_t *, 2 * NFSX_UNSIGNED);
419 } else if (nd->nd_flag & ND_NFSV3) {
420 NFSM_DISSECT(tl, u_int32_t *, NFSX_UNSIGNED);
422 flag = fxdr_unsigned(int, *tl);
423 } else if (fxdr_unsigned(int, *tl)) {
424 error = nfsm_advance(nd, NFSX_V3FATTR, -1);
430 error = nfsm_loadattr(nd, nap);
439 * Put a state Id in the mbuf list.
442 nfsm_stateidtom(struct nfsrv_descript *nd, nfsv4stateid_t *stateidp, int flag)
446 NFSM_BUILD(st, nfsv4stateid_t *, NFSX_STATEID);
447 if (flag == NFSSTATEID_PUTALLZERO) {
452 } else if (flag == NFSSTATEID_PUTALLONE) {
453 st->seqid = 0xffffffff;
454 st->other[0] = 0xffffffff;
455 st->other[1] = 0xffffffff;
456 st->other[2] = 0xffffffff;
458 st->seqid = stateidp->seqid;
459 st->other[0] = stateidp->other[0];
460 st->other[1] = stateidp->other[1];
461 st->other[2] = stateidp->other[2];
466 * Initialize the owner/delegation sleep lock.
469 nfscl_lockinit(struct nfsv4lock *lckp)
472 lckp->nfslock_usecnt = 0;
473 lckp->nfslock_lock = 0;
477 * Get an exclusive lock. (Not needed for OpenBSD4, since there is only one
478 * thread for each posix process in the kernel.)
481 nfscl_lockexcl(struct nfsv4lock *lckp, void *mutex)
486 igotlock = nfsv4_lock(lckp, 1, NULL, mutex);
491 * Release an exclusive lock.
494 nfscl_lockunlock(struct nfsv4lock *lckp)
497 nfsv4_unlock(lckp, 0);
501 * Called to derefernce a lock on a stateid (delegation or open owner).
504 nfscl_lockderef(struct nfsv4lock *lckp)
508 lckp->nfslock_usecnt--;
509 if (lckp->nfslock_usecnt == 0 && (lckp->nfslock_lock & NFSV4LOCK_WANTED)) {
510 lckp->nfslock_lock &= ~NFSV4LOCK_WANTED;
511 wakeup((caddr_t)lckp);