2 * Copyright (c) 2006-2007, by Cisco Systems, Inc. All rights reserved.
3 * Copyright (c) 2008-2011, by Randall Stewart. All rights reserved.
4 * Copyright (c) 2008-2011, by Michael Tuexen. All rights reserved.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are met:
9 * a) Redistributions of source code must retain the above copyright notice,
10 * this list of conditions and the following disclaimer.
12 * b) Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in
14 * the documentation and/or other materials provided with the distribution.
16 * c) Neither the name of Cisco Systems, Inc. nor the names of its
17 * contributors may be used to endorse or promote products derived
18 * from this software without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
22 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
30 * THE POSSIBILITY OF SUCH DAMAGE.
32 #include <sys/cdefs.h>
33 __FBSDID("$FreeBSD$");
34 #ifndef __sctp_os_bsd_h__
35 #define __sctp_os_bsd_h__
39 #include "opt_ipsec.h"
40 #include "opt_compat.h"
41 #include "opt_inet6.h"
47 #include <sys/param.h>
49 #include <sys/systm.h>
50 #include <sys/malloc.h>
51 #include <sys/kernel.h>
52 #include <sys/sysctl.h>
54 #include <sys/protosw.h>
55 #include <sys/socket.h>
56 #include <sys/socketvar.h>
58 #include <sys/sysctl.h>
59 #include <sys/resourcevar.h>
62 #include <sys/rwlock.h>
63 #include <sys/kthread.h>
65 #include <sys/random.h>
66 #include <sys/limits.h>
67 #include <sys/queue.h>
68 #include <machine/cpu.h>
71 #include <net/if_types.h>
72 #include <net/if_var.h>
73 #include <net/route.h>
76 #include <netinet/in.h>
77 #include <netinet/in_systm.h>
78 #include <netinet/ip.h>
79 #include <netinet/in_pcb.h>
80 #include <netinet/in_var.h>
81 #include <netinet/ip_var.h>
82 #include <netinet/ip_icmp.h>
83 #include <netinet/icmp_var.h>
86 #include <netipsec/ipsec.h>
87 #include <netipsec/key.h>
91 #include <sys/domain.h>
93 #include <netipsec/ipsec6.h>
95 #include <netinet/ip6.h>
96 #include <netinet6/ip6_var.h>
97 #include <netinet6/in6_pcb.h>
98 #include <netinet/icmp6.h>
99 #include <netinet6/ip6protosw.h>
100 #include <netinet6/nd6.h>
101 #include <netinet6/scope6_var.h>
105 #include <netinet/ip_options.h>
110 /* Declare all the malloc names for all the various mallocs */
111 MALLOC_DECLARE(SCTP_M_MAP);
112 MALLOC_DECLARE(SCTP_M_STRMI);
113 MALLOC_DECLARE(SCTP_M_STRMO);
114 MALLOC_DECLARE(SCTP_M_ASC_ADDR);
115 MALLOC_DECLARE(SCTP_M_ASC_IT);
116 MALLOC_DECLARE(SCTP_M_AUTH_CL);
117 MALLOC_DECLARE(SCTP_M_AUTH_KY);
118 MALLOC_DECLARE(SCTP_M_AUTH_HL);
119 MALLOC_DECLARE(SCTP_M_AUTH_IF);
120 MALLOC_DECLARE(SCTP_M_STRESET);
121 MALLOC_DECLARE(SCTP_M_CMSG);
122 MALLOC_DECLARE(SCTP_M_COPYAL);
123 MALLOC_DECLARE(SCTP_M_VRF);
124 MALLOC_DECLARE(SCTP_M_IFA);
125 MALLOC_DECLARE(SCTP_M_IFN);
126 MALLOC_DECLARE(SCTP_M_TIMW);
127 MALLOC_DECLARE(SCTP_M_MVRF);
128 MALLOC_DECLARE(SCTP_M_ITER);
129 MALLOC_DECLARE(SCTP_M_SOCKOPT);
130 MALLOC_DECLARE(SCTP_M_MCORE);
132 #if defined(SCTP_LOCAL_TRACE_BUF)
134 #define SCTP_GET_CYCLECOUNT get_cyclecount()
135 #define SCTP_CTR6 sctp_log_trace
138 #define SCTP_CTR6 CTR6
142 * Macros to expand out globals defined by various modules
143 * to either a real global or a virtualized instance of one,
144 * depending on whether VIMAGE is defined.
146 /* then define the macro(s) that hook into the vimage macros */
147 #define MODULE_GLOBAL(__SYMBOL) V_##__SYMBOL
149 #define V_system_base_info VNET(system_base_info)
150 #define SCTP_BASE_INFO(__m) V_system_base_info.sctppcbinfo.__m
151 #define SCTP_BASE_STATS V_system_base_info.sctpstat
152 #define SCTP_BASE_STATS_SYSCTL VNET_NAME(system_base_info.sctpstat)
153 #define SCTP_BASE_STAT(__m) V_system_base_info.sctpstat.__m
154 #define SCTP_BASE_SYSCTL(__m) VNET_NAME(system_base_info.sctpsysctl.__m)
155 #define SCTP_BASE_VAR(__m) V_system_base_info.__m
160 #define USER_ADDR_NULL (NULL) /* FIX ME: temp */
162 #if defined(SCTP_DEBUG)
163 #define SCTPDBG(level, params...) \
166 if (SCTP_BASE_SYSCTL(sctp_debug_on) & level ) { \
171 #define SCTPDBG_ADDR(level, addr) \
174 if (SCTP_BASE_SYSCTL(sctp_debug_on) & level ) { \
175 sctp_print_address(addr); \
179 #define SCTPDBG_PKT(level, iph, sh) \
182 if (SCTP_BASE_SYSCTL(sctp_debug_on) & level) { \
183 sctp_print_address_pkt(iph, sh); \
188 #define SCTPDBG(level, params...)
189 #define SCTPDBG_ADDR(level, addr)
190 #define SCTPDBG_PKT(level, iph, sh)
192 #define SCTP_PRINTF(params...) printf(params)
194 #ifdef SCTP_LTRACE_CHUNKS
195 #define SCTP_LTRACE_CHK(a, b, c, d) if(SCTP_BASE_SYSCTL(sctp_logging_level) & SCTP_LTRACE_CHUNK_ENABLE) SCTP_CTR6(KTR_SUBSYS, "SCTP:%d[%d]:%x-%x-%x-%x", SCTP_LOG_CHUNK_PROC, 0, a, b, c, d)
197 #define SCTP_LTRACE_CHK(a, b, c, d)
200 #ifdef SCTP_LTRACE_ERRORS
201 #define SCTP_LTRACE_ERR_RET_PKT(m, inp, stcb, net, file, err) if(SCTP_BASE_SYSCTL(sctp_logging_level) & SCTP_LTRACE_ERROR_ENABLE) \
202 printf("mbuf:%p inp:%p stcb:%p net:%p file:%x line:%d error:%d\n", \
203 m, inp, stcb, net, file, __LINE__, err);
204 #define SCTP_LTRACE_ERR_RET(inp, stcb, net, file, err) if(SCTP_BASE_SYSCTL(sctp_logging_level) & SCTP_LTRACE_ERROR_ENABLE) \
205 printf("inp:%p stcb:%p net:%p file:%x line:%d error:%d\n", \
206 inp, stcb, net, file, __LINE__, err);
208 #define SCTP_LTRACE_ERR_RET_PKT(m, inp, stcb, net, file, err)
209 #define SCTP_LTRACE_ERR_RET(inp, stcb, net, file, err)
214 * Local address and interface list handling
216 #define SCTP_MAX_VRF_ID 0
217 #define SCTP_SIZE_OF_VRF_HASH 3
218 #define SCTP_IFNAMSIZ IFNAMSIZ
219 #define SCTP_DEFAULT_VRFID 0
220 #define SCTP_VRF_ADDR_HASH_SIZE 16
221 #define SCTP_VRF_IFN_HASH_SIZE 3
222 #define SCTP_INIT_VRF_TABLEID(vrf)
224 #define SCTP_IFN_IS_IFT_LOOP(ifn) ((ifn)->ifn_type == IFT_LOOP)
225 #define SCTP_ROUTE_IS_REAL_LOOP(ro) ((ro)->ro_rt && (ro)->ro_rt->rt_ifa && (ro)->ro_rt->rt_ifa->ifa_ifp && (ro)->ro_rt->rt_ifa->ifa_ifp->if_type == IFT_LOOP)
228 * Access to IFN's to help with src-addr-selection
230 /* This could return VOID if the index works but for BSD we provide both. */
231 #define SCTP_GET_IFN_VOID_FROM_ROUTE(ro) (void *)ro->ro_rt->rt_ifp
232 #define SCTP_GET_IF_INDEX_FROM_ROUTE(ro) (ro)->ro_rt->rt_ifp->if_index
233 #define SCTP_ROUTE_HAS_VALID_IFN(ro) ((ro)->ro_rt && (ro)->ro_rt->rt_ifp)
236 * general memory allocation
238 #define SCTP_MALLOC(var, type, size, name) \
240 var = (type)malloc(size, name, M_NOWAIT); \
243 #define SCTP_FREE(var, type) free(var, type)
245 #define SCTP_MALLOC_SONAME(var, type, size) \
247 var = (type)malloc(size, M_SONAME, M_WAITOK | M_ZERO); \
250 #define SCTP_FREE_SONAME(var) free(var, M_SONAME)
252 #define SCTP_PROCESS_STRUCT struct proc *
255 * zone allocation functions
259 /* SCTP_ZONE_INIT: initialize the zone */
260 typedef struct uma_zone *sctp_zone_t;
262 #define SCTP_ZONE_INIT(zone, name, size, number) { \
263 zone = uma_zcreate(name, size, NULL, NULL, NULL, NULL, UMA_ALIGN_PTR,\
265 uma_zone_set_max(zone, number); \
268 #define SCTP_ZONE_DESTROY(zone) uma_zdestroy(zone)
270 /* SCTP_ZONE_GET: allocate element from the zone */
271 #define SCTP_ZONE_GET(zone, type) \
272 (type *)uma_zalloc(zone, M_NOWAIT);
274 /* SCTP_ZONE_FREE: free element from the zone */
275 #define SCTP_ZONE_FREE(zone, element) \
276 uma_zfree(zone, element);
278 #define SCTP_HASH_INIT(size, hashmark) hashinit_flags(size, M_PCB, hashmark, HASH_NOWAIT)
279 #define SCTP_HASH_FREE(table, hashmark) hashdestroy(table, M_PCB, hashmark)
281 #define SCTP_M_COPYM m_copym
286 #include <sys/callout.h>
287 typedef struct callout sctp_os_timer_t;
290 #define SCTP_OS_TIMER_INIT(tmr) callout_init(tmr, 1)
291 #define SCTP_OS_TIMER_START callout_reset
292 #define SCTP_OS_TIMER_STOP callout_stop
293 #define SCTP_OS_TIMER_STOP_DRAIN callout_drain
294 #define SCTP_OS_TIMER_PENDING callout_pending
295 #define SCTP_OS_TIMER_ACTIVE callout_active
296 #define SCTP_OS_TIMER_DEACTIVATE callout_deactivate
298 #define sctp_get_tick_count() (ticks)
300 #define SCTP_UNUSED __attribute__((unused))
305 /* Mbuf manipulation and access macros */
306 #define SCTP_BUF_LEN(m) (m->m_len)
307 #define SCTP_BUF_NEXT(m) (m->m_next)
308 #define SCTP_BUF_NEXT_PKT(m) (m->m_nextpkt)
309 #define SCTP_BUF_RESV_UF(m, size) m->m_data += size
310 #define SCTP_BUF_AT(m, size) m->m_data + size
311 #define SCTP_BUF_IS_EXTENDED(m) (m->m_flags & M_EXT)
312 #define SCTP_BUF_EXTEND_SIZE(m) (m->m_ext.ext_size)
313 #define SCTP_BUF_TYPE(m) (m->m_type)
314 #define SCTP_BUF_RECVIF(m) (m->m_pkthdr.rcvif)
315 #define SCTP_BUF_PREPEND M_PREPEND
317 #define SCTP_ALIGN_TO_END(m, len) if(m->m_flags & M_PKTHDR) { \
319 } else if ((m->m_flags & M_EXT) == 0) { \
323 /* We make it so if you have up to 4 threads
324 * writing based on the default size of
325 * the packet log 65 k, that would be
326 * 4 16k packets before we would hit
329 #define SCTP_PKTLOG_WRITERS_NEED_LOCK 3
331 /*************************/
333 /*************************/
334 #define SCTP_GATHER_MTU_FROM_IFN_INFO(ifn, ifn_index, af) ((struct ifnet *)ifn)->if_mtu
335 #define SCTP_GATHER_MTU_FROM_ROUTE(sctp_ifa, sa, rt) ((rt != NULL) ? rt->rt_rmx.rmx_mtu : 0)
336 #define SCTP_GATHER_MTU_FROM_INTFC(sctp_ifn) ((sctp_ifn->ifn_p != NULL) ? ((struct ifnet *)(sctp_ifn->ifn_p))->if_mtu : 0)
337 #define SCTP_SET_MTU_OF_ROUTE(sa, rt, mtu) do { \
339 rt->rt_rmx.rmx_mtu = mtu; \
342 /* (de-)register interface event notifications */
343 #define SCTP_REGISTER_INTERFACE(ifhandle, af)
344 #define SCTP_DEREGISTER_INTERFACE(ifhandle, af)
347 /*************************/
348 /* These are for logging */
349 /*************************/
350 /* return the base ext data pointer */
351 #define SCTP_BUF_EXTEND_BASE(m) (m->m_ext.ext_buf)
352 /* return the refcnt of the data pointer */
353 #define SCTP_BUF_EXTEND_REFCNT(m) (*m->m_ext.ref_cnt)
354 /* return any buffer related flags, this is
355 * used beyond logging for apple only.
357 #define SCTP_BUF_GET_FLAGS(m) (m->m_flags)
359 /* For BSD this just accesses the M_PKTHDR length
360 * so it operates on an mbuf with hdr flag. Other
361 * O/S's may have separate packet header and mbuf
362 * chain pointers.. thus the macro.
364 #define SCTP_HEADER_TO_CHAIN(m) (m)
365 #define SCTP_DETACH_HEADER_FROM_CHAIN(m)
366 #define SCTP_HEADER_LEN(m) (m->m_pkthdr.len)
367 #define SCTP_GET_HEADER_FOR_OUTPUT(o_pak) 0
368 #define SCTP_RELEASE_HEADER(m)
369 #define SCTP_RELEASE_PKT(m) sctp_m_freem(m)
370 #define SCTP_ENABLE_UDP_CSUM(m) do { \
371 m->m_pkthdr.csum_flags = CSUM_UDP; \
372 m->m_pkthdr.csum_data = offsetof(struct udphdr, uh_sum); \
375 #define SCTP_GET_PKT_VRFID(m, vrf_id) ((vrf_id = SCTP_DEFAULT_VRFID) != SCTP_DEFAULT_VRFID)
379 /* Attach the chain of data into the sendable packet. */
380 #define SCTP_ATTACH_CHAIN(pak, m, packet_length) do { \
382 pak->m_pkthdr.len = packet_length; \
385 /* Other m_pkthdr type things */
386 #define SCTP_IS_IT_BROADCAST(dst, m) ((m->m_flags & M_PKTHDR) ? in_broadcast(dst, m->m_pkthdr.rcvif) : 0)
387 #define SCTP_IS_IT_LOOPBACK(m) ((m->m_flags & M_PKTHDR) && ((m->m_pkthdr.rcvif == NULL) || (m->m_pkthdr.rcvif->if_type == IFT_LOOP)))
390 /* This converts any input packet header
391 * into the chain of data holders, for BSD
395 /* Macro's for getting length from V6/V4 header */
396 #define SCTP_GET_IPV4_LENGTH(iph) (iph->ip_len)
397 #define SCTP_GET_IPV6_LENGTH(ip6) (ntohs(ip6->ip6_plen))
399 /* get the v6 hop limit */
400 #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)));
402 /* is the endpoint v6only? */
403 #define SCTP_IPV6_V6ONLY(inp) (((struct inpcb *)inp)->inp_flags & IN6P_IPV6_V6ONLY)
404 /* is the socket non-blocking? */
405 #define SCTP_SO_IS_NBIO(so) ((so)->so_state & SS_NBIO)
406 #define SCTP_SET_SO_NBIO(so) ((so)->so_state |= SS_NBIO)
407 #define SCTP_CLEAR_SO_NBIO(so) ((so)->so_state &= ~SS_NBIO)
408 /* get the socket type */
409 #define SCTP_SO_TYPE(so) ((so)->so_type)
410 /* reserve sb space for a socket */
411 #define SCTP_SORESERVE(so, send, recv) soreserve(so, send, recv)
412 /* wakeup a socket */
413 #define SCTP_SOWAKEUP(so) wakeup(&(so)->so_timeo)
414 /* clear the socket buffer state */
415 #define SCTP_SB_CLEAR(sb) \
420 #define SCTP_SB_LIMIT_RCV(so) so->so_rcv.sb_hiwat
421 #define SCTP_SB_LIMIT_SND(so) so->so_snd.sb_hiwat
424 * routes, output, etc.
426 typedef struct route sctp_route_t;
427 typedef struct rtentry sctp_rtentry_t;
429 #define SCTP_RTALLOC(ro, vrf_id) rtalloc_ign((struct route *)ro, 0UL)
431 /* Future zero copy wakeup/send function */
432 #define SCTP_ZERO_COPY_EVENT(inp, so)
433 /* This is re-pulse ourselves for sendbuf */
434 #define SCTP_ZERO_COPY_SENDQ_EVENT(inp, so)
439 #define SCTP_IP_OUTPUT(result, o_pak, ro, stcb, vrf_id) \
441 int o_flgs = IP_RAWOUTPUT; \
442 struct sctp_tcb *local_stcb = stcb; \
444 local_stcb->sctp_ep && \
445 local_stcb->sctp_ep->sctp_socket) \
446 o_flgs |= local_stcb->sctp_ep->sctp_socket->so_options & SO_DONTROUTE; \
447 result = ip_output(o_pak, NULL, ro, o_flgs, 0, NULL); \
450 #define SCTP_IP6_OUTPUT(result, o_pak, ro, ifp, stcb, vrf_id) \
452 struct sctp_tcb *local_stcb = stcb; \
453 if (local_stcb && local_stcb->sctp_ep) \
454 result = ip6_output(o_pak, \
455 ((struct in6pcb *)(local_stcb->sctp_ep))->in6p_outputopts, \
456 (ro), 0, 0, ifp, NULL); \
458 result = ip6_output(o_pak, NULL, (ro), 0, 0, ifp, NULL); \
462 sctp_get_mbuf_for_msg(unsigned int space_needed,
463 int want_header, int how, int allonebuf, int type);
471 #define SCTP_READ_RANDOM(buf, len) read_random(buf, len)
474 #include <netinet/sctp_sha1.h>
476 #include <crypto/sha1.h>
477 /* map standard crypto API names */
478 #define SHA1_Init SHA1Init
479 #define SHA1_Update SHA1Update
480 #define SHA1_Final(x,y) SHA1Final((caddr_t)x, y)
483 #if defined(HAVE_SHA2)
484 #include <crypto/sha2/sha2.h>
489 #define SCTP_DECREMENT_AND_CHECK_REFCOUNT(addr) (atomic_fetchadd_int(addr, -1) == 1)
490 #if defined(INVARIANTS)
491 #define SCTP_SAVE_ATOMIC_DECREMENT(addr, val) \
494 oldval = atomic_fetchadd_int(addr, -val); \
495 if (oldval < val) { \
496 panic("Counter goes negative"); \
500 #define SCTP_SAVE_ATOMIC_DECREMENT(addr, val) \
503 oldval = atomic_fetchadd_int(addr, -val); \
504 if (oldval < val) { \