1/*- 2 * SPDX-License-Identifier: BSD-3-Clause 3 * 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. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions are met: 10 * 11 * a) Redistributions of source code must retain the above copyright notice, 12 * this list of conditions and the following disclaimer. 13 * 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. 17 * 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. 21 * 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. 33 */ 34 35#include <sys/cdefs.h> 36__FBSDID("$FreeBSD$"); 37 38#ifndef _NETINET_SCTP_OS_BSD_H_ 39#define _NETINET_SCTP_OS_BSD_H_ 40/* 41 * includes 42 */ 43#include "opt_inet6.h" 44#include "opt_inet.h" 45#include "opt_sctp.h" 46 47#include <sys/param.h> 48#include <sys/domain.h> 49#include <sys/eventhandler.h> 50#include <sys/ktr.h> 51#include <sys/systm.h> 52#include <sys/malloc.h> 53#include <sys/module.h> 54#include <sys/kernel.h> 55#include <sys/sysctl.h> 56#include <sys/mbuf.h> 57#include <sys/protosw.h> 58#include <sys/socket.h> 59#include <sys/socketvar.h> 60#include <sys/jail.h> 61#include <sys/sysctl.h> 62#include <sys/resourcevar.h> 63#include <sys/uio.h> 64#include <sys/lock.h> 65#include <sys/rwlock.h> 66#include <sys/kthread.h> 67#include <sys/priv.h> 68#include <sys/random.h> 69#include <sys/limits.h> 70#include <sys/queue.h> 71#include <machine/cpu.h> 72 73#include <net/if.h> 74#include <net/if_types.h> 75#include <net/if_var.h> 76#include <net/route.h> 77#include <net/route/nhop.h> 78#include <net/vnet.h> 79 80#include <netinet/in.h> 81#include <netinet/in_systm.h> 82#include <netinet/ip.h> 83#include <netinet/in_fib.h> 84#include <netinet/in_pcb.h> 85#include <netinet/in_var.h> 86#include <netinet/ip_var.h> 87#include <netinet/ip_icmp.h> 88#include <netinet/icmp_var.h> 89 90#ifdef INET6 91#include <netinet/ip6.h> 92#include <netinet6/in6_fib.h> 93#include <netinet6/ip6_var.h> 94#include <netinet6/in6_pcb.h> 95#include <netinet6/ip6protosw.h> 96#include <netinet6/nd6.h> 97#include <netinet6/scope6_var.h> 98#endif /* INET6 */ 99 100#include <netinet/ip_options.h> 101 102#include <crypto/sha1.h> 103#include <crypto/sha2/sha256.h> 104 105/* Declare all the malloc names for all the various mallocs */ 106MALLOC_DECLARE(SCTP_M_MAP); 107MALLOC_DECLARE(SCTP_M_STRMI); 108MALLOC_DECLARE(SCTP_M_STRMO); 109MALLOC_DECLARE(SCTP_M_ASC_ADDR); 110MALLOC_DECLARE(SCTP_M_ASC_IT); 111MALLOC_DECLARE(SCTP_M_AUTH_CL); 112MALLOC_DECLARE(SCTP_M_AUTH_KY); 113MALLOC_DECLARE(SCTP_M_AUTH_HL); 114MALLOC_DECLARE(SCTP_M_AUTH_IF); 115MALLOC_DECLARE(SCTP_M_STRESET); 116MALLOC_DECLARE(SCTP_M_CMSG); 117MALLOC_DECLARE(SCTP_M_COPYAL); 118MALLOC_DECLARE(SCTP_M_VRF); 119MALLOC_DECLARE(SCTP_M_IFA); 120MALLOC_DECLARE(SCTP_M_IFN); 121MALLOC_DECLARE(SCTP_M_TIMW); 122MALLOC_DECLARE(SCTP_M_MVRF); 123MALLOC_DECLARE(SCTP_M_ITER); 124MALLOC_DECLARE(SCTP_M_SOCKOPT); 125MALLOC_DECLARE(SCTP_M_MCORE); 126 127#if defined(SCTP_LOCAL_TRACE_BUF) 128 129#define SCTP_GET_CYCLECOUNT get_cyclecount() 130#define SCTP_CTR6 sctp_log_trace 131 132#else 133#define SCTP_CTR6 CTR6 134#endif 135 136/* 137 * Macros to expand out globals defined by various modules 138 * to either a real global or a virtualized instance of one, 139 * depending on whether VIMAGE is defined. 140 */ 141/* then define the macro(s) that hook into the vimage macros */ 142#define MODULE_GLOBAL(__SYMBOL) V_##__SYMBOL 143 144#define V_system_base_info VNET(system_base_info) 145#define SCTP_BASE_INFO(__m) V_system_base_info.sctppcbinfo.__m 146#define SCTP_BASE_STATS V_system_base_info.sctpstat 147#define SCTP_BASE_STAT(__m) V_system_base_info.sctpstat.__m 148#define SCTP_BASE_SYSCTL(__m) V_system_base_info.sctpsysctl.__m 149#define SCTP_BASE_VAR(__m) V_system_base_info.__m 150 151#define SCTP_PRINTF(params...) printf(params) 152#if defined(SCTP_DEBUG) 153#define SCTPDBG(level, params...) \ 154{ \ 155 do { \ 156 if (SCTP_BASE_SYSCTL(sctp_debug_on) & level ) { \ 157 SCTP_PRINTF(params); \ 158 } \ 159 } while (0); \ 160} 161#define SCTPDBG_ADDR(level, addr) \ 162{ \ 163 do { \ 164 if (SCTP_BASE_SYSCTL(sctp_debug_on) & level ) { \ 165 sctp_print_address(addr); \ 166 } \ 167 } while (0); \ 168} 169#else 170#define SCTPDBG(level, params...) 171#define SCTPDBG_ADDR(level, addr) 172#endif 173 174#ifdef SCTP_LTRACE_CHUNKS 175#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) 176#else 177#define SCTP_LTRACE_CHK(a, b, c, d) 178#endif 179 180#ifdef SCTP_LTRACE_ERRORS 181#define SCTP_LTRACE_ERR_RET_PKT(m, inp, stcb, net, file, err) \ 182 if (SCTP_BASE_SYSCTL(sctp_logging_level) & SCTP_LTRACE_ERROR_ENABLE) \ 183 SCTP_PRINTF("mbuf:%p inp:%p stcb:%p net:%p file:%x line:%d error:%d\n", \ 184 m, inp, stcb, net, file, __LINE__, err); 185#define SCTP_LTRACE_ERR_RET(inp, stcb, net, file, err) \ 186 if (SCTP_BASE_SYSCTL(sctp_logging_level) & SCTP_LTRACE_ERROR_ENABLE) \ 187 SCTP_PRINTF("inp:%p stcb:%p net:%p file:%x line:%d error:%d\n", \ 188 inp, stcb, net, file, __LINE__, err); 189#else 190#define SCTP_LTRACE_ERR_RET_PKT(m, inp, stcb, net, file, err) 191#define SCTP_LTRACE_ERR_RET(inp, stcb, net, file, err) 192#endif 193 194/* 195 * Local address and interface list handling 196 */ 197#define SCTP_MAX_VRF_ID 0 198#define SCTP_SIZE_OF_VRF_HASH 3 199#define SCTP_IFNAMSIZ IFNAMSIZ 200#define SCTP_DEFAULT_VRFID 0 201#define SCTP_VRF_ADDR_HASH_SIZE 16 202#define SCTP_VRF_IFN_HASH_SIZE 3 203#define SCTP_INIT_VRF_TABLEID(vrf) 204 205#define SCTP_IFN_IS_IFT_LOOP(ifn) ((ifn)->ifn_type == IFT_LOOP) 206#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) 207 208/* 209 * Access to IFN's to help with src-addr-selection 210 */ 211/* This could return VOID if the index works but for BSD we provide both. */ 212#define SCTP_GET_IFN_VOID_FROM_ROUTE(ro) (void *)ro->ro_nh->nh_ifp 213#define SCTP_GET_IF_INDEX_FROM_ROUTE(ro) (ro)->ro_nh->nh_ifp->if_index 214#define SCTP_ROUTE_HAS_VALID_IFN(ro) ((ro)->ro_nh && (ro)->ro_nh->nh_ifp) 215 216/* 217 * general memory allocation 218 */ 219#define SCTP_MALLOC(var, type, size, name) \ 220 do { \ 221 var = (type)malloc(size, name, M_NOWAIT); \ 222 } while (0) 223 224#define SCTP_FREE(var, type) free(var, type) 225 226#define SCTP_MALLOC_SONAME(var, type, size) \ 227 do { \ 228 var = (type)malloc(size, M_SONAME, M_WAITOK | M_ZERO); \ 229 } while (0) 230 231#define SCTP_FREE_SONAME(var) free(var, M_SONAME) 232 233#define SCTP_PROCESS_STRUCT struct proc * 234 235/* 236 * zone allocation functions 237 */ 238#include <vm/uma.h> 239 240/* SCTP_ZONE_INIT: initialize the zone */ 241typedef struct uma_zone *sctp_zone_t; 242#define SCTP_ZONE_INIT(zone, name, size, number) { \ 243 zone = uma_zcreate(name, size, NULL, NULL, NULL, NULL, UMA_ALIGN_PTR,\ 244 0); \ 245 uma_zone_set_max(zone, number); \ 246} 247 248#define SCTP_ZONE_DESTROY(zone) uma_zdestroy(zone) 249 250/* SCTP_ZONE_GET: allocate element from the zone */ 251#define SCTP_ZONE_GET(zone, type) \ 252 (type *)uma_zalloc(zone, M_NOWAIT); 253 254/* SCTP_ZONE_FREE: free element from the zone */ 255#define SCTP_ZONE_FREE(zone, element) \ 256 uma_zfree(zone, element); 257 258#define SCTP_HASH_INIT(size, hashmark) hashinit_flags(size, M_PCB, hashmark, HASH_NOWAIT) 259#define SCTP_HASH_FREE(table, hashmark) hashdestroy(table, M_PCB, hashmark) 260 261#define SCTP_M_COPYM m_copym 262 263/* 264 * timers 265 */ 266#include <sys/callout.h> 267typedef struct callout sctp_os_timer_t; 268 269#define SCTP_OS_TIMER_INIT(tmr) callout_init(tmr, 1) 270/* 271 * NOTE: The next two shouldn't be called directly outside of sctp_timer_start() 272 * and sctp_timer_stop(), since they don't handle incrementing/decrementing 273 * relevant reference counts. 274 */ 275#define SCTP_OS_TIMER_START callout_reset 276#define SCTP_OS_TIMER_STOP callout_stop 277#define SCTP_OS_TIMER_STOP_DRAIN callout_drain 278#define SCTP_OS_TIMER_PENDING callout_pending 279#define SCTP_OS_TIMER_ACTIVE callout_active 280#define SCTP_OS_TIMER_DEACTIVATE callout_deactivate 281 282#define sctp_get_tick_count() (ticks) 283 284#define SCTP_UNUSED __attribute__((unused)) 285 286/* 287 * Functions 288 */ 289/* Mbuf manipulation and access macros */ 290#define SCTP_BUF_LEN(m) (m->m_len) 291#define SCTP_BUF_NEXT(m) (m->m_next) 292#define SCTP_BUF_NEXT_PKT(m) (m->m_nextpkt) 293#define SCTP_BUF_RESV_UF(m, size) m->m_data += size 294#define SCTP_BUF_AT(m, size) m->m_data + size 295#define SCTP_BUF_IS_EXTENDED(m) (m->m_flags & M_EXT) 296#define SCTP_BUF_SIZE M_SIZE 297#define SCTP_BUF_TYPE(m) (m->m_type) 298#define SCTP_BUF_RECVIF(m) (m->m_pkthdr.rcvif) 299#define SCTP_BUF_PREPEND M_PREPEND 300 301#define SCTP_ALIGN_TO_END(m, len) M_ALIGN(m, len) 302 303#define SCTP_SNPRINTF(...) snprintf(__VA_ARGS__) 304 305/* We make it so if you have up to 4 threads 306 * writing based on the default size of 307 * the packet log 65 k, that would be 308 * 4 16k packets before we would hit 309 * a problem. 310 */ 311#define SCTP_PKTLOG_WRITERS_NEED_LOCK 3 312 313/*************************/ 314/* MTU */ 315/*************************/ 316#define SCTP_GATHER_MTU_FROM_IFN_INFO(ifn, ifn_index, af) ((struct ifnet *)ifn)->if_mtu 317#define SCTP_GATHER_MTU_FROM_ROUTE(sctp_ifa, sa, nh) ((uint32_t)((nh != NULL) ? nh->nh_mtu : 0)) 318#define SCTP_GATHER_MTU_FROM_INTFC(sctp_ifn) ((sctp_ifn->ifn_p != NULL) ? ((struct ifnet *)(sctp_ifn->ifn_p))->if_mtu : 0) 319 320/*************************/ 321/* These are for logging */ 322/*************************/ 323/* return the base ext data pointer */ 324#define SCTP_BUF_EXTEND_BASE(m) (m->m_ext.ext_buf) 325 /* return the refcnt of the data pointer */ 326#define SCTP_BUF_EXTEND_REFCNT(m) (*m->m_ext.ext_cnt) 327/* return any buffer related flags, this is 328 * used beyond logging for apple only. 329 */ 330#define SCTP_BUF_GET_FLAGS(m) (m->m_flags) 331 332/* For BSD this just accesses the M_PKTHDR length 333 * so it operates on an mbuf with hdr flag. Other 334 * O/S's may have separate packet header and mbuf 335 * chain pointers.. thus the macro. 336 */ 337#define SCTP_HEADER_TO_CHAIN(m) (m) 338#define SCTP_DETACH_HEADER_FROM_CHAIN(m) 339#define SCTP_HEADER_LEN(m) ((m)->m_pkthdr.len) 340#define SCTP_GET_HEADER_FOR_OUTPUT(o_pak) 0 341#define SCTP_RELEASE_HEADER(m) 342#define SCTP_RELEASE_PKT(m) sctp_m_freem(m) 343#define SCTP_ENABLE_UDP_CSUM(m) do { \ 344 m->m_pkthdr.csum_flags = CSUM_UDP; \ 345 m->m_pkthdr.csum_data = offsetof(struct udphdr, uh_sum); \ 346 } while (0) 347 348#define SCTP_GET_PKT_VRFID(m, vrf_id) ((vrf_id = SCTP_DEFAULT_VRFID) != SCTP_DEFAULT_VRFID) 349 350/* Attach the chain of data into the sendable packet. */ 351#define SCTP_ATTACH_CHAIN(pak, m, packet_length) do { \ 352 pak = m; \ 353 pak->m_pkthdr.len = packet_length; \ 354 } while(0) 355 356/* Other m_pkthdr type things */ 357#define SCTP_IS_IT_BROADCAST(dst, m) ((m->m_flags & M_PKTHDR) ? in_broadcast(dst, m->m_pkthdr.rcvif) : 0) 358#define SCTP_IS_IT_LOOPBACK(m) ((m->m_flags & M_PKTHDR) && ((m->m_pkthdr.rcvif == NULL) || (m->m_pkthdr.rcvif->if_type == IFT_LOOP))) 359 360/* This converts any input packet header 361 * into the chain of data holders, for BSD 362 * its a NOP. 363 */ 364 365/* get the v6 hop limit */ 366#define SCTP_GET_HLIM(inp, ro) in6_selecthlim(&inp->ip_inp.inp, (ro ? (ro->ro_nh ? (ro->ro_nh->nh_ifp) : (NULL)) : (NULL))); 367 368/* is the endpoint v6only? */ 369#define SCTP_IPV6_V6ONLY(sctp_inpcb) ((sctp_inpcb)->ip_inp.inp.inp_flags & IN6P_IPV6_V6ONLY) 370/* is the socket non-blocking? */ 371#define SCTP_SO_IS_NBIO(so) ((so)->so_state & SS_NBIO) 372#define SCTP_SET_SO_NBIO(so) ((so)->so_state |= SS_NBIO) 373#define SCTP_CLEAR_SO_NBIO(so) ((so)->so_state &= ~SS_NBIO) 374/* get the socket type */ 375#define SCTP_SO_TYPE(so) ((so)->so_type) 376/* Use a macro for renaming sb_cc to sb_acc. 377 * Initially sb_ccc was used, but this broke select() when used 378 * with SCTP sockets. 379 */ 380#define sb_cc sb_acc 381/* reserve sb space for a socket */ 382#define SCTP_SORESERVE(so, send, recv) soreserve(so, send, recv) 383/* wakeup a socket */ 384#define SCTP_SOWAKEUP(so) wakeup(&(so)->so_timeo) 385/* clear the socket buffer state */ 386#define SCTP_SB_CLEAR(sb) \ 387 (sb).sb_cc = 0; \ 388 (sb).sb_mb = NULL; \ 389 (sb).sb_mbcnt = 0; 390 391#define SCTP_SB_LIMIT_RCV(so) (SOLISTENING(so) ? so->sol_sbrcv_hiwat : so->so_rcv.sb_hiwat) 392#define SCTP_SB_LIMIT_SND(so) (SOLISTENING(so) ? so->sol_sbsnd_hiwat : so->so_snd.sb_hiwat) 393 394/* 395 * routes, output, etc. 396 */ 397typedef struct route sctp_route_t; 398 399#define SCTP_RTALLOC(ro, vrf_id, fibnum) \ 400{ \ 401 if ((ro)->ro_nh == NULL) { \ 402 (ro)->ro_nh = rib_lookup(fibnum, &(ro)->ro_dst, NHR_REF, 0); \ 403 } \ 404} 405 406/* 407 * SCTP protocol specific mbuf flags. 408 */ 409#define M_NOTIFICATION M_PROTO1 /* SCTP notification */ 410 411/* 412 * IP output routines 413 */ 414#define SCTP_IP_OUTPUT(result, o_pak, ro, stcb, vrf_id) \ 415{ \ 416 int o_flgs = IP_RAWOUTPUT; \ 417 struct sctp_tcb *local_stcb = stcb; \ 418 if (local_stcb && \ 419 local_stcb->sctp_ep && \ 420 local_stcb->sctp_ep->sctp_socket) \ 421 o_flgs |= local_stcb->sctp_ep->sctp_socket->so_options & SO_DONTROUTE; \ 422 m_clrprotoflags(o_pak); \ 423 result = ip_output(o_pak, NULL, ro, o_flgs, 0, NULL); \ 424} 425 426#define SCTP_IP6_OUTPUT(result, o_pak, ro, ifp, stcb, vrf_id) \ 427{ \ 428 struct sctp_tcb *local_stcb = stcb; \ 429 m_clrprotoflags(o_pak); \ 430 if (local_stcb && local_stcb->sctp_ep) \ 431 result = ip6_output(o_pak, \ 432 ((struct inpcb *)(local_stcb->sctp_ep))->in6p_outputopts, \ 433 (ro), 0, 0, ifp, NULL); \ 434 else \ 435 result = ip6_output(o_pak, NULL, (ro), 0, 0, ifp, NULL); \ 436} 437 438struct mbuf * 439sctp_get_mbuf_for_msg(unsigned int space_needed, 440 int want_header, int how, int allonebuf, int type); 441 442/* 443 * SCTP AUTH 444 */ 445#define SCTP_READ_RANDOM(buf, len) arc4rand(buf, len, 0) 446 447/* map standard crypto API names */ 448#define SCTP_SHA1_CTX SHA1_CTX 449#define SCTP_SHA1_INIT SHA1Init 450#define SCTP_SHA1_UPDATE SHA1Update 451#define SCTP_SHA1_FINAL(x,y) SHA1Final((caddr_t)x, y) 452 453#define SCTP_SHA256_CTX SHA256_CTX 454#define SCTP_SHA256_INIT SHA256_Init 455#define SCTP_SHA256_UPDATE SHA256_Update 456#define SCTP_SHA256_FINAL(x,y) SHA256_Final((caddr_t)x, y) 457 458#define SCTP_DECREMENT_AND_CHECK_REFCOUNT(addr) (atomic_fetchadd_int(addr, -1) == 1) 459#if defined(INVARIANTS) 460#define SCTP_SAVE_ATOMIC_DECREMENT(addr, val) \ 461{ \ 462 int32_t oldval; \ 463 oldval = atomic_fetchadd_int(addr, -val); \ 464 if (oldval < val) { \ 465 panic("Counter goes negative"); \ 466 } \ 467} 468#else 469#define SCTP_SAVE_ATOMIC_DECREMENT(addr, val) \ 470{ \ 471 int32_t oldval; \ 472 oldval = atomic_fetchadd_int(addr, -val); \ 473 if (oldval < val) { \ 474 *addr = 0; \ 475 } \ 476} 477#endif 478 479#define SCTP_IS_LISTENING(inp) ((inp->sctp_flags & SCTP_PCB_FLAGS_ACCEPTING) != 0) 480 481int sctp_syscalls_init(void); 482int sctp_syscalls_uninit(void); 483 484#endif 485