nfsm_subs.h revision 139823
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 * 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. 19 * 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 30 * SUCH DAMAGE. 31 * 32 * @(#)nfsm_subs.h 8.2 (Berkeley) 3/30/95 33 * $FreeBSD: head/sys/nfsclient/nfsm_subs.h 139823 2005-01-07 01:45:51Z imp $ 34 */ 35 36#ifndef _NFSCLIENT_NFSM_SUBS_H_ 37#define _NFSCLIENT_NFSM_SUBS_H_ 38 39#include <nfs/nfs_common.h> 40 41#define nfsv2tov_type(a) nv2tov_type[fxdr_unsigned(u_int32_t,(a))&0x7] 42 43struct ucred; 44struct vnode; 45 46/* 47 * These macros do strange and peculiar things to mbuf chains for 48 * the assistance of the nfs code. To attempt to use them for any 49 * other purpose will be dangerous. (they make weird assumptions) 50 */ 51 52/* 53 * First define what the actual subs. return 54 */ 55struct mbuf *nfsm_reqhead(struct vnode *vp, u_long procid, int hsiz); 56struct mbuf *nfsm_rpchead(struct ucred *cr, int nmflag, int procid, 57 int auth_type, int auth_len, 58 struct mbuf *mrest, int mrest_len, 59 struct mbuf **mbp, u_int32_t *xidp); 60 61#define M_HASCL(m) ((m)->m_flags & M_EXT) 62#define NFSMINOFF(m) \ 63 do { \ 64 if (M_HASCL(m)) \ 65 (m)->m_data = (m)->m_ext.ext_buf; \ 66 else if ((m)->m_flags & M_PKTHDR) \ 67 (m)->m_data = (m)->m_pktdat; \ 68 else \ 69 (m)->m_data = (m)->m_dat; \ 70 } while (0) 71#define NFSMSIZ(m) ((M_HASCL(m))?MCLBYTES: \ 72 (((m)->m_flags & M_PKTHDR)?MHLEN:MLEN)) 73 74/* 75 * Now for the macros that do the simple stuff and call the functions 76 * for the hard stuff. 77 * These macros use several vars. declared in nfsm_reqhead and these 78 * vars. must not be used elsewhere unless you are careful not to corrupt 79 * them. The vars. starting with pN and tN (N=1,2,3,..) are temporaries 80 * that may be used so long as the value is not expected to retained 81 * after a macro. 82 * I know, this is kind of dorkey, but it makes the actual op functions 83 * fairly clean and deals with the mess caused by the xdr discriminating 84 * unions. 85 */ 86 87 88/* *********************************** */ 89/* Request generation phase macros */ 90 91int nfsm_fhtom_xx(struct vnode *v, int v3, struct mbuf **mb, 92 caddr_t *bpos); 93void nfsm_v3attrbuild_xx(struct vattr *va, int full, struct mbuf **mb, 94 caddr_t *bpos); 95int nfsm_strtom_xx(const char *a, int s, int m, struct mbuf **mb, 96 caddr_t *bpos); 97 98#define nfsm_bcheck(t1, mreq) \ 99do { \ 100 if (t1) { \ 101 error = t1; \ 102 m_freem(mreq); \ 103 goto nfsmout; \ 104 } \ 105} while (0) 106 107#define nfsm_fhtom(v, v3) \ 108do { \ 109 int32_t t1; \ 110 t1 = nfsm_fhtom_xx((v), (v3), &mb, &bpos); \ 111 nfsm_bcheck(t1, mreq); \ 112} while (0) 113 114/* If full is true, set all fields, otherwise just set mode and time fields */ 115#define nfsm_v3attrbuild(a, full) \ 116 nfsm_v3attrbuild_xx(a, full, &mb, &bpos) 117 118#define nfsm_uiotom(p, s) \ 119do { \ 120 int t1; \ 121 t1 = nfsm_uiotombuf((p), &mb, (s), &bpos); \ 122 nfsm_bcheck(t1, mreq); \ 123} while (0) 124 125#define nfsm_strtom(a, s, m) \ 126do { \ 127 int t1; \ 128 t1 = nfsm_strtom_xx((a), (s), (m), &mb, &bpos); \ 129 nfsm_bcheck(t1, mreq); \ 130} while (0) 131 132/* *********************************** */ 133/* Send the request */ 134 135#define nfsm_request(v, t, p, c) \ 136do { \ 137 sigset_t oldset; \ 138 nfs_set_sigmask(p, &oldset); \ 139 error = nfs_request((v), mreq, (t), (p), (c), &mrep, &md, &dpos); \ 140 nfs_restore_sigmask(p, &oldset); \ 141 if (error != 0) { \ 142 if (error & NFSERR_RETERR) \ 143 error &= ~NFSERR_RETERR; \ 144 else \ 145 goto nfsmout; \ 146 } \ 147} while (0) 148 149#define nfsm_request_mnt(n, t, p, c) \ 150do { \ 151 error = nfs4_request_mnt((n), mreq, (t), (p), (c), &mrep, &md, &dpos); \ 152 if (error != 0) { \ 153 if (error & NFSERR_RETERR) \ 154 error &= ~NFSERR_RETERR; \ 155 else \ 156 goto nfsmout; \ 157 } \ 158} while (0) 159 160/* *********************************** */ 161/* Reply interpretation phase macros */ 162 163int nfsm_mtofh_xx(struct vnode *d, struct vnode **v, int v3, int *f, 164 struct mbuf **md, caddr_t *dpos); 165int nfsm_getfh_xx(nfsfh_t **f, int *s, int v3, struct mbuf **md, 166 caddr_t *dpos); 167int nfsm_loadattr_xx(struct vnode **v, struct vattr *va, struct mbuf **md, 168 caddr_t *dpos); 169int nfsm_postop_attr_xx(struct vnode **v, int *f, struct mbuf **md, 170 caddr_t *dpos); 171int nfsm_wcc_data_xx(struct vnode **v, int *f, struct mbuf **md, 172 caddr_t *dpos); 173 174#define nfsm_mtofh(d, v, v3, f) \ 175do { \ 176 int32_t t1; \ 177 t1 = nfsm_mtofh_xx((d), &(v), (v3), &(f), &md, &dpos); \ 178 nfsm_dcheck(t1, mrep); \ 179} while (0) 180 181#define nfsm_getfh(f, s, v3) \ 182do { \ 183 int32_t t1; \ 184 t1 = nfsm_getfh_xx(&(f), &(s), (v3), &md, &dpos); \ 185 nfsm_dcheck(t1, mrep); \ 186} while (0) 187 188#define nfsm_loadattr(v, a) \ 189do { \ 190 int32_t t1; \ 191 t1 = nfsm_loadattr_xx(&v, a, &md, &dpos); \ 192 nfsm_dcheck(t1, mrep); \ 193} while (0) 194 195#define nfsm_postop_attr(v, f) \ 196do { \ 197 int32_t t1; \ 198 t1 = nfsm_postop_attr_xx(&v, &f, &md, &dpos); \ 199 nfsm_dcheck(t1, mrep); \ 200} while (0) 201 202/* Used as (f) for nfsm_wcc_data() */ 203#define NFSV3_WCCRATTR 0 204#define NFSV3_WCCCHK 1 205 206#define nfsm_wcc_data(v, f) \ 207do { \ 208 int32_t t1; \ 209 t1 = nfsm_wcc_data_xx(&v, &f, &md, &dpos); \ 210 nfsm_dcheck(t1, mrep); \ 211} while (0) 212 213#endif 214