xref: /titanic_50/usr/src/uts/common/smbsrv/mbuf.h (revision 2c2961f8403049d948b9f3e6c35d6488b6b7e1aa)
1da6c28aaSamw /*
2da6c28aaSamw  * CDDL HEADER START
3da6c28aaSamw  *
4da6c28aaSamw  * The contents of this file are subject to the terms of the
5da6c28aaSamw  * Common Development and Distribution License (the "License").
6da6c28aaSamw  * You may not use this file except in compliance with the License.
7da6c28aaSamw  *
8da6c28aaSamw  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9da6c28aaSamw  * or http://www.opensolaris.org/os/licensing.
10da6c28aaSamw  * See the License for the specific language governing permissions
11da6c28aaSamw  * and limitations under the License.
12da6c28aaSamw  *
13da6c28aaSamw  * When distributing Covered Code, include this CDDL HEADER in each
14da6c28aaSamw  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15da6c28aaSamw  * If applicable, add the following below this CDDL HEADER, with the
16da6c28aaSamw  * fields enclosed by brackets "[]" replaced with your own identifying
17da6c28aaSamw  * information: Portions Copyright [yyyy] [name of copyright owner]
18da6c28aaSamw  *
19da6c28aaSamw  * CDDL HEADER END
20da6c28aaSamw  */
21da6c28aaSamw /*
22*2c2961f8Sjose borrego  * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
23da6c28aaSamw  * Use is subject to license terms.
24da6c28aaSamw  */
25da6c28aaSamw /*
26da6c28aaSamw  * Copyright (c) 1982, 1986, 1988 Regents of the University of California.
27da6c28aaSamw  * All rights reserved.
28da6c28aaSamw  *
29da6c28aaSamw  * Redistribution and use in source and binary forms, with or without
30da6c28aaSamw  * modification, are permitted provided that the following conditions
31da6c28aaSamw  * are met:
32da6c28aaSamw  * 1. Redistributions of source code must retain the above copyright
33da6c28aaSamw  *    notice, this list of conditions and the following disclaimer.
34da6c28aaSamw  * 2. Redistributions in binary form must reproduce the above copyright
35da6c28aaSamw  *    notice, this list of conditions and the following disclaimer in the
36da6c28aaSamw  *    documentation and/or other materials provided with the distribution.
37da6c28aaSamw  * 3. All advertising materials mentioning features or use of this software
38da6c28aaSamw  *    must display the following acknowledgement:
39da6c28aaSamw  *	This product includes software developed by the University of
40da6c28aaSamw  *	California, Berkeley and its contributors.
41da6c28aaSamw  * 4. Neither the name of the University nor the names of its contributors
42da6c28aaSamw  *    may be used to endorse or promote products derived from this software
43da6c28aaSamw  *    without specific prior written permission.
44da6c28aaSamw  *
45da6c28aaSamw  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
46da6c28aaSamw  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
47da6c28aaSamw  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
48da6c28aaSamw  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
49da6c28aaSamw  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
50da6c28aaSamw  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
51da6c28aaSamw  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
52da6c28aaSamw  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
53da6c28aaSamw  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
54da6c28aaSamw  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
55da6c28aaSamw  * SUCH DAMAGE.
56da6c28aaSamw  *
57da6c28aaSamw  */
58da6c28aaSamw 
59da6c28aaSamw #ifndef _SMBSRV_MBUF_H
60da6c28aaSamw #define	_SMBSRV_MBUF_H
61da6c28aaSamw 
62da6c28aaSamw /*
63da6c28aaSamw  * PBSHORTCUT This file should be removed from the PB port but is required
64da6c28aaSamw  * for now to get it to compile. This file has also been modified.
65da6c28aaSamw  */
66da6c28aaSamw 
67da6c28aaSamw #include <sys/types.h>
68da6c28aaSamw #include <sys/param.h>
69*2c2961f8Sjose borrego #include <sys/list.h>
70da6c28aaSamw #include <smbsrv/smb_i18n.h>
71da6c28aaSamw #include <smbsrv/alloc.h>
72da6c28aaSamw 
73da6c28aaSamw #ifdef __cplusplus
74da6c28aaSamw extern "C" {
75da6c28aaSamw #endif
76da6c28aaSamw 
77da6c28aaSamw #define	MSIZE		256
78da6c28aaSamw #define	MCLBYTES	2048
79da6c28aaSamw #define	MCLSHIFT	11
80da6c28aaSamw #define	MCLOFSET	(MCLBYTES - 1)
81da6c28aaSamw 
82da6c28aaSamw #define	NBPG 4096
83da6c28aaSamw #define	CLBYTES		NBPG
84da6c28aaSamw #define	PB_PAGESIZE 4096
85da6c28aaSamw 
86da6c28aaSamw /*
87da6c28aaSamw  * Mbufs are of a single size, MSIZE (machine/machparam.h), which
88da6c28aaSamw  * includes overhead.  An mbuf may add a single "mbuf cluster" of size
89da6c28aaSamw  * MCLBYTES (also in machine/machparam.h), which has no additional overhead
90da6c28aaSamw  * and is used instead of the internal data area; this is done when
91da6c28aaSamw  * at least MINCLSIZE of data must be stored.
92da6c28aaSamw  */
93da6c28aaSamw 
94da6c28aaSamw #define	MLEN		(MSIZE - sizeof (struct m_hdr))	/* normal data len */
95da6c28aaSamw #define	MHLEN		(MLEN - sizeof (struct pkthdr))	/* data len w/pkthdr */
96da6c28aaSamw 
97da6c28aaSamw #define	MINCLSIZE	(MHLEN + MLEN)	/* smallest amount to put in cluster */
98da6c28aaSamw 
99da6c28aaSamw /*
100da6c28aaSamw  * Macros for type conversion
101da6c28aaSamw  * mtod(m,t) -	convert mbuf pointer to data pointer of correct type
102da6c28aaSamw  */
103da6c28aaSamw #define	mtod(m, t)	((t)((m)->m_data))
104da6c28aaSamw 
105da6c28aaSamw 
106da6c28aaSamw /* header at beginning of each mbuf: */
107da6c28aaSamw struct m_hdr {
108da6c28aaSamw 	struct	mbuf *mh_next;		/* next buffer in chain */
109da6c28aaSamw 	struct	mbuf *mh_nextpkt;	/* next chain in queue/record */
110da6c28aaSamw 	int	mh_len;			/* amount of data in this mbuf */
111da6c28aaSamw 	caddr_t	mh_data;		/* location of data */
112da6c28aaSamw 	short	mh_type;		/* type of data in this mbuf */
113da6c28aaSamw 	short	mh_flags;		/* flags; see below */
114da6c28aaSamw };
115da6c28aaSamw 
116da6c28aaSamw /* record/packet header in first mbuf of chain; valid if M_PKTHDR set */
117da6c28aaSamw struct	pkthdr {
118da6c28aaSamw 	int	len;		/* total packet length */
119da6c28aaSamw };
120da6c28aaSamw 
121da6c28aaSamw 
122da6c28aaSamw /* XXX probably do not need m_ext */
123da6c28aaSamw 
124da6c28aaSamw /* description of external storage mapped into mbuf, valid if M_EXT set */
125da6c28aaSamw struct m_ext {
126da6c28aaSamw 	caddr_t	ext_buf;		/* start of buffer */
127da6c28aaSamw 	int	(*ext_ref)();		/* refcount adjust function */
128da6c28aaSamw 	uint_t	ext_size;		/* size of buffer, for ext_free */
129da6c28aaSamw };
130da6c28aaSamw 
13121b7895dSjb150015 typedef struct mbuf {
132da6c28aaSamw 	struct	m_hdr m_hdr;
133da6c28aaSamw 	union {
134da6c28aaSamw 		struct {
135da6c28aaSamw 			struct	pkthdr MH_pkthdr;	/* M_PKTHDR set */
136da6c28aaSamw 			union {
137da6c28aaSamw 				struct	m_ext MH_ext;	/* M_EXT set */
138da6c28aaSamw 				char	MH_databuf[MHLEN];
139da6c28aaSamw 			} MH_dat;
140da6c28aaSamw 		} MH;
141da6c28aaSamw 		char	M_databuf[MLEN];		/* !M_PKTHDR, !M_EXT */
142da6c28aaSamw 	} M_dat;
14321b7895dSjb150015 } mbuf_t;
14421b7895dSjb150015 
145da6c28aaSamw #define	m_next		m_hdr.mh_next
146da6c28aaSamw #define	m_len		m_hdr.mh_len
147da6c28aaSamw #define	m_data		m_hdr.mh_data
148da6c28aaSamw #define	m_type		m_hdr.mh_type
149da6c28aaSamw #define	m_flags		m_hdr.mh_flags
150da6c28aaSamw #define	m_nextpkt	m_hdr.mh_nextpkt
151da6c28aaSamw #define	m_act		m_nextpkt
152da6c28aaSamw #define	m_pkthdr	M_dat.MH.MH_pkthdr
153da6c28aaSamw #define	m_ext		M_dat.MH.MH_dat.MH_ext
154da6c28aaSamw #define	m_pktdat	M_dat.MH.MH_dat.MH_databuf
155da6c28aaSamw #define	m_dat		M_dat.M_databuf
156da6c28aaSamw 
157da6c28aaSamw /* mbuf flags */
158da6c28aaSamw #define	M_EXT		0x0001	/* has associated external storage */
159da6c28aaSamw #define	M_PKTHDR	0x0002	/* start of record */
160da6c28aaSamw #define	M_EOR		0x0004	/* end of record */
161da6c28aaSamw 
162da6c28aaSamw /* mbuf pkthdr flags, also in m_flags */
163da6c28aaSamw #define	M_BCAST		0x0100	/* send/received as link-level broadcast */
164da6c28aaSamw #define	M_MCAST		0x0200	/* send/received as link-level multicast */
165da6c28aaSamw 
166da6c28aaSamw /* flags copied when copying m_pkthdr */
167da6c28aaSamw #define	M_COPYFLAGS	(M_PKTHDR|M_EOR|M_BCAST|M_MCAST)
168da6c28aaSamw 
169da6c28aaSamw /* XXX probably only need MT_DATA */
170da6c28aaSamw 
171da6c28aaSamw /* mbuf types */
172da6c28aaSamw #define	MT_FREE		0	/* should be on free list */
173da6c28aaSamw #define	MT_DATA		1	/* dynamic (data) allocation */
174da6c28aaSamw #define	MT_HEADER	2	/* packet header */
175da6c28aaSamw #define	MT_SOCKET	3	/* socket structure */
176da6c28aaSamw #define	MT_PCB		4	/* protocol control block */
177da6c28aaSamw #define	MT_RTABLE	5	/* routing tables */
178da6c28aaSamw #define	MT_HTABLE	6	/* IMP host tables */
179da6c28aaSamw #define	MT_ATABLE	7	/* address resolution tables */
180da6c28aaSamw #define	MT_SONAME	8	/* socket name */
181da6c28aaSamw #define	MT_SOOPTS	10	/* socket options */
182da6c28aaSamw #define	MT_FTABLE	11	/* fragment reassembly header */
183da6c28aaSamw #define	MT_RIGHTS	12	/* access rights */
184da6c28aaSamw #define	MT_IFADDR	13	/* interface address */
185da6c28aaSamw #define	MT_CONTROL	14	/* extra-data protocol message */
186da6c28aaSamw #define	MT_OOBDATA	15	/* expedited data  */
187da6c28aaSamw 
188da6c28aaSamw /*
189da6c28aaSamw  * flags to malloc: PBSHORTCUT
190da6c28aaSamw  */
191da6c28aaSamw #define	M_WAITOK	0x0000
192da6c28aaSamw #define	M_NOWAIT	0x0001
193da6c28aaSamw 
194da6c28aaSamw /* flags to m_get/MGET */
195da6c28aaSamw #define	M_DONTWAIT	M_NOWAIT
196da6c28aaSamw #define	M_WAIT		M_WAITOK
197da6c28aaSamw 
198da6c28aaSamw 
199da6c28aaSamw /*
200da6c28aaSamw  * mbuf allocation/deallocation macros:
201da6c28aaSamw  *
202da6c28aaSamw  *	MGET(struct mbuf *m, int how, int type)
203da6c28aaSamw  * allocates an mbuf and initializes it to contain internal data.
204da6c28aaSamw  *
205da6c28aaSamw  *	MGETHDR(struct mbuf *m, int how, int type)
206da6c28aaSamw  * allocates an mbuf and initializes it to contain a packet header
207da6c28aaSamw  * and internal data.
208da6c28aaSamw  */
209da6c28aaSamw 
210da6c28aaSamw #define	MGET(m, how, type) { \
211da6c28aaSamw 	m = MEM_ZALLOC("mbuf", sizeof (struct mbuf)); \
212da6c28aaSamw 	(m)->m_next = (struct mbuf *)NULL; \
213da6c28aaSamw 	(m)->m_nextpkt = (struct mbuf *)NULL; \
214da6c28aaSamw 	(m)->m_data = (m)->m_dat; \
215da6c28aaSamw 	(m)->m_flags = 0; \
216da6c28aaSamw 	(m)->m_type = (short)(type); \
217da6c28aaSamw }
218da6c28aaSamw 
219da6c28aaSamw #define	MGETHDR(m, how, type) { \
220da6c28aaSamw 	m = MEM_ZALLOC("mbuf", sizeof (struct mbuf)); \
221da6c28aaSamw 	(m)->m_type = (MT_HEADER); \
222da6c28aaSamw 	(m)->m_next = (struct mbuf *)NULL; \
223da6c28aaSamw 	(m)->m_nextpkt = (struct mbuf *)NULL; \
224da6c28aaSamw 	(m)->m_data = (m)->m_pktdat; \
225da6c28aaSamw 	(m)->m_flags = M_PKTHDR; \
226da6c28aaSamw }
227da6c28aaSamw 
228da6c28aaSamw extern	int mclref();
229da6c28aaSamw extern	int mclrefnoop();
230da6c28aaSamw #define	MCLGET(m, how) \
231da6c28aaSamw 	{ \
232da6c28aaSamw 		(m)->m_ext.ext_buf = MEM_ZALLOC("mbuf", MCLBYTES);	\
233da6c28aaSamw 		(m)->m_data = (m)->m_ext.ext_buf;		\
234da6c28aaSamw 		(m)->m_flags |= M_EXT;				\
235da6c28aaSamw 		(m)->m_ext.ext_size = MCLBYTES;			\
236da6c28aaSamw 		(m)->m_ext.ext_ref = mclref;			\
237da6c28aaSamw 	}
238da6c28aaSamw 
239da6c28aaSamw /*
240da6c28aaSamw  * MFREE(struct mbuf *m, struct mbuf *nn)
241da6c28aaSamw  * Free a single mbuf and associated external storage.
242da6c28aaSamw  * Place the successor, if any, in nn.
243da6c28aaSamw  */
244da6c28aaSamw #define	MFREE(m, nn) \
245da6c28aaSamw 	{ \
246da6c28aaSamw 		if ((m)->m_flags & M_EXT) {		    \
247da6c28aaSamw 			(*((m)->m_ext.ext_ref))((m)->m_ext.ext_buf,	\
248da6c28aaSamw 			    (m)->m_ext.ext_size, -1);			\
249da6c28aaSamw 			(m)->m_ext.ext_buf = 0;				\
250da6c28aaSamw 		}							\
251da6c28aaSamw 		(nn) = (m)->m_next;					\
252da6c28aaSamw 		(m)->m_next = 0;					\
253da6c28aaSamw 		MEM_FREE("mbuf", m);					\
254da6c28aaSamw 	}
255da6c28aaSamw 
256da6c28aaSamw 
257da6c28aaSamw 
258da6c28aaSamw /*
259da6c28aaSamw  * As above, for mbufs allocated with m_gethdr/MGETHDR
260da6c28aaSamw  * or initialized by M_COPY_PKTHDR.
261da6c28aaSamw  */
262da6c28aaSamw #define	MH_ALIGN(m, len) \
263da6c28aaSamw 	{ (m)->m_data += (MHLEN - (len)) &~ (sizeof (int32_t) - 1); }
264da6c28aaSamw 
265*2c2961f8Sjose borrego #define	SMB_MBC_MAGIC		0x4D42435F
266*2c2961f8Sjose borrego #define	SMB_MBC_VALID(p)	ASSERT((p)->mbc_magic == SMB_MBC_MAGIC)
267*2c2961f8Sjose borrego 
26821b7895dSjb150015 typedef struct mbuf_chain {
269*2c2961f8Sjose borrego 	uint32_t		mbc_magic;
270*2c2961f8Sjose borrego 	list_node_t		mbc_lnd;
27121b7895dSjb150015 	volatile uint32_t	flags;		/* Various flags */
27221b7895dSjb150015 	struct mbuf_chain	*shadow_of;	/* I'm shadowing someone */
27321b7895dSjb150015 	mbuf_t			*chain;		/* Start of chain */
27421b7895dSjb150015 	int32_t			max_bytes;	/* max # of bytes for chain */
27521b7895dSjb150015 	int32_t			chain_offset;	/* Current offset into chain */
27621b7895dSjb150015 } mbuf_chain_t;
27721b7895dSjb150015 
27821b7895dSjb150015 mbuf_t *m_free(mbuf_t *);
27921b7895dSjb150015 void m_freem(mbuf_t *);
28021b7895dSjb150015 int mbc_moveout(mbuf_chain_t *, caddr_t, int, int *);
281*2c2961f8Sjose borrego int smb_mbc_init(void);
282*2c2961f8Sjose borrego void smb_mbc_fini(void);
283*2c2961f8Sjose borrego mbuf_chain_t *smb_mbc_alloc(uint32_t);
284*2c2961f8Sjose borrego void smb_mbc_free(mbuf_chain_t *);
28521b7895dSjb150015 
286da6c28aaSamw #ifdef __cplusplus
287da6c28aaSamw }
288da6c28aaSamw #endif
289da6c28aaSamw 
290da6c28aaSamw #endif /* _SMBSRV_MBUF_H */
291