sys/netinet/sctp_os_bsd.h

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