sys/fs/nfs/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  * $FreeBSD$
  35  */
  36
  37 #ifndef _NFS_NFSM_SUBS_H_
  38 #define _NFS_NFSM_SUBS_H_
  39
  40 /*
  41  * These macros do strange and peculiar things to mbuf chains for
  42  * the assistance of the nfs code. To attempt to use them for any
  43  * other purpose will be dangerous. (they make weird assumptions)
  44  */
  45
  46 #ifndef APPLE
  47 /*
  48  * First define what the actual subs. return
  49  */
  50 #define NFSM_DATAP(m, s)        (m)->m_data += (s)
  51
  52 /*
  53  * Now for the macros that do the simple stuff and call the functions
  54  * for the hard stuff.
  55  * They use fields in struct nfsrv_descript to handle the mbuf queues.
  56  * Replace most of the macro with an inline function, to minimize
  57  * the machine code. The inline functions in lower case can be called
  58  * directly, bypassing the macro.
  59  */
  60 static __inline void *
  61 nfsm_build(struct nfsrv_descript *nd, int siz)
  62 {
  63         void *retp;
  64         struct mbuf *mb2;
  65
  66         if ((nd->nd_flag & ND_EXTPG) == 0 &&
  67             siz > M_TRAILINGSPACE(nd->nd_mb)) {
  68                 NFSMCLGET(mb2, M_NOWAIT);
  69                 if (siz > MLEN)
  70                         panic("build > MLEN");
  71                 mb2->m_len = 0;
  72                 nd->nd_bpos = mtod(mb2, char *);
  73                 nd->nd_mb->m_next = mb2;
  74                 nd->nd_mb = mb2;
  75         } else if ((nd->nd_flag & ND_EXTPG) != 0) {
  76                 if (siz > nd->nd_bextpgsiz) {
  77                         mb2 = mb_alloc_ext_plus_pages(PAGE_SIZE, M_WAITOK);
  78                         nd->nd_bpos = (char *)(void *)
  79                             PHYS_TO_DMAP(mb2->m_epg_pa[0]);
  80                         nd->nd_bextpg = 0;
  81                         nd->nd_bextpgsiz = PAGE_SIZE - siz;
  82                         nd->nd_mb->m_next = mb2;
  83                         nd->nd_mb = mb2;
  84                 } else
  85                         nd->nd_bextpgsiz -= siz;
  86                 nd->nd_mb->m_epg_last_len += siz;
  87         }
  88         retp = (void *)(nd->nd_bpos);
  89         nd->nd_mb->m_len += siz;
  90         nd->nd_bpos += siz;
  91         return (retp);
  92 }
  93
  94 #define NFSM_BUILD(a, c, s)     ((a) = (c)nfsm_build(nd, (s)))
  95
  96 static __inline void *
  97 nfsm_dissect(struct nfsrv_descript *nd, int siz)
  98 {
  99         int tt1;
 100         void *retp;
 101
 102         tt1 = mtod(nd->nd_md, caddr_t) + nd->nd_md->m_len - nd->nd_dpos;
 103         if (tt1 >= siz) {
 104                 retp = (void *)nd->nd_dpos;
 105                 nd->nd_dpos += siz;
 106         } else {
 107                 retp = nfsm_dissct(nd, siz, M_WAITOK);
 108         }
 109         return (retp);
 110 }
 111
 112 static __inline void *
 113 nfsm_dissect_nonblock(struct nfsrv_descript *nd, int siz)
 114 {
 115         int tt1;
 116         void *retp;
 117
 118         tt1 = mtod(nd->nd_md, caddr_t) + nd->nd_md->m_len - nd->nd_dpos;
 119         if (tt1 >= siz) {
 120                 retp = (void *)nd->nd_dpos;
 121                 nd->nd_dpos += siz;
 122         } else {
 123                 retp = nfsm_dissct(nd, siz, M_NOWAIT);
 124         }
 125         return (retp);
 126 }
 127
 128 #define NFSM_DISSECT(a, c, s)                                           \
 129         do {                                                            \
 130                 (a) = (c)nfsm_dissect(nd, (s));                         \
 131                 if ((a) == NULL) {                                      \
 132                         error = EBADRPC;                                \
 133                         goto nfsmout;                                   \
 134                 }                                                       \
 135         } while (0)
 136
 137 #define NFSM_DISSECT_NONBLOCK(a, c, s)                                  \
 138         do {                                                            \
 139                 (a) = (c)nfsm_dissect_nonblock(nd, (s));                \
 140                 if ((a) == NULL) {                                      \
 141                         error = EBADRPC;                                \
 142                         goto nfsmout;                                   \
 143                 }                                                       \
 144         } while (0)
 145 #endif  /* !APPLE */
 146
 147 #define NFSM_STRSIZ(s, m)                                               \
 148         do {                                                            \
 149                 tl = (u_int32_t *)nfsm_dissect(nd, NFSX_UNSIGNED);      \
 150                 if (!tl || ((s) = fxdr_unsigned(int32_t, *tl)) > (m)) { \
 151                         error = EBADRPC;                                \
 152                         goto nfsmout;                                   \
 153                 }                                                       \
 154         } while (0)
 155
 156 #define NFSM_RNDUP(a)   (((a)+3)&(~0x3))
 157
 158 #endif  /* _NFS_NFSM_SUBS_H_ */