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. All advertising materials mentioning features or use of this software 16 * must display the following acknowledgement: 17 * This product includes software developed by the University of 18 * California, Berkeley and its contributors. 19 * 4. Neither the name of the University nor the names of its contributors 20 * may be used to endorse or promote products derived from this software 21 * without specific prior written permission. 22 * 23 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 26 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 33 * SUCH DAMAGE. 34 * 35 * @(#)mbuf.h 8.5 (Berkeley) 2/19/95 36 * $FreeBSD: src/sys/sys/mbuf.h,v 1.44.2.17 2003/04/15 06:15:02 silby Exp $ 37 * $DragonFly: src/sys/sys/mbuf.h,v 1.54 2008/10/19 08:39:55 sephe Exp $ 38 */ 39 40 #ifndef _SYS_MBUF_H_ 41 #define _SYS_MBUF_H_ 42 43 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES) 44 45 #ifndef _SYS_TYPES_H_ 46 #include <sys/types.h> 47 #endif 48 #ifndef _SYS_PARAM_H_ 49 #include <sys/param.h> 50 #endif 51 #ifndef _SYS_QUEUE_H_ 52 #include <sys/queue.h> 53 #endif 54 #ifndef _NET_NETISR_H_ 55 #include <net/netisr.h> 56 #endif 57 #ifndef _NET_ETHERNET_H_ 58 #include <net/ethernet.h> 59 #endif 60 61 /* 62 * Mbufs are of a single size, MSIZE (machine/param.h), which 63 * includes overhead. An mbuf may add a single "mbuf cluster" of size 64 * MCLBYTES (also in machine/param.h), which has no additional overhead 65 * and is used instead of the internal data area; this is done when 66 * at least MINCLSIZE of data must be stored. 67 */ 68 #define MLEN (MSIZE - sizeof(struct m_hdr)) /* normal data len */ 69 #define MHLEN (MLEN - sizeof(struct pkthdr)) /* data len w/pkthdr */ 70 #define MINCLSIZE (MHLEN + 1) /* smallest amount to put in cluster */ 71 #define M_MAXCOMPRESS (MHLEN / 2) /* max amount to copy for compression */ 72 73 /* 74 * Macros for type conversion: 75 * mtod(m, t) -- Convert mbuf pointer to data pointer of correct type. 76 * mtodoff(m, t, off) -- Convert mbuf pointer at the specified offset to data 77 * pointer of correct type. 78 */ 79 #define mtod(m, t) ((t)((m)->m_data)) 80 #define mtodoff(m, t, off) ((t)((m)->m_data + (off))) 81 82 /* 83 * Header present at the beginning of every mbuf. 84 */ 85 struct m_hdr { 86 struct mbuf *mh_next; /* next buffer in chain */ 87 struct mbuf *mh_nextpkt; /* next chain in queue/record */ 88 caddr_t mh_data; /* location of data */ 89 int mh_len; /* amount of data in this mbuf */ 90 int mh_flags; /* flags; see below */ 91 short mh_type; /* type of data in this mbuf */ 92 short mh_pad; /* padding */ 93 #ifdef MBUF_DEBUG 94 const char *mh_lastfunc; 95 #endif 96 union { 97 struct netmsg_packet mhm_pkt; /* hardware->proto stack msg */ 98 struct netmsg_pru_send mhm_snd; /* usrspace->proto stack msg */ 99 } mh_msgu; 100 }; 101 #define mh_netmsg mh_msgu.mhm_pkt 102 #define mh_sndmsg mh_msgu.mhm_snd 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 u_int32_t qid; /* queue id */ 110 u_int16_t tag; /* tag id */ 111 u_int8_t flags; 112 u_int8_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 }; 119 120 /* pkthdr_pf.flags */ 121 #define PF_TAG_GENERATED 0x01 122 #define PF_TAG_FRAGCACHE 0x02 123 #define PF_TAG_TRANSLATE_LOCALHOST 0x04 124 #define PF_TAG_DIVERTED 0x08 125 #define PF_TAG_DIVERTED_PACKET 0x10 126 #define PF_TAG_REROUTE 0x20 127 128 /* 129 * Valid if BRIDGE_MBUF_TAGGED is set in fw_flags, records 130 * the original ether header (if compatible). The bridge 131 */ 132 struct pkthdr_br { 133 struct ether_header ether; 134 }; 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 u_int16_t m_tag_id; /* Tag ID */ 142 u_int16_t m_tag_len; /* Length of data */ 143 u_int32_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 int len; /* total packet length */ 157 struct packet_tags tags; /* list of packet tags */ 158 159 /* variables for ip and tcp reassembly */ 160 void *header; /* pointer to packet header */ 161 162 /* variables for hardware checksum */ 163 int csum_flags; /* flags regarding checksum */ 164 int csum_data; /* data field used by csum routines */ 165 166 /* firewall flags */ 167 uint32_t fw_flags; /* flags for PF */ 168 169 /* variables for PF processing */ 170 struct pkthdr_pf pf; /* structure for PF */ 171 struct pkthdr_br br; /* structure for bridging */ 172 173 uint16_t ether_vlantag; /* ethernet 802.1p+q vlan tag */ 174 uint16_t hash; /* packet hash */ 175 176 uint16_t wlan_seqno; /* IEEE 802.11 seq no. */ 177 }; 178 179 /* 180 * Description of external storage mapped into mbuf; valid only if M_EXT is set. 181 */ 182 struct m_ext { 183 caddr_t ext_buf; /* start of buffer */ 184 void (*ext_free)(void *); 185 u_int ext_size; /* size of buffer, for ext_free */ 186 void (*ext_ref)(void *); 187 void *ext_arg; 188 }; 189 190 /* 191 * The core of the mbuf object along with some shortcut defines for 192 * practical purposes. 193 */ 194 struct mbuf { 195 struct m_hdr m_hdr; 196 union { 197 struct { 198 struct pkthdr MH_pkthdr; /* M_PKTHDR set */ 199 union { 200 struct m_ext MH_ext; /* M_EXT set */ 201 char MH_databuf[MHLEN]; 202 } MH_dat; 203 } MH; 204 char M_databuf[MLEN]; /* !M_PKTHDR, !M_EXT */ 205 } M_dat; 206 }; 207 #define m_next m_hdr.mh_next 208 #define m_len m_hdr.mh_len 209 #define m_data m_hdr.mh_data 210 #define m_type m_hdr.mh_type 211 #define m_flags m_hdr.mh_flags 212 #define m_nextpkt m_hdr.mh_nextpkt 213 #define m_pkthdr M_dat.MH.MH_pkthdr 214 #define m_ext M_dat.MH.MH_dat.MH_ext 215 #define m_pktdat M_dat.MH.MH_dat.MH_databuf 216 #define m_dat M_dat.M_databuf 217 218 /* 219 * Code that uses m_act should be converted to use m_nextpkt 220 * instead; m_act is historical and deprecated. 221 */ 222 #define m_act m_nextpkt 223 224 /* 225 * mbuf flags. 226 */ 227 #define M_EXT 0x0001 /* has associated external storage */ 228 #define M_PKTHDR 0x0002 /* start of record */ 229 #define M_EOR 0x0004 /* end of record */ 230 #define M_PROTO1 0x0008 /* protocol-specific */ 231 #define M_PROTO2 0x0010 /* protocol-specific */ 232 #define M_PROTO3 0x0020 /* protocol-specific */ 233 #define M_PROTO4 0x0040 /* protocol-specific */ 234 #define M_PROTO5 0x0080 /* protocol-specific */ 235 236 /* 237 * mbuf pkthdr flags (also stored in m_flags). 238 */ 239 #define M_BCAST 0x0100 /* send/received as link-level broadcast */ 240 #define M_MCAST 0x0200 /* send/received as link-level multicast */ 241 #define M_FRAG 0x0400 /* packet is a fragment of a larger packet */ 242 #define M_FIRSTFRAG 0x0800 /* packet is first fragment */ 243 #define M_LASTFRAG 0x1000 /* packet is last fragment */ 244 #define M_CLCACHE 0x2000 /* mbuf allocated from the cluster cache */ 245 #define M_EXT_CLUSTER 0x4000 /* standard cluster else special */ 246 #define M_PHCACHE 0x8000 /* mbuf allocated from the pkt header cache */ 247 #define M_NOTIFICATION 0x10000 /* notification event */ 248 #define M_VLANTAG 0x20000 /* ether_vlantag is valid */ 249 #define M_MPLSLABELED 0x40000 /* packet is mpls labeled */ 250 #define M_LENCHECKED 0x80000 /* packet proto lengths are checked */ 251 #define M_HASH 0x100000/* hash field in pkthdr is valid */ 252 #define M_PROTO6 0x200000/* protocol-specific */ 253 #define M_PROTO7 0x400000/* protocol-specific */ 254 #define M_PROTO8 0x800000/* protocol-specific */ 255 256 /* 257 * Flags copied when copying m_pkthdr. 258 */ 259 #define M_COPYFLAGS (M_PKTHDR|M_EOR|M_PROTO1|M_PROTO2|M_PROTO3 | \ 260 M_PROTO4|M_PROTO5|M_PROTO6|M_PROTO7|M_PROTO8 | \ 261 M_BCAST|M_MCAST|M_FRAG|M_FIRSTFRAG|M_LASTFRAG | \ 262 M_VLANTAG|M_MPLSLABELED | \ 263 M_LENCHECKED|M_HASH) 264 265 /* 266 * Flags indicating hw checksum support and sw checksum requirements. 267 */ 268 #define CSUM_IP 0x0001 /* will csum IP */ 269 #define CSUM_TCP 0x0002 /* will csum TCP */ 270 #define CSUM_UDP 0x0004 /* will csum UDP */ 271 #define CSUM_IP_FRAGS 0x0008 /* will csum IP fragments */ 272 #define CSUM_FRAGMENT 0x0010 /* will do IP fragmentation */ 273 274 #define CSUM_IP_CHECKED 0x0100 /* did csum IP */ 275 #define CSUM_IP_VALID 0x0200 /* ... the csum is valid */ 276 #define CSUM_DATA_VALID 0x0400 /* csum_data field is valid */ 277 #define CSUM_PSEUDO_HDR 0x0800 /* csum_data has pseudo hdr */ 278 #define CSUM_FRAG_NOT_CHECKED 0x1000 /* did _not_ csum fragment 279 * NB: This flag is only used 280 * by IP defragmenter. 281 */ 282 283 #define CSUM_DELAY_DATA (CSUM_TCP | CSUM_UDP) 284 #define CSUM_DELAY_IP (CSUM_IP) /* XXX add ipv6 here too? */ 285 286 /* 287 * Flags indicating PF processing status 288 */ 289 #define FW_MBUF_GENERATED 0x00000001 290 #define PF_MBUF_STRUCTURE 0x00000002 /* m_pkthdr.pf valid */ 291 #define PF_MBUF_ROUTED 0x00000004 /* pf_routed field is valid */ 292 #define PF_MBUF_TAGGED 0x00000008 293 #define XX_MBUF_UNUSED10 0x00000010 294 #define XX_MBUF_UNUSED20 0x00000020 295 #define IPFORWARD_MBUF_TAGGED 0x00000040 296 #define DUMMYNET_MBUF_TAGGED 0x00000080 297 #define BRIDGE_MBUF_TAGGED 0x00000100 298 #define FW_MBUF_REDISPATCH 0x00000200 299 #define IPFW_MBUF_GENERATED FW_MBUF_GENERATED 300 /* 301 * mbuf types. 302 */ 303 #define MT_FREE 0 /* should be on free list */ 304 #define MT_DATA 1 /* dynamic (data) allocation */ 305 #define MT_HEADER 2 /* packet header */ 306 #define MT_SONAME 3 /* socket name */ 307 /* 4 was MT_TAG */ 308 #define MT_CONTROL 5 /* extra-data protocol message */ 309 #define MT_OOBDATA 6 /* expedited data */ 310 #define MT_NTYPES 7 /* number of mbuf types for mbtypes[] */ 311 312 struct mbuf_chain { 313 struct mbuf *mc_head; 314 struct mbuf *mc_tail; 315 }; 316 317 /* 318 * General mbuf allocator statistics structure. 319 */ 320 struct mbstat { 321 u_long m_mbufs; /* mbufs obtained from page pool */ 322 u_long m_clusters; /* clusters obtained from page pool */ 323 u_long m_spare; /* spare field */ 324 u_long m_clfree; /* free clusters */ 325 u_long m_drops; /* times failed to find space */ 326 u_long m_wait; /* times waited for space */ 327 u_long m_drain; /* times drained protocols for space */ 328 u_long m_mcfail; /* times m_copym failed */ 329 u_long m_mpfail; /* times m_pullup failed */ 330 u_long m_msize; /* length of an mbuf */ 331 u_long m_mclbytes; /* length of an mbuf cluster */ 332 u_long m_mjumpagesize; /* length of a jumbo mbuf cluster */ 333 u_long m_minclsize; /* min length of data to allocate a cluster */ 334 u_long m_mlen; /* length of data in an mbuf */ 335 u_long m_mhlen; /* length of data in a header mbuf */ 336 }; 337 338 /* 339 * Flags specifying how an allocation should be made. 340 */ 341 342 #define MB_DONTWAIT 0x4 343 #define MB_TRYWAIT 0x8 344 #define MB_WAIT MB_TRYWAIT 345 346 /* 347 * Mbuf to Malloc Flag Conversion. 348 */ 349 #define MBTOM(how) ((how) & MB_TRYWAIT ? 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 MB_DONTWAIT 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), MB_DONTWAIT) 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 m_adj(struct mbuf *, int); 490 void m_align(struct mbuf *, int); 491 int m_apply(struct mbuf *, int, int, 492 int (*)(void *, void *, u_int), void *); 493 int m_append(struct mbuf *, int, c_caddr_t); 494 void m_cat(struct mbuf *, struct mbuf *); 495 u_int m_countm(struct mbuf *m, struct mbuf **lastm, u_int *mbcnt); 496 void m_copyback(struct mbuf *, int, int, caddr_t); 497 void m_copydata(const struct mbuf *, int, int, caddr_t); 498 struct mbuf *m_copym(const struct mbuf *, int, int, int); 499 struct mbuf *m_copypacket(struct mbuf *, int); 500 struct mbuf *m_defrag(struct mbuf *, int); 501 struct mbuf *m_defrag_nofree(struct mbuf *, int); 502 struct mbuf *m_devget(char *, int, int, struct ifnet *, 503 void (*copy)(volatile const void *, volatile void *, size_t)); 504 struct mbuf *m_dup(struct mbuf *, int); 505 struct mbuf *m_dup_data(struct mbuf *, int); 506 int m_dup_pkthdr(struct mbuf *, const struct mbuf *, int); 507 void m_extadd(struct mbuf *, caddr_t, u_int, void (*)(void *), 508 void (*)(void *), void *); 509 #ifdef MBUF_DEBUG 510 struct mbuf *_m_free(struct mbuf *, const char *name); 511 void _m_freem(struct mbuf *, const char *name); 512 #else 513 struct mbuf *m_free(struct mbuf *); 514 void m_freem(struct mbuf *); 515 #endif 516 struct mbuf *m_get(int, int); 517 struct mbuf *m_getc(int len, int how, int type); 518 struct mbuf *m_getcl(int how, short type, int flags); 519 struct mbuf *m_getjcl(int how, short type, int flags, size_t size); 520 struct mbuf *m_getclr(int, int); 521 struct mbuf *m_gethdr(int, int); 522 struct mbuf *m_getm(struct mbuf *, int, int, int); 523 struct mbuf *m_getptr(struct mbuf *, int, int *); 524 struct mbuf *m_last(struct mbuf *m); 525 u_int m_lengthm(struct mbuf *m, struct mbuf **lastm); 526 void m_move_pkthdr(struct mbuf *, struct mbuf *); 527 struct mbuf *m_prepend(struct mbuf *, int, int); 528 void m_print(const struct mbuf *m); 529 struct mbuf *m_pulldown(struct mbuf *, int, int, int *); 530 struct mbuf *m_pullup(struct mbuf *, int); 531 struct mbuf *m_split(struct mbuf *, int, int); 532 struct mbuf *m_uiomove(struct uio *); 533 struct mbuf *m_unshare(struct mbuf *, int); 534 void m_mclget(struct mbuf *m, int how); 535 int m_sharecount(struct mbuf *m); 536 void m_chtype(struct mbuf *m, int type); 537 int m_devpad(struct mbuf *m, int padto); 538 539 #ifdef MBUF_DEBUG 540 541 void mbuftrackid(struct mbuf *, int); 542 543 #define m_free(m) _m_free(m, __func__) 544 #define m_freem(m) _m_freem(m, __func__) 545 546 #else 547 548 #define mbuftrackid(m, id) /* empty */ 549 550 #endif 551 552 /* 553 * Allocate the right type of mbuf for the desired total length. 554 * The mbuf returned does not necessarily cover the entire requested length. 555 * This function follows mbuf chaining policy of allowing MINCLSIZE 556 * amount of chained mbufs. 557 */ 558 static __inline struct mbuf * 559 m_getl(int len, int how, int type, int flags, int *psize) 560 { 561 struct mbuf *m; 562 int size; 563 564 if (len >= MINCLSIZE) { 565 m = m_getcl(how, type, flags); 566 size = MCLBYTES; 567 } else if (flags & M_PKTHDR) { 568 m = m_gethdr(how, type); 569 size = MHLEN; 570 } else { 571 m = m_get(how, type); 572 size = MLEN; 573 } 574 if (psize != NULL) 575 *psize = size; 576 return (m); 577 } 578 579 /* 580 * Get a single mbuf that covers the requested number of bytes. 581 * This function does not create mbuf chains. It explicitly marks 582 * places in the code that abuse mbufs for contiguous data buffers. 583 */ 584 static __inline struct mbuf * 585 m_getb(int len, int how, int type, int flags) 586 { 587 struct mbuf *m; 588 int mbufsize = (flags & M_PKTHDR) ? MHLEN : MLEN; 589 590 if (len > mbufsize) 591 m = m_getcl(how, type, flags); 592 else if (flags & M_PKTHDR) 593 m = m_gethdr(how, type); 594 else 595 m = m_get(how, type); 596 return (m); 597 } 598 599 /* 600 * Packets may have annotations attached by affixing a list 601 * of "packet tags" to the pkthdr structure. Packet tags are 602 * dynamically allocated semi-opaque data structures that have 603 * a fixed header (struct m_tag) that specifies the size of the 604 * memory block and a <cookie,type> pair that identifies it. 605 * The cookie is a 32-bit unique unsigned value used to identify 606 * a module or ABI. By convention this value is chose as the 607 * date+time that the module is created, expressed as the number of 608 * seconds since the epoch (e.g. using date -u +'%s'). The type value 609 * is an ABI/module-specific value that identifies a particular annotation 610 * and is private to the module. For compatibility with systems 611 * like openbsd that define packet tags w/o an ABI/module cookie, 612 * the value PACKET_ABI_COMPAT is used to implement m_tag_get and 613 * m_tag_find compatibility shim functions and several tag types are 614 * defined below. Users that do not require compatibility should use 615 * a private cookie value so that packet tag-related definitions 616 * can be maintained privately. 617 * 618 * Note that the packet tag returned by m_tag_alloc has the default 619 * memory alignment implemented by kmalloc. To reference private data 620 * one can use a construct like: 621 * 622 * struct m_tag *mtag = m_tag_alloc(...); 623 * struct foo *p = m_tag_data(mtag); 624 * 625 * if the alignment of struct m_tag is sufficient for referencing members 626 * of struct foo. Otherwise it is necessary to embed struct m_tag within 627 * the private data structure to insure proper alignment; e.g. 628 * 629 * struct foo { 630 * struct m_tag tag; 631 * ... 632 * }; 633 * struct foo *p = (struct foo *)m_tag_alloc(...); 634 * struct m_tag *mtag = &p->tag; 635 */ 636 637 #define PACKET_TAG_NONE 0 /* Nadda */ 638 639 /* Packet tag for use with PACKET_ABI_COMPAT */ 640 #define PACKET_TAG_IPSEC_IN_DONE 1 /* IPsec applied, in */ 641 /* struct tdb_indent */ 642 #define PACKET_TAG_IPSEC_OUT_DONE 2 /* IPsec applied, out */ 643 /* struct tdb_indent */ 644 #define PACKET_TAG_IPSEC_IN_CRYPTO_DONE 3 /* NIC IPsec crypto done */ 645 /* struct tdb_indent, never added */ 646 #define PACKET_TAG_IPSEC_OUT_CRYPTO_NEEDED 4 /* NIC IPsec crypto req'ed */ 647 /* struct tdb_indent, never added */ 648 #define PACKET_TAG_IPSEC_PENDING_TDB 5 /* Reminder to do IPsec */ 649 /* struct tdb_indent, never added */ 650 #define PACKET_TAG_ENCAP 6 /* Encap. processing */ 651 /* struct ifnet *, the GIF interface */ 652 #define PACKET_TAG_IPSEC_HISTORY 7 /* IPSEC history */ 653 /* struct ipsec_history */ 654 #define PACKET_TAG_IPV6_INPUT 8 /* IPV6 input processing */ 655 /* struct ip6aux */ 656 #define PACKET_TAG_IPFW_DIVERT 9 /* divert info */ 657 /* struct divert_info */ 658 #define PACKET_TAG_DUMMYNET 15 /* dummynet info */ 659 /* struct dn_pkt */ 660 #define PACKET_TAG_IPFORWARD 18 /* ipforward info */ 661 /* struct sockaddr_in */ 662 #define PACKET_TAG_IPSRCRT 27 /* IP srcrt opts */ 663 /* struct ip_srcrt_opt */ 664 #define PACKET_TAG_CARP 28 /* CARP info */ 665 /* struct pf_mtag */ 666 #define PACKET_TAG_PF 29 /* PF info */ 667 668 #define PACKET_TAG_PF_DIVERT 0x0200 /* pf(4) diverted packet */ 669 670 671 /* Packet tag routines */ 672 struct m_tag *m_tag_alloc(u_int32_t, int, int, int); 673 void m_tag_free(struct m_tag *); 674 void m_tag_prepend(struct mbuf *, struct m_tag *); 675 void m_tag_unlink(struct mbuf *, struct m_tag *); 676 void m_tag_delete(struct mbuf *, struct m_tag *); 677 void m_tag_delete_chain(struct mbuf *); 678 struct m_tag *m_tag_locate(struct mbuf *, u_int32_t, int, struct m_tag *); 679 struct m_tag *m_tag_copy(struct m_tag *, int); 680 int m_tag_copy_chain(struct mbuf *, const struct mbuf *, int); 681 void m_tag_init(struct mbuf *); 682 struct m_tag *m_tag_first(struct mbuf *); 683 struct m_tag *m_tag_next(struct mbuf *, struct m_tag *); 684 685 /* these are for openbsd compatibility */ 686 #define MTAG_ABI_COMPAT 0 /* compatibility ABI */ 687 688 static __inline void * 689 m_tag_data(struct m_tag *tag) 690 { 691 return ((void *)(tag + 1)); 692 } 693 694 static __inline struct m_tag * 695 m_tag_get(int type, int length, int wait) 696 { 697 return m_tag_alloc(MTAG_ABI_COMPAT, type, length, wait); 698 } 699 700 static __inline struct m_tag * 701 m_tag_find(struct mbuf *m, int type, struct m_tag *start) 702 { 703 return m_tag_locate(m, MTAG_ABI_COMPAT, type, start); 704 } 705 706 #endif /* _KERNEL */ 707 708 #endif /* _KERNEL || _KERNEL_STRUCTURES */ 709 #endif /* !_SYS_MBUF_H_ */ 710