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