sys/sys/mbuf.h

   1 /*
   2  * Copyright (c) 1982, 1986, 1988, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 3. All advertising materials mentioning features or use of this software
  14  *    must display the following acknowledgement:
  15  *      This product includes software developed by the University of
  16  *      California, Berkeley and its contributors.
  17  * 4. Neither the name of the University nor the names of its contributors
  18  *    may be used to endorse or promote products derived from this software
  19  *    without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  *
  33  *      @(#)mbuf.h      8.5 (Berkeley) 2/19/95
  34  * $FreeBSD: src/sys/sys/mbuf.h,v 1.44.2.17 2003/04/15 06:15:02 silby Exp $
  35  * $DragonFly: src/sys/sys/mbuf.h,v 1.13 2004/07/29 08:46:22 dillon Exp $
  36  */
  37
  38 #ifndef _SYS_MBUF_H_
  39 #define _SYS_MBUF_H_
  40
  41 #include <sys/queue.h>
  42
  43 /*
  44  * Mbufs are of a single size, MSIZE (machine/param.h), which
  45  * includes overhead.  An mbuf may add a single "mbuf cluster" of size
  46  * MCLBYTES (also in machine/param.h), which has no additional overhead
  47  * and is used instead of the internal data area; this is done when
  48  * at least MINCLSIZE of data must be stored.
  49  */
  50 #define MLEN            (MSIZE - sizeof(struct m_hdr))  /* normal data len */
  51 #define MHLEN           (MLEN - sizeof(struct pkthdr))  /* data len w/pkthdr */
  52 #define MINCLSIZE       (MHLEN + 1)     /* smallest amount to put in cluster */
  53 #define M_MAXCOMPRESS   (MHLEN / 2)     /* max amount to copy for compression */
  54
  55 /*
  56  * Macros for type conversion:
  57  * mtod(m, t)   -- Convert mbuf pointer to data pointer of correct type.
  58  * mtocl(x) -   convert pointer within cluster to cluster index #
  59  * cltom(x) -   convert cluster # to ptr to beginning of cluster
  60  */
  61 #define mtod(m, t)      ((t)((m)->m_data))
  62 #define mtocl(x)        (((uintptr_t)(x) - (uintptr_t)mbutl) >> MCLSHIFT)
  63 #define cltom(x)        ((caddr_t)((uintptr_t)mbutl + \
  64                             ((uintptr_t)(x) << MCLSHIFT)))
  65
  66 /*
  67  * Header present at the beginning of every mbuf.
  68  */
  69 struct m_hdr {
  70         struct  mbuf *mh_next;          /* next buffer in chain */
  71         struct  mbuf *mh_nextpkt;       /* next chain in queue/record */
  72         caddr_t mh_data;                /* location of data */
  73         int     mh_len;                 /* amount of data in this mbuf */
  74         short   mh_type;                /* type of data in this mbuf */
  75         short   mh_flags;               /* flags; see below */
  76 };
  77
  78 /*
  79  * Packet tag structure (see below for details).
  80  */
  81 struct m_tag {
  82         SLIST_ENTRY(m_tag)      m_tag_link;     /* List of packet tags */
  83         u_int16_t               m_tag_id;       /* Tag ID */
  84         u_int16_t               m_tag_len;      /* Length of data */
  85         u_int32_t               m_tag_cookie;   /* ABI/Module ID */
  86 };
  87
  88 /*
  89  * Record/packet header in first mbuf of chain; valid only if M_PKTHDR is set.
  90  */
  91 struct pkthdr {
  92         struct  ifnet *rcvif;           /* rcv interface */
  93         int     len;                    /* total packet length */
  94         /* variables for ip and tcp reassembly */
  95         void    *header;                /* pointer to packet header */
  96         /* variables for hardware checksum */
  97         int     csum_flags;             /* flags regarding checksum */
  98         int     csum_data;              /* data field used by csum routines */
  99         SLIST_HEAD(packet_tags, m_tag) tags; /* list of packet tags */
 100 };
 101
 102 /*
 103  * Description of external storage mapped into mbuf; valid only if M_EXT is set.
 104  */
 105 struct m_ext {
 106         caddr_t ext_buf;                /* start of buffer */
 107         union {
 108             void (*old)(caddr_t, u_int);
 109             void (*new)(void *arg);
 110             void *any;
 111         } ext_nfree;
 112         u_int   ext_size;               /* size of buffer, for ext_nfree */
 113         union {
 114             void (*old)(caddr_t, u_int);
 115             void (*new)(void *arg);
 116             void *any;
 117         } ext_nref;
 118         void    *ext_arg;
 119 };
 120
 121 /*
 122  * The core of the mbuf object along with some shortcut defines for
 123  * practical purposes.
 124  */
 125 struct mbuf {
 126         struct  m_hdr m_hdr;
 127         union {
 128                 struct {
 129                         struct  pkthdr MH_pkthdr;       /* M_PKTHDR set */
 130                         union {
 131                                 struct  m_ext MH_ext;   /* M_EXT set */
 132                                 char    MH_databuf[MHLEN];
 133                         } MH_dat;
 134                 } MH;
 135                 char    M_databuf[MLEN];                /* !M_PKTHDR, !M_EXT */
 136         } M_dat;
 137 };
 138 #define m_next          m_hdr.mh_next
 139 #define m_len           m_hdr.mh_len
 140 #define m_data          m_hdr.mh_data
 141 #define m_type          m_hdr.mh_type
 142 #define m_flags         m_hdr.mh_flags
 143 #define m_nextpkt       m_hdr.mh_nextpkt
 144 #define m_pkthdr        M_dat.MH.MH_pkthdr
 145 #define m_ext           M_dat.MH.MH_dat.MH_ext
 146 #define m_pktdat        M_dat.MH.MH_dat.MH_databuf
 147 #define m_dat           M_dat.M_databuf
 148
 149 /*
 150  * Code that uses m_act should be converted to use m_nextpkt
 151  * instead; m_act is historical and deprecated.
 152  */
 153 #define m_act           m_nextpkt
 154
 155 /*
 156  * mbuf flags.
 157  */
 158 #define M_EXT           0x0001  /* has associated external storage */
 159 #define M_PKTHDR        0x0002  /* start of record */
 160 #define M_EOR           0x0004  /* end of record */
 161 #define M_PROTO1        0x0008  /* protocol-specific */
 162 #define M_PROTO2        0x0010  /* protocol-specific */
 163 #define M_PROTO3        0x0020  /* protocol-specific */
 164 #define M_PROTO4        0x0040  /* protocol-specific */
 165 #define M_PROTO5        0x0080  /* protocol-specific */
 166
 167 /*
 168  * mbuf pkthdr flags (also stored in m_flags).
 169  */
 170 #define M_BCAST         0x0100  /* send/received as link-level broadcast */
 171 #define M_MCAST         0x0200  /* send/received as link-level multicast */
 172 #define M_FRAG          0x0400  /* packet is a fragment of a larger packet */
 173 #define M_FIRSTFRAG     0x0800  /* packet is first fragment */
 174 #define M_LASTFRAG      0x1000  /* packet is last fragment */
 175 #define M_EXT_OLD       0x2000  /* new ext function format */
 176
 177 /*
 178  * Flags copied when copying m_pkthdr.
 179  */
 180 #define M_COPYFLAGS     (M_PKTHDR|M_EOR|M_PROTO1|M_PROTO1|M_PROTO2|M_PROTO3 | \
 181                             M_PROTO4|M_PROTO5|M_BCAST|M_MCAST|M_FRAG | \
 182                             M_FIRSTFRAG|M_LASTFRAG)
 183
 184 /*
 185  * Flags indicating hw checksum support and sw checksum requirements.
 186  */
 187 #define CSUM_IP                 0x0001          /* will csum IP */
 188 #define CSUM_TCP                0x0002          /* will csum TCP */
 189 #define CSUM_UDP                0x0004          /* will csum UDP */
 190 #define CSUM_IP_FRAGS           0x0008          /* will csum IP fragments */
 191 #define CSUM_FRAGMENT           0x0010          /* will do IP fragmentation */
 192
 193 #define CSUM_IP_CHECKED         0x0100          /* did csum IP */
 194 #define CSUM_IP_VALID           0x0200          /*   ... the csum is valid */
 195 #define CSUM_DATA_VALID         0x0400          /* csum_data field is valid */
 196 #define CSUM_PSEUDO_HDR         0x0800          /* csum_data has pseudo hdr */
 197
 198 #define CSUM_DELAY_DATA         (CSUM_TCP | CSUM_UDP)
 199 #define CSUM_DELAY_IP           (CSUM_IP)       /* XXX add ipv6 here too? */
 200
 201 /*
 202  * mbuf types.
 203  */
 204 #define MT_FREE         0       /* should be on free list */
 205 #define MT_DATA         1       /* dynamic (data) allocation */
 206 #define MT_HEADER       2       /* packet header */
 207 #if 0
 208 #define MT_SOCKET       3       /* socket structure */
 209 #define MT_PCB          4       /* protocol control block */
 210 #define MT_RTABLE       5       /* routing tables */
 211 #define MT_HTABLE       6       /* IMP host tables */
 212 #define MT_ATABLE       7       /* address resolution tables */
 213 #endif
 214 #define MT_SONAME       8       /* socket name */
 215 #if 0
 216 #define MT_SOOPTS       10      /* socket options */
 217 #endif
 218 #define MT_FTABLE       11      /* fragment reassembly header */
 219 #if 0
 220 #define MT_RIGHTS       12      /* access rights */
 221 #define MT_IFADDR       13      /* interface address */
 222 #endif
 223 #define MT_TAG          13      /* volatile metadata associated to pkts */
 224 #define MT_CONTROL      14      /* extra-data protocol message */
 225 #define MT_OOBDATA      15      /* expedited data  */
 226 #define MT_NTYPES       16      /* number of mbuf types for mbtypes[] */
 227
 228 /*
 229  * General mbuf allocator statistics structure.
 230  */
 231 struct mbstat {
 232         u_long  m_mbufs;        /* mbufs obtained from page pool */
 233         u_long  m_clusters;     /* clusters obtained from page pool */
 234         u_long  m_spare;        /* spare field */
 235         u_long  m_clfree;       /* free clusters */
 236         u_long  m_drops;        /* times failed to find space */
 237         u_long  m_wait;         /* times waited for space */
 238         u_long  m_drain;        /* times drained protocols for space */
 239         u_long  m_mcfail;       /* times m_copym failed */
 240         u_long  m_mpfail;       /* times m_pullup failed */
 241         u_long  m_msize;        /* length of an mbuf */
 242         u_long  m_mclbytes;     /* length of an mbuf cluster */
 243         u_long  m_minclsize;    /* min length of data to allocate a cluster */
 244         u_long  m_mlen;         /* length of data in an mbuf */
 245         u_long  m_mhlen;        /* length of data in a header mbuf */
 246 };
 247
 248 /*
 249  * Flags specifying how an allocation should be made.
 250  */
 251
 252 #define MB_DONTWAIT     0x4
 253 #define MB_TRYWAIT      0x8
 254 #define MB_WAIT         MB_TRYWAIT
 255
 256 /*
 257  * Mbuf to Malloc Flag Conversion.
 258  */
 259 #define MBTOM(how)      ((how) & MB_TRYWAIT ? M_WAITOK : M_NOWAIT)
 260
 261 /* Freelists:
 262  *
 263  * Normal mbuf clusters are normally treated as character arrays
 264  * after allocation, but use the first word of the buffer as a free list
 265  * pointer while on the free list.
 266  */
 267 union mcluster {
 268         union   mcluster *mcl_next;
 269         char    mcl_buf[MCLBYTES];
 270 };
 271
 272
 273 /*
 274  * These are identifying numbers passed to the m_mballoc_wait function,
 275  * allowing us to determine whether the call came from an MGETHDR or
 276  * an MGET.
 277  */
 278 #define MGETHDR_C      1
 279 #define MGET_C         2
 280
 281 /*
 282  * Wake up the next instance (if any) of m_mballoc_wait() which is
 283  * waiting for an mbuf to be freed.  This should be called at splimp().
 284  *
 285  * XXX: If there is another free mbuf, this routine will be called [again]
 286  * from the m_mballoc_wait routine in order to wake another sleep instance.
 287  */
 288 #define MMBWAKEUP() do {                                                \
 289         if (m_mballoc_wid) {                                            \
 290                 m_mballoc_wid--;                                        \
 291                 wakeup_one(&m_mballoc_wid);                             \
 292         }                                                               \
 293 } while (0)
 294
 295 /*
 296  * Same as above, but for mbuf cluster(s).
 297  */
 298 #define MCLWAKEUP() do {                                                \
 299         if (m_clalloc_wid) {                                            \
 300                 m_clalloc_wid--;                                        \
 301                 wakeup_one(&m_clalloc_wid);                             \
 302         }                                                               \
 303 } while (0)
 304
 305 /*
 306  * mbuf utility macros:
 307  *
 308  *      MBUFLOCK(code)
 309  * prevents a section of code from from being interrupted by network
 310  * drivers.
 311  */
 312 #define MBUFLOCK(code) do {                                             \
 313         int _ms = splimp();                                             \
 314                                                                         \
 315         { code }                                                        \
 316         splx(_ms);                                                      \
 317 } while (0)
 318
 319 /*
 320  * mbuf allocation/deallocation macros (YYY deprecated, too big):
 321  *
 322  *      MGET(struct mbuf *m, int how, int type)
 323  * allocates an mbuf and initializes it to contain internal data.
 324  *
 325  *      MGETHDR(struct mbuf *m, int how, int type)
 326  * allocates an mbuf and initializes it to contain a packet header
 327  * and internal data.
 328  */
 329 #define MGET(m, how, type) do {                                         \
 330         (m) = m_get((how), (type));                                     \
 331 } while (0)
 332
 333 #define MGETHDR(m, how, type) do {                                      \
 334         (m) = m_gethdr((how), (type));                                  \
 335 } while (0)
 336
 337 /*
 338  * Mbuf cluster macros.
 339  * MCLALLOC(caddr_t p, int how) allocates an mbuf cluster.
 340  * MCLGET adds such clusters to a normal mbuf;
 341  * the flag M_EXT is set upon success.
 342  * MCLFREE releases a reference to a cluster allocated by MCLALLOC,
 343  * freeing the cluster if the reference count has reached 0.
 344  */
 345 #define MCLALLOC(p, how) do {                                           \
 346         (p) = m_mclalloc(how);                                          \
 347 } while (0)
 348
 349 #define MCLGET(m, how) do {                                             \
 350         m_mclget((m), (how));                                           \
 351 } while (0)
 352
 353 /*
 354  * NB: M_COPY_PKTHDR is deprecated; use either M_MOVE_PKTHDR
 355  *     or m_dup_pkthdr.
 356  */
 357 /*
 358  * Move mbuf pkthdr from "from" to "to".
 359  * from should have M_PKTHDR set, and to must be empty.
 360  * from no longer has a pkthdr after this operation.
 361  */
 362 #define M_MOVE_PKTHDR(_to, _from)       m_move_pkthdr((_to), (_from))
 363
 364 /*
 365  * Set the m_data pointer of a newly-allocated mbuf (m_get/MGET) to place
 366  * an object of the specified size at the end of the mbuf, longword aligned.
 367  */
 368 #define M_ALIGN(m, len) do {                                            \
 369         (m)->m_data += (MLEN - (len)) & ~(sizeof(long) - 1);            \
 370 } while (0)
 371
 372 /*
 373  * As above, for mbufs allocated with m_gethdr/MGETHDR
 374  * or initialized by M_COPY_PKTHDR.
 375  */
 376 #define MH_ALIGN(m, len) do {                                           \
 377         (m)->m_data += (MHLEN - (len)) & ~(sizeof(long) - 1);           \
 378 } while (0)
 379
 380 /*
 381  * Check if we can write to an mbuf.
 382  */
 383 #define M_EXT_WRITABLE(m)       \
 384     ((m)->m_ext.ext_nfree.any == NULL && mclrefcnt[mtocl((m)->m_ext.ext_buf)] == 1)
 385
 386 #define M_WRITABLE(m) (!((m)->m_flags & M_EXT) || \
 387     M_EXT_WRITABLE(m) )
 388
 389 /*
 390  * Compute the amount of space available
 391  * before the current start of data in an mbuf.
 392  *
 393  * The M_WRITABLE() is a temporary, conservative safety measure: the burden
 394  * of checking writability of the mbuf data area rests solely with the caller.
 395  */
 396 #define M_LEADINGSPACE(m)                                               \
 397         ((m)->m_flags & M_EXT ?                                         \
 398             (M_EXT_WRITABLE(m) ? (m)->m_data - (m)->m_ext.ext_buf : 0): \
 399             (m)->m_flags & M_PKTHDR ? (m)->m_data - (m)->m_pktdat :     \
 400             (m)->m_data - (m)->m_dat)
 401
 402 /*
 403  * Compute the amount of space available
 404  * after the end of data in an mbuf.
 405  *
 406  * The M_WRITABLE() is a temporary, conservative safety measure: the burden
 407  * of checking writability of the mbuf data area rests solely with the caller.
 408  */
 409 #define M_TRAILINGSPACE(m)                                              \
 410         ((m)->m_flags & M_EXT ?                                         \
 411             (M_WRITABLE(m) ? (m)->m_ext.ext_buf + (m)->m_ext.ext_size   \
 412                 - ((m)->m_data + (m)->m_len) : 0) :                     \
 413             &(m)->m_dat[MLEN] - ((m)->m_data + (m)->m_len))
 414
 415 /*
 416  * Arrange to prepend space of size plen to mbuf m.
 417  * If a new mbuf must be allocated, how specifies whether to wait.
 418  * If how is MB_DONTWAIT and allocation fails, the original mbuf chain
 419  * is freed and m is set to NULL.
 420  */
 421 #define M_PREPEND(m, plen, how) do {                                    \
 422         struct mbuf **_mmp = &(m);                                      \
 423         struct mbuf *_mm = *_mmp;                                       \
 424         int _mplen = (plen);                                            \
 425         int __mhow = (how);                                             \
 426                                                                         \
 427         if (M_LEADINGSPACE(_mm) >= _mplen) {                            \
 428                 _mm->m_data -= _mplen;                                  \
 429                 _mm->m_len += _mplen;                                   \
 430         } else                                                          \
 431                 _mm = m_prepend(_mm, _mplen, __mhow);                   \
 432         if (_mm != NULL && _mm->m_flags & M_PKTHDR)                     \
 433                 _mm->m_pkthdr.len += _mplen;                            \
 434         *_mmp = _mm;                                                    \
 435 } while (0)
 436
 437 /* change mbuf to new type */
 438 #define MCHTYPE(m, t) do {                                              \
 439         struct mbuf *_mm = (m);                                         \
 440         int _mt = (t);                                                  \
 441         int _ms = splimp();                                             \
 442                                                                         \
 443         mbtypes[_mm->m_type]--;                                         \
 444         mbtypes[_mt]++;                                                 \
 445         splx(_ms);                                                      \
 446         _mm->m_type = (_mt);                                            \
 447 } while (0)
 448
 449 /* Length to m_copy to copy all. */
 450 #define M_COPYALL       1000000000
 451
 452 /* Compatibility with 4.3 */
 453 #define m_copy(m, o, l) m_copym((m), (o), (l), MB_DONTWAIT)
 454
 455 #ifdef _KERNEL
 456 extern  u_int            m_clalloc_wid; /* mbuf cluster wait count */
 457 extern  u_int            m_mballoc_wid; /* mbuf wait count */
 458 extern  int              max_linkhdr;   /* largest link-level header */
 459 extern  int              max_protohdr;  /* largest protocol header */
 460 extern  int              max_hdr;       /* largest link+protocol header */
 461 extern  int              max_datalen;   /* MHLEN - max_hdr */
 462 extern  struct mbstat    mbstat;
 463 extern  u_long           mbtypes[MT_NTYPES]; /* per-type mbuf allocations */
 464 extern  int              mbuf_wait;     /* mbuf sleep time */
 465 extern  struct mbuf     *mbutl;         /* virtual address of mclusters */
 466 extern  struct mbuf     *mbute;         /* ending VA of mclusters */
 467 extern  char            *mclrefcnt;     /* cluster reference counts */
 468 extern  union mcluster  *mclfree;
 469 extern  struct mbuf     *mmbfree;
 470 extern  int              nmbclusters;
 471 extern  int              nmbufs;
 472
 473 struct uio;
 474
 475 void             m_adj(struct mbuf *, int);
 476 void             m_cat(struct mbuf *, struct mbuf *);
 477 int              m_clalloc(int, int);
 478 caddr_t          m_clalloc_wait(void);
 479 void             m_copyback(struct mbuf *, int, int, caddr_t);
 480 void             m_copydata(const struct mbuf *, int, int, caddr_t);
 481 struct  mbuf    *m_copym(const struct mbuf *, int, int, int);
 482 struct  mbuf    *m_copypacket(struct mbuf *, int);
 483 struct  mbuf    *m_defrag(struct mbuf *, int);
 484 struct  mbuf    *m_devget(char *, int, int, struct ifnet *,
 485                     void (*copy)(char *, caddr_t, u_int));
 486 struct  mbuf    *m_dup(struct mbuf *, int);
 487 int              m_dup_pkthdr(struct mbuf *, const struct mbuf *, int);
 488 struct  mbuf    *m_free(struct mbuf *);
 489 void             m_freem(struct mbuf *);
 490 struct  mbuf    *m_get(int, int);
 491 struct  mbuf    *m_getcl(int how, short type, int flags);
 492 struct  mbuf    *m_getclr(int, int);
 493 struct  mbuf    *m_gethdr(int, int);
 494 struct  mbuf    *m_getm(struct mbuf *, int, int, int);
 495 int              m_mballoc(int, int);
 496 struct  mbuf    *m_mballoc_wait(int, int);
 497 void             m_move_pkthdr(struct mbuf *, struct mbuf *);
 498 struct  mbuf    *m_prepend(struct mbuf *, int, int);
 499 void             m_print(const struct mbuf *m);
 500 struct  mbuf    *m_pulldown(struct mbuf *, int, int, int *);
 501 struct  mbuf    *m_pullup(struct mbuf *, int);
 502 struct  mbuf    *m_retry(int, int);
 503 struct  mbuf    *m_retryhdr(int, int);
 504 struct  mbuf    *m_split(struct mbuf *, int, int);
 505 struct  mbuf    *m_uiomove(struct uio *, int, int);
 506 caddr_t         m_mclalloc(int how);
 507 void            m_mclget(struct mbuf *m, int how);
 508 void            m_mclfree(caddr_t data);
 509
 510 /*
 511  * Packets may have annotations attached by affixing a list
 512  * of "packet tags" to the pkthdr structure.  Packet tags are
 513  * dynamically allocated semi-opaque data structures that have
 514  * a fixed header (struct m_tag) that specifies the size of the
 515  * memory block and a <cookie,type> pair that identifies it.
 516  * The cookie is a 32-bit unique unsigned value used to identify
 517  * a module or ABI.  By convention this value is chose as the
 518  * date+time that the module is created, expressed as the number of
 519  * seconds since the epoch (e.g. using date -u +'%s').  The type value
 520  * is an ABI/module-specific value that identifies a particular annotation
 521  * and is private to the module.  For compatibility with systems
 522  * like openbsd that define packet tags w/o an ABI/module cookie,
 523  * the value PACKET_ABI_COMPAT is used to implement m_tag_get and
 524  * m_tag_find compatibility shim functions and several tag types are
 525  * defined below.  Users that do not require compatibility should use
 526  * a private cookie value so that packet tag-related definitions
 527  * can be maintained privately.
 528  *
 529  * Note that the packet tag returned by m_tag_allocate has the default
 530  * memory alignment implemented by malloc.  To reference private data
 531  * one can use a construct like:
 532  *
 533  *      struct m_tag *mtag = m_tag_allocate(...);
 534  *      struct foo *p = (struct foo *)(mtag+1);
 535  *
 536  * if the alignment of struct m_tag is sufficient for referencing members
 537  * of struct foo.  Otherwise it is necessary to embed struct m_tag within
 538  * the private data structure to insure proper alignment; e.g.
 539  *
 540  *      struct foo {
 541  *              struct m_tag    tag;
 542  *              ...
 543  *      };
 544  *      struct foo *p = (struct foo *) m_tag_allocate(...);
 545  *      struct m_tag *mtag = &p->tag;
 546  */
 547
 548 #define PACKET_TAG_NONE                         0  /* Nadda */
 549
 550 /* Packet tag for use with PACKET_ABI_COMPAT */
 551 #define PACKET_TAG_IPSEC_IN_DONE                1  /* IPsec applied, in */
 552 #define PACKET_TAG_IPSEC_OUT_DONE               2  /* IPsec applied, out */
 553 #define PACKET_TAG_IPSEC_IN_CRYPTO_DONE         3  /* NIC IPsec crypto done */
 554 #define PACKET_TAG_IPSEC_OUT_CRYPTO_NEEDED      4  /* NIC IPsec crypto req'ed */
 555 #define PACKET_TAG_IPSEC_IN_COULD_DO_CRYPTO     5  /* NIC notifies IPsec */
 556 #define PACKET_TAG_IPSEC_PENDING_TDB            6  /* Reminder to do IPsec */
 557 #define PACKET_TAG_BRIDGE                       7  /* Bridge processing done */
 558 #define PACKET_TAG_GIF                          8  /* GIF processing done */
 559 #define PACKET_TAG_GRE                          9  /* GRE processing done */
 560 #define PACKET_TAG_IN_PACKET_CHECKSUM           10 /* NIC checksumming done */
 561 #define PACKET_TAG_ENCAP                        11 /* Encap.  processing */
 562 #define PACKET_TAG_IPSEC_SOCKET                 12 /* IPSEC socket ref */
 563 #define PACKET_TAG_IPSEC_HISTORY                13 /* IPSEC history */
 564 #define PACKET_TAG_IPV6_INPUT                   14 /* IPV6 input processing */
 565
 566 /*
 567  * As a temporary and low impact solution to replace the even uglier
 568  * approach used so far in some parts of the network stack (which relies
 569  * on global variables), packet tag-like annotations are stored in MT_TAG
 570  * mbufs (or lookalikes) prepended to the actual mbuf chain.
 571  *
 572  *      m_type  = MT_TAG
 573  *      m_flags = m_tag_id
 574  *      m_next  = next buffer in chain.
 575  *
 576  * BE VERY CAREFUL not to pass these blocks to the mbuf handling routines.
 577  */
 578 #define _m_tag_id       m_hdr.mh_flags
 579
 580 /* Packet tags used in the FreeBSD network stack */
 581 #define PACKET_TAG_DUMMYNET                     15 /* dummynet info */
 582 #define PACKET_TAG_IPFW                         16 /* ipfw classification */
 583 #define PACKET_TAG_DIVERT                       17 /* divert info */
 584 #define PACKET_TAG_IPFORWARD                    18 /* ipforward info */
 585
 586 /* Packet tag routines */
 587 struct  m_tag   *m_tag_alloc(u_int32_t, int, int, int);
 588 void             m_tag_free(struct m_tag *);
 589 void             m_tag_prepend(struct mbuf *, struct m_tag *);
 590 void             m_tag_unlink(struct mbuf *, struct m_tag *);
 591 void             m_tag_delete(struct mbuf *, struct m_tag *);
 592 void             m_tag_delete_chain(struct mbuf *, struct m_tag *);
 593 struct  m_tag   *m_tag_locate(struct mbuf *, u_int32_t, int, struct m_tag *);
 594 struct  m_tag   *m_tag_copy(struct m_tag *, int);
 595 int              m_tag_copy_chain(struct mbuf *, const struct mbuf *, int);
 596 void             m_tag_init(struct mbuf *);
 597 struct  m_tag   *m_tag_first(struct mbuf *);
 598 struct  m_tag   *m_tag_next(struct mbuf *, struct m_tag *);
 599
 600 /* these are for openbsd compatibility */
 601 #define MTAG_ABI_COMPAT         0               /* compatibility ABI */
 602
 603 static __inline struct m_tag *
 604 m_tag_get(int type, int length, int wait)
 605 {
 606         return m_tag_alloc(MTAG_ABI_COMPAT, type, length, wait);
 607 }
 608
 609 static __inline struct m_tag *
 610 m_tag_find(struct mbuf *m, int type, struct m_tag *start)
 611 {
 612         return m_tag_locate(m, MTAG_ABI_COMPAT, type, start);
 613 }
 614 #endif /* _KERNEL */
 615
 616 #endif /* !_SYS_MBUF_H_ */