sctp_os_bsd.h revision 169382
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 169382 2007-05-08 17:01:12Z 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 102 103 104/* 105 * 106 */ 107#define USER_ADDR_NULL (NULL) /* FIX ME: temp */ 108#define SCTP_LIST_EMPTY(list) LIST_EMPTY(list) 109 110#if defined(SCTP_DEBUG) 111#define SCTPDBG(level, params...) \ 112{ \ 113 do { \ 114 if (sctp_debug_on & level ) { \ 115 printf(params); \ 116 } \ 117 } while (0); \ 118} 119#define SCTPDBG_ADDR(level, addr) \ 120{ \ 121 do { \ 122 if (sctp_debug_on & level ) { \ 123 sctp_print_address(addr); \ 124 } \ 125 } while (0); \ 126} 127#define SCTP_PRINTF(params...) printf(params) 128#else 129#define SCTPDBG(level, params...) 130#define SCTPDBG_ADDR(level, addr) 131#define SCTP_PRINTF(params...) 132#endif 133 134/* 135 * Local address and interface list handling 136 */ 137#define SCTP_MAX_VRF_ID 0 138#define SCTP_SIZE_OF_VRF_HASH 3 139#define SCTP_IFNAMSIZ IFNAMSIZ 140#define SCTP_DEFAULT_VRFID 0 141#define SCTP_DEFAULT_TABLEID 0 142#define SCTP_VRF_ADDR_HASH_SIZE 16 143#define SCTP_VRF_IFN_HASH_SIZE 3 144#define SCTP_VRF_DEFAULT_TABLEID(vrf_id) 0 145 146#define SCTP_IFN_IS_IFT_LOOP(ifn) ((ifn)->ifn_type == IFT_LOOP) 147 148/* 149 * Access to IFN's to help with src-addr-selection 150 */ 151/* This could return VOID if the index works but for BSD we provide both. */ 152#define SCTP_GET_IFN_VOID_FROM_ROUTE(ro) (void *)ro->ro_rt->rt_ifp 153#define SCTP_GET_IF_INDEX_FROM_ROUTE(ro) (ro)->ro_rt->rt_ifp->if_index 154#define SCTP_ROUTE_HAS_VALID_IFN(ro) ((ro)->ro_rt && (ro)->ro_rt->rt_ifp) 155 156/* 157 * general memory allocation 158 */ 159#define SCTP_MALLOC(var, type, size, name) \ 160 do { \ 161 MALLOC(var, type, size, M_PCB, M_NOWAIT); \ 162 } while (0) 163 164#define SCTP_FREE(var) FREE(var, M_PCB) 165 166#define SCTP_MALLOC_SONAME(var, type, size) \ 167 do { \ 168 MALLOC(var, type, size, M_SONAME, M_WAITOK | M_ZERO); \ 169 } while (0) 170 171#define SCTP_FREE_SONAME(var) FREE(var, M_SONAME) 172 173#define SCTP_PROCESS_STRUCT struct proc * 174 175/* 176 * zone allocation functions 177 */ 178#include <vm/uma.h> 179/* SCTP_ZONE_INIT: initialize the zone */ 180typedef struct uma_zone *sctp_zone_t; 181 182#define UMA_ZFLAG_FULL 0x0020 183#define SCTP_ZONE_INIT(zone, name, size, number) { \ 184 zone = uma_zcreate(name, size, NULL, NULL, NULL, NULL, UMA_ALIGN_PTR,\ 185 UMA_ZFLAG_FULL); \ 186 uma_zone_set_max(zone, number); \ 187} 188 189/* SCTP_ZONE_GET: allocate element from the zone */ 190#define SCTP_ZONE_GET(zone, type) \ 191 (type *)uma_zalloc(zone, M_NOWAIT); 192 193/* SCTP_ZONE_FREE: free element from the zone */ 194#define SCTP_ZONE_FREE(zone, element) \ 195 uma_zfree(zone, element); 196#define SCTP_HASH_INIT(size, hashmark) hashinit_flags(size, M_PCB, hashmark, HASH_NOWAIT) 197#define SCTP_HASH_FREE(table, hashmark) hashdestroy(table, M_PCB, hashmark) 198 199#define SCTP_M_COPYM m_copym 200 201/* 202 * timers 203 */ 204#include <sys/callout.h> 205typedef struct callout sctp_os_timer_t; 206 207#define SCTP_OS_TIMER_INIT(tmr) callout_init(tmr, 1) 208#define SCTP_OS_TIMER_START callout_reset 209#define SCTP_OS_TIMER_STOP callout_stop 210#define SCTP_OS_TIMER_STOP_DRAIN callout_drain 211#define SCTP_OS_TIMER_PENDING callout_pending 212#define SCTP_OS_TIMER_ACTIVE callout_active 213#define SCTP_OS_TIMER_DEACTIVATE callout_deactivate 214 215/* 216 * Functions 217 */ 218/* Mbuf manipulation and access macros */ 219#define SCTP_BUF_LEN(m) (m->m_len) 220#define SCTP_BUF_NEXT(m) (m->m_next) 221#define SCTP_BUF_NEXT_PKT(m) (m->m_nextpkt) 222#define SCTP_BUF_RESV_UF(m, size) m->m_data += size 223#define SCTP_BUF_AT(m, size) m->m_data + size 224#define SCTP_BUF_IS_EXTENDED(m) (m->m_flags & M_EXT) 225#define SCTP_BUF_EXTEND_SIZE(m) (m->m_ext.ext_size) 226#define SCTP_BUF_TYPE(m) (m->m_type) 227#define SCTP_BUF_RECVIF(m) (m->m_pkthdr.rcvif) 228#define SCTP_BUF_PREPEND M_PREPEND 229 230#define SCTP_ALIGN_TO_END(m, len) if(m->m_flags & M_PKTHDR) { \ 231 MH_ALIGN(m, len); \ 232 } else if ((m->m_flags & M_EXT) == 0) { \ 233 M_ALIGN(m, len); \ 234 } 235/*************************/ 236/* MTU */ 237/*************************/ 238#define SCTP_GATHER_MTU_FROM_IFN_INFO(ifn, ifn_index) ((struct ifnet *)ifn)->if_mtu 239#define SCTP_GATHER_MTU_FROM_ROUTE(sctp_ifa, sa, rt) ((rt != NULL) ? rt->rt_rmx.rmx_mtu : 0) 240#define SCTP_GATHER_MTU_FROM_INTFC(sctp_ifn) ((sctp_ifn->ifn_p != NULL) ? ((struct ifnet *)(sctp_ifn->ifn_p))->if_mtu : 0) 241#define SCTP_SET_MTU_OF_ROUTE(sa, rt, mtu) do { \ 242 if (rt != NULL) \ 243 rt->rt_rmx.rmx_mtu = mtu; \ 244 } while(0) 245 246/* (de-)register interface event notifications */ 247#define SCTP_REGISTER_INTERFACE(ifhandle, ifname) 248#define SCTP_DEREGISTER_INTERFACE(ifhandle, ifname) 249 250/*************************/ 251/* These are for logging */ 252/*************************/ 253/* return the base ext data pointer */ 254#define SCTP_BUF_EXTEND_BASE(m) (m->m_ext.ext_buf) 255 /* return the refcnt of the data pointer */ 256#define SCTP_BUF_EXTEND_REFCNT(m) (*m->m_ext.ref_cnt) 257/* return any buffer related flags, this is 258 * used beyond logging for apple only. 259 */ 260#define SCTP_BUF_GET_FLAGS(m) (m->m_flags) 261 262/* For BSD this just accesses the M_PKTHDR length 263 * so it operates on an mbuf with hdr flag. Other 264 * O/S's may have seperate packet header and mbuf 265 * chain pointers.. thus the macro. 266 */ 267#define SCTP_HEADER_TO_CHAIN(m) (m) 268#define SCTP_DETACH_HEADER_FROM_CHAIN(m) 269#define SCTP_HEADER_LEN(m) (m->m_pkthdr.len) 270#define SCTP_GET_HEADER_FOR_OUTPUT(o_pak) 0 271#define SCTP_RELEASE_HEADER(m) 272#define SCTP_RELEASE_PKT(m) sctp_m_freem(m) 273 274static inline int 275SCTP_GET_PKT_VRFID(void *m, uint32_t vrf_id) 276{ 277 vrf_id = SCTP_DEFAULT_VRFID; 278 return (0); 279} 280static inline int 281SCTP_GET_PKT_TABLEID(void *m, uint32_t table_id) 282{ 283 table_id = SCTP_DEFAULT_TABLEID; 284 return (0); 285} 286 287/* Attach the chain of data into the sendable packet. */ 288#define SCTP_ATTACH_CHAIN(pak, m, packet_length) do { \ 289 pak = m; \ 290 pak->m_pkthdr.len = packet_length; \ 291 } while(0) 292 293/* Other m_pkthdr type things */ 294#define SCTP_IS_IT_BROADCAST(dst, m) in_broadcast(dst, m->m_pkthdr.rcvif) 295#define SCTP_IS_IT_LOOPBACK(m) ((m->m_pkthdr.rcvif == NULL) ||(m->m_pkthdr.rcvif->if_type == IFT_LOOP)) 296 297 298/* This converts any input packet header 299 * into the chain of data holders, for BSD 300 * its a NOP. 301 */ 302 303/* Macro's for getting length from V6/V4 header */ 304#define SCTP_GET_IPV4_LENGTH(iph) (iph->ip_len) 305#define SCTP_GET_IPV6_LENGTH(ip6) (ntohs(ip6->ip6_plen)) 306 307/* get the v6 hop limit */ 308#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))); 309 310/* is the endpoint v6only? */ 311#define SCTP_IPV6_V6ONLY(inp) (((struct inpcb *)inp)->inp_flags & IN6P_IPV6_V6ONLY) 312/* is the socket non-blocking? */ 313#define SCTP_SO_IS_NBIO(so) ((so)->so_state & SS_NBIO) 314#define SCTP_SET_SO_NBIO(so) ((so)->so_state |= SS_NBIO) 315#define SCTP_CLEAR_SO_NBIO(so) ((so)->so_state &= ~SS_NBIO) 316/* get the socket type */ 317#define SCTP_SO_TYPE(so) ((so)->so_type) 318/* reserve sb space for a socket */ 319#define SCTP_SORESERVE(so, send, recv) soreserve(so, send, recv) 320/* wakeup a socket */ 321#define SCTP_SOWAKEUP(so) wakeup(&(so)->so_timeo) 322/* clear the socket buffer state */ 323#define SCTP_SB_CLEAR(sb) \ 324 (sb).sb_cc = 0; \ 325 (sb).sb_mb = NULL; \ 326 (sb).sb_mbcnt = 0; 327 328#define SCTP_SB_LIMIT_RCV(so) so->so_rcv.sb_hiwat 329#define SCTP_SB_LIMIT_SND(so) so->so_snd.sb_hiwat 330 331/* 332 * routes, output, etc. 333 */ 334typedef struct route sctp_route_t; 335typedef struct rtentry sctp_rtentry_t; 336 337#define SCTP_RTALLOC(ro, vrf_id, table_id) rtalloc_ign((struct route *)ro, 0UL) 338 339/* Future zero copy wakeup/send function */ 340#define SCTP_ZERO_COPY_EVENT(inp, so) 341 342/* 343 * IP output routines 344 */ 345#define SCTP_IP_OUTPUT(result, o_pak, ro, stcb, vrf_id, table_id) \ 346{ \ 347 int o_flgs = 0; \ 348 if (stcb && stcb->sctp_ep && stcb->sctp_ep->sctp_socket) { \ 349 o_flgs = IP_RAWOUTPUT | (stcb->sctp_ep->sctp_socket->so_options & SO_DONTROUTE); \ 350 } else { \ 351 o_flgs = IP_RAWOUTPUT; \ 352 } \ 353 result = ip_output(o_pak, NULL, ro, o_flgs, 0, NULL); \ 354} 355 356#define SCTP_IP6_OUTPUT(result, o_pak, ro, ifp, stcb, vrf_id, table_id) \ 357{ \ 358 if (stcb && stcb->sctp_ep) \ 359 result = ip6_output(o_pak, \ 360 ((struct in6pcb *)(stcb->sctp_ep))->in6p_outputopts, \ 361 (ro), 0, 0, ifp, NULL); \ 362 else \ 363 result = ip6_output(o_pak, NULL, (ro), 0, 0, ifp, NULL); \ 364} 365 366struct mbuf * 367sctp_get_mbuf_for_msg(unsigned int space_needed, 368 int want_header, int how, int allonebuf, int type); 369 370 371/* 372 * SCTP AUTH 373 */ 374#define HAVE_SHA2 375 376#define SCTP_READ_RANDOM(buf, len) read_random(buf, len) 377 378#ifdef USE_SCTP_SHA1 379#include <netinet/sctp_sha1.h> 380#else 381#include <crypto/sha1.h> 382/* map standard crypto API names */ 383#define SHA1_Init SHA1Init 384#define SHA1_Update SHA1Update 385#define SHA1_Final(x,y) SHA1Final((caddr_t)x, y) 386#endif 387 388#if defined(HAVE_SHA2) 389#include <crypto/sha2/sha2.h> 390#endif 391 392#include <sys/md5.h> 393/* map standard crypto API names */ 394#define MD5_Init MD5Init 395#define MD5_Update MD5Update 396#define MD5_Final MD5Final 397 398#endif 399