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