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 #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)
  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  * Function prototypes
  65  */
  66 int32_t
  67         sctp_map_assoc_state(int);
  68
  69 uint32_t
  70          sctp_get_ifa_hash_val(struct sockaddr *addr);
  71
  72 struct sctp_ifa *sctp_find_ifa_in_ep(struct sctp_inpcb *inp, struct sockaddr *addr, int hold_lock);
  73
  74 struct sctp_ifa *sctp_find_ifa_by_addr(struct sockaddr *addr, uint32_t vrf_id, int holds_lock);
  75
  76 uint32_t sctp_select_initial_TSN(struct sctp_pcb *);
  77
  78 uint32_t sctp_select_a_tag(struct sctp_inpcb *, uint16_t lport, uint16_t rport, int);
  79
  80 int sctp_init_asoc(struct sctp_inpcb *, struct sctp_tcb *, uint32_t, uint32_t, uint32_t, uint16_t);
  81
  82 void sctp_fill_random_store(struct sctp_pcb *);
  83
  84 void
  85 sctp_notify_stream_reset_add(struct sctp_tcb *stcb, uint16_t numberin,
  86     uint16_t numberout, int flag);
  87 void
  88      sctp_notify_stream_reset_tsn(struct sctp_tcb *stcb, uint32_t sending_tsn, uint32_t recv_tsn, int flag);
  89
  90 /*
  91  * NOTE: sctp_timer_start() will increment the reference count of any relevant
  92  * structure the timer is referencing, in order to prevent a race condition
  93  * between the timer executing and the structure being freed.
  94  *
  95  * When the timer fires or sctp_timer_stop() is called, these references are
  96  * removed.
  97  */
  98 void
  99 sctp_timer_start(int, struct sctp_inpcb *, struct sctp_tcb *,
 100     struct sctp_nets *);
 101
 102 void
 103 sctp_timer_stop(int, struct sctp_inpcb *, struct sctp_tcb *,
 104     struct sctp_nets *, uint32_t);
 105
 106 int
 107     sctp_dynamic_set_primary(struct sockaddr *sa, uint32_t vrf_id);
 108
 109 void
 110 sctp_wakeup_the_read_socket(struct sctp_inpcb *inp, struct sctp_tcb *stcb,
 111     int so_locked
 112     SCTP_UNUSED
 113 );
 114
 115 void
 116 sctp_add_to_readq(struct sctp_inpcb *inp,
 117     struct sctp_tcb *stcb,
 118     struct sctp_queued_to_read *control,
 119     struct sockbuf *sb,
 120     int end,
 121     int inpread_locked,
 122     int so_locked);
 123
 124 void sctp_iterator_worker(void);
 125
 126 uint32_t sctp_get_prev_mtu(uint32_t);
 127 uint32_t sctp_get_next_mtu(uint32_t);
 128
 129 void
 130      sctp_timeout_handler(void *);
 131
 132 int
 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 struct mbuf *sctp_add_pad_tombuf(struct mbuf *, int);
 145
 146 struct mbuf *sctp_pad_lastmbuf(struct mbuf *, int, struct mbuf *);
 147
 148 void sctp_ulp_notify(uint32_t, struct sctp_tcb *, uint32_t, void *, int);
 149
 150 void
 151 sctp_pull_off_control_to_new_inp(struct sctp_inpcb *old_inp,
 152     struct sctp_inpcb *new_inp,
 153     struct sctp_tcb *stcb, int waitflags);
 154
 155 void sctp_stop_timers_for_shutdown(struct sctp_tcb *);
 156
 157 /* Stop all timers for association and remote addresses. */
 158 void sctp_stop_association_timers(struct sctp_tcb *, bool);
 159
 160 void sctp_report_all_outbound(struct sctp_tcb *, uint16_t, int);
 161
 162 int sctp_expand_mapping_array(struct sctp_association *, uint32_t);
 163
 164 void
 165 sctp_abort_notification(struct sctp_tcb *, bool, bool, uint16_t,
 166     struct sctp_abort_chunk *, int);
 167
 168 /* We abort responding to an IP packet for some reason */
 169 void
 170 sctp_abort_association(struct sctp_inpcb *, struct sctp_tcb *, struct mbuf *,
 171     int, struct sockaddr *, struct sockaddr *,
 172     struct sctphdr *, struct mbuf *,
 173     uint8_t, uint32_t,
 174     uint32_t, uint16_t);
 175
 176 /* We choose to abort via user input */
 177 void
 178 sctp_abort_an_association(struct sctp_inpcb *, struct sctp_tcb *,
 179     struct mbuf *, bool, int);
 180
 181 void
 182 sctp_handle_ootb(struct mbuf *, int, int,
 183     struct sockaddr *, struct sockaddr *,
 184     struct sctphdr *, struct sctp_inpcb *,
 185     struct mbuf *,
 186     uint8_t, uint32_t, uint16_t,
 187     uint32_t, uint16_t);
 188
 189 int
 190 sctp_connectx_helper_add(struct sctp_tcb *stcb, struct sockaddr *addr,
 191     int totaddr, int *error);
 192
 193 int
 194 sctp_connectx_helper_find(struct sctp_inpcb *, struct sockaddr *,
 195     unsigned int, unsigned int *, unsigned int *, unsigned int);
 196
 197 int sctp_is_there_an_abort_here(struct mbuf *, int, uint32_t *);
 198 #ifdef INET6
 199 uint32_t sctp_is_same_scope(struct sockaddr_in6 *, struct sockaddr_in6 *);
 200
 201 struct sockaddr_in6 *sctp_recover_scope(struct sockaddr_in6 *, struct sockaddr_in6 *);
 202
 203 #define sctp_recover_scope_mac(addr, store) do { \
 204          if ((addr->sin6_family == AF_INET6) && \
 205              (IN6_IS_SCOPE_LINKLOCAL(&addr->sin6_addr))) { \
 206                 *store = *addr; \
 207                 if (addr->sin6_scope_id == 0) { \
 208                         if (!sa6_recoverscope(store)) { \
 209                                 addr = store; \
 210                         } \
 211                 } else { \
 212                         in6_clearscope(&addr->sin6_addr); \
 213                         addr = store; \
 214                 } \
 215          } \
 216 } while (0)
 217 #endif
 218
 219 int sctp_cmpaddr(struct sockaddr *, struct sockaddr *);
 220
 221 void sctp_print_address(struct sockaddr *);
 222
 223 int
 224 sctp_release_pr_sctp_chunk(struct sctp_tcb *, struct sctp_tmit_chunk *,
 225     uint8_t, int);
 226
 227 struct mbuf *sctp_generate_cause(uint16_t, char *);
 228 struct mbuf *sctp_generate_no_user_data_cause(uint32_t);
 229
 230 void
 231 sctp_bindx_add_address(struct socket *so, struct sctp_inpcb *inp,
 232     struct sockaddr *sa, uint32_t vrf_id, int *error,
 233     void *p);
 234 void
 235 sctp_bindx_delete_address(struct sctp_inpcb *inp, struct sockaddr *sa,
 236     uint32_t vrf_id, int *error);
 237
 238 int sctp_local_addr_count(struct sctp_tcb *stcb);
 239
 240 void
 241 sctp_free_bufspace(struct sctp_tcb *, struct sctp_association *,
 242     struct sctp_tmit_chunk *, int);
 243
 244 #define sctp_free_spbufspace(stcb, asoc, sp)  \
 245 do { \
 246         if (sp->data != NULL) { \
 247                 if ((asoc)->total_output_queue_size >= sp->length) { \
 248                         atomic_subtract_int(&(asoc)->total_output_queue_size, sp->length); \
 249                 } else { \
 250                         (asoc)->total_output_queue_size = 0; \
 251                 } \
 252                 if (stcb->sctp_socket && ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \
 253                     (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \
 254                         if (stcb->sctp_socket->so_snd.sb_cc >= sp->length) { \
 255                                 atomic_subtract_int(&stcb->sctp_socket->so_snd.sb_cc,sp->length); \
 256                         } else { \
 257                                 stcb->sctp_socket->so_snd.sb_cc = 0; \
 258                         } \
 259                 } \
 260         } \
 261 } while (0)
 262
 263 #define sctp_snd_sb_alloc(stcb, sz)  \
 264 do { \
 265         atomic_add_int(&stcb->asoc.total_output_queue_size,sz); \
 266         if ((stcb->sctp_socket != NULL) && \
 267             ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \
 268              (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \
 269                 atomic_add_int(&stcb->sctp_socket->so_snd.sb_cc,sz); \
 270         } \
 271 } while (0)
 272
 273 /* functions to start/stop udp tunneling */
 274 void sctp_over_udp_stop(void);
 275 int sctp_over_udp_start(void);
 276
 277 int
 278 sctp_soreceive(struct socket *so, struct sockaddr **psa,
 279     struct uio *uio,
 280     struct mbuf **mp0,
 281     struct mbuf **controlp,
 282     int *flagsp);
 283
 284 void
 285      sctp_misc_ints(uint8_t from, uint32_t a, uint32_t b, uint32_t c, uint32_t d);
 286
 287 void
 288 sctp_wakeup_log(struct sctp_tcb *stcb,
 289     uint32_t wake_cnt, int from);
 290
 291 void sctp_log_strm_del_alt(struct sctp_tcb *stcb, uint32_t, uint16_t, uint16_t, int);
 292
 293 void sctp_log_nagle_event(struct sctp_tcb *stcb, int action);
 294
 295 #ifdef SCTP_MBUF_LOGGING
 296 void
 297      sctp_log_mb(struct mbuf *m, int from);
 298
 299 void
 300      sctp_log_mbc(struct mbuf *m, int from);
 301 #endif
 302
 303 void
 304 sctp_sblog(struct sockbuf *sb,
 305     struct sctp_tcb *stcb, int from, int incr);
 306
 307 void
 308 sctp_log_strm_del(struct sctp_queued_to_read *control,
 309     struct sctp_queued_to_read *poschk,
 310     int from);
 311 void sctp_log_cwnd(struct sctp_tcb *stcb, struct sctp_nets *, int, uint8_t);
 312 void rto_logging(struct sctp_nets *net, int from);
 313
 314 void sctp_log_closing(struct sctp_inpcb *inp, struct sctp_tcb *stcb, int16_t loc);
 315
 316 void sctp_log_lock(struct sctp_inpcb *inp, struct sctp_tcb *stcb, uint8_t from);
 317 void sctp_log_maxburst(struct sctp_tcb *stcb, struct sctp_nets *, int, int, uint8_t);
 318 void sctp_log_block(uint8_t, struct sctp_association *, ssize_t);
 319 void sctp_log_rwnd(uint8_t, uint32_t, uint32_t, uint32_t);
 320 void sctp_log_rwnd_set(uint8_t, uint32_t, uint32_t, uint32_t, uint32_t);
 321 int sctp_fill_stat_log(void *, size_t *);
 322 void sctp_log_fr(uint32_t, uint32_t, uint32_t, int);
 323 void sctp_log_sack(uint32_t, uint32_t, uint32_t, uint16_t, uint16_t, int);
 324 void sctp_log_map(uint32_t, uint32_t, uint32_t, int);
 325 void sctp_print_mapping_array(struct sctp_association *asoc);
 326 void sctp_clr_stat_log(void);
 327
 328 #ifdef SCTP_AUDITING_ENABLED
 329 void
 330 sctp_auditing(int, struct sctp_inpcb *, struct sctp_tcb *,
 331     struct sctp_nets *);
 332 void sctp_audit_log(uint8_t, uint8_t);
 333
 334 #endif
 335 uint32_t sctp_min_mtu(uint32_t, uint32_t, uint32_t);
 336 void sctp_hc_set_mtu(union sctp_sockstore *, uint16_t, uint32_t);
 337 uint32_t sctp_hc_get_mtu(union sctp_sockstore *, uint16_t);
 338 void sctp_set_state(struct sctp_tcb *, int);
 339 void sctp_add_substate(struct sctp_tcb *, int);
 340 uint32_t sctp_ticks_to_msecs(uint32_t);
 341 uint32_t sctp_msecs_to_ticks(uint32_t);
 342 uint32_t sctp_ticks_to_secs(uint32_t);
 343 uint32_t sctp_secs_to_ticks(uint32_t);
 344
 345 #endif                          /* _KERNEL */
 346 #endif