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