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