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) 41 42 43 #ifdef SCTP_ASOCLOG_OF_TSNS 44 void sctp_print_out_track_log(struct sctp_tcb *stcb); 45 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 52 #else 53 #define sctp_m_free m_free 54 #define sctp_m_freem m_freem 55 #endif 56 57 #if defined(SCTP_LOCAL_TRACE_BUF) || defined(__APPLE__) 58 void 59 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); 60 61 #endif 62 63 #define sctp_get_associd(stcb) ((sctp_assoc_t)stcb->asoc.assoc_id) 64 65 66 /* 67 * Function prototypes 68 */ 69 uint32_t 70 sctp_get_ifa_hash_val(struct sockaddr *addr); 71 72 struct sctp_ifa * 73 sctp_find_ifa_in_ep(struct sctp_inpcb *inp, struct sockaddr *addr, int hold_lock); 74 75 struct sctp_ifa * 76 sctp_find_ifa_by_addr(struct sockaddr *addr, uint32_t vrf_id, int holds_lock); 77 78 uint32_t sctp_select_initial_TSN(struct sctp_pcb *); 79 80 uint32_t sctp_select_a_tag(struct sctp_inpcb *, int); 81 82 int sctp_init_asoc(struct sctp_inpcb *, struct sctp_tcb *, int, uint32_t, uint32_t); 83 84 void sctp_fill_random_store(struct sctp_pcb *); 85 86 void 87 sctp_timer_start(int, struct sctp_inpcb *, struct sctp_tcb *, 88 struct sctp_nets *); 89 90 void 91 sctp_timer_stop(int, struct sctp_inpcb *, struct sctp_tcb *, 92 struct sctp_nets *, uint32_t); 93 94 int 95 sctp_dynamic_set_primary(struct sockaddr *sa, uint32_t vrf_id); 96 97 uint32_t sctp_calculate_sum(struct mbuf *, int32_t *, uint32_t); 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 so_locked 109 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 110 SCTP_UNUSED 111 #endif 112 ); 113 114 int 115 sctp_append_to_readq(struct sctp_inpcb *inp, 116 struct sctp_tcb *stcb, 117 struct sctp_queued_to_read *control, 118 struct mbuf *m, 119 int end, 120 int new_cumack, 121 struct sockbuf *sb); 122 123 124 void sctp_iterator_worker(void); 125 126 int find_next_best_mtu(int); 127 128 void 129 sctp_timeout_handler(void *); 130 131 uint32_t 132 sctp_calculate_rto(struct sctp_tcb *, struct sctp_association *, 133 struct sctp_nets *, struct timeval *, int); 134 135 uint32_t sctp_calculate_len(struct mbuf *); 136 137 caddr_t sctp_m_getptr(struct mbuf *, int, int, uint8_t *); 138 139 struct sctp_paramhdr * 140 sctp_get_next_param(struct mbuf *, int, 141 struct sctp_paramhdr *, int); 142 143 int sctp_add_pad_tombuf(struct mbuf *, int); 144 145 int sctp_pad_lastmbuf(struct mbuf *, int, struct mbuf *); 146 147 void 148 sctp_ulp_notify(uint32_t, struct sctp_tcb *, uint32_t, void *, int 149 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 150 SCTP_UNUSED 151 #endif 152 ); 153 154 void 155 sctp_pull_off_control_to_new_inp(struct sctp_inpcb *old_inp, 156 struct sctp_inpcb *new_inp, 157 struct sctp_tcb *stcb, int waitflags); 158 159 160 void sctp_stop_timers_for_shutdown(struct sctp_tcb *); 161 162 void 163 sctp_report_all_outbound(struct sctp_tcb *, int, int 164 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 165 SCTP_UNUSED 166 #endif 167 ); 168 169 int sctp_expand_mapping_array(struct sctp_association *, uint32_t); 170 171 void 172 sctp_abort_notification(struct sctp_tcb *, int, int 173 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 174 SCTP_UNUSED 175 #endif 176 ); 177 178 /* We abort responding to an IP packet for some reason */ 179 void 180 sctp_abort_association(struct sctp_inpcb *, struct sctp_tcb *, 181 struct mbuf *, int, struct sctphdr *, struct mbuf *, uint32_t); 182 183 184 /* We choose to abort via user input */ 185 void 186 sctp_abort_an_association(struct sctp_inpcb *, struct sctp_tcb *, int, 187 struct mbuf *, int 188 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 189 SCTP_UNUSED 190 #endif 191 ); 192 193 void 194 sctp_handle_ootb(struct mbuf *, int, int, struct sctphdr *, 195 struct sctp_inpcb *, struct mbuf *, uint32_t); 196 197 int 198 sctp_connectx_helper_add(struct sctp_tcb *stcb, struct sockaddr *addr, 199 int totaddr, int *error); 200 201 struct sctp_tcb * 202 sctp_connectx_helper_find(struct sctp_inpcb *inp, struct sockaddr *addr, 203 int *totaddr, int *num_v4, int *num_v6, int *error, int limit, int *bad_addr); 204 205 int sctp_is_there_an_abort_here(struct mbuf *, int, uint32_t *); 206 207 #ifdef INET6 208 uint32_t sctp_is_same_scope(struct sockaddr_in6 *, struct sockaddr_in6 *); 209 210 struct sockaddr_in6 * 211 sctp_recover_scope(struct sockaddr_in6 *, struct sockaddr_in6 *); 212 213 #define sctp_recover_scope_mac(addr, store) do { \ 214 if ((addr->sin6_family == AF_INET6) && \ 215 (IN6_IS_SCOPE_LINKLOCAL(&addr->sin6_addr))) { \ 216 *store = *addr; \ 217 if (addr->sin6_scope_id == 0) { \ 218 if (!sa6_recoverscope(store)) { \ 219 addr = store; \ 220 } \ 221 } else { \ 222 in6_clearscope(&addr->sin6_addr); \ 223 addr = store; \ 224 } \ 225 } \ 226 } while (0) 227 #endif 228 229 int sctp_cmpaddr(struct sockaddr *, struct sockaddr *); 230 231 void sctp_print_address(struct sockaddr *); 232 void sctp_print_address_pkt(struct ip *, struct sctphdr *); 233 234 void 235 sctp_notify_partial_delivery_indication(struct sctp_tcb *stcb, 236 uint32_t error, int no_lock, uint32_t strseq); 237 238 int 239 sctp_release_pr_sctp_chunk(struct sctp_tcb *, struct sctp_tmit_chunk *, 240 int, struct sctpchunk_listhead *, 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 atomic_subtract_int(&(asoc)->chunks_on_out_queue, 1); \ 291 if ((asoc)->total_output_queue_size >= sp->length) { \ 292 atomic_subtract_int(&(asoc)->total_output_queue_size, sp->length); \ 293 } else { \ 294 (asoc)->total_output_queue_size = 0; \ 295 } \ 296 if (stcb->sctp_socket && ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \ 297 (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \ 298 if (stcb->sctp_socket->so_snd.sb_cc >= sp->length) { \ 299 atomic_subtract_int(&stcb->sctp_socket->so_snd.sb_cc,sp->length); \ 300 } else { \ 301 stcb->sctp_socket->so_snd.sb_cc = 0; \ 302 } \ 303 } \ 304 } \ 305 } while (0) 306 307 #define sctp_snd_sb_alloc(stcb, sz) \ 308 do { \ 309 atomic_add_int(&stcb->asoc.total_output_queue_size,sz); \ 310 if ((stcb->sctp_socket != NULL) && \ 311 ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \ 312 (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \ 313 atomic_add_int(&stcb->sctp_socket->so_snd.sb_cc,sz); \ 314 } \ 315 } while (0) 316 317 318 int 319 sctp_soreceive(struct socket *so, struct sockaddr **psa, 320 struct uio *uio, 321 struct mbuf **mp0, 322 struct mbuf **controlp, 323 int *flagsp); 324 325 326 /* For those not passing mbufs, this does the 327 * translations for you. Caller owns memory 328 * of size controllen returned in controlp. 329 */ 330 int 331 sctp_l_soreceive(struct socket *so, 332 struct sockaddr **name, 333 struct uio *uio, 334 char **controlp, 335 int *controllen, 336 int *flag); 337 338 339 void 340 sctp_misc_ints(uint8_t from, uint32_t a, uint32_t b, uint32_t c, uint32_t d); 341 342 void 343 sctp_wakeup_log(struct sctp_tcb *stcb, 344 uint32_t cumtsn, 345 uint32_t wake_cnt, int from); 346 347 void sctp_log_strm_del_alt(struct sctp_tcb *stcb, uint32_t, uint16_t, uint16_t, int); 348 349 void sctp_log_nagle_event(struct sctp_tcb *stcb, int action); 350 351 352 void 353 sctp_log_mb(struct mbuf *m, int from); 354 355 void 356 sctp_sblog(struct sockbuf *sb, 357 struct sctp_tcb *stcb, int from, int incr); 358 359 void 360 sctp_log_strm_del(struct sctp_queued_to_read *control, 361 struct sctp_queued_to_read *poschk, 362 int from); 363 void sctp_log_cwnd(struct sctp_tcb *stcb, struct sctp_nets *, int, uint8_t); 364 void rto_logging(struct sctp_nets *net, int from); 365 366 void sctp_log_closing(struct sctp_inpcb *inp, struct sctp_tcb *stcb, int16_t loc); 367 368 void sctp_log_lock(struct sctp_inpcb *inp, struct sctp_tcb *stcb, uint8_t from); 369 void sctp_log_maxburst(struct sctp_tcb *stcb, struct sctp_nets *, int, int, uint8_t); 370 void sctp_log_block(uint8_t, struct socket *, struct sctp_association *, int); 371 void sctp_log_rwnd(uint8_t, uint32_t, uint32_t, uint32_t); 372 void sctp_log_mbcnt(uint8_t, uint32_t, uint32_t, uint32_t, uint32_t); 373 void sctp_log_rwnd_set(uint8_t, uint32_t, uint32_t, uint32_t, uint32_t); 374 int sctp_fill_stat_log(void *, size_t *); 375 void sctp_log_fr(uint32_t, uint32_t, uint32_t, int); 376 void sctp_log_sack(uint32_t, uint32_t, uint32_t, uint16_t, uint16_t, int); 377 void sctp_log_map(uint32_t, uint32_t, uint32_t, int); 378 379 void sctp_clr_stat_log(void); 380 381 382 #ifdef SCTP_AUDITING_ENABLED 383 void 384 sctp_auditing(int, struct sctp_inpcb *, struct sctp_tcb *, 385 struct sctp_nets *); 386 void sctp_audit_log(uint8_t, uint8_t); 387 388 #endif 389 390 391 #endif /* _KERNEL */ 392 #endif 393