sctputil.h (11963B)
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 #ifndef _NETINET_SCTP_UTIL_H_ 36 #define _NETINET_SCTP_UTIL_H_ 37 38 #if defined(_KERNEL) || defined(__Userspace__) 39 40 #define SCTP_READ_LOCK_HELD 1 41 #define SCTP_READ_LOCK_NOT_HELD 0 42 43 #ifdef SCTP_ASOCLOG_OF_TSNS 44 void sctp_print_out_track_log(struct sctp_tcb *stcb); 45 #endif 46 47 #ifdef SCTP_MBUF_LOGGING 48 struct mbuf *sctp_m_free(struct mbuf *m); 49 void sctp_m_freem(struct mbuf *m); 50 #else 51 #define sctp_m_free m_free 52 #define sctp_m_freem m_freem 53 #endif 54 55 #if defined(SCTP_LOCAL_TRACE_BUF) 56 void 57 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); 58 #endif 59 60 #define sctp_get_associd(stcb) ((sctp_assoc_t)stcb->asoc.assoc_id) 61 62 /* 63 * Function prototypes 64 */ 65 int32_t 66 sctp_map_assoc_state(int); 67 68 uint32_t 69 sctp_get_ifa_hash_val(struct sockaddr *addr); 70 71 struct sctp_ifa * 72 sctp_find_ifa_in_ep(struct sctp_inpcb *inp, struct sockaddr *addr, int hold_lock); 73 74 struct sctp_ifa * 75 sctp_find_ifa_by_addr(struct sockaddr *addr, uint32_t vrf_id, int holds_lock); 76 77 uint32_t sctp_select_initial_TSN(struct sctp_pcb *); 78 79 uint32_t sctp_select_a_tag(struct sctp_inpcb *, uint16_t lport, uint16_t rport, int); 80 81 int sctp_init_asoc(struct sctp_inpcb *, struct sctp_tcb *, uint32_t, uint32_t, uint32_t, uint16_t); 82 83 void sctp_fill_random_store(struct sctp_pcb *); 84 85 /* 86 * NOTE: sctp_timer_start() will increment the reference count of any relevant 87 * structure the timer is referencing, in order to prevent a race condition 88 * between the timer executing and the structure being freed. 89 * 90 * When the timer fires or sctp_timer_stop() is called, these references are 91 * removed. 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_wakeup_the_read_socket(struct sctp_inpcb *inp, struct sctp_tcb *stcb, 106 int so_locked 107 #if !(defined(__APPLE__) && !defined(__Userspace__)) 108 SCTP_UNUSED 109 #endif 110 ); 111 112 #if defined(__Userspace__) 113 void sctp_invoke_recv_callback(struct sctp_inpcb *, 114 struct sctp_tcb *, 115 struct sctp_queued_to_read *, 116 int); 117 118 #endif 119 void 120 sctp_add_to_readq(struct sctp_inpcb *inp, 121 struct sctp_tcb *stcb, 122 struct sctp_queued_to_read *control, 123 struct sockbuf *sb, 124 int end, 125 int inpread_locked, 126 int so_locked); 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 * 149 sctp_add_pad_tombuf(struct mbuf *, int); 150 151 struct mbuf * 152 sctp_pad_lastmbuf(struct mbuf *, int, struct mbuf *); 153 154 void sctp_ulp_notify(uint32_t, struct sctp_tcb *, uint32_t, void *, int); 155 156 void 157 sctp_pull_off_control_to_new_inp(struct sctp_inpcb *old_inp, 158 struct sctp_inpcb *new_inp, 159 struct sctp_tcb *stcb, int waitflags); 160 161 void sctp_stop_timers_for_shutdown(struct sctp_tcb *); 162 163 /* Stop all timers for association and remote addresses. */ 164 void sctp_stop_association_timers(struct sctp_tcb *, bool); 165 166 void sctp_report_all_outbound(struct sctp_tcb *, uint16_t, int); 167 168 int sctp_expand_mapping_array(struct sctp_association *, uint32_t); 169 170 void sctp_abort_notification(struct sctp_tcb *, bool, bool, uint16_t, 171 struct sctp_abort_chunk *, int); 172 173 /* We abort responding to an IP packet for some reason */ 174 void 175 sctp_abort_association(struct sctp_inpcb *, struct sctp_tcb *, struct mbuf *, 176 int, struct sockaddr *, struct sockaddr *, 177 struct sctphdr *, struct mbuf *, 178 #if defined(__FreeBSD__) && !defined(__Userspace__) 179 uint8_t, uint32_t, 180 #endif 181 uint32_t, uint16_t); 182 183 /* We choose to abort via user input */ 184 void 185 sctp_abort_an_association(struct sctp_inpcb *, struct sctp_tcb *, 186 struct mbuf *, bool, int); 187 188 void sctp_handle_ootb(struct mbuf *, int, int, 189 struct sockaddr *, struct sockaddr *, 190 struct sctphdr *, struct sctp_inpcb *, 191 struct mbuf *, 192 #if defined(__FreeBSD__) && !defined(__Userspace__) 193 uint8_t, uint32_t, uint16_t, 194 #endif 195 uint32_t, uint16_t); 196 197 int sctp_connectx_helper_add(struct sctp_tcb *stcb, struct sockaddr *addr, 198 int totaddr, int *error); 199 200 int 201 sctp_connectx_helper_find(struct sctp_inpcb *, struct sockaddr *, 202 unsigned int, unsigned int *, unsigned int *, unsigned int); 203 204 int sctp_is_there_an_abort_here(struct mbuf *, int, uint32_t *); 205 #ifdef INET6 206 uint32_t sctp_is_same_scope(struct sockaddr_in6 *, struct sockaddr_in6 *); 207 208 #if defined(SCTP_EMBEDDED_V6_SCOPE) 209 struct sockaddr_in6 * 210 sctp_recover_scope(struct sockaddr_in6 *, struct sockaddr_in6 *); 211 212 #ifdef SCTP_KAME 213 #define sctp_recover_scope_mac(addr, store) do { \ 214 if ((addr->sin6_family == AF_INET6) && \ 215 (IN6_IS_SCOPE_LINKLOCAL(&addr->sin6_addr))) { \ 216 *store = *addr; \ 217 if (addr->sin6_scope_id == 0) { \ 218 if (!sa6_recoverscope(store)) { \ 219 addr = store; \ 220 } \ 221 } else { \ 222 in6_clearscope(&addr->sin6_addr); \ 223 addr = store; \ 224 } \ 225 } \ 226 } while (0) 227 #else 228 #define sctp_recover_scope_mac(addr, store) do { \ 229 if ((addr->sin6_family == AF_INET6) && \ 230 (IN6_IS_SCOPE_LINKLOCAL(&addr->sin6_addr))) { \ 231 *store = *addr; \ 232 if (addr->sin6_scope_id == 0) { \ 233 if (!in6_recoverscope(store, &store->sin6_addr, \ 234 NULL)) { \ 235 addr = store; \ 236 } \ 237 } else { \ 238 in6_clearscope(&addr->sin6_addr); \ 239 addr = store; \ 240 } \ 241 } \ 242 } while (0) 243 #endif 244 #endif 245 #endif 246 247 int sctp_cmpaddr(struct sockaddr *, struct sockaddr *); 248 249 void sctp_print_address(struct sockaddr *); 250 251 int 252 sctp_release_pr_sctp_chunk(struct sctp_tcb *, struct sctp_tmit_chunk *, 253 uint8_t, int); 254 255 struct mbuf *sctp_generate_cause(uint16_t, char *); 256 struct mbuf *sctp_generate_no_user_data_cause(uint32_t); 257 258 void sctp_bindx_add_address(struct socket *so, struct sctp_inpcb *inp, 259 struct sockaddr *sa, uint32_t vrf_id, int *error, 260 void *p); 261 void sctp_bindx_delete_address(struct sctp_inpcb *inp, struct sockaddr *sa, 262 uint32_t vrf_id, int *error); 263 264 int sctp_local_addr_count(struct sctp_tcb *stcb); 265 266 void 267 sctp_free_bufspace(struct sctp_tcb *, struct sctp_association *, 268 struct sctp_tmit_chunk *, int); 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 SCTP_SB_DECR(&stcb->sctp_socket->so_snd, sp->length); \ 281 } \ 282 } \ 283 } while (0) 284 285 #define sctp_snd_sb_alloc(stcb, sz) \ 286 do { \ 287 atomic_add_int(&stcb->asoc.total_output_queue_size,sz); \ 288 if ((stcb->sctp_socket != NULL) && \ 289 ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \ 290 (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \ 291 SCTP_SB_INCR(&stcb->sctp_socket->so_snd, sz); \ 292 } \ 293 } while (0) 294 295 /* functions to start/stop udp tunneling */ 296 #if (defined(__APPLE__) || defined(__FreeBSD__)) && !defined(__Userspace__) 297 void sctp_over_udp_stop(void); 298 int sctp_over_udp_start(void); 299 #endif 300 #if defined(_WIN32) && !defined(__Userspace__) 301 void sctp_over_udp_restart(void); 302 #endif 303 304 int 305 sctp_soreceive(struct socket *so, struct sockaddr **psa, 306 struct uio *uio, 307 struct mbuf **mp0, 308 struct mbuf **controlp, 309 int *flagsp); 310 311 void 312 sctp_misc_ints(uint8_t from, uint32_t a, uint32_t b, uint32_t c, uint32_t d); 313 314 void 315 sctp_wakeup_log(struct sctp_tcb *stcb, 316 uint32_t wake_cnt, int from); 317 318 void sctp_log_strm_del_alt(struct sctp_tcb *stcb, uint32_t, uint16_t, uint16_t, int); 319 320 void sctp_log_nagle_event(struct sctp_tcb *stcb, int action); 321 322 #ifdef SCTP_MBUF_LOGGING 323 void 324 sctp_log_mb(struct mbuf *m, int from); 325 326 void 327 sctp_log_mbc(struct mbuf *m, int from); 328 #endif 329 330 void 331 sctp_sblog(struct sockbuf *sb, 332 struct sctp_tcb *stcb, int from, int incr); 333 334 void 335 sctp_log_strm_del(struct sctp_queued_to_read *control, 336 struct sctp_queued_to_read *poschk, 337 int from); 338 void sctp_log_cwnd(struct sctp_tcb *stcb, struct sctp_nets *, int, uint8_t); 339 void rto_logging(struct sctp_nets *net, int from); 340 341 void sctp_log_closing(struct sctp_inpcb *inp, struct sctp_tcb *stcb, int16_t loc); 342 343 void sctp_log_lock(struct sctp_inpcb *inp, struct sctp_tcb *stcb, uint8_t from); 344 void sctp_log_maxburst(struct sctp_tcb *stcb, struct sctp_nets *, int, int, uint8_t); 345 void sctp_log_block(uint8_t, struct sctp_association *, ssize_t); 346 void sctp_log_rwnd(uint8_t, uint32_t, uint32_t, uint32_t); 347 void sctp_log_rwnd_set(uint8_t, uint32_t, uint32_t, uint32_t, uint32_t); 348 int sctp_fill_stat_log(void *, size_t *); 349 void sctp_log_fr(uint32_t, uint32_t, uint32_t, int); 350 void sctp_log_sack(uint32_t, uint32_t, uint32_t, uint16_t, uint16_t, int); 351 void sctp_log_map(uint32_t, uint32_t, uint32_t, int); 352 void sctp_print_mapping_array(struct sctp_association *asoc); 353 void sctp_clr_stat_log(void); 354 355 #ifdef SCTP_AUDITING_ENABLED 356 void 357 sctp_auditing(int, struct sctp_inpcb *, struct sctp_tcb *, 358 struct sctp_nets *); 359 void sctp_audit_log(uint8_t, uint8_t); 360 361 #endif 362 uint32_t sctp_min_mtu(uint32_t, uint32_t, uint32_t); 363 #if defined(__FreeBSD__) && !defined(__Userspace__) 364 void sctp_hc_set_mtu(union sctp_sockstore *, uint16_t, uint32_t); 365 uint32_t sctp_hc_get_mtu(union sctp_sockstore *, uint16_t); 366 #endif 367 void sctp_set_state(struct sctp_tcb *, int); 368 void sctp_add_substate(struct sctp_tcb *, int); 369 uint32_t sctp_ticks_to_msecs(uint32_t); 370 uint32_t sctp_msecs_to_ticks(uint32_t); 371 uint32_t sctp_ticks_to_secs(uint32_t); 372 uint32_t sctp_secs_to_ticks(uint32_t); 373 374 #endif /* _KERNEL */ 375 #endif