sctputil.h revision 237049
1/*- 2 * Copyright (c) 2001-2007, by Cisco Systems, Inc. All rights reserved. 3 * Copyright (c) 2008-2012, by Randall Stewart. All rights reserved. 4 * Copyright (c) 2008-2012, 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#include <sys/cdefs.h> 34__FBSDID("$FreeBSD: head/sys/netinet/sctputil.h 237049 2012-06-14 06:54:48Z tuexen $"); 35 36#ifndef _NETINET_SCTP_UTIL_H_ 37#define _NETINET_SCTP_UTIL_H_ 38 39#if defined(_KERNEL) || defined(__Userspace__) 40 41#define SCTP_READ_LOCK_HELD 1 42#define SCTP_READ_LOCK_NOT_HELD 0 43 44#ifdef SCTP_ASOCLOG_OF_TSNS 45void sctp_print_out_track_log(struct sctp_tcb *stcb); 46 47#endif 48 49#ifdef SCTP_MBUF_LOGGING 50struct mbuf *sctp_m_free(struct mbuf *m); 51void sctp_m_freem(struct mbuf *m); 52 53#else 54#define sctp_m_free m_free 55#define sctp_m_freem m_freem 56#endif 57 58#if defined(SCTP_LOCAL_TRACE_BUF) || defined(__APPLE__) 59void 60 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); 61 62#endif 63 64#define sctp_get_associd(stcb) ((sctp_assoc_t)stcb->asoc.assoc_id) 65 66 67/* 68 * Function prototypes 69 */ 70uint32_t 71sctp_get_ifa_hash_val(struct sockaddr *addr); 72 73struct sctp_ifa * 74 sctp_find_ifa_in_ep(struct sctp_inpcb *inp, struct sockaddr *addr, int hold_lock); 75 76struct sctp_ifa * 77 sctp_find_ifa_by_addr(struct sockaddr *addr, uint32_t vrf_id, int holds_lock); 78 79uint32_t sctp_select_initial_TSN(struct sctp_pcb *); 80 81uint32_t sctp_select_a_tag(struct sctp_inpcb *, uint16_t lport, uint16_t rport, int); 82 83int sctp_init_asoc(struct sctp_inpcb *, struct sctp_tcb *, uint32_t, uint32_t); 84 85void sctp_fill_random_store(struct sctp_pcb *); 86 87void 88sctp_notify_stream_reset_add(struct sctp_tcb *stcb, uint16_t numberin, 89 uint16_t numberout, int flag); 90void 91 sctp_notify_stream_reset_tsn(struct sctp_tcb *stcb, uint32_t sending_tsn, uint32_t recv_tsn, int flag); 92 93void 94sctp_timer_start(int, struct sctp_inpcb *, struct sctp_tcb *, 95 struct sctp_nets *); 96 97void 98sctp_timer_stop(int, struct sctp_inpcb *, struct sctp_tcb *, 99 struct sctp_nets *, uint32_t); 100 101int 102 sctp_dynamic_set_primary(struct sockaddr *sa, uint32_t vrf_id); 103 104void 105 sctp_mtu_size_reset(struct sctp_inpcb *, struct sctp_association *, uint32_t); 106 107void 108sctp_add_to_readq(struct sctp_inpcb *inp, 109 struct sctp_tcb *stcb, 110 struct sctp_queued_to_read *control, 111 struct sockbuf *sb, 112 int end, 113 int inpread_locked, 114 int so_locked 115#if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 116 SCTP_UNUSED 117#endif 118); 119 120int 121sctp_append_to_readq(struct sctp_inpcb *inp, 122 struct sctp_tcb *stcb, 123 struct sctp_queued_to_read *control, 124 struct mbuf *m, 125 int end, 126 int new_cumack, 127 struct sockbuf *sb); 128 129 130void sctp_iterator_worker(void); 131 132uint32_t sctp_get_prev_mtu(uint32_t); 133uint32_t sctp_get_next_mtu(uint32_t); 134 135void 136 sctp_timeout_handler(void *); 137 138uint32_t 139sctp_calculate_rto(struct sctp_tcb *, struct sctp_association *, 140 struct sctp_nets *, struct timeval *, int, int); 141 142uint32_t sctp_calculate_len(struct mbuf *); 143 144caddr_t sctp_m_getptr(struct mbuf *, int, int, uint8_t *); 145 146struct sctp_paramhdr * 147sctp_get_next_param(struct mbuf *, int, 148 struct sctp_paramhdr *, int); 149 150int sctp_add_pad_tombuf(struct mbuf *, int); 151 152int sctp_pad_lastmbuf(struct mbuf *, int, struct mbuf *); 153 154void 155sctp_ulp_notify(uint32_t, struct sctp_tcb *, uint32_t, void *, int 156#if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 157 SCTP_UNUSED 158#endif 159); 160 161void 162sctp_pull_off_control_to_new_inp(struct sctp_inpcb *old_inp, 163 struct sctp_inpcb *new_inp, 164 struct sctp_tcb *stcb, int waitflags); 165 166 167void sctp_stop_timers_for_shutdown(struct sctp_tcb *); 168 169void 170sctp_report_all_outbound(struct sctp_tcb *, uint16_t, int, int 171#if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 172 SCTP_UNUSED 173#endif 174); 175 176int sctp_expand_mapping_array(struct sctp_association *, uint32_t); 177 178void 179sctp_abort_notification(struct sctp_tcb *, uint8_t, uint16_t, 180 struct sctp_abort_chunk *, int 181#if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 182 SCTP_UNUSED 183#endif 184); 185 186/* We abort responding to an IP packet for some reason */ 187void 188sctp_abort_association(struct sctp_inpcb *, struct sctp_tcb *, struct mbuf *, 189 int, struct sctphdr *, struct mbuf *, 190 uint8_t, uint32_t, 191 uint32_t, uint16_t); 192 193 194/* We choose to abort via user input */ 195void 196sctp_abort_an_association(struct sctp_inpcb *, struct sctp_tcb *, 197 struct mbuf *, int 198#if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 199 SCTP_UNUSED 200#endif 201); 202 203void 204sctp_handle_ootb(struct mbuf *, int, int, struct sctphdr *, 205 struct sctp_inpcb *, 206 uint8_t, uint32_t, 207 uint32_t, uint16_t); 208 209int 210sctp_connectx_helper_add(struct sctp_tcb *stcb, struct sockaddr *addr, 211 int totaddr, int *error); 212 213struct sctp_tcb * 214sctp_connectx_helper_find(struct sctp_inpcb *inp, struct sockaddr *addr, 215 int *totaddr, int *num_v4, int *num_v6, int *error, int limit, int *bad_addr); 216 217int sctp_is_there_an_abort_here(struct mbuf *, int, uint32_t *); 218 219#ifdef INET6 220uint32_t sctp_is_same_scope(struct sockaddr_in6 *, struct sockaddr_in6 *); 221 222struct sockaddr_in6 * 223 sctp_recover_scope(struct sockaddr_in6 *, struct sockaddr_in6 *); 224 225#define sctp_recover_scope_mac(addr, store) do { \ 226 if ((addr->sin6_family == AF_INET6) && \ 227 (IN6_IS_SCOPE_LINKLOCAL(&addr->sin6_addr))) { \ 228 *store = *addr; \ 229 if (addr->sin6_scope_id == 0) { \ 230 if (!sa6_recoverscope(store)) { \ 231 addr = store; \ 232 } \ 233 } else { \ 234 in6_clearscope(&addr->sin6_addr); \ 235 addr = store; \ 236 } \ 237 } \ 238} while (0) 239#endif 240 241int sctp_cmpaddr(struct sockaddr *, struct sockaddr *); 242 243void sctp_print_address(struct sockaddr *); 244void sctp_print_address_pkt(struct ip *, struct sctphdr *); 245 246int 247sctp_release_pr_sctp_chunk(struct sctp_tcb *, struct sctp_tmit_chunk *, 248 uint8_t, int 249#if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 250 SCTP_UNUSED 251#endif 252); 253 254struct mbuf *sctp_generate_invmanparam(int); 255 256void 257sctp_bindx_add_address(struct socket *so, struct sctp_inpcb *inp, 258 struct sockaddr *sa, sctp_assoc_t assoc_id, 259 uint32_t vrf_id, int *error, void *p); 260void 261sctp_bindx_delete_address(struct sctp_inpcb *inp, 262 struct sockaddr *sa, sctp_assoc_t assoc_id, 263 uint32_t vrf_id, int *error); 264 265int sctp_local_addr_count(struct sctp_tcb *stcb); 266 267#ifdef SCTP_MBCNT_LOGGING 268void 269sctp_free_bufspace(struct sctp_tcb *, struct sctp_association *, 270 struct sctp_tmit_chunk *, int); 271 272#else 273#define sctp_free_bufspace(stcb, asoc, tp1, chk_cnt) \ 274do { \ 275 if (tp1->data != NULL) { \ 276 atomic_subtract_int(&((asoc)->chunks_on_out_queue), chk_cnt); \ 277 if ((asoc)->total_output_queue_size >= tp1->book_size) { \ 278 atomic_subtract_int(&((asoc)->total_output_queue_size), tp1->book_size); \ 279 } else { \ 280 (asoc)->total_output_queue_size = 0; \ 281 } \ 282 if (stcb->sctp_socket && ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \ 283 (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \ 284 if (stcb->sctp_socket->so_snd.sb_cc >= tp1->book_size) { \ 285 atomic_subtract_int(&((stcb)->sctp_socket->so_snd.sb_cc), tp1->book_size); \ 286 } else { \ 287 stcb->sctp_socket->so_snd.sb_cc = 0; \ 288 } \ 289 } \ 290 } \ 291} while (0) 292 293#endif 294 295#define sctp_free_spbufspace(stcb, asoc, sp) \ 296do { \ 297 if (sp->data != NULL) { \ 298 if ((asoc)->total_output_queue_size >= sp->length) { \ 299 atomic_subtract_int(&(asoc)->total_output_queue_size, sp->length); \ 300 } else { \ 301 (asoc)->total_output_queue_size = 0; \ 302 } \ 303 if (stcb->sctp_socket && ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \ 304 (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \ 305 if (stcb->sctp_socket->so_snd.sb_cc >= sp->length) { \ 306 atomic_subtract_int(&stcb->sctp_socket->so_snd.sb_cc,sp->length); \ 307 } else { \ 308 stcb->sctp_socket->so_snd.sb_cc = 0; \ 309 } \ 310 } \ 311 } \ 312} while (0) 313 314#define sctp_snd_sb_alloc(stcb, sz) \ 315do { \ 316 atomic_add_int(&stcb->asoc.total_output_queue_size,sz); \ 317 if ((stcb->sctp_socket != NULL) && \ 318 ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \ 319 (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \ 320 atomic_add_int(&stcb->sctp_socket->so_snd.sb_cc,sz); \ 321 } \ 322} while (0) 323 324/* functions to start/stop udp tunneling */ 325/* XXX: Remove the #ifdef after tunneling over IPv6 works also on FreeBSD. */ 326#ifdef INET 327void sctp_over_udp_stop(void); 328int sctp_over_udp_start(void); 329 330#endif 331 332int 333sctp_soreceive(struct socket *so, struct sockaddr **psa, 334 struct uio *uio, 335 struct mbuf **mp0, 336 struct mbuf **controlp, 337 int *flagsp); 338 339void 340 sctp_misc_ints(uint8_t from, uint32_t a, uint32_t b, uint32_t c, uint32_t d); 341 342void 343sctp_wakeup_log(struct sctp_tcb *stcb, 344 uint32_t wake_cnt, int from); 345 346void sctp_log_strm_del_alt(struct sctp_tcb *stcb, uint32_t, uint16_t, uint16_t, int); 347 348void sctp_log_nagle_event(struct sctp_tcb *stcb, int action); 349 350 351void 352 sctp_log_mb(struct mbuf *m, int from); 353 354void 355sctp_sblog(struct sockbuf *sb, 356 struct sctp_tcb *stcb, int from, int incr); 357 358void 359sctp_log_strm_del(struct sctp_queued_to_read *control, 360 struct sctp_queued_to_read *poschk, 361 int from); 362void sctp_log_cwnd(struct sctp_tcb *stcb, struct sctp_nets *, int, uint8_t); 363void rto_logging(struct sctp_nets *net, int from); 364 365void sctp_log_closing(struct sctp_inpcb *inp, struct sctp_tcb *stcb, int16_t loc); 366 367void sctp_log_lock(struct sctp_inpcb *inp, struct sctp_tcb *stcb, uint8_t from); 368void sctp_log_maxburst(struct sctp_tcb *stcb, struct sctp_nets *, int, int, uint8_t); 369void sctp_log_block(uint8_t, struct sctp_association *, int); 370void sctp_log_rwnd(uint8_t, uint32_t, uint32_t, uint32_t); 371void sctp_log_mbcnt(uint8_t, uint32_t, uint32_t, uint32_t, uint32_t); 372void sctp_log_rwnd_set(uint8_t, uint32_t, uint32_t, uint32_t, uint32_t); 373int sctp_fill_stat_log(void *, size_t *); 374void sctp_log_fr(uint32_t, uint32_t, uint32_t, int); 375void sctp_log_sack(uint32_t, uint32_t, uint32_t, uint16_t, uint16_t, int); 376void sctp_log_map(uint32_t, uint32_t, uint32_t, int); 377void sctp_print_mapping_array(struct sctp_association *asoc); 378void sctp_clr_stat_log(void); 379 380 381#ifdef SCTP_AUDITING_ENABLED 382void 383sctp_auditing(int, struct sctp_inpcb *, struct sctp_tcb *, 384 struct sctp_nets *); 385void sctp_audit_log(uint8_t, uint8_t); 386 387#endif 388#endif /* _KERNEL */ 389#endif 390