sys/nfsclient/nfsm_subs.h

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