bsd/sys/mbuf.h

   1 /*
   2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * The contents of this file constitute Original Code as defined in and
   7  * are subject to the Apple Public Source License Version 1.1 (the
   8  * "License").  You may not use this file except in compliance with the
   9  * License.  Please obtain a copy of the License at
  10  * http://www.apple.com/publicsource and read it before using this file.
  11  *
  12  * This Original Code and all software distributed under the License are
  13  * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  14  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  15  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
  17  * License for the specific language governing rights and limitations
  18  * under the License.
  19  *
  20  * @APPLE_LICENSE_HEADER_END@
  21  */
  22 /* Copyright (c) 1998, 1999 Apple Computer, Inc. All Rights Reserved */
  23 /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
  24 /*
  25  * Mach Operating System
  26  * Copyright (c) 1987 Carnegie-Mellon University
  27  * All rights reserved.  The CMU software License Agreement specifies
  28  * the terms and conditions for use and redistribution.
  29  */
  30 /*
  31  * Copyright (c) 1994 NeXT Computer, Inc. All rights reserved.
  32  *
  33  * Copyright (c) 1982, 1986, 1988 Regents of the University of California.
  34  * All rights reserved.
  35  *
  36  * Redistribution and use in source and binary forms, with or without
  37  * modification, are permitted provided that the following conditions
  38  * are met:
  39  * 1. Redistributions of source code must retain the above copyright
  40  *    notice, this list of conditions and the following disclaimer.
  41  * 2. Redistributions in binary form must reproduce the above copyright
  42  *    notice, this list of conditions and the following disclaimer in the
  43  *    documentation and/or other materials provided with the distribution.
  44  * 3. All advertising materials mentioning features or use of this software
  45  *    must display the following acknowledgement:
  46  *      This product includes software developed by the University of
  47  *      California, Berkeley and its contributors.
  48  * 4. Neither the name of the University nor the names of its contributors
  49  *    may be used to endorse or promote products derived from this software
  50  *    without specific prior written permission.
  51  *
  52  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  53  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  54  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  55  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  56  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  57  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  58  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  59  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  60  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  61  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  62  * SUCH DAMAGE.
  63  *
  64  *      @(#)mbuf.h      8.3 (Berkeley) 1/21/94
  65  **********************************************************************
  66  * HISTORY
  67  * 20-May-95  Mac Gillon (mgillon) at NeXT
  68  *      New version based on 4.4
  69  *      Purged old history
  70  */
  71
  72 #ifndef _SYS_MBUF_H_
  73 #define _SYS_MBUF_H_
  74
  75 #include <sys/appleapiopts.h>
  76 #include <sys/lock.h>
  77
  78 /*
  79  * Mbufs are of a single size, MSIZE (machine/param.h), which
  80  * includes overhead.  An mbuf may add a single "mbuf cluster" of size
  81  * MCLBYTES (also in machine/param.h), which has no additional overhead
  82  * and is used instead of the internal data area; this is done when
  83  * at least MINCLSIZE of data must be stored.
  84  */
  85
  86 #ifdef __APPLE_API_UNSTABLE
  87 #define MLEN            (MSIZE - sizeof(struct m_hdr))  /* normal data len */
  88 #define MHLEN           (MLEN - sizeof(struct pkthdr))  /* data len w/pkthdr */
  89
  90 #define MINCLSIZE       (MHLEN + MLEN)  /* smallest amount to put in cluster */
  91 #define M_MAXCOMPRESS   (MHLEN / 2)     /* max amount to copy for compression */
  92
  93 #define NMBPCL          (sizeof(union mcluster) / sizeof(struct mbuf))
  94
  95 /*
  96  * Macros for type conversion
  97  * mtod(m,t) -  convert mbuf pointer to data pointer of correct type
  98  * dtom(x) -    convert data pointer within mbuf to mbuf pointer (XXX)
  99  * mtocl(x) -   convert pointer within cluster to cluster index #
 100  * cltom(x) -   convert cluster # to ptr to beginning of cluster
 101  */
 102 #define mtod(m,t)       ((t)m_mtod(m))
 103 #define dtom(x)         m_dtom(x)
 104 #define mtocl(x)        m_mtocl(x)
 105 #define cltom(x)        m_cltom(x)
 106
 107 #define MCLREF(p)       m_mclref(p)
 108 #define MCLUNREF(p)     m_mclunref(p)
 109
 110 /* header at beginning of each mbuf: */
 111 struct m_hdr {
 112         struct  mbuf *mh_next;          /* next buffer in chain */
 113         struct  mbuf *mh_nextpkt;       /* next chain in queue/record */
 114         long    mh_len;                 /* amount of data in this mbuf */
 115         caddr_t mh_data;                /* location of data */
 116         short   mh_type;                /* type of data in this mbuf */
 117         short   mh_flags;               /* flags; see below */
 118 };
 119
 120 /* record/packet header in first mbuf of chain; valid if M_PKTHDR set */
 121 struct  pkthdr {
 122         int     len;                    /* total packet length */
 123         struct  ifnet *rcvif;           /* rcv interface */
 124
 125         /* variables for ip and tcp reassembly */
 126         void    *header;                /* pointer to packet header */
 127         /* variables for hardware checksum */
 128         int     csum_flags;             /* flags regarding checksum */
 129         int     csum_data;              /* data field used by csum routines */
 130         struct mbuf *aux;               /* extra data buffer; ipsec/others */
 131         void    *reserved1;             /* for future use */
 132         void    *reserved2;             /* for future use */
 133 };
 134
 135
 136 /* description of external storage mapped into mbuf, valid if M_EXT set */
 137 struct m_ext {
 138         caddr_t ext_buf;                /* start of buffer */
 139         void    (*ext_free)();          /* free routine if not the usual */
 140         u_int   ext_size;               /* size of buffer, for ext_free */
 141         caddr_t ext_arg;                /* additional ext_free argument */
 142         struct  ext_refsq {             /* references held */
 143                 struct ext_refsq *forward, *backward;
 144         } ext_refs;
 145 };
 146
 147 struct mbuf {
 148         struct  m_hdr m_hdr;
 149         union {
 150                 struct {
 151                         struct  pkthdr MH_pkthdr;       /* M_PKTHDR set */
 152                         union {
 153                                 struct  m_ext MH_ext;   /* M_EXT set */
 154                                 char    MH_databuf[MHLEN];
 155                         } MH_dat;
 156                 } MH;
 157                 char    M_databuf[MLEN];                /* !M_PKTHDR, !M_EXT */
 158         } M_dat;
 159 };
 160
 161 #define m_next          m_hdr.mh_next
 162 #define m_len           m_hdr.mh_len
 163 #define m_data          m_hdr.mh_data
 164 #define m_type          m_hdr.mh_type
 165 #define m_flags         m_hdr.mh_flags
 166 #define m_nextpkt       m_hdr.mh_nextpkt
 167 #define m_act           m_nextpkt
 168 #define m_pkthdr        M_dat.MH.MH_pkthdr
 169 #define m_ext           M_dat.MH.MH_dat.MH_ext
 170 #define m_pktdat        M_dat.MH.MH_dat.MH_databuf
 171 #define m_dat           M_dat.M_databuf
 172
 173 /* mbuf flags */
 174 #define M_EXT           0x0001  /* has associated external storage */
 175 #define M_PKTHDR        0x0002  /* start of record */
 176 #define M_EOR           0x0004  /* end of record */
 177 #define M_PROTO1        0x0008  /* protocol-specific */
 178 #define M_PROTO2        0x0010  /* protocol-specific */
 179 #define M_PROTO3        0x0020  /* protocol-specific */
 180 #define M_PROTO4        0x0040  /* protocol-specific */
 181 #define M_PROTO5        0x0080  /* protocol-specific */
 182
 183 /* mbuf pkthdr flags, also in m_flags */
 184 #define M_BCAST         0x0100  /* send/received as link-level broadcast */
 185 #define M_MCAST         0x0200  /* send/received as link-level multicast */
 186 #define M_FRAG          0x0400  /* packet is a fragment of a larger packet */
 187 #define M_FIRSTFRAG     0x0800  /* packet is first fragment */
 188 #define M_LASTFRAG      0x1000  /* packet is last fragment */
 189
 190 /* flags copied when copying m_pkthdr */
 191 #define M_COPYFLAGS     (M_PKTHDR|M_EOR|M_PROTO1|M_PROTO1|M_PROTO2|M_PROTO3 | \
 192                             M_PROTO4|M_PROTO5|M_BCAST|M_MCAST|M_FRAG)
 193
 194 /* flags indicating hw checksum support and sw checksum requirements [freebsd4.1]*/
 195 #define CSUM_IP                 0x0001          /* will csum IP */
 196 #define CSUM_TCP                0x0002          /* will csum TCP */
 197 #define CSUM_UDP                0x0004          /* will csum UDP */
 198 #define CSUM_IP_FRAGS           0x0008          /* will csum IP fragments */
 199 #define CSUM_FRAGMENT           0x0010          /* will do IP fragmentation */
 200
 201 #define CSUM_IP_CHECKED         0x0100          /* did csum IP */
 202 #define CSUM_IP_VALID           0x0200          /*   ... the csum is valid */
 203 #define CSUM_DATA_VALID         0x0400          /* csum_data field is valid */
 204 #define CSUM_PSEUDO_HDR         0x0800          /* csum_data has pseudo hdr */
 205 #define CSUM_TCP_SUM16          0x1000          /* simple TCP Sum16 computation */
 206
 207 #define CSUM_DELAY_DATA         (CSUM_TCP | CSUM_UDP)
 208 #define CSUM_DELAY_IP           (CSUM_IP)       /* XXX add ipv6 here too? */
 209
 210
 211 /* mbuf types */
 212 #define MT_FREE         0       /* should be on free list */
 213 #define MT_DATA         1       /* dynamic (data) allocation */
 214 #define MT_HEADER       2       /* packet header */
 215 #define MT_SOCKET       3       /* socket structure */
 216 #define MT_PCB          4       /* protocol control block */
 217 #define MT_RTABLE       5       /* routing tables */
 218 #define MT_HTABLE       6       /* IMP host tables */
 219 #define MT_ATABLE       7       /* address resolution tables */
 220 #define MT_SONAME       8       /* socket name */
 221 #define MT_SOOPTS       10      /* socket options */
 222 #define MT_FTABLE       11      /* fragment reassembly header */
 223 #define MT_RIGHTS       12      /* access rights */
 224 #define MT_IFADDR       13      /* interface address */
 225 #define MT_CONTROL      14      /* extra-data protocol message */
 226 #define MT_OOBDATA      15      /* expedited data  */
 227 #define MT_MAX          32      /* enough? */
 228
 229 /* flags to m_get/MGET */
 230 /* Need to include malloc.h to get right options for malloc  */
 231 #include        <sys/malloc.h>
 232
 233 #define M_DONTWAIT      M_NOWAIT
 234 #define M_WAIT          M_WAITOK
 235
 236 #ifdef __APPLE_API_PRIVATE
 237
 238 /*
 239  * mbuf utility macros:
 240  *
 241  *      MBUFLOCK(code)
 242  * prevents a section of code from from being interrupted by network
 243  * drivers.
 244  */
 245
 246
 247 extern
 248 decl_simple_lock_data(, mbuf_slock);
 249 #define MBUF_LOCK() usimple_lock(&mbuf_slock);
 250 #define MBUF_UNLOCK() usimple_unlock(&mbuf_slock);
 251 #define MBUF_LOCKINIT() simple_lock_init(&mbuf_slock);
 252
 253 #endif /* __APPLE_API_PRIVATE */
 254
 255 /*
 256  * mbuf allocation/deallocation macros:
 257  *
 258  *      MGET(struct mbuf *m, int how, int type)
 259  * allocates an mbuf and initializes it to contain internal data.
 260  *
 261  *      MGETHDR(struct mbuf *m, int how, int type)
 262  * allocates an mbuf and initializes it to contain a packet header
 263  * and internal data.
 264  */
 265
 266 #if 1
 267 #define MCHECK(m) m_mcheck(m)
 268 #else
 269 #define MCHECK(m)
 270 #endif
 271
 272 #ifdef __APPLE_API_PRIVATE
 273 extern struct mbuf *mfree;                              /* mbuf free list */
 274 extern simple_lock_data_t   mbuf_slock;
 275 #endif /* __APPLE_API_PRIVATE */
 276
 277
 278 #define MGET(m, how, type) ((m) = m_get((how), (type)))
 279
 280 #define MGETHDR(m, how, type)   ((m) = m_gethdr((how), (type)))
 281
 282 /*
 283  * Mbuf cluster macros.
 284  * MCLALLOC(caddr_t p, int how) allocates an mbuf cluster.
 285  * MCLGET adds such clusters to a normal mbuf;
 286  * the flag M_EXT is set upon success.
 287  * MCLFREE releases a reference to a cluster allocated by MCLALLOC,
 288  * freeing the cluster if the reference count has reached 0.
 289  *
 290  * Normal mbuf clusters are normally treated as character arrays
 291  * after allocation, but use the first word of the buffer as a free list
 292  * pointer while on the free list.
 293  */
 294 union mcluster {
 295         union   mcluster *mcl_next;
 296         char    mcl_buf[MCLBYTES];
 297 };
 298
 299 #define MCLALLOC(p, how)        ((p) = m_mclalloc(how))
 300
 301 #define MCLFREE(p)      m_mclfree(p)
 302
 303 #define MCLGET(m, how)  ((m) = m_mclget(m, how))
 304
 305 #define MCLHASREFERENCE(m) m_mclhasreference(m)
 306
 307 /*
 308  * MFREE(struct mbuf *m, struct mbuf *n)
 309  * Free a single mbuf and associated external storage.
 310  * Place the successor, if any, in n.
 311  */
 312
 313 #define MFREE(m, n) ((n) = m_free(m))
 314
 315 /*
 316  * Copy mbuf pkthdr from from to to.
 317  * from must have M_PKTHDR set, and to must be empty.
 318  * aux pointer will be moved to `to'.
 319  */
 320 #define M_COPY_PKTHDR(to, from)         m_copy_pkthdr(to, from)
 321
 322 /*
 323  * Set the m_data pointer of a newly-allocated mbuf (m_get/MGET) to place
 324  * an object of the specified size at the end of the mbuf, longword aligned.
 325  */
 326 #define M_ALIGN(m, len)                         \
 327         { (m)->m_data += (MLEN - (len)) &~ (sizeof(long) - 1); }
 328 /*
 329  * As above, for mbufs allocated with m_gethdr/MGETHDR
 330  * or initialized by M_COPY_PKTHDR.
 331  */
 332 #define MH_ALIGN(m, len) \
 333         { (m)->m_data += (MHLEN - (len)) &~ (sizeof(long) - 1); }
 334
 335 /*
 336  * Compute the amount of space available
 337  * before the current start of data in an mbuf.
 338  * Subroutine - data not available if certain references.
 339  */
 340 #define M_LEADINGSPACE(m)       m_leadingspace(m)
 341
 342 /*
 343  * Compute the amount of space available
 344  * after the end of data in an mbuf.
 345  * Subroutine - data not available if certain references.
 346  */
 347 #define M_TRAILINGSPACE(m)      m_trailingspace(m)
 348
 349 /*
 350  * Arrange to prepend space of size plen to mbuf m.
 351  * If a new mbuf must be allocated, how specifies whether to wait.
 352  * If how is M_DONTWAIT and allocation fails, the original mbuf chain
 353  * is freed and m is set to NULL.
 354  */
 355 #define M_PREPEND(m, plen, how)         ((m) = m_prepend_2((m), (plen), (how)))
 356
 357 /* change mbuf to new type */
 358 #define MCHTYPE(m, t)           m_mchtype(m, t)
 359
 360 /* length to m_copy to copy all */
 361 #define M_COPYALL       1000000000
 362
 363 /* compatiblity with 4.3 */
 364 #define  m_copy(m, o, l)        m_copym((m), (o), (l), M_DONTWAIT)
 365
 366 /*
 367  * Mbuf statistics.
 368  */
 369 struct mbstat {
 370         u_long  m_mbufs;        /* mbufs obtained from page pool */
 371         u_long  m_clusters;     /* clusters obtained from page pool */
 372         u_long  m_spare;        /* spare field */
 373         u_long  m_clfree;       /* free clusters */
 374         u_long  m_drops;        /* times failed to find space */
 375         u_long  m_wait;         /* times waited for space */
 376         u_long  m_drain;        /* times drained protocols for space */
 377         u_short m_mtypes[256];  /* type specific mbuf allocations */
 378         u_long  m_mcfail;       /* times m_copym failed */
 379         u_long  m_mpfail;       /* times m_pullup failed */
 380         u_long  m_msize;        /* length of an mbuf */
 381         u_long  m_mclbytes;     /* length of an mbuf cluster */
 382         u_long  m_minclsize;    /* min length of data to allocate a cluster */
 383         u_long  m_mlen;         /* length of data in an mbuf */
 384         u_long  m_mhlen;        /* length of data in a header mbuf */
 385 };
 386
 387 /*
 388  * pkthdr.aux type tags.
 389  */
 390 struct mauxtag {
 391         int af;
 392         int type;
 393 };
 394
 395 #ifdef  KERNEL
 396 extern union    mcluster *mbutl;        /* virtual address of mclusters */
 397 extern union    mcluster *embutl;       /* ending virtual address of mclusters */
 398 extern short    *mclrefcnt;             /* cluster reference counts */
 399 extern int      *mcl_paddr;             /* physical addresses of clusters */
 400 extern struct   mbstat mbstat;          /* statistics */
 401 extern int      nmbclusters;            /* number of mapped clusters */
 402 extern union    mcluster *mclfree;      /* free mapped cluster list */
 403 extern int      max_linkhdr;            /* largest link-level header */
 404 extern int      max_protohdr;           /* largest protocol header */
 405 extern int      max_hdr;                /* largest link+protocol header */
 406 extern int      max_datalen;            /* MHLEN - max_hdr */
 407
 408 struct  mbuf *m_copym __P((struct mbuf *, int, int, int));
 409 struct  mbuf *m_split __P((struct mbuf *, int, int));
 410 struct  mbuf *m_free __P((struct mbuf *));
 411 struct  mbuf *m_get __P((int, int));
 412 struct  mbuf *m_getpacket __P((void));
 413 struct  mbuf *m_getclr __P((int, int));
 414 struct  mbuf *m_gethdr __P((int, int));
 415 struct  mbuf *m_prepend __P((struct mbuf *, int, int));
 416 struct  mbuf *m_prepend_2 __P((struct mbuf *, int, int));
 417 struct  mbuf *m_pullup __P((struct mbuf *, int));
 418 struct  mbuf *m_retry __P((int, int));
 419 struct  mbuf *m_retryhdr __P((int, int));
 420 void m_adj __P((struct mbuf *, int));
 421 int      m_clalloc __P((int, int));
 422 void m_freem __P((struct mbuf *));
 423 int m_freem_list __P((struct mbuf *));
 424 struct  mbuf *m_devget __P((char *, int, int, struct ifnet *, void (*)()));
 425 char   *mcl_to_paddr __P((char *));
 426 struct mbuf *m_pulldown __P((struct mbuf*, int, int, int*));
 427 struct mbuf *m_aux_add __P((struct mbuf *, int, int));
 428 struct mbuf *m_aux_find __P((struct mbuf *, int, int));
 429 void m_aux_delete __P((struct mbuf *, struct mbuf *));
 430
 431 struct mbuf *m_mclget __P((struct mbuf *, int));
 432 caddr_t m_mclalloc __P((int));
 433 void m_mclfree __P((caddr_t p));
 434 int m_mclhasreference __P((struct mbuf *));
 435 void m_copy_pkthdr __P((struct mbuf *, struct mbuf*));
 436
 437 int m_mclref __P((struct mbuf *));
 438 int m_mclunref __P((struct mbuf *));
 439
 440 void *          m_mtod __P((struct mbuf *));
 441 struct mbuf *   m_dtom __P((void *));
 442 int             m_mtocl __P((void *));
 443 union mcluster *m_cltom __P((int ));
 444
 445 int m_trailingspace __P((struct mbuf *));
 446 int m_leadingspace __P((struct mbuf *));
 447
 448 void m_mchtype __P((struct mbuf *m, int t));
 449
 450 void m_mcheck __P((struct mbuf*));
 451
 452 #endif
 453 #endif /* __APPLE_API_UNSTABLE */
 454 #endif  /* !_SYS_MBUF_H_ */