sys/nfsserver/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 _NFSSERVER_NFSM_SUBS_H_
  37 #define _NFSSERVER_NFSM_SUBS_H_
  38
  39 #include <nfs/nfs_common.h>
  40
  41 #define nfstov_mode(a)  (fxdr_unsigned(u_int32_t, (a)) & ALLPERMS)
  42
  43 /*
  44  * These macros do strange and peculiar things to mbuf chains for
  45  * the assistance of the nfs code. To attempt to use them for any
  46  * other purpose will be dangerous. (they make weird assumptions)
  47  */
  48
  49 /*
  50  * First define what the actual subs. return
  51  */
  52
  53 #define M_HASCL(m)      ((m)->m_flags & M_EXT)
  54 #define NFSMSIZ(m)      ((M_HASCL(m))?MCLBYTES: \
  55                                 (((m)->m_flags & M_PKTHDR)?MHLEN:MLEN))
  56
  57 /*
  58  * Now for the macros that do the simple stuff and call the functions
  59  * for the hard stuff.
  60  * These macros use several vars. declared in nfsm_reqhead and these
  61  * vars. must not be used elsewhere unless you are careful not to corrupt
  62  * them. The vars. starting with pN and tN (N=1,2,3,..) are temporaries
  63  * that may be used so long as the value is not expected to retained
  64  * after a macro.
  65  * I know, this is kind of dorkey, but it makes the actual op functions
  66  * fairly clean and deals with the mess caused by the xdr discriminating
  67  * unions.
  68  */
  69
  70
  71
  72 /* ************************************* */
  73 /* Dissection phase macros */
  74
  75 int     nfsm_srvstrsiz_xx(int *s, int m, struct mbuf **md, caddr_t *dpos);
  76 int     nfsm_srvnamesiz_xx(int *s, int m, struct mbuf **md, caddr_t *dpos);
  77 int     nfsm_srvnamesiz0_xx(int *s, int m, struct mbuf **md, caddr_t *dpos);
  78 int     nfsm_srvmtofh_xx(fhandle_t *f, int v3, struct mbuf **md, caddr_t *dpos);
  79 int     nfsm_srvsattr_xx(struct vattr *a, struct mbuf **md, caddr_t *dpos);
  80
  81 #define nfsm_srvstrsiz(s, m) \
  82 do { \
  83         int t1; \
  84         t1 = nfsm_srvstrsiz_xx(&(s), (m), &md, &dpos); \
  85         if (t1) { \
  86                 error = t1; \
  87                 nfsm_reply(0); \
  88         } \
  89 } while (0)
  90
  91 #define nfsm_srvnamesiz(s) \
  92 do { \
  93         int t1; \
  94         t1 = nfsm_srvnamesiz_xx(&(s), NFS_MAXNAMLEN, &md, &dpos); \
  95         if (t1) { \
  96                 error = t1; \
  97                 nfsm_reply(0); \
  98         } \
  99 } while (0)
 100
 101 #define nfsm_srvpathsiz(s) \
 102 do { \
 103         int t1; \
 104         t1 = nfsm_srvnamesiz0_xx(&(s), NFS_MAXPATHLEN, &md, &dpos); \
 105         if (t1) { \
 106                 error = t1; \
 107                 nfsm_reply(0); \
 108         } \
 109 } while (0)
 110
 111 #define nfsm_srvmtofh(f) \
 112 do { \
 113         int t1; \
 114         t1 = nfsm_srvmtofh_xx((f), nfsd->nd_flag & ND_NFSV3, &md, &dpos); \
 115         if (t1) { \
 116                 error = t1; \
 117                 nfsm_reply(0); \
 118         } \
 119 } while (0)
 120
 121 /* XXX why is this different? */
 122 #define nfsm_srvsattr(a) \
 123 do { \
 124         int t1; \
 125         t1 = nfsm_srvsattr_xx((a), &md, &dpos); \
 126         if (t1) { \
 127                 error = t1; \
 128                 m_freem(mrep); \
 129                 mrep = NULL; \
 130                 goto nfsmout; \
 131         } \
 132 } while (0)
 133
 134 /* ************************************* */
 135 /* Prepare the reply */
 136
 137 #define nfsm_reply(s) \
 138 do { \
 139         if (mrep != NULL) { \
 140                 m_freem(mrep); \
 141                 mrep = NULL; \
 142         } \
 143         mreq = nfs_rephead((s), nfsd, error, &mb, &bpos); \
 144         *mrq = mreq; \
 145         if (error == EBADRPC) { \
 146                 error = 0; \
 147                 goto nfsmout; \
 148         } \
 149 } while (0)
 150
 151 #define nfsm_writereply(s) \
 152 do { \
 153         mreq = nfs_rephead((s), nfsd, error, &mb, &bpos); \
 154 } while(0)
 155
 156 /* ************************************* */
 157 /* Reply phase macros - add additional reply info */
 158
 159 void    nfsm_srvfhtom_xx(fhandle_t *f, int v3, struct mbuf **mb,
 160             caddr_t *bpos);
 161 void    nfsm_srvpostop_fh_xx(fhandle_t *f, struct mbuf **mb, caddr_t *bpos);
 162 void    nfsm_clget_xx(u_int32_t **tl, struct mbuf *mb, struct mbuf **mp,
 163             char **bp, char **be, caddr_t bpos);
 164
 165 #define nfsm_srvfhtom(f, v3) \
 166         nfsm_srvfhtom_xx((f), (v3), &mb, &bpos)
 167
 168 #define nfsm_srvpostop_fh(f) \
 169         nfsm_srvpostop_fh_xx((f), &mb, &bpos)
 170
 171 #define nfsm_srvwcc_data(br, b, ar, a) \
 172         nfsm_srvwcc(nfsd, (br), (b), (ar), (a), &mb, &bpos)
 173
 174 #define nfsm_srvpostop_attr(r, a) \
 175         nfsm_srvpostopattr(nfsd, (r), (a), &mb, &bpos)
 176
 177 #define nfsm_srvfillattr(a, f) \
 178         nfsm_srvfattr(nfsd, (a), (f))
 179
 180 #define nfsm_clget \
 181         nfsm_clget_xx(&tl, mb, &mp, &bp, &be, bpos)
 182
 183 #endif