1 /*- 2 * SPDX-License-Identifier: BSD-3-Clause 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. 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. 21 * 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 32 * SUCH DAMAGE. 33 * 34 */ 35 36 #include <sys/cdefs.h> 37 __FBSDID("$FreeBSD$"); 38 39 /* 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. 43 */ 44 #include <fs/nfs/nfsport.h> 45 46 extern struct nfsstatsv1 nfsstatsv1; 47 extern int ncl_mbuf_mlen; 48 extern enum vtype newnv2tov_type[8]; 49 extern enum vtype nv34tov_type[8]; 50 NFSCLSTATEMUTEX; 51 52 static nfsuint64 nfs_nullcookie = {{ 0, 0 }}; 53 54 /* 55 * copies a uio scatter/gather list to an mbuf chain. 56 * NOTE: can ony handle iovcnt == 1 57 */ 58 void 59 nfsm_uiombuf(struct nfsrv_descript *nd, struct uio *uiop, int siz) 60 { 61 char *uiocp; 62 struct mbuf *mp, *mp2; 63 int xfer, left, mlen; 64 int uiosiz, clflg, rem; 65 char *mcp, *tcp; 66 67 KASSERT(uiop->uio_iovcnt == 1, ("nfsm_uiotombuf: iovcnt != 1")); 68 69 if (siz > ncl_mbuf_mlen) /* or should it >= MCLBYTES ?? */ 70 clflg = 1; 71 else 72 clflg = 0; 73 rem = NFSM_RNDUP(siz) - siz; 74 mp = mp2 = nd->nd_mb; 75 mcp = nd->nd_bpos; 76 while (siz > 0) { 77 KASSERT((nd->nd_flag & ND_EXTPG) != 0 || mcp == 78 mtod(mp, char *) + mp->m_len, ("nfsm_uiombuf: mcp wrong")); 79 left = uiop->uio_iov->iov_len; 80 uiocp = uiop->uio_iov->iov_base; 81 if (left > siz) 82 left = siz; 83 uiosiz = left; 84 while (left > 0) { 85 if ((nd->nd_flag & ND_EXTPG) != 0) 86 mlen = nd->nd_bextpgsiz; 87 else 88 mlen = M_TRAILINGSPACE(mp); 89 if (mlen == 0) { 90 if ((nd->nd_flag & ND_EXTPG) != 0) { 91 mp = nfsm_add_ext_pgs(mp, 92 nd->nd_maxextsiz, &nd->nd_bextpg); 93 mcp = (char *)(void *)PHYS_TO_DMAP( 94 mp->m_epg_pa[nd->nd_bextpg]); 95 nd->nd_bextpgsiz = PAGE_SIZE; 96 } else { 97 if (clflg) 98 NFSMCLGET(mp, M_WAITOK); 99 else 100 NFSMGET(mp); 101 mp->m_len = 0; 102 mlen = M_TRAILINGSPACE(mp); 103 mcp = mtod(mp, char *); 104 mp2->m_next = mp; 105 mp2 = mp; 106 } 107 } 108 xfer = (left > mlen) ? mlen : left; 109 if (uiop->uio_segflg == UIO_SYSSPACE) 110 NFSBCOPY(uiocp, mcp, xfer); 111 else 112 copyin(uiocp, mcp, xfer); 113 mp->m_len += xfer; 114 left -= xfer; 115 uiocp += xfer; 116 mcp += xfer; 117 if ((nd->nd_flag & ND_EXTPG) != 0) { 118 nd->nd_bextpgsiz -= xfer; 119 mp->m_epg_last_len += xfer; 120 } 121 uiop->uio_offset += xfer; 122 uiop->uio_resid -= xfer; 123 } 124 tcp = (char *)uiop->uio_iov->iov_base; 125 tcp += uiosiz; 126 uiop->uio_iov->iov_base = (void *)tcp; 127 uiop->uio_iov->iov_len -= uiosiz; 128 siz -= uiosiz; 129 } 130 if (rem > 0) { 131 if ((nd->nd_flag & ND_EXTPG) == 0 && rem > 132 M_TRAILINGSPACE(mp)) { 133 NFSMGET(mp); 134 mp->m_len = 0; 135 mp2->m_next = mp; 136 mcp = mtod(mp, char *); 137 } else if ((nd->nd_flag & ND_EXTPG) != 0 && rem > 138 nd->nd_bextpgsiz) { 139 mp = nfsm_add_ext_pgs(mp, nd->nd_maxextsiz, 140 &nd->nd_bextpg); 141 mcp = (char *)(void *) 142 PHYS_TO_DMAP(mp->m_epg_pa[nd->nd_bextpg]); 143 nd->nd_bextpgsiz = PAGE_SIZE; 144 } 145 for (left = 0; left < rem; left++) 146 *mcp++ = '\0'; 147 mp->m_len += rem; 148 nd->nd_bpos = mcp; 149 if ((nd->nd_flag & ND_EXTPG) != 0) { 150 nd->nd_bextpgsiz -= rem; 151 mp->m_epg_last_len += rem; 152 } 153 } else 154 nd->nd_bpos = mcp; 155 nd->nd_mb = mp; 156 } 157 158 /* 159 * copies a uio scatter/gather list to an mbuf chain. 160 * This version returns the mbuf list and does not use "nd". 161 * NOTE: can ony handle iovcnt == 1 162 */ 163 struct mbuf * 164 nfsm_uiombuflist(struct uio *uiop, int siz, struct mbuf **mbp, char **cpp) 165 { 166 char *uiocp; 167 struct mbuf *mp, *mp2, *firstmp; 168 int xfer, left, mlen; 169 int uiosiz, clflg; 170 char *tcp; 171 172 KASSERT(uiop->uio_iovcnt == 1, ("nfsm_uiotombuf: iovcnt != 1")); 173 174 if (siz > ncl_mbuf_mlen) /* or should it >= MCLBYTES ?? */ 175 clflg = 1; 176 else 177 clflg = 0; 178 if (clflg != 0) 179 NFSMCLGET(mp, M_WAITOK); 180 else 181 NFSMGET(mp); 182 mp->m_len = 0; 183 firstmp = mp2 = mp; 184 while (siz > 0) { 185 left = uiop->uio_iov->iov_len; 186 uiocp = uiop->uio_iov->iov_base; 187 if (left > siz) 188 left = siz; 189 uiosiz = left; 190 while (left > 0) { 191 mlen = M_TRAILINGSPACE(mp); 192 if (mlen == 0) { 193 if (clflg) 194 NFSMCLGET(mp, M_WAITOK); 195 else 196 NFSMGET(mp); 197 mp->m_len = 0; 198 mp2->m_next = mp; 199 mp2 = mp; 200 mlen = M_TRAILINGSPACE(mp); 201 } 202 xfer = (left > mlen) ? mlen : left; 203 if (uiop->uio_segflg == UIO_SYSSPACE) 204 NFSBCOPY(uiocp, mtod(mp, caddr_t) + 205 mp->m_len, xfer); 206 else 207 copyin(uiocp, mtod(mp, caddr_t) + 208 mp->m_len, xfer); 209 mp->m_len += xfer; 210 left -= xfer; 211 uiocp += xfer; 212 uiop->uio_offset += xfer; 213 uiop->uio_resid -= xfer; 214 } 215 tcp = (char *)uiop->uio_iov->iov_base; 216 tcp += uiosiz; 217 uiop->uio_iov->iov_base = (void *)tcp; 218 uiop->uio_iov->iov_len -= uiosiz; 219 siz -= uiosiz; 220 } 221 if (cpp != NULL) 222 *cpp = mtod(mp, caddr_t) + mp->m_len; 223 if (mbp != NULL) 224 *mbp = mp; 225 return (firstmp); 226 } 227 228 /* 229 * Load vnode attributes from the xdr file attributes. 230 * Returns EBADRPC if they can't be parsed, 0 otherwise. 231 */ 232 int 233 nfsm_loadattr(struct nfsrv_descript *nd, struct nfsvattr *nap) 234 { 235 struct nfs_fattr *fp; 236 int error = 0; 237 238 if (nd->nd_flag & ND_NFSV4) { 239 error = nfsv4_loadattr(nd, NULL, nap, NULL, NULL, 0, NULL, 240 NULL, NULL, NULL, NULL, 0, NULL, NULL, NULL, NULL, NULL); 241 } else if (nd->nd_flag & ND_NFSV3) { 242 NFSM_DISSECT(fp, struct nfs_fattr *, NFSX_V3FATTR); 243 nap->na_type = nfsv34tov_type(fp->fa_type); 244 nap->na_mode = fxdr_unsigned(u_short, fp->fa_mode); 245 nap->na_rdev = NFSMAKEDEV( 246 fxdr_unsigned(int, fp->fa3_rdev.specdata1), 247 fxdr_unsigned(int, fp->fa3_rdev.specdata2)); 248 nap->na_nlink = fxdr_unsigned(uint32_t, fp->fa_nlink); 249 nap->na_uid = fxdr_unsigned(uid_t, fp->fa_uid); 250 nap->na_gid = fxdr_unsigned(gid_t, fp->fa_gid); 251 nap->na_size = fxdr_hyper(&fp->fa3_size); 252 nap->na_blocksize = NFS_FABLKSIZE; 253 nap->na_bytes = fxdr_hyper(&fp->fa3_used); 254 nap->na_fileid = fxdr_hyper(&fp->fa3_fileid); 255 fxdr_nfsv3time(&fp->fa3_atime, &nap->na_atime); 256 fxdr_nfsv3time(&fp->fa3_ctime, &nap->na_ctime); 257 fxdr_nfsv3time(&fp->fa3_mtime, &nap->na_mtime); 258 nap->na_flags = 0; 259 nap->na_filerev = 0; 260 } else { 261 NFSM_DISSECT(fp, struct nfs_fattr *, NFSX_V2FATTR); 262 nap->na_type = nfsv2tov_type(fp->fa_type); 263 nap->na_mode = fxdr_unsigned(u_short, fp->fa_mode); 264 if (nap->na_type == VNON || nap->na_type == VREG) 265 nap->na_type = IFTOVT(nap->na_mode); 266 nap->na_rdev = fxdr_unsigned(dev_t, fp->fa2_rdev); 267 268 /* 269 * Really ugly NFSv2 kludge. 270 */ 271 if (nap->na_type == VCHR && nap->na_rdev == ((dev_t)-1)) 272 nap->na_type = VFIFO; 273 nap->na_nlink = fxdr_unsigned(u_short, fp->fa_nlink); 274 nap->na_uid = fxdr_unsigned(uid_t, fp->fa_uid); 275 nap->na_gid = fxdr_unsigned(gid_t, fp->fa_gid); 276 nap->na_size = fxdr_unsigned(u_int32_t, fp->fa2_size); 277 nap->na_blocksize = fxdr_unsigned(int32_t, fp->fa2_blocksize); 278 nap->na_bytes = 279 (u_quad_t)fxdr_unsigned(int32_t, fp->fa2_blocks) * 280 NFS_FABLKSIZE; 281 nap->na_fileid = fxdr_unsigned(uint64_t, fp->fa2_fileid); 282 fxdr_nfsv2time(&fp->fa2_atime, &nap->na_atime); 283 fxdr_nfsv2time(&fp->fa2_mtime, &nap->na_mtime); 284 nap->na_flags = 0; 285 nap->na_ctime.tv_sec = fxdr_unsigned(u_int32_t, 286 fp->fa2_ctime.nfsv2_sec); 287 nap->na_ctime.tv_nsec = 0; 288 nap->na_gen = fxdr_unsigned(u_int32_t,fp->fa2_ctime.nfsv2_usec); 289 nap->na_filerev = 0; 290 } 291 nfsmout: 292 return (error); 293 } 294 295 /* 296 * This function finds the directory cookie that corresponds to the 297 * logical byte offset given. 298 */ 299 nfsuint64 * 300 nfscl_getcookie(struct nfsnode *np, off_t off, int add) 301 { 302 struct nfsdmap *dp, *dp2; 303 int pos; 304 305 pos = off / NFS_DIRBLKSIZ; 306 if (pos == 0) { 307 KASSERT(!add, ("nfs getcookie add at 0")); 308 return (&nfs_nullcookie); 309 } 310 pos--; 311 dp = LIST_FIRST(&np->n_cookies); 312 if (!dp) { 313 if (add) { 314 dp = malloc(sizeof (struct nfsdmap), 315 M_NFSDIROFF, M_WAITOK); 316 dp->ndm_eocookie = 0; 317 LIST_INSERT_HEAD(&np->n_cookies, dp, ndm_list); 318 } else 319 return (NULL); 320 } 321 while (pos >= NFSNUMCOOKIES) { 322 pos -= NFSNUMCOOKIES; 323 if (LIST_NEXT(dp, ndm_list) != NULL) { 324 if (!add && dp->ndm_eocookie < NFSNUMCOOKIES && 325 pos >= dp->ndm_eocookie) 326 return (NULL); 327 dp = LIST_NEXT(dp, ndm_list); 328 } else if (add) { 329 dp2 = malloc(sizeof (struct nfsdmap), 330 M_NFSDIROFF, M_WAITOK); 331 dp2->ndm_eocookie = 0; 332 LIST_INSERT_AFTER(dp, dp2, ndm_list); 333 dp = dp2; 334 } else 335 return (NULL); 336 } 337 if (pos >= dp->ndm_eocookie) { 338 if (add) 339 dp->ndm_eocookie = pos + 1; 340 else 341 return (NULL); 342 } 343 return (&dp->ndm_cookies[pos]); 344 } 345 346 /* 347 * Gets a file handle out of an nfs reply sent to the client and returns 348 * the file handle and the file's attributes. 349 * For V4, it assumes that Getfh and Getattr Op's results are here. 350 */ 351 int 352 nfscl_mtofh(struct nfsrv_descript *nd, struct nfsfh **nfhpp, 353 struct nfsvattr *nap, int *attrflagp) 354 { 355 u_int32_t *tl; 356 int error = 0, flag = 1; 357 358 *nfhpp = NULL; 359 *attrflagp = 0; 360 /* 361 * First get the file handle and vnode. 362 */ 363 if (nd->nd_flag & ND_NFSV3) { 364 NFSM_DISSECT(tl, u_int32_t *, NFSX_UNSIGNED); 365 flag = fxdr_unsigned(int, *tl); 366 } else if (nd->nd_flag & ND_NFSV4) { 367 NFSM_DISSECT(tl, u_int32_t *, 2 * NFSX_UNSIGNED); 368 /* If the GetFH failed, clear flag. */ 369 if (*++tl != 0) { 370 nd->nd_flag |= ND_NOMOREDATA; 371 flag = 0; 372 error = ENXIO; /* Return ENXIO so *nfhpp isn't used. */ 373 } 374 } 375 if (flag) { 376 error = nfsm_getfh(nd, nfhpp); 377 if (error) 378 return (error); 379 } 380 381 /* 382 * Now, get the attributes. 383 */ 384 if (flag != 0 && (nd->nd_flag & ND_NFSV4) != 0) { 385 NFSM_DISSECT(tl, u_int32_t *, 2 * NFSX_UNSIGNED); 386 if (*++tl != 0) { 387 nd->nd_flag |= ND_NOMOREDATA; 388 flag = 0; 389 } 390 } else if (nd->nd_flag & ND_NFSV3) { 391 NFSM_DISSECT(tl, u_int32_t *, NFSX_UNSIGNED); 392 if (flag) { 393 flag = fxdr_unsigned(int, *tl); 394 } else if (fxdr_unsigned(int, *tl)) { 395 error = nfsm_advance(nd, NFSX_V3FATTR, -1); 396 if (error) 397 return (error); 398 } 399 } 400 if (flag) { 401 error = nfsm_loadattr(nd, nap); 402 if (!error) 403 *attrflagp = 1; 404 } 405 nfsmout: 406 return (error); 407 } 408 409 /* 410 * Initialize the owner/delegation sleep lock. 411 */ 412 void 413 nfscl_lockinit(struct nfsv4lock *lckp) 414 { 415 416 lckp->nfslock_usecnt = 0; 417 lckp->nfslock_lock = 0; 418 } 419 420 /* 421 * Get an exclusive lock. (Not needed for OpenBSD4, since there is only one 422 * thread for each posix process in the kernel.) 423 */ 424 void 425 nfscl_lockexcl(struct nfsv4lock *lckp, void *mutex) 426 { 427 int igotlock; 428 429 do { 430 igotlock = nfsv4_lock(lckp, 1, NULL, mutex, NULL); 431 } while (!igotlock); 432 } 433 434 /* 435 * Release an exclusive lock. 436 */ 437 void 438 nfscl_lockunlock(struct nfsv4lock *lckp) 439 { 440 441 nfsv4_unlock(lckp, 0); 442 } 443 444 /* 445 * Called to derefernce a lock on a stateid (delegation or open owner). 446 */ 447 void 448 nfscl_lockderef(struct nfsv4lock *lckp) 449 { 450 451 NFSLOCKCLSTATE(); 452 lckp->nfslock_usecnt--; 453 if (lckp->nfslock_usecnt == 0 && (lckp->nfslock_lock & NFSV4LOCK_WANTED)) { 454 lckp->nfslock_lock &= ~NFSV4LOCK_WANTED; 455 wakeup((caddr_t)lckp); 456 } 457 NFSUNLOCKCLSTATE(); 458 } 459 460