sys/nfsclient/nfsm_subs.h

   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  *      @(#)nfsm_subs.h 8.2 (Berkeley) 3/30/95
  35  * $FreeBSD$
  36  */
  37
  38 #ifndef _NFSCLIENT_NFSM_SUBS_H_
  39 #define _NFSCLIENT_NFSM_SUBS_H_
  40
  41 #include <nfs/nfs_common.h>
  42
  43 #define nfsv2tov_type(a)        nv2tov_type[fxdr_unsigned(u_int32_t,(a))&0x7]
  44
  45 struct ucred;
  46 struct vnode;
  47
  48 /*
  49  * These macros do strange and peculiar things to mbuf chains for
  50  * the assistance of the nfs code. To attempt to use them for any
  51  * other purpose will be dangerous. (they make weird assumptions)
  52  */
  53
  54 /*
  55  * First define what the actual subs. return
  56  */
  57 u_int32_t nfs_xid_gen(void);
  58
  59 /* *********************************** */
  60 /* Request generation phase macros */
  61
  62 int     nfsm_fhtom_xx(struct vnode *v, int v3, struct mbuf **mb,
  63             caddr_t *bpos);
  64 void    nfsm_v3attrbuild_xx(struct vattr *va, int full, struct mbuf **mb,
  65             caddr_t *bpos);
  66 int     nfsm_strtom_xx(const char *a, int s, int m, struct mbuf **mb,
  67             caddr_t *bpos);
  68
  69 #define nfsm_bcheck(t1, mreq) \
  70 do { \
  71         if (t1) { \
  72                 error = t1; \
  73                 m_freem(mreq); \
  74                 goto nfsmout; \
  75         } \
  76 } while (0)
  77
  78 #define nfsm_fhtom(v, v3) \
  79 do { \
  80         int32_t t1; \
  81         t1 = nfsm_fhtom_xx((v), (v3), &mb, &bpos); \
  82         nfsm_bcheck(t1, mreq); \
  83 } while (0)
  84
  85 /* If full is true, set all fields, otherwise just set mode and time fields */
  86 #define nfsm_v3attrbuild(a, full) \
  87         nfsm_v3attrbuild_xx(a, full, &mb, &bpos)
  88
  89 #define nfsm_uiotom(p, s) \
  90 do { \
  91         int t1; \
  92         t1 = nfsm_uiotombuf((p), &mb, (s), &bpos); \
  93         nfsm_bcheck(t1, mreq); \
  94 } while (0)
  95
  96 #define nfsm_strtom(a, s, m) \
  97 do { \
  98         int t1; \
  99         t1 = nfsm_strtom_xx((a), (s), (m), &mb, &bpos); \
 100         nfsm_bcheck(t1, mreq); \
 101 } while (0)
 102
 103 /* *********************************** */
 104 /* Send the request */
 105
 106 #define nfsm_request(v, t, p, c) \
 107 do { \
 108         sigset_t oldset; \
 109         nfs_set_sigmask(p, &oldset); \
 110         error = nfs_request((v), mreq, (t), (p), (c), &mrep, &md, &dpos); \
 111         nfs_restore_sigmask(p, &oldset); \
 112         if (error != 0) { \
 113                 if (error & NFSERR_RETERR) \
 114                         error &= ~NFSERR_RETERR; \
 115                 else \
 116                         goto nfsmout; \
 117         } \
 118 } while (0)
 119
 120 /* *********************************** */
 121 /* Reply interpretation phase macros */
 122
 123 int     nfsm_mtofh_xx(struct vnode *d, struct vnode **v, int v3, int *f,
 124             struct mbuf **md, caddr_t *dpos);
 125 int     nfsm_getfh_xx(nfsfh_t **f, int *s, int v3, struct mbuf **md,
 126             caddr_t *dpos);
 127 int     nfsm_loadattr_xx(struct vnode **v, struct vattr *va, struct mbuf **md,
 128             caddr_t *dpos);
 129 int     nfsm_postop_attr_xx(struct vnode **v, int *f, struct vattr *va,
 130             struct mbuf **md, caddr_t *dpos);
 131 int     nfsm_wcc_data_xx(struct vnode **v, int *f, struct mbuf **md,
 132             caddr_t *dpos);
 133
 134 #define nfsm_mtofh(d, v, v3, f) \
 135 do { \
 136         int32_t t1; \
 137         t1 = nfsm_mtofh_xx((d), &(v), (v3), &(f), &md, &dpos); \
 138         nfsm_dcheck(t1, mrep); \
 139 } while (0)
 140
 141 #define nfsm_getfh(f, s, v3) \
 142 do { \
 143         int32_t t1; \
 144         t1 = nfsm_getfh_xx(&(f), &(s), (v3), &md, &dpos); \
 145         nfsm_dcheck(t1, mrep); \
 146 } while (0)
 147
 148 #define nfsm_loadattr(v, a) \
 149 do { \
 150         int32_t t1; \
 151         t1 = nfsm_loadattr_xx(&v, a, &md, &dpos); \
 152         nfsm_dcheck(t1, mrep); \
 153 } while (0)
 154
 155 #define nfsm_postop_attr(v, f) \
 156 do { \
 157         int32_t t1; \
 158         t1 = nfsm_postop_attr_xx(&v, &f, NULL, &md, &dpos);     \
 159         nfsm_dcheck(t1, mrep); \
 160 } while (0)
 161
 162 #define nfsm_postop_attr_va(v, f, va)           \
 163 do { \
 164         int32_t t1; \
 165         t1 = nfsm_postop_attr_xx(&v, &f, va, &md, &dpos);       \
 166         nfsm_dcheck(t1, mrep); \
 167 } while (0)
 168
 169 /* Used as (f) for nfsm_wcc_data() */
 170 #define NFSV3_WCCRATTR  0
 171 #define NFSV3_WCCCHK    1
 172
 173 #define nfsm_wcc_data(v, f) \
 174 do { \
 175         int32_t t1; \
 176         t1 = nfsm_wcc_data_xx(&v, &f, &md, &dpos); \
 177         nfsm_dcheck(t1, mrep); \
 178 } while (0)
 179
 180 #endif