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