1 /* 2 * Copyright (c) 1982, 1986, 1988, 1993 3 * The Regents of the University of California. All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 3. All advertising materials mentioning features or use of this software 14 * must display the following acknowledgement: 15 * This product includes software developed by the University of 16 * California, Berkeley and its contributors. 17 * 4. Neither the name of the University nor the names of its contributors 18 * may be used to endorse or promote products derived from this software 19 * without specific prior written permission. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 24 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31 * SUCH DAMAGE. 32 * 33 * @(#)mbuf.h 8.5 (Berkeley) 2/19/95 34 * $FreeBSD: src/sys/sys/mbuf.h,v 1.44.2.17 2003/04/15 06:15:02 silby Exp $ 35 * $DragonFly: src/sys/sys/mbuf.h,v 1.2 2003/06/17 04:28:58 dillon Exp $ 36 */ 37 38 #ifndef _SYS_MBUF_H_ 39 #define _SYS_MBUF_H_ 40 41 #include <sys/queue.h> 42 43 /* 44 * Mbufs are of a single size, MSIZE (machine/param.h), which 45 * includes overhead. An mbuf may add a single "mbuf cluster" of size 46 * MCLBYTES (also in machine/param.h), which has no additional overhead 47 * and is used instead of the internal data area; this is done when 48 * at least MINCLSIZE of data must be stored. 49 */ 50 #define MLEN (MSIZE - sizeof(struct m_hdr)) /* normal data len */ 51 #define MHLEN (MLEN - sizeof(struct pkthdr)) /* data len w/pkthdr */ 52 #define MINCLSIZE (MHLEN + 1) /* smallest amount to put in cluster */ 53 #define M_MAXCOMPRESS (MHLEN / 2) /* max amount to copy for compression */ 54 55 /* 56 * Macros for type conversion: 57 * mtod(m, t) -- Convert mbuf pointer to data pointer of correct type. 58 * dtom(x) -- Convert data pointer within mbuf to mbuf pointer (XXX). 59 * mtocl(x) - convert pointer within cluster to cluster index # 60 * cltom(x) - convert cluster # to ptr to beginning of cluster 61 */ 62 #define mtod(m, t) ((t)((m)->m_data)) 63 #define dtom(x) ((struct mbuf *)((intptr_t)(x) & ~(MSIZE-1))) 64 #define mtocl(x) (((uintptr_t)(x) - (uintptr_t)mbutl) >> MCLSHIFT) 65 #define cltom(x) ((caddr_t)((uintptr_t)mbutl + \ 66 ((uintptr_t)(x) << MCLSHIFT))) 67 68 /* 69 * Header present at the beginning of every mbuf. 70 */ 71 struct m_hdr { 72 struct mbuf *mh_next; /* next buffer in chain */ 73 struct mbuf *mh_nextpkt; /* next chain in queue/record */ 74 caddr_t mh_data; /* location of data */ 75 int mh_len; /* amount of data in this mbuf */ 76 short mh_type; /* type of data in this mbuf */ 77 short mh_flags; /* flags; see below */ 78 }; 79 80 /* 81 * Packet tag structure (see below for details). 82 */ 83 struct m_tag { 84 SLIST_ENTRY(m_tag) m_tag_link; /* List of packet tags */ 85 u_int16_t m_tag_id; /* Tag ID */ 86 u_int16_t m_tag_len; /* Length of data */ 87 u_int32_t m_tag_cookie; /* ABI/Module ID */ 88 }; 89 90 /* 91 * Record/packet header in first mbuf of chain; valid only if M_PKTHDR is set. 92 */ 93 struct pkthdr { 94 struct ifnet *rcvif; /* rcv interface */ 95 int len; /* total packet length */ 96 /* variables for ip and tcp reassembly */ 97 void *header; /* pointer to packet header */ 98 /* variables for hardware checksum */ 99 int csum_flags; /* flags regarding checksum */ 100 int csum_data; /* data field used by csum routines */ 101 SLIST_HEAD(packet_tags, m_tag) tags; /* list of packet tags */ 102 }; 103 104 /* 105 * Description of external storage mapped into mbuf; valid only if M_EXT is set. 106 */ 107 struct m_ext { 108 caddr_t ext_buf; /* start of buffer */ 109 void (*ext_free) /* free routine if not the usual */ 110 (caddr_t, u_int); 111 u_int ext_size; /* size of buffer, for ext_free */ 112 void (*ext_ref) /* add a reference to the ext object */ 113 (caddr_t, u_int); 114 }; 115 116 /* 117 * The core of the mbuf object along with some shortcut defines for 118 * practical purposes. 119 */ 120 struct mbuf { 121 struct m_hdr m_hdr; 122 union { 123 struct { 124 struct pkthdr MH_pkthdr; /* M_PKTHDR set */ 125 union { 126 struct m_ext MH_ext; /* M_EXT set */ 127 char MH_databuf[MHLEN]; 128 } MH_dat; 129 } MH; 130 char M_databuf[MLEN]; /* !M_PKTHDR, !M_EXT */ 131 } M_dat; 132 }; 133 #define m_next m_hdr.mh_next 134 #define m_len m_hdr.mh_len 135 #define m_data m_hdr.mh_data 136 #define m_type m_hdr.mh_type 137 #define m_flags m_hdr.mh_flags 138 #define m_nextpkt m_hdr.mh_nextpkt 139 #define m_act m_nextpkt 140 #define m_pkthdr M_dat.MH.MH_pkthdr 141 #define m_ext M_dat.MH.MH_dat.MH_ext 142 #define m_pktdat M_dat.MH.MH_dat.MH_databuf 143 #define m_dat M_dat.M_databuf 144 145 /* 146 * mbuf flags. 147 */ 148 #define M_EXT 0x0001 /* has associated external storage */ 149 #define M_PKTHDR 0x0002 /* start of record */ 150 #define M_EOR 0x0004 /* end of record */ 151 #define M_PROTO1 0x0008 /* protocol-specific */ 152 #define M_PROTO2 0x0010 /* protocol-specific */ 153 #define M_PROTO3 0x0020 /* protocol-specific */ 154 #define M_PROTO4 0x0040 /* protocol-specific */ 155 #define M_PROTO5 0x0080 /* protocol-specific */ 156 157 /* 158 * mbuf pkthdr flags (also stored in m_flags). 159 */ 160 #define M_BCAST 0x0100 /* send/received as link-level broadcast */ 161 #define M_MCAST 0x0200 /* send/received as link-level multicast */ 162 #define M_FRAG 0x0400 /* packet is a fragment of a larger packet */ 163 #define M_FIRSTFRAG 0x0800 /* packet is first fragment */ 164 #define M_LASTFRAG 0x1000 /* packet is last fragment */ 165 166 /* 167 * Flags copied when copying m_pkthdr. 168 */ 169 #define M_COPYFLAGS (M_PKTHDR|M_EOR|M_PROTO1|M_PROTO1|M_PROTO2|M_PROTO3 | \ 170 M_PROTO4|M_PROTO5|M_BCAST|M_MCAST|M_FRAG | \ 171 M_FIRSTFRAG|M_LASTFRAG) 172 173 /* 174 * Flags indicating hw checksum support and sw checksum requirements. 175 */ 176 #define CSUM_IP 0x0001 /* will csum IP */ 177 #define CSUM_TCP 0x0002 /* will csum TCP */ 178 #define CSUM_UDP 0x0004 /* will csum UDP */ 179 #define CSUM_IP_FRAGS 0x0008 /* will csum IP fragments */ 180 #define CSUM_FRAGMENT 0x0010 /* will do IP fragmentation */ 181 182 #define CSUM_IP_CHECKED 0x0100 /* did csum IP */ 183 #define CSUM_IP_VALID 0x0200 /* ... the csum is valid */ 184 #define CSUM_DATA_VALID 0x0400 /* csum_data field is valid */ 185 #define CSUM_PSEUDO_HDR 0x0800 /* csum_data has pseudo hdr */ 186 187 #define CSUM_DELAY_DATA (CSUM_TCP | CSUM_UDP) 188 #define CSUM_DELAY_IP (CSUM_IP) /* XXX add ipv6 here too? */ 189 190 /* 191 * mbuf types. 192 */ 193 #define MT_FREE 0 /* should be on free list */ 194 #define MT_DATA 1 /* dynamic (data) allocation */ 195 #define MT_HEADER 2 /* packet header */ 196 #if 0 197 #define MT_SOCKET 3 /* socket structure */ 198 #define MT_PCB 4 /* protocol control block */ 199 #define MT_RTABLE 5 /* routing tables */ 200 #define MT_HTABLE 6 /* IMP host tables */ 201 #define MT_ATABLE 7 /* address resolution tables */ 202 #endif 203 #define MT_SONAME 8 /* socket name */ 204 #if 0 205 #define MT_SOOPTS 10 /* socket options */ 206 #endif 207 #define MT_FTABLE 11 /* fragment reassembly header */ 208 #if 0 209 #define MT_RIGHTS 12 /* access rights */ 210 #define MT_IFADDR 13 /* interface address */ 211 #endif 212 #define MT_TAG 13 /* volatile metadata associated to pkts */ 213 #define MT_CONTROL 14 /* extra-data protocol message */ 214 #define MT_OOBDATA 15 /* expedited data */ 215 #define MT_NTYPES 16 /* number of mbuf types for mbtypes[] */ 216 217 /* 218 * General mbuf allocator statistics structure. 219 */ 220 struct mbstat { 221 u_long m_mbufs; /* mbufs obtained from page pool */ 222 u_long m_clusters; /* clusters obtained from page pool */ 223 u_long m_spare; /* spare field */ 224 u_long m_clfree; /* free clusters */ 225 u_long m_drops; /* times failed to find space */ 226 u_long m_wait; /* times waited for space */ 227 u_long m_drain; /* times drained protocols for space */ 228 u_long m_mcfail; /* times m_copym failed */ 229 u_long m_mpfail; /* times m_pullup failed */ 230 u_long m_msize; /* length of an mbuf */ 231 u_long m_mclbytes; /* length of an mbuf cluster */ 232 u_long m_minclsize; /* min length of data to allocate a cluster */ 233 u_long m_mlen; /* length of data in an mbuf */ 234 u_long m_mhlen; /* length of data in a header mbuf */ 235 }; 236 237 /* 238 * Flags specifying how an allocation should be made. 239 */ 240 241 #define M_DONTWAIT 1 242 #define M_WAIT 0 243 244 /* Freelists: 245 * 246 * Normal mbuf clusters are normally treated as character arrays 247 * after allocation, but use the first word of the buffer as a free list 248 * pointer while on the free list. 249 */ 250 union mcluster { 251 union mcluster *mcl_next; 252 char mcl_buf[MCLBYTES]; 253 }; 254 255 256 /* 257 * These are identifying numbers passed to the m_mballoc_wait function, 258 * allowing us to determine whether the call came from an MGETHDR or 259 * an MGET. 260 */ 261 #define MGETHDR_C 1 262 #define MGET_C 2 263 264 /* 265 * Wake up the next instance (if any) of m_mballoc_wait() which is 266 * waiting for an mbuf to be freed. This should be called at splimp(). 267 * 268 * XXX: If there is another free mbuf, this routine will be called [again] 269 * from the m_mballoc_wait routine in order to wake another sleep instance. 270 */ 271 #define MMBWAKEUP() do { \ 272 if (m_mballoc_wid) { \ 273 m_mballoc_wid--; \ 274 wakeup_one(&m_mballoc_wid); \ 275 } \ 276 } while (0) 277 278 /* 279 * Same as above, but for mbuf cluster(s). 280 */ 281 #define MCLWAKEUP() do { \ 282 if (m_clalloc_wid) { \ 283 m_clalloc_wid--; \ 284 wakeup_one(&m_clalloc_wid); \ 285 } \ 286 } while (0) 287 288 /* 289 * mbuf utility macros: 290 * 291 * MBUFLOCK(code) 292 * prevents a section of code from from being interrupted by network 293 * drivers. 294 */ 295 #define MBUFLOCK(code) do { \ 296 int _ms = splimp(); \ 297 \ 298 { code } \ 299 splx(_ms); \ 300 } while (0) 301 302 /* 303 * mbuf allocation/deallocation macros: 304 * 305 * MGET(struct mbuf *m, int how, int type) 306 * allocates an mbuf and initializes it to contain internal data. 307 * 308 * MGETHDR(struct mbuf *m, int how, int type) 309 * allocates an mbuf and initializes it to contain a packet header 310 * and internal data. 311 */ 312 #define MGET(m, how, type) do { \ 313 struct mbuf *_mm; \ 314 int _mhow = (how); \ 315 int _mtype = (type); \ 316 int _ms = splimp(); \ 317 \ 318 if (mmbfree == NULL) \ 319 (void)m_mballoc(1, _mhow); \ 320 _mm = mmbfree; \ 321 if (_mm != NULL) { \ 322 mmbfree = _mm->m_next; \ 323 mbtypes[MT_FREE]--; \ 324 _mm->m_type = _mtype; \ 325 mbtypes[_mtype]++; \ 326 _mm->m_next = NULL; \ 327 _mm->m_nextpkt = NULL; \ 328 _mm->m_data = _mm->m_dat; \ 329 _mm->m_flags = 0; \ 330 (m) = _mm; \ 331 splx(_ms); \ 332 } else { \ 333 splx(_ms); \ 334 _mm = m_retry(_mhow, _mtype); \ 335 if (_mm == NULL && _mhow == M_WAIT) \ 336 (m) = m_mballoc_wait(MGET_C, _mtype); \ 337 else \ 338 (m) = _mm; \ 339 } \ 340 } while (0) 341 342 #define MGETHDR(m, how, type) do { \ 343 struct mbuf *_mm; \ 344 int _mhow = (how); \ 345 int _mtype = (type); \ 346 int _ms = splimp(); \ 347 \ 348 if (mmbfree == NULL) \ 349 (void)m_mballoc(1, _mhow); \ 350 _mm = mmbfree; \ 351 if (_mm != NULL) { \ 352 mmbfree = _mm->m_next; \ 353 mbtypes[MT_FREE]--; \ 354 _mm->m_type = _mtype; \ 355 mbtypes[_mtype]++; \ 356 _mm->m_next = NULL; \ 357 _mm->m_nextpkt = NULL; \ 358 _mm->m_data = _mm->m_pktdat; \ 359 _mm->m_flags = M_PKTHDR; \ 360 _mm->m_pkthdr.rcvif = NULL; \ 361 SLIST_INIT(&_mm->m_pkthdr.tags); \ 362 _mm->m_pkthdr.csum_flags = 0; \ 363 (m) = _mm; \ 364 splx(_ms); \ 365 } else { \ 366 splx(_ms); \ 367 _mm = m_retryhdr(_mhow, _mtype); \ 368 if (_mm == NULL && _mhow == M_WAIT) \ 369 (m) = m_mballoc_wait(MGETHDR_C, _mtype); \ 370 else \ 371 (m) = _mm; \ 372 } \ 373 } while (0) 374 375 /* 376 * Mbuf cluster macros. 377 * MCLALLOC(caddr_t p, int how) allocates an mbuf cluster. 378 * MCLGET adds such clusters to a normal mbuf; 379 * the flag M_EXT is set upon success. 380 * MCLFREE releases a reference to a cluster allocated by MCLALLOC, 381 * freeing the cluster if the reference count has reached 0. 382 */ 383 #define MCLALLOC(p, how) do { \ 384 caddr_t _mp; \ 385 int _mhow = (how); \ 386 int _ms = splimp(); \ 387 \ 388 if (mclfree == NULL) \ 389 (void)m_clalloc(1, _mhow); \ 390 _mp = (caddr_t)mclfree; \ 391 if (_mp != NULL) { \ 392 mclrefcnt[mtocl(_mp)]++; \ 393 mbstat.m_clfree--; \ 394 mclfree = ((union mcluster *)_mp)->mcl_next; \ 395 (p) = _mp; \ 396 splx(_ms); \ 397 } else { \ 398 splx(_ms); \ 399 if (_mhow == M_WAIT) \ 400 (p) = m_clalloc_wait(); \ 401 else \ 402 (p) = NULL; \ 403 } \ 404 } while (0) 405 406 #define MCLGET(m, how) do { \ 407 struct mbuf *_mm = (m); \ 408 \ 409 MCLALLOC(_mm->m_ext.ext_buf, (how)); \ 410 if (_mm->m_ext.ext_buf != NULL) { \ 411 _mm->m_data = _mm->m_ext.ext_buf; \ 412 _mm->m_flags |= M_EXT; \ 413 _mm->m_ext.ext_free = NULL; \ 414 _mm->m_ext.ext_ref = NULL; \ 415 _mm->m_ext.ext_size = MCLBYTES; \ 416 } \ 417 } while (0) 418 419 #define MCLFREE1(p) do { \ 420 union mcluster *_mp = (union mcluster *)(p); \ 421 \ 422 KASSERT(mclrefcnt[mtocl(_mp)] > 0, ("freeing free cluster")); \ 423 if (--mclrefcnt[mtocl(_mp)] == 0) { \ 424 _mp->mcl_next = mclfree; \ 425 mclfree = _mp; \ 426 mbstat.m_clfree++; \ 427 MCLWAKEUP(); \ 428 } \ 429 } while (0) 430 431 #define MCLFREE(p) MBUFLOCK( \ 432 MCLFREE1(p); \ 433 ) 434 435 #define MEXTFREE1(m) do { \ 436 struct mbuf *_mm = (m); \ 437 \ 438 if (_mm->m_ext.ext_free != NULL) \ 439 (*_mm->m_ext.ext_free)(_mm->m_ext.ext_buf, \ 440 _mm->m_ext.ext_size); \ 441 else \ 442 MCLFREE1(_mm->m_ext.ext_buf); \ 443 } while (0) 444 445 #define MEXTFREE(m) MBUFLOCK( \ 446 MEXTFREE1(m); \ 447 ) 448 449 /* 450 * NB: M_COPY_PKTHDR is deprecated; use either M_MOVE_PKTHDR 451 * or m_dup_pkthdr. 452 */ 453 /* 454 * Move mbuf pkthdr from "from" to "to". 455 * from should have M_PKTHDR set, and to must be empty. 456 * from no longer has a pkthdr after this operation. 457 */ 458 #define M_MOVE_PKTHDR(_to, _from) m_move_pkthdr((_to), (_from)) 459 460 /* 461 * Set the m_data pointer of a newly-allocated mbuf (m_get/MGET) to place 462 * an object of the specified size at the end of the mbuf, longword aligned. 463 */ 464 #define M_ALIGN(m, len) do { \ 465 (m)->m_data += (MLEN - (len)) & ~(sizeof(long) - 1); \ 466 } while (0) 467 468 /* 469 * As above, for mbufs allocated with m_gethdr/MGETHDR 470 * or initialized by M_COPY_PKTHDR. 471 */ 472 #define MH_ALIGN(m, len) do { \ 473 (m)->m_data += (MHLEN - (len)) & ~(sizeof(long) - 1); \ 474 } while (0) 475 476 /* 477 * Check if we can write to an mbuf. 478 */ 479 #define M_EXT_WRITABLE(m) \ 480 ((m)->m_ext.ext_free == NULL && mclrefcnt[mtocl((m)->m_ext.ext_buf)] == 1) 481 482 #define M_WRITABLE(m) (!((m)->m_flags & M_EXT) || \ 483 M_EXT_WRITABLE(m) ) 484 485 /* 486 * Compute the amount of space available 487 * before the current start of data in an mbuf. 488 * 489 * The M_WRITABLE() is a temporary, conservative safety measure: the burden 490 * of checking writability of the mbuf data area rests solely with the caller. 491 */ 492 #define M_LEADINGSPACE(m) \ 493 ((m)->m_flags & M_EXT ? \ 494 (M_EXT_WRITABLE(m) ? (m)->m_data - (m)->m_ext.ext_buf : 0): \ 495 (m)->m_flags & M_PKTHDR ? (m)->m_data - (m)->m_pktdat : \ 496 (m)->m_data - (m)->m_dat) 497 498 /* 499 * Compute the amount of space available 500 * after the end of data in an mbuf. 501 * 502 * The M_WRITABLE() is a temporary, conservative safety measure: the burden 503 * of checking writability of the mbuf data area rests solely with the caller. 504 */ 505 #define M_TRAILINGSPACE(m) \ 506 ((m)->m_flags & M_EXT ? \ 507 (M_WRITABLE(m) ? (m)->m_ext.ext_buf + (m)->m_ext.ext_size \ 508 - ((m)->m_data + (m)->m_len) : 0) : \ 509 &(m)->m_dat[MLEN] - ((m)->m_data + (m)->m_len)) 510 511 /* 512 * Arrange to prepend space of size plen to mbuf m. 513 * If a new mbuf must be allocated, how specifies whether to wait. 514 * If how is M_DONTWAIT and allocation fails, the original mbuf chain 515 * is freed and m is set to NULL. 516 */ 517 #define M_PREPEND(m, plen, how) do { \ 518 struct mbuf **_mmp = &(m); \ 519 struct mbuf *_mm = *_mmp; \ 520 int _mplen = (plen); \ 521 int __mhow = (how); \ 522 \ 523 if (M_LEADINGSPACE(_mm) >= _mplen) { \ 524 _mm->m_data -= _mplen; \ 525 _mm->m_len += _mplen; \ 526 } else \ 527 _mm = m_prepend(_mm, _mplen, __mhow); \ 528 if (_mm != NULL && _mm->m_flags & M_PKTHDR) \ 529 _mm->m_pkthdr.len += _mplen; \ 530 *_mmp = _mm; \ 531 } while (0) 532 533 /* change mbuf to new type */ 534 #define MCHTYPE(m, t) do { \ 535 struct mbuf *_mm = (m); \ 536 int _mt = (t); \ 537 int _ms = splimp(); \ 538 \ 539 mbtypes[_mm->m_type]--; \ 540 mbtypes[_mt]++; \ 541 splx(_ms); \ 542 _mm->m_type = (_mt); \ 543 } while (0) 544 545 /* Length to m_copy to copy all. */ 546 #define M_COPYALL 1000000000 547 548 /* Compatibility with 4.3 */ 549 #define m_copy(m, o, l) m_copym((m), (o), (l), M_DONTWAIT) 550 551 #ifdef _KERNEL 552 extern u_int m_clalloc_wid; /* mbuf cluster wait count */ 553 extern u_int m_mballoc_wid; /* mbuf wait count */ 554 extern int max_linkhdr; /* largest link-level header */ 555 extern int max_protohdr; /* largest protocol header */ 556 extern int max_hdr; /* largest link+protocol header */ 557 extern int max_datalen; /* MHLEN - max_hdr */ 558 extern struct mbstat mbstat; 559 extern u_long mbtypes[MT_NTYPES]; /* per-type mbuf allocations */ 560 extern int mbuf_wait; /* mbuf sleep time */ 561 extern struct mbuf *mbutl; /* virtual address of mclusters */ 562 extern char *mclrefcnt; /* cluster reference counts */ 563 extern union mcluster *mclfree; 564 extern struct mbuf *mmbfree; 565 extern int nmbclusters; 566 extern int nmbufs; 567 extern int nsfbufs; 568 569 void m_adj(struct mbuf *, int); 570 void m_cat(struct mbuf *, struct mbuf *); 571 int m_clalloc(int, int); 572 caddr_t m_clalloc_wait(void); 573 void m_copyback(struct mbuf *, int, int, caddr_t); 574 void m_copydata(struct mbuf *, int, int, caddr_t); 575 struct mbuf *m_copym(struct mbuf *, int, int, int); 576 struct mbuf *m_copypacket(struct mbuf *, int); 577 struct mbuf *m_defrag(struct mbuf *, int); 578 struct mbuf *m_devget(char *, int, int, struct ifnet *, 579 void (*copy)(char *, caddr_t, u_int)); 580 struct mbuf *m_dup(struct mbuf *, int); 581 int m_dup_pkthdr(struct mbuf *, struct mbuf *, int); 582 struct mbuf *m_free(struct mbuf *); 583 void m_freem(struct mbuf *); 584 struct mbuf *m_get(int, int); 585 struct mbuf *m_getcl(int how, short type, int flags); 586 struct mbuf *m_getclr(int, int); 587 struct mbuf *m_gethdr(int, int); 588 struct mbuf *m_getm(struct mbuf *, int, int, int); 589 int m_mballoc(int, int); 590 struct mbuf *m_mballoc_wait(int, int); 591 void m_move_pkthdr(struct mbuf *, struct mbuf *); 592 struct mbuf *m_prepend(struct mbuf *, int, int); 593 void m_print(const struct mbuf *m); 594 struct mbuf *m_pulldown(struct mbuf *, int, int, int *); 595 struct mbuf *m_pullup(struct mbuf *, int); 596 struct mbuf *m_retry(int, int); 597 struct mbuf *m_retryhdr(int, int); 598 struct mbuf *m_split(struct mbuf *, int, int); 599 600 /* 601 * Packets may have annotations attached by affixing a list 602 * of "packet tags" to the pkthdr structure. Packet tags are 603 * dynamically allocated semi-opaque data structures that have 604 * a fixed header (struct m_tag) that specifies the size of the 605 * memory block and a <cookie,type> pair that identifies it. 606 * The cookie is a 32-bit unique unsigned value used to identify 607 * a module or ABI. By convention this value is chose as the 608 * date+time that the module is created, expressed as the number of 609 * seconds since the epoch (e.g. using date -u +'%s'). The type value 610 * is an ABI/module-specific value that identifies a particular annotation 611 * and is private to the module. For compatibility with systems 612 * like openbsd that define packet tags w/o an ABI/module cookie, 613 * the value PACKET_ABI_COMPAT is used to implement m_tag_get and 614 * m_tag_find compatibility shim functions and several tag types are 615 * defined below. Users that do not require compatibility should use 616 * a private cookie value so that packet tag-related definitions 617 * can be maintained privately. 618 * 619 * Note that the packet tag returned by m_tag_allocate has the default 620 * memory alignment implemented by malloc. To reference private data 621 * one can use a construct like: 622 * 623 * struct m_tag *mtag = m_tag_allocate(...); 624 * struct foo *p = (struct foo *)(mtag+1); 625 * 626 * if the alignment of struct m_tag is sufficient for referencing members 627 * of struct foo. Otherwise it is necessary to embed struct m_tag within 628 * the private data structure to insure proper alignment; e.g. 629 * 630 * struct foo { 631 * struct m_tag tag; 632 * ... 633 * }; 634 * struct foo *p = (struct foo *) m_tag_allocate(...); 635 * struct m_tag *mtag = &p->tag; 636 */ 637 638 #define PACKET_TAG_NONE 0 /* Nadda */ 639 640 /* Packet tag for use with PACKET_ABI_COMPAT */ 641 #define PACKET_TAG_IPSEC_IN_DONE 1 /* IPsec applied, in */ 642 #define PACKET_TAG_IPSEC_OUT_DONE 2 /* IPsec applied, out */ 643 #define PACKET_TAG_IPSEC_IN_CRYPTO_DONE 3 /* NIC IPsec crypto done */ 644 #define PACKET_TAG_IPSEC_OUT_CRYPTO_NEEDED 4 /* NIC IPsec crypto req'ed */ 645 #define PACKET_TAG_IPSEC_IN_COULD_DO_CRYPTO 5 /* NIC notifies IPsec */ 646 #define PACKET_TAG_IPSEC_PENDING_TDB 6 /* Reminder to do IPsec */ 647 #define PACKET_TAG_BRIDGE 7 /* Bridge processing done */ 648 #define PACKET_TAG_GIF 8 /* GIF processing done */ 649 #define PACKET_TAG_GRE 9 /* GRE processing done */ 650 #define PACKET_TAG_IN_PACKET_CHECKSUM 10 /* NIC checksumming done */ 651 #define PACKET_TAG_ENCAP 11 /* Encap. processing */ 652 #define PACKET_TAG_IPSEC_SOCKET 12 /* IPSEC socket ref */ 653 #define PACKET_TAG_IPSEC_HISTORY 13 /* IPSEC history */ 654 #define PACKET_TAG_IPV6_INPUT 14 /* IPV6 input processing */ 655 656 /* 657 * As a temporary and low impact solution to replace the even uglier 658 * approach used so far in some parts of the network stack (which relies 659 * on global variables), packet tag-like annotations are stored in MT_TAG 660 * mbufs (or lookalikes) prepended to the actual mbuf chain. 661 * 662 * m_type = MT_TAG 663 * m_flags = m_tag_id 664 * m_next = next buffer in chain. 665 * 666 * BE VERY CAREFUL not to pass these blocks to the mbuf handling routines. 667 */ 668 #define _m_tag_id m_hdr.mh_flags 669 670 /* Packet tags used in the FreeBSD network stack */ 671 #define PACKET_TAG_DUMMYNET 15 /* dummynet info */ 672 #define PACKET_TAG_IPFW 16 /* ipfw classification */ 673 #define PACKET_TAG_DIVERT 17 /* divert info */ 674 #define PACKET_TAG_IPFORWARD 18 /* ipforward info */ 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 *, struct m_tag *); 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 *, 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 struct m_tag * 694 m_tag_get(int type, int length, int wait) 695 { 696 return m_tag_alloc(MTAG_ABI_COMPAT, type, length, wait); 697 } 698 699 static __inline struct m_tag * 700 m_tag_find(struct mbuf *m, int type, struct m_tag *start) 701 { 702 return m_tag_locate(m, MTAG_ABI_COMPAT, type, start); 703 } 704 #endif /* _KERNEL */ 705 706 #endif /* !_SYS_MBUF_H_ */ 707