xref: /dragonfly/sys/sys/sockbuf.h (revision 956939d5)
1 /*-
2  * Copyright (c) 1982, 1986, 1990, 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  * @(#)socketvar.h	8.3 (Berkeley) 2/19/95
34  * $FreeBSD: src/sys/sys/socketvar.h,v 1.46.2.10 2003/08/24 08:24:39 hsu Exp $
35  * $DragonFly: src/sys/sys/sockbuf.h,v 1.1 2007/04/22 01:13:17 dillon Exp $
36  */
37 
38 #ifndef _SYS_SOCKBUF_H_
39 #define _SYS_SOCKBUF_H_
40 
41 #ifndef _SYS_TYPES_H_
42 #include <sys/types.h>
43 #endif
44 
45 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
46 
47 /*
48  * Generic socket buffer for keeping track of mbuf chains.  These
49  * are used primarily to manipulate mbuf chains in standalone pieces
50  * of code.
51  */
52 struct sockbuf {
53 	u_long	sb_cc;		/* actual chars in buffer */
54 	u_long	sb_mbcnt;	/* chars of mbufs used */
55 	u_long	sb_climit;	/* data limit when used for I/O */
56 	struct	mbuf *sb_mb;	/* the mbuf chain */
57 	struct	mbuf *sb_lastmbuf;	/* last mbuf in sb_mb */
58 	struct	mbuf *sb_lastrecord;	/* last record in sb_mb
59 					 * valid <=> sb_mb non-NULL */
60 };
61 
62 #define SB_MAX		(256*1024)	/* default for max chars in sockbuf */
63 
64 #endif
65 
66 #ifdef _KERNEL
67 
68 /*
69  * Macros for sockets and socket buffering.
70  */
71 
72 #ifdef SOCKBUF_DEBUG
73 #define sbcheck(sb)	_sbcheck(sb)
74 #else
75 #define sbcheck(sb)
76 #endif
77 
78 /* adjust counters in sb reflecting allocation of m */
79 #define	sballoc(sb, m) { \
80 	(sb)->sb_cc += (m)->m_len; \
81 	(sb)->sb_mbcnt += MSIZE; \
82 	if ((m)->m_flags & M_EXT) \
83 		(sb)->sb_mbcnt += (m)->m_ext.ext_size; \
84 }
85 
86 /* adjust counters in sb reflecting freeing of m */
87 #define	sbfree(sb, m) { \
88 	(sb)->sb_cc -= (m)->m_len; \
89 	(sb)->sb_mbcnt -= MSIZE; \
90 	if ((m)->m_flags & M_EXT) \
91 		(sb)->sb_mbcnt -= (m)->m_ext.ext_size; \
92 }
93 
94 static __inline void
95 sbinit(struct sockbuf *sb, u_long climit)
96 {
97 	sb->sb_cc = 0;
98 	sb->sb_mbcnt = 0;
99 	sb->sb_climit = climit;
100 	sb->sb_mb = NULL;
101 	sb->sb_lastmbuf = NULL;
102 	sb->sb_lastrecord = NULL;
103 }
104 
105 void	sbappend (struct sockbuf *sb, struct mbuf *m);
106 int	sbappendaddr (struct sockbuf *sb, const struct sockaddr *asa,
107 	    struct mbuf *m0, struct mbuf *control);
108 int	sbappendcontrol (struct sockbuf *sb, struct mbuf *m0,
109 	    struct mbuf *control);
110 void	sbappendrecord (struct sockbuf *sb, struct mbuf *m0);
111 void	sbappendstream (struct sockbuf *sb, struct mbuf *m);
112 void	_sbcheck (struct sockbuf *sb);
113 void	sbcompress (struct sockbuf *sb, struct mbuf *m, struct mbuf *n);
114 struct mbuf *
115 	sbcreatecontrol (caddr_t p, int size, int type, int level);
116 void	sbdrop (struct sockbuf *sb, int len);
117 void	sbdroprecord (struct sockbuf *sb);
118 struct mbuf *
119 	sbunlinkmbuf (struct sockbuf *, struct mbuf *, struct mbuf **);
120 void	sbflush (struct sockbuf *sb);
121 
122 #endif /* _KERNEL */
123 
124 #endif /* !_SYS_SOCKBUF_H_ */
125