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