mbuf.h revision 66569
1/*
2 * Copyright (c) 1982, 1986, 1988, 1993
3 *	The Regents of the University of California.  All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 * 3. All advertising materials mentioning features or use of this software
14 *    must display the following acknowledgement:
15 *	This product includes software developed by the University of
16 *	California, Berkeley and its contributors.
17 * 4. Neither the name of the University nor the names of its contributors
18 *    may be used to endorse or promote products derived from this software
19 *    without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * SUCH DAMAGE.
32 *
33 *	@(#)mbuf.h	8.5 (Berkeley) 2/19/95
34 * $FreeBSD: head/sys/sys/mbuf.h 66569 2000-10-03 02:23:35Z bmilekic $
35 */
36
37#ifndef _SYS_MBUF_H_
38#define	_SYS_MBUF_H_
39
40#include <machine/mutex.h>	/* XXX */
41
42/*
43 * Mbufs are of a single size, MSIZE (machine/param.h), which
44 * includes overhead.  An mbuf may add a single "mbuf cluster" of size
45 * MCLBYTES (also in machine/param.h), which has no additional overhead
46 * and is used instead of the internal data area; this is done when
47 * at least MINCLSIZE of data must be stored.
48 */
49
50#define	MLEN		(MSIZE - sizeof(struct m_hdr))	/* normal data len */
51#define	MHLEN		(MLEN - sizeof(struct pkthdr))	/* data len w/pkthdr */
52
53#define	MINCLSIZE	(MHLEN + 1)	/* smallest amount to put in cluster */
54#define	M_MAXCOMPRESS	(MHLEN / 2)	/* max amount to copy for compression */
55
56/*
57 * Maximum number of allocatable counters for external buffers. This
58 * ensures enough VM address space for the allocation of counters
59 * in the extreme case where all possible external buffers are allocated.
60 *
61 * Note: When new types of external storage are allocated, EXT_COUNTERS
62 * 	 must be tuned accordingly. Practically, this isn't a big deal
63 *	 as each counter is only a word long, so we can fit
64 *	 (PAGE_SIZE / length of word) counters in a single page.
65 *
66 * XXX: Must increase this if using any of if_ti, if_wb, if_sk drivers,
67 *	or any other drivers which may manage their own buffers and
68 *	eventually attach them to mbufs.
69 */
70#define EXT_COUNTERS (nmbclusters + nsfbufs)
71
72/*
73 * Macros for type conversion
74 * mtod(m, t) -	convert mbuf pointer to data pointer of correct type
75 * dtom(x) -	convert data pointer within mbuf to mbuf pointer (XXX)
76 */
77#define	mtod(m, t)	((t)((m)->m_data))
78#define	dtom(x)		((struct mbuf *)((intptr_t)(x) & ~(MSIZE-1)))
79
80/* header at beginning of each mbuf: */
81struct m_hdr {
82	struct	mbuf *mh_next;		/* next buffer in chain */
83	struct	mbuf *mh_nextpkt;	/* next chain in queue/record */
84	caddr_t	mh_data;		/* location of data */
85	int	mh_len;			/* amount of data in this mbuf */
86	short	mh_type;		/* type of data in this mbuf */
87	short	mh_flags;		/* flags; see below */
88};
89
90/* record/packet header in first mbuf of chain; valid if M_PKTHDR set */
91struct pkthdr {
92	struct	ifnet *rcvif;		/* rcv interface */
93	int	len;			/* total packet length */
94	/* variables for ip and tcp reassembly */
95	caddr_t	header;			/* pointer to packet header */
96	/* variables for hardware checksum */
97	int	csum_flags;		/* flags regarding checksum */
98	int	csum_data;		/* data field used by csum routines */
99	struct	mbuf *aux;		/* extra data buffer; ipsec/others */
100};
101
102/* description of external storage mapped into mbuf, valid if M_EXT set */
103struct m_ext {
104	caddr_t	ext_buf;		/* start of buffer */
105	void	(*ext_free)		/* free routine if not the usual */
106		__P((caddr_t, void *));
107	void	*ext_args;		/* optional argument pointer */
108	u_int	ext_size;		/* size of buffer, for ext_free */
109	union	mext_refcnt *ref_cnt;	/* pointer to ref count info */
110};
111
112struct mbuf {
113	struct	m_hdr m_hdr;
114	union {
115		struct {
116			struct	pkthdr MH_pkthdr;	/* M_PKTHDR set */
117			union {
118				struct	m_ext MH_ext;	/* M_EXT set */
119				char	MH_databuf[MHLEN];
120			} MH_dat;
121		} MH;
122		char	M_databuf[MLEN];		/* !M_PKTHDR, !M_EXT */
123	} M_dat;
124};
125#define	m_next		m_hdr.mh_next
126#define	m_len		m_hdr.mh_len
127#define	m_data		m_hdr.mh_data
128#define	m_type		m_hdr.mh_type
129#define	m_flags		m_hdr.mh_flags
130#define	m_nextpkt	m_hdr.mh_nextpkt
131#define	m_act		m_nextpkt
132#define	m_pkthdr	M_dat.MH.MH_pkthdr
133#define	m_ext		M_dat.MH.MH_dat.MH_ext
134#define	m_pktdat	M_dat.MH.MH_dat.MH_databuf
135#define	m_dat		M_dat.M_databuf
136
137/* mbuf flags */
138#define	M_EXT		0x0001	/* has associated external storage */
139#define	M_PKTHDR	0x0002	/* start of record */
140#define	M_EOR		0x0004	/* end of record */
141#define	M_PROTO1	0x0008	/* protocol-specific */
142#define	M_PROTO2	0x0010	/* protocol-specific */
143#define	M_PROTO3	0x0020	/* protocol-specific */
144#define	M_PROTO4	0x0040	/* protocol-specific */
145#define	M_PROTO5	0x0080	/* protocol-specific */
146
147/* mbuf pkthdr flags, also in m_flags */
148#define	M_BCAST		0x0100	/* send/received as link-level broadcast */
149#define	M_MCAST		0x0200	/* send/received as link-level multicast */
150#define	M_FRAG		0x0400	/* packet is a fragment of a larger packet */
151#define	M_FIRSTFRAG	0x0800	/* packet is first fragment */
152#define	M_LASTFRAG	0x1000	/* packet is last fragment */
153
154/* flags copied when copying m_pkthdr */
155#define	M_COPYFLAGS	(M_PKTHDR|M_EOR|M_PROTO1|M_PROTO1|M_PROTO2|M_PROTO3 | \
156			    M_PROTO4|M_PROTO5|M_BCAST|M_MCAST|M_FRAG)
157
158/* flags indicating hw checksum support and sw checksum requirements */
159#define CSUM_IP			0x0001		/* will csum IP */
160#define CSUM_TCP		0x0002		/* will csum TCP */
161#define CSUM_UDP		0x0004		/* will csum UDP */
162#define CSUM_IP_FRAGS		0x0008		/* will csum IP fragments */
163#define CSUM_FRAGMENT		0x0010		/* will do IP fragmentation */
164
165#define CSUM_IP_CHECKED		0x0100		/* did csum IP */
166#define CSUM_IP_VALID		0x0200		/*   ... the csum is valid */
167#define CSUM_DATA_VALID		0x0400		/* csum_data field is valid */
168#define CSUM_PSEUDO_HDR		0x0800		/* csum_data has pseudo hdr */
169
170#define CSUM_DELAY_DATA		(CSUM_TCP | CSUM_UDP)
171#define CSUM_DELAY_IP		(CSUM_IP)	/* XXX add ipv6 here too? */
172
173/* mbuf types */
174#define	MT_FREE		0	/* should be on free list */
175#define	MT_DATA		1	/* dynamic (data) allocation */
176#define	MT_HEADER	2	/* packet header */
177#if 0
178#define	MT_SOCKET	3	/* socket structure */
179#define	MT_PCB		4	/* protocol control block */
180#define	MT_RTABLE	5	/* routing tables */
181#define	MT_HTABLE	6	/* IMP host tables */
182#define	MT_ATABLE	7	/* address resolution tables */
183#endif
184#define	MT_SONAME	8	/* socket name */
185#if 0
186#define	MT_SOOPTS	10	/* socket options */
187#endif
188#define	MT_FTABLE	11	/* fragment reassembly header */
189#if 0
190#define	MT_RIGHTS	12	/* access rights */
191#define	MT_IFADDR	13	/* interface address */
192#endif
193#define	MT_CONTROL	14	/* extra-data protocol message */
194#define	MT_OOBDATA	15	/* expedited data  */
195
196#define	MT_NTYPES	16	/* number of mbuf types for mbtypes[] */
197
198/*
199 * mbuf statistics
200 */
201struct mbstat {
202	u_long	m_mbufs;	/* # mbufs obtained from page pool */
203	u_long	m_clusters;	/* # clusters obtained from page pool */
204	u_long	m_clfree;	/* # clusters on freelist (cache) */
205	u_long	m_refcnt;	/* # ref counters obtained from page pool */
206	u_long	m_refree;	/* # ref counters on freelist (cache) */
207	u_long	m_spare;	/* spare field */
208	u_long	m_drops;	/* times failed to find space */
209	u_long	m_wait;		/* times waited for space */
210	u_long	m_drain;	/* times drained protocols for space */
211	u_long	m_mcfail;	/* times m_copym failed */
212	u_long	m_mpfail;	/* times m_pullup failed */
213	u_long	m_msize;	/* length of an mbuf */
214	u_long	m_mclbytes;	/* length of an mbuf cluster */
215	u_long	m_minclsize;	/* min length of data to allocate a cluster */
216	u_long	m_mlen;		/* length of data in an mbuf */
217	u_long	m_mhlen;	/* length of data in a header mbuf */
218};
219
220/* flags to m_get/MGET */
221#define	M_DONTWAIT	1
222#define	M_WAIT		0
223
224/*
225 * Normal mbuf clusters are normally treated as character arrays
226 * after allocation, but use the first word of the buffer as a free list
227 * pointer while on the free list.
228 */
229union mcluster {
230	union	mcluster *mcl_next;
231	char	mcl_buf[MCLBYTES];
232};
233
234/*
235 * The m_ext object reference counter structure.
236 */
237union mext_refcnt {
238	union	mext_refcnt *next_ref;
239	u_long	refcnt;
240};
241
242/*
243 * free list header definitions: mbffree_lst, mclfree_lst, mcntfree_lst
244 */
245struct mbffree_lst {
246	struct mbuf *m_head;
247	struct mtx m_mtx;
248};
249
250struct mclfree_lst {
251        union mcluster *m_head;
252        struct mtx m_mtx;
253};
254
255struct mcntfree_lst {
256        union mext_refcnt *m_head;
257        struct mtx m_mtx;
258};
259
260/*
261 * Wake up the next instance (if any) of a sleeping allocation - which is
262 * waiting for a {cluster, mbuf} to be freed.
263 *
264 * Must be called with the appropriate mutex held.
265 */
266#define	MBWAKEUP(m_wid) do {						\
267	if ((m_wid)) {							\
268		m_wid--;						\
269		wakeup_one(&(m_wid)); 					\
270	}								\
271} while (0)
272
273/*
274 * mbuf external reference count management macros:
275 *
276 * MEXT_IS_REF(m): true if (m) is not the only mbuf referencing
277 *     the external buffer ext_buf
278 * MEXT_REM_REF(m): remove reference to m_ext object
279 * MEXT_ADD_REF(m): add reference to m_ext object already
280 *     referred to by (m)
281 * MEXT_INIT_REF(m): allocate and initialize an external
282 *     object reference counter for (m)
283 */
284#define MEXT_IS_REF(m) ((m)->m_ext.ref_cnt->refcnt > 1)
285
286#define MEXT_REM_REF(m) atomic_subtract_long(&((m)->m_ext.ref_cnt->refcnt), 1)
287
288#define MEXT_ADD_REF(m) atomic_add_long(&((m)->m_ext.ref_cnt->refcnt), 1)
289
290#define _MEXT_ALLOC_CNT(m_cnt, how) do {				\
291	union mext_refcnt *__mcnt;					\
292									\
293	mtx_enter(&mcntfree.m_mtx, MTX_DEF);				\
294	if (mcntfree.m_head == NULL)					\
295		m_alloc_ref(1, (how));					\
296	__mcnt = mcntfree.m_head;					\
297	if (__mcnt != NULL) {						\
298		mcntfree.m_head = __mcnt->next_ref;			\
299		mbstat.m_refree--;					\
300		__mcnt->refcnt = 0;					\
301	}								\
302	mtx_exit(&mcntfree.m_mtx, MTX_DEF);				\
303	(m_cnt) = __mcnt;						\
304} while (0)
305
306#define _MEXT_DEALLOC_CNT(m_cnt) do {					\
307	union mext_refcnt *__mcnt = (m_cnt);				\
308									\
309	mtx_enter(&mcntfree.m_mtx, MTX_DEF);				\
310	__mcnt->next_ref = mcntfree.m_head;				\
311	mcntfree.m_head = __mcnt;					\
312	mbstat.m_refree++;						\
313	mtx_exit(&mcntfree.m_mtx, MTX_DEF);				\
314} while (0)
315
316#define MEXT_INIT_REF(m, how) do {					\
317	struct mbuf *__mmm = (m);					\
318									\
319	_MEXT_ALLOC_CNT(__mmm->m_ext.ref_cnt, (how));			\
320	if (__mmm != NULL)						\
321		MEXT_ADD_REF(__mmm);					\
322} while (0)
323
324/*
325 * mbuf allocation/deallocation macros:
326 *
327 *	MGET(struct mbuf *m, int how, int type)
328 * allocates an mbuf and initializes it to contain internal data.
329 *
330 *	MGETHDR(struct mbuf *m, int how, int type)
331 * allocates an mbuf and initializes it to contain a packet header
332 * and internal data.
333 */
334/*
335 * Lower-level macros for MGET(HDR)... Not to be used outside the
336 * subsystem ("non-exportable" macro names are prepended with "_").
337 */
338#define _MGET_SETUP(m_set, m_set_type) do {				\
339	(m_set)->m_type = (m_set_type);					\
340	(m_set)->m_next = NULL;						\
341	(m_set)->m_nextpkt = NULL;					\
342	(m_set)->m_data = (m_set)->m_dat;				\
343	(m_set)->m_flags = 0;						\
344} while (0)
345
346#define	_MGET(m_mget, m_get_how) do {					\
347	if (mmbfree.m_head == NULL)					\
348		m_mballoc(1, (m_get_how));				\
349	(m_mget) = mmbfree.m_head;					\
350	if ((m_mget) != NULL) {						\
351		mmbfree.m_head = (m_mget)->m_next;			\
352		mbtypes[MT_FREE]--;					\
353	} else {							\
354		if ((m_get_how) == M_WAIT)				\
355			(m_mget) = m_mballoc_wait();			\
356	}								\
357} while (0)
358
359#define MGET(m, how, type) do {						\
360	struct mbuf *_mm;						\
361	int _mhow = (how);						\
362	int _mtype = (type);						\
363									\
364	mtx_enter(&mmbfree.m_mtx, MTX_DEF);				\
365	_MGET(_mm, _mhow);						\
366	if (_mm != NULL) {						\
367		 mbtypes[_mtype]++;					\
368		mtx_exit(&mmbfree.m_mtx, MTX_DEF);			\
369		_MGET_SETUP(_mm, _mtype);				\
370	} else								\
371		mtx_exit(&mmbfree.m_mtx, MTX_DEF);			\
372	(m) = _mm;							\
373} while (0)
374
375#define _MGETHDR_SETUP(m_set, m_set_type) do {				\
376	(m_set)->m_type = (m_set_type);					\
377	(m_set)->m_next = NULL;						\
378	(m_set)->m_nextpkt = NULL;					\
379	(m_set)->m_data = (m_set)->m_pktdat;				\
380	(m_set)->m_flags = M_PKTHDR;					\
381	(m_set)->m_pkthdr.rcvif = NULL;					\
382	(m_set)->m_pkthdr.csum_flags = 0;				\
383	(m_set)->m_pkthdr.aux = NULL;					\
384} while (0)
385
386#define MGETHDR(m, how, type) do {					\
387	struct mbuf *_mm;						\
388	int _mhow = (how);						\
389	int _mtype = (type);						\
390									\
391	mtx_enter(&mmbfree.m_mtx, MTX_DEF);				\
392	_MGET(_mm, _mhow);						\
393	if (_mm != NULL) {						\
394		 mbtypes[_mtype]++;					\
395		mtx_exit(&mmbfree.m_mtx, MTX_DEF);			\
396		_MGETHDR_SETUP(_mm, _mtype);				\
397	} else								\
398		mtx_exit(&mmbfree.m_mtx, MTX_DEF);			\
399	(m) = _mm;							\
400} while (0)
401
402/*
403 * mbuf external storage macros:
404 *
405 *   MCLGET allocates and refers an mcluster to an mbuf
406 *   MEXTADD sets up pre-allocated external storage and refers to mbuf
407 *   MEXTFREE removes reference to external object and frees it if
408 *       necessary
409 */
410#define	_MCLALLOC(p, how) do {						\
411	caddr_t _mp;							\
412	int _mhow = (how);						\
413									\
414	if (mclfree.m_head == NULL)					\
415		m_clalloc(1, _mhow);					\
416	_mp = (caddr_t)mclfree.m_head;					\
417	if (_mp != NULL) {						\
418		mbstat.m_clfree--;					\
419		mclfree.m_head = ((union mcluster *)_mp)->mcl_next;	\
420	} else {							\
421		if (_mhow == M_WAIT)					\
422			_mp = m_clalloc_wait();				\
423	}								\
424	(p) = _mp;							\
425} while (0)
426
427#define	MCLGET(m, how) do {						\
428	struct mbuf *_mm = (m);						\
429									\
430	mtx_enter(&mclfree.m_mtx, MTX_DEF);				\
431	_MCLALLOC(_mm->m_ext.ext_buf, (how));				\
432	mtx_exit(&mclfree.m_mtx, MTX_DEF);				\
433	if (_mm->m_ext.ext_buf != NULL) {				\
434		MEXT_INIT_REF(_mm, (how));				\
435		if (_mm->m_ext.ref_cnt == NULL) {			\
436			_MCLFREE(_mm->m_ext.ext_buf);			\
437			_mm->m_ext.ext_buf = NULL;			\
438		} else {						\
439			_mm->m_data = _mm->m_ext.ext_buf;		\
440			_mm->m_flags |= M_EXT;				\
441			_mm->m_ext.ext_free = NULL;			\
442			_mm->m_ext.ext_args = NULL;			\
443			_mm->m_ext.ext_size = MCLBYTES;			\
444		}							\
445	}								\
446} while (0)
447
448#define MEXTADD(m, buf, size, free, args) do {				\
449	struct mbuf *_mm = (m);						\
450									\
451	MEXT_INIT_REF(_mm, M_WAIT);					\
452	if (_mm->m_ext.ref_cnt != NULL) {				\
453		_mm->m_flags |= M_EXT;					\
454		_mm->m_ext.ext_buf = (caddr_t)(buf);			\
455		_mm->m_data = _mm->m_ext.ext_buf;			\
456		_mm->m_ext.ext_size = (size);				\
457		_mm->m_ext.ext_free = (free);				\
458		_mm->m_ext.ext_args = (args);				\
459	}								\
460} while (0)
461
462#define	_MCLFREE(p) do {						\
463	union mcluster *_mp = (union mcluster *)(p);			\
464									\
465	mtx_enter(&mclfree.m_mtx, MTX_DEF);				\
466	_mp->mcl_next = mclfree.m_head;					\
467	mclfree.m_head = _mp;						\
468	mbstat.m_clfree++;						\
469	MBWAKEUP(m_clalloc_wid);					\
470	mtx_exit(&mclfree.m_mtx, MTX_DEF); 				\
471} while (0)
472
473#define	MEXTFREE(m) do {						\
474	struct mbuf *_mmm = (m);					\
475									\
476	if (MEXT_IS_REF(_mmm))						\
477		MEXT_REM_REF(_mmm);					\
478	else if (_mmm->m_ext.ext_free != NULL) {			\
479		(*(_mmm->m_ext.ext_free))(_mmm->m_ext.ext_buf,		\
480		    _mmm->m_ext.ext_args);				\
481		_MEXT_DEALLOC_CNT(_mmm->m_ext.ref_cnt);			\
482	} else {							\
483		_MCLFREE(_mmm->m_ext.ext_buf);				\
484		_MEXT_DEALLOC_CNT(_mmm->m_ext.ref_cnt);			\
485	}								\
486	_mmm->m_flags &= ~M_EXT;					\
487} while (0)
488
489/*
490 * MFREE(struct mbuf *m, struct mbuf *n)
491 * Free a single mbuf and associated external storage.
492 * Place the successor, if any, in n.
493 */
494#define	MFREE(m, n) do {						\
495	struct mbuf *_mm = (m);						\
496									\
497	KASSERT(_mm->m_type != MT_FREE, ("freeing free mbuf"));		\
498	if (_mm->m_flags & M_EXT)					\
499		MEXTFREE(_mm);						\
500	mtx_enter(&mmbfree.m_mtx, MTX_DEF);				\
501	mbtypes[_mm->m_type]--;						\
502	_mm->m_type = MT_FREE;						\
503	mbtypes[MT_FREE]++;						\
504	(n) = _mm->m_next;						\
505	_mm->m_next = mmbfree.m_head;					\
506	mmbfree.m_head = _mm;						\
507	MBWAKEUP(m_mballoc_wid);					\
508	mtx_exit(&mmbfree.m_mtx, MTX_DEF); 				\
509} while (0)
510
511/*
512 * Copy mbuf pkthdr from "from" to "to".
513 * from must have M_PKTHDR set, and to must be empty.
514 * aux pointer will be moved to `to'.
515 */
516#define	M_COPY_PKTHDR(to, from) do {					\
517	struct mbuf *_mfrom = (from);					\
518	struct mbuf *_mto = (to);					\
519									\
520	_mto->m_data = _mto->m_pktdat;					\
521	_mto->m_flags = _mfrom->m_flags & M_COPYFLAGS;			\
522	_mto->m_pkthdr = _mfrom->m_pkthdr;				\
523	_mfrom->m_pkthdr.aux = (struct mbuf *)NULL;			\
524} while (0)
525
526/*
527 * Set the m_data pointer of a newly-allocated mbuf (m_get/MGET) to place
528 * an object of the specified size at the end of the mbuf, longword aligned.
529 */
530#define	M_ALIGN(m, len) do {						\
531	(m)->m_data += (MLEN - (len)) & ~(sizeof(long) - 1);		\
532} while (0)
533
534/*
535 * As above, for mbufs allocated with m_gethdr/MGETHDR
536 * or initialized by M_COPY_PKTHDR.
537 */
538#define	MH_ALIGN(m, len) do {						\
539	(m)->m_data += (MHLEN - (len)) & ~(sizeof(long) - 1);		\
540} while (0)
541
542/*
543 * Compute the amount of space available
544 * before the current start of data in an mbuf.
545 */
546#define	M_LEADINGSPACE(m)						\
547	((m)->m_flags & M_EXT ?						\
548	    /* (m)->m_data - (m)->m_ext.ext_buf */ 0 :			\
549	    (m)->m_flags & M_PKTHDR ? (m)->m_data - (m)->m_pktdat :	\
550	    (m)->m_data - (m)->m_dat)
551
552/*
553 * Compute the amount of space available
554 * after the end of data in an mbuf.
555 */
556#define	M_TRAILINGSPACE(m)						\
557	((m)->m_flags & M_EXT ? (m)->m_ext.ext_buf +			\
558	    (m)->m_ext.ext_size - ((m)->m_data + (m)->m_len) :		\
559	    &(m)->m_dat[MLEN] - ((m)->m_data + (m)->m_len))
560
561/*
562 * Arrange to prepend space of size plen to mbuf m.
563 * If a new mbuf must be allocated, how specifies whether to wait.
564 * If how is M_DONTWAIT and allocation fails, the original mbuf chain
565 * is freed and m is set to NULL.
566 */
567#define	M_PREPEND(m, plen, how) do {					\
568	struct mbuf **_mmp = &(m);					\
569	struct mbuf *_mm = *_mmp;					\
570	int _mplen = (plen);						\
571	int __mhow = (how);						\
572									\
573	if (M_LEADINGSPACE(_mm) >= _mplen) {				\
574		_mm->m_data -= _mplen;					\
575		_mm->m_len += _mplen;					\
576	} else								\
577		_mm = m_prepend(_mm, _mplen, __mhow);			\
578	if (_mm != NULL && _mm->m_flags & M_PKTHDR)			\
579		_mm->m_pkthdr.len += _mplen;				\
580	*_mmp = _mm;							\
581} while (0)
582
583/*
584 * change mbuf to new type
585 */
586#define	MCHTYPE(m, t) do {						\
587	struct mbuf *_mm = (m);						\
588	int _mt = (t);							\
589									\
590	atomic_subtract_long(&mbtypes[_mm->m_type], 1);			\
591	atomic_add_long(&mbtypes[_mt], 1);				\
592	_mm->m_type = (_mt);						\
593} while (0)
594
595/* length to m_copy to copy all */
596#define	M_COPYALL	1000000000
597
598/* compatibility with 4.3 */
599#define	m_copy(m, o, l)	m_copym((m), (o), (l), M_DONTWAIT)
600
601/*
602 * pkthdr.aux type tags.
603 */
604struct mauxtag {
605	int	af;
606	int	type;
607};
608
609#ifdef _KERNEL
610extern	u_long		 m_clalloc_wid;	/* mbuf cluster wait count */
611extern	u_long		 m_mballoc_wid;	/* mbuf wait count */
612extern	int		 max_linkhdr;	/* largest link-level header */
613extern	int		 max_protohdr;	/* largest protocol header */
614extern	int		 max_hdr;	/* largest link+protocol header */
615extern	int		 max_datalen;	/* MHLEN - max_hdr */
616extern	struct mbstat	 mbstat;
617extern	u_long		 mbtypes[MT_NTYPES]; /* per-type mbuf allocations */
618extern	int		 mbuf_wait;	/* mbuf sleep time */
619extern	struct mbuf	*mbutl;		/* virtual address of mclusters */
620extern	struct mclfree_lst	mclfree;
621extern	struct mbffree_lst	mmbfree;
622extern	struct mcntfree_lst	mcntfree;
623extern	int		 nmbclusters;
624extern	int		 nmbufs;
625extern	int		 nsfbufs;
626
627void	m_adj __P((struct mbuf *, int));
628int	m_alloc_ref __P((u_int, int));
629void	m_cat __P((struct mbuf *,struct mbuf *));
630int	m_clalloc __P((int, int));
631caddr_t	m_clalloc_wait __P((void));
632void	m_copyback __P((struct mbuf *, int, int, caddr_t));
633void	m_copydata __P((struct mbuf *,int,int,caddr_t));
634struct	mbuf *m_copym __P((struct mbuf *, int, int, int));
635struct	mbuf *m_copypacket __P((struct mbuf *, int));
636struct	mbuf *m_devget __P((char *, int, int, struct ifnet *,
637    void (*copy)(char *, caddr_t, u_int)));
638struct	mbuf *m_dup __P((struct mbuf *, int));
639struct	mbuf *m_free __P((struct mbuf *));
640void	m_freem __P((struct mbuf *));
641struct	mbuf *m_get __P((int, int));
642struct	mbuf *m_getclr __P((int, int));
643struct	mbuf *m_gethdr __P((int, int));
644int	m_mballoc __P((int, int));
645struct	mbuf *m_mballoc_wait __P((void));
646struct	mbuf *m_prepend __P((struct mbuf *,int,int));
647struct	mbuf *m_pulldown __P((struct mbuf *, int, int, int *));
648void	m_print __P((const struct mbuf *m));
649struct	mbuf *m_pullup __P((struct mbuf *, int));
650struct	mbuf *m_split __P((struct mbuf *,int,int));
651struct	mbuf *m_aux_add __P((struct mbuf *, int, int));
652struct	mbuf *m_aux_find __P((struct mbuf *, int, int));
653void	m_aux_delete __P((struct mbuf *, struct mbuf *));
654#endif /* _KERNEL */
655
656#endif /* !_SYS_MBUF_H_ */
657