2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 1989, 1993
5 * The Regents of the University of California. All rights reserved.
7 * This code is derived from software contributed to Berkeley by
8 * Rick Macklem at The University of Guelph.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
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. Neither the name of the University nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36 #include <sys/cdefs.h>
37 __FBSDID("$FreeBSD$");
40 * These functions support the macros and help fiddle mbuf chains for
41 * the nfs op functions. They do things like create the rpc header and
42 * copy data between mbuf chains and uio lists.
45 #include <fs/nfs/nfsport.h>
47 extern struct nfsstatsv1 nfsstatsv1;
48 extern struct nfsv4_opflag nfsv4_opflag[NFSV41_NOPS];
49 extern int ncl_mbuf_mlen;
50 extern enum vtype newnv2tov_type[8];
51 extern enum vtype nv34tov_type[8];
53 #endif /* !APPLEKEXT */
55 static nfsuint64 nfs_nullcookie = {{ 0, 0 }};
58 * copies a uio scatter/gather list to an mbuf chain.
59 * NOTE: can ony handle iovcnt == 1
62 nfsm_uiombuf(struct nfsrv_descript *nd, struct uio *uiop, int siz)
65 struct mbuf *mp, *mp2;
67 int uiosiz, clflg, rem;
70 KASSERT(uiop->uio_iovcnt == 1, ("nfsm_uiotombuf: iovcnt != 1"));
72 if (siz > ncl_mbuf_mlen) /* or should it >= MCLBYTES ?? */
76 rem = NFSM_RNDUP(siz) - siz;
79 left = uiop->uio_iov->iov_len;
80 uiocp = uiop->uio_iov->iov_base;
85 mlen = M_TRAILINGSPACE(mp);
88 NFSMCLGET(mp, M_WAITOK);
92 mbuf_setnext(mp2, mp);
94 mlen = M_TRAILINGSPACE(mp);
96 xfer = (left > mlen) ? mlen : left;
99 if (uiop->uio_iov->iov_op != NULL)
100 (*(uiop->uio_iov->iov_op))
101 (uiocp, NFSMTOD(mp, caddr_t) + mbuf_len(mp),
105 if (uiop->uio_segflg == UIO_SYSSPACE)
106 NFSBCOPY(uiocp, NFSMTOD(mp, caddr_t) + mbuf_len(mp),
109 copyin(CAST_USER_ADDR_T(uiocp), NFSMTOD(mp, caddr_t)
110 + mbuf_len(mp), xfer);
111 mbuf_setlen(mp, mbuf_len(mp) + xfer);
114 uiop->uio_offset += xfer;
115 uiop->uio_resid -= xfer;
117 tcp = (char *)uiop->uio_iov->iov_base;
119 uiop->uio_iov->iov_base = (void *)tcp;
120 uiop->uio_iov->iov_len -= uiosiz;
124 if (rem > M_TRAILINGSPACE(mp)) {
127 mbuf_setnext(mp2, mp);
129 cp = NFSMTOD(mp, caddr_t) + mbuf_len(mp);
130 for (left = 0; left < rem; left++)
132 mbuf_setlen(mp, mbuf_len(mp) + rem);
135 nd->nd_bpos = NFSMTOD(mp, caddr_t) + mbuf_len(mp);
140 * copies a uio scatter/gather list to an mbuf chain.
141 * This version returns the mbuf list and does not use "nd".
142 * NOTE: can ony handle iovcnt == 1
145 nfsm_uiombuflist(struct uio *uiop, int siz, struct mbuf **mbp, char **cpp)
148 struct mbuf *mp, *mp2, *firstmp;
149 int xfer, left, mlen;
153 KASSERT(uiop->uio_iovcnt == 1, ("nfsm_uiotombuf: iovcnt != 1"));
155 if (siz > ncl_mbuf_mlen) /* or should it >= MCLBYTES ?? */
160 NFSMCLGET(mp, M_WAITOK);
166 left = uiop->uio_iov->iov_len;
167 uiocp = uiop->uio_iov->iov_base;
172 mlen = M_TRAILINGSPACE(mp);
175 NFSMCLGET(mp, M_WAITOK);
179 mbuf_setnext(mp2, mp);
181 mlen = M_TRAILINGSPACE(mp);
183 xfer = (left > mlen) ? mlen : left;
184 if (uiop->uio_segflg == UIO_SYSSPACE)
185 NFSBCOPY(uiocp, NFSMTOD(mp, caddr_t) +
188 copyin(uiocp, NFSMTOD(mp, caddr_t) +
190 mbuf_setlen(mp, mbuf_len(mp) + xfer);
193 uiop->uio_offset += xfer;
194 uiop->uio_resid -= xfer;
196 tcp = (char *)uiop->uio_iov->iov_base;
198 uiop->uio_iov->iov_base = (void *)tcp;
199 uiop->uio_iov->iov_len -= uiosiz;
203 *cpp = NFSMTOD(mp, caddr_t) + mbuf_len(mp);
210 * Load vnode attributes from the xdr file attributes.
211 * Returns EBADRPC if they can't be parsed, 0 otherwise.
214 nfsm_loadattr(struct nfsrv_descript *nd, struct nfsvattr *nap)
216 struct nfs_fattr *fp;
219 if (nd->nd_flag & ND_NFSV4) {
220 error = nfsv4_loadattr(nd, NULL, nap, NULL, NULL, 0, NULL,
221 NULL, NULL, NULL, NULL, 0, NULL, NULL, NULL, NULL, NULL);
222 } else if (nd->nd_flag & ND_NFSV3) {
223 NFSM_DISSECT(fp, struct nfs_fattr *, NFSX_V3FATTR);
224 nap->na_type = nfsv34tov_type(fp->fa_type);
225 nap->na_mode = fxdr_unsigned(u_short, fp->fa_mode);
226 nap->na_rdev = NFSMAKEDEV(
227 fxdr_unsigned(int, fp->fa3_rdev.specdata1),
228 fxdr_unsigned(int, fp->fa3_rdev.specdata2));
229 nap->na_nlink = fxdr_unsigned(uint32_t, fp->fa_nlink);
230 nap->na_uid = fxdr_unsigned(uid_t, fp->fa_uid);
231 nap->na_gid = fxdr_unsigned(gid_t, fp->fa_gid);
232 nap->na_size = fxdr_hyper(&fp->fa3_size);
233 nap->na_blocksize = NFS_FABLKSIZE;
234 nap->na_bytes = fxdr_hyper(&fp->fa3_used);
235 nap->na_fileid = fxdr_hyper(&fp->fa3_fileid);
236 fxdr_nfsv3time(&fp->fa3_atime, &nap->na_atime);
237 fxdr_nfsv3time(&fp->fa3_ctime, &nap->na_ctime);
238 fxdr_nfsv3time(&fp->fa3_mtime, &nap->na_mtime);
242 NFSM_DISSECT(fp, struct nfs_fattr *, NFSX_V2FATTR);
243 nap->na_type = nfsv2tov_type(fp->fa_type);
244 nap->na_mode = fxdr_unsigned(u_short, fp->fa_mode);
245 if (nap->na_type == VNON || nap->na_type == VREG)
246 nap->na_type = IFTOVT(nap->na_mode);
247 nap->na_rdev = fxdr_unsigned(dev_t, fp->fa2_rdev);
250 * Really ugly NFSv2 kludge.
252 if (nap->na_type == VCHR && nap->na_rdev == ((dev_t)-1))
253 nap->na_type = VFIFO;
254 nap->na_nlink = fxdr_unsigned(u_short, fp->fa_nlink);
255 nap->na_uid = fxdr_unsigned(uid_t, fp->fa_uid);
256 nap->na_gid = fxdr_unsigned(gid_t, fp->fa_gid);
257 nap->na_size = fxdr_unsigned(u_int32_t, fp->fa2_size);
258 nap->na_blocksize = fxdr_unsigned(int32_t, fp->fa2_blocksize);
260 (u_quad_t)fxdr_unsigned(int32_t, fp->fa2_blocks) *
262 nap->na_fileid = fxdr_unsigned(uint64_t, fp->fa2_fileid);
263 fxdr_nfsv2time(&fp->fa2_atime, &nap->na_atime);
264 fxdr_nfsv2time(&fp->fa2_mtime, &nap->na_mtime);
266 nap->na_ctime.tv_sec = fxdr_unsigned(u_int32_t,
267 fp->fa2_ctime.nfsv2_sec);
268 nap->na_ctime.tv_nsec = 0;
269 nap->na_gen = fxdr_unsigned(u_int32_t,fp->fa2_ctime.nfsv2_usec);
277 * This function finds the directory cookie that corresponds to the
278 * logical byte offset given.
280 APPLESTATIC nfsuint64 *
281 nfscl_getcookie(struct nfsnode *np, off_t off, int add)
283 struct nfsdmap *dp, *dp2;
286 pos = off / NFS_DIRBLKSIZ;
288 KASSERT(!add, ("nfs getcookie add at 0"));
289 return (&nfs_nullcookie);
292 dp = LIST_FIRST(&np->n_cookies);
295 dp = malloc(sizeof (struct nfsdmap),
296 M_NFSDIROFF, M_WAITOK);
297 dp->ndm_eocookie = 0;
298 LIST_INSERT_HEAD(&np->n_cookies, dp, ndm_list);
302 while (pos >= NFSNUMCOOKIES) {
303 pos -= NFSNUMCOOKIES;
304 if (LIST_NEXT(dp, ndm_list) != NULL) {
305 if (!add && dp->ndm_eocookie < NFSNUMCOOKIES &&
306 pos >= dp->ndm_eocookie)
308 dp = LIST_NEXT(dp, ndm_list);
310 dp2 = malloc(sizeof (struct nfsdmap),
311 M_NFSDIROFF, M_WAITOK);
312 dp2->ndm_eocookie = 0;
313 LIST_INSERT_AFTER(dp, dp2, ndm_list);
318 if (pos >= dp->ndm_eocookie) {
320 dp->ndm_eocookie = pos + 1;
324 return (&dp->ndm_cookies[pos]);
328 * Gets a file handle out of an nfs reply sent to the client and returns
329 * the file handle and the file's attributes.
330 * For V4, it assumes that Getfh and Getattr Op's results are here.
333 nfscl_mtofh(struct nfsrv_descript *nd, struct nfsfh **nfhpp,
334 struct nfsvattr *nap, int *attrflagp)
337 int error = 0, flag = 1;
342 * First get the file handle and vnode.
344 if (nd->nd_flag & ND_NFSV3) {
345 NFSM_DISSECT(tl, u_int32_t *, NFSX_UNSIGNED);
346 flag = fxdr_unsigned(int, *tl);
347 } else if (nd->nd_flag & ND_NFSV4) {
348 NFSM_DISSECT(tl, u_int32_t *, 2 * NFSX_UNSIGNED);
349 /* If the GetFH failed, clear flag. */
351 nd->nd_flag |= ND_NOMOREDATA;
353 error = ENXIO; /* Return ENXIO so *nfhpp isn't used. */
357 error = nfsm_getfh(nd, nfhpp);
363 * Now, get the attributes.
365 if (flag != 0 && (nd->nd_flag & ND_NFSV4) != 0) {
366 NFSM_DISSECT(tl, u_int32_t *, 2 * NFSX_UNSIGNED);
368 nd->nd_flag |= ND_NOMOREDATA;
371 } else if (nd->nd_flag & ND_NFSV3) {
372 NFSM_DISSECT(tl, u_int32_t *, NFSX_UNSIGNED);
374 flag = fxdr_unsigned(int, *tl);
375 } else if (fxdr_unsigned(int, *tl)) {
376 error = nfsm_advance(nd, NFSX_V3FATTR, -1);
382 error = nfsm_loadattr(nd, nap);
391 * Initialize the owner/delegation sleep lock.
394 nfscl_lockinit(struct nfsv4lock *lckp)
397 lckp->nfslock_usecnt = 0;
398 lckp->nfslock_lock = 0;
402 * Get an exclusive lock. (Not needed for OpenBSD4, since there is only one
403 * thread for each posix process in the kernel.)
406 nfscl_lockexcl(struct nfsv4lock *lckp, void *mutex)
411 igotlock = nfsv4_lock(lckp, 1, NULL, mutex, NULL);
416 * Release an exclusive lock.
419 nfscl_lockunlock(struct nfsv4lock *lckp)
422 nfsv4_unlock(lckp, 0);
426 * Called to derefernce a lock on a stateid (delegation or open owner).
429 nfscl_lockderef(struct nfsv4lock *lckp)
433 lckp->nfslock_usecnt--;
434 if (lckp->nfslock_usecnt == 0 && (lckp->nfslock_lock & NFSV4LOCK_WANTED)) {
435 lckp->nfslock_lock &= ~NFSV4LOCK_WANTED;
436 wakeup((caddr_t)lckp);