1 /*- 2 * Copyright (c) 2001-2007, by Cisco Systems, Inc. All rights reserved. 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions are met: 6 * 7 * a) Redistributions of source code must retain the above copyright notice, 8 * this list of conditions and the following disclaimer. 9 * 10 * b) Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in 12 * the documentation and/or other materials provided with the distribution. 13 * 14 * c) Neither the name of Cisco Systems, Inc. nor the names of its 15 * contributors may be used to endorse or promote products derived 16 * from this software without specific prior written permission. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 20 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 22 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 23 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 24 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 25 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 26 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 28 * THE POSSIBILITY OF SUCH DAMAGE. 29 */ 30 31 32 /* $KAME: sctputil.h,v 1.15 2005/03/06 16:04:19 itojun Exp $ */ 33 34 #include <sys/cdefs.h> 35 __FBSDID("$FreeBSD$"); 36 #ifndef __sctputil_h__ 37 #define __sctputil_h__ 38 39 40 #if defined(_KERNEL) || defined(__Userspace__) 41 42 #define SCTP_READ_LOCK_HELD 1 43 #define SCTP_READ_LOCK_NOT_HELD 0 44 45 #ifdef SCTP_ASOCLOG_OF_TSNS 46 void sctp_print_out_track_log(struct sctp_tcb *stcb); 47 48 #endif 49 50 #ifdef SCTP_MBUF_LOGGING 51 struct mbuf *sctp_m_free(struct mbuf *m); 52 void sctp_m_freem(struct mbuf *m); 53 54 #else 55 #define sctp_m_free m_free 56 #define sctp_m_freem m_freem 57 #endif 58 59 #if defined(SCTP_LOCAL_TRACE_BUF) || defined(__APPLE__) 60 void 61 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); 62 63 #endif 64 65 #define sctp_get_associd(stcb) ((sctp_assoc_t)stcb->asoc.assoc_id) 66 67 68 /* 69 * Function prototypes 70 */ 71 uint32_t 72 sctp_get_ifa_hash_val(struct sockaddr *addr); 73 74 struct sctp_ifa * 75 sctp_find_ifa_in_ep(struct sctp_inpcb *inp, struct sockaddr *addr, int hold_lock); 76 77 struct sctp_ifa * 78 sctp_find_ifa_by_addr(struct sockaddr *addr, uint32_t vrf_id, int holds_lock); 79 80 uint32_t sctp_select_initial_TSN(struct sctp_pcb *); 81 82 uint32_t sctp_select_a_tag(struct sctp_inpcb *, uint16_t lport, uint16_t rport, int); 83 84 int sctp_init_asoc(struct sctp_inpcb *, struct sctp_tcb *, uint32_t, uint32_t); 85 86 void sctp_fill_random_store(struct sctp_pcb *); 87 88 void 89 sctp_timer_start(int, struct sctp_inpcb *, struct sctp_tcb *, 90 struct sctp_nets *); 91 92 void 93 sctp_timer_stop(int, struct sctp_inpcb *, struct sctp_tcb *, 94 struct sctp_nets *, uint32_t); 95 96 int 97 sctp_dynamic_set_primary(struct sockaddr *sa, uint32_t vrf_id); 98 99 void 100 sctp_mtu_size_reset(struct sctp_inpcb *, struct sctp_association *, uint32_t); 101 102 void 103 sctp_add_to_readq(struct sctp_inpcb *inp, 104 struct sctp_tcb *stcb, 105 struct sctp_queued_to_read *control, 106 struct sockbuf *sb, 107 int end, 108 int inpread_locked, 109 int so_locked 110 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 111 SCTP_UNUSED 112 #endif 113 ); 114 115 int 116 sctp_append_to_readq(struct sctp_inpcb *inp, 117 struct sctp_tcb *stcb, 118 struct sctp_queued_to_read *control, 119 struct mbuf *m, 120 int end, 121 int new_cumack, 122 struct sockbuf *sb); 123 124 125 void sctp_iterator_worker(void); 126 127 int find_next_best_mtu(int); 128 129 void 130 sctp_timeout_handler(void *); 131 132 uint32_t 133 sctp_calculate_rto(struct sctp_tcb *, struct sctp_association *, 134 struct sctp_nets *, struct timeval *, int); 135 136 uint32_t sctp_calculate_len(struct mbuf *); 137 138 caddr_t sctp_m_getptr(struct mbuf *, int, int, uint8_t *); 139 140 struct sctp_paramhdr * 141 sctp_get_next_param(struct mbuf *, int, 142 struct sctp_paramhdr *, int); 143 144 int sctp_add_pad_tombuf(struct mbuf *, int); 145 146 int sctp_pad_lastmbuf(struct mbuf *, int, struct mbuf *); 147 148 void 149 sctp_ulp_notify(uint32_t, struct sctp_tcb *, uint32_t, void *, int 150 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 151 SCTP_UNUSED 152 #endif 153 ); 154 155 void 156 sctp_pull_off_control_to_new_inp(struct sctp_inpcb *old_inp, 157 struct sctp_inpcb *new_inp, 158 struct sctp_tcb *stcb, int waitflags); 159 160 161 void sctp_stop_timers_for_shutdown(struct sctp_tcb *); 162 163 void 164 sctp_report_all_outbound(struct sctp_tcb *, int, int 165 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 166 SCTP_UNUSED 167 #endif 168 ); 169 170 int sctp_expand_mapping_array(struct sctp_association *, uint32_t); 171 172 void 173 sctp_abort_notification(struct sctp_tcb *, int, int 174 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 175 SCTP_UNUSED 176 #endif 177 ); 178 179 /* We abort responding to an IP packet for some reason */ 180 void 181 sctp_abort_association(struct sctp_inpcb *, struct sctp_tcb *, 182 struct mbuf *, int, struct sctphdr *, struct mbuf *, uint32_t, uint16_t); 183 184 185 /* We choose to abort via user input */ 186 void 187 sctp_abort_an_association(struct sctp_inpcb *, struct sctp_tcb *, int, 188 struct mbuf *, int 189 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 190 SCTP_UNUSED 191 #endif 192 ); 193 194 void 195 sctp_handle_ootb(struct mbuf *, int, int, struct sctphdr *, 196 struct sctp_inpcb *, struct mbuf *, uint32_t, uint16_t); 197 198 int 199 sctp_connectx_helper_add(struct sctp_tcb *stcb, struct sockaddr *addr, 200 int totaddr, int *error); 201 202 struct sctp_tcb * 203 sctp_connectx_helper_find(struct sctp_inpcb *inp, struct sockaddr *addr, 204 int *totaddr, int *num_v4, int *num_v6, int *error, int limit, int *bad_addr); 205 206 int sctp_is_there_an_abort_here(struct mbuf *, int, uint32_t *); 207 208 #ifdef INET6 209 uint32_t sctp_is_same_scope(struct sockaddr_in6 *, struct sockaddr_in6 *); 210 211 struct sockaddr_in6 * 212 sctp_recover_scope(struct sockaddr_in6 *, struct sockaddr_in6 *); 213 214 #define sctp_recover_scope_mac(addr, store) do { \ 215 if ((addr->sin6_family == AF_INET6) && \ 216 (IN6_IS_SCOPE_LINKLOCAL(&addr->sin6_addr))) { \ 217 *store = *addr; \ 218 if (addr->sin6_scope_id == 0) { \ 219 if (!sa6_recoverscope(store)) { \ 220 addr = store; \ 221 } \ 222 } else { \ 223 in6_clearscope(&addr->sin6_addr); \ 224 addr = store; \ 225 } \ 226 } \ 227 } while (0) 228 #endif 229 230 int sctp_cmpaddr(struct sockaddr *, struct sockaddr *); 231 232 void sctp_print_address(struct sockaddr *); 233 void sctp_print_address_pkt(struct ip *, struct sctphdr *); 234 235 int 236 sctp_release_pr_sctp_chunk(struct sctp_tcb *, struct sctp_tmit_chunk *, 237 int, int 238 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 239 SCTP_UNUSED 240 #endif 241 ); 242 243 struct mbuf *sctp_generate_invmanparam(int); 244 245 void 246 sctp_bindx_add_address(struct socket *so, struct sctp_inpcb *inp, 247 struct sockaddr *sa, sctp_assoc_t assoc_id, 248 uint32_t vrf_id, int *error, void *p); 249 void 250 sctp_bindx_delete_address(struct socket *so, struct sctp_inpcb *inp, 251 struct sockaddr *sa, sctp_assoc_t assoc_id, 252 uint32_t vrf_id, int *error); 253 254 int sctp_local_addr_count(struct sctp_tcb *stcb); 255 256 #ifdef SCTP_MBCNT_LOGGING 257 void 258 sctp_free_bufspace(struct sctp_tcb *, struct sctp_association *, 259 struct sctp_tmit_chunk *, int); 260 261 #else 262 #define sctp_free_bufspace(stcb, asoc, tp1, chk_cnt) \ 263 do { \ 264 if (tp1->data != NULL) { \ 265 atomic_subtract_int(&((asoc)->chunks_on_out_queue), chk_cnt); \ 266 if ((asoc)->total_output_queue_size >= tp1->book_size) { \ 267 atomic_subtract_int(&((asoc)->total_output_queue_size), tp1->book_size); \ 268 } else { \ 269 (asoc)->total_output_queue_size = 0; \ 270 } \ 271 if (stcb->sctp_socket && ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \ 272 (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \ 273 if (stcb->sctp_socket->so_snd.sb_cc >= tp1->book_size) { \ 274 atomic_subtract_int(&((stcb)->sctp_socket->so_snd.sb_cc), tp1->book_size); \ 275 } else { \ 276 stcb->sctp_socket->so_snd.sb_cc = 0; \ 277 } \ 278 } \ 279 } \ 280 } while (0) 281 282 #endif 283 284 #define sctp_free_spbufspace(stcb, asoc, sp) \ 285 do { \ 286 if (sp->data != NULL) { \ 287 if ((asoc)->total_output_queue_size >= sp->length) { \ 288 atomic_subtract_int(&(asoc)->total_output_queue_size, sp->length); \ 289 } else { \ 290 (asoc)->total_output_queue_size = 0; \ 291 } \ 292 if (stcb->sctp_socket && ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \ 293 (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \ 294 if (stcb->sctp_socket->so_snd.sb_cc >= sp->length) { \ 295 atomic_subtract_int(&stcb->sctp_socket->so_snd.sb_cc,sp->length); \ 296 } else { \ 297 stcb->sctp_socket->so_snd.sb_cc = 0; \ 298 } \ 299 } \ 300 } \ 301 } while (0) 302 303 #define sctp_snd_sb_alloc(stcb, sz) \ 304 do { \ 305 atomic_add_int(&stcb->asoc.total_output_queue_size,sz); \ 306 if ((stcb->sctp_socket != NULL) && \ 307 ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \ 308 (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \ 309 atomic_add_int(&stcb->sctp_socket->so_snd.sb_cc,sz); \ 310 } \ 311 } while (0) 312 313 /* new functions to start/stop udp tunneling */ 314 void sctp_over_udp_stop(void); 315 int sctp_over_udp_start(void); 316 317 int 318 sctp_soreceive(struct socket *so, struct sockaddr **psa, 319 struct uio *uio, 320 struct mbuf **mp0, 321 struct mbuf **controlp, 322 int *flagsp); 323 324 325 /* For those not passing mbufs, this does the 326 * translations for you. Caller owns memory 327 * of size controllen returned in controlp. 328 */ 329 int 330 sctp_l_soreceive(struct socket *so, 331 struct sockaddr **name, 332 struct uio *uio, 333 char **controlp, 334 int *controllen, 335 int *flag); 336 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 cumtsn, 344 uint32_t wake_cnt, int from); 345 346 void sctp_log_strm_del_alt(struct sctp_tcb *stcb, uint32_t, uint16_t, uint16_t, int); 347 348 void sctp_log_nagle_event(struct sctp_tcb *stcb, int action); 349 350 351 void 352 sctp_log_mb(struct mbuf *m, int from); 353 354 void 355 sctp_sblog(struct sockbuf *sb, 356 struct sctp_tcb *stcb, int from, int incr); 357 358 void 359 sctp_log_strm_del(struct sctp_queued_to_read *control, 360 struct sctp_queued_to_read *poschk, 361 int from); 362 void sctp_log_cwnd(struct sctp_tcb *stcb, struct sctp_nets *, int, uint8_t); 363 void rto_logging(struct sctp_nets *net, int from); 364 365 void sctp_log_closing(struct sctp_inpcb *inp, struct sctp_tcb *stcb, int16_t loc); 366 367 void sctp_log_lock(struct sctp_inpcb *inp, struct sctp_tcb *stcb, uint8_t from); 368 void sctp_log_maxburst(struct sctp_tcb *stcb, struct sctp_nets *, int, int, uint8_t); 369 void sctp_log_block(uint8_t, struct socket *, struct sctp_association *, int); 370 void sctp_log_rwnd(uint8_t, uint32_t, uint32_t, uint32_t); 371 void sctp_log_mbcnt(uint8_t, uint32_t, uint32_t, uint32_t, uint32_t); 372 void sctp_log_rwnd_set(uint8_t, uint32_t, uint32_t, uint32_t, uint32_t); 373 int sctp_fill_stat_log(void *, size_t *); 374 void sctp_log_fr(uint32_t, uint32_t, uint32_t, int); 375 void sctp_log_sack(uint32_t, uint32_t, uint32_t, uint16_t, uint16_t, int); 376 void sctp_log_map(uint32_t, uint32_t, uint32_t, int); 377 void sctp_print_mapping_array(struct sctp_association *asoc); 378 void sctp_clr_stat_log(void); 379 380 381 #ifdef SCTP_AUDITING_ENABLED 382 void 383 sctp_auditing(int, struct sctp_inpcb *, struct sctp_tcb *, 384 struct sctp_nets *); 385 void sctp_audit_log(uint8_t, uint8_t); 386 387 #endif 388 389 390 #endif /* _KERNEL */ 391 #endif 392