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/priv.h>
  55 #include <sys/random.h>
  56 #include <sys/limits.h>
  57 #include <sys/queue.h>
  58 #include <machine/cpu.h>
  59
  60 #include <net/if.h>
  61 #include <net/if_types.h>
  62 #include <net/if_var.h>
  63 #include <net/route.h>
  64
  65 #include <netinet/in.h>
  66 #include <netinet/in_systm.h>
  67 #include <netinet/ip.h>
  68 #include <netinet/in_pcb.h>
  69 #include <netinet/in_var.h>
  70 #include <netinet/ip_var.h>
  71 #include <netinet/ip_icmp.h>
  72 #include <netinet/icmp_var.h>
  73
  74
  75 #ifdef IPSEC
  76 #include <netinet6/ipsec.h>
  77 #include <netkey/key.h>
  78 #endif                          /* IPSEC */
  79
  80 #ifdef INET6
  81 #include <sys/domain.h>
  82 #ifdef IPSEC
  83 #include <netinet6/ipsec6.h>
  84 #endif
  85 #include <netinet/ip6.h>
  86 #include <netinet6/ip6_var.h>
  87 #include <netinet6/in6_pcb.h>
  88 #include <netinet/icmp6.h>
  89 #include <netinet6/ip6protosw.h>
  90 #include <netinet6/nd6.h>
  91 #include <netinet6/scope6_var.h>
  92 #endif                          /* INET6 */
  93
  94 #include <netinet/ip_options.h>
  95
  96
  97 #ifndef in6pcb
  98 #define in6pcb          inpcb
  99 #endif
 100
 101
 102
 103 /*
 104  *
 105  */
 106 #define USER_ADDR_NULL  (NULL)  /* FIX ME: temp */
 107
 108 /*
 109  * general memory allocation
 110  */
 111 #define SCTP_MALLOC(var, type, size, name) \
 112     do { \
 113         MALLOC(var, type, size, M_PCB, M_NOWAIT); \
 114     } while (0)
 115
 116 #define SCTP_FREE(var)  FREE(var, M_PCB)
 117
 118 #define SCTP_MALLOC_SONAME(var, type, size) \
 119     do { \
 120         MALLOC(var, type, size, M_SONAME, M_WAITOK | M_ZERO); \
 121     } while (0)
 122
 123 #define SCTP_FREE_SONAME(var)   FREE(var, M_SONAME)
 124
 125 /*
 126  * zone allocation functions
 127  */
 128 #include <vm/uma.h>
 129 /* SCTP_ZONE_INIT: initialize the zone */
 130 typedef struct uma_zone *sctp_zone_t;
 131
 132 #define UMA_ZFLAG_FULL  0x0020
 133 #define SCTP_ZONE_INIT(zone, name, size, number) { \
 134         zone = uma_zcreate(name, size, NULL, NULL, NULL, NULL, UMA_ALIGN_PTR,\
 135                 UMA_ZFLAG_FULL); \
 136         uma_zone_set_max(zone, number); \
 137 }
 138
 139 /* SCTP_ZONE_GET: allocate element from the zone */
 140 #define SCTP_ZONE_GET(zone) \
 141         uma_zalloc(zone, M_NOWAIT);
 142
 143 /* SCTP_ZONE_FREE: free element from the zone */
 144 #define SCTP_ZONE_FREE(zone, element) \
 145         uma_zfree(zone, element);
 146 #define SCTP_HASH_INIT(size, hashmark) hashinit_flags(size, M_PCB, hashmark, HASH_NOWAIT)
 147 #define SCTP_HASH_FREE(table, hashmark) hashdestroy(table, M_PCB, hashmark)
 148
 149 #define SCTP_M_COPYM    m_copym
 150
 151 /*
 152  * timers
 153  */
 154 #include <sys/callout.h>
 155 typedef struct callout sctp_os_timer_t;
 156
 157 #define SCTP_OS_TIMER_INIT(tmr) callout_init(tmr, 1)
 158 #define SCTP_OS_TIMER_START     callout_reset
 159 #define SCTP_OS_TIMER_STOP      callout_stop
 160 #define SCTP_OS_TIMER_STOP_DRAIN callout_drain
 161 #define SCTP_OS_TIMER_PENDING   callout_pending
 162 #define SCTP_OS_TIMER_ACTIVE    callout_active
 163 #define SCTP_OS_TIMER_DEACTIVATE callout_deactivate
 164
 165 /*
 166  * Functions
 167  */
 168 #define SCTP_READ_RANDOM(buf, len)      read_random(buf, len)
 169
 170 /* Mbuf manipulation and access macros  */
 171 #define SCTP_BUF_LEN(m) (m->m_len)
 172 #define SCTP_BUF_NEXT(m) (m->m_next)
 173 #define SCTP_BUF_NEXT_PKT(m) (m->m_nextpkt)
 174 #define SCTP_BUF_RESV_UF(m, size) m->m_data += size
 175 #define SCTP_BUF_AT(m, size) m->m_data + size
 176 #define SCTP_BUF_IS_EXTENDED(m) (m->m_flags & M_EXT)
 177 #define SCTP_BUF_EXTEND_SIZE(m) (m->m_ext.ext_size)
 178 #define SCTP_BUF_TYPE(m) (m->m_type)
 179 #define SCTP_BUF_RECVIF(m) (m->m_pkthdr.rcvif)
 180 #define SCTP_BUF_PREPEND        M_PREPEND
 181 /*************************/
 182 /* These are for logging */
 183 /*************************/
 184 /* return the base ext data pointer */
 185 #define SCTP_BUF_EXTEND_BASE(m) (m->m_ext.ext_buf)
 186  /* return the refcnt of the data pointer */
 187 #define SCTP_BUF_EXTEND_REFCNT(m) (*m->m_ext.ref_cnt)
 188 /* return any buffer related flags, this is
 189  * used beyond logging for apple only.
 190  */
 191 #define SCTP_BUF_GET_FLAGS(m) (m->m_flags)
 192
 193 /* For BSD this just accesses the M_PKTHDR length
 194  * so it operates on an mbuf with hdr flag. Other
 195  * O/S's may have seperate packet header and mbuf
 196  * chain pointers.. thus the macro.
 197  */
 198 #define SCTP_HEADER_TO_CHAIN(m) (m)
 199 #define SCTP_HEADER_LEN(m) (m->m_pkthdr.len)
 200 #define SCTP_GET_HEADER_FOR_OUTPUT(len) sctp_get_mbuf_for_msg(len, 1, M_DONTWAIT, 1, MT_DATA)
 201
 202 /* Attach the chain of data into the sendable packet. */
 203 #define SCTP_ATTACH_CHAIN(pak, m, packet_length) do { \
 204                                                  pak->m_next = m; \
 205                                                  pak->m_pkthdr.len = packet_length; \
 206                          } while(0)
 207
 208 /* Other m_pkthdr type things */
 209 #define SCTP_IS_IT_BROADCAST(dst, m) in_broadcast(dst, m->m_pkthdr.rcvif)
 210 #define SCTP_IS_IT_LOOPBACK(m) ((m->m_pkthdr.rcvif == NULL) ||(m->m_pkthdr.rcvif->if_type == IFT_LOOP))
 211
 212
 213 /* This converts any input packet header
 214  * into the chain of data holders, for BSD
 215  * its a NOP.
 216  */
 217 #define SCTP_PAK_TO_BUF(i_pak) (i_pak)
 218
 219 /* Macro's for getting length from V6/V4 header */
 220 #define SCTP_GET_IPV4_LENGTH(iph) (iph->ip_len)
 221 #define SCTP_GET_IPV6_LENGTH(ip6) (ntohs(ip6->ip6_plen))
 222
 223 /* is the endpoint v6only? */
 224 #define SCTP_IPV6_V6ONLY(inp)   (((struct inpcb *)inp)->inp_flags & IN6P_IPV6_V6ONLY)
 225
 226
 227 #endif