1 /*- 2 * Copyright (c) 2001-2007, by Cisco Systems, Inc. All rights reserved. 3 * Copyright (c) 2008-2012, by Randall Stewart. All rights reserved. 4 * Copyright (c) 2008-2012, by Michael Tuexen. All rights reserved. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions are met: 8 * 9 * a) Redistributions of source code must retain the above copyright notice, 10 * this list of conditions and the following disclaimer. 11 * 12 * b) Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in 14 * the documentation and/or other materials provided with the distribution. 15 * 16 * c) Neither the name of Cisco Systems, Inc. nor the names of its 17 * contributors may be used to endorse or promote products derived 18 * from this software without specific prior written permission. 19 * 20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 22 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 30 * THE POSSIBILITY OF SUCH DAMAGE. 31 */ 32 33 #ifdef __FreeBSD__ 34 #include <sys/cdefs.h> 35 __FBSDID("$FreeBSD: head/sys/netinet/sctputil.h 264679 2014-04-19 19:21:06Z tuexen $"); 36 #endif 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 uint32_t 70 sctp_get_ifa_hash_val(struct sockaddr *addr); 71 72 struct sctp_ifa * 73 sctp_find_ifa_in_ep(struct sctp_inpcb *inp, struct sockaddr *addr, int hold_lock); 74 75 struct sctp_ifa * 76 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); 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 void 93 sctp_timer_start(int, struct sctp_inpcb *, struct sctp_tcb *, 94 struct sctp_nets *); 95 96 void 97 sctp_timer_stop(int, struct sctp_inpcb *, struct sctp_tcb *, 98 struct sctp_nets *, uint32_t); 99 100 int 101 sctp_dynamic_set_primary(struct sockaddr *sa, uint32_t vrf_id); 102 103 void 104 sctp_mtu_size_reset(struct sctp_inpcb *, struct sctp_association *, uint32_t); 105 106 void 107 sctp_add_to_readq(struct sctp_inpcb *inp, 108 struct sctp_tcb *stcb, 109 struct sctp_queued_to_read *control, 110 struct sockbuf *sb, 111 int end, 112 int inpread_locked, 113 int so_locked 114 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 115 SCTP_UNUSED 116 #endif 117 ); 118 119 int 120 sctp_append_to_readq(struct sctp_inpcb *inp, 121 struct sctp_tcb *stcb, 122 struct sctp_queued_to_read *control, 123 struct mbuf *m, 124 int end, 125 int new_cumack, 126 struct sockbuf *sb); 127 128 129 void sctp_iterator_worker(void); 130 131 uint32_t sctp_get_prev_mtu(uint32_t); 132 uint32_t sctp_get_next_mtu(uint32_t); 133 134 void 135 sctp_timeout_handler(void *); 136 137 uint32_t 138 sctp_calculate_rto(struct sctp_tcb *, struct sctp_association *, 139 struct sctp_nets *, struct timeval *, int, int); 140 141 uint32_t sctp_calculate_len(struct mbuf *); 142 143 caddr_t sctp_m_getptr(struct mbuf *, int, int, uint8_t *); 144 145 struct sctp_paramhdr * 146 sctp_get_next_param(struct mbuf *, int, 147 struct sctp_paramhdr *, int); 148 149 int sctp_add_pad_tombuf(struct mbuf *, int); 150 151 int sctp_pad_lastmbuf(struct mbuf *, int, struct mbuf *); 152 153 void 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 void sctp_report_all_outbound(struct sctp_tcb *, uint16_t, int, int 168 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 169 SCTP_UNUSED 170 #endif 171 ); 172 173 int sctp_expand_mapping_array(struct sctp_association *, uint32_t); 174 175 void sctp_abort_notification(struct sctp_tcb *, uint8_t, uint16_t, 176 struct sctp_abort_chunk *, int 177 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 178 SCTP_UNUSED 179 #endif 180 ); 181 182 /* We abort responding to an IP packet for some reason */ 183 void 184 sctp_abort_association(struct sctp_inpcb *, struct sctp_tcb *, struct mbuf *, 185 int, struct sockaddr *, struct sockaddr *, 186 struct sctphdr *, struct mbuf *, 187 #if defined(__FreeBSD__) 188 uint8_t, uint32_t, 189 #endif 190 uint32_t, uint16_t); 191 192 193 /* We choose to abort via user input */ 194 void 195 sctp_abort_an_association(struct sctp_inpcb *, struct sctp_tcb *, 196 struct mbuf *, int 197 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 198 SCTP_UNUSED 199 #endif 200 ); 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__) 207 uint8_t, uint32_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 struct sctp_tcb * 215 sctp_connectx_helper_find(struct sctp_inpcb *inp, struct sockaddr *addr, 216 int *totaddr, int *num_v4, int *num_v6, int *error, int limit, int *bad_addr); 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 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 269 SCTP_UNUSED 270 #endif 271 ); 272 273 struct mbuf *sctp_generate_cause(uint16_t, char *); 274 struct mbuf *sctp_generate_no_user_data_cause(uint32_t); 275 276 void sctp_bindx_add_address(struct socket *so, struct sctp_inpcb *inp, 277 struct sockaddr *sa, sctp_assoc_t assoc_id, 278 uint32_t vrf_id, int *error, void *p); 279 void sctp_bindx_delete_address(struct sctp_inpcb *inp, 280 struct sockaddr *sa, sctp_assoc_t assoc_id, 281 uint32_t vrf_id, int *error); 282 283 int sctp_local_addr_count(struct sctp_tcb *stcb); 284 285 #ifdef SCTP_MBCNT_LOGGING 286 void 287 sctp_free_bufspace(struct sctp_tcb *, struct sctp_association *, 288 struct sctp_tmit_chunk *, int); 289 290 #else 291 #define sctp_free_bufspace(stcb, asoc, tp1, chk_cnt) \ 292 do { \ 293 if (tp1->data != NULL) { \ 294 atomic_subtract_int(&((asoc)->chunks_on_out_queue), chk_cnt); \ 295 if ((asoc)->total_output_queue_size >= tp1->book_size) { \ 296 atomic_subtract_int(&((asoc)->total_output_queue_size), tp1->book_size); \ 297 } else { \ 298 (asoc)->total_output_queue_size = 0; \ 299 } \ 300 if (stcb->sctp_socket && ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \ 301 (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \ 302 if (stcb->sctp_socket->so_snd.sb_cc >= tp1->book_size) { \ 303 atomic_subtract_int(&((stcb)->sctp_socket->so_snd.sb_cc), tp1->book_size); \ 304 } else { \ 305 stcb->sctp_socket->so_snd.sb_cc = 0; \ 306 } \ 307 } \ 308 } \ 309 } while (0) 310 311 #endif 312 313 #define sctp_free_spbufspace(stcb, asoc, sp) \ 314 do { \ 315 if (sp->data != NULL) { \ 316 if ((asoc)->total_output_queue_size >= sp->length) { \ 317 atomic_subtract_int(&(asoc)->total_output_queue_size, sp->length); \ 318 } else { \ 319 (asoc)->total_output_queue_size = 0; \ 320 } \ 321 if (stcb->sctp_socket && ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \ 322 (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \ 323 if (stcb->sctp_socket->so_snd.sb_cc >= sp->length) { \ 324 atomic_subtract_int(&stcb->sctp_socket->so_snd.sb_cc,sp->length); \ 325 } else { \ 326 stcb->sctp_socket->so_snd.sb_cc = 0; \ 327 } \ 328 } \ 329 } \ 330 } while (0) 331 332 #define sctp_snd_sb_alloc(stcb, sz) \ 333 do { \ 334 atomic_add_int(&stcb->asoc.total_output_queue_size,sz); \ 335 if ((stcb->sctp_socket != NULL) && \ 336 ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \ 337 (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \ 338 atomic_add_int(&stcb->sctp_socket->so_snd.sb_cc,sz); \ 339 } \ 340 } while (0) 341 342 /* functions to start/stop udp tunneling */ 343 #if defined(__APPLE__) || defined(__FreeBSD__) 344 void sctp_over_udp_stop(void); 345 int sctp_over_udp_start(void); 346 #endif 347 #if defined(__Windows__) 348 void sctp_over_udp_restart(void); 349 #endif 350 351 int 352 sctp_soreceive(struct socket *so, struct sockaddr **psa, 353 struct uio *uio, 354 struct mbuf **mp0, 355 struct mbuf **controlp, 356 int *flagsp); 357 358 void 359 sctp_misc_ints(uint8_t from, uint32_t a, uint32_t b, uint32_t c, uint32_t d); 360 361 void 362 sctp_wakeup_log(struct sctp_tcb *stcb, 363 uint32_t wake_cnt, int from); 364 365 void sctp_log_strm_del_alt(struct sctp_tcb *stcb, uint32_t, uint16_t, uint16_t, int); 366 367 void sctp_log_nagle_event(struct sctp_tcb *stcb, int action); 368 369 370 void 371 sctp_log_mb(struct mbuf *m, int from); 372 373 void 374 sctp_sblog(struct sockbuf *sb, 375 struct sctp_tcb *stcb, int from, int incr); 376 377 void 378 sctp_log_strm_del(struct sctp_queued_to_read *control, 379 struct sctp_queued_to_read *poschk, 380 int from); 381 void sctp_log_cwnd(struct sctp_tcb *stcb, struct sctp_nets *, int, uint8_t); 382 void rto_logging(struct sctp_nets *net, int from); 383 384 void sctp_log_closing(struct sctp_inpcb *inp, struct sctp_tcb *stcb, int16_t loc); 385 386 void sctp_log_lock(struct sctp_inpcb *inp, struct sctp_tcb *stcb, uint8_t from); 387 void sctp_log_maxburst(struct sctp_tcb *stcb, struct sctp_nets *, int, int, uint8_t); 388 void sctp_log_block(uint8_t, struct sctp_association *, int); 389 void sctp_log_rwnd(uint8_t, uint32_t, uint32_t, uint32_t); 390 void sctp_log_mbcnt(uint8_t, uint32_t, uint32_t, uint32_t, uint32_t); 391 void sctp_log_rwnd_set(uint8_t, uint32_t, uint32_t, uint32_t, uint32_t); 392 int sctp_fill_stat_log(void *, size_t *); 393 void sctp_log_fr(uint32_t, uint32_t, uint32_t, int); 394 void sctp_log_sack(uint32_t, uint32_t, uint32_t, uint16_t, uint16_t, int); 395 void sctp_log_map(uint32_t, uint32_t, uint32_t, int); 396 void sctp_print_mapping_array(struct sctp_association *asoc); 397 void sctp_clr_stat_log(void); 398 399 400 #ifdef SCTP_AUDITING_ENABLED 401 void 402 sctp_auditing(int, struct sctp_inpcb *, struct sctp_tcb *, 403 struct sctp_nets *); 404 void sctp_audit_log(uint8_t, uint8_t); 405 406 #endif 407 #endif /* _KERNEL */ 408 #endif 409
