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_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 int sctp_add_pad_tombuf(struct mbuf *, int); 154 155 int 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 *, 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 *, int, int 183 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 184 SCTP_UNUSED 185 #endif 186 ); 187 188 /* We abort responding to an IP packet for some reason */ 189 void 190 sctp_abort_association(struct sctp_inpcb *, struct sctp_tcb *, 191 struct mbuf *, int, struct sctphdr *, struct mbuf *, uint32_t, uint16_t); 192 193 194 /* We choose to abort via user input */ 195 void 196 sctp_abort_an_association(struct sctp_inpcb *, struct sctp_tcb *, int, 197 struct mbuf *, int 198 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 199 SCTP_UNUSED 200 #endif 201 ); 202 203 void 204 sctp_handle_ootb(struct mbuf *, int, int, struct sctphdr *, 205 struct sctp_inpcb *, struct mbuf *, uint32_t, uint16_t); 206 207 int 208 sctp_connectx_helper_add(struct sctp_tcb *stcb, struct sockaddr *addr, 209 int totaddr, int *error); 210 211 struct sctp_tcb * 212 sctp_connectx_helper_find(struct sctp_inpcb *inp, struct sockaddr *addr, 213 int *totaddr, int *num_v4, int *num_v6, int *error, int limit, int *bad_addr); 214 215 int sctp_is_there_an_abort_here(struct mbuf *, int, uint32_t *); 216 217 #ifdef INET6 218 uint32_t sctp_is_same_scope(struct sockaddr_in6 *, struct sockaddr_in6 *); 219 220 struct sockaddr_in6 * 221 sctp_recover_scope(struct sockaddr_in6 *, struct sockaddr_in6 *); 222 223 #define sctp_recover_scope_mac(addr, store) do { \ 224 if ((addr->sin6_family == AF_INET6) && \ 225 (IN6_IS_SCOPE_LINKLOCAL(&addr->sin6_addr))) { \ 226 *store = *addr; \ 227 if (addr->sin6_scope_id == 0) { \ 228 if (!sa6_recoverscope(store)) { \ 229 addr = store; \ 230 } \ 231 } else { \ 232 in6_clearscope(&addr->sin6_addr); \ 233 addr = store; \ 234 } \ 235 } \ 236 } while (0) 237 #endif 238 239 int sctp_cmpaddr(struct sockaddr *, struct sockaddr *); 240 241 void sctp_print_address(struct sockaddr *); 242 void sctp_print_address_pkt(struct ip *, struct sctphdr *); 243 244 int 245 sctp_release_pr_sctp_chunk(struct sctp_tcb *, struct sctp_tmit_chunk *, 246 int, int 247 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 248 SCTP_UNUSED 249 #endif 250 ); 251 252 struct mbuf *sctp_generate_invmanparam(int); 253 254 void 255 sctp_bindx_add_address(struct socket *so, struct sctp_inpcb *inp, 256 struct sockaddr *sa, sctp_assoc_t assoc_id, 257 uint32_t vrf_id, int *error, void *p); 258 void 259 sctp_bindx_delete_address(struct sctp_inpcb *inp, 260 struct sockaddr *sa, sctp_assoc_t assoc_id, 261 uint32_t vrf_id, int *error); 262 263 int sctp_local_addr_count(struct sctp_tcb *stcb); 264 265 #ifdef SCTP_MBCNT_LOGGING 266 void 267 sctp_free_bufspace(struct sctp_tcb *, struct sctp_association *, 268 struct sctp_tmit_chunk *, int); 269 270 #else 271 #define sctp_free_bufspace(stcb, asoc, tp1, chk_cnt) \ 272 do { \ 273 if (tp1->data != NULL) { \ 274 atomic_subtract_int(&((asoc)->chunks_on_out_queue), chk_cnt); \ 275 if ((asoc)->total_output_queue_size >= tp1->book_size) { \ 276 atomic_subtract_int(&((asoc)->total_output_queue_size), tp1->book_size); \ 277 } else { \ 278 (asoc)->total_output_queue_size = 0; \ 279 } \ 280 if (stcb->sctp_socket && ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \ 281 (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \ 282 if (stcb->sctp_socket->so_snd.sb_cc >= tp1->book_size) { \ 283 atomic_subtract_int(&((stcb)->sctp_socket->so_snd.sb_cc), tp1->book_size); \ 284 } else { \ 285 stcb->sctp_socket->so_snd.sb_cc = 0; \ 286 } \ 287 } \ 288 } \ 289 } while (0) 290 291 #endif 292 293 #define sctp_free_spbufspace(stcb, asoc, sp) \ 294 do { \ 295 if (sp->data != NULL) { \ 296 if ((asoc)->total_output_queue_size >= sp->length) { \ 297 atomic_subtract_int(&(asoc)->total_output_queue_size, sp->length); \ 298 } else { \ 299 (asoc)->total_output_queue_size = 0; \ 300 } \ 301 if (stcb->sctp_socket && ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \ 302 (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \ 303 if (stcb->sctp_socket->so_snd.sb_cc >= sp->length) { \ 304 atomic_subtract_int(&stcb->sctp_socket->so_snd.sb_cc,sp->length); \ 305 } else { \ 306 stcb->sctp_socket->so_snd.sb_cc = 0; \ 307 } \ 308 } \ 309 } \ 310 } while (0) 311 312 #define sctp_snd_sb_alloc(stcb, sz) \ 313 do { \ 314 atomic_add_int(&stcb->asoc.total_output_queue_size,sz); \ 315 if ((stcb->sctp_socket != NULL) && \ 316 ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \ 317 (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \ 318 atomic_add_int(&stcb->sctp_socket->so_snd.sb_cc,sz); \ 319 } \ 320 } while (0) 321 322 /* functions to start/stop udp tunneling */ 323 /* XXX: Remove the #ifdef after tunneling over IPv6 works also on FreeBSD. */ 324 #ifdef INET 325 void sctp_over_udp_stop(void); 326 int sctp_over_udp_start(void); 327 328 #endif 329 330 int 331 sctp_soreceive(struct socket *so, struct sockaddr **psa, 332 struct uio *uio, 333 struct mbuf **mp0, 334 struct mbuf **controlp, 335 int *flagsp); 336 337 void 338 sctp_misc_ints(uint8_t from, uint32_t a, uint32_t b, uint32_t c, uint32_t d); 339 340 void 341 sctp_wakeup_log(struct sctp_tcb *stcb, 342 uint32_t wake_cnt, int from); 343 344 void sctp_log_strm_del_alt(struct sctp_tcb *stcb, uint32_t, uint16_t, uint16_t, int); 345 346 void sctp_log_nagle_event(struct sctp_tcb *stcb, int action); 347 348 349 void 350 sctp_log_mb(struct mbuf *m, int from); 351 352 void 353 sctp_sblog(struct sockbuf *sb, 354 struct sctp_tcb *stcb, int from, int incr); 355 356 void 357 sctp_log_strm_del(struct sctp_queued_to_read *control, 358 struct sctp_queued_to_read *poschk, 359 int from); 360 void sctp_log_cwnd(struct sctp_tcb *stcb, struct sctp_nets *, int, uint8_t); 361 void rto_logging(struct sctp_nets *net, int from); 362 363 void sctp_log_closing(struct sctp_inpcb *inp, struct sctp_tcb *stcb, int16_t loc); 364 365 void sctp_log_lock(struct sctp_inpcb *inp, struct sctp_tcb *stcb, uint8_t from); 366 void sctp_log_maxburst(struct sctp_tcb *stcb, struct sctp_nets *, int, int, uint8_t); 367 void sctp_log_block(uint8_t, struct sctp_association *, int); 368 void sctp_log_rwnd(uint8_t, uint32_t, uint32_t, uint32_t); 369 void sctp_log_mbcnt(uint8_t, uint32_t, uint32_t, uint32_t, uint32_t); 370 void sctp_log_rwnd_set(uint8_t, uint32_t, uint32_t, uint32_t, uint32_t); 371 int sctp_fill_stat_log(void *, size_t *); 372 void sctp_log_fr(uint32_t, uint32_t, uint32_t, int); 373 void sctp_log_sack(uint32_t, uint32_t, uint32_t, uint16_t, uint16_t, int); 374 void sctp_log_map(uint32_t, uint32_t, uint32_t, int); 375 void sctp_print_mapping_array(struct sctp_association *asoc); 376 void sctp_clr_stat_log(void); 377 378 379 #ifdef SCTP_AUDITING_ENABLED 380 void 381 sctp_auditing(int, struct sctp_inpcb *, struct sctp_tcb *, 382 struct sctp_nets *); 383 void sctp_audit_log(uint8_t, uint8_t); 384 385 #endif 386 387 388 #endif /* _KERNEL */ 389 #endif 390