1 /*- 2 * SPDX-License-Identifier: BSD-3-Clause 3 * 4 * Copyright (c) 1982, 1986, 1988, 1993 5 * The Regents of the University of California. 6 * All rights reserved. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 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. 19 * 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 30 * SUCH DAMAGE. 31 * 32 * @(#)mbuf.h 8.5 (Berkeley) 2/19/95 33 * $FreeBSD$ 34 */ 35 36 #ifndef _SYS_MBUF_H_ 37 #define _SYS_MBUF_H_ 38 39 /* XXX: These includes suck. Sorry! */ 40 #include <sys/queue.h> 41 #ifdef _KERNEL 42 #include <sys/systm.h> 43 #include <sys/refcount.h> 44 #include <vm/uma.h> 45 #ifdef WITNESS 46 #include <sys/lock.h> 47 #endif 48 #endif 49 50 #ifdef _KERNEL 51 #include <sys/sdt.h> 52 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) 63 64 SDT_PROBE_DECLARE(sdt, , , m__init); 65 SDT_PROBE_DECLARE(sdt, , , m__gethdr_raw); 66 SDT_PROBE_DECLARE(sdt, , , m__gethdr); 67 SDT_PROBE_DECLARE(sdt, , , m__get_raw); 68 SDT_PROBE_DECLARE(sdt, , , m__get); 69 SDT_PROBE_DECLARE(sdt, , , m__getcl); 70 SDT_PROBE_DECLARE(sdt, , , m__getjcl); 71 SDT_PROBE_DECLARE(sdt, , , m__clget); 72 SDT_PROBE_DECLARE(sdt, , , m__cljget); 73 SDT_PROBE_DECLARE(sdt, , , m__cljset); 74 SDT_PROBE_DECLARE(sdt, , , m__free); 75 SDT_PROBE_DECLARE(sdt, , , m__freem); 76 77 #endif /* _KERNEL */ 78 79 /* 80 * Mbufs are of a single size, MSIZE (sys/param.h), which includes overhead. 81 * An mbuf may add a single "mbuf cluster" of size MCLBYTES (also in 82 * sys/param.h), which has no additional overhead and is used instead of the 83 * internal data area; this is done when at least MINCLSIZE of data must be 84 * stored. Additionally, it is possible to allocate a separate buffer 85 * externally and attach it to the mbuf in a way similar to that of mbuf 86 * clusters. 87 * 88 * NB: These calculation do not take actual compiler-induced alignment and 89 * padding inside the complete struct mbuf into account. Appropriate 90 * attention is required when changing members of struct mbuf. 91 * 92 * MLEN is data length in a normal mbuf. 93 * MHLEN is data length in an mbuf with pktheader. 94 * MINCLSIZE is a smallest amount of data that should be put into cluster. 95 * 96 * Compile-time assertions in uipc_mbuf.c test these values to ensure that 97 * they are sensible. 98 */ 99 struct mbuf; 100 #define MHSIZE offsetof(struct mbuf, m_dat) 101 #define MPKTHSIZE offsetof(struct mbuf, m_pktdat) 102 #define MLEN ((int)(MSIZE - MHSIZE)) 103 #define MHLEN ((int)(MSIZE - MPKTHSIZE)) 104 #define MINCLSIZE (MHLEN + 1) 105 #define M_NODOM 255 106 107 #ifdef _KERNEL 108 /*- 109 * Macro for type conversion: convert mbuf pointer to data pointer of correct 110 * type: 111 * 112 * mtod(m, t) -- Convert mbuf pointer to data pointer of correct type. 113 * mtodo(m, o) -- Same as above but with offset 'o' into data. 114 */ 115 #define mtod(m, t) ((t)((m)->m_data)) 116 #define mtodo(m, o) ((void *)(((m)->m_data) + (o))) 117 118 /* 119 * Argument structure passed to UMA routines during mbuf and packet 120 * allocations. 121 */ 122 struct mb_args { 123 int flags; /* Flags for mbuf being allocated */ 124 short type; /* Type of mbuf being allocated */ 125 }; 126 #endif /* _KERNEL */ 127 128 /* 129 * Packet tag structure (see below for details). 130 */ 131 struct m_tag { 132 SLIST_ENTRY(m_tag) m_tag_link; /* List of packet tags */ 133 u_int16_t m_tag_id; /* Tag ID */ 134 u_int16_t m_tag_len; /* Length of data */ 135 u_int32_t m_tag_cookie; /* ABI/Module ID */ 136 void (*m_tag_free)(struct m_tag *); 137 }; 138 139 /* 140 * Static network interface owned tag. 141 * Allocated through ifp->if_snd_tag_alloc(). 142 */ 143 struct if_snd_tag_sw; 144 145 struct m_snd_tag { 146 struct ifnet *ifp; /* network interface tag belongs to */ 147 const struct if_snd_tag_sw *sw; 148 volatile u_int refcount; 149 }; 150 151 /* 152 * Record/packet header in first mbuf of chain; valid only if M_PKTHDR is set. 153 * Size ILP32: 48 154 * LP64: 56 155 * Compile-time assertions in uipc_mbuf.c test these values to ensure that 156 * they are correct. 157 */ 158 struct pkthdr { 159 union { 160 struct m_snd_tag *snd_tag; /* send tag, if any */ 161 struct ifnet *rcvif; /* rcv interface */ 162 }; 163 SLIST_HEAD(packet_tags, m_tag) tags; /* list of packet tags */ 164 int32_t len; /* total packet length */ 165 166 /* Layer crossing persistent information. */ 167 uint32_t flowid; /* packet's 4-tuple system */ 168 uint32_t csum_flags; /* checksum and offload features */ 169 uint16_t fibnum; /* this packet should use this fib */ 170 uint8_t numa_domain; /* NUMA domain of recvd pkt */ 171 uint8_t rsstype; /* hash type */ 172 union { 173 uint64_t rcv_tstmp; /* timestamp in ns */ 174 struct { 175 uint8_t l2hlen; /* layer 2 hdr len */ 176 uint8_t l3hlen; /* layer 3 hdr len */ 177 uint8_t l4hlen; /* layer 4 hdr len */ 178 uint8_t l5hlen; /* layer 5 hdr len */ 179 uint8_t inner_l2hlen; 180 uint8_t inner_l3hlen; 181 uint8_t inner_l4hlen; 182 uint8_t inner_l5hlen; 183 }; 184 }; 185 union { 186 uint8_t eight[8]; 187 uint16_t sixteen[4]; 188 uint32_t thirtytwo[2]; 189 uint64_t sixtyfour[1]; 190 uintptr_t unintptr[1]; 191 void *ptr; 192 } PH_per; 193 194 /* Layer specific non-persistent local storage for reassembly, etc. */ 195 union { 196 uint8_t eight[8]; 197 uint16_t sixteen[4]; 198 uint32_t thirtytwo[2]; 199 uint64_t sixtyfour[1]; 200 uintptr_t unintptr[1]; 201 void *ptr; 202 } PH_loc; 203 }; 204 #define ether_vtag PH_per.sixteen[0] 205 #define tcp_tun_port PH_per.sixteen[0] /* outbound */ 206 #define PH_vt PH_per 207 #define vt_nrecs sixteen[0] /* mld and v6-ND */ 208 #define tso_segsz PH_per.sixteen[1] /* inbound after LRO */ 209 #define lro_nsegs tso_segsz /* inbound after LRO */ 210 #define csum_data PH_per.thirtytwo[1] /* inbound from hardware up */ 211 #define lro_tcp_d_len PH_loc.sixteen[0] /* inbound during LRO (no reassembly) */ 212 #define lro_tcp_d_csum PH_loc.sixteen[1] /* inbound during LRO (no reassembly) */ 213 #define lro_tcp_h_off PH_loc.sixteen[2] /* inbound during LRO (no reassembly) */ 214 #define lro_etype PH_loc.sixteen[3] /* inbound during LRO (no reassembly) */ 215 /* Note PH_loc is used during IP reassembly (all 8 bytes as a ptr) */ 216 217 /* 218 * TLS records for TLS 1.0-1.2 can have the following header lengths: 219 * - 5 (AES-CBC with implicit IV) 220 * - 21 (AES-CBC with explicit IV) 221 * - 13 (AES-GCM with 8 byte explicit IV) 222 */ 223 #define MBUF_PEXT_HDR_LEN 23 224 225 /* 226 * TLS records for TLS 1.0-1.2 can have the following maximum trailer 227 * lengths: 228 * - 16 (AES-GCM) 229 * - 36 (AES-CBC with SHA1 and up to 16 bytes of padding) 230 * - 48 (AES-CBC with SHA2-256 and up to 16 bytes of padding) 231 * - 64 (AES-CBC with SHA2-384 and up to 16 bytes of padding) 232 */ 233 #define MBUF_PEXT_TRAIL_LEN 64 234 235 #if defined(__LP64__) 236 #define MBUF_PEXT_MAX_PGS (40 / sizeof(vm_paddr_t)) 237 #else 238 #define MBUF_PEXT_MAX_PGS (72 / sizeof(vm_paddr_t)) 239 #endif 240 241 #define MBUF_PEXT_MAX_BYTES \ 242 (MBUF_PEXT_MAX_PGS * PAGE_SIZE + MBUF_PEXT_HDR_LEN + MBUF_PEXT_TRAIL_LEN) 243 244 struct ktls_session; 245 struct socket; 246 247 /* 248 * Description of external storage mapped into mbuf; valid only if M_EXT is 249 * set. 250 * Size ILP32: 28 251 * LP64: 48 252 * Compile-time assertions in uipc_mbuf.c test these values to ensure that 253 * they are correct. 254 */ 255 typedef void m_ext_free_t(struct mbuf *); 256 struct m_ext { 257 union { 258 /* 259 * If EXT_FLAG_EMBREF is set, then we use refcount in the 260 * mbuf, the 'ext_count' member. Otherwise, we have a 261 * shadow copy and we use pointer 'ext_cnt'. The original 262 * mbuf is responsible to carry the pointer to free routine 263 * and its arguments. They aren't copied into shadows in 264 * mb_dupcl() to avoid dereferencing next cachelines. 265 */ 266 volatile u_int ext_count; 267 volatile u_int *ext_cnt; 268 }; 269 uint32_t ext_size; /* size of buffer, for ext_free */ 270 uint32_t ext_type:8, /* type of external storage */ 271 ext_flags:24; /* external storage mbuf flags */ 272 union { 273 struct { 274 /* 275 * Regular M_EXT mbuf: 276 * o ext_buf always points to the external buffer. 277 * o ext_free (below) and two optional arguments 278 * ext_arg1 and ext_arg2 store the free context for 279 * the external storage. They are set only in the 280 * refcount carrying mbuf, the one with 281 * EXT_FLAG_EMBREF flag, with exclusion for 282 * EXT_EXTREF type, where the free context is copied 283 * into all mbufs that use same external storage. 284 */ 285 char *ext_buf; /* start of buffer */ 286 #define m_ext_copylen offsetof(struct m_ext, ext_arg2) 287 void *ext_arg2; 288 }; 289 struct { 290 /* 291 * Multi-page M_EXTPG mbuf: 292 * o extpg_pa - page vector. 293 * o extpg_trail and extpg_hdr - TLS trailer and 294 * header. 295 * Uses ext_free and may also use ext_arg1. 296 */ 297 vm_paddr_t extpg_pa[MBUF_PEXT_MAX_PGS]; 298 char extpg_trail[MBUF_PEXT_TRAIL_LEN]; 299 char extpg_hdr[MBUF_PEXT_HDR_LEN]; 300 /* Pretend these 3 fields are part of mbuf itself. */ 301 #define m_epg_pa m_ext.extpg_pa 302 #define m_epg_trail m_ext.extpg_trail 303 #define m_epg_hdr m_ext.extpg_hdr 304 #define m_epg_ext_copylen offsetof(struct m_ext, ext_free) 305 }; 306 }; 307 /* 308 * Free method and optional argument pointer, both 309 * used by M_EXT and M_EXTPG. 310 */ 311 m_ext_free_t *ext_free; 312 void *ext_arg1; 313 }; 314 315 /* 316 * The core of the mbuf object along with some shortcut defines for practical 317 * purposes. 318 */ 319 struct mbuf { 320 /* 321 * Header present at the beginning of every mbuf. 322 * Size ILP32: 24 323 * LP64: 32 324 * Compile-time assertions in uipc_mbuf.c test these values to ensure 325 * that they are correct. 326 */ 327 union { /* next buffer in chain */ 328 struct mbuf *m_next; 329 SLIST_ENTRY(mbuf) m_slist; 330 STAILQ_ENTRY(mbuf) m_stailq; 331 }; 332 union { /* next chain in queue/record */ 333 struct mbuf *m_nextpkt; 334 SLIST_ENTRY(mbuf) m_slistpkt; 335 STAILQ_ENTRY(mbuf) m_stailqpkt; 336 }; 337 caddr_t m_data; /* location of data */ 338 int32_t m_len; /* amount of data in this mbuf */ 339 uint32_t m_type:8, /* type of data in this mbuf */ 340 m_flags:24; /* flags; see below */ 341 #if !defined(__LP64__) 342 uint32_t m_pad; /* pad for 64bit alignment */ 343 #endif 344 345 /* 346 * A set of optional headers (packet header, external storage header) 347 * and internal data storage. Historically, these arrays were sized 348 * to MHLEN (space left after a packet header) and MLEN (space left 349 * after only a regular mbuf header); they are now variable size in 350 * order to support future work on variable-size mbufs. 351 */ 352 union { 353 struct { 354 union { 355 /* M_PKTHDR set. */ 356 struct pkthdr m_pkthdr; 357 358 /* M_EXTPG set. 359 * Multi-page M_EXTPG mbuf has its meta data 360 * split between the below anonymous structure 361 * and m_ext. It carries vector of pages, 362 * optional header and trailer char vectors 363 * and pointers to socket/TLS data. 364 */ 365 #define m_epg_startcopy m_epg_npgs 366 #define m_epg_endcopy m_epg_stailq 367 struct { 368 /* Overall count of pages and count of 369 * pages with I/O pending. */ 370 uint8_t m_epg_npgs; 371 uint8_t m_epg_nrdy; 372 /* TLS header and trailer lengths. 373 * The data itself resides in m_ext. */ 374 uint8_t m_epg_hdrlen; 375 uint8_t m_epg_trllen; 376 /* Offset into 1st page and length of 377 * data in the last page. */ 378 uint16_t m_epg_1st_off; 379 uint16_t m_epg_last_len; 380 uint8_t m_epg_flags; 381 #define EPG_FLAG_ANON 0x1 /* Data can be encrypted in place. */ 382 #define EPG_FLAG_2FREE 0x2 /* Scheduled for free. */ 383 uint8_t m_epg_record_type; 384 uint8_t __spare[2]; 385 int m_epg_enc_cnt; 386 struct ktls_session *m_epg_tls; 387 struct socket *m_epg_so; 388 uint64_t m_epg_seqno; 389 STAILQ_ENTRY(mbuf) m_epg_stailq; 390 }; 391 }; 392 union { 393 /* M_EXT or M_EXTPG set. */ 394 struct m_ext m_ext; 395 /* M_PKTHDR set, neither M_EXT nor M_EXTPG. */ 396 char m_pktdat[0]; 397 }; 398 }; 399 char m_dat[0]; /* !M_PKTHDR, !M_EXT */ 400 }; 401 }; 402 403 #ifdef _KERNEL 404 static inline int 405 m_epg_pagelen(const struct mbuf *m, int pidx, int pgoff) 406 { 407 408 KASSERT(pgoff == 0 || pidx == 0, 409 ("page %d with non-zero offset %d in %p", pidx, pgoff, m)); 410 411 if (pidx == m->m_epg_npgs - 1) { 412 return (m->m_epg_last_len); 413 } else { 414 return (PAGE_SIZE - pgoff); 415 } 416 } 417 418 #ifdef INVARIANTS 419 #define MCHECK(ex, msg) KASSERT((ex), \ 420 ("Multi page mbuf %p with " #msg " at %s:%d", \ 421 m, __FILE__, __LINE__)) 422 /* 423 * NB: This expects a non-empty buffer (npgs > 0 and 424 * last_pg_len > 0). 425 */ 426 #define MBUF_EXT_PGS_ASSERT_SANITY(m) do { \ 427 MCHECK(m->m_epg_npgs > 0, "no valid pages"); \ 428 MCHECK(m->m_epg_npgs <= nitems(m->m_epg_pa), \ 429 "too many pages"); \ 430 MCHECK(m->m_epg_nrdy <= m->m_epg_npgs, \ 431 "too many ready pages"); \ 432 MCHECK(m->m_epg_1st_off < PAGE_SIZE, \ 433 "too large page offset"); \ 434 MCHECK(m->m_epg_last_len > 0, "zero last page length"); \ 435 MCHECK(m->m_epg_last_len <= PAGE_SIZE, \ 436 "too large last page length"); \ 437 if (m->m_epg_npgs == 1) \ 438 MCHECK(m->m_epg_1st_off + \ 439 m->m_epg_last_len <= PAGE_SIZE, \ 440 "single page too large"); \ 441 MCHECK(m->m_epg_hdrlen <= sizeof(m->m_epg_hdr), \ 442 "too large header length"); \ 443 MCHECK(m->m_epg_trllen <= sizeof(m->m_epg_trail), \ 444 "too large header length"); \ 445 } while (0) 446 #else 447 #define MBUF_EXT_PGS_ASSERT_SANITY(m) do {} while (0); 448 #endif 449 #endif 450 451 /* 452 * mbuf flags of global significance and layer crossing. 453 * Those of only protocol/layer specific significance are to be mapped 454 * to M_PROTO[1-11] and cleared at layer handoff boundaries. 455 * NB: Limited to the lower 24 bits. 456 */ 457 #define M_EXT 0x00000001 /* has associated external storage */ 458 #define M_PKTHDR 0x00000002 /* start of record */ 459 #define M_EOR 0x00000004 /* end of record */ 460 #define M_RDONLY 0x00000008 /* associated data is marked read-only */ 461 #define M_BCAST 0x00000010 /* send/received as link-level broadcast */ 462 #define M_MCAST 0x00000020 /* send/received as link-level multicast */ 463 #define M_PROMISC 0x00000040 /* packet was not for us */ 464 #define M_VLANTAG 0x00000080 /* ether_vtag is valid */ 465 #define M_EXTPG 0x00000100 /* has array of unmapped pages and TLS */ 466 #define M_NOFREE 0x00000200 /* do not free mbuf, embedded in cluster */ 467 #define M_TSTMP 0x00000400 /* rcv_tstmp field is valid */ 468 #define M_TSTMP_HPREC 0x00000800 /* rcv_tstmp is high-prec, typically 469 hw-stamped on port (useful for IEEE 1588 470 and 802.1AS) */ 471 #define M_TSTMP_LRO 0x00001000 /* Time LRO pushed in pkt is valid in (PH_loc) */ 472 473 #define M_PROTO1 0x00002000 /* protocol-specific */ 474 #define M_PROTO2 0x00004000 /* protocol-specific */ 475 #define M_PROTO3 0x00008000 /* protocol-specific */ 476 #define M_PROTO4 0x00010000 /* protocol-specific */ 477 #define M_PROTO5 0x00020000 /* protocol-specific */ 478 #define M_PROTO6 0x00040000 /* protocol-specific */ 479 #define M_PROTO7 0x00080000 /* protocol-specific */ 480 #define M_PROTO8 0x00100000 /* protocol-specific */ 481 #define M_PROTO9 0x00200000 /* protocol-specific */ 482 #define M_PROTO10 0x00400000 /* protocol-specific */ 483 #define M_PROTO11 0x00800000 /* protocol-specific */ 484 485 /* 486 * Flags to purge when crossing layers. 487 */ 488 #define M_PROTOFLAGS \ 489 (M_PROTO1|M_PROTO2|M_PROTO3|M_PROTO4|M_PROTO5|M_PROTO6|M_PROTO7|M_PROTO8|\ 490 M_PROTO9|M_PROTO10|M_PROTO11) 491 492 /* 493 * Flags preserved when copying m_pkthdr. 494 */ 495 #define M_COPYFLAGS \ 496 (M_PKTHDR|M_EOR|M_RDONLY|M_BCAST|M_MCAST|M_PROMISC|M_VLANTAG|M_TSTMP| \ 497 M_TSTMP_HPREC|M_TSTMP_LRO|M_PROTOFLAGS) 498 499 /* 500 * Mbuf flag description for use with printf(9) %b identifier. 501 */ 502 #define M_FLAG_BITS \ 503 "\20\1M_EXT\2M_PKTHDR\3M_EOR\4M_RDONLY\5M_BCAST\6M_MCAST" \ 504 "\7M_PROMISC\10M_VLANTAG\11M_EXTPG\12M_NOFREE\13M_TSTMP\14M_TSTMP_HPREC\15M_TSTMP_LRO" 505 #define M_FLAG_PROTOBITS \ 506 "\16M_PROTO1\17M_PROTO2\20M_PROTO3\21M_PROTO4" \ 507 "\22M_PROTO5\23M_PROTO6\24M_PROTO7\25M_PROTO8\26M_PROTO9" \ 508 "\27M_PROTO10\28M_PROTO11" 509 #define M_FLAG_PRINTF (M_FLAG_BITS M_FLAG_PROTOBITS) 510 511 /* 512 * Network interface cards are able to hash protocol fields (such as IPv4 513 * addresses and TCP port numbers) classify packets into flows. These flows 514 * can then be used to maintain ordering while delivering packets to the OS 515 * via parallel input queues, as well as to provide a stateless affinity 516 * model. NIC drivers can pass up the hash via m->m_pkthdr.flowid, and set 517 * m_flag fields to indicate how the hash should be interpreted by the 518 * network stack. 519 * 520 * Most NICs support RSS, which provides ordering and explicit affinity, and 521 * use the hash m_flag bits to indicate what header fields were covered by 522 * the hash. M_HASHTYPE_OPAQUE and M_HASHTYPE_OPAQUE_HASH can be set by non- 523 * RSS cards or configurations that provide an opaque flow identifier, allowing 524 * for ordering and distribution without explicit affinity. Additionally, 525 * M_HASHTYPE_OPAQUE_HASH indicates that the flow identifier has hash 526 * properties. 527 * 528 * The meaning of the IPV6_EX suffix: 529 * "o Home address from the home address option in the IPv6 destination 530 * options header. If the extension header is not present, use the Source 531 * IPv6 Address. 532 * o IPv6 address that is contained in the Routing-Header-Type-2 from the 533 * associated extension header. If the extension header is not present, 534 * use the Destination IPv6 Address." 535 * Quoted from: 536 * https://docs.microsoft.com/en-us/windows-hardware/drivers/network/rss-hashing-types#ndishashipv6ex 537 */ 538 #define M_HASHTYPE_HASHPROP 0x80 /* has hash properties */ 539 #define M_HASHTYPE_INNER 0x40 /* calculated from inner headers */ 540 #define M_HASHTYPE_HASH(t) (M_HASHTYPE_HASHPROP | (t)) 541 /* Microsoft RSS standard hash types */ 542 #define M_HASHTYPE_NONE 0 543 #define M_HASHTYPE_RSS_IPV4 M_HASHTYPE_HASH(1) /* IPv4 2-tuple */ 544 #define M_HASHTYPE_RSS_TCP_IPV4 M_HASHTYPE_HASH(2) /* TCPv4 4-tuple */ 545 #define M_HASHTYPE_RSS_IPV6 M_HASHTYPE_HASH(3) /* IPv6 2-tuple */ 546 #define M_HASHTYPE_RSS_TCP_IPV6 M_HASHTYPE_HASH(4) /* TCPv6 4-tuple */ 547 #define M_HASHTYPE_RSS_IPV6_EX M_HASHTYPE_HASH(5) /* IPv6 2-tuple + 548 * ext hdrs */ 549 #define M_HASHTYPE_RSS_TCP_IPV6_EX M_HASHTYPE_HASH(6) /* TCPv6 4-tuple + 550 * ext hdrs */ 551 #define M_HASHTYPE_RSS_UDP_IPV4 M_HASHTYPE_HASH(7) /* IPv4 UDP 4-tuple*/ 552 #define M_HASHTYPE_RSS_UDP_IPV6 M_HASHTYPE_HASH(9) /* IPv6 UDP 4-tuple*/ 553 #define M_HASHTYPE_RSS_UDP_IPV6_EX M_HASHTYPE_HASH(10)/* IPv6 UDP 4-tuple + 554 * ext hdrs */ 555 556 #define M_HASHTYPE_OPAQUE 0x3f /* ordering, not affinity */ 557 #define M_HASHTYPE_OPAQUE_HASH M_HASHTYPE_HASH(M_HASHTYPE_OPAQUE) 558 /* ordering+hash, not affinity*/ 559 560 #define M_HASHTYPE_CLEAR(m) ((m)->m_pkthdr.rsstype = 0) 561 #define M_HASHTYPE_GET(m) ((m)->m_pkthdr.rsstype & ~M_HASHTYPE_INNER) 562 #define M_HASHTYPE_SET(m, v) ((m)->m_pkthdr.rsstype = (v)) 563 #define M_HASHTYPE_TEST(m, v) (M_HASHTYPE_GET(m) == (v)) 564 #define M_HASHTYPE_ISHASH(m) \ 565 (((m)->m_pkthdr.rsstype & M_HASHTYPE_HASHPROP) != 0) 566 #define M_HASHTYPE_SETINNER(m) do { \ 567 (m)->m_pkthdr.rsstype |= M_HASHTYPE_INNER; \ 568 } while (0) 569 570 /* 571 * External mbuf storage buffer types. 572 */ 573 #define EXT_CLUSTER 1 /* mbuf cluster */ 574 #define EXT_SFBUF 2 /* sendfile(2)'s sf_buf */ 575 #define EXT_JUMBOP 3 /* jumbo cluster page sized */ 576 #define EXT_JUMBO9 4 /* jumbo cluster 9216 bytes */ 577 #define EXT_JUMBO16 5 /* jumbo cluster 16184 bytes */ 578 #define EXT_PACKET 6 /* mbuf+cluster from packet zone */ 579 #define EXT_MBUF 7 /* external mbuf reference */ 580 #define EXT_RXRING 8 /* data in NIC receive ring */ 581 582 #define EXT_VENDOR1 224 /* for vendor-internal use */ 583 #define EXT_VENDOR2 225 /* for vendor-internal use */ 584 #define EXT_VENDOR3 226 /* for vendor-internal use */ 585 #define EXT_VENDOR4 227 /* for vendor-internal use */ 586 587 #define EXT_EXP1 244 /* for experimental use */ 588 #define EXT_EXP2 245 /* for experimental use */ 589 #define EXT_EXP3 246 /* for experimental use */ 590 #define EXT_EXP4 247 /* for experimental use */ 591 592 #define EXT_NET_DRV 252 /* custom ext_buf provided by net driver(s) */ 593 #define EXT_MOD_TYPE 253 /* custom module's ext_buf type */ 594 #define EXT_DISPOSABLE 254 /* can throw this buffer away w/page flipping */ 595 #define EXT_EXTREF 255 /* has externally maintained ext_cnt ptr */ 596 597 /* 598 * Flags for external mbuf buffer types. 599 * NB: limited to the lower 24 bits. 600 */ 601 #define EXT_FLAG_EMBREF 0x000001 /* embedded ext_count */ 602 #define EXT_FLAG_EXTREF 0x000002 /* external ext_cnt, notyet */ 603 604 #define EXT_FLAG_NOFREE 0x000010 /* don't free mbuf to pool, notyet */ 605 606 #define EXT_FLAG_VENDOR1 0x010000 /* These flags are vendor */ 607 #define EXT_FLAG_VENDOR2 0x020000 /* or submodule specific, */ 608 #define EXT_FLAG_VENDOR3 0x040000 /* not used by mbuf code. */ 609 #define EXT_FLAG_VENDOR4 0x080000 /* Set/read by submodule. */ 610 611 #define EXT_FLAG_EXP1 0x100000 /* for experimental use */ 612 #define EXT_FLAG_EXP2 0x200000 /* for experimental use */ 613 #define EXT_FLAG_EXP3 0x400000 /* for experimental use */ 614 #define EXT_FLAG_EXP4 0x800000 /* for experimental use */ 615 616 /* 617 * EXT flag description for use with printf(9) %b identifier. 618 */ 619 #define EXT_FLAG_BITS \ 620 "\20\1EXT_FLAG_EMBREF\2EXT_FLAG_EXTREF\5EXT_FLAG_NOFREE" \ 621 "\21EXT_FLAG_VENDOR1\22EXT_FLAG_VENDOR2\23EXT_FLAG_VENDOR3" \ 622 "\24EXT_FLAG_VENDOR4\25EXT_FLAG_EXP1\26EXT_FLAG_EXP2\27EXT_FLAG_EXP3" \ 623 "\30EXT_FLAG_EXP4" 624 625 /* 626 * Flags indicating checksum, segmentation and other offload work to be 627 * done, or already done, by hardware or lower layers. It is split into 628 * separate inbound and outbound flags. 629 * 630 * Outbound flags that are set by upper protocol layers requesting lower 631 * layers, or ideally the hardware, to perform these offloading tasks. 632 * For outbound packets this field and its flags can be directly tested 633 * against ifnet if_hwassist. Note that the outbound and the inbound flags do 634 * not collide right now but they could be allowed to (as long as the flags are 635 * scrubbed appropriately when the direction of an mbuf changes). CSUM_BITS 636 * would also have to split into CSUM_BITS_TX and CSUM_BITS_RX. 637 * 638 * CSUM_INNER_<x> is the same as CSUM_<x> but it applies to the inner frame. 639 * The CSUM_ENCAP_<x> bits identify the outer encapsulation. 640 */ 641 #define CSUM_IP 0x00000001 /* IP header checksum offload */ 642 #define CSUM_IP_UDP 0x00000002 /* UDP checksum offload */ 643 #define CSUM_IP_TCP 0x00000004 /* TCP checksum offload */ 644 #define CSUM_IP_SCTP 0x00000008 /* SCTP checksum offload */ 645 #define CSUM_IP_TSO 0x00000010 /* TCP segmentation offload */ 646 #define CSUM_IP_ISCSI 0x00000020 /* iSCSI checksum offload */ 647 648 #define CSUM_INNER_IP6_UDP 0x00000040 649 #define CSUM_INNER_IP6_TCP 0x00000080 650 #define CSUM_INNER_IP6_TSO 0x00000100 651 #define CSUM_IP6_UDP 0x00000200 /* UDP checksum offload */ 652 #define CSUM_IP6_TCP 0x00000400 /* TCP checksum offload */ 653 #define CSUM_IP6_SCTP 0x00000800 /* SCTP checksum offload */ 654 #define CSUM_IP6_TSO 0x00001000 /* TCP segmentation offload */ 655 #define CSUM_IP6_ISCSI 0x00002000 /* iSCSI checksum offload */ 656 657 #define CSUM_INNER_IP 0x00004000 658 #define CSUM_INNER_IP_UDP 0x00008000 659 #define CSUM_INNER_IP_TCP 0x00010000 660 #define CSUM_INNER_IP_TSO 0x00020000 661 662 #define CSUM_ENCAP_VXLAN 0x00040000 /* VXLAN outer encapsulation */ 663 #define CSUM_ENCAP_RSVD1 0x00080000 664 665 /* Inbound checksum support where the checksum was verified by hardware. */ 666 #define CSUM_INNER_L3_CALC 0x00100000 667 #define CSUM_INNER_L3_VALID 0x00200000 668 #define CSUM_INNER_L4_CALC 0x00400000 669 #define CSUM_INNER_L4_VALID 0x00800000 670 #define CSUM_L3_CALC 0x01000000 /* calculated layer 3 csum */ 671 #define CSUM_L3_VALID 0x02000000 /* checksum is correct */ 672 #define CSUM_L4_CALC 0x04000000 /* calculated layer 4 csum */ 673 #define CSUM_L4_VALID 0x08000000 /* checksum is correct */ 674 #define CSUM_L5_CALC 0x10000000 /* calculated layer 5 csum */ 675 #define CSUM_L5_VALID 0x20000000 /* checksum is correct */ 676 #define CSUM_COALESCED 0x40000000 /* contains merged segments */ 677 678 #define CSUM_SND_TAG 0x80000000 /* Packet header has send tag */ 679 680 #define CSUM_FLAGS_TX (CSUM_IP | CSUM_IP_UDP | CSUM_IP_TCP | CSUM_IP_SCTP | \ 681 CSUM_IP_TSO | CSUM_IP_ISCSI | CSUM_INNER_IP6_UDP | CSUM_INNER_IP6_TCP | \ 682 CSUM_INNER_IP6_TSO | CSUM_IP6_UDP | CSUM_IP6_TCP | CSUM_IP6_SCTP | \ 683 CSUM_IP6_TSO | CSUM_IP6_ISCSI | CSUM_INNER_IP | CSUM_INNER_IP_UDP | \ 684 CSUM_INNER_IP_TCP | CSUM_INNER_IP_TSO | CSUM_ENCAP_VXLAN | \ 685 CSUM_ENCAP_RSVD1 | CSUM_SND_TAG) 686 687 #define CSUM_FLAGS_RX (CSUM_INNER_L3_CALC | CSUM_INNER_L3_VALID | \ 688 CSUM_INNER_L4_CALC | CSUM_INNER_L4_VALID | CSUM_L3_CALC | CSUM_L3_VALID | \ 689 CSUM_L4_CALC | CSUM_L4_VALID | CSUM_L5_CALC | CSUM_L5_VALID | \ 690 CSUM_COALESCED) 691 692 /* 693 * CSUM flag description for use with printf(9) %b identifier. 694 */ 695 #define CSUM_BITS \ 696 "\20\1CSUM_IP\2CSUM_IP_UDP\3CSUM_IP_TCP\4CSUM_IP_SCTP\5CSUM_IP_TSO" \ 697 "\6CSUM_IP_ISCSI\7CSUM_INNER_IP6_UDP\10CSUM_INNER_IP6_TCP" \ 698 "\11CSUM_INNER_IP6_TSO\12CSUM_IP6_UDP\13CSUM_IP6_TCP\14CSUM_IP6_SCTP" \ 699 "\15CSUM_IP6_TSO\16CSUM_IP6_ISCSI\17CSUM_INNER_IP\20CSUM_INNER_IP_UDP" \ 700 "\21CSUM_INNER_IP_TCP\22CSUM_INNER_IP_TSO\23CSUM_ENCAP_VXLAN" \ 701 "\24CSUM_ENCAP_RSVD1\25CSUM_INNER_L3_CALC\26CSUM_INNER_L3_VALID" \ 702 "\27CSUM_INNER_L4_CALC\30CSUM_INNER_L4_VALID\31CSUM_L3_CALC" \ 703 "\32CSUM_L3_VALID\33CSUM_L4_CALC\34CSUM_L4_VALID\35CSUM_L5_CALC" \ 704 "\36CSUM_L5_VALID\37CSUM_COALESCED\40CSUM_SND_TAG" 705 706 /* CSUM flags compatibility mappings. */ 707 #define CSUM_IP_CHECKED CSUM_L3_CALC 708 #define CSUM_IP_VALID CSUM_L3_VALID 709 #define CSUM_DATA_VALID CSUM_L4_VALID 710 #define CSUM_PSEUDO_HDR CSUM_L4_CALC 711 #define CSUM_SCTP_VALID CSUM_L4_VALID 712 #define CSUM_DELAY_DATA (CSUM_TCP|CSUM_UDP) 713 #define CSUM_DELAY_IP CSUM_IP /* Only v4, no v6 IP hdr csum */ 714 #define CSUM_DELAY_DATA_IPV6 (CSUM_TCP_IPV6|CSUM_UDP_IPV6) 715 #define CSUM_DATA_VALID_IPV6 CSUM_DATA_VALID 716 #define CSUM_TCP CSUM_IP_TCP 717 #define CSUM_UDP CSUM_IP_UDP 718 #define CSUM_SCTP CSUM_IP_SCTP 719 #define CSUM_TSO (CSUM_IP_TSO|CSUM_IP6_TSO) 720 #define CSUM_INNER_TSO (CSUM_INNER_IP_TSO|CSUM_INNER_IP6_TSO) 721 #define CSUM_UDP_IPV6 CSUM_IP6_UDP 722 #define CSUM_TCP_IPV6 CSUM_IP6_TCP 723 #define CSUM_SCTP_IPV6 CSUM_IP6_SCTP 724 725 /* 726 * mbuf types describing the content of the mbuf (including external storage). 727 */ 728 #define MT_NOTMBUF 0 /* USED INTERNALLY ONLY! Object is not mbuf */ 729 #define MT_DATA 1 /* dynamic (data) allocation */ 730 #define MT_HEADER MT_DATA /* packet header, use M_PKTHDR instead */ 731 732 #define MT_VENDOR1 4 /* for vendor-internal use */ 733 #define MT_VENDOR2 5 /* for vendor-internal use */ 734 #define MT_VENDOR3 6 /* for vendor-internal use */ 735 #define MT_VENDOR4 7 /* for vendor-internal use */ 736 737 #define MT_SONAME 8 /* socket name */ 738 739 #define MT_EXP1 9 /* for experimental use */ 740 #define MT_EXP2 10 /* for experimental use */ 741 #define MT_EXP3 11 /* for experimental use */ 742 #define MT_EXP4 12 /* for experimental use */ 743 744 #define MT_CONTROL 14 /* extra-data protocol message */ 745 #define MT_EXTCONTROL 15 /* control message with externalized contents */ 746 #define MT_OOBDATA 16 /* expedited data */ 747 748 #define MT_NOINIT 255 /* Not a type but a flag to allocate 749 a non-initialized mbuf */ 750 751 /* 752 * String names of mbuf-related UMA(9) and malloc(9) types. Exposed to 753 * !_KERNEL so that monitoring tools can look up the zones with 754 * libmemstat(3). 755 */ 756 #define MBUF_MEM_NAME "mbuf" 757 #define MBUF_CLUSTER_MEM_NAME "mbuf_cluster" 758 #define MBUF_PACKET_MEM_NAME "mbuf_packet" 759 #define MBUF_JUMBOP_MEM_NAME "mbuf_jumbo_page" 760 #define MBUF_JUMBO9_MEM_NAME "mbuf_jumbo_9k" 761 #define MBUF_JUMBO16_MEM_NAME "mbuf_jumbo_16k" 762 #define MBUF_TAG_MEM_NAME "mbuf_tag" 763 #define MBUF_EXTREFCNT_MEM_NAME "mbuf_ext_refcnt" 764 #define MBUF_EXTPGS_MEM_NAME "mbuf_extpgs" 765 766 #ifdef _KERNEL 767 union if_snd_tag_alloc_params; 768 769 #ifdef WITNESS 770 #define MBUF_CHECKSLEEP(how) do { \ 771 if (how == M_WAITOK) \ 772 WITNESS_WARN(WARN_GIANTOK | WARN_SLEEPOK, NULL, \ 773 "Sleeping in \"%s\"", __func__); \ 774 } while (0) 775 #else 776 #define MBUF_CHECKSLEEP(how) 777 #endif 778 779 /* 780 * Network buffer allocation API 781 * 782 * The rest of it is defined in kern/kern_mbuf.c 783 */ 784 extern uma_zone_t zone_mbuf; 785 extern uma_zone_t zone_clust; 786 extern uma_zone_t zone_pack; 787 extern uma_zone_t zone_jumbop; 788 extern uma_zone_t zone_jumbo9; 789 extern uma_zone_t zone_jumbo16; 790 extern uma_zone_t zone_extpgs; 791 792 void mb_dupcl(struct mbuf *, struct mbuf *); 793 void mb_free_ext(struct mbuf *); 794 void mb_free_extpg(struct mbuf *); 795 void mb_free_mext_pgs(struct mbuf *); 796 struct mbuf *mb_alloc_ext_pgs(int, m_ext_free_t); 797 struct mbuf *mb_alloc_ext_plus_pages(int, int); 798 struct mbuf *mb_mapped_to_unmapped(struct mbuf *, int, int, int, 799 struct mbuf **); 800 int mb_unmapped_compress(struct mbuf *m); 801 struct mbuf *mb_unmapped_to_ext(struct mbuf *m); 802 void mb_free_notready(struct mbuf *m, int count); 803 void m_adj(struct mbuf *, int); 804 void m_adj_decap(struct mbuf *, int); 805 int m_apply(struct mbuf *, int, int, 806 int (*)(void *, void *, u_int), void *); 807 int m_append(struct mbuf *, int, c_caddr_t); 808 void m_cat(struct mbuf *, struct mbuf *); 809 void m_catpkt(struct mbuf *, struct mbuf *); 810 int m_clget(struct mbuf *m, int how); 811 void *m_cljget(struct mbuf *m, int how, int size); 812 struct mbuf *m_collapse(struct mbuf *, int, int); 813 void m_copyback(struct mbuf *, int, int, c_caddr_t); 814 void m_copydata(const struct mbuf *, int, int, caddr_t); 815 struct mbuf *m_copym(struct mbuf *, int, int, int); 816 struct mbuf *m_copypacket(struct mbuf *, int); 817 void m_copy_pkthdr(struct mbuf *, struct mbuf *); 818 struct mbuf *m_copyup(struct mbuf *, int, int); 819 struct mbuf *m_defrag(struct mbuf *, int); 820 void m_demote_pkthdr(struct mbuf *); 821 void m_demote(struct mbuf *, int, int); 822 struct mbuf *m_devget(char *, int, int, struct ifnet *, 823 void (*)(char *, caddr_t, u_int)); 824 void m_dispose_extcontrolm(struct mbuf *m); 825 struct mbuf *m_dup(const struct mbuf *, int); 826 int m_dup_pkthdr(struct mbuf *, const struct mbuf *, int); 827 void m_extadd(struct mbuf *, char *, u_int, m_ext_free_t, 828 void *, void *, int, int); 829 u_int m_fixhdr(struct mbuf *); 830 struct mbuf *m_fragment(struct mbuf *, int, int); 831 void m_freem(struct mbuf *); 832 void m_free_raw(struct mbuf *); 833 struct mbuf *m_get2(int, int, short, int); 834 struct mbuf *m_get3(int, int, short, int); 835 struct mbuf *m_getjcl(int, short, int, int); 836 struct mbuf *m_getm2(struct mbuf *, int, int, short, int); 837 struct mbuf *m_getptr(struct mbuf *, int, int *); 838 u_int m_length(struct mbuf *, struct mbuf **); 839 int m_mbuftouio(struct uio *, const struct mbuf *, int); 840 void m_move_pkthdr(struct mbuf *, struct mbuf *); 841 int m_pkthdr_init(struct mbuf *, int); 842 struct mbuf *m_prepend(struct mbuf *, int, int); 843 void m_print(const struct mbuf *, int); 844 struct mbuf *m_pulldown(struct mbuf *, int, int, int *); 845 struct mbuf *m_pullup(struct mbuf *, int); 846 int m_sanity(struct mbuf *, int); 847 struct mbuf *m_split(struct mbuf *, int, int); 848 struct mbuf *m_uiotombuf(struct uio *, int, int, int, int); 849 int m_unmapped_uiomove(const struct mbuf *, int, struct uio *, 850 int); 851 struct mbuf *m_unshare(struct mbuf *, int); 852 int m_snd_tag_alloc(struct ifnet *, 853 union if_snd_tag_alloc_params *, struct m_snd_tag **); 854 void m_snd_tag_init(struct m_snd_tag *, struct ifnet *, 855 const struct if_snd_tag_sw *); 856 void m_snd_tag_destroy(struct m_snd_tag *); 857 858 static __inline int 859 m_gettype(int size) 860 { 861 int type; 862 863 switch (size) { 864 case MSIZE: 865 type = EXT_MBUF; 866 break; 867 case MCLBYTES: 868 type = EXT_CLUSTER; 869 break; 870 #if MJUMPAGESIZE != MCLBYTES 871 case MJUMPAGESIZE: 872 type = EXT_JUMBOP; 873 break; 874 #endif 875 case MJUM9BYTES: 876 type = EXT_JUMBO9; 877 break; 878 case MJUM16BYTES: 879 type = EXT_JUMBO16; 880 break; 881 default: 882 panic("%s: invalid cluster size %d", __func__, size); 883 } 884 885 return (type); 886 } 887 888 /* 889 * Associated an external reference counted buffer with an mbuf. 890 */ 891 static __inline void 892 m_extaddref(struct mbuf *m, char *buf, u_int size, u_int *ref_cnt, 893 m_ext_free_t freef, void *arg1, void *arg2) 894 { 895 896 KASSERT(ref_cnt != NULL, ("%s: ref_cnt not provided", __func__)); 897 898 atomic_add_int(ref_cnt, 1); 899 m->m_flags |= M_EXT; 900 m->m_ext.ext_buf = buf; 901 m->m_ext.ext_cnt = ref_cnt; 902 m->m_data = m->m_ext.ext_buf; 903 m->m_ext.ext_size = size; 904 m->m_ext.ext_free = freef; 905 m->m_ext.ext_arg1 = arg1; 906 m->m_ext.ext_arg2 = arg2; 907 m->m_ext.ext_type = EXT_EXTREF; 908 m->m_ext.ext_flags = 0; 909 } 910 911 static __inline uma_zone_t 912 m_getzone(int size) 913 { 914 uma_zone_t zone; 915 916 switch (size) { 917 case MCLBYTES: 918 zone = zone_clust; 919 break; 920 #if MJUMPAGESIZE != MCLBYTES 921 case MJUMPAGESIZE: 922 zone = zone_jumbop; 923 break; 924 #endif 925 case MJUM9BYTES: 926 zone = zone_jumbo9; 927 break; 928 case MJUM16BYTES: 929 zone = zone_jumbo16; 930 break; 931 default: 932 panic("%s: invalid cluster size %d", __func__, size); 933 } 934 935 return (zone); 936 } 937 938 /* 939 * Initialize an mbuf with linear storage. 940 * 941 * Inline because the consumer text overhead will be roughly the same to 942 * initialize or call a function with this many parameters and M_PKTHDR 943 * should go away with constant propagation for !MGETHDR. 944 */ 945 static __inline int 946 m_init(struct mbuf *m, int how, short type, int flags) 947 { 948 int error; 949 950 m->m_next = NULL; 951 m->m_nextpkt = NULL; 952 m->m_data = m->m_dat; 953 m->m_len = 0; 954 m->m_flags = flags; 955 m->m_type = type; 956 if (flags & M_PKTHDR) 957 error = m_pkthdr_init(m, how); 958 else 959 error = 0; 960 961 MBUF_PROBE5(m__init, m, how, type, flags, error); 962 return (error); 963 } 964 965 static __inline struct mbuf * 966 m_get_raw(int how, short type) 967 { 968 struct mbuf *m; 969 struct mb_args args; 970 971 args.flags = 0; 972 args.type = type | MT_NOINIT; 973 m = uma_zalloc_arg(zone_mbuf, &args, how); 974 MBUF_PROBE3(m__get_raw, how, type, m); 975 return (m); 976 } 977 978 static __inline struct mbuf * 979 m_get(int how, short type) 980 { 981 struct mbuf *m; 982 struct mb_args args; 983 984 args.flags = 0; 985 args.type = type; 986 m = uma_zalloc_arg(zone_mbuf, &args, how); 987 MBUF_PROBE3(m__get, how, type, m); 988 return (m); 989 } 990 991 static __inline struct mbuf * 992 m_gethdr_raw(int how, short type) 993 { 994 struct mbuf *m; 995 struct mb_args args; 996 997 args.flags = M_PKTHDR; 998 args.type = type | MT_NOINIT; 999 m = uma_zalloc_arg(zone_mbuf, &args, how); 1000 MBUF_PROBE3(m__gethdr_raw, how, type, m); 1001 return (m); 1002 } 1003 1004 static __inline struct mbuf * 1005 m_gethdr(int how, short type) 1006 { 1007 struct mbuf *m; 1008 struct mb_args args; 1009 1010 args.flags = M_PKTHDR; 1011 args.type = type; 1012 m = uma_zalloc_arg(zone_mbuf, &args, how); 1013 MBUF_PROBE3(m__gethdr, how, type, m); 1014 return (m); 1015 } 1016 1017 static __inline struct mbuf * 1018 m_getcl(int how, short type, int flags) 1019 { 1020 struct mbuf *m; 1021 struct mb_args args; 1022 1023 args.flags = flags; 1024 args.type = type; 1025 m = uma_zalloc_arg(zone_pack, &args, how); 1026 MBUF_PROBE4(m__getcl, how, type, flags, m); 1027 return (m); 1028 } 1029 1030 /* 1031 * XXX: m_cljset() is a dangerous API. One must attach only a new, 1032 * unreferenced cluster to an mbuf(9). It is not possible to assert 1033 * that, so care can be taken only by users of the API. 1034 */ 1035 static __inline void 1036 m_cljset(struct mbuf *m, void *cl, int type) 1037 { 1038 int size; 1039 1040 switch (type) { 1041 case EXT_CLUSTER: 1042 size = MCLBYTES; 1043 break; 1044 #if MJUMPAGESIZE != MCLBYTES 1045 case EXT_JUMBOP: 1046 size = MJUMPAGESIZE; 1047 break; 1048 #endif 1049 case EXT_JUMBO9: 1050 size = MJUM9BYTES; 1051 break; 1052 case EXT_JUMBO16: 1053 size = MJUM16BYTES; 1054 break; 1055 default: 1056 panic("%s: unknown cluster type %d", __func__, type); 1057 break; 1058 } 1059 1060 m->m_data = m->m_ext.ext_buf = cl; 1061 m->m_ext.ext_free = m->m_ext.ext_arg1 = m->m_ext.ext_arg2 = NULL; 1062 m->m_ext.ext_size = size; 1063 m->m_ext.ext_type = type; 1064 m->m_ext.ext_flags = EXT_FLAG_EMBREF; 1065 m->m_ext.ext_count = 1; 1066 m->m_flags |= M_EXT; 1067 MBUF_PROBE3(m__cljset, m, cl, type); 1068 } 1069 1070 static __inline void 1071 m_chtype(struct mbuf *m, short new_type) 1072 { 1073 1074 m->m_type = new_type; 1075 } 1076 1077 static __inline void 1078 m_clrprotoflags(struct mbuf *m) 1079 { 1080 1081 while (m) { 1082 m->m_flags &= ~M_PROTOFLAGS; 1083 m = m->m_next; 1084 } 1085 } 1086 1087 static __inline struct mbuf * 1088 m_last(struct mbuf *m) 1089 { 1090 1091 while (m->m_next) 1092 m = m->m_next; 1093 return (m); 1094 } 1095 1096 static inline u_int 1097 m_extrefcnt(struct mbuf *m) 1098 { 1099 1100 KASSERT(m->m_flags & M_EXT, ("%s: M_EXT missing", __func__)); 1101 1102 return ((m->m_ext.ext_flags & EXT_FLAG_EMBREF) ? m->m_ext.ext_count : 1103 *m->m_ext.ext_cnt); 1104 } 1105 1106 /* 1107 * mbuf, cluster, and external object allocation macros (for compatibility 1108 * purposes). 1109 */ 1110 #define M_MOVE_PKTHDR(to, from) m_move_pkthdr((to), (from)) 1111 #define MGET(m, how, type) ((m) = m_get((how), (type))) 1112 #define MGETHDR(m, how, type) ((m) = m_gethdr((how), (type))) 1113 #define MCLGET(m, how) m_clget((m), (how)) 1114 #define MEXTADD(m, buf, size, free, arg1, arg2, flags, type) \ 1115 m_extadd((m), (char *)(buf), (size), (free), (arg1), (arg2), \ 1116 (flags), (type)) 1117 #define m_getm(m, len, how, type) \ 1118 m_getm2((m), (len), (how), (type), M_PKTHDR) 1119 1120 /* 1121 * Evaluate TRUE if it's safe to write to the mbuf m's data region (this can 1122 * be both the local data payload, or an external buffer area, depending on 1123 * whether M_EXT is set). 1124 */ 1125 #define M_WRITABLE(m) (((m)->m_flags & (M_RDONLY | M_EXTPG)) == 0 && \ 1126 (!(((m)->m_flags & M_EXT)) || \ 1127 (m_extrefcnt(m) == 1))) 1128 1129 /* Check if the supplied mbuf has a packet header, or else panic. */ 1130 #define M_ASSERTPKTHDR(m) \ 1131 KASSERT((m) != NULL && (m)->m_flags & M_PKTHDR, \ 1132 ("%s: no mbuf packet header!", __func__)) 1133 1134 /* Check if mbuf is multipage. */ 1135 #define M_ASSERTEXTPG(m) \ 1136 KASSERT(((m)->m_flags & (M_EXTPG|M_PKTHDR)) == M_EXTPG, \ 1137 ("%s: m %p is not multipage!", __func__, m)) 1138 1139 /* 1140 * Ensure that the supplied mbuf is a valid, non-free mbuf. 1141 * 1142 * XXX: Broken at the moment. Need some UMA magic to make it work again. 1143 */ 1144 #define M_ASSERTVALID(m) \ 1145 KASSERT((((struct mbuf *)m)->m_flags & 0) == 0, \ 1146 ("%s: attempted use of a free mbuf!", __func__)) 1147 1148 /* Check whether any mbuf in the chain is unmapped. */ 1149 #ifdef INVARIANTS 1150 #define M_ASSERTMAPPED(m) do { \ 1151 for (struct mbuf *__m = (m); __m != NULL; __m = __m->m_next) \ 1152 KASSERT((__m->m_flags & M_EXTPG) == 0, \ 1153 ("%s: chain %p contains an unmapped mbuf", __func__, (m)));\ 1154 } while (0) 1155 #else 1156 #define M_ASSERTMAPPED(m) 1157 #endif 1158 1159 /* 1160 * Return the address of the start of the buffer associated with an mbuf, 1161 * handling external storage, packet-header mbufs, and regular data mbufs. 1162 */ 1163 #define M_START(m) \ 1164 (((m)->m_flags & M_EXTPG) ? NULL : \ 1165 ((m)->m_flags & M_EXT) ? (m)->m_ext.ext_buf : \ 1166 ((m)->m_flags & M_PKTHDR) ? &(m)->m_pktdat[0] : \ 1167 &(m)->m_dat[0]) 1168 1169 /* 1170 * Return the size of the buffer associated with an mbuf, handling external 1171 * storage, packet-header mbufs, and regular data mbufs. 1172 */ 1173 #define M_SIZE(m) \ 1174 (((m)->m_flags & M_EXT) ? (m)->m_ext.ext_size : \ 1175 ((m)->m_flags & M_PKTHDR) ? MHLEN : \ 1176 MLEN) 1177 1178 /* 1179 * Set the m_data pointer of a newly allocated mbuf to place an object of the 1180 * specified size at the end of the mbuf, longword aligned. 1181 * 1182 * NB: Historically, we had M_ALIGN(), MH_ALIGN(), and MEXT_ALIGN() as 1183 * separate macros, each asserting that it was called at the proper moment. 1184 * This required callers to themselves test the storage type and call the 1185 * right one. Rather than require callers to be aware of those layout 1186 * decisions, we centralize here. 1187 */ 1188 static __inline void 1189 m_align(struct mbuf *m, int len) 1190 { 1191 #ifdef INVARIANTS 1192 const char *msg = "%s: not a virgin mbuf"; 1193 #endif 1194 int adjust; 1195 1196 KASSERT(m->m_data == M_START(m), (msg, __func__)); 1197 1198 adjust = M_SIZE(m) - len; 1199 m->m_data += adjust &~ (sizeof(long)-1); 1200 } 1201 1202 #define M_ALIGN(m, len) m_align(m, len) 1203 #define MH_ALIGN(m, len) m_align(m, len) 1204 #define MEXT_ALIGN(m, len) m_align(m, len) 1205 1206 /* 1207 * Compute the amount of space available before the current start of data in 1208 * an mbuf. 1209 * 1210 * The M_WRITABLE() is a temporary, conservative safety measure: the burden 1211 * of checking writability of the mbuf data area rests solely with the caller. 1212 * 1213 * NB: In previous versions, M_LEADINGSPACE() would only check M_WRITABLE() 1214 * for mbufs with external storage. We now allow mbuf-embedded data to be 1215 * read-only as well. 1216 */ 1217 #define M_LEADINGSPACE(m) \ 1218 (M_WRITABLE(m) ? ((m)->m_data - M_START(m)) : 0) 1219 1220 /* 1221 * Compute the amount of space available after the end of data in an mbuf. 1222 * 1223 * The M_WRITABLE() is a temporary, conservative safety measure: the burden 1224 * of checking writability of the mbuf data area rests solely with the caller. 1225 * 1226 * NB: In previous versions, M_TRAILINGSPACE() would only check M_WRITABLE() 1227 * for mbufs with external storage. We now allow mbuf-embedded data to be 1228 * read-only as well. 1229 */ 1230 #define M_TRAILINGSPACE(m) \ 1231 (M_WRITABLE(m) ? \ 1232 ((M_START(m) + M_SIZE(m)) - ((m)->m_data + (m)->m_len)) : 0) 1233 1234 /* 1235 * Arrange to prepend space of size plen to mbuf m. If a new mbuf must be 1236 * allocated, how specifies whether to wait. If the allocation fails, the 1237 * original mbuf chain is freed and m is set to NULL. 1238 */ 1239 #define M_PREPEND(m, plen, how) do { \ 1240 struct mbuf **_mmp = &(m); \ 1241 struct mbuf *_mm = *_mmp; \ 1242 int _mplen = (plen); \ 1243 int __mhow = (how); \ 1244 \ 1245 MBUF_CHECKSLEEP(how); \ 1246 if (M_LEADINGSPACE(_mm) >= _mplen) { \ 1247 _mm->m_data -= _mplen; \ 1248 _mm->m_len += _mplen; \ 1249 } else \ 1250 _mm = m_prepend(_mm, _mplen, __mhow); \ 1251 if (_mm != NULL && _mm->m_flags & M_PKTHDR) \ 1252 _mm->m_pkthdr.len += _mplen; \ 1253 *_mmp = _mm; \ 1254 } while (0) 1255 1256 /* 1257 * Change mbuf to new type. This is a relatively expensive operation and 1258 * should be avoided. 1259 */ 1260 #define MCHTYPE(m, t) m_chtype((m), (t)) 1261 1262 /* Return the rcvif of a packet header. */ 1263 static __inline struct ifnet * 1264 m_rcvif(struct mbuf *m) 1265 { 1266 1267 M_ASSERTPKTHDR(m); 1268 if (m->m_pkthdr.csum_flags & CSUM_SND_TAG) 1269 return (NULL); 1270 return (m->m_pkthdr.rcvif); 1271 } 1272 1273 /* Length to m_copy to copy all. */ 1274 #define M_COPYALL 1000000000 1275 1276 extern int max_datalen; /* MHLEN - max_hdr */ 1277 extern int max_hdr; /* Largest link + protocol header */ 1278 extern int max_linkhdr; /* Largest link-level header */ 1279 extern int max_protohdr; /* Largest protocol header */ 1280 extern int nmbclusters; /* Maximum number of clusters */ 1281 extern bool mb_use_ext_pgs; /* Use ext_pgs for sendfile */ 1282 1283 /*- 1284 * Network packets may have annotations attached by affixing a list of 1285 * "packet tags" to the pkthdr structure. Packet tags are dynamically 1286 * allocated semi-opaque data structures that have a fixed header 1287 * (struct m_tag) that specifies the size of the memory block and a 1288 * <cookie,type> pair that identifies it. The cookie is a 32-bit unique 1289 * unsigned value used to identify a module or ABI. By convention this value 1290 * is chosen as the date+time that the module is created, expressed as the 1291 * number of seconds since the epoch (e.g., using date -u +'%s'). The type 1292 * value is an ABI/module-specific value that identifies a particular 1293 * annotation and is private to the module. For compatibility with systems 1294 * like OpenBSD that define packet tags w/o an ABI/module cookie, the value 1295 * PACKET_ABI_COMPAT is used to implement m_tag_get and m_tag_find 1296 * compatibility shim functions and several tag types are defined below. 1297 * Users that do not require compatibility should use a private cookie value 1298 * so that packet tag-related definitions can be maintained privately. 1299 * 1300 * Note that the packet tag returned by m_tag_alloc has the default memory 1301 * alignment implemented by malloc. To reference private data one can use a 1302 * construct like: 1303 * 1304 * struct m_tag *mtag = m_tag_alloc(...); 1305 * struct foo *p = (struct foo *)(mtag+1); 1306 * 1307 * if the alignment of struct m_tag is sufficient for referencing members of 1308 * struct foo. Otherwise it is necessary to embed struct m_tag within the 1309 * private data structure to insure proper alignment; e.g., 1310 * 1311 * struct foo { 1312 * struct m_tag tag; 1313 * ... 1314 * }; 1315 * struct foo *p = (struct foo *) m_tag_alloc(...); 1316 * struct m_tag *mtag = &p->tag; 1317 */ 1318 1319 /* 1320 * Persistent tags stay with an mbuf until the mbuf is reclaimed. Otherwise 1321 * tags are expected to ``vanish'' when they pass through a network 1322 * interface. For most interfaces this happens normally as the tags are 1323 * reclaimed when the mbuf is free'd. However in some special cases 1324 * reclaiming must be done manually. An example is packets that pass through 1325 * the loopback interface. Also, one must be careful to do this when 1326 * ``turning around'' packets (e.g., icmp_reflect). 1327 * 1328 * To mark a tag persistent bit-or this flag in when defining the tag id. 1329 * The tag will then be treated as described above. 1330 */ 1331 #define MTAG_PERSISTENT 0x800 1332 1333 #define PACKET_TAG_NONE 0 /* Nadda */ 1334 1335 /* Packet tags for use with PACKET_ABI_COMPAT. */ 1336 #define PACKET_TAG_IPSEC_IN_DONE 1 /* IPsec applied, in */ 1337 #define PACKET_TAG_IPSEC_OUT_DONE 2 /* IPsec applied, out */ 1338 #define PACKET_TAG_IPSEC_IN_CRYPTO_DONE 3 /* NIC IPsec crypto done */ 1339 #define PACKET_TAG_IPSEC_OUT_CRYPTO_NEEDED 4 /* NIC IPsec crypto req'ed */ 1340 #define PACKET_TAG_IPSEC_IN_COULD_DO_CRYPTO 5 /* NIC notifies IPsec */ 1341 #define PACKET_TAG_IPSEC_PENDING_TDB 6 /* Reminder to do IPsec */ 1342 #define PACKET_TAG_BRIDGE 7 /* Bridge processing done */ 1343 #define PACKET_TAG_GIF 8 /* GIF processing done */ 1344 #define PACKET_TAG_GRE 9 /* GRE processing done */ 1345 #define PACKET_TAG_IN_PACKET_CHECKSUM 10 /* NIC checksumming done */ 1346 #define PACKET_TAG_ENCAP 11 /* Encap. processing */ 1347 #define PACKET_TAG_IPSEC_SOCKET 12 /* IPSEC socket ref */ 1348 #define PACKET_TAG_IPSEC_HISTORY 13 /* IPSEC history */ 1349 #define PACKET_TAG_IPV6_INPUT 14 /* IPV6 input processing */ 1350 #define PACKET_TAG_DUMMYNET 15 /* dummynet info */ 1351 #define PACKET_TAG_DIVERT 17 /* divert info */ 1352 #define PACKET_TAG_IPFORWARD 18 /* ipforward info */ 1353 #define PACKET_TAG_MACLABEL (19 | MTAG_PERSISTENT) /* MAC label */ 1354 #define PACKET_TAG_PF (21 | MTAG_PERSISTENT) /* PF/ALTQ information */ 1355 #define PACKET_TAG_RTSOCKFAM 25 /* rtsock sa family */ 1356 #define PACKET_TAG_IPOPTIONS 27 /* Saved IP options */ 1357 #define PACKET_TAG_CARP 28 /* CARP info */ 1358 #define PACKET_TAG_IPSEC_NAT_T_PORTS 29 /* two uint16_t */ 1359 #define PACKET_TAG_ND_OUTGOING 30 /* ND outgoing */ 1360 1361 /* Specific cookies and tags. */ 1362 1363 /* Packet tag routines. */ 1364 struct m_tag *m_tag_alloc(u_int32_t, int, int, int); 1365 void m_tag_delete(struct mbuf *, struct m_tag *); 1366 void m_tag_delete_chain(struct mbuf *, struct m_tag *); 1367 void m_tag_free_default(struct m_tag *); 1368 struct m_tag *m_tag_locate(struct mbuf *, u_int32_t, int, struct m_tag *); 1369 struct m_tag *m_tag_copy(struct m_tag *, int); 1370 int m_tag_copy_chain(struct mbuf *, const struct mbuf *, int); 1371 void m_tag_delete_nonpersistent(struct mbuf *); 1372 1373 /* 1374 * Initialize the list of tags associated with an mbuf. 1375 */ 1376 static __inline void 1377 m_tag_init(struct mbuf *m) 1378 { 1379 1380 SLIST_INIT(&m->m_pkthdr.tags); 1381 } 1382 1383 /* 1384 * Set up the contents of a tag. Note that this does not fill in the free 1385 * method; the caller is expected to do that. 1386 * 1387 * XXX probably should be called m_tag_init, but that was already taken. 1388 */ 1389 static __inline void 1390 m_tag_setup(struct m_tag *t, u_int32_t cookie, int type, int len) 1391 { 1392 1393 t->m_tag_id = type; 1394 t->m_tag_len = len; 1395 t->m_tag_cookie = cookie; 1396 } 1397 1398 /* 1399 * Reclaim resources associated with a tag. 1400 */ 1401 static __inline void 1402 m_tag_free(struct m_tag *t) 1403 { 1404 1405 (*t->m_tag_free)(t); 1406 } 1407 1408 /* 1409 * Return the first tag associated with an mbuf. 1410 */ 1411 static __inline struct m_tag * 1412 m_tag_first(struct mbuf *m) 1413 { 1414 1415 return (SLIST_FIRST(&m->m_pkthdr.tags)); 1416 } 1417 1418 /* 1419 * Return the next tag in the list of tags associated with an mbuf. 1420 */ 1421 static __inline struct m_tag * 1422 m_tag_next(struct mbuf *m __unused, struct m_tag *t) 1423 { 1424 1425 return (SLIST_NEXT(t, m_tag_link)); 1426 } 1427 1428 /* 1429 * Prepend a tag to the list of tags associated with an mbuf. 1430 */ 1431 static __inline void 1432 m_tag_prepend(struct mbuf *m, struct m_tag *t) 1433 { 1434 1435 SLIST_INSERT_HEAD(&m->m_pkthdr.tags, t, m_tag_link); 1436 } 1437 1438 /* 1439 * Unlink a tag from the list of tags associated with an mbuf. 1440 */ 1441 static __inline void 1442 m_tag_unlink(struct mbuf *m, struct m_tag *t) 1443 { 1444 1445 SLIST_REMOVE(&m->m_pkthdr.tags, t, m_tag, m_tag_link); 1446 } 1447 1448 /* These are for OpenBSD compatibility. */ 1449 #define MTAG_ABI_COMPAT 0 /* compatibility ABI */ 1450 1451 static __inline struct m_tag * 1452 m_tag_get(int type, int length, int wait) 1453 { 1454 return (m_tag_alloc(MTAG_ABI_COMPAT, type, length, wait)); 1455 } 1456 1457 static __inline struct m_tag * 1458 m_tag_find(struct mbuf *m, int type, struct m_tag *start) 1459 { 1460 return (SLIST_EMPTY(&m->m_pkthdr.tags) ? (struct m_tag *)NULL : 1461 m_tag_locate(m, MTAG_ABI_COMPAT, type, start)); 1462 } 1463 1464 static inline struct m_snd_tag * 1465 m_snd_tag_ref(struct m_snd_tag *mst) 1466 { 1467 1468 refcount_acquire(&mst->refcount); 1469 return (mst); 1470 } 1471 1472 static inline void 1473 m_snd_tag_rele(struct m_snd_tag *mst) 1474 { 1475 1476 if (refcount_release(&mst->refcount)) 1477 m_snd_tag_destroy(mst); 1478 } 1479 1480 static __inline struct mbuf * 1481 m_free(struct mbuf *m) 1482 { 1483 struct mbuf *n = m->m_next; 1484 1485 MBUF_PROBE1(m__free, m); 1486 if ((m->m_flags & (M_PKTHDR|M_NOFREE)) == (M_PKTHDR|M_NOFREE)) 1487 m_tag_delete_chain(m, NULL); 1488 if (m->m_flags & M_PKTHDR && m->m_pkthdr.csum_flags & CSUM_SND_TAG) 1489 m_snd_tag_rele(m->m_pkthdr.snd_tag); 1490 if (m->m_flags & M_EXTPG) 1491 mb_free_extpg(m); 1492 else if (m->m_flags & M_EXT) 1493 mb_free_ext(m); 1494 else if ((m->m_flags & M_NOFREE) == 0) 1495 uma_zfree(zone_mbuf, m); 1496 return (n); 1497 } 1498 1499 static __inline int 1500 rt_m_getfib(struct mbuf *m) 1501 { 1502 KASSERT(m->m_flags & M_PKTHDR , ("Attempt to get FIB from non header mbuf.")); 1503 return (m->m_pkthdr.fibnum); 1504 } 1505 1506 #define M_GETFIB(_m) rt_m_getfib(_m) 1507 1508 #define M_SETFIB(_m, _fib) do { \ 1509 KASSERT((_m)->m_flags & M_PKTHDR, ("Attempt to set FIB on non header mbuf.")); \ 1510 ((_m)->m_pkthdr.fibnum) = (_fib); \ 1511 } while (0) 1512 1513 /* flags passed as first argument for "m_xxx_tcpip_hash()" */ 1514 #define MBUF_HASHFLAG_L2 (1 << 2) 1515 #define MBUF_HASHFLAG_L3 (1 << 3) 1516 #define MBUF_HASHFLAG_L4 (1 << 4) 1517 1518 /* mbuf hashing helper routines */ 1519 uint32_t m_ether_tcpip_hash_init(void); 1520 uint32_t m_ether_tcpip_hash(const uint32_t, const struct mbuf *, uint32_t); 1521 uint32_t m_infiniband_tcpip_hash_init(void); 1522 uint32_t m_infiniband_tcpip_hash(const uint32_t, const struct mbuf *, uint32_t); 1523 1524 #ifdef MBUF_PROFILING 1525 void m_profile(struct mbuf *m); 1526 #define M_PROFILE(m) m_profile(m) 1527 #else 1528 #define M_PROFILE(m) 1529 #endif 1530 1531 struct mbufq { 1532 STAILQ_HEAD(, mbuf) mq_head; 1533 int mq_len; 1534 int mq_maxlen; 1535 }; 1536 1537 static inline void 1538 mbufq_init(struct mbufq *mq, int maxlen) 1539 { 1540 1541 STAILQ_INIT(&mq->mq_head); 1542 mq->mq_maxlen = maxlen; 1543 mq->mq_len = 0; 1544 } 1545 1546 static inline struct mbuf * 1547 mbufq_flush(struct mbufq *mq) 1548 { 1549 struct mbuf *m; 1550 1551 m = STAILQ_FIRST(&mq->mq_head); 1552 STAILQ_INIT(&mq->mq_head); 1553 mq->mq_len = 0; 1554 return (m); 1555 } 1556 1557 static inline void 1558 mbufq_drain(struct mbufq *mq) 1559 { 1560 struct mbuf *m, *n; 1561 1562 n = mbufq_flush(mq); 1563 while ((m = n) != NULL) { 1564 n = STAILQ_NEXT(m, m_stailqpkt); 1565 m_freem(m); 1566 } 1567 } 1568 1569 static inline struct mbuf * 1570 mbufq_first(const struct mbufq *mq) 1571 { 1572 1573 return (STAILQ_FIRST(&mq->mq_head)); 1574 } 1575 1576 static inline struct mbuf * 1577 mbufq_last(const struct mbufq *mq) 1578 { 1579 1580 return (STAILQ_LAST(&mq->mq_head, mbuf, m_stailqpkt)); 1581 } 1582 1583 static inline int 1584 mbufq_full(const struct mbufq *mq) 1585 { 1586 1587 return (mq->mq_maxlen > 0 && mq->mq_len >= mq->mq_maxlen); 1588 } 1589 1590 static inline int 1591 mbufq_len(const struct mbufq *mq) 1592 { 1593 1594 return (mq->mq_len); 1595 } 1596 1597 static inline int 1598 mbufq_enqueue(struct mbufq *mq, struct mbuf *m) 1599 { 1600 1601 if (mbufq_full(mq)) 1602 return (ENOBUFS); 1603 STAILQ_INSERT_TAIL(&mq->mq_head, m, m_stailqpkt); 1604 mq->mq_len++; 1605 return (0); 1606 } 1607 1608 static inline struct mbuf * 1609 mbufq_dequeue(struct mbufq *mq) 1610 { 1611 struct mbuf *m; 1612 1613 m = STAILQ_FIRST(&mq->mq_head); 1614 if (m) { 1615 STAILQ_REMOVE_HEAD(&mq->mq_head, m_stailqpkt); 1616 m->m_nextpkt = NULL; 1617 mq->mq_len--; 1618 } 1619 return (m); 1620 } 1621 1622 static inline void 1623 mbufq_prepend(struct mbufq *mq, struct mbuf *m) 1624 { 1625 1626 STAILQ_INSERT_HEAD(&mq->mq_head, m, m_stailqpkt); 1627 mq->mq_len++; 1628 } 1629 1630 /* 1631 * Note: this doesn't enforce the maximum list size for dst. 1632 */ 1633 static inline void 1634 mbufq_concat(struct mbufq *mq_dst, struct mbufq *mq_src) 1635 { 1636 1637 mq_dst->mq_len += mq_src->mq_len; 1638 STAILQ_CONCAT(&mq_dst->mq_head, &mq_src->mq_head); 1639 mq_src->mq_len = 0; 1640 } 1641 1642 #ifdef _SYS_TIMESPEC_H_ 1643 static inline void 1644 mbuf_tstmp2timespec(struct mbuf *m, struct timespec *ts) 1645 { 1646 1647 KASSERT((m->m_flags & M_PKTHDR) != 0, ("mbuf %p no M_PKTHDR", m)); 1648 KASSERT((m->m_flags & (M_TSTMP|M_TSTMP_LRO)) != 0, ("mbuf %p no M_TSTMP or M_TSTMP_LRO", m)); 1649 ts->tv_sec = m->m_pkthdr.rcv_tstmp / 1000000000; 1650 ts->tv_nsec = m->m_pkthdr.rcv_tstmp % 1000000000; 1651 } 1652 #endif 1653 1654 #ifdef DEBUGNET 1655 /* Invoked from the debugnet client code. */ 1656 void debugnet_mbuf_drain(void); 1657 void debugnet_mbuf_start(void); 1658 void debugnet_mbuf_finish(void); 1659 void debugnet_mbuf_reinit(int nmbuf, int nclust, int clsize); 1660 #endif 1661 1662 static inline bool 1663 mbuf_has_tls_session(struct mbuf *m) 1664 { 1665 1666 if (m->m_flags & M_EXTPG) { 1667 if (m->m_epg_tls != NULL) { 1668 return (true); 1669 } 1670 } 1671 return (false); 1672 } 1673 1674 #endif /* _KERNEL */ 1675 #endif /* !_SYS_MBUF_H_ */ 1676