sys/netinet/sctp_os_bsd.h

   1 /*-
   2  * Copyright (c) 2006-2007, 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$");
  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 /*
 111  * Local address and interface list handling
 112  */
 113 #define SCTP_MAX_VRF_ID 0
 114 #define SCTP_SIZE_OF_VRF_HASH 3
 115 #define SCTP_IFNAMSIZ IFNAMSIZ
 116 #define SCTP_DEFAULT_VRFID 0
 117 #define SCTP_VRF_HASH_SIZE 16
 118
 119
 120 #define SCTP_IFN_IS_IFT_LOOP(ifn) ((ifn)->ifn_type == IFT_LOOP)
 121
 122 /*
 123  * Access to IFN's to help with src-addr-selection
 124  */
 125 /* This could return VOID if the index works but for BSD we provide both. */
 126 #define SCTP_GET_IFN_VOID_FROM_ROUTE(ro) (void *)ro->ro_rt->rt_ifp
 127 #define SCTP_GET_IF_INDEX_FROM_ROUTE(ro) ro->ro_rt->rt_ifp->if_index
 128
 129 /*
 130  * general memory allocation
 131  */
 132 #define SCTP_MALLOC(var, type, size, name) \
 133     do { \
 134         MALLOC(var, type, size, M_PCB, M_NOWAIT); \
 135     } while (0)
 136
 137 #define SCTP_FREE(var)  FREE(var, M_PCB)
 138
 139 #define SCTP_MALLOC_SONAME(var, type, size) \
 140     do { \
 141         MALLOC(var, type, size, M_SONAME, M_WAITOK | M_ZERO); \
 142     } while (0)
 143
 144 #define SCTP_FREE_SONAME(var)   FREE(var, M_SONAME)
 145
 146 #define SCTP_PROCESS_STRUCT struct proc *
 147
 148 /*
 149  * zone allocation functions
 150  */
 151 #include <vm/uma.h>
 152 /* SCTP_ZONE_INIT: initialize the zone */
 153 typedef struct uma_zone *sctp_zone_t;
 154
 155 #define UMA_ZFLAG_FULL  0x0020
 156 #define SCTP_ZONE_INIT(zone, name, size, number) { \
 157         zone = uma_zcreate(name, size, NULL, NULL, NULL, NULL, UMA_ALIGN_PTR,\
 158                 UMA_ZFLAG_FULL); \
 159         uma_zone_set_max(zone, number); \
 160 }
 161
 162 /* SCTP_ZONE_GET: allocate element from the zone */
 163 #define SCTP_ZONE_GET(zone, type) \
 164         (type *)uma_zalloc(zone, M_NOWAIT);
 165
 166 /* SCTP_ZONE_FREE: free element from the zone */
 167 #define SCTP_ZONE_FREE(zone, element) \
 168         uma_zfree(zone, element);
 169 #define SCTP_HASH_INIT(size, hashmark) hashinit_flags(size, M_PCB, hashmark, HASH_NOWAIT)
 170 #define SCTP_HASH_FREE(table, hashmark) hashdestroy(table, M_PCB, hashmark)
 171
 172 #define SCTP_M_COPYM    m_copym
 173
 174 /*
 175  * timers
 176  */
 177 #include <sys/callout.h>
 178 typedef struct callout sctp_os_timer_t;
 179
 180 #define SCTP_OS_TIMER_INIT(tmr) callout_init(tmr, 1)
 181 #define SCTP_OS_TIMER_START     callout_reset
 182 #define SCTP_OS_TIMER_STOP      callout_stop
 183 #define SCTP_OS_TIMER_STOP_DRAIN callout_drain
 184 #define SCTP_OS_TIMER_PENDING   callout_pending
 185 #define SCTP_OS_TIMER_ACTIVE    callout_active
 186 #define SCTP_OS_TIMER_DEACTIVATE callout_deactivate
 187
 188 /*
 189  * Functions
 190  */
 191 /* Mbuf manipulation and access macros  */
 192 #define SCTP_BUF_LEN(m) (m->m_len)
 193 #define SCTP_BUF_NEXT(m) (m->m_next)
 194 #define SCTP_BUF_NEXT_PKT(m) (m->m_nextpkt)
 195 #define SCTP_BUF_RESV_UF(m, size) m->m_data += size
 196 #define SCTP_BUF_AT(m, size) m->m_data + size
 197 #define SCTP_BUF_IS_EXTENDED(m) (m->m_flags & M_EXT)
 198 #define SCTP_BUF_EXTEND_SIZE(m) (m->m_ext.ext_size)
 199 #define SCTP_BUF_TYPE(m) (m->m_type)
 200 #define SCTP_BUF_RECVIF(m) (m->m_pkthdr.rcvif)
 201 #define SCTP_BUF_PREPEND        M_PREPEND
 202
 203 #define SCTP_ALIGN_TO_END(m, len) if(m->m_flags & M_PKTHDR) { \
 204                                      MH_ALIGN(m, len); \
 205                                   } else if ((m->m_flags & M_EXT) == 0) { \
 206                                      M_ALIGN(m, len); \
 207                                   }
 208
 209 /*************************/
 210 /* These are for logging */
 211 /*************************/
 212 /* return the base ext data pointer */
 213 #define SCTP_BUF_EXTEND_BASE(m) (m->m_ext.ext_buf)
 214  /* return the refcnt of the data pointer */
 215 #define SCTP_BUF_EXTEND_REFCNT(m) (*m->m_ext.ref_cnt)
 216 /* return any buffer related flags, this is
 217  * used beyond logging for apple only.
 218  */
 219 #define SCTP_BUF_GET_FLAGS(m) (m->m_flags)
 220
 221 /* For BSD this just accesses the M_PKTHDR length
 222  * so it operates on an mbuf with hdr flag. Other
 223  * O/S's may have seperate packet header and mbuf
 224  * chain pointers.. thus the macro.
 225  */
 226 #define SCTP_HEADER_TO_CHAIN(m) (m)
 227 #define SCTP_HEADER_LEN(m) (m->m_pkthdr.len)
 228 #define SCTP_GET_HEADER_FOR_OUTPUT(len) sctp_get_mbuf_for_msg(len, 1, M_DONTWAIT, 1, MT_DATA)
 229
 230 /* Attach the chain of data into the sendable packet. */
 231 #define SCTP_ATTACH_CHAIN(pak, m, packet_length) do { \
 232                                                  pak->m_next = m; \
 233                                                  pak->m_pkthdr.len = packet_length; \
 234                          } while(0)
 235
 236 /* Other m_pkthdr type things */
 237 #define SCTP_IS_IT_BROADCAST(dst, m) in_broadcast(dst, m->m_pkthdr.rcvif)
 238 #define SCTP_IS_IT_LOOPBACK(m) ((m->m_pkthdr.rcvif == NULL) ||(m->m_pkthdr.rcvif->if_type == IFT_LOOP))
 239
 240
 241 /* This converts any input packet header
 242  * into the chain of data holders, for BSD
 243  * its a NOP.
 244  */
 245 #define SCTP_PAK_TO_BUF(i_pak) (i_pak)
 246
 247 /* Macro's for getting length from V6/V4 header */
 248 #define SCTP_GET_IPV4_LENGTH(iph) (iph->ip_len)
 249 #define SCTP_GET_IPV6_LENGTH(ip6) (ntohs(ip6->ip6_plen))
 250
 251 /* is the endpoint v6only? */
 252 #define SCTP_IPV6_V6ONLY(inp)   (((struct inpcb *)inp)->inp_flags & IN6P_IPV6_V6ONLY)
 253 /* is the socket non-blocking? */
 254 #define SCTP_SO_IS_NBIO(so)     ((so)->so_state & SS_NBIO)
 255 #define SCTP_SET_SO_NBIO(so)    ((so)->so_state |= SS_NBIO)
 256 #define SCTP_CLEAR_SO_NBIO(so)  ((so)->so_state &= ~SS_NBIO)
 257 /* get the socket type */
 258 #define SCTP_SO_TYPE(so)        ((so)->so_type)
 259 /* reserve sb space for a socket */
 260 #define SCTP_SORESERVE(so, send, recv)  soreserve(so, send, recv)
 261 /* clear the socket buffer state */
 262 #define SCTP_SB_CLEAR(sb)       \
 263         (sb).sb_cc = 0;         \
 264         (sb).sb_mb = NULL;      \
 265         (sb).sb_mbcnt = 0;
 266
 267 #define SCTP_SB_LIMIT_RCV(so) so->so_rcv.sb_hiwat
 268 #define SCTP_SB_LIMIT_SND(so) so->so_snd.sb_hiwat
 269
 270 /*
 271  * routes, output, etc.
 272  */
 273 typedef struct route sctp_route_t;
 274
 275
 276 /*
 277  * SCTP AUTH
 278  */
 279 #define HAVE_SHA2
 280
 281 #define SCTP_READ_RANDOM(buf, len)      read_random(buf, len)
 282
 283 #ifdef USE_SCTP_SHA1
 284 #include <netinet/sctp_sha1.h>
 285 #else
 286 #include <crypto/sha1.h>
 287 /* map standard crypto API names */
 288 #define SHA1_Init       SHA1Init
 289 #define SHA1_Update     SHA1Update
 290 #define SHA1_Final(x,y) SHA1Final((caddr_t)x, y)
 291 #endif
 292
 293 #if defined(HAVE_SHA2)
 294 #include <crypto/sha2/sha2.h>
 295 #endif
 296
 297 #include <sys/md5.h>
 298 /* map standard crypto API names */
 299 #define MD5_Init        MD5Init
 300 #define MD5_Update      MD5Update
 301 #define MD5_Final       MD5Final
 302
 303 #endif