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