sctputil.h revision 172090
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: head/sys/netinet/sctputil.h 172090 2007-09-08 11:35:11Z rrs $"); 36#ifndef __sctputil_h__ 37#define __sctputil_h__ 38 39 40#if defined(_KERNEL) 41 42 43#ifdef SCTP_ASOCLOG_OF_TSNS 44void sctp_print_out_track_log(struct sctp_tcb *stcb); 45 46#endif 47 48#ifdef SCTP_MBUF_LOGGING 49struct mbuf *sctp_m_free(struct mbuf *m); 50void 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__) 58void 59 sctp_log_trace(uint32_t fr, const char *str, 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 */ 69uint32_t 70sctp_get_ifa_hash_val(struct sockaddr *addr); 71 72struct sctp_ifa * 73 sctp_find_ifa_in_ep(struct sctp_inpcb *inp, struct sockaddr *addr, int hold_lock); 74 75struct sctp_ifa * 76 sctp_find_ifa_by_addr(struct sockaddr *addr, uint32_t vrf_id, int holds_lock); 77 78uint32_t sctp_select_initial_TSN(struct sctp_pcb *); 79 80uint32_t sctp_select_a_tag(struct sctp_inpcb *); 81 82int sctp_init_asoc(struct sctp_inpcb *, struct sctp_tcb *, int, uint32_t, uint32_t); 83 84void sctp_fill_random_store(struct sctp_pcb *); 85 86void 87sctp_timer_start(int, struct sctp_inpcb *, struct sctp_tcb *, 88 struct sctp_nets *); 89 90void 91sctp_timer_stop(int, struct sctp_inpcb *, struct sctp_tcb *, 92 struct sctp_nets *, uint32_t); 93 94int 95 sctp_dynamic_set_primary(struct sockaddr *sa, uint32_t vrf_id); 96 97uint32_t sctp_calculate_sum(struct mbuf *, int32_t *, uint32_t); 98 99void 100 sctp_mtu_size_reset(struct sctp_inpcb *, struct sctp_association *, uint32_t); 101 102void 103sctp_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 114int 115sctp_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 124void sctp_iterator_worker(void); 125 126int find_next_best_mtu(int); 127 128void 129 sctp_timeout_handler(void *); 130 131uint32_t 132sctp_calculate_rto(struct sctp_tcb *, struct sctp_association *, 133 struct sctp_nets *, struct timeval *, int); 134 135uint32_t sctp_calculate_len(struct mbuf *); 136 137caddr_t sctp_m_getptr(struct mbuf *, int, int, uint8_t *); 138 139struct sctp_paramhdr * 140sctp_get_next_param(struct mbuf *, int, 141 struct sctp_paramhdr *, int); 142 143int sctp_add_pad_tombuf(struct mbuf *, int); 144 145int sctp_pad_lastmbuf(struct mbuf *, int, struct mbuf *); 146 147void 148sctp_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 154void 155sctp_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 160void sctp_stop_timers_for_shutdown(struct sctp_tcb *); 161 162void 163sctp_report_all_outbound(struct sctp_tcb *, int, int 164#if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 165 SCTP_UNUSED 166#endif 167); 168 169int sctp_expand_mapping_array(struct sctp_association *, uint32_t); 170 171void 172sctp_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 */ 179void 180sctp_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 */ 185void 186sctp_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 193void 194sctp_handle_ootb(struct mbuf *, int, int, struct sctphdr *, 195 struct sctp_inpcb *, struct mbuf *, uint32_t); 196 197int 198sctp_connectx_helper_add(struct sctp_tcb *stcb, struct sockaddr *addr, 199 int totaddr, int *error); 200 201struct sctp_tcb * 202sctp_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 205int sctp_is_there_an_abort_here(struct mbuf *, int, uint32_t *); 206uint32_t sctp_is_same_scope(struct sockaddr_in6 *, struct sockaddr_in6 *); 207 208struct sockaddr_in6 * 209 sctp_recover_scope(struct sockaddr_in6 *, struct sockaddr_in6 *); 210 211#define sctp_recover_scope_mac(addr, store) do { \ 212 if ((addr->sin6_family == AF_INET6) && \ 213 (IN6_IS_SCOPE_LINKLOCAL(&addr->sin6_addr))) { \ 214 *store = *addr; \ 215 if (addr->sin6_scope_id == 0) { \ 216 if (!sa6_recoverscope(store)) { \ 217 addr = store; \ 218 } \ 219 } else { \ 220 in6_clearscope(&addr->sin6_addr); \ 221 addr = store; \ 222 } \ 223 } \ 224} while (0) 225 226 227int sctp_cmpaddr(struct sockaddr *, struct sockaddr *); 228 229void sctp_print_address(struct sockaddr *); 230void sctp_print_address_pkt(struct ip *, struct sctphdr *); 231 232void 233sctp_notify_partial_delivery_indication(struct sctp_tcb *stcb, 234 uint32_t error, int no_lock, uint32_t strseq); 235 236int 237sctp_release_pr_sctp_chunk(struct sctp_tcb *, struct sctp_tmit_chunk *, 238 int, struct sctpchunk_listhead *, int 239#if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 240 SCTP_UNUSED 241#endif 242); 243 244struct mbuf *sctp_generate_invmanparam(int); 245 246void 247sctp_bindx_add_address(struct socket *so, struct sctp_inpcb *inp, 248 struct sockaddr *sa, sctp_assoc_t assoc_id, 249 uint32_t vrf_id, int *error, void *p); 250void 251sctp_bindx_delete_address(struct socket *so, struct sctp_inpcb *inp, 252 struct sockaddr *sa, sctp_assoc_t assoc_id, 253 uint32_t vrf_id, int *error); 254 255int sctp_local_addr_count(struct sctp_tcb *stcb); 256 257#ifdef SCTP_MBCNT_LOGGING 258void 259sctp_free_bufspace(struct sctp_tcb *, struct sctp_association *, 260 struct sctp_tmit_chunk *, int); 261 262#else 263#define sctp_free_bufspace(stcb, asoc, tp1, chk_cnt) \ 264do { \ 265 if (tp1->data != NULL) { \ 266 atomic_subtract_int(&((asoc)->chunks_on_out_queue), chk_cnt); \ 267 if ((asoc)->total_output_queue_size >= tp1->book_size) { \ 268 atomic_subtract_int(&((asoc)->total_output_queue_size), tp1->book_size); \ 269 } else { \ 270 (asoc)->total_output_queue_size = 0; \ 271 } \ 272 if (stcb->sctp_socket && ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \ 273 (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \ 274 if (stcb->sctp_socket->so_snd.sb_cc >= tp1->book_size) { \ 275 atomic_subtract_int(&((stcb)->sctp_socket->so_snd.sb_cc), tp1->book_size); \ 276 } else { \ 277 stcb->sctp_socket->so_snd.sb_cc = 0; \ 278 } \ 279 } \ 280 } \ 281} while (0) 282 283#endif 284 285#define sctp_free_spbufspace(stcb, asoc, sp) \ 286do { \ 287 if (sp->data != NULL) { \ 288 atomic_subtract_int(&(asoc)->chunks_on_out_queue, 1); \ 289 if ((asoc)->total_output_queue_size >= sp->length) { \ 290 atomic_subtract_int(&(asoc)->total_output_queue_size, sp->length); \ 291 } else { \ 292 (asoc)->total_output_queue_size = 0; \ 293 } \ 294 if (stcb->sctp_socket && ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \ 295 (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \ 296 if (stcb->sctp_socket->so_snd.sb_cc >= sp->length) { \ 297 atomic_subtract_int(&stcb->sctp_socket->so_snd.sb_cc,sp->length); \ 298 } else { \ 299 stcb->sctp_socket->so_snd.sb_cc = 0; \ 300 } \ 301 } \ 302 } \ 303} while (0) 304 305#define sctp_snd_sb_alloc(stcb, sz) \ 306do { \ 307 atomic_add_int(&stcb->asoc.total_output_queue_size,sz); \ 308 if ((stcb->sctp_socket != NULL) && \ 309 ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \ 310 (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \ 311 atomic_add_int(&stcb->sctp_socket->so_snd.sb_cc,sz); \ 312 } \ 313} while (0) 314 315 316int 317sctp_soreceive(struct socket *so, struct sockaddr **psa, 318 struct uio *uio, 319 struct mbuf **mp0, 320 struct mbuf **controlp, 321 int *flagsp); 322 323 324/* For those not passing mbufs, this does the 325 * translations for you. Caller owns memory 326 * of size controllen returned in controlp. 327 */ 328int 329sctp_l_soreceive(struct socket *so, 330 struct sockaddr **name, 331 struct uio *uio, 332 char **controlp, 333 int *controllen, 334 int *flag); 335 336 337void 338 sctp_misc_ints(uint8_t from, uint32_t a, uint32_t b, uint32_t c, uint32_t d); 339 340void 341sctp_wakeup_log(struct sctp_tcb *stcb, 342 uint32_t cumtsn, 343 uint32_t wake_cnt, int from); 344 345void sctp_log_strm_del_alt(struct sctp_tcb *stcb, uint32_t, uint16_t, uint16_t, int); 346 347void sctp_log_nagle_event(struct sctp_tcb *stcb, int action); 348 349 350void 351 sctp_log_mb(struct mbuf *m, int from); 352 353void 354sctp_sblog(struct sockbuf *sb, 355 struct sctp_tcb *stcb, int from, int incr); 356 357void 358sctp_log_strm_del(struct sctp_queued_to_read *control, 359 struct sctp_queued_to_read *poschk, 360 int from); 361void sctp_log_cwnd(struct sctp_tcb *stcb, struct sctp_nets *, int, uint8_t); 362void rto_logging(struct sctp_nets *net, int from); 363 364void sctp_log_closing(struct sctp_inpcb *inp, struct sctp_tcb *stcb, int16_t loc); 365 366void sctp_log_lock(struct sctp_inpcb *inp, struct sctp_tcb *stcb, uint8_t from); 367void sctp_log_maxburst(struct sctp_tcb *stcb, struct sctp_nets *, int, int, uint8_t); 368void sctp_log_block(uint8_t, struct socket *, struct sctp_association *, int); 369void sctp_log_rwnd(uint8_t, uint32_t, uint32_t, uint32_t); 370void sctp_log_mbcnt(uint8_t, uint32_t, uint32_t, uint32_t, uint32_t); 371void sctp_log_rwnd_set(uint8_t, uint32_t, uint32_t, uint32_t, uint32_t); 372int sctp_fill_stat_log(void *, size_t *); 373void sctp_log_fr(uint32_t, uint32_t, uint32_t, int); 374void sctp_log_sack(uint32_t, uint32_t, uint32_t, uint16_t, uint16_t, int); 375void sctp_log_map(uint32_t, uint32_t, uint32_t, int); 376 377void sctp_clr_stat_log(void); 378 379 380#ifdef SCTP_AUDITING_ENABLED 381void 382sctp_auditing(int, struct sctp_inpcb *, struct sctp_tcb *, 383 struct sctp_nets *); 384void sctp_audit_log(uint8_t, uint8_t); 385 386#endif 387 388 389#endif /* _KERNEL */ 390#endif 391