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