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