]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - sys/kern/uipc_mbuf.c
MFV r276759: libpcap 1.6.2.
[FreeBSD/FreeBSD.git] / sys / kern / uipc_mbuf.c
1 /*-
2  * Copyright (c) 1982, 1986, 1988, 1991, 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  * 4. Neither the name of the University nor the names of its contributors
14  *    may be used to endorse or promote products derived from this software
15  *    without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  *      @(#)uipc_mbuf.c 8.2 (Berkeley) 1/4/94
30  */
31
32 #include <sys/cdefs.h>
33 __FBSDID("$FreeBSD$");
34
35 #include "opt_param.h"
36 #include "opt_mbuf_stress_test.h"
37 #include "opt_mbuf_profiling.h"
38
39 #include <sys/param.h>
40 #include <sys/systm.h>
41 #include <sys/kernel.h>
42 #include <sys/limits.h>
43 #include <sys/lock.h>
44 #include <sys/malloc.h>
45 #include <sys/mbuf.h>
46 #include <sys/sysctl.h>
47 #include <sys/domain.h>
48 #include <sys/protosw.h>
49 #include <sys/uio.h>
50
51 int     max_linkhdr;
52 int     max_protohdr;
53 int     max_hdr;
54 int     max_datalen;
55 #ifdef MBUF_STRESS_TEST
56 int     m_defragpackets;
57 int     m_defragbytes;
58 int     m_defraguseless;
59 int     m_defragfailure;
60 int     m_defragrandomfailures;
61 #endif
62
63 /*
64  * sysctl(8) exported objects
65  */
66 SYSCTL_INT(_kern_ipc, KIPC_MAX_LINKHDR, max_linkhdr, CTLFLAG_RD,
67            &max_linkhdr, 0, "Size of largest link layer header");
68 SYSCTL_INT(_kern_ipc, KIPC_MAX_PROTOHDR, max_protohdr, CTLFLAG_RD,
69            &max_protohdr, 0, "Size of largest protocol layer header");
70 SYSCTL_INT(_kern_ipc, KIPC_MAX_HDR, max_hdr, CTLFLAG_RD,
71            &max_hdr, 0, "Size of largest link plus protocol header");
72 SYSCTL_INT(_kern_ipc, KIPC_MAX_DATALEN, max_datalen, CTLFLAG_RD,
73            &max_datalen, 0, "Minimum space left in mbuf after max_hdr");
74 #ifdef MBUF_STRESS_TEST
75 SYSCTL_INT(_kern_ipc, OID_AUTO, m_defragpackets, CTLFLAG_RD,
76            &m_defragpackets, 0, "");
77 SYSCTL_INT(_kern_ipc, OID_AUTO, m_defragbytes, CTLFLAG_RD,
78            &m_defragbytes, 0, "");
79 SYSCTL_INT(_kern_ipc, OID_AUTO, m_defraguseless, CTLFLAG_RD,
80            &m_defraguseless, 0, "");
81 SYSCTL_INT(_kern_ipc, OID_AUTO, m_defragfailure, CTLFLAG_RD,
82            &m_defragfailure, 0, "");
83 SYSCTL_INT(_kern_ipc, OID_AUTO, m_defragrandomfailures, CTLFLAG_RW,
84            &m_defragrandomfailures, 0, "");
85 #endif
86
87 /*
88  * Ensure the correct size of various mbuf parameters.  It could be off due
89  * to compiler-induced padding and alignment artifacts.
90  */
91 CTASSERT(sizeof(struct mbuf) == MSIZE);
92 CTASSERT(MSIZE - offsetof(struct mbuf, m_dat) == MLEN);
93 CTASSERT(MSIZE - offsetof(struct mbuf, m_pktdat) == MHLEN);
94
95 /*
96  * m_get2() allocates minimum mbuf that would fit "size" argument.
97  */
98 struct mbuf *
99 m_get2(int size, int how, short type, int flags)
100 {
101         struct mb_args args;
102         struct mbuf *m, *n;
103
104         args.flags = flags;
105         args.type = type;
106
107         if (size <= MHLEN || (size <= MLEN && (flags & M_PKTHDR) == 0))
108                 return (uma_zalloc_arg(zone_mbuf, &args, how));
109         if (size <= MCLBYTES)
110                 return (uma_zalloc_arg(zone_pack, &args, how));
111
112         if (size > MJUMPAGESIZE)
113                 return (NULL);
114
115         m = uma_zalloc_arg(zone_mbuf, &args, how);
116         if (m == NULL)
117                 return (NULL);
118
119         n = uma_zalloc_arg(zone_jumbop, m, how);
120         if (n == NULL) {
121                 uma_zfree(zone_mbuf, m);
122                 return (NULL);
123         }
124
125         return (m);
126 }
127
128 /*
129  * m_getjcl() returns an mbuf with a cluster of the specified size attached.
130  * For size it takes MCLBYTES, MJUMPAGESIZE, MJUM9BYTES, MJUM16BYTES.
131  */
132 struct mbuf *
133 m_getjcl(int how, short type, int flags, int size)
134 {
135         struct mb_args args;
136         struct mbuf *m, *n;
137         uma_zone_t zone;
138
139         if (size == MCLBYTES)
140                 return m_getcl(how, type, flags);
141
142         args.flags = flags;
143         args.type = type;
144
145         m = uma_zalloc_arg(zone_mbuf, &args, how);
146         if (m == NULL)
147                 return (NULL);
148
149         zone = m_getzone(size);
150         n = uma_zalloc_arg(zone, m, how);
151         if (n == NULL) {
152                 uma_zfree(zone_mbuf, m);
153                 return (NULL);
154         }
155         return (m);
156 }
157
158 /*
159  * Allocate a given length worth of mbufs and/or clusters (whatever fits
160  * best) and return a pointer to the top of the allocated chain.  If an
161  * existing mbuf chain is provided, then we will append the new chain
162  * to the existing one but still return the top of the newly allocated
163  * chain.
164  */
165 struct mbuf *
166 m_getm2(struct mbuf *m, int len, int how, short type, int flags)
167 {
168         struct mbuf *mb, *nm = NULL, *mtail = NULL;
169
170         KASSERT(len >= 0, ("%s: len is < 0", __func__));
171
172         /* Validate flags. */
173         flags &= (M_PKTHDR | M_EOR);
174
175         /* Packet header mbuf must be first in chain. */
176         if ((flags & M_PKTHDR) && m != NULL)
177                 flags &= ~M_PKTHDR;
178
179         /* Loop and append maximum sized mbufs to the chain tail. */
180         while (len > 0) {
181                 if (len > MCLBYTES)
182                         mb = m_getjcl(how, type, (flags & M_PKTHDR),
183                             MJUMPAGESIZE);
184                 else if (len >= MINCLSIZE)
185                         mb = m_getcl(how, type, (flags & M_PKTHDR));
186                 else if (flags & M_PKTHDR)
187                         mb = m_gethdr(how, type);
188                 else
189                         mb = m_get(how, type);
190
191                 /* Fail the whole operation if one mbuf can't be allocated. */
192                 if (mb == NULL) {
193                         if (nm != NULL)
194                                 m_freem(nm);
195                         return (NULL);
196                 }
197
198                 /* Book keeping. */
199                 len -= (mb->m_flags & M_EXT) ? mb->m_ext.ext_size :
200                         ((mb->m_flags & M_PKTHDR) ? MHLEN : MLEN);
201                 if (mtail != NULL)
202                         mtail->m_next = mb;
203                 else
204                         nm = mb;
205                 mtail = mb;
206                 flags &= ~M_PKTHDR;     /* Only valid on the first mbuf. */
207         }
208         if (flags & M_EOR)
209                 mtail->m_flags |= M_EOR;  /* Only valid on the last mbuf. */
210
211         /* If mbuf was supplied, append new chain to the end of it. */
212         if (m != NULL) {
213                 for (mtail = m; mtail->m_next != NULL; mtail = mtail->m_next)
214                         ;
215                 mtail->m_next = nm;
216                 mtail->m_flags &= ~M_EOR;
217         } else
218                 m = nm;
219
220         return (m);
221 }
222
223 /*
224  * Free an entire chain of mbufs and associated external buffers, if
225  * applicable.
226  */
227 void
228 m_freem(struct mbuf *mb)
229 {
230
231         while (mb != NULL)
232                 mb = m_free(mb);
233 }
234
235 /*-
236  * Configure a provided mbuf to refer to the provided external storage
237  * buffer and setup a reference count for said buffer.  If the setting
238  * up of the reference count fails, the M_EXT bit will not be set.  If
239  * successfull, the M_EXT bit is set in the mbuf's flags.
240  *
241  * Arguments:
242  *    mb     The existing mbuf to which to attach the provided buffer.
243  *    buf    The address of the provided external storage buffer.
244  *    size   The size of the provided buffer.
245  *    freef  A pointer to a routine that is responsible for freeing the
246  *           provided external storage buffer.
247  *    args   A pointer to an argument structure (of any type) to be passed
248  *           to the provided freef routine (may be NULL).
249  *    flags  Any other flags to be passed to the provided mbuf.
250  *    type   The type that the external storage buffer should be
251  *           labeled with.
252  *
253  * Returns:
254  *    Nothing.
255  */
256 int
257 m_extadd(struct mbuf *mb, caddr_t buf, u_int size,
258     void (*freef)(struct mbuf *, void *, void *), void *arg1, void *arg2,
259     int flags, int type, int wait)
260 {
261         KASSERT(type != EXT_CLUSTER, ("%s: EXT_CLUSTER not allowed", __func__));
262
263         if (type != EXT_EXTREF)
264                 mb->m_ext.ext_cnt = uma_zalloc(zone_ext_refcnt, wait);
265
266         if (mb->m_ext.ext_cnt == NULL)
267                 return (ENOMEM);
268
269         *(mb->m_ext.ext_cnt) = 1;
270         mb->m_flags |= (M_EXT | flags);
271         mb->m_ext.ext_buf = buf;
272         mb->m_data = mb->m_ext.ext_buf;
273         mb->m_ext.ext_size = size;
274         mb->m_ext.ext_free = freef;
275         mb->m_ext.ext_arg1 = arg1;
276         mb->m_ext.ext_arg2 = arg2;
277         mb->m_ext.ext_type = type;
278         mb->m_ext.ext_flags = 0;
279
280         return (0);
281 }
282
283 /*
284  * Non-directly-exported function to clean up after mbufs with M_EXT
285  * storage attached to them if the reference count hits 1.
286  */
287 void
288 mb_free_ext(struct mbuf *m)
289 {
290         int freembuf;
291
292         KASSERT(m->m_flags & M_EXT, ("%s: M_EXT not set on %p", __func__, m));
293
294         /*
295          * Check if the header is embedded in the cluster.
296          */
297         freembuf = (m->m_flags & M_NOFREE) ? 0 : 1;
298
299         switch (m->m_ext.ext_type) {
300         case EXT_SFBUF:
301                 sf_ext_free(m->m_ext.ext_arg1, m->m_ext.ext_arg2);
302                 break;
303         default:
304                 KASSERT(m->m_ext.ext_cnt != NULL,
305                     ("%s: no refcounting pointer on %p", __func__, m));
306                 /* 
307                  * Free attached storage if this mbuf is the only
308                  * reference to it.
309                  */
310                 if (*(m->m_ext.ext_cnt) != 1) {
311                         if (atomic_fetchadd_int(m->m_ext.ext_cnt, -1) != 1)
312                                 break;
313                 }
314
315                 switch (m->m_ext.ext_type) {
316                 case EXT_PACKET:        /* The packet zone is special. */
317                         if (*(m->m_ext.ext_cnt) == 0)
318                                 *(m->m_ext.ext_cnt) = 1;
319                         uma_zfree(zone_pack, m);
320                         return;         /* Job done. */
321                 case EXT_CLUSTER:
322                         uma_zfree(zone_clust, m->m_ext.ext_buf);
323                         break;
324                 case EXT_JUMBOP:
325                         uma_zfree(zone_jumbop, m->m_ext.ext_buf);
326                         break;
327                 case EXT_JUMBO9:
328                         uma_zfree(zone_jumbo9, m->m_ext.ext_buf);
329                         break;
330                 case EXT_JUMBO16:
331                         uma_zfree(zone_jumbo16, m->m_ext.ext_buf);
332                         break;
333                 case EXT_NET_DRV:
334                 case EXT_MOD_TYPE:
335                 case EXT_DISPOSABLE:
336                         *(m->m_ext.ext_cnt) = 0;
337                         uma_zfree(zone_ext_refcnt, __DEVOLATILE(u_int *,
338                                 m->m_ext.ext_cnt));
339                         /* FALLTHROUGH */
340                 case EXT_EXTREF:
341                         KASSERT(m->m_ext.ext_free != NULL,
342                                 ("%s: ext_free not set", __func__));
343                         (*(m->m_ext.ext_free))(m, m->m_ext.ext_arg1,
344                             m->m_ext.ext_arg2);
345                         break;
346                 default:
347                         KASSERT(m->m_ext.ext_type == 0,
348                                 ("%s: unknown ext_type", __func__));
349                 }
350         }
351
352         if (freembuf)
353                 uma_zfree(zone_mbuf, m);
354 }
355
356 /*
357  * Attach the cluster from *m to *n, set up m_ext in *n
358  * and bump the refcount of the cluster.
359  */
360 static void
361 mb_dupcl(struct mbuf *n, struct mbuf *m)
362 {
363
364         KASSERT(m->m_flags & M_EXT, ("%s: M_EXT not set on %p", __func__, m));
365         KASSERT(!(n->m_flags & M_EXT), ("%s: M_EXT set on %p", __func__, n));
366
367         switch (m->m_ext.ext_type) {
368         case EXT_SFBUF:
369                 sf_ext_ref(m->m_ext.ext_arg1, m->m_ext.ext_arg2);
370                 break;
371         default:
372                 KASSERT(m->m_ext.ext_cnt != NULL,
373                     ("%s: no refcounting pointer on %p", __func__, m));
374                 if (*(m->m_ext.ext_cnt) == 1)
375                         *(m->m_ext.ext_cnt) += 1;
376                 else
377                         atomic_add_int(m->m_ext.ext_cnt, 1);
378         }
379
380         n->m_ext = m->m_ext;
381         n->m_flags |= M_EXT;
382         n->m_flags |= m->m_flags & M_RDONLY;
383 }
384
385 /*
386  * Clean up mbuf (chain) from any tags and packet headers.
387  * If "all" is set then the first mbuf in the chain will be
388  * cleaned too.
389  */
390 void
391 m_demote(struct mbuf *m0, int all, int flags)
392 {
393         struct mbuf *m;
394
395         for (m = all ? m0 : m0->m_next; m != NULL; m = m->m_next) {
396                 KASSERT(m->m_nextpkt == NULL, ("%s: m_nextpkt in m %p, m0 %p",
397                     __func__, m, m0));
398                 if (m->m_flags & M_PKTHDR) {
399                         m_tag_delete_chain(m, NULL);
400                         m->m_flags &= ~M_PKTHDR;
401                         bzero(&m->m_pkthdr, sizeof(struct pkthdr));
402                 }
403                 m->m_flags = m->m_flags & (M_EXT | M_RDONLY | M_NOFREE | flags);
404         }
405 }
406
407 /*
408  * Sanity checks on mbuf (chain) for use in KASSERT() and general
409  * debugging.
410  * Returns 0 or panics when bad and 1 on all tests passed.
411  * Sanitize, 0 to run M_SANITY_ACTION, 1 to garble things so they
412  * blow up later.
413  */
414 int
415 m_sanity(struct mbuf *m0, int sanitize)
416 {
417         struct mbuf *m;
418         caddr_t a, b;
419         int pktlen = 0;
420
421 #ifdef INVARIANTS
422 #define M_SANITY_ACTION(s)      panic("mbuf %p: " s, m)
423 #else
424 #define M_SANITY_ACTION(s)      printf("mbuf %p: " s, m)
425 #endif
426
427         for (m = m0; m != NULL; m = m->m_next) {
428                 /*
429                  * Basic pointer checks.  If any of these fails then some
430                  * unrelated kernel memory before or after us is trashed.
431                  * No way to recover from that.
432                  */
433                 a = ((m->m_flags & M_EXT) ? m->m_ext.ext_buf :
434                         ((m->m_flags & M_PKTHDR) ? (caddr_t)(&m->m_pktdat) :
435                          (caddr_t)(&m->m_dat)) );
436                 b = (caddr_t)(a + (m->m_flags & M_EXT ? m->m_ext.ext_size :
437                         ((m->m_flags & M_PKTHDR) ? MHLEN : MLEN)));
438                 if ((caddr_t)m->m_data < a)
439                         M_SANITY_ACTION("m_data outside mbuf data range left");
440                 if ((caddr_t)m->m_data > b)
441                         M_SANITY_ACTION("m_data outside mbuf data range right");
442                 if ((caddr_t)m->m_data + m->m_len > b)
443                         M_SANITY_ACTION("m_data + m_len exeeds mbuf space");
444
445                 /* m->m_nextpkt may only be set on first mbuf in chain. */
446                 if (m != m0 && m->m_nextpkt != NULL) {
447                         if (sanitize) {
448                                 m_freem(m->m_nextpkt);
449                                 m->m_nextpkt = (struct mbuf *)0xDEADC0DE;
450                         } else
451                                 M_SANITY_ACTION("m->m_nextpkt on in-chain mbuf");
452                 }
453
454                 /* packet length (not mbuf length!) calculation */
455                 if (m0->m_flags & M_PKTHDR)
456                         pktlen += m->m_len;
457
458                 /* m_tags may only be attached to first mbuf in chain. */
459                 if (m != m0 && m->m_flags & M_PKTHDR &&
460                     !SLIST_EMPTY(&m->m_pkthdr.tags)) {
461                         if (sanitize) {
462                                 m_tag_delete_chain(m, NULL);
463                                 /* put in 0xDEADC0DE perhaps? */
464                         } else
465                                 M_SANITY_ACTION("m_tags on in-chain mbuf");
466                 }
467
468                 /* M_PKTHDR may only be set on first mbuf in chain */
469                 if (m != m0 && m->m_flags & M_PKTHDR) {
470                         if (sanitize) {
471                                 bzero(&m->m_pkthdr, sizeof(m->m_pkthdr));
472                                 m->m_flags &= ~M_PKTHDR;
473                                 /* put in 0xDEADCODE and leave hdr flag in */
474                         } else
475                                 M_SANITY_ACTION("M_PKTHDR on in-chain mbuf");
476                 }
477         }
478         m = m0;
479         if (pktlen && pktlen != m->m_pkthdr.len) {
480                 if (sanitize)
481                         m->m_pkthdr.len = 0;
482                 else
483                         M_SANITY_ACTION("m_pkthdr.len != mbuf chain length");
484         }
485         return 1;
486
487 #undef  M_SANITY_ACTION
488 }
489
490
491 /*
492  * "Move" mbuf pkthdr from "from" to "to".
493  * "from" must have M_PKTHDR set, and "to" must be empty.
494  */
495 void
496 m_move_pkthdr(struct mbuf *to, struct mbuf *from)
497 {
498
499 #if 0
500         /* see below for why these are not enabled */
501         M_ASSERTPKTHDR(to);
502         /* Note: with MAC, this may not be a good assertion. */
503         KASSERT(SLIST_EMPTY(&to->m_pkthdr.tags),
504             ("m_move_pkthdr: to has tags"));
505 #endif
506 #ifdef MAC
507         /*
508          * XXXMAC: It could be this should also occur for non-MAC?
509          */
510         if (to->m_flags & M_PKTHDR)
511                 m_tag_delete_chain(to, NULL);
512 #endif
513         to->m_flags = (from->m_flags & M_COPYFLAGS) | (to->m_flags & M_EXT);
514         if ((to->m_flags & M_EXT) == 0)
515                 to->m_data = to->m_pktdat;
516         to->m_pkthdr = from->m_pkthdr;          /* especially tags */
517         SLIST_INIT(&from->m_pkthdr.tags);       /* purge tags from src */
518         from->m_flags &= ~M_PKTHDR;
519 }
520
521 /*
522  * Duplicate "from"'s mbuf pkthdr in "to".
523  * "from" must have M_PKTHDR set, and "to" must be empty.
524  * In particular, this does a deep copy of the packet tags.
525  */
526 int
527 m_dup_pkthdr(struct mbuf *to, struct mbuf *from, int how)
528 {
529
530 #if 0
531         /*
532          * The mbuf allocator only initializes the pkthdr
533          * when the mbuf is allocated with m_gethdr(). Many users
534          * (e.g. m_copy*, m_prepend) use m_get() and then
535          * smash the pkthdr as needed causing these
536          * assertions to trip.  For now just disable them.
537          */
538         M_ASSERTPKTHDR(to);
539         /* Note: with MAC, this may not be a good assertion. */
540         KASSERT(SLIST_EMPTY(&to->m_pkthdr.tags), ("m_dup_pkthdr: to has tags"));
541 #endif
542         MBUF_CHECKSLEEP(how);
543 #ifdef MAC
544         if (to->m_flags & M_PKTHDR)
545                 m_tag_delete_chain(to, NULL);
546 #endif
547         to->m_flags = (from->m_flags & M_COPYFLAGS) | (to->m_flags & M_EXT);
548         if ((to->m_flags & M_EXT) == 0)
549                 to->m_data = to->m_pktdat;
550         to->m_pkthdr = from->m_pkthdr;
551         SLIST_INIT(&to->m_pkthdr.tags);
552         return (m_tag_copy_chain(to, from, how));
553 }
554
555 /*
556  * Lesser-used path for M_PREPEND:
557  * allocate new mbuf to prepend to chain,
558  * copy junk along.
559  */
560 struct mbuf *
561 m_prepend(struct mbuf *m, int len, int how)
562 {
563         struct mbuf *mn;
564
565         if (m->m_flags & M_PKTHDR)
566                 mn = m_gethdr(how, m->m_type);
567         else
568                 mn = m_get(how, m->m_type);
569         if (mn == NULL) {
570                 m_freem(m);
571                 return (NULL);
572         }
573         if (m->m_flags & M_PKTHDR)
574                 m_move_pkthdr(mn, m);
575         mn->m_next = m;
576         m = mn;
577         if (len < M_SIZE(m))
578                 M_ALIGN(m, len);
579         m->m_len = len;
580         return (m);
581 }
582
583 /*
584  * Make a copy of an mbuf chain starting "off0" bytes from the beginning,
585  * continuing for "len" bytes.  If len is M_COPYALL, copy to end of mbuf.
586  * The wait parameter is a choice of M_WAITOK/M_NOWAIT from caller.
587  * Note that the copy is read-only, because clusters are not copied,
588  * only their reference counts are incremented.
589  */
590 struct mbuf *
591 m_copym(struct mbuf *m, int off0, int len, int wait)
592 {
593         struct mbuf *n, **np;
594         int off = off0;
595         struct mbuf *top;
596         int copyhdr = 0;
597
598         KASSERT(off >= 0, ("m_copym, negative off %d", off));
599         KASSERT(len >= 0, ("m_copym, negative len %d", len));
600         MBUF_CHECKSLEEP(wait);
601         if (off == 0 && m->m_flags & M_PKTHDR)
602                 copyhdr = 1;
603         while (off > 0) {
604                 KASSERT(m != NULL, ("m_copym, offset > size of mbuf chain"));
605                 if (off < m->m_len)
606                         break;
607                 off -= m->m_len;
608                 m = m->m_next;
609         }
610         np = &top;
611         top = 0;
612         while (len > 0) {
613                 if (m == NULL) {
614                         KASSERT(len == M_COPYALL,
615                             ("m_copym, length > size of mbuf chain"));
616                         break;
617                 }
618                 if (copyhdr)
619                         n = m_gethdr(wait, m->m_type);
620                 else
621                         n = m_get(wait, m->m_type);
622                 *np = n;
623                 if (n == NULL)
624                         goto nospace;
625                 if (copyhdr) {
626                         if (!m_dup_pkthdr(n, m, wait))
627                                 goto nospace;
628                         if (len == M_COPYALL)
629                                 n->m_pkthdr.len -= off0;
630                         else
631                                 n->m_pkthdr.len = len;
632                         copyhdr = 0;
633                 }
634                 n->m_len = min(len, m->m_len - off);
635                 if (m->m_flags & M_EXT) {
636                         n->m_data = m->m_data + off;
637                         mb_dupcl(n, m);
638                 } else
639                         bcopy(mtod(m, caddr_t)+off, mtod(n, caddr_t),
640                             (u_int)n->m_len);
641                 if (len != M_COPYALL)
642                         len -= n->m_len;
643                 off = 0;
644                 m = m->m_next;
645                 np = &n->m_next;
646         }
647
648         return (top);
649 nospace:
650         m_freem(top);
651         return (NULL);
652 }
653
654 /*
655  * Returns mbuf chain with new head for the prepending case.
656  * Copies from mbuf (chain) n from off for len to mbuf (chain) m
657  * either prepending or appending the data.
658  * The resulting mbuf (chain) m is fully writeable.
659  * m is destination (is made writeable)
660  * n is source, off is offset in source, len is len from offset
661  * dir, 0 append, 1 prepend
662  * how, wait or nowait
663  */
664
665 static int
666 m_bcopyxxx(void *s, void *t, u_int len)
667 {
668         bcopy(s, t, (size_t)len);
669         return 0;
670 }
671
672 struct mbuf *
673 m_copymdata(struct mbuf *m, struct mbuf *n, int off, int len,
674     int prep, int how)
675 {
676         struct mbuf *mm, *x, *z, *prev = NULL;
677         caddr_t p;
678         int i, nlen = 0;
679         caddr_t buf[MLEN];
680
681         KASSERT(m != NULL && n != NULL, ("m_copymdata, no target or source"));
682         KASSERT(off >= 0, ("m_copymdata, negative off %d", off));
683         KASSERT(len >= 0, ("m_copymdata, negative len %d", len));
684         KASSERT(prep == 0 || prep == 1, ("m_copymdata, unknown direction %d", prep));
685
686         mm = m;
687         if (!prep) {
688                 while(mm->m_next) {
689                         prev = mm;
690                         mm = mm->m_next;
691                 }
692         }
693         for (z = n; z != NULL; z = z->m_next)
694                 nlen += z->m_len;
695         if (len == M_COPYALL)
696                 len = nlen - off;
697         if (off + len > nlen || len < 1)
698                 return NULL;
699
700         if (!M_WRITABLE(mm)) {
701                 /* XXX: Use proper m_xxx function instead. */
702                 x = m_getcl(how, MT_DATA, mm->m_flags);
703                 if (x == NULL)
704                         return NULL;
705                 bcopy(mm->m_ext.ext_buf, x->m_ext.ext_buf, x->m_ext.ext_size);
706                 p = x->m_ext.ext_buf + (mm->m_data - mm->m_ext.ext_buf);
707                 x->m_data = p;
708                 mm->m_next = NULL;
709                 if (mm != m)
710                         prev->m_next = x;
711                 m_free(mm);
712                 mm = x;
713         }
714
715         /*
716          * Append/prepend the data.  Allocating mbufs as necessary.
717          */
718         /* Shortcut if enough free space in first/last mbuf. */
719         if (!prep && M_TRAILINGSPACE(mm) >= len) {
720                 m_apply(n, off, len, m_bcopyxxx, mtod(mm, caddr_t) +
721                          mm->m_len);
722                 mm->m_len += len;
723                 mm->m_pkthdr.len += len;
724                 return m;
725         }
726         if (prep && M_LEADINGSPACE(mm) >= len) {
727                 mm->m_data = mtod(mm, caddr_t) - len;
728                 m_apply(n, off, len, m_bcopyxxx, mtod(mm, caddr_t));
729                 mm->m_len += len;
730                 mm->m_pkthdr.len += len;
731                 return mm;
732         }
733
734         /* Expand first/last mbuf to cluster if possible. */
735         if (!prep && !(mm->m_flags & M_EXT) && len > M_TRAILINGSPACE(mm)) {
736                 bcopy(mm->m_data, &buf, mm->m_len);
737                 m_clget(mm, how);
738                 if (!(mm->m_flags & M_EXT))
739                         return NULL;
740                 bcopy(&buf, mm->m_ext.ext_buf, mm->m_len);
741                 mm->m_data = mm->m_ext.ext_buf;
742         }
743         if (prep && !(mm->m_flags & M_EXT) && len > M_LEADINGSPACE(mm)) {
744                 bcopy(mm->m_data, &buf, mm->m_len);
745                 m_clget(mm, how);
746                 if (!(mm->m_flags & M_EXT))
747                         return NULL;
748                 bcopy(&buf, (caddr_t *)mm->m_ext.ext_buf +
749                     mm->m_ext.ext_size - mm->m_len, mm->m_len);
750                 mm->m_data = (caddr_t)mm->m_ext.ext_buf +
751                     mm->m_ext.ext_size - mm->m_len;
752         }
753
754         /* Append/prepend as many mbuf (clusters) as necessary to fit len. */
755         if (!prep && len > M_TRAILINGSPACE(mm)) {
756                 if (!m_getm(mm, len - M_TRAILINGSPACE(mm), how, MT_DATA))
757                         return NULL;
758         }
759         if (prep && len > M_LEADINGSPACE(mm)) {
760                 if (!(z = m_getm(NULL, len - M_LEADINGSPACE(mm), how, MT_DATA)))
761                         return NULL;
762                 i = 0;
763                 for (x = z; x != NULL; x = x->m_next) {
764                         i += x->m_flags & M_EXT ? x->m_ext.ext_size :
765                             (x->m_flags & M_PKTHDR ? MHLEN : MLEN);
766                         if (!x->m_next)
767                                 break;
768                 }
769                 z->m_data += i - len;
770                 m_move_pkthdr(mm, z);
771                 x->m_next = mm;
772                 mm = z;
773         }
774
775         /* Seek to start position in source mbuf. Optimization for long chains. */
776         while (off > 0) {
777                 if (off < n->m_len)
778                         break;
779                 off -= n->m_len;
780                 n = n->m_next;
781         }
782
783         /* Copy data into target mbuf. */
784         z = mm;
785         while (len > 0) {
786                 KASSERT(z != NULL, ("m_copymdata, falling off target edge"));
787                 i = M_TRAILINGSPACE(z);
788                 m_apply(n, off, i, m_bcopyxxx, mtod(z, caddr_t) + z->m_len);
789                 z->m_len += i;
790                 /* fixup pkthdr.len if necessary */
791                 if ((prep ? mm : m)->m_flags & M_PKTHDR)
792                         (prep ? mm : m)->m_pkthdr.len += i;
793                 off += i;
794                 len -= i;
795                 z = z->m_next;
796         }
797         return (prep ? mm : m);
798 }
799
800 /*
801  * Copy an entire packet, including header (which must be present).
802  * An optimization of the common case `m_copym(m, 0, M_COPYALL, how)'.
803  * Note that the copy is read-only, because clusters are not copied,
804  * only their reference counts are incremented.
805  * Preserve alignment of the first mbuf so if the creator has left
806  * some room at the beginning (e.g. for inserting protocol headers)
807  * the copies still have the room available.
808  */
809 struct mbuf *
810 m_copypacket(struct mbuf *m, int how)
811 {
812         struct mbuf *top, *n, *o;
813
814         MBUF_CHECKSLEEP(how);
815         n = m_get(how, m->m_type);
816         top = n;
817         if (n == NULL)
818                 goto nospace;
819
820         if (!m_dup_pkthdr(n, m, how))
821                 goto nospace;
822         n->m_len = m->m_len;
823         if (m->m_flags & M_EXT) {
824                 n->m_data = m->m_data;
825                 mb_dupcl(n, m);
826         } else {
827                 n->m_data = n->m_pktdat + (m->m_data - m->m_pktdat );
828                 bcopy(mtod(m, char *), mtod(n, char *), n->m_len);
829         }
830
831         m = m->m_next;
832         while (m) {
833                 o = m_get(how, m->m_type);
834                 if (o == NULL)
835                         goto nospace;
836
837                 n->m_next = o;
838                 n = n->m_next;
839
840                 n->m_len = m->m_len;
841                 if (m->m_flags & M_EXT) {
842                         n->m_data = m->m_data;
843                         mb_dupcl(n, m);
844                 } else {
845                         bcopy(mtod(m, char *), mtod(n, char *), n->m_len);
846                 }
847
848                 m = m->m_next;
849         }
850         return top;
851 nospace:
852         m_freem(top);
853         return (NULL);
854 }
855
856 /*
857  * Copy data from an mbuf chain starting "off" bytes from the beginning,
858  * continuing for "len" bytes, into the indicated buffer.
859  */
860 void
861 m_copydata(const struct mbuf *m, int off, int len, caddr_t cp)
862 {
863         u_int count;
864
865         KASSERT(off >= 0, ("m_copydata, negative off %d", off));
866         KASSERT(len >= 0, ("m_copydata, negative len %d", len));
867         while (off > 0) {
868                 KASSERT(m != NULL, ("m_copydata, offset > size of mbuf chain"));
869                 if (off < m->m_len)
870                         break;
871                 off -= m->m_len;
872                 m = m->m_next;
873         }
874         while (len > 0) {
875                 KASSERT(m != NULL, ("m_copydata, length > size of mbuf chain"));
876                 count = min(m->m_len - off, len);
877                 bcopy(mtod(m, caddr_t) + off, cp, count);
878                 len -= count;
879                 cp += count;
880                 off = 0;
881                 m = m->m_next;
882         }
883 }
884
885 /*
886  * Copy a packet header mbuf chain into a completely new chain, including
887  * copying any mbuf clusters.  Use this instead of m_copypacket() when
888  * you need a writable copy of an mbuf chain.
889  */
890 struct mbuf *
891 m_dup(struct mbuf *m, int how)
892 {
893         struct mbuf **p, *top = NULL;
894         int remain, moff, nsize;
895
896         MBUF_CHECKSLEEP(how);
897         /* Sanity check */
898         if (m == NULL)
899                 return (NULL);
900         M_ASSERTPKTHDR(m);
901
902         /* While there's more data, get a new mbuf, tack it on, and fill it */
903         remain = m->m_pkthdr.len;
904         moff = 0;
905         p = &top;
906         while (remain > 0 || top == NULL) {     /* allow m->m_pkthdr.len == 0 */
907                 struct mbuf *n;
908
909                 /* Get the next new mbuf */
910                 if (remain >= MINCLSIZE) {
911                         n = m_getcl(how, m->m_type, 0);
912                         nsize = MCLBYTES;
913                 } else {
914                         n = m_get(how, m->m_type);
915                         nsize = MLEN;
916                 }
917                 if (n == NULL)
918                         goto nospace;
919
920                 if (top == NULL) {              /* First one, must be PKTHDR */
921                         if (!m_dup_pkthdr(n, m, how)) {
922                                 m_free(n);
923                                 goto nospace;
924                         }
925                         if ((n->m_flags & M_EXT) == 0)
926                                 nsize = MHLEN;
927                 }
928                 n->m_len = 0;
929
930                 /* Link it into the new chain */
931                 *p = n;
932                 p = &n->m_next;
933
934                 /* Copy data from original mbuf(s) into new mbuf */
935                 while (n->m_len < nsize && m != NULL) {
936                         int chunk = min(nsize - n->m_len, m->m_len - moff);
937
938                         bcopy(m->m_data + moff, n->m_data + n->m_len, chunk);
939                         moff += chunk;
940                         n->m_len += chunk;
941                         remain -= chunk;
942                         if (moff == m->m_len) {
943                                 m = m->m_next;
944                                 moff = 0;
945                         }
946                 }
947
948                 /* Check correct total mbuf length */
949                 KASSERT((remain > 0 && m != NULL) || (remain == 0 && m == NULL),
950                         ("%s: bogus m_pkthdr.len", __func__));
951         }
952         return (top);
953
954 nospace:
955         m_freem(top);
956         return (NULL);
957 }
958
959 /*
960  * Concatenate mbuf chain n to m.
961  * Both chains must be of the same type (e.g. MT_DATA).
962  * Any m_pkthdr is not updated.
963  */
964 void
965 m_cat(struct mbuf *m, struct mbuf *n)
966 {
967         while (m->m_next)
968                 m = m->m_next;
969         while (n) {
970                 if (!M_WRITABLE(m) ||
971                     M_TRAILINGSPACE(m) < n->m_len) {
972                         /* just join the two chains */
973                         m->m_next = n;
974                         return;
975                 }
976                 /* splat the data from one into the other */
977                 bcopy(mtod(n, caddr_t), mtod(m, caddr_t) + m->m_len,
978                     (u_int)n->m_len);
979                 m->m_len += n->m_len;
980                 n = m_free(n);
981         }
982 }
983
984 /*
985  * Concatenate two pkthdr mbuf chains.
986  */
987 void
988 m_catpkt(struct mbuf *m, struct mbuf *n)
989 {
990
991         M_ASSERTPKTHDR(m);
992         M_ASSERTPKTHDR(n);
993
994         m->m_pkthdr.len += n->m_pkthdr.len;
995         m_demote(n, 1, 0);
996
997         m_cat(m, n);
998 }
999
1000 void
1001 m_adj(struct mbuf *mp, int req_len)
1002 {
1003         int len = req_len;
1004         struct mbuf *m;
1005         int count;
1006
1007         if ((m = mp) == NULL)
1008                 return;
1009         if (len >= 0) {
1010                 /*
1011                  * Trim from head.
1012                  */
1013                 while (m != NULL && len > 0) {
1014                         if (m->m_len <= len) {
1015                                 len -= m->m_len;
1016                                 m->m_len = 0;
1017                                 m = m->m_next;
1018                         } else {
1019                                 m->m_len -= len;
1020                                 m->m_data += len;
1021                                 len = 0;
1022                         }
1023                 }
1024                 if (mp->m_flags & M_PKTHDR)
1025                         mp->m_pkthdr.len -= (req_len - len);
1026         } else {
1027                 /*
1028                  * Trim from tail.  Scan the mbuf chain,
1029                  * calculating its length and finding the last mbuf.
1030                  * If the adjustment only affects this mbuf, then just
1031                  * adjust and return.  Otherwise, rescan and truncate
1032                  * after the remaining size.
1033                  */
1034                 len = -len;
1035                 count = 0;
1036                 for (;;) {
1037                         count += m->m_len;
1038                         if (m->m_next == (struct mbuf *)0)
1039                                 break;
1040                         m = m->m_next;
1041                 }
1042                 if (m->m_len >= len) {
1043                         m->m_len -= len;
1044                         if (mp->m_flags & M_PKTHDR)
1045                                 mp->m_pkthdr.len -= len;
1046                         return;
1047                 }
1048                 count -= len;
1049                 if (count < 0)
1050                         count = 0;
1051                 /*
1052                  * Correct length for chain is "count".
1053                  * Find the mbuf with last data, adjust its length,
1054                  * and toss data from remaining mbufs on chain.
1055                  */
1056                 m = mp;
1057                 if (m->m_flags & M_PKTHDR)
1058                         m->m_pkthdr.len = count;
1059                 for (; m; m = m->m_next) {
1060                         if (m->m_len >= count) {
1061                                 m->m_len = count;
1062                                 if (m->m_next != NULL) {
1063                                         m_freem(m->m_next);
1064                                         m->m_next = NULL;
1065                                 }
1066                                 break;
1067                         }
1068                         count -= m->m_len;
1069                 }
1070         }
1071 }
1072
1073 /*
1074  * Rearange an mbuf chain so that len bytes are contiguous
1075  * and in the data area of an mbuf (so that mtod will work
1076  * for a structure of size len).  Returns the resulting
1077  * mbuf chain on success, frees it and returns null on failure.
1078  * If there is room, it will add up to max_protohdr-len extra bytes to the
1079  * contiguous region in an attempt to avoid being called next time.
1080  */
1081 struct mbuf *
1082 m_pullup(struct mbuf *n, int len)
1083 {
1084         struct mbuf *m;
1085         int count;
1086         int space;
1087
1088         /*
1089          * If first mbuf has no cluster, and has room for len bytes
1090          * without shifting current data, pullup into it,
1091          * otherwise allocate a new mbuf to prepend to the chain.
1092          */
1093         if ((n->m_flags & M_EXT) == 0 &&
1094             n->m_data + len < &n->m_dat[MLEN] && n->m_next) {
1095                 if (n->m_len >= len)
1096                         return (n);
1097                 m = n;
1098                 n = n->m_next;
1099                 len -= m->m_len;
1100         } else {
1101                 if (len > MHLEN)
1102                         goto bad;
1103                 m = m_get(M_NOWAIT, n->m_type);
1104                 if (m == NULL)
1105                         goto bad;
1106                 if (n->m_flags & M_PKTHDR)
1107                         m_move_pkthdr(m, n);
1108         }
1109         space = &m->m_dat[MLEN] - (m->m_data + m->m_len);
1110         do {
1111                 count = min(min(max(len, max_protohdr), space), n->m_len);
1112                 bcopy(mtod(n, caddr_t), mtod(m, caddr_t) + m->m_len,
1113                   (u_int)count);
1114                 len -= count;
1115                 m->m_len += count;
1116                 n->m_len -= count;
1117                 space -= count;
1118                 if (n->m_len)
1119                         n->m_data += count;
1120                 else
1121                         n = m_free(n);
1122         } while (len > 0 && n);
1123         if (len > 0) {
1124                 (void) m_free(m);
1125                 goto bad;
1126         }
1127         m->m_next = n;
1128         return (m);
1129 bad:
1130         m_freem(n);
1131         return (NULL);
1132 }
1133
1134 /*
1135  * Like m_pullup(), except a new mbuf is always allocated, and we allow
1136  * the amount of empty space before the data in the new mbuf to be specified
1137  * (in the event that the caller expects to prepend later).
1138  */
1139 int MSFail;
1140
1141 struct mbuf *
1142 m_copyup(struct mbuf *n, int len, int dstoff)
1143 {
1144         struct mbuf *m;
1145         int count, space;
1146
1147         if (len > (MHLEN - dstoff))
1148                 goto bad;
1149         m = m_get(M_NOWAIT, n->m_type);
1150         if (m == NULL)
1151                 goto bad;
1152         if (n->m_flags & M_PKTHDR)
1153                 m_move_pkthdr(m, n);
1154         m->m_data += dstoff;
1155         space = &m->m_dat[MLEN] - (m->m_data + m->m_len);
1156         do {
1157                 count = min(min(max(len, max_protohdr), space), n->m_len);
1158                 memcpy(mtod(m, caddr_t) + m->m_len, mtod(n, caddr_t),
1159                     (unsigned)count);
1160                 len -= count;
1161                 m->m_len += count;
1162                 n->m_len -= count;
1163                 space -= count;
1164                 if (n->m_len)
1165                         n->m_data += count;
1166                 else
1167                         n = m_free(n);
1168         } while (len > 0 && n);
1169         if (len > 0) {
1170                 (void) m_free(m);
1171                 goto bad;
1172         }
1173         m->m_next = n;
1174         return (m);
1175  bad:
1176         m_freem(n);
1177         MSFail++;
1178         return (NULL);
1179 }
1180
1181 /*
1182  * Partition an mbuf chain in two pieces, returning the tail --
1183  * all but the first len0 bytes.  In case of failure, it returns NULL and
1184  * attempts to restore the chain to its original state.
1185  *
1186  * Note that the resulting mbufs might be read-only, because the new
1187  * mbuf can end up sharing an mbuf cluster with the original mbuf if
1188  * the "breaking point" happens to lie within a cluster mbuf. Use the
1189  * M_WRITABLE() macro to check for this case.
1190  */
1191 struct mbuf *
1192 m_split(struct mbuf *m0, int len0, int wait)
1193 {
1194         struct mbuf *m, *n;
1195         u_int len = len0, remain;
1196
1197         MBUF_CHECKSLEEP(wait);
1198         for (m = m0; m && len > m->m_len; m = m->m_next)
1199                 len -= m->m_len;
1200         if (m == NULL)
1201                 return (NULL);
1202         remain = m->m_len - len;
1203         if (m0->m_flags & M_PKTHDR && remain == 0) {
1204                 n = m_gethdr(wait, m0->m_type);
1205                 if (n == NULL)
1206                         return (NULL);
1207                 n->m_next = m->m_next;
1208                 m->m_next = NULL;
1209                 n->m_pkthdr.rcvif = m0->m_pkthdr.rcvif;
1210                 n->m_pkthdr.len = m0->m_pkthdr.len - len0;
1211                 m0->m_pkthdr.len = len0;
1212                 return (n);
1213         } else if (m0->m_flags & M_PKTHDR) {
1214                 n = m_gethdr(wait, m0->m_type);
1215                 if (n == NULL)
1216                         return (NULL);
1217                 n->m_pkthdr.rcvif = m0->m_pkthdr.rcvif;
1218                 n->m_pkthdr.len = m0->m_pkthdr.len - len0;
1219                 m0->m_pkthdr.len = len0;
1220                 if (m->m_flags & M_EXT)
1221                         goto extpacket;
1222                 if (remain > MHLEN) {
1223                         /* m can't be the lead packet */
1224                         M_ALIGN(n, 0);
1225                         n->m_next = m_split(m, len, wait);
1226                         if (n->m_next == NULL) {
1227                                 (void) m_free(n);
1228                                 return (NULL);
1229                         } else {
1230                                 n->m_len = 0;
1231                                 return (n);
1232                         }
1233                 } else
1234                         M_ALIGN(n, remain);
1235         } else if (remain == 0) {
1236                 n = m->m_next;
1237                 m->m_next = NULL;
1238                 return (n);
1239         } else {
1240                 n = m_get(wait, m->m_type);
1241                 if (n == NULL)
1242                         return (NULL);
1243                 M_ALIGN(n, remain);
1244         }
1245 extpacket:
1246         if (m->m_flags & M_EXT) {
1247                 n->m_data = m->m_data + len;
1248                 mb_dupcl(n, m);
1249         } else {
1250                 bcopy(mtod(m, caddr_t) + len, mtod(n, caddr_t), remain);
1251         }
1252         n->m_len = remain;
1253         m->m_len = len;
1254         n->m_next = m->m_next;
1255         m->m_next = NULL;
1256         return (n);
1257 }
1258 /*
1259  * Routine to copy from device local memory into mbufs.
1260  * Note that `off' argument is offset into first mbuf of target chain from
1261  * which to begin copying the data to.
1262  */
1263 struct mbuf *
1264 m_devget(char *buf, int totlen, int off, struct ifnet *ifp,
1265     void (*copy)(char *from, caddr_t to, u_int len))
1266 {
1267         struct mbuf *m;
1268         struct mbuf *top = NULL, **mp = &top;
1269         int len;
1270
1271         if (off < 0 || off > MHLEN)
1272                 return (NULL);
1273
1274         while (totlen > 0) {
1275                 if (top == NULL) {      /* First one, must be PKTHDR */
1276                         if (totlen + off >= MINCLSIZE) {
1277                                 m = m_getcl(M_NOWAIT, MT_DATA, M_PKTHDR);
1278                                 len = MCLBYTES;
1279                         } else {
1280                                 m = m_gethdr(M_NOWAIT, MT_DATA);
1281                                 len = MHLEN;
1282
1283                                 /* Place initial small packet/header at end of mbuf */
1284                                 if (m && totlen + off + max_linkhdr <= MLEN) {
1285                                         m->m_data += max_linkhdr;
1286                                         len -= max_linkhdr;
1287                                 }
1288                         }
1289                         if (m == NULL)
1290                                 return NULL;
1291                         m->m_pkthdr.rcvif = ifp;
1292                         m->m_pkthdr.len = totlen;
1293                 } else {
1294                         if (totlen + off >= MINCLSIZE) {
1295                                 m = m_getcl(M_NOWAIT, MT_DATA, 0);
1296                                 len = MCLBYTES;
1297                         } else {
1298                                 m = m_get(M_NOWAIT, MT_DATA);
1299                                 len = MLEN;
1300                         }
1301                         if (m == NULL) {
1302                                 m_freem(top);
1303                                 return NULL;
1304                         }
1305                 }
1306                 if (off) {
1307                         m->m_data += off;
1308                         len -= off;
1309                         off = 0;
1310                 }
1311                 m->m_len = len = min(totlen, len);
1312                 if (copy)
1313                         copy(buf, mtod(m, caddr_t), (u_int)len);
1314                 else
1315                         bcopy(buf, mtod(m, caddr_t), (u_int)len);
1316                 buf += len;
1317                 *mp = m;
1318                 mp = &m->m_next;
1319                 totlen -= len;
1320         }
1321         return (top);
1322 }
1323
1324 /*
1325  * Copy data from a buffer back into the indicated mbuf chain,
1326  * starting "off" bytes from the beginning, extending the mbuf
1327  * chain if necessary.
1328  */
1329 void
1330 m_copyback(struct mbuf *m0, int off, int len, c_caddr_t cp)
1331 {
1332         int mlen;
1333         struct mbuf *m = m0, *n;
1334         int totlen = 0;
1335
1336         if (m0 == NULL)
1337                 return;
1338         while (off > (mlen = m->m_len)) {
1339                 off -= mlen;
1340                 totlen += mlen;
1341                 if (m->m_next == NULL) {
1342                         n = m_get(M_NOWAIT, m->m_type);
1343                         if (n == NULL)
1344                                 goto out;
1345                         bzero(mtod(n, caddr_t), MLEN);
1346                         n->m_len = min(MLEN, len + off);
1347                         m->m_next = n;
1348                 }
1349                 m = m->m_next;
1350         }
1351         while (len > 0) {
1352                 if (m->m_next == NULL && (len > m->m_len - off)) {
1353                         m->m_len += min(len - (m->m_len - off),
1354                             M_TRAILINGSPACE(m));
1355                 }
1356                 mlen = min (m->m_len - off, len);
1357                 bcopy(cp, off + mtod(m, caddr_t), (u_int)mlen);
1358                 cp += mlen;
1359                 len -= mlen;
1360                 mlen += off;
1361                 off = 0;
1362                 totlen += mlen;
1363                 if (len == 0)
1364                         break;
1365                 if (m->m_next == NULL) {
1366                         n = m_get(M_NOWAIT, m->m_type);
1367                         if (n == NULL)
1368                                 break;
1369                         n->m_len = min(MLEN, len);
1370                         m->m_next = n;
1371                 }
1372                 m = m->m_next;
1373         }
1374 out:    if (((m = m0)->m_flags & M_PKTHDR) && (m->m_pkthdr.len < totlen))
1375                 m->m_pkthdr.len = totlen;
1376 }
1377
1378 /*
1379  * Append the specified data to the indicated mbuf chain,
1380  * Extend the mbuf chain if the new data does not fit in
1381  * existing space.
1382  *
1383  * Return 1 if able to complete the job; otherwise 0.
1384  */
1385 int
1386 m_append(struct mbuf *m0, int len, c_caddr_t cp)
1387 {
1388         struct mbuf *m, *n;
1389         int remainder, space;
1390
1391         for (m = m0; m->m_next != NULL; m = m->m_next)
1392                 ;
1393         remainder = len;
1394         space = M_TRAILINGSPACE(m);
1395         if (space > 0) {
1396                 /*
1397                  * Copy into available space.
1398                  */
1399                 if (space > remainder)
1400                         space = remainder;
1401                 bcopy(cp, mtod(m, caddr_t) + m->m_len, space);
1402                 m->m_len += space;
1403                 cp += space, remainder -= space;
1404         }
1405         while (remainder > 0) {
1406                 /*
1407                  * Allocate a new mbuf; could check space
1408                  * and allocate a cluster instead.
1409                  */
1410                 n = m_get(M_NOWAIT, m->m_type);
1411                 if (n == NULL)
1412                         break;
1413                 n->m_len = min(MLEN, remainder);
1414                 bcopy(cp, mtod(n, caddr_t), n->m_len);
1415                 cp += n->m_len, remainder -= n->m_len;
1416                 m->m_next = n;
1417                 m = n;
1418         }
1419         if (m0->m_flags & M_PKTHDR)
1420                 m0->m_pkthdr.len += len - remainder;
1421         return (remainder == 0);
1422 }
1423
1424 /*
1425  * Apply function f to the data in an mbuf chain starting "off" bytes from
1426  * the beginning, continuing for "len" bytes.
1427  */
1428 int
1429 m_apply(struct mbuf *m, int off, int len,
1430     int (*f)(void *, void *, u_int), void *arg)
1431 {
1432         u_int count;
1433         int rval;
1434
1435         KASSERT(off >= 0, ("m_apply, negative off %d", off));
1436         KASSERT(len >= 0, ("m_apply, negative len %d", len));
1437         while (off > 0) {
1438                 KASSERT(m != NULL, ("m_apply, offset > size of mbuf chain"));
1439                 if (off < m->m_len)
1440                         break;
1441                 off -= m->m_len;
1442                 m = m->m_next;
1443         }
1444         while (len > 0) {
1445                 KASSERT(m != NULL, ("m_apply, offset > size of mbuf chain"));
1446                 count = min(m->m_len - off, len);
1447                 rval = (*f)(arg, mtod(m, caddr_t) + off, count);
1448                 if (rval)
1449                         return (rval);
1450                 len -= count;
1451                 off = 0;
1452                 m = m->m_next;
1453         }
1454         return (0);
1455 }
1456
1457 /*
1458  * Return a pointer to mbuf/offset of location in mbuf chain.
1459  */
1460 struct mbuf *
1461 m_getptr(struct mbuf *m, int loc, int *off)
1462 {
1463
1464         while (loc >= 0) {
1465                 /* Normal end of search. */
1466                 if (m->m_len > loc) {
1467                         *off = loc;
1468                         return (m);
1469                 } else {
1470                         loc -= m->m_len;
1471                         if (m->m_next == NULL) {
1472                                 if (loc == 0) {
1473                                         /* Point at the end of valid data. */
1474                                         *off = m->m_len;
1475                                         return (m);
1476                                 }
1477                                 return (NULL);
1478                         }
1479                         m = m->m_next;
1480                 }
1481         }
1482         return (NULL);
1483 }
1484
1485 void
1486 m_print(const struct mbuf *m, int maxlen)
1487 {
1488         int len;
1489         int pdata;
1490         const struct mbuf *m2;
1491
1492         if (m == NULL) {
1493                 printf("mbuf: %p\n", m);
1494                 return;
1495         }
1496
1497         if (m->m_flags & M_PKTHDR)
1498                 len = m->m_pkthdr.len;
1499         else
1500                 len = -1;
1501         m2 = m;
1502         while (m2 != NULL && (len == -1 || len)) {
1503                 pdata = m2->m_len;
1504                 if (maxlen != -1 && pdata > maxlen)
1505                         pdata = maxlen;
1506                 printf("mbuf: %p len: %d, next: %p, %b%s", m2, m2->m_len,
1507                     m2->m_next, m2->m_flags, "\20\20freelist\17skipfw"
1508                     "\11proto5\10proto4\7proto3\6proto2\5proto1\4rdonly"
1509                     "\3eor\2pkthdr\1ext", pdata ? "" : "\n");
1510                 if (pdata)
1511                         printf(", %*D\n", pdata, (u_char *)m2->m_data, "-");
1512                 if (len != -1)
1513                         len -= m2->m_len;
1514                 m2 = m2->m_next;
1515         }
1516         if (len > 0)
1517                 printf("%d bytes unaccounted for.\n", len);
1518         return;
1519 }
1520
1521 u_int
1522 m_fixhdr(struct mbuf *m0)
1523 {
1524         u_int len;
1525
1526         len = m_length(m0, NULL);
1527         m0->m_pkthdr.len = len;
1528         return (len);
1529 }
1530
1531 u_int
1532 m_length(struct mbuf *m0, struct mbuf **last)
1533 {
1534         struct mbuf *m;
1535         u_int len;
1536
1537         len = 0;
1538         for (m = m0; m != NULL; m = m->m_next) {
1539                 len += m->m_len;
1540                 if (m->m_next == NULL)
1541                         break;
1542         }
1543         if (last != NULL)
1544                 *last = m;
1545         return (len);
1546 }
1547
1548 /*
1549  * Defragment a mbuf chain, returning the shortest possible
1550  * chain of mbufs and clusters.  If allocation fails and
1551  * this cannot be completed, NULL will be returned, but
1552  * the passed in chain will be unchanged.  Upon success,
1553  * the original chain will be freed, and the new chain
1554  * will be returned.
1555  *
1556  * If a non-packet header is passed in, the original
1557  * mbuf (chain?) will be returned unharmed.
1558  */
1559 struct mbuf *
1560 m_defrag(struct mbuf *m0, int how)
1561 {
1562         struct mbuf *m_new = NULL, *m_final = NULL;
1563         int progress = 0, length;
1564
1565         MBUF_CHECKSLEEP(how);
1566         if (!(m0->m_flags & M_PKTHDR))
1567                 return (m0);
1568
1569         m_fixhdr(m0); /* Needed sanity check */
1570
1571 #ifdef MBUF_STRESS_TEST
1572         if (m_defragrandomfailures) {
1573                 int temp = arc4random() & 0xff;
1574                 if (temp == 0xba)
1575                         goto nospace;
1576         }
1577 #endif
1578
1579         if (m0->m_pkthdr.len > MHLEN)
1580                 m_final = m_getcl(how, MT_DATA, M_PKTHDR);
1581         else
1582                 m_final = m_gethdr(how, MT_DATA);
1583
1584         if (m_final == NULL)
1585                 goto nospace;
1586
1587         if (m_dup_pkthdr(m_final, m0, how) == 0)
1588                 goto nospace;
1589
1590         m_new = m_final;
1591
1592         while (progress < m0->m_pkthdr.len) {
1593                 length = m0->m_pkthdr.len - progress;
1594                 if (length > MCLBYTES)
1595                         length = MCLBYTES;
1596
1597                 if (m_new == NULL) {
1598                         if (length > MLEN)
1599                                 m_new = m_getcl(how, MT_DATA, 0);
1600                         else
1601                                 m_new = m_get(how, MT_DATA);
1602                         if (m_new == NULL)
1603                                 goto nospace;
1604                 }
1605
1606                 m_copydata(m0, progress, length, mtod(m_new, caddr_t));
1607                 progress += length;
1608                 m_new->m_len = length;
1609                 if (m_new != m_final)
1610                         m_cat(m_final, m_new);
1611                 m_new = NULL;
1612         }
1613 #ifdef MBUF_STRESS_TEST
1614         if (m0->m_next == NULL)
1615                 m_defraguseless++;
1616 #endif
1617         m_freem(m0);
1618         m0 = m_final;
1619 #ifdef MBUF_STRESS_TEST
1620         m_defragpackets++;
1621         m_defragbytes += m0->m_pkthdr.len;
1622 #endif
1623         return (m0);
1624 nospace:
1625 #ifdef MBUF_STRESS_TEST
1626         m_defragfailure++;
1627 #endif
1628         if (m_final)
1629                 m_freem(m_final);
1630         return (NULL);
1631 }
1632
1633 /*
1634  * Defragment an mbuf chain, returning at most maxfrags separate
1635  * mbufs+clusters.  If this is not possible NULL is returned and
1636  * the original mbuf chain is left in it's present (potentially
1637  * modified) state.  We use two techniques: collapsing consecutive
1638  * mbufs and replacing consecutive mbufs by a cluster.
1639  *
1640  * NB: this should really be named m_defrag but that name is taken
1641  */
1642 struct mbuf *
1643 m_collapse(struct mbuf *m0, int how, int maxfrags)
1644 {
1645         struct mbuf *m, *n, *n2, **prev;
1646         u_int curfrags;
1647
1648         /*
1649          * Calculate the current number of frags.
1650          */
1651         curfrags = 0;
1652         for (m = m0; m != NULL; m = m->m_next)
1653                 curfrags++;
1654         /*
1655          * First, try to collapse mbufs.  Note that we always collapse
1656          * towards the front so we don't need to deal with moving the
1657          * pkthdr.  This may be suboptimal if the first mbuf has much
1658          * less data than the following.
1659          */
1660         m = m0;
1661 again:
1662         for (;;) {
1663                 n = m->m_next;
1664                 if (n == NULL)
1665                         break;
1666                 if (M_WRITABLE(m) &&
1667                     n->m_len < M_TRAILINGSPACE(m)) {
1668                         bcopy(mtod(n, void *), mtod(m, char *) + m->m_len,
1669                                 n->m_len);
1670                         m->m_len += n->m_len;
1671                         m->m_next = n->m_next;
1672                         m_free(n);
1673                         if (--curfrags <= maxfrags)
1674                                 return m0;
1675                 } else
1676                         m = n;
1677         }
1678         KASSERT(maxfrags > 1,
1679                 ("maxfrags %u, but normal collapse failed", maxfrags));
1680         /*
1681          * Collapse consecutive mbufs to a cluster.
1682          */
1683         prev = &m0->m_next;             /* NB: not the first mbuf */
1684         while ((n = *prev) != NULL) {
1685                 if ((n2 = n->m_next) != NULL &&
1686                     n->m_len + n2->m_len < MCLBYTES) {
1687                         m = m_getcl(how, MT_DATA, 0);
1688                         if (m == NULL)
1689                                 goto bad;
1690                         bcopy(mtod(n, void *), mtod(m, void *), n->m_len);
1691                         bcopy(mtod(n2, void *), mtod(m, char *) + n->m_len,
1692                                 n2->m_len);
1693                         m->m_len = n->m_len + n2->m_len;
1694                         m->m_next = n2->m_next;
1695                         *prev = m;
1696                         m_free(n);
1697                         m_free(n2);
1698                         if (--curfrags <= maxfrags)     /* +1 cl -2 mbufs */
1699                                 return m0;
1700                         /*
1701                          * Still not there, try the normal collapse
1702                          * again before we allocate another cluster.
1703                          */
1704                         goto again;
1705                 }
1706                 prev = &n->m_next;
1707         }
1708         /*
1709          * No place where we can collapse to a cluster; punt.
1710          * This can occur if, for example, you request 2 frags
1711          * but the packet requires that both be clusters (we
1712          * never reallocate the first mbuf to avoid moving the
1713          * packet header).
1714          */
1715 bad:
1716         return NULL;
1717 }
1718
1719 #ifdef MBUF_STRESS_TEST
1720
1721 /*
1722  * Fragment an mbuf chain.  There's no reason you'd ever want to do
1723  * this in normal usage, but it's great for stress testing various
1724  * mbuf consumers.
1725  *
1726  * If fragmentation is not possible, the original chain will be
1727  * returned.
1728  *
1729  * Possible length values:
1730  * 0     no fragmentation will occur
1731  * > 0  each fragment will be of the specified length
1732  * -1   each fragment will be the same random value in length
1733  * -2   each fragment's length will be entirely random
1734  * (Random values range from 1 to 256)
1735  */
1736 struct mbuf *
1737 m_fragment(struct mbuf *m0, int how, int length)
1738 {
1739         struct mbuf *m_new = NULL, *m_final = NULL;
1740         int progress = 0;
1741
1742         if (!(m0->m_flags & M_PKTHDR))
1743                 return (m0);
1744
1745         if ((length == 0) || (length < -2))
1746                 return (m0);
1747
1748         m_fixhdr(m0); /* Needed sanity check */
1749
1750         m_final = m_getcl(how, MT_DATA, M_PKTHDR);
1751
1752         if (m_final == NULL)
1753                 goto nospace;
1754
1755         if (m_dup_pkthdr(m_final, m0, how) == 0)
1756                 goto nospace;
1757
1758         m_new = m_final;
1759
1760         if (length == -1)
1761                 length = 1 + (arc4random() & 255);
1762
1763         while (progress < m0->m_pkthdr.len) {
1764                 int fraglen;
1765
1766                 if (length > 0)
1767                         fraglen = length;
1768                 else
1769                         fraglen = 1 + (arc4random() & 255);
1770                 if (fraglen > m0->m_pkthdr.len - progress)
1771                         fraglen = m0->m_pkthdr.len - progress;
1772
1773                 if (fraglen > MCLBYTES)
1774                         fraglen = MCLBYTES;
1775
1776                 if (m_new == NULL) {
1777                         m_new = m_getcl(how, MT_DATA, 0);
1778                         if (m_new == NULL)
1779                                 goto nospace;
1780                 }
1781
1782                 m_copydata(m0, progress, fraglen, mtod(m_new, caddr_t));
1783                 progress += fraglen;
1784                 m_new->m_len = fraglen;
1785                 if (m_new != m_final)
1786                         m_cat(m_final, m_new);
1787                 m_new = NULL;
1788         }
1789         m_freem(m0);
1790         m0 = m_final;
1791         return (m0);
1792 nospace:
1793         if (m_final)
1794                 m_freem(m_final);
1795         /* Return the original chain on failure */
1796         return (m0);
1797 }
1798
1799 #endif
1800
1801 /*
1802  * Copy the contents of uio into a properly sized mbuf chain.
1803  */
1804 struct mbuf *
1805 m_uiotombuf(struct uio *uio, int how, int len, int align, int flags)
1806 {
1807         struct mbuf *m, *mb;
1808         int error, length;
1809         ssize_t total;
1810         int progress = 0;
1811
1812         /*
1813          * len can be zero or an arbitrary large value bound by
1814          * the total data supplied by the uio.
1815          */
1816         if (len > 0)
1817                 total = min(uio->uio_resid, len);
1818         else
1819                 total = uio->uio_resid;
1820
1821         /*
1822          * The smallest unit returned by m_getm2() is a single mbuf
1823          * with pkthdr.  We can't align past it.
1824          */
1825         if (align >= MHLEN)
1826                 return (NULL);
1827
1828         /*
1829          * Give us the full allocation or nothing.
1830          * If len is zero return the smallest empty mbuf.
1831          */
1832         m = m_getm2(NULL, max(total + align, 1), how, MT_DATA, flags);
1833         if (m == NULL)
1834                 return (NULL);
1835         m->m_data += align;
1836
1837         /* Fill all mbufs with uio data and update header information. */
1838         for (mb = m; mb != NULL; mb = mb->m_next) {
1839                 length = min(M_TRAILINGSPACE(mb), total - progress);
1840
1841                 error = uiomove(mtod(mb, void *), length, uio);
1842                 if (error) {
1843                         m_freem(m);
1844                         return (NULL);
1845                 }
1846
1847                 mb->m_len = length;
1848                 progress += length;
1849                 if (flags & M_PKTHDR)
1850                         m->m_pkthdr.len += length;
1851         }
1852         KASSERT(progress == total, ("%s: progress != total", __func__));
1853
1854         return (m);
1855 }
1856
1857 /*
1858  * Copy an mbuf chain into a uio limited by len if set.
1859  */
1860 int
1861 m_mbuftouio(struct uio *uio, struct mbuf *m, int len)
1862 {
1863         int error, length, total;
1864         int progress = 0;
1865
1866         if (len > 0)
1867                 total = min(uio->uio_resid, len);
1868         else
1869                 total = uio->uio_resid;
1870
1871         /* Fill the uio with data from the mbufs. */
1872         for (; m != NULL; m = m->m_next) {
1873                 length = min(m->m_len, total - progress);
1874
1875                 error = uiomove(mtod(m, void *), length, uio);
1876                 if (error)
1877                         return (error);
1878
1879                 progress += length;
1880         }
1881
1882         return (0);
1883 }
1884
1885 /*
1886  * Create a writable copy of the mbuf chain.  While doing this
1887  * we compact the chain with a goal of producing a chain with
1888  * at most two mbufs.  The second mbuf in this chain is likely
1889  * to be a cluster.  The primary purpose of this work is to create
1890  * a writable packet for encryption, compression, etc.  The
1891  * secondary goal is to linearize the data so the data can be
1892  * passed to crypto hardware in the most efficient manner possible.
1893  */
1894 struct mbuf *
1895 m_unshare(struct mbuf *m0, int how)
1896 {
1897         struct mbuf *m, *mprev;
1898         struct mbuf *n, *mfirst, *mlast;
1899         int len, off;
1900
1901         mprev = NULL;
1902         for (m = m0; m != NULL; m = mprev->m_next) {
1903                 /*
1904                  * Regular mbufs are ignored unless there's a cluster
1905                  * in front of it that we can use to coalesce.  We do
1906                  * the latter mainly so later clusters can be coalesced
1907                  * also w/o having to handle them specially (i.e. convert
1908                  * mbuf+cluster -> cluster).  This optimization is heavily
1909                  * influenced by the assumption that we're running over
1910                  * Ethernet where MCLBYTES is large enough that the max
1911                  * packet size will permit lots of coalescing into a
1912                  * single cluster.  This in turn permits efficient
1913                  * crypto operations, especially when using hardware.
1914                  */
1915                 if ((m->m_flags & M_EXT) == 0) {
1916                         if (mprev && (mprev->m_flags & M_EXT) &&
1917                             m->m_len <= M_TRAILINGSPACE(mprev)) {
1918                                 /* XXX: this ignores mbuf types */
1919                                 memcpy(mtod(mprev, caddr_t) + mprev->m_len,
1920                                     mtod(m, caddr_t), m->m_len);
1921                                 mprev->m_len += m->m_len;
1922                                 mprev->m_next = m->m_next;      /* unlink from chain */
1923                                 m_free(m);                      /* reclaim mbuf */
1924 #if 0
1925                                 newipsecstat.ips_mbcoalesced++;
1926 #endif
1927                         } else {
1928                                 mprev = m;
1929                         }
1930                         continue;
1931                 }
1932                 /*
1933                  * Writable mbufs are left alone (for now).
1934                  */
1935                 if (M_WRITABLE(m)) {
1936                         mprev = m;
1937                         continue;
1938                 }
1939
1940                 /*
1941                  * Not writable, replace with a copy or coalesce with
1942                  * the previous mbuf if possible (since we have to copy
1943                  * it anyway, we try to reduce the number of mbufs and
1944                  * clusters so that future work is easier).
1945                  */
1946                 KASSERT(m->m_flags & M_EXT, ("m_flags 0x%x", m->m_flags));
1947                 /* NB: we only coalesce into a cluster or larger */
1948                 if (mprev != NULL && (mprev->m_flags & M_EXT) &&
1949                     m->m_len <= M_TRAILINGSPACE(mprev)) {
1950                         /* XXX: this ignores mbuf types */
1951                         memcpy(mtod(mprev, caddr_t) + mprev->m_len,
1952                             mtod(m, caddr_t), m->m_len);
1953                         mprev->m_len += m->m_len;
1954                         mprev->m_next = m->m_next;      /* unlink from chain */
1955                         m_free(m);                      /* reclaim mbuf */
1956 #if 0
1957                         newipsecstat.ips_clcoalesced++;
1958 #endif
1959                         continue;
1960                 }
1961
1962                 /*
1963                  * Allocate new space to hold the copy and copy the data.
1964                  * We deal with jumbo mbufs (i.e. m_len > MCLBYTES) by
1965                  * splitting them into clusters.  We could just malloc a
1966                  * buffer and make it external but too many device drivers
1967                  * don't know how to break up the non-contiguous memory when
1968                  * doing DMA.
1969                  */
1970                 n = m_getcl(how, m->m_type, m->m_flags);
1971                 if (n == NULL) {
1972                         m_freem(m0);
1973                         return (NULL);
1974                 }
1975                 len = m->m_len;
1976                 off = 0;
1977                 mfirst = n;
1978                 mlast = NULL;
1979                 for (;;) {
1980                         int cc = min(len, MCLBYTES);
1981                         memcpy(mtod(n, caddr_t), mtod(m, caddr_t) + off, cc);
1982                         n->m_len = cc;
1983                         if (mlast != NULL)
1984                                 mlast->m_next = n;
1985                         mlast = n;
1986 #if 0
1987                         newipsecstat.ips_clcopied++;
1988 #endif
1989
1990                         len -= cc;
1991                         if (len <= 0)
1992                                 break;
1993                         off += cc;
1994
1995                         n = m_getcl(how, m->m_type, m->m_flags);
1996                         if (n == NULL) {
1997                                 m_freem(mfirst);
1998                                 m_freem(m0);
1999                                 return (NULL);
2000                         }
2001                 }
2002                 n->m_next = m->m_next;
2003                 if (mprev == NULL)
2004                         m0 = mfirst;            /* new head of chain */
2005                 else
2006                         mprev->m_next = mfirst; /* replace old mbuf */
2007                 m_free(m);                      /* release old mbuf */
2008                 mprev = mfirst;
2009         }
2010         return (m0);
2011 }
2012
2013 #ifdef MBUF_PROFILING
2014
2015 #define MP_BUCKETS 32 /* don't just change this as things may overflow.*/
2016 struct mbufprofile {
2017         uintmax_t wasted[MP_BUCKETS];
2018         uintmax_t used[MP_BUCKETS];
2019         uintmax_t segments[MP_BUCKETS];
2020 } mbprof;
2021
2022 #define MP_MAXDIGITS 21 /* strlen("16,000,000,000,000,000,000") == 21 */
2023 #define MP_NUMLINES 6
2024 #define MP_NUMSPERLINE 16
2025 #define MP_EXTRABYTES 64        /* > strlen("used:\nwasted:\nsegments:\n") */
2026 /* work out max space needed and add a bit of spare space too */
2027 #define MP_MAXLINE ((MP_MAXDIGITS+1) * MP_NUMSPERLINE)
2028 #define MP_BUFSIZE ((MP_MAXLINE * MP_NUMLINES) + 1 + MP_EXTRABYTES)
2029
2030 char mbprofbuf[MP_BUFSIZE];
2031
2032 void
2033 m_profile(struct mbuf *m)
2034 {
2035         int segments = 0;
2036         int used = 0;
2037         int wasted = 0;
2038
2039         while (m) {
2040                 segments++;
2041                 used += m->m_len;
2042                 if (m->m_flags & M_EXT) {
2043                         wasted += MHLEN - sizeof(m->m_ext) +
2044                             m->m_ext.ext_size - m->m_len;
2045                 } else {
2046                         if (m->m_flags & M_PKTHDR)
2047                                 wasted += MHLEN - m->m_len;
2048                         else
2049                                 wasted += MLEN - m->m_len;
2050                 }
2051                 m = m->m_next;
2052         }
2053         /* be paranoid.. it helps */
2054         if (segments > MP_BUCKETS - 1)
2055                 segments = MP_BUCKETS - 1;
2056         if (used > 100000)
2057                 used = 100000;
2058         if (wasted > 100000)
2059                 wasted = 100000;
2060         /* store in the appropriate bucket */
2061         /* don't bother locking. if it's slightly off, so what? */
2062         mbprof.segments[segments]++;
2063         mbprof.used[fls(used)]++;
2064         mbprof.wasted[fls(wasted)]++;
2065 }
2066
2067 static void
2068 mbprof_textify(void)
2069 {
2070         int offset;
2071         char *c;
2072         uint64_t *p;
2073
2074         p = &mbprof.wasted[0];
2075         c = mbprofbuf;
2076         offset = snprintf(c, MP_MAXLINE + 10,
2077             "wasted:\n"
2078             "%ju %ju %ju %ju %ju %ju %ju %ju "
2079             "%ju %ju %ju %ju %ju %ju %ju %ju\n",
2080             p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7],
2081             p[8], p[9], p[10], p[11], p[12], p[13], p[14], p[15]);
2082 #ifdef BIG_ARRAY
2083         p = &mbprof.wasted[16];
2084         c += offset;
2085         offset = snprintf(c, MP_MAXLINE,
2086             "%ju %ju %ju %ju %ju %ju %ju %ju "
2087             "%ju %ju %ju %ju %ju %ju %ju %ju\n",
2088             p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7],
2089             p[8], p[9], p[10], p[11], p[12], p[13], p[14], p[15]);
2090 #endif
2091         p = &mbprof.used[0];
2092         c += offset;
2093         offset = snprintf(c, MP_MAXLINE + 10,
2094             "used:\n"
2095             "%ju %ju %ju %ju %ju %ju %ju %ju "
2096             "%ju %ju %ju %ju %ju %ju %ju %ju\n",
2097             p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7],
2098             p[8], p[9], p[10], p[11], p[12], p[13], p[14], p[15]);
2099 #ifdef BIG_ARRAY
2100         p = &mbprof.used[16];
2101         c += offset;
2102         offset = snprintf(c, MP_MAXLINE,
2103             "%ju %ju %ju %ju %ju %ju %ju %ju "
2104             "%ju %ju %ju %ju %ju %ju %ju %ju\n",
2105             p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7],
2106             p[8], p[9], p[10], p[11], p[12], p[13], p[14], p[15]);
2107 #endif
2108         p = &mbprof.segments[0];
2109         c += offset;
2110         offset = snprintf(c, MP_MAXLINE + 10,
2111             "segments:\n"
2112             "%ju %ju %ju %ju %ju %ju %ju %ju "
2113             "%ju %ju %ju %ju %ju %ju %ju %ju\n",
2114             p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7],
2115             p[8], p[9], p[10], p[11], p[12], p[13], p[14], p[15]);
2116 #ifdef BIG_ARRAY
2117         p = &mbprof.segments[16];
2118         c += offset;
2119         offset = snprintf(c, MP_MAXLINE,
2120             "%ju %ju %ju %ju %ju %ju %ju %ju "
2121             "%ju %ju %ju %ju %ju %ju %ju %jju",
2122             p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7],
2123             p[8], p[9], p[10], p[11], p[12], p[13], p[14], p[15]);
2124 #endif
2125 }
2126
2127 static int
2128 mbprof_handler(SYSCTL_HANDLER_ARGS)
2129 {
2130         int error;
2131
2132         mbprof_textify();
2133         error = SYSCTL_OUT(req, mbprofbuf, strlen(mbprofbuf) + 1);
2134         return (error);
2135 }
2136
2137 static int
2138 mbprof_clr_handler(SYSCTL_HANDLER_ARGS)
2139 {
2140         int clear, error;
2141
2142         clear = 0;
2143         error = sysctl_handle_int(oidp, &clear, 0, req);
2144         if (error || !req->newptr)
2145                 return (error);
2146
2147         if (clear) {
2148                 bzero(&mbprof, sizeof(mbprof));
2149         }
2150
2151         return (error);
2152 }
2153
2154
2155 SYSCTL_PROC(_kern_ipc, OID_AUTO, mbufprofile, CTLTYPE_STRING|CTLFLAG_RD,
2156             NULL, 0, mbprof_handler, "A", "mbuf profiling statistics");
2157
2158 SYSCTL_PROC(_kern_ipc, OID_AUTO, mbufprofileclr, CTLTYPE_INT|CTLFLAG_RW,
2159             NULL, 0, mbprof_clr_handler, "I", "clear mbuf profiling statistics");
2160 #endif
2161