1 /* 2 * Copyright (c) 2004 The DragonFly Project. All rights reserved. 3 * 4 * Copyright (c) 1982, 1986, 1988, 1993 5 * The Regents of the University of California. All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 3. Neither the name of the University nor the names of its contributors 16 * may be used to endorse or promote products derived from this software 17 * without specific prior written permission. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 22 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 29 * SUCH DAMAGE. 30 * 31 * @(#)mbuf.h 8.5 (Berkeley) 2/19/95 32 * $FreeBSD: src/sys/sys/mbuf.h,v 1.44.2.17 2003/04/15 06:15:02 silby Exp $ 33 */ 34 35 #ifndef _SYS_MBUF_H_ 36 #define _SYS_MBUF_H_ 37 38 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES) 39 40 #ifndef _SYS_TYPES_H_ 41 #include <sys/types.h> 42 #endif 43 #ifndef _SYS_PARAM_H_ 44 #include <sys/param.h> 45 #endif 46 #ifndef _SYS_QUEUE_H_ 47 #include <sys/queue.h> 48 #endif 49 #ifndef _NET_NETISR_H_ 50 #include <net/netisr.h> 51 #endif 52 #ifndef _NET_ETHERNET_H_ 53 #include <net/ethernet.h> 54 #endif 55 56 /* 57 * Mbufs are of a single size, MSIZE (machine/param.h), which 58 * includes overhead. An mbuf may add a single "mbuf cluster" of size 59 * MCLBYTES (also in machine/param.h), which has no additional overhead 60 * and is used instead of the internal data area; this is done when 61 * at least MINCLSIZE of data must be stored. 62 */ 63 #define MLEN (MSIZE - sizeof(struct m_hdr)) /* normal data len */ 64 #define MHLEN (MLEN - sizeof(struct pkthdr)) /* data len w/pkthdr */ 65 #define MINCLSIZE (MHLEN + 1) /* smallest amount to put in cluster */ 66 #define M_MAXCOMPRESS (MHLEN / 2) /* max amount to copy for compression */ 67 68 /* 69 * Macros for type conversion: 70 * mtod(m, t) -- Convert mbuf pointer to data pointer of correct type. 71 * mtodoff(m, t, off) -- Convert mbuf pointer at the specified offset to data 72 * pointer of correct type. 73 */ 74 #define mtod(m, t) ((t)((m)->m_data)) 75 #define mtodoff(m, t, off) ((t)((m)->m_data + (off))) 76 77 /* 78 * Header present at the beginning of every mbuf. 79 */ 80 struct m_hdr { 81 struct mbuf *mh_next; /* next buffer in chain */ 82 union { 83 struct mbuf *mh_nextpkt; /* next chain in queue/record */ 84 STAILQ_ENTRY(mbuf) mh_stailqpkt; 85 }; 86 caddr_t mh_data; /* location of data */ 87 int mh_len; /* amount of data in this mbuf */ 88 int mh_flags; /* flags; see below */ 89 short mh_type; /* type of data in this mbuf */ 90 short mh_pad; /* padding */ 91 /* XXX implicit 4 bytes padding on x86_64 */ 92 #ifdef MBUF_DEBUG 93 const char *mh_lastfunc; 94 #endif 95 union { 96 struct netmsg_packet mhm_pkt; /* hardware->proto stack msg */ 97 struct netmsg_pru_send mhm_snd; /* usrspace->proto stack msg */ 98 struct netmsg_inarp mhm_arp; /* proto stack arpinput msg */ 99 struct netmsg_ctlinput mhm_ctl; /* proto stack ctlinput msg */ 100 struct netmsg_genpkt mhm_gen; /* generic pkt send/recv msg */ 101 struct netmsg_forward mhm_fwd; /* forwarding msg */ 102 } mh_msgu; 103 }; 104 #define mh_netmsg mh_msgu.mhm_pkt 105 #define mh_sndmsg mh_msgu.mhm_snd 106 #define mh_arpmsg mh_msgu.mhm_arp 107 #define mh_ctlmsg mh_msgu.mhm_ctl 108 #define mh_genmsg mh_msgu.mhm_gen 109 #define mh_fwdmsg mh_msgu.mhm_fwd 110 111 /* pf stuff */ 112 struct pkthdr_pf { 113 void *hdr; /* saved hdr pos in mbuf, for ECN */ 114 void *statekey; /* pf stackside statekey */ 115 u_int rtableid; /* alternate routing table id */ 116 uint32_t qid; /* queue id */ 117 uint16_t tag; /* tag id */ 118 uint8_t flags; 119 uint8_t routed; 120 uint32_t state_hash; /* identifies 'connections' */ 121 uint8_t ecn_af; /* for altq_red */ 122 uint8_t unused01; 123 uint8_t unused02; 124 uint8_t unused03; 125 /* XXX implicit 4 bytes padding on x86_64 */ 126 }; 127 128 /* pkthdr_pf.flags */ 129 #define PF_TAG_GENERATED 0x01 130 #define PF_TAG_FRAGCACHE 0x02 131 #define PF_TAG_TRANSLATE_LOCALHOST 0x04 132 #define PF_TAG_DIVERTED 0x08 133 #define PF_TAG_DIVERTED_PACKET 0x10 134 #define PF_TAG_REROUTE 0x20 135 136 /* 137 * Packet tag structure (see below for details). 138 */ 139 struct m_tag { 140 SLIST_ENTRY(m_tag) m_tag_link; /* List of packet tags */ 141 uint16_t m_tag_id; /* Tag ID */ 142 uint16_t m_tag_len; /* Length of data */ 143 uint32_t m_tag_cookie; /* ABI/Module ID */ 144 }; 145 146 SLIST_HEAD(packet_tags, m_tag); 147 148 /* 149 * Record/packet header in first mbuf of chain; valid only if M_PKTHDR is set. 150 * 151 * Be careful: The fields have been carefully ordered to avoid hidden padding. 152 * Keep this in mind, when adding or removing fields! 153 */ 154 struct pkthdr { 155 struct ifnet *rcvif; /* rcv interface */ 156 struct packet_tags tags; /* list of packet tags */ 157 158 /* variables for ip and tcp reassembly */ 159 void *header; /* pointer to packet header */ 160 int len; /* total packet length */ 161 162 /* variables for hardware checksum */ 163 int csum_flags; /* flags regarding checksum */ 164 int csum_data; /* data field used by csum routines */ 165 uint16_t csum_iphlen; /* IP header length */ 166 /* valid if CSUM IP|UDP|TCP|TSO */ 167 uint8_t csum_thlen; /* TCP/UDP header length */ 168 /* valid if CSUM UDP|TCP|TSO */ 169 uint8_t csum_lhlen; /* link header length */ 170 171 uint16_t tso_segsz; /* TSO segment size */ 172 uint16_t ether_vlantag; /* ethernet 802.1p+q vlan tag */ 173 174 uint16_t hash; /* packet hash */ 175 uint16_t unused1; /* reserved for route table id */ 176 uint32_t unused2; /* reserved for codel timestamp */ 177 178 uint16_t wlan_seqno; /* IEEE 802.11 seq no. */ 179 /* 180 * Valid if BRIDGE_MBUF_TAGGED is set in fw_flags, records 181 * the original ether source address (if compatible). 182 */ 183 uint8_t ether_br_shost[ETHER_ADDR_LEN]; 184 185 /* firewall flags */ 186 uint32_t fw_flags; /* flags for FW */ 187 188 /* variables for PF processing */ 189 struct pkthdr_pf pf; /* structure for PF */ 190 }; 191 192 /* 193 * Description of external storage mapped into mbuf; valid only if M_EXT is set. 194 */ 195 struct m_ext { 196 caddr_t ext_buf; /* start of buffer */ 197 void (*ext_free)(void *); 198 u_int ext_size; /* size of buffer, for ext_free */ 199 void (*ext_ref)(void *); 200 void *ext_arg; 201 }; 202 203 /* 204 * The core of the mbuf object along with some shortcut defines for 205 * practical purposes. 206 */ 207 struct mbuf { 208 struct m_hdr m_hdr; 209 union { 210 struct { 211 struct pkthdr MH_pkthdr; /* M_PKTHDR set */ 212 union { 213 struct m_ext MH_ext; /* M_EXT set */ 214 char MH_databuf[MHLEN]; 215 } MH_dat; 216 } MH; 217 char M_databuf[MLEN]; /* !M_PKTHDR, !M_EXT */ 218 } M_dat; 219 }; 220 #define m_next m_hdr.mh_next 221 #define m_len m_hdr.mh_len 222 #define m_data m_hdr.mh_data 223 #define m_type m_hdr.mh_type 224 #define m_flags m_hdr.mh_flags 225 #define m_nextpkt m_hdr.mh_nextpkt 226 #define m_stailqpkt m_hdr.mh_stailqpkt 227 #define m_pkthdr M_dat.MH.MH_pkthdr 228 #define m_ext M_dat.MH.MH_dat.MH_ext 229 #define m_pktdat M_dat.MH.MH_dat.MH_databuf 230 #define m_dat M_dat.M_databuf 231 232 /* 233 * Code that uses m_act should be converted to use m_nextpkt 234 * instead; m_act is historical and deprecated. 235 */ 236 #define m_act m_nextpkt 237 238 /* 239 * mbuf flags. 240 */ 241 #define M_EXT 0x0001 /* has associated external storage */ 242 #define M_PKTHDR 0x0002 /* start of record */ 243 #define M_EOR 0x0004 /* end of record */ 244 #define M_PROTO1 0x0008 /* protocol-specific */ 245 #define M_PROTO2 0x0010 /* protocol-specific */ 246 #define M_PROTO3 0x0020 /* protocol-specific */ 247 #define M_PROTO4 0x0040 /* protocol-specific */ 248 #define M_PROTO5 0x0080 /* protocol-specific */ 249 250 /* 251 * mbuf pkthdr flags (also stored in m_flags). 252 */ 253 #define M_BCAST 0x0100 /* send/received as link-level broadcast */ 254 #define M_MCAST 0x0200 /* send/received as link-level multicast */ 255 #define M_FRAG 0x0400 /* packet is a fragment of a larger packet */ 256 #define M_FIRSTFRAG 0x0800 /* packet is first fragment */ 257 #define M_LASTFRAG 0x1000 /* packet is last fragment */ 258 #define M_CLCACHE 0x2000 /* mbuf allocated from the cluster cache */ 259 #define M_EXT_CLUSTER 0x4000 /* standard cluster else special */ 260 #define M_PHCACHE 0x8000 /* mbuf allocated from the pkt header cache */ 261 #define M_UNUSED16 0x10000 /* was: notification event (SCTP) */ 262 #define M_VLANTAG 0x20000 /* ether_vlantag is valid */ 263 #define M_MPLSLABELED 0x40000 /* packet is mpls labeled */ 264 #define M_LENCHECKED 0x80000 /* packet proto lengths are checked */ 265 #define M_HASH 0x100000/* hash field in pkthdr is valid */ 266 #define M_PROTO6 0x200000/* protocol-specific */ 267 #define M_PROTO7 0x400000/* protocol-specific */ 268 #define M_PROTO8 0x800000/* protocol-specific */ 269 #define M_CKHASH 0x1000000/* hash needs software verification */ 270 #define M_PRIO 0x2000000/* high priority mbuf */ 271 #define M_SOLOCKED 0x4000000/* locked by userland for read() */ 272 273 /* 274 * Flags copied when copying m_pkthdr. 275 */ 276 #define M_COPYFLAGS (M_PKTHDR|M_EOR|M_PROTO1|M_PROTO2|M_PROTO3 | \ 277 M_PROTO4|M_PROTO5|M_PROTO6|M_PROTO7|M_PROTO8 | \ 278 M_BCAST|M_MCAST|M_FRAG|M_FIRSTFRAG|M_LASTFRAG | \ 279 M_VLANTAG|M_MPLSLABELED | \ 280 M_LENCHECKED|M_HASH|M_CKHASH|M_PRIO) 281 282 /* 283 * Flags indicating hw checksum support and sw checksum requirements. 284 */ 285 #define CSUM_IP 0x0001 /* will csum IP */ 286 #define CSUM_TCP 0x0002 /* will csum TCP */ 287 #define CSUM_UDP 0x0004 /* will csum UDP */ 288 #define CSUM_IP_FRAGS 0x0008 /* will csum IP fragments */ 289 #define CSUM_FRAGMENT 0x0010 /* will do IP fragmentation */ 290 291 #define CSUM_IP_CHECKED 0x0100 /* did csum IP */ 292 #define CSUM_IP_VALID 0x0200 /* ... the csum is valid */ 293 #define CSUM_DATA_VALID 0x0400 /* csum_data field is valid */ 294 #define CSUM_PSEUDO_HDR 0x0800 /* csum_data has pseudo hdr */ 295 #define CSUM_FRAG_NOT_CHECKED 0x1000 /* did _not_ csum fragment 296 * NB: This flag is only used 297 * by IP defragmenter. 298 */ 299 #define CSUM_TSO 0x2000 /* will do TCP segmentation */ 300 301 #define CSUM_DELAY_DATA (CSUM_TCP | CSUM_UDP) 302 #define CSUM_DELAY_IP (CSUM_IP) /* XXX add ipv6 here too? */ 303 304 /* 305 * Flags indicating PF processing status 306 */ 307 #define FW_MBUF_GENERATED 0x00000001 308 #define PF_MBUF_STRUCTURE 0x00000002 /* m_pkthdr.pf valid */ 309 #define PF_MBUF_ROUTED 0x00000004 /* pf_routed field is valid */ 310 #define PF_MBUF_TAGGED 0x00000008 311 #define IPFW_MBUF_CONTINUE 0x00000010 312 #define XX_MBUF_UNUSED20 0x00000020 313 #define IPFORWARD_MBUF_TAGGED 0x00000040 314 #define DUMMYNET_MBUF_TAGGED 0x00000080 315 #define BRIDGE_MBUF_TAGGED 0x00000100 316 #define FW_MBUF_REDISPATCH 0x00000200 317 #define FW_MBUF_PRIVATE1 0x00000400 318 #define FW_MBUF_PRIVATE2 0x00000800 319 #define IPFW_MBUF_GENERATED FW_MBUF_GENERATED 320 321 /* 322 * mbuf types. 323 */ 324 #define MT_FREE 0 /* should be on free list */ 325 #define MT_DATA 1 /* dynamic (data) allocation */ 326 #define MT_HEADER 2 /* packet header */ 327 #define MT_SONAME 3 /* socket name */ 328 /* 4 was MT_TAG */ 329 #define MT_CONTROL 5 /* extra-data protocol message */ 330 #define MT_OOBDATA 6 /* expedited data */ 331 #define MT_NTYPES 7 /* number of mbuf types for mbtypes[] */ 332 333 /* 334 * General mbuf allocator statistics structure. 335 * 336 * NOTE: Make sure this struct's size is multiple cache line size. 337 */ 338 struct mbstat { 339 u_long m_mbufs; /* mbufs obtained from page pool */ 340 u_long m_clusters; /* clusters obtained from page pool */ 341 u_long m_jclusters; /* jclusters obtained from page pool */ 342 u_long m_clfree; /* free clusters */ 343 u_long m_drops; /* times failed to find space */ 344 u_long m_wait; /* times waited for space */ 345 u_long m_drain; /* times drained protocols for space */ 346 u_long m_mcfail; /* times m_copym failed */ 347 u_long m_mpfail; /* times m_pullup failed */ 348 u_long m_msize; /* length of an mbuf */ 349 u_long m_mclbytes; /* length of an mbuf cluster */ 350 u_long m_mjumpagesize; /* length of a jumbo mbuf cluster */ 351 u_long m_minclsize; /* min length of data to allocate a cluster */ 352 u_long m_mlen; /* length of data in an mbuf */ 353 u_long m_mhlen; /* length of data in a header mbuf */ 354 u_long m_pad; /* pad to cache line size (64B) */ 355 }; 356 357 /* 358 * objcache(9) ocflags sanitizing 359 */ 360 #define MB_OCFLAG(how) ((how) & M_WAITOK ? M_WAITOK : M_NOWAIT) 361 362 /* 363 * These are identifying numbers passed to the m_mballoc_wait function, 364 * allowing us to determine whether the call came from an MGETHDR or 365 * an MGET. 366 */ 367 #define MGETHDR_C 1 368 #define MGET_C 2 369 370 /* 371 * mbuf allocation/deallocation macros (YYY deprecated, too big): 372 * 373 * MGET(struct mbuf *m, int how, int type) 374 * allocates an mbuf and initializes it to contain internal data. 375 * 376 * MGETHDR(struct mbuf *m, int how, int type) 377 * allocates an mbuf and initializes it to contain a packet header 378 * and internal data. 379 */ 380 #define MGET(m, how, type) do { \ 381 (m) = m_get((how), (type)); \ 382 } while (0) 383 384 #define MGETHDR(m, how, type) do { \ 385 (m) = m_gethdr((how), (type)); \ 386 } while (0) 387 388 /* 389 * MCLGET adds such clusters to a normal mbuf. The flag M_EXT is set upon 390 * success. 391 * Deprecated. Use m_getcl() or m_getl() instead. 392 */ 393 #define MCLGET(m, how) do { \ 394 m_mclget((m), (how)); \ 395 } while (0) 396 397 /* 398 * NB: M_COPY_PKTHDR is deprecated; use either M_MOVE_PKTHDR 399 * or m_dup_pkthdr. 400 */ 401 /* 402 * Move mbuf pkthdr from "from" to "to". 403 * from should have M_PKTHDR set, and to must be empty. 404 * from no longer has a pkthdr after this operation. 405 */ 406 #define M_MOVE_PKTHDR(_to, _from) m_move_pkthdr((_to), (_from)) 407 408 /* 409 * Set the m_data pointer of a newly-allocated mbuf (m_get/MGET) to place 410 * an object of the specified size at the end of the mbuf, longword aligned. 411 */ 412 #define M_ALIGN(m, len) do { \ 413 (m)->m_data += rounddown2(MLEN - (len), sizeof(long)); \ 414 } while (0) 415 416 /* 417 * As above, for mbufs allocated with m_gethdr/MGETHDR 418 * or initialized by M_COPY_PKTHDR. 419 */ 420 #define MH_ALIGN(m, len) do { \ 421 (m)->m_data += rounddown2(MHLEN - (len), sizeof(long)); \ 422 } while (0) 423 424 /* 425 * Check if we can write to an mbuf. 426 */ 427 #define M_EXT_WRITABLE(m) (m_sharecount(m) == 1) 428 #define M_WRITABLE(m) (!((m)->m_flags & M_EXT) || M_EXT_WRITABLE(m)) 429 430 /* 431 * Check if the supplied mbuf has a packet header, or else panic. 432 */ 433 #define M_ASSERTPKTHDR(m) \ 434 KASSERT(m != NULL && m->m_flags & M_PKTHDR, \ 435 ("%s: invalid mbuf or no mbuf packet header!", __func__)) 436 437 /* 438 * Compute the amount of space available before the current start of data. 439 * The M_EXT_WRITABLE() is a temporary, conservative safety measure: the burden 440 * of checking writability of the mbuf data area rests solely with the caller. 441 */ 442 #define M_LEADINGSPACE(m) \ 443 ((m)->m_flags & M_EXT ? \ 444 (M_EXT_WRITABLE(m) ? (m)->m_data - (m)->m_ext.ext_buf : 0): \ 445 (m)->m_flags & M_PKTHDR ? (m)->m_data - (m)->m_pktdat : \ 446 (m)->m_data - (m)->m_dat) 447 448 /* 449 * Compute the amount of space available after the end of data in an mbuf. 450 * The M_WRITABLE() is a temporary, conservative safety measure: the burden 451 * of checking writability of the mbuf data area rests solely with the caller. 452 */ 453 #define M_TRAILINGSPACE(m) \ 454 ((m)->m_flags & M_EXT ? \ 455 (M_WRITABLE(m) ? (m)->m_ext.ext_buf + (m)->m_ext.ext_size \ 456 - ((m)->m_data + (m)->m_len) : 0) : \ 457 &(m)->m_dat[MLEN] - ((m)->m_data + (m)->m_len)) 458 459 /* 460 * Arrange to prepend space of size plen to mbuf m. 461 * If a new mbuf must be allocated, how specifies whether to wait. 462 * If how is M_NOWAIT and allocation fails, the original mbuf chain 463 * is freed and m is set to NULL. 464 */ 465 #define M_PREPEND(m, plen, how) do { \ 466 struct mbuf **_mmp = &(m); \ 467 struct mbuf *_mm = *_mmp; \ 468 int _mplen = (plen); \ 469 int __mhow = (how); \ 470 \ 471 if (M_LEADINGSPACE(_mm) >= _mplen) { \ 472 _mm->m_data -= _mplen; \ 473 _mm->m_len += _mplen; \ 474 } else \ 475 _mm = m_prepend(_mm, _mplen, __mhow); \ 476 if (_mm != NULL && (_mm->m_flags & M_PKTHDR)) \ 477 _mm->m_pkthdr.len += _mplen; \ 478 *_mmp = _mm; \ 479 } while (0) 480 481 /* Length to m_copy to copy all. */ 482 #define M_COPYALL 1000000000 483 484 /* Compatibility with 4.3 */ 485 #define m_copy(m, o, l) m_copym((m), (o), (l), M_NOWAIT) 486 487 #ifdef _KERNEL 488 extern u_int m_clalloc_wid; /* mbuf cluster wait count */ 489 extern u_int m_mballoc_wid; /* mbuf wait count */ 490 extern int max_linkhdr; /* largest link-level header */ 491 extern int max_protohdr; /* largest protocol header */ 492 extern int max_hdr; /* largest link+protocol header */ 493 extern int max_datalen; /* MHLEN - max_hdr */ 494 extern int mbuf_wait; /* mbuf sleep time */ 495 extern int nmbclusters; 496 extern int nmbufs; 497 498 struct uio; 499 500 void mcl_inclimit(int); 501 void mjcl_inclimit(int); 502 void mb_inclimit(int); 503 void m_adj(struct mbuf *, int); 504 void m_align(struct mbuf *, int); 505 int m_apply(struct mbuf *, int, int, 506 int (*)(void *, void *, u_int), void *); 507 int m_append(struct mbuf *, int, c_caddr_t); 508 void m_cat(struct mbuf *, struct mbuf *); 509 u_int m_countm(struct mbuf *m, struct mbuf **lastm, u_int *mbcnt); 510 void m_copyback(struct mbuf *, int, int, caddr_t); 511 void m_copydata(const struct mbuf *, int, int, caddr_t); 512 struct mbuf *m_copym(const struct mbuf *, int, int, int); 513 struct mbuf *m_copypacket(struct mbuf *, int); 514 struct mbuf *m_defrag(struct mbuf *, int); 515 struct mbuf *m_defrag_nofree(struct mbuf *, int); 516 struct mbuf *m_devget(char *, int, int, struct ifnet *); 517 struct mbuf *m_dup(struct mbuf *, int); 518 struct mbuf *m_dup_data(struct mbuf *, int); 519 int m_dup_pkthdr(struct mbuf *, const struct mbuf *, int); 520 void m_extadd(struct mbuf *, caddr_t, u_int, void (*)(void *), 521 void (*)(void *), void *); 522 #ifdef MBUF_DEBUG 523 struct mbuf *_m_free(struct mbuf *, const char *name); 524 void _m_freem(struct mbuf *, const char *name); 525 #else 526 struct mbuf *m_free(struct mbuf *); 527 void m_freem(struct mbuf *); 528 #endif 529 struct mbuf *m_get(int, int); 530 struct mbuf *m_getc(int len, int how, int type); 531 struct mbuf *m_getcl(int how, short type, int flags); 532 struct mbuf *m_getjcl(int how, short type, int flags, size_t size); 533 struct mbuf *m_getclr(int, int); 534 struct mbuf *m_gethdr(int, int); 535 struct mbuf *m_getm(struct mbuf *, int, int, int); 536 struct mbuf *m_getptr(struct mbuf *, int, int *); 537 struct mbuf *m_last(struct mbuf *m); 538 u_int m_lengthm(struct mbuf *m, struct mbuf **lastm); 539 void m_move_pkthdr(struct mbuf *, struct mbuf *); 540 struct mbuf *m_prepend(struct mbuf *, int, int); 541 void m_print(const struct mbuf *m); 542 struct mbuf *m_pulldown(struct mbuf *, int, int, int *); 543 struct mbuf *m_pullup(struct mbuf *, int); 544 struct mbuf *m_split(struct mbuf *, int, int); 545 struct mbuf *m_uiomove(struct uio *); 546 struct mbuf *m_unshare(struct mbuf *, int); 547 void m_mclget(struct mbuf *m, int how); 548 int m_sharecount(struct mbuf *m); 549 void m_chtype(struct mbuf *m, int type); 550 int m_devpad(struct mbuf *m, int padto); 551 552 #ifdef MBUF_DEBUG 553 554 void mbuftrackid(struct mbuf *, int); 555 556 #define m_free(m) _m_free(m, __func__) 557 #define m_freem(m) _m_freem(m, __func__) 558 559 #else 560 561 #define mbuftrackid(m, id) /* empty */ 562 563 #endif 564 565 static __inline void 566 m_sethash(struct mbuf *m, uint16_t hash) 567 { 568 m->m_flags |= M_HASH; 569 m->m_pkthdr.hash = hash; 570 } 571 572 /* 573 * Allocate the right type of mbuf for the desired total length. 574 * The mbuf returned does not necessarily cover the entire requested length. 575 * This function follows mbuf chaining policy of allowing MINCLSIZE 576 * amount of chained mbufs. 577 */ 578 static __inline struct mbuf * 579 m_getl(int len, int how, int type, int flags, int *psize) 580 { 581 struct mbuf *m; 582 int size; 583 584 if (len >= MINCLSIZE) { 585 m = m_getcl(how, type, flags); 586 size = MCLBYTES; 587 } else if (flags & M_PKTHDR) { 588 m = m_gethdr(how, type); 589 size = MHLEN; 590 } else { 591 m = m_get(how, type); 592 size = MLEN; 593 } 594 if (psize != NULL) 595 *psize = size; 596 return (m); 597 } 598 599 static __inline struct mbuf * 600 m_getlj(int len, int how, int type, int flags, int *psize) 601 { 602 if (len > MCLBYTES) { 603 struct mbuf *m; 604 605 m = m_getjcl(how, type, flags, MJUMPAGESIZE); 606 if (psize != NULL) 607 *psize = MJUMPAGESIZE; 608 return m; 609 } 610 return m_getl(len, how, type, flags, psize); 611 } 612 613 /* 614 * Get a single mbuf that covers the requested number of bytes. 615 * This function does not create mbuf chains. It explicitly marks 616 * places in the code that abuse mbufs for contiguous data buffers. 617 */ 618 static __inline struct mbuf * 619 m_getb(int len, int how, int type, int flags) 620 { 621 struct mbuf *m; 622 int mbufsize = (flags & M_PKTHDR) ? MHLEN : MLEN; 623 624 if (len > mbufsize) 625 m = m_getcl(how, type, flags); 626 else if (flags & M_PKTHDR) 627 m = m_gethdr(how, type); 628 else 629 m = m_get(how, type); 630 return (m); 631 } 632 633 /* 634 * Packets may have annotations attached by affixing a list 635 * of "packet tags" to the pkthdr structure. Packet tags are 636 * dynamically allocated semi-opaque data structures that have 637 * a fixed header (struct m_tag) that specifies the size of the 638 * memory block and a <cookie,type> pair that identifies it. 639 * The cookie is a 32-bit unique unsigned value used to identify 640 * a module or ABI. By convention this value is chose as the 641 * date+time that the module is created, expressed as the number of 642 * seconds since the epoch (e.g. using date -u +'%s'). The type value 643 * is an ABI/module-specific value that identifies a particular annotation 644 * and is private to the module. For compatibility with systems 645 * like openbsd that define packet tags w/o an ABI/module cookie, 646 * the value PACKET_ABI_COMPAT is used to implement m_tag_get and 647 * m_tag_find compatibility shim functions and several tag types are 648 * defined below. Users that do not require compatibility should use 649 * a private cookie value so that packet tag-related definitions 650 * can be maintained privately. 651 * 652 * Note that the packet tag returned by m_tag_alloc has the default 653 * memory alignment implemented by kmalloc. To reference private data 654 * one can use a construct like: 655 * 656 * struct m_tag *mtag = m_tag_alloc(...); 657 * struct foo *p = m_tag_data(mtag); 658 * 659 * if the alignment of struct m_tag is sufficient for referencing members 660 * of struct foo. Otherwise it is necessary to embed struct m_tag within 661 * the private data structure to insure proper alignment; e.g. 662 * 663 * struct foo { 664 * struct m_tag tag; 665 * ... 666 * }; 667 * struct foo *p = (struct foo *)m_tag_alloc(...); 668 * struct m_tag *mtag = &p->tag; 669 */ 670 671 #define PACKET_TAG_NONE 0 /* Nadda */ 672 673 #define PACKET_TAG_ENCAP 6 /* Encap. processing */ 674 /* struct ifnet *, the GIF interface */ 675 #define PACKET_TAG_IPV6_INPUT 8 /* IPV6 input processing */ 676 /* struct ip6aux */ 677 #define PACKET_TAG_IPFW_DIVERT 9 /* divert info */ 678 /* struct divert_info */ 679 #define PACKET_TAG_DUMMYNET 15 /* dummynet info */ 680 /* struct dn_pkt */ 681 #define PACKET_TAG_IPFORWARD 18 /* ipforward info */ 682 /* struct sockaddr_in */ 683 #define PACKET_TAG_IPSRCRT 27 /* IP srcrt opts */ 684 /* struct ip_srcrt_opt */ 685 #define PACKET_TAG_CARP 28 /* CARP info */ 686 /* struct ifnet */ 687 #define PACKET_TAG_PF 29 /* PF info */ 688 /* struct pf_mtag */ 689 690 #define PACKET_TAG_PF_DIVERT 0x0200 /* pf(4) diverted packet */ 691 692 693 /* Packet tag routines */ 694 struct m_tag *m_tag_alloc(uint32_t, int, int, int); 695 void m_tag_free(struct m_tag *); 696 void m_tag_prepend(struct mbuf *, struct m_tag *); 697 void m_tag_unlink(struct mbuf *, struct m_tag *); 698 void m_tag_delete(struct mbuf *, struct m_tag *); 699 void m_tag_delete_chain(struct mbuf *); 700 struct m_tag *m_tag_locate(struct mbuf *, uint32_t, int, struct m_tag *); 701 struct m_tag *m_tag_copy(struct m_tag *, int); 702 int m_tag_copy_chain(struct mbuf *, const struct mbuf *, int); 703 void m_tag_init(struct mbuf *); 704 struct m_tag *m_tag_first(struct mbuf *); 705 struct m_tag *m_tag_next(struct mbuf *, struct m_tag *); 706 707 /* these are for openbsd compatibility */ 708 #define MTAG_ABI_COMPAT 0 /* compatibility ABI */ 709 710 static __inline void * 711 m_tag_data(struct m_tag *tag) 712 { 713 return ((void *)(tag + 1)); 714 } 715 716 static __inline struct m_tag * 717 m_tag_get(int type, int length, int mflags) 718 { 719 return m_tag_alloc(MTAG_ABI_COMPAT, type, length, mflags); 720 } 721 722 static __inline struct m_tag * 723 m_tag_find(struct mbuf *m, int type, struct m_tag *start) 724 { 725 return m_tag_locate(m, MTAG_ABI_COMPAT, type, start); 726 } 727 728 struct mbufq { 729 STAILQ_HEAD(, mbuf) mq_head; 730 int mq_len; 731 int mq_maxlen; 732 }; 733 734 static inline void 735 mbufq_init(struct mbufq *mq, int maxlen) 736 { 737 738 STAILQ_INIT(&mq->mq_head); 739 mq->mq_maxlen = maxlen; 740 mq->mq_len = 0; 741 } 742 743 static inline struct mbuf * 744 mbufq_flush(struct mbufq *mq) 745 { 746 struct mbuf *m; 747 748 m = STAILQ_FIRST(&mq->mq_head); 749 STAILQ_INIT(&mq->mq_head); 750 mq->mq_len = 0; 751 return (m); 752 } 753 754 static inline void 755 mbufq_drain(struct mbufq *mq) 756 { 757 struct mbuf *m, *n; 758 759 n = mbufq_flush(mq); 760 while ((m = n) != NULL) { 761 n = STAILQ_NEXT(m, m_stailqpkt); 762 m_freem(m); 763 } 764 } 765 766 static inline struct mbuf * 767 mbufq_first(const struct mbufq *mq) 768 { 769 770 return (STAILQ_FIRST(&mq->mq_head)); 771 } 772 773 static inline struct mbuf * 774 mbufq_last(const struct mbufq *mq) 775 { 776 777 return (STAILQ_LAST(&mq->mq_head, mbuf, m_stailqpkt)); 778 } 779 780 static inline int 781 mbufq_full(const struct mbufq *mq) 782 { 783 784 return (mq->mq_len >= mq->mq_maxlen); 785 } 786 787 static inline int 788 mbufq_len(const struct mbufq *mq) 789 { 790 791 return (mq->mq_len); 792 } 793 794 static inline int 795 mbufq_enqueue(struct mbufq *mq, struct mbuf *m) 796 { 797 798 if (mbufq_full(mq)) 799 return (ENOBUFS); 800 STAILQ_INSERT_TAIL(&mq->mq_head, m, m_stailqpkt); 801 mq->mq_len++; 802 return (0); 803 } 804 805 static inline struct mbuf * 806 mbufq_dequeue(struct mbufq *mq) 807 { 808 struct mbuf *m; 809 810 m = STAILQ_FIRST(&mq->mq_head); 811 if (m) { 812 STAILQ_REMOVE_HEAD(&mq->mq_head, m_stailqpkt); 813 m->m_nextpkt = NULL; 814 mq->mq_len--; 815 } 816 return (m); 817 } 818 819 static inline void 820 mbufq_prepend(struct mbufq *mq, struct mbuf *m) 821 { 822 823 STAILQ_INSERT_HEAD(&mq->mq_head, m, m_stailqpkt); 824 mq->mq_len++; 825 } 826 827 #endif /* _KERNEL */ 828 829 #endif /* _KERNEL || _KERNEL_STRUCTURES */ 830 #endif /* !_SYS_MBUF_H_ */ 831