sctp_os_bsd.h revision 169420 
1/*-
2 * Copyright (c) 2006-2007, by 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: head/sys/netinet/sctp_os_bsd.h 169420 2007-05-09 13:30:06Z rrs $");
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/kthread.h>
55#include <sys/priv.h>
56#include <sys/random.h>
57#include <sys/limits.h>
58#include <sys/queue.h>
59#include <machine/cpu.h>
60
61#include <net/if.h>
62#include <net/if_types.h>
63#include <net/if_var.h>
64#include <net/route.h>
65
66#include <netinet/in.h>
67#include <netinet/in_systm.h>
68#include <netinet/ip.h>
69#include <netinet/in_pcb.h>
70#include <netinet/in_var.h>
71#include <netinet/ip_var.h>
72#include <netinet/ip_icmp.h>
73#include <netinet/icmp_var.h>
74
75
76#ifdef IPSEC
77#include <netinet6/ipsec.h>
78#include <netkey/key.h>
79#endif				/* IPSEC */
80
81#ifdef INET6
82#include <sys/domain.h>
83#ifdef IPSEC
84#include <netinet6/ipsec6.h>
85#endif
86#include <netinet/ip6.h>
87#include <netinet6/ip6_var.h>
88#include <netinet6/in6_pcb.h>
89#include <netinet/icmp6.h>
90#include <netinet6/ip6protosw.h>
91#include <netinet6/nd6.h>
92#include <netinet6/scope6_var.h>
93#endif				/* INET6 */
94
95
96#include <netinet/ip_options.h>
97
98#ifndef in6pcb
99#define in6pcb		inpcb
100#endif
101
102
103
104/*
105 *
106 */
107#define USER_ADDR_NULL	(NULL)	/* FIX ME: temp */
108#define SCTP_LIST_EMPTY(list)	LIST_EMPTY(list)
109
110#if defined(SCTP_DEBUG)
111#define SCTPDBG(level, params...)					\
112{									\
113    do {								\
114	if (sctp_debug_on & level ) {					\
115	    printf(params);						\
116	}								\
117    } while (0);							\
118}
119#define SCTPDBG_ADDR(level, addr)					\
120{									\
121    do {								\
122	if (sctp_debug_on & level ) {					\
123	    sctp_print_address(addr);					\
124	}								\
125    } while (0);							\
126}
127#define SCTPDBG_PKT(level, iph, sh)					\
128{									\
129    do {								\
130	    if (sctp_debug_on & level) {				\
131		    sctp_print_address_pkt(iph, sh);			\
132	    }								\
133    } while (0);							\
134}
135#else
136#define SCTPDBG(level, params...)
137#define SCTPDBG_ADDR(level, addr)
138#define SCTPDBG_PKT(level, iph, sh)
139#endif
140#define SCTP_PRINTF(params...)	printf(params)
141
142/*
143 * Local address and interface list handling
144 */
145#define SCTP_MAX_VRF_ID		0
146#define SCTP_SIZE_OF_VRF_HASH	3
147#define SCTP_IFNAMSIZ		IFNAMSIZ
148#define SCTP_DEFAULT_VRFID	0
149#define SCTP_DEFAULT_TABLEID	0
150#define SCTP_VRF_ADDR_HASH_SIZE	16
151#define SCTP_VRF_IFN_HASH_SIZE	3
152#define SCTP_VRF_DEFAULT_TABLEID(vrf_id)	0
153
154#define SCTP_IFN_IS_IFT_LOOP(ifn) ((ifn)->ifn_type == IFT_LOOP)
155
156/*
157 * Access to IFN's to help with src-addr-selection
158 */
159/* This could return VOID if the index works but for BSD we provide both. */
160#define SCTP_GET_IFN_VOID_FROM_ROUTE(ro) (void *)ro->ro_rt->rt_ifp
161#define SCTP_GET_IF_INDEX_FROM_ROUTE(ro) (ro)->ro_rt->rt_ifp->if_index
162#define SCTP_ROUTE_HAS_VALID_IFN(ro) ((ro)->ro_rt && (ro)->ro_rt->rt_ifp)
163
164/*
165 * general memory allocation
166 */
167#define SCTP_MALLOC(var, type, size, name) \
168    do { \
169	MALLOC(var, type, size, M_PCB, M_NOWAIT); \
170    } while (0)
171
172#define SCTP_FREE(var)	FREE(var, M_PCB)
173
174#define SCTP_MALLOC_SONAME(var, type, size) \
175    do { \
176	MALLOC(var, type, size, M_SONAME, M_WAITOK | M_ZERO); \
177    } while (0)
178
179#define SCTP_FREE_SONAME(var)	FREE(var, M_SONAME)
180
181#define SCTP_PROCESS_STRUCT struct proc *
182
183/*
184 * zone allocation functions
185 */
186#include <vm/uma.h>
187/* SCTP_ZONE_INIT: initialize the zone */
188typedef struct uma_zone *sctp_zone_t;
189
190#define UMA_ZFLAG_FULL	0x0020
191#define SCTP_ZONE_INIT(zone, name, size, number) { \
192	zone = uma_zcreate(name, size, NULL, NULL, NULL, NULL, UMA_ALIGN_PTR,\
193		UMA_ZFLAG_FULL); \
194	uma_zone_set_max(zone, number); \
195}
196
197/* SCTP_ZONE_GET: allocate element from the zone */
198#define SCTP_ZONE_GET(zone, type) \
199	(type *)uma_zalloc(zone, M_NOWAIT);
200
201/* SCTP_ZONE_FREE: free element from the zone */
202#define SCTP_ZONE_FREE(zone, element) \
203	uma_zfree(zone, element);
204#define SCTP_HASH_INIT(size, hashmark) hashinit_flags(size, M_PCB, hashmark, HASH_NOWAIT)
205#define SCTP_HASH_FREE(table, hashmark) hashdestroy(table, M_PCB, hashmark)
206
207#define SCTP_M_COPYM	m_copym
208
209/*
210 * timers
211 */
212#include <sys/callout.h>
213typedef struct callout sctp_os_timer_t;
214
215#define SCTP_OS_TIMER_INIT(tmr)	callout_init(tmr, 1)
216#define SCTP_OS_TIMER_START	callout_reset
217#define SCTP_OS_TIMER_STOP	callout_stop
218#define SCTP_OS_TIMER_STOP_DRAIN callout_drain
219#define SCTP_OS_TIMER_PENDING	callout_pending
220#define SCTP_OS_TIMER_ACTIVE	callout_active
221#define SCTP_OS_TIMER_DEACTIVATE callout_deactivate
222
223/*
224 * Functions
225 */
226/* Mbuf manipulation and access macros  */
227#define SCTP_BUF_LEN(m) (m->m_len)
228#define SCTP_BUF_NEXT(m) (m->m_next)
229#define SCTP_BUF_NEXT_PKT(m) (m->m_nextpkt)
230#define SCTP_BUF_RESV_UF(m, size) m->m_data += size
231#define SCTP_BUF_AT(m, size) m->m_data + size
232#define SCTP_BUF_IS_EXTENDED(m) (m->m_flags & M_EXT)
233#define SCTP_BUF_EXTEND_SIZE(m) (m->m_ext.ext_size)
234#define SCTP_BUF_TYPE(m) (m->m_type)
235#define SCTP_BUF_RECVIF(m) (m->m_pkthdr.rcvif)
236#define SCTP_BUF_PREPEND	M_PREPEND
237
238#define SCTP_ALIGN_TO_END(m, len) if(m->m_flags & M_PKTHDR) { \
239                                     MH_ALIGN(m, len); \
240                                  } else if ((m->m_flags & M_EXT) == 0) { \
241                                     M_ALIGN(m, len); \
242                                  }
243/*************************/
244/*      MTU              */
245/*************************/
246#define SCTP_GATHER_MTU_FROM_IFN_INFO(ifn, ifn_index) ((struct ifnet *)ifn)->if_mtu
247#define SCTP_GATHER_MTU_FROM_ROUTE(sctp_ifa, sa, rt) ((rt != NULL) ? rt->rt_rmx.rmx_mtu : 0)
248#define SCTP_GATHER_MTU_FROM_INTFC(sctp_ifn) ((sctp_ifn->ifn_p != NULL) ? ((struct ifnet *)(sctp_ifn->ifn_p))->if_mtu : 0)
249#define SCTP_SET_MTU_OF_ROUTE(sa, rt, mtu) do { \
250                                              if (rt != NULL) \
251                                                 rt->rt_rmx.rmx_mtu = mtu; \
252                                           } while(0)
253
254/* (de-)register interface event notifications */
255#define SCTP_REGISTER_INTERFACE(ifhandle, ifname)
256#define SCTP_DEREGISTER_INTERFACE(ifhandle, ifname)
257
258/*************************/
259/* These are for logging */
260/*************************/
261/* return the base ext data pointer */
262#define SCTP_BUF_EXTEND_BASE(m) (m->m_ext.ext_buf)
263 /* return the refcnt of the data pointer */
264#define SCTP_BUF_EXTEND_REFCNT(m) (*m->m_ext.ref_cnt)
265/* return any buffer related flags, this is
266 * used beyond logging for apple only.
267 */
268#define SCTP_BUF_GET_FLAGS(m) (m->m_flags)
269
270/* For BSD this just accesses the M_PKTHDR length
271 * so it operates on an mbuf with hdr flag. Other
272 * O/S's may have seperate packet header and mbuf
273 * chain pointers.. thus the macro.
274 */
275#define SCTP_HEADER_TO_CHAIN(m) (m)
276#define SCTP_DETACH_HEADER_FROM_CHAIN(m)
277#define SCTP_HEADER_LEN(m) (m->m_pkthdr.len)
278#define SCTP_GET_HEADER_FOR_OUTPUT(o_pak) 0
279#define SCTP_RELEASE_HEADER(m)
280#define SCTP_RELEASE_PKT(m)	sctp_m_freem(m)
281
282static inline int
283SCTP_GET_PKT_VRFID(void *m, uint32_t vrf_id)
284{
285	vrf_id = SCTP_DEFAULT_VRFID;
286	return (0);
287}
288static inline int
289SCTP_GET_PKT_TABLEID(void *m, uint32_t table_id)
290{
291	table_id = SCTP_DEFAULT_TABLEID;
292	return (0);
293}
294
295/* Attach the chain of data into the sendable packet. */
296#define SCTP_ATTACH_CHAIN(pak, m, packet_length) do { \
297                                                 pak = m; \
298                                                 pak->m_pkthdr.len = packet_length; \
299                         } while(0)
300
301/* Other m_pkthdr type things */
302#define SCTP_IS_IT_BROADCAST(dst, m) in_broadcast(dst, m->m_pkthdr.rcvif)
303#define SCTP_IS_IT_LOOPBACK(m) ((m->m_pkthdr.rcvif == NULL) ||(m->m_pkthdr.rcvif->if_type == IFT_LOOP))
304
305
306/* This converts any input packet header
307 * into the chain of data holders, for BSD
308 * its a NOP.
309 */
310
311/* Macro's for getting length from V6/V4 header */
312#define SCTP_GET_IPV4_LENGTH(iph) (iph->ip_len)
313#define SCTP_GET_IPV6_LENGTH(ip6) (ntohs(ip6->ip6_plen))
314
315/* get the v6 hop limit */
316#define SCTP_GET_HLIM(inp, ro)	in6_selecthlim((struct in6pcb *)&inp->ip_inp.inp, (ro ? (ro->ro_rt ? (ro->ro_rt->rt_ifp) : (NULL)) : (NULL)));
317
318/* is the endpoint v6only? */
319#define SCTP_IPV6_V6ONLY(inp)	(((struct inpcb *)inp)->inp_flags & IN6P_IPV6_V6ONLY)
320/* is the socket non-blocking? */
321#define SCTP_SO_IS_NBIO(so)	((so)->so_state & SS_NBIO)
322#define SCTP_SET_SO_NBIO(so)	((so)->so_state |= SS_NBIO)
323#define SCTP_CLEAR_SO_NBIO(so)	((so)->so_state &= ~SS_NBIO)
324/* get the socket type */
325#define SCTP_SO_TYPE(so)	((so)->so_type)
326/* reserve sb space for a socket */
327#define SCTP_SORESERVE(so, send, recv)	soreserve(so, send, recv)
328/* wakeup a socket */
329#define SCTP_SOWAKEUP(so)	wakeup(&(so)->so_timeo)
330/* clear the socket buffer state */
331#define SCTP_SB_CLEAR(sb)	\
332	(sb).sb_cc = 0;		\
333	(sb).sb_mb = NULL;	\
334	(sb).sb_mbcnt = 0;
335
336#define SCTP_SB_LIMIT_RCV(so) so->so_rcv.sb_hiwat
337#define SCTP_SB_LIMIT_SND(so) so->so_snd.sb_hiwat
338
339/*
340 * routes, output, etc.
341 */
342typedef struct route sctp_route_t;
343typedef struct rtentry sctp_rtentry_t;
344
345#define SCTP_RTALLOC(ro, vrf_id, table_id) rtalloc_ign((struct route *)ro, 0UL)
346
347/* Future zero copy wakeup/send  function */
348#define SCTP_ZERO_COPY_EVENT(inp, so)
349
350/*
351 * IP output routines
352 */
353#define SCTP_IP_OUTPUT(result, o_pak, ro, stcb, vrf_id, table_id) \
354{ \
355	int o_flgs = 0; \
356	if (stcb && stcb->sctp_ep && stcb->sctp_ep->sctp_socket) { \
357		o_flgs = IP_RAWOUTPUT | (stcb->sctp_ep->sctp_socket->so_options & SO_DONTROUTE); \
358	} else { \
359		o_flgs = IP_RAWOUTPUT; \
360	} \
361	result = ip_output(o_pak, NULL, ro, o_flgs, 0, NULL); \
362}
363
364#define SCTP_IP6_OUTPUT(result, o_pak, ro, ifp, stcb, vrf_id, table_id) \
365{ \
366 	if (stcb && stcb->sctp_ep) \
367		result = ip6_output(o_pak, \
368				    ((struct in6pcb *)(stcb->sctp_ep))->in6p_outputopts, \
369				    (ro), 0, 0, ifp, NULL); \
370	else \
371		result = ip6_output(o_pak, NULL, (ro), 0, 0, ifp, NULL); \
372}
373
374struct mbuf *
375sctp_get_mbuf_for_msg(unsigned int space_needed,
376    int want_header, int how, int allonebuf, int type);
377
378
379/*
380 * SCTP AUTH
381 */
382#define HAVE_SHA2
383
384#define SCTP_READ_RANDOM(buf, len)	read_random(buf, len)
385
386#ifdef USE_SCTP_SHA1
387#include <netinet/sctp_sha1.h>
388#else
389#include <crypto/sha1.h>
390/* map standard crypto API names */
391#define SHA1_Init	SHA1Init
392#define SHA1_Update	SHA1Update
393#define SHA1_Final(x,y)	SHA1Final((caddr_t)x, y)
394#endif
395
396#if defined(HAVE_SHA2)
397#include <crypto/sha2/sha2.h>
398#endif
399
400#include <sys/md5.h>
401/* map standard crypto API names */
402#define MD5_Init	MD5Init
403#define MD5_Update	MD5Update
404#define MD5_Final	MD5Final
405
406#endif
407