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