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