]> git.saurik.com Git - apple/xnu.git/blame - bsd/sys/mbuf.h
projects / apple / xnu.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
xnu-7195.81.3.tar.gz
[apple/xnu.git] / bsd / sys / mbuf.h
CommitLineData
1c79356b 1/*
f427ee49 2 * Copyright (c) 1999-2020 Apple Inc. All rights reserved.
5d5c5d0d 3 *
2d21ac55 4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
6d2010ae 5 *
2d21ac55
A		 6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. The rights granted to you under the License
10 * may not be used to create, or enable the creation or redistribution of,
11 * unlawful or unlicensed copies of an Apple operating system, or to
12 * circumvent, violate, or enable the circumvention or violation of, any
13 * terms of an Apple operating system software license agreement.
6d2010ae 14 *
2d21ac55
A		 15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
6d2010ae 17 *
2d21ac55
A		 18 * The Original Code and all software distributed under the License are
19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
8f6c56a5
A		 20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55
A		 22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23 * Please see the License for the specific language governing rights and
24 * limitations under the License.
6d2010ae 25 *
2d21ac55 26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b
A		 27 */
28/* Copyright (c) 1998, 1999 Apple Computer, Inc. All Rights Reserved */
29/* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
6d2010ae 30/*
1c79356b
A		 31 * Mach Operating System
32 * Copyright (c) 1987 Carnegie-Mellon University
33 * All rights reserved. The CMU software License Agreement specifies
34 * the terms and conditions for use and redistribution.
35 */
36/*
37 * Copyright (c) 1994 NeXT Computer, Inc. All rights reserved.
38 *
39 * Copyright (c) 1982, 1986, 1988 Regents of the University of California.
40 * All rights reserved.
41 *
42 * Redistribution and use in source and binary forms, with or without
43 * modification, are permitted provided that the following conditions
44 * are met:
45 * 1. Redistributions of source code must retain the above copyright
46 * notice, this list of conditions and the following disclaimer.
47 * 2. Redistributions in binary form must reproduce the above copyright
48 * notice, this list of conditions and the following disclaimer in the
49 * documentation and/or other materials provided with the distribution.
50 * 3. All advertising materials mentioning features or use of this software
51 * must display the following acknowledgement:
52 * This product includes software developed by the University of
53 * California, Berkeley and its contributors.
54 * 4. Neither the name of the University nor the names of its contributors
55 * may be used to endorse or promote products derived from this software
56 * without specific prior written permission.
57 *
58 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
59 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
60 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
61 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
62 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
63 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
64 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
65 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
66 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
67 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
68 * SUCH DAMAGE.
69 *
70 * @(#)mbuf.h 8.3 (Berkeley) 1/21/94
1c79356b 71 */
2d21ac55
A		 72/*
73 * NOTICE: This file was modified by SPARTA, Inc. in 2005 to introduce
74 * support for mandatory and extensible security protections. This notice
75 * is included in support of clause 2.2 (b) of the Apple Public License,
76 * Version 2.0.
77 */
1c79356b 78
0a7de745
A		 79#ifndef _SYS_MBUF_H_
80#define _SYS_MBUF_H_
1c79356b 81
9bccf70c 82#include <sys/appleapiopts.h>
d9a64523 83#include <sys/cdefs.h>
5ba3f43e
A		 84#include <sys/_types/_u_int32_t.h> /* u_int32_t */
85#include <sys/_types/_u_int64_t.h> /* u_int64_t */
86#include <sys/_types/_u_short.h> /* u_short */
91447636 87
d9a64523
A		 88#ifdef KERNEL
89#include <sys/kpi_mbuf.h>
90#endif
91447636 91
d9a64523 92#ifdef XNU_KERNEL_PRIVATE
1c79356b 93#include <sys/lock.h>
91447636 94#include <sys/queue.h>
39236c6e 95#include <machine/endian.h>
1c79356b
A		 96/*
97 * Mbufs are of a single size, MSIZE (machine/param.h), which
98 * includes overhead. An mbuf may add a single "mbuf cluster" of size
6d2010ae
A		 99 * MCLBYTES/MBIGCLBYTES/M16KCLBYTES (also in machine/param.h), which has
100 * no additional overhead and is used instead of the internal data area;
101 * this is done when at least MINCLSIZE of data must be stored.
b0d623f7 102 */
b0d623f7
A		 103
104/*
105 * The following _MLEN and _MHLEN macros are private to xnu. Private code
106 * that are outside of xnu must use the mbuf_get_{mlen,mhlen} routines since
107 * the sizes of the structures are dependent upon specific xnu configs.
108 */
0a7de745
A		 109#define _MLEN (MSIZE - sizeof(struct m_hdr)) /* normal data len */
110#define _MHLEN (_MLEN - sizeof(struct pkthdr)) /* data len w/pkthdr */
1c79356b 111
0a7de745
A		 112#define NMBPGSHIFT (PAGE_SHIFT - MSIZESHIFT)
113#define NMBPG (1 << NMBPGSHIFT) /* # of mbufs per page */
1c79356b 114
0a7de745
A		 115#define NCLPGSHIFT (PAGE_SHIFT - MCLSHIFT)
116#define NCLPG (1 << NCLPGSHIFT) /* # of cl per page */
6d2010ae 117
0a7de745
A		 118#define NBCLPGSHIFT (PAGE_SHIFT - MBIGCLSHIFT)
119#define NBCLPG (1 << NBCLPGSHIFT) /* # of big cl per page */
3e170ce0 120
0a7de745
A		 121#define NMBPCLSHIFT (MCLSHIFT - MSIZESHIFT)
122#define NMBPCL (1 << NMBPCLSHIFT) /* # of mbufs per cl */
6d2010ae 123
0a7de745
A		 124#define NCLPJCLSHIFT (M16KCLSHIFT - MCLSHIFT)
125#define NCLPJCL (1 << NCLPJCLSHIFT) /* # of cl per jumbo cl */
1c79356b 126
0a7de745
A		 127#define NCLPBGSHIFT (MBIGCLSHIFT - MCLSHIFT)
128#define NCLPBG (1 << NCLPBGSHIFT) /* # of cl per big cl */
3e170ce0 129
0a7de745
A		 130#define NMBPBGSHIFT (MBIGCLSHIFT - MSIZESHIFT)
131#define NMBPBG (1 << NMBPBGSHIFT) /* # of mbufs per big cl */
3e170ce0 132
1c79356b
A		 133/*
134 * Macros for type conversion
135 * mtod(m,t) - convert mbuf pointer to data pointer of correct type
5ba3f43e 136 * mtodo(m, o) -- Same as above but with offset 'o' into data.
1c79356b 137 * dtom(x) - convert data pointer within mbuf to mbuf pointer (XXX)
1c79356b 138 */
0a7de745 139#define mtod(m, t) ((t)m_mtod(m))
5ba3f43e 140#define mtodo(m, o) ((void *)(mtod(m, uint8_t *) + (o)))
0a7de745 141#define dtom(x) m_dtom(x)
1c79356b
A		 142
143/* header at beginning of each mbuf: */
144struct m_hdr {
0a7de745
A		 145 struct mbuf *mh_next; /* next buffer in chain */
146 struct mbuf *mh_nextpkt; /* next chain in queue/record */
147 caddr_t mh_data; /* location of data */
148 int32_t mh_len; /* amount of data in this mbuf */
149 u_int16_t mh_type; /* type of data in this mbuf */
150 u_int16_t mh_flags; /* flags; see below */
5ba3f43e
A		 151#if __arm__ && (__BIGGEST_ALIGNMENT__ > 4)
152/* This is needed because of how _MLEN is defined and used. Ideally, _MLEN
153 * should be defined using the offsetof(struct mbuf, M_dat), since there is
154 * no guarantee that mbuf.M_dat will start where mbuf.m_hdr ends. The compiler
155 * may (and does in the armv7k case) insert padding between m_hdr and M_dat in
156 * mbuf. We cannot easily use offsetof, however, since _MLEN is referenced
157 * in the definition of mbuf.
158 */
159} __attribute__((aligned(8)));
160#else
1c79356b 161};
5ba3f43e 162#endif
1c79356b 163
91447636
A		 164/*
165 * Packet tag structure (see below for details).
166 */
167struct m_tag {
f427ee49 168 uint64_t m_tag_cookie; /* Error checking */
6d2010ae 169#ifndef __LP64__
f427ee49 170 uint32_t pad; /* For structure alignment */
6d2010ae 171#endif /* !__LP64__ */
0a7de745 172 SLIST_ENTRY(m_tag) m_tag_link; /* List of packet tags */
f427ee49
A		 173 uint16_t m_tag_type; /* Module specific type */
174 uint16_t m_tag_len; /* Length of data */
175 uint32_t m_tag_id; /* Module ID */
6d2010ae
A		 176};
177
0a7de745 178#define M_TAG_ALIGN(len) \
316670eb 179 (P2ROUNDUP(len, sizeof (u_int64_t)) + sizeof (struct m_tag))
6d2010ae 180
0a7de745
A		 181#define M_TAG_VALID_PATTERN 0xfeedfacefeedfaceULL
182#define M_TAG_FREE_PATTERN 0xdeadbeefdeadbeefULL
6d2010ae 183
316670eb
A		 184/*
185 * Packet tag header structure (at the top of mbuf). Pointers are
186 * 32-bit in ILP32; m_tag needs 64-bit alignment, hence padded.
187 */
6d2010ae 188struct m_taghdr {
316670eb 189#ifndef __LP64__
0a7de745 190 u_int32_t pad; /* For structure alignment */
316670eb 191#endif /* !__LP64__ */
0a7de745 192 u_int64_t refcnt; /* Number of tags in this mbuf */
91447636
A		 193};
194
39236c6e
A		 195/*
196 * Driver auxiliary metadata tag (KERNEL_TAG_TYPE_DRVAUX).
197 */
198struct m_drvaux_tag {
0a7de745
A		 199 u_int32_t da_family; /* IFNET_FAMILY values */
200 u_int32_t da_subfamily; /* IFNET_SUBFAMILY values */
201 u_int32_t da_reserved; /* for future */
202 u_int32_t da_length; /* length of following data */
39236c6e 203};
316670eb 204
39236c6e 205/* Values for pftag_flags (16-bit wide) */
0a7de745
A		 206#define PF_TAG_GENERATED 0x1 /* pkt generated by PF */
207#define PF_TAG_FRAGCACHE 0x2
208#define PF_TAG_TRANSLATE_LOCALHOST 0x4
39236c6e 209#if PF_ECN
0a7de745
A		 210#define PF_TAG_HDR_INET 0x8 /* hdr points to IPv4 */
211#define PF_TAG_HDR_INET6 0x10 /* hdr points to IPv6 */
39236c6e 212#endif /* PF_ECN */
cb323159
A		 213#define PF_TAG_REASSEMBLED 0x20 /* pkt reassembled by PF */
214#define PF_TAG_REFRAGMENTED 0x40 /* pkt refragmented by PF */
39236c6e
A		 215/*
216 * PF mbuf tag
217 */
316670eb 218struct pf_mtag {
0a7de745
A		 219 u_int16_t pftag_flags; /* PF_TAG flags */
220 u_int16_t pftag_rtableid; /* alternate routing table id */
221 u_int16_t pftag_tag;
222 u_int16_t pftag_routed;
39236c6e 223#if PF_ECN
0a7de745 224 void *pftag_hdr; /* saved hdr pos in mbuf, for ECN */
39236c6e
A		 225#endif /* PF_ECN */
226};
227
f427ee49
A		 228/* System reserved PF tags */
229#define PF_TAG_ID_SYSTEM_SERVICE 0xff00
230#define PF_TAG_ID_STACK_DROP 0xff01
231
cb323159
A		 232/*
233 * PF fragment tag
234 */
235struct pf_fragment_tag {
236 uint32_t ft_id; /* fragment id */
237 uint16_t ft_hdrlen; /* header length of reassembled pkt */
238 uint16_t ft_unfragpartlen; /* length of the per-fragment headers */
239 uint16_t ft_extoff; /* last extension header offset or 0 */
240 uint16_t ft_maxlen; /* maximum fragment payload length */
241};
242
39236c6e
A		 243/*
244 * TCP mbuf tag
245 */
246struct tcp_pktinfo {
316670eb
A		 247 union {
248 struct {
f427ee49
A		 249 uint32_t segsz; /* segment size (actual MSS) */
250 uint32_t start_seq; /* start seq of this packet */
d9a64523
A		 251 pid_t pid;
252 pid_t e_pid;
39236c6e
A		 253 } __tx;
254 struct {
f427ee49 255 uint8_t seg_cnt; /* # of coalesced TCP pkts */
39236c6e
A		 256 } __rx;
257 } __offload;
0a7de745
A		 258#define tso_segsz proto_mtag.__pr_u.tcp.tm_tcp.__offload.__tx.segsz
259#define tx_start_seq proto_mtag.__pr_u.tcp.tm_tcp.__offload.__tx.start_seq
260#define tx_tcp_pid proto_mtag.__pr_u.tcp.tm_tcp.__offload.__tx.pid
261#define tx_tcp_e_pid proto_mtag.__pr_u.tcp.tm_tcp.__offload.__tx.e_pid
f427ee49 262#define seg_cnt proto_mtag.__pr_u.tcp.tm_tcp.__offload.__rx.seg_cnt
316670eb
A		 263};
264
39236c6e
A		 265/*
266 * MPTCP mbuf tag
267 */
268struct mptcp_pktinfo {
f427ee49
A		 269 uint64_t mtpi_dsn; /* MPTCP Data Sequence Number */
270 uint32_t mtpi_rel_seq; /* Relative Seq Number */
271 uint16_t mtpi_length; /* Length of mapping */
272 uint16_t mtpi_csum;
0a7de745
A		 273#define mp_dsn proto_mtag.__pr_u.tcp.tm_mptcp.mtpi_dsn
274#define mp_rseq proto_mtag.__pr_u.tcp.tm_mptcp.mtpi_rel_seq
275#define mp_rlen proto_mtag.__pr_u.tcp.tm_mptcp.mtpi_length
276#define mp_csum proto_mtag.__pr_u.tcp.tm_mptcp.mtpi_csum
39236c6e
A		 277};
278
279/*
280 * TCP specific mbuf tag. Note that the current implementation uses
281 * MPTCP metadata strictly between MPTCP and the TCP subflow layers,
282 * hence tm_tcp and tm_mptcp are mutually exclusive. This also means
283 * that TCP messages functionality is currently incompatible with MPTCP.
284 */
316670eb 285struct tcp_mtag {
39236c6e 286 union {
0a7de745
A		 287 struct tcp_pktinfo tm_tcp; /* TCP and below */
288 struct mptcp_pktinfo tm_mptcp; /* MPTCP-TCP only */
39236c6e
A		 289 };
290};
291
d9a64523
A		 292struct udp_mtag {
293 pid_t _pid;
294 pid_t _e_pid;
0a7de745
A		 295#define tx_udp_pid proto_mtag.__pr_u.udp._pid
296#define tx_udp_e_pid proto_mtag.__pr_u.udp._e_pid
d9a64523
A		 297};
298
299struct rawip_mtag {
300 pid_t _pid;
301 pid_t _e_pid;
0a7de745
A		 302#define tx_rawip_pid proto_mtag.__pr_u.rawip._pid
303#define tx_rawip_e_pid proto_mtag.__pr_u.rawip._e_pid
d9a64523
A		 304};
305
39037602 306struct driver_mtag_ {
0a7de745
A		 307 uintptr_t _drv_tx_compl_arg;
308 uintptr_t _drv_tx_compl_data;
309 kern_return_t _drv_tx_status;
310 uint16_t _drv_flowid;
311#define drv_tx_compl_arg builtin_mtag._drv_mtag._drv_tx_compl_arg
312#define drv_tx_compl_data builtin_mtag._drv_mtag._drv_tx_compl_data
313#define drv_tx_status builtin_mtag._drv_mtag._drv_tx_status
314#define drv_flowid builtin_mtag._drv_mtag._drv_flowid
39037602
A		 315};
316
39236c6e
A		 317/*
318 * Protocol specific mbuf tag (at most one protocol metadata per mbuf).
319 *
320 * Care must be taken to ensure that they are mutually exclusive, e.g.
cb323159 321 * IPsec policy ID implies no TCP segment offload (which is fine given
39236c6e
A		 322 * that the former is used on the virtual ipsec interface that does
323 * not advertise the TSO capability.)
324 */
39037602 325struct proto_mtag_ {
39236c6e 326 union {
0a7de745
A		 327 struct tcp_mtag tcp; /* TCP specific */
328 struct udp_mtag udp; /* UDP specific */
329 struct rawip_mtag rawip; /* raw IPv4/IPv6 specific */
39236c6e
A		 330 } __pr_u;
331};
332
fe8ab488
A		 333/*
334 * NECP specific mbuf tag.
335 */
39037602 336struct necp_mtag_ {
0a7de745
A		 337 u_int32_t necp_policy_id;
338 u_int32_t necp_skip_policy_id;
339 u_int32_t necp_route_rule_id;
340 u_int16_t necp_last_interface_index;
341 u_int16_t necp_app_id;
39037602
A		 342};
343
344union builtin_mtag {
345 struct {
0a7de745
A		 346 struct proto_mtag_ _proto_mtag; /* built-in protocol-specific tag */
347 struct pf_mtag _pf_mtag; /* built-in PF tag */
39037602
A		 348 struct necp_mtag_ _necp_mtag; /* built-in NECP tag */
349 } _net_mtag;
350 struct driver_mtag_ _drv_mtag;
351#define necp_mtag builtin_mtag._net_mtag._necp_mtag
352#define proto_mtag builtin_mtag._net_mtag._proto_mtag
353#define driver_mtag builtin_mtag._drv_mtag
fe8ab488
A		 354};
355
39236c6e
A		 356/*
357 * Record/packet header in first mbuf of chain; valid only if M_PKTHDR set.
358 */
39037602 359struct pkthdr {
0a7de745 360 struct ifnet *rcvif; /* rcv interface */
1c79356b 361 /* variables for ip and tcp reassembly */
0a7de745
A		 362 void *pkt_hdr; /* pointer to packet header */
363 int32_t len; /* total packet length */
6d2010ae
A		 364 /* variables for hardware checksum */
365 /* Note: csum_flags is used for hardware checksum and VLAN */
0a7de745 366 u_int32_t csum_flags; /* flags regarding checksum */
39236c6e
A		 367 union {
368 struct {
0a7de745 369 u_int16_t val; /* checksum value */
39236c6e
A		 370 u_int16_t start; /* checksum start offset */
371 } _csum_rx;
0a7de745
A		 372#define csum_rx_val _csum_rx.val
373#define csum_rx_start _csum_rx.start
39236c6e
A		 374 struct {
375 u_int16_t start; /* checksum start offset */
376 u_int16_t stuff; /* checksum stuff offset */
377 } _csum_tx;
0a7de745
A		 378#define csum_tx_start _csum_tx.start
379#define csum_tx_stuff _csum_tx.stuff
d9a64523
A		 380 /*
381 * Generic data field used by csum routines.
382 * It gets used differently in different contexts.
383 */
384 u_int32_t csum_data;
39236c6e 385 };
0a7de745 386 u_int16_t vlan_tag; /* VLAN tag, host byte order */
39236c6e
A		 387 /*
388 * Packet classifier info
389 *
390 * PKTF_FLOW_ID set means valid flow ID. A non-zero flow ID value
391 * means the packet has been classified by one of the flow sources.
392 * It is also a prerequisite for flow control advisory, which is
393 * enabled by additionally setting PKTF_FLOW_ADV.
394 *
395 * The protocol value is a best-effort representation of the payload.
396 * It is opportunistically updated and used only for optimization.
397 * It is not a substitute for parsing the protocol header(s); use it
398 * only as a hint.
399 *
400 * If PKTF_IFAINFO is set, pkt_ifainfo contains one or both of the
401 * indices of interfaces which own the source and/or destination
402 * addresses of the packet. For the local/loopback case (PKTF_LOOP),
403 * both should be valid, and thus allows for the receiving end to
404 * quickly determine the actual interfaces used by the the addresses;
405 * they may not necessarily be the same or refer to the loopback
406 * interface. Otherwise, in the non-local/loopback case, the indices
407 * are opportunistically set, and because of that only one may be set
408 * (0 means the index has not been determined.) In addition, the
409 * interface address flags are also recorded. This allows us to avoid
410 * storing the corresponding {in,in6}_ifaddr in an mbuf tag. Ideally
411 * this would be a superset of {ia,ia6}_flags, but the namespaces are
412 * overlapping at present, so we'll need a new set of values in future
413 * to achieve this. For now, we will just rely on the address family
414 * related code paths examining this mbuf to interpret the flags.
415 */
0a7de745
A		 416 u_int8_t pkt_proto; /* IPPROTO value */
417 u_int8_t pkt_flowsrc; /* FLOWSRC values */
418 u_int32_t pkt_flowid; /* flow ID */
419 u_int32_t pkt_flags; /* PKTF flags (see below) */
420 u_int32_t pkt_svc; /* MBUF_SVC value */
39037602 421
0a7de745 422 u_int32_t pkt_compl_context; /* Packet completion context */
39037602 423
39236c6e
A		 424 union {
425 struct {
0a7de745
A		 426 u_int16_t src; /* ifindex of src addr i/f */
427 u_int16_t src_flags; /* src PKT_IFAIFF flags */
428 u_int16_t dst; /* ifindex of dst addr i/f */
429 u_int16_t dst_flags; /* dst PKT_IFAIFF flags */
39236c6e 430 } _pkt_iaif;
0a7de745
A		 431#define src_ifindex _pkt_iaif.src
432#define src_iff _pkt_iaif.src_flags
433#define dst_ifindex _pkt_iaif.dst
434#define dst_iff _pkt_iaif.dst_flags
435 u_int64_t pkt_ifainfo; /* data field used by ifainfo */
39037602
A		 436 struct {
437 u_int32_t if_data; /* bytes in interface queue */
438 u_int32_t sndbuf_data; /* bytes in socket buffer */
0a7de745
A		 439 } _pkt_bsr; /* Buffer status report used by cellular interface */
440#define bufstatus_if _pkt_bsr.if_data
441#define bufstatus_sndbuf _pkt_bsr.sndbuf_data
39236c6e 442 };
cb323159 443 u_int64_t pkt_timestamp; /* TX: enqueue time, RX: receive timestamp */
3e170ce0 444
39236c6e
A		 445 /*
446 * Tags (external and built-in)
447 */
448 SLIST_HEAD(packet_tags, m_tag) tags; /* list of external tags */
39037602 449 union builtin_mtag builtin_mtag;
f427ee49
A		 450
451 uint32_t comp_gencnt;
452 uint32_t padding;
39236c6e
A		 453 /*
454 * Module private scratch space (32-bit aligned), currently 16-bytes
39037602 455 * large. Anything stored here is not guaranteed to survive across
5ba3f43e
A		 456 * modules. The AQM layer (outbound) uses all 16-bytes for both
457 * packet scheduling and flow advisory information.
39236c6e
A		 458 */
459 struct {
460 union {
0a7de745
A		 461 u_int8_t __mpriv8[16];
462 u_int16_t __mpriv16[8];
39236c6e
A		 463 struct {
464 union {
0a7de745
A		 465 u_int8_t __val8[4];
466 u_int16_t __val16[2];
467 u_int32_t __val32;
39236c6e 468 } __mpriv32_u;
0a7de745
A		 469 } __mpriv32[4];
470 u_int64_t __mpriv64[2];
39236c6e
A		 471 } __mpriv_u;
472 } pkt_mpriv __attribute__((aligned(4)));
0a7de745
A		 473#define pkt_mpriv_hash pkt_mpriv.__mpriv_u.__mpriv32[0].__mpriv32_u.__val32
474#define pkt_mpriv_flags pkt_mpriv.__mpriv_u.__mpriv32[1].__mpriv32_u.__val32
475#define pkt_mpriv_srcid pkt_mpriv.__mpriv_u.__mpriv32[2].__mpriv32_u.__val32
476#define pkt_mpriv_fidx pkt_mpriv.__mpriv_u.__mpriv32[3].__mpriv32_u.__val32
5ba3f43e 477
0a7de745
A		 478 u_int32_t redzone; /* red zone */
479 u_int32_t pkt_compl_callbacks; /* Packet completion callbacks */
1c79356b
A		 480};
481
39236c6e
A		 482/*
483 * Flow data source type. A data source module is responsible for generating
484 * a unique flow ID and associating it to each data flow as pkt_flowid.
485 * This is required for flow control/advisory, as it allows the output queue
486 * to identify the data source object and inform that it can resume its
487 * transmission (in the event it was flow controlled.)
488 */
0a7de745
A		 489#define FLOWSRC_INPCB 1 /* flow ID generated by INPCB */
490#define FLOWSRC_IFNET 2 /* flow ID generated by interface */
491#define FLOWSRC_PF 3 /* flow ID generated by PF */
492#define FLOWSRC_CHANNEL 4 /* flow ID generated by channel */
39236c6e 493
cb323159
A		 494/*
495 * FLOWSRC_MPKL_INPUT is not a true flow data source and is used for
496 * multi-layer packet logging. We're usurping the pkt_flowsrc field because
497 * the mbuf packet header ran out of space and pkt_flowsrc is normally
498 * used on output so we assume we can safely overwrite the normal semantic of
499 * the field.
500 * This value is meant to be used on incoming packet from a lower level protocol
501 * to pass information to some upper level protocol. When FLOWSRC_MPKL_INPUT
502 * is set, the following fields are used:
503 * - pkt_proto: the IP protocol ID of the lower level protocol
504 * - pkt_flowid: the identifier of the packet at the lower protocol.
505 * For example ESP would set pkt_proto to IPPROTO_ESP and pkt_flowid to the SPI.
506 */
507
39236c6e
A		 508/*
509 * Packet flags. Unlike m_flags, all packet flags are copied along when
510 * copying m_pkthdr, i.e. no equivalent of M_COPYFLAGS here. These flags
511 * (and other classifier info) will be cleared during DLIL input.
512 *
513 * Some notes about M_LOOP and PKTF_LOOP:
514 *
515 * - M_LOOP flag is overloaded, and its use is discouraged. Historically,
516 * that flag was used by the KAME implementation for allowing certain
517 * certain exceptions to be made in the IP6_EXTHDR_CHECK() logic; this
518 * was originally meant to be set as the packet is looped back to the
519 * system, and in some circumstances temporarily set in ip6_output().
520 * Over time, this flag was used by the pre-output routines to indicate
521 * to the DLIL frameout and output routines, that the packet may be
522 * looped back to the system under the right conditions. In addition,
523 * this is an mbuf flag rather than an mbuf packet header flag.
524 *
525 * - PKTF_LOOP is an mbuf packet header flag, which is set if and only
526 * if the packet was looped back to the system. This flag should be
527 * used instead for newer code.
528 */
0a7de745
A		 529#define PKTF_FLOW_ID 0x1 /* pkt has valid flowid value */
530#define PKTF_FLOW_ADV 0x2 /* pkt triggers local flow advisory */
531#define PKTF_FLOW_LOCALSRC 0x4 /* pkt is locally originated */
532#define PKTF_FLOW_RAWSOCK 0x8 /* pkt locally generated by raw sock */
533#define PKTF_PRIO_PRIVILEGED 0x10 /* packet priority is privileged */
534#define PKTF_PROXY_DST 0x20 /* processed but not locally destined */
535#define PKTF_INET_RESOLVE 0x40 /* IPv4 resolver packet */
536#define PKTF_INET6_RESOLVE 0x80 /* IPv6 resolver packet */
537#define PKTF_RESOLVE_RTR 0x100 /* pkt is for resolving router */
f427ee49 538#define PKTF_SKIP_PKTAP 0x200 /* pkt has already passed through pktap */
0a7de745
A		 539#define PKTF_MPTCP 0x800 /* TCP with MPTCP metadata */
540#define PKTF_MPSO 0x1000 /* MPTCP socket meta data */
541#define PKTF_LOOP 0x2000 /* loopbacked packet */
542#define PKTF_IFAINFO 0x4000 /* pkt has valid interface addr info */
543#define PKTF_SO_BACKGROUND 0x8000 /* data is from background source */
544#define PKTF_FORWARDED 0x10000 /* pkt was forwarded from another i/f */
545#define PKTF_PRIV_GUARDED 0x20000 /* pkt_mpriv area guard enabled */
546#define PKTF_KEEPALIVE 0x40000 /* pkt is kernel-generated keepalive */
547#define PKTF_SO_REALTIME 0x80000 /* data is realtime traffic */
548#define PKTF_VALID_UNSENT_DATA 0x100000 /* unsent data is valid */
549#define PKTF_TCP_REXMT 0x200000 /* packet is TCP retransmission */
550#define PKTF_REASSEMBLED 0x400000 /* Packet was reassembled */
551#define PKTF_TX_COMPL_TS_REQ 0x800000 /* tx completion timestamp requested */
552#define PKTF_TS_VALID 0x1000000 /* pkt timestamp is valid */
553#define PKTF_DRIVER_MTAG 0x2000000 /* driver mbuf tags fields inited */
554#define PKTF_NEW_FLOW 0x4000000 /* Data from a new flow */
555#define PKTF_START_SEQ 0x8000000 /* valid start sequence */
556#define PKTF_LAST_PKT 0x10000000 /* last packet in the flow */
557#define PKTF_MPTCP_REINJ 0x20000000 /* Packet has been reinjected for MPTCP */
558#define PKTF_MPTCP_DFIN 0x40000000 /* Packet is a data-fin */
559#define PKTF_HBH_CHKED 0x80000000 /* HBH option is checked */
3e170ce0 560
39236c6e 561/* flags related to flow control/advisory and identification */
0a7de745 562#define PKTF_FLOW_MASK \
39236c6e
A		 563 (PKTF_FLOW_ID | PKTF_FLOW_ADV | PKTF_FLOW_LOCALSRC | PKTF_FLOW_RAWSOCK)
564
565/*
566 * Description of external storage mapped into mbuf, valid only if M_EXT set.
567 */
813fb2f6 568typedef void (*m_ext_free_func_t)(caddr_t, u_int, caddr_t);
1c79356b 569struct m_ext {
0a7de745
A		 570 caddr_t ext_buf; /* start of buffer */
571 m_ext_free_func_t ext_free; /* free routine if not the usual */
572 u_int ext_size; /* size of buffer, for ext_free */
573 caddr_t ext_arg; /* additional ext_free argument */
2d21ac55 574 struct ext_ref {
39037602
A		 575 struct mbuf *paired;
576 u_int16_t minref;
577 u_int16_t refcnt;
578 u_int16_t prefcnt;
579 u_int16_t flags;
580 u_int32_t priv;
813fb2f6 581 uintptr_t ext_token;
2d21ac55 582 } *ext_refflags;
1c79356b
A		 583};
584
b0d623f7
A		 585/* define m_ext to a type since it gets redefined below */
586typedef struct m_ext _m_ext_t;
587
39236c6e
A		 588/*
589 * The mbuf object
590 */
1c79356b 591struct mbuf {
39037602 592 struct m_hdr m_hdr;
1c79356b
A		 593 union {
594 struct {
0a7de745 595 struct pkthdr MH_pkthdr; /* M_PKTHDR set */
1c79356b 596 union {
0a7de745
A		 597 struct m_ext MH_ext; /* M_EXT set */
598 char MH_databuf[_MHLEN];
1c79356b
A		 599 } MH_dat;
600 } MH;
0a7de745 601 char M_databuf[_MLEN]; /* !M_PKTHDR, !M_EXT */
1c79356b
A		 602 } M_dat;
603};
604
0a7de745
A		 605#define m_next m_hdr.mh_next
606#define m_len m_hdr.mh_len
607#define m_data m_hdr.mh_data
608#define m_type m_hdr.mh_type
609#define m_flags m_hdr.mh_flags
610#define m_nextpkt m_hdr.mh_nextpkt
611#define m_act m_nextpkt
612#define m_pkthdr M_dat.MH.MH_pkthdr
613#define m_ext M_dat.MH.MH_dat.MH_ext
614#define m_pktdat M_dat.MH.MH_dat.MH_databuf
615#define m_dat M_dat.M_databuf
616#define m_pktlen(_m) ((_m)->m_pkthdr.len)
617#define m_pftag(_m) (&(_m)->m_pkthdr.builtin_mtag._net_mtag._pf_mtag)
2a1bd2d3 618#define m_necptag(_m) (&(_m)->m_pkthdr.builtin_mtag._net_mtag._necp_mtag)
1c79356b 619
6d2010ae 620/* mbuf flags (private) */
0a7de745
A		 621#define M_EXT 0x0001 /* has associated external storage */
622#define M_PKTHDR 0x0002 /* start of record */
623#define M_EOR 0x0004 /* end of record */
624#define M_PROTO1 0x0008 /* protocol-specific */
625#define M_PROTO2 0x0010 /* protocol-specific */
626#define M_PROTO3 0x0020 /* protocol-specific */
627#define M_LOOP 0x0040 /* packet is looped back (also see PKTF_LOOP) */
628#define M_PROTO5 0x0080 /* protocol-specific */
1c79356b 629
6d2010ae 630/* mbuf pkthdr flags, also in m_flags (private) */
0a7de745
A		 631#define M_BCAST 0x0100 /* send/received as link-level broadcast */
632#define M_MCAST 0x0200 /* send/received as link-level multicast */
633#define M_FRAG 0x0400 /* packet is a fragment of a larger packet */
634#define M_FIRSTFRAG 0x0800 /* packet is first fragment */
635#define M_LASTFRAG 0x1000 /* packet is last fragment */
636#define M_PROMISC 0x2000 /* packet is promiscuous (shouldn't go to stack) */
637#define M_HASFCS 0x4000 /* packet has FCS */
638#define M_TAGHDR 0x8000 /* m_tag hdr structure at top of mbuf data */
6d2010ae
A		 639
640/*
641 * Flags to purge when crossing layers.
642 */
0a7de745 643#define M_PROTOFLAGS \
6d2010ae 644 (M_PROTO1|M_PROTO2|M_PROTO3|M_PROTO5)
1c79356b
A		 645
646/* flags copied when copying m_pkthdr */
0a7de745
A		 647#define M_COPYFLAGS \
648 (M_PKTHDR|M_EOR|M_PROTO1|M_PROTO2|M_PROTO3 | \
649 M_LOOP|M_PROTO5|M_BCAST|M_MCAST|M_FRAG | \
6d2010ae
A		 650 M_FIRSTFRAG|M_LASTFRAG|M_PROMISC|M_HASFCS)
651
316670eb 652/* flags indicating hw checksum support and sw checksum requirements */
0a7de745
A		 653#define CSUM_IP 0x0001 /* will csum IP */
654#define CSUM_TCP 0x0002 /* will csum TCP */
655#define CSUM_UDP 0x0004 /* will csum UDP */
656#define CSUM_IP_FRAGS 0x0008 /* will csum IP fragments */
657#define CSUM_FRAGMENT 0x0010 /* will do IP fragmentation */
658#define CSUM_TCPIPV6 0x0020 /* will csum TCP for IPv6 */
659#define CSUM_UDPIPV6 0x0040 /* will csum UDP for IPv6 */
660#define CSUM_FRAGMENT_IPV6 0x0080 /* will do IPv6 fragmentation */
661
662#define CSUM_IP_CHECKED 0x0100 /* did csum IP */
663#define CSUM_IP_VALID 0x0200 /* ... the csum is valid */
664#define CSUM_DATA_VALID 0x0400 /* csum_data field is valid */
665#define CSUM_PSEUDO_HDR 0x0800 /* csum_data has pseudo hdr */
666#define CSUM_PARTIAL 0x1000 /* simple Sum16 computation */
667#define CSUM_ZERO_INVERT 0x2000 /* invert 0 to -0 (0xffff) */
668
669#define CSUM_DELAY_DATA (CSUM_TCP | CSUM_UDP)
670#define CSUM_DELAY_IP (CSUM_IP) /* IPv4 only: no IPv6 IP cksum */
671#define CSUM_DELAY_IPV6_DATA (CSUM_TCPIPV6 | CSUM_UDPIPV6)
672#define CSUM_DATA_IPV6_VALID CSUM_DATA_VALID /* csum_data field is valid */
673
674#define CSUM_TX_FLAGS \
675 (CSUM_DELAY_IP | CSUM_DELAY_DATA | CSUM_DELAY_IPV6_DATA | \
5ba3f43e 676 CSUM_DATA_VALID | CSUM_PARTIAL | CSUM_ZERO_INVERT)
39236c6e 677
f427ee49 678#define CSUM_RX_FULL_FLAGS \
0a7de745 679 (CSUM_IP_CHECKED | CSUM_IP_VALID | CSUM_PSEUDO_HDR | \
f427ee49
A		 680 CSUM_DATA_VALID)
681
682#define CSUM_RX_FLAGS \
683 (CSUM_RX_FULL_FLAGS | CSUM_PARTIAL)
684
685
39236c6e 686
4a249263
A		 687/*
688 * Note: see also IF_HWASSIST_CSUM defined in <net/if_var.h>
689 */
4a249263
A		 690
691/* VLAN tag present */
cb323159
A		 692#define CSUM_VLAN_TAG_VALID 0x00010000 /* vlan_tag field is valid */
693
694/* checksum start adjustment has been done */
695#define CSUM_ADJUST_DONE 0x00020000
b0d623f7
A		 696
697/* TCP Segment Offloading requested on this mbuf */
cb323159
A		 698#define CSUM_TSO_IPV4 0x00100000 /* This mbuf needs to be segmented by the NIC */
699#define CSUM_TSO_IPV6 0x00200000 /* This mbuf needs to be segmented by the NIC */
316670eb 700
0a7de745
A		 701#define TSO_IPV4_OK(_ifp, _m) \
702 (((_ifp)->if_hwassist & IFNET_TSO_IPV4) && \
703 ((_m)->m_pkthdr.csum_flags & CSUM_TSO_IPV4)) \
39236c6e 704
0a7de745
A		 705#define TSO_IPV4_NOTOK(_ifp, _m) \
706 (!((_ifp)->if_hwassist & IFNET_TSO_IPV4) && \
707 ((_m)->m_pkthdr.csum_flags & CSUM_TSO_IPV4)) \
39236c6e 708
0a7de745
A		 709#define TSO_IPV6_OK(_ifp, _m) \
710 (((_ifp)->if_hwassist & IFNET_TSO_IPV6) && \
711 ((_m)->m_pkthdr.csum_flags & CSUM_TSO_IPV6)) \
39236c6e 712
0a7de745
A		 713#define TSO_IPV6_NOTOK(_ifp, _m) \
714 (!((_ifp)->if_hwassist & IFNET_TSO_IPV6) && \
715 ((_m)->m_pkthdr.csum_flags & CSUM_TSO_IPV6)) \
39236c6e 716
6d2010ae 717#endif /* XNU_KERNEL_PRIVATE */
1c79356b
A		 718
719/* mbuf types */
0a7de745
A		 720#define MT_FREE 0 /* should be on free list */
721#define MT_DATA 1 /* dynamic (data) allocation */
722#define MT_HEADER 2 /* packet header */
723#define MT_SOCKET 3 /* socket structure */
724#define MT_PCB 4 /* protocol control block */
725#define MT_RTABLE 5 /* routing tables */
726#define MT_HTABLE 6 /* IMP host tables */
727#define MT_ATABLE 7 /* address resolution tables */
728#define MT_SONAME 8 /* socket name */
729#define MT_SOOPTS 10 /* socket options */
730#define MT_FTABLE 11 /* fragment reassembly header */
731#define MT_RIGHTS 12 /* access rights */
732#define MT_IFADDR 13 /* interface address */
733#define MT_CONTROL 14 /* extra-data protocol message */
734#define MT_OOBDATA 15 /* expedited data */
735#define MT_TAG 16 /* volatile metadata associated to pkts */
736#define MT_MAX 32 /* enough? */
1c79356b 737
6d2010ae 738#ifdef XNU_KERNEL_PRIVATE
1c79356b
A		 739/*
740 * mbuf allocation/deallocation macros:
741 *
742 * MGET(struct mbuf *m, int how, int type)
743 * allocates an mbuf and initializes it to contain internal data.
744 *
745 * MGETHDR(struct mbuf *m, int how, int type)
746 * allocates an mbuf and initializes it to contain a packet header
747 * and internal data.
748 */
749
e3027f41 750#if 1
0a7de745 751#define MCHECK(m) m_mcheck(m)
1c79356b 752#else
0a7de745 753#define MCHECK(m)
1c79356b
A		 754#endif
755
0a7de745 756#define MGET(m, how, type) ((m) = m_get((how), (type)))
9bccf70c 757
0a7de745 758#define MGETHDR(m, how, type) ((m) = m_gethdr((how), (type)))
1c79356b
A		 759
760/*
761 * Mbuf cluster macros.
762 * MCLALLOC(caddr_t p, int how) allocates an mbuf cluster.
763 * MCLGET adds such clusters to a normal mbuf;
764 * the flag M_EXT is set upon success.
765 * MCLFREE releases a reference to a cluster allocated by MCLALLOC,
766 * freeing the cluster if the reference count has reached 0.
767 *
768 * Normal mbuf clusters are normally treated as character arrays
769 * after allocation, but use the first word of the buffer as a free list
770 * pointer while on the free list.
771 */
772union mcluster {
0a7de745
A		 773 union mcluster *mcl_next;
774 char mcl_buf[MCLBYTES];
1c79356b
A		 775};
776
0a7de745 777#define MCLALLOC(p, how) ((p) = m_mclalloc(how))
9bccf70c 778
0a7de745 779#define MCLFREE(p) m_mclfree(p)
9bccf70c 780
0a7de745 781#define MCLGET(m, how) ((m) = m_mclget(m, how))
9bccf70c 782
91447636
A		 783/*
784 * Mbuf big cluster
785 */
91447636 786union mbigcluster {
0a7de745
A		 787 union mbigcluster *mbc_next;
788 char mbc_buf[MBIGCLBYTES];
91447636
A		 789};
790
6d2010ae
A		 791/*
792 * Mbuf jumbo cluster
793 */
2d21ac55 794union m16kcluster {
0a7de745
A		 795 union m16kcluster *m16kcl_next;
796 char m16kcl_buf[M16KCLBYTES];
2d21ac55 797};
91447636 798
0a7de745 799#define MCLHASREFERENCE(m) m_mclhasreference(m)
1c79356b
A		 800
801/*
802 * MFREE(struct mbuf *m, struct mbuf *n)
803 * Free a single mbuf and associated external storage.
804 * Place the successor, if any, in n.
805 */
806
0a7de745 807#define MFREE(m, n) ((n) = m_free(m))
1c79356b
A		 808
809/*
810 * Copy mbuf pkthdr from from to to.
811 * from must have M_PKTHDR set, and to must be empty.
812 * aux pointer will be moved to `to'.
813 */
0a7de745 814#define M_COPY_PKTHDR(to, from) m_copy_pkthdr(to, from)
1c79356b 815
0a7de745 816#define M_COPY_PFTAG(to, from) m_copy_pftag(to, from)
316670eb 817
2a1bd2d3
A		 818#define M_COPY_NECPTAG(to, from) m_copy_necptag(to, from)
819
0a7de745 820#define M_COPY_CLASSIFIER(to, from) m_copy_classifier(to, from)
39236c6e 821
1c79356b 822/*
d9a64523
A		 823 * Evaluate TRUE if it's safe to write to the mbuf m's data region (this can
824 * be both the local data payload, or an external buffer area, depending on
825 * whether M_EXT is set).
1c79356b 826 */
0a7de745 827#define M_WRITABLE(m) (((m)->m_flags & M_EXT) == 0 || !MCLHASREFERENCE(m))
6d2010ae 828
1c79356b 829/*
d9a64523
A		 830 * These macros are mapped to the appropriate KPIs, so that private code
831 * can be simply recompiled in order to be forward-compatible with future
832 * changes toward the struture sizes.
833 */
834#define MLEN mbuf_get_mlen() /* normal mbuf data len */
835#define MHLEN mbuf_get_mhlen() /* data len in an mbuf w/pkthdr */
836#define MINCLSIZE mbuf_get_minclsize() /* cluster usage threshold */
837/*
838 * Return the address of the start of the buffer associated with an mbuf,
839 * handling external storage, packet-header mbufs, and regular data mbufs.
1c79356b 840 */
d9a64523 841#define M_START(m) \
0a7de745
A		 842 (((m)->m_flags & M_EXT) ? (m)->m_ext.ext_buf : \
843 ((m)->m_flags & M_PKTHDR) ? &(m)->m_pktdat[0] : \
844 &(m)->m_dat[0])
1c79356b
A		 845
846/*
d9a64523
A		 847 * Return the size of the buffer associated with an mbuf, handling external
848 * storage, packet-header mbufs, and regular data mbufs.
1c79356b 849 */
d9a64523 850#define M_SIZE(m) \
0a7de745
A		 851 (((m)->m_flags & M_EXT) ? (m)->m_ext.ext_size : \
852 ((m)->m_flags & M_PKTHDR) ? MHLEN : \
853 MLEN)
d9a64523 854
0a7de745
A		 855#define M_ALIGN(m, len) m_align(m, len)
856#define MH_ALIGN(m, len) m_align(m, len)
857#define MEXT_ALIGN(m, len) m_align(m, len)
d9a64523
A		 858
859/*
860 * Compute the amount of space available before the current start of data in
861 * an mbuf.
862 *
863 * The M_WRITABLE() is a temporary, conservative safety measure: the burden
864 * of checking writability of the mbuf data area rests solely with the caller.
865 */
0a7de745 866#define M_LEADINGSPACE(m) \
d9a64523 867 (M_WRITABLE(m) ? ((m)->m_data - M_START(m)) : 0)
1c79356b
A		 868
869/*
d9a64523
A		 870 * Compute the amount of space available after the end of data in an mbuf.
871 *
872 * The M_WRITABLE() is a temporary, conservative safety measure: the burden
873 * of checking writability of the mbuf data area rests solely with the caller.
1c79356b 874 */
0a7de745
A		 875#define M_TRAILINGSPACE(m) \
876 (M_WRITABLE(m) ? \
d9a64523 877 ((M_START(m) + M_SIZE(m)) - ((m)->m_data + (m)->m_len)) : 0)
1c79356b
A		 878
879/*
880 * Arrange to prepend space of size plen to mbuf m.
881 * If a new mbuf must be allocated, how specifies whether to wait.
882 * If how is M_DONTWAIT and allocation fails, the original mbuf chain
883 * is freed and m is set to NULL.
884 */
0a7de745 885#define M_PREPEND(m, plen, how, align) \
3e170ce0 886 ((m) = m_prepend_2((m), (plen), (how), (align)))
1c79356b
A		 887
888/* change mbuf to new type */
0a7de745 889#define MCHTYPE(m, t) m_mchtype(m, t)
1c79356b
A		 890
891/* compatiblity with 4.3 */
0a7de745 892#define m_copy(m, o, l) m_copym((m), (o), (l), M_DONTWAIT)
1c79356b 893
0a7de745
A		 894#define MBSHIFT 20 /* 1MB */
895#define MBSIZE (1 << MBSHIFT)
896#define GBSHIFT 30 /* 1GB */
897#define GBSIZE (1 << GBSHIFT)
c910b4d9 898
6d2010ae
A		 899/*
900 * M_STRUCT_GET ensures that intermediate protocol header (from "off" to
316670eb 901 * "off+len") is located in single mbuf, on contiguous memory region.
6d2010ae
A		 902 * The pointer to the region will be returned to pointer variable "val",
903 * with type "typ".
904 *
905 * M_STRUCT_GET0 does the same, except that it aligns the structure at
906 * very top of mbuf. GET0 is likely to make memory copy than GET.
907 */
0a7de745
A		 908#define M_STRUCT_GET(val, typ, m, off, len) \
909do { \
910 struct mbuf *t; \
911 int tmp; \
912 \
913 if ((m)->m_len >= (off) + (len)) { \
914 (val) = (typ)(mtod((m), caddr_t) + (off)); \
915 } else { \
916 t = m_pulldown((m), (off), (len), &tmp); \
917 if (t != NULL) { \
918 if (t->m_len < tmp + (len)) \
919 panic("m_pulldown malfunction"); \
920 (val) = (typ)(mtod(t, caddr_t) + tmp); \
921 } else { \
922 (val) = (typ)NULL; \
923 (m) = NULL; \
924 } \
925 } \
6d2010ae
A		 926} while (0)
927
0a7de745
A		 928#define M_STRUCT_GET0(val, typ, m, off, len) \
929do { \
930 struct mbuf *t; \
931 \
932 if ((off) == 0 && ((m)->m_len >= (len))) { \
933 (val) = (typ)(void *)mtod(m, caddr_t); \
934 } else { \
935 t = m_pulldown((m), (off), (len), NULL); \
936 if (t != NULL) { \
937 if (t->m_len < (len)) \
938 panic("m_pulldown malfunction"); \
939 (val) = (typ)(void *)mtod(t, caddr_t); \
940 } else { \
941 (val) = (typ)NULL; \
942 (m) = NULL; \
943 } \
944 } \
6d2010ae
A		 945} while (0)
946
0a7de745
A		 947#define MBUF_INPUT_CHECK(m, rcvif) \
948do { \
949 if (!(m->m_flags & MBUF_PKTHDR) || \
950 m->m_len < 0 || \
951 m->m_len > ((njcl > 0) ? njclbytes : MBIGCLBYTES) || \
952 m->m_type == MT_FREE || \
953 ((m->m_flags & M_EXT) != 0 && m->m_ext.ext_buf == NULL)) { \
954 panic_plain("Failed mbuf validity check: mbuf %p len %d " \
955 "type %d flags 0x%x data %p rcvif %s ifflags 0x%x", \
956 m, m->m_len, m->m_type, m->m_flags, \
957 ((m->m_flags & M_EXT) ? m->m_ext.ext_buf : m->m_data), \
958 if_name(rcvif), \
959 (rcvif->if_flags & 0xffff)); \
960 } \
6d2010ae
A		 961} while (0)
962
316670eb
A		 963/*
964 * Simple mbuf queueing system
965 *
966 * This is basically a SIMPLEQ adapted to mbuf use (i.e. using
967 * m_nextpkt instead of field.sqe_next).
968 *
969 * m_next is ignored, so queueing chains of mbufs is possible
970 */
0a7de745
A		 971#define MBUFQ_HEAD(name) \
972struct name { \
973 struct mbuf *mq_first; /* first packet */ \
974 struct mbuf **mq_last; /* addr of last next packet */ \
316670eb
A		 975}
976
0a7de745
A		 977#define MBUFQ_INIT(q) do { \
978 MBUFQ_FIRST(q) = NULL; \
979 (q)->mq_last = &MBUFQ_FIRST(q); \
316670eb
A		 980} while (0)
981
0a7de745
A		 982#define MBUFQ_PREPEND(q, m) do { \
983 if ((MBUFQ_NEXT(m) = MBUFQ_FIRST(q)) == NULL) \
984 (q)->mq_last = &MBUFQ_NEXT(m); \
985 MBUFQ_FIRST(q) = (m); \
316670eb
A		 986} while (0)
987
0a7de745
A		 988#define MBUFQ_ENQUEUE(q, m) do { \
989 MBUFQ_NEXT(m) = NULL; \
990 *(q)->mq_last = (m); \
991 (q)->mq_last = &MBUFQ_NEXT(m); \
316670eb
A		 992} while (0)
993
0a7de745
A		 994#define MBUFQ_ENQUEUE_MULTI(q, m, n) do { \
995 MBUFQ_NEXT(n) = NULL; \
996 *(q)->mq_last = (m); \
997 (q)->mq_last = &MBUFQ_NEXT(n); \
316670eb
A		 998} while (0)
999
0a7de745
A		 1000#define MBUFQ_DEQUEUE(q, m) do { \
1001 if (((m) = MBUFQ_FIRST(q)) != NULL) { \
1002 if ((MBUFQ_FIRST(q) = MBUFQ_NEXT(m)) == NULL) \
1003 (q)->mq_last = &MBUFQ_FIRST(q); \
1004 else \
1005 MBUFQ_NEXT(m) = NULL; \
1006 } \
316670eb
A		 1007} while (0)
1008
0a7de745
A		 1009#define MBUFQ_REMOVE(q, m) do { \
1010 if (MBUFQ_FIRST(q) == (m)) { \
1011 MBUFQ_DEQUEUE(q, m); \
1012 } else { \
1013 struct mbuf *_m = MBUFQ_FIRST(q); \
1014 while (MBUFQ_NEXT(_m) != (m)) \
1015 _m = MBUFQ_NEXT(_m); \
1016 if ((MBUFQ_NEXT(_m) = \
1017 MBUFQ_NEXT(MBUFQ_NEXT(_m))) == NULL) \
1018 (q)->mq_last = &MBUFQ_NEXT(_m); \
1019 } \
316670eb
A		 1020} while (0)
1021
0a7de745
A		 1022#define MBUFQ_DRAIN(q) do { \
1023 struct mbuf *__m0; \
1024 while ((__m0 = MBUFQ_FIRST(q)) != NULL) { \
1025 MBUFQ_FIRST(q) = MBUFQ_NEXT(__m0); \
1026 MBUFQ_NEXT(__m0) = NULL; \
1027 m_freem(__m0); \
1028 } \
1029 (q)->mq_last = &MBUFQ_FIRST(q); \
316670eb
A		 1030} while (0)
1031
0a7de745
A		 1032#define MBUFQ_FOREACH(m, q) \
1033 for ((m) = MBUFQ_FIRST(q); \
1034 (m); \
316670eb
A		 1035 (m) = MBUFQ_NEXT(m))
1036
0a7de745
A		 1037#define MBUFQ_FOREACH_SAFE(m, q, tvar) \
1038 for ((m) = MBUFQ_FIRST(q); \
1039 (m) && ((tvar) = MBUFQ_NEXT(m), 1); \
316670eb
A		 1040 (m) = (tvar))
1041
0a7de745
A		 1042#define MBUFQ_EMPTY(q) ((q)->mq_first == NULL)
1043#define MBUFQ_FIRST(q) ((q)->mq_first)
1044#define MBUFQ_NEXT(m) ((m)->m_nextpkt)
39037602
A		 1045/*
1046 * mq_last is initialized to point to mq_first, so check if they're
1047 * equal and return NULL when the list is empty. Otherwise, we need
1048 * to subtract the offset of MBUQ_NEXT (i.e. m_nextpkt field) to get
1049 * to the base mbuf address to return to caller.
1050 */
0a7de745
A		 1051#define MBUFQ_LAST(head) \
1052 (((head)->mq_last == &MBUFQ_FIRST(head)) ? NULL : \
1053 ((struct mbuf *)(void *)((char *)(head)->mq_last - \
cb323159 1054 __builtin_offsetof(struct mbuf, m_nextpkt))))
316670eb 1055
f427ee49
A		 1056#define max_linkhdr (int)P2ROUNDUP(_max_linkhdr, sizeof (uint32_t))
1057#define max_protohdr (int)P2ROUNDUP(_max_protohdr, sizeof (uint32_t))
6d2010ae 1058#endif /* XNU_KERNEL_PRIVATE */
91447636 1059
1c79356b 1060/*
2d21ac55 1061 * Mbuf statistics (legacy).
1c79356b
A		 1062 */
1063struct mbstat {
0a7de745
A		 1064 u_int32_t m_mbufs; /* mbufs obtained from page pool */
1065 u_int32_t m_clusters; /* clusters obtained from page pool */
1066 u_int32_t m_spare; /* spare field */
1067 u_int32_t m_clfree; /* free clusters */
1068 u_int32_t m_drops; /* times failed to find space */
1069 u_int32_t m_wait; /* times waited for space */
1070 u_int32_t m_drain; /* times drained protocols for space */
1071 u_short m_mtypes[256]; /* type specific mbuf allocations */
1072 u_int32_t m_mcfail; /* times m_copym failed */
1073 u_int32_t m_mpfail; /* times m_pullup failed */
1074 u_int32_t m_msize; /* length of an mbuf */
1075 u_int32_t m_mclbytes; /* length of an mbuf cluster */
1076 u_int32_t m_minclsize; /* min length of data to allocate a cluster */
1077 u_int32_t m_mlen; /* length of data in an mbuf */
1078 u_int32_t m_mhlen; /* length of data in a header mbuf */
1079 u_int32_t m_bigclusters; /* clusters obtained from page pool */
1080 u_int32_t m_bigclfree; /* free clusters */
1081 u_int32_t m_bigmclbytes; /* length of an mbuf cluster */
91447636
A		 1082};
1083
1084/* Compatibillity with 10.3 */
1085struct ombstat {
0a7de745
A		 1086 u_int32_t m_mbufs; /* mbufs obtained from page pool */
1087 u_int32_t m_clusters; /* clusters obtained from page pool */
1088 u_int32_t m_spare; /* spare field */
1089 u_int32_t m_clfree; /* free clusters */
1090 u_int32_t m_drops; /* times failed to find space */
1091 u_int32_t m_wait; /* times waited for space */
1092 u_int32_t m_drain; /* times drained protocols for space */
1093 u_short m_mtypes[256]; /* type specific mbuf allocations */
1094 u_int32_t m_mcfail; /* times m_copym failed */
1095 u_int32_t m_mpfail; /* times m_pullup failed */
1096 u_int32_t m_msize; /* length of an mbuf */
1097 u_int32_t m_mclbytes; /* length of an mbuf cluster */
1098 u_int32_t m_minclsize; /* min length of data to allocate a cluster */
1099 u_int32_t m_mlen; /* length of data in an mbuf */
1100 u_int32_t m_mhlen; /* length of data in a header mbuf */
1c79356b
A		 1101};
1102
1103/*
2d21ac55 1104 * mbuf class statistics.
1c79356b 1105 */
0a7de745 1106#define MAX_MBUF_CNAME 15
2d21ac55 1107
6d2010ae 1108#if defined(XNU_KERNEL_PRIVATE)
b0d623f7
A		 1109/* For backwards compatibility with 32-bit userland process */
1110struct omb_class_stat {
0a7de745
A		 1111 char mbcl_cname[MAX_MBUF_CNAME + 1]; /* class name */
1112 u_int32_t mbcl_size; /* buffer size */
1113 u_int32_t mbcl_total; /* # of buffers created */
1114 u_int32_t mbcl_active; /* # of active buffers */
1115 u_int32_t mbcl_infree; /* # of available buffers */
1116 u_int32_t mbcl_slab_cnt; /* # of available slabs */
1117 u_int64_t mbcl_alloc_cnt; /* # of times alloc is called */
1118 u_int64_t mbcl_free_cnt; /* # of times free is called */
1119 u_int64_t mbcl_notified; /* # of notified wakeups */
1120 u_int64_t mbcl_purge_cnt; /* # of purges so far */
1121 u_int64_t mbcl_fail_cnt; /* # of allocation failures */
1122 u_int32_t mbcl_ctotal; /* total only for this class */
1123 u_int32_t mbcl_release_cnt; /* amount of memory returned */
b0d623f7
A		 1124 /*
1125 * Cache layer statistics
1126 */
0a7de745
A		 1127 u_int32_t mbcl_mc_state; /* cache state (see below) */
1128 u_int32_t mbcl_mc_cached; /* # of cached buffers */
1129 u_int32_t mbcl_mc_waiter_cnt; /* # waiters on the cache */
1130 u_int32_t mbcl_mc_wretry_cnt; /* # of wait retries */
1131 u_int32_t mbcl_mc_nwretry_cnt; /* # of no-wait retry attempts */
1132 u_int64_t mbcl_reserved[4]; /* for future use */
b0d623f7 1133} __attribute__((__packed__));
6d2010ae 1134#endif /* XNU_KERNEL_PRIVATE */
b0d623f7 1135
2d21ac55 1136typedef struct mb_class_stat {
0a7de745
A		 1137 char mbcl_cname[MAX_MBUF_CNAME + 1]; /* class name */
1138 u_int32_t mbcl_size; /* buffer size */
1139 u_int32_t mbcl_total; /* # of buffers created */
1140 u_int32_t mbcl_active; /* # of active buffers */
1141 u_int32_t mbcl_infree; /* # of available buffers */
1142 u_int32_t mbcl_slab_cnt; /* # of available slabs */
b0d623f7 1143#if defined(KERNEL) || defined(__LP64__)
0a7de745 1144 u_int32_t mbcl_pad; /* padding */
b0d623f7 1145#endif /* KERNEL || __LP64__ */
0a7de745
A		 1146 u_int64_t mbcl_alloc_cnt; /* # of times alloc is called */
1147 u_int64_t mbcl_free_cnt; /* # of times free is called */
1148 u_int64_t mbcl_notified; /* # of notified wakeups */
1149 u_int64_t mbcl_purge_cnt; /* # of purges so far */
1150 u_int64_t mbcl_fail_cnt; /* # of allocation failures */
1151 u_int32_t mbcl_ctotal; /* total only for this class */
1152 u_int32_t mbcl_release_cnt; /* amount of memory returned */
2d21ac55
A		 1153 /*
1154 * Cache layer statistics
1155 */
0a7de745
A		 1156 u_int32_t mbcl_mc_state; /* cache state (see below) */
1157 u_int32_t mbcl_mc_cached; /* # of cached buffers */
1158 u_int32_t mbcl_mc_waiter_cnt; /* # waiters on the cache */
1159 u_int32_t mbcl_mc_wretry_cnt; /* # of wait retries */
1160 u_int32_t mbcl_mc_nwretry_cnt; /* # of no-wait retry attempts */
1161 u_int32_t mbcl_peak_reported; /* last usage peak reported */
1162 u_int32_t mbcl_reserved[7]; /* for future use */
2d21ac55
A		 1163} mb_class_stat_t;
1164
0a7de745
A		 1165#define MCS_DISABLED 0 /* cache is permanently disabled */
1166#define MCS_ONLINE 1 /* cache is online */
1167#define MCS_PURGING 2 /* cache is being purged */
1168#define MCS_OFFLINE 3 /* cache is offline (resizing) */
2d21ac55 1169
6d2010ae 1170#if defined(XNU_KERNEL_PRIVATE)
b0d623f7
A		 1171/* For backwards compatibility with 32-bit userland process */
1172struct omb_stat {
0a7de745
A		 1173 u_int32_t mbs_cnt; /* number of classes */
1174 struct omb_class_stat mbs_class[1]; /* class array */
b0d623f7 1175} __attribute__((__packed__));
6d2010ae 1176#endif /* XNU_KERNEL_PRIVATE */
b0d623f7 1177
2d21ac55 1178typedef struct mb_stat {
0a7de745 1179 u_int32_t mbs_cnt; /* number of classes */
b0d623f7 1180#if defined(KERNEL) || defined(__LP64__)
0a7de745 1181 u_int32_t mbs_pad; /* padding */
b0d623f7 1182#endif /* KERNEL || __LP64__ */
0a7de745 1183 mb_class_stat_t mbs_class[1]; /* class array */
2d21ac55
A		 1184} mb_stat_t;
1185
6d2010ae 1186#ifdef PRIVATE
0a7de745 1187#define MLEAK_STACK_DEPTH 16 /* Max PC stack depth */
6d2010ae
A		 1188
1189typedef struct mleak_trace_stat {
0a7de745
A		 1190 u_int64_t mltr_collisions;
1191 u_int64_t mltr_hitcount;
1192 u_int64_t mltr_allocs;
1193 u_int64_t mltr_depth;
1194 u_int64_t mltr_addr[MLEAK_STACK_DEPTH];
6d2010ae
A		 1195} mleak_trace_stat_t;
1196
1197typedef struct mleak_stat {
0a7de745
A		 1198 u_int32_t ml_isaddr64; /* 64-bit KVA? */
1199 u_int32_t ml_cnt; /* number of traces */
1200 mleak_trace_stat_t ml_trace[1]; /* trace array */
6d2010ae
A		 1201} mleak_stat_t;
1202
1203struct mleak_table {
0a7de745
A		 1204 u_int32_t mleak_capture; /* sampling capture counter */
1205 u_int32_t mleak_sample_factor; /* sample factor */
6d2010ae
A		 1206
1207 /* Times two active records want to occupy the same spot */
1208 u_int64_t alloc_collisions;
1209 u_int64_t trace_collisions;
1210
1211 /* Times new record lands on spot previously occupied by freed alloc */
1212 u_int64_t alloc_overwrites;
1213 u_int64_t trace_overwrites;
1214
1215 /* Times a new alloc or trace is put into the hash table */
1216 u_int64_t alloc_recorded;
1217 u_int64_t trace_recorded;
1218
1219 /* Total number of outstanding allocs */
1220 u_int64_t outstanding_allocs;
1221
1222 /* Times mleak_log returned false because couldn't acquire the lock */
1223 u_int64_t total_conflicts;
1224};
1225#endif /* PRIVATE */
1226
2d21ac55 1227#ifdef KERNEL_PRIVATE
6d2010ae 1228__BEGIN_DECLS
1c79356b 1229
6d2010ae
A		 1230/*
1231 * Exported (private)
1232 */
1233
0a7de745 1234extern struct mbstat mbstat; /* statistics */
6d2010ae
A		 1235
1236__END_DECLS
1237#endif /* KERNEL_PRIVATE */
1c79356b 1238
6d2010ae 1239#ifdef XNU_KERNEL_PRIVATE
91447636 1240__BEGIN_DECLS
6d2010ae
A		 1241
1242/*
1243 * Not exported (xnu private)
1244 */
1245
1246/* flags to m_get/MGET */
1247/* Need to include malloc.h to get right options for malloc */
0a7de745 1248#include <sys/malloc.h>
6d2010ae
A		 1249
1250struct mbuf;
1251
1252/* length to m_copy to copy all */
0a7de745 1253#define M_COPYALL 1000000000
6d2010ae 1254
0a7de745
A		 1255#define M_DONTWAIT M_NOWAIT
1256#define M_WAIT M_WAITOK
6d2010ae 1257
39236c6e 1258/* modes for m_copym and variants */
0a7de745
A		 1259#define M_COPYM_NOOP_HDR 0 /* don't copy/move pkthdr contents */
1260#define M_COPYM_COPY_HDR 1 /* copy pkthdr from old to new */
1261#define M_COPYM_MOVE_HDR 2 /* move pkthdr from old to new */
1262#define M_COPYM_MUST_COPY_HDR 3 /* MUST copy pkthdr from old to new */
1263#define M_COPYM_MUST_MOVE_HDR 4 /* MUST move pkthdr from old to new */
39236c6e 1264
cb323159 1265extern void m_freem(struct mbuf *) __XNU_INTERNAL(m_freem);
39236c6e 1266extern u_int64_t mcl_to_paddr(char *);
6d2010ae
A		 1267extern void m_adj(struct mbuf *, int);
1268extern void m_cat(struct mbuf *, struct mbuf *);
1269extern void m_copydata(struct mbuf *, int, int, void *);
1270extern struct mbuf *m_copym(struct mbuf *, int, int, int);
39236c6e 1271extern struct mbuf *m_copym_mode(struct mbuf *, int, int, int, uint32_t);
6d2010ae
A		 1272extern struct mbuf *m_get(int, int);
1273extern struct mbuf *m_gethdr(int, int);
1274extern struct mbuf *m_getpacket(void);
1275extern struct mbuf *m_getpackets(int, int, int);
1276extern struct mbuf *m_mclget(struct mbuf *, int);
1277extern void *m_mtod(struct mbuf *);
3e170ce0 1278extern struct mbuf *m_prepend_2(struct mbuf *, int, int, int);
6d2010ae
A		 1279extern struct mbuf *m_pullup(struct mbuf *, int);
1280extern struct mbuf *m_split(struct mbuf *, int, int);
1281extern void m_mclfree(caddr_t p);
2a1bd2d3
A		 1282extern int mbuf_get_class(struct mbuf *m);
1283extern bool mbuf_class_under_pressure(struct mbuf *m);
6d2010ae 1284
316670eb
A		 1285/*
1286 * On platforms which require strict alignment (currently for anything but
1287 * i386 or x86_64), this macro checks whether the data pointer of an mbuf
1288 * is 32-bit aligned (this is the expected minimum alignment for protocol
1289 * headers), and assert otherwise.
1290 */
1291#if defined(__i386__) || defined(__x86_64__)
0a7de745 1292#define MBUF_STRICT_DATA_ALIGNMENT_CHECK_32(_m)
316670eb 1293#else /* !__i386__ && !__x86_64__ */
0a7de745
A		 1294#define MBUF_STRICT_DATA_ALIGNMENT_CHECK_32(_m) do { \
1295 if (!IS_P2ALIGNED((_m)->m_data, sizeof (u_int32_t))) { \
1296 if (((_m)->m_flags & M_PKTHDR) && \
1297 (_m)->m_pkthdr.rcvif != NULL) { \
1298 panic_plain("\n%s: mbuf %p data ptr %p is not " \
1299 "32-bit aligned [%s: alignerrs=%lld]\n", \
1300 __func__, (_m), (_m)->m_data, \
1301 if_name((_m)->m_pkthdr.rcvif), \
1302 (_m)->m_pkthdr.rcvif->if_alignerrs); \
1303 } else { \
1304 panic_plain("\n%s: mbuf %p data ptr %p is not " \
1305 "32-bit aligned\n", \
1306 __func__, (_m), (_m)->m_data); \
1307 } \
1308 } \
316670eb
A		 1309} while (0)
1310#endif /* !__i386__ && !__x86_64__ */
1311
1312/* Maximum number of MBUF_SC values (excluding MBUF_SC_UNSPEC) */
0a7de745 1313#define MBUF_SC_MAX_CLASSES 10
316670eb
A		 1314
1315/*
1316 * These conversion macros rely on the corresponding MBUF_SC and
1317 * MBUF_TC values in order to establish the following mapping:
1318 *
1319 * MBUF_SC_BK_SYS ] ==> MBUF_TC_BK
1320 * MBUF_SC_BK ]
1321 *
1322 * MBUF_SC_BE ] ==> MBUF_TC_BE
1323 * MBUF_SC_RD ]
1324 * MBUF_SC_OAM ]
1325 *
1326 * MBUF_SC_AV ] ==> MBUF_TC_VI
1327 * MBUF_SC_RV ]
1328 * MBUF_SC_VI ]
d9a64523 1329 * MBUF_SC_SIG ]
316670eb
A		 1330 *
1331 * MBUF_SC_VO ] ==> MBUF_TC_VO
1332 * MBUF_SC_CTL ]
1333 *
1334 * The values assigned to each service class allows for a fast mapping to
1335 * the corresponding MBUF_TC traffic class values, as well as to retrieve the
1336 * assigned index; therefore care must be taken when comparing against these
1337 * values. Use the corresponding class and index macros to retrieve the
1338 * corresponding portion, and never assume that a higher class corresponds
1339 * to a higher index.
1340 */
0a7de745
A		 1341#define MBUF_SCVAL(x) ((x) & 0xffff)
1342#define MBUF_SCIDX(x) ((((x) >> 16) & 0xff) >> 3)
1343#define MBUF_SC2TC(_sc) (MBUF_SCVAL(_sc) >> 7)
1344#define MBUF_TC2SCVAL(_tc) ((_tc) << 7)
316670eb
A		 1345#define IS_MBUF_SC_BACKGROUND(_sc) (((_sc) == MBUF_SC_BK_SYS) || \
1346 ((_sc) == MBUF_SC_BK))
0a7de745
A		 1347#define IS_MBUF_SC_REALTIME(_sc) ((_sc) >= MBUF_SC_AV && (_sc) <= MBUF_SC_VO)
1348#define IS_MBUF_SC_BESTEFFORT(_sc) ((_sc) == MBUF_SC_BE || \
3e170ce0 1349 (_sc) == MBUF_SC_RD || (_sc) == MBUF_SC_OAM)
316670eb 1350
0a7de745
A		 1351#define SCIDX_BK_SYS MBUF_SCIDX(MBUF_SC_BK_SYS)
1352#define SCIDX_BK MBUF_SCIDX(MBUF_SC_BK)
1353#define SCIDX_BE MBUF_SCIDX(MBUF_SC_BE)
1354#define SCIDX_RD MBUF_SCIDX(MBUF_SC_RD)
1355#define SCIDX_OAM MBUF_SCIDX(MBUF_SC_OAM)
1356#define SCIDX_AV MBUF_SCIDX(MBUF_SC_AV)
1357#define SCIDX_RV MBUF_SCIDX(MBUF_SC_RV)
1358#define SCIDX_VI MBUF_SCIDX(MBUF_SC_VI)
1359#define SCIDX_SIG MBUF_SCIDX(MBUF_SC_SIG)
1360#define SCIDX_VO MBUF_SCIDX(MBUF_SC_VO)
1361#define SCIDX_CTL MBUF_SCIDX(MBUF_SC_CTL)
1362
1363#define SCVAL_BK_SYS MBUF_SCVAL(MBUF_SC_BK_SYS)
1364#define SCVAL_BK MBUF_SCVAL(MBUF_SC_BK)
1365#define SCVAL_BE MBUF_SCVAL(MBUF_SC_BE)
1366#define SCVAL_RD MBUF_SCVAL(MBUF_SC_RD)
1367#define SCVAL_OAM MBUF_SCVAL(MBUF_SC_OAM)
1368#define SCVAL_AV MBUF_SCVAL(MBUF_SC_AV)
1369#define SCVAL_RV MBUF_SCVAL(MBUF_SC_RV)
1370#define SCVAL_VI MBUF_SCVAL(MBUF_SC_VI)
1371#define SCVAL_SIG MBUF_SCVAL(MBUF_SC_SIG)
1372#define SCVAL_VO MBUF_SCVAL(MBUF_SC_VO)
1373#define SCVAL_CTL MBUF_SCVAL(MBUF_SC_CTL)
1374
1375#define MBUF_VALID_SC(c) \
1376 (c == MBUF_SC_BK_SYS || c == MBUF_SC_BK || c == MBUF_SC_BE || \
1377 c == MBUF_SC_RD || c == MBUF_SC_OAM || c == MBUF_SC_AV || \
1378 c == MBUF_SC_RV || c == MBUF_SC_VI || c == MBUF_SC_SIG || \
d9a64523 1379 c == MBUF_SC_VO || c == MBUF_SC_CTL)
316670eb 1380
0a7de745
A		 1381#define MBUF_VALID_SCIDX(c) \
1382 (c == SCIDX_BK_SYS || c == SCIDX_BK || c == SCIDX_BE || \
1383 c == SCIDX_RD || c == SCIDX_OAM || c == SCIDX_AV || \
1384 c == SCIDX_RV || c == SCIDX_VI || c == SCIDX_SIG || \
d9a64523 1385 c == SCIDX_VO || c == SCIDX_CTL)
316670eb 1386
0a7de745
A		 1387#define MBUF_VALID_SCVAL(c) \
1388 (c == SCVAL_BK_SYS || c == SCVAL_BK || c == SCVAL_BE || \
1389 c == SCVAL_RD || c == SCVAL_OAM || c == SCVAL_AV || \
1390 c == SCVAL_RV || c == SCVAL_VI || c == SCVAL_SIG || \
d9a64523 1391 c == SCVAL_VO || SCVAL_CTL)
316670eb 1392
0a7de745
A		 1393extern unsigned char *mbutl; /* start VA of mbuf pool */
1394extern unsigned char *embutl; /* end VA of mbuf pool */
1395extern unsigned int nmbclusters; /* number of mapped clusters */
1396extern int njcl; /* # of jumbo clusters */
1397extern int njclbytes; /* size of a jumbo cluster */
1398extern int max_hdr; /* largest link+protocol header */
1399extern int max_datalen; /* MHLEN - max_hdr */
6d2010ae 1400
316670eb 1401/* Use max_linkhdr instead of _max_linkhdr */
0a7de745 1402extern int _max_linkhdr; /* largest link-level header */
316670eb
A		 1403
1404/* Use max_protohdr instead of _max_protohdr */
0a7de745 1405extern int _max_protohdr; /* largest protocol header */
316670eb 1406
f427ee49 1407__private_extern__ unsigned int mbuf_default_ncl(uint64_t);
2d21ac55
A		 1408__private_extern__ void mbinit(void);
1409__private_extern__ struct mbuf *m_clattach(struct mbuf *, int, caddr_t,
39037602 1410 void (*)(caddr_t, u_int, caddr_t), u_int, caddr_t, int, int);
2d21ac55
A		 1411__private_extern__ caddr_t m_bigalloc(int);
1412__private_extern__ void m_bigfree(caddr_t, u_int, caddr_t);
1413__private_extern__ struct mbuf *m_mbigget(struct mbuf *, int);
1414__private_extern__ caddr_t m_16kalloc(int);
1415__private_extern__ void m_16kfree(caddr_t, u_int, caddr_t);
1416__private_extern__ struct mbuf *m_m16kget(struct mbuf *, int);
39236c6e 1417__private_extern__ int m_reinit(struct mbuf *, int);
cb323159 1418__private_extern__ struct mbuf *m_free(struct mbuf *) __XNU_INTERNAL(m_free);
6d2010ae
A		 1419__private_extern__ struct mbuf *m_getclr(int, int);
1420__private_extern__ struct mbuf *m_getptr(struct mbuf *, int, int *);
1421__private_extern__ unsigned int m_length(struct mbuf *);
316670eb
A		 1422__private_extern__ unsigned int m_length2(struct mbuf *, struct mbuf **);
1423__private_extern__ unsigned int m_fixhdr(struct mbuf *);
1424__private_extern__ struct mbuf *m_defrag(struct mbuf *, int);
1425__private_extern__ struct mbuf *m_defrag_offset(struct mbuf *, u_int32_t, int);
6d2010ae
A		 1426__private_extern__ struct mbuf *m_prepend(struct mbuf *, int, int);
1427__private_extern__ struct mbuf *m_copyup(struct mbuf *, int, int);
1428__private_extern__ struct mbuf *m_retry(int, int);
1429__private_extern__ struct mbuf *m_retryhdr(int, int);
1430__private_extern__ int m_freem_list(struct mbuf *);
1431__private_extern__ int m_append(struct mbuf *, int, caddr_t);
1432__private_extern__ struct mbuf *m_last(struct mbuf *);
1433__private_extern__ struct mbuf *m_devget(char *, int, int, struct ifnet *,
1434 void (*)(const void *, void *, size_t));
1435__private_extern__ struct mbuf *m_pulldown(struct mbuf *, int, int, int *);
1436
1437__private_extern__ struct mbuf *m_getcl(int, int, int);
1438__private_extern__ caddr_t m_mclalloc(int);
1439__private_extern__ int m_mclhasreference(struct mbuf *);
1440__private_extern__ void m_copy_pkthdr(struct mbuf *, struct mbuf *);
316670eb 1441__private_extern__ void m_copy_pftag(struct mbuf *, struct mbuf *);
2a1bd2d3 1442__private_extern__ void m_copy_necptag(struct mbuf *, struct mbuf *);
39236c6e 1443__private_extern__ void m_copy_classifier(struct mbuf *, struct mbuf *);
6d2010ae
A		 1444
1445__private_extern__ struct mbuf *m_dtom(void *);
1446__private_extern__ int m_mtocl(void *);
1447__private_extern__ union mcluster *m_cltom(int);
1448
d9a64523 1449__private_extern__ void m_align(struct mbuf *, int);
6d2010ae
A		 1450
1451__private_extern__ struct mbuf *m_normalize(struct mbuf *m);
1452__private_extern__ void m_mchtype(struct mbuf *m, int t);
1453__private_extern__ void m_mcheck(struct mbuf *);
1454
1455__private_extern__ void m_copyback(struct mbuf *, int, int, const void *);
1456__private_extern__ struct mbuf *m_copyback_cow(struct mbuf *, int, int,
1457 const void *, int);
1458__private_extern__ int m_makewritable(struct mbuf **, int, int, int);
1459__private_extern__ struct mbuf *m_dup(struct mbuf *m, int how);
1460__private_extern__ struct mbuf *m_copym_with_hdrs(struct mbuf *, int, int, int,
39236c6e 1461 struct mbuf **, int *, uint32_t);
6d2010ae
A		 1462__private_extern__ struct mbuf *m_getpackethdrs(int, int);
1463__private_extern__ struct mbuf *m_getpacket_how(int);
1464__private_extern__ struct mbuf *m_getpackets_internal(unsigned int *, int,
1465 int, int, size_t);
1466__private_extern__ struct mbuf *m_allocpacket_internal(unsigned int *, size_t,
1467 unsigned int *, int, int, size_t);
9bccf70c 1468
39037602
A		 1469__private_extern__ int m_ext_set_prop(struct mbuf *, uint32_t, uint32_t);
1470__private_extern__ uint32_t m_ext_get_prop(struct mbuf *);
1471__private_extern__ int m_ext_paired_is_active(struct mbuf *);
1472__private_extern__ void m_ext_paired_activate(struct mbuf *);
1473
d9a64523 1474__private_extern__ void mbuf_drain(boolean_t);
fe8ab488 1475
91447636 1476/*
6d2010ae
A		 1477 * Packets may have annotations attached by affixing a list of "packet
1478 * tags" to the pkthdr structure. Packet tags are dynamically allocated
1479 * semi-opaque data structures that have a fixed header (struct m_tag)
1480 * that specifies the size of the memory block and an <id,type> pair that
1481 * identifies it. The id identifies the module and the type identifies the
1482 * type of data for that module. The id of zero is reserved for the kernel.
1483 *
1484 * Note that the packet tag returned by m_tag_allocate has the default
1485 * memory alignment implemented by malloc. To reference private data one
1486 * can use a construct like:
1487 *
1488 * struct m_tag *mtag = m_tag_allocate(...);
1489 * struct foo *p = (struct foo *)(mtag+1);
1490 *
1491 * if the alignment of struct m_tag is sufficient for referencing members
1492 * of struct foo. Otherwise it is necessary to embed struct m_tag within
1493 * the private data structure to insure proper alignment; e.g.
1494 *
1495 * struct foo {
1496 * struct m_tag tag;
1497 * ...
1498 * };
1499 * struct foo *p = (struct foo *) m_tag_allocate(...);
1500 * struct m_tag *mtag = &p->tag;
91447636
A		 1501 */
1502
0a7de745 1503#define KERNEL_MODULE_TAG_ID 0
91447636
A		 1504
1505enum {
0a7de745
A		 1506 KERNEL_TAG_TYPE_NONE = 0,
1507 KERNEL_TAG_TYPE_DUMMYNET = 1,
1508 KERNEL_TAG_TYPE_DIVERT = 2,
1509 KERNEL_TAG_TYPE_IPFORWARD = 3,
1510 KERNEL_TAG_TYPE_IPFILT = 4,
1511 KERNEL_TAG_TYPE_MACLABEL = 5,
1512 KERNEL_TAG_TYPE_MAC_POLICY_LABEL = 6,
1513 KERNEL_TAG_TYPE_ENCAP = 8,
1514 KERNEL_TAG_TYPE_INET6 = 9,
1515 KERNEL_TAG_TYPE_IPSEC = 10,
1516 KERNEL_TAG_TYPE_DRVAUX = 11,
1517 KERNEL_TAG_TYPE_CFIL_UDP = 13,
cb323159 1518 KERNEL_TAG_TYPE_PF_REASS = 14,
91447636
A		 1519};
1520
91447636 1521/* Packet tag routines */
6d2010ae
A		 1522__private_extern__ struct m_tag *m_tag_alloc(u_int32_t, u_int16_t, int, int);
1523__private_extern__ struct m_tag *m_tag_create(u_int32_t, u_int16_t, int, int,
0a7de745 1524 struct mbuf *);
6d2010ae
A		 1525__private_extern__ void m_tag_free(struct m_tag *);
1526__private_extern__ void m_tag_prepend(struct mbuf *, struct m_tag *);
1527__private_extern__ void m_tag_unlink(struct mbuf *, struct m_tag *);
1528__private_extern__ void m_tag_delete(struct mbuf *, struct m_tag *);
1529__private_extern__ void m_tag_delete_chain(struct mbuf *, struct m_tag *);
1530__private_extern__ struct m_tag *m_tag_locate(struct mbuf *, u_int32_t,
1531 u_int16_t, struct m_tag *);
1532__private_extern__ struct m_tag *m_tag_copy(struct m_tag *, int);
1533__private_extern__ int m_tag_copy_chain(struct mbuf *, struct mbuf *, int);
39236c6e 1534__private_extern__ void m_tag_init(struct mbuf *, int);
6d2010ae
A		 1535__private_extern__ struct m_tag *m_tag_first(struct mbuf *);
1536__private_extern__ struct m_tag *m_tag_next(struct mbuf *, struct m_tag *);
1537
39236c6e
A		 1538__private_extern__ void m_scratch_init(struct mbuf *);
1539__private_extern__ u_int32_t m_scratch_get(struct mbuf *, u_int8_t **);
1540
1541__private_extern__ void m_classifier_init(struct mbuf *, uint32_t);
1542
316670eb
A		 1543__private_extern__ int m_set_service_class(struct mbuf *, mbuf_svc_class_t);
1544__private_extern__ mbuf_svc_class_t m_get_service_class(struct mbuf *);
1545__private_extern__ mbuf_svc_class_t m_service_class_from_idx(u_int32_t);
1546__private_extern__ mbuf_svc_class_t m_service_class_from_val(u_int32_t);
1547__private_extern__ int m_set_traffic_class(struct mbuf *, mbuf_traffic_class_t);
1548__private_extern__ mbuf_traffic_class_t m_get_traffic_class(struct mbuf *);
1549
0a7de745
A		 1550#define ADDCARRY(_x) do { \
1551 while (((_x) >> 16) != 0) \
1552 (_x) = ((_x) >> 16) + ((_x) & 0xffff); \
39236c6e
A		 1553} while (0)
1554
1555__private_extern__ u_int16_t m_adj_sum16(struct mbuf *, u_int32_t,
5ba3f43e 1556 u_int32_t, u_int32_t, u_int32_t);
39236c6e
A		 1557__private_extern__ u_int16_t m_sum16(struct mbuf *, u_int32_t, u_int32_t);
1558
5ba3f43e
A		 1559__private_extern__ void m_set_ext(struct mbuf *, struct ext_ref *,
1560 m_ext_free_func_t, caddr_t);
813fb2f6
A		 1561__private_extern__ struct ext_ref *m_get_rfa(struct mbuf *);
1562__private_extern__ m_ext_free_func_t m_get_ext_free(struct mbuf *);
1563__private_extern__ caddr_t m_get_ext_arg(struct mbuf *);
1564
d9a64523
A		 1565__private_extern__ void m_do_tx_compl_callback(struct mbuf *, struct ifnet *);
1566__private_extern__ mbuf_tx_compl_func m_get_tx_compl_callback(u_int32_t);
39037602 1567
316670eb
A		 1568__END_DECLS
1569#endif /* XNU_KERNEL_PRIVATE */
0a7de745 1570#endif /* !_SYS_MBUF_H_ */
mirror of XNU