nfsm_subs.h revision 36097
1/* 2 * Copyright (c) 1989, 1993 3 * The Regents of the University of California. All rights reserved. 4 * 5 * This code is derived from software contributed to Berkeley by 6 * Rick Macklem at The University of Guelph. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 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 * 3. All advertising materials mentioning features or use of this software 17 * must display the following acknowledgement: 18 * This product includes software developed by the University of 19 * California, Berkeley and its contributors. 20 * 4. Neither the name of the University nor the names of its contributors 21 * may be used to endorse or promote products derived from this software 22 * without specific prior written permission. 23 * 24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 27 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 34 * SUCH DAMAGE. 35 * 36 * @(#)nfsm_subs.h 8.2 (Berkeley) 3/30/95 37 * $Id: nfsm_subs.h,v 1.15 1998/03/30 09:54:41 phk Exp $ 38 */ 39 40 41#ifndef _NFS_NFSM_SUBS_H_ 42#define _NFS_NFSM_SUBS_H_ 43 44struct ucred; 45struct vnode; 46 47/* 48 * These macros do strange and peculiar things to mbuf chains for 49 * the assistance of the nfs code. To attempt to use them for any 50 * other purpose will be dangerous. (they make weird assumptions) 51 */ 52 53/* 54 * First define what the actual subs. return 55 */ 56struct mbuf *nfsm_reqh __P((struct vnode *vp, u_long procid, int hsiz, 57 caddr_t *bposp)); 58struct mbuf *nfsm_rpchead __P((struct ucred *cr, int nmflag, int procid, 59 int auth_type, int auth_len, char *auth_str, 60 int verf_len, char *verf_str, 61 struct mbuf *mrest, int mrest_len, 62 struct mbuf **mbp, u_long *xidp)); 63 64#define M_HASCL(m) ((m)->m_flags & M_EXT) 65#define NFSMINOFF(m) \ 66 if (M_HASCL(m)) \ 67 (m)->m_data = (m)->m_ext.ext_buf; \ 68 else if ((m)->m_flags & M_PKTHDR) \ 69 (m)->m_data = (m)->m_pktdat; \ 70 else \ 71 (m)->m_data = (m)->m_dat 72#define NFSMADV(m, s) (m)->m_data += (s) 73#define NFSMSIZ(m) ((M_HASCL(m))?MCLBYTES: \ 74 (((m)->m_flags & M_PKTHDR)?MHLEN:MLEN)) 75 76/* 77 * Now for the macros that do the simple stuff and call the functions 78 * for the hard stuff. 79 * These macros use several vars. declared in nfsm_reqhead and these 80 * vars. must not be used elsewhere unless you are careful not to corrupt 81 * them. The vars. starting with pN and tN (N=1,2,3,..) are temporaries 82 * that may be used so long as the value is not expected to retained 83 * after a macro. 84 * I know, this is kind of dorkey, but it makes the actual op functions 85 * fairly clean and deals with the mess caused by the xdr discriminating 86 * unions. 87 */ 88 89#define nfsm_build(a,c,s) \ 90 { if ((s) > M_TRAILINGSPACE(mb)) { \ 91 MGET(mb2, M_WAIT, MT_DATA); \ 92 if ((s) > MLEN) \ 93 panic("build > MLEN"); \ 94 mb->m_next = mb2; \ 95 mb = mb2; \ 96 mb->m_len = 0; \ 97 bpos = mtod(mb, caddr_t); \ 98 } \ 99 (a) = (c)(bpos); \ 100 mb->m_len += (s); \ 101 bpos += (s); } 102 103#define nfsm_dissect(a, c, s) \ 104 { t1 = mtod(md, caddr_t)+md->m_len-dpos; \ 105 if (t1 >= (s)) { \ 106 (a) = (c)(dpos); \ 107 dpos += (s); \ 108 } else if (t1 = nfsm_disct(&md, &dpos, (s), t1, &cp2)) { \ 109 error = t1; \ 110 m_freem(mrep); \ 111 goto nfsmout; \ 112 } else { \ 113 (a) = (c)cp2; \ 114 } } 115 116#define nfsm_fhtom(v, v3) \ 117 { if (v3) { \ 118 t2 = nfsm_rndup(VTONFS(v)->n_fhsize) + NFSX_UNSIGNED; \ 119 if (t2 <= M_TRAILINGSPACE(mb)) { \ 120 nfsm_build(tl, u_long *, t2); \ 121 *tl++ = txdr_unsigned(VTONFS(v)->n_fhsize); \ 122 *(tl + ((t2>>2) - 2)) = 0; \ 123 bcopy((caddr_t)VTONFS(v)->n_fhp,(caddr_t)tl, \ 124 VTONFS(v)->n_fhsize); \ 125 } else if (t2 = nfsm_strtmbuf(&mb, &bpos, \ 126 (caddr_t)VTONFS(v)->n_fhp, VTONFS(v)->n_fhsize)) { \ 127 error = t2; \ 128 m_freem(mreq); \ 129 goto nfsmout; \ 130 } \ 131 } else { \ 132 nfsm_build(cp, caddr_t, NFSX_V2FH); \ 133 bcopy((caddr_t)VTONFS(v)->n_fhp, cp, NFSX_V2FH); \ 134 } } 135 136#define nfsm_srvfhtom(f, v3) \ 137 { if (v3) { \ 138 nfsm_build(tl, u_long *, NFSX_UNSIGNED + NFSX_V3FH); \ 139 *tl++ = txdr_unsigned(NFSX_V3FH); \ 140 bcopy((caddr_t)(f), (caddr_t)tl, NFSX_V3FH); \ 141 } else { \ 142 nfsm_build(cp, caddr_t, NFSX_V2FH); \ 143 bcopy((caddr_t)(f), cp, NFSX_V2FH); \ 144 } } 145 146#define nfsm_srvpostop_fh(f) \ 147 { nfsm_build(tl, u_long *, 2 * NFSX_UNSIGNED + NFSX_V3FH); \ 148 *tl++ = nfs_true; \ 149 *tl++ = txdr_unsigned(NFSX_V3FH); \ 150 bcopy((caddr_t)(f), (caddr_t)tl, NFSX_V3FH); \ 151 } 152 153#define nfsm_mtofh(d, v, v3, f) \ 154 { struct nfsnode *ttnp; nfsfh_t *ttfhp; int ttfhsize; \ 155 if (v3) { \ 156 nfsm_dissect(tl, u_long *, NFSX_UNSIGNED); \ 157 (f) = fxdr_unsigned(int, *tl); \ 158 } else \ 159 (f) = 1; \ 160 if (f) { \ 161 nfsm_getfh(ttfhp, ttfhsize, (v3)); \ 162 if (t1 = nfs_nget((d)->v_mount, ttfhp, ttfhsize, \ 163 &ttnp)) { \ 164 error = t1; \ 165 m_freem(mrep); \ 166 goto nfsmout; \ 167 } \ 168 (v) = NFSTOV(ttnp); \ 169 } \ 170 if (v3) { \ 171 nfsm_dissect(tl, u_long *, NFSX_UNSIGNED); \ 172 if (f) \ 173 (f) = fxdr_unsigned(int, *tl); \ 174 else if (fxdr_unsigned(int, *tl)) \ 175 nfsm_adv(NFSX_V3FATTR); \ 176 } \ 177 if (f) \ 178 nfsm_loadattr((v), (struct vattr *)0); \ 179 } 180 181#define nfsm_getfh(f, s, v3) \ 182 { if (v3) { \ 183 nfsm_dissect(tl, u_long *, NFSX_UNSIGNED); \ 184 if (((s) = fxdr_unsigned(int, *tl)) <= 0 || \ 185 (s) > NFSX_V3FHMAX) { \ 186 m_freem(mrep); \ 187 error = EBADRPC; \ 188 goto nfsmout; \ 189 } \ 190 } else \ 191 (s) = NFSX_V2FH; \ 192 nfsm_dissect((f), nfsfh_t *, nfsm_rndup(s)); } 193 194#define nfsm_loadattr(v, a) \ 195 { struct vnode *ttvp = (v); \ 196 if (t1 = nfs_loadattrcache(&ttvp, &md, &dpos, (a))) { \ 197 error = t1; \ 198 m_freem(mrep); \ 199 goto nfsmout; \ 200 } \ 201 (v) = ttvp; } 202 203#define nfsm_postop_attr(v, f) \ 204 { struct vnode *ttvp = (v); \ 205 nfsm_dissect(tl, u_long *, NFSX_UNSIGNED); \ 206 if ((f) = fxdr_unsigned(int, *tl)) { \ 207 if (t1 = nfs_loadattrcache(&ttvp, &md, &dpos, \ 208 (struct vattr *)0)) { \ 209 error = t1; \ 210 (f) = 0; \ 211 m_freem(mrep); \ 212 goto nfsmout; \ 213 } \ 214 (v) = ttvp; \ 215 } } 216 217/* Used as (f) for nfsm_wcc_data() */ 218#define NFSV3_WCCRATTR 0 219#define NFSV3_WCCCHK 1 220 221#define nfsm_wcc_data(v, f) \ 222 { int ttattrf, ttretf = 0; \ 223 nfsm_dissect(tl, u_long *, NFSX_UNSIGNED); \ 224 if (*tl == nfs_true) { \ 225 nfsm_dissect(tl, u_long *, 6 * NFSX_UNSIGNED); \ 226 if (f) \ 227 ttretf = (VTONFS(v)->n_mtime == \ 228 fxdr_unsigned(u_long, *(tl + 2))); \ 229 } \ 230 nfsm_postop_attr((v), ttattrf); \ 231 if (f) { \ 232 (f) = ttretf; \ 233 } else { \ 234 (f) = ttattrf; \ 235 } } 236 237#define nfsm_v3sattr(s, a, u, g) \ 238 { (s)->sa_modetrue = nfs_true; \ 239 (s)->sa_mode = vtonfsv3_mode((a)->va_mode); \ 240 (s)->sa_uidtrue = nfs_true; \ 241 (s)->sa_uid = txdr_unsigned(u); \ 242 (s)->sa_gidtrue = nfs_true; \ 243 (s)->sa_gid = txdr_unsigned(g); \ 244 (s)->sa_sizefalse = nfs_false; \ 245 (s)->sa_atimetype = txdr_unsigned(NFSV3SATTRTIME_TOCLIENT); \ 246 txdr_nfsv3time(&(a)->va_atime, &(s)->sa_atime); \ 247 (s)->sa_mtimetype = txdr_unsigned(NFSV3SATTRTIME_TOCLIENT); \ 248 txdr_nfsv3time(&(a)->va_mtime, &(s)->sa_mtime); \ 249 } 250 251#define nfsm_strsiz(s,m) \ 252 { nfsm_dissect(tl,u_long *,NFSX_UNSIGNED); \ 253 if (((s) = fxdr_unsigned(long,*tl)) > (m)) { \ 254 m_freem(mrep); \ 255 error = EBADRPC; \ 256 goto nfsmout; \ 257 } } 258 259#define nfsm_srvstrsiz(s,m) \ 260 { nfsm_dissect(tl,u_long *,NFSX_UNSIGNED); \ 261 if (((s) = fxdr_unsigned(long,*tl)) > (m) || (s) <= 0) { \ 262 error = EBADRPC; \ 263 nfsm_reply(0); \ 264 } } 265 266#define nfsm_srvnamesiz(s) \ 267 { nfsm_dissect(tl,u_long *,NFSX_UNSIGNED); \ 268 if (((s) = fxdr_unsigned(long,*tl)) > NFS_MAXNAMLEN) \ 269 error = NFSERR_NAMETOL; \ 270 if ((s) <= 0) \ 271 error = EBADRPC; \ 272 if (error) \ 273 nfsm_reply(0); \ 274 } 275 276#define nfsm_mtouio(p,s) \ 277 if ((s) > 0 && \ 278 (t1 = nfsm_mbuftouio(&md,(p),(s),&dpos))) { \ 279 error = t1; \ 280 m_freem(mrep); \ 281 goto nfsmout; \ 282 } 283 284#define nfsm_uiotom(p,s) \ 285 if (t1 = nfsm_uiotombuf((p),&mb,(s),&bpos)) { \ 286 error = t1; \ 287 m_freem(mreq); \ 288 goto nfsmout; \ 289 } 290 291#define nfsm_reqhead(v,a,s) \ 292 mb = mreq = nfsm_reqh((v),(a),(s),&bpos) 293 294#define nfsm_reqdone m_freem(mrep); \ 295 nfsmout: 296 297#define nfsm_rndup(a) (((a)+3)&(~0x3)) 298 299#define nfsm_request(v, t, p, c) \ 300 if (error = nfs_request((v), mreq, (t), (p), \ 301 (c), &mrep, &md, &dpos)) { \ 302 if (error & NFSERR_RETERR) \ 303 error &= ~NFSERR_RETERR; \ 304 else \ 305 goto nfsmout; \ 306 } 307 308#define nfsm_strtom(a,s,m) \ 309 if ((s) > (m)) { \ 310 m_freem(mreq); \ 311 error = ENAMETOOLONG; \ 312 goto nfsmout; \ 313 } \ 314 t2 = nfsm_rndup(s)+NFSX_UNSIGNED; \ 315 if (t2 <= M_TRAILINGSPACE(mb)) { \ 316 nfsm_build(tl,u_long *,t2); \ 317 *tl++ = txdr_unsigned(s); \ 318 *(tl+((t2>>2)-2)) = 0; \ 319 bcopy((caddr_t)(a), (caddr_t)tl, (s)); \ 320 } else if (t2 = nfsm_strtmbuf(&mb, &bpos, (a), (s))) { \ 321 error = t2; \ 322 m_freem(mreq); \ 323 goto nfsmout; \ 324 } 325 326#define nfsm_srvdone \ 327 nfsmout: \ 328 return(error) 329 330#define nfsm_reply(s) \ 331 { \ 332 nfsd->nd_repstat = error; \ 333 if (error && !(nfsd->nd_flag & ND_NFSV3)) \ 334 (void) nfs_rephead(0, nfsd, slp, error, cache, &frev, \ 335 mrq, &mb, &bpos); \ 336 else \ 337 (void) nfs_rephead((s), nfsd, slp, error, cache, &frev, \ 338 mrq, &mb, &bpos); \ 339 m_freem(mrep); \ 340 mreq = *mrq; \ 341 if (error && (!(nfsd->nd_flag & ND_NFSV3) || \ 342 error == EBADRPC)) \ 343 return(0); \ 344 } 345 346#define nfsm_writereply(s, v3) \ 347 { \ 348 nfsd->nd_repstat = error; \ 349 if (error && !(v3)) \ 350 (void) nfs_rephead(0, nfsd, slp, error, cache, &frev, \ 351 &mreq, &mb, &bpos); \ 352 else \ 353 (void) nfs_rephead((s), nfsd, slp, error, cache, &frev, \ 354 &mreq, &mb, &bpos); \ 355 } 356 357#define nfsm_adv(s) \ 358 { t1 = mtod(md, caddr_t)+md->m_len-dpos; \ 359 if (t1 >= (s)) { \ 360 dpos += (s); \ 361 } else if (t1 = nfs_adv(&md, &dpos, (s), t1)) { \ 362 error = t1; \ 363 m_freem(mrep); \ 364 goto nfsmout; \ 365 } } 366 367#define nfsm_srvmtofh(f) \ 368 { int fhlen = NFSX_V3FH; \ 369 if (nfsd->nd_flag & ND_NFSV3) { \ 370 nfsm_dissect(tl, u_long *, NFSX_UNSIGNED); \ 371 fhlen = fxdr_unsigned(int, *tl); \ 372 if (fhlen == 0) { \ 373 bzero((caddr_t)(f), NFSX_V3FH); \ 374 } else if (fhlen != NFSX_V3FH) { \ 375 error = EBADRPC; \ 376 nfsm_reply(0); \ 377 } \ 378 } \ 379 if (fhlen != 0) { \ 380 nfsm_dissect(tl, u_long *, NFSX_V3FH); \ 381 bcopy((caddr_t)tl, (caddr_t)(f), NFSX_V3FH); \ 382 if ((nfsd->nd_flag & ND_NFSV3) == 0) \ 383 nfsm_adv(NFSX_V2FH - NFSX_V3FH); \ 384 } \ 385 } 386 387#define nfsm_clget \ 388 if (bp >= be) { \ 389 if (mp == mb) \ 390 mp->m_len += bp-bpos; \ 391 MGET(mp, M_WAIT, MT_DATA); \ 392 MCLGET(mp, M_WAIT); \ 393 mp->m_len = NFSMSIZ(mp); \ 394 mp2->m_next = mp; \ 395 mp2 = mp; \ 396 bp = mtod(mp, caddr_t); \ 397 be = bp+mp->m_len; \ 398 } \ 399 tl = (u_long *)bp 400 401#define nfsm_srvfillattr(a, f) \ 402 nfsm_srvfattr(nfsd, (a), (f)) 403 404#define nfsm_srvwcc_data(br, b, ar, a) \ 405 nfsm_srvwcc(nfsd, (br), (b), (ar), (a), &mb, &bpos) 406 407#define nfsm_srvpostop_attr(r, a) \ 408 nfsm_srvpostopattr(nfsd, (r), (a), &mb, &bpos) 409 410#define nfsm_srvsattr(a) \ 411 { nfsm_dissect(tl, u_long *, NFSX_UNSIGNED); \ 412 if (*tl == nfs_true) { \ 413 nfsm_dissect(tl, u_long *, NFSX_UNSIGNED); \ 414 (a)->va_mode = nfstov_mode(*tl); \ 415 } \ 416 nfsm_dissect(tl, u_long *, NFSX_UNSIGNED); \ 417 if (*tl == nfs_true) { \ 418 nfsm_dissect(tl, u_long *, NFSX_UNSIGNED); \ 419 (a)->va_uid = fxdr_unsigned(uid_t, *tl); \ 420 } \ 421 nfsm_dissect(tl, u_long *, NFSX_UNSIGNED); \ 422 if (*tl == nfs_true) { \ 423 nfsm_dissect(tl, u_long *, NFSX_UNSIGNED); \ 424 (a)->va_gid = fxdr_unsigned(gid_t, *tl); \ 425 } \ 426 nfsm_dissect(tl, u_long *, NFSX_UNSIGNED); \ 427 if (*tl == nfs_true) { \ 428 nfsm_dissect(tl, u_long *, 2 * NFSX_UNSIGNED); \ 429 fxdr_hyper(tl, &(a)->va_size); \ 430 } \ 431 nfsm_dissect(tl, u_long *, NFSX_UNSIGNED); \ 432 switch (fxdr_unsigned(int, *tl)) { \ 433 case NFSV3SATTRTIME_TOCLIENT: \ 434 nfsm_dissect(tl, u_long *, 2 * NFSX_UNSIGNED); \ 435 fxdr_nfsv3time(tl, &(a)->va_atime); \ 436 break; \ 437 case NFSV3SATTRTIME_TOSERVER: \ 438 getnanotime(&(a)->va_atime); \ 439 break; \ 440 }; \ 441 nfsm_dissect(tl, u_long *, NFSX_UNSIGNED); \ 442 switch (fxdr_unsigned(int, *tl)) { \ 443 case NFSV3SATTRTIME_TOCLIENT: \ 444 nfsm_dissect(tl, u_long *, 2 * NFSX_UNSIGNED); \ 445 fxdr_nfsv3time(tl, &(a)->va_mtime); \ 446 break; \ 447 case NFSV3SATTRTIME_TOSERVER: \ 448 getnanotime(&(a)->va_mtime); \ 449 break; \ 450 }; } 451 452#endif 453