sctputil.h revision 235360
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: head/sys/netinet/sctputil.h 235360 2012-05-12 20:11:35Z tuexen $"); 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 48void sctp_print_out_track_log(struct sctp_tcb *stcb); 49 50#endif 51 52#ifdef SCTP_MBUF_LOGGING 53struct mbuf *sctp_m_free(struct mbuf *m); 54void 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__) 62void 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 */ 73uint32_t 74sctp_get_ifa_hash_val(struct sockaddr *addr); 75 76struct sctp_ifa * 77 sctp_find_ifa_in_ep(struct sctp_inpcb *inp, struct sockaddr *addr, int hold_lock); 78 79struct sctp_ifa * 80 sctp_find_ifa_by_addr(struct sockaddr *addr, uint32_t vrf_id, int holds_lock); 81 82uint32_t sctp_select_initial_TSN(struct sctp_pcb *); 83 84uint32_t sctp_select_a_tag(struct sctp_inpcb *, uint16_t lport, uint16_t rport, int); 85 86int sctp_init_asoc(struct sctp_inpcb *, struct sctp_tcb *, uint32_t, uint32_t); 87 88void sctp_fill_random_store(struct sctp_pcb *); 89 90void 91sctp_notify_stream_reset_add(struct sctp_tcb *stcb, uint16_t numberin, 92 uint16_t numberout, int flag); 93void 94 sctp_notify_stream_reset_tsn(struct sctp_tcb *stcb, uint32_t sending_tsn, uint32_t recv_tsn, int flag); 95 96void 97sctp_timer_start(int, struct sctp_inpcb *, struct sctp_tcb *, 98 struct sctp_nets *); 99 100void 101sctp_timer_stop(int, struct sctp_inpcb *, struct sctp_tcb *, 102 struct sctp_nets *, uint32_t); 103 104int 105 sctp_dynamic_set_primary(struct sockaddr *sa, uint32_t vrf_id); 106 107void 108 sctp_mtu_size_reset(struct sctp_inpcb *, struct sctp_association *, uint32_t); 109 110void 111sctp_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 123int 124sctp_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 133void sctp_iterator_worker(void); 134 135uint32_t sctp_get_prev_mtu(uint32_t); 136uint32_t sctp_get_next_mtu(uint32_t); 137 138void 139 sctp_timeout_handler(void *); 140 141uint32_t 142sctp_calculate_rto(struct sctp_tcb *, struct sctp_association *, 143 struct sctp_nets *, struct timeval *, int, int); 144 145uint32_t sctp_calculate_len(struct mbuf *); 146 147caddr_t sctp_m_getptr(struct mbuf *, int, int, uint8_t *); 148 149struct sctp_paramhdr * 150sctp_get_next_param(struct mbuf *, int, 151 struct sctp_paramhdr *, int); 152 153int sctp_add_pad_tombuf(struct mbuf *, int); 154 155int sctp_pad_lastmbuf(struct mbuf *, int, struct mbuf *); 156 157void 158sctp_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 164void 165sctp_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 170void sctp_stop_timers_for_shutdown(struct sctp_tcb *); 171 172void 173sctp_report_all_outbound(struct sctp_tcb *, int, int 174#if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 175 SCTP_UNUSED 176#endif 177); 178 179int sctp_expand_mapping_array(struct sctp_association *, uint32_t); 180 181void 182sctp_abort_notification(struct sctp_tcb *, uint16_t, 183 struct sctp_abort_chunk *, int 184#if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 185 SCTP_UNUSED 186#endif 187); 188 189/* We abort responding to an IP packet for some reason */ 190void 191sctp_abort_association(struct sctp_inpcb *, struct sctp_tcb *, 192 struct mbuf *, int, struct sctphdr *, struct mbuf *, uint32_t, uint16_t); 193 194 195/* We choose to abort via user input */ 196void 197sctp_abort_an_association(struct sctp_inpcb *, struct sctp_tcb *, 198 struct mbuf *, int 199#if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 200 SCTP_UNUSED 201#endif 202); 203 204void 205sctp_handle_ootb(struct mbuf *, int, int, struct sctphdr *, 206 struct sctp_inpcb *, struct mbuf *, uint32_t, uint16_t); 207 208int 209sctp_connectx_helper_add(struct sctp_tcb *stcb, struct sockaddr *addr, 210 int totaddr, int *error); 211 212struct sctp_tcb * 213sctp_connectx_helper_find(struct sctp_inpcb *inp, struct sockaddr *addr, 214 int *totaddr, int *num_v4, int *num_v6, int *error, int limit, int *bad_addr); 215 216int sctp_is_there_an_abort_here(struct mbuf *, int, uint32_t *); 217 218#ifdef INET6 219uint32_t sctp_is_same_scope(struct sockaddr_in6 *, struct sockaddr_in6 *); 220 221struct sockaddr_in6 * 222 sctp_recover_scope(struct sockaddr_in6 *, struct sockaddr_in6 *); 223 224#define sctp_recover_scope_mac(addr, store) do { \ 225 if ((addr->sin6_family == AF_INET6) && \ 226 (IN6_IS_SCOPE_LINKLOCAL(&addr->sin6_addr))) { \ 227 *store = *addr; \ 228 if (addr->sin6_scope_id == 0) { \ 229 if (!sa6_recoverscope(store)) { \ 230 addr = store; \ 231 } \ 232 } else { \ 233 in6_clearscope(&addr->sin6_addr); \ 234 addr = store; \ 235 } \ 236 } \ 237} while (0) 238#endif 239 240int sctp_cmpaddr(struct sockaddr *, struct sockaddr *); 241 242void sctp_print_address(struct sockaddr *); 243void sctp_print_address_pkt(struct ip *, struct sctphdr *); 244 245int 246sctp_release_pr_sctp_chunk(struct sctp_tcb *, struct sctp_tmit_chunk *, 247 int, int 248#if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 249 SCTP_UNUSED 250#endif 251); 252 253struct mbuf *sctp_generate_invmanparam(int); 254 255void 256sctp_bindx_add_address(struct socket *so, struct sctp_inpcb *inp, 257 struct sockaddr *sa, sctp_assoc_t assoc_id, 258 uint32_t vrf_id, int *error, void *p); 259void 260sctp_bindx_delete_address(struct sctp_inpcb *inp, 261 struct sockaddr *sa, sctp_assoc_t assoc_id, 262 uint32_t vrf_id, int *error); 263 264int sctp_local_addr_count(struct sctp_tcb *stcb); 265 266#ifdef SCTP_MBCNT_LOGGING 267void 268sctp_free_bufspace(struct sctp_tcb *, struct sctp_association *, 269 struct sctp_tmit_chunk *, int); 270 271#else 272#define sctp_free_bufspace(stcb, asoc, tp1, chk_cnt) \ 273do { \ 274 if (tp1->data != NULL) { \ 275 atomic_subtract_int(&((asoc)->chunks_on_out_queue), chk_cnt); \ 276 if ((asoc)->total_output_queue_size >= tp1->book_size) { \ 277 atomic_subtract_int(&((asoc)->total_output_queue_size), tp1->book_size); \ 278 } else { \ 279 (asoc)->total_output_queue_size = 0; \ 280 } \ 281 if (stcb->sctp_socket && ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \ 282 (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \ 283 if (stcb->sctp_socket->so_snd.sb_cc >= tp1->book_size) { \ 284 atomic_subtract_int(&((stcb)->sctp_socket->so_snd.sb_cc), tp1->book_size); \ 285 } else { \ 286 stcb->sctp_socket->so_snd.sb_cc = 0; \ 287 } \ 288 } \ 289 } \ 290} while (0) 291 292#endif 293 294#define sctp_free_spbufspace(stcb, asoc, sp) \ 295do { \ 296 if (sp->data != NULL) { \ 297 if ((asoc)->total_output_queue_size >= sp->length) { \ 298 atomic_subtract_int(&(asoc)->total_output_queue_size, sp->length); \ 299 } else { \ 300 (asoc)->total_output_queue_size = 0; \ 301 } \ 302 if (stcb->sctp_socket && ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \ 303 (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \ 304 if (stcb->sctp_socket->so_snd.sb_cc >= sp->length) { \ 305 atomic_subtract_int(&stcb->sctp_socket->so_snd.sb_cc,sp->length); \ 306 } else { \ 307 stcb->sctp_socket->so_snd.sb_cc = 0; \ 308 } \ 309 } \ 310 } \ 311} while (0) 312 313#define sctp_snd_sb_alloc(stcb, sz) \ 314do { \ 315 atomic_add_int(&stcb->asoc.total_output_queue_size,sz); \ 316 if ((stcb->sctp_socket != NULL) && \ 317 ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \ 318 (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \ 319 atomic_add_int(&stcb->sctp_socket->so_snd.sb_cc,sz); \ 320 } \ 321} while (0) 322 323/* functions to start/stop udp tunneling */ 324/* XXX: Remove the #ifdef after tunneling over IPv6 works also on FreeBSD. */ 325#ifdef INET 326void sctp_over_udp_stop(void); 327int sctp_over_udp_start(void); 328 329#endif 330 331int 332sctp_soreceive(struct socket *so, struct sockaddr **psa, 333 struct uio *uio, 334 struct mbuf **mp0, 335 struct mbuf **controlp, 336 int *flagsp); 337 338void 339 sctp_misc_ints(uint8_t from, uint32_t a, uint32_t b, uint32_t c, uint32_t d); 340 341void 342sctp_wakeup_log(struct sctp_tcb *stcb, 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 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); 376void sctp_print_mapping_array(struct sctp_association *asoc); 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