1 /*- 2 * Copyright (c) 2001-2007, by Cisco Systems, Inc. All rights reserved. 3 * Copyright (c) 2008-2011, by Randall Stewart. All rights reserved. 4 * Copyright (c) 2008-2011, 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 34 /* $KAME: sctputil.h,v 1.15 2005/03/06 16:04:19 itojun Exp $ */ 35 36 #include <sys/cdefs.h> 37 __FBSDID("$FreeBSD$"); 38 #ifndef __sctputil_h__ 39 #define __sctputil_h__ 40 41 42 #if defined(_KERNEL) || defined(__Userspace__) 43 44 #define SCTP_READ_LOCK_HELD 1 45 #define SCTP_READ_LOCK_NOT_HELD 0 46 47 #ifdef SCTP_ASOCLOG_OF_TSNS 48 void sctp_print_out_track_log(struct sctp_tcb *stcb); 49 50 #endif 51 52 #ifdef SCTP_MBUF_LOGGING 53 struct mbuf *sctp_m_free(struct mbuf *m); 54 void sctp_m_freem(struct mbuf *m); 55 56 #else 57 #define sctp_m_free m_free 58 #define sctp_m_freem m_freem 59 #endif 60 61 #if defined(SCTP_LOCAL_TRACE_BUF) || defined(__APPLE__) 62 void 63 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); 64 65 #endif 66 67 #define sctp_get_associd(stcb) ((sctp_assoc_t)stcb->asoc.assoc_id) 68 69 70 /* 71 * Function prototypes 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); 87 88 void sctp_fill_random_store(struct sctp_pcb *); 89 90 void 91 sctp_timer_start(int, struct sctp_inpcb *, struct sctp_tcb *, 92 struct sctp_nets *); 93 94 void 95 sctp_timer_stop(int, struct sctp_inpcb *, struct sctp_tcb *, 96 struct sctp_nets *, uint32_t); 97 98 int 99 sctp_dynamic_set_primary(struct sockaddr *sa, uint32_t vrf_id); 100 101 void 102 sctp_mtu_size_reset(struct sctp_inpcb *, struct sctp_association *, uint32_t); 103 104 void 105 sctp_add_to_readq(struct sctp_inpcb *inp, 106 struct sctp_tcb *stcb, 107 struct sctp_queued_to_read *control, 108 struct sockbuf *sb, 109 int end, 110 int inpread_locked, 111 int so_locked 112 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 113 SCTP_UNUSED 114 #endif 115 ); 116 117 int 118 sctp_append_to_readq(struct sctp_inpcb *inp, 119 struct sctp_tcb *stcb, 120 struct sctp_queued_to_read *control, 121 struct mbuf *m, 122 int end, 123 int new_cumack, 124 struct sockbuf *sb); 125 126 127 void sctp_iterator_worker(void); 128 129 uint32_t sctp_get_prev_mtu(uint32_t); 130 uint32_t sctp_get_next_mtu(struct sctp_inpcb *, uint32_t); 131 132 void 133 sctp_timeout_handler(void *); 134 135 uint32_t 136 sctp_calculate_rto(struct sctp_tcb *, struct sctp_association *, 137 struct sctp_nets *, struct timeval *, int, int); 138 139 uint32_t sctp_calculate_len(struct mbuf *); 140 141 caddr_t sctp_m_getptr(struct mbuf *, int, int, uint8_t *); 142 143 struct sctp_paramhdr * 144 sctp_get_next_param(struct mbuf *, int, 145 struct sctp_paramhdr *, int); 146 147 int sctp_add_pad_tombuf(struct mbuf *, int); 148 149 int sctp_pad_lastmbuf(struct mbuf *, int, struct mbuf *); 150 151 void 152 sctp_ulp_notify(uint32_t, struct sctp_tcb *, uint32_t, void *, int 153 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 154 SCTP_UNUSED 155 #endif 156 ); 157 158 void 159 sctp_pull_off_control_to_new_inp(struct sctp_inpcb *old_inp, 160 struct sctp_inpcb *new_inp, 161 struct sctp_tcb *stcb, int waitflags); 162 163 164 void sctp_stop_timers_for_shutdown(struct sctp_tcb *); 165 166 void 167 sctp_report_all_outbound(struct sctp_tcb *, int, int 168 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 169 SCTP_UNUSED 170 #endif 171 ); 172 173 int sctp_expand_mapping_array(struct sctp_association *, uint32_t); 174 175 void 176 sctp_abort_notification(struct sctp_tcb *, int, int 177 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 178 SCTP_UNUSED 179 #endif 180 ); 181 182 /* We abort responding to an IP packet for some reason */ 183 void 184 sctp_abort_association(struct sctp_inpcb *, struct sctp_tcb *, 185 struct mbuf *, int, struct sctphdr *, struct mbuf *, uint32_t, uint16_t); 186 187 188 /* We choose to abort via user input */ 189 void 190 sctp_abort_an_association(struct sctp_inpcb *, struct sctp_tcb *, int, 191 struct mbuf *, int 192 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 193 SCTP_UNUSED 194 #endif 195 ); 196 197 void 198 sctp_handle_ootb(struct mbuf *, int, int, struct sctphdr *, 199 struct sctp_inpcb *, struct mbuf *, uint32_t, uint16_t); 200 201 int 202 sctp_connectx_helper_add(struct sctp_tcb *stcb, struct sockaddr *addr, 203 int totaddr, int *error); 204 205 struct sctp_tcb * 206 sctp_connectx_helper_find(struct sctp_inpcb *inp, struct sockaddr *addr, 207 int *totaddr, int *num_v4, int *num_v6, int *error, int limit, int *bad_addr); 208 209 int sctp_is_there_an_abort_here(struct mbuf *, int, uint32_t *); 210 211 #ifdef INET6 212 uint32_t sctp_is_same_scope(struct sockaddr_in6 *, struct sockaddr_in6 *); 213 214 struct sockaddr_in6 * 215 sctp_recover_scope(struct sockaddr_in6 *, struct sockaddr_in6 *); 216 217 #define sctp_recover_scope_mac(addr, store) do { \ 218 if ((addr->sin6_family == AF_INET6) && \ 219 (IN6_IS_SCOPE_LINKLOCAL(&addr->sin6_addr))) { \ 220 *store = *addr; \ 221 if (addr->sin6_scope_id == 0) { \ 222 if (!sa6_recoverscope(store)) { \ 223 addr = store; \ 224 } \ 225 } else { \ 226 in6_clearscope(&addr->sin6_addr); \ 227 addr = store; \ 228 } \ 229 } \ 230 } while (0) 231 #endif 232 233 int sctp_cmpaddr(struct sockaddr *, struct sockaddr *); 234 235 void sctp_print_address(struct sockaddr *); 236 void sctp_print_address_pkt(struct ip *, struct sctphdr *); 237 238 int 239 sctp_release_pr_sctp_chunk(struct sctp_tcb *, struct sctp_tmit_chunk *, 240 int, int 241 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 242 SCTP_UNUSED 243 #endif 244 ); 245 246 struct mbuf *sctp_generate_invmanparam(int); 247 248 void 249 sctp_bindx_add_address(struct socket *so, struct sctp_inpcb *inp, 250 struct sockaddr *sa, sctp_assoc_t assoc_id, 251 uint32_t vrf_id, int *error, void *p); 252 void 253 sctp_bindx_delete_address(struct socket *so, struct sctp_inpcb *inp, 254 struct sockaddr *sa, sctp_assoc_t assoc_id, 255 uint32_t vrf_id, int *error); 256 257 int sctp_local_addr_count(struct sctp_tcb *stcb); 258 259 #ifdef SCTP_MBCNT_LOGGING 260 void 261 sctp_free_bufspace(struct sctp_tcb *, struct sctp_association *, 262 struct sctp_tmit_chunk *, int); 263 264 #else 265 #define sctp_free_bufspace(stcb, asoc, tp1, chk_cnt) \ 266 do { \ 267 if (tp1->data != NULL) { \ 268 atomic_subtract_int(&((asoc)->chunks_on_out_queue), chk_cnt); \ 269 if ((asoc)->total_output_queue_size >= tp1->book_size) { \ 270 atomic_subtract_int(&((asoc)->total_output_queue_size), tp1->book_size); \ 271 } else { \ 272 (asoc)->total_output_queue_size = 0; \ 273 } \ 274 if (stcb->sctp_socket && ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \ 275 (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \ 276 if (stcb->sctp_socket->so_snd.sb_cc >= tp1->book_size) { \ 277 atomic_subtract_int(&((stcb)->sctp_socket->so_snd.sb_cc), tp1->book_size); \ 278 } else { \ 279 stcb->sctp_socket->so_snd.sb_cc = 0; \ 280 } \ 281 } \ 282 } \ 283 } while (0) 284 285 #endif 286 287 #define sctp_free_spbufspace(stcb, asoc, sp) \ 288 do { \ 289 if (sp->data != NULL) { \ 290 if ((asoc)->total_output_queue_size >= sp->length) { \ 291 atomic_subtract_int(&(asoc)->total_output_queue_size, sp->length); \ 292 } else { \ 293 (asoc)->total_output_queue_size = 0; \ 294 } \ 295 if (stcb->sctp_socket && ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \ 296 (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \ 297 if (stcb->sctp_socket->so_snd.sb_cc >= sp->length) { \ 298 atomic_subtract_int(&stcb->sctp_socket->so_snd.sb_cc,sp->length); \ 299 } else { \ 300 stcb->sctp_socket->so_snd.sb_cc = 0; \ 301 } \ 302 } \ 303 } \ 304 } while (0) 305 306 #define sctp_snd_sb_alloc(stcb, sz) \ 307 do { \ 308 atomic_add_int(&stcb->asoc.total_output_queue_size,sz); \ 309 if ((stcb->sctp_socket != NULL) && \ 310 ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \ 311 (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \ 312 atomic_add_int(&stcb->sctp_socket->so_snd.sb_cc,sz); \ 313 } \ 314 } while (0) 315 316 /* new functions to start/stop udp tunneling */ 317 void sctp_over_udp_stop(void); 318 int sctp_over_udp_start(void); 319 320 int 321 sctp_soreceive(struct socket *so, struct sockaddr **psa, 322 struct uio *uio, 323 struct mbuf **mp0, 324 struct mbuf **controlp, 325 int *flagsp); 326 327 328 /* For those not passing mbufs, this does the 329 * translations for you. Caller owns memory 330 * of size controllen returned in controlp. 331 */ 332 int 333 sctp_l_soreceive(struct socket *so, 334 struct sockaddr **name, 335 struct uio *uio, 336 char **controlp, 337 int *controllen, 338 int *flag); 339 340 341 void 342 sctp_misc_ints(uint8_t from, uint32_t a, uint32_t b, uint32_t c, uint32_t d); 343 344 void 345 sctp_wakeup_log(struct sctp_tcb *stcb, 346 uint32_t cumtsn, 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 void 355 sctp_log_mb(struct mbuf *m, int from); 356 357 void 358 sctp_sblog(struct sockbuf *sb, 359 struct sctp_tcb *stcb, int from, int incr); 360 361 void 362 sctp_log_strm_del(struct sctp_queued_to_read *control, 363 struct sctp_queued_to_read *poschk, 364 int from); 365 void sctp_log_cwnd(struct sctp_tcb *stcb, struct sctp_nets *, int, uint8_t); 366 void rto_logging(struct sctp_nets *net, int from); 367 368 void sctp_log_closing(struct sctp_inpcb *inp, struct sctp_tcb *stcb, int16_t loc); 369 370 void sctp_log_lock(struct sctp_inpcb *inp, struct sctp_tcb *stcb, uint8_t from); 371 void sctp_log_maxburst(struct sctp_tcb *stcb, struct sctp_nets *, int, int, uint8_t); 372 void sctp_log_block(uint8_t, struct socket *, struct sctp_association *, int); 373 void sctp_log_rwnd(uint8_t, uint32_t, uint32_t, uint32_t); 374 void sctp_log_mbcnt(uint8_t, uint32_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 392 393 #endif /* _KERNEL */ 394 #endif 395