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