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