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