1 /*- 2 * Copyright (c) 2006-2007, by Cisco Systems, Inc. All rights reserved. 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions are met: 6 * 7 * a) Redistributions of source code must retain the above copyright notice, 8 * this list of conditions and the following disclaimer. 9 * 10 * b) Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in 12 * the documentation and/or other materials provided with the distribution. 13 * 14 * c) Neither the name of Cisco Systems, Inc. nor the names of its 15 * contributors may be used to endorse or promote products derived 16 * from this software without specific prior written permission. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 20 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 22 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 23 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 24 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 25 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 26 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 28 * THE POSSIBILITY OF SUCH DAMAGE. 29 */ 30 #include <sys/cdefs.h> 31 __FBSDID("$FreeBSD$"); 32 #ifndef __sctp_os_bsd_h__ 33 #define __sctp_os_bsd_h__ 34 /* 35 * includes 36 */ 37 #include "opt_ipsec.h" 38 #include "opt_compat.h" 39 #include "opt_inet6.h" 40 #include "opt_inet.h" 41 #include "opt_sctp.h" 42 43 #include <sys/param.h> 44 #include <sys/ktr.h> 45 #include <sys/systm.h> 46 #include <sys/malloc.h> 47 #include <sys/kernel.h> 48 #include <sys/sysctl.h> 49 #include <sys/mbuf.h> 50 #include <sys/protosw.h> 51 #include <sys/socket.h> 52 #include <sys/socketvar.h> 53 #include <sys/jail.h> 54 #include <sys/sysctl.h> 55 #include <sys/resourcevar.h> 56 #include <sys/uio.h> 57 #include <sys/lock.h> 58 #include <sys/rwlock.h> 59 #include <sys/kthread.h> 60 #include <sys/priv.h> 61 #include <sys/random.h> 62 #include <sys/limits.h> 63 #include <sys/queue.h> 64 #include <machine/cpu.h> 65 66 #include <net/if.h> 67 #include <net/if_types.h> 68 #include <net/if_var.h> 69 #include <net/route.h> 70 #include <net/vnet.h> 71 72 #include <netinet/in.h> 73 #include <netinet/in_systm.h> 74 #include <netinet/ip.h> 75 #include <netinet/in_pcb.h> 76 #include <netinet/in_var.h> 77 #include <netinet/ip_var.h> 78 #include <netinet/ip_icmp.h> 79 #include <netinet/icmp_var.h> 80 81 #ifdef IPSEC 82 #include <netipsec/ipsec.h> 83 #include <netipsec/key.h> 84 #endif /* IPSEC */ 85 86 #ifdef INET6 87 #include <sys/domain.h> 88 #ifdef IPSEC 89 #include <netipsec/ipsec6.h> 90 #endif 91 #include <netinet/ip6.h> 92 #include <netinet6/ip6_var.h> 93 #include <netinet6/in6_pcb.h> 94 #include <netinet/icmp6.h> 95 #include <netinet6/ip6protosw.h> 96 #include <netinet6/nd6.h> 97 #include <netinet6/scope6_var.h> 98 #endif /* INET6 */ 99 100 101 #include <netinet/ip_options.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 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_STATS_SYSCTL VNET_NAME(system_base_info.sctpstat) 148 #define SCTP_BASE_STAT(__m) V_system_base_info.sctpstat.__m 149 #define SCTP_BASE_SYSCTL(__m) VNET_NAME(system_base_info.sctpsysctl.__m) 150 #define SCTP_BASE_VAR(__m) V_system_base_info.__m 151 152 /* 153 * 154 */ 155 #define USER_ADDR_NULL (NULL) /* FIX ME: temp */ 156 157 #if defined(SCTP_DEBUG) 158 #define SCTPDBG(level, params...) \ 159 { \ 160 do { \ 161 if (SCTP_BASE_SYSCTL(sctp_debug_on) & level ) { \ 162 printf(params); \ 163 } \ 164 } while (0); \ 165 } 166 #define SCTPDBG_ADDR(level, addr) \ 167 { \ 168 do { \ 169 if (SCTP_BASE_SYSCTL(sctp_debug_on) & level ) { \ 170 sctp_print_address(addr); \ 171 } \ 172 } while (0); \ 173 } 174 #define SCTPDBG_PKT(level, iph, sh) \ 175 { \ 176 do { \ 177 if (SCTP_BASE_SYSCTL(sctp_debug_on) & level) { \ 178 sctp_print_address_pkt(iph, sh); \ 179 } \ 180 } while (0); \ 181 } 182 #else 183 #define SCTPDBG(level, params...) 184 #define SCTPDBG_ADDR(level, addr) 185 #define SCTPDBG_PKT(level, iph, sh) 186 #endif 187 #define SCTP_PRINTF(params...) printf(params) 188 189 #ifdef SCTP_LTRACE_CHUNKS 190 #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) 191 #else 192 #define SCTP_LTRACE_CHK(a, b, c, d) 193 #endif 194 195 #ifdef SCTP_LTRACE_ERRORS 196 #define SCTP_LTRACE_ERR_RET_PKT(m, inp, stcb, net, file, err) if(SCTP_BASE_SYSCTL(sctp_logging_level) & SCTP_LTRACE_ERROR_ENABLE) \ 197 printf("mbuf:%p inp:%p stcb:%p net:%p file:%x line:%d error:%d\n", \ 198 m, inp, stcb, net, file, __LINE__, err); 199 #define SCTP_LTRACE_ERR_RET(inp, stcb, net, file, err) if(SCTP_BASE_SYSCTL(sctp_logging_level) & SCTP_LTRACE_ERROR_ENABLE) \ 200 printf("inp:%p stcb:%p net:%p file:%x line:%d error:%d\n", \ 201 inp, stcb, net, file, __LINE__, err); 202 #else 203 #define SCTP_LTRACE_ERR_RET_PKT(m, inp, stcb, net, file, err) 204 #define SCTP_LTRACE_ERR_RET(inp, stcb, net, file, err) 205 #endif 206 207 208 /* 209 * Local address and interface list handling 210 */ 211 #define SCTP_MAX_VRF_ID 0 212 #define SCTP_SIZE_OF_VRF_HASH 3 213 #define SCTP_IFNAMSIZ IFNAMSIZ 214 #define SCTP_DEFAULT_VRFID 0 215 #define SCTP_VRF_ADDR_HASH_SIZE 16 216 #define SCTP_VRF_IFN_HASH_SIZE 3 217 #define SCTP_INIT_VRF_TABLEID(vrf) 218 219 #define SCTP_IFN_IS_IFT_LOOP(ifn) ((ifn)->ifn_type == IFT_LOOP) 220 #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) 221 222 /* 223 * Access to IFN's to help with src-addr-selection 224 */ 225 /* This could return VOID if the index works but for BSD we provide both. */ 226 #define SCTP_GET_IFN_VOID_FROM_ROUTE(ro) (void *)ro->ro_rt->rt_ifp 227 #define SCTP_GET_IF_INDEX_FROM_ROUTE(ro) (ro)->ro_rt->rt_ifp->if_index 228 #define SCTP_ROUTE_HAS_VALID_IFN(ro) ((ro)->ro_rt && (ro)->ro_rt->rt_ifp) 229 230 /* 231 * general memory allocation 232 */ 233 #define SCTP_MALLOC(var, type, size, name) \ 234 do { \ 235 var = (type)malloc(size, name, M_NOWAIT); \ 236 } while (0) 237 238 #define SCTP_FREE(var, type) free(var, type) 239 240 #define SCTP_MALLOC_SONAME(var, type, size) \ 241 do { \ 242 var = (type)malloc(size, M_SONAME, M_WAITOK | M_ZERO); \ 243 } while (0) 244 245 #define SCTP_FREE_SONAME(var) free(var, M_SONAME) 246 247 #define SCTP_PROCESS_STRUCT struct proc * 248 249 /* 250 * zone allocation functions 251 */ 252 #include <vm/uma.h> 253 254 /* SCTP_ZONE_INIT: initialize the zone */ 255 typedef struct uma_zone *sctp_zone_t; 256 257 #define SCTP_ZONE_INIT(zone, name, size, number) { \ 258 zone = uma_zcreate(name, size, NULL, NULL, NULL, NULL, UMA_ALIGN_PTR,\ 259 0); \ 260 uma_zone_set_max(zone, number); \ 261 } 262 263 #define SCTP_ZONE_DESTROY(zone) uma_zdestroy(zone) 264 265 /* SCTP_ZONE_GET: allocate element from the zone */ 266 #define SCTP_ZONE_GET(zone, type) \ 267 (type *)uma_zalloc(zone, M_NOWAIT); 268 269 /* SCTP_ZONE_FREE: free element from the zone */ 270 #define SCTP_ZONE_FREE(zone, element) \ 271 uma_zfree(zone, element); 272 273 #define SCTP_HASH_INIT(size, hashmark) hashinit_flags(size, M_PCB, hashmark, HASH_NOWAIT) 274 #define SCTP_HASH_FREE(table, hashmark) hashdestroy(table, M_PCB, hashmark) 275 276 #define SCTP_M_COPYM m_copym 277 278 /* 279 * timers 280 */ 281 #include <sys/callout.h> 282 typedef struct callout sctp_os_timer_t; 283 284 285 #define SCTP_OS_TIMER_INIT(tmr) callout_init(tmr, 1) 286 #define SCTP_OS_TIMER_START callout_reset 287 #define SCTP_OS_TIMER_STOP callout_stop 288 #define SCTP_OS_TIMER_STOP_DRAIN callout_drain 289 #define SCTP_OS_TIMER_PENDING callout_pending 290 #define SCTP_OS_TIMER_ACTIVE callout_active 291 #define SCTP_OS_TIMER_DEACTIVATE callout_deactivate 292 293 #define sctp_get_tick_count() (ticks) 294 295 #define SCTP_UNUSED __attribute__((unused)) 296 297 /* 298 * Functions 299 */ 300 /* Mbuf manipulation and access macros */ 301 #define SCTP_BUF_LEN(m) (m->m_len) 302 #define SCTP_BUF_NEXT(m) (m->m_next) 303 #define SCTP_BUF_NEXT_PKT(m) (m->m_nextpkt) 304 #define SCTP_BUF_RESV_UF(m, size) m->m_data += size 305 #define SCTP_BUF_AT(m, size) m->m_data + size 306 #define SCTP_BUF_IS_EXTENDED(m) (m->m_flags & M_EXT) 307 #define SCTP_BUF_EXTEND_SIZE(m) (m->m_ext.ext_size) 308 #define SCTP_BUF_TYPE(m) (m->m_type) 309 #define SCTP_BUF_RECVIF(m) (m->m_pkthdr.rcvif) 310 #define SCTP_BUF_PREPEND M_PREPEND 311 312 #define SCTP_ALIGN_TO_END(m, len) if(m->m_flags & M_PKTHDR) { \ 313 MH_ALIGN(m, len); \ 314 } else if ((m->m_flags & M_EXT) == 0) { \ 315 M_ALIGN(m, len); \ 316 } 317 318 /* We make it so if you have up to 4 threads 319 * writting based on the default size of 320 * the packet log 65 k, that would be 321 * 4 16k packets before we would hit 322 * a problem. 323 */ 324 #define SCTP_PKTLOG_WRITERS_NEED_LOCK 3 325 326 /*************************/ 327 /* MTU */ 328 /*************************/ 329 #define SCTP_GATHER_MTU_FROM_IFN_INFO(ifn, ifn_index, af) ((struct ifnet *)ifn)->if_mtu 330 #define SCTP_GATHER_MTU_FROM_ROUTE(sctp_ifa, sa, rt) ((rt != NULL) ? rt->rt_rmx.rmx_mtu : 0) 331 #define SCTP_GATHER_MTU_FROM_INTFC(sctp_ifn) ((sctp_ifn->ifn_p != NULL) ? ((struct ifnet *)(sctp_ifn->ifn_p))->if_mtu : 0) 332 #define SCTP_SET_MTU_OF_ROUTE(sa, rt, mtu) do { \ 333 if (rt != NULL) \ 334 rt->rt_rmx.rmx_mtu = mtu; \ 335 } while(0) 336 337 /* (de-)register interface event notifications */ 338 #define SCTP_REGISTER_INTERFACE(ifhandle, af) 339 #define SCTP_DEREGISTER_INTERFACE(ifhandle, af) 340 341 342 /*************************/ 343 /* These are for logging */ 344 /*************************/ 345 /* return the base ext data pointer */ 346 #define SCTP_BUF_EXTEND_BASE(m) (m->m_ext.ext_buf) 347 /* return the refcnt of the data pointer */ 348 #define SCTP_BUF_EXTEND_REFCNT(m) (*m->m_ext.ref_cnt) 349 /* return any buffer related flags, this is 350 * used beyond logging for apple only. 351 */ 352 #define SCTP_BUF_GET_FLAGS(m) (m->m_flags) 353 354 /* For BSD this just accesses the M_PKTHDR length 355 * so it operates on an mbuf with hdr flag. Other 356 * O/S's may have seperate packet header and mbuf 357 * chain pointers.. thus the macro. 358 */ 359 #define SCTP_HEADER_TO_CHAIN(m) (m) 360 #define SCTP_DETACH_HEADER_FROM_CHAIN(m) 361 #define SCTP_HEADER_LEN(m) (m->m_pkthdr.len) 362 #define SCTP_GET_HEADER_FOR_OUTPUT(o_pak) 0 363 #define SCTP_RELEASE_HEADER(m) 364 #define SCTP_RELEASE_PKT(m) sctp_m_freem(m) 365 #define SCTP_ENABLE_UDP_CSUM(m) do { \ 366 m->m_pkthdr.csum_flags = CSUM_UDP; \ 367 m->m_pkthdr.csum_data = offsetof(struct udphdr, uh_sum); \ 368 } while (0) 369 370 #define SCTP_GET_PKT_VRFID(m, vrf_id) ((vrf_id = SCTP_DEFAULT_VRFID) != SCTP_DEFAULT_VRFID) 371 372 373 374 /* Attach the chain of data into the sendable packet. */ 375 #define SCTP_ATTACH_CHAIN(pak, m, packet_length) do { \ 376 pak = m; \ 377 pak->m_pkthdr.len = packet_length; \ 378 } while(0) 379 380 /* Other m_pkthdr type things */ 381 #define SCTP_IS_IT_BROADCAST(dst, m) ((m->m_flags & M_PKTHDR) ? in_broadcast(dst, m->m_pkthdr.rcvif) : 0) 382 #define SCTP_IS_IT_LOOPBACK(m) ((m->m_flags & M_PKTHDR) && ((m->m_pkthdr.rcvif == NULL) || (m->m_pkthdr.rcvif->if_type == IFT_LOOP))) 383 384 385 /* This converts any input packet header 386 * into the chain of data holders, for BSD 387 * its a NOP. 388 */ 389 390 /* Macro's for getting length from V6/V4 header */ 391 #define SCTP_GET_IPV4_LENGTH(iph) (iph->ip_len) 392 #define SCTP_GET_IPV6_LENGTH(ip6) (ntohs(ip6->ip6_plen)) 393 394 /* get the v6 hop limit */ 395 #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))); 396 397 /* is the endpoint v6only? */ 398 #define SCTP_IPV6_V6ONLY(inp) (((struct inpcb *)inp)->inp_flags & IN6P_IPV6_V6ONLY) 399 /* is the socket non-blocking? */ 400 #define SCTP_SO_IS_NBIO(so) ((so)->so_state & SS_NBIO) 401 #define SCTP_SET_SO_NBIO(so) ((so)->so_state |= SS_NBIO) 402 #define SCTP_CLEAR_SO_NBIO(so) ((so)->so_state &= ~SS_NBIO) 403 /* get the socket type */ 404 #define SCTP_SO_TYPE(so) ((so)->so_type) 405 /* reserve sb space for a socket */ 406 #define SCTP_SORESERVE(so, send, recv) soreserve(so, send, recv) 407 /* wakeup a socket */ 408 #define SCTP_SOWAKEUP(so) wakeup(&(so)->so_timeo) 409 /* clear the socket buffer state */ 410 #define SCTP_SB_CLEAR(sb) \ 411 (sb).sb_cc = 0; \ 412 (sb).sb_mb = NULL; \ 413 (sb).sb_mbcnt = 0; 414 415 #define SCTP_SB_LIMIT_RCV(so) so->so_rcv.sb_hiwat 416 #define SCTP_SB_LIMIT_SND(so) so->so_snd.sb_hiwat 417 418 /* 419 * routes, output, etc. 420 */ 421 typedef struct route sctp_route_t; 422 typedef struct rtentry sctp_rtentry_t; 423 424 #define SCTP_RTALLOC(ro, vrf_id) rtalloc_ign((struct route *)ro, 0UL) 425 426 /* Future zero copy wakeup/send function */ 427 #define SCTP_ZERO_COPY_EVENT(inp, so) 428 /* This is re-pulse ourselves for sendbuf */ 429 #define SCTP_ZERO_COPY_SENDQ_EVENT(inp, so) 430 431 /* 432 * IP output routines 433 */ 434 #define SCTP_IP_OUTPUT(result, o_pak, ro, stcb, vrf_id) \ 435 { \ 436 int o_flgs = 0; \ 437 if (stcb && stcb->sctp_ep && stcb->sctp_ep->sctp_socket) { \ 438 o_flgs = IP_RAWOUTPUT | (stcb->sctp_ep->sctp_socket->so_options & SO_DONTROUTE); \ 439 } else { \ 440 o_flgs = IP_RAWOUTPUT; \ 441 } \ 442 result = ip_output(o_pak, NULL, ro, o_flgs, 0, NULL); \ 443 } 444 445 #define SCTP_IP6_OUTPUT(result, o_pak, ro, ifp, stcb, vrf_id) \ 446 { \ 447 if (stcb && stcb->sctp_ep) \ 448 result = ip6_output(o_pak, \ 449 ((struct in6pcb *)(stcb->sctp_ep))->in6p_outputopts, \ 450 (ro), 0, 0, ifp, NULL); \ 451 else \ 452 result = ip6_output(o_pak, NULL, (ro), 0, 0, ifp, NULL); \ 453 } 454 455 struct mbuf * 456 sctp_get_mbuf_for_msg(unsigned int space_needed, 457 int want_header, int how, int allonebuf, int type); 458 459 460 /* 461 * SCTP AUTH 462 */ 463 #define HAVE_SHA2 464 465 #define SCTP_READ_RANDOM(buf, len) read_random(buf, len) 466 467 #ifdef USE_SCTP_SHA1 468 #include <netinet/sctp_sha1.h> 469 #else 470 #include <crypto/sha1.h> 471 /* map standard crypto API names */ 472 #define SHA1_Init SHA1Init 473 #define SHA1_Update SHA1Update 474 #define SHA1_Final(x,y) SHA1Final((caddr_t)x, y) 475 #endif 476 477 #if defined(HAVE_SHA2) 478 #include <crypto/sha2/sha2.h> 479 #endif 480 481 #endif 482 483 #define SCTP_DECREMENT_AND_CHECK_REFCOUNT(addr) (atomic_fetchadd_int(addr, -1) == 1) 484 #if defined(INVARIANTS) 485 #define SCTP_SAVE_ATOMIC_DECREMENT(addr, val) \ 486 { \ 487 int32_t oldval; \ 488 oldval = atomic_fetchadd_int(addr, -val); \ 489 if (oldval < val) { \ 490 panic("Counter goes negative"); \ 491 } \ 492 } 493 #else 494 #define SCTP_SAVE_ATOMIC_DECREMENT(addr, val) \ 495 { \ 496 int32_t oldval; \ 497 oldval = atomic_fetchadd_int(addr, -val); \ 498 if (oldval < val) { \ 499 *addr = 0; \ 500 } \ 501 } 502 #endif 503