sys/kern/kern_mbuf.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2004, 2005,
   5  *      Bosko Milekic <bmilekic@FreeBSD.org>.  All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice unmodified, this list of conditions and the following
  12  *    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 "opt_param.h"
  34 #include "opt_kern_tls.h"
  35
  36 #include <sys/param.h>
  37 #include <sys/conf.h>
  38 #include <sys/domainset.h>
  39 #include <sys/malloc.h>
  40 #include <sys/systm.h>
  41 #include <sys/mbuf.h>
  42 #include <sys/domain.h>
  43 #include <sys/eventhandler.h>
  44 #include <sys/kernel.h>
  45 #include <sys/ktls.h>
  46 #include <sys/limits.h>
  47 #include <sys/lock.h>
  48 #include <sys/mutex.h>
  49 #include <sys/protosw.h>
  50 #include <sys/refcount.h>
  51 #include <sys/sf_buf.h>
  52 #include <sys/smp.h>
  53 #include <sys/socket.h>
  54 #include <sys/sysctl.h>
  55
  56 #include <net/if.h>
  57 #include <net/if_var.h>
  58
  59 #include <vm/vm.h>
  60 #include <vm/vm_extern.h>
  61 #include <vm/vm_kern.h>
  62 #include <vm/vm_page.h>
  63 #include <vm/vm_map.h>
  64 #include <vm/uma.h>
  65 #include <vm/uma_dbg.h>
  66
  67 /*
  68  * In FreeBSD, Mbufs and Mbuf Clusters are allocated from UMA
  69  * Zones.
  70  *
  71  * Mbuf Clusters (2K, contiguous) are allocated from the Cluster
  72  * Zone.  The Zone can be capped at kern.ipc.nmbclusters, if the
  73  * administrator so desires.
  74  *
  75  * Mbufs are allocated from a UMA Master Zone called the Mbuf
  76  * Zone.
  77  *
  78  * Additionally, FreeBSD provides a Packet Zone, which it
  79  * configures as a Secondary Zone to the Mbuf Master Zone,
  80  * thus sharing backend Slab kegs with the Mbuf Master Zone.
  81  *
  82  * Thus common-case allocations and locking are simplified:
  83  *
  84  *  m_clget()                m_getcl()
  85  *    |                         |
  86  *    |   .------------>[(Packet Cache)]    m_get(), m_gethdr()
  87  *    |   |             [     Packet   ]            |
  88  *  [(Cluster Cache)]   [    Secondary ]   [ (Mbuf Cache)     ]
  89  *  [ Cluster Zone  ]   [     Zone     ]   [ Mbuf Master Zone ]
  90  *        |                       \________         |
  91  *  [ Cluster Keg   ]                      \       /
  92  *        |                              [ Mbuf Keg   ]
  93  *  [ Cluster Slabs ]                         |
  94  *        |                              [ Mbuf Slabs ]
  95  *         \____________(VM)_________________/
  96  *
  97  *
  98  * Whenever an object is allocated with uma_zalloc() out of
  99  * one of the Zones its _ctor_ function is executed.  The same
 100  * for any deallocation through uma_zfree() the _dtor_ function
 101  * is executed.
 102  *
 103  * Caches are per-CPU and are filled from the Master Zone.
 104  *
 105  * Whenever an object is allocated from the underlying global
 106  * memory pool it gets pre-initialized with the _zinit_ functions.
 107  * When the Keg's are overfull objects get decommissioned with
 108  * _zfini_ functions and free'd back to the global memory pool.
 109  *
 110  */
 111
 112 int nmbufs;                     /* limits number of mbufs */
 113 int nmbclusters;                /* limits number of mbuf clusters */
 114 int nmbjumbop;                  /* limits number of page size jumbo clusters */
 115 int nmbjumbo9;                  /* limits number of 9k jumbo clusters */
 116 int nmbjumbo16;                 /* limits number of 16k jumbo clusters */
 117
 118 bool mb_use_ext_pgs;            /* use EXT_PGS mbufs for sendfile & TLS */
 119 SYSCTL_BOOL(_kern_ipc, OID_AUTO, mb_use_ext_pgs, CTLFLAG_RWTUN,
 120     &mb_use_ext_pgs, 0,
 121     "Use unmapped mbufs for sendfile(2) and TLS offload");
 122
 123 static quad_t maxmbufmem;       /* overall real memory limit for all mbufs */
 124
 125 SYSCTL_QUAD(_kern_ipc, OID_AUTO, maxmbufmem, CTLFLAG_RDTUN | CTLFLAG_NOFETCH, &maxmbufmem, 0,
 126     "Maximum real memory allocatable to various mbuf types");
 127
 128 static counter_u64_t snd_tag_count;
 129 SYSCTL_COUNTER_U64(_kern_ipc, OID_AUTO, num_snd_tags, CTLFLAG_RW,
 130     &snd_tag_count, "# of active mbuf send tags");
 131
 132 /*
 133  * tunable_mbinit() has to be run before any mbuf allocations are done.
 134  */
 135 static void
 136 tunable_mbinit(void *dummy)
 137 {
 138         quad_t realmem;
 139
 140         /*
 141          * The default limit for all mbuf related memory is 1/2 of all
 142          * available kernel memory (physical or kmem).
 143          * At most it can be 3/4 of available kernel memory.
 144          */
 145         realmem = qmin((quad_t)physmem * PAGE_SIZE, vm_kmem_size);
 146         maxmbufmem = realmem / 2;
 147         TUNABLE_QUAD_FETCH("kern.ipc.maxmbufmem", &maxmbufmem);
 148         if (maxmbufmem > realmem / 4 * 3)
 149                 maxmbufmem = realmem / 4 * 3;
 150
 151         TUNABLE_INT_FETCH("kern.ipc.nmbclusters", &nmbclusters);
 152         if (nmbclusters == 0)
 153                 nmbclusters = maxmbufmem / MCLBYTES / 4;
 154
 155         TUNABLE_INT_FETCH("kern.ipc.nmbjumbop", &nmbjumbop);
 156         if (nmbjumbop == 0)
 157                 nmbjumbop = maxmbufmem / MJUMPAGESIZE / 4;
 158
 159         TUNABLE_INT_FETCH("kern.ipc.nmbjumbo9", &nmbjumbo9);
 160         if (nmbjumbo9 == 0)
 161                 nmbjumbo9 = maxmbufmem / MJUM9BYTES / 6;
 162
 163         TUNABLE_INT_FETCH("kern.ipc.nmbjumbo16", &nmbjumbo16);
 164         if (nmbjumbo16 == 0)
 165                 nmbjumbo16 = maxmbufmem / MJUM16BYTES / 6;
 166
 167         /*
 168          * We need at least as many mbufs as we have clusters of
 169          * the various types added together.
 170          */
 171         TUNABLE_INT_FETCH("kern.ipc.nmbufs", &nmbufs);
 172         if (nmbufs < nmbclusters + nmbjumbop + nmbjumbo9 + nmbjumbo16)
 173                 nmbufs = lmax(maxmbufmem / MSIZE / 5,
 174                     nmbclusters + nmbjumbop + nmbjumbo9 + nmbjumbo16);
 175 }
 176 SYSINIT(tunable_mbinit, SI_SUB_KMEM, SI_ORDER_MIDDLE, tunable_mbinit, NULL);
 177
 178 static int
 179 sysctl_nmbclusters(SYSCTL_HANDLER_ARGS)
 180 {
 181         int error, newnmbclusters;
 182
 183         newnmbclusters = nmbclusters;
 184         error = sysctl_handle_int(oidp, &newnmbclusters, 0, req);
 185         if (error == 0 && req->newptr && newnmbclusters != nmbclusters) {
 186                 if (newnmbclusters > nmbclusters &&
 187                     nmbufs >= nmbclusters + nmbjumbop + nmbjumbo9 + nmbjumbo16) {
 188                         nmbclusters = newnmbclusters;
 189                         nmbclusters = uma_zone_set_max(zone_clust, nmbclusters);
 190                         EVENTHANDLER_INVOKE(nmbclusters_change);
 191                 } else
 192                         error = EINVAL;
 193         }
 194         return (error);
 195 }
 196 SYSCTL_PROC(_kern_ipc, OID_AUTO, nmbclusters,
 197     CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_NEEDGIANT, &nmbclusters, 0,
 198     sysctl_nmbclusters, "IU",
 199     "Maximum number of mbuf clusters allowed");
 200
 201 static int
 202 sysctl_nmbjumbop(SYSCTL_HANDLER_ARGS)
 203 {
 204         int error, newnmbjumbop;
 205
 206         newnmbjumbop = nmbjumbop;
 207         error = sysctl_handle_int(oidp, &newnmbjumbop, 0, req);
 208         if (error == 0 && req->newptr && newnmbjumbop != nmbjumbop) {
 209                 if (newnmbjumbop > nmbjumbop &&
 210                     nmbufs >= nmbclusters + nmbjumbop + nmbjumbo9 + nmbjumbo16) {
 211                         nmbjumbop = newnmbjumbop;
 212                         nmbjumbop = uma_zone_set_max(zone_jumbop, nmbjumbop);
 213                 } else
 214                         error = EINVAL;
 215         }
 216         return (error);
 217 }
 218 SYSCTL_PROC(_kern_ipc, OID_AUTO, nmbjumbop,
 219     CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_NEEDGIANT, &nmbjumbop, 0,
 220     sysctl_nmbjumbop, "IU",
 221     "Maximum number of mbuf page size jumbo clusters allowed");
 222
 223 static int
 224 sysctl_nmbjumbo9(SYSCTL_HANDLER_ARGS)
 225 {
 226         int error, newnmbjumbo9;
 227
 228         newnmbjumbo9 = nmbjumbo9;
 229         error = sysctl_handle_int(oidp, &newnmbjumbo9, 0, req);
 230         if (error == 0 && req->newptr && newnmbjumbo9 != nmbjumbo9) {
 231                 if (newnmbjumbo9 > nmbjumbo9 &&
 232                     nmbufs >= nmbclusters + nmbjumbop + nmbjumbo9 + nmbjumbo16) {
 233                         nmbjumbo9 = newnmbjumbo9;
 234                         nmbjumbo9 = uma_zone_set_max(zone_jumbo9, nmbjumbo9);
 235                 } else
 236                         error = EINVAL;
 237         }
 238         return (error);
 239 }
 240 SYSCTL_PROC(_kern_ipc, OID_AUTO, nmbjumbo9,
 241     CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_NEEDGIANT, &nmbjumbo9, 0,
 242     sysctl_nmbjumbo9, "IU",
 243     "Maximum number of mbuf 9k jumbo clusters allowed");
 244
 245 static int
 246 sysctl_nmbjumbo16(SYSCTL_HANDLER_ARGS)
 247 {
 248         int error, newnmbjumbo16;
 249
 250         newnmbjumbo16 = nmbjumbo16;
 251         error = sysctl_handle_int(oidp, &newnmbjumbo16, 0, req);
 252         if (error == 0 && req->newptr && newnmbjumbo16 != nmbjumbo16) {
 253                 if (newnmbjumbo16 > nmbjumbo16 &&
 254                     nmbufs >= nmbclusters + nmbjumbop + nmbjumbo9 + nmbjumbo16) {
 255                         nmbjumbo16 = newnmbjumbo16;
 256                         nmbjumbo16 = uma_zone_set_max(zone_jumbo16, nmbjumbo16);
 257                 } else
 258                         error = EINVAL;
 259         }
 260         return (error);
 261 }
 262 SYSCTL_PROC(_kern_ipc, OID_AUTO, nmbjumbo16,
 263     CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_NEEDGIANT, &nmbjumbo16, 0,
 264     sysctl_nmbjumbo16, "IU",
 265     "Maximum number of mbuf 16k jumbo clusters allowed");
 266
 267 static int
 268 sysctl_nmbufs(SYSCTL_HANDLER_ARGS)
 269 {
 270         int error, newnmbufs;
 271
 272         newnmbufs = nmbufs;
 273         error = sysctl_handle_int(oidp, &newnmbufs, 0, req);
 274         if (error == 0 && req->newptr && newnmbufs != nmbufs) {
 275                 if (newnmbufs > nmbufs) {
 276                         nmbufs = newnmbufs;
 277                         nmbufs = uma_zone_set_max(zone_mbuf, nmbufs);
 278                         EVENTHANDLER_INVOKE(nmbufs_change);
 279                 } else
 280                         error = EINVAL;
 281         }
 282         return (error);
 283 }
 284 SYSCTL_PROC(_kern_ipc, OID_AUTO, nmbufs,
 285     CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_NEEDGIANT,
 286     &nmbufs, 0, sysctl_nmbufs, "IU",
 287     "Maximum number of mbufs allowed");
 288
 289 /*
 290  * Zones from which we allocate.
 291  */
 292 uma_zone_t      zone_mbuf;
 293 uma_zone_t      zone_clust;
 294 uma_zone_t      zone_pack;
 295 uma_zone_t      zone_jumbop;
 296 uma_zone_t      zone_jumbo9;
 297 uma_zone_t      zone_jumbo16;
 298
 299 /*
 300  * Local prototypes.
 301  */
 302 static int      mb_ctor_mbuf(void *, int, void *, int);
 303 static int      mb_ctor_clust(void *, int, void *, int);
 304 static int      mb_ctor_pack(void *, int, void *, int);
 305 static void     mb_dtor_mbuf(void *, int, void *);
 306 static void     mb_dtor_pack(void *, int, void *);
 307 static int      mb_zinit_pack(void *, int, int);
 308 static void     mb_zfini_pack(void *, int);
 309 static void     mb_reclaim(uma_zone_t, int);
 310
 311 /* Ensure that MSIZE is a power of 2. */
 312 CTASSERT((((MSIZE - 1) ^ MSIZE) + 1) >> 1 == MSIZE);
 313
 314 _Static_assert(sizeof(struct mbuf) <= MSIZE,
 315     "size of mbuf exceeds MSIZE");
 316 /*
 317  * Initialize FreeBSD Network buffer allocation.
 318  */
 319 static void
 320 mbuf_init(void *dummy)
 321 {
 322
 323         /*
 324          * Configure UMA zones for Mbufs, Clusters, and Packets.
 325          */
 326         zone_mbuf = uma_zcreate(MBUF_MEM_NAME, MSIZE,
 327             mb_ctor_mbuf, mb_dtor_mbuf, NULL, NULL,
 328             MSIZE - 1, UMA_ZONE_CONTIG | UMA_ZONE_MAXBUCKET);
 329         if (nmbufs > 0)
 330                 nmbufs = uma_zone_set_max(zone_mbuf, nmbufs);
 331         uma_zone_set_warning(zone_mbuf, "kern.ipc.nmbufs limit reached");
 332         uma_zone_set_maxaction(zone_mbuf, mb_reclaim);
 333
 334         zone_clust = uma_zcreate(MBUF_CLUSTER_MEM_NAME, MCLBYTES,
 335             mb_ctor_clust, NULL, NULL, NULL,
 336             UMA_ALIGN_PTR, UMA_ZONE_CONTIG);
 337         if (nmbclusters > 0)
 338                 nmbclusters = uma_zone_set_max(zone_clust, nmbclusters);
 339         uma_zone_set_warning(zone_clust, "kern.ipc.nmbclusters limit reached");
 340         uma_zone_set_maxaction(zone_clust, mb_reclaim);
 341
 342         zone_pack = uma_zsecond_create(MBUF_PACKET_MEM_NAME, mb_ctor_pack,
 343             mb_dtor_pack, mb_zinit_pack, mb_zfini_pack, zone_mbuf);
 344
 345         /* Make jumbo frame zone too. Page size, 9k and 16k. */
 346         zone_jumbop = uma_zcreate(MBUF_JUMBOP_MEM_NAME, MJUMPAGESIZE,
 347             mb_ctor_clust, NULL, NULL, NULL,
 348             UMA_ALIGN_PTR, UMA_ZONE_CONTIG);
 349         if (nmbjumbop > 0)
 350                 nmbjumbop = uma_zone_set_max(zone_jumbop, nmbjumbop);
 351         uma_zone_set_warning(zone_jumbop, "kern.ipc.nmbjumbop limit reached");
 352         uma_zone_set_maxaction(zone_jumbop, mb_reclaim);
 353
 354         zone_jumbo9 = uma_zcreate(MBUF_JUMBO9_MEM_NAME, MJUM9BYTES,
 355             mb_ctor_clust, NULL, NULL, NULL,
 356             UMA_ALIGN_PTR, UMA_ZONE_CONTIG);
 357         if (nmbjumbo9 > 0)
 358                 nmbjumbo9 = uma_zone_set_max(zone_jumbo9, nmbjumbo9);
 359         uma_zone_set_warning(zone_jumbo9, "kern.ipc.nmbjumbo9 limit reached");
 360         uma_zone_set_maxaction(zone_jumbo9, mb_reclaim);
 361
 362         zone_jumbo16 = uma_zcreate(MBUF_JUMBO16_MEM_NAME, MJUM16BYTES,
 363             mb_ctor_clust, NULL, NULL, NULL,
 364             UMA_ALIGN_PTR, UMA_ZONE_CONTIG);
 365         if (nmbjumbo16 > 0)
 366                 nmbjumbo16 = uma_zone_set_max(zone_jumbo16, nmbjumbo16);
 367         uma_zone_set_warning(zone_jumbo16, "kern.ipc.nmbjumbo16 limit reached");
 368         uma_zone_set_maxaction(zone_jumbo16, mb_reclaim);
 369
 370         /*
 371          * Hook event handler for low-memory situation, used to
 372          * drain protocols and push data back to the caches (UMA
 373          * later pushes it back to VM).
 374          */
 375         EVENTHANDLER_REGISTER(vm_lowmem, mb_reclaim, NULL,
 376             EVENTHANDLER_PRI_FIRST);
 377
 378         snd_tag_count = counter_u64_alloc(M_WAITOK);
 379 }
 380 SYSINIT(mbuf, SI_SUB_MBUF, SI_ORDER_FIRST, mbuf_init, NULL);
 381
 382 #ifdef DEBUGNET
 383 /*
 384  * debugnet makes use of a pre-allocated pool of mbufs and clusters.  When
 385  * debugnet is configured, we initialize a set of UMA cache zones which return
 386  * items from this pool.  At panic-time, the regular UMA zone pointers are
 387  * overwritten with those of the cache zones so that drivers may allocate and
 388  * free mbufs and clusters without attempting to allocate physical memory.
 389  *
 390  * We keep mbufs and clusters in a pair of mbuf queues.  In particular, for
 391  * the purpose of caching clusters, we treat them as mbufs.
 392  */
 393 static struct mbufq dn_mbufq =
 394     { STAILQ_HEAD_INITIALIZER(dn_mbufq.mq_head), 0, INT_MAX };
 395 static struct mbufq dn_clustq =
 396     { STAILQ_HEAD_INITIALIZER(dn_clustq.mq_head), 0, INT_MAX };
 397
 398 static int dn_clsize;
 399 static uma_zone_t dn_zone_mbuf;
 400 static uma_zone_t dn_zone_clust;
 401 static uma_zone_t dn_zone_pack;
 402
 403 static struct debugnet_saved_zones {
 404         uma_zone_t dsz_mbuf;
 405         uma_zone_t dsz_clust;
 406         uma_zone_t dsz_pack;
 407         uma_zone_t dsz_jumbop;
 408         uma_zone_t dsz_jumbo9;
 409         uma_zone_t dsz_jumbo16;
 410         bool dsz_debugnet_zones_enabled;
 411 } dn_saved_zones;
 412
 413 static int
 414 dn_buf_import(void *arg, void **store, int count, int domain __unused,
 415     int flags)
 416 {
 417         struct mbufq *q;
 418         struct mbuf *m;
 419         int i;
 420
 421         q = arg;
 422
 423         for (i = 0; i < count; i++) {
 424                 m = mbufq_dequeue(q);
 425                 if (m == NULL)
 426                         break;
 427                 trash_init(m, q == &dn_mbufq ? MSIZE : dn_clsize, flags);
 428                 store[i] = m;
 429         }
 430         KASSERT((flags & M_WAITOK) == 0 || i == count,
 431             ("%s: ran out of pre-allocated mbufs", __func__));
 432         return (i);
 433 }
 434
 435 static void
 436 dn_buf_release(void *arg, void **store, int count)
 437 {
 438         struct mbufq *q;
 439         struct mbuf *m;
 440         int i;
 441
 442         q = arg;
 443
 444         for (i = 0; i < count; i++) {
 445                 m = store[i];
 446                 (void)mbufq_enqueue(q, m);
 447         }
 448 }
 449
 450 static int
 451 dn_pack_import(void *arg __unused, void **store, int count, int domain __unused,
 452     int flags __unused)
 453 {
 454         struct mbuf *m;
 455         void *clust;
 456         int i;
 457
 458         for (i = 0; i < count; i++) {
 459                 m = m_get(MT_DATA, M_NOWAIT);
 460                 if (m == NULL)
 461                         break;
 462                 clust = uma_zalloc(dn_zone_clust, M_NOWAIT);
 463                 if (clust == NULL) {
 464                         m_free(m);
 465                         break;
 466                 }
 467                 mb_ctor_clust(clust, dn_clsize, m, 0);
 468                 store[i] = m;
 469         }
 470         KASSERT((flags & M_WAITOK) == 0 || i == count,
 471             ("%s: ran out of pre-allocated mbufs", __func__));
 472         return (i);
 473 }
 474
 475 static void
 476 dn_pack_release(void *arg __unused, void **store, int count)
 477 {
 478         struct mbuf *m;
 479         void *clust;
 480         int i;
 481
 482         for (i = 0; i < count; i++) {
 483                 m = store[i];
 484                 clust = m->m_ext.ext_buf;
 485                 uma_zfree(dn_zone_clust, clust);
 486                 uma_zfree(dn_zone_mbuf, m);
 487         }
 488 }
 489
 490 /*
 491  * Free the pre-allocated mbufs and clusters reserved for debugnet, and destroy
 492  * the corresponding UMA cache zones.
 493  */
 494 void
 495 debugnet_mbuf_drain(void)
 496 {
 497         struct mbuf *m;
 498         void *item;
 499
 500         if (dn_zone_mbuf != NULL) {
 501                 uma_zdestroy(dn_zone_mbuf);
 502                 dn_zone_mbuf = NULL;
 503         }
 504         if (dn_zone_clust != NULL) {
 505                 uma_zdestroy(dn_zone_clust);
 506                 dn_zone_clust = NULL;
 507         }
 508         if (dn_zone_pack != NULL) {
 509                 uma_zdestroy(dn_zone_pack);
 510                 dn_zone_pack = NULL;
 511         }
 512
 513         while ((m = mbufq_dequeue(&dn_mbufq)) != NULL)
 514                 m_free(m);
 515         while ((item = mbufq_dequeue(&dn_clustq)) != NULL)
 516                 uma_zfree(m_getzone(dn_clsize), item);
 517 }
 518
 519 /*
 520  * Callback invoked immediately prior to starting a debugnet connection.
 521  */
 522 void
 523 debugnet_mbuf_start(void)
 524 {
 525
 526         MPASS(!dn_saved_zones.dsz_debugnet_zones_enabled);
 527
 528         /* Save the old zone pointers to restore when debugnet is closed. */
 529         dn_saved_zones = (struct debugnet_saved_zones) {
 530                 .dsz_debugnet_zones_enabled = true,
 531                 .dsz_mbuf = zone_mbuf,
 532                 .dsz_clust = zone_clust,
 533                 .dsz_pack = zone_pack,
 534                 .dsz_jumbop = zone_jumbop,
 535                 .dsz_jumbo9 = zone_jumbo9,
 536                 .dsz_jumbo16 = zone_jumbo16,
 537         };
 538
 539         /*
 540          * All cluster zones return buffers of the size requested by the
 541          * drivers.  It's up to the driver to reinitialize the zones if the
 542          * MTU of a debugnet-enabled interface changes.
 543          */
 544         printf("debugnet: overwriting mbuf zone pointers\n");
 545         zone_mbuf = dn_zone_mbuf;
 546         zone_clust = dn_zone_clust;
 547         zone_pack = dn_zone_pack;
 548         zone_jumbop = dn_zone_clust;
 549         zone_jumbo9 = dn_zone_clust;
 550         zone_jumbo16 = dn_zone_clust;
 551 }
 552
 553 /*
 554  * Callback invoked when a debugnet connection is closed/finished.
 555  */
 556 void
 557 debugnet_mbuf_finish(void)
 558 {
 559
 560         MPASS(dn_saved_zones.dsz_debugnet_zones_enabled);
 561
 562         printf("debugnet: restoring mbuf zone pointers\n");
 563         zone_mbuf = dn_saved_zones.dsz_mbuf;
 564         zone_clust = dn_saved_zones.dsz_clust;
 565         zone_pack = dn_saved_zones.dsz_pack;
 566         zone_jumbop = dn_saved_zones.dsz_jumbop;
 567         zone_jumbo9 = dn_saved_zones.dsz_jumbo9;
 568         zone_jumbo16 = dn_saved_zones.dsz_jumbo16;
 569
 570         memset(&dn_saved_zones, 0, sizeof(dn_saved_zones));
 571 }
 572
 573 /*
 574  * Reinitialize the debugnet mbuf+cluster pool and cache zones.
 575  */
 576 void
 577 debugnet_mbuf_reinit(int nmbuf, int nclust, int clsize)
 578 {
 579         struct mbuf *m;
 580         void *item;
 581
 582         debugnet_mbuf_drain();
 583
 584         dn_clsize = clsize;
 585
 586         dn_zone_mbuf = uma_zcache_create("debugnet_" MBUF_MEM_NAME,
 587             MSIZE, mb_ctor_mbuf, mb_dtor_mbuf, NULL, NULL,
 588             dn_buf_import, dn_buf_release,
 589             &dn_mbufq, UMA_ZONE_NOBUCKET);
 590
 591         dn_zone_clust = uma_zcache_create("debugnet_" MBUF_CLUSTER_MEM_NAME,
 592             clsize, mb_ctor_clust, NULL, NULL, NULL,
 593             dn_buf_import, dn_buf_release,
 594             &dn_clustq, UMA_ZONE_NOBUCKET);
 595
 596         dn_zone_pack = uma_zcache_create("debugnet_" MBUF_PACKET_MEM_NAME,
 597             MCLBYTES, mb_ctor_pack, mb_dtor_pack, NULL, NULL,
 598             dn_pack_import, dn_pack_release,
 599             NULL, UMA_ZONE_NOBUCKET);
 600
 601         while (nmbuf-- > 0) {
 602                 m = m_get(MT_DATA, M_WAITOK);
 603                 uma_zfree(dn_zone_mbuf, m);
 604         }
 605         while (nclust-- > 0) {
 606                 item = uma_zalloc(m_getzone(dn_clsize), M_WAITOK);
 607                 uma_zfree(dn_zone_clust, item);
 608         }
 609 }
 610 #endif /* DEBUGNET */
 611
 612 /*
 613  * Constructor for Mbuf master zone.
 614  *
 615  * The 'arg' pointer points to a mb_args structure which
 616  * contains call-specific information required to support the
 617  * mbuf allocation API.  See mbuf.h.
 618  */
 619 static int
 620 mb_ctor_mbuf(void *mem, int size, void *arg, int how)
 621 {
 622         struct mbuf *m;
 623         struct mb_args *args;
 624         int error;
 625         int flags;
 626         short type;
 627
 628         args = (struct mb_args *)arg;
 629         type = args->type;
 630
 631         /*
 632          * The mbuf is initialized later.  The caller has the
 633          * responsibility to set up any MAC labels too.
 634          */
 635         if (type == MT_NOINIT)
 636                 return (0);
 637
 638         m = (struct mbuf *)mem;
 639         flags = args->flags;
 640         MPASS((flags & M_NOFREE) == 0);
 641
 642         error = m_init(m, how, type, flags);
 643
 644         return (error);
 645 }
 646
 647 /*
 648  * The Mbuf master zone destructor.
 649  */
 650 static void
 651 mb_dtor_mbuf(void *mem, int size, void *arg)
 652 {
 653         struct mbuf *m;
 654         unsigned long flags;
 655
 656         m = (struct mbuf *)mem;
 657         flags = (unsigned long)arg;
 658
 659         KASSERT((m->m_flags & M_NOFREE) == 0, ("%s: M_NOFREE set", __func__));
 660         if (!(flags & MB_DTOR_SKIP) && (m->m_flags & M_PKTHDR) && !SLIST_EMPTY(&m->m_pkthdr.tags))
 661                 m_tag_delete_chain(m, NULL);
 662 }
 663
 664 /*
 665  * The Mbuf Packet zone destructor.
 666  */
 667 static void
 668 mb_dtor_pack(void *mem, int size, void *arg)
 669 {
 670         struct mbuf *m;
 671
 672         m = (struct mbuf *)mem;
 673         if ((m->m_flags & M_PKTHDR) != 0)
 674                 m_tag_delete_chain(m, NULL);
 675
 676         /* Make sure we've got a clean cluster back. */
 677         KASSERT((m->m_flags & M_EXT) == M_EXT, ("%s: M_EXT not set", __func__));
 678         KASSERT(m->m_ext.ext_buf != NULL, ("%s: ext_buf == NULL", __func__));
 679         KASSERT(m->m_ext.ext_free == NULL, ("%s: ext_free != NULL", __func__));
 680         KASSERT(m->m_ext.ext_arg1 == NULL, ("%s: ext_arg1 != NULL", __func__));
 681         KASSERT(m->m_ext.ext_arg2 == NULL, ("%s: ext_arg2 != NULL", __func__));
 682         KASSERT(m->m_ext.ext_size == MCLBYTES, ("%s: ext_size != MCLBYTES", __func__));
 683         KASSERT(m->m_ext.ext_type == EXT_PACKET, ("%s: ext_type != EXT_PACKET", __func__));
 684 #ifdef INVARIANTS
 685         trash_dtor(m->m_ext.ext_buf, MCLBYTES, arg);
 686 #endif
 687         /*
 688          * If there are processes blocked on zone_clust, waiting for pages
 689          * to be freed up, cause them to be woken up by draining the
 690          * packet zone.  We are exposed to a race here (in the check for
 691          * the UMA_ZFLAG_FULL) where we might miss the flag set, but that
 692          * is deliberate. We don't want to acquire the zone lock for every
 693          * mbuf free.
 694          */
 695         if (uma_zone_exhausted(zone_clust))
 696                 uma_zone_reclaim(zone_pack, UMA_RECLAIM_DRAIN);
 697 }
 698
 699 /*
 700  * The Cluster and Jumbo[PAGESIZE|9|16] zone constructor.
 701  *
 702  * Here the 'arg' pointer points to the Mbuf which we
 703  * are configuring cluster storage for.  If 'arg' is
 704  * empty we allocate just the cluster without setting
 705  * the mbuf to it.  See mbuf.h.
 706  */
 707 static int
 708 mb_ctor_clust(void *mem, int size, void *arg, int how)
 709 {
 710         struct mbuf *m;
 711
 712         m = (struct mbuf *)arg;
 713         if (m != NULL) {
 714                 m->m_ext.ext_buf = (char *)mem;
 715                 m->m_data = m->m_ext.ext_buf;
 716                 m->m_flags |= M_EXT;
 717                 m->m_ext.ext_free = NULL;
 718                 m->m_ext.ext_arg1 = NULL;
 719                 m->m_ext.ext_arg2 = NULL;
 720                 m->m_ext.ext_size = size;
 721                 m->m_ext.ext_type = m_gettype(size);
 722                 m->m_ext.ext_flags = EXT_FLAG_EMBREF;
 723                 m->m_ext.ext_count = 1;
 724         }
 725
 726         return (0);
 727 }
 728
 729 /*
 730  * The Packet secondary zone's init routine, executed on the
 731  * object's transition from mbuf keg slab to zone cache.
 732  */
 733 static int
 734 mb_zinit_pack(void *mem, int size, int how)
 735 {
 736         struct mbuf *m;
 737
 738         m = (struct mbuf *)mem;         /* m is virgin. */
 739         if (uma_zalloc_arg(zone_clust, m, how) == NULL ||
 740             m->m_ext.ext_buf == NULL)
 741                 return (ENOMEM);
 742         m->m_ext.ext_type = EXT_PACKET; /* Override. */
 743 #ifdef INVARIANTS
 744         trash_init(m->m_ext.ext_buf, MCLBYTES, how);
 745 #endif
 746         return (0);
 747 }
 748
 749 /*
 750  * The Packet secondary zone's fini routine, executed on the
 751  * object's transition from zone cache to keg slab.
 752  */
 753 static void
 754 mb_zfini_pack(void *mem, int size)
 755 {
 756         struct mbuf *m;
 757
 758         m = (struct mbuf *)mem;
 759 #ifdef INVARIANTS
 760         trash_fini(m->m_ext.ext_buf, MCLBYTES);
 761 #endif
 762         uma_zfree_arg(zone_clust, m->m_ext.ext_buf, NULL);
 763 #ifdef INVARIANTS
 764         trash_dtor(mem, size, NULL);
 765 #endif
 766 }
 767
 768 /*
 769  * The "packet" keg constructor.
 770  */
 771 static int
 772 mb_ctor_pack(void *mem, int size, void *arg, int how)
 773 {
 774         struct mbuf *m;
 775         struct mb_args *args;
 776         int error, flags;
 777         short type;
 778
 779         m = (struct mbuf *)mem;
 780         args = (struct mb_args *)arg;
 781         flags = args->flags;
 782         type = args->type;
 783         MPASS((flags & M_NOFREE) == 0);
 784
 785 #ifdef INVARIANTS
 786         trash_ctor(m->m_ext.ext_buf, MCLBYTES, arg, how);
 787 #endif
 788
 789         error = m_init(m, how, type, flags);
 790
 791         /* m_ext is already initialized. */
 792         m->m_data = m->m_ext.ext_buf;
 793         m->m_flags = (flags | M_EXT);
 794
 795         return (error);
 796 }
 797
 798 /*
 799  * This is the protocol drain routine.  Called by UMA whenever any of the
 800  * mbuf zones is closed to its limit.
 801  *
 802  * No locks should be held when this is called.  The drain routines have to
 803  * presently acquire some locks which raises the possibility of lock order
 804  * reversal.
 805  */
 806 static void
 807 mb_reclaim(uma_zone_t zone __unused, int pending __unused)
 808 {
 809         struct epoch_tracker et;
 810         struct domain *dp;
 811         struct protosw *pr;
 812
 813         WITNESS_WARN(WARN_GIANTOK | WARN_SLEEPOK | WARN_PANIC, NULL, __func__);
 814
 815         NET_EPOCH_ENTER(et);
 816         for (dp = domains; dp != NULL; dp = dp->dom_next)
 817                 for (pr = dp->dom_protosw; pr < dp->dom_protoswNPROTOSW; pr++)
 818                         if (pr->pr_drain != NULL)
 819                                 (*pr->pr_drain)();
 820         NET_EPOCH_EXIT(et);
 821 }
 822
 823 /*
 824  * Free "count" units of I/O from an mbuf chain.  They could be held
 825  * in EXT_PGS or just as a normal mbuf.  This code is intended to be
 826  * called in an error path (I/O error, closed connection, etc).
 827  */
 828 void
 829 mb_free_notready(struct mbuf *m, int count)
 830 {
 831         int i;
 832
 833         for (i = 0; i < count && m != NULL; i++) {
 834                 if ((m->m_flags & M_EXT) != 0 &&
 835                     m->m_ext.ext_type == EXT_PGS) {
 836                         m->m_epg_nrdy--;
 837                         if (m->m_epg_nrdy != 0)
 838                                 continue;
 839                 }
 840                 m = m_free(m);
 841         }
 842         KASSERT(i == count, ("Removed only %d items from %p", i, m));
 843 }
 844
 845 /*
 846  * Compress an unmapped mbuf into a simple mbuf when it holds a small
 847  * amount of data.  This is used as a DOS defense to avoid having
 848  * small packets tie up wired pages, an ext_pgs structure, and an
 849  * mbuf.  Since this converts the existing mbuf in place, it can only
 850  * be used if there are no other references to 'm'.
 851  */
 852 int
 853 mb_unmapped_compress(struct mbuf *m)
 854 {
 855         volatile u_int *refcnt;
 856         char buf[MLEN];
 857
 858         /*
 859          * Assert that 'm' does not have a packet header.  If 'm' had
 860          * a packet header, it would only be able to hold MHLEN bytes
 861          * and m_data would have to be initialized differently.
 862          */
 863         KASSERT((m->m_flags & M_PKTHDR) == 0 && (m->m_flags & M_EXT) &&
 864             m->m_ext.ext_type == EXT_PGS,
 865             ("%s: m %p !M_EXT or !EXT_PGS or M_PKTHDR", __func__, m));
 866         KASSERT(m->m_len <= MLEN, ("m_len too large %p", m));
 867
 868         if (m->m_ext.ext_flags & EXT_FLAG_EMBREF) {
 869                 refcnt = &m->m_ext.ext_count;
 870         } else {
 871                 KASSERT(m->m_ext.ext_cnt != NULL,
 872                     ("%s: no refcounting pointer on %p", __func__, m));
 873                 refcnt = m->m_ext.ext_cnt;
 874         }
 875
 876         if (*refcnt != 1)
 877                 return (EBUSY);
 878
 879         m_copydata(m, 0, m->m_len, buf);
 880
 881         /* Free the backing pages. */
 882         m->m_ext.ext_free(m);
 883
 884         /* Turn 'm' into a "normal" mbuf. */
 885         m->m_flags &= ~(M_EXT | M_RDONLY | M_NOMAP);
 886         m->m_data = m->m_dat;
 887
 888         /* Copy data back into m. */
 889         bcopy(buf, mtod(m, char *), m->m_len);
 890
 891         return (0);
 892 }
 893
 894 /*
 895  * These next few routines are used to permit downgrading an unmapped
 896  * mbuf to a chain of mapped mbufs.  This is used when an interface
 897  * doesn't supported unmapped mbufs or if checksums need to be
 898  * computed in software.
 899  *
 900  * Each unmapped mbuf is converted to a chain of mbufs.  First, any
 901  * TLS header data is stored in a regular mbuf.  Second, each page of
 902  * unmapped data is stored in an mbuf with an EXT_SFBUF external
 903  * cluster.  These mbufs use an sf_buf to provide a valid KVA for the
 904  * associated physical page.  They also hold a reference on the
 905  * original EXT_PGS mbuf to ensure the physical page doesn't go away.
 906  * Finally, any TLS trailer data is stored in a regular mbuf.
 907  *
 908  * mb_unmapped_free_mext() is the ext_free handler for the EXT_SFBUF
 909  * mbufs.  It frees the associated sf_buf and releases its reference
 910  * on the original EXT_PGS mbuf.
 911  *
 912  * _mb_unmapped_to_ext() is a helper function that converts a single
 913  * unmapped mbuf into a chain of mbufs.
 914  *
 915  * mb_unmapped_to_ext() is the public function that walks an mbuf
 916  * chain converting any unmapped mbufs to mapped mbufs.  It returns
 917  * the new chain of unmapped mbufs on success.  On failure it frees
 918  * the original mbuf chain and returns NULL.
 919  */
 920 static void
 921 mb_unmapped_free_mext(struct mbuf *m)
 922 {
 923         struct sf_buf *sf;
 924         struct mbuf *old_m;
 925
 926         sf = m->m_ext.ext_arg1;
 927         sf_buf_free(sf);
 928
 929         /* Drop the reference on the backing EXT_PGS mbuf. */
 930         old_m = m->m_ext.ext_arg2;
 931         mb_free_ext(old_m);
 932 }
 933
 934 static struct mbuf *
 935 _mb_unmapped_to_ext(struct mbuf *m)
 936 {
 937         struct mbuf *m_new, *top, *prev, *mref;
 938         struct sf_buf *sf;
 939         vm_page_t pg;
 940         int i, len, off, pglen, pgoff, seglen, segoff;
 941         volatile u_int *refcnt;
 942         u_int ref_inc = 0;
 943
 944         MBUF_EXT_PGS_ASSERT(m);
 945         len = m->m_len;
 946         KASSERT(m->m_epg_tls == NULL, ("%s: can't convert TLS mbuf %p",
 947             __func__, m));
 948
 949         /* See if this is the mbuf that holds the embedded refcount. */
 950         if (m->m_ext.ext_flags & EXT_FLAG_EMBREF) {
 951                 refcnt = &m->m_ext.ext_count;
 952                 mref = m;
 953         } else {
 954                 KASSERT(m->m_ext.ext_cnt != NULL,
 955                     ("%s: no refcounting pointer on %p", __func__, m));
 956                 refcnt = m->m_ext.ext_cnt;
 957                 mref = __containerof(refcnt, struct mbuf, m_ext.ext_count);
 958         }
 959
 960         /* Skip over any data removed from the front. */
 961         off = mtod(m, vm_offset_t);
 962
 963         top = NULL;
 964         if (m->m_epg_hdrlen != 0) {
 965                 if (off >= m->m_epg_hdrlen) {
 966                         off -= m->m_epg_hdrlen;
 967                 } else {
 968                         seglen = m->m_epg_hdrlen - off;
 969                         segoff = off;
 970                         seglen = min(seglen, len);
 971                         off = 0;
 972                         len -= seglen;
 973                         m_new = m_get(M_NOWAIT, MT_DATA);
 974                         if (m_new == NULL)
 975                                 goto fail;
 976                         m_new->m_len = seglen;
 977                         prev = top = m_new;
 978                         memcpy(mtod(m_new, void *), &m->m_epg_hdr[segoff],
 979                             seglen);
 980                 }
 981         }
 982         pgoff = m->m_epg_1st_off;
 983         for (i = 0; i < m->m_epg_npgs && len > 0; i++) {
 984                 pglen = m_epg_pagelen(m, i, pgoff);
 985                 if (off >= pglen) {
 986                         off -= pglen;
 987                         pgoff = 0;
 988                         continue;
 989                 }
 990                 seglen = pglen - off;
 991                 segoff = pgoff + off;
 992                 off = 0;
 993                 seglen = min(seglen, len);
 994                 len -= seglen;
 995
 996                 pg = PHYS_TO_VM_PAGE(m->m_epg_pa[i]);
 997                 m_new = m_get(M_NOWAIT, MT_DATA);
 998                 if (m_new == NULL)
 999                         goto fail;
1000                 if (top == NULL) {
1001                         top = prev = m_new;
1002                 } else {
1003                         prev->m_next = m_new;
1004                         prev = m_new;
1005                 }
1006                 sf = sf_buf_alloc(pg, SFB_NOWAIT);
1007                 if (sf == NULL)
1008                         goto fail;
1009
1010                 ref_inc++;
1011                 m_extadd(m_new, (char *)sf_buf_kva(sf), PAGE_SIZE,
1012                     mb_unmapped_free_mext, sf, mref, M_RDONLY, EXT_SFBUF);
1013                 m_new->m_data += segoff;
1014                 m_new->m_len = seglen;
1015
1016                 pgoff = 0;
1017         };
1018         if (len != 0) {
1019                 KASSERT((off + len) <= m->m_epg_trllen,
1020                     ("off + len > trail (%d + %d > %d)", off, len,
1021                     m->m_epg_trllen));
1022                 m_new = m_get(M_NOWAIT, MT_DATA);
1023                 if (m_new == NULL)
1024                         goto fail;
1025                 if (top == NULL)
1026                         top = m_new;
1027                 else
1028                         prev->m_next = m_new;
1029                 m_new->m_len = len;
1030                 memcpy(mtod(m_new, void *), &m->m_epg_trail[off], len);
1031         }
1032
1033         if (ref_inc != 0) {
1034                 /*
1035                  * Obtain an additional reference on the old mbuf for
1036                  * each created EXT_SFBUF mbuf.  They will be dropped
1037                  * in mb_unmapped_free_mext().
1038                  */
1039                 if (*refcnt == 1)
1040                         *refcnt += ref_inc;
1041                 else
1042                         atomic_add_int(refcnt, ref_inc);
1043         }
1044         m_free(m);
1045         return (top);
1046
1047 fail:
1048         if (ref_inc != 0) {
1049                 /*
1050                  * Obtain an additional reference on the old mbuf for
1051                  * each created EXT_SFBUF mbuf.  They will be
1052                  * immediately dropped when these mbufs are freed
1053                  * below.
1054                  */
1055                 if (*refcnt == 1)
1056                         *refcnt += ref_inc;
1057                 else
1058                         atomic_add_int(refcnt, ref_inc);
1059         }
1060         m_free(m);
1061         m_freem(top);
1062         return (NULL);
1063 }
1064
1065 struct mbuf *
1066 mb_unmapped_to_ext(struct mbuf *top)
1067 {
1068         struct mbuf *m, *next, *prev = NULL;
1069
1070         prev = NULL;
1071         for (m = top; m != NULL; m = next) {
1072                 /* m might be freed, so cache the next pointer. */
1073                 next = m->m_next;
1074                 if (m->m_flags & M_NOMAP) {
1075                         if (prev != NULL) {
1076                                 /*
1077                                  * Remove 'm' from the new chain so
1078                                  * that the 'top' chain terminates
1079                                  * before 'm' in case 'top' is freed
1080                                  * due to an error.
1081                                  */
1082                                 prev->m_next = NULL;
1083                         }
1084                         m = _mb_unmapped_to_ext(m);
1085                         if (m == NULL) {
1086                                 m_freem(top);
1087                                 m_freem(next);
1088                                 return (NULL);
1089                         }
1090                         if (prev == NULL) {
1091                                 top = m;
1092                         } else {
1093                                 prev->m_next = m;
1094                         }
1095
1096                         /*
1097                          * Replaced one mbuf with a chain, so we must
1098                          * find the end of chain.
1099                          */
1100                         prev = m_last(m);
1101                 } else {
1102                         if (prev != NULL) {
1103                                 prev->m_next = m;
1104                         }
1105                         prev = m;
1106                 }
1107         }
1108         return (top);
1109 }
1110
1111 /*
1112  * Allocate an empty EXT_PGS mbuf.  The ext_free routine is
1113  * responsible for freeing any pages backing this mbuf when it is
1114  * freed.
1115  */
1116 struct mbuf *
1117 mb_alloc_ext_pgs(int how, m_ext_free_t ext_free)
1118 {
1119         struct mbuf *m;
1120
1121         m = m_get(how, MT_DATA);
1122         if (m == NULL)
1123                 return (NULL);
1124
1125         m->m_epg_npgs = 0;
1126         m->m_epg_nrdy = 0;
1127         m->m_epg_1st_off = 0;
1128         m->m_epg_last_len = 0;
1129         m->m_epg_flags = 0;
1130         m->m_epg_hdrlen = 0;
1131         m->m_epg_trllen = 0;
1132         m->m_epg_tls = NULL;
1133         m->m_epg_so = NULL;
1134         m->m_data = NULL;
1135         m->m_flags |= (M_EXT | M_RDONLY | M_NOMAP);
1136         m->m_ext.ext_type = EXT_PGS;
1137         m->m_ext.ext_flags = EXT_FLAG_EMBREF;
1138         m->m_ext.ext_count = 1;
1139         m->m_ext.ext_size = 0;
1140         m->m_ext.ext_free = ext_free;
1141         return (m);
1142 }
1143
1144 /*
1145  * Clean up after mbufs with M_EXT storage attached to them if the
1146  * reference count hits 1.
1147  */
1148 void
1149 mb_free_ext(struct mbuf *m)
1150 {
1151         volatile u_int *refcnt;
1152         struct mbuf *mref;
1153         int freembuf;
1154
1155         KASSERT(m->m_flags & M_EXT, ("%s: M_EXT not set on %p", __func__, m));
1156
1157         /* See if this is the mbuf that holds the embedded refcount. */
1158         if (m->m_ext.ext_flags & EXT_FLAG_EMBREF) {
1159                 refcnt = &m->m_ext.ext_count;
1160                 mref = m;
1161         } else {
1162                 KASSERT(m->m_ext.ext_cnt != NULL,
1163                     ("%s: no refcounting pointer on %p", __func__, m));
1164                 refcnt = m->m_ext.ext_cnt;
1165                 mref = __containerof(refcnt, struct mbuf, m_ext.ext_count);
1166         }
1167
1168         /*
1169          * Check if the header is embedded in the cluster.  It is
1170          * important that we can't touch any of the mbuf fields
1171          * after we have freed the external storage, since mbuf
1172          * could have been embedded in it.  For now, the mbufs
1173          * embedded into the cluster are always of type EXT_EXTREF,
1174          * and for this type we won't free the mref.
1175          */
1176         if (m->m_flags & M_NOFREE) {
1177                 freembuf = 0;
1178                 KASSERT(m->m_ext.ext_type == EXT_EXTREF ||
1179                     m->m_ext.ext_type == EXT_RXRING,
1180                     ("%s: no-free mbuf %p has wrong type", __func__, m));
1181         } else
1182                 freembuf = 1;
1183
1184         /* Free attached storage if this mbuf is the only reference to it. */
1185         if (*refcnt == 1 || atomic_fetchadd_int(refcnt, -1) == 1) {
1186                 switch (m->m_ext.ext_type) {
1187                 case EXT_PACKET:
1188                         /* The packet zone is special. */
1189                         if (*refcnt == 0)
1190                                 *refcnt = 1;
1191                         uma_zfree(zone_pack, mref);
1192                         break;
1193                 case EXT_CLUSTER:
1194                         uma_zfree(zone_clust, m->m_ext.ext_buf);
1195                         uma_zfree(zone_mbuf, mref);
1196                         break;
1197                 case EXT_JUMBOP:
1198                         uma_zfree(zone_jumbop, m->m_ext.ext_buf);
1199                         uma_zfree(zone_mbuf, mref);
1200                         break;
1201                 case EXT_JUMBO9:
1202                         uma_zfree(zone_jumbo9, m->m_ext.ext_buf);
1203                         uma_zfree(zone_mbuf, mref);
1204                         break;
1205                 case EXT_JUMBO16:
1206                         uma_zfree(zone_jumbo16, m->m_ext.ext_buf);
1207                         uma_zfree(zone_mbuf, mref);
1208                         break;
1209                 case EXT_PGS: {
1210 #ifdef KERN_TLS
1211                         struct ktls_session *tls;
1212 #endif
1213
1214                         KASSERT(mref->m_ext.ext_free != NULL,
1215                             ("%s: ext_free not set", __func__));
1216                         mref->m_ext.ext_free(mref);
1217 #ifdef KERN_TLS
1218                         tls = mref->m_epg_tls;
1219                         if (tls != NULL &&
1220                             !refcount_release_if_not_last(&tls->refcount))
1221                                 ktls_enqueue_to_free(mref);
1222                         else
1223 #endif
1224                                 uma_zfree(zone_mbuf, mref);
1225                         break;
1226                 }
1227                 case EXT_SFBUF:
1228                 case EXT_NET_DRV:
1229                 case EXT_MOD_TYPE:
1230                 case EXT_DISPOSABLE:
1231                         KASSERT(mref->m_ext.ext_free != NULL,
1232                             ("%s: ext_free not set", __func__));
1233                         mref->m_ext.ext_free(mref);
1234                         uma_zfree(zone_mbuf, mref);
1235                         break;
1236                 case EXT_EXTREF:
1237                         KASSERT(m->m_ext.ext_free != NULL,
1238                             ("%s: ext_free not set", __func__));
1239                         m->m_ext.ext_free(m);
1240                         break;
1241                 case EXT_RXRING:
1242                         KASSERT(m->m_ext.ext_free == NULL,
1243                             ("%s: ext_free is set", __func__));
1244                         break;
1245                 default:
1246                         KASSERT(m->m_ext.ext_type == 0,
1247                             ("%s: unknown ext_type", __func__));
1248                 }
1249         }
1250
1251         if (freembuf && m != mref)
1252                 uma_zfree(zone_mbuf, m);
1253 }
1254
1255 /*
1256  * Official mbuf(9) allocation KPI for stack and drivers:
1257  *
1258  * m_get()      - a single mbuf without any attachments, sys/mbuf.h.
1259  * m_gethdr()   - a single mbuf initialized as M_PKTHDR, sys/mbuf.h.
1260  * m_getcl()    - an mbuf + 2k cluster, sys/mbuf.h.
1261  * m_clget()    - attach cluster to already allocated mbuf.
1262  * m_cljget()   - attach jumbo cluster to already allocated mbuf.
1263  * m_get2()     - allocate minimum mbuf that would fit size argument.
1264  * m_getm2()    - allocate a chain of mbufs/clusters.
1265  * m_extadd()   - attach external cluster to mbuf.
1266  *
1267  * m_free()     - free single mbuf with its tags and ext, sys/mbuf.h.
1268  * m_freem()    - free chain of mbufs.
1269  */
1270
1271 int
1272 m_clget(struct mbuf *m, int how)
1273 {
1274
1275         KASSERT((m->m_flags & M_EXT) == 0, ("%s: mbuf %p has M_EXT",
1276             __func__, m));
1277         m->m_ext.ext_buf = (char *)NULL;
1278         uma_zalloc_arg(zone_clust, m, how);
1279         /*
1280          * On a cluster allocation failure, drain the packet zone and retry,
1281          * we might be able to loosen a few clusters up on the drain.
1282          */
1283         if ((how & M_NOWAIT) && (m->m_ext.ext_buf == NULL)) {
1284                 uma_zone_reclaim(zone_pack, UMA_RECLAIM_DRAIN);
1285                 uma_zalloc_arg(zone_clust, m, how);
1286         }
1287         MBUF_PROBE2(m__clget, m, how);
1288         return (m->m_flags & M_EXT);
1289 }
1290
1291 /*
1292  * m_cljget() is different from m_clget() as it can allocate clusters without
1293  * attaching them to an mbuf.  In that case the return value is the pointer
1294  * to the cluster of the requested size.  If an mbuf was specified, it gets
1295  * the cluster attached to it and the return value can be safely ignored.
1296  * For size it takes MCLBYTES, MJUMPAGESIZE, MJUM9BYTES, MJUM16BYTES.
1297  */
1298 void *
1299 m_cljget(struct mbuf *m, int how, int size)
1300 {
1301         uma_zone_t zone;
1302         void *retval;
1303
1304         if (m != NULL) {
1305                 KASSERT((m->m_flags & M_EXT) == 0, ("%s: mbuf %p has M_EXT",
1306                     __func__, m));
1307                 m->m_ext.ext_buf = NULL;
1308         }
1309
1310         zone = m_getzone(size);
1311         retval = uma_zalloc_arg(zone, m, how);
1312
1313         MBUF_PROBE4(m__cljget, m, how, size, retval);
1314
1315         return (retval);
1316 }
1317
1318 /*
1319  * m_get2() allocates minimum mbuf that would fit "size" argument.
1320  */
1321 struct mbuf *
1322 m_get2(int size, int how, short type, int flags)
1323 {
1324         struct mb_args args;
1325         struct mbuf *m, *n;
1326
1327         args.flags = flags;
1328         args.type = type;
1329
1330         if (size <= MHLEN || (size <= MLEN && (flags & M_PKTHDR) == 0))
1331                 return (uma_zalloc_arg(zone_mbuf, &args, how));
1332         if (size <= MCLBYTES)
1333                 return (uma_zalloc_arg(zone_pack, &args, how));
1334
1335         if (size > MJUMPAGESIZE)
1336                 return (NULL);
1337
1338         m = uma_zalloc_arg(zone_mbuf, &args, how);
1339         if (m == NULL)
1340                 return (NULL);
1341
1342         n = uma_zalloc_arg(zone_jumbop, m, how);
1343         if (n == NULL) {
1344                 uma_zfree(zone_mbuf, m);
1345                 return (NULL);
1346         }
1347
1348         return (m);
1349 }
1350
1351 /*
1352  * m_getjcl() returns an mbuf with a cluster of the specified size attached.
1353  * For size it takes MCLBYTES, MJUMPAGESIZE, MJUM9BYTES, MJUM16BYTES.
1354  */
1355 struct mbuf *
1356 m_getjcl(int how, short type, int flags, int size)
1357 {
1358         struct mb_args args;
1359         struct mbuf *m, *n;
1360         uma_zone_t zone;
1361
1362         if (size == MCLBYTES)
1363                 return m_getcl(how, type, flags);
1364
1365         args.flags = flags;
1366         args.type = type;
1367
1368         m = uma_zalloc_arg(zone_mbuf, &args, how);
1369         if (m == NULL)
1370                 return (NULL);
1371
1372         zone = m_getzone(size);
1373         n = uma_zalloc_arg(zone, m, how);
1374         if (n == NULL) {
1375                 uma_zfree(zone_mbuf, m);
1376                 return (NULL);
1377         }
1378         return (m);
1379 }
1380
1381 /*
1382  * Allocate a given length worth of mbufs and/or clusters (whatever fits
1383  * best) and return a pointer to the top of the allocated chain.  If an
1384  * existing mbuf chain is provided, then we will append the new chain
1385  * to the existing one and return a pointer to the provided mbuf.
1386  */
1387 struct mbuf *
1388 m_getm2(struct mbuf *m, int len, int how, short type, int flags)
1389 {
1390         struct mbuf *mb, *nm = NULL, *mtail = NULL;
1391
1392         KASSERT(len >= 0, ("%s: len is < 0", __func__));
1393
1394         /* Validate flags. */
1395         flags &= (M_PKTHDR | M_EOR);
1396
1397         /* Packet header mbuf must be first in chain. */
1398         if ((flags & M_PKTHDR) && m != NULL)
1399                 flags &= ~M_PKTHDR;
1400
1401         /* Loop and append maximum sized mbufs to the chain tail. */
1402         while (len > 0) {
1403                 if (len > MCLBYTES)
1404                         mb = m_getjcl(how, type, (flags & M_PKTHDR),
1405                             MJUMPAGESIZE);
1406                 else if (len >= MINCLSIZE)
1407                         mb = m_getcl(how, type, (flags & M_PKTHDR));
1408                 else if (flags & M_PKTHDR)
1409                         mb = m_gethdr(how, type);
1410                 else
1411                         mb = m_get(how, type);
1412
1413                 /* Fail the whole operation if one mbuf can't be allocated. */
1414                 if (mb == NULL) {
1415                         if (nm != NULL)
1416                                 m_freem(nm);
1417                         return (NULL);
1418                 }
1419
1420                 /* Book keeping. */
1421                 len -= M_SIZE(mb);
1422                 if (mtail != NULL)
1423                         mtail->m_next = mb;
1424                 else
1425                         nm = mb;
1426                 mtail = mb;
1427                 flags &= ~M_PKTHDR;     /* Only valid on the first mbuf. */
1428         }
1429         if (flags & M_EOR)
1430                 mtail->m_flags |= M_EOR;  /* Only valid on the last mbuf. */
1431
1432         /* If mbuf was supplied, append new chain to the end of it. */
1433         if (m != NULL) {
1434                 for (mtail = m; mtail->m_next != NULL; mtail = mtail->m_next)
1435                         ;
1436                 mtail->m_next = nm;
1437                 mtail->m_flags &= ~M_EOR;
1438         } else
1439                 m = nm;
1440
1441         return (m);
1442 }
1443
1444 /*-
1445  * Configure a provided mbuf to refer to the provided external storage
1446  * buffer and setup a reference count for said buffer.
1447  *
1448  * Arguments:
1449  *    mb     The existing mbuf to which to attach the provided buffer.
1450  *    buf    The address of the provided external storage buffer.
1451  *    size   The size of the provided buffer.
1452  *    freef  A pointer to a routine that is responsible for freeing the
1453  *           provided external storage buffer.
1454  *    args   A pointer to an argument structure (of any type) to be passed
1455  *           to the provided freef routine (may be NULL).
1456  *    flags  Any other flags to be passed to the provided mbuf.
1457  *    type   The type that the external storage buffer should be
1458  *           labeled with.
1459  *
1460  * Returns:
1461  *    Nothing.
1462  */
1463 void
1464 m_extadd(struct mbuf *mb, char *buf, u_int size, m_ext_free_t freef,
1465     void *arg1, void *arg2, int flags, int type)
1466 {
1467
1468         KASSERT(type != EXT_CLUSTER, ("%s: EXT_CLUSTER not allowed", __func__));
1469
1470         mb->m_flags |= (M_EXT | flags);
1471         mb->m_ext.ext_buf = buf;
1472         mb->m_data = mb->m_ext.ext_buf;
1473         mb->m_ext.ext_size = size;
1474         mb->m_ext.ext_free = freef;
1475         mb->m_ext.ext_arg1 = arg1;
1476         mb->m_ext.ext_arg2 = arg2;
1477         mb->m_ext.ext_type = type;
1478
1479         if (type != EXT_EXTREF) {
1480                 mb->m_ext.ext_count = 1;
1481                 mb->m_ext.ext_flags = EXT_FLAG_EMBREF;
1482         } else
1483                 mb->m_ext.ext_flags = 0;
1484 }
1485
1486 /*
1487  * Free an entire chain of mbufs and associated external buffers, if
1488  * applicable.
1489  */
1490 void
1491 m_freem(struct mbuf *mb)
1492 {
1493
1494         MBUF_PROBE1(m__freem, mb);
1495         while (mb != NULL)
1496                 mb = m_free(mb);
1497 }
1498
1499 void
1500 m_snd_tag_init(struct m_snd_tag *mst, struct ifnet *ifp)
1501 {
1502
1503         if_ref(ifp);
1504         mst->ifp = ifp;
1505         refcount_init(&mst->refcount, 1);
1506         counter_u64_add(snd_tag_count, 1);
1507 }
1508
1509 void
1510 m_snd_tag_destroy(struct m_snd_tag *mst)
1511 {
1512         struct ifnet *ifp;
1513
1514         ifp = mst->ifp;
1515         ifp->if_snd_tag_free(mst);
1516         if_rele(ifp);
1517         counter_u64_add(snd_tag_count, -1);
1518 }