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) || defined(__APPLE__)
  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 *
  76          sctp_find_ifa_in_ep(struct sctp_inpcb *inp, struct sockaddr *addr, int hold_lock);
  77
  78 struct sctp_ifa *
  79          sctp_find_ifa_by_addr(struct sockaddr *addr, uint32_t vrf_id, int holds_lock);
  80
  81 uint32_t sctp_select_initial_TSN(struct sctp_pcb *);
  82
  83 uint32_t sctp_select_a_tag(struct sctp_inpcb *, uint16_t lport, uint16_t rport, int);
  84
  85 int sctp_init_asoc(struct sctp_inpcb *, struct sctp_tcb *, uint32_t, uint32_t, uint16_t);
  86
  87 void sctp_fill_random_store(struct sctp_pcb *);
  88
  89 void
  90 sctp_notify_stream_reset_add(struct sctp_tcb *stcb, uint16_t numberin,
  91     uint16_t numberout, int flag);
  92 void
  93      sctp_notify_stream_reset_tsn(struct sctp_tcb *stcb, uint32_t sending_tsn, uint32_t recv_tsn, int flag);
  94
  95 void
  96 sctp_timer_start(int, struct sctp_inpcb *, struct sctp_tcb *,
  97     struct sctp_nets *);
  98
  99 void
 100 sctp_timer_stop(int, struct sctp_inpcb *, struct sctp_tcb *,
 101     struct sctp_nets *, uint32_t);
 102
 103 int
 104     sctp_dynamic_set_primary(struct sockaddr *sa, uint32_t vrf_id);
 105
 106 void
 107      sctp_mtu_size_reset(struct sctp_inpcb *, struct sctp_association *, uint32_t);
 108
 109 void
 110 sctp_wakeup_the_read_socket(struct sctp_inpcb *inp, struct sctp_tcb *stcb,
 111     int so_locked
 112 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING)
 113     SCTP_UNUSED
 114 #endif
 115 );
 116
 117 void
 118 sctp_add_to_readq(struct sctp_inpcb *inp,
 119     struct sctp_tcb *stcb,
 120     struct sctp_queued_to_read *control,
 121     struct sockbuf *sb,
 122     int end,
 123     int inpread_locked,
 124     int so_locked
 125 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING)
 126     SCTP_UNUSED
 127 #endif
 128 );
 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 uint32_t
 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 *
 151      sctp_add_pad_tombuf(struct mbuf *, int);
 152
 153 struct mbuf *
 154      sctp_pad_lastmbuf(struct mbuf *, int, struct mbuf *);
 155
 156 void
 157 sctp_ulp_notify(uint32_t, struct sctp_tcb *, uint32_t, void *, int
 158 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING)
 159     SCTP_UNUSED
 160 #endif
 161 );
 162
 163 void
 164 sctp_pull_off_control_to_new_inp(struct sctp_inpcb *old_inp,
 165     struct sctp_inpcb *new_inp,
 166     struct sctp_tcb *stcb, int waitflags);
 167
 168
 169 void sctp_stop_timers_for_shutdown(struct sctp_tcb *);
 170
 171 void
 172 sctp_report_all_outbound(struct sctp_tcb *, uint16_t, int, int
 173 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING)
 174     SCTP_UNUSED
 175 #endif
 176 );
 177
 178 int sctp_expand_mapping_array(struct sctp_association *, uint32_t);
 179
 180 void
 181 sctp_abort_notification(struct sctp_tcb *, uint8_t, uint16_t,
 182     struct sctp_abort_chunk *, int
 183 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING)
 184     SCTP_UNUSED
 185 #endif
 186 );
 187
 188 /* We abort responding to an IP packet for some reason */
 189 void
 190 sctp_abort_association(struct sctp_inpcb *, struct sctp_tcb *, struct mbuf *,
 191     int, struct sockaddr *, struct sockaddr *,
 192     struct sctphdr *, struct mbuf *,
 193     uint8_t, uint32_t,
 194     uint32_t, uint16_t);
 195
 196
 197 /* We choose to abort via user input */
 198 void
 199 sctp_abort_an_association(struct sctp_inpcb *, struct sctp_tcb *,
 200     struct mbuf *, int
 201 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING)
 202     SCTP_UNUSED
 203 #endif
 204 );
 205
 206 void
 207 sctp_handle_ootb(struct mbuf *, int, int,
 208     struct sockaddr *, struct sockaddr *,
 209     struct sctphdr *, struct sctp_inpcb *,
 210     struct mbuf *,
 211     uint8_t, uint32_t, uint16_t,
 212     uint32_t, uint16_t);
 213
 214 int
 215 sctp_connectx_helper_add(struct sctp_tcb *stcb, struct sockaddr *addr,
 216     int totaddr, int *error);
 217
 218 struct sctp_tcb *
 219 sctp_connectx_helper_find(struct sctp_inpcb *inp, struct sockaddr *addr,
 220     unsigned int *totaddr, unsigned int *num_v4, unsigned int *num_v6,
 221     int *error, unsigned int limit, int *bad_addr);
 222
 223 int sctp_is_there_an_abort_here(struct mbuf *, int, uint32_t *);
 224 #ifdef INET6
 225 uint32_t sctp_is_same_scope(struct sockaddr_in6 *, struct sockaddr_in6 *);
 226
 227 struct sockaddr_in6 *
 228              sctp_recover_scope(struct sockaddr_in6 *, struct sockaddr_in6 *);
 229
 230 #define sctp_recover_scope_mac(addr, store) do { \
 231          if ((addr->sin6_family == AF_INET6) && \
 232              (IN6_IS_SCOPE_LINKLOCAL(&addr->sin6_addr))) { \
 233                 *store = *addr; \
 234                 if (addr->sin6_scope_id == 0) { \
 235                         if (!sa6_recoverscope(store)) { \
 236                                 addr = store; \
 237                         } \
 238                 } else { \
 239                         in6_clearscope(&addr->sin6_addr); \
 240                         addr = store; \
 241                 } \
 242          } \
 243 } while (0)
 244 #endif
 245
 246 int sctp_cmpaddr(struct sockaddr *, struct sockaddr *);
 247
 248 void sctp_print_address(struct sockaddr *);
 249
 250 int
 251 sctp_release_pr_sctp_chunk(struct sctp_tcb *, struct sctp_tmit_chunk *,
 252     uint8_t, int
 253 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING)
 254     SCTP_UNUSED
 255 #endif
 256 );
 257
 258 struct mbuf *sctp_generate_cause(uint16_t, char *);
 259 struct mbuf *sctp_generate_no_user_data_cause(uint32_t);
 260
 261 void
 262 sctp_bindx_add_address(struct socket *so, struct sctp_inpcb *inp,
 263     struct sockaddr *sa, sctp_assoc_t assoc_id,
 264     uint32_t vrf_id, int *error, void *p);
 265 void
 266 sctp_bindx_delete_address(struct sctp_inpcb *inp,
 267     struct sockaddr *sa, sctp_assoc_t assoc_id,
 268     uint32_t vrf_id, int *error);
 269
 270 int sctp_local_addr_count(struct sctp_tcb *stcb);
 271
 272 #ifdef SCTP_MBCNT_LOGGING
 273 void
 274 sctp_free_bufspace(struct sctp_tcb *, struct sctp_association *,
 275     struct sctp_tmit_chunk *, int);
 276
 277 #else
 278 #define sctp_free_bufspace(stcb, asoc, tp1, chk_cnt)  \
 279 do { \
 280         if (tp1->data != NULL) { \
 281                 atomic_subtract_int(&((asoc)->chunks_on_out_queue), chk_cnt); \
 282                 if ((asoc)->total_output_queue_size >= tp1->book_size) { \
 283                         atomic_subtract_int(&((asoc)->total_output_queue_size), tp1->book_size); \
 284                 } else { \
 285                         (asoc)->total_output_queue_size = 0; \
 286                 } \
 287                 if (stcb->sctp_socket && ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \
 288                     (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \
 289                         if (stcb->sctp_socket->so_snd.sb_cc >= tp1->book_size) { \
 290                                 atomic_subtract_int(&((stcb)->sctp_socket->so_snd.sb_cc), tp1->book_size); \
 291                         } else { \
 292                                 stcb->sctp_socket->so_snd.sb_cc = 0; \
 293                         } \
 294                 } \
 295         } \
 296 } while (0)
 297
 298 #endif
 299
 300 #define sctp_free_spbufspace(stcb, asoc, sp)  \
 301 do { \
 302         if (sp->data != NULL) { \
 303                 if ((asoc)->total_output_queue_size >= sp->length) { \
 304                         atomic_subtract_int(&(asoc)->total_output_queue_size, sp->length); \
 305                 } else { \
 306                         (asoc)->total_output_queue_size = 0; \
 307                 } \
 308                 if (stcb->sctp_socket && ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \
 309                     (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \
 310                         if (stcb->sctp_socket->so_snd.sb_cc >= sp->length) { \
 311                                 atomic_subtract_int(&stcb->sctp_socket->so_snd.sb_cc,sp->length); \
 312                         } else { \
 313                                 stcb->sctp_socket->so_snd.sb_cc = 0; \
 314                         } \
 315                 } \
 316         } \
 317 } while (0)
 318
 319 #define sctp_snd_sb_alloc(stcb, sz)  \
 320 do { \
 321         atomic_add_int(&stcb->asoc.total_output_queue_size,sz); \
 322         if ((stcb->sctp_socket != NULL) && \
 323             ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \
 324              (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \
 325                 atomic_add_int(&stcb->sctp_socket->so_snd.sb_cc,sz); \
 326         } \
 327 } while (0)
 328
 329 /* functions to start/stop udp tunneling */
 330 void sctp_over_udp_stop(void);
 331 int sctp_over_udp_start(void);
 332
 333 int
 334 sctp_soreceive(struct socket *so, struct sockaddr **psa,
 335     struct uio *uio,
 336     struct mbuf **mp0,
 337     struct mbuf **controlp,
 338     int *flagsp);
 339
 340 void
 341      sctp_misc_ints(uint8_t from, uint32_t a, uint32_t b, uint32_t c, uint32_t d);
 342
 343 void
 344 sctp_wakeup_log(struct sctp_tcb *stcb,
 345     uint32_t wake_cnt, int from);
 346
 347 void sctp_log_strm_del_alt(struct sctp_tcb *stcb, uint32_t, uint16_t, uint16_t, int);
 348
 349 void sctp_log_nagle_event(struct sctp_tcb *stcb, int action);
 350
 351
 352 #ifdef SCTP_MBUF_LOGGING
 353 void
 354      sctp_log_mb(struct mbuf *m, int from);
 355
 356 void
 357      sctp_log_mbc(struct mbuf *m, int from);
 358 #endif
 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 sctp_association *, size_t);
 376 void sctp_log_rwnd(uint8_t, uint32_t, uint32_t, uint32_t);
 377 void sctp_log_rwnd_set(uint8_t, uint32_t, uint32_t, uint32_t, uint32_t);
 378 int sctp_fill_stat_log(void *, size_t *);
 379 void sctp_log_fr(uint32_t, uint32_t, uint32_t, int);
 380 void sctp_log_sack(uint32_t, uint32_t, uint32_t, uint16_t, uint16_t, int);
 381 void sctp_log_map(uint32_t, uint32_t, uint32_t, int);
 382 void sctp_print_mapping_array(struct sctp_association *asoc);
 383 void sctp_clr_stat_log(void);
 384
 385
 386 #ifdef SCTP_AUDITING_ENABLED
 387 void
 388 sctp_auditing(int, struct sctp_inpcb *, struct sctp_tcb *,
 389     struct sctp_nets *);
 390 void sctp_audit_log(uint8_t, uint8_t);
 391
 392 #endif
 393 uint32_t sctp_min_mtu(uint32_t, uint32_t, uint32_t);
 394 void sctp_hc_set_mtu(union sctp_sockstore *, uint16_t, uint32_t);
 395 uint32_t sctp_hc_get_mtu(union sctp_sockstore *, uint16_t);
 396 #endif                          /* _KERNEL */
 397 #endif