mbuf: Remove unused MALLOC_DEFINEs
[dragonfly.git] / sys / kern / uipc_mbuf.c
1 /*
2  * (MPSAFE)
3  *
4  * Copyright (c) 2004 Jeffrey M. Hsu.  All rights reserved.
5  * Copyright (c) 2004 The DragonFly Project.  All rights reserved.
6  * 
7  * This code is derived from software contributed to The DragonFly Project
8  * by Jeffrey M. Hsu.
9  * 
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. Neither the name of The DragonFly Project nor the names of its
19  *    contributors may be used to endorse or promote products derived
20  *    from this software without specific, prior written permission.
21  * 
22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
25  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
26  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
27  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
28  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
30  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
31  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33  * SUCH DAMAGE.
34  */
35
36 /*
37  * Copyright (c) 1982, 1986, 1988, 1991, 1993
38  *      The Regents of the University of California.  All rights reserved.
39  *
40  * Redistribution and use in source and binary forms, with or without
41  * modification, are permitted provided that the following conditions
42  * are met:
43  * 1. Redistributions of source code must retain the above copyright
44  *    notice, this list of conditions and the following disclaimer.
45  * 2. Redistributions in binary form must reproduce the above copyright
46  *    notice, this list of conditions and the following disclaimer in the
47  *    documentation and/or other materials provided with the distribution.
48  * 3. All advertising materials mentioning features or use of this software
49  *    must display the following acknowledgement:
50  *      This product includes software developed by the University of
51  *      California, Berkeley and its contributors.
52  * 4. Neither the name of the University nor the names of its contributors
53  *    may be used to endorse or promote products derived from this software
54  *    without specific prior written permission.
55  *
56  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
57  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
58  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
59  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
60  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
61  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
62  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
63  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
64  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
65  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
66  * SUCH DAMAGE.
67  *
68  * @(#)uipc_mbuf.c      8.2 (Berkeley) 1/4/94
69  * $FreeBSD: src/sys/kern/uipc_mbuf.c,v 1.51.2.24 2003/04/15 06:59:29 silby Exp $
70  */
71
72 #include "opt_param.h"
73 #include "opt_mbuf_stress_test.h"
74 #include <sys/param.h>
75 #include <sys/systm.h>
76 #include <sys/file.h>
77 #include <sys/malloc.h>
78 #include <sys/mbuf.h>
79 #include <sys/kernel.h>
80 #include <sys/sysctl.h>
81 #include <sys/domain.h>
82 #include <sys/objcache.h>
83 #include <sys/tree.h>
84 #include <sys/protosw.h>
85 #include <sys/uio.h>
86 #include <sys/thread.h>
87 #include <sys/globaldata.h>
88
89 #include <sys/thread2.h>
90 #include <sys/spinlock2.h>
91
92 #include <machine/atomic.h>
93 #include <machine/limits.h>
94
95 #include <vm/vm.h>
96 #include <vm/vm_kern.h>
97 #include <vm/vm_extern.h>
98
99 #ifdef INVARIANTS
100 #include <machine/cpu.h>
101 #endif
102
103 /*
104  * mbuf cluster meta-data
105  */
106 struct mbcluster {
107         int32_t mcl_refs;
108         void    *mcl_data;
109 };
110
111 /*
112  * mbuf tracking for debugging purposes
113  */
114 #ifdef MBUF_DEBUG
115
116 static MALLOC_DEFINE(M_MTRACK, "mtrack", "mtrack");
117
118 struct mbctrack;
119 RB_HEAD(mbuf_rb_tree, mbtrack);
120 RB_PROTOTYPE2(mbuf_rb_tree, mbtrack, rb_node, mbtrack_cmp, struct mbuf *);
121
122 struct mbtrack {
123         RB_ENTRY(mbtrack) rb_node;
124         int trackid;
125         struct mbuf *m;
126 };
127
128 static int
129 mbtrack_cmp(struct mbtrack *mb1, struct mbtrack *mb2)
130 {
131         if (mb1->m < mb2->m)
132                 return(-1);
133         if (mb1->m > mb2->m)
134                 return(1);
135         return(0);
136 }
137
138 RB_GENERATE2(mbuf_rb_tree, mbtrack, rb_node, mbtrack_cmp, struct mbuf *, m);
139
140 struct mbuf_rb_tree     mbuf_track_root;
141 static struct spinlock  mbuf_track_spin = SPINLOCK_INITIALIZER(mbuf_track_spin);
142
143 static void
144 mbuftrack(struct mbuf *m)
145 {
146         struct mbtrack *mbt;
147
148         mbt = kmalloc(sizeof(*mbt), M_MTRACK, M_INTWAIT|M_ZERO);
149         spin_lock(&mbuf_track_spin);
150         mbt->m = m;
151         if (mbuf_rb_tree_RB_INSERT(&mbuf_track_root, mbt)) {
152                 spin_unlock(&mbuf_track_spin);
153                 panic("mbuftrack: mbuf %p already being tracked", m);
154         }
155         spin_unlock(&mbuf_track_spin);
156 }
157
158 static void
159 mbufuntrack(struct mbuf *m)
160 {
161         struct mbtrack *mbt;
162
163         spin_lock(&mbuf_track_spin);
164         mbt = mbuf_rb_tree_RB_LOOKUP(&mbuf_track_root, m);
165         if (mbt == NULL) {
166                 spin_unlock(&mbuf_track_spin);
167                 panic("mbufuntrack: mbuf %p was not tracked", m);
168         } else {
169                 mbuf_rb_tree_RB_REMOVE(&mbuf_track_root, mbt);
170                 spin_unlock(&mbuf_track_spin);
171                 kfree(mbt, M_MTRACK);
172         }
173 }
174
175 void
176 mbuftrackid(struct mbuf *m, int trackid)
177 {
178         struct mbtrack *mbt;
179         struct mbuf *n;
180
181         spin_lock(&mbuf_track_spin);
182         while (m) { 
183                 n = m->m_nextpkt;
184                 while (m) {
185                         mbt = mbuf_rb_tree_RB_LOOKUP(&mbuf_track_root, m);
186                         if (mbt == NULL) {
187                                 spin_unlock(&mbuf_track_spin);
188                                 panic("mbuftrackid: mbuf %p not tracked", m);
189                         }
190                         mbt->trackid = trackid;
191                         m = m->m_next;
192                 }
193                 m = n;
194         }
195         spin_unlock(&mbuf_track_spin);
196 }
197
198 static int
199 mbuftrack_callback(struct mbtrack *mbt, void *arg)
200 {
201         struct sysctl_req *req = arg;
202         char buf[64];
203         int error;
204
205         ksnprintf(buf, sizeof(buf), "mbuf %p track %d\n", mbt->m, mbt->trackid);
206
207         spin_unlock(&mbuf_track_spin);
208         error = SYSCTL_OUT(req, buf, strlen(buf));
209         spin_lock(&mbuf_track_spin);
210         if (error)      
211                 return(-error);
212         return(0);
213 }
214
215 static int
216 mbuftrack_show(SYSCTL_HANDLER_ARGS)
217 {
218         int error;
219
220         spin_lock(&mbuf_track_spin);
221         error = mbuf_rb_tree_RB_SCAN(&mbuf_track_root, NULL,
222                                      mbuftrack_callback, req);
223         spin_unlock(&mbuf_track_spin);
224         return (-error);
225 }
226 SYSCTL_PROC(_kern_ipc, OID_AUTO, showmbufs, CTLFLAG_RD|CTLTYPE_STRING,
227             0, 0, mbuftrack_show, "A", "Show all in-use mbufs");
228
229 #else
230
231 #define mbuftrack(m)
232 #define mbufuntrack(m)
233
234 #endif
235
236 static void mbinit(void *);
237 SYSINIT(mbuf, SI_BOOT2_MACHDEP, SI_ORDER_FIRST, mbinit, NULL)
238
239 static u_long   mbtypes[SMP_MAXCPU][MT_NTYPES];
240
241 static struct mbstat mbstat[SMP_MAXCPU];
242 int     max_linkhdr;
243 int     max_protohdr;
244 int     max_hdr;
245 int     max_datalen;
246 int     m_defragpackets;
247 int     m_defragbytes;
248 int     m_defraguseless;
249 int     m_defragfailure;
250 #ifdef MBUF_STRESS_TEST
251 int     m_defragrandomfailures;
252 #endif
253
254 struct objcache *mbuf_cache, *mbufphdr_cache;
255 struct objcache *mclmeta_cache, *mjclmeta_cache;
256 struct objcache *mbufcluster_cache, *mbufphdrcluster_cache;
257 struct objcache *mbufjcluster_cache, *mbufphdrjcluster_cache;
258
259 int     nmbclusters;
260 int     nmbufs;
261
262 SYSCTL_INT(_kern_ipc, KIPC_MAX_LINKHDR, max_linkhdr, CTLFLAG_RW,
263         &max_linkhdr, 0, "Max size of a link-level header");
264 SYSCTL_INT(_kern_ipc, KIPC_MAX_PROTOHDR, max_protohdr, CTLFLAG_RW,
265         &max_protohdr, 0, "Max size of a protocol header");
266 SYSCTL_INT(_kern_ipc, KIPC_MAX_HDR, max_hdr, CTLFLAG_RW, &max_hdr, 0,
267         "Max size of link+protocol headers");
268 SYSCTL_INT(_kern_ipc, KIPC_MAX_DATALEN, max_datalen, CTLFLAG_RW,
269         &max_datalen, 0, "Max data payload size without headers");
270 SYSCTL_INT(_kern_ipc, OID_AUTO, mbuf_wait, CTLFLAG_RW,
271         &mbuf_wait, 0, "Time in ticks to sleep after failed mbuf allocations");
272 static int do_mbstat(SYSCTL_HANDLER_ARGS);
273
274 SYSCTL_PROC(_kern_ipc, KIPC_MBSTAT, mbstat, CTLTYPE_STRUCT|CTLFLAG_RD,
275         0, 0, do_mbstat, "S,mbstat", "mbuf usage statistics");
276
277 static int do_mbtypes(SYSCTL_HANDLER_ARGS);
278
279 SYSCTL_PROC(_kern_ipc, OID_AUTO, mbtypes, CTLTYPE_ULONG|CTLFLAG_RD,
280         0, 0, do_mbtypes, "LU", "");
281
282 static int
283 do_mbstat(SYSCTL_HANDLER_ARGS)
284 {
285         struct mbstat mbstat_total;
286         struct mbstat *mbstat_totalp;
287         int i;
288
289         bzero(&mbstat_total, sizeof(mbstat_total));
290         mbstat_totalp = &mbstat_total;
291
292         for (i = 0; i < ncpus; i++)
293         {
294                 mbstat_total.m_mbufs += mbstat[i].m_mbufs;      
295                 mbstat_total.m_clusters += mbstat[i].m_clusters;        
296                 mbstat_total.m_spare += mbstat[i].m_spare;      
297                 mbstat_total.m_clfree += mbstat[i].m_clfree;    
298                 mbstat_total.m_drops += mbstat[i].m_drops;      
299                 mbstat_total.m_wait += mbstat[i].m_wait;        
300                 mbstat_total.m_drain += mbstat[i].m_drain;      
301                 mbstat_total.m_mcfail += mbstat[i].m_mcfail;    
302                 mbstat_total.m_mpfail += mbstat[i].m_mpfail;    
303
304         }
305         /*
306          * The following fields are not cumulative fields so just
307          * get their values once.
308          */
309         mbstat_total.m_msize = mbstat[0].m_msize;       
310         mbstat_total.m_mclbytes = mbstat[0].m_mclbytes; 
311         mbstat_total.m_minclsize = mbstat[0].m_minclsize;       
312         mbstat_total.m_mlen = mbstat[0].m_mlen; 
313         mbstat_total.m_mhlen = mbstat[0].m_mhlen;       
314
315         return(sysctl_handle_opaque(oidp, mbstat_totalp, sizeof(mbstat_total), req));
316 }
317
318 static int
319 do_mbtypes(SYSCTL_HANDLER_ARGS)
320 {
321         u_long totals[MT_NTYPES];
322         int i, j;
323
324         for (i = 0; i < MT_NTYPES; i++)
325                 totals[i] = 0;
326
327         for (i = 0; i < ncpus; i++)
328         {
329                 for (j = 0; j < MT_NTYPES; j++)
330                         totals[j] += mbtypes[i][j];
331         }
332
333         return(sysctl_handle_opaque(oidp, totals, sizeof(totals), req));
334 }
335
336 /*
337  * These are read-only because we do not currently have any code
338  * to adjust the objcache limits after the fact.  The variables
339  * may only be set as boot-time tunables.
340  */
341 SYSCTL_INT(_kern_ipc, KIPC_NMBCLUSTERS, nmbclusters, CTLFLAG_RD,
342            &nmbclusters, 0, "Maximum number of mbuf clusters available");
343 SYSCTL_INT(_kern_ipc, OID_AUTO, nmbufs, CTLFLAG_RD, &nmbufs, 0,
344            "Maximum number of mbufs available"); 
345
346 SYSCTL_INT(_kern_ipc, OID_AUTO, m_defragpackets, CTLFLAG_RD,
347            &m_defragpackets, 0, "Number of defragment packets");
348 SYSCTL_INT(_kern_ipc, OID_AUTO, m_defragbytes, CTLFLAG_RD,
349            &m_defragbytes, 0, "Number of defragment bytes");
350 SYSCTL_INT(_kern_ipc, OID_AUTO, m_defraguseless, CTLFLAG_RD,
351            &m_defraguseless, 0, "Number of useless defragment mbuf chain operations");
352 SYSCTL_INT(_kern_ipc, OID_AUTO, m_defragfailure, CTLFLAG_RD,
353            &m_defragfailure, 0, "Number of failed defragment mbuf chain operations");
354 #ifdef MBUF_STRESS_TEST
355 SYSCTL_INT(_kern_ipc, OID_AUTO, m_defragrandomfailures, CTLFLAG_RW,
356            &m_defragrandomfailures, 0, "");
357 #endif
358
359 static MALLOC_DEFINE(M_MBUF, "mbuf", "mbuf");
360 static MALLOC_DEFINE(M_MBUFCL, "mbufcl", "mbufcl");
361 static MALLOC_DEFINE(M_MCLMETA, "mclmeta", "mclmeta");
362
363 static void m_reclaim (void);
364 static void m_mclref(void *arg);
365 static void m_mclfree(void *arg);
366
367 /*
368  * NOTE: Default NMBUFS must take into account a possible DOS attack
369  *       using fd passing on unix domain sockets.
370  */
371 #ifndef NMBCLUSTERS
372 #define NMBCLUSTERS     (512 + maxusers * 16)
373 #endif
374 #ifndef NMBUFS
375 #define NMBUFS          (nmbclusters * 2 + maxfiles)
376 #endif
377
378 /*
379  * Perform sanity checks of tunables declared above.
380  */
381 static void
382 tunable_mbinit(void *dummy)
383 {
384         /*
385          * This has to be done before VM init.
386          */
387         nmbclusters = NMBCLUSTERS;
388         TUNABLE_INT_FETCH("kern.ipc.nmbclusters", &nmbclusters);
389         nmbufs = NMBUFS;
390         TUNABLE_INT_FETCH("kern.ipc.nmbufs", &nmbufs);
391         /* Sanity checks */
392         if (nmbufs < nmbclusters * 2)
393                 nmbufs = nmbclusters * 2;
394 }
395 SYSINIT(tunable_mbinit, SI_BOOT1_TUNABLES, SI_ORDER_ANY,
396         tunable_mbinit, NULL);
397
398 /* "number of clusters of pages" */
399 #define NCL_INIT        1
400
401 #define NMB_INIT        16
402
403 /*
404  * The mbuf object cache only guarantees that m_next and m_nextpkt are
405  * NULL and that m_data points to the beginning of the data area.  In
406  * particular, m_len and m_pkthdr.len are uninitialized.  It is the
407  * responsibility of the caller to initialize those fields before use.
408  */
409
410 static __inline boolean_t
411 mbuf_ctor(void *obj, void *private, int ocflags)
412 {
413         struct mbuf *m = obj;
414
415         m->m_next = NULL;
416         m->m_nextpkt = NULL;
417         m->m_data = m->m_dat;
418         m->m_flags = 0;
419
420         return (TRUE);
421 }
422
423 /*
424  * Initialize the mbuf and the packet header fields.
425  */
426 static boolean_t
427 mbufphdr_ctor(void *obj, void *private, int ocflags)
428 {
429         struct mbuf *m = obj;
430
431         m->m_next = NULL;
432         m->m_nextpkt = NULL;
433         m->m_data = m->m_pktdat;
434         m->m_flags = M_PKTHDR | M_PHCACHE;
435
436         m->m_pkthdr.rcvif = NULL;       /* eliminate XXX JH */
437         SLIST_INIT(&m->m_pkthdr.tags);
438         m->m_pkthdr.csum_flags = 0;     /* eliminate XXX JH */
439         m->m_pkthdr.fw_flags = 0;       /* eliminate XXX JH */
440
441         return (TRUE);
442 }
443
444 /*
445  * A mbcluster object consists of 2K (MCLBYTES) cluster and a refcount.
446  */
447 static boolean_t
448 mclmeta_ctor(void *obj, void *private, int ocflags)
449 {
450         struct mbcluster *cl = obj;
451         void *buf;
452
453         if (ocflags & M_NOWAIT)
454                 buf = kmalloc(MCLBYTES, M_MBUFCL, M_NOWAIT | M_ZERO);
455         else
456                 buf = kmalloc(MCLBYTES, M_MBUFCL, M_INTWAIT | M_ZERO);
457         if (buf == NULL)
458                 return (FALSE);
459         cl->mcl_refs = 0;
460         cl->mcl_data = buf;
461         return (TRUE);
462 }
463
464 static boolean_t
465 mjclmeta_ctor(void *obj, void *private, int ocflags)
466 {
467         struct mbcluster *cl = obj;
468         void *buf;
469
470         if (ocflags & M_NOWAIT)
471                 buf = kmalloc(MJUMPAGESIZE, M_MBUFCL, M_NOWAIT | M_ZERO);
472         else
473                 buf = kmalloc(MJUMPAGESIZE, M_MBUFCL, M_INTWAIT | M_ZERO);
474         if (buf == NULL)
475                 return (FALSE);
476         cl->mcl_refs = 0;
477         cl->mcl_data = buf;
478         return (TRUE);
479 }
480
481 static void
482 mclmeta_dtor(void *obj, void *private)
483 {
484         struct mbcluster *mcl = obj;
485
486         KKASSERT(mcl->mcl_refs == 0);
487         kfree(mcl->mcl_data, M_MBUFCL);
488 }
489
490 static void
491 linkjcluster(struct mbuf *m, struct mbcluster *cl, uint size)
492 {
493         /*
494          * Add the cluster to the mbuf.  The caller will detect that the
495          * mbuf now has an attached cluster.
496          */
497         m->m_ext.ext_arg = cl;
498         m->m_ext.ext_buf = cl->mcl_data;
499         m->m_ext.ext_ref = m_mclref;
500         m->m_ext.ext_free = m_mclfree;
501         m->m_ext.ext_size = size;
502         atomic_add_int(&cl->mcl_refs, 1);
503
504         m->m_data = m->m_ext.ext_buf;
505         m->m_flags |= M_EXT | M_EXT_CLUSTER;
506 }
507
508 static void
509 linkcluster(struct mbuf *m, struct mbcluster *cl)
510 {
511         linkjcluster(m, cl, MCLBYTES);
512 }
513
514 static boolean_t
515 mbufphdrcluster_ctor(void *obj, void *private, int ocflags)
516 {
517         struct mbuf *m = obj;
518         struct mbcluster *cl;
519
520         mbufphdr_ctor(obj, private, ocflags);
521         cl = objcache_get(mclmeta_cache, ocflags);
522         if (cl == NULL) {
523                 ++mbstat[mycpu->gd_cpuid].m_drops;
524                 return (FALSE);
525         }
526         m->m_flags |= M_CLCACHE;
527         linkcluster(m, cl);
528         return (TRUE);
529 }
530
531 static boolean_t
532 mbufphdrjcluster_ctor(void *obj, void *private, int ocflags)
533 {
534         struct mbuf *m = obj;
535         struct mbcluster *cl;
536
537         mbufphdr_ctor(obj, private, ocflags);
538         cl = objcache_get(mjclmeta_cache, ocflags);
539         if (cl == NULL) {
540                 ++mbstat[mycpu->gd_cpuid].m_drops;
541                 return (FALSE);
542         }
543         m->m_flags |= M_CLCACHE;
544         linkjcluster(m, cl, MJUMPAGESIZE);
545         return (TRUE);
546 }
547
548 static boolean_t
549 mbufcluster_ctor(void *obj, void *private, int ocflags)
550 {
551         struct mbuf *m = obj;
552         struct mbcluster *cl;
553
554         mbuf_ctor(obj, private, ocflags);
555         cl = objcache_get(mclmeta_cache, ocflags);
556         if (cl == NULL) {
557                 ++mbstat[mycpu->gd_cpuid].m_drops;
558                 return (FALSE);
559         }
560         m->m_flags |= M_CLCACHE;
561         linkcluster(m, cl);
562         return (TRUE);
563 }
564
565 static boolean_t
566 mbufjcluster_ctor(void *obj, void *private, int ocflags)
567 {
568         struct mbuf *m = obj;
569         struct mbcluster *cl;
570
571         mbuf_ctor(obj, private, ocflags);
572         cl = objcache_get(mjclmeta_cache, ocflags);
573         if (cl == NULL) {
574                 ++mbstat[mycpu->gd_cpuid].m_drops;
575                 return (FALSE);
576         }
577         m->m_flags |= M_CLCACHE;
578         linkjcluster(m, cl, MJUMPAGESIZE);
579         return (TRUE);
580 }
581
582 /*
583  * Used for both the cluster and cluster PHDR caches.
584  *
585  * The mbuf may have lost its cluster due to sharing, deal
586  * with the situation by checking M_EXT.
587  */
588 static void
589 mbufcluster_dtor(void *obj, void *private)
590 {
591         struct mbuf *m = obj;
592         struct mbcluster *mcl;
593
594         if (m->m_flags & M_EXT) {
595                 KKASSERT((m->m_flags & M_EXT_CLUSTER) != 0);
596                 mcl = m->m_ext.ext_arg;
597                 KKASSERT(mcl->mcl_refs == 1);
598                 mcl->mcl_refs = 0;
599                 if (m->m_flags & M_EXT && m->m_ext.ext_size != MCLBYTES)
600                         objcache_put(mjclmeta_cache, mcl);
601                 else
602                         objcache_put(mclmeta_cache, mcl);
603         }
604 }
605
606 struct objcache_malloc_args mbuf_malloc_args = { MSIZE, M_MBUF };
607 struct objcache_malloc_args mclmeta_malloc_args =
608         { sizeof(struct mbcluster), M_MCLMETA };
609
610 /* ARGSUSED*/
611 static void
612 mbinit(void *dummy)
613 {
614         int mb_limit, cl_limit;
615         int limit;
616         int i;
617
618         /*
619          * Initialize statistics
620          */
621         for (i = 0; i < ncpus; i++) {
622                 mbstat[i].m_msize = MSIZE;
623                 mbstat[i].m_mclbytes = MCLBYTES;
624                 mbstat[i].m_mjumpagesize = MJUMPAGESIZE;
625                 mbstat[i].m_minclsize = MINCLSIZE;
626                 mbstat[i].m_mlen = MLEN;
627                 mbstat[i].m_mhlen = MHLEN;
628         }
629
630         /*
631          * Create objtect caches and save cluster limits, which will
632          * be used to adjust backing kmalloc pools' limit later.
633          */
634
635         mb_limit = cl_limit = 0;
636
637         limit = nmbufs;
638         mbuf_cache = objcache_create("mbuf",
639             &limit, 0,
640             mbuf_ctor, NULL, NULL,
641             objcache_malloc_alloc, objcache_malloc_free, &mbuf_malloc_args);
642         mb_limit += limit;
643
644         limit = nmbufs;
645         mbufphdr_cache = objcache_create("mbuf pkt hdr",
646             &limit, nmbufs / 4,
647             mbufphdr_ctor, NULL, NULL,
648             objcache_malloc_alloc, objcache_malloc_free, &mbuf_malloc_args);
649         mb_limit += limit;
650
651         cl_limit = nmbclusters;
652         mclmeta_cache = objcache_create("cluster mbuf",
653             &cl_limit, 0,
654             mclmeta_ctor, mclmeta_dtor, NULL,
655             objcache_malloc_alloc, objcache_malloc_free, &mclmeta_malloc_args);
656
657         cl_limit = nmbclusters;
658         mjclmeta_cache = objcache_create("jcluster mbuf",
659             &cl_limit, 0,
660             mjclmeta_ctor, mclmeta_dtor, NULL,
661             objcache_malloc_alloc, objcache_malloc_free, &mclmeta_malloc_args);
662
663         limit = nmbclusters;
664         mbufcluster_cache = objcache_create("mbuf + cluster",
665             &limit, 0,
666             mbufcluster_ctor, mbufcluster_dtor, NULL,
667             objcache_malloc_alloc, objcache_malloc_free, &mbuf_malloc_args);
668         mb_limit += limit;
669
670         limit = nmbclusters;
671         mbufphdrcluster_cache = objcache_create("mbuf pkt hdr + cluster",
672             &limit, nmbclusters / 16,
673             mbufphdrcluster_ctor, mbufcluster_dtor, NULL,
674             objcache_malloc_alloc, objcache_malloc_free, &mbuf_malloc_args);
675         mb_limit += limit;
676
677         limit = nmbclusters;
678         mbufjcluster_cache = objcache_create("mbuf + jcluster",
679             &limit, 0,
680             mbufjcluster_ctor, mbufcluster_dtor, NULL,
681             objcache_malloc_alloc, objcache_malloc_free, &mbuf_malloc_args);
682
683         limit = nmbclusters;
684         mbufphdrjcluster_cache = objcache_create("mbuf pkt hdr + jcluster",
685             &limit, nmbclusters / 16,
686             mbufphdrjcluster_ctor, mbufcluster_dtor, NULL,
687             objcache_malloc_alloc, objcache_malloc_free, &mbuf_malloc_args);
688
689         /*
690          * Adjust backing kmalloc pools' limit
691          *
692          * NOTE: We raise the limit by another 1/8 to take the effect
693          * of loosememuse into account.
694          */
695         cl_limit += cl_limit / 8;
696         kmalloc_raise_limit(mclmeta_malloc_args.mtype,
697             mclmeta_malloc_args.objsize * (size_t)cl_limit);
698         kmalloc_raise_limit(M_MBUFCL,
699             ((MCLBYTES * (size_t)cl_limit * 3) / 4) +
700             ((MJUMPAGESIZE * (size_t)cl_limit) / 4));
701
702         mb_limit += mb_limit / 8;
703         kmalloc_raise_limit(mbuf_malloc_args.mtype,
704             mbuf_malloc_args.objsize * (size_t)mb_limit);
705 }
706
707 /*
708  * Return the number of references to this mbuf's data.  0 is returned
709  * if the mbuf is not M_EXT, a reference count is returned if it is
710  * M_EXT | M_EXT_CLUSTER, and 99 is returned if it is a special M_EXT.
711  */
712 int
713 m_sharecount(struct mbuf *m)
714 {
715         switch (m->m_flags & (M_EXT | M_EXT_CLUSTER)) {
716         case 0:
717                 return (0);
718         case M_EXT:
719                 return (99);
720         case M_EXT | M_EXT_CLUSTER:
721                 return (((struct mbcluster *)m->m_ext.ext_arg)->mcl_refs);
722         }
723         /* NOTREACHED */
724         return (0);             /* to shut up compiler */
725 }
726
727 /*
728  * change mbuf to new type
729  */
730 void
731 m_chtype(struct mbuf *m, int type)
732 {
733         struct globaldata *gd = mycpu;
734
735         ++mbtypes[gd->gd_cpuid][type];
736         --mbtypes[gd->gd_cpuid][m->m_type];
737         m->m_type = type;
738 }
739
740 static void
741 m_reclaim(void)
742 {
743         struct domain *dp;
744         struct protosw *pr;
745
746         kprintf("Debug: m_reclaim() called\n");
747
748         SLIST_FOREACH(dp, &domains, dom_next) {
749                 for (pr = dp->dom_protosw; pr < dp->dom_protoswNPROTOSW; pr++) {
750                         if (pr->pr_drain)
751                                 (*pr->pr_drain)();
752                 }
753         }
754         ++mbstat[mycpu->gd_cpuid].m_drain;
755 }
756
757 static __inline void
758 updatestats(struct mbuf *m, int type)
759 {
760         struct globaldata *gd = mycpu;
761
762         m->m_type = type;
763         mbuftrack(m);
764 #ifdef MBUF_DEBUG
765         KASSERT(m->m_next == NULL, ("mbuf %p: bad m_next in get", m));
766         KASSERT(m->m_nextpkt == NULL, ("mbuf %p: bad m_nextpkt in get", m));
767 #endif
768
769         ++mbtypes[gd->gd_cpuid][type];
770         ++mbstat[gd->gd_cpuid].m_mbufs;
771
772 }
773
774 /*
775  * Allocate an mbuf.
776  */
777 struct mbuf *
778 m_get(int how, int type)
779 {
780         struct mbuf *m;
781         int ntries = 0;
782         int ocf = MBTOM(how);
783
784 retryonce:
785
786         m = objcache_get(mbuf_cache, ocf);
787
788         if (m == NULL) {
789                 if ((how & MB_TRYWAIT) && ntries++ == 0) {
790                         struct objcache *reclaimlist[] = {
791                                 mbufphdr_cache,
792                                 mbufcluster_cache,
793                                 mbufphdrcluster_cache,
794                                 mbufjcluster_cache,
795                                 mbufphdrjcluster_cache
796                         };
797                         const int nreclaims = NELEM(reclaimlist);
798
799                         if (!objcache_reclaimlist(reclaimlist, nreclaims, ocf))
800                                 m_reclaim();
801                         goto retryonce;
802                 }
803                 ++mbstat[mycpu->gd_cpuid].m_drops;
804                 return (NULL);
805         }
806 #ifdef MBUF_DEBUG
807         KASSERT(m->m_data == m->m_dat, ("mbuf %p: bad m_data in get", m));
808 #endif
809         m->m_len = 0;
810
811         updatestats(m, type);
812         return (m);
813 }
814
815 struct mbuf *
816 m_gethdr(int how, int type)
817 {
818         struct mbuf *m;
819         int ocf = MBTOM(how);
820         int ntries = 0;
821
822 retryonce:
823
824         m = objcache_get(mbufphdr_cache, ocf);
825
826         if (m == NULL) {
827                 if ((how & MB_TRYWAIT) && ntries++ == 0) {
828                         struct objcache *reclaimlist[] = {
829                                 mbuf_cache,
830                                 mbufcluster_cache, mbufphdrcluster_cache,
831                                 mbufjcluster_cache, mbufphdrjcluster_cache
832                         };
833                         const int nreclaims = NELEM(reclaimlist);
834
835                         if (!objcache_reclaimlist(reclaimlist, nreclaims, ocf))
836                                 m_reclaim();
837                         goto retryonce;
838                 }
839                 ++mbstat[mycpu->gd_cpuid].m_drops;
840                 return (NULL);
841         }
842 #ifdef MBUF_DEBUG
843         KASSERT(m->m_data == m->m_pktdat, ("mbuf %p: bad m_data in get", m));
844 #endif
845         m->m_len = 0;
846         m->m_pkthdr.len = 0;
847
848         updatestats(m, type);
849         return (m);
850 }
851
852 /*
853  * Get a mbuf (not a mbuf cluster!) and zero it.
854  * Deprecated.
855  */
856 struct mbuf *
857 m_getclr(int how, int type)
858 {
859         struct mbuf *m;
860
861         m = m_get(how, type);
862         if (m != NULL)
863                 bzero(m->m_data, MLEN);
864         return (m);
865 }
866
867 struct mbuf *
868 m_getjcl(int how, short type, int flags, size_t size)
869 {
870         struct mbuf *m = NULL;
871         struct objcache *mbclc, *mbphclc;
872         int ocflags = MBTOM(how);
873         int ntries = 0;
874
875         switch (size) {
876                 case MCLBYTES:
877                         mbclc = mbufcluster_cache;
878                         mbphclc = mbufphdrcluster_cache;
879                         break;
880                 default:
881                         mbclc = mbufjcluster_cache;
882                         mbphclc = mbufphdrjcluster_cache;
883                         break;
884         }
885                         
886 retryonce:
887
888         if (flags & M_PKTHDR)
889                 m = objcache_get(mbphclc, ocflags);
890         else
891                 m = objcache_get(mbclc, ocflags);
892
893         if (m == NULL) {
894                 if ((how & MB_TRYWAIT) && ntries++ == 0) {
895                         struct objcache *reclaimlist[1];
896
897                         if (flags & M_PKTHDR)
898                                 reclaimlist[0] = mbclc;
899                         else
900                                 reclaimlist[0] = mbphclc;
901                         if (!objcache_reclaimlist(reclaimlist, 1, ocflags))
902                                 m_reclaim();
903                         goto retryonce;
904                 }
905                 ++mbstat[mycpu->gd_cpuid].m_drops;
906                 return (NULL);
907         }
908
909 #ifdef MBUF_DEBUG
910         KASSERT(m->m_data == m->m_ext.ext_buf,
911                 ("mbuf %p: bad m_data in get", m));
912 #endif
913         m->m_type = type;
914         m->m_len = 0;
915         m->m_pkthdr.len = 0;    /* just do it unconditonally */
916
917         mbuftrack(m);
918
919         ++mbtypes[mycpu->gd_cpuid][type];
920         ++mbstat[mycpu->gd_cpuid].m_clusters;
921         return (m);
922 }
923
924 /*
925  * Returns an mbuf with an attached cluster.
926  * Because many network drivers use this kind of buffers a lot, it is
927  * convenient to keep a small pool of free buffers of this kind.
928  * Even a small size such as 10 gives about 10% improvement in the
929  * forwarding rate in a bridge or router.
930  */
931 struct mbuf *
932 m_getcl(int how, short type, int flags)
933 {
934         return (m_getjcl(how, type, flags, MCLBYTES));
935 }
936
937 /*
938  * Allocate chain of requested length.
939  */
940 struct mbuf *
941 m_getc(int len, int how, int type)
942 {
943         struct mbuf *n, *nfirst = NULL, **ntail = &nfirst;
944         int nsize;
945
946         while (len > 0) {
947                 n = m_getl(len, how, type, 0, &nsize);
948                 if (n == NULL)
949                         goto failed;
950                 n->m_len = 0;
951                 *ntail = n;
952                 ntail = &n->m_next;
953                 len -= nsize;
954         }
955         return (nfirst);
956
957 failed:
958         m_freem(nfirst);
959         return (NULL);
960 }
961
962 /*
963  * Allocate len-worth of mbufs and/or mbuf clusters (whatever fits best)
964  * and return a pointer to the head of the allocated chain. If m0 is
965  * non-null, then we assume that it is a single mbuf or an mbuf chain to
966  * which we want len bytes worth of mbufs and/or clusters attached, and so
967  * if we succeed in allocating it, we will just return a pointer to m0.
968  *
969  * If we happen to fail at any point during the allocation, we will free
970  * up everything we have already allocated and return NULL.
971  *
972  * Deprecated.  Use m_getc() and m_cat() instead.
973  */
974 struct mbuf *
975 m_getm(struct mbuf *m0, int len, int type, int how)
976 {
977         struct mbuf *nfirst;
978
979         nfirst = m_getc(len, how, type);
980
981         if (m0 != NULL) {
982                 m_last(m0)->m_next = nfirst;
983                 return (m0);
984         }
985
986         return (nfirst);
987 }
988
989 /*
990  * Adds a cluster to a normal mbuf, M_EXT is set on success.
991  * Deprecated.  Use m_getcl() instead.
992  */
993 void
994 m_mclget(struct mbuf *m, int how)
995 {
996         struct mbcluster *mcl;
997
998         KKASSERT((m->m_flags & M_EXT) == 0);
999         mcl = objcache_get(mclmeta_cache, MBTOM(how));
1000         if (mcl != NULL) {
1001                 linkcluster(m, mcl);
1002                 ++mbstat[mycpu->gd_cpuid].m_clusters;
1003         } else {
1004                 ++mbstat[mycpu->gd_cpuid].m_drops;
1005         }
1006 }
1007
1008 /*
1009  * Updates to mbcluster must be MPSAFE.  Only an entity which already has
1010  * a reference to the cluster can ref it, so we are in no danger of 
1011  * racing an add with a subtract.  But the operation must still be atomic
1012  * since multiple entities may have a reference on the cluster.
1013  *
1014  * m_mclfree() is almost the same but it must contend with two entities
1015  * freeing the cluster at the same time.
1016  */
1017 static void
1018 m_mclref(void *arg)
1019 {
1020         struct mbcluster *mcl = arg;
1021
1022         atomic_add_int(&mcl->mcl_refs, 1);
1023 }
1024
1025 /*
1026  * When dereferencing a cluster we have to deal with a N->0 race, where
1027  * N entities free their references simultaniously.  To do this we use
1028  * atomic_fetchadd_int().
1029  */
1030 static void
1031 m_mclfree(void *arg)
1032 {
1033         struct mbcluster *mcl = arg;
1034
1035         if (atomic_fetchadd_int(&mcl->mcl_refs, -1) == 1) {
1036                 --mbstat[mycpu->gd_cpuid].m_clusters;
1037                 objcache_put(mclmeta_cache, mcl);
1038         }
1039 }
1040
1041 /*
1042  * Free a single mbuf and any associated external storage.  The successor,
1043  * if any, is returned.
1044  *
1045  * We do need to check non-first mbuf for m_aux, since some of existing
1046  * code does not call M_PREPEND properly.
1047  * (example: call to bpf_mtap from drivers)
1048  */
1049
1050 #ifdef MBUF_DEBUG
1051
1052 struct mbuf  *
1053 _m_free(struct mbuf *m, const char *func)
1054
1055 #else
1056
1057 struct mbuf *
1058 m_free(struct mbuf *m)
1059
1060 #endif
1061 {
1062         struct mbuf *n;
1063         struct globaldata *gd = mycpu;
1064
1065         KASSERT(m->m_type != MT_FREE, ("freeing free mbuf %p", m));
1066         KASSERT(M_TRAILINGSPACE(m) >= 0, ("overflowed mbuf %p", m));
1067         --mbtypes[gd->gd_cpuid][m->m_type];
1068
1069         n = m->m_next;
1070
1071         /*
1072          * Make sure the mbuf is in constructed state before returning it
1073          * to the objcache.
1074          */
1075         m->m_next = NULL;
1076         mbufuntrack(m);
1077 #ifdef MBUF_DEBUG
1078         m->m_hdr.mh_lastfunc = func;
1079 #endif
1080 #ifdef notyet
1081         KKASSERT(m->m_nextpkt == NULL);
1082 #else
1083         if (m->m_nextpkt != NULL) {
1084                 static int afewtimes = 10;
1085
1086                 if (afewtimes-- > 0) {
1087                         kprintf("mfree: m->m_nextpkt != NULL\n");
1088                         print_backtrace(-1);
1089                 }
1090                 m->m_nextpkt = NULL;
1091         }
1092 #endif
1093         if (m->m_flags & M_PKTHDR) {
1094                 m_tag_delete_chain(m);          /* eliminate XXX JH */
1095         }
1096
1097         m->m_flags &= (M_EXT | M_EXT_CLUSTER | M_CLCACHE | M_PHCACHE);
1098
1099         /*
1100          * Clean the M_PKTHDR state so we can return the mbuf to its original
1101          * cache.  This is based on the PHCACHE flag which tells us whether
1102          * the mbuf was originally allocated out of a packet-header cache
1103          * or a non-packet-header cache.
1104          */
1105         if (m->m_flags & M_PHCACHE) {
1106                 m->m_flags |= M_PKTHDR;
1107                 m->m_pkthdr.rcvif = NULL;       /* eliminate XXX JH */
1108                 m->m_pkthdr.csum_flags = 0;     /* eliminate XXX JH */
1109                 m->m_pkthdr.fw_flags = 0;       /* eliminate XXX JH */
1110                 SLIST_INIT(&m->m_pkthdr.tags);
1111         }
1112
1113         /*
1114          * Handle remaining flags combinations.  M_CLCACHE tells us whether
1115          * the mbuf was originally allocated from a cluster cache or not,
1116          * and is totally separate from whether the mbuf is currently
1117          * associated with a cluster.
1118          */
1119         switch(m->m_flags & (M_CLCACHE | M_EXT | M_EXT_CLUSTER)) {
1120         case M_CLCACHE | M_EXT | M_EXT_CLUSTER:
1121                 /*
1122                  * mbuf+cluster cache case.  The mbuf was allocated from the
1123                  * combined mbuf_cluster cache and can be returned to the
1124                  * cache if the cluster hasn't been shared.
1125                  */
1126                 if (m_sharecount(m) == 1) {
1127                         /*
1128                          * The cluster has not been shared, we can just
1129                          * reset the data pointer and return the mbuf
1130                          * to the cluster cache.  Note that the reference
1131                          * count is left intact (it is still associated with
1132                          * an mbuf).
1133                          */
1134                         m->m_data = m->m_ext.ext_buf;
1135                         if (m->m_flags & M_EXT && m->m_ext.ext_size != MCLBYTES) {
1136                                 if (m->m_flags & M_PHCACHE)
1137                                         objcache_put(mbufphdrjcluster_cache, m);
1138                                 else
1139                                         objcache_put(mbufjcluster_cache, m);
1140                         } else {
1141                                 if (m->m_flags & M_PHCACHE)
1142                                         objcache_put(mbufphdrcluster_cache, m);
1143                                 else
1144                                         objcache_put(mbufcluster_cache, m);
1145                         }
1146                         --mbstat[mycpu->gd_cpuid].m_clusters;
1147                 } else {
1148                         /*
1149                          * Hell.  Someone else has a ref on this cluster,
1150                          * we have to disconnect it which means we can't
1151                          * put it back into the mbufcluster_cache, we
1152                          * have to destroy the mbuf.
1153                          *
1154                          * Other mbuf references to the cluster will typically
1155                          * be M_EXT | M_EXT_CLUSTER but without M_CLCACHE.
1156                          *
1157                          * XXX we could try to connect another cluster to
1158                          * it.
1159                          */
1160                         m->m_ext.ext_free(m->m_ext.ext_arg); 
1161                         m->m_flags &= ~(M_EXT | M_EXT_CLUSTER);
1162                         if (m->m_ext.ext_size == MCLBYTES) {
1163                                 if (m->m_flags & M_PHCACHE)
1164                                         objcache_dtor(mbufphdrcluster_cache, m);
1165                                 else
1166                                         objcache_dtor(mbufcluster_cache, m);
1167                         } else {
1168                                 if (m->m_flags & M_PHCACHE)
1169                                         objcache_dtor(mbufphdrjcluster_cache, m);
1170                                 else
1171                                         objcache_dtor(mbufjcluster_cache, m);
1172                         }
1173                 }
1174                 break;
1175         case M_EXT | M_EXT_CLUSTER:
1176         case M_EXT:
1177                 /*
1178                  * Normal cluster association case, disconnect the cluster from
1179                  * the mbuf.  The cluster may or may not be custom.
1180                  */
1181                 m->m_ext.ext_free(m->m_ext.ext_arg); 
1182                 m->m_flags &= ~(M_EXT | M_EXT_CLUSTER);
1183                 /* fall through */
1184         case 0:
1185                 /*
1186                  * return the mbuf to the mbuf cache.
1187                  */
1188                 if (m->m_flags & M_PHCACHE) {
1189                         m->m_data = m->m_pktdat;
1190                         objcache_put(mbufphdr_cache, m);
1191                 } else {
1192                         m->m_data = m->m_dat;
1193                         objcache_put(mbuf_cache, m);
1194                 }
1195                 --mbstat[mycpu->gd_cpuid].m_mbufs;
1196                 break;
1197         default:
1198                 if (!panicstr)
1199                         panic("bad mbuf flags %p %08x", m, m->m_flags);
1200                 break;
1201         }
1202         return (n);
1203 }
1204
1205 #ifdef MBUF_DEBUG
1206
1207 void
1208 _m_freem(struct mbuf *m, const char *func)
1209 {
1210         while (m)
1211                 m = _m_free(m, func);
1212 }
1213
1214 #else
1215
1216 void
1217 m_freem(struct mbuf *m)
1218 {
1219         while (m)
1220                 m = m_free(m);
1221 }
1222
1223 #endif
1224
1225 void
1226 m_extadd(struct mbuf *m, caddr_t buf, u_int size,  void (*reff)(void *),
1227     void (*freef)(void *), void *arg)
1228 {
1229         m->m_ext.ext_arg = arg;
1230         m->m_ext.ext_buf = buf;
1231         m->m_ext.ext_ref = reff;
1232         m->m_ext.ext_free = freef;
1233         m->m_ext.ext_size = size;
1234         reff(arg);
1235         m->m_data = buf;
1236         m->m_flags |= M_EXT;
1237 }
1238
1239 /*
1240  * mbuf utility routines
1241  */
1242
1243 /*
1244  * Lesser-used path for M_PREPEND: allocate new mbuf to prepend to chain and
1245  * copy junk along.
1246  */
1247 struct mbuf *
1248 m_prepend(struct mbuf *m, int len, int how)
1249 {
1250         struct mbuf *mn;
1251
1252         if (m->m_flags & M_PKTHDR)
1253             mn = m_gethdr(how, m->m_type);
1254         else
1255             mn = m_get(how, m->m_type);
1256         if (mn == NULL) {
1257                 m_freem(m);
1258                 return (NULL);
1259         }
1260         if (m->m_flags & M_PKTHDR)
1261                 M_MOVE_PKTHDR(mn, m);
1262         mn->m_next = m;
1263         m = mn;
1264         if (len < MHLEN)
1265                 MH_ALIGN(m, len);
1266         m->m_len = len;
1267         return (m);
1268 }
1269
1270 /*
1271  * Make a copy of an mbuf chain starting "off0" bytes from the beginning,
1272  * continuing for "len" bytes.  If len is M_COPYALL, copy to end of mbuf.
1273  * The wait parameter is a choice of MB_WAIT/MB_DONTWAIT from caller.
1274  * Note that the copy is read-only, because clusters are not copied,
1275  * only their reference counts are incremented.
1276  */
1277 struct mbuf *
1278 m_copym(const struct mbuf *m, int off0, int len, int wait)
1279 {
1280         struct mbuf *n, **np;
1281         int off = off0;
1282         struct mbuf *top;
1283         int copyhdr = 0;
1284
1285         KASSERT(off >= 0, ("m_copym, negative off %d", off));
1286         KASSERT(len >= 0, ("m_copym, negative len %d", len));
1287         if (off == 0 && (m->m_flags & M_PKTHDR))
1288                 copyhdr = 1;
1289         while (off > 0) {
1290                 KASSERT(m != NULL, ("m_copym, offset > size of mbuf chain"));
1291                 if (off < m->m_len)
1292                         break;
1293                 off -= m->m_len;
1294                 m = m->m_next;
1295         }
1296         np = &top;
1297         top = NULL;
1298         while (len > 0) {
1299                 if (m == NULL) {
1300                         KASSERT(len == M_COPYALL, 
1301                             ("m_copym, length > size of mbuf chain"));
1302                         break;
1303                 }
1304                 /*
1305                  * Because we are sharing any cluster attachment below,
1306                  * be sure to get an mbuf that does not have a cluster
1307                  * associated with it.
1308                  */
1309                 if (copyhdr)
1310                         n = m_gethdr(wait, m->m_type);
1311                 else
1312                         n = m_get(wait, m->m_type);
1313                 *np = n;
1314                 if (n == NULL)
1315                         goto nospace;
1316                 if (copyhdr) {
1317                         if (!m_dup_pkthdr(n, m, wait))
1318                                 goto nospace;
1319                         if (len == M_COPYALL)
1320                                 n->m_pkthdr.len -= off0;
1321                         else
1322                                 n->m_pkthdr.len = len;
1323                         copyhdr = 0;
1324                 }
1325                 n->m_len = min(len, m->m_len - off);
1326                 if (m->m_flags & M_EXT) {
1327                         KKASSERT((n->m_flags & M_EXT) == 0);
1328                         n->m_data = m->m_data + off;
1329                         m->m_ext.ext_ref(m->m_ext.ext_arg); 
1330                         n->m_ext = m->m_ext;
1331                         n->m_flags |= m->m_flags & (M_EXT | M_EXT_CLUSTER);
1332                 } else {
1333                         bcopy(mtod(m, caddr_t)+off, mtod(n, caddr_t),
1334                             (unsigned)n->m_len);
1335                 }
1336                 if (len != M_COPYALL)
1337                         len -= n->m_len;
1338                 off = 0;
1339                 m = m->m_next;
1340                 np = &n->m_next;
1341         }
1342         if (top == NULL)
1343                 ++mbstat[mycpu->gd_cpuid].m_mcfail;
1344         return (top);
1345 nospace:
1346         m_freem(top);
1347         ++mbstat[mycpu->gd_cpuid].m_mcfail;
1348         return (NULL);
1349 }
1350
1351 /*
1352  * Copy an entire packet, including header (which must be present).
1353  * An optimization of the common case `m_copym(m, 0, M_COPYALL, how)'.
1354  * Note that the copy is read-only, because clusters are not copied,
1355  * only their reference counts are incremented.
1356  * Preserve alignment of the first mbuf so if the creator has left
1357  * some room at the beginning (e.g. for inserting protocol headers)
1358  * the copies also have the room available.
1359  */
1360 struct mbuf *
1361 m_copypacket(struct mbuf *m, int how)
1362 {
1363         struct mbuf *top, *n, *o;
1364
1365         n = m_gethdr(how, m->m_type);
1366         top = n;
1367         if (!n)
1368                 goto nospace;
1369
1370         if (!m_dup_pkthdr(n, m, how))
1371                 goto nospace;
1372         n->m_len = m->m_len;
1373         if (m->m_flags & M_EXT) {
1374                 KKASSERT((n->m_flags & M_EXT) == 0);
1375                 n->m_data = m->m_data;
1376                 m->m_ext.ext_ref(m->m_ext.ext_arg); 
1377                 n->m_ext = m->m_ext;
1378                 n->m_flags |= m->m_flags & (M_EXT | M_EXT_CLUSTER);
1379         } else {
1380                 n->m_data = n->m_pktdat + (m->m_data - m->m_pktdat );
1381                 bcopy(mtod(m, char *), mtod(n, char *), n->m_len);
1382         }
1383
1384         m = m->m_next;
1385         while (m) {
1386                 o = m_get(how, m->m_type);
1387                 if (!o)
1388                         goto nospace;
1389
1390                 n->m_next = o;
1391                 n = n->m_next;
1392
1393                 n->m_len = m->m_len;
1394                 if (m->m_flags & M_EXT) {
1395                         KKASSERT((n->m_flags & M_EXT) == 0);
1396                         n->m_data = m->m_data;
1397                         m->m_ext.ext_ref(m->m_ext.ext_arg); 
1398                         n->m_ext = m->m_ext;
1399                         n->m_flags |= m->m_flags & (M_EXT | M_EXT_CLUSTER);
1400                 } else {
1401                         bcopy(mtod(m, char *), mtod(n, char *), n->m_len);
1402                 }
1403
1404                 m = m->m_next;
1405         }
1406         return top;
1407 nospace:
1408         m_freem(top);
1409         ++mbstat[mycpu->gd_cpuid].m_mcfail;
1410         return (NULL);
1411 }
1412
1413 /*
1414  * Copy data from an mbuf chain starting "off" bytes from the beginning,
1415  * continuing for "len" bytes, into the indicated buffer.
1416  */
1417 void
1418 m_copydata(const struct mbuf *m, int off, int len, caddr_t cp)
1419 {
1420         unsigned count;
1421
1422         KASSERT(off >= 0, ("m_copydata, negative off %d", off));
1423         KASSERT(len >= 0, ("m_copydata, negative len %d", len));
1424         while (off > 0) {
1425                 KASSERT(m != NULL, ("m_copydata, offset > size of mbuf chain"));
1426                 if (off < m->m_len)
1427                         break;
1428                 off -= m->m_len;
1429                 m = m->m_next;
1430         }
1431         while (len > 0) {
1432                 KASSERT(m != NULL, ("m_copydata, length > size of mbuf chain"));
1433                 count = min(m->m_len - off, len);
1434                 bcopy(mtod(m, caddr_t) + off, cp, count);
1435                 len -= count;
1436                 cp += count;
1437                 off = 0;
1438                 m = m->m_next;
1439         }
1440 }
1441
1442 /*
1443  * Copy a packet header mbuf chain into a completely new chain, including
1444  * copying any mbuf clusters.  Use this instead of m_copypacket() when
1445  * you need a writable copy of an mbuf chain.
1446  */
1447 struct mbuf *
1448 m_dup(struct mbuf *m, int how)
1449 {
1450         struct mbuf **p, *top = NULL;
1451         int remain, moff, nsize;
1452
1453         /* Sanity check */
1454         if (m == NULL)
1455                 return (NULL);
1456         KASSERT((m->m_flags & M_PKTHDR) != 0, ("%s: !PKTHDR", __func__));
1457
1458         /* While there's more data, get a new mbuf, tack it on, and fill it */
1459         remain = m->m_pkthdr.len;
1460         moff = 0;
1461         p = &top;
1462         while (remain > 0 || top == NULL) {     /* allow m->m_pkthdr.len == 0 */
1463                 struct mbuf *n;
1464
1465                 /* Get the next new mbuf */
1466                 n = m_getl(remain, how, m->m_type, top == NULL ? M_PKTHDR : 0,
1467                            &nsize);
1468                 if (n == NULL)
1469                         goto nospace;
1470                 if (top == NULL)
1471                         if (!m_dup_pkthdr(n, m, how))
1472                                 goto nospace0;
1473
1474                 /* Link it into the new chain */
1475                 *p = n;
1476                 p = &n->m_next;
1477
1478                 /* Copy data from original mbuf(s) into new mbuf */
1479                 n->m_len = 0;
1480                 while (n->m_len < nsize && m != NULL) {
1481                         int chunk = min(nsize - n->m_len, m->m_len - moff);
1482
1483                         bcopy(m->m_data + moff, n->m_data + n->m_len, chunk);
1484                         moff += chunk;
1485                         n->m_len += chunk;
1486                         remain -= chunk;
1487                         if (moff == m->m_len) {
1488                                 m = m->m_next;
1489                                 moff = 0;
1490                         }
1491                 }
1492
1493                 /* Check correct total mbuf length */
1494                 KASSERT((remain > 0 && m != NULL) || (remain == 0 && m == NULL),
1495                         ("%s: bogus m_pkthdr.len", __func__));
1496         }
1497         return (top);
1498
1499 nospace:
1500         m_freem(top);
1501 nospace0:
1502         ++mbstat[mycpu->gd_cpuid].m_mcfail;
1503         return (NULL);
1504 }
1505
1506 /*
1507  * Copy the non-packet mbuf data chain into a new set of mbufs, including
1508  * copying any mbuf clusters.  This is typically used to realign a data
1509  * chain by nfs_realign().
1510  *
1511  * The original chain is left intact.  how should be MB_WAIT or MB_DONTWAIT
1512  * and NULL can be returned if MB_DONTWAIT is passed.
1513  *
1514  * Be careful to use cluster mbufs, a large mbuf chain converted to non
1515  * cluster mbufs can exhaust our supply of mbufs.
1516  */
1517 struct mbuf *
1518 m_dup_data(struct mbuf *m, int how)
1519 {
1520         struct mbuf **p, *n, *top = NULL;
1521         int mlen, moff, chunk, gsize, nsize;
1522
1523         /*
1524          * Degenerate case
1525          */
1526         if (m == NULL)
1527                 return (NULL);
1528
1529         /*
1530          * Optimize the mbuf allocation but do not get too carried away.
1531          */
1532         if (m->m_next || m->m_len > MLEN)
1533                 if (m->m_flags & M_EXT && m->m_ext.ext_size == MCLBYTES)
1534                         gsize = MCLBYTES;
1535                 else
1536                         gsize = MJUMPAGESIZE;
1537         else
1538                 gsize = MLEN;
1539
1540         /* Chain control */
1541         p = &top;
1542         n = NULL;
1543         nsize = 0;
1544
1545         /*
1546          * Scan the mbuf chain until nothing is left, the new mbuf chain
1547          * will be allocated on the fly as needed.
1548          */
1549         while (m) {
1550                 mlen = m->m_len;
1551                 moff = 0;
1552
1553                 while (mlen) {
1554                         KKASSERT(m->m_type == MT_DATA);
1555                         if (n == NULL) {
1556                                 n = m_getl(gsize, how, MT_DATA, 0, &nsize);
1557                                 n->m_len = 0;
1558                                 if (n == NULL)
1559                                         goto nospace;
1560                                 *p = n;
1561                                 p = &n->m_next;
1562                         }
1563                         chunk = imin(mlen, nsize);
1564                         bcopy(m->m_data + moff, n->m_data + n->m_len, chunk);
1565                         mlen -= chunk;
1566                         moff += chunk;
1567                         n->m_len += chunk;
1568                         nsize -= chunk;
1569                         if (nsize == 0)
1570                                 n = NULL;
1571                 }
1572                 m = m->m_next;
1573         }
1574         *p = NULL;
1575         return(top);
1576 nospace:
1577         *p = NULL;
1578         m_freem(top);
1579         ++mbstat[mycpu->gd_cpuid].m_mcfail;
1580         return (NULL);
1581 }
1582
1583 /*
1584  * Concatenate mbuf chain n to m.
1585  * Both chains must be of the same type (e.g. MT_DATA).
1586  * Any m_pkthdr is not updated.
1587  */
1588 void
1589 m_cat(struct mbuf *m, struct mbuf *n)
1590 {
1591         m = m_last(m);
1592         while (n) {
1593                 if (m->m_flags & M_EXT ||
1594                     m->m_data + m->m_len + n->m_len >= &m->m_dat[MLEN]) {
1595                         /* just join the two chains */
1596                         m->m_next = n;
1597                         return;
1598                 }
1599                 /* splat the data from one into the other */
1600                 bcopy(mtod(n, caddr_t), mtod(m, caddr_t) + m->m_len,
1601                     (u_int)n->m_len);
1602                 m->m_len += n->m_len;
1603                 n = m_free(n);
1604         }
1605 }
1606
1607 void
1608 m_adj(struct mbuf *mp, int req_len)
1609 {
1610         int len = req_len;
1611         struct mbuf *m;
1612         int count;
1613
1614         if ((m = mp) == NULL)
1615                 return;
1616         if (len >= 0) {
1617                 /*
1618                  * Trim from head.
1619                  */
1620                 while (m != NULL && len > 0) {
1621                         if (m->m_len <= len) {
1622                                 len -= m->m_len;
1623                                 m->m_len = 0;
1624                                 m = m->m_next;
1625                         } else {
1626                                 m->m_len -= len;
1627                                 m->m_data += len;
1628                                 len = 0;
1629                         }
1630                 }
1631                 m = mp;
1632                 if (mp->m_flags & M_PKTHDR)
1633                         m->m_pkthdr.len -= (req_len - len);
1634         } else {
1635                 /*
1636                  * Trim from tail.  Scan the mbuf chain,
1637                  * calculating its length and finding the last mbuf.
1638                  * If the adjustment only affects this mbuf, then just
1639                  * adjust and return.  Otherwise, rescan and truncate
1640                  * after the remaining size.
1641                  */
1642                 len = -len;
1643                 count = 0;
1644                 for (;;) {
1645                         count += m->m_len;
1646                         if (m->m_next == NULL)
1647                                 break;
1648                         m = m->m_next;
1649                 }
1650                 if (m->m_len >= len) {
1651                         m->m_len -= len;
1652                         if (mp->m_flags & M_PKTHDR)
1653                                 mp->m_pkthdr.len -= len;
1654                         return;
1655                 }
1656                 count -= len;
1657                 if (count < 0)
1658                         count = 0;
1659                 /*
1660                  * Correct length for chain is "count".
1661                  * Find the mbuf with last data, adjust its length,
1662                  * and toss data from remaining mbufs on chain.
1663                  */
1664                 m = mp;
1665                 if (m->m_flags & M_PKTHDR)
1666                         m->m_pkthdr.len = count;
1667                 for (; m; m = m->m_next) {
1668                         if (m->m_len >= count) {
1669                                 m->m_len = count;
1670                                 break;
1671                         }
1672                         count -= m->m_len;
1673                 }
1674                 while (m->m_next)
1675                         (m = m->m_next) ->m_len = 0;
1676         }
1677 }
1678
1679 /*
1680  * Set the m_data pointer of a newly-allocated mbuf
1681  * to place an object of the specified size at the
1682  * end of the mbuf, longword aligned.
1683  */
1684 void
1685 m_align(struct mbuf *m, int len)
1686 {
1687         int adjust;
1688
1689         if (m->m_flags & M_EXT)
1690                 adjust = m->m_ext.ext_size - len;
1691         else if (m->m_flags & M_PKTHDR)
1692                 adjust = MHLEN - len;
1693         else
1694                 adjust = MLEN - len;
1695         m->m_data += adjust &~ (sizeof(long)-1);
1696 }
1697
1698 /*
1699  * Create a writable copy of the mbuf chain.  While doing this
1700  * we compact the chain with a goal of producing a chain with
1701  * at most two mbufs.  The second mbuf in this chain is likely
1702  * to be a cluster.  The primary purpose of this work is to create
1703  * a writable packet for encryption, compression, etc.  The
1704  * secondary goal is to linearize the data so the data can be
1705  * passed to crypto hardware in the most efficient manner possible.
1706  */
1707 struct mbuf *
1708 m_unshare(struct mbuf *m0, int how)
1709 {
1710         struct mbuf *m, *mprev;
1711         struct mbuf *n, *mfirst, *mlast;
1712         int len, off;
1713
1714         mprev = NULL;
1715         for (m = m0; m != NULL; m = mprev->m_next) {
1716                 /*
1717                  * Regular mbufs are ignored unless there's a cluster
1718                  * in front of it that we can use to coalesce.  We do
1719                  * the latter mainly so later clusters can be coalesced
1720                  * also w/o having to handle them specially (i.e. convert
1721                  * mbuf+cluster -> cluster).  This optimization is heavily
1722                  * influenced by the assumption that we're running over
1723                  * Ethernet where MCLBYTES is large enough that the max
1724                  * packet size will permit lots of coalescing into a
1725                  * single cluster.  This in turn permits efficient
1726                  * crypto operations, especially when using hardware.
1727                  */
1728                 if ((m->m_flags & M_EXT) == 0) {
1729                         if (mprev && (mprev->m_flags & M_EXT) &&
1730                             m->m_len <= M_TRAILINGSPACE(mprev)) {
1731                                 /* XXX: this ignores mbuf types */
1732                                 memcpy(mtod(mprev, caddr_t) + mprev->m_len,
1733                                        mtod(m, caddr_t), m->m_len);
1734                                 mprev->m_len += m->m_len;
1735                                 mprev->m_next = m->m_next;      /* unlink from chain */
1736                                 m_free(m);                      /* reclaim mbuf */
1737                         } else {
1738                                 mprev = m;
1739                         }
1740                         continue;
1741                 }
1742                 /*
1743                  * Writable mbufs are left alone (for now).
1744                  */
1745                 if (M_WRITABLE(m)) {
1746                         mprev = m;
1747                         continue;
1748                 }
1749
1750                 /*
1751                  * Not writable, replace with a copy or coalesce with
1752                  * the previous mbuf if possible (since we have to copy
1753                  * it anyway, we try to reduce the number of mbufs and
1754                  * clusters so that future work is easier).
1755                  */
1756                 KASSERT(m->m_flags & M_EXT, ("m_flags 0x%x", m->m_flags));
1757                 /* NB: we only coalesce into a cluster or larger */
1758                 if (mprev != NULL && (mprev->m_flags & M_EXT) &&
1759                     m->m_len <= M_TRAILINGSPACE(mprev)) {
1760                         /* XXX: this ignores mbuf types */
1761                         memcpy(mtod(mprev, caddr_t) + mprev->m_len,
1762                                mtod(m, caddr_t), m->m_len);
1763                         mprev->m_len += m->m_len;
1764                         mprev->m_next = m->m_next;      /* unlink from chain */
1765                         m_free(m);                      /* reclaim mbuf */
1766                         continue;
1767                 }
1768
1769                 /*
1770                  * Allocate new space to hold the copy...
1771                  */
1772                 /* XXX why can M_PKTHDR be set past the first mbuf? */
1773                 if (mprev == NULL && (m->m_flags & M_PKTHDR)) {
1774                         /*
1775                          * NB: if a packet header is present we must
1776                          * allocate the mbuf separately from any cluster
1777                          * because M_MOVE_PKTHDR will smash the data
1778                          * pointer and drop the M_EXT marker.
1779                          */
1780                         MGETHDR(n, how, m->m_type);
1781                         if (n == NULL) {
1782                                 m_freem(m0);
1783                                 return (NULL);
1784                         }
1785                         M_MOVE_PKTHDR(n, m);
1786                         MCLGET(n, how);
1787                         if ((n->m_flags & M_EXT) == 0) {
1788                                 m_free(n);
1789                                 m_freem(m0);
1790                                 return (NULL);
1791                         }
1792                 } else {
1793                         n = m_getcl(how, m->m_type, m->m_flags);
1794                         if (n == NULL) {
1795                                 m_freem(m0);
1796                                 return (NULL);
1797                         }
1798                 }
1799                 /*
1800                  * ... and copy the data.  We deal with jumbo mbufs
1801                  * (i.e. m_len > MCLBYTES) by splitting them into
1802                  * clusters.  We could just malloc a buffer and make
1803                  * it external but too many device drivers don't know
1804                  * how to break up the non-contiguous memory when
1805                  * doing DMA.
1806                  */
1807                 len = m->m_len;
1808                 off = 0;
1809                 mfirst = n;
1810                 mlast = NULL;
1811                 for (;;) {
1812                         int cc = min(len, MCLBYTES);
1813                         memcpy(mtod(n, caddr_t), mtod(m, caddr_t) + off, cc);
1814                         n->m_len = cc;
1815                         if (mlast != NULL)
1816                                 mlast->m_next = n;
1817                         mlast = n;      
1818
1819                         len -= cc;
1820                         if (len <= 0)
1821                                 break;
1822                         off += cc;
1823
1824                         n = m_getcl(how, m->m_type, m->m_flags);
1825                         if (n == NULL) {
1826                                 m_freem(mfirst);
1827                                 m_freem(m0);
1828                                 return (NULL);
1829                         }
1830                 }
1831                 n->m_next = m->m_next; 
1832                 if (mprev == NULL)
1833                         m0 = mfirst;            /* new head of chain */
1834                 else
1835                         mprev->m_next = mfirst; /* replace old mbuf */
1836                 m_free(m);                      /* release old mbuf */
1837                 mprev = mfirst;
1838         }
1839         return (m0);
1840 }
1841
1842 /*
1843  * Rearrange an mbuf chain so that len bytes are contiguous
1844  * and in the data area of an mbuf (so that mtod will work for a structure
1845  * of size len).  Returns the resulting mbuf chain on success, frees it and
1846  * returns null on failure.  If there is room, it will add up to
1847  * max_protohdr-len extra bytes to the contiguous region in an attempt to
1848  * avoid being called next time.
1849  */
1850 struct mbuf *
1851 m_pullup(struct mbuf *n, int len)
1852 {
1853         struct mbuf *m;
1854         int count;
1855         int space;
1856
1857         /*
1858          * If first mbuf has no cluster, and has room for len bytes
1859          * without shifting current data, pullup into it,
1860          * otherwise allocate a new mbuf to prepend to the chain.
1861          */
1862         if (!(n->m_flags & M_EXT) &&
1863             n->m_data + len < &n->m_dat[MLEN] &&
1864             n->m_next) {
1865                 if (n->m_len >= len)
1866                         return (n);
1867                 m = n;
1868                 n = n->m_next;
1869                 len -= m->m_len;
1870         } else {
1871                 if (len > MHLEN)
1872                         goto bad;
1873                 if (n->m_flags & M_PKTHDR)
1874                         m = m_gethdr(MB_DONTWAIT, n->m_type);
1875                 else
1876                         m = m_get(MB_DONTWAIT, n->m_type);
1877                 if (m == NULL)
1878                         goto bad;
1879                 m->m_len = 0;
1880                 if (n->m_flags & M_PKTHDR)
1881                         M_MOVE_PKTHDR(m, n);
1882         }
1883         space = &m->m_dat[MLEN] - (m->m_data + m->m_len);
1884         do {
1885                 count = min(min(max(len, max_protohdr), space), n->m_len);
1886                 bcopy(mtod(n, caddr_t), mtod(m, caddr_t) + m->m_len,
1887                   (unsigned)count);
1888                 len -= count;
1889                 m->m_len += count;
1890                 n->m_len -= count;
1891                 space -= count;
1892                 if (n->m_len)
1893                         n->m_data += count;
1894                 else
1895                         n = m_free(n);
1896         } while (len > 0 && n);
1897         if (len > 0) {
1898                 m_free(m);
1899                 goto bad;
1900         }
1901         m->m_next = n;
1902         return (m);
1903 bad:
1904         m_freem(n);
1905         ++mbstat[mycpu->gd_cpuid].m_mcfail;
1906         return (NULL);
1907 }
1908
1909 /*
1910  * Partition an mbuf chain in two pieces, returning the tail --
1911  * all but the first len0 bytes.  In case of failure, it returns NULL and
1912  * attempts to restore the chain to its original state.
1913  *
1914  * Note that the resulting mbufs might be read-only, because the new
1915  * mbuf can end up sharing an mbuf cluster with the original mbuf if
1916  * the "breaking point" happens to lie within a cluster mbuf. Use the
1917  * M_WRITABLE() macro to check for this case.
1918  */
1919 struct mbuf *
1920 m_split(struct mbuf *m0, int len0, int wait)
1921 {
1922         struct mbuf *m, *n;
1923         unsigned len = len0, remain;
1924
1925         for (m = m0; m && len > m->m_len; m = m->m_next)
1926                 len -= m->m_len;
1927         if (m == NULL)
1928                 return (NULL);
1929         remain = m->m_len - len;
1930         if (m0->m_flags & M_PKTHDR) {
1931                 n = m_gethdr(wait, m0->m_type);
1932                 if (n == NULL)
1933                         return (NULL);
1934                 n->m_pkthdr.rcvif = m0->m_pkthdr.rcvif;
1935                 n->m_pkthdr.len = m0->m_pkthdr.len - len0;
1936                 m0->m_pkthdr.len = len0;
1937                 if (m->m_flags & M_EXT)
1938                         goto extpacket;
1939                 if (remain > MHLEN) {
1940                         /* m can't be the lead packet */
1941                         MH_ALIGN(n, 0);
1942                         n->m_next = m_split(m, len, wait);
1943                         if (n->m_next == NULL) {
1944                                 m_free(n);
1945                                 return (NULL);
1946                         } else {
1947                                 n->m_len = 0;
1948                                 return (n);
1949                         }
1950                 } else
1951                         MH_ALIGN(n, remain);
1952         } else if (remain == 0) {
1953                 n = m->m_next;
1954                 m->m_next = NULL;
1955                 return (n);
1956         } else {
1957                 n = m_get(wait, m->m_type);
1958                 if (n == NULL)
1959                         return (NULL);
1960                 M_ALIGN(n, remain);
1961         }
1962 extpacket:
1963         if (m->m_flags & M_EXT) {
1964                 KKASSERT((n->m_flags & M_EXT) == 0);
1965                 n->m_data = m->m_data + len;
1966                 m->m_ext.ext_ref(m->m_ext.ext_arg); 
1967                 n->m_ext = m->m_ext;
1968                 n->m_flags |= m->m_flags & (M_EXT | M_EXT_CLUSTER);
1969         } else {
1970                 bcopy(mtod(m, caddr_t) + len, mtod(n, caddr_t), remain);
1971         }
1972         n->m_len = remain;
1973         m->m_len = len;
1974         n->m_next = m->m_next;
1975         m->m_next = NULL;
1976         return (n);
1977 }
1978
1979 /*
1980  * Routine to copy from device local memory into mbufs.
1981  * Note: "offset" is ill-defined and always called as 0, so ignore it.
1982  */
1983 struct mbuf *
1984 m_devget(char *buf, int len, int offset, struct ifnet *ifp,
1985     void (*copy)(volatile const void *from, volatile void *to, size_t length))
1986 {
1987         struct mbuf *m, *mfirst = NULL, **mtail;
1988         int nsize, flags;
1989
1990         if (copy == NULL)
1991                 copy = bcopy;
1992         mtail = &mfirst;
1993         flags = M_PKTHDR;
1994
1995         while (len > 0) {
1996                 m = m_getl(len, MB_DONTWAIT, MT_DATA, flags, &nsize);
1997                 if (m == NULL) {
1998                         m_freem(mfirst);
1999                         return (NULL);
2000                 }
2001                 m->m_len = min(len, nsize);
2002
2003                 if (flags & M_PKTHDR) {
2004                         if (len + max_linkhdr <= nsize)
2005                                 m->m_data += max_linkhdr;
2006                         m->m_pkthdr.rcvif = ifp;
2007                         m->m_pkthdr.len = len;
2008                         flags = 0;
2009                 }
2010
2011                 copy(buf, m->m_data, (unsigned)m->m_len);
2012                 buf += m->m_len;
2013                 len -= m->m_len;
2014                 *mtail = m;
2015                 mtail = &m->m_next;
2016         }
2017
2018         return (mfirst);
2019 }
2020
2021 /*
2022  * Routine to pad mbuf to the specified length 'padto'.
2023  */
2024 int
2025 m_devpad(struct mbuf *m, int padto)
2026 {
2027         struct mbuf *last = NULL;
2028         int padlen;
2029
2030         if (padto <= m->m_pkthdr.len)
2031                 return 0;
2032
2033         padlen = padto - m->m_pkthdr.len;
2034
2035         /* if there's only the packet-header and we can pad there, use it. */
2036         if (m->m_pkthdr.len == m->m_len && M_TRAILINGSPACE(m) >= padlen) {
2037                 last = m;
2038         } else {
2039                 /*
2040                  * Walk packet chain to find last mbuf. We will either
2041                  * pad there, or append a new mbuf and pad it
2042                  */
2043                 for (last = m; last->m_next != NULL; last = last->m_next)
2044                         ; /* EMPTY */
2045
2046                 /* `last' now points to last in chain. */
2047                 if (M_TRAILINGSPACE(last) < padlen) {
2048                         struct mbuf *n;
2049
2050                         /* Allocate new empty mbuf, pad it.  Compact later. */
2051                         MGET(n, MB_DONTWAIT, MT_DATA);
2052                         if (n == NULL)
2053                                 return ENOBUFS;
2054                         n->m_len = 0;
2055                         last->m_next = n;
2056                         last = n;
2057                 }
2058         }
2059         KKASSERT(M_TRAILINGSPACE(last) >= padlen);
2060         KKASSERT(M_WRITABLE(last));
2061
2062         /* Now zero the pad area */
2063         bzero(mtod(last, char *) + last->m_len, padlen);
2064         last->m_len += padlen;
2065         m->m_pkthdr.len += padlen;
2066         return 0;
2067 }
2068
2069 /*
2070  * Copy data from a buffer back into the indicated mbuf chain,
2071  * starting "off" bytes from the beginning, extending the mbuf
2072  * chain if necessary.
2073  */
2074 void
2075 m_copyback(struct mbuf *m0, int off, int len, caddr_t cp)
2076 {
2077         int mlen;
2078         struct mbuf *m = m0, *n;
2079         int totlen = 0;
2080
2081         if (m0 == NULL)
2082                 return;
2083         while (off > (mlen = m->m_len)) {
2084                 off -= mlen;
2085                 totlen += mlen;
2086                 if (m->m_next == NULL) {
2087                         n = m_getclr(MB_DONTWAIT, m->m_type);
2088                         if (n == NULL)
2089                                 goto out;
2090                         n->m_len = min(MLEN, len + off);
2091                         m->m_next = n;
2092                 }
2093                 m = m->m_next;
2094         }
2095         while (len > 0) {
2096                 mlen = min (m->m_len - off, len);
2097                 bcopy(cp, off + mtod(m, caddr_t), (unsigned)mlen);
2098                 cp += mlen;
2099                 len -= mlen;
2100                 mlen += off;
2101                 off = 0;
2102                 totlen += mlen;
2103                 if (len == 0)
2104                         break;
2105                 if (m->m_next == NULL) {
2106                         n = m_get(MB_DONTWAIT, m->m_type);
2107                         if (n == NULL)
2108                                 break;
2109                         n->m_len = min(MLEN, len);
2110                         m->m_next = n;
2111                 }
2112                 m = m->m_next;
2113         }
2114 out:    if (((m = m0)->m_flags & M_PKTHDR) && (m->m_pkthdr.len < totlen))
2115                 m->m_pkthdr.len = totlen;
2116 }
2117
2118 /*
2119  * Append the specified data to the indicated mbuf chain,
2120  * Extend the mbuf chain if the new data does not fit in
2121  * existing space.
2122  *
2123  * Return 1 if able to complete the job; otherwise 0.
2124  */
2125 int
2126 m_append(struct mbuf *m0, int len, c_caddr_t cp)
2127 {
2128         struct mbuf *m, *n;
2129         int remainder, space;
2130
2131         for (m = m0; m->m_next != NULL; m = m->m_next)
2132                 ;
2133         remainder = len;
2134         space = M_TRAILINGSPACE(m);
2135         if (space > 0) {
2136                 /*
2137                  * Copy into available space.
2138                  */
2139                 if (space > remainder)
2140                         space = remainder;
2141                 bcopy(cp, mtod(m, caddr_t) + m->m_len, space);
2142                 m->m_len += space;
2143                 cp += space, remainder -= space;
2144         }
2145         while (remainder > 0) {
2146                 /*
2147                  * Allocate a new mbuf; could check space
2148                  * and allocate a cluster instead.
2149                  */
2150                 n = m_get(MB_DONTWAIT, m->m_type);
2151                 if (n == NULL)
2152                         break;
2153                 n->m_len = min(MLEN, remainder);
2154                 bcopy(cp, mtod(n, caddr_t), n->m_len);
2155                 cp += n->m_len, remainder -= n->m_len;
2156                 m->m_next = n;
2157                 m = n;
2158         }
2159         if (m0->m_flags & M_PKTHDR)
2160                 m0->m_pkthdr.len += len - remainder;
2161         return (remainder == 0);
2162 }
2163
2164 /*
2165  * Apply function f to the data in an mbuf chain starting "off" bytes from
2166  * the beginning, continuing for "len" bytes.
2167  */
2168 int
2169 m_apply(struct mbuf *m, int off, int len,
2170     int (*f)(void *, void *, u_int), void *arg)
2171 {
2172         u_int count;
2173         int rval;
2174
2175         KASSERT(off >= 0, ("m_apply, negative off %d", off));
2176         KASSERT(len >= 0, ("m_apply, negative len %d", len));
2177         while (off > 0) {
2178                 KASSERT(m != NULL, ("m_apply, offset > size of mbuf chain"));
2179                 if (off < m->m_len)
2180                         break;
2181                 off -= m->m_len;
2182                 m = m->m_next;
2183         }
2184         while (len > 0) {
2185                 KASSERT(m != NULL, ("m_apply, offset > size of mbuf chain"));
2186                 count = min(m->m_len - off, len);
2187                 rval = (*f)(arg, mtod(m, caddr_t) + off, count);
2188                 if (rval)
2189                         return (rval);
2190                 len -= count;
2191                 off = 0;
2192                 m = m->m_next;
2193         }
2194         return (0);
2195 }
2196
2197 /*
2198  * Return a pointer to mbuf/offset of location in mbuf chain.
2199  */
2200 struct mbuf *
2201 m_getptr(struct mbuf *m, int loc, int *off)
2202 {
2203
2204         while (loc >= 0) {
2205                 /* Normal end of search. */
2206                 if (m->m_len > loc) {
2207                         *off = loc;
2208                         return (m);
2209                 } else {
2210                         loc -= m->m_len;
2211                         if (m->m_next == NULL) {
2212                                 if (loc == 0) {
2213                                         /* Point at the end of valid data. */
2214                                         *off = m->m_len;
2215                                         return (m);
2216                                 }
2217                                 return (NULL);
2218                         }
2219                         m = m->m_next;
2220                 }
2221         }
2222         return (NULL);
2223 }
2224
2225 void
2226 m_print(const struct mbuf *m)
2227 {
2228         int len;
2229         const struct mbuf *m2;
2230
2231         len = m->m_pkthdr.len;
2232         m2 = m;
2233         while (len) {
2234                 kprintf("%p %*D\n", m2, m2->m_len, (u_char *)m2->m_data, "-");
2235                 len -= m2->m_len;
2236                 m2 = m2->m_next;
2237         }
2238         return;
2239 }
2240
2241 /*
2242  * "Move" mbuf pkthdr from "from" to "to".
2243  * "from" must have M_PKTHDR set, and "to" must be empty.
2244  */
2245 void
2246 m_move_pkthdr(struct mbuf *to, struct mbuf *from)
2247 {
2248         KASSERT((to->m_flags & M_PKTHDR), ("m_move_pkthdr: not packet header"));
2249
2250         to->m_flags |= from->m_flags & M_COPYFLAGS;
2251         to->m_pkthdr = from->m_pkthdr;          /* especially tags */
2252         SLIST_INIT(&from->m_pkthdr.tags);       /* purge tags from src */
2253 }
2254
2255 /*
2256  * Duplicate "from"'s mbuf pkthdr in "to".
2257  * "from" must have M_PKTHDR set, and "to" must be empty.
2258  * In particular, this does a deep copy of the packet tags.
2259  */
2260 int
2261 m_dup_pkthdr(struct mbuf *to, const struct mbuf *from, int how)
2262 {
2263         KASSERT((to->m_flags & M_PKTHDR), ("m_dup_pkthdr: not packet header"));
2264
2265         to->m_flags = (from->m_flags & M_COPYFLAGS) |
2266                       (to->m_flags & ~M_COPYFLAGS);
2267         to->m_pkthdr = from->m_pkthdr;
2268         SLIST_INIT(&to->m_pkthdr.tags);
2269         return (m_tag_copy_chain(to, from, how));
2270 }
2271
2272 /*
2273  * Defragment a mbuf chain, returning the shortest possible
2274  * chain of mbufs and clusters.  If allocation fails and
2275  * this cannot be completed, NULL will be returned, but
2276  * the passed in chain will be unchanged.  Upon success,
2277  * the original chain will be freed, and the new chain
2278  * will be returned.
2279  *
2280  * If a non-packet header is passed in, the original
2281  * mbuf (chain?) will be returned unharmed.
2282  *
2283  * m_defrag_nofree doesn't free the passed in mbuf.
2284  */
2285 struct mbuf *
2286 m_defrag(struct mbuf *m0, int how)
2287 {
2288         struct mbuf *m_new;
2289
2290         if ((m_new = m_defrag_nofree(m0, how)) == NULL)
2291                 return (NULL);
2292         if (m_new != m0)
2293                 m_freem(m0);
2294         return (m_new);
2295 }
2296
2297 struct mbuf *
2298 m_defrag_nofree(struct mbuf *m0, int how)
2299 {
2300         struct mbuf     *m_new = NULL, *m_final = NULL;
2301         int             progress = 0, length, nsize;
2302
2303         if (!(m0->m_flags & M_PKTHDR))
2304                 return (m0);
2305
2306 #ifdef MBUF_STRESS_TEST
2307         if (m_defragrandomfailures) {
2308                 int temp = karc4random() & 0xff;
2309                 if (temp == 0xba)
2310                         goto nospace;
2311         }
2312 #endif
2313         
2314         m_final = m_getl(m0->m_pkthdr.len, how, MT_DATA, M_PKTHDR, &nsize);
2315         if (m_final == NULL)
2316                 goto nospace;
2317         m_final->m_len = 0;     /* in case m0->m_pkthdr.len is zero */
2318
2319         if (m_dup_pkthdr(m_final, m0, how) == 0)
2320                 goto nospace;
2321
2322         m_new = m_final;
2323
2324         while (progress < m0->m_pkthdr.len) {
2325                 length = m0->m_pkthdr.len - progress;
2326                 if (length > MCLBYTES)
2327                         length = MCLBYTES;
2328
2329                 if (m_new == NULL) {
2330                         m_new = m_getl(length, how, MT_DATA, 0, &nsize);
2331                         if (m_new == NULL)
2332                                 goto nospace;
2333                 }
2334
2335                 m_copydata(m0, progress, length, mtod(m_new, caddr_t));
2336                 progress += length;
2337                 m_new->m_len = length;
2338                 if (m_new != m_final)
2339                         m_cat(m_final, m_new);
2340                 m_new = NULL;
2341         }
2342         if (m0->m_next == NULL)
2343                 m_defraguseless++;
2344         m_defragpackets++;
2345         m_defragbytes += m_final->m_pkthdr.len;
2346         return (m_final);
2347 nospace:
2348         m_defragfailure++;
2349         if (m_new)
2350                 m_free(m_new);
2351         m_freem(m_final);
2352         return (NULL);
2353 }
2354
2355 /*
2356  * Move data from uio into mbufs.
2357  */
2358 struct mbuf *
2359 m_uiomove(struct uio *uio)
2360 {
2361         struct mbuf *m;                 /* current working mbuf */
2362         struct mbuf *head = NULL;       /* result mbuf chain */
2363         struct mbuf **mp = &head;
2364         int flags = M_PKTHDR;
2365         int nsize;
2366         int error;
2367         int resid;
2368
2369         do {
2370                 if (uio->uio_resid > INT_MAX)
2371                         resid = INT_MAX;
2372                 else
2373                         resid = (int)uio->uio_resid;
2374                 m = m_getl(resid, MB_WAIT, MT_DATA, flags, &nsize);
2375                 if (flags) {
2376                         m->m_pkthdr.len = 0;
2377                         /* Leave room for protocol headers. */
2378                         if (resid < MHLEN)
2379                                 MH_ALIGN(m, resid);
2380                         flags = 0;
2381                 }
2382                 m->m_len = imin(nsize, resid);
2383                 error = uiomove(mtod(m, caddr_t), m->m_len, uio);
2384                 if (error) {
2385                         m_free(m);
2386                         goto failed;
2387                 }
2388                 *mp = m;
2389                 mp = &m->m_next;
2390                 head->m_pkthdr.len += m->m_len;
2391         } while (uio->uio_resid > 0);
2392
2393         return (head);
2394
2395 failed:
2396         m_freem(head);
2397         return (NULL);
2398 }
2399
2400 struct mbuf *
2401 m_last(struct mbuf *m)
2402 {
2403         while (m->m_next)
2404                 m = m->m_next;
2405         return (m);
2406 }
2407
2408 /*
2409  * Return the number of bytes in an mbuf chain.
2410  * If lastm is not NULL, also return the last mbuf.
2411  */
2412 u_int
2413 m_lengthm(struct mbuf *m, struct mbuf **lastm)
2414 {
2415         u_int len = 0;
2416         struct mbuf *prev = m;
2417
2418         while (m) {
2419                 len += m->m_len;
2420                 prev = m;
2421                 m = m->m_next;
2422         }
2423         if (lastm != NULL)
2424                 *lastm = prev;
2425         return (len);
2426 }
2427
2428 /*
2429  * Like m_lengthm(), except also keep track of mbuf usage.
2430  */
2431 u_int
2432 m_countm(struct mbuf *m, struct mbuf **lastm, u_int *pmbcnt)
2433 {
2434         u_int len = 0, mbcnt = 0;
2435         struct mbuf *prev = m;
2436
2437         while (m) {
2438                 len += m->m_len;
2439                 mbcnt += MSIZE;
2440                 if (m->m_flags & M_EXT)
2441                         mbcnt += m->m_ext.ext_size;
2442                 prev = m;
2443                 m = m->m_next;
2444         }
2445         if (lastm != NULL)
2446                 *lastm = prev;
2447         *pmbcnt = mbcnt;
2448         return (len);
2449 }