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