2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 1982, 1986, 1988, 1993
5 * The Regents of the University of California.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 3. Neither the name of the University nor the names of its contributors
17 * may be used to endorse or promote products derived from this software
18 * without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 * @(#)mbuf.h 8.5 (Berkeley) 2/19/95
39 /* XXX: These includes suck. Sorry! */
40 #include <sys/queue.h>
42 #include <sys/systm.h>
43 #include <sys/refcount.h>
53 #define MBUF_PROBE1(probe, arg0) \
54 SDT_PROBE1(sdt, , , probe, arg0)
55 #define MBUF_PROBE2(probe, arg0, arg1) \
56 SDT_PROBE2(sdt, , , probe, arg0, arg1)
57 #define MBUF_PROBE3(probe, arg0, arg1, arg2) \
58 SDT_PROBE3(sdt, , , probe, arg0, arg1, arg2)
59 #define MBUF_PROBE4(probe, arg0, arg1, arg2, arg3) \
60 SDT_PROBE4(sdt, , , probe, arg0, arg1, arg2, arg3)
61 #define MBUF_PROBE5(probe, arg0, arg1, arg2, arg3, arg4) \
62 SDT_PROBE5(sdt, , , probe, arg0, arg1, arg2, arg3, arg4)
64 SDT_PROBE_DECLARE(sdt, , , m__init);
65 SDT_PROBE_DECLARE(sdt, , , m__gethdr);
66 SDT_PROBE_DECLARE(sdt, , , m__get);
67 SDT_PROBE_DECLARE(sdt, , , m__getcl);
68 SDT_PROBE_DECLARE(sdt, , , m__clget);
69 SDT_PROBE_DECLARE(sdt, , , m__cljget);
70 SDT_PROBE_DECLARE(sdt, , , m__cljset);
71 SDT_PROBE_DECLARE(sdt, , , m__free);
72 SDT_PROBE_DECLARE(sdt, , , m__freem);
77 * Mbufs are of a single size, MSIZE (sys/param.h), which includes overhead.
78 * An mbuf may add a single "mbuf cluster" of size MCLBYTES (also in
79 * sys/param.h), which has no additional overhead and is used instead of the
80 * internal data area; this is done when at least MINCLSIZE of data must be
81 * stored. Additionally, it is possible to allocate a separate buffer
82 * externally and attach it to the mbuf in a way similar to that of mbuf
85 * NB: These calculation do not take actual compiler-induced alignment and
86 * padding inside the complete struct mbuf into account. Appropriate
87 * attention is required when changing members of struct mbuf.
89 * MLEN is data length in a normal mbuf.
90 * MHLEN is data length in an mbuf with pktheader.
91 * MINCLSIZE is a smallest amount of data that should be put into cluster.
93 * Compile-time assertions in uipc_mbuf.c test these values to ensure that
97 #define MHSIZE offsetof(struct mbuf, m_dat)
98 #define MPKTHSIZE offsetof(struct mbuf, m_pktdat)
99 #define MLEN ((int)(MSIZE - MHSIZE))
100 #define MHLEN ((int)(MSIZE - MPKTHSIZE))
101 #define MINCLSIZE (MHLEN + 1)
106 * Macro for type conversion: convert mbuf pointer to data pointer of correct
109 * mtod(m, t) -- Convert mbuf pointer to data pointer of correct type.
110 * mtodo(m, o) -- Same as above but with offset 'o' into data.
112 #define mtod(m, t) ((t)((m)->m_data))
113 #define mtodo(m, o) ((void *)(((m)->m_data) + (o)))
116 * Argument structure passed to UMA routines during mbuf and packet
120 int flags; /* Flags for mbuf being allocated */
121 short type; /* Type of mbuf being allocated */
126 * Packet tag structure (see below for details).
129 SLIST_ENTRY(m_tag) m_tag_link; /* List of packet tags */
130 u_int16_t m_tag_id; /* Tag ID */
131 u_int16_t m_tag_len; /* Length of data */
132 u_int32_t m_tag_cookie; /* ABI/Module ID */
133 void (*m_tag_free)(struct m_tag *);
137 * Static network interface owned tag.
138 * Allocated through ifp->if_snd_tag_alloc().
141 struct ifnet *ifp; /* network interface tag belongs to */
142 volatile u_int refcount;
146 * Record/packet header in first mbuf of chain; valid only if M_PKTHDR is set.
149 * Compile-time assertions in uipc_mbuf.c test these values to ensure that
154 struct m_snd_tag *snd_tag; /* send tag, if any */
155 struct ifnet *rcvif; /* rcv interface */
157 SLIST_HEAD(packet_tags, m_tag) tags; /* list of packet tags */
158 int32_t len; /* total packet length */
160 /* Layer crossing persistent information. */
161 uint32_t flowid; /* packet's 4-tuple system */
162 uint32_t csum_flags; /* checksum and offload features */
163 uint16_t fibnum; /* this packet should use this fib */
164 uint8_t numa_domain; /* NUMA domain of recvd pkt */
165 uint8_t rsstype; /* hash type */
167 uint64_t rcv_tstmp; /* timestamp in ns */
169 uint8_t l2hlen; /* layer 2 hdr len */
170 uint8_t l3hlen; /* layer 3 hdr len */
171 uint8_t l4hlen; /* layer 4 hdr len */
172 uint8_t l5hlen; /* layer 5 hdr len */
179 uint32_t thirtytwo[2];
180 uint64_t sixtyfour[1];
181 uintptr_t unintptr[1];
185 /* Layer specific non-persistent local storage for reassembly, etc. */
189 uint32_t thirtytwo[2];
190 uint64_t sixtyfour[1];
191 uintptr_t unintptr[1];
195 #define ether_vtag PH_per.sixteen[0]
197 #define vt_nrecs sixteen[0] /* mld and v6-ND */
198 #define tso_segsz PH_per.sixteen[1] /* inbound after LRO */
199 #define lro_nsegs tso_segsz /* inbound after LRO */
200 #define csum_data PH_per.thirtytwo[1] /* inbound from hardware up */
201 #define lro_len PH_loc.sixteen[0] /* inbound during LRO (no reassembly) */
202 #define lro_csum PH_loc.sixteen[1] /* inbound during LRO (no reassembly) */
203 /* Note PH_loc is used during IP reassembly (all 8 bytes as a ptr) */
206 * TLS records for TLS 1.0-1.2 can have the following header lengths:
207 * - 5 (AES-CBC with implicit IV)
208 * - 21 (AES-CBC with explicit IV)
209 * - 13 (AES-GCM with 8 byte explicit IV)
211 #define MBUF_PEXT_HDR_LEN 23
214 * TLS records for TLS 1.0-1.2 can have the following maximum trailer
217 * - 36 (AES-CBC with SHA1 and up to 16 bytes of padding)
218 * - 48 (AES-CBC with SHA2-256 and up to 16 bytes of padding)
219 * - 64 (AES-CBC with SHA2-384 and up to 16 bytes of padding)
221 #define MBUF_PEXT_TRAIL_LEN 64
223 #if defined(__LP64__)
224 #define MBUF_PEXT_MAX_PGS (40 / sizeof(vm_paddr_t))
226 #define MBUF_PEXT_MAX_PGS (72 / sizeof(vm_paddr_t))
229 #define MBUF_PEXT_MAX_BYTES \
230 (MBUF_PEXT_MAX_PGS * PAGE_SIZE + MBUF_PEXT_HDR_LEN + MBUF_PEXT_TRAIL_LEN)
236 * Description of external storage mapped into mbuf; valid only if M_EXT is
240 * Compile-time assertions in uipc_mbuf.c test these values to ensure that
243 typedef void m_ext_free_t(struct mbuf *);
247 * If EXT_FLAG_EMBREF is set, then we use refcount in the
248 * mbuf, the 'ext_count' member. Otherwise, we have a
249 * shadow copy and we use pointer 'ext_cnt'. The original
250 * mbuf is responsible to carry the pointer to free routine
251 * and its arguments. They aren't copied into shadows in
252 * mb_dupcl() to avoid dereferencing next cachelines.
254 volatile u_int ext_count;
255 volatile u_int *ext_cnt;
257 uint32_t ext_size; /* size of buffer, for ext_free */
258 uint32_t ext_type:8, /* type of external storage */
259 ext_flags:24; /* external storage mbuf flags */
263 * Regular M_EXT mbuf:
264 * o ext_buf always points to the external buffer.
265 * o ext_free (below) and two optional arguments
266 * ext_arg1 and ext_arg2 store the free context for
267 * the external storage. They are set only in the
268 * refcount carrying mbuf, the one with
269 * EXT_FLAG_EMBREF flag, with exclusion for
270 * EXT_EXTREF type, where the free context is copied
271 * into all mbufs that use same external storage.
273 char *ext_buf; /* start of buffer */
274 #define m_ext_copylen offsetof(struct m_ext, ext_arg2)
279 * Multi-page M_EXTPG mbuf:
280 * o extpg_pa - page vector.
281 * o extpg_trail and extpg_hdr - TLS trailer and
283 * Uses ext_free and may also use ext_arg1.
285 vm_paddr_t extpg_pa[MBUF_PEXT_MAX_PGS];
286 char extpg_trail[MBUF_PEXT_TRAIL_LEN];
287 char extpg_hdr[MBUF_PEXT_HDR_LEN];
288 /* Pretend these 3 fields are part of mbuf itself. */
289 #define m_epg_pa m_ext.extpg_pa
290 #define m_epg_trail m_ext.extpg_trail
291 #define m_epg_hdr m_ext.extpg_hdr
292 #define m_epg_copylen offsetof(struct m_ext, ext_free)
296 * Free method and optional argument pointer, both
297 * used by M_EXT and M_EXTPG.
299 m_ext_free_t *ext_free;
304 * The core of the mbuf object along with some shortcut defines for practical
309 * Header present at the beginning of every mbuf.
312 * Compile-time assertions in uipc_mbuf.c test these values to ensure
313 * that they are correct.
315 union { /* next buffer in chain */
317 SLIST_ENTRY(mbuf) m_slist;
318 STAILQ_ENTRY(mbuf) m_stailq;
320 union { /* next chain in queue/record */
321 struct mbuf *m_nextpkt;
322 SLIST_ENTRY(mbuf) m_slistpkt;
323 STAILQ_ENTRY(mbuf) m_stailqpkt;
325 caddr_t m_data; /* location of data */
326 int32_t m_len; /* amount of data in this mbuf */
327 uint32_t m_type:8, /* type of data in this mbuf */
328 m_flags:24; /* flags; see below */
329 #if !defined(__LP64__)
330 uint32_t m_pad; /* pad for 64bit alignment */
334 * A set of optional headers (packet header, external storage header)
335 * and internal data storage. Historically, these arrays were sized
336 * to MHLEN (space left after a packet header) and MLEN (space left
337 * after only a regular mbuf header); they are now variable size in
338 * order to support future work on variable-size mbufs.
344 struct pkthdr m_pkthdr;
347 * Multi-page M_EXTPG mbuf has its meta data
348 * split between the mbuf_ext_pgs structure
349 * and m_ext. It carries vector of pages,
350 * optional header and trailer char vectors
351 * and pointers to socket/TLS data.
353 struct mbuf_ext_pgs {
354 /* Overall count of pages and count of
355 * pages with I/O pending. */
358 /* TLS header and trailer lengths.
359 * The data itself resides in m_ext. */
362 /* Offset into 1st page and lenght of
363 * data in the last page. */
364 uint16_t first_pg_off;
365 uint16_t last_pg_len;
367 #define EPG_FLAG_ANON 0x1 /* Data can be encrypted in place. */
368 #define EPG_FLAG_2FREE 0x2 /* Scheduled for free. */
372 struct ktls_session *tls;
375 STAILQ_ENTRY(mbuf) stailq;
379 /* M_EXT or M_EXTPG set. */
381 /* M_PKTHDR set, neither M_EXT nor M_EXTPG. */
385 char m_dat[0]; /* !M_PKTHDR, !M_EXT */
391 mbuf_ext_pg_len(struct mbuf_ext_pgs *ext_pgs, int pidx, int pgoff)
393 KASSERT(pgoff == 0 || pidx == 0,
394 ("page %d with non-zero offset %d in %p", pidx, pgoff, ext_pgs));
395 if (pidx == ext_pgs->npgs - 1) {
396 return (ext_pgs->last_pg_len);
398 return (PAGE_SIZE - pgoff);
402 #ifdef INVARIANT_SUPPORT
403 void mb_ext_pgs_check(struct mbuf *m);
406 #define MBUF_EXT_PGS_ASSERT_SANITY(m) mb_ext_pgs_check((m))
408 #define MBUF_EXT_PGS_ASSERT_SANITY(m)
413 * mbuf flags of global significance and layer crossing.
414 * Those of only protocol/layer specific significance are to be mapped
415 * to M_PROTO[1-11] and cleared at layer handoff boundaries.
416 * NB: Limited to the lower 24 bits.
418 #define M_EXT 0x00000001 /* has associated external storage */
419 #define M_PKTHDR 0x00000002 /* start of record */
420 #define M_EOR 0x00000004 /* end of record */
421 #define M_RDONLY 0x00000008 /* associated data is marked read-only */
422 #define M_BCAST 0x00000010 /* send/received as link-level broadcast */
423 #define M_MCAST 0x00000020 /* send/received as link-level multicast */
424 #define M_PROMISC 0x00000040 /* packet was not for us */
425 #define M_VLANTAG 0x00000080 /* ether_vtag is valid */
426 #define M_NOMAP 0x00000100 /* mbuf data is unmapped */
427 #define M_NOFREE 0x00000200 /* do not free mbuf, embedded in cluster */
428 #define M_TSTMP 0x00000400 /* rcv_tstmp field is valid */
429 #define M_TSTMP_HPREC 0x00000800 /* rcv_tstmp is high-prec, typically
430 hw-stamped on port (useful for IEEE 1588
432 #define M_TSTMP_LRO 0x00001000 /* Time LRO pushed in pkt is valid in (PH_loc) */
434 #define M_PROTO1 0x00002000 /* protocol-specific */
435 #define M_PROTO2 0x00004000 /* protocol-specific */
436 #define M_PROTO3 0x00008000 /* protocol-specific */
437 #define M_PROTO4 0x00010000 /* protocol-specific */
438 #define M_PROTO5 0x00020000 /* protocol-specific */
439 #define M_PROTO6 0x00040000 /* protocol-specific */
440 #define M_PROTO7 0x00080000 /* protocol-specific */
441 #define M_PROTO8 0x00100000 /* protocol-specific */
442 #define M_PROTO9 0x00200000 /* protocol-specific */
443 #define M_PROTO10 0x00400000 /* protocol-specific */
444 #define M_PROTO11 0x00800000 /* protocol-specific */
446 #define MB_DTOR_SKIP 0x1 /* don't pollute the cache by touching a freed mbuf */
449 * Flags to purge when crossing layers.
451 #define M_PROTOFLAGS \
452 (M_PROTO1|M_PROTO2|M_PROTO3|M_PROTO4|M_PROTO5|M_PROTO6|M_PROTO7|M_PROTO8|\
453 M_PROTO9|M_PROTO10|M_PROTO11)
456 * Flags preserved when copying m_pkthdr.
458 #define M_COPYFLAGS \
459 (M_PKTHDR|M_EOR|M_RDONLY|M_BCAST|M_MCAST|M_PROMISC|M_VLANTAG|M_TSTMP| \
460 M_TSTMP_HPREC|M_TSTMP_LRO|M_PROTOFLAGS)
463 * Mbuf flag description for use with printf(9) %b identifier.
465 #define M_FLAG_BITS \
466 "\20\1M_EXT\2M_PKTHDR\3M_EOR\4M_RDONLY\5M_BCAST\6M_MCAST" \
467 "\7M_PROMISC\10M_VLANTAG\11M_NOMAP\12M_NOFREE\13M_TSTMP\14M_TSTMP_HPREC\15M_TSTMP_LRO"
468 #define M_FLAG_PROTOBITS \
469 "\16M_PROTO1\17M_PROTO2\20M_PROTO3\21M_PROTO4" \
470 "\22M_PROTO5\23M_PROTO6\24M_PROTO7\25M_PROTO8\26M_PROTO9" \
471 "\27M_PROTO10\28M_PROTO11"
472 #define M_FLAG_PRINTF (M_FLAG_BITS M_FLAG_PROTOBITS)
475 * Network interface cards are able to hash protocol fields (such as IPv4
476 * addresses and TCP port numbers) classify packets into flows. These flows
477 * can then be used to maintain ordering while delivering packets to the OS
478 * via parallel input queues, as well as to provide a stateless affinity
479 * model. NIC drivers can pass up the hash via m->m_pkthdr.flowid, and set
480 * m_flag fields to indicate how the hash should be interpreted by the
483 * Most NICs support RSS, which provides ordering and explicit affinity, and
484 * use the hash m_flag bits to indicate what header fields were covered by
485 * the hash. M_HASHTYPE_OPAQUE and M_HASHTYPE_OPAQUE_HASH can be set by non-
486 * RSS cards or configurations that provide an opaque flow identifier, allowing
487 * for ordering and distribution without explicit affinity. Additionally,
488 * M_HASHTYPE_OPAQUE_HASH indicates that the flow identifier has hash
491 * The meaning of the IPV6_EX suffix:
492 * "o Home address from the home address option in the IPv6 destination
493 * options header. If the extension header is not present, use the Source
495 * o IPv6 address that is contained in the Routing-Header-Type-2 from the
496 * associated extension header. If the extension header is not present,
497 * use the Destination IPv6 Address."
499 * https://docs.microsoft.com/en-us/windows-hardware/drivers/network/rss-hashing-types#ndishashipv6ex
501 #define M_HASHTYPE_HASHPROP 0x80 /* has hash properties */
502 #define M_HASHTYPE_HASH(t) (M_HASHTYPE_HASHPROP | (t))
503 /* Microsoft RSS standard hash types */
504 #define M_HASHTYPE_NONE 0
505 #define M_HASHTYPE_RSS_IPV4 M_HASHTYPE_HASH(1) /* IPv4 2-tuple */
506 #define M_HASHTYPE_RSS_TCP_IPV4 M_HASHTYPE_HASH(2) /* TCPv4 4-tuple */
507 #define M_HASHTYPE_RSS_IPV6 M_HASHTYPE_HASH(3) /* IPv6 2-tuple */
508 #define M_HASHTYPE_RSS_TCP_IPV6 M_HASHTYPE_HASH(4) /* TCPv6 4-tuple */
509 #define M_HASHTYPE_RSS_IPV6_EX M_HASHTYPE_HASH(5) /* IPv6 2-tuple +
511 #define M_HASHTYPE_RSS_TCP_IPV6_EX M_HASHTYPE_HASH(6) /* TCPv6 4-tuple +
513 #define M_HASHTYPE_RSS_UDP_IPV4 M_HASHTYPE_HASH(7) /* IPv4 UDP 4-tuple*/
514 #define M_HASHTYPE_RSS_UDP_IPV6 M_HASHTYPE_HASH(9) /* IPv6 UDP 4-tuple*/
515 #define M_HASHTYPE_RSS_UDP_IPV6_EX M_HASHTYPE_HASH(10)/* IPv6 UDP 4-tuple +
518 #define M_HASHTYPE_OPAQUE 63 /* ordering, not affinity */
519 #define M_HASHTYPE_OPAQUE_HASH M_HASHTYPE_HASH(M_HASHTYPE_OPAQUE)
520 /* ordering+hash, not affinity*/
522 #define M_HASHTYPE_CLEAR(m) ((m)->m_pkthdr.rsstype = 0)
523 #define M_HASHTYPE_GET(m) ((m)->m_pkthdr.rsstype)
524 #define M_HASHTYPE_SET(m, v) ((m)->m_pkthdr.rsstype = (v))
525 #define M_HASHTYPE_TEST(m, v) (M_HASHTYPE_GET(m) == (v))
526 #define M_HASHTYPE_ISHASH(m) (M_HASHTYPE_GET(m) & M_HASHTYPE_HASHPROP)
529 * External mbuf storage buffer types.
531 #define EXT_CLUSTER 1 /* mbuf cluster */
532 #define EXT_SFBUF 2 /* sendfile(2)'s sf_buf */
533 #define EXT_JUMBOP 3 /* jumbo cluster page sized */
534 #define EXT_JUMBO9 4 /* jumbo cluster 9216 bytes */
535 #define EXT_JUMBO16 5 /* jumbo cluster 16184 bytes */
536 #define EXT_PACKET 6 /* mbuf+cluster from packet zone */
537 #define EXT_MBUF 7 /* external mbuf reference */
538 #define EXT_RXRING 8 /* data in NIC receive ring */
539 #define EXT_PGS 9 /* array of unmapped pages */
541 #define EXT_VENDOR1 224 /* for vendor-internal use */
542 #define EXT_VENDOR2 225 /* for vendor-internal use */
543 #define EXT_VENDOR3 226 /* for vendor-internal use */
544 #define EXT_VENDOR4 227 /* for vendor-internal use */
546 #define EXT_EXP1 244 /* for experimental use */
547 #define EXT_EXP2 245 /* for experimental use */
548 #define EXT_EXP3 246 /* for experimental use */
549 #define EXT_EXP4 247 /* for experimental use */
551 #define EXT_NET_DRV 252 /* custom ext_buf provided by net driver(s) */
552 #define EXT_MOD_TYPE 253 /* custom module's ext_buf type */
553 #define EXT_DISPOSABLE 254 /* can throw this buffer away w/page flipping */
554 #define EXT_EXTREF 255 /* has externally maintained ext_cnt ptr */
557 * Flags for external mbuf buffer types.
558 * NB: limited to the lower 24 bits.
560 #define EXT_FLAG_EMBREF 0x000001 /* embedded ext_count */
561 #define EXT_FLAG_EXTREF 0x000002 /* external ext_cnt, notyet */
563 #define EXT_FLAG_NOFREE 0x000010 /* don't free mbuf to pool, notyet */
565 #define EXT_FLAG_VENDOR1 0x010000 /* These flags are vendor */
566 #define EXT_FLAG_VENDOR2 0x020000 /* or submodule specific, */
567 #define EXT_FLAG_VENDOR3 0x040000 /* not used by mbuf code. */
568 #define EXT_FLAG_VENDOR4 0x080000 /* Set/read by submodule. */
570 #define EXT_FLAG_EXP1 0x100000 /* for experimental use */
571 #define EXT_FLAG_EXP2 0x200000 /* for experimental use */
572 #define EXT_FLAG_EXP3 0x400000 /* for experimental use */
573 #define EXT_FLAG_EXP4 0x800000 /* for experimental use */
576 * EXT flag description for use with printf(9) %b identifier.
578 #define EXT_FLAG_BITS \
579 "\20\1EXT_FLAG_EMBREF\2EXT_FLAG_EXTREF\5EXT_FLAG_NOFREE" \
580 "\21EXT_FLAG_VENDOR1\22EXT_FLAG_VENDOR2\23EXT_FLAG_VENDOR3" \
581 "\24EXT_FLAG_VENDOR4\25EXT_FLAG_EXP1\26EXT_FLAG_EXP2\27EXT_FLAG_EXP3" \
584 #define MBUF_EXT_PGS_ASSERT(m) \
585 KASSERT((((m)->m_flags & M_EXT) != 0) && \
586 ((m)->m_ext.ext_type == EXT_PGS), \
587 ("%s: m %p !M_EXT or !EXT_PGS", __func__, m))
590 * Flags indicating checksum, segmentation and other offload work to be
591 * done, or already done, by hardware or lower layers. It is split into
592 * separate inbound and outbound flags.
594 * Outbound flags that are set by upper protocol layers requesting lower
595 * layers, or ideally the hardware, to perform these offloading tasks.
596 * For outbound packets this field and its flags can be directly tested
597 * against ifnet if_hwassist.
599 #define CSUM_IP 0x00000001 /* IP header checksum offload */
600 #define CSUM_IP_UDP 0x00000002 /* UDP checksum offload */
601 #define CSUM_IP_TCP 0x00000004 /* TCP checksum offload */
602 #define CSUM_IP_SCTP 0x00000008 /* SCTP checksum offload */
603 #define CSUM_IP_TSO 0x00000010 /* TCP segmentation offload */
604 #define CSUM_IP_ISCSI 0x00000020 /* iSCSI checksum offload */
606 #define CSUM_IP6_UDP 0x00000200 /* UDP checksum offload */
607 #define CSUM_IP6_TCP 0x00000400 /* TCP checksum offload */
608 #define CSUM_IP6_SCTP 0x00000800 /* SCTP checksum offload */
609 #define CSUM_IP6_TSO 0x00001000 /* TCP segmentation offload */
610 #define CSUM_IP6_ISCSI 0x00002000 /* iSCSI checksum offload */
612 /* Inbound checksum support where the checksum was verified by hardware. */
613 #define CSUM_L3_CALC 0x01000000 /* calculated layer 3 csum */
614 #define CSUM_L3_VALID 0x02000000 /* checksum is correct */
615 #define CSUM_L4_CALC 0x04000000 /* calculated layer 4 csum */
616 #define CSUM_L4_VALID 0x08000000 /* checksum is correct */
617 #define CSUM_L5_CALC 0x10000000 /* calculated layer 5 csum */
618 #define CSUM_L5_VALID 0x20000000 /* checksum is correct */
619 #define CSUM_COALESCED 0x40000000 /* contains merged segments */
621 #define CSUM_SND_TAG 0x80000000 /* Packet header has send tag */
624 * CSUM flag description for use with printf(9) %b identifier.
627 "\20\1CSUM_IP\2CSUM_IP_UDP\3CSUM_IP_TCP\4CSUM_IP_SCTP\5CSUM_IP_TSO" \
629 "\12CSUM_IP6_UDP\13CSUM_IP6_TCP\14CSUM_IP6_SCTP\15CSUM_IP6_TSO" \
630 "\16CSUM_IP6_ISCSI" \
631 "\31CSUM_L3_CALC\32CSUM_L3_VALID\33CSUM_L4_CALC\34CSUM_L4_VALID" \
632 "\35CSUM_L5_CALC\36CSUM_L5_VALID\37CSUM_COALESCED\40CSUM_SND_TAG"
634 /* CSUM flags compatibility mappings. */
635 #define CSUM_IP_CHECKED CSUM_L3_CALC
636 #define CSUM_IP_VALID CSUM_L3_VALID
637 #define CSUM_DATA_VALID CSUM_L4_VALID
638 #define CSUM_PSEUDO_HDR CSUM_L4_CALC
639 #define CSUM_SCTP_VALID CSUM_L4_VALID
640 #define CSUM_DELAY_DATA (CSUM_TCP|CSUM_UDP)
641 #define CSUM_DELAY_IP CSUM_IP /* Only v4, no v6 IP hdr csum */
642 #define CSUM_DELAY_DATA_IPV6 (CSUM_TCP_IPV6|CSUM_UDP_IPV6)
643 #define CSUM_DATA_VALID_IPV6 CSUM_DATA_VALID
644 #define CSUM_TCP CSUM_IP_TCP
645 #define CSUM_UDP CSUM_IP_UDP
646 #define CSUM_SCTP CSUM_IP_SCTP
647 #define CSUM_TSO (CSUM_IP_TSO|CSUM_IP6_TSO)
648 #define CSUM_UDP_IPV6 CSUM_IP6_UDP
649 #define CSUM_TCP_IPV6 CSUM_IP6_TCP
650 #define CSUM_SCTP_IPV6 CSUM_IP6_SCTP
653 * mbuf types describing the content of the mbuf (including external storage).
655 #define MT_NOTMBUF 0 /* USED INTERNALLY ONLY! Object is not mbuf */
656 #define MT_DATA 1 /* dynamic (data) allocation */
657 #define MT_HEADER MT_DATA /* packet header, use M_PKTHDR instead */
659 #define MT_VENDOR1 4 /* for vendor-internal use */
660 #define MT_VENDOR2 5 /* for vendor-internal use */
661 #define MT_VENDOR3 6 /* for vendor-internal use */
662 #define MT_VENDOR4 7 /* for vendor-internal use */
664 #define MT_SONAME 8 /* socket name */
666 #define MT_EXP1 9 /* for experimental use */
667 #define MT_EXP2 10 /* for experimental use */
668 #define MT_EXP3 11 /* for experimental use */
669 #define MT_EXP4 12 /* for experimental use */
671 #define MT_CONTROL 14 /* extra-data protocol message */
672 #define MT_EXTCONTROL 15 /* control message with externalized contents */
673 #define MT_OOBDATA 16 /* expedited data */
675 #define MT_NOINIT 255 /* Not a type but a flag to allocate
676 a non-initialized mbuf */
679 * String names of mbuf-related UMA(9) and malloc(9) types. Exposed to
680 * !_KERNEL so that monitoring tools can look up the zones with
683 #define MBUF_MEM_NAME "mbuf"
684 #define MBUF_CLUSTER_MEM_NAME "mbuf_cluster"
685 #define MBUF_PACKET_MEM_NAME "mbuf_packet"
686 #define MBUF_JUMBOP_MEM_NAME "mbuf_jumbo_page"
687 #define MBUF_JUMBO9_MEM_NAME "mbuf_jumbo_9k"
688 #define MBUF_JUMBO16_MEM_NAME "mbuf_jumbo_16k"
689 #define MBUF_TAG_MEM_NAME "mbuf_tag"
690 #define MBUF_EXTREFCNT_MEM_NAME "mbuf_ext_refcnt"
691 #define MBUF_EXTPGS_MEM_NAME "mbuf_extpgs"
696 #define MBUF_CHECKSLEEP(how) do { \
697 if (how == M_WAITOK) \
698 WITNESS_WARN(WARN_GIANTOK | WARN_SLEEPOK, NULL, \
699 "Sleeping in \"%s\"", __func__); \
702 #define MBUF_CHECKSLEEP(how)
706 * Network buffer allocation API
708 * The rest of it is defined in kern/kern_mbuf.c
710 extern uma_zone_t zone_mbuf;
711 extern uma_zone_t zone_clust;
712 extern uma_zone_t zone_pack;
713 extern uma_zone_t zone_jumbop;
714 extern uma_zone_t zone_jumbo9;
715 extern uma_zone_t zone_jumbo16;
716 extern uma_zone_t zone_extpgs;
718 void mb_dupcl(struct mbuf *, struct mbuf *);
719 void mb_free_ext(struct mbuf *);
720 void mb_free_mext_pgs(struct mbuf *);
721 struct mbuf *mb_alloc_ext_pgs(int, m_ext_free_t);
722 int mb_unmapped_compress(struct mbuf *m);
723 struct mbuf *mb_unmapped_to_ext(struct mbuf *m);
724 void mb_free_notready(struct mbuf *m, int count);
725 void m_adj(struct mbuf *, int);
726 int m_apply(struct mbuf *, int, int,
727 int (*)(void *, void *, u_int), void *);
728 int m_append(struct mbuf *, int, c_caddr_t);
729 void m_cat(struct mbuf *, struct mbuf *);
730 void m_catpkt(struct mbuf *, struct mbuf *);
731 int m_clget(struct mbuf *m, int how);
732 void *m_cljget(struct mbuf *m, int how, int size);
733 struct mbuf *m_collapse(struct mbuf *, int, int);
734 void m_copyback(struct mbuf *, int, int, c_caddr_t);
735 void m_copydata(const struct mbuf *, int, int, caddr_t);
736 struct mbuf *m_copym(struct mbuf *, int, int, int);
737 struct mbuf *m_copypacket(struct mbuf *, int);
738 void m_copy_pkthdr(struct mbuf *, struct mbuf *);
739 struct mbuf *m_copyup(struct mbuf *, int, int);
740 struct mbuf *m_defrag(struct mbuf *, int);
741 void m_demote_pkthdr(struct mbuf *);
742 void m_demote(struct mbuf *, int, int);
743 struct mbuf *m_devget(char *, int, int, struct ifnet *,
744 void (*)(char *, caddr_t, u_int));
745 void m_dispose_extcontrolm(struct mbuf *m);
746 struct mbuf *m_dup(const struct mbuf *, int);
747 int m_dup_pkthdr(struct mbuf *, const struct mbuf *, int);
748 void m_extadd(struct mbuf *, char *, u_int, m_ext_free_t,
749 void *, void *, int, int);
750 u_int m_fixhdr(struct mbuf *);
751 struct mbuf *m_fragment(struct mbuf *, int, int);
752 void m_freem(struct mbuf *);
753 struct mbuf *m_get2(int, int, short, int);
754 struct mbuf *m_getjcl(int, short, int, int);
755 struct mbuf *m_getm2(struct mbuf *, int, int, short, int);
756 struct mbuf *m_getptr(struct mbuf *, int, int *);
757 u_int m_length(struct mbuf *, struct mbuf **);
758 int m_mbuftouio(struct uio *, const struct mbuf *, int);
759 int m_unmappedtouio(const struct mbuf *, int, struct uio *, int);
760 void m_move_pkthdr(struct mbuf *, struct mbuf *);
761 int m_pkthdr_init(struct mbuf *, int);
762 struct mbuf *m_prepend(struct mbuf *, int, int);
763 void m_print(const struct mbuf *, int);
764 struct mbuf *m_pulldown(struct mbuf *, int, int, int *);
765 struct mbuf *m_pullup(struct mbuf *, int);
766 int m_sanity(struct mbuf *, int);
767 struct mbuf *m_split(struct mbuf *, int, int);
768 struct mbuf *m_uiotombuf(struct uio *, int, int, int, int);
769 struct mbuf *m_unshare(struct mbuf *, int);
770 void m_snd_tag_init(struct m_snd_tag *, struct ifnet *);
771 void m_snd_tag_destroy(struct m_snd_tag *);
785 #if MJUMPAGESIZE != MCLBYTES
797 panic("%s: invalid cluster size %d", __func__, size);
804 * Associated an external reference counted buffer with an mbuf.
807 m_extaddref(struct mbuf *m, char *buf, u_int size, u_int *ref_cnt,
808 m_ext_free_t freef, void *arg1, void *arg2)
811 KASSERT(ref_cnt != NULL, ("%s: ref_cnt not provided", __func__));
813 atomic_add_int(ref_cnt, 1);
815 m->m_ext.ext_buf = buf;
816 m->m_ext.ext_cnt = ref_cnt;
817 m->m_data = m->m_ext.ext_buf;
818 m->m_ext.ext_size = size;
819 m->m_ext.ext_free = freef;
820 m->m_ext.ext_arg1 = arg1;
821 m->m_ext.ext_arg2 = arg2;
822 m->m_ext.ext_type = EXT_EXTREF;
823 m->m_ext.ext_flags = 0;
826 static __inline uma_zone_t
835 #if MJUMPAGESIZE != MCLBYTES
847 panic("%s: invalid cluster size %d", __func__, size);
854 * Initialize an mbuf with linear storage.
856 * Inline because the consumer text overhead will be roughly the same to
857 * initialize or call a function with this many parameters and M_PKTHDR
858 * should go away with constant propagation for !MGETHDR.
861 m_init(struct mbuf *m, int how, short type, int flags)
867 m->m_data = m->m_dat;
871 if (flags & M_PKTHDR)
872 error = m_pkthdr_init(m, how);
876 MBUF_PROBE5(m__init, m, how, type, flags, error);
880 static __inline struct mbuf *
881 m_get(int how, short type)
888 m = uma_zalloc_arg(zone_mbuf, &args, how);
889 MBUF_PROBE3(m__get, how, type, m);
893 static __inline struct mbuf *
894 m_gethdr(int how, short type)
899 args.flags = M_PKTHDR;
901 m = uma_zalloc_arg(zone_mbuf, &args, how);
902 MBUF_PROBE3(m__gethdr, how, type, m);
906 static __inline struct mbuf *
907 m_getcl(int how, short type, int flags)
914 m = uma_zalloc_arg(zone_pack, &args, how);
915 MBUF_PROBE4(m__getcl, how, type, flags, m);
920 * XXX: m_cljset() is a dangerous API. One must attach only a new,
921 * unreferenced cluster to an mbuf(9). It is not possible to assert
922 * that, so care can be taken only by users of the API.
925 m_cljset(struct mbuf *m, void *cl, int type)
933 #if MJUMPAGESIZE != MCLBYTES
945 panic("%s: unknown cluster type %d", __func__, type);
949 m->m_data = m->m_ext.ext_buf = cl;
950 m->m_ext.ext_free = m->m_ext.ext_arg1 = m->m_ext.ext_arg2 = NULL;
951 m->m_ext.ext_size = size;
952 m->m_ext.ext_type = type;
953 m->m_ext.ext_flags = EXT_FLAG_EMBREF;
954 m->m_ext.ext_count = 1;
956 MBUF_PROBE3(m__cljset, m, cl, type);
960 m_chtype(struct mbuf *m, short new_type)
963 m->m_type = new_type;
967 m_clrprotoflags(struct mbuf *m)
971 m->m_flags &= ~M_PROTOFLAGS;
976 static __inline struct mbuf *
977 m_last(struct mbuf *m)
986 m_extrefcnt(struct mbuf *m)
989 KASSERT(m->m_flags & M_EXT, ("%s: M_EXT missing", __func__));
991 return ((m->m_ext.ext_flags & EXT_FLAG_EMBREF) ? m->m_ext.ext_count :
996 * mbuf, cluster, and external object allocation macros (for compatibility
999 #define M_MOVE_PKTHDR(to, from) m_move_pkthdr((to), (from))
1000 #define MGET(m, how, type) ((m) = m_get((how), (type)))
1001 #define MGETHDR(m, how, type) ((m) = m_gethdr((how), (type)))
1002 #define MCLGET(m, how) m_clget((m), (how))
1003 #define MEXTADD(m, buf, size, free, arg1, arg2, flags, type) \
1004 m_extadd((m), (char *)(buf), (size), (free), (arg1), (arg2), \
1006 #define m_getm(m, len, how, type) \
1007 m_getm2((m), (len), (how), (type), M_PKTHDR)
1010 * Evaluate TRUE if it's safe to write to the mbuf m's data region (this can
1011 * be both the local data payload, or an external buffer area, depending on
1012 * whether M_EXT is set).
1014 #define M_WRITABLE(m) (((m)->m_flags & (M_RDONLY | M_NOMAP)) == 0 && \
1015 (!(((m)->m_flags & M_EXT)) || \
1016 (m_extrefcnt(m) == 1)))
1018 /* Check if the supplied mbuf has a packet header, or else panic. */
1019 #define M_ASSERTPKTHDR(m) \
1020 KASSERT((m) != NULL && (m)->m_flags & M_PKTHDR, \
1021 ("%s: no mbuf packet header!", __func__))
1024 * Ensure that the supplied mbuf is a valid, non-free mbuf.
1026 * XXX: Broken at the moment. Need some UMA magic to make it work again.
1028 #define M_ASSERTVALID(m) \
1029 KASSERT((((struct mbuf *)m)->m_flags & 0) == 0, \
1030 ("%s: attempted use of a free mbuf!", __func__))
1033 * Return the address of the start of the buffer associated with an mbuf,
1034 * handling external storage, packet-header mbufs, and regular data mbufs.
1036 #define M_START(m) \
1037 (((m)->m_flags & M_NOMAP) ? NULL : \
1038 ((m)->m_flags & M_EXT) ? (m)->m_ext.ext_buf : \
1039 ((m)->m_flags & M_PKTHDR) ? &(m)->m_pktdat[0] : \
1043 * Return the size of the buffer associated with an mbuf, handling external
1044 * storage, packet-header mbufs, and regular data mbufs.
1047 (((m)->m_flags & M_EXT) ? (m)->m_ext.ext_size : \
1048 ((m)->m_flags & M_PKTHDR) ? MHLEN : \
1052 * Set the m_data pointer of a newly allocated mbuf to place an object of the
1053 * specified size at the end of the mbuf, longword aligned.
1055 * NB: Historically, we had M_ALIGN(), MH_ALIGN(), and MEXT_ALIGN() as
1056 * separate macros, each asserting that it was called at the proper moment.
1057 * This required callers to themselves test the storage type and call the
1058 * right one. Rather than require callers to be aware of those layout
1059 * decisions, we centralize here.
1061 static __inline void
1062 m_align(struct mbuf *m, int len)
1065 const char *msg = "%s: not a virgin mbuf";
1069 KASSERT(m->m_data == M_START(m), (msg, __func__));
1071 adjust = M_SIZE(m) - len;
1072 m->m_data += adjust &~ (sizeof(long)-1);
1075 #define M_ALIGN(m, len) m_align(m, len)
1076 #define MH_ALIGN(m, len) m_align(m, len)
1077 #define MEXT_ALIGN(m, len) m_align(m, len)
1080 * Compute the amount of space available before the current start of data in
1083 * The M_WRITABLE() is a temporary, conservative safety measure: the burden
1084 * of checking writability of the mbuf data area rests solely with the caller.
1086 * NB: In previous versions, M_LEADINGSPACE() would only check M_WRITABLE()
1087 * for mbufs with external storage. We now allow mbuf-embedded data to be
1088 * read-only as well.
1090 #define M_LEADINGSPACE(m) \
1091 (M_WRITABLE(m) ? ((m)->m_data - M_START(m)) : 0)
1094 * Compute the amount of space available after the end of data in an mbuf.
1096 * The M_WRITABLE() is a temporary, conservative safety measure: the burden
1097 * of checking writability of the mbuf data area rests solely with the caller.
1099 * NB: In previous versions, M_TRAILINGSPACE() would only check M_WRITABLE()
1100 * for mbufs with external storage. We now allow mbuf-embedded data to be
1101 * read-only as well.
1103 #define M_TRAILINGSPACE(m) \
1105 ((M_START(m) + M_SIZE(m)) - ((m)->m_data + (m)->m_len)) : 0)
1108 * Arrange to prepend space of size plen to mbuf m. If a new mbuf must be
1109 * allocated, how specifies whether to wait. If the allocation fails, the
1110 * original mbuf chain is freed and m is set to NULL.
1112 #define M_PREPEND(m, plen, how) do { \
1113 struct mbuf **_mmp = &(m); \
1114 struct mbuf *_mm = *_mmp; \
1115 int _mplen = (plen); \
1116 int __mhow = (how); \
1118 MBUF_CHECKSLEEP(how); \
1119 if (M_LEADINGSPACE(_mm) >= _mplen) { \
1120 _mm->m_data -= _mplen; \
1121 _mm->m_len += _mplen; \
1123 _mm = m_prepend(_mm, _mplen, __mhow); \
1124 if (_mm != NULL && _mm->m_flags & M_PKTHDR) \
1125 _mm->m_pkthdr.len += _mplen; \
1130 * Change mbuf to new type. This is a relatively expensive operation and
1131 * should be avoided.
1133 #define MCHTYPE(m, t) m_chtype((m), (t))
1135 /* Return the rcvif of a packet header. */
1136 static __inline struct ifnet *
1137 m_rcvif(struct mbuf *m)
1141 if (m->m_pkthdr.csum_flags & CSUM_SND_TAG)
1143 return (m->m_pkthdr.rcvif);
1146 /* Length to m_copy to copy all. */
1147 #define M_COPYALL 1000000000
1149 extern int max_datalen; /* MHLEN - max_hdr */
1150 extern int max_hdr; /* Largest link + protocol header */
1151 extern int max_linkhdr; /* Largest link-level header */
1152 extern int max_protohdr; /* Largest protocol header */
1153 extern int nmbclusters; /* Maximum number of clusters */
1154 extern bool mb_use_ext_pgs; /* Use ext_pgs for sendfile */
1157 * Network packets may have annotations attached by affixing a list of
1158 * "packet tags" to the pkthdr structure. Packet tags are dynamically
1159 * allocated semi-opaque data structures that have a fixed header
1160 * (struct m_tag) that specifies the size of the memory block and a
1161 * <cookie,type> pair that identifies it. The cookie is a 32-bit unique
1162 * unsigned value used to identify a module or ABI. By convention this value
1163 * is chosen as the date+time that the module is created, expressed as the
1164 * number of seconds since the epoch (e.g., using date -u +'%s'). The type
1165 * value is an ABI/module-specific value that identifies a particular
1166 * annotation and is private to the module. For compatibility with systems
1167 * like OpenBSD that define packet tags w/o an ABI/module cookie, the value
1168 * PACKET_ABI_COMPAT is used to implement m_tag_get and m_tag_find
1169 * compatibility shim functions and several tag types are defined below.
1170 * Users that do not require compatibility should use a private cookie value
1171 * so that packet tag-related definitions can be maintained privately.
1173 * Note that the packet tag returned by m_tag_alloc has the default memory
1174 * alignment implemented by malloc. To reference private data one can use a
1177 * struct m_tag *mtag = m_tag_alloc(...);
1178 * struct foo *p = (struct foo *)(mtag+1);
1180 * if the alignment of struct m_tag is sufficient for referencing members of
1181 * struct foo. Otherwise it is necessary to embed struct m_tag within the
1182 * private data structure to insure proper alignment; e.g.,
1188 * struct foo *p = (struct foo *) m_tag_alloc(...);
1189 * struct m_tag *mtag = &p->tag;
1193 * Persistent tags stay with an mbuf until the mbuf is reclaimed. Otherwise
1194 * tags are expected to ``vanish'' when they pass through a network
1195 * interface. For most interfaces this happens normally as the tags are
1196 * reclaimed when the mbuf is free'd. However in some special cases
1197 * reclaiming must be done manually. An example is packets that pass through
1198 * the loopback interface. Also, one must be careful to do this when
1199 * ``turning around'' packets (e.g., icmp_reflect).
1201 * To mark a tag persistent bit-or this flag in when defining the tag id.
1202 * The tag will then be treated as described above.
1204 #define MTAG_PERSISTENT 0x800
1206 #define PACKET_TAG_NONE 0 /* Nadda */
1208 /* Packet tags for use with PACKET_ABI_COMPAT. */
1209 #define PACKET_TAG_IPSEC_IN_DONE 1 /* IPsec applied, in */
1210 #define PACKET_TAG_IPSEC_OUT_DONE 2 /* IPsec applied, out */
1211 #define PACKET_TAG_IPSEC_IN_CRYPTO_DONE 3 /* NIC IPsec crypto done */
1212 #define PACKET_TAG_IPSEC_OUT_CRYPTO_NEEDED 4 /* NIC IPsec crypto req'ed */
1213 #define PACKET_TAG_IPSEC_IN_COULD_DO_CRYPTO 5 /* NIC notifies IPsec */
1214 #define PACKET_TAG_IPSEC_PENDING_TDB 6 /* Reminder to do IPsec */
1215 #define PACKET_TAG_BRIDGE 7 /* Bridge processing done */
1216 #define PACKET_TAG_GIF 8 /* GIF processing done */
1217 #define PACKET_TAG_GRE 9 /* GRE processing done */
1218 #define PACKET_TAG_IN_PACKET_CHECKSUM 10 /* NIC checksumming done */
1219 #define PACKET_TAG_ENCAP 11 /* Encap. processing */
1220 #define PACKET_TAG_IPSEC_SOCKET 12 /* IPSEC socket ref */
1221 #define PACKET_TAG_IPSEC_HISTORY 13 /* IPSEC history */
1222 #define PACKET_TAG_IPV6_INPUT 14 /* IPV6 input processing */
1223 #define PACKET_TAG_DUMMYNET 15 /* dummynet info */
1224 #define PACKET_TAG_DIVERT 17 /* divert info */
1225 #define PACKET_TAG_IPFORWARD 18 /* ipforward info */
1226 #define PACKET_TAG_MACLABEL (19 | MTAG_PERSISTENT) /* MAC label */
1227 #define PACKET_TAG_PF (21 | MTAG_PERSISTENT) /* PF/ALTQ information */
1228 #define PACKET_TAG_RTSOCKFAM 25 /* rtsock sa family */
1229 #define PACKET_TAG_IPOPTIONS 27 /* Saved IP options */
1230 #define PACKET_TAG_CARP 28 /* CARP info */
1231 #define PACKET_TAG_IPSEC_NAT_T_PORTS 29 /* two uint16_t */
1232 #define PACKET_TAG_ND_OUTGOING 30 /* ND outgoing */
1234 /* Specific cookies and tags. */
1236 /* Packet tag routines. */
1237 struct m_tag *m_tag_alloc(u_int32_t, int, int, int);
1238 void m_tag_delete(struct mbuf *, struct m_tag *);
1239 void m_tag_delete_chain(struct mbuf *, struct m_tag *);
1240 void m_tag_free_default(struct m_tag *);
1241 struct m_tag *m_tag_locate(struct mbuf *, u_int32_t, int, struct m_tag *);
1242 struct m_tag *m_tag_copy(struct m_tag *, int);
1243 int m_tag_copy_chain(struct mbuf *, const struct mbuf *, int);
1244 void m_tag_delete_nonpersistent(struct mbuf *);
1247 * Initialize the list of tags associated with an mbuf.
1249 static __inline void
1250 m_tag_init(struct mbuf *m)
1253 SLIST_INIT(&m->m_pkthdr.tags);
1257 * Set up the contents of a tag. Note that this does not fill in the free
1258 * method; the caller is expected to do that.
1260 * XXX probably should be called m_tag_init, but that was already taken.
1262 static __inline void
1263 m_tag_setup(struct m_tag *t, u_int32_t cookie, int type, int len)
1268 t->m_tag_cookie = cookie;
1272 * Reclaim resources associated with a tag.
1274 static __inline void
1275 m_tag_free(struct m_tag *t)
1278 (*t->m_tag_free)(t);
1282 * Return the first tag associated with an mbuf.
1284 static __inline struct m_tag *
1285 m_tag_first(struct mbuf *m)
1288 return (SLIST_FIRST(&m->m_pkthdr.tags));
1292 * Return the next tag in the list of tags associated with an mbuf.
1294 static __inline struct m_tag *
1295 m_tag_next(struct mbuf *m __unused, struct m_tag *t)
1298 return (SLIST_NEXT(t, m_tag_link));
1302 * Prepend a tag to the list of tags associated with an mbuf.
1304 static __inline void
1305 m_tag_prepend(struct mbuf *m, struct m_tag *t)
1308 SLIST_INSERT_HEAD(&m->m_pkthdr.tags, t, m_tag_link);
1312 * Unlink a tag from the list of tags associated with an mbuf.
1314 static __inline void
1315 m_tag_unlink(struct mbuf *m, struct m_tag *t)
1318 SLIST_REMOVE(&m->m_pkthdr.tags, t, m_tag, m_tag_link);
1321 /* These are for OpenBSD compatibility. */
1322 #define MTAG_ABI_COMPAT 0 /* compatibility ABI */
1324 static __inline struct m_tag *
1325 m_tag_get(int type, int length, int wait)
1327 return (m_tag_alloc(MTAG_ABI_COMPAT, type, length, wait));
1330 static __inline struct m_tag *
1331 m_tag_find(struct mbuf *m, int type, struct m_tag *start)
1333 return (SLIST_EMPTY(&m->m_pkthdr.tags) ? (struct m_tag *)NULL :
1334 m_tag_locate(m, MTAG_ABI_COMPAT, type, start));
1337 static inline struct m_snd_tag *
1338 m_snd_tag_ref(struct m_snd_tag *mst)
1341 refcount_acquire(&mst->refcount);
1346 m_snd_tag_rele(struct m_snd_tag *mst)
1349 if (refcount_release(&mst->refcount))
1350 m_snd_tag_destroy(mst);
1353 static __inline struct mbuf *
1354 m_free(struct mbuf *m)
1356 struct mbuf *n = m->m_next;
1358 MBUF_PROBE1(m__free, m);
1359 if ((m->m_flags & (M_PKTHDR|M_NOFREE)) == (M_PKTHDR|M_NOFREE))
1360 m_tag_delete_chain(m, NULL);
1361 if (m->m_flags & M_PKTHDR && m->m_pkthdr.csum_flags & CSUM_SND_TAG)
1362 m_snd_tag_rele(m->m_pkthdr.snd_tag);
1363 if (m->m_flags & M_EXT)
1365 else if ((m->m_flags & M_NOFREE) == 0)
1366 uma_zfree(zone_mbuf, m);
1371 rt_m_getfib(struct mbuf *m)
1373 KASSERT(m->m_flags & M_PKTHDR , ("Attempt to get FIB from non header mbuf."));
1374 return (m->m_pkthdr.fibnum);
1377 #define M_GETFIB(_m) rt_m_getfib(_m)
1379 #define M_SETFIB(_m, _fib) do { \
1380 KASSERT((_m)->m_flags & M_PKTHDR, ("Attempt to set FIB on non header mbuf.")); \
1381 ((_m)->m_pkthdr.fibnum) = (_fib); \
1384 /* flags passed as first argument for "m_ether_tcpip_hash()" */
1385 #define MBUF_HASHFLAG_L2 (1 << 2)
1386 #define MBUF_HASHFLAG_L3 (1 << 3)
1387 #define MBUF_HASHFLAG_L4 (1 << 4)
1389 /* mbuf hashing helper routines */
1390 uint32_t m_ether_tcpip_hash_init(void);
1391 uint32_t m_ether_tcpip_hash(const uint32_t, const struct mbuf *, const uint32_t);
1393 #ifdef MBUF_PROFILING
1394 void m_profile(struct mbuf *m);
1395 #define M_PROFILE(m) m_profile(m)
1397 #define M_PROFILE(m)
1401 STAILQ_HEAD(, mbuf) mq_head;
1407 mbufq_init(struct mbufq *mq, int maxlen)
1410 STAILQ_INIT(&mq->mq_head);
1411 mq->mq_maxlen = maxlen;
1415 static inline struct mbuf *
1416 mbufq_flush(struct mbufq *mq)
1420 m = STAILQ_FIRST(&mq->mq_head);
1421 STAILQ_INIT(&mq->mq_head);
1427 mbufq_drain(struct mbufq *mq)
1431 n = mbufq_flush(mq);
1432 while ((m = n) != NULL) {
1433 n = STAILQ_NEXT(m, m_stailqpkt);
1438 static inline struct mbuf *
1439 mbufq_first(const struct mbufq *mq)
1442 return (STAILQ_FIRST(&mq->mq_head));
1445 static inline struct mbuf *
1446 mbufq_last(const struct mbufq *mq)
1449 return (STAILQ_LAST(&mq->mq_head, mbuf, m_stailqpkt));
1453 mbufq_full(const struct mbufq *mq)
1456 return (mq->mq_maxlen > 0 && mq->mq_len >= mq->mq_maxlen);
1460 mbufq_len(const struct mbufq *mq)
1463 return (mq->mq_len);
1467 mbufq_enqueue(struct mbufq *mq, struct mbuf *m)
1472 STAILQ_INSERT_TAIL(&mq->mq_head, m, m_stailqpkt);
1477 static inline struct mbuf *
1478 mbufq_dequeue(struct mbufq *mq)
1482 m = STAILQ_FIRST(&mq->mq_head);
1484 STAILQ_REMOVE_HEAD(&mq->mq_head, m_stailqpkt);
1485 m->m_nextpkt = NULL;
1492 mbufq_prepend(struct mbufq *mq, struct mbuf *m)
1495 STAILQ_INSERT_HEAD(&mq->mq_head, m, m_stailqpkt);
1500 * Note: this doesn't enforce the maximum list size for dst.
1503 mbufq_concat(struct mbufq *mq_dst, struct mbufq *mq_src)
1506 mq_dst->mq_len += mq_src->mq_len;
1507 STAILQ_CONCAT(&mq_dst->mq_head, &mq_src->mq_head);
1511 #ifdef _SYS_TIMESPEC_H_
1513 mbuf_tstmp2timespec(struct mbuf *m, struct timespec *ts)
1516 KASSERT((m->m_flags & M_PKTHDR) != 0, ("mbuf %p no M_PKTHDR", m));
1517 KASSERT((m->m_flags & (M_TSTMP|M_TSTMP_LRO)) != 0, ("mbuf %p no M_TSTMP or M_TSTMP_LRO", m));
1518 ts->tv_sec = m->m_pkthdr.rcv_tstmp / 1000000000;
1519 ts->tv_nsec = m->m_pkthdr.rcv_tstmp % 1000000000;
1524 /* Invoked from the debugnet client code. */
1525 void debugnet_mbuf_drain(void);
1526 void debugnet_mbuf_start(void);
1527 void debugnet_mbuf_finish(void);
1528 void debugnet_mbuf_reinit(int nmbuf, int nclust, int clsize);
1532 mbuf_has_tls_session(struct mbuf *m)
1535 if (m->m_flags & M_NOMAP) {
1536 MBUF_EXT_PGS_ASSERT(m);
1537 if (m->m_ext_pgs.tls != NULL) {
1544 #endif /* _KERNEL */
1545 #endif /* !_SYS_MBUF_H_ */