sys/netinet/sctputil.h

   1 /*-
   2  * Copyright (c) 2001-2007, by Cisco Systems, Inc. All rights reserved.
   3  * Copyright (c) 2008-2012, by Randall Stewart. All rights reserved.
   4  * Copyright (c) 2008-2012, by Michael Tuexen. All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions are met:
   8  *
   9  * a) Redistributions of source code must retain the above copyright notice,
  10  *    this list of conditions and the following disclaimer.
  11  *
  12  * b) Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in
  14  *    the documentation and/or other materials provided with the distribution.
  15  *
  16  * c) Neither the name of Cisco Systems, Inc. nor the names of its
  17  *    contributors may be used to endorse or promote products derived
  18  *    from this software without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  22  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  24  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  30  * THE POSSIBILITY OF SUCH DAMAGE.
  31  */
  32
  33 #include <sys/cdefs.h>
  34 __FBSDID("$FreeBSD$");
  35
  36 #ifndef _NETINET_SCTP_UTIL_H_
  37 #define _NETINET_SCTP_UTIL_H_
  38
  39 #if defined(_KERNEL) || defined(__Userspace__)
  40
  41 #define SCTP_READ_LOCK_HELD 1
  42 #define SCTP_READ_LOCK_NOT_HELD 0
  43
  44 #ifdef SCTP_ASOCLOG_OF_TSNS
  45 void sctp_print_out_track_log(struct sctp_tcb *stcb);
  46 #endif
  47
  48 #ifdef SCTP_MBUF_LOGGING
  49 struct mbuf *sctp_m_free(struct mbuf *m);
  50 void sctp_m_freem(struct mbuf *m);
  51 #else
  52 #define sctp_m_free m_free
  53 #define sctp_m_freem m_freem
  54 #endif
  55
  56 #if defined(SCTP_LOCAL_TRACE_BUF) || defined(__APPLE__)
  57 void
  58      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);
  59 #endif
  60
  61 #define sctp_get_associd(stcb) ((sctp_assoc_t)stcb->asoc.assoc_id)
  62
  63
  64 /*
  65  * Function prototypes
  66  */
  67 int32_t
  68         sctp_map_assoc_state(int);
  69
  70 uint32_t
  71          sctp_get_ifa_hash_val(struct sockaddr *addr);
  72
  73 struct sctp_ifa *sctp_find_ifa_in_ep(struct sctp_inpcb *inp, struct sockaddr *addr, int hold_lock);
  74
  75 struct sctp_ifa *sctp_find_ifa_by_addr(struct sockaddr *addr, uint32_t vrf_id, int holds_lock);
  76
  77 uint32_t sctp_select_initial_TSN(struct sctp_pcb *);
  78
  79 uint32_t sctp_select_a_tag(struct sctp_inpcb *, uint16_t lport, uint16_t rport, int);
  80
  81 int sctp_init_asoc(struct sctp_inpcb *, struct sctp_tcb *, uint32_t, uint32_t, uint16_t);
  82
  83 void sctp_fill_random_store(struct sctp_pcb *);
  84
  85 void
  86 sctp_notify_stream_reset_add(struct sctp_tcb *stcb, uint16_t numberin,
  87     uint16_t numberout, int flag);
  88 void
  89      sctp_notify_stream_reset_tsn(struct sctp_tcb *stcb, uint32_t sending_tsn, uint32_t recv_tsn, int flag);
  90
  91 void
  92 sctp_timer_start(int, struct sctp_inpcb *, struct sctp_tcb *,
  93     struct sctp_nets *);
  94
  95 void
  96 sctp_timer_stop(int, struct sctp_inpcb *, struct sctp_tcb *,
  97     struct sctp_nets *, uint32_t);
  98
  99 int
 100     sctp_dynamic_set_primary(struct sockaddr *sa, uint32_t vrf_id);
 101
 102 void
 103      sctp_mtu_size_reset(struct sctp_inpcb *, struct sctp_association *, uint32_t);
 104
 105 void
 106 sctp_wakeup_the_read_socket(struct sctp_inpcb *inp, struct sctp_tcb *stcb,
 107     int so_locked
 108 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING)
 109     SCTP_UNUSED
 110 #endif
 111 );
 112
 113 void
 114 sctp_add_to_readq(struct sctp_inpcb *inp,
 115     struct sctp_tcb *stcb,
 116     struct sctp_queued_to_read *control,
 117     struct sockbuf *sb,
 118     int end,
 119     int inpread_locked,
 120     int so_locked
 121 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING)
 122     SCTP_UNUSED
 123 #endif
 124 );
 125
 126 void sctp_iterator_worker(void);
 127
 128 uint32_t sctp_get_prev_mtu(uint32_t);
 129 uint32_t sctp_get_next_mtu(uint32_t);
 130
 131 void
 132      sctp_timeout_handler(void *);
 133
 134 uint32_t
 135 sctp_calculate_rto(struct sctp_tcb *, struct sctp_association *,
 136     struct sctp_nets *, struct timeval *, int);
 137
 138 uint32_t sctp_calculate_len(struct mbuf *);
 139
 140 caddr_t sctp_m_getptr(struct mbuf *, int, int, uint8_t *);
 141
 142 struct sctp_paramhdr *
 143 sctp_get_next_param(struct mbuf *, int,
 144     struct sctp_paramhdr *, int);
 145
 146 struct mbuf *sctp_add_pad_tombuf(struct mbuf *, int);
 147
 148 struct mbuf *sctp_pad_lastmbuf(struct mbuf *, int, struct mbuf *);
 149
 150 void
 151 sctp_ulp_notify(uint32_t, struct sctp_tcb *, uint32_t, void *, int
 152 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING)
 153     SCTP_UNUSED
 154 #endif
 155 );
 156
 157 void
 158 sctp_pull_off_control_to_new_inp(struct sctp_inpcb *old_inp,
 159     struct sctp_inpcb *new_inp,
 160     struct sctp_tcb *stcb, int waitflags);
 161
 162
 163 void sctp_stop_timers_for_shutdown(struct sctp_tcb *);
 164
 165 void
 166 sctp_report_all_outbound(struct sctp_tcb *, uint16_t, int
 167 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING)
 168     SCTP_UNUSED
 169 #endif
 170 );
 171
 172 int sctp_expand_mapping_array(struct sctp_association *, uint32_t);
 173
 174 void
 175 sctp_abort_notification(struct sctp_tcb *, uint8_t, uint16_t,
 176     struct sctp_abort_chunk *, int
 177 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING)
 178     SCTP_UNUSED
 179 #endif
 180 );
 181
 182 /* We abort responding to an IP packet for some reason */
 183 void
 184 sctp_abort_association(struct sctp_inpcb *, struct sctp_tcb *, struct mbuf *,
 185     int, struct sockaddr *, struct sockaddr *,
 186     struct sctphdr *, struct mbuf *,
 187     uint8_t, uint32_t,
 188     uint32_t, uint16_t);
 189
 190
 191 /* We choose to abort via user input */
 192 void
 193 sctp_abort_an_association(struct sctp_inpcb *, struct sctp_tcb *,
 194     struct mbuf *, int
 195 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING)
 196     SCTP_UNUSED
 197 #endif
 198 );
 199
 200 void
 201 sctp_handle_ootb(struct mbuf *, int, int,
 202     struct sockaddr *, struct sockaddr *,
 203     struct sctphdr *, struct sctp_inpcb *,
 204     struct mbuf *,
 205     uint8_t, uint32_t, uint16_t,
 206     uint32_t, uint16_t);
 207
 208 int
 209 sctp_connectx_helper_add(struct sctp_tcb *stcb, struct sockaddr *addr,
 210     int totaddr, int *error);
 211
 212 int
 213 sctp_connectx_helper_find(struct sctp_inpcb *, struct sockaddr *,
 214     unsigned int, unsigned int *, unsigned int *, unsigned int);
 215
 216 int sctp_is_there_an_abort_here(struct mbuf *, int, uint32_t *);
 217 #ifdef INET6
 218 uint32_t sctp_is_same_scope(struct sockaddr_in6 *, struct sockaddr_in6 *);
 219
 220 struct sockaddr_in6 *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 #endif
 237
 238 int sctp_cmpaddr(struct sockaddr *, struct sockaddr *);
 239
 240 void sctp_print_address(struct sockaddr *);
 241
 242 int
 243 sctp_release_pr_sctp_chunk(struct sctp_tcb *, struct sctp_tmit_chunk *,
 244     uint8_t, int
 245 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING)
 246     SCTP_UNUSED
 247 #endif
 248 );
 249
 250 struct mbuf *sctp_generate_cause(uint16_t, char *);
 251 struct mbuf *sctp_generate_no_user_data_cause(uint32_t);
 252
 253 void
 254 sctp_bindx_add_address(struct socket *so, struct sctp_inpcb *inp,
 255     struct sockaddr *sa, sctp_assoc_t assoc_id,
 256     uint32_t vrf_id, int *error, void *p);
 257 void
 258 sctp_bindx_delete_address(struct sctp_inpcb *inp,
 259     struct sockaddr *sa, sctp_assoc_t assoc_id,
 260     uint32_t vrf_id, int *error);
 261
 262 int sctp_local_addr_count(struct sctp_tcb *stcb);
 263
 264 #ifdef SCTP_MBCNT_LOGGING
 265 void
 266 sctp_free_bufspace(struct sctp_tcb *, struct sctp_association *,
 267     struct sctp_tmit_chunk *, int);
 268
 269 #else
 270 #define sctp_free_bufspace(stcb, asoc, tp1, chk_cnt)  \
 271 do { \
 272         if (tp1->data != NULL) { \
 273                 atomic_subtract_int(&((asoc)->chunks_on_out_queue), chk_cnt); \
 274                 if ((asoc)->total_output_queue_size >= tp1->book_size) { \
 275                         atomic_subtract_int(&((asoc)->total_output_queue_size), tp1->book_size); \
 276                 } else { \
 277                         (asoc)->total_output_queue_size = 0; \
 278                 } \
 279                 if (stcb->sctp_socket && ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \
 280                     (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \
 281                         if (stcb->sctp_socket->so_snd.sb_cc >= tp1->book_size) { \
 282                                 atomic_subtract_int(&((stcb)->sctp_socket->so_snd.sb_cc), tp1->book_size); \
 283                         } else { \
 284                                 stcb->sctp_socket->so_snd.sb_cc = 0; \
 285                         } \
 286                 } \
 287         } \
 288 } while (0)
 289
 290 #endif
 291
 292 #define sctp_free_spbufspace(stcb, asoc, sp)  \
 293 do { \
 294         if (sp->data != NULL) { \
 295                 if ((asoc)->total_output_queue_size >= sp->length) { \
 296                         atomic_subtract_int(&(asoc)->total_output_queue_size, sp->length); \
 297                 } else { \
 298                         (asoc)->total_output_queue_size = 0; \
 299                 } \
 300                 if (stcb->sctp_socket && ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \
 301                     (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \
 302                         if (stcb->sctp_socket->so_snd.sb_cc >= sp->length) { \
 303                                 atomic_subtract_int(&stcb->sctp_socket->so_snd.sb_cc,sp->length); \
 304                         } else { \
 305                                 stcb->sctp_socket->so_snd.sb_cc = 0; \
 306                         } \
 307                 } \
 308         } \
 309 } while (0)
 310
 311 #define sctp_snd_sb_alloc(stcb, sz)  \
 312 do { \
 313         atomic_add_int(&stcb->asoc.total_output_queue_size,sz); \
 314         if ((stcb->sctp_socket != NULL) && \
 315             ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \
 316              (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \
 317                 atomic_add_int(&stcb->sctp_socket->so_snd.sb_cc,sz); \
 318         } \
 319 } while (0)
 320
 321 /* functions to start/stop udp tunneling */
 322 void sctp_over_udp_stop(void);
 323 int sctp_over_udp_start(void);
 324
 325 int
 326 sctp_soreceive(struct socket *so, struct sockaddr **psa,
 327     struct uio *uio,
 328     struct mbuf **mp0,
 329     struct mbuf **controlp,
 330     int *flagsp);
 331
 332 void
 333      sctp_misc_ints(uint8_t from, uint32_t a, uint32_t b, uint32_t c, uint32_t d);
 334
 335 void
 336 sctp_wakeup_log(struct sctp_tcb *stcb,
 337     uint32_t wake_cnt, int from);
 338
 339 void sctp_log_strm_del_alt(struct sctp_tcb *stcb, uint32_t, uint16_t, uint16_t, int);
 340
 341 void sctp_log_nagle_event(struct sctp_tcb *stcb, int action);
 342
 343
 344 #ifdef SCTP_MBUF_LOGGING
 345 void
 346      sctp_log_mb(struct mbuf *m, int from);
 347
 348 void
 349      sctp_log_mbc(struct mbuf *m, int from);
 350 #endif
 351
 352 void
 353 sctp_sblog(struct sockbuf *sb,
 354     struct sctp_tcb *stcb, int from, int incr);
 355
 356 void
 357 sctp_log_strm_del(struct sctp_queued_to_read *control,
 358     struct sctp_queued_to_read *poschk,
 359     int from);
 360 void sctp_log_cwnd(struct sctp_tcb *stcb, struct sctp_nets *, int, uint8_t);
 361 void rto_logging(struct sctp_nets *net, int from);
 362
 363 void sctp_log_closing(struct sctp_inpcb *inp, struct sctp_tcb *stcb, int16_t loc);
 364
 365 void sctp_log_lock(struct sctp_inpcb *inp, struct sctp_tcb *stcb, uint8_t from);
 366 void sctp_log_maxburst(struct sctp_tcb *stcb, struct sctp_nets *, int, int, uint8_t);
 367 void sctp_log_block(uint8_t, struct sctp_association *, ssize_t);
 368 void sctp_log_rwnd(uint8_t, uint32_t, uint32_t, uint32_t);
 369 void sctp_log_rwnd_set(uint8_t, uint32_t, uint32_t, uint32_t, uint32_t);
 370 int sctp_fill_stat_log(void *, size_t *);
 371 void sctp_log_fr(uint32_t, uint32_t, uint32_t, int);
 372 void sctp_log_sack(uint32_t, uint32_t, uint32_t, uint16_t, uint16_t, int);
 373 void sctp_log_map(uint32_t, uint32_t, uint32_t, int);
 374 void sctp_print_mapping_array(struct sctp_association *asoc);
 375 void sctp_clr_stat_log(void);
 376
 377
 378 #ifdef SCTP_AUDITING_ENABLED
 379 void
 380 sctp_auditing(int, struct sctp_inpcb *, struct sctp_tcb *,
 381     struct sctp_nets *);
 382 void sctp_audit_log(uint8_t, uint8_t);
 383
 384 #endif
 385 #if defined(INET6) || defined(INET)
 386 uint32_t sctp_min_mtu(uint32_t, uint32_t, uint32_t);
 387 void sctp_hc_set_mtu(union sctp_sockstore *, uint16_t, uint32_t);
 388 uint32_t sctp_hc_get_mtu(union sctp_sockstore *, uint16_t);
 389 #endif
 390 #endif                          /* _KERNEL */
 391 #endif