sys/sys/mbuf.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 1982, 1986, 1988, 1993
   5  *      The Regents of the University of California.
   6  * All rights reserved.
   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 University nor the names of its contributors
  17  *    may be used to endorse or promote products derived from this software
  18  *    without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30  * SUCH DAMAGE.
  31  *
  32  *      @(#)mbuf.h      8.5 (Berkeley) 2/19/95
  33  * $FreeBSD$
  34  */
  35
  36 #ifndef _SYS_MBUF_H_
  37 #define _SYS_MBUF_H_
  38
  39 /* XXX: These includes suck. Sorry! */
  40 #include <sys/queue.h>
  41 #ifdef _KERNEL
  42 #include <sys/systm.h>
  43 #include <vm/uma.h>
  44 #ifdef WITNESS
  45 #include <sys/lock.h>
  46 #endif
  47 #endif
  48
  49 #ifdef _KERNEL
  50 #include <sys/sdt.h>
  51
  52 #define MBUF_PROBE1(probe, arg0)                                        \
  53         SDT_PROBE1(sdt, , , probe, arg0)
  54 #define MBUF_PROBE2(probe, arg0, arg1)                                  \
  55         SDT_PROBE2(sdt, , , probe, arg0, arg1)
  56 #define MBUF_PROBE3(probe, arg0, arg1, arg2)                            \
  57         SDT_PROBE3(sdt, , , probe, arg0, arg1, arg2)
  58 #define MBUF_PROBE4(probe, arg0, arg1, arg2, arg3)                      \
  59         SDT_PROBE4(sdt, , , probe, arg0, arg1, arg2, arg3)
  60 #define MBUF_PROBE5(probe, arg0, arg1, arg2, arg3, arg4)                \
  61         SDT_PROBE5(sdt, , , probe, arg0, arg1, arg2, arg3, arg4)
  62
  63 SDT_PROBE_DECLARE(sdt, , , m__init);
  64 SDT_PROBE_DECLARE(sdt, , , m__gethdr);
  65 SDT_PROBE_DECLARE(sdt, , , m__get);
  66 SDT_PROBE_DECLARE(sdt, , , m__getcl);
  67 SDT_PROBE_DECLARE(sdt, , , m__getjcl);
  68 SDT_PROBE_DECLARE(sdt, , , m__clget);
  69 SDT_PROBE_DECLARE(sdt, , , m__cljget);
  70 SDT_PROBE_DECLARE(sdt, , , m__cljset);
  71 SDT_PROBE_DECLARE(sdt, , , m__free);
  72 SDT_PROBE_DECLARE(sdt, , , m__freem);
  73
  74 #endif /* _KERNEL */
  75
  76 /*
  77  * Mbufs are of a single size, MSIZE (sys/param.h), which includes overhead.
  78  * An mbuf may add a single "mbuf cluster" of size MCLBYTES (also in
  79  * sys/param.h), which has no additional overhead and is used instead of the
  80  * internal data area; this is done when at least MINCLSIZE of data must be
  81  * stored.  Additionally, it is possible to allocate a separate buffer
  82  * externally and attach it to the mbuf in a way similar to that of mbuf
  83  * clusters.
  84  *
  85  * NB: These calculation do not take actual compiler-induced alignment and
  86  * padding inside the complete struct mbuf into account.  Appropriate
  87  * attention is required when changing members of struct mbuf.
  88  *
  89  * MLEN is data length in a normal mbuf.
  90  * MHLEN is data length in an mbuf with pktheader.
  91  * MINCLSIZE is a smallest amount of data that should be put into cluster.
  92  *
  93  * Compile-time assertions in uipc_mbuf.c test these values to ensure that
  94  * they are sensible.
  95  */
  96 struct mbuf;
  97 #define MHSIZE          offsetof(struct mbuf, m_dat)
  98 #define MPKTHSIZE       offsetof(struct mbuf, m_pktdat)
  99 #define MLEN            ((int)(MSIZE - MHSIZE))
 100 #define MHLEN           ((int)(MSIZE - MPKTHSIZE))
 101 #define MINCLSIZE       (MHLEN + 1)
 102
 103 #ifdef _KERNEL
 104 /*-
 105  * Macro for type conversion: convert mbuf pointer to data pointer of correct
 106  * type:
 107  *
 108  * mtod(m, t)   -- Convert mbuf pointer to data pointer of correct type.
 109  * mtodo(m, o) -- Same as above but with offset 'o' into data.
 110  */
 111 #define mtod(m, t)      ((t)((m)->m_data))
 112 #define mtodo(m, o)     ((void *)(((m)->m_data) + (o)))
 113
 114 /*
 115  * Argument structure passed to UMA routines during mbuf and packet
 116  * allocations.
 117  */
 118 struct mb_args {
 119         int     flags;  /* Flags for mbuf being allocated */
 120         short   type;   /* Type of mbuf being allocated */
 121 };
 122 #endif /* _KERNEL */
 123
 124 /*
 125  * Packet tag structure (see below for details).
 126  */
 127 struct m_tag {
 128         SLIST_ENTRY(m_tag)      m_tag_link;     /* List of packet tags */
 129         u_int16_t               m_tag_id;       /* Tag ID */
 130         u_int16_t               m_tag_len;      /* Length of data */
 131         u_int32_t               m_tag_cookie;   /* ABI/Module ID */
 132         void                    (*m_tag_free)(struct m_tag *);
 133 };
 134
 135 /*
 136  * Static network interface owned tag.
 137  * Allocated through ifp->if_snd_tag_alloc().
 138  */
 139 struct m_snd_tag {
 140         struct ifnet *ifp;              /* network interface tag belongs to */
 141 };
 142
 143 /*
 144  * Record/packet header in first mbuf of chain; valid only if M_PKTHDR is set.
 145  * Size ILP32: 48
 146  *       LP64: 56
 147  * Compile-time assertions in uipc_mbuf.c test these values to ensure that
 148  * they are correct.
 149  */
 150 struct pkthdr {
 151         union {
 152                 struct m_snd_tag *snd_tag;      /* send tag, if any */
 153                 struct ifnet    *rcvif;         /* rcv interface */
 154         };
 155         SLIST_HEAD(packet_tags, m_tag) tags; /* list of packet tags */
 156         int32_t          len;           /* total packet length */
 157
 158         /* Layer crossing persistent information. */
 159         uint32_t         flowid;        /* packet's 4-tuple system */
 160         uint32_t         csum_flags;    /* checksum and offload features */
 161         uint16_t         fibnum;        /* this packet should use this fib */
 162         uint8_t          cosqos;        /* class/quality of service */
 163         uint8_t          rsstype;       /* hash type */
 164         union {
 165                 uint64_t        rcv_tstmp;      /* timestamp in ns */
 166                 struct {
 167                         uint8_t          l2hlen;        /* layer 2 hdr len */
 168                         uint8_t          l3hlen;        /* layer 3 hdr len */
 169                         uint8_t          l4hlen;        /* layer 4 hdr len */
 170                         uint8_t          l5hlen;        /* layer 5 hdr len */
 171                         uint32_t         spare;
 172                 };
 173         };
 174         union {
 175                 uint8_t  eight[8];
 176                 uint16_t sixteen[4];
 177                 uint32_t thirtytwo[2];
 178                 uint64_t sixtyfour[1];
 179                 uintptr_t unintptr[1];
 180                 void    *ptr;
 181         } PH_per;
 182
 183         /* Layer specific non-persistent local storage for reassembly, etc. */
 184         union {
 185                 uint8_t  eight[8];
 186                 uint16_t sixteen[4];
 187                 uint32_t thirtytwo[2];
 188                 uint64_t sixtyfour[1];
 189                 uintptr_t unintptr[1];
 190                 void    *ptr;
 191         } PH_loc;
 192 };
 193 #define ether_vtag      PH_per.sixteen[0]
 194 #define PH_vt           PH_per
 195 #define vt_nrecs        sixteen[0]
 196 #define tso_segsz       PH_per.sixteen[1]
 197 #define lro_nsegs       tso_segsz
 198 #define csum_phsum      PH_per.sixteen[2]
 199 #define csum_data       PH_per.thirtytwo[1]
 200 #define pace_thoff      PH_loc.sixteen[0]
 201 #define pace_tlen       PH_loc.sixteen[1]
 202 #define pace_drphdrlen  PH_loc.sixteen[2]
 203 #define pace_tos        PH_loc.eight[6]
 204 #define pace_lock       PH_loc.eight[7]
 205
 206 /*
 207  * Description of external storage mapped into mbuf; valid only if M_EXT is
 208  * set.
 209  * Size ILP32: 28
 210  *       LP64: 48
 211  * Compile-time assertions in uipc_mbuf.c test these values to ensure that
 212  * they are correct.
 213  */
 214 typedef void m_ext_free_t(struct mbuf *);
 215 struct m_ext {
 216         union {
 217                 /*
 218                  * If EXT_FLAG_EMBREF is set, then we use refcount in the
 219                  * mbuf, the 'ext_count' member.  Otherwise, we have a
 220                  * shadow copy and we use pointer 'ext_cnt'.  The original
 221                  * mbuf is responsible to carry the pointer to free routine
 222                  * and its arguments.  They aren't copied into shadows in
 223                  * mb_dupcl() to avoid dereferencing next cachelines.
 224                  */
 225                 volatile u_int   ext_count;
 226                 volatile u_int  *ext_cnt;
 227         };
 228         char            *ext_buf;       /* start of buffer */
 229         uint32_t         ext_size;      /* size of buffer, for ext_free */
 230         uint32_t         ext_type:8,    /* type of external storage */
 231                          ext_flags:24;  /* external storage mbuf flags */
 232         /*
 233          * Fields below store the free context for the external storage.
 234          * They are valid only in the refcount carrying mbuf, the one with
 235          * EXT_FLAG_EMBREF flag, with exclusion for EXT_EXTREF type, where
 236          * the free context is copied into all mbufs that use same external
 237          * storage.
 238          */
 239 #define m_ext_copylen   offsetof(struct m_ext, ext_free)
 240         m_ext_free_t    *ext_free;      /* free routine if not the usual */
 241         void            *ext_arg1;      /* optional argument pointer */
 242         void            *ext_arg2;      /* optional argument pointer */
 243 };
 244
 245 /*
 246  * The core of the mbuf object along with some shortcut defines for practical
 247  * purposes.
 248  */
 249 struct mbuf {
 250         /*
 251          * Header present at the beginning of every mbuf.
 252          * Size ILP32: 24
 253          *      LP64: 32
 254          * Compile-time assertions in uipc_mbuf.c test these values to ensure
 255          * that they are correct.
 256          */
 257         union { /* next buffer in chain */
 258                 struct mbuf             *m_next;
 259                 SLIST_ENTRY(mbuf)       m_slist;
 260                 STAILQ_ENTRY(mbuf)      m_stailq;
 261         };
 262         union { /* next chain in queue/record */
 263                 struct mbuf             *m_nextpkt;
 264                 SLIST_ENTRY(mbuf)       m_slistpkt;
 265                 STAILQ_ENTRY(mbuf)      m_stailqpkt;
 266         };
 267         caddr_t          m_data;        /* location of data */
 268         int32_t          m_len;         /* amount of data in this mbuf */
 269         uint32_t         m_type:8,      /* type of data in this mbuf */
 270                          m_flags:24;    /* flags; see below */
 271 #if !defined(__LP64__)
 272         uint32_t         m_pad;         /* pad for 64bit alignment */
 273 #endif
 274
 275         /*
 276          * A set of optional headers (packet header, external storage header)
 277          * and internal data storage.  Historically, these arrays were sized
 278          * to MHLEN (space left after a packet header) and MLEN (space left
 279          * after only a regular mbuf header); they are now variable size in
 280          * order to support future work on variable-size mbufs.
 281          */
 282         union {
 283                 struct {
 284                         struct pkthdr   m_pkthdr;       /* M_PKTHDR set */
 285                         union {
 286                                 struct m_ext    m_ext;  /* M_EXT set */
 287                                 char            m_pktdat[0];
 288                         };
 289                 };
 290                 char    m_dat[0];                       /* !M_PKTHDR, !M_EXT */
 291         };
 292 };
 293
 294 /*
 295  * mbuf flags of global significance and layer crossing.
 296  * Those of only protocol/layer specific significance are to be mapped
 297  * to M_PROTO[1-12] and cleared at layer handoff boundaries.
 298  * NB: Limited to the lower 24 bits.
 299  */
 300 #define M_EXT           0x00000001 /* has associated external storage */
 301 #define M_PKTHDR        0x00000002 /* start of record */
 302 #define M_EOR           0x00000004 /* end of record */
 303 #define M_RDONLY        0x00000008 /* associated data is marked read-only */
 304 #define M_BCAST         0x00000010 /* send/received as link-level broadcast */
 305 #define M_MCAST         0x00000020 /* send/received as link-level multicast */
 306 #define M_PROMISC       0x00000040 /* packet was not for us */
 307 #define M_VLANTAG       0x00000080 /* ether_vtag is valid */
 308 #define M_NOMAP         0x00000100 /* mbuf data is unmapped (soon from Drew) */
 309 #define M_NOFREE        0x00000200 /* do not free mbuf, embedded in cluster */
 310 #define M_TSTMP         0x00000400 /* rcv_tstmp field is valid */
 311 #define M_TSTMP_HPREC   0x00000800 /* rcv_tstmp is high-prec, typically
 312                                       hw-stamped on port (useful for IEEE 1588
 313                                       and 802.1AS) */
 314 #define M_TSTMP_LRO     0x00001000 /* Time LRO pushed in pkt is valid in (PH_loc) */
 315
 316 #define M_PROTO1        0x00001000 /* protocol-specific */
 317 #define M_PROTO2        0x00002000 /* protocol-specific */
 318 #define M_PROTO3        0x00004000 /* protocol-specific */
 319 #define M_PROTO4        0x00008000 /* protocol-specific */
 320 #define M_PROTO5        0x00010000 /* protocol-specific */
 321 #define M_PROTO6        0x00020000 /* protocol-specific */
 322 #define M_PROTO7        0x00040000 /* protocol-specific */
 323 #define M_PROTO8        0x00080000 /* protocol-specific */
 324 #define M_PROTO9        0x00100000 /* protocol-specific */
 325 #define M_PROTO10       0x00200000 /* protocol-specific */
 326 #define M_PROTO11       0x00400000 /* protocol-specific */
 327 #define M_PROTO12       0x00800000 /* protocol-specific */
 328
 329 #define MB_DTOR_SKIP    0x1     /* don't pollute the cache by touching a freed mbuf */
 330
 331 /*
 332  * Flags to purge when crossing layers.
 333  */
 334 #define M_PROTOFLAGS \
 335     (M_PROTO1|M_PROTO2|M_PROTO3|M_PROTO4|M_PROTO5|M_PROTO6|M_PROTO7|M_PROTO8|\
 336      M_PROTO9|M_PROTO10|M_PROTO11|M_PROTO12)
 337
 338 /*
 339  * Flags preserved when copying m_pkthdr.
 340  */
 341 #define M_COPYFLAGS \
 342     (M_PKTHDR|M_EOR|M_RDONLY|M_BCAST|M_MCAST|M_PROMISC|M_VLANTAG|M_TSTMP| \
 343      M_TSTMP_HPREC|M_PROTOFLAGS)
 344
 345 /*
 346  * Mbuf flag description for use with printf(9) %b identifier.
 347  */
 348 #define M_FLAG_BITS \
 349     "\20\1M_EXT\2M_PKTHDR\3M_EOR\4M_RDONLY\5M_BCAST\6M_MCAST" \
 350     "\7M_PROMISC\10M_VLANTAG\13M_TSTMP\14M_TSTMP_HPREC"
 351 #define M_FLAG_PROTOBITS \
 352     "\15M_PROTO1\16M_PROTO2\17M_PROTO3\20M_PROTO4\21M_PROTO5" \
 353     "\22M_PROTO6\23M_PROTO7\24M_PROTO8\25M_PROTO9\26M_PROTO10" \
 354     "\27M_PROTO11\30M_PROTO12"
 355 #define M_FLAG_PRINTF (M_FLAG_BITS M_FLAG_PROTOBITS)
 356
 357 /*
 358  * Network interface cards are able to hash protocol fields (such as IPv4
 359  * addresses and TCP port numbers) classify packets into flows.  These flows
 360  * can then be used to maintain ordering while delivering packets to the OS
 361  * via parallel input queues, as well as to provide a stateless affinity
 362  * model.  NIC drivers can pass up the hash via m->m_pkthdr.flowid, and set
 363  * m_flag fields to indicate how the hash should be interpreted by the
 364  * network stack.
 365  *
 366  * Most NICs support RSS, which provides ordering and explicit affinity, and
 367  * use the hash m_flag bits to indicate what header fields were covered by
 368  * the hash.  M_HASHTYPE_OPAQUE and M_HASHTYPE_OPAQUE_HASH can be set by non-
 369  * RSS cards or configurations that provide an opaque flow identifier, allowing
 370  * for ordering and distribution without explicit affinity.  Additionally,
 371  * M_HASHTYPE_OPAQUE_HASH indicates that the flow identifier has hash
 372  * properties.
 373  *
 374  * The meaning of the IPV6_EX suffix:
 375  * "o  Home address from the home address option in the IPv6 destination
 376  *     options header.  If the extension header is not present, use the Source
 377  *     IPv6 Address.
 378  *  o  IPv6 address that is contained in the Routing-Header-Type-2 from the
 379  *     associated extension header.  If the extension header is not present,
 380  *     use the Destination IPv6 Address."
 381  * Quoted from:
 382  * https://docs.microsoft.com/en-us/windows-hardware/drivers/network/rss-hashing-types#ndishashipv6ex
 383  */
 384 #define M_HASHTYPE_HASHPROP             0x80    /* has hash properties */
 385 #define M_HASHTYPE_HASH(t)              (M_HASHTYPE_HASHPROP | (t))
 386 /* Microsoft RSS standard hash types */
 387 #define M_HASHTYPE_NONE                 0
 388 #define M_HASHTYPE_RSS_IPV4             M_HASHTYPE_HASH(1) /* IPv4 2-tuple */
 389 #define M_HASHTYPE_RSS_TCP_IPV4         M_HASHTYPE_HASH(2) /* TCPv4 4-tuple */
 390 #define M_HASHTYPE_RSS_IPV6             M_HASHTYPE_HASH(3) /* IPv6 2-tuple */
 391 #define M_HASHTYPE_RSS_TCP_IPV6         M_HASHTYPE_HASH(4) /* TCPv6 4-tuple */
 392 #define M_HASHTYPE_RSS_IPV6_EX          M_HASHTYPE_HASH(5) /* IPv6 2-tuple +
 393                                                             * ext hdrs */
 394 #define M_HASHTYPE_RSS_TCP_IPV6_EX      M_HASHTYPE_HASH(6) /* TCPv6 4-tuple +
 395                                                             * ext hdrs */
 396 #define M_HASHTYPE_RSS_UDP_IPV4         M_HASHTYPE_HASH(7) /* IPv4 UDP 4-tuple*/
 397 #define M_HASHTYPE_RSS_UDP_IPV6         M_HASHTYPE_HASH(9) /* IPv6 UDP 4-tuple*/
 398 #define M_HASHTYPE_RSS_UDP_IPV6_EX      M_HASHTYPE_HASH(10)/* IPv6 UDP 4-tuple +
 399                                                             * ext hdrs */
 400
 401 #define M_HASHTYPE_OPAQUE               63      /* ordering, not affinity */
 402 #define M_HASHTYPE_OPAQUE_HASH          M_HASHTYPE_HASH(M_HASHTYPE_OPAQUE)
 403                                                 /* ordering+hash, not affinity*/
 404
 405 #define M_HASHTYPE_CLEAR(m)     ((m)->m_pkthdr.rsstype = 0)
 406 #define M_HASHTYPE_GET(m)       ((m)->m_pkthdr.rsstype)
 407 #define M_HASHTYPE_SET(m, v)    ((m)->m_pkthdr.rsstype = (v))
 408 #define M_HASHTYPE_TEST(m, v)   (M_HASHTYPE_GET(m) == (v))
 409 #define M_HASHTYPE_ISHASH(m)    (M_HASHTYPE_GET(m) & M_HASHTYPE_HASHPROP)
 410
 411 /*
 412  * COS/QOS class and quality of service tags.
 413  * It uses DSCP code points as base.
 414  */
 415 #define QOS_DSCP_CS0            0x00
 416 #define QOS_DSCP_DEF            QOS_DSCP_CS0
 417 #define QOS_DSCP_CS1            0x20
 418 #define QOS_DSCP_AF11           0x28
 419 #define QOS_DSCP_AF12           0x30
 420 #define QOS_DSCP_AF13           0x38
 421 #define QOS_DSCP_CS2            0x40
 422 #define QOS_DSCP_AF21           0x48
 423 #define QOS_DSCP_AF22           0x50
 424 #define QOS_DSCP_AF23           0x58
 425 #define QOS_DSCP_CS3            0x60
 426 #define QOS_DSCP_AF31           0x68
 427 #define QOS_DSCP_AF32           0x70
 428 #define QOS_DSCP_AF33           0x78
 429 #define QOS_DSCP_CS4            0x80
 430 #define QOS_DSCP_AF41           0x88
 431 #define QOS_DSCP_AF42           0x90
 432 #define QOS_DSCP_AF43           0x98
 433 #define QOS_DSCP_CS5            0xa0
 434 #define QOS_DSCP_EF             0xb8
 435 #define QOS_DSCP_CS6            0xc0
 436 #define QOS_DSCP_CS7            0xe0
 437
 438 /*
 439  * External mbuf storage buffer types.
 440  */
 441 #define EXT_CLUSTER     1       /* mbuf cluster */
 442 #define EXT_SFBUF       2       /* sendfile(2)'s sf_buf */
 443 #define EXT_JUMBOP      3       /* jumbo cluster page sized */
 444 #define EXT_JUMBO9      4       /* jumbo cluster 9216 bytes */
 445 #define EXT_JUMBO16     5       /* jumbo cluster 16184 bytes */
 446 #define EXT_PACKET      6       /* mbuf+cluster from packet zone */
 447 #define EXT_MBUF        7       /* external mbuf reference */
 448
 449 #define EXT_VENDOR1     224     /* for vendor-internal use */
 450 #define EXT_VENDOR2     225     /* for vendor-internal use */
 451 #define EXT_VENDOR3     226     /* for vendor-internal use */
 452 #define EXT_VENDOR4     227     /* for vendor-internal use */
 453
 454 #define EXT_EXP1        244     /* for experimental use */
 455 #define EXT_EXP2        245     /* for experimental use */
 456 #define EXT_EXP3        246     /* for experimental use */
 457 #define EXT_EXP4        247     /* for experimental use */
 458
 459 #define EXT_NET_DRV     252     /* custom ext_buf provided by net driver(s) */
 460 #define EXT_MOD_TYPE    253     /* custom module's ext_buf type */
 461 #define EXT_DISPOSABLE  254     /* can throw this buffer away w/page flipping */
 462 #define EXT_EXTREF      255     /* has externally maintained ext_cnt ptr */
 463
 464 /*
 465  * Flags for external mbuf buffer types.
 466  * NB: limited to the lower 24 bits.
 467  */
 468 #define EXT_FLAG_EMBREF         0x000001        /* embedded ext_count */
 469 #define EXT_FLAG_EXTREF         0x000002        /* external ext_cnt, notyet */
 470
 471 #define EXT_FLAG_NOFREE         0x000010        /* don't free mbuf to pool, notyet */
 472
 473 #define EXT_FLAG_VENDOR1        0x010000        /* These flags are vendor */
 474 #define EXT_FLAG_VENDOR2        0x020000        /* or submodule specific, */
 475 #define EXT_FLAG_VENDOR3        0x040000        /* not used by mbuf code. */
 476 #define EXT_FLAG_VENDOR4        0x080000        /* Set/read by submodule. */
 477
 478 #define EXT_FLAG_EXP1           0x100000        /* for experimental use */
 479 #define EXT_FLAG_EXP2           0x200000        /* for experimental use */
 480 #define EXT_FLAG_EXP3           0x400000        /* for experimental use */
 481 #define EXT_FLAG_EXP4           0x800000        /* for experimental use */
 482
 483 /*
 484  * EXT flag description for use with printf(9) %b identifier.
 485  */
 486 #define EXT_FLAG_BITS \
 487     "\20\1EXT_FLAG_EMBREF\2EXT_FLAG_EXTREF\5EXT_FLAG_NOFREE" \
 488     "\21EXT_FLAG_VENDOR1\22EXT_FLAG_VENDOR2\23EXT_FLAG_VENDOR3" \
 489     "\24EXT_FLAG_VENDOR4\25EXT_FLAG_EXP1\26EXT_FLAG_EXP2\27EXT_FLAG_EXP3" \
 490     "\30EXT_FLAG_EXP4"
 491
 492 /*
 493  * Flags indicating checksum, segmentation and other offload work to be
 494  * done, or already done, by hardware or lower layers.  It is split into
 495  * separate inbound and outbound flags.
 496  *
 497  * Outbound flags that are set by upper protocol layers requesting lower
 498  * layers, or ideally the hardware, to perform these offloading tasks.
 499  * For outbound packets this field and its flags can be directly tested
 500  * against ifnet if_hwassist.
 501  */
 502 #define CSUM_IP                 0x00000001      /* IP header checksum offload */
 503 #define CSUM_IP_UDP             0x00000002      /* UDP checksum offload */
 504 #define CSUM_IP_TCP             0x00000004      /* TCP checksum offload */
 505 #define CSUM_IP_SCTP            0x00000008      /* SCTP checksum offload */
 506 #define CSUM_IP_TSO             0x00000010      /* TCP segmentation offload */
 507 #define CSUM_IP_ISCSI           0x00000020      /* iSCSI checksum offload */
 508
 509 #define CSUM_IP6_UDP            0x00000200      /* UDP checksum offload */
 510 #define CSUM_IP6_TCP            0x00000400      /* TCP checksum offload */
 511 #define CSUM_IP6_SCTP           0x00000800      /* SCTP checksum offload */
 512 #define CSUM_IP6_TSO            0x00001000      /* TCP segmentation offload */
 513 #define CSUM_IP6_ISCSI          0x00002000      /* iSCSI checksum offload */
 514
 515 /* Inbound checksum support where the checksum was verified by hardware. */
 516 #define CSUM_L3_CALC            0x01000000      /* calculated layer 3 csum */
 517 #define CSUM_L3_VALID           0x02000000      /* checksum is correct */
 518 #define CSUM_L4_CALC            0x04000000      /* calculated layer 4 csum */
 519 #define CSUM_L4_VALID           0x08000000      /* checksum is correct */
 520 #define CSUM_L5_CALC            0x10000000      /* calculated layer 5 csum */
 521 #define CSUM_L5_VALID           0x20000000      /* checksum is correct */
 522 #define CSUM_COALESCED          0x40000000      /* contains merged segments */
 523
 524 #define CSUM_SND_TAG            0x80000000      /* Packet header has send tag */
 525
 526 /*
 527  * CSUM flag description for use with printf(9) %b identifier.
 528  */
 529 #define CSUM_BITS \
 530     "\20\1CSUM_IP\2CSUM_IP_UDP\3CSUM_IP_TCP\4CSUM_IP_SCTP\5CSUM_IP_TSO" \
 531     "\6CSUM_IP_ISCSI" \
 532     "\12CSUM_IP6_UDP\13CSUM_IP6_TCP\14CSUM_IP6_SCTP\15CSUM_IP6_TSO" \
 533     "\16CSUM_IP6_ISCSI" \
 534     "\31CSUM_L3_CALC\32CSUM_L3_VALID\33CSUM_L4_CALC\34CSUM_L4_VALID" \
 535     "\35CSUM_L5_CALC\36CSUM_L5_VALID\37CSUM_COALESCED\40CSUM_SND_TAG"
 536
 537 /* CSUM flags compatibility mappings. */
 538 #define CSUM_IP_CHECKED         CSUM_L3_CALC
 539 #define CSUM_IP_VALID           CSUM_L3_VALID
 540 #define CSUM_DATA_VALID         CSUM_L4_VALID
 541 #define CSUM_PSEUDO_HDR         CSUM_L4_CALC
 542 #define CSUM_SCTP_VALID         CSUM_L4_VALID
 543 #define CSUM_DELAY_DATA         (CSUM_TCP|CSUM_UDP)
 544 #define CSUM_DELAY_IP           CSUM_IP         /* Only v4, no v6 IP hdr csum */
 545 #define CSUM_DELAY_DATA_IPV6    (CSUM_TCP_IPV6|CSUM_UDP_IPV6)
 546 #define CSUM_DATA_VALID_IPV6    CSUM_DATA_VALID
 547 #define CSUM_TCP                CSUM_IP_TCP
 548 #define CSUM_UDP                CSUM_IP_UDP
 549 #define CSUM_SCTP               CSUM_IP_SCTP
 550 #define CSUM_TSO                (CSUM_IP_TSO|CSUM_IP6_TSO)
 551 #define CSUM_UDP_IPV6           CSUM_IP6_UDP
 552 #define CSUM_TCP_IPV6           CSUM_IP6_TCP
 553 #define CSUM_SCTP_IPV6          CSUM_IP6_SCTP
 554
 555 /*
 556  * mbuf types describing the content of the mbuf (including external storage).
 557  */
 558 #define MT_NOTMBUF      0       /* USED INTERNALLY ONLY! Object is not mbuf */
 559 #define MT_DATA         1       /* dynamic (data) allocation */
 560 #define MT_HEADER       MT_DATA /* packet header, use M_PKTHDR instead */
 561
 562 #define MT_VENDOR1      4       /* for vendor-internal use */
 563 #define MT_VENDOR2      5       /* for vendor-internal use */
 564 #define MT_VENDOR3      6       /* for vendor-internal use */
 565 #define MT_VENDOR4      7       /* for vendor-internal use */
 566
 567 #define MT_SONAME       8       /* socket name */
 568
 569 #define MT_EXP1         9       /* for experimental use */
 570 #define MT_EXP2         10      /* for experimental use */
 571 #define MT_EXP3         11      /* for experimental use */
 572 #define MT_EXP4         12      /* for experimental use */
 573
 574 #define MT_CONTROL      14      /* extra-data protocol message */
 575 #define MT_EXTCONTROL   15      /* control message with externalized contents */
 576 #define MT_OOBDATA      16      /* expedited data  */
 577
 578 #define MT_NOINIT       255     /* Not a type but a flag to allocate
 579                                    a non-initialized mbuf */
 580
 581 /*
 582  * String names of mbuf-related UMA(9) and malloc(9) types.  Exposed to
 583  * !_KERNEL so that monitoring tools can look up the zones with
 584  * libmemstat(3).
 585  */
 586 #define MBUF_MEM_NAME           "mbuf"
 587 #define MBUF_CLUSTER_MEM_NAME   "mbuf_cluster"
 588 #define MBUF_PACKET_MEM_NAME    "mbuf_packet"
 589 #define MBUF_JUMBOP_MEM_NAME    "mbuf_jumbo_page"
 590 #define MBUF_JUMBO9_MEM_NAME    "mbuf_jumbo_9k"
 591 #define MBUF_JUMBO16_MEM_NAME   "mbuf_jumbo_16k"
 592 #define MBUF_TAG_MEM_NAME       "mbuf_tag"
 593 #define MBUF_EXTREFCNT_MEM_NAME "mbuf_ext_refcnt"
 594
 595 #ifdef _KERNEL
 596
 597 #ifdef WITNESS
 598 #define MBUF_CHECKSLEEP(how) do {                                       \
 599         if (how == M_WAITOK)                                            \
 600                 WITNESS_WARN(WARN_GIANTOK | WARN_SLEEPOK, NULL,         \
 601                     "Sleeping in \"%s\"", __func__);                    \
 602 } while (0)
 603 #else
 604 #define MBUF_CHECKSLEEP(how)
 605 #endif
 606
 607 /*
 608  * Network buffer allocation API
 609  *
 610  * The rest of it is defined in kern/kern_mbuf.c
 611  */
 612 extern uma_zone_t       zone_mbuf;
 613 extern uma_zone_t       zone_clust;
 614 extern uma_zone_t       zone_pack;
 615 extern uma_zone_t       zone_jumbop;
 616 extern uma_zone_t       zone_jumbo9;
 617 extern uma_zone_t       zone_jumbo16;
 618
 619 void             mb_dupcl(struct mbuf *, struct mbuf *);
 620 void             mb_free_ext(struct mbuf *);
 621 void             m_adj(struct mbuf *, int);
 622 int              m_apply(struct mbuf *, int, int,
 623                     int (*)(void *, void *, u_int), void *);
 624 int              m_append(struct mbuf *, int, c_caddr_t);
 625 void             m_cat(struct mbuf *, struct mbuf *);
 626 void             m_catpkt(struct mbuf *, struct mbuf *);
 627 int              m_clget(struct mbuf *m, int how);
 628 void            *m_cljget(struct mbuf *m, int how, int size);
 629 struct mbuf     *m_collapse(struct mbuf *, int, int);
 630 void             m_copyback(struct mbuf *, int, int, c_caddr_t);
 631 void             m_copydata(const struct mbuf *, int, int, caddr_t);
 632 struct mbuf     *m_copym(struct mbuf *, int, int, int);
 633 struct mbuf     *m_copypacket(struct mbuf *, int);
 634 void             m_copy_pkthdr(struct mbuf *, struct mbuf *);
 635 struct mbuf     *m_copyup(struct mbuf *, int, int);
 636 struct mbuf     *m_defrag(struct mbuf *, int);
 637 void             m_demote_pkthdr(struct mbuf *);
 638 void             m_demote(struct mbuf *, int, int);
 639 struct mbuf     *m_devget(char *, int, int, struct ifnet *,
 640                     void (*)(char *, caddr_t, u_int));
 641 void             m_dispose_extcontrolm(struct mbuf *m);
 642 struct mbuf     *m_dup(const struct mbuf *, int);
 643 int              m_dup_pkthdr(struct mbuf *, const struct mbuf *, int);
 644 void             m_extadd(struct mbuf *, char *, u_int, m_ext_free_t,
 645                     void *, void *, int, int);
 646 u_int            m_fixhdr(struct mbuf *);
 647 struct mbuf     *m_fragment(struct mbuf *, int, int);
 648 void             m_freem(struct mbuf *);
 649 struct mbuf     *m_get2(int, int, short, int);
 650 struct mbuf     *m_getjcl(int, short, int, int);
 651 struct mbuf     *m_getm2(struct mbuf *, int, int, short, int);
 652 struct mbuf     *m_getptr(struct mbuf *, int, int *);
 653 u_int            m_length(struct mbuf *, struct mbuf **);
 654 int              m_mbuftouio(struct uio *, const struct mbuf *, int);
 655 void             m_move_pkthdr(struct mbuf *, struct mbuf *);
 656 int              m_pkthdr_init(struct mbuf *, int);
 657 struct mbuf     *m_prepend(struct mbuf *, int, int);
 658 void             m_print(const struct mbuf *, int);
 659 struct mbuf     *m_pulldown(struct mbuf *, int, int, int *);
 660 struct mbuf     *m_pullup(struct mbuf *, int);
 661 int              m_sanity(struct mbuf *, int);
 662 struct mbuf     *m_split(struct mbuf *, int, int);
 663 struct mbuf     *m_uiotombuf(struct uio *, int, int, int, int);
 664 struct mbuf     *m_unshare(struct mbuf *, int);
 665
 666 static __inline int
 667 m_gettype(int size)
 668 {
 669         int type;
 670
 671         switch (size) {
 672         case MSIZE:
 673                 type = EXT_MBUF;
 674                 break;
 675         case MCLBYTES:
 676                 type = EXT_CLUSTER;
 677                 break;
 678 #if MJUMPAGESIZE != MCLBYTES
 679         case MJUMPAGESIZE:
 680                 type = EXT_JUMBOP;
 681                 break;
 682 #endif
 683         case MJUM9BYTES:
 684                 type = EXT_JUMBO9;
 685                 break;
 686         case MJUM16BYTES:
 687                 type = EXT_JUMBO16;
 688                 break;
 689         default:
 690                 panic("%s: invalid cluster size %d", __func__, size);
 691         }
 692
 693         return (type);
 694 }
 695
 696 /*
 697  * Associated an external reference counted buffer with an mbuf.
 698  */
 699 static __inline void
 700 m_extaddref(struct mbuf *m, char *buf, u_int size, u_int *ref_cnt,
 701     m_ext_free_t freef, void *arg1, void *arg2)
 702 {
 703
 704         KASSERT(ref_cnt != NULL, ("%s: ref_cnt not provided", __func__));
 705
 706         atomic_add_int(ref_cnt, 1);
 707         m->m_flags |= M_EXT;
 708         m->m_ext.ext_buf = buf;
 709         m->m_ext.ext_cnt = ref_cnt;
 710         m->m_data = m->m_ext.ext_buf;
 711         m->m_ext.ext_size = size;
 712         m->m_ext.ext_free = freef;
 713         m->m_ext.ext_arg1 = arg1;
 714         m->m_ext.ext_arg2 = arg2;
 715         m->m_ext.ext_type = EXT_EXTREF;
 716         m->m_ext.ext_flags = 0;
 717 }
 718
 719 static __inline uma_zone_t
 720 m_getzone(int size)
 721 {
 722         uma_zone_t zone;
 723
 724         switch (size) {
 725         case MCLBYTES:
 726                 zone = zone_clust;
 727                 break;
 728 #if MJUMPAGESIZE != MCLBYTES
 729         case MJUMPAGESIZE:
 730                 zone = zone_jumbop;
 731                 break;
 732 #endif
 733         case MJUM9BYTES:
 734                 zone = zone_jumbo9;
 735                 break;
 736         case MJUM16BYTES:
 737                 zone = zone_jumbo16;
 738                 break;
 739         default:
 740                 panic("%s: invalid cluster size %d", __func__, size);
 741         }
 742
 743         return (zone);
 744 }
 745
 746 /*
 747  * Initialize an mbuf with linear storage.
 748  *
 749  * Inline because the consumer text overhead will be roughly the same to
 750  * initialize or call a function with this many parameters and M_PKTHDR
 751  * should go away with constant propagation for !MGETHDR.
 752  */
 753 static __inline int
 754 m_init(struct mbuf *m, int how, short type, int flags)
 755 {
 756         int error;
 757
 758         m->m_next = NULL;
 759         m->m_nextpkt = NULL;
 760         m->m_data = m->m_dat;
 761         m->m_len = 0;
 762         m->m_flags = flags;
 763         m->m_type = type;
 764         if (flags & M_PKTHDR)
 765                 error = m_pkthdr_init(m, how);
 766         else
 767                 error = 0;
 768
 769         MBUF_PROBE5(m__init, m, how, type, flags, error);
 770         return (error);
 771 }
 772
 773 static __inline struct mbuf *
 774 m_get(int how, short type)
 775 {
 776         struct mbuf *m;
 777         struct mb_args args;
 778
 779         args.flags = 0;
 780         args.type = type;
 781         m = uma_zalloc_arg(zone_mbuf, &args, how);
 782         MBUF_PROBE3(m__get, how, type, m);
 783         return (m);
 784 }
 785
 786 static __inline struct mbuf *
 787 m_gethdr(int how, short type)
 788 {
 789         struct mbuf *m;
 790         struct mb_args args;
 791
 792         args.flags = M_PKTHDR;
 793         args.type = type;
 794         m = uma_zalloc_arg(zone_mbuf, &args, how);
 795         MBUF_PROBE3(m__gethdr, how, type, m);
 796         return (m);
 797 }
 798
 799 static __inline struct mbuf *
 800 m_getcl(int how, short type, int flags)
 801 {
 802         struct mbuf *m;
 803         struct mb_args args;
 804
 805         args.flags = flags;
 806         args.type = type;
 807         m = uma_zalloc_arg(zone_pack, &args, how);
 808         MBUF_PROBE4(m__getcl, how, type, flags, m);
 809         return (m);
 810 }
 811
 812 /*
 813  * XXX: m_cljset() is a dangerous API.  One must attach only a new,
 814  * unreferenced cluster to an mbuf(9).  It is not possible to assert
 815  * that, so care can be taken only by users of the API.
 816  */
 817 static __inline void
 818 m_cljset(struct mbuf *m, void *cl, int type)
 819 {
 820         int size;
 821
 822         switch (type) {
 823         case EXT_CLUSTER:
 824                 size = MCLBYTES;
 825                 break;
 826 #if MJUMPAGESIZE != MCLBYTES
 827         case EXT_JUMBOP:
 828                 size = MJUMPAGESIZE;
 829                 break;
 830 #endif
 831         case EXT_JUMBO9:
 832                 size = MJUM9BYTES;
 833                 break;
 834         case EXT_JUMBO16:
 835                 size = MJUM16BYTES;
 836                 break;
 837         default:
 838                 panic("%s: unknown cluster type %d", __func__, type);
 839                 break;
 840         }
 841
 842         m->m_data = m->m_ext.ext_buf = cl;
 843         m->m_ext.ext_free = m->m_ext.ext_arg1 = m->m_ext.ext_arg2 = NULL;
 844         m->m_ext.ext_size = size;
 845         m->m_ext.ext_type = type;
 846         m->m_ext.ext_flags = EXT_FLAG_EMBREF;
 847         m->m_ext.ext_count = 1;
 848         m->m_flags |= M_EXT;
 849         MBUF_PROBE3(m__cljset, m, cl, type);
 850 }
 851
 852 static __inline void
 853 m_chtype(struct mbuf *m, short new_type)
 854 {
 855
 856         m->m_type = new_type;
 857 }
 858
 859 static __inline void
 860 m_clrprotoflags(struct mbuf *m)
 861 {
 862
 863         while (m) {
 864                 m->m_flags &= ~M_PROTOFLAGS;
 865                 m = m->m_next;
 866         }
 867 }
 868
 869 static __inline struct mbuf *
 870 m_last(struct mbuf *m)
 871 {
 872
 873         while (m->m_next)
 874                 m = m->m_next;
 875         return (m);
 876 }
 877
 878 static inline u_int
 879 m_extrefcnt(struct mbuf *m)
 880 {
 881
 882         KASSERT(m->m_flags & M_EXT, ("%s: M_EXT missing", __func__));
 883
 884         return ((m->m_ext.ext_flags & EXT_FLAG_EMBREF) ? m->m_ext.ext_count :
 885             *m->m_ext.ext_cnt);
 886 }
 887
 888 /*
 889  * mbuf, cluster, and external object allocation macros (for compatibility
 890  * purposes).
 891  */
 892 #define M_MOVE_PKTHDR(to, from) m_move_pkthdr((to), (from))
 893 #define MGET(m, how, type)      ((m) = m_get((how), (type)))
 894 #define MGETHDR(m, how, type)   ((m) = m_gethdr((how), (type)))
 895 #define MCLGET(m, how)          m_clget((m), (how))
 896 #define MEXTADD(m, buf, size, free, arg1, arg2, flags, type)            \
 897     m_extadd((m), (char *)(buf), (size), (free), (arg1), (arg2),        \
 898     (flags), (type))
 899 #define m_getm(m, len, how, type)                                       \
 900     m_getm2((m), (len), (how), (type), M_PKTHDR)
 901
 902 /*
 903  * Evaluate TRUE if it's safe to write to the mbuf m's data region (this can
 904  * be both the local data payload, or an external buffer area, depending on
 905  * whether M_EXT is set).
 906  */
 907 #define M_WRITABLE(m)   (!((m)->m_flags & M_RDONLY) &&                  \
 908                          (!(((m)->m_flags & M_EXT)) ||                  \
 909                          (m_extrefcnt(m) == 1)))
 910
 911 /* Check if the supplied mbuf has a packet header, or else panic. */
 912 #define M_ASSERTPKTHDR(m)                                               \
 913         KASSERT((m) != NULL && (m)->m_flags & M_PKTHDR,                 \
 914             ("%s: no mbuf packet header!", __func__))
 915
 916 /*
 917  * Ensure that the supplied mbuf is a valid, non-free mbuf.
 918  *
 919  * XXX: Broken at the moment.  Need some UMA magic to make it work again.
 920  */
 921 #define M_ASSERTVALID(m)                                                \
 922         KASSERT((((struct mbuf *)m)->m_flags & 0) == 0,                 \
 923             ("%s: attempted use of a free mbuf!", __func__))
 924
 925 /*
 926  * Return the address of the start of the buffer associated with an mbuf,
 927  * handling external storage, packet-header mbufs, and regular data mbufs.
 928  */
 929 #define M_START(m)                                                      \
 930         (((m)->m_flags & M_EXT) ? (m)->m_ext.ext_buf :                  \
 931          ((m)->m_flags & M_PKTHDR) ? &(m)->m_pktdat[0] :                \
 932          &(m)->m_dat[0])
 933
 934 /*
 935  * Return the size of the buffer associated with an mbuf, handling external
 936  * storage, packet-header mbufs, and regular data mbufs.
 937  */
 938 #define M_SIZE(m)                                                       \
 939         (((m)->m_flags & M_EXT) ? (m)->m_ext.ext_size :                 \
 940          ((m)->m_flags & M_PKTHDR) ? MHLEN :                            \
 941          MLEN)
 942
 943 /*
 944  * Set the m_data pointer of a newly allocated mbuf to place an object of the
 945  * specified size at the end of the mbuf, longword aligned.
 946  *
 947  * NB: Historically, we had M_ALIGN(), MH_ALIGN(), and MEXT_ALIGN() as
 948  * separate macros, each asserting that it was called at the proper moment.
 949  * This required callers to themselves test the storage type and call the
 950  * right one.  Rather than require callers to be aware of those layout
 951  * decisions, we centralize here.
 952  */
 953 static __inline void
 954 m_align(struct mbuf *m, int len)
 955 {
 956 #ifdef INVARIANTS
 957         const char *msg = "%s: not a virgin mbuf";
 958 #endif
 959         int adjust;
 960
 961         KASSERT(m->m_data == M_START(m), (msg, __func__));
 962
 963         adjust = M_SIZE(m) - len;
 964         m->m_data += adjust &~ (sizeof(long)-1);
 965 }
 966
 967 #define M_ALIGN(m, len)         m_align(m, len)
 968 #define MH_ALIGN(m, len)        m_align(m, len)
 969 #define MEXT_ALIGN(m, len)      m_align(m, len)
 970
 971 /*
 972  * Compute the amount of space available before the current start of data in
 973  * an mbuf.
 974  *
 975  * The M_WRITABLE() is a temporary, conservative safety measure: the burden
 976  * of checking writability of the mbuf data area rests solely with the caller.
 977  *
 978  * NB: In previous versions, M_LEADINGSPACE() would only check M_WRITABLE()
 979  * for mbufs with external storage.  We now allow mbuf-embedded data to be
 980  * read-only as well.
 981  */
 982 #define M_LEADINGSPACE(m)                                               \
 983         (M_WRITABLE(m) ? ((m)->m_data - M_START(m)) : 0)
 984
 985 /*
 986  * Compute the amount of space available after the end of data in an mbuf.
 987  *
 988  * The M_WRITABLE() is a temporary, conservative safety measure: the burden
 989  * of checking writability of the mbuf data area rests solely with the caller.
 990  *
 991  * NB: In previous versions, M_TRAILINGSPACE() would only check M_WRITABLE()
 992  * for mbufs with external storage.  We now allow mbuf-embedded data to be
 993  * read-only as well.
 994  */
 995 #define M_TRAILINGSPACE(m)                                              \
 996         (M_WRITABLE(m) ?                                                \
 997             ((M_START(m) + M_SIZE(m)) - ((m)->m_data + (m)->m_len)) : 0)
 998
 999 /*
1000  * Arrange to prepend space of size plen to mbuf m.  If a new mbuf must be
1001  * allocated, how specifies whether to wait.  If the allocation fails, the
1002  * original mbuf chain is freed and m is set to NULL.
1003  */
1004 #define M_PREPEND(m, plen, how) do {                                    \
1005         struct mbuf **_mmp = &(m);                                      \
1006         struct mbuf *_mm = *_mmp;                                       \
1007         int _mplen = (plen);                                            \
1008         int __mhow = (how);                                             \
1009                                                                         \
1010         MBUF_CHECKSLEEP(how);                                           \
1011         if (M_LEADINGSPACE(_mm) >= _mplen) {                            \
1012                 _mm->m_data -= _mplen;                                  \
1013                 _mm->m_len += _mplen;                                   \
1014         } else                                                          \
1015                 _mm = m_prepend(_mm, _mplen, __mhow);                   \
1016         if (_mm != NULL && _mm->m_flags & M_PKTHDR)                     \
1017                 _mm->m_pkthdr.len += _mplen;                            \
1018         *_mmp = _mm;                                                    \
1019 } while (0)
1020
1021 /*
1022  * Change mbuf to new type.  This is a relatively expensive operation and
1023  * should be avoided.
1024  */
1025 #define MCHTYPE(m, t)   m_chtype((m), (t))
1026
1027 /* Length to m_copy to copy all. */
1028 #define M_COPYALL       1000000000
1029
1030 extern int              max_datalen;    /* MHLEN - max_hdr */
1031 extern int              max_hdr;        /* Largest link + protocol header */
1032 extern int              max_linkhdr;    /* Largest link-level header */
1033 extern int              max_protohdr;   /* Largest protocol header */
1034 extern int              nmbclusters;    /* Maximum number of clusters */
1035
1036 /*-
1037  * Network packets may have annotations attached by affixing a list of
1038  * "packet tags" to the pkthdr structure.  Packet tags are dynamically
1039  * allocated semi-opaque data structures that have a fixed header
1040  * (struct m_tag) that specifies the size of the memory block and a
1041  * <cookie,type> pair that identifies it.  The cookie is a 32-bit unique
1042  * unsigned value used to identify a module or ABI.  By convention this value
1043  * is chosen as the date+time that the module is created, expressed as the
1044  * number of seconds since the epoch (e.g., using date -u +'%s').  The type
1045  * value is an ABI/module-specific value that identifies a particular
1046  * annotation and is private to the module.  For compatibility with systems
1047  * like OpenBSD that define packet tags w/o an ABI/module cookie, the value
1048  * PACKET_ABI_COMPAT is used to implement m_tag_get and m_tag_find
1049  * compatibility shim functions and several tag types are defined below.
1050  * Users that do not require compatibility should use a private cookie value
1051  * so that packet tag-related definitions can be maintained privately.
1052  *
1053  * Note that the packet tag returned by m_tag_alloc has the default memory
1054  * alignment implemented by malloc.  To reference private data one can use a
1055  * construct like:
1056  *
1057  *      struct m_tag *mtag = m_tag_alloc(...);
1058  *      struct foo *p = (struct foo *)(mtag+1);
1059  *
1060  * if the alignment of struct m_tag is sufficient for referencing members of
1061  * struct foo.  Otherwise it is necessary to embed struct m_tag within the
1062  * private data structure to insure proper alignment; e.g.,
1063  *
1064  *      struct foo {
1065  *              struct m_tag    tag;
1066  *              ...
1067  *      };
1068  *      struct foo *p = (struct foo *) m_tag_alloc(...);
1069  *      struct m_tag *mtag = &p->tag;
1070  */
1071
1072 /*
1073  * Persistent tags stay with an mbuf until the mbuf is reclaimed.  Otherwise
1074  * tags are expected to ``vanish'' when they pass through a network
1075  * interface.  For most interfaces this happens normally as the tags are
1076  * reclaimed when the mbuf is free'd.  However in some special cases
1077  * reclaiming must be done manually.  An example is packets that pass through
1078  * the loopback interface.  Also, one must be careful to do this when
1079  * ``turning around'' packets (e.g., icmp_reflect).
1080  *
1081  * To mark a tag persistent bit-or this flag in when defining the tag id.
1082  * The tag will then be treated as described above.
1083  */
1084 #define MTAG_PERSISTENT                         0x800
1085
1086 #define PACKET_TAG_NONE                         0  /* Nadda */
1087
1088 /* Packet tags for use with PACKET_ABI_COMPAT. */
1089 #define PACKET_TAG_IPSEC_IN_DONE                1  /* IPsec applied, in */
1090 #define PACKET_TAG_IPSEC_OUT_DONE               2  /* IPsec applied, out */
1091 #define PACKET_TAG_IPSEC_IN_CRYPTO_DONE         3  /* NIC IPsec crypto done */
1092 #define PACKET_TAG_IPSEC_OUT_CRYPTO_NEEDED      4  /* NIC IPsec crypto req'ed */
1093 #define PACKET_TAG_IPSEC_IN_COULD_DO_CRYPTO     5  /* NIC notifies IPsec */
1094 #define PACKET_TAG_IPSEC_PENDING_TDB            6  /* Reminder to do IPsec */
1095 #define PACKET_TAG_BRIDGE                       7  /* Bridge processing done */
1096 #define PACKET_TAG_GIF                          8  /* GIF processing done */
1097 #define PACKET_TAG_GRE                          9  /* GRE processing done */
1098 #define PACKET_TAG_IN_PACKET_CHECKSUM           10 /* NIC checksumming done */
1099 #define PACKET_TAG_ENCAP                        11 /* Encap.  processing */
1100 #define PACKET_TAG_IPSEC_SOCKET                 12 /* IPSEC socket ref */
1101 #define PACKET_TAG_IPSEC_HISTORY                13 /* IPSEC history */
1102 #define PACKET_TAG_IPV6_INPUT                   14 /* IPV6 input processing */
1103 #define PACKET_TAG_DUMMYNET                     15 /* dummynet info */
1104 #define PACKET_TAG_DIVERT                       17 /* divert info */
1105 #define PACKET_TAG_IPFORWARD                    18 /* ipforward info */
1106 #define PACKET_TAG_MACLABEL     (19 | MTAG_PERSISTENT) /* MAC label */
1107 #define PACKET_TAG_PF           (21 | MTAG_PERSISTENT) /* PF/ALTQ information */
1108 #define PACKET_TAG_RTSOCKFAM                    25 /* rtsock sa family */
1109 #define PACKET_TAG_IPOPTIONS                    27 /* Saved IP options */
1110 #define PACKET_TAG_CARP                         28 /* CARP info */
1111 #define PACKET_TAG_IPSEC_NAT_T_PORTS            29 /* two uint16_t */
1112 #define PACKET_TAG_ND_OUTGOING                  30 /* ND outgoing */
1113
1114 /* Specific cookies and tags. */
1115
1116 /* Packet tag routines. */
1117 struct m_tag    *m_tag_alloc(u_int32_t, int, int, int);
1118 void             m_tag_delete(struct mbuf *, struct m_tag *);
1119 void             m_tag_delete_chain(struct mbuf *, struct m_tag *);
1120 void             m_tag_free_default(struct m_tag *);
1121 struct m_tag    *m_tag_locate(struct mbuf *, u_int32_t, int, struct m_tag *);
1122 struct m_tag    *m_tag_copy(struct m_tag *, int);
1123 int              m_tag_copy_chain(struct mbuf *, const struct mbuf *, int);
1124 void             m_tag_delete_nonpersistent(struct mbuf *);
1125
1126 /*
1127  * Initialize the list of tags associated with an mbuf.
1128  */
1129 static __inline void
1130 m_tag_init(struct mbuf *m)
1131 {
1132
1133         SLIST_INIT(&m->m_pkthdr.tags);
1134 }
1135
1136 /*
1137  * Set up the contents of a tag.  Note that this does not fill in the free
1138  * method; the caller is expected to do that.
1139  *
1140  * XXX probably should be called m_tag_init, but that was already taken.
1141  */
1142 static __inline void
1143 m_tag_setup(struct m_tag *t, u_int32_t cookie, int type, int len)
1144 {
1145
1146         t->m_tag_id = type;
1147         t->m_tag_len = len;
1148         t->m_tag_cookie = cookie;
1149 }
1150
1151 /*
1152  * Reclaim resources associated with a tag.
1153  */
1154 static __inline void
1155 m_tag_free(struct m_tag *t)
1156 {
1157
1158         (*t->m_tag_free)(t);
1159 }
1160
1161 /*
1162  * Return the first tag associated with an mbuf.
1163  */
1164 static __inline struct m_tag *
1165 m_tag_first(struct mbuf *m)
1166 {
1167
1168         return (SLIST_FIRST(&m->m_pkthdr.tags));
1169 }
1170
1171 /*
1172  * Return the next tag in the list of tags associated with an mbuf.
1173  */
1174 static __inline struct m_tag *
1175 m_tag_next(struct mbuf *m __unused, struct m_tag *t)
1176 {
1177
1178         return (SLIST_NEXT(t, m_tag_link));
1179 }
1180
1181 /*
1182  * Prepend a tag to the list of tags associated with an mbuf.
1183  */
1184 static __inline void
1185 m_tag_prepend(struct mbuf *m, struct m_tag *t)
1186 {
1187
1188         SLIST_INSERT_HEAD(&m->m_pkthdr.tags, t, m_tag_link);
1189 }
1190
1191 /*
1192  * Unlink a tag from the list of tags associated with an mbuf.
1193  */
1194 static __inline void
1195 m_tag_unlink(struct mbuf *m, struct m_tag *t)
1196 {
1197
1198         SLIST_REMOVE(&m->m_pkthdr.tags, t, m_tag, m_tag_link);
1199 }
1200
1201 /* These are for OpenBSD compatibility. */
1202 #define MTAG_ABI_COMPAT         0               /* compatibility ABI */
1203
1204 static __inline struct m_tag *
1205 m_tag_get(int type, int length, int wait)
1206 {
1207         return (m_tag_alloc(MTAG_ABI_COMPAT, type, length, wait));
1208 }
1209
1210 static __inline struct m_tag *
1211 m_tag_find(struct mbuf *m, int type, struct m_tag *start)
1212 {
1213         return (SLIST_EMPTY(&m->m_pkthdr.tags) ? (struct m_tag *)NULL :
1214             m_tag_locate(m, MTAG_ABI_COMPAT, type, start));
1215 }
1216
1217 static __inline struct mbuf *
1218 m_free(struct mbuf *m)
1219 {
1220         struct mbuf *n = m->m_next;
1221
1222         MBUF_PROBE1(m__free, m);
1223         if ((m->m_flags & (M_PKTHDR|M_NOFREE)) == (M_PKTHDR|M_NOFREE))
1224                 m_tag_delete_chain(m, NULL);
1225         if (m->m_flags & M_EXT)
1226                 mb_free_ext(m);
1227         else if ((m->m_flags & M_NOFREE) == 0)
1228                 uma_zfree(zone_mbuf, m);
1229         return (n);
1230 }
1231
1232 static __inline int
1233 rt_m_getfib(struct mbuf *m)
1234 {
1235         KASSERT(m->m_flags & M_PKTHDR , ("Attempt to get FIB from non header mbuf."));
1236         return (m->m_pkthdr.fibnum);
1237 }
1238
1239 #define M_GETFIB(_m)   rt_m_getfib(_m)
1240
1241 #define M_SETFIB(_m, _fib) do {                                         \
1242         KASSERT((_m)->m_flags & M_PKTHDR, ("Attempt to set FIB on non header mbuf."));  \
1243         ((_m)->m_pkthdr.fibnum) = (_fib);                               \
1244 } while (0)
1245
1246 /* flags passed as first argument for "m_ether_tcpip_hash()" */
1247 #define MBUF_HASHFLAG_L2        (1 << 2)
1248 #define MBUF_HASHFLAG_L3        (1 << 3)
1249 #define MBUF_HASHFLAG_L4        (1 << 4)
1250
1251 /* mbuf hashing helper routines */
1252 uint32_t        m_ether_tcpip_hash_init(void);
1253 uint32_t        m_ether_tcpip_hash(const uint32_t, const struct mbuf *, const uint32_t);
1254
1255 #ifdef MBUF_PROFILING
1256  void m_profile(struct mbuf *m);
1257  #define M_PROFILE(m) m_profile(m)
1258 #else
1259  #define M_PROFILE(m)
1260 #endif
1261
1262 struct mbufq {
1263         STAILQ_HEAD(, mbuf)     mq_head;
1264         int                     mq_len;
1265         int                     mq_maxlen;
1266 };
1267
1268 static inline void
1269 mbufq_init(struct mbufq *mq, int maxlen)
1270 {
1271
1272         STAILQ_INIT(&mq->mq_head);
1273         mq->mq_maxlen = maxlen;
1274         mq->mq_len = 0;
1275 }
1276
1277 static inline struct mbuf *
1278 mbufq_flush(struct mbufq *mq)
1279 {
1280         struct mbuf *m;
1281
1282         m = STAILQ_FIRST(&mq->mq_head);
1283         STAILQ_INIT(&mq->mq_head);
1284         mq->mq_len = 0;
1285         return (m);
1286 }
1287
1288 static inline void
1289 mbufq_drain(struct mbufq *mq)
1290 {
1291         struct mbuf *m, *n;
1292
1293         n = mbufq_flush(mq);
1294         while ((m = n) != NULL) {
1295                 n = STAILQ_NEXT(m, m_stailqpkt);
1296                 m_freem(m);
1297         }
1298 }
1299
1300 static inline struct mbuf *
1301 mbufq_first(const struct mbufq *mq)
1302 {
1303
1304         return (STAILQ_FIRST(&mq->mq_head));
1305 }
1306
1307 static inline struct mbuf *
1308 mbufq_last(const struct mbufq *mq)
1309 {
1310
1311         return (STAILQ_LAST(&mq->mq_head, mbuf, m_stailqpkt));
1312 }
1313
1314 static inline int
1315 mbufq_full(const struct mbufq *mq)
1316 {
1317
1318         return (mq->mq_len >= mq->mq_maxlen);
1319 }
1320
1321 static inline int
1322 mbufq_len(const struct mbufq *mq)
1323 {
1324
1325         return (mq->mq_len);
1326 }
1327
1328 static inline int
1329 mbufq_enqueue(struct mbufq *mq, struct mbuf *m)
1330 {
1331
1332         if (mbufq_full(mq))
1333                 return (ENOBUFS);
1334         STAILQ_INSERT_TAIL(&mq->mq_head, m, m_stailqpkt);
1335         mq->mq_len++;
1336         return (0);
1337 }
1338
1339 static inline struct mbuf *
1340 mbufq_dequeue(struct mbufq *mq)
1341 {
1342         struct mbuf *m;
1343
1344         m = STAILQ_FIRST(&mq->mq_head);
1345         if (m) {
1346                 STAILQ_REMOVE_HEAD(&mq->mq_head, m_stailqpkt);
1347                 m->m_nextpkt = NULL;
1348                 mq->mq_len--;
1349         }
1350         return (m);
1351 }
1352
1353 static inline void
1354 mbufq_prepend(struct mbufq *mq, struct mbuf *m)
1355 {
1356
1357         STAILQ_INSERT_HEAD(&mq->mq_head, m, m_stailqpkt);
1358         mq->mq_len++;
1359 }
1360
1361 /*
1362  * Note: this doesn't enforce the maximum list size for dst.
1363  */
1364 static inline void
1365 mbufq_concat(struct mbufq *mq_dst, struct mbufq *mq_src)
1366 {
1367
1368         mq_dst->mq_len += mq_src->mq_len;
1369         STAILQ_CONCAT(&mq_dst->mq_head, &mq_src->mq_head);
1370         mq_src->mq_len = 0;
1371 }
1372
1373 #ifdef _SYS_TIMESPEC_H_
1374 static inline void
1375 mbuf_tstmp2timespec(struct mbuf *m, struct timespec *ts)
1376 {
1377
1378         KASSERT((m->m_flags & M_PKTHDR) != 0, ("mbuf %p no M_PKTHDR", m));
1379         KASSERT((m->m_flags & M_TSTMP) != 0, ("mbuf %p no M_TSTMP", m));
1380         ts->tv_sec = m->m_pkthdr.rcv_tstmp / 1000000000;
1381         ts->tv_nsec = m->m_pkthdr.rcv_tstmp % 1000000000;
1382 }
1383 #endif
1384
1385 #ifdef NETDUMP
1386 /* Invoked from the netdump client code. */
1387 void    netdump_mbuf_drain(void);
1388 void    netdump_mbuf_dump(void);
1389 void    netdump_mbuf_reinit(int nmbuf, int nclust, int clsize);
1390 #endif
1391
1392 #endif /* _KERNEL */
1393 #endif /* !_SYS_MBUF_H_ */