sys/netinet/sctputil.h

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