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