1 /*- 2 * Copyright (c) 1982, 1986, 1988, 1993 3 * The Regents of the University of California. 4 * All rights reserved. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 1. Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 3. Neither the name of the University nor the names of its contributors 15 * may be used to endorse or promote products derived from this software 16 * without specific prior written permission. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 28 * SUCH DAMAGE. 29 * 30 * @(#)mbuf.h 8.5 (Berkeley) 2/19/95 31 * $FreeBSD$ 32 */ 33 34 #ifndef _SYS_MBUF_H_ 35 #define _SYS_MBUF_H_ 36 37 /* XXX: These includes suck. Sorry! */ 38 #include <sys/queue.h> 39 #ifdef _KERNEL 40 #include <sys/systm.h> 41 #include <vm/uma.h> 42 #ifdef WITNESS 43 #include <sys/lock.h> 44 #endif 45 #endif 46 47 /* 48 * Mbufs are of a single size, MSIZE (sys/param.h), which includes overhead. 49 * An mbuf may add a single "mbuf cluster" of size MCLBYTES (also in 50 * sys/param.h), which has no additional overhead and is used instead of the 51 * internal data area; this is done when at least MINCLSIZE of data must be 52 * stored. Additionally, it is possible to allocate a separate buffer 53 * externally and attach it to the mbuf in a way similar to that of mbuf 54 * clusters. 55 * 56 * NB: These calculation do not take actual compiler-induced alignment and 57 * padding inside the complete struct mbuf into account. Appropriate 58 * attention is required when changing members of struct mbuf. 59 * 60 * MLEN is data length in a normal mbuf. 61 * MHLEN is data length in an mbuf with pktheader. 62 * MINCLSIZE is a smallest amount of data that should be put into cluster. 63 */ 64 #define MLEN ((int)(MSIZE - sizeof(struct m_hdr))) 65 #define MHLEN ((int)(MLEN - sizeof(struct pkthdr))) 66 #define MINCLSIZE (MHLEN + 1) 67 68 #ifdef _KERNEL 69 /*- 70 * Macro for type conversion: convert mbuf pointer to data pointer of correct 71 * type: 72 * 73 * mtod(m, t) -- Convert mbuf pointer to data pointer of correct type. 74 * mtodo(m, o) -- Same as above but with offset 'o' into data. 75 */ 76 #define mtod(m, t) ((t)((m)->m_data)) 77 #define mtodo(m, o) ((void *)(((m)->m_data) + (o))) 78 79 /* 80 * Argument structure passed to UMA routines during mbuf and packet 81 * allocations. 82 */ 83 struct mb_args { 84 int flags; /* Flags for mbuf being allocated */ 85 short type; /* Type of mbuf being allocated */ 86 }; 87 #endif /* _KERNEL */ 88 89 /* 90 * Header present at the beginning of every mbuf. 91 * Size ILP32: 24 92 * LP64: 32 93 */ 94 struct m_hdr { 95 struct mbuf *mh_next; /* next buffer in chain */ 96 struct mbuf *mh_nextpkt; /* next chain in queue/record */ 97 caddr_t mh_data; /* location of data */ 98 int32_t mh_len; /* amount of data in this mbuf */ 99 uint32_t mh_type:8, /* type of data in this mbuf */ 100 mh_flags:24; /* flags; see below */ 101 #if !defined(__LP64__) 102 uint32_t mh_pad; /* pad for 64bit alignment */ 103 #endif 104 }; 105 106 /* 107 * Packet tag structure (see below for details). 108 */ 109 struct m_tag { 110 SLIST_ENTRY(m_tag) m_tag_link; /* List of packet tags */ 111 u_int16_t m_tag_id; /* Tag ID */ 112 u_int16_t m_tag_len; /* Length of data */ 113 u_int32_t m_tag_cookie; /* ABI/Module ID */ 114 void (*m_tag_free)(struct m_tag *); 115 }; 116 117 /* 118 * Record/packet header in first mbuf of chain; valid only if M_PKTHDR is set. 119 * Size ILP32: 48 120 * LP64: 56 121 */ 122 struct pkthdr { 123 struct ifnet *rcvif; /* rcv interface */ 124 SLIST_HEAD(packet_tags, m_tag) tags; /* list of packet tags */ 125 int32_t len; /* total packet length */ 126 127 /* Layer crossing persistent information. */ 128 uint32_t flowid; /* packet's 4-tuple system */ 129 uint64_t csum_flags; /* checksum and offload features */ 130 uint16_t fibnum; /* this packet should use this fib */ 131 uint8_t cosqos; /* class/quality of service */ 132 uint8_t rsstype; /* hash type */ 133 uint8_t l2hlen; /* layer 2 header length */ 134 uint8_t l3hlen; /* layer 3 header length */ 135 uint8_t l4hlen; /* layer 4 header length */ 136 uint8_t l5hlen; /* layer 5 header length */ 137 union { 138 uint8_t eight[8]; 139 uint16_t sixteen[4]; 140 uint32_t thirtytwo[2]; 141 uint64_t sixtyfour[1]; 142 uintptr_t unintptr[1]; 143 void *ptr; 144 } PH_per; 145 146 /* Layer specific non-persistent local storage for reassembly, etc. */ 147 union { 148 uint8_t eight[8]; 149 uint16_t sixteen[4]; 150 uint32_t thirtytwo[2]; 151 uint64_t sixtyfour[1]; 152 uintptr_t unintptr[1]; 153 void *ptr; 154 } PH_loc; 155 }; 156 #define ether_vtag PH_per.sixteen[0] 157 #define PH_vt PH_per 158 #define vt_nrecs sixteen[0] 159 #define tso_segsz PH_per.sixteen[1] 160 #define csum_phsum PH_per.sixteen[2] 161 #define csum_data PH_per.thirtytwo[1] 162 163 /* 164 * Description of external storage mapped into mbuf; valid only if M_EXT is 165 * set. 166 * Size ILP32: 28 167 * LP64: 48 168 */ 169 struct m_ext { 170 volatile u_int *ref_cnt; /* pointer to ref count info */ 171 caddr_t ext_buf; /* start of buffer */ 172 uint32_t ext_size; /* size of buffer, for ext_free */ 173 uint32_t ext_type:8, /* type of external storage */ 174 ext_flags:24; /* external storage mbuf flags */ 175 int (*ext_free) /* free routine if not the usual */ 176 (struct mbuf *, void *, void *); 177 void *ext_arg1; /* optional argument pointer */ 178 void *ext_arg2; /* optional argument pointer */ 179 }; 180 181 /* 182 * The core of the mbuf object along with some shortcut defines for practical 183 * purposes. 184 */ 185 struct mbuf { 186 struct m_hdr m_hdr; 187 union { 188 struct { 189 struct pkthdr MH_pkthdr; /* M_PKTHDR set */ 190 union { 191 struct m_ext MH_ext; /* M_EXT set */ 192 char MH_databuf[MHLEN]; 193 } MH_dat; 194 } MH; 195 char M_databuf[MLEN]; /* !M_PKTHDR, !M_EXT */ 196 } M_dat; 197 }; 198 #define m_next m_hdr.mh_next 199 #define m_len m_hdr.mh_len 200 #define m_data m_hdr.mh_data 201 #define m_type m_hdr.mh_type 202 #define m_flags m_hdr.mh_flags 203 #define m_nextpkt m_hdr.mh_nextpkt 204 #define m_act m_nextpkt 205 #define m_pkthdr M_dat.MH.MH_pkthdr 206 #define m_ext M_dat.MH.MH_dat.MH_ext 207 #define m_pktdat M_dat.MH.MH_dat.MH_databuf 208 #define m_dat M_dat.M_databuf 209 210 /* 211 * mbuf flags of global significance and layer crossing. 212 * Those of only protocol/layer specific significance are to be mapped 213 * to M_PROTO[1-12] and cleared at layer handoff boundaries. 214 * NB: Limited to the lower 24 bits. 215 */ 216 #define M_EXT 0x00000001 /* has associated external storage */ 217 #define M_PKTHDR 0x00000002 /* start of record */ 218 #define M_EOR 0x00000004 /* end of record */ 219 #define M_RDONLY 0x00000008 /* associated data is marked read-only */ 220 #define M_BCAST 0x00000010 /* send/received as link-level broadcast */ 221 #define M_MCAST 0x00000020 /* send/received as link-level multicast */ 222 #define M_PROMISC 0x00000040 /* packet was not for us */ 223 #define M_VLANTAG 0x00000080 /* ether_vtag is valid */ 224 #define M_FLOWID 0x00000100 /* deprecated: flowid is valid */ 225 #define M_NOFREE 0x00000200 /* do not free mbuf, embedded in cluster */ 226 227 #define M_PROTO1 0x00001000 /* protocol-specific */ 228 #define M_PROTO2 0x00002000 /* protocol-specific */ 229 #define M_PROTO3 0x00004000 /* protocol-specific */ 230 #define M_PROTO4 0x00008000 /* protocol-specific */ 231 #define M_PROTO5 0x00010000 /* protocol-specific */ 232 #define M_PROTO6 0x00020000 /* protocol-specific */ 233 #define M_PROTO7 0x00040000 /* protocol-specific */ 234 #define M_PROTO8 0x00080000 /* protocol-specific */ 235 #define M_PROTO9 0x00100000 /* protocol-specific */ 236 #define M_PROTO10 0x00200000 /* protocol-specific */ 237 #define M_PROTO11 0x00400000 /* protocol-specific */ 238 #define M_PROTO12 0x00800000 /* protocol-specific */ 239 240 /* 241 * Flags to purge when crossing layers. 242 */ 243 #define M_PROTOFLAGS \ 244 (M_PROTO1|M_PROTO2|M_PROTO3|M_PROTO4|M_PROTO5|M_PROTO6|M_PROTO7|M_PROTO8|\ 245 M_PROTO9|M_PROTO10|M_PROTO11|M_PROTO12) 246 247 /* 248 * Flags preserved when copying m_pkthdr. 249 */ 250 #define M_COPYFLAGS \ 251 (M_PKTHDR|M_EOR|M_RDONLY|M_BCAST|M_MCAST|M_VLANTAG|M_PROMISC| \ 252 M_PROTOFLAGS) 253 254 /* 255 * Mbuf flag description for use with printf(9) %b identifier. 256 */ 257 #define M_FLAG_BITS \ 258 "\20\1M_EXT\2M_PKTHDR\3M_EOR\4M_RDONLY\5M_BCAST\6M_MCAST" \ 259 "\7M_PROMISC\10M_VLANTAG\11M_FLOWID" 260 #define M_FLAG_PROTOBITS \ 261 "\15M_PROTO1\16M_PROTO2\17M_PROTO3\20M_PROTO4\21M_PROTO5" \ 262 "\22M_PROTO6\23M_PROTO7\24M_PROTO8\25M_PROTO9\26M_PROTO10" \ 263 "\27M_PROTO11\30M_PROTO12" 264 #define M_FLAG_PRINTF (M_FLAG_BITS M_FLAG_PROTOBITS) 265 266 /* 267 * Network interface cards are able to hash protocol fields (such as IPv4 268 * addresses and TCP port numbers) classify packets into flows. These flows 269 * can then be used to maintain ordering while delivering packets to the OS 270 * via parallel input queues, as well as to provide a stateless affinity 271 * model. NIC drivers can pass up the hash via m->m_pkthdr.flowid, and set 272 * m_flag fields to indicate how the hash should be interpreted by the 273 * network stack. 274 * 275 * Most NICs support RSS, which provides ordering and explicit affinity, and 276 * use the hash m_flag bits to indicate what header fields were covered by 277 * the hash. M_HASHTYPE_OPAQUE can be set by non-RSS cards or configurations 278 * that provide an opaque flow identifier, allowing for ordering and 279 * distribution without explicit affinity. 280 */ 281 #define M_HASHTYPE_NONE 0 282 #define M_HASHTYPE_RSS_IPV4 1 /* IPv4 2-tuple */ 283 #define M_HASHTYPE_RSS_TCP_IPV4 2 /* TCPv4 4-tuple */ 284 #define M_HASHTYPE_RSS_IPV6 3 /* IPv6 2-tuple */ 285 #define M_HASHTYPE_RSS_TCP_IPV6 4 /* TCPv6 4-tuple */ 286 #define M_HASHTYPE_RSS_IPV6_EX 5 /* IPv6 2-tuple + ext hdrs */ 287 #define M_HASHTYPE_RSS_TCP_IPV6_EX 6 /* TCPv6 4-tiple + ext hdrs */ 288 #define M_HASHTYPE_OPAQUE 255 /* ordering, not affinity */ 289 290 #define M_HASHTYPE_CLEAR(m) ((m)->m_pkthdr.rsstype = 0) 291 #define M_HASHTYPE_GET(m) ((m)->m_pkthdr.rsstype) 292 #define M_HASHTYPE_SET(m, v) ((m)->m_pkthdr.rsstype = (v)) 293 #define M_HASHTYPE_TEST(m, v) (M_HASHTYPE_GET(m) == (v)) 294 295 /* 296 * COS/QOS class and quality of service tags. 297 * It uses DSCP code points as base. 298 */ 299 #define QOS_DSCP_CS0 0x00 300 #define QOS_DSCP_DEF QOS_DSCP_CS0 301 #define QOS_DSCP_CS1 0x20 302 #define QOS_DSCP_AF11 0x28 303 #define QOS_DSCP_AF12 0x30 304 #define QOS_DSCP_AF13 0x38 305 #define QOS_DSCP_CS2 0x40 306 #define QOS_DSCP_AF21 0x48 307 #define QOS_DSCP_AF22 0x50 308 #define QOS_DSCP_AF23 0x58 309 #define QOS_DSCP_CS3 0x60 310 #define QOS_DSCP_AF31 0x68 311 #define QOS_DSCP_AF32 0x70 312 #define QOS_DSCP_AF33 0x78 313 #define QOS_DSCP_CS4 0x80 314 #define QOS_DSCP_AF41 0x88 315 #define QOS_DSCP_AF42 0x90 316 #define QOS_DSCP_AF43 0x98 317 #define QOS_DSCP_CS5 0xa0 318 #define QOS_DSCP_EF 0xb8 319 #define QOS_DSCP_CS6 0xc0 320 #define QOS_DSCP_CS7 0xe0 321 322 /* 323 * External mbuf storage buffer types. 324 */ 325 #define EXT_CLUSTER 1 /* mbuf cluster */ 326 #define EXT_SFBUF 2 /* sendfile(2)'s sf_bufs */ 327 #define EXT_JUMBOP 3 /* jumbo cluster 4096 bytes */ 328 #define EXT_JUMBO9 4 /* jumbo cluster 9216 bytes */ 329 #define EXT_JUMBO16 5 /* jumbo cluster 16184 bytes */ 330 #define EXT_PACKET 6 /* mbuf+cluster from packet zone */ 331 #define EXT_MBUF 7 /* external mbuf reference (M_IOVEC) */ 332 333 #define EXT_VENDOR1 224 /* for vendor-internal use */ 334 #define EXT_VENDOR2 225 /* for vendor-internal use */ 335 #define EXT_VENDOR3 226 /* for vendor-internal use */ 336 #define EXT_VENDOR4 227 /* for vendor-internal use */ 337 338 #define EXT_EXP1 244 /* for experimental use */ 339 #define EXT_EXP2 245 /* for experimental use */ 340 #define EXT_EXP3 246 /* for experimental use */ 341 #define EXT_EXP4 247 /* for experimental use */ 342 343 #define EXT_NET_DRV 252 /* custom ext_buf provided by net driver(s) */ 344 #define EXT_MOD_TYPE 253 /* custom module's ext_buf type */ 345 #define EXT_DISPOSABLE 254 /* can throw this buffer away w/page flipping */ 346 #define EXT_EXTREF 255 /* has externally maintained ref_cnt ptr */ 347 348 /* 349 * Flags for external mbuf buffer types. 350 * NB: limited to the lower 24 bits. 351 */ 352 #define EXT_FLAG_EMBREF 0x000001 /* embedded ref_cnt, notyet */ 353 #define EXT_FLAG_EXTREF 0x000002 /* external ref_cnt, notyet */ 354 #define EXT_FLAG_NOFREE 0x000010 /* don't free mbuf to pool, notyet */ 355 356 #define EXT_FLAG_VENDOR1 0x010000 /* for vendor-internal use */ 357 #define EXT_FLAG_VENDOR2 0x020000 /* for vendor-internal use */ 358 #define EXT_FLAG_VENDOR3 0x040000 /* for vendor-internal use */ 359 #define EXT_FLAG_VENDOR4 0x080000 /* for vendor-internal use */ 360 361 #define EXT_FLAG_EXP1 0x100000 /* for experimental use */ 362 #define EXT_FLAG_EXP2 0x200000 /* for experimental use */ 363 #define EXT_FLAG_EXP3 0x400000 /* for experimental use */ 364 #define EXT_FLAG_EXP4 0x800000 /* for experimental use */ 365 366 /* 367 * EXT flag description for use with printf(9) %b identifier. 368 */ 369 #define EXT_FLAG_BITS \ 370 "\20\1EXT_FLAG_EMBREF\2EXT_FLAG_EXTREF\5EXT_FLAG_NOFREE" \ 371 "\21EXT_FLAG_VENDOR1\22EXT_FLAG_VENDOR2\23EXT_FLAG_VENDOR3" \ 372 "\24EXT_FLAG_VENDOR4\25EXT_FLAG_EXP1\26EXT_FLAG_EXP2\27EXT_FLAG_EXP3" \ 373 "\30EXT_FLAG_EXP4" 374 375 /* 376 * Return values for (*ext_free). 377 */ 378 #define EXT_FREE_OK 0 /* Normal return */ 379 380 /* 381 * Flags indicating checksum, segmentation and other offload work to be 382 * done, or already done, by hardware or lower layers. It is split into 383 * separate inbound and outbound flags. 384 * 385 * Outbound flags that are set by upper protocol layers requesting lower 386 * layers, or ideally the hardware, to perform these offloading tasks. 387 * For outbound packets this field and its flags can be directly tested 388 * against if_data.ifi_hwassist. 389 */ 390 #define CSUM_IP 0x00000001 /* IP header checksum offload */ 391 #define CSUM_IP_UDP 0x00000002 /* UDP checksum offload */ 392 #define CSUM_IP_TCP 0x00000004 /* TCP checksum offload */ 393 #define CSUM_IP_SCTP 0x00000008 /* SCTP checksum offload */ 394 #define CSUM_IP_TSO 0x00000010 /* TCP segmentation offload */ 395 #define CSUM_IP_ISCSI 0x00000020 /* iSCSI checksum offload */ 396 397 #define CSUM_IP6_UDP 0x00000200 /* UDP checksum offload */ 398 #define CSUM_IP6_TCP 0x00000400 /* TCP checksum offload */ 399 #define CSUM_IP6_SCTP 0x00000800 /* SCTP checksum offload */ 400 #define CSUM_IP6_TSO 0x00001000 /* TCP segmentation offload */ 401 #define CSUM_IP6_ISCSI 0x00002000 /* iSCSI checksum offload */ 402 403 /* Inbound checksum support where the checksum was verified by hardware. */ 404 #define CSUM_L3_CALC 0x01000000 /* calculated layer 3 csum */ 405 #define CSUM_L3_VALID 0x02000000 /* checksum is correct */ 406 #define CSUM_L4_CALC 0x04000000 /* calculated layer 4 csum */ 407 #define CSUM_L4_VALID 0x08000000 /* checksum is correct */ 408 #define CSUM_L5_CALC 0x10000000 /* calculated layer 5 csum */ 409 #define CSUM_L5_VALID 0x20000000 /* checksum is correct */ 410 #define CSUM_COALESED 0x40000000 /* contains merged segments */ 411 412 /* 413 * CSUM flag description for use with printf(9) %b identifier. 414 */ 415 #define CSUM_BITS \ 416 "\20\1CSUM_IP\2CSUM_IP_UDP\3CSUM_IP_TCP\4CSUM_IP_SCTP\5CSUM_IP_TSO" \ 417 "\6CSUM_IP_ISCSI" \ 418 "\12CSUM_IP6_UDP\13CSUM_IP6_TCP\14CSUM_IP6_SCTP\15CSUM_IP6_TSO" \ 419 "\16CSUM_IP6_ISCSI" \ 420 "\31CSUM_L3_CALC\32CSUM_L3_VALID\33CSUM_L4_CALC\34CSUM_L4_VALID" \ 421 "\35CSUM_L5_CALC\36CSUM_L5_VALID\37CSUM_COALESED" 422 423 /* CSUM flags compatibility mappings. */ 424 #define CSUM_IP_CHECKED CSUM_L3_CALC 425 #define CSUM_IP_VALID CSUM_L3_VALID 426 #define CSUM_DATA_VALID CSUM_L4_VALID 427 #define CSUM_PSEUDO_HDR CSUM_L4_CALC 428 #define CSUM_SCTP_VALID CSUM_L4_VALID 429 #define CSUM_DELAY_DATA (CSUM_TCP|CSUM_UDP) 430 #define CSUM_DELAY_IP CSUM_IP /* Only v4, no v6 IP hdr csum */ 431 #define CSUM_DELAY_DATA_IPV6 (CSUM_TCP_IPV6|CSUM_UDP_IPV6) 432 #define CSUM_DATA_VALID_IPV6 CSUM_DATA_VALID 433 #define CSUM_TCP CSUM_IP_TCP 434 #define CSUM_UDP CSUM_IP_UDP 435 #define CSUM_SCTP CSUM_IP_SCTP 436 #define CSUM_TSO (CSUM_IP_TSO|CSUM_IP6_TSO) 437 #define CSUM_UDP_IPV6 CSUM_IP6_UDP 438 #define CSUM_TCP_IPV6 CSUM_IP6_TCP 439 #define CSUM_SCTP_IPV6 CSUM_IP6_SCTP 440 #define CSUM_FRAGMENT 0x0 /* Unused */ 441 442 /* 443 * mbuf types describing the content of the mbuf (including external storage). 444 */ 445 #define MT_NOTMBUF 0 /* USED INTERNALLY ONLY! Object is not mbuf */ 446 #define MT_DATA 1 /* dynamic (data) allocation */ 447 #define MT_HEADER MT_DATA /* packet header, use M_PKTHDR instead */ 448 449 #define MT_VENDOR1 4 /* for vendor-internal use */ 450 #define MT_VENDOR2 5 /* for vendor-internal use */ 451 #define MT_VENDOR3 6 /* for vendor-internal use */ 452 #define MT_VENDOR4 7 /* for vendor-internal use */ 453 454 #define MT_SONAME 8 /* socket name */ 455 456 #define MT_EXP1 9 /* for experimental use */ 457 #define MT_EXP2 10 /* for experimental use */ 458 #define MT_EXP3 11 /* for experimental use */ 459 #define MT_EXP4 12 /* for experimental use */ 460 461 #define MT_CONTROL 14 /* extra-data protocol message */ 462 #define MT_OOBDATA 15 /* expedited data */ 463 #define MT_NTYPES 16 /* number of mbuf types for mbtypes[] */ 464 465 #define MT_NOINIT 255 /* Not a type but a flag to allocate 466 a non-initialized mbuf */ 467 468 /* 469 * String names of mbuf-related UMA(9) and malloc(9) types. Exposed to 470 * !_KERNEL so that monitoring tools can look up the zones with 471 * libmemstat(3). 472 */ 473 #define MBUF_MEM_NAME "mbuf" 474 #define MBUF_CLUSTER_MEM_NAME "mbuf_cluster" 475 #define MBUF_PACKET_MEM_NAME "mbuf_packet" 476 #define MBUF_JUMBOP_MEM_NAME "mbuf_jumbo_page" 477 #define MBUF_JUMBO9_MEM_NAME "mbuf_jumbo_9k" 478 #define MBUF_JUMBO16_MEM_NAME "mbuf_jumbo_16k" 479 #define MBUF_TAG_MEM_NAME "mbuf_tag" 480 #define MBUF_EXTREFCNT_MEM_NAME "mbuf_ext_refcnt" 481 482 #ifdef _KERNEL 483 484 #ifdef WITNESS 485 #define MBUF_CHECKSLEEP(how) do { \ 486 if (how == M_WAITOK) \ 487 WITNESS_WARN(WARN_GIANTOK | WARN_SLEEPOK, NULL, \ 488 "Sleeping in \"%s\"", __func__); \ 489 } while (0) 490 #else 491 #define MBUF_CHECKSLEEP(how) 492 #endif 493 494 /* 495 * Network buffer allocation API 496 * 497 * The rest of it is defined in kern/kern_mbuf.c 498 */ 499 extern uma_zone_t zone_mbuf; 500 extern uma_zone_t zone_clust; 501 extern uma_zone_t zone_pack; 502 extern uma_zone_t zone_jumbop; 503 extern uma_zone_t zone_jumbo9; 504 extern uma_zone_t zone_jumbo16; 505 extern uma_zone_t zone_ext_refcnt; 506 507 void mb_free_ext(struct mbuf *); 508 int m_pkthdr_init(struct mbuf *, int); 509 510 static __inline int 511 m_gettype(int size) 512 { 513 int type; 514 515 switch (size) { 516 case MSIZE: 517 type = EXT_MBUF; 518 break; 519 case MCLBYTES: 520 type = EXT_CLUSTER; 521 break; 522 #if MJUMPAGESIZE != MCLBYTES 523 case MJUMPAGESIZE: 524 type = EXT_JUMBOP; 525 break; 526 #endif 527 case MJUM9BYTES: 528 type = EXT_JUMBO9; 529 break; 530 case MJUM16BYTES: 531 type = EXT_JUMBO16; 532 break; 533 default: 534 panic("%s: invalid cluster size %d", __func__, size); 535 } 536 537 return (type); 538 } 539 540 /* 541 * Associated an external reference counted buffer with an mbuf. 542 */ 543 static __inline void 544 m_extaddref(struct mbuf *m, caddr_t buf, u_int size, u_int *ref_cnt, 545 int (*freef)(struct mbuf *, void *, void *), void *arg1, void *arg2) 546 { 547 548 KASSERT(ref_cnt != NULL, ("%s: ref_cnt not provided", __func__)); 549 550 atomic_add_int(ref_cnt, 1); 551 m->m_flags |= M_EXT; 552 m->m_ext.ext_buf = buf; 553 m->m_ext.ref_cnt = ref_cnt; 554 m->m_data = m->m_ext.ext_buf; 555 m->m_ext.ext_size = size; 556 m->m_ext.ext_free = freef; 557 m->m_ext.ext_arg1 = arg1; 558 m->m_ext.ext_arg2 = arg2; 559 m->m_ext.ext_type = EXT_EXTREF; 560 } 561 562 static __inline uma_zone_t 563 m_getzone(int size) 564 { 565 uma_zone_t zone; 566 567 switch (size) { 568 case MCLBYTES: 569 zone = zone_clust; 570 break; 571 #if MJUMPAGESIZE != MCLBYTES 572 case MJUMPAGESIZE: 573 zone = zone_jumbop; 574 break; 575 #endif 576 case MJUM9BYTES: 577 zone = zone_jumbo9; 578 break; 579 case MJUM16BYTES: 580 zone = zone_jumbo16; 581 break; 582 default: 583 panic("%s: invalid cluster size %d", __func__, size); 584 } 585 586 return (zone); 587 } 588 589 /* 590 * Initialize an mbuf with linear storage. 591 * 592 * Inline because the consumer text overhead will be roughly the same to 593 * initialize or call a function with this many parameters and M_PKTHDR 594 * should go away with constant propagation for !MGETHDR. 595 */ 596 static __inline int 597 m_init(struct mbuf *m, uma_zone_t zone, int size, int how, short type, 598 int flags) 599 { 600 int error; 601 602 m->m_next = NULL; 603 m->m_nextpkt = NULL; 604 m->m_data = m->m_dat; 605 m->m_len = 0; 606 m->m_flags = flags; 607 m->m_type = type; 608 if (flags & M_PKTHDR) { 609 if ((error = m_pkthdr_init(m, how)) != 0) 610 return (error); 611 } 612 613 return (0); 614 } 615 616 static __inline struct mbuf * 617 m_get(int how, short type) 618 { 619 struct mb_args args; 620 621 args.flags = 0; 622 args.type = type; 623 return (uma_zalloc_arg(zone_mbuf, &args, how)); 624 } 625 626 /* 627 * XXX This should be deprecated, very little use. 628 */ 629 static __inline struct mbuf * 630 m_getclr(int how, short type) 631 { 632 struct mbuf *m; 633 struct mb_args args; 634 635 args.flags = 0; 636 args.type = type; 637 m = uma_zalloc_arg(zone_mbuf, &args, how); 638 if (m != NULL) 639 bzero(m->m_data, MLEN); 640 return (m); 641 } 642 643 static __inline struct mbuf * 644 m_gethdr(int how, short type) 645 { 646 struct mb_args args; 647 648 args.flags = M_PKTHDR; 649 args.type = type; 650 return (uma_zalloc_arg(zone_mbuf, &args, how)); 651 } 652 653 static __inline struct mbuf * 654 m_getcl(int how, short type, int flags) 655 { 656 struct mb_args args; 657 658 args.flags = flags; 659 args.type = type; 660 return (uma_zalloc_arg(zone_pack, &args, how)); 661 } 662 663 static __inline void 664 m_clget(struct mbuf *m, int how) 665 { 666 667 if (m->m_flags & M_EXT) 668 printf("%s: %p mbuf already has cluster\n", __func__, m); 669 m->m_ext.ext_buf = (char *)NULL; 670 uma_zalloc_arg(zone_clust, m, how); 671 /* 672 * On a cluster allocation failure, drain the packet zone and retry, 673 * we might be able to loosen a few clusters up on the drain. 674 */ 675 if ((how & M_NOWAIT) && (m->m_ext.ext_buf == NULL)) { 676 zone_drain(zone_pack); 677 uma_zalloc_arg(zone_clust, m, how); 678 } 679 } 680 681 /* 682 * m_cljget() is different from m_clget() as it can allocate clusters without 683 * attaching them to an mbuf. In that case the return value is the pointer 684 * to the cluster of the requested size. If an mbuf was specified, it gets 685 * the cluster attached to it and the return value can be safely ignored. 686 * For size it takes MCLBYTES, MJUMPAGESIZE, MJUM9BYTES, MJUM16BYTES. 687 */ 688 static __inline void * 689 m_cljget(struct mbuf *m, int how, int size) 690 { 691 uma_zone_t zone; 692 693 if (m && m->m_flags & M_EXT) 694 printf("%s: %p mbuf already has cluster\n", __func__, m); 695 if (m != NULL) 696 m->m_ext.ext_buf = NULL; 697 698 zone = m_getzone(size); 699 return (uma_zalloc_arg(zone, m, how)); 700 } 701 702 static __inline void 703 m_cljset(struct mbuf *m, void *cl, int type) 704 { 705 uma_zone_t zone; 706 int size; 707 708 switch (type) { 709 case EXT_CLUSTER: 710 size = MCLBYTES; 711 zone = zone_clust; 712 break; 713 #if MJUMPAGESIZE != MCLBYTES 714 case EXT_JUMBOP: 715 size = MJUMPAGESIZE; 716 zone = zone_jumbop; 717 break; 718 #endif 719 case EXT_JUMBO9: 720 size = MJUM9BYTES; 721 zone = zone_jumbo9; 722 break; 723 case EXT_JUMBO16: 724 size = MJUM16BYTES; 725 zone = zone_jumbo16; 726 break; 727 default: 728 panic("%s: unknown cluster type %d", __func__, type); 729 break; 730 } 731 732 m->m_data = m->m_ext.ext_buf = cl; 733 m->m_ext.ext_free = m->m_ext.ext_arg1 = m->m_ext.ext_arg2 = NULL; 734 m->m_ext.ext_size = size; 735 m->m_ext.ext_type = type; 736 m->m_ext.ext_flags = 0; 737 m->m_ext.ref_cnt = uma_find_refcnt(zone, cl); 738 m->m_flags |= M_EXT; 739 740 } 741 742 static __inline void 743 m_chtype(struct mbuf *m, short new_type) 744 { 745 746 m->m_type = new_type; 747 } 748 749 static __inline void 750 m_clrprotoflags(struct mbuf *m) 751 { 752 753 m->m_flags &= ~M_PROTOFLAGS; 754 } 755 756 static __inline struct mbuf * 757 m_last(struct mbuf *m) 758 { 759 760 while (m->m_next) 761 m = m->m_next; 762 return (m); 763 } 764 765 /* 766 * mbuf, cluster, and external object allocation macros (for compatibility 767 * purposes). 768 */ 769 #define M_MOVE_PKTHDR(to, from) m_move_pkthdr((to), (from)) 770 #define MGET(m, how, type) ((m) = m_get((how), (type))) 771 #define MGETHDR(m, how, type) ((m) = m_gethdr((how), (type))) 772 #define MCLGET(m, how) m_clget((m), (how)) 773 #define MEXTADD(m, buf, size, free, arg1, arg2, flags, type) \ 774 (void )m_extadd((m), (caddr_t)(buf), (size), (free), (arg1), (arg2),\ 775 (flags), (type), M_NOWAIT) 776 #define m_getm(m, len, how, type) \ 777 m_getm2((m), (len), (how), (type), M_PKTHDR) 778 779 /* 780 * Evaluate TRUE if it's safe to write to the mbuf m's data region (this can 781 * be both the local data payload, or an external buffer area, depending on 782 * whether M_EXT is set). 783 */ 784 #define M_WRITABLE(m) (!((m)->m_flags & M_RDONLY) && \ 785 (!(((m)->m_flags & M_EXT)) || \ 786 (*((m)->m_ext.ref_cnt) == 1)) ) \ 787 788 /* Check if the supplied mbuf has a packet header, or else panic. */ 789 #define M_ASSERTPKTHDR(m) \ 790 KASSERT((m) != NULL && (m)->m_flags & M_PKTHDR, \ 791 ("%s: no mbuf packet header!", __func__)) 792 793 /* 794 * Ensure that the supplied mbuf is a valid, non-free mbuf. 795 * 796 * XXX: Broken at the moment. Need some UMA magic to make it work again. 797 */ 798 #define M_ASSERTVALID(m) \ 799 KASSERT((((struct mbuf *)m)->m_flags & 0) == 0, \ 800 ("%s: attempted use of a free mbuf!", __func__)) 801 802 /* 803 * Set the m_data pointer of a newly-allocated mbuf (m_get/MGET) to place an 804 * object of the specified size at the end of the mbuf, longword aligned. 805 */ 806 #define M_ALIGN(m, len) do { \ 807 KASSERT(!((m)->m_flags & (M_PKTHDR|M_EXT)), \ 808 ("%s: M_ALIGN not normal mbuf", __func__)); \ 809 KASSERT((m)->m_data == (m)->m_dat, \ 810 ("%s: M_ALIGN not a virgin mbuf", __func__)); \ 811 (m)->m_data += (MLEN - (len)) & ~(sizeof(long) - 1); \ 812 } while (0) 813 814 /* 815 * As above, for mbufs allocated with m_gethdr/MGETHDR or initialized by 816 * M_DUP/MOVE_PKTHDR. 817 */ 818 #define MH_ALIGN(m, len) do { \ 819 KASSERT((m)->m_flags & M_PKTHDR && !((m)->m_flags & M_EXT), \ 820 ("%s: MH_ALIGN not PKTHDR mbuf", __func__)); \ 821 KASSERT((m)->m_data == (m)->m_pktdat, \ 822 ("%s: MH_ALIGN not a virgin mbuf", __func__)); \ 823 (m)->m_data += (MHLEN - (len)) & ~(sizeof(long) - 1); \ 824 } while (0) 825 826 /* 827 * As above, for mbuf with external storage. 828 */ 829 #define MEXT_ALIGN(m, len) do { \ 830 KASSERT((m)->m_flags & M_EXT, \ 831 ("%s: MEXT_ALIGN not an M_EXT mbuf", __func__)); \ 832 KASSERT((m)->m_data == (m)->m_ext.ext_buf, \ 833 ("%s: MEXT_ALIGN not a virgin mbuf", __func__)); \ 834 (m)->m_data += ((m)->m_ext.ext_size - (len)) & \ 835 ~(sizeof(long) - 1); \ 836 } while (0) 837 838 /* 839 * Compute the amount of space available before the current start of data in 840 * an mbuf. 841 * 842 * The M_WRITABLE() is a temporary, conservative safety measure: the burden 843 * of checking writability of the mbuf data area rests solely with the caller. 844 */ 845 #define M_LEADINGSPACE(m) \ 846 ((m)->m_flags & M_EXT ? \ 847 (M_WRITABLE(m) ? (m)->m_data - (m)->m_ext.ext_buf : 0): \ 848 (m)->m_flags & M_PKTHDR ? (m)->m_data - (m)->m_pktdat : \ 849 (m)->m_data - (m)->m_dat) 850 851 /* 852 * Compute the amount of space available after the end of data in an mbuf. 853 * 854 * The M_WRITABLE() is a temporary, conservative safety measure: the burden 855 * of checking writability of the mbuf data area rests solely with the caller. 856 */ 857 #define M_TRAILINGSPACE(m) \ 858 ((m)->m_flags & M_EXT ? \ 859 (M_WRITABLE(m) ? (m)->m_ext.ext_buf + (m)->m_ext.ext_size \ 860 - ((m)->m_data + (m)->m_len) : 0) : \ 861 &(m)->m_dat[MLEN] - ((m)->m_data + (m)->m_len)) 862 863 /* 864 * Arrange to prepend space of size plen to mbuf m. If a new mbuf must be 865 * allocated, how specifies whether to wait. If the allocation fails, the 866 * original mbuf chain is freed and m is set to NULL. 867 */ 868 #define M_PREPEND(m, plen, how) do { \ 869 struct mbuf **_mmp = &(m); \ 870 struct mbuf *_mm = *_mmp; \ 871 int _mplen = (plen); \ 872 int __mhow = (how); \ 873 \ 874 MBUF_CHECKSLEEP(how); \ 875 if (M_LEADINGSPACE(_mm) >= _mplen) { \ 876 _mm->m_data -= _mplen; \ 877 _mm->m_len += _mplen; \ 878 } else \ 879 _mm = m_prepend(_mm, _mplen, __mhow); \ 880 if (_mm != NULL && _mm->m_flags & M_PKTHDR) \ 881 _mm->m_pkthdr.len += _mplen; \ 882 *_mmp = _mm; \ 883 } while (0) 884 885 /* 886 * Change mbuf to new type. This is a relatively expensive operation and 887 * should be avoided. 888 */ 889 #define MCHTYPE(m, t) m_chtype((m), (t)) 890 891 /* Length to m_copy to copy all. */ 892 #define M_COPYALL 1000000000 893 894 /* Compatibility with 4.3. */ 895 #define m_copy(m, o, l) m_copym((m), (o), (l), M_NOWAIT) 896 897 extern int max_datalen; /* MHLEN - max_hdr */ 898 extern int max_hdr; /* Largest link + protocol header */ 899 extern int max_linkhdr; /* Largest link-level header */ 900 extern int max_protohdr; /* Largest protocol header */ 901 extern int nmbclusters; /* Maximum number of clusters */ 902 903 struct uio; 904 905 void m_adj(struct mbuf *, int); 906 void m_align(struct mbuf *, int); 907 int m_apply(struct mbuf *, int, int, 908 int (*)(void *, void *, u_int), void *); 909 int m_append(struct mbuf *, int, c_caddr_t); 910 void m_cat(struct mbuf *, struct mbuf *); 911 int m_extadd(struct mbuf *, caddr_t, u_int, 912 int (*)(struct mbuf *, void *, void *), void *, void *, 913 int, int, int); 914 struct mbuf *m_collapse(struct mbuf *, int, int); 915 void m_copyback(struct mbuf *, int, int, c_caddr_t); 916 void m_copydata(const struct mbuf *, int, int, caddr_t); 917 struct mbuf *m_copym(struct mbuf *, int, int, int); 918 struct mbuf *m_copymdata(struct mbuf *, struct mbuf *, 919 int, int, int, int); 920 struct mbuf *m_copypacket(struct mbuf *, int); 921 void m_copy_pkthdr(struct mbuf *, struct mbuf *); 922 struct mbuf *m_copyup(struct mbuf *, int, int); 923 struct mbuf *m_defrag(struct mbuf *, int); 924 void m_demote(struct mbuf *, int); 925 struct mbuf *m_devget(char *, int, int, struct ifnet *, 926 void (*)(char *, caddr_t, u_int)); 927 struct mbuf *m_dup(struct mbuf *, int); 928 int m_dup_pkthdr(struct mbuf *, struct mbuf *, int); 929 u_int m_fixhdr(struct mbuf *); 930 struct mbuf *m_fragment(struct mbuf *, int, int); 931 void m_freem(struct mbuf *); 932 struct mbuf *m_get2(int, int, short, int); 933 struct mbuf *m_getjcl(int, short, int, int); 934 struct mbuf *m_getm2(struct mbuf *, int, int, short, int); 935 struct mbuf *m_getptr(struct mbuf *, int, int *); 936 u_int m_length(struct mbuf *, struct mbuf **); 937 int m_mbuftouio(struct uio *, struct mbuf *, int); 938 void m_move_pkthdr(struct mbuf *, struct mbuf *); 939 struct mbuf *m_prepend(struct mbuf *, int, int); 940 void m_print(const struct mbuf *, int); 941 struct mbuf *m_pulldown(struct mbuf *, int, int, int *); 942 struct mbuf *m_pullup(struct mbuf *, int); 943 int m_sanity(struct mbuf *, int); 944 struct mbuf *m_split(struct mbuf *, int, int); 945 struct mbuf *m_uiotombuf(struct uio *, int, int, int, int); 946 struct mbuf *m_unshare(struct mbuf *, int); 947 948 /*- 949 * Network packets may have annotations attached by affixing a list of 950 * "packet tags" to the pkthdr structure. Packet tags are dynamically 951 * allocated semi-opaque data structures that have a fixed header 952 * (struct m_tag) that specifies the size of the memory block and a 953 * <cookie,type> pair that identifies it. The cookie is a 32-bit unique 954 * unsigned value used to identify a module or ABI. By convention this value 955 * is chosen as the date+time that the module is created, expressed as the 956 * number of seconds since the epoch (e.g., using date -u +'%s'). The type 957 * value is an ABI/module-specific value that identifies a particular 958 * annotation and is private to the module. For compatibility with systems 959 * like OpenBSD that define packet tags w/o an ABI/module cookie, the value 960 * PACKET_ABI_COMPAT is used to implement m_tag_get and m_tag_find 961 * compatibility shim functions and several tag types are defined below. 962 * Users that do not require compatibility should use a private cookie value 963 * so that packet tag-related definitions can be maintained privately. 964 * 965 * Note that the packet tag returned by m_tag_alloc has the default memory 966 * alignment implemented by malloc. To reference private data one can use a 967 * construct like: 968 * 969 * struct m_tag *mtag = m_tag_alloc(...); 970 * struct foo *p = (struct foo *)(mtag+1); 971 * 972 * if the alignment of struct m_tag is sufficient for referencing members of 973 * struct foo. Otherwise it is necessary to embed struct m_tag within the 974 * private data structure to insure proper alignment; e.g., 975 * 976 * struct foo { 977 * struct m_tag tag; 978 * ... 979 * }; 980 * struct foo *p = (struct foo *) m_tag_alloc(...); 981 * struct m_tag *mtag = &p->tag; 982 */ 983 984 /* 985 * Persistent tags stay with an mbuf until the mbuf is reclaimed. Otherwise 986 * tags are expected to ``vanish'' when they pass through a network 987 * interface. For most interfaces this happens normally as the tags are 988 * reclaimed when the mbuf is free'd. However in some special cases 989 * reclaiming must be done manually. An example is packets that pass through 990 * the loopback interface. Also, one must be careful to do this when 991 * ``turning around'' packets (e.g., icmp_reflect). 992 * 993 * To mark a tag persistent bit-or this flag in when defining the tag id. 994 * The tag will then be treated as described above. 995 */ 996 #define MTAG_PERSISTENT 0x800 997 998 #define PACKET_TAG_NONE 0 /* Nadda */ 999 1000 /* Packet tags for use with PACKET_ABI_COMPAT. */ 1001 #define PACKET_TAG_IPSEC_IN_DONE 1 /* IPsec applied, in */ 1002 #define PACKET_TAG_IPSEC_OUT_DONE 2 /* IPsec applied, out */ 1003 #define PACKET_TAG_IPSEC_IN_CRYPTO_DONE 3 /* NIC IPsec crypto done */ 1004 #define PACKET_TAG_IPSEC_OUT_CRYPTO_NEEDED 4 /* NIC IPsec crypto req'ed */ 1005 #define PACKET_TAG_IPSEC_IN_COULD_DO_CRYPTO 5 /* NIC notifies IPsec */ 1006 #define PACKET_TAG_IPSEC_PENDING_TDB 6 /* Reminder to do IPsec */ 1007 #define PACKET_TAG_BRIDGE 7 /* Bridge processing done */ 1008 #define PACKET_TAG_GIF 8 /* GIF processing done */ 1009 #define PACKET_TAG_GRE 9 /* GRE processing done */ 1010 #define PACKET_TAG_IN_PACKET_CHECKSUM 10 /* NIC checksumming done */ 1011 #define PACKET_TAG_ENCAP 11 /* Encap. processing */ 1012 #define PACKET_TAG_IPSEC_SOCKET 12 /* IPSEC socket ref */ 1013 #define PACKET_TAG_IPSEC_HISTORY 13 /* IPSEC history */ 1014 #define PACKET_TAG_IPV6_INPUT 14 /* IPV6 input processing */ 1015 #define PACKET_TAG_DUMMYNET 15 /* dummynet info */ 1016 #define PACKET_TAG_DIVERT 17 /* divert info */ 1017 #define PACKET_TAG_IPFORWARD 18 /* ipforward info */ 1018 #define PACKET_TAG_MACLABEL (19 | MTAG_PERSISTENT) /* MAC label */ 1019 #define PACKET_TAG_PF (21 | MTAG_PERSISTENT) /* PF/ALTQ information */ 1020 #define PACKET_TAG_RTSOCKFAM 25 /* rtsock sa family */ 1021 #define PACKET_TAG_IPOPTIONS 27 /* Saved IP options */ 1022 #define PACKET_TAG_CARP 28 /* CARP info */ 1023 #define PACKET_TAG_IPSEC_NAT_T_PORTS 29 /* two uint16_t */ 1024 #define PACKET_TAG_ND_OUTGOING 30 /* ND outgoing */ 1025 1026 /* Specific cookies and tags. */ 1027 1028 /* Packet tag routines. */ 1029 struct m_tag *m_tag_alloc(u_int32_t, int, int, int); 1030 void m_tag_delete(struct mbuf *, struct m_tag *); 1031 void m_tag_delete_chain(struct mbuf *, struct m_tag *); 1032 void m_tag_free_default(struct m_tag *); 1033 struct m_tag *m_tag_locate(struct mbuf *, u_int32_t, int, struct m_tag *); 1034 struct m_tag *m_tag_copy(struct m_tag *, int); 1035 int m_tag_copy_chain(struct mbuf *, struct mbuf *, int); 1036 void m_tag_delete_nonpersistent(struct mbuf *); 1037 1038 /* 1039 * Initialize the list of tags associated with an mbuf. 1040 */ 1041 static __inline void 1042 m_tag_init(struct mbuf *m) 1043 { 1044 1045 SLIST_INIT(&m->m_pkthdr.tags); 1046 } 1047 1048 /* 1049 * Set up the contents of a tag. Note that this does not fill in the free 1050 * method; the caller is expected to do that. 1051 * 1052 * XXX probably should be called m_tag_init, but that was already taken. 1053 */ 1054 static __inline void 1055 m_tag_setup(struct m_tag *t, u_int32_t cookie, int type, int len) 1056 { 1057 1058 t->m_tag_id = type; 1059 t->m_tag_len = len; 1060 t->m_tag_cookie = cookie; 1061 } 1062 1063 /* 1064 * Reclaim resources associated with a tag. 1065 */ 1066 static __inline void 1067 m_tag_free(struct m_tag *t) 1068 { 1069 1070 (*t->m_tag_free)(t); 1071 } 1072 1073 /* 1074 * Return the first tag associated with an mbuf. 1075 */ 1076 static __inline struct m_tag * 1077 m_tag_first(struct mbuf *m) 1078 { 1079 1080 return (SLIST_FIRST(&m->m_pkthdr.tags)); 1081 } 1082 1083 /* 1084 * Return the next tag in the list of tags associated with an mbuf. 1085 */ 1086 static __inline struct m_tag * 1087 m_tag_next(struct mbuf *m, struct m_tag *t) 1088 { 1089 1090 return (SLIST_NEXT(t, m_tag_link)); 1091 } 1092 1093 /* 1094 * Prepend a tag to the list of tags associated with an mbuf. 1095 */ 1096 static __inline void 1097 m_tag_prepend(struct mbuf *m, struct m_tag *t) 1098 { 1099 1100 SLIST_INSERT_HEAD(&m->m_pkthdr.tags, t, m_tag_link); 1101 } 1102 1103 /* 1104 * Unlink a tag from the list of tags associated with an mbuf. 1105 */ 1106 static __inline void 1107 m_tag_unlink(struct mbuf *m, struct m_tag *t) 1108 { 1109 1110 SLIST_REMOVE(&m->m_pkthdr.tags, t, m_tag, m_tag_link); 1111 } 1112 1113 /* These are for OpenBSD compatibility. */ 1114 #define MTAG_ABI_COMPAT 0 /* compatibility ABI */ 1115 1116 static __inline struct m_tag * 1117 m_tag_get(int type, int length, int wait) 1118 { 1119 return (m_tag_alloc(MTAG_ABI_COMPAT, type, length, wait)); 1120 } 1121 1122 static __inline struct m_tag * 1123 m_tag_find(struct mbuf *m, int type, struct m_tag *start) 1124 { 1125 return (SLIST_EMPTY(&m->m_pkthdr.tags) ? (struct m_tag *)NULL : 1126 m_tag_locate(m, MTAG_ABI_COMPAT, type, start)); 1127 } 1128 1129 static __inline struct mbuf * 1130 m_free(struct mbuf *m) 1131 { 1132 struct mbuf *n = m->m_next; 1133 1134 if ((m->m_flags & (M_PKTHDR|M_NOFREE)) == (M_PKTHDR|M_NOFREE)) 1135 m_tag_delete_chain(m, NULL); 1136 if (m->m_flags & M_EXT) 1137 mb_free_ext(m); 1138 else if ((m->m_flags & M_NOFREE) == 0) 1139 uma_zfree(zone_mbuf, m); 1140 return (n); 1141 } 1142 1143 static int inline 1144 rt_m_getfib(struct mbuf *m) 1145 { 1146 KASSERT(m->m_flags & M_PKTHDR , ("Attempt to get FIB from non header mbuf.")); 1147 return (m->m_pkthdr.fibnum); 1148 } 1149 1150 #define M_GETFIB(_m) rt_m_getfib(_m) 1151 1152 #define M_SETFIB(_m, _fib) do { \ 1153 KASSERT((_m)->m_flags & M_PKTHDR, ("Attempt to set FIB on non header mbuf.")); \ 1154 ((_m)->m_pkthdr.fibnum) = (_fib); \ 1155 } while (0) 1156 1157 #endif /* _KERNEL */ 1158 1159 #ifdef MBUF_PROFILING 1160 void m_profile(struct mbuf *m); 1161 #define M_PROFILE(m) m_profile(m) 1162 #else 1163 #define M_PROFILE(m) 1164 #endif 1165 1166 1167 #endif /* !_SYS_MBUF_H_ */ 1168