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 269376 2014-08-01 12:42:37Z 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 struct mbuf * 150 sctp_add_pad_tombuf(struct mbuf *, int); 151 152 struct mbuf * 153 sctp_pad_lastmbuf(struct mbuf *, int, struct mbuf *); 154 155 void sctp_ulp_notify(uint32_t, struct sctp_tcb *, uint32_t, void *, int 156 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 157 SCTP_UNUSED 158 #endif 159 ); 160 161 void 162 sctp_pull_off_control_to_new_inp(struct sctp_inpcb *old_inp, 163 struct sctp_inpcb *new_inp, 164 struct sctp_tcb *stcb, int waitflags); 165 166 167 void sctp_stop_timers_for_shutdown(struct sctp_tcb *); 168 169 void sctp_report_all_outbound(struct sctp_tcb *, uint16_t, int, int 170 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 171 SCTP_UNUSED 172 #endif 173 ); 174 175 int sctp_expand_mapping_array(struct sctp_association *, uint32_t); 176 177 void sctp_abort_notification(struct sctp_tcb *, uint8_t, uint16_t, 178 struct sctp_abort_chunk *, int 179 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 180 SCTP_UNUSED 181 #endif 182 ); 183 184 /* We abort responding to an IP packet for some reason */ 185 void 186 sctp_abort_association(struct sctp_inpcb *, struct sctp_tcb *, struct mbuf *, 187 int, struct sockaddr *, struct sockaddr *, 188 struct sctphdr *, struct mbuf *, 189 #if defined(__FreeBSD__) 190 uint8_t, uint32_t, 191 #endif 192 uint32_t, uint16_t); 193 194 195 /* We choose to abort via user input */ 196 void 197 sctp_abort_an_association(struct sctp_inpcb *, struct sctp_tcb *, 198 struct mbuf *, int 199 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 200 SCTP_UNUSED 201 #endif 202 ); 203 204 void sctp_handle_ootb(struct mbuf *, int, int, 205 struct sockaddr *, struct sockaddr *, 206 struct sctphdr *, struct sctp_inpcb *, 207 struct mbuf *, 208 #if defined(__FreeBSD__) 209 uint8_t, uint32_t, 210 #endif 211 uint32_t, uint16_t); 212 213 int sctp_connectx_helper_add(struct sctp_tcb *stcb, struct sockaddr *addr, 214 int totaddr, int *error); 215 216 struct sctp_tcb * 217 sctp_connectx_helper_find(struct sctp_inpcb *inp, struct sockaddr *addr, 218 int *totaddr, int *num_v4, int *num_v6, int *error, int limit, int *bad_addr); 219 220 int sctp_is_there_an_abort_here(struct mbuf *, int, uint32_t *); 221 #ifdef INET6 222 uint32_t sctp_is_same_scope(struct sockaddr_in6 *, struct sockaddr_in6 *); 223 224 #if defined(SCTP_EMBEDDED_V6_SCOPE) 225 struct sockaddr_in6 * 226 sctp_recover_scope(struct sockaddr_in6 *, struct sockaddr_in6 *); 227 228 #ifdef SCTP_KAME 229 #define sctp_recover_scope_mac(addr, store) do { \ 230 if ((addr->sin6_family == AF_INET6) && \ 231 (IN6_IS_SCOPE_LINKLOCAL(&addr->sin6_addr))) { \ 232 *store = *addr; \ 233 if (addr->sin6_scope_id == 0) { \ 234 if (!sa6_recoverscope(store)) { \ 235 addr = store; \ 236 } \ 237 } else { \ 238 in6_clearscope(&addr->sin6_addr); \ 239 addr = store; \ 240 } \ 241 } \ 242 } while (0) 243 #else 244 #define sctp_recover_scope_mac(addr, store) do { \ 245 if ((addr->sin6_family == AF_INET6) && \ 246 (IN6_IS_SCOPE_LINKLOCAL(&addr->sin6_addr))) { \ 247 *store = *addr; \ 248 if (addr->sin6_scope_id == 0) { \ 249 if (!in6_recoverscope(store, &store->sin6_addr, \ 250 NULL)) { \ 251 addr = store; \ 252 } \ 253 } else { \ 254 in6_clearscope(&addr->sin6_addr); \ 255 addr = store; \ 256 } \ 257 } \ 258 } while (0) 259 #endif 260 #endif 261 #endif 262 263 int sctp_cmpaddr(struct sockaddr *, struct sockaddr *); 264 265 void sctp_print_address(struct sockaddr *); 266 267 int 268 sctp_release_pr_sctp_chunk(struct sctp_tcb *, struct sctp_tmit_chunk *, 269 uint8_t, int 270 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 271 SCTP_UNUSED 272 #endif 273 ); 274 275 struct mbuf *sctp_generate_cause(uint16_t, char *); 276 struct mbuf *sctp_generate_no_user_data_cause(uint32_t); 277 278 void sctp_bindx_add_address(struct socket *so, struct sctp_inpcb *inp, 279 struct sockaddr *sa, sctp_assoc_t assoc_id, 280 uint32_t vrf_id, int *error, void *p); 281 void sctp_bindx_delete_address(struct sctp_inpcb *inp, 282 struct sockaddr *sa, sctp_assoc_t assoc_id, 283 uint32_t vrf_id, int *error); 284 285 int sctp_local_addr_count(struct sctp_tcb *stcb); 286 287 #ifdef SCTP_MBCNT_LOGGING 288 void 289 sctp_free_bufspace(struct sctp_tcb *, struct sctp_association *, 290 struct sctp_tmit_chunk *, int); 291 292 #else 293 #define sctp_free_bufspace(stcb, asoc, tp1, chk_cnt) \ 294 do { \ 295 if (tp1->data != NULL) { \ 296 atomic_subtract_int(&((asoc)->chunks_on_out_queue), chk_cnt); \ 297 if ((asoc)->total_output_queue_size >= tp1->book_size) { \ 298 atomic_subtract_int(&((asoc)->total_output_queue_size), tp1->book_size); \ 299 } else { \ 300 (asoc)->total_output_queue_size = 0; \ 301 } \ 302 if (stcb->sctp_socket && ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \ 303 (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \ 304 if (stcb->sctp_socket->so_snd.sb_cc >= tp1->book_size) { \ 305 atomic_subtract_int(&((stcb)->sctp_socket->so_snd.sb_cc), tp1->book_size); \ 306 } else { \ 307 stcb->sctp_socket->so_snd.sb_cc = 0; \ 308 } \ 309 } \ 310 } \ 311 } while (0) 312 313 #endif 314 315 #define sctp_free_spbufspace(stcb, asoc, sp) \ 316 do { \ 317 if (sp->data != NULL) { \ 318 if ((asoc)->total_output_queue_size >= sp->length) { \ 319 atomic_subtract_int(&(asoc)->total_output_queue_size, sp->length); \ 320 } else { \ 321 (asoc)->total_output_queue_size = 0; \ 322 } \ 323 if (stcb->sctp_socket && ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \ 324 (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \ 325 if (stcb->sctp_socket->so_snd.sb_cc >= sp->length) { \ 326 atomic_subtract_int(&stcb->sctp_socket->so_snd.sb_cc,sp->length); \ 327 } else { \ 328 stcb->sctp_socket->so_snd.sb_cc = 0; \ 329 } \ 330 } \ 331 } \ 332 } while (0) 333 334 #define sctp_snd_sb_alloc(stcb, sz) \ 335 do { \ 336 atomic_add_int(&stcb->asoc.total_output_queue_size,sz); \ 337 if ((stcb->sctp_socket != NULL) && \ 338 ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \ 339 (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \ 340 atomic_add_int(&stcb->sctp_socket->so_snd.sb_cc,sz); \ 341 } \ 342 } while (0) 343 344 /* functions to start/stop udp tunneling */ 345 #if defined(__APPLE__) || defined(__FreeBSD__) 346 void sctp_over_udp_stop(void); 347 int sctp_over_udp_start(void); 348 #endif 349 #if defined(__Windows__) 350 void sctp_over_udp_restart(void); 351 #endif 352 353 int 354 sctp_soreceive(struct socket *so, struct sockaddr **psa, 355 struct uio *uio, 356 struct mbuf **mp0, 357 struct mbuf **controlp, 358 int *flagsp); 359 360 void 361 sctp_misc_ints(uint8_t from, uint32_t a, uint32_t b, uint32_t c, uint32_t d); 362 363 void 364 sctp_wakeup_log(struct sctp_tcb *stcb, 365 uint32_t wake_cnt, int from); 366 367 void sctp_log_strm_del_alt(struct sctp_tcb *stcb, uint32_t, uint16_t, uint16_t, int); 368 369 void sctp_log_nagle_event(struct sctp_tcb *stcb, int action); 370 371 372 void 373 sctp_log_mb(struct mbuf *m, int from); 374 375 void 376 sctp_sblog(struct sockbuf *sb, 377 struct sctp_tcb *stcb, int from, int incr); 378 379 void 380 sctp_log_strm_del(struct sctp_queued_to_read *control, 381 struct sctp_queued_to_read *poschk, 382 int from); 383 void sctp_log_cwnd(struct sctp_tcb *stcb, struct sctp_nets *, int, uint8_t); 384 void rto_logging(struct sctp_nets *net, int from); 385 386 void sctp_log_closing(struct sctp_inpcb *inp, struct sctp_tcb *stcb, int16_t loc); 387 388 void sctp_log_lock(struct sctp_inpcb *inp, struct sctp_tcb *stcb, uint8_t from); 389 void sctp_log_maxburst(struct sctp_tcb *stcb, struct sctp_nets *, int, int, uint8_t); 390 void sctp_log_block(uint8_t, struct sctp_association *, int); 391 void sctp_log_rwnd(uint8_t, uint32_t, uint32_t, uint32_t); 392 void sctp_log_mbcnt(uint8_t, uint32_t, uint32_t, uint32_t, uint32_t); 393 void sctp_log_rwnd_set(uint8_t, uint32_t, uint32_t, uint32_t, uint32_t); 394 int sctp_fill_stat_log(void *, size_t *); 395 void sctp_log_fr(uint32_t, uint32_t, uint32_t, int); 396 void sctp_log_sack(uint32_t, uint32_t, uint32_t, uint16_t, uint16_t, int); 397 void sctp_log_map(uint32_t, uint32_t, uint32_t, int); 398 void sctp_print_mapping_array(struct sctp_association *asoc); 399 void sctp_clr_stat_log(void); 400 401 402 #ifdef SCTP_AUDITING_ENABLED 403 void 404 sctp_auditing(int, struct sctp_inpcb *, struct sctp_tcb *, 405 struct sctp_nets *); 406 void sctp_audit_log(uint8_t, uint8_t); 407 408 #endif 409 #endif /* _KERNEL */ 410 #endif 411