share/man/man9/mbuf.9

   1 .\" Copyright (c) 2000 FreeBSD Inc.
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL [your name] OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD: src/share/man/man9/mbuf.9,v 1.27.2.1 2003/05/28 13:53:18 yar Exp $
  26 .\"
  27 .Dd October 17, 2000
  28 .Dt MBUF 9
  29 .Os
  30 .\"
  31 .Sh NAME
  32 .Nm mbuf
  33 .Nd "memory management in the kernel IPC subsystem"
  34 .\"
  35 .Sh SYNOPSIS
  36 .In sys/param.h
  37 .In sys/systm.h
  38 .In sys/mbuf.h
  39 .\"
  40 .Ss Mbuf allocation macros
  41 .Fn MGET "struct mbuf *mbuf" "int how" "short type"
  42 .Fn MGETHDR "struct mbuf *mbuf" "int how" "short type"
  43 .Fn MCLGET "struct mbuf *mbuf" "int how"
  44 .Fn MFREE "struct mbuf *mbuf" "struct mbuf *successor"
  45 .\"
  46 .Ss Mbuf utility macros
  47 .Ft void *
  48 .Fn mtod "struct mbuf *mbuf" "type"
  49 .Ft int
  50 .Fn M_COPY_PKTHDR "struct mbuf *to" "struct mbuf *from"
  51 .Fn M_ALIGN "struct mbuf *mbuf" "u_int len"
  52 .Fn MH_ALIGN "struct mbuf *mbuf" "u_int len"
  53 .Ft int
  54 .Fn M_LEADINGSPACE "struct mbuf *mbuf"
  55 .Ft int
  56 .Fn M_TRAILINGSPACE "struct mbuf *mbuf"
  57 .Fn M_PREPEND "struct mbuf *mbuf" "int len" "int how"
  58 .Fn MCHTYPE "struct mbuf *mbuf" "u_int type"
  59 .\"
  60 .Ss Mbuf allocation functions
  61 .Ft struct mbuf *
  62 .Fn m_get "int how" "int type"
  63 .Ft struct mbuf *
  64 .Fn m_getm "struct mbuf *orig" "int len" "int how" "int type"
  65 .Ft struct mbuf *
  66 .Fn m_getclr "int how" "int type"
  67 .Ft struct mbuf *
  68 .Fn m_gethdr "int how" "int type"
  69 .Ft struct mbuf *
  70 .Fn m_free "struct mbuf *mbuf"
  71 .Ft void
  72 .Fn m_freem "struct mbuf *mbuf"
  73 .\"
  74 .Ss Mbuf utility functions
  75 .Ft void
  76 .Fn m_adj "struct mbuf *mbuf" "int len"
  77 .Ft struct mbuf *
  78 .Fn m_prepend "struct mbuf *mbuf" "int len" "int how"
  79 .Ft struct mbuf *
  80 .Fn m_pullup "struct mbuf *mbuf" "int len"
  81 .Ft struct mbuf *
  82 .Fn m_copym "struct mbuf *mbuf" "int offset" "int len" "int how"
  83 .Ft struct mbuf *
  84 .Fn m_copypacket "struct mbuf *mbuf" "int how"
  85 .Ft struct mbuf *
  86 .Fn m_dup "struct mbuf *mbuf" "int how"
  87 .Ft void
  88 .Fn m_copydata "const struct mbuf *mbuf" "int offset" "int len" "caddr_t buf"
  89 .Ft void
  90 .Fn m_copyback "struct mbuf *mbuf" "int offset" "int len" "caddr_t buf"
  91 .Ft struct mbuf *
  92 .Fo m_devget
  93 .Fa "char *buf"
  94 .Fa "int len"
  95 .Fa "int offset"
  96 .Fa "struct ifnet *ifp"
  97 .Fa "void (*copy)(char *from, caddr_t to, u_int len)"
  98 .Fc
  99 .Ft void
 100 .Fn m_cat "struct mbuf *m" "struct mbuf *n"
 101 .Ft struct mbuf *
 102 .Fn m_split "struct mbuf *mbuf" "int len" "int how"
 103 .\"
 104 .Sh DESCRIPTION
 105 An mbuf is a basic unit of memory management in the kernel IPC subsystem.
 106 Network packets and socket buffers are stored in mbufs.
 107 A network packet may span multiple mbufs arranged into a chain
 108 (linked list),
 109 which allows adding or trimming
 110 network headers with little overhead.
 111 .Pp
 112 While a developer should not bother with mbuf internals without serious
 113 reason in order to avoid incompatibilities with future changes, it
 114 is useful to understand the mbuf's general structure.
 115 .Pp
 116 An mbuf consists of a variable-sized header and a small internal
 117 buffer for data.
 118 The mbuf's total size,
 119 .Dv MSIZE ,
 120 is a machine-dependent constant defined in
 121 .Pa machine/param.h .
 122 The mbuf header includes:
 123 .Pp
 124 .Bl -tag -width "m_nextpkt" -compact -offset indent
 125 .It Fa m_next
 126 a pointer to the next buffer in the chain
 127 .It Fa m_nextpkt
 128 a pointer to the next chain in the queue
 129 .It Fa m_data
 130 a pointer to the data
 131 .It Fa m_len
 132 the length of the data
 133 .It Fa m_type
 134 the type of data
 135 .It Fa m_flags
 136 the mbuf flags
 137 .El
 138 .Pp
 139 The mbuf flag bits are defined as follows:
 140 .Bd -literal
 141 /* mbuf flags */
 142 #define M_EXT           0x0001  /* has associated external storage */
 143 #define M_PKTHDR        0x0002  /* start of record */
 144 #define M_EOR           0x0004  /* end of record */
 145 #define M_PROTO1        0x0010  /* protocol-specific */
 146 #define M_PROTO2        0x0020  /* protocol-specific */
 147 #define M_PROTO3        0x0040  /* protocol-specific */
 148 #define M_PROTO4        0x0080  /* protocol-specific */
 149 #define M_PROTO5        0x0100  /* protocol-specific */
 150
 151 /* mbuf pkthdr flags, also in m_flags */
 152 #define M_BCAST         0x0200  /* send/received as link-level broadcast */
 153 #define M_MCAST         0x0400  /* send/received as link-level multicast */
 154 #define M_FRAG          0x0800  /* packet is fragment of larger packet */
 155 #define M_FIRSTFRAG     0x1000  /* packet is first fragment */
 156 #define M_LASTFRAG      0x2000  /* packet is last fragment */
 157 .Ed
 158 .Pp
 159 The available mbuf types are defined as follows:
 160 .Bd -literal
 161 /* mbuf types */
 162 #define MT_FREE         0       /* should be on free list */
 163 #define MT_DATA         1       /* dynamic (data) allocation */
 164 #define MT_HEADER       2       /* packet header */
 165 #define MT_SONAME       8       /* socket name */
 166 #define MT_FTABLE       11      /* fragment reassembly header */
 167 #define MT_CONTROL      14      /* extra-data protocol message */
 168 #define MT_OOBDATA      15      /* expedited data  */
 169 .Ed
 170 .Pp
 171 If the
 172 .Dv M_PKTHDR
 173 flag is set, a
 174 .Li struct pkthdr m_pkthdr
 175 is added to the mbuf header.
 176 It contains a pointer to the interface
 177 the packet has been received from
 178 .Pq Fa struct ifnet *rcvif ,
 179 and the total packet length
 180 .Pq Fa int len .
 181 .Pp
 182 If small enough, data is stored in the mbuf's internal data buffer.
 183 If the data is sufficiently large, another mbuf may be added to the chain,
 184 or external storage may be associated with the mbuf.
 185 .Dv MHLEN
 186 bytes of data can fit into an mbuf with the
 187 .Dv M_PKTHDR
 188 flag set,
 189 .Dv MLEN
 190 bytes can otherwise.
 191 .Pp
 192 If external storage is being associated with an mbuf, the
 193 .Dv m_ext
 194 header is added at the cost of losing the internal data buffer.
 195 It includes a pointer to external storage, the size of the storage,
 196 a pointer to a function used for freeing the storage,
 197 a pointer to an optional argument that can be passed to the function,
 198 and a pointer to a reference counter.
 199 An mbuf using external storage has the
 200 .Dv M_EXT
 201 flag set.
 202 .Pp
 203 The system supplies a default type of external storage buffer called an
 204 .Dq mbuf cluster .
 205 Mbuf clusters can be allocated and configured with the use of the
 206 .Dv MCLGET
 207 macro.
 208 Each cluster is
 209 .Dv MCLBYTES
 210 in size, where MCLBYTES is a machine-dependent constant.
 211 The system defines an advisory macro
 212 .Dv MINCLSIZE ,
 213 which is the smallest amount of data to put into a cluster.
 214 It's equal to the sum of
 215 .Dv MLEN
 216 and
 217 .Dv MHLEN .
 218 It is typically preferable to store data into an mbuf's data region, if size
 219 permits, as opposed to allocating a separate mbuf cluster to hold the same
 220 data.
 221 .\"
 222 .Ss Macros and Functions
 223 There are numerous predefined macros and functions that provide the
 224 developer with common utilities.
 225 .\"
 226 .Bl -ohang -offset indent
 227 .It Fn mtod mbuf type
 228 Convert an mbuf pointer to a data pointer.
 229 The macro expands to the data pointer cast to the pointer of the specified type.
 230 .Sy Note :
 231 It is advisable to ensure that there is enough contiguous data in the mbuf.
 232 See
 233 .Fn m_pullup
 234 for details.
 235 .It Fn MGET mbuf how type
 236 Allocate an mbuf and initialize it to contain internal data.
 237 .Fa mbuf
 238 will point to the allocated mbuf on success, or be set to
 239 .Dv NULL
 240 on failure.
 241 The
 242 .Fa how
 243 argument is to be set to
 244 .Dv M_WAIT
 245 or
 246 .Dv M_DONTWAIT .
 247 It specifies whether the caller is willing to block if necessary.
 248 If
 249 .Fa how
 250 is set to
 251 .Dv M_WAIT ,
 252 a failed allocation will result in the caller being put
 253 to sleep for a designated
 254 kern.ipc.mbuf_wait
 255 .Xr ( sysctl 8
 256 tunable)
 257 number of ticks.
 258 A number of other mbuf-related
 259 functions and macros have the same argument because they may
 260 at some point need to allocate new mbufs.
 261 .Pp
 262 Programmers should be careful not to confuse the mbuf allocation flag
 263 .Dv M_DONTWAIT
 264 with the
 265 .Xr malloc 9
 266 allocation flag,
 267 .Dv M_NOWAIT .
 268 They are not the same.
 269 .It Fn MGETHDR mbuf how type
 270 Allocate an mbuf and initialize it to contain a packet header
 271 and internal data.
 272 See
 273 .Fn MGET
 274 for details.
 275 .It Fn MCLGET mbuf how
 276 Allocate and attach an mbuf cluster to an mbuf.
 277 If the macro fails, the
 278 .Dv M_EXT
 279 flag won't be set in the mbuf.
 280 .It Fn M_PREPEND mbuf len how
 281 This macro operates on an mbuf chain.
 282 It is an optimized wrapper for
 283 .Fn m_prepend
 284 that can make use of possible empty space before data
 285 (e.g. left after trimming of a link-layer header).
 286 The new chain pointer or
 287 .Dv NULL
 288 is in
 289 .Fa mbuf
 290 after the call.
 291 .El
 292 .Pp
 293 The functions are:
 294 .Bl -ohang -offset indent
 295 .It Fn m_get how type
 296 A function version of
 297 .Fn MGET
 298 for non-critical paths.
 299 .It Fn m_getm orig len how type
 300 Allocate
 301 .Fa len
 302 bytes worth of mbufs and mbuf clusters if necessary and append the resulting
 303 allocated chain to the
 304 .Fa orig
 305 mbuf chain, if it is
 306 .No non- Ns Dv NULL .
 307 If the allocation fails at any point,
 308 free whatever was allocated and return
 309 .Dv NULL .
 310 If
 311 .Fa orig
 312 is
 313 .No non- Ns Dv NULL ,
 314 it will not be freed.
 315 It is possible to use
 316 .Fn m_getm
 317 to either append
 318 .Fa len
 319 bytes to an existing mbuf or mbuf chain
 320 (for example, one which may be sitting in a pre-allocated ring)
 321 or to simply perform an all-or-nothing mbuf and mbuf cluster allocation.
 322 .It Fn m_gethdr how type
 323 A function version of
 324 .Fn MGETHDR
 325 for non-critical paths.
 326 .It Fn m_getclr how type
 327 Allocate an mbuf and zero out the data region.
 328 .El
 329 .Pp
 330 The functions below operate on mbuf chains.
 331 .Bl -ohang -offset indent
 332 .It Fn m_freem mbuf
 333 Free an entire mbuf chain, including any external
 334 storage.
 335 .\"
 336 .It Fn m_adj mbuf len
 337 Trim
 338 .Fa len
 339 bytes from the head of an mbuf chain if
 340 .Fa len
 341 is positive, from the tail otherwise.
 342 .\"
 343 .It Fn m_prepend mbuf len how
 344 Allocate a new mbuf and prepend it to the chain, handle
 345 .Dv M_PKTHDR
 346 properly.
 347 .Sy Note :
 348 It doesn't allocate any clusters, so
 349 .Fa len
 350 must be less than
 351 .Dv MLEN
 352 or
 353 .Dv MHLEN ,
 354 depending on the
 355 .Dv M_PKTHDR
 356 flag setting.
 357 .\"
 358 .It Fn m_pullup mbuf len
 359 Arrange that the first
 360 .Fa len
 361 bytes of an mbuf chain are contiguous and lay in the data area of
 362 .Fa mbuf ,
 363 so they are accessible with
 364 .Fn mtod mbuf type .
 365 Return the new chain on success,
 366 .Dv NULL
 367 on failure
 368 (the chain is freed in this case).
 369 .Sy Note :
 370 It doesn't allocate any clusters, so
 371 .Fa len
 372 must be less than
 373 .Dv MHLEN .
 374 .\"
 375 .It Fn m_copym mbuf offset len how
 376 Make a copy of an mbuf chain starting
 377 .Fa offset
 378 bytes from the beginning, continuing for
 379 .Fa len
 380 bytes.
 381 If
 382 .Fa len
 383 is
 384 .Dv M_COPYALL ,
 385 copy to the end of the mbuf chain.
 386 .Sy Note :
 387 The copy is read-only, because clusters are not
 388 copied, only their reference counts are incremented.
 389 .\"
 390 .It Fn m_copypacket mbuf how
 391 Copy an entire packet including header, which must be present.
 392 This is an optimized version of the common case
 393 .Fn m_copym mbuf 0 M_COPYALL how .
 394 .Sy Note :
 395 the copy is read-only, because clusters are not
 396 copied, only their reference counts are incremented.
 397 .\"
 398 .It Fn m_dup mbuf how
 399 Copy a packet header mbuf chain into a completely new chain, including
 400 copying any mbuf clusters.
 401 Use this instead of
 402 .Fn m_copypacket
 403 when you need a writable copy of an mbuf chain.
 404 .\"
 405 .It Fn m_copydata mbuf offset len buf
 406 Copy data from an mbuf chain starting
 407 .Fa off
 408 bytes from the beginning, continuing for
 409 .Fa len
 410 bytes, into the indicated buffer
 411 .Fa buf .
 412 .\"
 413 .It Fn m_copyback mbuf offset len buf
 414 Copy
 415 .Fa len
 416 bytes from the buffer
 417 .Fa buf
 418 back into the indicated mbuf chain,
 419 starting at
 420 .Fa offset
 421 bytes from the beginning of the chain, extending the mbuf chain if necessary.
 422 .Sy Note :
 423 It doesn't allocate any clusters, just adds mbufs to the chain.
 424 It's safe to set
 425 .Fa offset
 426 beyond the current chain end: zeroed mbufs will be allocated to fill the
 427 space.
 428 .\"
 429 .It Fn m_devget buf len offset ifp copy
 430 Copy data from a device local memory pointed to by
 431 .Fa buf
 432 to an mbuf chain.
 433 The copy is done using a specified copy routine
 434 .Fa copy ,
 435 or
 436 .Fn bcopy
 437 if
 438 .Fa copy
 439 is
 440 .Dv NULL .
 441 .\"
 442 .It Fn m_cat m n
 443 Concatenate
 444 .Fa n
 445 to
 446 .Fa m .
 447 Both chains must be of the same type.
 448 .Fa N
 449 is still valid after the function returned.
 450 .Sy Note :
 451 It does not handle
 452 .Dv M_PKTHDR
 453 and friends.
 454 .\"
 455 .It Fn m_split mbuf len how
 456 Partition an mbuf chain in two pieces, returning the tail:
 457 all but the first
 458 .Fa len
 459 bytes.
 460 In case of failure, it returns
 461 .Dv NULL
 462 and attempts to restore the chain to its original state.
 463 .El
 464 .Sh RETURN VALUES
 465 See above.
 466 .Sh HISTORY
 467 .\" Please correct me if I'm wrong
 468 Mbufs appeared in an early version of
 469 .Bx .
 470 Besides for being used for network packets, they were used
 471 to store various dynamic structures, such as routing table
 472 entries, interface addresses, protocol control blocks, etc.
 473 .Sh AUTHORS
 474 The original
 475 .Nm
 476 man page was written by Yar Tikhiy.