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