sys/sys/mbuf.h

   1 /*-
   2  * Copyright (c) 1982, 1986, 1988, 1993
   3  *      The Regents of the University of California.
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  * 3. Neither the name of the University nor the names of its contributors
  15  *    may be used to endorse or promote products derived from this software
  16  *    without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28  * SUCH DAMAGE.
  29  *
  30  *      @(#)mbuf.h      8.5 (Berkeley) 2/19/95
  31  * $FreeBSD$
  32  */
  33
  34 #ifndef _SYS_MBUF_H_
  35 #define _SYS_MBUF_H_
  36
  37 /* XXX: These includes suck. Sorry! */
  38 #include <sys/queue.h>
  39 #ifdef _KERNEL
  40 #include <sys/systm.h>
  41 #include <vm/uma.h>
  42 #ifdef WITNESS
  43 #include <sys/lock.h>
  44 #endif
  45 #endif
  46
  47 /*
  48  * Mbufs are of a single size, MSIZE (sys/param.h), which includes overhead.
  49  * An mbuf may add a single "mbuf cluster" of size MCLBYTES (also in
  50  * sys/param.h), which has no additional overhead and is used instead of the
  51  * internal data area; this is done when at least MINCLSIZE of data must be
  52  * stored.  Additionally, it is possible to allocate a separate buffer
  53  * externally and attach it to the mbuf in a way similar to that of mbuf
  54  * clusters.
  55  */
  56 #define MLEN            (MSIZE - sizeof(struct m_hdr))  /* normal data len */
  57 #define MHLEN           (MLEN - sizeof(struct pkthdr))  /* data len w/pkthdr */
  58 #define MINCLSIZE       (MHLEN + 1)     /* smallest amount to put in cluster */
  59 #define M_MAXCOMPRESS   (MHLEN / 2)     /* max amount to copy for compression */
  60
  61 #ifdef _KERNEL
  62 /*-
  63  * Macro for type conversion: convert mbuf pointer to data pointer of correct
  64  * type:
  65  *
  66  * mtod(m, t)   -- Convert mbuf pointer to data pointer of correct type.
  67  */
  68 #define mtod(m, t)      ((t)((m)->m_data))
  69
  70 /*
  71  * Argument structure passed to UMA routines during mbuf and packet
  72  * allocations.
  73  */
  74 struct mb_args {
  75         int     flags;  /* Flags for mbuf being allocated */
  76         short   type;   /* Type of mbuf being allocated */
  77 };
  78 #endif /* _KERNEL */
  79
  80 #if defined(__LP64__)
  81 #define M_HDR_PAD    6
  82 #else
  83 #define M_HDR_PAD    2
  84 #endif
  85
  86 /*
  87  * Header present at the beginning of every mbuf.
  88  */
  89 struct m_hdr {
  90         struct mbuf     *mh_next;       /* next buffer in chain */
  91         struct mbuf     *mh_nextpkt;    /* next chain in queue/record */
  92         caddr_t          mh_data;       /* location of data */
  93         int              mh_len;        /* amount of data in this mbuf */
  94         int              mh_flags;      /* flags; see below */
  95         short            mh_type;       /* type of data in this mbuf */
  96         uint8_t          pad[M_HDR_PAD];/* word align                  */
  97 };
  98
  99 /*
 100  * Packet tag structure (see below for details).
 101  */
 102 struct m_tag {
 103         SLIST_ENTRY(m_tag)      m_tag_link;     /* List of packet tags */
 104         u_int16_t               m_tag_id;       /* Tag ID */
 105         u_int16_t               m_tag_len;      /* Length of data */
 106         u_int32_t               m_tag_cookie;   /* ABI/Module ID */
 107         void                    (*m_tag_free)(struct m_tag *);
 108 };
 109
 110 /*
 111  * Record/packet header in first mbuf of chain; valid only if M_PKTHDR is set.
 112  */
 113 struct pkthdr {
 114         struct ifnet    *rcvif;         /* rcv interface */
 115         /* variables for ip and tcp reassembly */
 116         void            *header;        /* pointer to packet header */
 117         int              len;           /* total packet length */
 118         uint32_t         flowid;        /* packet's 4-tuple system
 119                                          * flow identifier
 120                                          */
 121         /* variables for hardware checksum */
 122         int              csum_flags;    /* flags regarding checksum */
 123         int              csum_data;     /* data field used by csum routines */
 124         u_int16_t        tso_segsz;     /* TSO segment size */
 125         union {
 126                 u_int16_t vt_vtag;      /* Ethernet 802.1p+q vlan tag */
 127                 u_int16_t vt_nrecs;     /* # of IGMPv3 records in this chain */
 128         } PH_vt;
 129         SLIST_HEAD(packet_tags, m_tag) tags; /* list of packet tags */
 130 };
 131 #define ether_vtag      PH_vt.vt_vtag
 132
 133 /*
 134  * Description of external storage mapped into mbuf; valid only if M_EXT is
 135  * set.
 136  */
 137 struct m_ext {
 138         caddr_t          ext_buf;       /* start of buffer */
 139         void            (*ext_free)     /* free routine if not the usual */
 140                             (void *, void *);
 141         void            *ext_arg1;      /* optional argument pointer */
 142         void            *ext_arg2;      /* optional argument pointer */
 143         u_int            ext_size;      /* size of buffer, for ext_free */
 144         volatile u_int  *ref_cnt;       /* pointer to ref count info */
 145         int              ext_type;      /* type of external storage */
 146 };
 147
 148 /*
 149  * The core of the mbuf object along with some shortcut defines for practical
 150  * purposes.
 151  */
 152 struct mbuf {
 153         struct m_hdr    m_hdr;
 154         union {
 155                 struct {
 156                         struct pkthdr   MH_pkthdr;      /* M_PKTHDR set */
 157                         union {
 158                                 struct m_ext    MH_ext; /* M_EXT set */
 159                                 char            MH_databuf[MHLEN];
 160                         } MH_dat;
 161                 } MH;
 162                 char    M_databuf[MLEN];                /* !M_PKTHDR, !M_EXT */
 163         } M_dat;
 164 };
 165 #define m_next          m_hdr.mh_next
 166 #define m_len           m_hdr.mh_len
 167 #define m_data          m_hdr.mh_data
 168 #define m_type          m_hdr.mh_type
 169 #define m_flags         m_hdr.mh_flags
 170 #define m_nextpkt       m_hdr.mh_nextpkt
 171 #define m_act           m_nextpkt
 172 #define m_pkthdr        M_dat.MH.MH_pkthdr
 173 #define m_ext           M_dat.MH.MH_dat.MH_ext
 174 #define m_pktdat        M_dat.MH.MH_dat.MH_databuf
 175 #define m_dat           M_dat.M_databuf
 176
 177 /*
 178  * mbuf flags.
 179  */
 180 #define M_EXT           0x00000001 /* has associated external storage */
 181 #define M_PKTHDR        0x00000002 /* start of record */
 182 #define M_EOR           0x00000004 /* end of record */
 183 #define M_RDONLY        0x00000008 /* associated data is marked read-only */
 184 #define M_PROTO1        0x00000010 /* protocol-specific */
 185 #define M_PROTO2        0x00000020 /* protocol-specific */
 186 #define M_PROTO3        0x00000040 /* protocol-specific */
 187 #define M_PROTO4        0x00000080 /* protocol-specific */
 188 #define M_PROTO5        0x00000100 /* protocol-specific */
 189 #define M_BCAST         0x00000200 /* send/received as link-level broadcast */
 190 #define M_MCAST         0x00000400 /* send/received as link-level multicast */
 191 #define M_FRAG          0x00000800 /* packet is a fragment of a larger packet */
 192 #define M_FIRSTFRAG     0x00001000 /* packet is first fragment */
 193 #define M_LASTFRAG      0x00002000 /* packet is last fragment */
 194 #define M_SKIP_FIREWALL 0x00004000 /* skip firewall processing */
 195 #define M_FREELIST      0x00008000 /* mbuf is on the free list */
 196 #define M_VLANTAG       0x00010000 /* ether_vtag is valid */
 197 #define M_PROMISC       0x00020000 /* packet was not for us */
 198 #define M_NOFREE        0x00040000 /* do not free mbuf, embedded in cluster */
 199 #define M_PROTO6        0x00080000 /* protocol-specific */
 200 #define M_PROTO7        0x00100000 /* protocol-specific */
 201 #define M_PROTO8        0x00200000 /* protocol-specific */
 202 #define M_FLOWID        0x00400000 /* deprecated: flowid is valid */
 203 #define M_HASHTYPEBITS  0x0F000000 /* mask of bits holding flowid hash type */
 204
 205 /*
 206  * For RELENG_{6,7} steal these flags for limited multiple routing table
 207  * support. In RELENG_8 and beyond, use just one flag and a tag.
 208  */
 209 #define M_FIB           0xF0000000 /* steal some bits to store fib number. */
 210
 211 #define M_NOTIFICATION  M_PROTO5    /* SCTP notification */
 212
 213 /*
 214  * Flags to purge when crossing layers.
 215  */
 216 #define M_PROTOFLAGS \
 217     (M_PROTO1|M_PROTO2|M_PROTO3|M_PROTO4|M_PROTO5|M_PROTO6|M_PROTO7|M_PROTO8)
 218
 219 /*
 220  * Network interface cards are able to hash protocol fields (such as IPv4
 221  * addresses and TCP port numbers) classify packets into flows.  These flows
 222  * can then be used to maintain ordering while delivering packets to the OS
 223  * via parallel input queues, as well as to provide a stateless affinity
 224  * model.  NIC drivers can pass up the hash via m->m_pkthdr.flowid, and set
 225  * m_flag fields to indicate how the hash should be interpreted by the
 226  * network stack.
 227  *
 228  * Most NICs support RSS, which provides ordering and explicit affinity, and
 229  * use the hash m_flag bits to indicate what header fields were covered by
 230  * the hash.  M_HASHTYPE_OPAQUE can be set by non-RSS cards or configurations
 231  * that provide an opaque flow identifier, allowing for ordering and
 232  * distribution without explicit affinity.
 233  */
 234 #define M_HASHTYPE_SHIFT                24
 235 #define M_HASHTYPE_NONE                 0x0
 236 #define M_HASHTYPE_RSS_IPV4             0x1     /* IPv4 2-tuple */
 237 #define M_HASHTYPE_RSS_TCP_IPV4         0x2     /* TCPv4 4-tuple */
 238 #define M_HASHTYPE_RSS_IPV6             0x3     /* IPv6 2-tuple */
 239 #define M_HASHTYPE_RSS_TCP_IPV6         0x4     /* TCPv6 4-tuple */
 240 #define M_HASHTYPE_RSS_IPV6_EX          0x5     /* IPv6 2-tuple + ext hdrs */
 241 #define M_HASHTYPE_RSS_TCP_IPV6_EX      0x6     /* TCPv6 4-tiple + ext hdrs */
 242 #define M_HASHTYPE_OPAQUE               0xf     /* ordering, not affinity */
 243
 244 #define M_HASHTYPE_CLEAR(m)     (m)->m_flags &= ~(M_HASHTYPEBITS)
 245 #define M_HASHTYPE_GET(m)       (((m)->m_flags & M_HASHTYPEBITS) >> \
 246                                     M_HASHTYPE_SHIFT)
 247 #define M_HASHTYPE_SET(m, v)    do {                                    \
 248         (m)->m_flags &= ~M_HASHTYPEBITS;                                \
 249         (m)->m_flags |= ((v) << M_HASHTYPE_SHIFT);                      \
 250 } while (0)
 251 #define M_HASHTYPE_TEST(m, v)   (M_HASHTYPE_GET(m) == (v))
 252
 253 /*
 254  * Flags preserved when copying m_pkthdr.
 255  */
 256 #define M_COPYFLAGS \
 257     (M_PKTHDR|M_EOR|M_RDONLY|M_PROTOFLAGS|M_SKIP_FIREWALL|M_BCAST|M_MCAST|\
 258      M_FRAG|M_FIRSTFRAG|M_LASTFRAG|M_VLANTAG|M_PROMISC|M_FIB|M_HASHTYPEBITS)
 259
 260 /*
 261  * External buffer types: identify ext_buf type.
 262  */
 263 #define EXT_CLUSTER     1       /* mbuf cluster */
 264 #define EXT_SFBUF       2       /* sendfile(2)'s sf_bufs */
 265 #define EXT_JUMBOP      3       /* jumbo cluster 4096 bytes */
 266 #define EXT_JUMBO9      4       /* jumbo cluster 9216 bytes */
 267 #define EXT_JUMBO16     5       /* jumbo cluster 16184 bytes */
 268 #define EXT_PACKET      6       /* mbuf+cluster from packet zone */
 269 #define EXT_MBUF        7       /* external mbuf reference (M_IOVEC) */
 270 #define EXT_NET_DRV     100     /* custom ext_buf provided by net driver(s) */
 271 #define EXT_MOD_TYPE    200     /* custom module's ext_buf type */
 272 #define EXT_DISPOSABLE  300     /* can throw this buffer away w/page flipping */
 273 #define EXT_EXTREF      400     /* has externally maintained ref_cnt ptr */
 274
 275 /*
 276  * Flags indicating hw checksum support and sw checksum requirements.  This
 277  * field can be directly tested against if_data.ifi_hwassist.
 278  */
 279 #define CSUM_IP                 0x0001          /* will csum IP */
 280 #define CSUM_TCP                0x0002          /* will csum TCP */
 281 #define CSUM_UDP                0x0004          /* will csum UDP */
 282 #define CSUM_FRAGMENT           0x0010          /* will do IP fragmentation */
 283 #define CSUM_TSO                0x0020          /* will do TSO */
 284 #define CSUM_SCTP               0x0040          /* will csum SCTP */
 285 #define CSUM_SCTP_IPV6          0x0080          /* will csum IPv6/SCTP */
 286
 287 #define CSUM_IP_CHECKED         0x0100          /* did csum IP */
 288 #define CSUM_IP_VALID           0x0200          /*   ... the csum is valid */
 289 #define CSUM_DATA_VALID         0x0400          /* csum_data field is valid */
 290 #define CSUM_PSEUDO_HDR         0x0800          /* csum_data has pseudo hdr */
 291 #define CSUM_SCTP_VALID         0x1000          /* SCTP checksum is valid */
 292 #define CSUM_UDP_IPV6           0x2000          /* will csum IPv6/UDP */
 293 #define CSUM_TCP_IPV6           0x4000          /* will csum IPv6/TCP */
 294 /*      CSUM_TSO_IPV6           0x8000          will do IPv6/TSO */
 295
 296 /*      CSUM_FRAGMENT_IPV6      0x10000         will do IPv6 fragementation */
 297
 298 #define CSUM_DELAY_DATA_IPV6    (CSUM_TCP_IPV6 | CSUM_UDP_IPV6)
 299 #define CSUM_DATA_VALID_IPV6    CSUM_DATA_VALID
 300
 301 #define CSUM_DELAY_DATA         (CSUM_TCP | CSUM_UDP)
 302 #define CSUM_DELAY_IP           (CSUM_IP)       /* Only v4, no v6 IP hdr csum */
 303
 304 /*
 305  * mbuf types.
 306  */
 307 #define MT_NOTMBUF      0       /* USED INTERNALLY ONLY! Object is not mbuf */
 308 #define MT_DATA         1       /* dynamic (data) allocation */
 309 #define MT_HEADER       MT_DATA /* packet header, use M_PKTHDR instead */
 310 #define MT_SONAME       8       /* socket name */
 311 #define MT_CONTROL      14      /* extra-data protocol message */
 312 #define MT_OOBDATA      15      /* expedited data  */
 313 #define MT_NTYPES       16      /* number of mbuf types for mbtypes[] */
 314
 315 #define MT_NOINIT       255     /* Not a type but a flag to allocate
 316                                    a non-initialized mbuf */
 317
 318 #define MB_NOTAGS       0x1UL   /* no tags attached to mbuf */
 319
 320 /*
 321  * General mbuf allocator statistics structure.
 322  *
 323  * Many of these statistics are no longer used; we instead track many
 324  * allocator statistics through UMA's built in statistics mechanism.
 325  */
 326 struct mbstat {
 327         u_long  m_mbufs;        /* XXX */
 328         u_long  m_mclusts;      /* XXX */
 329
 330         u_long  m_drain;        /* times drained protocols for space */
 331         u_long  m_mcfail;       /* XXX: times m_copym failed */
 332         u_long  m_mpfail;       /* XXX: times m_pullup failed */
 333         u_long  m_msize;        /* length of an mbuf */
 334         u_long  m_mclbytes;     /* length of an mbuf cluster */
 335         u_long  m_minclsize;    /* min length of data to allocate a cluster */
 336         u_long  m_mlen;         /* length of data in an mbuf */
 337         u_long  m_mhlen;        /* length of data in a header mbuf */
 338
 339         /* Number of mbtypes (gives # elems in mbtypes[] array) */
 340         short   m_numtypes;
 341
 342         /* XXX: Sendfile stats should eventually move to their own struct */
 343         u_long  sf_iocnt;       /* times sendfile had to do disk I/O */
 344         u_long  sf_allocfail;   /* times sfbuf allocation failed */
 345         u_long  sf_allocwait;   /* times sfbuf allocation had to wait */
 346 };
 347
 348 /*
 349  * Flags specifying how an allocation should be made.
 350  *
 351  * The flag to use is as follows:
 352  * - M_DONTWAIT or M_NOWAIT from an interrupt handler to not block allocation.
 353  * - M_WAIT or M_WAITOK from wherever it is safe to block.
 354  *
 355  * M_DONTWAIT/M_NOWAIT means that we will not block the thread explicitly and
 356  * if we cannot allocate immediately we may return NULL, whereas
 357  * M_WAIT/M_WAITOK means that if we cannot allocate resources we
 358  * will block until they are available, and thus never return NULL.
 359  *
 360  * XXX Eventually just phase this out to use M_WAITOK/M_NOWAIT.
 361  */
 362 #define MBTOM(how)      (how)
 363 #define M_DONTWAIT      M_NOWAIT
 364 #define M_TRYWAIT       M_WAITOK
 365 #define M_WAIT          M_WAITOK
 366
 367 /*
 368  * String names of mbuf-related UMA(9) and malloc(9) types.  Exposed to
 369  * !_KERNEL so that monitoring tools can look up the zones with
 370  * libmemstat(3).
 371  */
 372 #define MBUF_MEM_NAME           "mbuf"
 373 #define MBUF_CLUSTER_MEM_NAME   "mbuf_cluster"
 374 #define MBUF_PACKET_MEM_NAME    "mbuf_packet"
 375 #define MBUF_JUMBOP_MEM_NAME    "mbuf_jumbo_page"
 376 #define MBUF_JUMBO9_MEM_NAME    "mbuf_jumbo_9k"
 377 #define MBUF_JUMBO16_MEM_NAME   "mbuf_jumbo_16k"
 378 #define MBUF_TAG_MEM_NAME       "mbuf_tag"
 379 #define MBUF_EXTREFCNT_MEM_NAME "mbuf_ext_refcnt"
 380
 381 #ifdef _KERNEL
 382
 383 #ifdef WITNESS
 384 #define MBUF_CHECKSLEEP(how) do {                                       \
 385         if (how == M_WAITOK)                                            \
 386                 WITNESS_WARN(WARN_GIANTOK | WARN_SLEEPOK, NULL,         \
 387                     "Sleeping in \"%s\"", __func__);                    \
 388 } while (0)
 389 #else
 390 #define MBUF_CHECKSLEEP(how)
 391 #endif
 392
 393 /*
 394  * Network buffer allocation API
 395  *
 396  * The rest of it is defined in kern/kern_mbuf.c
 397  */
 398
 399 extern uma_zone_t       zone_mbuf;
 400 extern uma_zone_t       zone_clust;
 401 extern uma_zone_t       zone_pack;
 402 extern uma_zone_t       zone_jumbop;
 403 extern uma_zone_t       zone_jumbo9;
 404 extern uma_zone_t       zone_jumbo16;
 405 extern uma_zone_t       zone_ext_refcnt;
 406
 407 static __inline struct mbuf     *m_getcl(int how, short type, int flags);
 408 static __inline struct mbuf     *m_get(int how, short type);
 409 static __inline struct mbuf     *m_get2(int how, short type, int flags,
 410                                     int size);
 411 static __inline struct mbuf     *m_gethdr(int how, short type);
 412 static __inline struct mbuf     *m_getjcl(int how, short type, int flags,
 413                                     int size);
 414 static __inline struct mbuf     *m_getclr(int how, short type); /* XXX */
 415 static __inline int              m_init(struct mbuf *m, uma_zone_t zone,
 416                                     int size, int how, short type, int flags);
 417 static __inline struct mbuf     *m_free(struct mbuf *m);
 418 static __inline void             m_clget(struct mbuf *m, int how);
 419 static __inline void            *m_cljget(struct mbuf *m, int how, int size);
 420 static __inline void             m_chtype(struct mbuf *m, short new_type);
 421 void                             mb_free_ext(struct mbuf *);
 422 static __inline struct mbuf     *m_last(struct mbuf *m);
 423 int                              m_pkthdr_init(struct mbuf *m, int how);
 424
 425 static __inline int
 426 m_gettype(int size)
 427 {
 428         int type;
 429
 430         switch (size) {
 431         case MSIZE:
 432                 type = EXT_MBUF;
 433                 break;
 434         case MCLBYTES:
 435                 type = EXT_CLUSTER;
 436                 break;
 437 #if MJUMPAGESIZE != MCLBYTES
 438         case MJUMPAGESIZE:
 439                 type = EXT_JUMBOP;
 440                 break;
 441 #endif
 442         case MJUM9BYTES:
 443                 type = EXT_JUMBO9;
 444                 break;
 445         case MJUM16BYTES:
 446                 type = EXT_JUMBO16;
 447                 break;
 448         default:
 449                 panic("%s: invalid cluster size", __func__);
 450         }
 451
 452         return (type);
 453 }
 454
 455 static __inline uma_zone_t
 456 m_getzone(int size)
 457 {
 458         uma_zone_t zone;
 459
 460         switch (size) {
 461         case MCLBYTES:
 462                 zone = zone_clust;
 463                 break;
 464 #if MJUMPAGESIZE != MCLBYTES
 465         case MJUMPAGESIZE:
 466                 zone = zone_jumbop;
 467                 break;
 468 #endif
 469         case MJUM9BYTES:
 470                 zone = zone_jumbo9;
 471                 break;
 472         case MJUM16BYTES:
 473                 zone = zone_jumbo16;
 474                 break;
 475         default:
 476                 panic("%s: invalid cluster size", __func__);
 477         }
 478
 479         return (zone);
 480 }
 481
 482 /*
 483  * Initialize an mbuf with linear storage.
 484  *
 485  * Inline because the consumer text overhead will be roughly the same to
 486  * initialize or call a function with this many parameters and M_PKTHDR
 487  * should go away with constant propagation for !MGETHDR.
 488  */
 489 static __inline int
 490 m_init(struct mbuf *m, uma_zone_t zone, int size, int how, short type,
 491     int flags)
 492 {
 493         int error;
 494
 495         m->m_next = NULL;
 496         m->m_nextpkt = NULL;
 497         m->m_data = m->m_dat;
 498         m->m_len = 0;
 499         m->m_flags = flags;
 500         m->m_type = type;
 501         if (flags & M_PKTHDR) {
 502                 if ((error = m_pkthdr_init(m, how)) != 0)
 503                         return (error);
 504         }
 505
 506         return (0);
 507 }
 508
 509 static __inline struct mbuf *
 510 m_get(int how, short type)
 511 {
 512         struct mb_args args;
 513
 514         args.flags = 0;
 515         args.type = type;
 516         return ((struct mbuf *)(uma_zalloc_arg(zone_mbuf, &args, how)));
 517 }
 518
 519 /*
 520  * XXX This should be deprecated, very little use.
 521  */
 522 static __inline struct mbuf *
 523 m_getclr(int how, short type)
 524 {
 525         struct mbuf *m;
 526         struct mb_args args;
 527
 528         args.flags = 0;
 529         args.type = type;
 530         m = uma_zalloc_arg(zone_mbuf, &args, how);
 531         if (m != NULL)
 532                 bzero(m->m_data, MLEN);
 533         return (m);
 534 }
 535
 536 static __inline struct mbuf *
 537 m_gethdr(int how, short type)
 538 {
 539         struct mb_args args;
 540
 541         args.flags = M_PKTHDR;
 542         args.type = type;
 543         return ((struct mbuf *)(uma_zalloc_arg(zone_mbuf, &args, how)));
 544 }
 545
 546 static __inline struct mbuf *
 547 m_getcl(int how, short type, int flags)
 548 {
 549         struct mb_args args;
 550
 551         args.flags = flags;
 552         args.type = type;
 553         return ((struct mbuf *)(uma_zalloc_arg(zone_pack, &args, how)));
 554 }
 555
 556 /*
 557  * m_get2() allocates minimum mbuf that would fit "size" argument.
 558  *
 559  * XXX: This is rather large, should be real function maybe.
 560  */
 561 static __inline struct mbuf *
 562 m_get2(int how, short type, int flags, int size)
 563 {
 564         struct mb_args args;
 565         struct mbuf *m, *n;
 566         uma_zone_t zone;
 567
 568         args.flags = flags;
 569         args.type = type;
 570
 571         if (size <= MHLEN || (size <= MLEN && (flags & M_PKTHDR) == 0))
 572                 return ((struct mbuf *)(uma_zalloc_arg(zone_mbuf, &args, how)));
 573         if (size <= MCLBYTES)
 574                 return ((struct mbuf *)(uma_zalloc_arg(zone_pack, &args, how)));
 575
 576         if (size > MJUM16BYTES)
 577                 return (NULL);
 578
 579         m = uma_zalloc_arg(zone_mbuf, &args, how);
 580         if (m == NULL)
 581                 return (NULL);
 582
 583 #if MJUMPAGESIZE != MCLBYTES
 584         if (size <= MJUMPAGESIZE)
 585                 zone = zone_jumbop;
 586         else
 587 #endif
 588         if (size <= MJUM9BYTES)
 589                 zone = zone_jumbo9;
 590         else
 591                 zone = zone_jumbo16;
 592
 593         n = uma_zalloc_arg(zone, m, how);
 594         if (n == NULL) {
 595                 uma_zfree(zone_mbuf, m);
 596                 return (NULL);
 597         }
 598
 599         return (m);
 600 }
 601
 602 /*
 603  * m_getjcl() returns an mbuf with a cluster of the specified size attached.
 604  * For size it takes MCLBYTES, MJUMPAGESIZE, MJUM9BYTES, MJUM16BYTES.
 605  *
 606  * XXX: This is rather large, should be real function maybe.
 607  */
 608 static __inline struct mbuf *
 609 m_getjcl(int how, short type, int flags, int size)
 610 {
 611         struct mb_args args;
 612         struct mbuf *m, *n;
 613         uma_zone_t zone;
 614
 615         if (size == MCLBYTES)
 616                 return m_getcl(how, type, flags);
 617
 618         args.flags = flags;
 619         args.type = type;
 620
 621         m = uma_zalloc_arg(zone_mbuf, &args, how);
 622         if (m == NULL)
 623                 return (NULL);
 624
 625         zone = m_getzone(size);
 626         n = uma_zalloc_arg(zone, m, how);
 627         if (n == NULL) {
 628                 uma_zfree(zone_mbuf, m);
 629                 return (NULL);
 630         }
 631         return (m);
 632 }
 633
 634 static __inline void
 635 m_free_fast(struct mbuf *m)
 636 {
 637 #ifdef INVARIANTS
 638         if (m->m_flags & M_PKTHDR)
 639                 KASSERT(SLIST_EMPTY(&m->m_pkthdr.tags), ("doing fast free of mbuf with tags"));
 640 #endif
 641
 642         uma_zfree_arg(zone_mbuf, m, (void *)MB_NOTAGS);
 643 }
 644
 645 static __inline struct mbuf *
 646 m_free(struct mbuf *m)
 647 {
 648         struct mbuf *n = m->m_next;
 649
 650         if (m->m_flags & M_EXT)
 651                 mb_free_ext(m);
 652         else if ((m->m_flags & M_NOFREE) == 0)
 653                 uma_zfree(zone_mbuf, m);
 654         return (n);
 655 }
 656
 657 static __inline void
 658 m_clget(struct mbuf *m, int how)
 659 {
 660
 661         if (m->m_flags & M_EXT)
 662                 printf("%s: %p mbuf already has cluster\n", __func__, m);
 663         m->m_ext.ext_buf = (char *)NULL;
 664         uma_zalloc_arg(zone_clust, m, how);
 665         /*
 666          * On a cluster allocation failure, drain the packet zone and retry,
 667          * we might be able to loosen a few clusters up on the drain.
 668          */
 669         if ((how & M_NOWAIT) && (m->m_ext.ext_buf == NULL)) {
 670                 zone_drain(zone_pack);
 671                 uma_zalloc_arg(zone_clust, m, how);
 672         }
 673 }
 674
 675 /*
 676  * m_cljget() is different from m_clget() as it can allocate clusters without
 677  * attaching them to an mbuf.  In that case the return value is the pointer
 678  * to the cluster of the requested size.  If an mbuf was specified, it gets
 679  * the cluster attached to it and the return value can be safely ignored.
 680  * For size it takes MCLBYTES, MJUMPAGESIZE, MJUM9BYTES, MJUM16BYTES.
 681  */
 682 static __inline void *
 683 m_cljget(struct mbuf *m, int how, int size)
 684 {
 685         uma_zone_t zone;
 686
 687         if (m && m->m_flags & M_EXT)
 688                 printf("%s: %p mbuf already has cluster\n", __func__, m);
 689         if (m != NULL)
 690                 m->m_ext.ext_buf = NULL;
 691
 692         zone = m_getzone(size);
 693         return (uma_zalloc_arg(zone, m, how));
 694 }
 695
 696 static __inline void
 697 m_cljset(struct mbuf *m, void *cl, int type)
 698 {
 699         uma_zone_t zone;
 700         int size;
 701
 702         switch (type) {
 703         case EXT_CLUSTER:
 704                 size = MCLBYTES;
 705                 zone = zone_clust;
 706                 break;
 707 #if MJUMPAGESIZE != MCLBYTES
 708         case EXT_JUMBOP:
 709                 size = MJUMPAGESIZE;
 710                 zone = zone_jumbop;
 711                 break;
 712 #endif
 713         case EXT_JUMBO9:
 714                 size = MJUM9BYTES;
 715                 zone = zone_jumbo9;
 716                 break;
 717         case EXT_JUMBO16:
 718                 size = MJUM16BYTES;
 719                 zone = zone_jumbo16;
 720                 break;
 721         default:
 722                 panic("%s: unknown cluster type", __func__);
 723                 break;
 724         }
 725
 726         m->m_data = m->m_ext.ext_buf = cl;
 727         m->m_ext.ext_free = m->m_ext.ext_arg1 = m->m_ext.ext_arg2 = NULL;
 728         m->m_ext.ext_size = size;
 729         m->m_ext.ext_type = type;
 730         m->m_ext.ref_cnt = uma_find_refcnt(zone, cl);
 731         m->m_flags |= M_EXT;
 732
 733 }
 734
 735 static __inline void
 736 m_chtype(struct mbuf *m, short new_type)
 737 {
 738
 739         m->m_type = new_type;
 740 }
 741
 742 static __inline struct mbuf *
 743 m_last(struct mbuf *m)
 744 {
 745
 746         while (m->m_next)
 747                 m = m->m_next;
 748         return (m);
 749 }
 750
 751 /*
 752  * mbuf, cluster, and external object allocation macros (for compatibility
 753  * purposes).
 754  */
 755 #define M_MOVE_PKTHDR(to, from) m_move_pkthdr((to), (from))
 756 #define MGET(m, how, type)      ((m) = m_get((how), (type)))
 757 #define MGETHDR(m, how, type)   ((m) = m_gethdr((how), (type)))
 758 #define MCLGET(m, how)          m_clget((m), (how))
 759 #define MEXTADD(m, buf, size, free, arg1, arg2, flags, type)            \
 760     m_extadd((m), (caddr_t)(buf), (size), (free),(arg1),(arg2),(flags), (type))
 761 #define m_getm(m, len, how, type)                                       \
 762     m_getm2((m), (len), (how), (type), M_PKTHDR)
 763
 764 /*
 765  * Evaluate TRUE if it's safe to write to the mbuf m's data region (this can
 766  * be both the local data payload, or an external buffer area, depending on
 767  * whether M_EXT is set).
 768  */
 769 #define M_WRITABLE(m)   (!((m)->m_flags & M_RDONLY) &&                  \
 770                          (!(((m)->m_flags & M_EXT)) ||                  \
 771                          (*((m)->m_ext.ref_cnt) == 1)) )                \
 772
 773 /* Check if the supplied mbuf has a packet header, or else panic. */
 774 #define M_ASSERTPKTHDR(m)                                               \
 775         KASSERT((m) != NULL && (m)->m_flags & M_PKTHDR,                 \
 776             ("%s: no mbuf packet header!", __func__))
 777
 778 /*
 779  * Ensure that the supplied mbuf is a valid, non-free mbuf.
 780  *
 781  * XXX: Broken at the moment.  Need some UMA magic to make it work again.
 782  */
 783 #define M_ASSERTVALID(m)                                                \
 784         KASSERT((((struct mbuf *)m)->m_flags & 0) == 0,                 \
 785             ("%s: attempted use of a free mbuf!", __func__))
 786
 787 /*
 788  * Set the m_data pointer of a newly-allocated mbuf (m_get/MGET) to place an
 789  * object of the specified size at the end of the mbuf, longword aligned.
 790  */
 791 #define M_ALIGN(m, len) do {                                            \
 792         KASSERT(!((m)->m_flags & (M_PKTHDR|M_EXT)),                     \
 793                 ("%s: M_ALIGN not normal mbuf", __func__));             \
 794         KASSERT((m)->m_data == (m)->m_dat,                              \
 795                 ("%s: M_ALIGN not a virgin mbuf", __func__));           \
 796         (m)->m_data += (MLEN - (len)) & ~(sizeof(long) - 1);            \
 797 } while (0)
 798
 799 /*
 800  * As above, for mbufs allocated with m_gethdr/MGETHDR or initialized by
 801  * M_DUP/MOVE_PKTHDR.
 802  */
 803 #define MH_ALIGN(m, len) do {                                           \
 804         KASSERT((m)->m_flags & M_PKTHDR && !((m)->m_flags & M_EXT),     \
 805                 ("%s: MH_ALIGN not PKTHDR mbuf", __func__));            \
 806         KASSERT((m)->m_data == (m)->m_pktdat,                           \
 807                 ("%s: MH_ALIGN not a virgin mbuf", __func__));          \
 808         (m)->m_data += (MHLEN - (len)) & ~(sizeof(long) - 1);           \
 809 } while (0)
 810
 811 /*
 812  * Compute the amount of space available before the current start of data in
 813  * an mbuf.
 814  *
 815  * The M_WRITABLE() is a temporary, conservative safety measure: the burden
 816  * of checking writability of the mbuf data area rests solely with the caller.
 817  */
 818 #define M_LEADINGSPACE(m)                                               \
 819         ((m)->m_flags & M_EXT ?                                         \
 820             (M_WRITABLE(m) ? (m)->m_data - (m)->m_ext.ext_buf : 0):     \
 821             (m)->m_flags & M_PKTHDR ? (m)->m_data - (m)->m_pktdat :     \
 822             (m)->m_data - (m)->m_dat)
 823
 824 /*
 825  * Compute the amount of space available after the end of data in an mbuf.
 826  *
 827  * The M_WRITABLE() is a temporary, conservative safety measure: the burden
 828  * of checking writability of the mbuf data area rests solely with the caller.
 829  */
 830 #define M_TRAILINGSPACE(m)                                              \
 831         ((m)->m_flags & M_EXT ?                                         \
 832             (M_WRITABLE(m) ? (m)->m_ext.ext_buf + (m)->m_ext.ext_size   \
 833                 - ((m)->m_data + (m)->m_len) : 0) :                     \
 834             &(m)->m_dat[MLEN] - ((m)->m_data + (m)->m_len))
 835
 836 /*
 837  * Arrange to prepend space of size plen to mbuf m.  If a new mbuf must be
 838  * allocated, how specifies whether to wait.  If the allocation fails, the
 839  * original mbuf chain is freed and m is set to NULL.
 840  */
 841 #define M_PREPEND(m, plen, how) do {                                    \
 842         struct mbuf **_mmp = &(m);                                      \
 843         struct mbuf *_mm = *_mmp;                                       \
 844         int _mplen = (plen);                                            \
 845         int __mhow = (how);                                             \
 846                                                                         \
 847         MBUF_CHECKSLEEP(how);                                           \
 848         if (M_LEADINGSPACE(_mm) >= _mplen) {                            \
 849                 _mm->m_data -= _mplen;                                  \
 850                 _mm->m_len += _mplen;                                   \
 851         } else                                                          \
 852                 _mm = m_prepend(_mm, _mplen, __mhow);                   \
 853         if (_mm != NULL && _mm->m_flags & M_PKTHDR)                     \
 854                 _mm->m_pkthdr.len += _mplen;                            \
 855         *_mmp = _mm;                                                    \
 856 } while (0)
 857
 858 /*
 859  * Change mbuf to new type.  This is a relatively expensive operation and
 860  * should be avoided.
 861  */
 862 #define MCHTYPE(m, t)   m_chtype((m), (t))
 863
 864 /* Length to m_copy to copy all. */
 865 #define M_COPYALL       1000000000
 866
 867 /* Compatibility with 4.3. */
 868 #define m_copy(m, o, l) m_copym((m), (o), (l), M_DONTWAIT)
 869
 870 extern int              max_datalen;    /* MHLEN - max_hdr */
 871 extern int              max_hdr;        /* Largest link + protocol header */
 872 extern int              max_linkhdr;    /* Largest link-level header */
 873 extern int              max_protohdr;   /* Largest protocol header */
 874 extern struct mbstat    mbstat;         /* General mbuf stats/infos */
 875 extern int              nmbclusters;    /* Maximum number of clusters */
 876
 877 struct uio;
 878
 879 void             m_adj(struct mbuf *, int);
 880 void             m_align(struct mbuf *, int);
 881 int              m_apply(struct mbuf *, int, int,
 882                     int (*)(void *, void *, u_int), void *);
 883 int              m_append(struct mbuf *, int, c_caddr_t);
 884 void             m_cat(struct mbuf *, struct mbuf *);
 885 void             m_extadd(struct mbuf *, caddr_t, u_int,
 886                     void (*)(void *, void *), void *, void *, int, int);
 887 struct mbuf     *m_collapse(struct mbuf *, int, int);
 888 void             m_copyback(struct mbuf *, int, int, c_caddr_t);
 889 void             m_copydata(const struct mbuf *, int, int, caddr_t);
 890 struct mbuf     *m_copym(struct mbuf *, int, int, int);
 891 struct mbuf     *m_copymdata(struct mbuf *, struct mbuf *,
 892                     int, int, int, int);
 893 struct mbuf     *m_copypacket(struct mbuf *, int);
 894 void             m_copy_pkthdr(struct mbuf *, struct mbuf *);
 895 struct mbuf     *m_copyup(struct mbuf *n, int len, int dstoff);
 896 struct mbuf     *m_defrag(struct mbuf *, int);
 897 void             m_demote(struct mbuf *, int);
 898 struct mbuf     *m_devget(char *, int, int, struct ifnet *,
 899                     void (*)(char *, caddr_t, u_int));
 900 struct mbuf     *m_dup(struct mbuf *, int);
 901 int              m_dup_pkthdr(struct mbuf *, struct mbuf *, int);
 902 u_int            m_fixhdr(struct mbuf *);
 903 struct mbuf     *m_fragment(struct mbuf *, int, int);
 904 void             m_freem(struct mbuf *);
 905 struct mbuf     *m_getm2(struct mbuf *, int, int, short, int);
 906 struct mbuf     *m_getptr(struct mbuf *, int, int *);
 907 u_int            m_length(struct mbuf *, struct mbuf **);
 908 int              m_mbuftouio(struct uio *, struct mbuf *, int);
 909 void             m_move_pkthdr(struct mbuf *, struct mbuf *);
 910 struct mbuf     *m_prepend(struct mbuf *, int, int);
 911 void             m_print(const struct mbuf *, int);
 912 struct mbuf     *m_pulldown(struct mbuf *, int, int, int *);
 913 struct mbuf     *m_pullup(struct mbuf *, int);
 914 int             m_sanity(struct mbuf *, int);
 915 struct mbuf     *m_split(struct mbuf *, int, int);
 916 struct mbuf     *m_uiotombuf(struct uio *, int, int, int, int);
 917 struct mbuf     *m_unshare(struct mbuf *, int how);
 918
 919 /*-
 920  * Network packets may have annotations attached by affixing a list of
 921  * "packet tags" to the pkthdr structure.  Packet tags are dynamically
 922  * allocated semi-opaque data structures that have a fixed header
 923  * (struct m_tag) that specifies the size of the memory block and a
 924  * <cookie,type> pair that identifies it.  The cookie is a 32-bit unique
 925  * unsigned value used to identify a module or ABI.  By convention this value
 926  * is chosen as the date+time that the module is created, expressed as the
 927  * number of seconds since the epoch (e.g., using date -u +'%s').  The type
 928  * value is an ABI/module-specific value that identifies a particular
 929  * annotation and is private to the module.  For compatibility with systems
 930  * like OpenBSD that define packet tags w/o an ABI/module cookie, the value
 931  * PACKET_ABI_COMPAT is used to implement m_tag_get and m_tag_find
 932  * compatibility shim functions and several tag types are defined below.
 933  * Users that do not require compatibility should use a private cookie value
 934  * so that packet tag-related definitions can be maintained privately.
 935  *
 936  * Note that the packet tag returned by m_tag_alloc has the default memory
 937  * alignment implemented by malloc.  To reference private data one can use a
 938  * construct like:
 939  *
 940  *      struct m_tag *mtag = m_tag_alloc(...);
 941  *      struct foo *p = (struct foo *)(mtag+1);
 942  *
 943  * if the alignment of struct m_tag is sufficient for referencing members of
 944  * struct foo.  Otherwise it is necessary to embed struct m_tag within the
 945  * private data structure to insure proper alignment; e.g.,
 946  *
 947  *      struct foo {
 948  *              struct m_tag    tag;
 949  *              ...
 950  *      };
 951  *      struct foo *p = (struct foo *) m_tag_alloc(...);
 952  *      struct m_tag *mtag = &p->tag;
 953  */
 954
 955 /*
 956  * Persistent tags stay with an mbuf until the mbuf is reclaimed.  Otherwise
 957  * tags are expected to ``vanish'' when they pass through a network
 958  * interface.  For most interfaces this happens normally as the tags are
 959  * reclaimed when the mbuf is free'd.  However in some special cases
 960  * reclaiming must be done manually.  An example is packets that pass through
 961  * the loopback interface.  Also, one must be careful to do this when
 962  * ``turning around'' packets (e.g., icmp_reflect).
 963  *
 964  * To mark a tag persistent bit-or this flag in when defining the tag id.
 965  * The tag will then be treated as described above.
 966  */
 967 #define MTAG_PERSISTENT                         0x800
 968
 969 #define PACKET_TAG_NONE                         0  /* Nadda */
 970
 971 /* Packet tags for use with PACKET_ABI_COMPAT. */
 972 #define PACKET_TAG_IPSEC_IN_DONE                1  /* IPsec applied, in */
 973 #define PACKET_TAG_IPSEC_OUT_DONE               2  /* IPsec applied, out */
 974 #define PACKET_TAG_IPSEC_IN_CRYPTO_DONE         3  /* NIC IPsec crypto done */
 975 #define PACKET_TAG_IPSEC_OUT_CRYPTO_NEEDED      4  /* NIC IPsec crypto req'ed */
 976 #define PACKET_TAG_IPSEC_IN_COULD_DO_CRYPTO     5  /* NIC notifies IPsec */
 977 #define PACKET_TAG_IPSEC_PENDING_TDB            6  /* Reminder to do IPsec */
 978 #define PACKET_TAG_BRIDGE                       7  /* Bridge processing done */
 979 #define PACKET_TAG_GIF                          8  /* GIF processing done */
 980 #define PACKET_TAG_GRE                          9  /* GRE processing done */
 981 #define PACKET_TAG_IN_PACKET_CHECKSUM           10 /* NIC checksumming done */
 982 #define PACKET_TAG_ENCAP                        11 /* Encap.  processing */
 983 #define PACKET_TAG_IPSEC_SOCKET                 12 /* IPSEC socket ref */
 984 #define PACKET_TAG_IPSEC_HISTORY                13 /* IPSEC history */
 985 #define PACKET_TAG_IPV6_INPUT                   14 /* IPV6 input processing */
 986 #define PACKET_TAG_DUMMYNET                     15 /* dummynet info */
 987 #define PACKET_TAG_DIVERT                       17 /* divert info */
 988 #define PACKET_TAG_IPFORWARD                    18 /* ipforward info */
 989 #define PACKET_TAG_MACLABEL     (19 | MTAG_PERSISTENT) /* MAC label */
 990 #define PACKET_TAG_PF           (21 | MTAG_PERSISTENT) /* PF/ALTQ information */
 991 #define PACKET_TAG_RTSOCKFAM                    25 /* rtsock sa family */
 992 #define PACKET_TAG_IPOPTIONS                    27 /* Saved IP options */
 993 #define PACKET_TAG_CARP                         28 /* CARP info */
 994 #define PACKET_TAG_IPSEC_NAT_T_PORTS            29 /* two uint16_t */
 995 #define PACKET_TAG_ND_OUTGOING                  30 /* ND outgoing */
 996
 997 /* Specific cookies and tags. */
 998
 999 /* Packet tag routines. */
