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