sys/netinet/sctputil.h

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