sys/netinet/sctputil.h

   1 /*-
   2  * Copyright (c) 2001-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
  31
  32 /* $KAME: sctputil.h,v 1.15 2005/03/06 16:04:19 itojun Exp $     */
  33
  34 #include <sys/cdefs.h>
  35 __FBSDID("$FreeBSD$");
  36 #ifndef __sctputil_h__
  37 #define __sctputil_h__
  38
  39
  40 #if defined(_KERNEL)
  41
  42
  43 /*-
  44  * Any new logging added must also define SCTP_STAT_LOGGING if
  45  * its not already defined.
  46  */
  47 #if defined(SCTP_LOG_MAXBURST) || defined(SCTP_LOG_RWND) || defined(SCTP_LOG_RWND)
  48 #ifndef SCTP_STAT_LOGGING
  49 #define SCTP_STAT_LOGGING 1
  50 #endif
  51 #endif
  52
  53 #if defined(SCTP_CWND_LOGGING) || defined(SCTP_CWND_MONITOR) || defined(SCTP_BLK_LOGGING)
  54 #ifndef SCTP_STAT_LOGGING
  55 #define SCTP_STAT_LOGGING 1
  56 #endif
  57 #endif
  58
  59 #if defined(SCTP_STR_LOGGING) || defined(SCTP_FR_LOGGING) || defined(SCTP_MAP_LOGGING)
  60 #ifndef SCTP_STAT_LOGGING
  61 #define SCTP_STAT_LOGGING 1
  62 #endif
  63 #endif
  64
  65 #if defined(SCTP_SACK_LOGGING) || defined(SCTP_LOCK_LOGGING) || defined(SCTP_STAT_LOGGING)
  66 #ifndef SCTP_STAT_LOGGING
  67 #define SCTP_STAT_LOGGING 1
  68 #endif
  69 #endif
  70
  71 #if defined(SCTP_RTTVAR_LOGGING) || defined(SCTP_SB_LOGGING) || defined(SCTP_EARLYFR_LOGGING)
  72 #ifndef SCTP_STAT_LOGGING
  73 #define SCTP_STAT_LOGGING 1
  74 #endif
  75 #endif
  76
  77 #if defined(SCTP_NAGLE_LOGGING) || defined(SCTP_WAKE_LOGGING) || defined(SCTP_RECV_RWND_LOGGING)
  78 #ifndef SCTP_STAT_LOGGING
  79 #define SCTP_STAT_LOGGING 1
  80 #endif
  81 #endif
  82
  83 #if defined(SCTP_SACK_RWND_LOGGING) || defined(SCTP_FLIGHT_LOGGING) || defined(SCTP_MBUF_LOGGING)
  84 #ifndef SCTP_STAT_LOGGING
  85 #define SCTP_STAT_LOGGING 1
  86 #endif
  87 #endif
  88
  89 #ifdef SCTP_ASOCLOG_OF_TSNS
  90 void sctp_print_out_track_log(struct sctp_tcb *stcb);
  91
  92 #endif
  93
  94 #ifdef SCTP_MBUF_LOGGING
  95 struct mbuf *sctp_m_free(struct mbuf *m);
  96 void sctp_m_freem(struct mbuf *m);
  97
  98 #else
  99 #define sctp_m_free m_free
 100 #define sctp_m_freem m_freem
 101 #endif
 102
 103
 104 #define sctp_get_associd(stcb) ((sctp_assoc_t)stcb->asoc.assoc_id)
 105
 106
 107 /*
 108  * Function prototypes
 109  */
 110 uint32_t
 111 sctp_get_ifa_hash_val(struct sockaddr *addr);
 112
 113 struct sctp_ifa *
 114          sctp_find_ifa_in_ep(struct sctp_inpcb *inp, struct sockaddr *addr, int hold_lock);
 115 struct sctp_ifa *
 116 sctp_find_ifa_in_ifn(struct sctp_ifn *sctp_ifnp, struct sockaddr *addr,
 117     int holds_lock);
 118
 119 struct sctp_ifa *
 120          sctp_find_ifa_by_addr(struct sockaddr *addr, uint32_t vrf_id, int holds_lock);
 121
 122 uint32_t sctp_select_initial_TSN(struct sctp_pcb *);
 123
 124 uint32_t sctp_select_a_tag(struct sctp_inpcb *);
 125
 126 int sctp_init_asoc(struct sctp_inpcb *, struct sctp_association *, int, uint32_t, uint32_t);
 127
 128 void sctp_fill_random_store(struct sctp_pcb *);
 129
 130 int
 131 sctp_timer_start(int, struct sctp_inpcb *, struct sctp_tcb *,
 132     struct sctp_nets *);
 133
 134 int
 135 sctp_timer_stop(int, struct sctp_inpcb *, struct sctp_tcb *,
 136     struct sctp_nets *, uint32_t);
 137
 138 int
 139     sctp_dynamic_set_primary(struct sockaddr *sa, uint32_t vrf_id);
 140
 141 uint32_t sctp_calculate_sum(struct mbuf *, int32_t *, uint32_t);
 142
 143 void
 144      sctp_mtu_size_reset(struct sctp_inpcb *, struct sctp_association *, uint32_t);
 145
 146 void
 147 sctp_add_to_readq(struct sctp_inpcb *inp,
 148     struct sctp_tcb *stcb,
 149     struct sctp_queued_to_read *control,
 150     struct sockbuf *sb,
 151     int end);
 152
 153 int
 154 sctp_append_to_readq(struct sctp_inpcb *inp,
 155     struct sctp_tcb *stcb,
 156     struct sctp_queued_to_read *control,
 157     struct mbuf *m,
 158     int end,
 159     int new_cumack,
 160     struct sockbuf *sb);
 161
 162
 163 void sctp_iterator_worker(void);
 164
 165 int find_next_best_mtu(int);
 166
 167 void
 168      sctp_timeout_handler(void *);
 169
 170 uint32_t
 171 sctp_calculate_rto(struct sctp_tcb *, struct sctp_association *,
 172     struct sctp_nets *, struct timeval *);
 173
 174 uint32_t sctp_calculate_len(struct mbuf *);
 175
 176 caddr_t sctp_m_getptr(struct mbuf *, int, int, uint8_t *);
 177
 178 struct sctp_paramhdr *
 179 sctp_get_next_param(struct mbuf *, int,
 180     struct sctp_paramhdr *, int);
 181
 182 int sctp_add_pad_tombuf(struct mbuf *, int);
 183
 184 int sctp_pad_lastmbuf(struct mbuf *, int, struct mbuf *);
 185
 186 void sctp_ulp_notify(uint32_t, struct sctp_tcb *, uint32_t, void *);
 187
 188 void
 189 sctp_pull_off_control_to_new_inp(struct sctp_inpcb *old_inp,
 190     struct sctp_inpcb *new_inp,
 191     struct sctp_tcb *stcb);
 192
 193
 194 void sctp_stop_timers_for_shutdown(struct sctp_tcb *);
 195
 196 void sctp_report_all_outbound(struct sctp_tcb *, int);
 197
 198 int sctp_expand_mapping_array(struct sctp_association *);
 199
 200 void sctp_abort_notification(struct sctp_tcb *, int);
 201
 202 /* We abort responding to an IP packet for some reason */
 203 void
 204 sctp_abort_association(struct sctp_inpcb *, struct sctp_tcb *,
 205     struct mbuf *, int, struct sctphdr *, struct mbuf *);
 206
 207 /* We choose to abort via user input */
 208 void
 209 sctp_abort_an_association(struct sctp_inpcb *, struct sctp_tcb *, int,
 210     struct mbuf *);
 211
 212 void
 213 sctp_handle_ootb(struct mbuf *, int, int, struct sctphdr *,
 214     struct sctp_inpcb *, struct mbuf *);
 215
 216 int sctp_is_there_an_abort_here(struct mbuf *, int, uint32_t *);
 217 uint32_t sctp_is_same_scope(struct sockaddr_in6 *, struct sockaddr_in6 *);
 218
 219 struct sockaddr_in6 *
 220              sctp_recover_scope(struct sockaddr_in6 *, struct sockaddr_in6 *);
 221
 222 #define sctp_recover_scope_mac(addr, store) do { \
 223          if ((addr->sin6_family == AF_INET6) && \
 224              (IN6_IS_SCOPE_LINKLOCAL(&addr->sin6_addr))) { \
 225                 *store = *addr; \
 226                 if (addr->sin6_scope_id == 0) { \
 227                         if (!sa6_recoverscope(store)) { \
 228                                 addr = store; \
 229                         } \
 230                 } else { \
 231                         in6_clearscope(&addr->sin6_addr); \
 232                         addr = store; \
 233                 } \
 234          } \
 235 } while (0)
 236
 237
 238 int sctp_cmpaddr(struct sockaddr *, struct sockaddr *);
 239
 240 void sctp_print_address(struct sockaddr *);
 241 void sctp_print_address_pkt(struct ip *, struct sctphdr *);
 242
 243 void
 244 sctp_notify_partial_delivery_indication(struct sctp_tcb *stcb,
 245     uint32_t error, int no_lock, uint32_t strseq);
 246
 247 int
 248 sctp_release_pr_sctp_chunk(struct sctp_tcb *, struct sctp_tmit_chunk *,
 249     int, struct sctpchunk_listhead *);
 250
 251 struct mbuf *sctp_generate_invmanparam(int);
 252
 253
 254 #ifdef SCTP_MBCNT_LOGGING
 255 void
 256 sctp_free_bufspace(struct sctp_tcb *, struct sctp_association *,
 257     struct sctp_tmit_chunk *);
 258
 259 #else
 260 #define sctp_free_bufspace(stcb, asoc, tp1, chk_cnt)  \
 261 do { \
 262         if (tp1->data != NULL) { \
 263                 atomic_add_int(&((asoc)->chunks_on_out_queue), -chk_cnt); \
 264                 if ((asoc)->total_output_queue_size >= tp1->book_size) { \
 265                         atomic_add_int(&((asoc)->total_output_queue_size), -tp1->book_size); \
 266                 } else { \
 267                         (asoc)->total_output_queue_size = 0; \
 268                 } \
 269                 if (stcb->sctp_socket && ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \
 270                     (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \
 271                         if (stcb->sctp_socket->so_snd.sb_cc >= tp1->book_size) { \
 272                                 atomic_add_int(&((stcb)->sctp_socket->so_snd.sb_cc), -tp1->book_size); \
 273                         } else { \
 274                                 stcb->sctp_socket->so_snd.sb_cc = 0; \
 275                         } \
 276                 } \
 277         } \
 278 } while (0)
 279
 280 #endif
 281
 282 #define sctp_free_spbufspace(stcb, asoc, sp)  \
 283 do { \
 284         if (sp->data != NULL) { \
 285                 atomic_add_int(&(asoc)->chunks_on_out_queue, -1); \
 286                 if ((asoc)->total_output_queue_size >= sp->length) { \
 287                         atomic_add_int(&(asoc)->total_output_queue_size,sp->length); \
 288                 } else { \
 289                         (asoc)->total_output_queue_size = 0; \
 290                 } \
 291                 if (stcb->sctp_socket && ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \
 292                     (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \
 293                         if (stcb->sctp_socket->so_snd.sb_cc >= sp->length) { \
 294                                 atomic_add_int(&stcb->sctp_socket->so_snd.sb_cc,sp->length); \
 295                         } else { \
 296                                 stcb->sctp_socket->so_snd.sb_cc = 0; \
 297                         } \
 298                 } \
 299         } \
 300 } while (0)
 301
 302 #define sctp_snd_sb_alloc(stcb, sz)  \
 303 do { \
 304         atomic_add_int(&stcb->asoc.total_output_queue_size,sz); \
 305         if ((stcb->sctp_socket != NULL) && \
 306             ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \
 307              (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \
 308                 atomic_add_int(&stcb->sctp_socket->so_snd.sb_cc,sz); \
 309         } \
 310 } while (0)
 311
 312
 313 int
 314 sctp_soreceive(struct socket *so, struct sockaddr **psa,
 315     struct uio *uio,
 316     struct mbuf **mp0,
 317     struct mbuf **controlp,
 318     int *flagsp);
 319
 320
 321 #ifdef SCTP_STAT_LOGGING
 322 void
 323      sctp_misc_ints(uint8_t from, uint32_t a, uint32_t b, uint32_t c, uint32_t d);
 324
 325 void
 326 sctp_wakeup_log(struct sctp_tcb *stcb,
 327     uint32_t cumtsn,
 328     uint32_t wake_cnt, int from);
 329
 330 void sctp_log_strm_del_alt(struct sctp_tcb *stcb, uint32_t, uint16_t, uint16_t, int);
 331
 332 void sctp_log_nagle_event(struct sctp_tcb *stcb, int action);
 333
 334
 335 void
 336      sctp_log_mb(struct mbuf *m, int from);
 337
 338 void
 339 sctp_sblog(struct sockbuf *sb,
 340     struct sctp_tcb *stcb, int from, int incr);
 341
 342 void
 343 sctp_log_strm_del(struct sctp_queued_to_read *control,
 344     struct sctp_queued_to_read *poschk,
 345     int from);
 346 void sctp_log_cwnd(struct sctp_tcb *stcb, struct sctp_nets *, int, uint8_t);
 347 void rto_logging(struct sctp_nets *net, int from);
 348
 349 void sctp_log_closing(struct sctp_inpcb *inp, struct sctp_tcb *stcb, int16_t loc);
 350
 351 void sctp_log_lock(struct sctp_inpcb *inp, struct sctp_tcb *stcb, uint8_t from);
 352 void sctp_log_maxburst(struct sctp_tcb *stcb, struct sctp_nets *, int, int, uint8_t);
 353 void sctp_log_block(uint8_t, struct socket *, struct sctp_association *, int);
 354 void sctp_log_rwnd(uint8_t, uint32_t, uint32_t, uint32_t);
 355 void sctp_log_mbcnt(uint8_t, uint32_t, uint32_t, uint32_t, uint32_t);
 356 void sctp_log_rwnd_set(uint8_t, uint32_t, uint32_t, uint32_t, uint32_t);
 357 int sctp_fill_stat_log(void *, size_t *);
 358 void sctp_log_fr(uint32_t, uint32_t, uint32_t, int);
 359 void sctp_log_sack(uint32_t, uint32_t, uint32_t, uint16_t, uint16_t, int);
 360 void sctp_log_map(uint32_t, uint32_t, uint32_t, int);
 361
 362 void sctp_clr_stat_log(void);
 363
 364 #endif
 365
 366 #ifdef SCTP_AUDITING_ENABLED
 367 void
 368 sctp_auditing(int, struct sctp_inpcb *, struct sctp_tcb *,
 369     struct sctp_nets *);
 370 void sctp_audit_log(uint8_t, uint8_t);
 371
 372 #endif
 373
 374
 375 #endif                          /* _KERNEL */
 376 #endif