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 *sctp_find_ifa_in_ep(struct sctp_inpcb *inp, struct sockaddr *addr, int hold_lock); 76 77 struct sctp_ifa *sctp_find_ifa_by_addr(struct sockaddr *addr, uint32_t vrf_id, int holds_lock); 78 79 uint32_t sctp_select_initial_TSN(struct sctp_pcb *); 80 81 uint32_t sctp_select_a_tag(struct sctp_inpcb *, uint16_t lport, uint16_t rport, int); 82 83 int sctp_init_asoc(struct sctp_inpcb *, struct sctp_tcb *, uint32_t, uint32_t, uint16_t); 84 85 void sctp_fill_random_store(struct sctp_pcb *); 86 87 void 88 sctp_notify_stream_reset_add(struct sctp_tcb *stcb, uint16_t numberin, 89 uint16_t numberout, int flag); 90 void 91 sctp_notify_stream_reset_tsn(struct sctp_tcb *stcb, uint32_t sending_tsn, uint32_t recv_tsn, int flag); 92 93 void 94 sctp_timer_start(int, struct sctp_inpcb *, struct sctp_tcb *, 95 struct sctp_nets *); 96 97 void 98 sctp_timer_stop(int, struct sctp_inpcb *, struct sctp_tcb *, 99 struct sctp_nets *, uint32_t); 100 101 int 102 sctp_dynamic_set_primary(struct sockaddr *sa, uint32_t vrf_id); 103 104 void 105 sctp_mtu_size_reset(struct sctp_inpcb *, struct sctp_association *, uint32_t); 106 107 void 108 sctp_wakeup_the_read_socket(struct sctp_inpcb *inp, struct sctp_tcb *stcb, 109 int so_locked 110 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 111 SCTP_UNUSED 112 #endif 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 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 124 SCTP_UNUSED 125 #endif 126 ); 127 128 void sctp_iterator_worker(void); 129 130 uint32_t sctp_get_prev_mtu(uint32_t); 131 uint32_t sctp_get_next_mtu(uint32_t); 132 133 void 134 sctp_timeout_handler(void *); 135 136 int 137 sctp_calculate_rto(struct sctp_tcb *, struct sctp_association *, 138 struct sctp_nets *, struct timeval *, int); 139 140 uint32_t sctp_calculate_len(struct mbuf *); 141 142 caddr_t sctp_m_getptr(struct mbuf *, int, int, uint8_t *); 143 144 struct sctp_paramhdr * 145 sctp_get_next_param(struct mbuf *, int, 146 struct sctp_paramhdr *, int); 147 148 struct mbuf *sctp_add_pad_tombuf(struct mbuf *, int); 149 150 struct mbuf *sctp_pad_lastmbuf(struct mbuf *, int, struct mbuf *); 151 152 void 153 sctp_ulp_notify(uint32_t, struct sctp_tcb *, uint32_t, void *, int 154 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 155 SCTP_UNUSED 156 #endif 157 ); 158 159 void 160 sctp_pull_off_control_to_new_inp(struct sctp_inpcb *old_inp, 161 struct sctp_inpcb *new_inp, 162 struct sctp_tcb *stcb, int waitflags); 163 164 165 void sctp_stop_timers_for_shutdown(struct sctp_tcb *); 166 167 /* Stop all timers for association and remote addresses. */ 168 void sctp_stop_association_timers(struct sctp_tcb *, bool); 169 170 void 171 sctp_report_all_outbound(struct sctp_tcb *, uint16_t, int, int 172 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 173 SCTP_UNUSED 174 #endif 175 ); 176 177 int sctp_expand_mapping_array(struct sctp_association *, uint32_t); 178 179 void 180 sctp_abort_notification(struct sctp_tcb *, uint8_t, uint16_t, 181 struct sctp_abort_chunk *, int 182 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 183 SCTP_UNUSED 184 #endif 185 ); 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 uint8_t, uint32_t, 193 uint32_t, uint16_t); 194 195 196 /* We choose to abort via user input */ 197 void 198 sctp_abort_an_association(struct sctp_inpcb *, struct sctp_tcb *, 199 struct mbuf *, int 200 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 201 SCTP_UNUSED 202 #endif 203 ); 204 205 void 206 sctp_handle_ootb(struct mbuf *, int, int, 207 struct sockaddr *, struct sockaddr *, 208 struct sctphdr *, struct sctp_inpcb *, 209 struct mbuf *, 210 uint8_t, uint32_t, uint16_t, 211 uint32_t, uint16_t); 212 213 int 214 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 struct sockaddr_in6 *sctp_recover_scope(struct sockaddr_in6 *, struct sockaddr_in6 *); 226 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 #endif 242 243 int sctp_cmpaddr(struct sockaddr *, struct sockaddr *); 244 245 void sctp_print_address(struct sockaddr *); 246 247 int 248 sctp_release_pr_sctp_chunk(struct sctp_tcb *, struct sctp_tmit_chunk *, 249 uint8_t, int 250 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 251 SCTP_UNUSED 252 #endif 253 ); 254 255 struct mbuf *sctp_generate_cause(uint16_t, char *); 256 struct mbuf *sctp_generate_no_user_data_cause(uint32_t); 257 258 void 259 sctp_bindx_add_address(struct socket *so, struct sctp_inpcb *inp, 260 struct sockaddr *sa, sctp_assoc_t assoc_id, 261 uint32_t vrf_id, int *error, void *p); 262 void 263 sctp_bindx_delete_address(struct sctp_inpcb *inp, 264 struct sockaddr *sa, sctp_assoc_t assoc_id, 265 uint32_t vrf_id, int *error); 266 267 int sctp_local_addr_count(struct sctp_tcb *stcb); 268 269 #ifdef SCTP_MBCNT_LOGGING 270 void 271 sctp_free_bufspace(struct sctp_tcb *, struct sctp_association *, 272 struct sctp_tmit_chunk *, int); 273 274 #else 275 #define sctp_free_bufspace(stcb, asoc, tp1, chk_cnt) \ 276 do { \ 277 if (tp1->data != NULL) { \ 278 atomic_subtract_int(&((asoc)->chunks_on_out_queue), chk_cnt); \ 279 if ((asoc)->total_output_queue_size >= tp1->book_size) { \ 280 atomic_subtract_int(&((asoc)->total_output_queue_size), tp1->book_size); \ 281 } else { \ 282 (asoc)->total_output_queue_size = 0; \ 283 } \ 284 if (stcb->sctp_socket && ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \ 285 (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \ 286 if (stcb->sctp_socket->so_snd.sb_cc >= tp1->book_size) { \ 287 atomic_subtract_int(&((stcb)->sctp_socket->so_snd.sb_cc), tp1->book_size); \ 288 } else { \ 289 stcb->sctp_socket->so_snd.sb_cc = 0; \ 290 } \ 291 } \ 292 } \ 293 } while (0) 294 295 #endif 296 297 #define sctp_free_spbufspace(stcb, asoc, sp) \ 298 do { \ 299 if (sp->data != NULL) { \ 300 if ((asoc)->total_output_queue_size >= sp->length) { \ 301 atomic_subtract_int(&(asoc)->total_output_queue_size, sp->length); \ 302 } else { \ 303 (asoc)->total_output_queue_size = 0; \ 304 } \ 305 if (stcb->sctp_socket && ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \ 306 (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \ 307 if (stcb->sctp_socket->so_snd.sb_cc >= sp->length) { \ 308 atomic_subtract_int(&stcb->sctp_socket->so_snd.sb_cc,sp->length); \ 309 } else { \ 310 stcb->sctp_socket->so_snd.sb_cc = 0; \ 311 } \ 312 } \ 313 } \ 314 } while (0) 315 316 #define sctp_snd_sb_alloc(stcb, sz) \ 317 do { \ 318 atomic_add_int(&stcb->asoc.total_output_queue_size,sz); \ 319 if ((stcb->sctp_socket != NULL) && \ 320 ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \ 321 (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \ 322 atomic_add_int(&stcb->sctp_socket->so_snd.sb_cc,sz); \ 323 } \ 324 } while (0) 325 326 /* functions to start/stop udp tunneling */ 327 void sctp_over_udp_stop(void); 328 int sctp_over_udp_start(void); 329 330 int 331 sctp_soreceive(struct socket *so, struct sockaddr **psa, 332 struct uio *uio, 333 struct mbuf **mp0, 334 struct mbuf **controlp, 335 int *flagsp); 336 337 void 338 sctp_misc_ints(uint8_t from, uint32_t a, uint32_t b, uint32_t c, uint32_t d); 339 340 void 341 sctp_wakeup_log(struct sctp_tcb *stcb, 342 uint32_t wake_cnt, int from); 343 344 void sctp_log_strm_del_alt(struct sctp_tcb *stcb, uint32_t, uint16_t, uint16_t, int); 345 346 void sctp_log_nagle_event(struct sctp_tcb *stcb, int action); 347 348 349 #ifdef SCTP_MBUF_LOGGING 350 void 351 sctp_log_mb(struct mbuf *m, int from); 352 353 void 354 sctp_log_mbc(struct mbuf *m, int from); 355 #endif 356 357 void 358 sctp_sblog(struct sockbuf *sb, 359 struct sctp_tcb *stcb, int from, int incr); 360 361 void 362 sctp_log_strm_del(struct sctp_queued_to_read *control, 363 struct sctp_queued_to_read *poschk, 364 int from); 365 void sctp_log_cwnd(struct sctp_tcb *stcb, struct sctp_nets *, int, uint8_t); 366 void rto_logging(struct sctp_nets *net, int from); 367 368 void sctp_log_closing(struct sctp_inpcb *inp, struct sctp_tcb *stcb, int16_t loc); 369 370 void sctp_log_lock(struct sctp_inpcb *inp, struct sctp_tcb *stcb, uint8_t from); 371 void sctp_log_maxburst(struct sctp_tcb *stcb, struct sctp_nets *, int, int, uint8_t); 372 void sctp_log_block(uint8_t, struct sctp_association *, ssize_t); 373 void sctp_log_rwnd(uint8_t, uint32_t, uint32_t, uint32_t); 374 void sctp_log_rwnd_set(uint8_t, uint32_t, uint32_t, uint32_t, uint32_t); 375 int sctp_fill_stat_log(void *, size_t *); 376 void sctp_log_fr(uint32_t, uint32_t, uint32_t, int); 377 void sctp_log_sack(uint32_t, uint32_t, uint32_t, uint16_t, uint16_t, int); 378 void sctp_log_map(uint32_t, uint32_t, uint32_t, int); 379 void sctp_print_mapping_array(struct sctp_association *asoc); 380 void sctp_clr_stat_log(void); 381 382 383 #ifdef SCTP_AUDITING_ENABLED 384 void 385 sctp_auditing(int, struct sctp_inpcb *, struct sctp_tcb *, 386 struct sctp_nets *); 387 void sctp_audit_log(uint8_t, uint8_t); 388 389 #endif 390 uint32_t sctp_min_mtu(uint32_t, uint32_t, uint32_t); 391 void sctp_hc_set_mtu(union sctp_sockstore *, uint16_t, uint32_t); 392 uint32_t sctp_hc_get_mtu(union sctp_sockstore *, uint16_t); 393 void sctp_set_state(struct sctp_tcb *, int); 394 void sctp_add_substate(struct sctp_tcb *, int); 395 #endif /* _KERNEL */ 396 #endif 397