sys/kern/uipc_mbuf.c

   1 /*
   2  * Copyright (c) 2004 Jeffrey M. Hsu.  All rights reserved.
   3  * Copyright (c) 2004 The DragonFly Project.  All rights reserved.
   4  *
   5  * This code is derived from software contributed to The DragonFly Project
   6  * by Jeffrey M. Hsu.
   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  * 3. Neither the name of The DragonFly Project nor the names of its
  17  *    contributors may be used to endorse or promote products derived
  18  *    from this software without specific, prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  24  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  25  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
  26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  27  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  28  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  29  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  30  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  */
  33
  34 /*
  35  * Copyright (c) 1982, 1986, 1988, 1991, 1993
  36  *      The Regents of the University of California.  All rights reserved.
  37  *
  38  * Redistribution and use in source and binary forms, with or without
  39  * modification, are permitted provided that the following conditions
  40  * are met:
  41  * 1. Redistributions of source code must retain the above copyright
  42  *    notice, this list of conditions and the following disclaimer.
  43  * 2. Redistributions in binary form must reproduce the above copyright
  44  *    notice, this list of conditions and the following disclaimer in the
  45  *    documentation and/or other materials provided with the distribution.
  46  * 3. All advertising materials mentioning features or use of this software
  47  *    must display the following acknowledgement:
  48  *      This product includes software developed by the University of
  49  *      California, Berkeley and its contributors.
  50  * 4. Neither the name of the University nor the names of its contributors
  51  *    may be used to endorse or promote products derived from this software
  52  *    without specific prior written permission.
  53  *
  54  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  55  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  56  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  57  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  58  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  59  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  60  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  61  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  62  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  63  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  64  * SUCH DAMAGE.
  65  *
  66  * @(#)uipc_mbuf.c      8.2 (Berkeley) 1/4/94
  67  * $FreeBSD: src/sys/kern/uipc_mbuf.c,v 1.51.2.24 2003/04/15 06:59:29 silby Exp $
  68  * $DragonFly: src/sys/kern/uipc_mbuf.c,v 1.64 2007/08/11 23:11:22 josepht Exp $
  69  */
  70
  71 #include "opt_param.h"
  72 #include "opt_ddb.h"
  73 #include "opt_mbuf_stress_test.h"
  74 #include <sys/param.h>
  75 #include <sys/systm.h>
  76 #include <sys/malloc.h>
  77 #include <sys/mbuf.h>
  78 #include <sys/kernel.h>
  79 #include <sys/sysctl.h>
  80 #include <sys/domain.h>
  81 #include <sys/objcache.h>
  82 #include <sys/tree.h>
  83 #include <sys/protosw.h>
  84 #include <sys/uio.h>
  85 #include <sys/thread.h>
  86 #include <sys/globaldata.h>
  87 #include <sys/serialize.h>
  88 #include <sys/thread2.h>
  89
  90 #include <vm/vm.h>
  91 #include <vm/vm_kern.h>
  92 #include <vm/vm_extern.h>
  93
  94 #ifdef INVARIANTS
  95 #include <machine/cpu.h>
  96 #endif
  97
  98 /*
  99  * mbuf cluster meta-data
 100  */
 101 struct mbcluster {
 102         int32_t mcl_refs;
 103         void    *mcl_data;
 104         struct lwkt_serialize mcl_serializer;
 105 };
 106
 107 /*
 108  * mbuf tracking for debugging purposes
 109  */
 110 #ifdef MBUF_DEBUG
 111
 112 static MALLOC_DEFINE(M_MTRACK, "mtrack", "mtrack");
 113
 114 struct mbctrack;
 115 RB_HEAD(mbuf_rb_tree, mbtrack);
 116 RB_PROTOTYPE2(mbuf_rb_tree, mbtrack, rb_node, mbtrack_cmp, struct mbuf *);
 117
 118 struct mbtrack {
 119         RB_ENTRY(mbtrack) rb_node;
 120         int trackid;
 121         struct mbuf *m;
 122 };
 123
 124 static int
 125 mbtrack_cmp(struct mbtrack *mb1, struct mbtrack *mb2)
 126 {
 127         if (mb1->m < mb2->m)
 128                 return(-1);
 129         if (mb1->m > mb2->m)
 130                 return(1);
 131         return(0);
 132 }
 133
 134 RB_GENERATE2(mbuf_rb_tree, mbtrack, rb_node, mbtrack_cmp, struct mbuf *, m);
 135
 136 struct mbuf_rb_tree     mbuf_track_root;
 137
 138 static void
 139 mbuftrack(struct mbuf *m)
 140 {
 141         struct mbtrack *mbt;
 142
 143         crit_enter();
 144         mbt = kmalloc(sizeof(*mbt), M_MTRACK, M_INTWAIT|M_ZERO);
 145         mbt->m = m;
 146         if (mbuf_rb_tree_RB_INSERT(&mbuf_track_root, mbt))
 147                 panic("mbuftrack: mbuf %p already being tracked\n", m);
 148         crit_exit();
 149 }
 150
 151 static void
 152 mbufuntrack(struct mbuf *m)
 153 {
 154         struct mbtrack *mbt;
 155
 156         crit_enter();
 157         mbt = mbuf_rb_tree_RB_LOOKUP(&mbuf_track_root, m);
 158         if (mbt == NULL) {
 159                 kprintf("mbufuntrack: mbuf %p was not tracked\n", m);
 160         } else {
 161                 mbuf_rb_tree_RB_REMOVE(&mbuf_track_root, mbt);
 162                 kfree(mbt, M_MTRACK);
 163         }
 164         crit_exit();
 165 }
 166
 167 void
 168 mbuftrackid(struct mbuf *m, int trackid)
 169 {
 170         struct mbtrack *mbt;
 171         struct mbuf *n;
 172
 173         crit_enter();
 174         while (m) {
 175                 n = m->m_nextpkt;
 176                 while (m) {
 177                         mbt = mbuf_rb_tree_RB_LOOKUP(&mbuf_track_root, m);
 178                         if (mbt)
 179                                 mbt->trackid = trackid;
 180                         m = m->m_next;
 181                 }
 182                 m = n;
 183         }
 184         crit_exit();
 185 }
 186
 187 static int
 188 mbuftrack_callback(struct mbtrack *mbt, void *arg)
 189 {
 190         struct sysctl_req *req = arg;
 191         char buf[64];
 192         int error;
 193
 194         ksnprintf(buf, sizeof(buf), "mbuf %p track %d\n", mbt->m, mbt->trackid);
 195
 196         error = SYSCTL_OUT(req, buf, strlen(buf));
 197         if (error)
 198                 return(-error);
 199         return(0);
 200 }
 201
 202 static int
 203 mbuftrack_show(SYSCTL_HANDLER_ARGS)
 204 {
 205         int error;
 206
 207         crit_enter();
 208         error = mbuf_rb_tree_RB_SCAN(&mbuf_track_root, NULL,
 209                                      mbuftrack_callback, req);
 210         crit_exit();
 211         return (-error);
 212 }
 213 SYSCTL_PROC(_kern_ipc, OID_AUTO, showmbufs, CTLFLAG_RD|CTLTYPE_STRING,
 214             0, 0, mbuftrack_show, "A", "Show all in-use mbufs");
 215
 216 #else
 217
 218 #define mbuftrack(m)
 219 #define mbufuntrack(m)
 220
 221 #endif
 222
 223 static void mbinit(void *);
 224 SYSINIT(mbuf, SI_BOOT2_MACHDEP, SI_ORDER_FIRST, mbinit, NULL)
 225
 226 static u_long   mbtypes[SMP_MAXCPU][MT_NTYPES];
 227
 228 static struct mbstat mbstat[SMP_MAXCPU];
 229 int     max_linkhdr;
 230 int     max_protohdr;
 231 int     max_hdr;
 232 int     max_datalen;
 233 int     m_defragpackets;
 234 int     m_defragbytes;
 235 int     m_defraguseless;
 236 int     m_defragfailure;
 237 #ifdef MBUF_STRESS_TEST
 238 int     m_defragrandomfailures;
 239 #endif
 240
 241 struct objcache *mbuf_cache, *mbufphdr_cache;
 242 struct objcache *mclmeta_cache;
 243 struct objcache *mbufcluster_cache, *mbufphdrcluster_cache;
 244
 245 int     nmbclusters;
 246 int     nmbufs;
 247
 248 SYSCTL_INT(_kern_ipc, KIPC_MAX_LINKHDR, max_linkhdr, CTLFLAG_RW,
 249            &max_linkhdr, 0, "");
 250 SYSCTL_INT(_kern_ipc, KIPC_MAX_PROTOHDR, max_protohdr, CTLFLAG_RW,
 251            &max_protohdr, 0, "");
 252 SYSCTL_INT(_kern_ipc, KIPC_MAX_HDR, max_hdr, CTLFLAG_RW, &max_hdr, 0, "");
 253 SYSCTL_INT(_kern_ipc, KIPC_MAX_DATALEN, max_datalen, CTLFLAG_RW,
 254            &max_datalen, 0, "");
 255 SYSCTL_INT(_kern_ipc, OID_AUTO, mbuf_wait, CTLFLAG_RW,
 256            &mbuf_wait, 0, "");
 257 static int do_mbstat(SYSCTL_HANDLER_ARGS);
 258
 259 SYSCTL_PROC(_kern_ipc, KIPC_MBSTAT, mbstat, CTLTYPE_STRUCT|CTLFLAG_RD,
 260         0, 0, do_mbstat, "S,mbstat", "");
 261
 262 static int do_mbtypes(SYSCTL_HANDLER_ARGS);
 263
 264 SYSCTL_PROC(_kern_ipc, OID_AUTO, mbtypes, CTLTYPE_ULONG|CTLFLAG_RD,
 265         0, 0, do_mbtypes, "LU", "");
 266
 267 static int
 268 do_mbstat(SYSCTL_HANDLER_ARGS)
 269 {
 270         struct mbstat mbstat_total;
 271         struct mbstat *mbstat_totalp;
 272         int i;
 273
 274         bzero(&mbstat_total, sizeof(mbstat_total));
 275         mbstat_totalp = &mbstat_total;
 276
 277         for (i = 0; i < ncpus; i++)
 278         {
 279                 mbstat_total.m_mbufs += mbstat[i].m_mbufs;
 280                 mbstat_total.m_clusters += mbstat[i].m_clusters;
 281                 mbstat_total.m_spare += mbstat[i].m_spare;
 282                 mbstat_total.m_clfree += mbstat[i].m_clfree;
 283                 mbstat_total.m_drops += mbstat[i].m_drops;
 284                 mbstat_total.m_wait += mbstat[i].m_wait;
 285                 mbstat_total.m_drain += mbstat[i].m_drain;
 286                 mbstat_total.m_mcfail += mbstat[i].m_mcfail;
 287                 mbstat_total.m_mpfail += mbstat[i].m_mpfail;
 288
 289         }
 290         /*
 291          * The following fields are not cumulative fields so just
 292          * get their values once.
 293          */
 294         mbstat_total.m_msize = mbstat[0].m_msize;
 295         mbstat_total.m_mclbytes = mbstat[0].m_mclbytes;
 296         mbstat_total.m_minclsize = mbstat[0].m_minclsize;
 297         mbstat_total.m_mlen = mbstat[0].m_mlen;
 298         mbstat_total.m_mhlen = mbstat[0].m_mhlen;
 299
 300         return(sysctl_handle_opaque(oidp, mbstat_totalp, sizeof(mbstat_total), req));
 301 }
 302
 303 static int
 304 do_mbtypes(SYSCTL_HANDLER_ARGS)
 305 {
 306         u_long totals[MT_NTYPES];
 307         int i, j;
 308
 309         for (i = 0; i < MT_NTYPES; i++)
 310                 totals[i] = 0;
 311
 312         for (i = 0; i < ncpus; i++)
 313         {
 314                 for (j = 0; j < MT_NTYPES; j++)
 315                         totals[j] += mbtypes[i][j];
 316         }
 317
 318         return(sysctl_handle_opaque(oidp, totals, sizeof(totals), req));
 319 }
 320
 321 /*
 322  * These are read-only because we do not currently have any code
 323  * to adjust the objcache limits after the fact.  The variables
 324  * may only be set as boot-time tunables.
 325  */
 326 SYSCTL_INT(_kern_ipc, KIPC_NMBCLUSTERS, nmbclusters, CTLFLAG_RD,
 327            &nmbclusters, 0, "Maximum number of mbuf clusters available");
 328 SYSCTL_INT(_kern_ipc, OID_AUTO, nmbufs, CTLFLAG_RD, &nmbufs, 0,
 329            "Maximum number of mbufs available");
 330
 331 SYSCTL_INT(_kern_ipc, OID_AUTO, m_defragpackets, CTLFLAG_RD,
 332            &m_defragpackets, 0, "");
 333 SYSCTL_INT(_kern_ipc, OID_AUTO, m_defragbytes, CTLFLAG_RD,
 334            &m_defragbytes, 0, "");
 335 SYSCTL_INT(_kern_ipc, OID_AUTO, m_defraguseless, CTLFLAG_RD,
 336            &m_defraguseless, 0, "");
 337 SYSCTL_INT(_kern_ipc, OID_AUTO, m_defragfailure, CTLFLAG_RD,
 338            &m_defragfailure, 0, "");
 339 #ifdef MBUF_STRESS_TEST
 340 SYSCTL_INT(_kern_ipc, OID_AUTO, m_defragrandomfailures, CTLFLAG_RW,
 341            &m_defragrandomfailures, 0, "");
 342 #endif
 343
 344 static MALLOC_DEFINE(M_MBUF, "mbuf", "mbuf");
 345 static MALLOC_DEFINE(M_MBUFCL, "mbufcl", "mbufcl");
 346 static MALLOC_DEFINE(M_MCLMETA, "mclmeta", "mclmeta");
 347
 348 static void m_reclaim (void);
 349 static void m_mclref(void *arg);
 350 static void m_mclfree(void *arg);
 351
 352 #ifndef NMBCLUSTERS
 353 #define NMBCLUSTERS     (512 + maxusers * 16)
 354 #endif
 355 #ifndef NMBUFS
 356 #define NMBUFS          (nmbclusters * 2)
 357 #endif
 358
 359 /*
 360  * Perform sanity checks of tunables declared above.
 361  */
 362 static void
 363 tunable_mbinit(void *dummy)
 364 {
 365         /*
 366          * This has to be done before VM init.
 367          */
 368         nmbclusters = NMBCLUSTERS;
 369         TUNABLE_INT_FETCH("kern.ipc.nmbclusters", &nmbclusters);
 370         nmbufs = NMBUFS;
 371         TUNABLE_INT_FETCH("kern.ipc.nmbufs", &nmbufs);
 372         /* Sanity checks */
 373         if (nmbufs < nmbclusters * 2)
 374                 nmbufs = nmbclusters * 2;
 375 }
 376 SYSINIT(tunable_mbinit, SI_BOOT1_TUNABLES, SI_ORDER_ANY,
 377         tunable_mbinit, NULL);
 378
 379 /* "number of clusters of pages" */
 380 #define NCL_INIT        1
 381
 382 #define NMB_INIT        16
 383
 384 /*
 385  * The mbuf object cache only guarantees that m_next and m_nextpkt are
 386  * NULL and that m_data points to the beginning of the data area.  In
 387  * particular, m_len and m_pkthdr.len are uninitialized.  It is the
 388  * responsibility of the caller to initialize those fields before use.
 389  */
 390
 391 static boolean_t __inline
 392 mbuf_ctor(void *obj, void *private, int ocflags)
 393 {
 394         struct mbuf *m = obj;
 395
 396         m->m_next = NULL;
 397         m->m_nextpkt = NULL;
 398         m->m_data = m->m_dat;
 399         m->m_flags = 0;
 400
 401         return (TRUE);
 402 }
 403
 404 /*
 405  * Initialize the mbuf and the packet header fields.
 406  */
 407 static boolean_t
 408 mbufphdr_ctor(void *obj, void *private, int ocflags)
 409 {
 410         struct mbuf *m = obj;
 411
 412         m->m_next = NULL;
 413         m->m_nextpkt = NULL;
 414         m->m_data = m->m_pktdat;
 415         m->m_flags = M_PKTHDR | M_PHCACHE;
 416
 417         m->m_pkthdr.rcvif = NULL;       /* eliminate XXX JH */
 418         SLIST_INIT(&m->m_pkthdr.tags);
 419         m->m_pkthdr.csum_flags = 0;     /* eliminate XXX JH */
 420         m->m_pkthdr.fw_flags = 0;       /* eliminate XXX JH */
 421
 422         return (TRUE);
 423 }
 424
 425 /*
 426  * A mbcluster object consists of 2K (MCLBYTES) cluster and a refcount.
 427  */
 428 static boolean_t
 429 mclmeta_ctor(void *obj, void *private, int ocflags)
 430 {
 431         struct mbcluster *cl = obj;
 432         void *buf;
 433
 434         if (ocflags & M_NOWAIT)
 435                 buf = kmalloc(MCLBYTES, M_MBUFCL, M_NOWAIT | M_ZERO);
 436         else
 437                 buf = kmalloc(MCLBYTES, M_MBUFCL, M_INTWAIT | M_ZERO);
 438         if (buf == NULL)
 439                 return (FALSE);
 440         cl->mcl_refs = 0;
 441         cl->mcl_data = buf;
 442         lwkt_serialize_init(&cl->mcl_serializer);
 443         return (TRUE);
 444 }
 445
 446 static void
 447 mclmeta_dtor(void *obj, void *private)
 448 {
 449         struct mbcluster *mcl = obj;
 450
 451         KKASSERT(mcl->mcl_refs == 0);
 452         kfree(mcl->mcl_data, M_MBUFCL);
 453 }
 454
 455 static void
 456 linkcluster(struct mbuf *m, struct mbcluster *cl)
 457 {
 458         /*
 459          * Add the cluster to the mbuf.  The caller will detect that the
 460          * mbuf now has an attached cluster.
 461          */
 462         m->m_ext.ext_arg = cl;
 463         m->m_ext.ext_buf = cl->mcl_data;
 464         m->m_ext.ext_ref = m_mclref;
 465         m->m_ext.ext_free = m_mclfree;
 466         m->m_ext.ext_size = MCLBYTES;
 467         atomic_add_int(&cl->mcl_refs, 1);
 468
 469         m->m_data = m->m_ext.ext_buf;
 470         m->m_flags |= M_EXT | M_EXT_CLUSTER;
 471 }
 472
 473 static boolean_t
 474 mbufphdrcluster_ctor(void *obj, void *private, int ocflags)
 475 {
 476         struct mbuf *m = obj;
 477         struct mbcluster *cl;
 478
 479         mbufphdr_ctor(obj, private, ocflags);
 480         cl = objcache_get(mclmeta_cache, ocflags);
 481         if (cl == NULL)
 482                 return (FALSE);
 483         m->m_flags |= M_CLCACHE;
 484         linkcluster(m, cl);
 485         return (TRUE);
 486 }
 487
 488 static boolean_t
 489 mbufcluster_ctor(void *obj, void *private, int ocflags)
 490 {
 491         struct mbuf *m = obj;
 492         struct mbcluster *cl;
 493
 494         mbuf_ctor(obj, private, ocflags);
 495         cl = objcache_get(mclmeta_cache, ocflags);
 496         if (cl == NULL)
 497                 return (FALSE);
 498         m->m_flags |= M_CLCACHE;
 499         linkcluster(m, cl);
 500         return (TRUE);
 501 }
 502
 503 /*
 504  * Used for both the cluster and cluster PHDR caches.
 505  *
 506  * The mbuf may have lost its cluster due to sharing, deal
 507  * with the situation by checking M_EXT.
 508  */
 509 static void
 510 mbufcluster_dtor(void *obj, void *private)
 511 {
 512         struct mbuf *m = obj;
 513         struct mbcluster *mcl;
 514
 515         if (m->m_flags & M_EXT) {
 516                 KKASSERT((m->m_flags & M_EXT_CLUSTER) != 0);
 517                 mcl = m->m_ext.ext_arg;
 518                 KKASSERT(mcl->mcl_refs == 1);
 519                 mcl->mcl_refs = 0;
 520                 objcache_put(mclmeta_cache, mcl);
 521         }
 522 }
 523
 524 struct objcache_malloc_args mbuf_malloc_args = { MSIZE, M_MBUF };
 525 struct objcache_malloc_args mclmeta_malloc_args =
 526         { sizeof(struct mbcluster), M_MCLMETA };
 527
 528 /* ARGSUSED*/
 529 static void
 530 mbinit(void *dummy)
 531 {
 532         int i;
 533
 534         for (i = 0; i < ncpus; i++)
 535         {
 536                 atomic_set_long_nonlocked(&mbstat[i].m_msize, MSIZE);
 537                 atomic_set_long_nonlocked(&mbstat[i].m_mclbytes, MCLBYTES);
 538                 atomic_set_long_nonlocked(&mbstat[i].m_minclsize, MINCLSIZE);
 539                 atomic_set_long_nonlocked(&mbstat[i].m_mlen, MLEN);
 540                 atomic_set_long_nonlocked(&mbstat[i].m_mhlen, MHLEN);
 541         }
 542
 543         mbuf_cache = objcache_create("mbuf", nmbufs, 0,
 544             mbuf_ctor, NULL, NULL,
 545             objcache_malloc_alloc, objcache_malloc_free, &mbuf_malloc_args);
 546         mbufphdr_cache = objcache_create("mbuf pkt hdr", nmbufs, 64,
 547             mbufphdr_ctor, NULL, NULL,
 548             objcache_malloc_alloc, objcache_malloc_free, &mbuf_malloc_args);
 549         mclmeta_cache = objcache_create("cluster mbuf", nmbclusters , 0,
 550             mclmeta_ctor, mclmeta_dtor, NULL,
 551             objcache_malloc_alloc, objcache_malloc_free, &mclmeta_malloc_args);
 552         mbufcluster_cache = objcache_create("mbuf + cluster", nmbclusters, 0,
 553             mbufcluster_ctor, mbufcluster_dtor, NULL,
 554             objcache_malloc_alloc, objcache_malloc_free, &mbuf_malloc_args);
 555         mbufphdrcluster_cache = objcache_create("mbuf pkt hdr + cluster",
 556             nmbclusters, 64, mbufphdrcluster_ctor, mbufcluster_dtor, NULL,
 557             objcache_malloc_alloc, objcache_malloc_free, &mbuf_malloc_args);
 558         return;
 559 }
 560
 561 /*
 562  * Return the number of references to this mbuf's data.  0 is returned
 563  * if the mbuf is not M_EXT, a reference count is returned if it is
 564  * M_EXT | M_EXT_CLUSTER, and 99 is returned if it is a special M_EXT.
 565  */
 566 int
 567 m_sharecount(struct mbuf *m)
 568 {
 569         switch (m->m_flags & (M_EXT | M_EXT_CLUSTER)) {
 570         case 0:
 571                 return (0);
 572         case M_EXT:
 573                 return (99);
 574         case M_EXT | M_EXT_CLUSTER:
 575                 return (((struct mbcluster *)m->m_ext.ext_arg)->mcl_refs);
 576         }
 577         /* NOTREACHED */
 578         return (0);             /* to shut up compiler */
 579 }
 580
 581 /*
 582  * change mbuf to new type
 583  */
 584 void
 585 m_chtype(struct mbuf *m, int type)
 586 {
 587         struct globaldata *gd = mycpu;
 588
 589         atomic_add_long_nonlocked(&mbtypes[gd->gd_cpuid][type], 1);
 590         atomic_subtract_long_nonlocked(&mbtypes[gd->gd_cpuid][m->m_type], 1);
 591         atomic_set_short_nonlocked(&m->m_type, type);
 592 }
 593
 594 static void
 595 m_reclaim(void)
 596 {
 597         struct domain *dp;
 598         struct protosw *pr;
 599
 600         crit_enter();
 601         SLIST_FOREACH(dp, &domains, dom_next) {
 602                 for (pr = dp->dom_protosw; pr < dp->dom_protoswNPROTOSW; pr++) {
 603                         if (pr->pr_drain)
 604                                 (*pr->pr_drain)();
 605                 }
 606         }
 607         crit_exit();
 608         atomic_add_long_nonlocked(&mbstat[mycpu->gd_cpuid].m_drain, 1);
 609 }
 610
 611 static void __inline
 612 updatestats(struct mbuf *m, int type)
 613 {
 614         struct globaldata *gd = mycpu;
 615         m->m_type = type;
 616
 617         mbuftrack(m);
 618
 619         atomic_add_long_nonlocked(&mbtypes[gd->gd_cpuid][type], 1);
 620         atomic_add_long_nonlocked(&mbstat[mycpu->gd_cpuid].m_mbufs, 1);
 621
 622 }
 623
 624 /*
 625  * Allocate an mbuf.
 626  */
 627 struct mbuf *
 628 m_get(int how, int type)
 629 {
 630         struct mbuf *m;
 631         int ntries = 0;
 632         int ocf = MBTOM(how);
 633
 634 retryonce:
 635
 636         m = objcache_get(mbuf_cache, ocf);
 637
 638         if (m == NULL) {
 639                 if ((how & MB_TRYWAIT) && ntries++ == 0) {
 640                         struct objcache *reclaimlist[] = {
 641                                 mbufphdr_cache,
 642                                 mbufcluster_cache, mbufphdrcluster_cache
 643                         };
 644                         const int nreclaims = __arysize(reclaimlist);
 645
 646                         if (!objcache_reclaimlist(reclaimlist, nreclaims, ocf))
 647                                 m_reclaim();
 648                         goto retryonce;
 649                 }
 650                 return (NULL);
 651         }
 652
 653         updatestats(m, type);
 654         return (m);
 655 }
 656
 657 struct mbuf *
 658 m_gethdr(int how, int type)
 659 {
 660         struct mbuf *m;
 661         int ocf = MBTOM(how);
 662         int ntries = 0;
 663
 664 retryonce:
 665
 666         m = objcache_get(mbufphdr_cache, ocf);
 667
 668         if (m == NULL) {
 669                 if ((how & MB_TRYWAIT) && ntries++ == 0) {
 670                         struct objcache *reclaimlist[] = {
 671                                 mbuf_cache,
 672                                 mbufcluster_cache, mbufphdrcluster_cache
 673                         };
 674                         const int nreclaims = __arysize(reclaimlist);
 675
 676                         if (!objcache_reclaimlist(reclaimlist, nreclaims, ocf))
 677                                 m_reclaim();
 678                         goto retryonce;
 679                 }
 680                 return (NULL);
 681         }
 682
 683         updatestats(m, type);
 684         return (m);
 685 }
 686
 687 /*
 688  * Get a mbuf (not a mbuf cluster!) and zero it.
 689  * Deprecated.
 690  */
 691 struct mbuf *
 692 m_getclr(int how, int type)
 693 {
 694         struct mbuf *m;
 695
 696         m = m_get(how, type);
 697         if (m != NULL)
 698                 bzero(m->m_data, MLEN);
 699         return (m);
 700 }
 701
 702 /*
 703  * Returns an mbuf with an attached cluster.
 704  * Because many network drivers use this kind of buffers a lot, it is
 705  * convenient to keep a small pool of free buffers of this kind.
 706  * Even a small size such as 10 gives about 10% improvement in the
 707  * forwarding rate in a bridge or router.
 708  */
 709 struct mbuf *
 710 m_getcl(int how, short type, int flags)
 711 {
 712         struct mbuf *m;
 713         int ocflags = MBTOM(how);
 714         int ntries = 0;
 715
 716 retryonce:
 717
 718         if (flags & M_PKTHDR)
 719                 m = objcache_get(mbufphdrcluster_cache, ocflags);
 720         else
 721                 m = objcache_get(mbufcluster_cache, ocflags);
 722
 723         if (m == NULL) {
 724                 if ((how & MB_TRYWAIT) && ntries++ == 0) {
 725                         struct objcache *reclaimlist[1];
 726
 727                         if (flags & M_PKTHDR)
 728                                 reclaimlist[0] = mbufcluster_cache;
 729                         else
 730                                 reclaimlist[0] = mbufphdrcluster_cache;
 731                         if (!objcache_reclaimlist(reclaimlist, 1, ocflags))
 732                                 m_reclaim();
 733                         goto retryonce;
 734                 }
 735                 return (NULL);
 736         }
 737
 738         m->m_type = type;
 739
 740         mbuftrack(m);
 741
 742         atomic_add_long_nonlocked(&mbtypes[mycpu->gd_cpuid][type], 1);
 743         atomic_add_long_nonlocked(&mbstat[mycpu->gd_cpuid].m_clusters, 1);
 744         return (m);
 745 }
 746
 747 /*
 748  * Allocate chain of requested length.
 749  */
 750 struct mbuf *
 751 m_getc(int len, int how, int type)
 752 {
 753         struct mbuf *n, *nfirst = NULL, **ntail = &nfirst;
 754         int nsize;
 755
 756         while (len > 0) {
 757                 n = m_getl(len, how, type, 0, &nsize);
 758                 if (n == NULL)
 759                         goto failed;
 760                 n->m_len = 0;
 761                 *ntail = n;
 762                 ntail = &n->m_next;
 763                 len -= nsize;
 764         }
 765         return (nfirst);
 766
 767 failed:
 768         m_freem(nfirst);
 769         return (NULL);
 770 }
 771
 772 /*
 773  * Allocate len-worth of mbufs and/or mbuf clusters (whatever fits best)
 774  * and return a pointer to the head of the allocated chain. If m0 is
 775  * non-null, then we assume that it is a single mbuf or an mbuf chain to
 776  * which we want len bytes worth of mbufs and/or clusters attached, and so
 777  * if we succeed in allocating it, we will just return a pointer to m0.
 778  *
 779  * If we happen to fail at any point during the allocation, we will free
 780  * up everything we have already allocated and return NULL.
 781  *
 782  * Deprecated.  Use m_getc() and m_cat() instead.
 783  */
 784 struct mbuf *
 785 m_getm(struct mbuf *m0, int len, int type, int how)
 786 {
 787         struct mbuf *nfirst;
 788
 789         nfirst = m_getc(len, how, type);
 790
 791         if (m0 != NULL) {
 792                 m_last(m0)->m_next = nfirst;
 793                 return (m0);
 794         }
 795
 796         return (nfirst);
 797 }
 798
 799 /*
 800  * Adds a cluster to a normal mbuf, M_EXT is set on success.
 801  * Deprecated.  Use m_getcl() instead.
 802  */
 803 void
 804 m_mclget(struct mbuf *m, int how)
 805 {
 806         struct mbcluster *mcl;
 807
 808         KKASSERT((m->m_flags & M_EXT) == 0);
 809         mcl = objcache_get(mclmeta_cache, MBTOM(how));
 810         if (mcl != NULL) {
 811                 linkcluster(m, mcl);
 812                 atomic_add_long_nonlocked(&mbstat[mycpu->gd_cpuid].m_clusters, 1);
 813         }
 814 }
 815
 816 /*
 817  * Updates to mbcluster must be MPSAFE.  Only an entity which already has
 818  * a reference to the cluster can ref it, so we are in no danger of
 819  * racing an add with a subtract.  But the operation must still be atomic
 820  * since multiple entities may have a reference on the cluster.
 821  *
 822  * m_mclfree() is almost the same but it must contend with two entities
 823  * freeing the cluster at the same time.  If there is only one reference
 824  * count we are the only entity referencing the cluster and no further
 825  * locking is required.  Otherwise we must protect against a race to 0
 826  * with the serializer.
 827  */
 828 static void
 829 m_mclref(void *arg)
 830 {
 831         struct mbcluster *mcl = arg;
 832
 833         atomic_add_int(&mcl->mcl_refs, 1);
 834 }
 835
 836 static void
 837 m_mclfree(void *arg)
 838 {
 839         struct mbcluster *mcl = arg;
 840
 841         if (mcl->mcl_refs == 1) {
 842                 mcl->mcl_refs = 0;
 843                 objcache_put(mclmeta_cache, mcl);
 844         } else {
 845                 lwkt_serialize_enter(&mcl->mcl_serializer);
 846                 if (mcl->mcl_refs > 1) {
 847                         atomic_subtract_int(&mcl->mcl_refs, 1);
 848                         lwkt_serialize_exit(&mcl->mcl_serializer);
 849                 } else {
 850                         lwkt_serialize_exit(&mcl->mcl_serializer);
 851                         KKASSERT(mcl->mcl_refs == 1);
 852                         mcl->mcl_refs = 0;
 853                         objcache_put(mclmeta_cache, mcl);
 854                 }
 855         }
 856 }
 857
 858 extern void db_print_backtrace(void);
 859
 860 /*
 861  * Free a single mbuf and any associated external storage.  The successor,
 862  * if any, is returned.
 863  *
 864  * We do need to check non-first mbuf for m_aux, since some of existing
 865  * code does not call M_PREPEND properly.
 866  * (example: call to bpf_mtap from drivers)
 867  */
 868 struct mbuf *
 869 m_free(struct mbuf *m)
 870 {
 871         struct mbuf *n;
 872         struct globaldata *gd = mycpu;
 873
 874         KASSERT(m->m_type != MT_FREE, ("freeing free mbuf %p", m));
 875         atomic_subtract_long_nonlocked(&mbtypes[gd->gd_cpuid][m->m_type], 1);
 876
 877         n = m->m_next;
 878
 879         /*
 880          * Make sure the mbuf is in constructed state before returning it
 881          * to the objcache.
 882          */
 883         m->m_next = NULL;
 884         mbufuntrack(m);
 885 #ifdef notyet
 886         KKASSERT(m->m_nextpkt == NULL);
 887 #else
 888         if (m->m_nextpkt != NULL) {
 889 #ifdef DDB
 890                 static int afewtimes = 10;
 891
 892                 if (afewtimes-- > 0) {
 893                         kprintf("mfree: m->m_nextpkt != NULL\n");
 894                         db_print_backtrace();
 895                 }
 896 #endif
 897                 m->m_nextpkt = NULL;
 898         }
 899 #endif
 900         if (m->m_flags & M_PKTHDR) {
 901                 m_tag_delete_chain(m);          /* eliminate XXX JH */
 902         }
 903
 904         m->m_flags &= (M_EXT | M_EXT_CLUSTER | M_CLCACHE | M_PHCACHE);
 905
 906         /*
 907          * Clean the M_PKTHDR state so we can return the mbuf to its original
 908          * cache.  This is based on the PHCACHE flag which tells us whether
 909          * the mbuf was originally allocated out of a packet-header cache
 910          * or a non-packet-header cache.
 911          */
 912         if (m->m_flags & M_PHCACHE) {
 913                 m->m_flags |= M_PKTHDR;
 914                 m->m_pkthdr.rcvif = NULL;       /* eliminate XXX JH */
 915                 m->m_pkthdr.csum_flags = 0;     /* eliminate XXX JH */
 916                 m->m_pkthdr.fw_flags = 0;       /* eliminate XXX JH */
 917                 SLIST_INIT(&m->m_pkthdr.tags);
 918         }
 919
 920         /*
 921          * Handle remaining flags combinations.  M_CLCACHE tells us whether
 922          * the mbuf was originally allocated from a cluster cache or not,
 923          * and is totally separate from whether the mbuf is currently
 924          * associated with a cluster.
 925          */
 926         crit_enter();
 927         switch(m->m_flags & (M_CLCACHE | M_EXT | M_EXT_CLUSTER)) {
 928         case M_CLCACHE | M_EXT | M_EXT_CLUSTER:
 929                 /*
 930                  * mbuf+cluster cache case.  The mbuf was allocated from the
 931                  * combined mbuf_cluster cache and can be returned to the
 932                  * cache if the cluster hasn't been shared.
 933                  */
 934                 if (m_sharecount(m) == 1) {
 935                         /*
 936                          * The cluster has not been shared, we can just
 937                          * reset the data pointer and return the mbuf
 938                          * to the cluster cache.  Note that the reference
 939                          * count is left intact (it is still associated with
 940                          * an mbuf).
 941                          */
 942                         m->m_data = m->m_ext.ext_buf;
 943                         if (m->m_flags & M_PHCACHE)
 944                                 objcache_put(mbufphdrcluster_cache, m);
 945                         else
 946                                 objcache_put(mbufcluster_cache, m);
 947                         atomic_subtract_long_nonlocked(&mbstat[mycpu->gd_cpuid].m_clusters, 1);
 948                 } else {
 949                         /*
 950                          * Hell.  Someone else has a ref on this cluster,
 951                          * we have to disconnect it which means we can't
 952                          * put it back into the mbufcluster_cache, we
 953                          * have to destroy the mbuf.
 954                          *
 955                          * Other mbuf references to the cluster will typically
 956                          * be M_EXT | M_EXT_CLUSTER but without M_CLCACHE.
 957                          *
 958                          * XXX we could try to connect another cluster to
 959                          * it.
 960                          */
 961                         m->m_ext.ext_free(m->m_ext.ext_arg);
 962                         m->m_flags &= ~(M_EXT | M_EXT_CLUSTER);
 963                         if (m->m_flags & M_PHCACHE)
 964                                 objcache_dtor(mbufphdrcluster_cache, m);
 965                         else
 966                                 objcache_dtor(mbufcluster_cache, m);
 967                 }
 968                 break;
 969         case M_EXT | M_EXT_CLUSTER:
 970                 /*
 971                  * Normal cluster associated with an mbuf that was allocated
 972                  * from the normal mbuf pool rather then the cluster pool.
 973                  * The cluster has to be independantly disassociated from the
 974                  * mbuf.
 975                  */
 976                 if (m_sharecount(m) == 1)
 977                         atomic_subtract_long_nonlocked(&mbstat[mycpu->gd_cpuid].m_clusters, 1);
 978                 /* fall through */
 979         case M_EXT:
 980                 /*
 981                  * Normal cluster association case, disconnect the cluster from
 982                  * the mbuf.  The cluster may or may not be custom.
 983                  */
 984                 m->m_ext.ext_free(m->m_ext.ext_arg);
 985                 m->m_flags &= ~(M_EXT | M_EXT_CLUSTER);
 986                 /* fall through */
 987         case 0:
 988                 /*
 989                  * return the mbuf to the mbuf cache.
 990                  */
 991                 if (m->m_flags & M_PHCACHE) {
 992                         m->m_data = m->m_pktdat;
 993                         objcache_put(mbufphdr_cache, m);
 994                 } else {
 995                         m->m_data = m->m_dat;
 996                         objcache_put(mbuf_cache, m);
 997                 }
 998                 atomic_subtract_long_nonlocked(&mbstat[mycpu->gd_cpuid].m_mbufs, 1);
 999                 break;
1000         default:
1001                 if (!panicstr)
1002                         panic("bad mbuf flags %p %08x\n", m, m->m_flags);
1003                 break;
1004         }
1005         crit_exit();
1006         return (n);
1007 }
1008
1009 void
1010 m_freem(struct mbuf *m)
1011 {
1012         crit_enter();
1013         while (m)
1014                 m = m_free(m);
1015         crit_exit();
1016 }
1017
1018 /*
1019  * mbuf utility routines
1020  */
1021
1022 /*
1023  * Lesser-used path for M_PREPEND: allocate new mbuf to prepend to chain and
1024  * copy junk along.
1025  */
1026 struct mbuf *
1027 m_prepend(struct mbuf *m, int len, int how)
1028 {
1029         struct mbuf *mn;
1030
1031         if (m->m_flags & M_PKTHDR)
1032             mn = m_gethdr(how, m->m_type);
1033         else
1034             mn = m_get(how, m->m_type);
1035         if (mn == NULL) {
1036                 m_freem(m);
1037                 return (NULL);
1038         }
1039         if (m->m_flags & M_PKTHDR)
1040                 M_MOVE_PKTHDR(mn, m);
1041         mn->m_next = m;
1042         m = mn;
1043         if (len < MHLEN)
1044                 MH_ALIGN(m, len);
1045         m->m_len = len;
1046         return (m);
1047 }
1048
1049 /*
1050  * Make a copy of an mbuf chain starting "off0" bytes from the beginning,
1051  * continuing for "len" bytes.  If len is M_COPYALL, copy to end of mbuf.
1052  * The wait parameter is a choice of MB_WAIT/MB_DONTWAIT from caller.
1053  * Note that the copy is read-only, because clusters are not copied,
1054  * only their reference counts are incremented.
1055  */
1056 struct mbuf *
1057 m_copym(const struct mbuf *m, int off0, int len, int wait)
1058 {
1059         struct mbuf *n, **np;
1060         int off = off0;
1061         struct mbuf *top;
1062         int copyhdr = 0;
1063
1064         KASSERT(off >= 0, ("m_copym, negative off %d", off));
1065         KASSERT(len >= 0, ("m_copym, negative len %d", len));
1066         if (off == 0 && m->m_flags & M_PKTHDR)
1067                 copyhdr = 1;
1068         while (off > 0) {
1069                 KASSERT(m != NULL, ("m_copym, offset > size of mbuf chain"));
1070                 if (off < m->m_len)
1071                         break;
1072                 off -= m->m_len;
1073                 m = m->m_next;
1074         }
1075         np = &top;
1076         top = 0;
1077         while (len > 0) {
1078                 if (m == NULL) {
1079                         KASSERT(len == M_COPYALL,
1080                             ("m_copym, length > size of mbuf chain"));
1081                         break;
1082                 }
1083                 /*
1084                  * Because we are sharing any cluster attachment below,
1085                  * be sure to get an mbuf that does not have a cluster
1086                  * associated with it.
1087                  */
1088                 if (copyhdr)
1089                         n = m_gethdr(wait, m->m_type);
1090                 else
1091                         n = m_get(wait, m->m_type);
1092                 *np = n;
1093                 if (n == NULL)
1094                         goto nospace;
1095                 if (copyhdr) {
1096                         if (!m_dup_pkthdr(n, m, wait))
1097                                 goto nospace;
1098                         if (len == M_COPYALL)
1099                                 n->m_pkthdr.len -= off0;
1100                         else
1101                                 n->m_pkthdr.len = len;
1102                         copyhdr = 0;
1103                 }
1104                 n->m_len = min(len, m->m_len - off);
1105                 if (m->m_flags & M_EXT) {
1106                         KKASSERT((n->m_flags & M_EXT) == 0);
1107                         n->m_data = m->m_data + off;
1108                         m->m_ext.ext_ref(m->m_ext.ext_arg);
1109                         n->m_ext = m->m_ext;
1110                         n->m_flags |= m->m_flags & (M_EXT | M_EXT_CLUSTER);
1111                 } else {
1112                         bcopy(mtod(m, caddr_t)+off, mtod(n, caddr_t),
1113                             (unsigned)n->m_len);
1114                 }
1115                 if (len != M_COPYALL)
1116                         len -= n->m_len;
1117                 off = 0;
1118                 m = m->m_next;
1119                 np = &n->m_next;
1120         }
1121         if (top == NULL)
1122                 atomic_add_long_nonlocked(&mbstat[mycpu->gd_cpuid].m_mcfail, 1);
1123         return (top);
1124 nospace:
1125         m_freem(top);
1126         atomic_add_long_nonlocked(&mbstat[mycpu->gd_cpuid].m_mcfail, 1);
1127         return (NULL);
1128 }
1129
1130 /*
1131  * Copy an entire packet, including header (which must be present).
1132  * An optimization of the common case `m_copym(m, 0, M_COPYALL, how)'.
1133  * Note that the copy is read-only, because clusters are not copied,
1134  * only their reference counts are incremented.
1135  * Preserve alignment of the first mbuf so if the creator has left
1136  * some room at the beginning (e.g. for inserting protocol headers)
1137  * the copies also have the room available.
1138  */
1139 struct mbuf *
1140 m_copypacket(struct mbuf *m, int how)
1141 {
1142         struct mbuf *top, *n, *o;
1143
1144         n = m_gethdr(how, m->m_type);
1145         top = n;
1146         if (!n)
1147                 goto nospace;
1148
1149         if (!m_dup_pkthdr(n, m, how))
1150                 goto nospace;
1151         n->m_len = m->m_len;
1152         if (m->m_flags & M_EXT) {
1153                 KKASSERT((n->m_flags & M_EXT) == 0);
1154                 n->m_data = m->m_data;
1155                 m->m_ext.ext_ref(m->m_ext.ext_arg);
1156                 n->m_ext = m->m_ext;
1157                 n->m_flags |= m->m_flags & (M_EXT | M_EXT_CLUSTER);
1158         } else {
1159                 n->m_data = n->m_pktdat + (m->m_data - m->m_pktdat );
1160                 bcopy(mtod(m, char *), mtod(n, char *), n->m_len);
1161         }
1162
1163         m = m->m_next;
1164         while (m) {
1165                 o = m_get(how, m->m_type);
1166                 if (!o)
1167                         goto nospace;
1168
1169                 n->m_next = o;
1170                 n = n->m_next;
1171
1172                 n->m_len = m->m_len;
1173                 if (m->m_flags & M_EXT) {
1174                         KKASSERT((n->m_flags & M_EXT) == 0);
1175                         n->m_data = m->m_data;
1176                         m->m_ext.ext_ref(m->m_ext.ext_arg);
1177                         n->m_ext = m->m_ext;
1178                         n->m_flags |= m->m_flags & (M_EXT | M_EXT_CLUSTER);
1179                 } else {
1180                         bcopy(mtod(m, char *), mtod(n, char *), n->m_len);
1181                 }
1182
1183                 m = m->m_next;
1184         }
1185         return top;
1186 nospace:
1187         m_freem(top);
1188         atomic_add_long_nonlocked(&mbstat[mycpu->gd_cpuid].m_mcfail, 1);
1189         return (NULL);
1190 }
1191
1192 /*
1193  * Copy data from an mbuf chain starting "off" bytes from the beginning,
1194  * continuing for "len" bytes, into the indicated buffer.
1195  */
1196 void
1197 m_copydata(const struct mbuf *m, int off, int len, caddr_t cp)
1198 {
1199         unsigned count;
1200
1201         KASSERT(off >= 0, ("m_copydata, negative off %d", off));
1202         KASSERT(len >= 0, ("m_copydata, negative len %d", len));
1203         while (off > 0) {
1204                 KASSERT(m != NULL, ("m_copydata, offset > size of mbuf chain"));
1205                 if (off < m->m_len)
1206                         break;
1207                 off -= m->m_len;
1208                 m = m->m_next;
1209         }
1210         while (len > 0) {
1211                 KASSERT(m != NULL, ("m_copydata, length > size of mbuf chain"));
1212                 count = min(m->m_len - off, len);
1213                 bcopy(mtod(m, caddr_t) + off, cp, count);
1214                 len -= count;
1215                 cp += count;
1216                 off = 0;
1217                 m = m->m_next;
1218         }
1219 }
1220
1221 /*
1222  * Copy a packet header mbuf chain into a completely new chain, including
1223  * copying any mbuf clusters.  Use this instead of m_copypacket() when
1224  * you need a writable copy of an mbuf chain.
1225  */
1226 struct mbuf *
1227 m_dup(struct mbuf *m, int how)
1228 {
1229         struct mbuf **p, *top = NULL;
1230         int remain, moff, nsize;
1231
1232         /* Sanity check */
1233         if (m == NULL)
1234                 return (NULL);
1235         KASSERT((m->m_flags & M_PKTHDR) != 0, ("%s: !PKTHDR", __func__));
1236
1237         /* While there's more data, get a new mbuf, tack it on, and fill it */
1238         remain = m->m_pkthdr.len;
1239         moff = 0;
1240         p = &top;
1241         while (remain > 0 || top == NULL) {     /* allow m->m_pkthdr.len == 0 */
1242                 struct mbuf *n;
1243
1244                 /* Get the next new mbuf */
1245                 n = m_getl(remain, how, m->m_type, top == NULL ? M_PKTHDR : 0,
1246                            &nsize);
1247                 if (n == NULL)
1248                         goto nospace;
1249                 if (top == NULL)
1250                         if (!m_dup_pkthdr(n, m, how))
1251                                 goto nospace0;
1252
1253                 /* Link it into the new chain */
1254                 *p = n;
1255                 p = &n->m_next;
1256
1257                 /* Copy data from original mbuf(s) into new mbuf */
1258                 n->m_len = 0;
1259                 while (n->m_len < nsize && m != NULL) {
1260                         int chunk = min(nsize - n->m_len, m->m_len - moff);
1261
1262                         bcopy(m->m_data + moff, n->m_data + n->m_len, chunk);
1263                         moff += chunk;
1264                         n->m_len += chunk;
1265                         remain -= chunk;
1266                         if (moff == m->m_len) {
1267                                 m = m->m_next;
1268                                 moff = 0;
1269                         }
1270                 }
1271
1272                 /* Check correct total mbuf length */
1273                 KASSERT((remain > 0 && m != NULL) || (remain == 0 && m == NULL),
1274                         ("%s: bogus m_pkthdr.len", __func__));
1275         }
1276         return (top);
1277
1278 nospace:
1279         m_freem(top);
1280 nospace0:
1281         atomic_add_long_nonlocked(&mbstat[mycpu->gd_cpuid].m_mcfail, 1);
1282         return (NULL);
1283 }
1284
1285 /*
1286  * Concatenate mbuf chain n to m.
1287  * Both chains must be of the same type (e.g. MT_DATA).
1288  * Any m_pkthdr is not updated.
1289  */
1290 void
1291 m_cat(struct mbuf *m, struct mbuf *n)
1292 {
1293         m = m_last(m);
1294         while (n) {
1295                 if (m->m_flags & M_EXT ||
1296                     m->m_data + m->m_len + n->m_len >= &m->m_dat[MLEN]) {
1297                         /* just join the two chains */
1298                         m->m_next = n;
1299                         return;
1300                 }
1301                 /* splat the data from one into the other */
1302                 bcopy(mtod(n, caddr_t), mtod(m, caddr_t) + m->m_len,
1303                     (u_int)n->m_len);
1304                 m->m_len += n->m_len;
1305                 n = m_free(n);
1306         }
1307 }
1308
1309 void
1310 m_adj(struct mbuf *mp, int req_len)
1311 {
1312         int len = req_len;
1313         struct mbuf *m;
1314         int count;
1315
1316         if ((m = mp) == NULL)
1317                 return;
1318         if (len >= 0) {
1319                 /*
1320                  * Trim from head.
1321                  */
1322                 while (m != NULL && len > 0) {
1323                         if (m->m_len <= len) {
1324                                 len -= m->m_len;
1325                                 m->m_len = 0;
1326                                 m = m->m_next;
1327                         } else {
1328                                 m->m_len -= len;
1329                                 m->m_data += len;
1330                                 len = 0;
1331                         }
1332                 }
1333                 m = mp;
1334                 if (mp->m_flags & M_PKTHDR)
1335                         m->m_pkthdr.len -= (req_len - len);
1336         } else {
1337                 /*
1338                  * Trim from tail.  Scan the mbuf chain,
1339                  * calculating its length and finding the last mbuf.
1340                  * If the adjustment only affects this mbuf, then just
1341                  * adjust and return.  Otherwise, rescan and truncate
1342                  * after the remaining size.
1343                  */
1344                 len = -len;
1345                 count = 0;
1346                 for (;;) {
1347                         count += m->m_len;
1348                         if (m->m_next == (struct mbuf *)0)
1349                                 break;
1350                         m = m->m_next;
1351                 }
1352                 if (m->m_len >= len) {
1353                         m->m_len -= len;
1354                         if (mp->m_flags & M_PKTHDR)
1355                                 mp->m_pkthdr.len -= len;
1356                         return;
1357                 }
1358                 count -= len;
1359                 if (count < 0)
1360                         count = 0;
1361                 /*
1362                  * Correct length for chain is "count".
1363                  * Find the mbuf with last data, adjust its length,
1364                  * and toss data from remaining mbufs on chain.
1365                  */
1366                 m = mp;
1367                 if (m->m_flags & M_PKTHDR)
1368                         m->m_pkthdr.len = count;
1369                 for (; m; m = m->m_next) {
1370                         if (m->m_len >= count) {
1371                                 m->m_len = count;
1372                                 break;
1373                         }
1374                         count -= m->m_len;
1375                 }
1376                 while (m->m_next)
1377                         (m = m->m_next) ->m_len = 0;
1378         }
1379 }
1380
1381 /*
1382  * Rearrange an mbuf chain so that len bytes are contiguous
1383  * and in the data area of an mbuf (so that mtod will work for a structure
1384  * of size len).  Returns the resulting mbuf chain on success, frees it and
1385  * returns null on failure.  If there is room, it will add up to
1386  * max_protohdr-len extra bytes to the contiguous region in an attempt to
1387  * avoid being called next time.
1388  */
1389 struct mbuf *
1390 m_pullup(struct mbuf *n, int len)
1391 {
1392         struct mbuf *m;
1393         int count;
1394         int space;
1395
1396         /*
1397          * If first mbuf has no cluster, and has room for len bytes
1398          * without shifting current data, pullup into it,
1399          * otherwise allocate a new mbuf to prepend to the chain.
1400          */
1401         if (!(n->m_flags & M_EXT) &&
1402             n->m_data + len < &n->m_dat[MLEN] &&
1403             n->m_next) {
1404                 if (n->m_len >= len)
1405                         return (n);
1406                 m = n;
1407                 n = n->m_next;
1408                 len -= m->m_len;
1409         } else {
1410                 if (len > MHLEN)
1411                         goto bad;
1412                 if (n->m_flags & M_PKTHDR)
1413                         m = m_gethdr(MB_DONTWAIT, n->m_type);
1414                 else
1415                         m = m_get(MB_DONTWAIT, n->m_type);
1416                 if (m == NULL)
1417                         goto bad;
1418                 m->m_len = 0;
1419                 if (n->m_flags & M_PKTHDR)
1420                         M_MOVE_PKTHDR(m, n);
1421         }
1422         space = &m->m_dat[MLEN] - (m->m_data + m->m_len);
1423         do {
1424                 count = min(min(max(len, max_protohdr), space), n->m_len);
1425                 bcopy(mtod(n, caddr_t), mtod(m, caddr_t) + m->m_len,
1426                   (unsigned)count);
1427                 len -= count;
1428                 m->m_len += count;
1429                 n->m_len -= count;
1430                 space -= count;
1431                 if (n->m_len)
1432                         n->m_data += count;
1433                 else
1434                         n = m_free(n);
1435         } while (len > 0 && n);
1436         if (len > 0) {
1437                 m_free(m);
1438                 goto bad;
1439         }
1440         m->m_next = n;
1441         return (m);
1442 bad:
1443         m_freem(n);
1444         atomic_add_long_nonlocked(&mbstat[mycpu->gd_cpuid].m_mcfail, 1);
1445         return (NULL);
1446 }
1447
1448 /*
1449  * Partition an mbuf chain in two pieces, returning the tail --
1450  * all but the first len0 bytes.  In case of failure, it returns NULL and
1451  * attempts to restore the chain to its original state.
1452  *
1453  * Note that the resulting mbufs might be read-only, because the new
1454  * mbuf can end up sharing an mbuf cluster with the original mbuf if
1455  * the "breaking point" happens to lie within a cluster mbuf. Use the
1456  * M_WRITABLE() macro to check for this case.
1457  */
1458 struct mbuf *
1459 m_split(struct mbuf *m0, int len0, int wait)
1460 {
1461         struct mbuf *m, *n;
1462         unsigned len = len0, remain;
1463
1464         for (m = m0; m && len > m->m_len; m = m->m_next)
1465                 len -= m->m_len;
1466         if (m == NULL)
1467                 return (NULL);
1468         remain = m->m_len - len;
1469         if (m0->m_flags & M_PKTHDR) {
1470                 n = m_gethdr(wait, m0->m_type);
1471                 if (n == NULL)
1472                         return (NULL);
1473                 n->m_pkthdr.rcvif = m0->m_pkthdr.rcvif;
1474                 n->m_pkthdr.len = m0->m_pkthdr.len - len0;
1475                 m0->m_pkthdr.len = len0;
1476                 if (m->m_flags & M_EXT)
1477                         goto extpacket;
1478                 if (remain > MHLEN) {
1479                         /* m can't be the lead packet */
1480                         MH_ALIGN(n, 0);
1481                         n->m_next = m_split(m, len, wait);
1482                         if (n->m_next == NULL) {
1483                                 m_free(n);
1484                                 return (NULL);
1485                         } else {
1486                                 n->m_len = 0;
1487                                 return (n);
1488                         }
1489                 } else
1490                         MH_ALIGN(n, remain);
1491         } else if (remain == 0) {
1492                 n = m->m_next;
1493                 m->m_next = 0;
1494                 return (n);
1495         } else {
1496                 n = m_get(wait, m->m_type);
1497                 if (n == NULL)
1498                         return (NULL);
1499                 M_ALIGN(n, remain);
1500         }
1501 extpacket:
1502         if (m->m_flags & M_EXT) {
1503                 KKASSERT((n->m_flags & M_EXT) == 0);
1504                 n->m_data = m->m_data + len;
1505                 m->m_ext.ext_ref(m->m_ext.ext_arg);
1506                 n->m_ext = m->m_ext;
1507                 n->m_flags |= m->m_flags & (M_EXT | M_EXT_CLUSTER);
1508         } else {
1509                 bcopy(mtod(m, caddr_t) + len, mtod(n, caddr_t), remain);
1510         }
1511         n->m_len = remain;
1512         m->m_len = len;
1513         n->m_next = m->m_next;
1514         m->m_next = 0;
1515         return (n);
1516 }
1517
1518 /*
1519  * Routine to copy from device local memory into mbufs.
1520  * Note: "offset" is ill-defined and always called as 0, so ignore it.
1521  */
1522 struct mbuf *
1523 m_devget(char *buf, int len, int offset, struct ifnet *ifp,
1524     void (*copy)(volatile const void *from, volatile void *to, size_t length))
1525 {
1526         struct mbuf *m, *mfirst = NULL, **mtail;
1527         int nsize, flags;
1528
1529         if (copy == NULL)
1530                 copy = bcopy;
1531         mtail = &mfirst;
1532         flags = M_PKTHDR;
1533
1534         while (len > 0) {
1535                 m = m_getl(len, MB_DONTWAIT, MT_DATA, flags, &nsize);
1536                 if (m == NULL) {
1537                         m_freem(mfirst);
1538                         return (NULL);
1539                 }
1540                 m->m_len = min(len, nsize);
1541
1542                 if (flags & M_PKTHDR) {
1543                         if (len + max_linkhdr <= nsize)
1544                                 m->m_data += max_linkhdr;
1545                         m->m_pkthdr.rcvif = ifp;
1546                         m->m_pkthdr.len = len;
1547                         flags = 0;
1548                 }
1549
1550                 copy(buf, m->m_data, (unsigned)m->m_len);
1551                 buf += m->m_len;
1552                 len -= m->m_len;
1553                 *mtail = m;
1554                 mtail = &m->m_next;
1555         }
1556
1557         return (mfirst);
1558 }
1559
1560 /*
1561  * Copy data from a buffer back into the indicated mbuf chain,
1562  * starting "off" bytes from the beginning, extending the mbuf
1563  * chain if necessary.
1564  */
1565 void
1566 m_copyback(struct mbuf *m0, int off, int len, caddr_t cp)
1567 {
1568         int mlen;
1569         struct mbuf *m = m0, *n;
1570         int totlen = 0;
1571
1572         if (m0 == NULL)
1573                 return;
1574         while (off > (mlen = m->m_len)) {
1575                 off -= mlen;
1576                 totlen += mlen;
1577                 if (m->m_next == NULL) {
1578                         n = m_getclr(MB_DONTWAIT, m->m_type);
1579                         if (n == NULL)
1580                                 goto out;
1581                         n->m_len = min(MLEN, len + off);
1582                         m->m_next = n;
1583                 }
1584                 m = m->m_next;
1585         }
1586         while (len > 0) {
1587                 mlen = min (m->m_len - off, len);
1588                 bcopy(cp, off + mtod(m, caddr_t), (unsigned)mlen);
1589                 cp += mlen;
1590                 len -= mlen;
1591                 mlen += off;
1592                 off = 0;
1593                 totlen += mlen;
1594                 if (len == 0)
1595                         break;
1596                 if (m->m_next == NULL) {
1597                         n = m_get(MB_DONTWAIT, m->m_type);
1598                         if (n == NULL)
1599                                 break;
1600                         n->m_len = min(MLEN, len);
1601                         m->m_next = n;
1602                 }
1603                 m = m->m_next;
1604         }
1605 out:    if (((m = m0)->m_flags & M_PKTHDR) && (m->m_pkthdr.len < totlen))
1606                 m->m_pkthdr.len = totlen;
1607 }
1608
1609 void
1610 m_print(const struct mbuf *m)
1611 {
1612         int len;
1613         const struct mbuf *m2;
1614
1615         len = m->m_pkthdr.len;
1616         m2 = m;
1617         while (len) {
1618                 kprintf("%p %*D\n", m2, m2->m_len, (u_char *)m2->m_data, "-");
1619                 len -= m2->m_len;
1620                 m2 = m2->m_next;
1621         }
1622         return;
1623 }
1624
1625 /*
1626  * "Move" mbuf pkthdr from "from" to "to".
1627  * "from" must have M_PKTHDR set, and "to" must be empty.
1628  */
1629 void
1630 m_move_pkthdr(struct mbuf *to, struct mbuf *from)
1631 {
1632         KASSERT((to->m_flags & M_PKTHDR), ("m_move_pkthdr: not packet header"));
1633
1634         to->m_flags |= from->m_flags & M_COPYFLAGS;
1635         to->m_pkthdr = from->m_pkthdr;          /* especially tags */
1636         SLIST_INIT(&from->m_pkthdr.tags);       /* purge tags from src */
1637 }
1638
1639 /*
1640  * Duplicate "from"'s mbuf pkthdr in "to".
1641  * "from" must have M_PKTHDR set, and "to" must be empty.
1642  * In particular, this does a deep copy of the packet tags.
1643  */
1644 int
1645 m_dup_pkthdr(struct mbuf *to, const struct mbuf *from, int how)
1646 {
1647         KASSERT((to->m_flags & M_PKTHDR), ("m_dup_pkthdr: not packet header"));
1648
1649         to->m_flags = (from->m_flags & M_COPYFLAGS) |
1650                       (to->m_flags & ~M_COPYFLAGS);
1651         to->m_pkthdr = from->m_pkthdr;
1652         SLIST_INIT(&to->m_pkthdr.tags);
1653         return (m_tag_copy_chain(to, from, how));
1654 }
1655
1656 /*
1657  * Defragment a mbuf chain, returning the shortest possible
1658  * chain of mbufs and clusters.  If allocation fails and
1659  * this cannot be completed, NULL will be returned, but
1660  * the passed in chain will be unchanged.  Upon success,
1661  * the original chain will be freed, and the new chain
1662  * will be returned.
1663  *
1664  * If a non-packet header is passed in, the original
1665  * mbuf (chain?) will be returned unharmed.
1666  *
1667  * m_defrag_nofree doesn't free the passed in mbuf.
1668  */
1669 struct mbuf *
1670 m_defrag(struct mbuf *m0, int how)
1671 {
1672         struct mbuf *m_new;
1673
1674         if ((m_new = m_defrag_nofree(m0, how)) == NULL)
1675                 return (NULL);
1676         if (m_new != m0)
1677                 m_freem(m0);
1678         return (m_new);
1679 }
1680
1681 struct mbuf *
1682 m_defrag_nofree(struct mbuf *m0, int how)
1683 {
1684         struct mbuf     *m_new = NULL, *m_final = NULL;
1685         int             progress = 0, length, nsize;
1686
1687         if (!(m0->m_flags & M_PKTHDR))
1688                 return (m0);
1689
1690 #ifdef MBUF_STRESS_TEST
1691         if (m_defragrandomfailures) {
1692                 int temp = karc4random() & 0xff;
1693                 if (temp == 0xba)
1694                         goto nospace;
1695         }
1696 #endif
1697
1698         m_final = m_getl(m0->m_pkthdr.len, how, MT_DATA, M_PKTHDR, &nsize);
1699         if (m_final == NULL)
1700                 goto nospace;
1701         m_final->m_len = 0;     /* in case m0->m_pkthdr.len is zero */
1702
1703         if (m_dup_pkthdr(m_final, m0, how) == NULL)
1704                 goto nospace;
1705
1706         m_new = m_final;
1707
1708         while (progress < m0->m_pkthdr.len) {
1709                 length = m0->m_pkthdr.len - progress;
1710                 if (length > MCLBYTES)
1711                         length = MCLBYTES;
1712
1713                 if (m_new == NULL) {
1714                         m_new = m_getl(length, how, MT_DATA, 0, &nsize);
1715                         if (m_new == NULL)
1716                                 goto nospace;
1717                 }
1718
1719                 m_copydata(m0, progress, length, mtod(m_new, caddr_t));
1720                 progress += length;
1721                 m_new->m_len = length;
1722                 if (m_new != m_final)
1723                         m_cat(m_final, m_new);
1724                 m_new = NULL;
1725         }
1726         if (m0->m_next == NULL)
1727                 m_defraguseless++;
1728         m_defragpackets++;
1729         m_defragbytes += m_final->m_pkthdr.len;
1730         return (m_final);
1731 nospace:
1732         m_defragfailure++;
1733         if (m_new)
1734                 m_free(m_new);
1735         m_freem(m_final);
1736         return (NULL);
1737 }
1738
1739 /*
1740  * Move data from uio into mbufs.
1741  */
1742 struct mbuf *
1743 m_uiomove(struct uio *uio)
1744 {
1745         struct mbuf *m;                 /* current working mbuf */
1746         struct mbuf *head = NULL;       /* result mbuf chain */
1747         struct mbuf **mp = &head;
1748         int resid = uio->uio_resid, nsize, flags = M_PKTHDR, error;
1749
1750         do {
1751                 m = m_getl(resid, MB_WAIT, MT_DATA, flags, &nsize);
1752                 if (flags) {
1753                         m->m_pkthdr.len = 0;
1754                         /* Leave room for protocol headers. */
1755                         if (resid < MHLEN)
1756                                 MH_ALIGN(m, resid);
1757                         flags = 0;
1758                 }
1759                 m->m_len = min(nsize, resid);
1760                 error = uiomove(mtod(m, caddr_t), m->m_len, uio);
1761                 if (error) {
1762                         m_free(m);
1763                         goto failed;
1764                 }
1765                 *mp = m;
1766                 mp = &m->m_next;
1767                 head->m_pkthdr.len += m->m_len;
1768                 resid -= m->m_len;
1769         } while (resid > 0);
1770
1771         return (head);
1772
1773 failed:
1774         m_freem(head);
1775         return (NULL);
1776 }
1777
1778 struct mbuf *
1779 m_last(struct mbuf *m)
1780 {
1781         while (m->m_next)
1782                 m = m->m_next;
1783         return (m);
1784 }
1785
1786 /*
1787  * Return the number of bytes in an mbuf chain.
1788  * If lastm is not NULL, also return the last mbuf.
1789  */
1790 u_int
1791 m_lengthm(struct mbuf *m, struct mbuf **lastm)
1792 {
1793         u_int len = 0;
1794         struct mbuf *prev = m;
1795
1796         while (m) {
1797                 len += m->m_len;
1798                 prev = m;
1799                 m = m->m_next;
1800         }
1801         if (lastm != NULL)
1802                 *lastm = prev;
1803         return (len);
1804 }
1805
1806 /*
1807  * Like m_lengthm(), except also keep track of mbuf usage.
1808  */
1809 u_int
1810 m_countm(struct mbuf *m, struct mbuf **lastm, u_int *pmbcnt)
1811 {
1812         u_int len = 0, mbcnt = 0;
1813         struct mbuf *prev = m;
1814
1815         while (m) {
1816                 len += m->m_len;
1817                 mbcnt += MSIZE;
1818                 if (m->m_flags & M_EXT)
1819                         mbcnt += m->m_ext.ext_size;
1820                 prev = m;
1821                 m = m->m_next;
1822         }
1823         if (lastm != NULL)
1824                 *lastm = prev;
1825         *pmbcnt = mbcnt;
1826         return (len);
1827 }