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 #include <sys/cdefs.h> 34 __FBSDID("$FreeBSD$"); 35 36 #ifndef _NETINET_SCTP_UTIL_H_ 37 #define _NETINET_SCTP_UTIL_H_ 38 39 #if defined(_KERNEL) || defined(__Userspace__) 40 41 #define SCTP_READ_LOCK_HELD 1 42 #define SCTP_READ_LOCK_NOT_HELD 0 43 44 #ifdef SCTP_ASOCLOG_OF_TSNS 45 void sctp_print_out_track_log(struct sctp_tcb *stcb); 46 47 #endif 48 49 #ifdef SCTP_MBUF_LOGGING 50 struct mbuf *sctp_m_free(struct mbuf *m); 51 void sctp_m_freem(struct mbuf *m); 52 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 62 #endif 63 64 #define sctp_get_associd(stcb) ((sctp_assoc_t)stcb->asoc.assoc_id) 65 66 67 /* 68 * Function prototypes 69 */ 70 int32_t 71 sctp_map_assoc_state(int); 72 73 uint32_t 74 sctp_get_ifa_hash_val(struct sockaddr *addr); 75 76 struct sctp_ifa * 77 sctp_find_ifa_in_ep(struct sctp_inpcb *inp, struct sockaddr *addr, int hold_lock); 78 79 struct sctp_ifa * 80 sctp_find_ifa_by_addr(struct sockaddr *addr, uint32_t vrf_id, int holds_lock); 81 82 uint32_t sctp_select_initial_TSN(struct sctp_pcb *); 83 84 uint32_t sctp_select_a_tag(struct sctp_inpcb *, uint16_t lport, uint16_t rport, int); 85 86 int sctp_init_asoc(struct sctp_inpcb *, struct sctp_tcb *, uint32_t, uint32_t, uint16_t); 87 88 void sctp_fill_random_store(struct sctp_pcb *); 89 90 void 91 sctp_notify_stream_reset_add(struct sctp_tcb *stcb, uint16_t numberin, 92 uint16_t numberout, int flag); 93 void 94 sctp_notify_stream_reset_tsn(struct sctp_tcb *stcb, uint32_t sending_tsn, uint32_t recv_tsn, int flag); 95 96 void 97 sctp_timer_start(int, struct sctp_inpcb *, struct sctp_tcb *, 98 struct sctp_nets *); 99 100 void 101 sctp_timer_stop(int, struct sctp_inpcb *, struct sctp_tcb *, 102 struct sctp_nets *, uint32_t); 103 104 int 105 sctp_dynamic_set_primary(struct sockaddr *sa, uint32_t vrf_id); 106 107 void 108 sctp_mtu_size_reset(struct sctp_inpcb *, struct sctp_association *, uint32_t); 109 110 void 111 sctp_add_to_readq(struct sctp_inpcb *inp, 112 struct sctp_tcb *stcb, 113 struct sctp_queued_to_read *control, 114 struct sockbuf *sb, 115 int end, 116 int inpread_locked, 117 int so_locked 118 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 119 SCTP_UNUSED 120 #endif 121 ); 122 123 int 124 sctp_append_to_readq(struct sctp_inpcb *inp, 125 struct sctp_tcb *stcb, 126 struct sctp_queued_to_read *control, 127 struct mbuf *m, 128 int end, 129 int new_cumack, 130 struct sockbuf *sb); 131 132 133 void sctp_iterator_worker(void); 134 135 uint32_t sctp_get_prev_mtu(uint32_t); 136 uint32_t sctp_get_next_mtu(uint32_t); 137 138 void 139 sctp_timeout_handler(void *); 140 141 uint32_t 142 sctp_calculate_rto(struct sctp_tcb *, struct sctp_association *, 143 struct sctp_nets *, struct timeval *, int, int); 144 145 uint32_t sctp_calculate_len(struct mbuf *); 146 147 caddr_t sctp_m_getptr(struct mbuf *, int, int, uint8_t *); 148 149 struct sctp_paramhdr * 150 sctp_get_next_param(struct mbuf *, int, 151 struct sctp_paramhdr *, int); 152 153 struct mbuf * 154 sctp_add_pad_tombuf(struct mbuf *, int); 155 156 struct mbuf * 157 sctp_pad_lastmbuf(struct mbuf *, int, struct mbuf *); 158 159 void 160 sctp_ulp_notify(uint32_t, struct sctp_tcb *, uint32_t, void *, int 161 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 162 SCTP_UNUSED 163 #endif 164 ); 165 166 void 167 sctp_pull_off_control_to_new_inp(struct sctp_inpcb *old_inp, 168 struct sctp_inpcb *new_inp, 169 struct sctp_tcb *stcb, int waitflags); 170 171 172 void sctp_stop_timers_for_shutdown(struct sctp_tcb *); 173 174 void 175 sctp_report_all_outbound(struct sctp_tcb *, uint16_t, int, int 176 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 177 SCTP_UNUSED 178 #endif 179 ); 180 181 int sctp_expand_mapping_array(struct sctp_association *, uint32_t); 182 183 void 184 sctp_abort_notification(struct sctp_tcb *, uint8_t, uint16_t, 185 struct sctp_abort_chunk *, int 186 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 187 SCTP_UNUSED 188 #endif 189 ); 190 191 /* We abort responding to an IP packet for some reason */ 192 void 193 sctp_abort_association(struct sctp_inpcb *, struct sctp_tcb *, struct mbuf *, 194 int, struct sockaddr *, struct sockaddr *, 195 struct sctphdr *, struct mbuf *, 196 uint8_t, uint32_t, 197 uint32_t, uint16_t); 198 199 200 /* We choose to abort via user input */ 201 void 202 sctp_abort_an_association(struct sctp_inpcb *, struct sctp_tcb *, 203 struct mbuf *, int 204 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 205 SCTP_UNUSED 206 #endif 207 ); 208 209 void 210 sctp_handle_ootb(struct mbuf *, int, int, 211 struct sockaddr *, struct sockaddr *, 212 struct sctphdr *, struct sctp_inpcb *, 213 struct mbuf *, 214 uint8_t, uint32_t, uint16_t, 215 uint32_t, uint16_t); 216 217 int 218 sctp_connectx_helper_add(struct sctp_tcb *stcb, struct sockaddr *addr, 219 int totaddr, int *error); 220 221 struct sctp_tcb * 222 sctp_connectx_helper_find(struct sctp_inpcb *inp, struct sockaddr *addr, 223 int *totaddr, int *num_v4, int *num_v6, int *error, int limit, int *bad_addr); 224 225 int sctp_is_there_an_abort_here(struct mbuf *, int, uint32_t *); 226 227 #ifdef INET6 228 uint32_t sctp_is_same_scope(struct sockaddr_in6 *, struct sockaddr_in6 *); 229 230 struct sockaddr_in6 * 231 sctp_recover_scope(struct sockaddr_in6 *, struct sockaddr_in6 *); 232 233 #define sctp_recover_scope_mac(addr, store) do { \ 234 if ((addr->sin6_family == AF_INET6) && \ 235 (IN6_IS_SCOPE_LINKLOCAL(&addr->sin6_addr))) { \ 236 *store = *addr; \ 237 if (addr->sin6_scope_id == 0) { \ 238 if (!sa6_recoverscope(store)) { \ 239 addr = store; \ 240 } \ 241 } else { \ 242 in6_clearscope(&addr->sin6_addr); \ 243 addr = store; \ 244 } \ 245 } \ 246 } while (0) 247 #endif 248 249 int sctp_cmpaddr(struct sockaddr *, struct sockaddr *); 250 251 void sctp_print_address(struct sockaddr *); 252 253 int 254 sctp_release_pr_sctp_chunk(struct sctp_tcb *, struct sctp_tmit_chunk *, 255 uint8_t, int 256 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 257 SCTP_UNUSED 258 #endif 259 ); 260 261 struct mbuf *sctp_generate_cause(uint16_t, char *); 262 struct mbuf *sctp_generate_no_user_data_cause(uint32_t); 263 264 void 265 sctp_bindx_add_address(struct socket *so, struct sctp_inpcb *inp, 266 struct sockaddr *sa, sctp_assoc_t assoc_id, 267 uint32_t vrf_id, int *error, void *p); 268 void 269 sctp_bindx_delete_address(struct sctp_inpcb *inp, 270 struct sockaddr *sa, sctp_assoc_t assoc_id, 271 uint32_t vrf_id, int *error); 272 273 int sctp_local_addr_count(struct sctp_tcb *stcb); 274 275 #ifdef SCTP_MBCNT_LOGGING 276 void 277 sctp_free_bufspace(struct sctp_tcb *, struct sctp_association *, 278 struct sctp_tmit_chunk *, int); 279 280 #else 281 #define sctp_free_bufspace(stcb, asoc, tp1, chk_cnt) \ 282 do { \ 283 if (tp1->data != NULL) { \ 284 atomic_subtract_int(&((asoc)->chunks_on_out_queue), chk_cnt); \ 285 if ((asoc)->total_output_queue_size >= tp1->book_size) { \ 286 atomic_subtract_int(&((asoc)->total_output_queue_size), tp1->book_size); \ 287 } else { \ 288 (asoc)->total_output_queue_size = 0; \ 289 } \ 290 if (stcb->sctp_socket && ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \ 291 (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \ 292 if (stcb->sctp_socket->so_snd.sb_cc >= tp1->book_size) { \ 293 atomic_subtract_int(&((stcb)->sctp_socket->so_snd.sb_cc), tp1->book_size); \ 294 } else { \ 295 stcb->sctp_socket->so_snd.sb_cc = 0; \ 296 } \ 297 } \ 298 } \ 299 } while (0) 300 301 #endif 302 303 #define sctp_free_spbufspace(stcb, asoc, sp) \ 304 do { \ 305 if (sp->data != NULL) { \ 306 if ((asoc)->total_output_queue_size >= sp->length) { \ 307 atomic_subtract_int(&(asoc)->total_output_queue_size, sp->length); \ 308 } else { \ 309 (asoc)->total_output_queue_size = 0; \ 310 } \ 311 if (stcb->sctp_socket && ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \ 312 (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \ 313 if (stcb->sctp_socket->so_snd.sb_cc >= sp->length) { \ 314 atomic_subtract_int(&stcb->sctp_socket->so_snd.sb_cc,sp->length); \ 315 } else { \ 316 stcb->sctp_socket->so_snd.sb_cc = 0; \ 317 } \ 318 } \ 319 } \ 320 } while (0) 321 322 #define sctp_snd_sb_alloc(stcb, sz) \ 323 do { \ 324 atomic_add_int(&stcb->asoc.total_output_queue_size,sz); \ 325 if ((stcb->sctp_socket != NULL) && \ 326 ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \ 327 (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \ 328 atomic_add_int(&stcb->sctp_socket->so_snd.sb_cc,sz); \ 329 } \ 330 } while (0) 331 332 /* functions to start/stop udp tunneling */ 333 void sctp_over_udp_stop(void); 334 int sctp_over_udp_start(void); 335 336 int 337 sctp_soreceive(struct socket *so, struct sockaddr **psa, 338 struct uio *uio, 339 struct mbuf **mp0, 340 struct mbuf **controlp, 341 int *flagsp); 342 343 void 344 sctp_misc_ints(uint8_t from, uint32_t a, uint32_t b, uint32_t c, uint32_t d); 345 346 void 347 sctp_wakeup_log(struct sctp_tcb *stcb, 348 uint32_t wake_cnt, int from); 349 350 void sctp_log_strm_del_alt(struct sctp_tcb *stcb, uint32_t, uint16_t, uint16_t, int); 351 352 void sctp_log_nagle_event(struct sctp_tcb *stcb, int action); 353 354 355 #ifdef SCTP_MBUF_LOGGING 356 void 357 sctp_log_mb(struct mbuf *m, int from); 358 359 void 360 sctp_log_mbc(struct mbuf *m, int from); 361 362 #endif 363 364 void 365 sctp_sblog(struct sockbuf *sb, 366 struct sctp_tcb *stcb, int from, int incr); 367 368 void 369 sctp_log_strm_del(struct sctp_queued_to_read *control, 370 struct sctp_queued_to_read *poschk, 371 int from); 372 void sctp_log_cwnd(struct sctp_tcb *stcb, struct sctp_nets *, int, uint8_t); 373 void rto_logging(struct sctp_nets *net, int from); 374 375 void sctp_log_closing(struct sctp_inpcb *inp, struct sctp_tcb *stcb, int16_t loc); 376 377 void sctp_log_lock(struct sctp_inpcb *inp, struct sctp_tcb *stcb, uint8_t from); 378 void sctp_log_maxburst(struct sctp_tcb *stcb, struct sctp_nets *, int, int, uint8_t); 379 void sctp_log_block(uint8_t, struct sctp_association *, int); 380 void sctp_log_rwnd(uint8_t, uint32_t, uint32_t, uint32_t); 381 void sctp_log_rwnd_set(uint8_t, uint32_t, uint32_t, uint32_t, uint32_t); 382 int sctp_fill_stat_log(void *, size_t *); 383 void sctp_log_fr(uint32_t, uint32_t, uint32_t, int); 384 void sctp_log_sack(uint32_t, uint32_t, uint32_t, uint16_t, uint16_t, int); 385 void sctp_log_map(uint32_t, uint32_t, uint32_t, int); 386 void sctp_print_mapping_array(struct sctp_association *asoc); 387 void sctp_clr_stat_log(void); 388 389 390 #ifdef SCTP_AUDITING_ENABLED 391 void 392 sctp_auditing(int, struct sctp_inpcb *, struct sctp_tcb *, 393 struct sctp_nets *); 394 void sctp_audit_log(uint8_t, uint8_t); 395 396 #endif 397 #endif /* _KERNEL */ 398 #endif 399