2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 2006-2007, by Cisco Systems, Inc. All rights reserved.
5 * Copyright (c) 2008-2012, by Randall Stewart. All rights reserved.
6 * Copyright (c) 2008-2012, by Michael Tuexen. All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are met:
11 * a) Redistributions of source code must retain the above copyright notice,
12 * this list of conditions and the following disclaimer.
14 * b) Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in
16 * the documentation and/or other materials provided with the distribution.
18 * c) Neither the name of Cisco Systems, Inc. nor the names of its
19 * contributors may be used to endorse or promote products derived
20 * from this software without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
24 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
26 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
27 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
28 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
30 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
31 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
32 * THE POSSIBILITY OF SUCH DAMAGE.
35 #include <sys/cdefs.h>
36 __FBSDID("$FreeBSD$");
38 #ifndef _NETINET_SCTP_OS_BSD_H_
39 #define _NETINET_SCTP_OS_BSD_H_
43 #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>
74 #include <net/route/nhop.h>
77 #include <netinet/in.h>
78 #include <netinet/in_systm.h>
79 #include <netinet/ip.h>
80 #include <netinet/in_fib.h>
81 #include <netinet/in_pcb.h>
82 #include <netinet/in_var.h>
83 #include <netinet/ip_var.h>
84 #include <netinet/ip_icmp.h>
85 #include <netinet/icmp_var.h>
88 #include <sys/domain.h>
89 #include <netinet/ip6.h>
90 #include <netinet6/in6_fib.h>
91 #include <netinet6/ip6_var.h>
92 #include <netinet6/in6_pcb.h>
93 #include <netinet6/ip6protosw.h>
94 #include <netinet6/nd6.h>
95 #include <netinet6/scope6_var.h>
98 #include <netinet/ip_options.h>
100 #include <crypto/sha1.h>
101 #include <crypto/sha2/sha256.h>
103 /* Declare all the malloc names for all the various mallocs */
104 MALLOC_DECLARE(SCTP_M_MAP);
105 MALLOC_DECLARE(SCTP_M_STRMI);
106 MALLOC_DECLARE(SCTP_M_STRMO);
107 MALLOC_DECLARE(SCTP_M_ASC_ADDR);
108 MALLOC_DECLARE(SCTP_M_ASC_IT);
109 MALLOC_DECLARE(SCTP_M_AUTH_CL);
110 MALLOC_DECLARE(SCTP_M_AUTH_KY);
111 MALLOC_DECLARE(SCTP_M_AUTH_HL);
112 MALLOC_DECLARE(SCTP_M_AUTH_IF);
113 MALLOC_DECLARE(SCTP_M_STRESET);
114 MALLOC_DECLARE(SCTP_M_CMSG);
115 MALLOC_DECLARE(SCTP_M_COPYAL);
116 MALLOC_DECLARE(SCTP_M_VRF);
117 MALLOC_DECLARE(SCTP_M_IFA);
118 MALLOC_DECLARE(SCTP_M_IFN);
119 MALLOC_DECLARE(SCTP_M_TIMW);
120 MALLOC_DECLARE(SCTP_M_MVRF);
121 MALLOC_DECLARE(SCTP_M_ITER);
122 MALLOC_DECLARE(SCTP_M_SOCKOPT);
123 MALLOC_DECLARE(SCTP_M_MCORE);
125 #if defined(SCTP_LOCAL_TRACE_BUF)
127 #define SCTP_GET_CYCLECOUNT get_cyclecount()
128 #define SCTP_CTR6 sctp_log_trace
131 #define SCTP_CTR6 CTR6
135 * Macros to expand out globals defined by various modules
136 * to either a real global or a virtualized instance of one,
137 * depending on whether VIMAGE is defined.
139 /* then define the macro(s) that hook into the vimage macros */
140 #define MODULE_GLOBAL(__SYMBOL) V_##__SYMBOL
142 #define V_system_base_info VNET(system_base_info)
143 #define SCTP_BASE_INFO(__m) V_system_base_info.sctppcbinfo.__m
144 #define SCTP_BASE_STATS V_system_base_info.sctpstat
145 #define SCTP_BASE_STAT(__m) V_system_base_info.sctpstat.__m
146 #define SCTP_BASE_SYSCTL(__m) V_system_base_info.sctpsysctl.__m
147 #define SCTP_BASE_VAR(__m) V_system_base_info.__m
149 #define SCTP_PRINTF(params...) printf(params)
150 #if defined(SCTP_DEBUG)
151 #define SCTPDBG(level, params...) \
154 if (SCTP_BASE_SYSCTL(sctp_debug_on) & level ) { \
155 SCTP_PRINTF(params); \
159 #define SCTPDBG_ADDR(level, addr) \
162 if (SCTP_BASE_SYSCTL(sctp_debug_on) & level ) { \
163 sctp_print_address(addr); \
168 #define SCTPDBG(level, params...)
169 #define SCTPDBG_ADDR(level, addr)
172 #ifdef SCTP_LTRACE_CHUNKS
173 #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)
175 #define SCTP_LTRACE_CHK(a, b, c, d)
178 #ifdef SCTP_LTRACE_ERRORS
179 #define SCTP_LTRACE_ERR_RET_PKT(m, inp, stcb, net, file, err) \
180 if (SCTP_BASE_SYSCTL(sctp_logging_level) & SCTP_LTRACE_ERROR_ENABLE) \
181 SCTP_PRINTF("mbuf:%p inp:%p stcb:%p net:%p file:%x line:%d error:%d\n", \
182 m, inp, stcb, net, file, __LINE__, err);
183 #define SCTP_LTRACE_ERR_RET(inp, stcb, net, file, err) \
184 if (SCTP_BASE_SYSCTL(sctp_logging_level) & SCTP_LTRACE_ERROR_ENABLE) \
185 SCTP_PRINTF("inp:%p stcb:%p net:%p file:%x line:%d error:%d\n", \
186 inp, stcb, net, file, __LINE__, err);
188 #define SCTP_LTRACE_ERR_RET_PKT(m, inp, stcb, net, file, err)
189 #define SCTP_LTRACE_ERR_RET(inp, stcb, net, file, err)
194 * Local address and interface list handling
196 #define SCTP_MAX_VRF_ID 0
197 #define SCTP_SIZE_OF_VRF_HASH 3
198 #define SCTP_IFNAMSIZ IFNAMSIZ
199 #define SCTP_DEFAULT_VRFID 0
200 #define SCTP_VRF_ADDR_HASH_SIZE 16
201 #define SCTP_VRF_IFN_HASH_SIZE 3
202 #define SCTP_INIT_VRF_TABLEID(vrf)
204 #define SCTP_IFN_IS_IFT_LOOP(ifn) ((ifn)->ifn_type == IFT_LOOP)
205 #define SCTP_ROUTE_IS_REAL_LOOP(ro) ((ro)->ro_nh && (ro)->ro_nh->nh_ifa && (ro)->ro_nh->nh_ifa->ifa_ifp && (ro)->ro_nh->nh_ifa->ifa_ifp->if_type == IFT_LOOP)
208 * Access to IFN's to help with src-addr-selection
210 /* This could return VOID if the index works but for BSD we provide both. */
211 #define SCTP_GET_IFN_VOID_FROM_ROUTE(ro) (void *)ro->ro_nh->nh_ifp
212 #define SCTP_GET_IF_INDEX_FROM_ROUTE(ro) (ro)->ro_nh->nh_ifp->if_index
213 #define SCTP_ROUTE_HAS_VALID_IFN(ro) ((ro)->ro_nh && (ro)->ro_nh->nh_ifp)
216 * general memory allocation
218 #define SCTP_MALLOC(var, type, size, name) \
220 var = (type)malloc(size, name, M_NOWAIT); \
223 #define SCTP_FREE(var, type) free(var, type)
225 #define SCTP_MALLOC_SONAME(var, type, size) \
227 var = (type)malloc(size, M_SONAME, M_WAITOK | M_ZERO); \
230 #define SCTP_FREE_SONAME(var) free(var, M_SONAME)
232 #define SCTP_PROCESS_STRUCT struct proc *
235 * zone allocation functions
239 /* SCTP_ZONE_INIT: initialize the zone */
240 typedef struct uma_zone *sctp_zone_t;
241 #define SCTP_ZONE_INIT(zone, name, size, number) { \
242 zone = uma_zcreate(name, size, NULL, NULL, NULL, NULL, UMA_ALIGN_PTR,\
244 uma_zone_set_max(zone, number); \
247 #define SCTP_ZONE_DESTROY(zone) uma_zdestroy(zone)
249 /* SCTP_ZONE_GET: allocate element from the zone */
250 #define SCTP_ZONE_GET(zone, type) \
251 (type *)uma_zalloc(zone, M_NOWAIT);
253 /* SCTP_ZONE_FREE: free element from the zone */
254 #define SCTP_ZONE_FREE(zone, element) \
255 uma_zfree(zone, element);
257 #define SCTP_HASH_INIT(size, hashmark) hashinit_flags(size, M_PCB, hashmark, HASH_NOWAIT)
258 #define SCTP_HASH_FREE(table, hashmark) hashdestroy(table, M_PCB, hashmark)
260 #define SCTP_M_COPYM m_copym
265 #include <sys/callout.h>
266 typedef struct callout sctp_os_timer_t;
269 #define SCTP_OS_TIMER_INIT(tmr) callout_init(tmr, 1)
270 #define SCTP_OS_TIMER_START callout_reset
271 #define SCTP_OS_TIMER_STOP callout_stop
272 #define SCTP_OS_TIMER_STOP_DRAIN callout_drain
273 #define SCTP_OS_TIMER_PENDING callout_pending
274 #define SCTP_OS_TIMER_ACTIVE callout_active
275 #define SCTP_OS_TIMER_DEACTIVATE callout_deactivate
277 #define sctp_get_tick_count() (ticks)
279 #define SCTP_UNUSED __attribute__((unused))
284 /* Mbuf manipulation and access macros */
285 #define SCTP_BUF_LEN(m) (m->m_len)
286 #define SCTP_BUF_NEXT(m) (m->m_next)
287 #define SCTP_BUF_NEXT_PKT(m) (m->m_nextpkt)
288 #define SCTP_BUF_RESV_UF(m, size) m->m_data += size
289 #define SCTP_BUF_AT(m, size) m->m_data + size
290 #define SCTP_BUF_IS_EXTENDED(m) (m->m_flags & M_EXT)
291 #define SCTP_BUF_SIZE M_SIZE
292 #define SCTP_BUF_TYPE(m) (m->m_type)
293 #define SCTP_BUF_RECVIF(m) (m->m_pkthdr.rcvif)
294 #define SCTP_BUF_PREPEND M_PREPEND
296 #define SCTP_ALIGN_TO_END(m, len) M_ALIGN(m, len)
298 #define SCTP_SNPRINTF(...) snprintf(__VA_ARGS__)
300 /* We make it so if you have up to 4 threads
301 * writing based on the default size of
302 * the packet log 65 k, that would be
303 * 4 16k packets before we would hit
306 #define SCTP_PKTLOG_WRITERS_NEED_LOCK 3
308 /*************************/
310 /*************************/
311 #define SCTP_GATHER_MTU_FROM_IFN_INFO(ifn, ifn_index, af) ((struct ifnet *)ifn)->if_mtu
312 #define SCTP_GATHER_MTU_FROM_ROUTE(sctp_ifa, sa, nh) ((uint32_t)((nh != NULL) ? nh->nh_mtu : 0))
313 #define SCTP_GATHER_MTU_FROM_INTFC(sctp_ifn) ((sctp_ifn->ifn_p != NULL) ? ((struct ifnet *)(sctp_ifn->ifn_p))->if_mtu : 0)
315 /*************************/
316 /* These are for logging */
317 /*************************/
318 /* return the base ext data pointer */
319 #define SCTP_BUF_EXTEND_BASE(m) (m->m_ext.ext_buf)
320 /* return the refcnt of the data pointer */
321 #define SCTP_BUF_EXTEND_REFCNT(m) (*m->m_ext.ext_cnt)
322 /* return any buffer related flags, this is
323 * used beyond logging for apple only.
325 #define SCTP_BUF_GET_FLAGS(m) (m->m_flags)
327 /* For BSD this just accesses the M_PKTHDR length
328 * so it operates on an mbuf with hdr flag. Other
329 * O/S's may have separate packet header and mbuf
330 * chain pointers.. thus the macro.
332 #define SCTP_HEADER_TO_CHAIN(m) (m)
333 #define SCTP_DETACH_HEADER_FROM_CHAIN(m)
334 #define SCTP_HEADER_LEN(m) ((m)->m_pkthdr.len)
335 #define SCTP_GET_HEADER_FOR_OUTPUT(o_pak) 0
336 #define SCTP_RELEASE_HEADER(m)
337 #define SCTP_RELEASE_PKT(m) sctp_m_freem(m)
338 #define SCTP_ENABLE_UDP_CSUM(m) do { \
339 m->m_pkthdr.csum_flags = CSUM_UDP; \
340 m->m_pkthdr.csum_data = offsetof(struct udphdr, uh_sum); \
343 #define SCTP_GET_PKT_VRFID(m, vrf_id) ((vrf_id = SCTP_DEFAULT_VRFID) != SCTP_DEFAULT_VRFID)
347 /* Attach the chain of data into the sendable packet. */
348 #define SCTP_ATTACH_CHAIN(pak, m, packet_length) do { \
350 pak->m_pkthdr.len = packet_length; \
353 /* Other m_pkthdr type things */
354 #define SCTP_IS_IT_BROADCAST(dst, m) ((m->m_flags & M_PKTHDR) ? in_broadcast(dst, m->m_pkthdr.rcvif) : 0)
355 #define SCTP_IS_IT_LOOPBACK(m) ((m->m_flags & M_PKTHDR) && ((m->m_pkthdr.rcvif == NULL) || (m->m_pkthdr.rcvif->if_type == IFT_LOOP)))
358 /* This converts any input packet header
359 * into the chain of data holders, for BSD
363 /* get the v6 hop limit */
364 #define SCTP_GET_HLIM(inp, ro) in6_selecthlim(&inp->ip_inp.inp, (ro ? (ro->ro_nh ? (ro->ro_nh->nh_ifp) : (NULL)) : (NULL)));
366 /* is the endpoint v6only? */
367 #define SCTP_IPV6_V6ONLY(sctp_inpcb) ((sctp_inpcb)->ip_inp.inp.inp_flags & IN6P_IPV6_V6ONLY)
368 /* is the socket non-blocking? */
369 #define SCTP_SO_IS_NBIO(so) ((so)->so_state & SS_NBIO)
370 #define SCTP_SET_SO_NBIO(so) ((so)->so_state |= SS_NBIO)
371 #define SCTP_CLEAR_SO_NBIO(so) ((so)->so_state &= ~SS_NBIO)
372 /* get the socket type */
373 #define SCTP_SO_TYPE(so) ((so)->so_type)
374 /* Use a macro for renaming sb_cc to sb_acc.
375 * Initially sb_ccc was used, but this broke select() when used
379 /* reserve sb space for a socket */
380 #define SCTP_SORESERVE(so, send, recv) soreserve(so, send, recv)
381 /* wakeup a socket */
382 #define SCTP_SOWAKEUP(so) wakeup(&(so)->so_timeo)
383 /* clear the socket buffer state */
384 #define SCTP_SB_CLEAR(sb) \
389 #define SCTP_SB_LIMIT_RCV(so) (SOLISTENING(so) ? so->sol_sbrcv_hiwat : so->so_rcv.sb_hiwat)
390 #define SCTP_SB_LIMIT_SND(so) (SOLISTENING(so) ? so->sol_sbsnd_hiwat : so->so_snd.sb_hiwat)
393 * routes, output, etc.
395 typedef struct route sctp_route_t;
397 #define SCTP_RTALLOC(ro, vrf_id, fibnum) \
399 if ((ro)->ro_nh == NULL) { \
400 (ro)->ro_nh = rib_lookup(fibnum, &(ro)->ro_dst, NHR_REF, 0); \
405 * SCTP protocol specific mbuf flags.
407 #define M_NOTIFICATION M_PROTO1 /* SCTP notification */
412 #define SCTP_IP_OUTPUT(result, o_pak, ro, stcb, vrf_id) \
414 int o_flgs = IP_RAWOUTPUT; \
415 struct sctp_tcb *local_stcb = stcb; \
417 local_stcb->sctp_ep && \
418 local_stcb->sctp_ep->sctp_socket) \
419 o_flgs |= local_stcb->sctp_ep->sctp_socket->so_options & SO_DONTROUTE; \
420 m_clrprotoflags(o_pak); \
421 result = ip_output(o_pak, NULL, ro, o_flgs, 0, NULL); \
424 #define SCTP_IP6_OUTPUT(result, o_pak, ro, ifp, stcb, vrf_id) \
426 struct sctp_tcb *local_stcb = stcb; \
427 m_clrprotoflags(o_pak); \
428 if (local_stcb && local_stcb->sctp_ep) \
429 result = ip6_output(o_pak, \
430 ((struct inpcb *)(local_stcb->sctp_ep))->in6p_outputopts, \
431 (ro), 0, 0, ifp, NULL); \
433 result = ip6_output(o_pak, NULL, (ro), 0, 0, ifp, NULL); \
437 sctp_get_mbuf_for_msg(unsigned int space_needed,
438 int want_header, int how, int allonebuf, int type);
444 #define SCTP_READ_RANDOM(buf, len) arc4rand(buf, len, 0)
446 /* map standard crypto API names */
447 #define SCTP_SHA1_CTX SHA1_CTX
448 #define SCTP_SHA1_INIT SHA1Init
449 #define SCTP_SHA1_UPDATE SHA1Update
450 #define SCTP_SHA1_FINAL(x,y) SHA1Final((caddr_t)x, y)
452 #define SCTP_SHA256_CTX SHA256_CTX
453 #define SCTP_SHA256_INIT SHA256_Init
454 #define SCTP_SHA256_UPDATE SHA256_Update
455 #define SCTP_SHA256_FINAL(x,y) SHA256_Final((caddr_t)x, y)
457 #define SCTP_DECREMENT_AND_CHECK_REFCOUNT(addr) (atomic_fetchadd_int(addr, -1) == 1)
458 #if defined(INVARIANTS)
459 #define SCTP_SAVE_ATOMIC_DECREMENT(addr, val) \
462 oldval = atomic_fetchadd_int(addr, -val); \
463 if (oldval < val) { \
464 panic("Counter goes negative"); \
468 #define SCTP_SAVE_ATOMIC_DECREMENT(addr, val) \
471 oldval = atomic_fetchadd_int(addr, -val); \
472 if (oldval < val) { \
478 #define SCTP_IS_LISTENING(inp) ((inp->sctp_flags & SCTP_PCB_FLAGS_ACCEPTING) != 0)