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