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