1000 struct m_tag    *m_tag_alloc(u_int32_t, int, int, int);
1001 void             m_tag_delete(struct mbuf *, struct m_tag *);
1002 void             m_tag_delete_chain(struct mbuf *, struct m_tag *);
1003 void             m_tag_free_default(struct m_tag *);
1004 struct m_tag    *m_tag_locate(struct mbuf *, u_int32_t, int, struct m_tag *);
1005 struct m_tag    *m_tag_copy(struct m_tag *, int);
1006 int              m_tag_copy_chain(struct mbuf *, struct mbuf *, int);
1007 void             m_tag_delete_nonpersistent(struct mbuf *);
1008
1009 /*
1010  * Initialize the list of tags associated with an mbuf.
1011  */
1012 static __inline void
1013 m_tag_init(struct mbuf *m)
1014 {
1015
1016         SLIST_INIT(&m->m_pkthdr.tags);
1017 }
1018
1019 /*
1020  * Set up the contents of a tag.  Note that this does not fill in the free
1021  * method; the caller is expected to do that.
1022  *
1023  * XXX probably should be called m_tag_init, but that was already taken.
1024  */
1025 static __inline void
1026 m_tag_setup(struct m_tag *t, u_int32_t cookie, int type, int len)
1027 {
1028
1029         t->m_tag_id = type;
1030         t->m_tag_len = len;
1031         t->m_tag_cookie = cookie;
1032 }
1033
1034 /*
1035  * Reclaim resources associated with a tag.
1036  */
1037 static __inline void
1038 m_tag_free(struct m_tag *t)
1039 {
1040
1041         (*t->m_tag_free)(t);
1042 }
1043
1044 /*
1045  * Return the first tag associated with an mbuf.
1046  */
1047 static __inline struct m_tag *
1048 m_tag_first(struct mbuf *m)
1049 {
1050
1051         return (SLIST_FIRST(&m->m_pkthdr.tags));
1052 }
1053
1054 /*
1055  * Return the next tag in the list of tags associated with an mbuf.
1056  */
1057 static __inline struct m_tag *
1058 m_tag_next(struct mbuf *m, struct m_tag *t)
1059 {
1060
1061         return (SLIST_NEXT(t, m_tag_link));
1062 }
1063
1064 /*
1065  * Prepend a tag to the list of tags associated with an mbuf.
1066  */
1067 static __inline void
1068 m_tag_prepend(struct mbuf *m, struct m_tag *t)
1069 {
1070
1071         SLIST_INSERT_HEAD(&m->m_pkthdr.tags, t, m_tag_link);
1072 }
1073
1074 /*
1075  * Unlink a tag from the list of tags associated with an mbuf.
1076  */
1077 static __inline void
1078 m_tag_unlink(struct mbuf *m, struct m_tag *t)
1079 {
1080
1081         SLIST_REMOVE(&m->m_pkthdr.tags, t, m_tag, m_tag_link);
1082 }
1083
1084 /* These are for OpenBSD compatibility. */
1085 #define MTAG_ABI_COMPAT         0               /* compatibility ABI */
1086
1087 static __inline struct m_tag *
1088 m_tag_get(int type, int length, int wait)
1089 {
1090         return (m_tag_alloc(MTAG_ABI_COMPAT, type, length, wait));
1091 }
1092
1093 static __inline struct m_tag *
1094 m_tag_find(struct mbuf *m, int type, struct m_tag *start)
1095 {
1096         return (SLIST_EMPTY(&m->m_pkthdr.tags) ? (struct m_tag *)NULL :
1097             m_tag_locate(m, MTAG_ABI_COMPAT, type, start));
1098 }
1099
1100 /* XXX temporary FIB methods probably eventually use tags.*/
1101 #define M_FIBSHIFT    28
1102 #define M_FIBMASK       0x0F
1103
1104 /* get the fib from an mbuf and if it is not set, return the default */
1105 #define M_GETFIB(_m) \
1106     ((((_m)->m_flags & M_FIB) >> M_FIBSHIFT) & M_FIBMASK)
1107
1108 #define M_SETFIB(_m, _fib) do {                                         \
1109         _m->m_flags &= ~M_FIB;                                          \
1110         _m->m_flags |= (((_fib) << M_FIBSHIFT) & M_FIB);  \
1111 } while (0)
1112
1113 #endif /* _KERNEL */
1114
1115 #ifdef MBUF_PROFILING
1116  void m_profile(struct mbuf *m);
1117  #define M_PROFILE(m) m_profile(m)
1118 #else
1119  #define M_PROFILE(m)
1120 #endif
1121
1122
1123 #endif /* !_SYS_MBUF_H_ */