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 #ifdef SCTP_MBUF_LOGGING
  43
  44 struct mbuf *sctp_m_free(struct mbuf *m);
  45 void sctp_m_freem(struct mbuf *m);
  46
  47 #else
  48 #define sctp_m_free m_free
  49 #define sctp_m_freem m_freem
  50 #endif
  51
  52
  53 #define sctp_get_associd(stcb) ((sctp_assoc_t)stcb->asoc.assoc_id)
  54
  55
  56 /*
  57  * Function prototypes
  58  */
  59 struct ifaddr *sctp_find_ifa_by_addr(struct sockaddr *sa);
  60
  61 uint32_t sctp_select_initial_TSN(struct sctp_pcb *);
  62
  63 uint32_t sctp_select_a_tag(struct sctp_inpcb *);
  64
  65 int sctp_init_asoc(struct sctp_inpcb *, struct sctp_association *, int, uint32_t);
  66
  67 void sctp_fill_random_store(struct sctp_pcb *);
  68
  69 int
  70 sctp_timer_start(int, struct sctp_inpcb *, struct sctp_tcb *,
  71     struct sctp_nets *);
  72
  73 int
  74 sctp_timer_stop(int, struct sctp_inpcb *, struct sctp_tcb *,
  75     struct sctp_nets *, uint32_t);
  76
  77 uint32_t sctp_calculate_sum(struct mbuf *, int32_t *, uint32_t);
  78
  79 void
  80      sctp_mtu_size_reset(struct sctp_inpcb *, struct sctp_association *, uint32_t);
  81
  82 void
  83 sctp_add_to_readq(struct sctp_inpcb *inp,
  84     struct sctp_tcb *stcb,
  85     struct sctp_queued_to_read *control,
  86     struct sockbuf *sb,
  87     int end);
  88
  89 int
  90 sctp_append_to_readq(struct sctp_inpcb *inp,
  91     struct sctp_tcb *stcb,
  92     struct sctp_queued_to_read *control,
  93     struct mbuf *m,
  94     int end,
  95     int new_cumack,
  96     struct sockbuf *sb);
  97
  98
  99 int find_next_best_mtu(int);
 100
 101 void
 102      sctp_timeout_handler(void *);
 103
 104 uint32_t
 105 sctp_calculate_rto(struct sctp_tcb *, struct sctp_association *,
 106     struct sctp_nets *, struct timeval *);
 107
 108 uint32_t sctp_calculate_len(struct mbuf *);
 109
 110 caddr_t sctp_m_getptr(struct mbuf *, int, int, uint8_t *);
 111
 112 struct sctp_paramhdr *
 113 sctp_get_next_param(struct mbuf *, int,
 114     struct sctp_paramhdr *, int);
 115
 116 int sctp_add_pad_tombuf(struct mbuf *, int);
 117
 118 int sctp_pad_lastmbuf(struct mbuf *, int, struct mbuf *);
 119
 120 void sctp_ulp_notify(uint32_t, struct sctp_tcb *, uint32_t, void *);
 121
 122 void
 123 sctp_pull_off_control_to_new_inp(struct sctp_inpcb *old_inp,
 124     struct sctp_inpcb *new_inp,
 125     struct sctp_tcb *stcb);
 126
 127
 128 void sctp_stop_timers_for_shutdown(struct sctp_tcb *);
 129
 130 void sctp_report_all_outbound(struct sctp_tcb *, int);
 131
 132 int sctp_expand_mapping_array(struct sctp_association *);
 133
 134 void sctp_abort_notification(struct sctp_tcb *, int);
 135
 136 /* We abort responding to an IP packet for some reason */
 137 void
 138 sctp_abort_association(struct sctp_inpcb *, struct sctp_tcb *,
 139     struct mbuf *, int, struct sctphdr *, struct mbuf *);
 140
 141 /* We choose to abort via user input */
 142 void
 143 sctp_abort_an_association(struct sctp_inpcb *, struct sctp_tcb *, int,
 144     struct mbuf *);
 145
 146 void
 147 sctp_handle_ootb(struct mbuf *, int, int, struct sctphdr *,
 148     struct sctp_inpcb *, struct mbuf *);
 149
 150 int sctp_is_there_an_abort_here(struct mbuf *, int, uint32_t *);
 151 uint32_t sctp_is_same_scope(struct sockaddr_in6 *, struct sockaddr_in6 *);
 152 struct sockaddr_in6 *
 153 sctp_recover_scope(struct sockaddr_in6 *,
 154     struct sockaddr_in6 *);
 155
 156
 157
 158
 159 #define sctp_recover_scope_mac(addr, store) do { \
 160                          if ((addr->sin6_family == AF_INET6) && \
 161                              (IN6_IS_SCOPE_LINKLOCAL(&addr->sin6_addr)) && \
 162                              (addr->sin6_scope_id == 0)) { \
 163                                 *store = *addr; \
 164                                 if (!sa6_recoverscope(store)) { \
 165                                         addr = store; \
 166                                 } \
 167                          } \
 168                       } while (0)
 169
 170
 171
 172 int sctp_cmpaddr(struct sockaddr *, struct sockaddr *);
 173
 174 void sctp_print_address(struct sockaddr *);
 175 void sctp_print_address_pkt(struct ip *, struct sctphdr *);
 176
 177 void
 178 sctp_notify_partial_delivery_indication(struct sctp_tcb *stcb,
 179     uint32_t error, int no_lock);
 180
 181 int
 182 sctp_release_pr_sctp_chunk(struct sctp_tcb *, struct sctp_tmit_chunk *,
 183     int, struct sctpchunk_listhead *);
 184
 185 struct mbuf *sctp_generate_invmanparam(int);
 186
 187
 188 #ifdef SCTP_MBCNT_LOGGING
 189 void
 190 sctp_free_bufspace(struct sctp_tcb *, struct sctp_association *,
 191     struct sctp_tmit_chunk *);
 192
 193 #else
 194 #define sctp_free_bufspace(stcb, asoc, tp1, chk_cnt)  \
 195 do { \
 196         if (tp1->data != NULL) { \
 197                 atomic_add_int(&((asoc)->chunks_on_out_queue), -chk_cnt); \
 198                 if ((asoc)->total_output_queue_size >= tp1->book_size) { \
 199                         atomic_add_int(&((asoc)->total_output_queue_size), -tp1->book_size); \
 200                 } else { \
 201                         (asoc)->total_output_queue_size = 0; \
 202                 } \
 203                 if (stcb->sctp_socket && ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \
 204                     (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \
 205                         if (stcb->sctp_socket->so_snd.sb_cc >= tp1->book_size) { \
 206                                 atomic_add_int(&((stcb)->sctp_socket->so_snd.sb_cc), -tp1->book_size); \
 207                         } else { \
 208                                 stcb->sctp_socket->so_snd.sb_cc = 0; \
 209                         } \
 210                 } \
 211         } \
 212 } while (0)
 213
 214 #endif
 215
 216 #define sctp_free_spbufspace(stcb, asoc, sp)  \
 217 do { \
 218         if (sp->data != NULL) { \
 219                 atomic_add_int(&(asoc)->chunks_on_out_queue, -1); \
 220                 if ((asoc)->total_output_queue_size >= sp->length) { \
 221                         atomic_add_int(&(asoc)->total_output_queue_size,sp->length); \
 222                 } else { \
 223                         (asoc)->total_output_queue_size = 0; \
 224                 } \
 225                 if (stcb->sctp_socket && ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \
 226                     (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \
 227                         if (stcb->sctp_socket->so_snd.sb_cc >= sp->length) { \
 228                                 atomic_add_int(&stcb->sctp_socket->so_snd.sb_cc,sp->length); \
 229                         } else { \
 230                                 stcb->sctp_socket->so_snd.sb_cc = 0; \
 231                         } \
 232                 } \
 233         } \
 234 } while (0)
 235
 236 #define sctp_snd_sb_alloc(stcb, sz)  \
 237 do { \
 238         atomic_add_int(&stcb->asoc.total_output_queue_size,sz); \
 239         if ((stcb->sctp_socket != NULL) && \
 240             ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \
 241              (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \
 242                 atomic_add_int(&stcb->sctp_socket->so_snd.sb_cc,sz); \
 243         } \
 244 } while (0)
 245
 246
 247 int
 248 sctp_soreceive(struct socket *so, struct sockaddr **psa,
 249     struct uio *uio,
 250     struct mbuf **mp0,
 251     struct mbuf **controlp,
 252     int *flagsp);
 253
 254
 255 #ifdef SCTP_STAT_LOGGING
 256 void
 257      sctp_misc_ints(uint8_t from, uint32_t a, uint32_t b, uint32_t c, uint32_t d);
 258
 259 void
 260 sctp_wakeup_log(struct sctp_tcb *stcb,
 261     uint32_t cumtsn,
 262     uint32_t wake_cnt, int from);
 263
 264 void sctp_log_strm_del_alt(struct sctp_tcb *stcb, uint32_t, uint16_t, uint16_t, int);
 265
 266 void sctp_log_nagle_event(struct sctp_tcb *stcb, int action);
 267
 268
 269 void
 270      sctp_log_mb(struct mbuf *m, int from);
 271
 272 void
 273 sctp_sblog(struct sockbuf *sb,
 274     struct sctp_tcb *stcb, int from, int incr);
 275
 276 void
 277 sctp_log_strm_del(struct sctp_queued_to_read *control,
 278     struct sctp_queued_to_read *poschk,
 279     int from);
 280 void sctp_log_cwnd(struct sctp_tcb *stcb, struct sctp_nets *, int, uint8_t);
 281 void rto_logging(struct sctp_nets *net, int from);
 282
 283 void sctp_log_closing(struct sctp_inpcb *inp, struct sctp_tcb *stcb, int16_t loc);
 284
 285 void sctp_log_lock(struct sctp_inpcb *inp, struct sctp_tcb *stcb, uint8_t from);
 286 void sctp_log_maxburst(struct sctp_tcb *stcb, struct sctp_nets *, int, int, uint8_t);
 287 void sctp_log_block(uint8_t, struct socket *, struct sctp_association *, int);
 288 void sctp_log_rwnd(uint8_t, uint32_t, uint32_t, uint32_t);
 289 void sctp_log_mbcnt(uint8_t, uint32_t, uint32_t, uint32_t, uint32_t);
 290 void sctp_log_rwnd_set(uint8_t, uint32_t, uint32_t, uint32_t, uint32_t);
 291 int sctp_fill_stat_log(struct mbuf *);
 292 void sctp_log_fr(uint32_t, uint32_t, uint32_t, int);
 293 void sctp_log_sack(uint32_t, uint32_t, uint32_t, uint16_t, uint16_t, int);
 294 void sctp_log_map(uint32_t, uint32_t, uint32_t, int);
 295
 296 void sctp_clr_stat_log(void);
 297
 298 #endif
 299
 300 #ifdef SCTP_AUDITING_ENABLED
 301 void
 302 sctp_auditing(int, struct sctp_inpcb *, struct sctp_tcb *,
 303     struct sctp_nets *);
 304 void sctp_audit_log(uint8_t, uint8_t);
 305
 306 #endif
 307
 308
 309 #endif                          /* _KERNEL */
 310 #endif