sys/kern/uipc_mbuf2.c

   1 /*      $FreeBSD: src/sys/kern/uipc_mbuf2.c,v 1.2.2.5 2003/01/23 21:06:44 sam Exp $     */
   2 /*      $DragonFly: src/sys/kern/uipc_mbuf2.c,v 1.8 2004/07/31 07:52:48 dillon Exp $    */
   3 /*      $KAME: uipc_mbuf2.c,v 1.31 2001/11/28 11:08:53 itojun Exp $     */
   4 /*      $NetBSD: uipc_mbuf.c,v 1.40 1999/04/01 00:23:25 thorpej Exp $   */
   5
   6 /*
   7  * Copyright (C) 1999 WIDE Project.
   8  * All rights reserved.
   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 project 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 PROJECT 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 PROJECT 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
  35 /*
  36  * Copyright (c) 1982, 1986, 1988, 1991, 1993
  37  *      The Regents of the University of California.  All rights reserved.
  38  *
  39  * Redistribution and use in source and binary forms, with or without
  40  * modification, are permitted provided that the following conditions
  41  * are met:
  42  * 1. Redistributions of source code must retain the above copyright
  43  *    notice, this list of conditions and the following disclaimer.
  44  * 2. Redistributions in binary form must reproduce the above copyright
  45  *    notice, this list of conditions and the following disclaimer in the
  46  *    documentation and/or other materials provided with the distribution.
  47  * 3. All advertising materials mentioning features or use of this software
  48  *    must display the following acknowledgement:
  49  *      This product includes software developed by the University of
  50  *      California, Berkeley and its contributors.
  51  * 4. Neither the name of the University nor the names of its contributors
  52  *    may be used to endorse or promote products derived from this software
  53  *    without specific prior written permission.
  54  *
  55  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  56  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  57  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  58  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  59  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  60  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  61  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  62  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  63  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  64  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  65  * SUCH DAMAGE.
  66  *
  67  *      @(#)uipc_mbuf.c 8.4 (Berkeley) 2/14/95
  68  */
  69
  70 /*#define PULLDOWN_DEBUG*/
  71
  72 #include <sys/param.h>
  73 #include <sys/systm.h>
  74 #include <sys/kernel.h>
  75 #include <sys/proc.h>
  76 #include <sys/malloc.h>
  77 #include <sys/mbuf.h>
  78
  79 MALLOC_DEFINE(M_PACKET_TAGS, "tag", "packet-attached information");
  80
  81 /* can't call it m_dup(), as freebsd[34] uses m_dup() with different arg */
  82 static struct mbuf *m_dup1 (struct mbuf *, int, int, int);
  83
  84 /*
  85  * ensure that [off, off + len) is contiguous on the mbuf chain "m".
  86  * packet chain before "off" is kept untouched.
  87  * if offp == NULL, the target will start at <retval, 0> on resulting chain.
  88  * if offp != NULL, the target will start at <retval, *offp> on resulting chain.
  89  *
  90  * on error return (NULL return value), original "m" will be freed.
  91  *
  92  * XXX M_TRAILINGSPACE/M_LEADINGSPACE on shared cluster (sharedcluster)
  93  */
  94 struct mbuf *
  95 m_pulldown(m, off, len, offp)
  96         struct mbuf *m;
  97         int off, len;
  98         int *offp;
  99 {
 100         struct mbuf *n, *o;
 101         int hlen, tlen, olen;
 102         int sharedcluster;
 103
 104         /* check invalid arguments. */
 105         if (m == NULL)
 106                 panic("m == NULL in m_pulldown()");
 107         if (len > MCLBYTES) {
 108                 m_freem(m);
 109                 return NULL;    /* impossible */
 110         }
 111
 112 #ifdef PULLDOWN_DEBUG
 113     {
 114         struct mbuf *t;
 115         printf("before:");
 116         for (t = m; t; t = t->m_next)
 117                 printf(" %d", t->m_len);
 118         printf("\n");
 119     }
 120 #endif
 121         n = m;
 122         while (n != NULL && off > 0) {
 123                 if (n->m_len > off)
 124                         break;
 125                 off -= n->m_len;
 126                 n = n->m_next;
 127         }
 128         /* be sure to point non-empty mbuf */
 129         while (n != NULL && n->m_len == 0)
 130                 n = n->m_next;
 131         if (!n) {
 132                 m_freem(m);
 133                 return NULL;    /* mbuf chain too short */
 134         }
 135
 136         sharedcluster = (m_sharecount(n) > 1);
 137
 138         /*
 139          * the target data is on <n, off>.
 140          * if we got enough data on the mbuf "n", we're done.
 141          */
 142         if ((off == 0 || offp) && len <= n->m_len - off && !sharedcluster)
 143                 goto ok;
 144
 145         /*
 146          * when len <= n->m_len - off and off != 0, it is a special case.
 147          * len bytes from <n, off> sits in single mbuf, but the caller does
 148          * not like the starting position (off).
 149          * chop the current mbuf into two pieces, set off to 0.
 150          */
 151         if (len <= n->m_len - off) {
 152                 o = m_dup1(n, off, n->m_len - off, MB_DONTWAIT);
 153                 if (o == NULL) {
 154                         m_freem(m);
 155                         return NULL;    /* ENOBUFS */
 156                 }
 157                 n->m_len = off;
 158                 o->m_next = n->m_next;
 159                 n->m_next = o;
 160                 n = n->m_next;
 161                 off = 0;
 162                 goto ok;
 163         }
 164
 165         /*
 166          * we need to take hlen from <n, off> and tlen from <n->m_next, 0>,
 167          * and construct contiguous mbuf with m_len == len.
 168          * note that hlen + tlen == len, and tlen > 0.
 169          */
 170         hlen = n->m_len - off;
 171         tlen = len - hlen;
 172
 173         /*
 174          * ensure that we have enough trailing data on mbuf chain.
 175          * if not, we can do nothing about the chain.
 176          */
 177         olen = 0;
 178         for (o = n->m_next; o != NULL; o = o->m_next)
 179                 olen += o->m_len;
 180         if (hlen + olen < len) {
 181                 m_freem(m);
 182                 return NULL;    /* mbuf chain too short */
 183         }
 184
 185         /*
 186          * easy cases first.
 187          * we need to use m_copydata() to get data from <n->m_next, 0>.
 188          */
 189         if ((off == 0 || offp) && M_TRAILINGSPACE(n) >= tlen &&
 190             !sharedcluster) {
 191                 m_copydata(n->m_next, 0, tlen, mtod(n, caddr_t) + n->m_len);
 192                 n->m_len += tlen;
 193                 m_adj(n->m_next, tlen);
 194                 goto ok;
 195         }
 196         if ((off == 0 || offp) && M_LEADINGSPACE(n->m_next) >= hlen &&
 197             !sharedcluster) {
 198                 n->m_next->m_data -= hlen;
 199                 n->m_next->m_len += hlen;
 200                 bcopy(mtod(n, caddr_t) + off, mtod(n->m_next, caddr_t), hlen);
 201                 n->m_len -= hlen;
 202                 n = n->m_next;
 203                 off = 0;
 204                 goto ok;
 205         }
 206
 207         /*
 208          * now, we need to do the hard way.  don't m_copy as there's no room
 209          * on both end.
 210          */
 211         MGET(o, MB_DONTWAIT, m->m_type);
 212         if (o && len > MLEN) {
 213                 MCLGET(o, MB_DONTWAIT);
 214                 if ((o->m_flags & M_EXT) == 0) {
 215                         m_free(o);
 216                         o = NULL;
 217                 }
 218         }
 219         if (!o) {
 220                 m_freem(m);
 221                 return NULL;    /* ENOBUFS */
 222         }
 223         /* get hlen from <n, off> into <o, 0> */
 224         o->m_len = hlen;
 225         bcopy(mtod(n, caddr_t) + off, mtod(o, caddr_t), hlen);
 226         n->m_len -= hlen;
 227         /* get tlen from <n->m_next, 0> into <o, hlen> */
 228         m_copydata(n->m_next, 0, tlen, mtod(o, caddr_t) + o->m_len);
 229         o->m_len += tlen;
 230         m_adj(n->m_next, tlen);
 231         o->m_next = n->m_next;
 232         n->m_next = o;
 233         n = o;
 234         off = 0;
 235
 236 ok:
 237 #ifdef PULLDOWN_DEBUG
 238     {
 239         struct mbuf *t;
 240         printf("after:");
 241         for (t = m; t; t = t->m_next)
 242                 printf("%c%d", t == n ? '*' : ' ', t->m_len);
 243         printf(" (off=%d)\n", off);
 244     }
 245 #endif
 246         if (offp)
 247                 *offp = off;
 248         return n;
 249 }
 250
 251 static struct mbuf *
 252 m_dup1(m, off, len, wait)
 253         struct mbuf *m;
 254         int off;
 255         int len;
 256         int wait;
 257 {
 258         struct mbuf *n;
 259         int l;
 260         int copyhdr;
 261
 262         if (len > MCLBYTES)
 263                 return NULL;
 264         if (off == 0 && (m->m_flags & M_PKTHDR) != 0) {
 265                 copyhdr = 1;
 266                 MGETHDR(n, wait, m->m_type);
 267                 l = MHLEN;
 268         } else {
 269                 copyhdr = 0;
 270                 MGET(n, wait, m->m_type);
 271                 l = MLEN;
 272         }
 273         if (n && len > l) {
 274                 MCLGET(n, wait);
 275                 if ((n->m_flags & M_EXT) == 0) {
 276                         m_free(n);
 277                         n = NULL;
 278                 }
 279         }
 280         if (!n)
 281                 return NULL;
 282
 283         if (copyhdr && !m_dup_pkthdr(n, m, wait)) {
 284                 m_free(n);
 285                 return NULL;
 286         }
 287         m_copydata(m, off, len, mtod(n, caddr_t));
 288         return n;
 289 }
 290
 291 /* Get a packet tag structure along with specified data following. */
 292 struct m_tag *
 293 m_tag_alloc(u_int32_t cookie, int type, int len, int wait)
 294 {
 295         struct m_tag *t;
 296
 297         if (len < 0)
 298                 return NULL;
 299         t = malloc(len + sizeof(struct m_tag), M_PACKET_TAGS,
 300                    wait != MB_WAIT ? M_NOWAIT : M_WAITOK);
 301         if (t == NULL)
 302                 return NULL;
 303         t->m_tag_id = type;
 304         t->m_tag_len = len;
 305         t->m_tag_cookie = cookie;
 306         return t;
 307 }
 308
 309
 310 /* Free a packet tag. */
 311 void
 312 m_tag_free(struct m_tag *t)
 313 {
 314         free(t, M_PACKET_TAGS);
 315 }
 316
 317 /* Prepend a packet tag. */
 318 void
 319 m_tag_prepend(struct mbuf *m, struct m_tag *t)
 320 {
 321         KASSERT(m && t, ("m_tag_prepend: null argument, m %p t %p", m, t));
 322         SLIST_INSERT_HEAD(&m->m_pkthdr.tags, t, m_tag_link);
 323 }
 324
 325 /* Unlink a packet tag. */
 326 void
 327 m_tag_unlink(struct mbuf *m, struct m_tag *t)
 328 {
 329         KASSERT(m && t, ("m_tag_unlink: null argument, m %p t %p", m, t));
 330         SLIST_REMOVE(&m->m_pkthdr.tags, t, m_tag, m_tag_link);
 331 }
 332
 333 /* Unlink and free a packet tag. */
 334 void
 335 m_tag_delete(struct mbuf *m, struct m_tag *t)
 336 {
 337         KASSERT(m && t, ("m_tag_delete: null argument, m %p t %p", m, t));
 338         m_tag_unlink(m, t);
 339         m_tag_free(t);
 340 }
 341
 342 /* Unlink and free a packet tag chain, starting from given tag. */
 343 void
 344 m_tag_delete_chain(struct mbuf *m, struct m_tag *t)
 345 {
 346         struct m_tag *p, *q;
 347
 348         KASSERT(m, ("m_tag_delete_chain: null mbuf"));
 349         if (t != NULL)
 350                 p = t;
 351         else
 352                 p = SLIST_FIRST(&m->m_pkthdr.tags);
 353         if (p == NULL)
 354                 return;
 355         while ((q = SLIST_NEXT(p, m_tag_link)) != NULL)
 356                 m_tag_delete(m, q);
 357         m_tag_delete(m, p);
 358 }
 359
 360 /* Find a tag, starting from a given position. */
 361 struct m_tag *
 362 m_tag_locate(struct mbuf *m, u_int32_t cookie, int type, struct m_tag *t)
 363 {
 364         struct m_tag *p;
 365
 366         KASSERT(m, ("m_tag_find: null mbuf"));
 367         if (t == NULL)
 368                 p = SLIST_FIRST(&m->m_pkthdr.tags);
 369         else
 370                 p = SLIST_NEXT(t, m_tag_link);
 371         while (p != NULL) {
 372                 if (p->m_tag_cookie == cookie && p->m_tag_id == type)
 373                         return p;
 374                 p = SLIST_NEXT(p, m_tag_link);
 375         }
 376         return NULL;
 377 }
 378
 379 /* Copy a single tag. */
 380 struct m_tag *
 381 m_tag_copy(struct m_tag *t, int how)
 382 {
 383         struct m_tag *p;
 384
 385         KASSERT(t, ("m_tag_copy: null tag"));
 386         p = m_tag_alloc(t->m_tag_cookie, t->m_tag_id, t->m_tag_len, how);
 387         if (p == NULL)
 388                 return (NULL);
 389         bcopy(t + 1, p + 1, t->m_tag_len); /* Copy the data */
 390         return p;
 391 }
 392
 393 /*
 394  * Copy two tag chains. The destination mbuf (to) loses any attached
 395  * tags even if the operation fails. This should not be a problem, as
 396  * m_tag_copy_chain() is typically called with a newly-allocated
 397  * destination mbuf.
 398  */
 399 int
 400 m_tag_copy_chain(struct mbuf *to, const struct mbuf *from, int how)
 401 {
 402         struct m_tag *p, *t, *tprev = NULL;
 403
 404         KASSERT(to && from,
 405                 ("m_tag_copy: null argument, to %p from %p", to, from));
 406         m_tag_delete_chain(to, NULL);
 407         SLIST_FOREACH(p, &from->m_pkthdr.tags, m_tag_link) {
 408                 t = m_tag_copy(p, how);
 409                 if (t == NULL) {
 410                         m_tag_delete_chain(to, NULL);
 411                         return 0;
 412                 }
 413                 if (tprev == NULL)
 414                         SLIST_INSERT_HEAD(&to->m_pkthdr.tags, t, m_tag_link);
 415                 else {
 416                         SLIST_INSERT_AFTER(tprev, t, m_tag_link);
 417                         tprev = t;
 418                 }
 419         }
 420         return 1;
 421 }
 422
 423 /* Initialize tags on an mbuf. */
 424 void
 425 m_tag_init(struct mbuf *m)
 426 {
 427         SLIST_INIT(&m->m_pkthdr.tags);
 428 }
 429
 430 /* Get first tag in chain. */
 431 struct m_tag *
 432 m_tag_first(struct mbuf *m)
 433 {
 434         return SLIST_FIRST(&m->m_pkthdr.tags);
 435 }
 436
 437 /* Get next tag in chain. */
 438 struct m_tag *
 439 m_tag_next(struct mbuf *m, struct m_tag *t)
 440 {
 441         return SLIST_NEXT(t, m_tag_link);
 442 }