sys/netinet/sctputil.h

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