sys/xdr/xdr_mbuf.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2008 Isilon Inc http://www.isilon.com/
   5  * Authors: Doug Rabson <dfr@rabson.org>
   6  * Developed with Red Inc: Alfred Perlstein <alfred@freebsd.org>
   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  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  */
  29
  30 #include <sys/cdefs.h>
  31 __FBSDID("$FreeBSD$");
  32
  33 #include <sys/param.h>
  34 #include <sys/systm.h>
  35 #include <sys/malloc.h>
  36 #include <sys/mbuf.h>
  37
  38 #include <rpc/types.h>
  39 #include <rpc/xdr.h>
  40
  41 static void xdrmbuf_destroy(XDR *);
  42 static bool_t xdrmbuf_getlong(XDR *, long *);
  43 static bool_t xdrmbuf_putlong(XDR *, const long *);
  44 static bool_t xdrmbuf_getbytes(XDR *, char *, u_int);
  45 static bool_t xdrmbuf_putbytes(XDR *, const char *, u_int);
  46 /* XXX: w/64-bit pointers, u_int not enough! */
  47 static u_int xdrmbuf_getpos(XDR *);
  48 static bool_t xdrmbuf_setpos(XDR *, u_int);
  49 static int32_t *xdrmbuf_inline(XDR *, u_int);
  50
  51 static const struct     xdr_ops xdrmbuf_ops = {
  52         xdrmbuf_getlong,
  53         xdrmbuf_putlong,
  54         xdrmbuf_getbytes,
  55         xdrmbuf_putbytes,
  56         xdrmbuf_getpos,
  57         xdrmbuf_setpos,
  58         xdrmbuf_inline,
  59         xdrmbuf_destroy
  60 };
  61
  62 /*
  63  * The procedure xdrmbuf_create initializes a stream descriptor for a
  64  * mbuf.
  65  */
  66 void
  67 xdrmbuf_create(XDR *xdrs, struct mbuf *m, enum xdr_op op)
  68 {
  69
  70         KASSERT(m != NULL, ("xdrmbuf_create with NULL mbuf chain"));
  71         xdrs->x_op = op;
  72         xdrs->x_ops = &xdrmbuf_ops;
  73         xdrs->x_base = (char *) m;
  74         if (op == XDR_ENCODE) {
  75                 m = m_last(m);
  76                 xdrs->x_private = m;
  77                 xdrs->x_handy = m->m_len;
  78         } else {
  79                 xdrs->x_private = m;
  80                 xdrs->x_handy = 0;
  81         }
  82 }
  83
  84 void
  85 xdrmbuf_append(XDR *xdrs, struct mbuf *madd)
  86 {
  87         struct mbuf *m;
  88
  89         KASSERT(xdrs->x_ops == &xdrmbuf_ops && xdrs->x_op == XDR_ENCODE,
  90             ("xdrmbuf_append: invalid XDR stream"));
  91
  92         if (m_length(madd, NULL) == 0) {
  93                 m_freem(madd);
  94                 return;
  95         }
  96
  97         m = (struct mbuf *) xdrs->x_private;
  98         m->m_next = madd;
  99
 100         m = m_last(madd);
 101         xdrs->x_private = m;
 102         xdrs->x_handy = m->m_len;
 103 }
 104
 105 struct mbuf *
 106 xdrmbuf_getall(XDR *xdrs)
 107 {
 108         struct mbuf *m0, *m;
 109
 110         KASSERT(xdrs->x_ops == &xdrmbuf_ops && xdrs->x_op == XDR_DECODE,
 111             ("xdrmbuf_append: invalid XDR stream"));
 112
 113         m0 = (struct mbuf *) xdrs->x_base;
 114         m = (struct mbuf *) xdrs->x_private;
 115         if (m0 != m) {
 116                 while (m0->m_next != m)
 117                         m0 = m0->m_next;
 118                 m0->m_next = NULL;
 119                 xdrs->x_private = NULL;
 120         } else {
 121                 xdrs->x_base = NULL;
 122                 xdrs->x_private = NULL;
 123         }
 124
 125         if (m)
 126                 m_adj(m, xdrs->x_handy);
 127         else
 128                 m = m_get(M_WAITOK, MT_DATA);
 129         return (m);
 130 }
 131
 132 static void
 133 xdrmbuf_destroy(XDR *xdrs)
 134 {
 135
 136         if (xdrs->x_op == XDR_DECODE && xdrs->x_base) {
 137                 m_freem((struct mbuf *) xdrs->x_base);
 138                 xdrs->x_base = NULL;
 139                 xdrs->x_private = NULL;
 140         }
 141 }
 142
 143 static bool_t
 144 xdrmbuf_getlong(XDR *xdrs, long *lp)
 145 {
 146         int32_t *p;
 147         int32_t t;
 148
 149         p = xdrmbuf_inline(xdrs, sizeof(int32_t));
 150         if (p) {
 151                 t = *p;
 152         } else {
 153                 xdrmbuf_getbytes(xdrs, (char *) &t, sizeof(int32_t));
 154         }
 155
 156         *lp = ntohl(t);
 157         return (TRUE);
 158 }
 159
 160 static bool_t
 161 xdrmbuf_putlong(XDR *xdrs, const long *lp)
 162 {
 163         int32_t *p;
 164         int32_t t = htonl(*lp);
 165
 166         p = xdrmbuf_inline(xdrs, sizeof(int32_t));
 167         if (p) {
 168                 *p = t;
 169                 return (TRUE);
 170         } else {
 171                 return (xdrmbuf_putbytes(xdrs, (char *) &t, sizeof(int32_t)));
 172         }
 173 }
 174
 175 static bool_t
 176 xdrmbuf_getbytes(XDR *xdrs, char *addr, u_int len)
 177 {
 178         struct mbuf *m = (struct mbuf *) xdrs->x_private;
 179         size_t sz;
 180
 181         while (len > 0) {
 182                 /*
 183                  * Make sure we haven't hit the end.
 184                  */
 185                 if (!m) {
 186                         return (FALSE);
 187                 }
 188
 189                 /*
 190                  * See how much we can get from this mbuf.
 191                  */
 192                 sz = m->m_len - xdrs->x_handy;
 193                 if (sz > len)
 194                         sz = len;
 195                 bcopy(mtod(m, const char *) + xdrs->x_handy, addr, sz);
 196
 197                 addr += sz;
 198                 xdrs->x_handy += sz;
 199                 len -= sz;
 200
 201                 if (xdrs->x_handy == m->m_len) {
 202                         m = m->m_next;
 203                         xdrs->x_private = (void *) m;
 204                         xdrs->x_handy = 0;
 205                 }
 206         }
 207
 208         return (TRUE);
 209 }
 210
 211 static bool_t
 212 xdrmbuf_putbytes(XDR *xdrs, const char *addr, u_int len)
 213 {
 214         struct mbuf *m = (struct mbuf *) xdrs->x_private;
 215         struct mbuf *n;
 216         size_t sz;
 217
 218         while (len > 0) {
 219                 sz = M_TRAILINGSPACE(m) + (m->m_len - xdrs->x_handy);
 220                 if (sz > len)
 221                         sz = len;
 222                 bcopy(addr, mtod(m, char *) + xdrs->x_handy, sz);
 223                 addr += sz;
 224                 xdrs->x_handy += sz;
 225                 if (xdrs->x_handy > m->m_len)
 226                         m->m_len = xdrs->x_handy;
 227                 len -= sz;
 228
 229                 if (xdrs->x_handy == m->m_len && M_TRAILINGSPACE(m) == 0) {
 230                         if (!m->m_next) {
 231                                 if (m->m_flags & M_EXT)
 232                                         n = m_getcl(M_WAITOK, m->m_type, 0);
 233                                 else
 234                                         n = m_get(M_WAITOK, m->m_type);
 235                                 m->m_next = n;
 236                         }
 237                         m = m->m_next;
 238                         xdrs->x_private = (void *) m;
 239                         xdrs->x_handy = 0;
 240                 }
 241         }
 242
 243         return (TRUE);
 244 }
 245
 246 static u_int
 247 xdrmbuf_getpos(XDR *xdrs)
 248 {
 249         struct mbuf *m0 = (struct mbuf *) xdrs->x_base;
 250         struct mbuf *m = (struct mbuf *) xdrs->x_private;
 251         u_int pos = 0;
 252
 253         while (m0 && m0 != m) {
 254                 pos += m0->m_len;
 255                 m0 = m0->m_next;
 256         }
 257         KASSERT(m0, ("Corrupted mbuf chain"));
 258
 259         return (pos + xdrs->x_handy);
 260 }
 261
 262 static bool_t
 263 xdrmbuf_setpos(XDR *xdrs, u_int pos)
 264 {
 265         struct mbuf *m = (struct mbuf *) xdrs->x_base;
 266
 267         while (m && pos > m->m_len) {
 268                 pos -= m->m_len;
 269                 m = m->m_next;
 270         }
 271         KASSERT(m, ("Corrupted mbuf chain"));
 272
 273         xdrs->x_private = (void *) m;
 274         xdrs->x_handy = pos;
 275
 276         return (TRUE);
 277 }
 278
 279 static int32_t *
 280 xdrmbuf_inline(XDR *xdrs, u_int len)
 281 {
 282         struct mbuf *m = (struct mbuf *) xdrs->x_private;
 283         size_t available;
 284         char *p;
 285
 286         if (!m)
 287                 return (0);
 288         if (xdrs->x_op == XDR_ENCODE) {
 289                 available = M_TRAILINGSPACE(m) + (m->m_len - xdrs->x_handy);
 290         } else {
 291                 available = m->m_len - xdrs->x_handy;
 292         }
 293
 294         if (available >= len) {
 295                 p = mtod(m, char *) + xdrs->x_handy;
 296                 if (((uintptr_t) p) & (sizeof(int32_t) - 1))
 297                         return (0);
 298                 xdrs->x_handy += len;
 299                 if (xdrs->x_handy > m->m_len)
 300                         m->m_len = xdrs->x_handy;
 301                 return ((int32_t *) p);
 302         }
 303
 304         return (0);
 305 }