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 struct mbuf *mh_nextpkt; /* next chain in queue/record */ 83 caddr_t mh_data; /* location of data */ 84 int mh_len; /* amount of data in this mbuf */ 85 int mh_flags; /* flags; see below */ 86 short mh_type; /* type of data in this mbuf */ 87 short mh_pad; /* padding */ 88 /* XXX implicit 4 bytes padding on x86_64 */ 89 #ifdef MBUF_DEBUG 90 const char *mh_lastfunc; 91 #endif 92 union { 93 struct netmsg_packet mhm_pkt; /* hardware->proto stack msg */ 94 struct netmsg_pru_send mhm_snd; /* usrspace->proto stack msg */ 95 struct netmsg_inarp mhm_arp; /* proto stack arpinput msg */ 96 struct netmsg_ctlinput mhm_ctl; /* proto stack ctlinput msg */ 97 } mh_msgu; 98 }; 99 #define mh_netmsg mh_msgu.mhm_pkt 100 #define mh_sndmsg mh_msgu.mhm_snd 101 #define mh_arpmsg mh_msgu.mhm_arp 102 #define mh_ctlmsg mh_msgu.mhm_ctl 103 104 /* pf stuff */ 105 struct pkthdr_pf { 106 void *hdr; /* saved hdr pos in mbuf, for ECN */ 107 void *statekey; /* pf stackside statekey */ 108 u_int rtableid; /* alternate routing table id */ 109 uint32_t qid; /* queue id */ 110 uint16_t tag; /* tag id */ 111 uint8_t flags; 112 uint8_t routed; 113 uint32_t state_hash; /* identifies 'connections' */ 114 uint8_t ecn_af; /* for altq_red */ 115 uint8_t unused01; 116 uint8_t unused02; 117 uint8_t unused03; 118 /* XXX implicit 4 bytes padding on x86_64 */ 119 }; 120 121 /* pkthdr_pf.flags */ 122 #define PF_TAG_GENERATED 0x01 123 #define PF_TAG_FRAGCACHE 0x02 124 #define PF_TAG_TRANSLATE_LOCALHOST 0x04 125 #define PF_TAG_DIVERTED 0x08 126 #define PF_TAG_DIVERTED_PACKET 0x10 127 #define PF_TAG_REROUTE 0x20 128 129 /* 130 * Packet tag structure (see below for details). 131 */ 132 struct m_tag { 133 SLIST_ENTRY(m_tag) m_tag_link; /* List of packet tags */ 134 uint16_t m_tag_id; /* Tag ID */ 135 uint16_t m_tag_len; /* Length of data */ 136 uint32_t m_tag_cookie; /* ABI/Module ID */ 137 }; 138 139 SLIST_HEAD(packet_tags, m_tag); 140 141 /* 142 * Record/packet header in first mbuf of chain; valid only if M_PKTHDR is set. 143 * 144 * Be careful: The fields have been carefully ordered to avoid hidden padding. 145 * Keep this in mind, when adding or removing fields! 146 */ 147 struct pkthdr { 148 struct ifnet *rcvif; /* rcv interface */ 149 struct packet_tags tags; /* list of packet tags */ 150 151 /* variables for ip and tcp reassembly */ 152 void *header; /* pointer to packet header */ 153 int len; /* total packet length */ 154 155 /* variables for hardware checksum */ 156 int csum_flags; /* flags regarding checksum */ 157 int csum_data; /* data field used by csum routines */ 158 uint16_t csum_iphlen; /* IP header length */ 159 /* valid if CSUM IP|UDP|TCP|TSO */ 160 uint8_t csum_thlen; /* TCP/UDP header length */ 161 /* valid if CSUM UDP|TCP|TSO */ 162 uint8_t csum_lhlen; /* link header length */ 163 164 uint16_t tso_segsz; /* TSO segment size */ 165 uint16_t ether_vlantag; /* ethernet 802.1p+q vlan tag */ 166 167 uint16_t hash; /* packet hash */ 168 uint16_t unused1; /* reserved for route table id */ 169 uint32_t unused2; /* reserved for codel timestamp */ 170 171 uint16_t wlan_seqno; /* IEEE 802.11 seq no. */ 172 /* 173 * Valid if BRIDGE_MBUF_TAGGED is set in fw_flags, records 174 * the original ether source address (if compatible). 175 */ 176 uint8_t ether_br_shost[ETHER_ADDR_LEN]; 177 178 /* firewall flags */ 179 uint32_t fw_flags; /* flags for FW */ 180 181 /* variables for PF processing */ 182 struct pkthdr_pf pf; /* structure for PF */ 183 }; 184 185 /* 186 * Description of external storage mapped into mbuf; valid only if M_EXT is set. 187 */ 188 struct m_ext { 189 caddr_t ext_buf; /* start of buffer */ 190 void (*ext_free)(void *); 191 u_int ext_size; /* size of buffer, for ext_free */ 192 void (*ext_ref)(void *); 193 void *ext_arg; 194 }; 195 196 /* 197 * The core of the mbuf object along with some shortcut defines for 198 * practical purposes. 199 */ 200 struct mbuf { 201 struct m_hdr m_hdr; 202 union { 203 struct { 204 struct pkthdr MH_pkthdr; /* M_PKTHDR set */ 205 union { 206 struct m_ext MH_ext; /* M_EXT set */ 207 char MH_databuf[MHLEN]; 208 } MH_dat; 209 } MH; 210 char M_databuf[MLEN]; /* !M_PKTHDR, !M_EXT */ 211 } M_dat; 212 }; 213 #define m_next m_hdr.mh_next 214 #define m_len m_hdr.mh_len 215 #define m_data m_hdr.mh_data 216 #define m_type m_hdr.mh_type 217 #define m_flags m_hdr.mh_flags 218 #define m_nextpkt m_hdr.mh_nextpkt 219 #define m_pkthdr M_dat.MH.MH_pkthdr 220 #define m_ext M_dat.MH.MH_dat.MH_ext 221 #define m_pktdat M_dat.MH.MH_dat.MH_databuf 222 #define m_dat M_dat.M_databuf 223 224 /* 225 * Code that uses m_act should be converted to use m_nextpkt 226 * instead; m_act is historical and deprecated. 227 */ 228 #define m_act m_nextpkt 229 230 /* 231 * mbuf flags. 232 */ 233 #define M_EXT 0x0001 /* has associated external storage */ 234 #define M_PKTHDR 0x0002 /* start of record */ 235 #define M_EOR 0x0004 /* end of record */ 236 #define M_PROTO1 0x0008 /* protocol-specific */ 237 #define M_PROTO2 0x0010 /* protocol-specific */ 238 #define M_PROTO3 0x0020 /* protocol-specific */ 239 #define M_PROTO4 0x0040 /* protocol-specific */ 240 #define M_PROTO5 0x0080 /* protocol-specific */ 241 242 /* 243 * mbuf pkthdr flags (also stored in m_flags). 244 */ 245 #define M_BCAST 0x0100 /* send/received as link-level broadcast */ 246 #define M_MCAST 0x0200 /* send/received as link-level multicast */ 247 #define M_FRAG 0x0400 /* packet is a fragment of a larger packet */ 248 #define M_FIRSTFRAG 0x0800 /* packet is first fragment */ 249 #define M_LASTFRAG 0x1000 /* packet is last fragment */ 250 #define M_CLCACHE 0x2000 /* mbuf allocated from the cluster cache */ 251 #define M_EXT_CLUSTER 0x4000 /* standard cluster else special */ 252 #define M_PHCACHE 0x8000 /* mbuf allocated from the pkt header cache */ 253 #define M_UNUSED16 0x10000 /* was: notification event (SCTP) */ 254 #define M_VLANTAG 0x20000 /* ether_vlantag is valid */ 255 #define M_MPLSLABELED 0x40000 /* packet is mpls labeled */ 256 #define M_LENCHECKED 0x80000 /* packet proto lengths are checked */ 257 #define M_HASH 0x100000/* hash field in pkthdr is valid */ 258 #define M_PROTO6 0x200000/* protocol-specific */ 259 #define M_PROTO7 0x400000/* protocol-specific */ 260 #define M_PROTO8 0x800000/* protocol-specific */ 261 #define M_CKHASH 0x1000000/* hash needs software verification */ 262 #define M_PRIO 0x2000000/* high priority mbuf */ 263 #define M_SOLOCKED 0x4000000/* locked by userland for read() */ 264 265 /* 266 * Flags copied when copying m_pkthdr. 267 */ 268 #define M_COPYFLAGS (M_PKTHDR|M_EOR|M_PROTO1|M_PROTO2|M_PROTO3 | \ 269 M_PROTO4|M_PROTO5|M_PROTO6|M_PROTO7|M_PROTO8 | \ 270 M_BCAST|M_MCAST|M_FRAG|M_FIRSTFRAG|M_LASTFRAG | \ 271 M_VLANTAG|M_MPLSLABELED | \ 272 M_LENCHECKED|M_HASH|M_CKHASH|M_PRIO) 273 274 /* 275 * Flags indicating hw checksum support and sw checksum requirements. 276 */ 277 #define CSUM_IP 0x0001 /* will csum IP */ 278 #define CSUM_TCP 0x0002 /* will csum TCP */ 279 #define CSUM_UDP 0x0004 /* will csum UDP */ 280 #define CSUM_IP_FRAGS 0x0008 /* will csum IP fragments */ 281 #define CSUM_FRAGMENT 0x0010 /* will do IP fragmentation */ 282 283 #define CSUM_IP_CHECKED 0x0100 /* did csum IP */ 284 #define CSUM_IP_VALID 0x0200 /* ... the csum is valid */ 285 #define CSUM_DATA_VALID 0x0400 /* csum_data field is valid */ 286 #define CSUM_PSEUDO_HDR 0x0800 /* csum_data has pseudo hdr */ 287 #define CSUM_FRAG_NOT_CHECKED 0x1000 /* did _not_ csum fragment 288 * NB: This flag is only used 289 * by IP defragmenter. 290 */ 291 #define CSUM_TSO 0x2000 /* will do TCP segmentation */ 292 293 #define CSUM_DELAY_DATA (CSUM_TCP | CSUM_UDP) 294 #define CSUM_DELAY_IP (CSUM_IP) /* XXX add ipv6 here too? */ 295 296 /* 297 * Flags indicating PF processing status 298 */ 299 #define FW_MBUF_GENERATED 0x00000001 300 #define PF_MBUF_STRUCTURE 0x00000002 /* m_pkthdr.pf valid */ 301 #define PF_MBUF_ROUTED 0x00000004 /* pf_routed field is valid */ 302 #define PF_MBUF_TAGGED 0x00000008 303 #define XX_MBUF_UNUSED10 0x00000010 304 #define XX_MBUF_UNUSED20 0x00000020 305 #define IPFORWARD_MBUF_TAGGED 0x00000040 306 #define DUMMYNET_MBUF_TAGGED 0x00000080 307 #define BRIDGE_MBUF_TAGGED 0x00000100 308 #define FW_MBUF_REDISPATCH 0x00000200 309 #define IPFW_MBUF_GENERATED FW_MBUF_GENERATED 310 /* 311 * mbuf types. 312 */ 313 #define MT_FREE 0 /* should be on free list */ 314 #define MT_DATA 1 /* dynamic (data) allocation */ 315 #define MT_HEADER 2 /* packet header */ 316 #define MT_SONAME 3 /* socket name */ 317 /* 4 was MT_TAG */ 318 #define MT_CONTROL 5 /* extra-data protocol message */ 319 #define MT_OOBDATA 6 /* expedited data */ 320 #define MT_NTYPES 7 /* number of mbuf types for mbtypes[] */ 321 322 /* 323 * General mbuf allocator statistics structure. 324 * 325 * NOTE: Make sure this struct's size is multiple cache line size. 326 */ 327 struct mbstat { 328 u_long m_mbufs; /* mbufs obtained from page pool */ 329 u_long m_clusters; /* clusters obtained from page pool */ 330 u_long m_jclusters; /* jclusters obtained from page pool */ 331 u_long m_clfree; /* free clusters */ 332 u_long m_drops; /* times failed to find space */ 333 u_long m_wait; /* times waited for space */ 334 u_long m_drain; /* times drained protocols for space */ 335 u_long m_mcfail; /* times m_copym failed */ 336 u_long m_mpfail; /* times m_pullup failed */ 337 u_long m_msize; /* length of an mbuf */ 338 u_long m_mclbytes; /* length of an mbuf cluster */ 339 u_long m_mjumpagesize; /* length of a jumbo mbuf cluster */ 340 u_long m_minclsize; /* min length of data to allocate a cluster */ 341 u_long m_mlen; /* length of data in an mbuf */ 342 u_long m_mhlen; /* length of data in a header mbuf */ 343 u_long m_pad; /* pad to cache line size (64B) */ 344 }; 345 346 /* 347 * objcache(9) ocflags sanitizing 348 */ 349 #define MB_OCFLAG(how) ((how) & M_WAITOK ? M_WAITOK : M_NOWAIT) 350 351 /* 352 * These are identifying numbers passed to the m_mballoc_wait function, 353 * allowing us to determine whether the call came from an MGETHDR or 354 * an MGET. 355 */ 356 #define MGETHDR_C 1 357 #define MGET_C 2 358 359 /* 360 * mbuf allocation/deallocation macros (YYY deprecated, too big): 361 * 362 * MGET(struct mbuf *m, int how, int type) 363 * allocates an mbuf and initializes it to contain internal data. 364 * 365 * MGETHDR(struct mbuf *m, int how, int type) 366 * allocates an mbuf and initializes it to contain a packet header 367 * and internal data. 368 */ 369 #define MGET(m, how, type) do { \ 370 (m) = m_get((how), (type)); \ 371 } while (0) 372 373 #define MGETHDR(m, how, type) do { \ 374 (m) = m_gethdr((how), (type)); \ 375 } while (0) 376 377 /* 378 * MCLGET adds such clusters to a normal mbuf. The flag M_EXT is set upon 379 * success. 380 * Deprecated. Use m_getcl() or m_getl() instead. 381 */ 382 #define MCLGET(m, how) do { \ 383 m_mclget((m), (how)); \ 384 } while (0) 385 386 /* 387 * NB: M_COPY_PKTHDR is deprecated; use either M_MOVE_PKTHDR 388 * or m_dup_pkthdr. 389 */ 390 /* 391 * Move mbuf pkthdr from "from" to "to". 392 * from should have M_PKTHDR set, and to must be empty. 393 * from no longer has a pkthdr after this operation. 394 */ 395 #define M_MOVE_PKTHDR(_to, _from) m_move_pkthdr((_to), (_from)) 396 397 /* 398 * Set the m_data pointer of a newly-allocated mbuf (m_get/MGET) to place 399 * an object of the specified size at the end of the mbuf, longword aligned. 400 */ 401 #define M_ALIGN(m, len) do { \ 402 (m)->m_data += (MLEN - (len)) & ~(sizeof(long) - 1); \ 403 } while (0) 404 405 /* 406 * As above, for mbufs allocated with m_gethdr/MGETHDR 407 * or initialized by M_COPY_PKTHDR. 408 */ 409 #define MH_ALIGN(m, len) do { \ 410 (m)->m_data += (MHLEN - (len)) & ~(sizeof(long) - 1); \ 411 } while (0) 412 413 /* 414 * Check if we can write to an mbuf. 415 */ 416 #define M_EXT_WRITABLE(m) (m_sharecount(m) == 1) 417 #define M_WRITABLE(m) (!((m)->m_flags & M_EXT) || M_EXT_WRITABLE(m)) 418 419 /* 420 * Check if the supplied mbuf has a packet header, or else panic. 421 */ 422 #define M_ASSERTPKTHDR(m) \ 423 KASSERT(m != NULL && m->m_flags & M_PKTHDR, \ 424 ("%s: invalid mbuf or no mbuf packet header!", __func__)) 425 426 /* 427 * Compute the amount of space available before the current start of data. 428 * The M_EXT_WRITABLE() is a temporary, conservative safety measure: the burden 429 * of checking writability of the mbuf data area rests solely with the caller. 430 */ 431 #define M_LEADINGSPACE(m) \ 432 ((m)->m_flags & M_EXT ? \ 433 (M_EXT_WRITABLE(m) ? (m)->m_data - (m)->m_ext.ext_buf : 0): \ 434 (m)->m_flags & M_PKTHDR ? (m)->m_data - (m)->m_pktdat : \ 435 (m)->m_data - (m)->m_dat) 436 437 /* 438 * Compute the amount of space available after the end of data in an mbuf. 439 * The M_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_TRAILINGSPACE(m) \ 443 ((m)->m_flags & M_EXT ? \ 444 (M_WRITABLE(m) ? (m)->m_ext.ext_buf + (m)->m_ext.ext_size \ 445 - ((m)->m_data + (m)->m_len) : 0) : \ 446 &(m)->m_dat[MLEN] - ((m)->m_data + (m)->m_len)) 447 448 /* 449 * Arrange to prepend space of size plen to mbuf m. 450 * If a new mbuf must be allocated, how specifies whether to wait. 451 * If how is M_NOWAIT and allocation fails, the original mbuf chain 452 * is freed and m is set to NULL. 453 */ 454 #define M_PREPEND(m, plen, how) do { \ 455 struct mbuf **_mmp = &(m); \ 456 struct mbuf *_mm = *_mmp; \ 457 int _mplen = (plen); \ 458 int __mhow = (how); \ 459 \ 460 if (M_LEADINGSPACE(_mm) >= _mplen) { \ 461 _mm->m_data -= _mplen; \ 462 _mm->m_len += _mplen; \ 463 } else \ 464 _mm = m_prepend(_mm, _mplen, __mhow); \ 465 if (_mm != NULL && (_mm->m_flags & M_PKTHDR)) \ 466 _mm->m_pkthdr.len += _mplen; \ 467 *_mmp = _mm; \ 468 } while (0) 469 470 /* Length to m_copy to copy all. */ 471 #define M_COPYALL 1000000000 472 473 /* Compatibility with 4.3 */ 474 #define m_copy(m, o, l) m_copym((m), (o), (l), M_NOWAIT) 475 476 #ifdef _KERNEL 477 extern u_int m_clalloc_wid; /* mbuf cluster wait count */ 478 extern u_int m_mballoc_wid; /* mbuf wait count */ 479 extern int max_linkhdr; /* largest link-level header */ 480 extern int max_protohdr; /* largest protocol header */ 481 extern int max_hdr; /* largest link+protocol header */ 482 extern int max_datalen; /* MHLEN - max_hdr */ 483 extern int mbuf_wait; /* mbuf sleep time */ 484 extern int nmbclusters; 485 extern int nmbufs; 486 487 struct uio; 488 489 void mcl_inclimit(int); 490 void mjcl_inclimit(int); 491 void mb_inclimit(int); 492 void m_adj(struct mbuf *, int); 493 void m_align(struct mbuf *, int); 494 int m_apply(struct mbuf *, int, int, 495 int (*)(void *, void *, u_int), void *); 496 int m_append(struct mbuf *, int, c_caddr_t); 497 void m_cat(struct mbuf *, struct mbuf *); 498 u_int m_countm(struct mbuf *m, struct mbuf **lastm, u_int *mbcnt); 499 void m_copyback(struct mbuf *, int, int, caddr_t); 500 void m_copydata(const struct mbuf *, int, int, caddr_t); 501 struct mbuf *m_copym(const struct mbuf *, int, int, int); 502 struct mbuf *m_copypacket(struct mbuf *, int); 503 struct mbuf *m_defrag(struct mbuf *, int); 504 struct mbuf *m_defrag_nofree(struct mbuf *, int); 505 struct mbuf *m_devget(char *, int, int, struct ifnet *, 506 void (*copy)(volatile const void *, volatile void *, size_t)); 507 struct mbuf *m_dup(struct mbuf *, int); 508 struct mbuf *m_dup_data(struct mbuf *, int); 509 int m_dup_pkthdr(struct mbuf *, const struct mbuf *, int); 510 void m_extadd(struct mbuf *, caddr_t, u_int, void (*)(void *), 511 void (*)(void *), void *); 512 #ifdef MBUF_DEBUG 513 struct mbuf *_m_free(struct mbuf *, const char *name); 514 void _m_freem(struct mbuf *, const char *name); 515 #else 516 struct mbuf *m_free(struct mbuf *); 517 void m_freem(struct mbuf *); 518 #endif 519 struct mbuf *m_get(int, int); 520 struct mbuf *m_getc(int len, int how, int type); 521 struct mbuf *m_getcl(int how, short type, int flags); 522 struct mbuf *m_getjcl(int how, short type, int flags, size_t size); 523 struct mbuf *m_getclr(int, int); 524 struct mbuf *m_gethdr(int, int); 525 struct mbuf *m_getm(struct mbuf *, int, int, int); 526 struct mbuf *m_getptr(struct mbuf *, int, int *); 527 struct mbuf *m_last(struct mbuf *m); 528 u_int m_lengthm(struct mbuf *m, struct mbuf **lastm); 529 void m_move_pkthdr(struct mbuf *, struct mbuf *); 530 struct mbuf *m_prepend(struct mbuf *, int, int); 531 void m_print(const struct mbuf *m); 532 struct mbuf *m_pulldown(struct mbuf *, int, int, int *); 533 struct mbuf *m_pullup(struct mbuf *, int); 534 struct mbuf *m_split(struct mbuf *, int, int); 535 struct mbuf *m_uiomove(struct uio *); 536 struct mbuf *m_unshare(struct mbuf *, int); 537 void m_mclget(struct mbuf *m, int how); 538 int m_sharecount(struct mbuf *m); 539 void m_chtype(struct mbuf *m, int type); 540 int m_devpad(struct mbuf *m, int padto); 541 542 #ifdef MBUF_DEBUG 543 544 void mbuftrackid(struct mbuf *, int); 545 546 #define m_free(m) _m_free(m, __func__) 547 #define m_freem(m) _m_freem(m, __func__) 548 549 #else 550 551 #define mbuftrackid(m, id) /* empty */ 552 553 #endif 554 555 /* 556 * Allocate the right type of mbuf for the desired total length. 557 * The mbuf returned does not necessarily cover the entire requested length. 558 * This function follows mbuf chaining policy of allowing MINCLSIZE 559 * amount of chained mbufs. 560 */ 561 static __inline struct mbuf * 562 m_getl(int len, int how, int type, int flags, int *psize) 563 { 564 struct mbuf *m; 565 int size; 566 567 if (len >= MINCLSIZE) { 568 m = m_getcl(how, type, flags); 569 size = MCLBYTES; 570 } else if (flags & M_PKTHDR) { 571 m = m_gethdr(how, type); 572 size = MHLEN; 573 } else { 574 m = m_get(how, type); 575 size = MLEN; 576 } 577 if (psize != NULL) 578 *psize = size; 579 return (m); 580 } 581 582 static __inline struct mbuf * 583 m_getlj(int len, int how, int type, int flags, int *psize) 584 { 585 if (len > MCLBYTES) { 586 struct mbuf *m; 587 588 m = m_getjcl(how, type, flags, MJUMPAGESIZE); 589 if (psize != NULL) 590 *psize = MJUMPAGESIZE; 591 return m; 592 } 593 return m_getl(len, how, type, flags, psize); 594 } 595 596 /* 597 * Get a single mbuf that covers the requested number of bytes. 598 * This function does not create mbuf chains. It explicitly marks 599 * places in the code that abuse mbufs for contiguous data buffers. 600 */ 601 static __inline struct mbuf * 602 m_getb(int len, int how, int type, int flags) 603 { 604 struct mbuf *m; 605 int mbufsize = (flags & M_PKTHDR) ? MHLEN : MLEN; 606 607 if (len > mbufsize) 608 m = m_getcl(how, type, flags); 609 else if (flags & M_PKTHDR) 610 m = m_gethdr(how, type); 611 else 612 m = m_get(how, type); 613 return (m); 614 } 615 616 /* 617 * Packets may have annotations attached by affixing a list 618 * of "packet tags" to the pkthdr structure. Packet tags are 619 * dynamically allocated semi-opaque data structures that have 620 * a fixed header (struct m_tag) that specifies the size of the 621 * memory block and a <cookie,type> pair that identifies it. 622 * The cookie is a 32-bit unique unsigned value used to identify 623 * a module or ABI. By convention this value is chose as the 624 * date+time that the module is created, expressed as the number of 625 * seconds since the epoch (e.g. using date -u +'%s'). The type value 626 * is an ABI/module-specific value that identifies a particular annotation 627 * and is private to the module. For compatibility with systems 628 * like openbsd that define packet tags w/o an ABI/module cookie, 629 * the value PACKET_ABI_COMPAT is used to implement m_tag_get and 630 * m_tag_find compatibility shim functions and several tag types are 631 * defined below. Users that do not require compatibility should use 632 * a private cookie value so that packet tag-related definitions 633 * can be maintained privately. 634 * 635 * Note that the packet tag returned by m_tag_alloc has the default 636 * memory alignment implemented by kmalloc. To reference private data 637 * one can use a construct like: 638 * 639 * struct m_tag *mtag = m_tag_alloc(...); 640 * struct foo *p = m_tag_data(mtag); 641 * 642 * if the alignment of struct m_tag is sufficient for referencing members 643 * of struct foo. Otherwise it is necessary to embed struct m_tag within 644 * the private data structure to insure proper alignment; e.g. 645 * 646 * struct foo { 647 * struct m_tag tag; 648 * ... 649 * }; 650 * struct foo *p = (struct foo *)m_tag_alloc(...); 651 * struct m_tag *mtag = &p->tag; 652 */ 653 654 #define PACKET_TAG_NONE 0 /* Nadda */ 655 656 /* Packet tag for use with PACKET_ABI_COMPAT */ 657 #define PACKET_TAG_IPSEC_IN_DONE 1 /* IPsec applied, in */ 658 /* struct tdb_indent */ 659 #define PACKET_TAG_IPSEC_OUT_DONE 2 /* IPsec applied, out */ 660 /* struct tdb_indent */ 661 #define PACKET_TAG_IPSEC_IN_CRYPTO_DONE 3 /* NIC IPsec crypto done */ 662 /* struct tdb_indent, never added */ 663 #define PACKET_TAG_IPSEC_OUT_CRYPTO_NEEDED 4 /* NIC IPsec crypto req'ed */ 664 /* struct tdb_indent, never added */ 665 #define PACKET_TAG_IPSEC_PENDING_TDB 5 /* Reminder to do IPsec */ 666 /* struct tdb_indent, never added */ 667 #define PACKET_TAG_ENCAP 6 /* Encap. processing */ 668 /* struct ifnet *, the GIF interface */ 669 #define PACKET_TAG_IPSEC_HISTORY 7 /* IPSEC history */ 670 /* struct ipsec_history */ 671 #define PACKET_TAG_IPV6_INPUT 8 /* IPV6 input processing */ 672 /* struct ip6aux */ 673 #define PACKET_TAG_IPFW_DIVERT 9 /* divert info */ 674 /* struct divert_info */ 675 #define PACKET_TAG_DUMMYNET 15 /* dummynet info */ 676 /* struct dn_pkt */ 677 #define PACKET_TAG_IPFORWARD 18 /* ipforward info */ 678 /* struct sockaddr_in */ 679 #define PACKET_TAG_IPSRCRT 27 /* IP srcrt opts */ 680 /* struct ip_srcrt_opt */ 681 #define PACKET_TAG_CARP 28 /* CARP info */ 682 /* struct pf_mtag */ 683 #define PACKET_TAG_PF 29 /* PF info */ 684 685 #define PACKET_TAG_PF_DIVERT 0x0200 /* pf(4) diverted packet */ 686 687 688 /* Packet tag routines */ 689 struct m_tag *m_tag_alloc(uint32_t, int, int, int); 690 void m_tag_free(struct m_tag *); 691 void m_tag_prepend(struct mbuf *, struct m_tag *); 692 void m_tag_unlink(struct mbuf *, struct m_tag *); 693 void m_tag_delete(struct mbuf *, struct m_tag *); 694 void m_tag_delete_chain(struct mbuf *); 695 struct m_tag *m_tag_locate(struct mbuf *, uint32_t, int, struct m_tag *); 696 struct m_tag *m_tag_copy(struct m_tag *, int); 697 int m_tag_copy_chain(struct mbuf *, const struct mbuf *, int); 698 void m_tag_init(struct mbuf *); 699 struct m_tag *m_tag_first(struct mbuf *); 700 struct m_tag *m_tag_next(struct mbuf *, struct m_tag *); 701 702 /* these are for openbsd compatibility */ 703 #define MTAG_ABI_COMPAT 0 /* compatibility ABI */ 704 705 static __inline void * 706 m_tag_data(struct m_tag *tag) 707 { 708 return ((void *)(tag + 1)); 709 } 710 711 static __inline struct m_tag * 712 m_tag_get(int type, int length, int wait) 713 { 714 return m_tag_alloc(MTAG_ABI_COMPAT, type, length, wait); 715 } 716 717 static __inline struct m_tag * 718 m_tag_find(struct mbuf *m, int type, struct m_tag *start) 719 { 720 return m_tag_locate(m, MTAG_ABI_COMPAT, type, start); 721 } 722 723 #endif /* _KERNEL */ 724 725 #endif /* _KERNEL || _KERNEL_STRUCTURES */ 726 #endif /* !_SYS_MBUF_H_ */ 727