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