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