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