sys/sys/mbuf.h

   1 /*
   2  * Copyright (c) 2004 The DragonFly Project.  All rights reserved.
   3  *
   4  * Copyright (c) 1982, 1986, 1988, 1993
   5  *      The Regents of the University of California.  All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  * 3. Neither the name of the University nor the names of its contributors
  16  *    may be used to endorse or promote products derived from this software
  17  *    without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29  * SUCH DAMAGE.
  30  *
  31  *      @(#)mbuf.h      8.5 (Berkeley) 2/19/95
  32  * $FreeBSD: src/sys/sys/mbuf.h,v 1.44.2.17 2003/04/15 06:15:02 silby Exp $
  33  */
  34
  35 #ifndef _SYS_MBUF_H_
  36 #define _SYS_MBUF_H_
  37
  38 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
  39
  40 #ifndef _SYS_TYPES_H_
  41 #include <sys/types.h>
  42 #endif
  43 #ifndef _SYS_PARAM_H_
  44 #include <sys/param.h>
  45 #endif
  46 #ifndef _SYS_QUEUE_H_
  47 #include <sys/queue.h>
  48 #endif
  49 #ifndef _NET_NETISR_H_
  50 #include <net/netisr.h>
  51 #endif
  52 #ifndef _NET_ETHERNET_H_
  53 #include <net/ethernet.h>
  54 #endif
  55
  56 /*
  57  * Mbufs are of a single size, MSIZE (machine/param.h), which
  58  * includes overhead.  An mbuf may add a single "mbuf cluster" of size
  59  * MCLBYTES (also in machine/param.h), which has no additional overhead
  60  * and is used instead of the internal data area; this is done when
  61  * at least MINCLSIZE of data must be stored.
  62  */
  63 #define MLEN            (MSIZE - sizeof(struct m_hdr))  /* normal data len */
  64 #define MHLEN           (MLEN - sizeof(struct pkthdr))  /* data len w/pkthdr */
  65 #define MINCLSIZE       (MHLEN + 1)     /* smallest amount to put in cluster */
  66 #define M_MAXCOMPRESS   (MHLEN / 2)     /* max amount to copy for compression */
  67
  68 /*
  69  * Macros for type conversion:
  70  * mtod(m, t)           -- Convert mbuf pointer to data pointer of correct type.
  71  * mtodoff(m, t, off)   -- Convert mbuf pointer at the specified offset to data
  72  *                         pointer of correct type.
  73  */
  74 #define mtod(m, t)              ((t)((m)->m_data))
  75 #define mtodoff(m, t, off)      ((t)((m)->m_data + (off)))
  76
  77 /*
  78  * Header present at the beginning of every mbuf.
  79  */
  80 struct m_hdr {
  81         struct  mbuf *mh_next;          /* next buffer in chain */
  82         union {
  83                 struct  mbuf *mh_nextpkt; /* next chain in queue/record */
  84                 STAILQ_ENTRY(mbuf) mh_stailqpkt;
  85         };
  86         caddr_t mh_data;                /* location of data */
  87         int     mh_len;                 /* amount of data in this mbuf */
  88         int     mh_flags;               /* flags; see below */
  89         short   mh_type;                /* type of data in this mbuf */
  90         short   mh_pad;                 /* padding */
  91         /* XXX implicit 4 bytes padding on x86_64 */
  92 #ifdef MBUF_DEBUG
  93         const char *mh_lastfunc;
  94 #endif
  95         union {
  96                 struct netmsg_packet mhm_pkt;   /* hardware->proto stack msg */
  97                 struct netmsg_pru_send mhm_snd; /* usrspace->proto stack msg */
  98                 struct netmsg_inarp mhm_arp;    /* proto stack arpinput msg */
  99                 struct netmsg_ctlinput mhm_ctl; /* proto stack ctlinput msg */
 100                 struct netmsg_genpkt mhm_gen;   /* generic pkt send/recv msg */
 101         } mh_msgu;
 102 };
 103 #define mh_netmsg       mh_msgu.mhm_pkt
 104 #define mh_sndmsg       mh_msgu.mhm_snd
 105 #define mh_arpmsg       mh_msgu.mhm_arp
 106 #define mh_ctlmsg       mh_msgu.mhm_ctl
 107 #define mh_genmsg       mh_msgu.mhm_gen
 108
 109 /* pf stuff */
 110 struct pkthdr_pf {
 111         void            *hdr;           /* saved hdr pos in mbuf, for ECN */
 112         void            *statekey;      /* pf stackside statekey */
 113         u_int           rtableid;       /* alternate routing table id */
 114         uint32_t        qid;            /* queue id */
 115         uint16_t        tag;            /* tag id */
 116         uint8_t         flags;
 117         uint8_t         routed;
 118         uint32_t        state_hash;     /* identifies 'connections' */
 119         uint8_t         ecn_af;         /* for altq_red */
 120         uint8_t         unused01;
 121         uint8_t         unused02;
 122         uint8_t         unused03;
 123         /* XXX implicit 4 bytes padding on x86_64 */
 124 };
 125
 126 /* pkthdr_pf.flags */
 127 #define PF_TAG_GENERATED                0x01
 128 #define PF_TAG_FRAGCACHE                0x02
 129 #define PF_TAG_TRANSLATE_LOCALHOST      0x04
 130 #define PF_TAG_DIVERTED                 0x08
 131 #define PF_TAG_DIVERTED_PACKET          0x10
 132 #define PF_TAG_REROUTE                  0x20
 133
 134 /*
 135  * Packet tag structure (see below for details).
 136  */
 137 struct m_tag {
 138         SLIST_ENTRY(m_tag)      m_tag_link;     /* List of packet tags */
 139         uint16_t                m_tag_id;       /* Tag ID */
 140         uint16_t                m_tag_len;      /* Length of data */
 141         uint32_t                m_tag_cookie;   /* ABI/Module ID */
 142 };
 143
 144 SLIST_HEAD(packet_tags, m_tag);
 145
 146 /*
 147  * Record/packet header in first mbuf of chain; valid only if M_PKTHDR is set.
 148  *
 149  * Be careful: The fields have been carefully ordered to avoid hidden padding.
 150  *             Keep this in mind, when adding or removing fields!
 151  */
 152 struct pkthdr {
 153         struct  ifnet *rcvif;           /* rcv interface */
 154         struct packet_tags tags;        /* list of packet tags */
 155
 156         /* variables for ip and tcp reassembly */
 157         void    *header;                /* pointer to packet header */
 158         int     len;                    /* total packet length */
 159
 160         /* variables for hardware checksum */
 161         int     csum_flags;             /* flags regarding checksum */
 162         int     csum_data;              /* data field used by csum routines */
 163         uint16_t csum_iphlen;           /* IP header length */
 164                                         /* valid if CSUM IP|UDP|TCP|TSO */
 165         uint8_t csum_thlen;             /* TCP/UDP header length */
 166                                         /* valid if CSUM UDP|TCP|TSO */
 167         uint8_t csum_lhlen;             /* link header length */
 168
 169         uint16_t tso_segsz;             /* TSO segment size */
 170         uint16_t ether_vlantag;         /* ethernet 802.1p+q vlan tag */
 171
 172         uint16_t hash;                  /* packet hash */
 173         uint16_t unused1;               /* reserved for route table id */
 174         uint32_t unused2;               /* reserved for codel timestamp */
 175
 176         uint16_t wlan_seqno;            /* IEEE 802.11 seq no. */
 177         /*
 178          * Valid if BRIDGE_MBUF_TAGGED is set in fw_flags, records
 179          * the original ether source address (if compatible).
 180          */
 181         uint8_t ether_br_shost[ETHER_ADDR_LEN];
 182
 183         /* firewall flags */
 184         uint32_t fw_flags;              /* flags for FW */
 185
 186         /* variables for PF processing */
 187         struct pkthdr_pf pf;            /* structure for PF */
 188 };
 189
 190 /*
 191  * Description of external storage mapped into mbuf; valid only if M_EXT is set.
 192  */
 193 struct m_ext {
 194         caddr_t ext_buf;                /* start of buffer */
 195         void    (*ext_free)(void *);
 196         u_int   ext_size;               /* size of buffer, for ext_free */
 197         void    (*ext_ref)(void *);
 198         void    *ext_arg;
 199 };
 200
 201 /*
 202  * The core of the mbuf object along with some shortcut defines for
 203  * practical purposes.
 204  */
 205 struct mbuf {
 206         struct  m_hdr m_hdr;
 207         union {
 208                 struct {
 209                         struct  pkthdr MH_pkthdr;       /* M_PKTHDR set */
 210                         union {
 211                                 struct  m_ext MH_ext;   /* M_EXT set */
 212                                 char    MH_databuf[MHLEN];
 213                         } MH_dat;
 214                 } MH;
 215                 char    M_databuf[MLEN];                /* !M_PKTHDR, !M_EXT */
 216         } M_dat;
 217 };
 218 #define m_next          m_hdr.mh_next
 219 #define m_len           m_hdr.mh_len
 220 #define m_data          m_hdr.mh_data
 221 #define m_type          m_hdr.mh_type
 222 #define m_flags         m_hdr.mh_flags
 223 #define m_nextpkt       m_hdr.mh_nextpkt
 224 #define m_stailqpkt     m_hdr.mh_stailqpkt
 225 #define m_pkthdr        M_dat.MH.MH_pkthdr
 226 #define m_ext           M_dat.MH.MH_dat.MH_ext
 227 #define m_pktdat        M_dat.MH.MH_dat.MH_databuf
 228 #define m_dat           M_dat.M_databuf
 229
 230 /*
 231  * Code that uses m_act should be converted to use m_nextpkt
 232  * instead; m_act is historical and deprecated.
 233  */
 234 #define m_act           m_nextpkt
 235
 236 /*
 237  * mbuf flags.
 238  */
 239 #define M_EXT           0x0001  /* has associated external storage */
 240 #define M_PKTHDR        0x0002  /* start of record */
 241 #define M_EOR           0x0004  /* end of record */
 242 #define M_PROTO1        0x0008  /* protocol-specific */
 243 #define M_PROTO2        0x0010  /* protocol-specific */
 244 #define M_PROTO3        0x0020  /* protocol-specific */
 245 #define M_PROTO4        0x0040  /* protocol-specific */
 246 #define M_PROTO5        0x0080  /* protocol-specific */
 247
 248 /*
 249  * mbuf pkthdr flags (also stored in m_flags).
 250  */
 251 #define M_BCAST         0x0100  /* send/received as link-level broadcast */
 252 #define M_MCAST         0x0200  /* send/received as link-level multicast */
 253 #define M_FRAG          0x0400  /* packet is a fragment of a larger packet */
 254 #define M_FIRSTFRAG     0x0800  /* packet is first fragment */
 255 #define M_LASTFRAG      0x1000  /* packet is last fragment */
 256 #define M_CLCACHE       0x2000  /* mbuf allocated from the cluster cache */
 257 #define M_EXT_CLUSTER   0x4000  /* standard cluster else special */
 258 #define M_PHCACHE       0x8000  /* mbuf allocated from the pkt header cache */
 259 #define M_UNUSED16      0x10000 /* was: notification event (SCTP) */
 260 #define M_VLANTAG       0x20000 /* ether_vlantag is valid */
 261 #define M_MPLSLABELED   0x40000 /* packet is mpls labeled */
 262 #define M_LENCHECKED    0x80000 /* packet proto lengths are checked */
 263 #define M_HASH          0x100000/* hash field in pkthdr is valid */
 264 #define M_PROTO6        0x200000/* protocol-specific */
 265 #define M_PROTO7        0x400000/* protocol-specific */
 266 #define M_PROTO8        0x800000/* protocol-specific */
 267 #define M_CKHASH        0x1000000/* hash needs software verification */
 268 #define M_PRIO          0x2000000/* high priority mbuf */
 269 #define M_SOLOCKED      0x4000000/* locked by userland for read() */
 270
 271 /*
 272  * Flags copied when copying m_pkthdr.
 273  */
 274 #define M_COPYFLAGS     (M_PKTHDR|M_EOR|M_PROTO1|M_PROTO2|M_PROTO3 | \
 275                          M_PROTO4|M_PROTO5|M_PROTO6|M_PROTO7|M_PROTO8 | \
 276                          M_BCAST|M_MCAST|M_FRAG|M_FIRSTFRAG|M_LASTFRAG | \
 277                          M_VLANTAG|M_MPLSLABELED | \
 278                          M_LENCHECKED|M_HASH|M_CKHASH|M_PRIO)
 279
 280 /*
 281  * Flags indicating hw checksum support and sw checksum requirements.
 282  */
 283 #define CSUM_IP                 0x0001          /* will csum IP */
 284 #define CSUM_TCP                0x0002          /* will csum TCP */
 285 #define CSUM_UDP                0x0004          /* will csum UDP */
 286 #define CSUM_IP_FRAGS           0x0008          /* will csum IP fragments */
 287 #define CSUM_FRAGMENT           0x0010          /* will do IP fragmentation */
 288
 289 #define CSUM_IP_CHECKED         0x0100          /* did csum IP */
 290 #define CSUM_IP_VALID           0x0200          /*   ... the csum is valid */
 291 #define CSUM_DATA_VALID         0x0400          /* csum_data field is valid */
 292 #define CSUM_PSEUDO_HDR         0x0800          /* csum_data has pseudo hdr */
 293 #define CSUM_FRAG_NOT_CHECKED   0x1000          /* did _not_ csum fragment
 294                                                  * NB: This flag is only used
 295                                                  * by IP defragmenter.
 296                                                  */
 297 #define CSUM_TSO                0x2000          /* will do TCP segmentation */
 298
 299 #define CSUM_DELAY_DATA         (CSUM_TCP | CSUM_UDP)
 300 #define CSUM_DELAY_IP           (CSUM_IP)       /* XXX add ipv6 here too? */
 301
 302 /*
 303  * Flags indicating PF processing status
 304  */
 305 #define FW_MBUF_GENERATED       0x00000001
 306 #define PF_MBUF_STRUCTURE       0x00000002      /* m_pkthdr.pf valid */
 307 #define PF_MBUF_ROUTED          0x00000004      /* pf_routed field is valid */
 308 #define PF_MBUF_TAGGED          0x00000008
 309 #define IPFW_MBUF_CONTINUE      0x00000010
 310 #define XX_MBUF_UNUSED20        0x00000020
 311 #define IPFORWARD_MBUF_TAGGED   0x00000040
 312 #define DUMMYNET_MBUF_TAGGED    0x00000080
 313 #define BRIDGE_MBUF_TAGGED      0x00000100
 314 #define FW_MBUF_REDISPATCH      0x00000200
 315 #define FW_MBUF_PRIVATE1        0x00000400
 316 #define FW_MBUF_PRIVATE2        0x00000800
 317 #define IPFW_MBUF_GENERATED     FW_MBUF_GENERATED
 318
 319 /*
 320  * mbuf types.
 321  */
 322 #define MT_FREE         0       /* should be on free list */
 323 #define MT_DATA         1       /* dynamic (data) allocation */
 324 #define MT_HEADER       2       /* packet header */
 325 #define MT_SONAME       3       /* socket name */
 326 /* 4 was MT_TAG */
 327 #define MT_CONTROL      5       /* extra-data protocol message */
 328 #define MT_OOBDATA      6       /* expedited data  */
 329 #define MT_NTYPES       7       /* number of mbuf types for mbtypes[] */
 330
 331 /*
 332  * General mbuf allocator statistics structure.
 333  *
 334  * NOTE: Make sure this struct's size is multiple cache line size.
 335  */
 336 struct mbstat {
 337         u_long  m_mbufs;        /* mbufs obtained from page pool */
 338         u_long  m_clusters;     /* clusters obtained from page pool */
 339         u_long  m_jclusters;    /* jclusters obtained from page pool */
 340         u_long  m_clfree;       /* free clusters */
 341         u_long  m_drops;        /* times failed to find space */
 342         u_long  m_wait;         /* times waited for space */
 343         u_long  m_drain;        /* times drained protocols for space */
 344         u_long  m_mcfail;       /* times m_copym failed */
 345         u_long  m_mpfail;       /* times m_pullup failed */
 346         u_long  m_msize;        /* length of an mbuf */
 347         u_long  m_mclbytes;     /* length of an mbuf cluster */
 348         u_long  m_mjumpagesize; /* length of a jumbo mbuf cluster */
 349         u_long  m_minclsize;    /* min length of data to allocate a cluster */
 350         u_long  m_mlen;         /* length of data in an mbuf */
 351         u_long  m_mhlen;        /* length of data in a header mbuf */
 352         u_long  m_pad;          /* pad to cache line size (64B) */
 353 };
 354
 355 /*
 356  * objcache(9) ocflags sanitizing
 357  */
 358 #define MB_OCFLAG(how)  ((how) & M_WAITOK ? M_WAITOK : M_NOWAIT)
 359
 360 /*
 361  * These are identifying numbers passed to the m_mballoc_wait function,
 362  * allowing us to determine whether the call came from an MGETHDR or
 363  * an MGET.
 364  */
 365 #define MGETHDR_C      1
 366 #define MGET_C         2
 367
 368 /*
 369  * mbuf allocation/deallocation macros (YYY deprecated, too big):
 370  *
 371  *      MGET(struct mbuf *m, int how, int type)
 372  * allocates an mbuf and initializes it to contain internal data.
 373  *
 374  *      MGETHDR(struct mbuf *m, int how, int type)
 375  * allocates an mbuf and initializes it to contain a packet header
 376  * and internal data.
 377  */
 378 #define MGET(m, how, type) do {                                         \
 379         (m) = m_get((how), (type));                                     \
 380 } while (0)
 381
 382 #define MGETHDR(m, how, type) do {                                      \
 383         (m) = m_gethdr((how), (type));                                  \
 384 } while (0)
 385
 386 /*
 387  * MCLGET adds such clusters to a normal mbuf.  The flag M_EXT is set upon
 388  * success.
 389  * Deprecated.  Use m_getcl() or m_getl() instead.
 390  */
 391 #define MCLGET(m, how) do {                                             \
 392         m_mclget((m), (how));                                           \
 393 } while (0)
 394
 395 /*
 396  * NB: M_COPY_PKTHDR is deprecated; use either M_MOVE_PKTHDR
 397  *     or m_dup_pkthdr.
 398  */
 399 /*
 400  * Move mbuf pkthdr from "from" to "to".
 401  * from should have M_PKTHDR set, and to must be empty.
 402  * from no longer has a pkthdr after this operation.
 403  */
 404 #define M_MOVE_PKTHDR(_to, _from)       m_move_pkthdr((_to), (_from))
 405
 406 /*
 407  * Set the m_data pointer of a newly-allocated mbuf (m_get/MGET) to place
 408  * an object of the specified size at the end of the mbuf, longword aligned.
 409  */
 410 #define M_ALIGN(m, len) do {                                            \
 411         (m)->m_data += (MLEN - (len)) & ~(sizeof(long) - 1);            \
 412 } while (0)
 413
 414 /*
 415  * As above, for mbufs allocated with m_gethdr/MGETHDR
 416  * or initialized by M_COPY_PKTHDR.
 417  */
 418 #define MH_ALIGN(m, len) do {                                           \
 419         (m)->m_data += (MHLEN - (len)) & ~(sizeof(long) - 1);           \
 420 } while (0)
 421
 422 /*
 423  * Check if we can write to an mbuf.
 424  */
 425 #define M_EXT_WRITABLE(m)       (m_sharecount(m) == 1)
 426 #define M_WRITABLE(m)           (!((m)->m_flags & M_EXT) || M_EXT_WRITABLE(m))
 427
 428 /*
 429  * Check if the supplied mbuf has a packet header, or else panic.
 430  */
 431 #define M_ASSERTPKTHDR(m)                                               \
 432         KASSERT(m != NULL && m->m_flags & M_PKTHDR,                     \
 433                 ("%s: invalid mbuf or no mbuf packet header!", __func__))
 434
 435 /*
 436  * Compute the amount of space available before the current start of data.
 437  * The M_EXT_WRITABLE() is a temporary, conservative safety measure: the burden
 438  * of checking writability of the mbuf data area rests solely with the caller.
 439  */
 440 #define M_LEADINGSPACE(m)                                               \
 441         ((m)->m_flags & M_EXT ?                                         \
 442             (M_EXT_WRITABLE(m) ? (m)->m_data - (m)->m_ext.ext_buf : 0): \
 443             (m)->m_flags & M_PKTHDR ? (m)->m_data - (m)->m_pktdat :     \
 444             (m)->m_data - (m)->m_dat)
 445
 446 /*
 447  * Compute the amount of space available after the end of data in an mbuf.
 448  * The M_WRITABLE() is a temporary, conservative safety measure: the burden
 449  * of checking writability of the mbuf data area rests solely with the caller.
 450  */
 451 #define M_TRAILINGSPACE(m)                                              \
 452         ((m)->m_flags & M_EXT ?                                         \
 453             (M_WRITABLE(m) ? (m)->m_ext.ext_buf + (m)->m_ext.ext_size   \
 454                 - ((m)->m_data + (m)->m_len) : 0) :                     \
 455             &(m)->m_dat[MLEN] - ((m)->m_data + (m)->m_len))
 456
 457 /*
 458  * Arrange to prepend space of size plen to mbuf m.
 459  * If a new mbuf must be allocated, how specifies whether to wait.
 460  * If how is M_NOWAIT and allocation fails, the original mbuf chain
 461  * is freed and m is set to NULL.
 462  */
 463 #define M_PREPEND(m, plen, how) do {                                    \
 464         struct mbuf **_mmp = &(m);                                      \
 465         struct mbuf *_mm = *_mmp;                                       \
 466         int _mplen = (plen);                                            \
 467         int __mhow = (how);                                             \
 468                                                                         \
 469         if (M_LEADINGSPACE(_mm) >= _mplen) {                            \
 470                 _mm->m_data -= _mplen;                                  \
 471                 _mm->m_len += _mplen;                                   \
 472         } else                                                          \
 473                 _mm = m_prepend(_mm, _mplen, __mhow);                   \
 474         if (_mm != NULL && (_mm->m_flags & M_PKTHDR))                   \
 475                 _mm->m_pkthdr.len += _mplen;                            \
 476         *_mmp = _mm;                                                    \
 477 } while (0)
 478
 479 /* Length to m_copy to copy all. */
 480 #define M_COPYALL       1000000000
 481
 482 /* Compatibility with 4.3 */
 483 #define m_copy(m, o, l) m_copym((m), (o), (l), M_NOWAIT)
 484
 485 #ifdef _KERNEL
 486 extern  u_int            m_clalloc_wid; /* mbuf cluster wait count */
 487 extern  u_int            m_mballoc_wid; /* mbuf wait count */
 488 extern  int              max_linkhdr;   /* largest link-level header */
 489 extern  int              max_protohdr;  /* largest protocol header */
 490 extern  int              max_hdr;       /* largest link+protocol header */
 491 extern  int              max_datalen;   /* MHLEN - max_hdr */
 492 extern  int              mbuf_wait;     /* mbuf sleep time */
 493 extern  int              nmbclusters;
 494 extern  int              nmbufs;
 495
 496 struct uio;
 497
 498 void             mcl_inclimit(int);
 499 void             mjcl_inclimit(int);
 500 void             mb_inclimit(int);
 501 void             m_adj(struct mbuf *, int);
 502 void             m_align(struct mbuf *, int);
 503 int              m_apply(struct mbuf *, int, int,
 504                     int (*)(void *, void *, u_int), void *);
 505 int             m_append(struct mbuf *, int, c_caddr_t);
 506 void             m_cat(struct mbuf *, struct mbuf *);
 507 u_int            m_countm(struct mbuf *m, struct mbuf **lastm, u_int *mbcnt);
 508 void             m_copyback(struct mbuf *, int, int, caddr_t);
 509 void             m_copydata(const struct mbuf *, int, int, caddr_t);
 510 struct  mbuf    *m_copym(const struct mbuf *, int, int, int);
 511 struct  mbuf    *m_copypacket(struct mbuf *, int);
 512 struct  mbuf    *m_defrag(struct mbuf *, int);
 513 struct  mbuf    *m_defrag_nofree(struct mbuf *, int);
 514 struct  mbuf    *m_devget(char *, int, int, struct ifnet *);
 515 struct  mbuf    *m_dup(struct mbuf *, int);
 516 struct  mbuf    *m_dup_data(struct mbuf *, int);
 517 int              m_dup_pkthdr(struct mbuf *, const struct mbuf *, int);
 518 void             m_extadd(struct mbuf *, caddr_t, u_int, void (*)(void *),
 519                   void (*)(void *), void *);
 520 #ifdef MBUF_DEBUG
 521 struct  mbuf    *_m_free(struct mbuf *, const char *name);
 522 void             _m_freem(struct mbuf *, const char *name);
 523 #else
 524 struct  mbuf    *m_free(struct mbuf *);
 525 void             m_freem(struct mbuf *);
 526 #endif
 527 struct  mbuf    *m_get(int, int);
 528 struct  mbuf    *m_getc(int len, int how, int type);
 529 struct  mbuf    *m_getcl(int how, short type, int flags);
 530 struct  mbuf    *m_getjcl(int how, short type, int flags, size_t size);
 531 struct  mbuf    *m_getclr(int, int);
 532 struct  mbuf    *m_gethdr(int, int);
 533 struct  mbuf    *m_getm(struct mbuf *, int, int, int);
 534 struct  mbuf    *m_getptr(struct mbuf *, int, int *);
 535 struct  mbuf    *m_last(struct mbuf *m);
 536 u_int            m_lengthm(struct mbuf *m, struct mbuf **lastm);
 537 void             m_move_pkthdr(struct mbuf *, struct mbuf *);
 538 struct  mbuf    *m_prepend(struct mbuf *, int, int);
 539 void             m_print(const struct mbuf *m);
 540 struct  mbuf    *m_pulldown(struct mbuf *, int, int, int *);
 541 struct  mbuf    *m_pullup(struct mbuf *, int);
 542 struct  mbuf    *m_split(struct mbuf *, int, int);
 543 struct  mbuf    *m_uiomove(struct uio *);
 544 struct  mbuf    *m_unshare(struct mbuf *, int);
 545 void            m_mclget(struct mbuf *m, int how);
 546 int             m_sharecount(struct mbuf *m);
 547 void            m_chtype(struct mbuf *m, int type);
 548 int             m_devpad(struct mbuf *m, int padto);
 549
 550 #ifdef MBUF_DEBUG
 551
 552 void            mbuftrackid(struct mbuf *, int);
 553
 554 #define m_free(m)       _m_free(m, __func__)
 555 #define m_freem(m)      _m_freem(m, __func__)
 556
 557 #else
 558
 559 #define mbuftrackid(m, id)      /* empty */
 560
 561 #endif
 562
 563 static __inline void
 564 m_sethash(struct mbuf *m, uint16_t hash)
 565 {
 566         m->m_flags |= M_HASH;
 567         m->m_pkthdr.hash = hash;
 568 }
 569
 570 /*
 571  * Allocate the right type of mbuf for the desired total length.
 572  * The mbuf returned does not necessarily cover the entire requested length.
 573  * This function follows mbuf chaining policy of allowing MINCLSIZE
 574  * amount of chained mbufs.
 575  */
 576 static __inline struct mbuf *
 577 m_getl(int len, int how, int type, int flags, int *psize)
 578 {
 579         struct mbuf *m;
 580         int size;
 581
 582         if (len >= MINCLSIZE) {
 583                 m = m_getcl(how, type, flags);
 584                 size = MCLBYTES;
 585         } else if (flags & M_PKTHDR) {
 586                 m = m_gethdr(how, type);
 587                 size = MHLEN;
 588         } else {
 589                 m = m_get(how, type);
 590                 size = MLEN;
 591         }
 592         if (psize != NULL)
 593                 *psize = size;
 594         return (m);
 595 }
 596
 597 static __inline struct mbuf *
 598 m_getlj(int len, int how, int type, int flags, int *psize)
 599 {
 600         if (len > MCLBYTES) {
 601                 struct mbuf *m;
 602
 603                 m = m_getjcl(how, type, flags, MJUMPAGESIZE);
 604                 if (psize != NULL)
 605                         *psize = MJUMPAGESIZE;
 606                 return m;
 607         }
 608         return m_getl(len, how, type, flags, psize);
 609 }
 610
 611 /*
 612  * Get a single mbuf that covers the requested number of bytes.
 613  * This function does not create mbuf chains.  It explicitly marks
 614  * places in the code that abuse mbufs for contiguous data buffers.
 615  */
 616 static __inline struct mbuf *
 617 m_getb(int len, int how, int type, int flags)
 618 {
 619         struct mbuf *m;
 620         int mbufsize = (flags & M_PKTHDR) ? MHLEN : MLEN;
 621
 622         if (len > mbufsize)
 623                 m = m_getcl(how, type, flags);
 624         else if (flags & M_PKTHDR)
 625                 m = m_gethdr(how, type);
 626         else
 627                 m = m_get(how, type);
 628         return (m);
 629 }
 630
 631 /*
 632  * Packets may have annotations attached by affixing a list
 633  * of "packet tags" to the pkthdr structure.  Packet tags are
 634  * dynamically allocated semi-opaque data structures that have
 635  * a fixed header (struct m_tag) that specifies the size of the
 636  * memory block and a <cookie,type> pair that identifies it.
 637  * The cookie is a 32-bit unique unsigned value used to identify
 638  * a module or ABI.  By convention this value is chose as the
 639  * date+time that the module is created, expressed as the number of
 640  * seconds since the epoch (e.g. using date -u +'%s').  The type value
 641  * is an ABI/module-specific value that identifies a particular annotation
 642  * and is private to the module.  For compatibility with systems
 643  * like openbsd that define packet tags w/o an ABI/module cookie,
 644  * the value PACKET_ABI_COMPAT is used to implement m_tag_get and
 645  * m_tag_find compatibility shim functions and several tag types are
 646  * defined below.  Users that do not require compatibility should use
 647  * a private cookie value so that packet tag-related definitions
 648  * can be maintained privately.
 649  *
 650  * Note that the packet tag returned by m_tag_alloc has the default
 651  * memory alignment implemented by kmalloc.  To reference private data
 652  * one can use a construct like:
 653  *
 654  *      struct m_tag *mtag = m_tag_alloc(...);
 655  *      struct foo *p = m_tag_data(mtag);
 656  *
 657  * if the alignment of struct m_tag is sufficient for referencing members
 658  * of struct foo.  Otherwise it is necessary to embed struct m_tag within
 659  * the private data structure to insure proper alignment; e.g.
 660  *
 661  *      struct foo {
 662  *              struct m_tag    tag;
 663  *              ...
 664  *      };
 665  *      struct foo *p = (struct foo *)m_tag_alloc(...);
 666  *      struct m_tag *mtag = &p->tag;
 667  */
 668
 669 #define PACKET_TAG_NONE                         0  /* Nadda */
 670
 671 /* Packet tag for use with PACKET_ABI_COMPAT */
 672 #define PACKET_TAG_IPSEC_IN_DONE                1  /* IPsec applied, in */
 673 /* struct tdb_indent */
 674 #define PACKET_TAG_IPSEC_OUT_DONE               2  /* IPsec applied, out */
 675 /* struct tdb_indent */
 676 #define PACKET_TAG_IPSEC_IN_CRYPTO_DONE         3  /* NIC IPsec crypto done */
 677 /* struct tdb_indent, never added */
 678 #define PACKET_TAG_IPSEC_OUT_CRYPTO_NEEDED      4  /* NIC IPsec crypto req'ed */
 679 /* struct tdb_indent, never added */
 680 #define PACKET_TAG_IPSEC_PENDING_TDB            5  /* Reminder to do IPsec */
 681 /* struct tdb_indent, never added */
 682 #define PACKET_TAG_ENCAP                        6 /* Encap.  processing */
 683 /* struct ifnet *, the GIF interface */
 684 #define PACKET_TAG_IPSEC_HISTORY                7 /* IPSEC history */
 685 /* struct ipsec_history */
 686 #define PACKET_TAG_IPV6_INPUT                   8 /* IPV6 input processing */
 687 /* struct ip6aux */
 688 #define PACKET_TAG_IPFW_DIVERT                  9 /* divert info */
 689 /* struct divert_info */
 690 #define PACKET_TAG_DUMMYNET                     15 /* dummynet info */
 691 /* struct dn_pkt */
 692 #define PACKET_TAG_IPFORWARD                    18 /* ipforward info */
 693 /* struct sockaddr_in */
 694 #define PACKET_TAG_IPSRCRT                      27 /* IP srcrt opts */
 695 /* struct ip_srcrt_opt */
 696 #define PACKET_TAG_CARP                         28 /* CARP info */
 697 /* struct pf_mtag */
 698 #define PACKET_TAG_PF                           29 /* PF info */
 699
 700 #define PACKET_TAG_PF_DIVERT                    0x0200 /* pf(4) diverted packet */
 701
 702
 703 /* Packet tag routines */
 704 struct  m_tag   *m_tag_alloc(uint32_t, int, int, int);
 705 void             m_tag_free(struct m_tag *);
 706 void             m_tag_prepend(struct mbuf *, struct m_tag *);
 707 void             m_tag_unlink(struct mbuf *, struct m_tag *);
 708 void             m_tag_delete(struct mbuf *, struct m_tag *);
 709 void             m_tag_delete_chain(struct mbuf *);
 710 struct  m_tag   *m_tag_locate(struct mbuf *, uint32_t, int, struct m_tag *);
 711 struct  m_tag   *m_tag_copy(struct m_tag *, int);
 712 int              m_tag_copy_chain(struct mbuf *, const struct mbuf *, int);
 713 void             m_tag_init(struct mbuf *);
 714 struct  m_tag   *m_tag_first(struct mbuf *);
 715 struct  m_tag   *m_tag_next(struct mbuf *, struct m_tag *);
 716
 717 /* these are for openbsd compatibility */
 718 #define MTAG_ABI_COMPAT         0               /* compatibility ABI */
 719
 720 static __inline void *
 721 m_tag_data(struct m_tag *tag)
 722 {
 723         return ((void *)(tag + 1));
 724 }
 725
 726 static __inline struct m_tag *
 727 m_tag_get(int type, int length, int mflags)
 728 {
 729         return m_tag_alloc(MTAG_ABI_COMPAT, type, length, mflags);
 730 }
 731
 732 static __inline struct m_tag *
 733 m_tag_find(struct mbuf *m, int type, struct m_tag *start)
 734 {
 735         return m_tag_locate(m, MTAG_ABI_COMPAT, type, start);
 736 }
 737
 738 struct mbufq {
 739         STAILQ_HEAD(, mbuf)     mq_head;
 740         int                     mq_len;
 741         int                     mq_maxlen;
 742 };
 743
 744 static inline void
 745 mbufq_init(struct mbufq *mq, int maxlen)
 746 {
 747
 748         STAILQ_INIT(&mq->mq_head);
 749         mq->mq_maxlen = maxlen;
 750         mq->mq_len = 0;
 751 }
 752
 753 static inline struct mbuf *
 754 mbufq_flush(struct mbufq *mq)
 755 {
 756         struct mbuf *m;
 757
 758         m = STAILQ_FIRST(&mq->mq_head);
 759         STAILQ_INIT(&mq->mq_head);
 760         mq->mq_len = 0;
 761         return (m);
 762 }
 763
 764 static inline void
 765 mbufq_drain(struct mbufq *mq)
 766 {
 767         struct mbuf *m, *n;
 768
 769         n = mbufq_flush(mq);
 770         while ((m = n) != NULL) {
 771                 n = STAILQ_NEXT(m, m_stailqpkt);
 772                 m_freem(m);
 773         }
 774 }
 775
 776 static inline struct mbuf *
 777 mbufq_first(const struct mbufq *mq)
 778 {
 779
 780         return (STAILQ_FIRST(&mq->mq_head));
 781 }
 782
 783 static inline struct mbuf *
 784 mbufq_last(const struct mbufq *mq)
 785 {
 786
 787         return (STAILQ_LAST(&mq->mq_head, mbuf, m_stailqpkt));
 788 }
 789
 790 static inline int
 791 mbufq_full(const struct mbufq *mq)
 792 {
 793
 794         return (mq->mq_len >= mq->mq_maxlen);
 795 }
 796
 797 static inline int
 798 mbufq_len(const struct mbufq *mq)
 799 {
 800
 801         return (mq->mq_len);
 802 }
 803
 804 static inline int
 805 mbufq_enqueue(struct mbufq *mq, struct mbuf *m)
 806 {
 807
 808         if (mbufq_full(mq))
 809                 return (ENOBUFS);
 810         STAILQ_INSERT_TAIL(&mq->mq_head, m, m_stailqpkt);
 811         mq->mq_len++;
 812         return (0);
 813 }
 814
 815 static inline struct mbuf *
 816 mbufq_dequeue(struct mbufq *mq)
 817 {
 818         struct mbuf *m;
 819
 820         m = STAILQ_FIRST(&mq->mq_head);
 821         if (m) {
 822                 STAILQ_REMOVE_HEAD(&mq->mq_head, m_stailqpkt);
 823                 m->m_nextpkt = NULL;
 824                 mq->mq_len--;
 825         }
 826         return (m);
 827 }
 828
 829 static inline void
 830 mbufq_prepend(struct mbufq *mq, struct mbuf *m)
 831 {
 832
 833         STAILQ_INSERT_HEAD(&mq->mq_head, m, m_stailqpkt);
 834         mq->mq_len++;
 835 }
 836
 837 #endif  /* _KERNEL */
 838
 839 #endif  /* _KERNEL || _KERNEL_STRUCTURES */
 840 #endif  /* !_SYS_MBUF_H_ */