sctp_os_bsd.h revision 254527
1/*- 2 * Copyright (c) 2006-2007, by Cisco Systems, Inc. All rights reserved. 3 * Copyright (c) 2008-2012, by Randall Stewart. All rights reserved. 4 * Copyright (c) 2008-2012, by Michael Tuexen. All rights reserved. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions are met: 8 * 9 * a) Redistributions of source code must retain the above copyright notice, 10 * this list of conditions and the following disclaimer. 11 * 12 * b) Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in 14 * the documentation and/or other materials provided with the distribution. 15 * 16 * c) Neither the name of Cisco Systems, Inc. nor the names of its 17 * contributors may be used to endorse or promote products derived 18 * from this software without specific prior written permission. 19 * 20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 22 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 30 * THE POSSIBILITY OF SUCH DAMAGE. 31 */ 32 33#include <sys/cdefs.h> 34__FBSDID("$FreeBSD: head/sys/netinet/sctp_os_bsd.h 254527 2013-08-19 14:25:11Z andre $"); 35 36#ifndef _NETINET_SCTP_OS_BSD_H_ 37#define _NETINET_SCTP_OS_BSD_H_ 38/* 39 * includes 40 */ 41#include "opt_ipsec.h" 42#include "opt_compat.h" 43#include "opt_inet6.h" 44#include "opt_inet.h" 45#include "opt_sctp.h" 46 47#include <sys/param.h> 48#include <sys/ktr.h> 49#include <sys/systm.h> 50#include <sys/malloc.h> 51#include <sys/kernel.h> 52#include <sys/sysctl.h> 53#include <sys/mbuf.h> 54#include <sys/protosw.h> 55#include <sys/socket.h> 56#include <sys/socketvar.h> 57#include <sys/jail.h> 58#include <sys/sysctl.h> 59#include <sys/resourcevar.h> 60#include <sys/uio.h> 61#include <sys/lock.h> 62#include <sys/rwlock.h> 63#include <sys/kthread.h> 64#include <sys/priv.h> 65#include <sys/random.h> 66#include <sys/limits.h> 67#include <sys/queue.h> 68#include <machine/cpu.h> 69 70#include <net/if.h> 71#include <net/if_types.h> 72#include <net/if_var.h> 73#include <net/route.h> 74#include <net/vnet.h> 75 76#include <netinet/in.h> 77#include <netinet/in_systm.h> 78#include <netinet/ip.h> 79#include <netinet/in_pcb.h> 80#include <netinet/in_var.h> 81#include <netinet/ip_var.h> 82#include <netinet/ip_icmp.h> 83#include <netinet/icmp_var.h> 84 85#ifdef IPSEC 86#include <netipsec/ipsec.h> 87#include <netipsec/key.h> 88#endif /* IPSEC */ 89 90#ifdef INET6 91#include <sys/domain.h> 92#ifdef IPSEC 93#include <netipsec/ipsec6.h> 94#endif 95#include <netinet/ip6.h> 96#include <netinet6/ip6_var.h> 97#include <netinet6/in6_pcb.h> 98#include <netinet/icmp6.h> 99#include <netinet6/ip6protosw.h> 100#include <netinet6/nd6.h> 101#include <netinet6/scope6_var.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 */ 111MALLOC_DECLARE(SCTP_M_MAP); 112MALLOC_DECLARE(SCTP_M_STRMI); 113MALLOC_DECLARE(SCTP_M_STRMO); 114MALLOC_DECLARE(SCTP_M_ASC_ADDR); 115MALLOC_DECLARE(SCTP_M_ASC_IT); 116MALLOC_DECLARE(SCTP_M_AUTH_CL); 117MALLOC_DECLARE(SCTP_M_AUTH_KY); 118MALLOC_DECLARE(SCTP_M_AUTH_HL); 119MALLOC_DECLARE(SCTP_M_AUTH_IF); 120MALLOC_DECLARE(SCTP_M_STRESET); 121MALLOC_DECLARE(SCTP_M_CMSG); 122MALLOC_DECLARE(SCTP_M_COPYAL); 123MALLOC_DECLARE(SCTP_M_VRF); 124MALLOC_DECLARE(SCTP_M_IFA); 125MALLOC_DECLARE(SCTP_M_IFN); 126MALLOC_DECLARE(SCTP_M_TIMW); 127MALLOC_DECLARE(SCTP_M_MVRF); 128MALLOC_DECLARE(SCTP_M_ITER); 129MALLOC_DECLARE(SCTP_M_SOCKOPT); 130MALLOC_DECLARE(SCTP_M_MCORE); 131 132#if defined(SCTP_LOCAL_TRACE_BUF) 133 134#define SCTP_GET_CYCLECOUNT get_cyclecount() 135#define SCTP_CTR6 sctp_log_trace 136 137#else 138#define SCTP_CTR6 CTR6 139#endif 140 141/* 142 * Macros to expand out globals defined by various modules 143 * to either a real global or a virtualized instance of one, 144 * depending on whether VIMAGE is defined. 145 */ 146/* then define the macro(s) that hook into the vimage macros */ 147#define MODULE_GLOBAL(__SYMBOL) V_##__SYMBOL 148 149#define V_system_base_info VNET(system_base_info) 150#define SCTP_BASE_INFO(__m) V_system_base_info.sctppcbinfo.__m 151#define SCTP_BASE_STATS V_system_base_info.sctpstat 152#define SCTP_BASE_STATS_SYSCTL VNET_NAME(system_base_info.sctpstat) 153#define SCTP_BASE_STAT(__m) V_system_base_info.sctpstat.__m 154#define SCTP_BASE_SYSCTL(__m) VNET_NAME(system_base_info.sctpsysctl.__m) 155#define SCTP_BASE_VAR(__m) V_system_base_info.__m 156 157/* 158 * 159 */ 160#define USER_ADDR_NULL (NULL) /* FIX ME: temp */ 161 162#define SCTP_PRINTF(params...) printf(params) 163#if defined(SCTP_DEBUG) 164#define SCTPDBG(level, params...) \ 165{ \ 166 do { \ 167 if (SCTP_BASE_SYSCTL(sctp_debug_on) & level ) { \ 168 SCTP_PRINTF(params); \ 169 } \ 170 } while (0); \ 171} 172#define SCTPDBG_ADDR(level, addr) \ 173{ \ 174 do { \ 175 if (SCTP_BASE_SYSCTL(sctp_debug_on) & level ) { \ 176 sctp_print_address(addr); \ 177 } \ 178 } while (0); \ 179} 180#else 181#define SCTPDBG(level, params...) 182#define SCTPDBG_ADDR(level, addr) 183#endif 184 185#ifdef SCTP_LTRACE_CHUNKS 186#define SCTP_LTRACE_CHK(a, b, c, d) if(SCTP_BASE_SYSCTL(sctp_logging_level) & SCTP_LTRACE_CHUNK_ENABLE) SCTP_CTR6(KTR_SUBSYS, "SCTP:%d[%d]:%x-%x-%x-%x", SCTP_LOG_CHUNK_PROC, 0, a, b, c, d) 187#else 188#define SCTP_LTRACE_CHK(a, b, c, d) 189#endif 190 191#ifdef SCTP_LTRACE_ERRORS 192#define SCTP_LTRACE_ERR_RET_PKT(m, inp, stcb, net, file, err) \ 193 if (SCTP_BASE_SYSCTL(sctp_logging_level) & SCTP_LTRACE_ERROR_ENABLE) \ 194 SCTP_PRINTF("mbuf:%p inp:%p stcb:%p net:%p file:%x line:%d error:%d\n", \ 195 m, inp, stcb, net, file, __LINE__, err); 196#define SCTP_LTRACE_ERR_RET(inp, stcb, net, file, err) \ 197 if (SCTP_BASE_SYSCTL(sctp_logging_level) & SCTP_LTRACE_ERROR_ENABLE) \ 198 SCTP_PRINTF("inp:%p stcb:%p net:%p file:%x line:%d error:%d\n", \ 199 inp, stcb, net, file, __LINE__, err); 200#else 201#define SCTP_LTRACE_ERR_RET_PKT(m, inp, stcb, net, file, err) 202#define SCTP_LTRACE_ERR_RET(inp, stcb, net, file, err) 203#endif 204 205 206/* 207 * Local address and interface list handling 208 */ 209#define SCTP_MAX_VRF_ID 0 210#define SCTP_SIZE_OF_VRF_HASH 3 211#define SCTP_IFNAMSIZ IFNAMSIZ 212#define SCTP_DEFAULT_VRFID 0 213#define SCTP_VRF_ADDR_HASH_SIZE 16 214#define SCTP_VRF_IFN_HASH_SIZE 3 215#define SCTP_INIT_VRF_TABLEID(vrf) 216 217#define SCTP_IFN_IS_IFT_LOOP(ifn) ((ifn)->ifn_type == IFT_LOOP) 218#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) 219 220/* 221 * Access to IFN's to help with src-addr-selection 222 */ 223/* This could return VOID if the index works but for BSD we provide both. */ 224#define SCTP_GET_IFN_VOID_FROM_ROUTE(ro) (void *)ro->ro_rt->rt_ifp 225#define SCTP_GET_IF_INDEX_FROM_ROUTE(ro) (ro)->ro_rt->rt_ifp->if_index 226#define SCTP_ROUTE_HAS_VALID_IFN(ro) ((ro)->ro_rt && (ro)->ro_rt->rt_ifp) 227 228/* 229 * general memory allocation 230 */ 231#define SCTP_MALLOC(var, type, size, name) \ 232 do { \ 233 var = (type)malloc(size, name, M_NOWAIT); \ 234 } while (0) 235 236#define SCTP_FREE(var, type) free(var, type) 237 238#define SCTP_MALLOC_SONAME(var, type, size) \ 239 do { \ 240 var = (type)malloc(size, M_SONAME, M_WAITOK | M_ZERO); \ 241 } while (0) 242 243#define SCTP_FREE_SONAME(var) free(var, M_SONAME) 244 245#define SCTP_PROCESS_STRUCT struct proc * 246 247/* 248 * zone allocation functions 249 */ 250#include <vm/uma.h> 251 252/* SCTP_ZONE_INIT: initialize the zone */ 253typedef struct uma_zone *sctp_zone_t; 254 255#define SCTP_ZONE_INIT(zone, name, size, number) { \ 256 zone = uma_zcreate(name, size, NULL, NULL, NULL, NULL, UMA_ALIGN_PTR,\ 257 0); \ 258 uma_zone_set_max(zone, number); \ 259} 260 261#define SCTP_ZONE_DESTROY(zone) uma_zdestroy(zone) 262 263/* SCTP_ZONE_GET: allocate element from the zone */ 264#define SCTP_ZONE_GET(zone, type) \ 265 (type *)uma_zalloc(zone, M_NOWAIT); 266 267/* SCTP_ZONE_FREE: free element from the zone */ 268#define SCTP_ZONE_FREE(zone, element) \ 269 uma_zfree(zone, element); 270 271#define SCTP_HASH_INIT(size, hashmark) hashinit_flags(size, M_PCB, hashmark, HASH_NOWAIT) 272#define SCTP_HASH_FREE(table, hashmark) hashdestroy(table, M_PCB, hashmark) 273 274#define SCTP_M_COPYM m_copym 275 276/* 277 * timers 278 */ 279#include <sys/callout.h> 280typedef struct callout sctp_os_timer_t; 281 282 283#define SCTP_OS_TIMER_INIT(tmr) callout_init(tmr, 1) 284#define SCTP_OS_TIMER_START callout_reset 285#define SCTP_OS_TIMER_STOP callout_stop 286#define SCTP_OS_TIMER_STOP_DRAIN callout_drain 287#define SCTP_OS_TIMER_PENDING callout_pending 288#define SCTP_OS_TIMER_ACTIVE callout_active 289#define SCTP_OS_TIMER_DEACTIVATE callout_deactivate 290 291#define sctp_get_tick_count() (ticks) 292 293#define SCTP_UNUSED __attribute__((unused)) 294 295/* 296 * Functions 297 */ 298/* Mbuf manipulation and access macros */ 299#define SCTP_BUF_LEN(m) (m->m_len) 300#define SCTP_BUF_NEXT(m) (m->m_next) 301#define SCTP_BUF_NEXT_PKT(m) (m->m_nextpkt) 302#define SCTP_BUF_RESV_UF(m, size) m->m_data += size 303#define SCTP_BUF_AT(m, size) m->m_data + size 304#define SCTP_BUF_IS_EXTENDED(m) (m->m_flags & M_EXT) 305#define SCTP_BUF_EXTEND_SIZE(m) (m->m_ext.ext_size) 306#define SCTP_BUF_TYPE(m) (m->m_type) 307#define SCTP_BUF_RECVIF(m) (m->m_pkthdr.rcvif) 308#define SCTP_BUF_PREPEND M_PREPEND 309 310#define SCTP_ALIGN_TO_END(m, len) if(m->m_flags & M_PKTHDR) { \ 311 MH_ALIGN(m, len); \ 312 } else if ((m->m_flags & M_EXT) == 0) { \ 313 M_ALIGN(m, len); \ 314 } 315 316/* We make it so if you have up to 4 threads 317 * writing based on the default size of 318 * the packet log 65 k, that would be 319 * 4 16k packets before we would hit 320 * a problem. 321 */ 322#define SCTP_PKTLOG_WRITERS_NEED_LOCK 3 323 324/*************************/ 325/* MTU */ 326/*************************/ 327#define SCTP_GATHER_MTU_FROM_IFN_INFO(ifn, ifn_index, af) ((struct ifnet *)ifn)->if_mtu 328#define SCTP_GATHER_MTU_FROM_ROUTE(sctp_ifa, sa, rt) ((rt != NULL) ? rt->rt_rmx.rmx_mtu : 0) 329#define SCTP_GATHER_MTU_FROM_INTFC(sctp_ifn) ((sctp_ifn->ifn_p != NULL) ? ((struct ifnet *)(sctp_ifn->ifn_p))->if_mtu : 0) 330#define SCTP_SET_MTU_OF_ROUTE(sa, rt, mtu) do { \ 331 if (rt != NULL) \ 332 rt->rt_rmx.rmx_mtu = mtu; \ 333 } while(0) 334 335/* (de-)register interface event notifications */ 336#define SCTP_REGISTER_INTERFACE(ifhandle, af) 337#define SCTP_DEREGISTER_INTERFACE(ifhandle, af) 338 339 340/*************************/ 341/* These are for logging */ 342/*************************/ 343/* return the base ext data pointer */ 344#define SCTP_BUF_EXTEND_BASE(m) (m->m_ext.ext_buf) 345 /* return the refcnt of the data pointer */ 346#define SCTP_BUF_EXTEND_REFCNT(m) (*m->m_ext.ref_cnt) 347/* return any buffer related flags, this is 348 * used beyond logging for apple only. 349 */ 350#define SCTP_BUF_GET_FLAGS(m) (m->m_flags) 351 352/* For BSD this just accesses the M_PKTHDR length 353 * so it operates on an mbuf with hdr flag. Other 354 * O/S's may have separate packet header and mbuf 355 * chain pointers.. thus the macro. 356 */ 357#define SCTP_HEADER_TO_CHAIN(m) (m) 358#define SCTP_DETACH_HEADER_FROM_CHAIN(m) 359#define SCTP_HEADER_LEN(m) ((m)->m_pkthdr.len) 360#define SCTP_GET_HEADER_FOR_OUTPUT(o_pak) 0 361#define SCTP_RELEASE_HEADER(m) 362#define SCTP_RELEASE_PKT(m) sctp_m_freem(m) 363#define SCTP_ENABLE_UDP_CSUM(m) do { \ 364 m->m_pkthdr.csum_flags = CSUM_UDP; \ 365 m->m_pkthdr.csum_data = offsetof(struct udphdr, uh_sum); \ 366 } while (0) 367 368#define SCTP_GET_PKT_VRFID(m, vrf_id) ((vrf_id = SCTP_DEFAULT_VRFID) != SCTP_DEFAULT_VRFID) 369 370 371 372/* Attach the chain of data into the sendable packet. */ 373#define SCTP_ATTACH_CHAIN(pak, m, packet_length) do { \ 374 pak = m; \ 375 pak->m_pkthdr.len = packet_length; \ 376 } while(0) 377 378/* Other m_pkthdr type things */ 379#define SCTP_IS_IT_BROADCAST(dst, m) ((m->m_flags & M_PKTHDR) ? in_broadcast(dst, m->m_pkthdr.rcvif) : 0) 380#define SCTP_IS_IT_LOOPBACK(m) ((m->m_flags & M_PKTHDR) && ((m->m_pkthdr.rcvif == NULL) || (m->m_pkthdr.rcvif->if_type == IFT_LOOP))) 381 382 383/* This converts any input packet header 384 * into the chain of data holders, for BSD 385 * its a NOP. 386 */ 387 388/* get the v6 hop limit */ 389#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))); 390 391/* is the endpoint v6only? */ 392#define SCTP_IPV6_V6ONLY(inp) (((struct inpcb *)inp)->inp_flags & IN6P_IPV6_V6ONLY) 393/* is the socket non-blocking? */ 394#define SCTP_SO_IS_NBIO(so) ((so)->so_state & SS_NBIO) 395#define SCTP_SET_SO_NBIO(so) ((so)->so_state |= SS_NBIO) 396#define SCTP_CLEAR_SO_NBIO(so) ((so)->so_state &= ~SS_NBIO) 397/* get the socket type */ 398#define SCTP_SO_TYPE(so) ((so)->so_type) 399/* reserve sb space for a socket */ 400#define SCTP_SORESERVE(so, send, recv) soreserve(so, send, recv) 401/* wakeup a socket */ 402#define SCTP_SOWAKEUP(so) wakeup(&(so)->so_timeo) 403/* clear the socket buffer state */ 404#define SCTP_SB_CLEAR(sb) \ 405 (sb).sb_cc = 0; \ 406 (sb).sb_mb = NULL; \ 407 (sb).sb_mbcnt = 0; 408 409#define SCTP_SB_LIMIT_RCV(so) so->so_rcv.sb_hiwat 410#define SCTP_SB_LIMIT_SND(so) so->so_snd.sb_hiwat 411 412/* 413 * routes, output, etc. 414 */ 415typedef struct route sctp_route_t; 416typedef struct rtentry sctp_rtentry_t; 417 418/* 419 * XXX multi-FIB support was backed out in r179783 and it seems clear that the 420 * VRF support as currently in FreeBSD is not ready to support multi-FIB. 421 * It might be best to implement multi-FIB support for both v4 and v6 indepedent 422 * of VRFs and leave those to a real MPLS stack. 423 */ 424#define SCTP_RTALLOC(ro, vrf_id) rtalloc_ign((struct route *)ro, 0UL) 425 426/* Future zero copy wakeup/send function */ 427#define SCTP_ZERO_COPY_EVENT(inp, so) 428/* This is re-pulse ourselves for sendbuf */ 429#define SCTP_ZERO_COPY_SENDQ_EVENT(inp, so) 430 431/* 432 * SCTP protocol specific mbuf flags. 433 */ 434#define M_NOTIFICATION M_PROTO1 /* SCTP notification */ 435 436/* 437 * IP output routines 438 */ 439#define SCTP_IP_OUTPUT(result, o_pak, ro, stcb, vrf_id) \ 440{ \ 441 int o_flgs = IP_RAWOUTPUT; \ 442 struct sctp_tcb *local_stcb = stcb; \ 443 if (local_stcb && \ 444 local_stcb->sctp_ep && \ 445 local_stcb->sctp_ep->sctp_socket) \ 446 o_flgs |= local_stcb->sctp_ep->sctp_socket->so_options & SO_DONTROUTE; \ 447 m_clrprotoflags(o_pak); \ 448 result = ip_output(o_pak, NULL, ro, o_flgs, 0, NULL); \ 449} 450 451#define SCTP_IP6_OUTPUT(result, o_pak, ro, ifp, stcb, vrf_id) \ 452{ \ 453 struct sctp_tcb *local_stcb = stcb; \ 454 m_clrprotoflags(o_pak); \ 455 if (local_stcb && local_stcb->sctp_ep) \ 456 result = ip6_output(o_pak, \ 457 ((struct in6pcb *)(local_stcb->sctp_ep))->in6p_outputopts, \ 458 (ro), 0, 0, ifp, NULL); \ 459 else \ 460 result = ip6_output(o_pak, NULL, (ro), 0, 0, ifp, NULL); \ 461} 462 463struct mbuf * 464sctp_get_mbuf_for_msg(unsigned int space_needed, 465 int want_header, int how, int allonebuf, int type); 466 467 468/* 469 * SCTP AUTH 470 */ 471#define HAVE_SHA2 472 473#define SCTP_READ_RANDOM(buf, len) read_random(buf, len) 474 475#ifdef USE_SCTP_SHA1 476#include <netinet/sctp_sha1.h> 477#else 478#include <crypto/sha1.h> 479/* map standard crypto API names */ 480#define SHA1_Init SHA1Init 481#define SHA1_Update SHA1Update 482#define SHA1_Final(x,y) SHA1Final((caddr_t)x, y) 483#endif 484 485#if defined(HAVE_SHA2) 486#include <crypto/sha2/sha2.h> 487#endif 488 489#endif 490 491#define SCTP_DECREMENT_AND_CHECK_REFCOUNT(addr) (atomic_fetchadd_int(addr, -1) == 1) 492#if defined(INVARIANTS) 493#define SCTP_SAVE_ATOMIC_DECREMENT(addr, val) \ 494{ \ 495 int32_t oldval; \ 496 oldval = atomic_fetchadd_int(addr, -val); \ 497 if (oldval < val) { \ 498 panic("Counter goes negative"); \ 499 } \ 500} 501#else 502#define SCTP_SAVE_ATOMIC_DECREMENT(addr, val) \ 503{ \ 504 int32_t oldval; \ 505 oldval = atomic_fetchadd_int(addr, -val); \ 506 if (oldval < val) { \ 507 *addr = 0; \ 508 } \ 509} 510#endif 511