xref: /freebsd/sys/netinet/sctp_os_bsd.h (revision 588ff6c0cc9aaf10ba19080d9f8acbd8be36abf3)
1 /*-
2  * Copyright (c) 2006-2007, Cisco Systems, Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  *
7  * a) Redistributions of source code must retain the above copyright notice,
8  *   this list of conditions and the following disclaimer.
9  *
10  * b) Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in
12  *   the documentation and/or other materials provided with the distribution.
13  *
14  * c) Neither the name of Cisco Systems, Inc. nor the names of its
15  *    contributors may be used to endorse or promote products derived
16  *    from this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
20  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
22  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
28  * THE POSSIBILITY OF SUCH DAMAGE.
29  */
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
32 #ifndef __sctp_os_bsd_h__
33 #define __sctp_os_bsd_h__
34 /*
35  * includes
36  */
37 #include "opt_ipsec.h"
38 #include "opt_compat.h"
39 #include "opt_inet6.h"
40 #include "opt_inet.h"
41 #include "opt_sctp.h"
42 #include <sys/param.h>
43 #include <sys/systm.h>
44 #include <sys/malloc.h>
45 #include <sys/kernel.h>
46 #include <sys/sysctl.h>
47 #include <sys/mbuf.h>
48 #include <sys/protosw.h>
49 #include <sys/socket.h>
50 #include <sys/socketvar.h>
51 #include <sys/sysctl.h>
52 #include <sys/resourcevar.h>
53 #include <sys/uio.h>
54 #include <sys/priv.h>
55 #include <sys/random.h>
56 #include <sys/limits.h>
57 #include <sys/queue.h>
58 #include <machine/cpu.h>
59 
60 #include <net/if.h>
61 #include <net/if_types.h>
62 #include <net/if_var.h>
63 #include <net/route.h>
64 
65 #include <netinet/in.h>
66 #include <netinet/in_systm.h>
67 #include <netinet/ip.h>
68 #include <netinet/in_pcb.h>
69 #include <netinet/in_var.h>
70 #include <netinet/ip_var.h>
71 #include <netinet/ip_icmp.h>
72 #include <netinet/icmp_var.h>
73 
74 
75 #ifdef IPSEC
76 #include <netinet6/ipsec.h>
77 #include <netkey/key.h>
78 #endif				/* IPSEC */
79 
80 #ifdef INET6
81 #include <sys/domain.h>
82 #ifdef IPSEC
83 #include <netinet6/ipsec6.h>
84 #endif
85 #include <netinet/ip6.h>
86 #include <netinet6/ip6_var.h>
87 #include <netinet6/in6_pcb.h>
88 #include <netinet/icmp6.h>
89 #include <netinet6/ip6protosw.h>
90 #include <netinet6/nd6.h>
91 #include <netinet6/scope6_var.h>
92 #endif				/* INET6 */
93 
94 
95 
96 #include <netinet/ip_options.h>
97 
98 
99 #ifndef in6pcb
100 #define in6pcb		inpcb
101 #endif
102 
103 
104 
105 /*
106  *
107  */
108 #define USER_ADDR_NULL	(NULL)	/* FIX ME: temp */
109 #define SCTP_LIST_EMPTY(list)	LIST_EMPTY(list)
110 
111 /*
112  * general memory allocation
113  */
114 #define SCTP_MALLOC(var, type, size, name) \
115     do { \
116 	MALLOC(var, type, size, M_PCB, M_NOWAIT); \
117     } while (0)
118 
119 #define SCTP_FREE(var)	FREE(var, M_PCB)
120 
121 #define SCTP_MALLOC_SONAME(var, type, size) \
122     do { \
123 	MALLOC(var, type, size, M_SONAME, M_WAITOK | M_ZERO); \
124     } while (0)
125 
126 #define SCTP_FREE_SONAME(var)	FREE(var, M_SONAME)
127 
128 /*
129  * zone allocation functions
130  */
131 #include <vm/uma.h>
132 /* SCTP_ZONE_INIT: initialize the zone */
133 typedef struct uma_zone *sctp_zone_t;
134 
135 #define UMA_ZFLAG_FULL	0x0020
136 #define SCTP_ZONE_INIT(zone, name, size, number) { \
137 	zone = uma_zcreate(name, size, NULL, NULL, NULL, NULL, UMA_ALIGN_PTR,\
138 		UMA_ZFLAG_FULL); \
139 	uma_zone_set_max(zone, number); \
140 }
141 
142 /* SCTP_ZONE_GET: allocate element from the zone */
143 #define SCTP_ZONE_GET(zone, type) \
144 	(type *)uma_zalloc(zone, M_NOWAIT);
145 
146 /* SCTP_ZONE_FREE: free element from the zone */
147 #define SCTP_ZONE_FREE(zone, element) \
148 	uma_zfree(zone, element);
149 #define SCTP_HASH_INIT(size, hashmark) hashinit_flags(size, M_PCB, hashmark, HASH_NOWAIT)
150 #define SCTP_HASH_FREE(table, hashmark) hashdestroy(table, M_PCB, hashmark)
151 
152 #define SCTP_M_COPYM	m_copym
153 
154 /*
155  * timers
156  */
157 #include <sys/callout.h>
158 typedef struct callout sctp_os_timer_t;
159 
160 #define SCTP_OS_TIMER_INIT(tmr)	callout_init(tmr, 1)
161 #define SCTP_OS_TIMER_START	callout_reset
162 #define SCTP_OS_TIMER_STOP	callout_stop
163 #define SCTP_OS_TIMER_STOP_DRAIN callout_drain
164 #define SCTP_OS_TIMER_PENDING	callout_pending
165 #define SCTP_OS_TIMER_ACTIVE	callout_active
166 #define SCTP_OS_TIMER_DEACTIVATE callout_deactivate
167 
168 /*
169  * Functions
170  */
171 
172 /* Mbuf manipulation and access macros  */
173 #define SCTP_BUF_LEN(m) (m->m_len)
174 #define SCTP_BUF_NEXT(m) (m->m_next)
175 #define SCTP_BUF_NEXT_PKT(m) (m->m_nextpkt)
176 #define SCTP_BUF_RESV_UF(m, size) m->m_data += size
177 #define SCTP_BUF_AT(m, size) m->m_data + size
178 #define SCTP_BUF_IS_EXTENDED(m) (m->m_flags & M_EXT)
179 #define SCTP_BUF_EXTEND_SIZE(m) (m->m_ext.ext_size)
180 #define SCTP_BUF_TYPE(m) (m->m_type)
181 #define SCTP_BUF_RECVIF(m) (m->m_pkthdr.rcvif)
182 #define SCTP_BUF_PREPEND	M_PREPEND
183 /*************************/
184 /* These are for logging */
185 /*************************/
186 /* return the base ext data pointer */
187 #define SCTP_BUF_EXTEND_BASE(m) (m->m_ext.ext_buf)
188  /* return the refcnt of the data pointer */
189 #define SCTP_BUF_EXTEND_REFCNT(m) (*m->m_ext.ref_cnt)
190 /* return any buffer related flags, this is
191  * used beyond logging for apple only.
192  */
193 #define SCTP_BUF_GET_FLAGS(m) (m->m_flags)
194 
195 /* For BSD this just accesses the M_PKTHDR length
196  * so it operates on an mbuf with hdr flag. Other
197  * O/S's may have seperate packet header and mbuf
198  * chain pointers.. thus the macro.
199  */
200 #define SCTP_HEADER_TO_CHAIN(m) (m)
201 #define SCTP_HEADER_LEN(m) (m->m_pkthdr.len)
202 #define SCTP_GET_HEADER_FOR_OUTPUT(len) sctp_get_mbuf_for_msg(len, 1, M_DONTWAIT, 1, MT_DATA)
203 
204 /* Attach the chain of data into the sendable packet. */
205 #define SCTP_ATTACH_CHAIN(pak, m, packet_length) do { \
206                                                  pak->m_next = m; \
207                                                  pak->m_pkthdr.len = packet_length; \
208                          } while(0)
209 
210 /* Other m_pkthdr type things */
211 #define SCTP_IS_IT_BROADCAST(dst, m) in_broadcast(dst, m->m_pkthdr.rcvif)
212 #define SCTP_IS_IT_LOOPBACK(m) ((m->m_pkthdr.rcvif == NULL) ||(m->m_pkthdr.rcvif->if_type == IFT_LOOP))
213 
214 
215 /* This converts any input packet header
216  * into the chain of data holders, for BSD
217  * its a NOP.
218  */
219 #define SCTP_PAK_TO_BUF(i_pak) (i_pak)
220 
221 /* Macro's for getting length from V6/V4 header */
222 #define SCTP_GET_IPV4_LENGTH(iph) (iph->ip_len)
223 #define SCTP_GET_IPV6_LENGTH(ip6) (ntohs(ip6->ip6_plen))
224 
225 /* is the endpoint v6only? */
226 #define SCTP_IPV6_V6ONLY(inp)	(((struct inpcb *)inp)->inp_flags & IN6P_IPV6_V6ONLY)
227 
228 
229 /*
230  * SCTP AUTH
231  */
232 #define HAVE_SHA2
233 
234 #define SCTP_READ_RANDOM(buf, len)	read_random(buf, len)
235 
236 #ifdef USE_SCTP_SHA1
237 #include <netinet/sctp_sha1.h>
238 #else
239 #include <crypto/sha1.h>
240 /* map standard crypto API names */
241 #define SHA1_Init	SHA1Init
242 #define SHA1_Update	SHA1Update
243 #define SHA1_Final(x,y)	SHA1Final((caddr_t)x, y)
244 #endif
245 
246 #if defined(HAVE_SHA2)
247 #include <crypto/sha2/sha2.h>
248 #endif
249 
250 #include <sys/md5.h>
251 /* map standard crypto API names */
252 #define MD5_Init	MD5Init
253 #define MD5_Update	MD5Update
254 #define MD5_Final	MD5Final
255 
256 #endif
257