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