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