1163953Srrs/*- 2169382Srrs * Copyright (c) 2001-2007, by Cisco Systems, Inc. All rights reserved. 3235828Stuexen * Copyright (c) 2008-2012, by Randall Stewart. All rights reserved. 4235828Stuexen * Copyright (c) 2008-2012, by Michael Tuexen. All rights reserved. 5163953Srrs * 6163953Srrs * Redistribution and use in source and binary forms, with or without 7163953Srrs * modification, are permitted provided that the following conditions are met: 8163953Srrs * 9163953Srrs * a) Redistributions of source code must retain the above copyright notice, 10228653Stuexen * this list of conditions and the following disclaimer. 11163953Srrs * 12163953Srrs * b) Redistributions in binary form must reproduce the above copyright 13163953Srrs * notice, this list of conditions and the following disclaimer in 14228653Stuexen * the documentation and/or other materials provided with the distribution. 15163953Srrs * 16163953Srrs * c) Neither the name of Cisco Systems, Inc. nor the names of its 17163953Srrs * contributors may be used to endorse or promote products derived 18163953Srrs * from this software without specific prior written permission. 19163953Srrs * 20163953Srrs * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 21163953Srrs * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 22163953Srrs * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23163953Srrs * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 24163953Srrs * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 25163953Srrs * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 26163953Srrs * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 27163953Srrs * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 28163953Srrs * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 29163953Srrs * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 30163953Srrs * THE POSSIBILITY OF SUCH DAMAGE. 31163953Srrs */ 32163953Srrs 33163953Srrs#include <sys/cdefs.h> 34163953Srrs__FBSDID("$FreeBSD$"); 35163953Srrs 36235828Stuexen#ifndef _NETINET_SCTP_UTIL_H_ 37235828Stuexen#define _NETINET_SCTP_UTIL_H_ 38163953Srrs 39180387Srrs#if defined(_KERNEL) || defined(__Userspace__) 40163953Srrs 41195918Srrs#define SCTP_READ_LOCK_HELD 1 42195918Srrs#define SCTP_READ_LOCK_NOT_HELD 0 43168755Srrs 44168859Srrs#ifdef SCTP_ASOCLOG_OF_TSNS 45168859Srrsvoid sctp_print_out_track_log(struct sctp_tcb *stcb); 46168859Srrs 47168859Srrs#endif 48168859Srrs 49163953Srrs#ifdef SCTP_MBUF_LOGGING 50163953Srrsstruct mbuf *sctp_m_free(struct mbuf *m); 51163953Srrsvoid sctp_m_freem(struct mbuf *m); 52163953Srrs 53163953Srrs#else 54163953Srrs#define sctp_m_free m_free 55163953Srrs#define sctp_m_freem m_freem 56163953Srrs#endif 57163953Srrs 58171943Srrs#if defined(SCTP_LOCAL_TRACE_BUF) || defined(__APPLE__) 59171943Srrsvoid 60172157Srrs 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); 61163953Srrs 62171943Srrs#endif 63171943Srrs 64163953Srrs#define sctp_get_associd(stcb) ((sctp_assoc_t)stcb->asoc.assoc_id) 65163953Srrs 66163953Srrs 67163953Srrs/* 68163953Srrs * Function prototypes 69163953Srrs */ 70294149Stuexenint32_t 71294149Stuexensctp_map_assoc_state(int); 72294149Stuexen 73167698Srrsuint32_t 74167698Srrssctp_get_ifa_hash_val(struct sockaddr *addr); 75167698Srrs 76167598Srrsstruct sctp_ifa * 77167598Srrs sctp_find_ifa_in_ep(struct sctp_inpcb *inp, struct sockaddr *addr, int hold_lock); 78163953Srrs 79167598Srrsstruct sctp_ifa * 80167598Srrs sctp_find_ifa_by_addr(struct sockaddr *addr, uint32_t vrf_id, int holds_lock); 81167598Srrs 82163953Srrsuint32_t sctp_select_initial_TSN(struct sctp_pcb *); 83163953Srrs 84185694Srrsuint32_t sctp_select_a_tag(struct sctp_inpcb *, uint16_t lport, uint16_t rport, int); 85163953Srrs 86294215Stuexenint sctp_init_asoc(struct sctp_inpcb *, struct sctp_tcb *, uint32_t, uint32_t, uint16_t); 87163953Srrs 88163953Srrsvoid sctp_fill_random_store(struct sctp_pcb *); 89163953Srrs 90169420Srrsvoid 91233660Srrssctp_notify_stream_reset_add(struct sctp_tcb *stcb, uint16_t numberin, 92233660Srrs uint16_t numberout, int flag); 93233660Srrsvoid 94233660Srrs sctp_notify_stream_reset_tsn(struct sctp_tcb *stcb, uint32_t sending_tsn, uint32_t recv_tsn, int flag); 95233660Srrs 96233660Srrsvoid 97163953Srrssctp_timer_start(int, struct sctp_inpcb *, struct sctp_tcb *, 98163953Srrs struct sctp_nets *); 99163953Srrs 100169378Srrsvoid 101163953Srrssctp_timer_stop(int, struct sctp_inpcb *, struct sctp_tcb *, 102165220Srrs struct sctp_nets *, uint32_t); 103163953Srrs 104167598Srrsint 105167598Srrs sctp_dynamic_set_primary(struct sockaddr *sa, uint32_t vrf_id); 106167598Srrs 107163953Srrsvoid 108166023Srrs sctp_mtu_size_reset(struct sctp_inpcb *, struct sctp_association *, uint32_t); 109163953Srrs 110163953Srrsvoid 111163953Srrssctp_add_to_readq(struct sctp_inpcb *inp, 112163953Srrs struct sctp_tcb *stcb, 113163953Srrs struct sctp_queued_to_read *control, 114163953Srrs struct sockbuf *sb, 115172090Srrs int end, 116195918Srrs int inpread_locked, 117172090Srrs int so_locked 118172090Srrs#if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 119172090Srrs SCTP_UNUSED 120172090Srrs#endif 121172090Srrs); 122163953Srrs 123163953Srrsint 124163953Srrssctp_append_to_readq(struct sctp_inpcb *inp, 125163953Srrs struct sctp_tcb *stcb, 126163953Srrs struct sctp_queued_to_read *control, 127163953Srrs struct mbuf *m, 128163953Srrs int end, 129163953Srrs int new_cumack, 130163953Srrs struct sockbuf *sb); 131163953Srrs 132163953Srrs 133167598Srrsvoid sctp_iterator_worker(void); 134167598Srrs 135214939Stuexenuint32_t sctp_get_prev_mtu(uint32_t); 136228653Stuexenuint32_t sctp_get_next_mtu(uint32_t); 137163953Srrs 138163953Srrsvoid 139163953Srrs sctp_timeout_handler(void *); 140163953Srrs 141163953Srrsuint32_t 142163953Srrssctp_calculate_rto(struct sctp_tcb *, struct sctp_association *, 143218186Srrs struct sctp_nets *, struct timeval *, int, int); 144163953Srrs 145163953Srrsuint32_t sctp_calculate_len(struct mbuf *); 146163953Srrs 147163953Srrscaddr_t sctp_m_getptr(struct mbuf *, int, int, uint8_t *); 148163953Srrs 149163953Srrsstruct sctp_paramhdr * 150163953Srrssctp_get_next_param(struct mbuf *, int, 151163953Srrs struct sctp_paramhdr *, int); 152163953Srrs 153270354Stuexenstruct mbuf * 154270354Stuexen sctp_add_pad_tombuf(struct mbuf *, int); 155163953Srrs 156270354Stuexenstruct mbuf * 157270354Stuexen sctp_pad_lastmbuf(struct mbuf *, int, struct mbuf *); 158163953Srrs 159172090Srrsvoid 160172090Srrssctp_ulp_notify(uint32_t, struct sctp_tcb *, uint32_t, void *, int 161172090Srrs#if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 162172090Srrs SCTP_UNUSED 163172090Srrs#endif 164172090Srrs); 165163953Srrs 166163953Srrsvoid 167163953Srrssctp_pull_off_control_to_new_inp(struct sctp_inpcb *old_inp, 168163953Srrs struct sctp_inpcb *new_inp, 169169208Srrs struct sctp_tcb *stcb, int waitflags); 170163953Srrs 171163953Srrs 172163953Srrsvoid sctp_stop_timers_for_shutdown(struct sctp_tcb *); 173163953Srrs 174172090Srrsvoid 175235416Stuexensctp_report_all_outbound(struct sctp_tcb *, uint16_t, int, int 176172090Srrs#if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 177172090Srrs SCTP_UNUSED 178172090Srrs#endif 179172090Srrs); 180163953Srrs 181170138Srrsint sctp_expand_mapping_array(struct sctp_association *, uint32_t); 182163953Srrs 183172090Srrsvoid 184235403Stuexensctp_abort_notification(struct sctp_tcb *, uint8_t, uint16_t, 185235360Stuexen struct sctp_abort_chunk *, int 186172090Srrs#if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 187172090Srrs SCTP_UNUSED 188172090Srrs#endif 189172090Srrs); 190163953Srrs 191163953Srrs/* We abort responding to an IP packet for some reason */ 192163953Srrsvoid 193237049Stuexensctp_abort_association(struct sctp_inpcb *, struct sctp_tcb *, struct mbuf *, 194237715Stuexen int, struct sockaddr *, struct sockaddr *, 195237715Stuexen struct sctphdr *, struct mbuf *, 196237049Stuexen uint8_t, uint32_t, 197237049Stuexen uint32_t, uint16_t); 198163953Srrs 199169352Srrs 200163953Srrs/* We choose to abort via user input */ 201163953Srrsvoid 202235360Stuexensctp_abort_an_association(struct sctp_inpcb *, struct sctp_tcb *, 203172090Srrs struct mbuf *, int 204172090Srrs#if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 205172090Srrs SCTP_UNUSED 206172090Srrs#endif 207172090Srrs); 208163953Srrs 209169352Srrsvoid 210237715Stuexensctp_handle_ootb(struct mbuf *, int, int, 211237715Stuexen struct sockaddr *, struct sockaddr *, 212237715Stuexen struct sctphdr *, struct sctp_inpcb *, 213267723Stuexen struct mbuf *, 214284633Stuexen uint8_t, uint32_t, uint16_t, 215237049Stuexen uint32_t, uint16_t); 216163953Srrs 217170056Srrsint 218170056Srrssctp_connectx_helper_add(struct sctp_tcb *stcb, struct sockaddr *addr, 219170056Srrs int totaddr, int *error); 220169352Srrs 221169352Srrsstruct sctp_tcb * 222170056Srrssctp_connectx_helper_find(struct sctp_inpcb *inp, struct sockaddr *addr, 223170056Srrs int *totaddr, int *num_v4, int *num_v6, int *error, int limit, int *bad_addr); 224169352Srrs 225163953Srrsint sctp_is_there_an_abort_here(struct mbuf *, int, uint32_t *); 226178251Srrs 227178251Srrs#ifdef INET6 228163953Srrsuint32_t sctp_is_same_scope(struct sockaddr_in6 *, struct sockaddr_in6 *); 229166675Srrs 230163953Srrsstruct sockaddr_in6 * 231166675Srrs sctp_recover_scope(struct sockaddr_in6 *, struct sockaddr_in6 *); 232163953Srrs 233163953Srrs#define sctp_recover_scope_mac(addr, store) do { \ 234166675Srrs if ((addr->sin6_family == AF_INET6) && \ 235166675Srrs (IN6_IS_SCOPE_LINKLOCAL(&addr->sin6_addr))) { \ 236166675Srrs *store = *addr; \ 237166675Srrs if (addr->sin6_scope_id == 0) { \ 238166675Srrs if (!sa6_recoverscope(store)) { \ 239166675Srrs addr = store; \ 240166675Srrs } \ 241166675Srrs } else { \ 242166675Srrs in6_clearscope(&addr->sin6_addr); \ 243166675Srrs addr = store; \ 244166675Srrs } \ 245166675Srrs } \ 246166675Srrs} while (0) 247178251Srrs#endif 248163953Srrs 249163953Srrsint sctp_cmpaddr(struct sockaddr *, struct sockaddr *); 250163953Srrs 251163953Srrsvoid sctp_print_address(struct sockaddr *); 252163953Srrs 253163953Srrsint 254163953Srrssctp_release_pr_sctp_chunk(struct sctp_tcb *, struct sctp_tmit_chunk *, 255235416Stuexen uint8_t, int 256172090Srrs#if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 257172090Srrs SCTP_UNUSED 258172090Srrs#endif 259172090Srrs); 260163953Srrs 261267723Stuexenstruct mbuf *sctp_generate_cause(uint16_t, char *); 262267729Stuexenstruct mbuf *sctp_generate_no_user_data_cause(uint32_t); 263163953Srrs 264170606Srrsvoid 265170606Srrssctp_bindx_add_address(struct socket *so, struct sctp_inpcb *inp, 266170606Srrs struct sockaddr *sa, sctp_assoc_t assoc_id, 267170606Srrs uint32_t vrf_id, int *error, void *p); 268170606Srrsvoid 269228653Stuexensctp_bindx_delete_address(struct sctp_inpcb *inp, 270170606Srrs struct sockaddr *sa, sctp_assoc_t assoc_id, 271170606Srrs uint32_t vrf_id, int *error); 272163953Srrs 273171572Srrsint sctp_local_addr_count(struct sctp_tcb *stcb); 274171572Srrs 275163953Srrs#ifdef SCTP_MBCNT_LOGGING 276163953Srrsvoid 277163953Srrssctp_free_bufspace(struct sctp_tcb *, struct sctp_association *, 278170744Srrs struct sctp_tmit_chunk *, int); 279163953Srrs 280163953Srrs#else 281163953Srrs#define sctp_free_bufspace(stcb, asoc, tp1, chk_cnt) \ 282163953Srrsdo { \ 283163953Srrs if (tp1->data != NULL) { \ 284270352Stuexen atomic_subtract_int(&((asoc)->chunks_on_out_queue), chk_cnt); \ 285163953Srrs if ((asoc)->total_output_queue_size >= tp1->book_size) { \ 286169420Srrs atomic_subtract_int(&((asoc)->total_output_queue_size), tp1->book_size); \ 287163953Srrs } else { \ 288163953Srrs (asoc)->total_output_queue_size = 0; \ 289163953Srrs } \ 290270352Stuexen if (stcb->sctp_socket && ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \ 291270352Stuexen (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \ 292163953Srrs if (stcb->sctp_socket->so_snd.sb_cc >= tp1->book_size) { \ 293169420Srrs atomic_subtract_int(&((stcb)->sctp_socket->so_snd.sb_cc), tp1->book_size); \ 294163953Srrs } else { \ 295163953Srrs stcb->sctp_socket->so_snd.sb_cc = 0; \ 296163953Srrs } \ 297163953Srrs } \ 298270352Stuexen } \ 299163953Srrs} while (0) 300163953Srrs 301163953Srrs#endif 302163953Srrs 303163953Srrs#define sctp_free_spbufspace(stcb, asoc, sp) \ 304163953Srrsdo { \ 305270352Stuexen if (sp->data != NULL) { \ 306163953Srrs if ((asoc)->total_output_queue_size >= sp->length) { \ 307169420Srrs atomic_subtract_int(&(asoc)->total_output_queue_size, sp->length); \ 308163953Srrs } else { \ 309163953Srrs (asoc)->total_output_queue_size = 0; \ 310163953Srrs } \ 311270352Stuexen if (stcb->sctp_socket && ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \ 312270352Stuexen (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \ 313163953Srrs if (stcb->sctp_socket->so_snd.sb_cc >= sp->length) { \ 314169420Srrs atomic_subtract_int(&stcb->sctp_socket->so_snd.sb_cc,sp->length); \ 315163953Srrs } else { \ 316163953Srrs stcb->sctp_socket->so_snd.sb_cc = 0; \ 317163953Srrs } \ 318163953Srrs } \ 319270352Stuexen } \ 320163953Srrs} while (0) 321163953Srrs 322163953Srrs#define sctp_snd_sb_alloc(stcb, sz) \ 323163953Srrsdo { \ 324163953Srrs atomic_add_int(&stcb->asoc.total_output_queue_size,sz); \ 325163953Srrs if ((stcb->sctp_socket != NULL) && \ 326163953Srrs ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \ 327163953Srrs (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \ 328163953Srrs atomic_add_int(&stcb->sctp_socket->so_snd.sb_cc,sz); \ 329163953Srrs } \ 330163953Srrs} while (0) 331163953Srrs 332221328Stuexen/* functions to start/stop udp tunneling */ 333179157Srrsvoid sctp_over_udp_stop(void); 334179157Srrsint sctp_over_udp_start(void); 335163953Srrs 336163953Srrsint 337163953Srrssctp_soreceive(struct socket *so, struct sockaddr **psa, 338163953Srrs struct uio *uio, 339163953Srrs struct mbuf **mp0, 340163953Srrs struct mbuf **controlp, 341163953Srrs int *flagsp); 342163953Srrs 343163953Srrsvoid 344163953Srrs sctp_misc_ints(uint8_t from, uint32_t a, uint32_t b, uint32_t c, uint32_t d); 345163953Srrs 346163953Srrsvoid 347163953Srrssctp_wakeup_log(struct sctp_tcb *stcb, 348163953Srrs uint32_t wake_cnt, int from); 349163953Srrs 350164181Srrsvoid sctp_log_strm_del_alt(struct sctp_tcb *stcb, uint32_t, uint16_t, uint16_t, int); 351163953Srrs 352163953Srrsvoid sctp_log_nagle_event(struct sctp_tcb *stcb, int action); 353163953Srrs 354163953Srrs 355283708Stuexen#ifdef SCTP_MBUF_LOGGING 356163953Srrsvoid 357163953Srrs sctp_log_mb(struct mbuf *m, int from); 358163953Srrs 359163953Srrsvoid 360283708Stuexen sctp_log_mbc(struct mbuf *m, int from); 361283708Stuexen 362283708Stuexen#endif 363283708Stuexen 364283708Stuexenvoid 365163953Srrssctp_sblog(struct sockbuf *sb, 366163953Srrs struct sctp_tcb *stcb, int from, int incr); 367163953Srrs 368163953Srrsvoid 369163953Srrssctp_log_strm_del(struct sctp_queued_to_read *control, 370163953Srrs struct sctp_queued_to_read *poschk, 371163953Srrs int from); 372163953Srrsvoid sctp_log_cwnd(struct sctp_tcb *stcb, struct sctp_nets *, int, uint8_t); 373163953Srrsvoid rto_logging(struct sctp_nets *net, int from); 374163953Srrs 375163953Srrsvoid sctp_log_closing(struct sctp_inpcb *inp, struct sctp_tcb *stcb, int16_t loc); 376163953Srrs 377163953Srrsvoid sctp_log_lock(struct sctp_inpcb *inp, struct sctp_tcb *stcb, uint8_t from); 378163953Srrsvoid sctp_log_maxburst(struct sctp_tcb *stcb, struct sctp_nets *, int, int, uint8_t); 379228653Stuexenvoid sctp_log_block(uint8_t, struct sctp_association *, int); 380163953Srrsvoid sctp_log_rwnd(uint8_t, uint32_t, uint32_t, uint32_t); 381163953Srrsvoid sctp_log_rwnd_set(uint8_t, uint32_t, uint32_t, uint32_t, uint32_t); 382167598Srrsint sctp_fill_stat_log(void *, size_t *); 383163953Srrsvoid sctp_log_fr(uint32_t, uint32_t, uint32_t, int); 384163953Srrsvoid sctp_log_sack(uint32_t, uint32_t, uint32_t, uint16_t, uint16_t, int); 385163953Srrsvoid sctp_log_map(uint32_t, uint32_t, uint32_t, int); 386205502Srrsvoid sctp_print_mapping_array(struct sctp_association *asoc); 387163953Srrsvoid sctp_clr_stat_log(void); 388163953Srrs 389163953Srrs 390163953Srrs#ifdef SCTP_AUDITING_ENABLED 391163953Srrsvoid 392163953Srrssctp_auditing(int, struct sctp_inpcb *, struct sctp_tcb *, 393163953Srrs struct sctp_nets *); 394163953Srrsvoid sctp_audit_log(uint8_t, uint8_t); 395163953Srrs 396163953Srrs#endif 397163953Srrs#endif /* _KERNEL */ 398163953Srrs#endif 399