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