sctputil.h revision 360735
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: stable/11/sys/netinet/sctputil.h 360735 2020-05-07 01:34:41Z tuexen $"); 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#endif 47168859Srrs 48163953Srrs#ifdef SCTP_MBUF_LOGGING 49163953Srrsstruct mbuf *sctp_m_free(struct mbuf *m); 50163953Srrsvoid sctp_m_freem(struct mbuf *m); 51163953Srrs#else 52163953Srrs#define sctp_m_free m_free 53163953Srrs#define sctp_m_freem m_freem 54163953Srrs#endif 55163953Srrs 56171943Srrs#if defined(SCTP_LOCAL_TRACE_BUF) || defined(__APPLE__) 57171943Srrsvoid 58172157Srrs 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); 59171943Srrs#endif 60171943Srrs 61163953Srrs#define sctp_get_associd(stcb) ((sctp_assoc_t)stcb->asoc.assoc_id) 62163953Srrs 63163953Srrs 64163953Srrs/* 65163953Srrs * Function prototypes 66163953Srrs */ 67287282Stuexenint32_t 68310773Stuexen sctp_map_assoc_state(int); 69287282Stuexen 70167698Srrsuint32_t 71310773Stuexen sctp_get_ifa_hash_val(struct sockaddr *addr); 72167698Srrs 73347154Stuexenstruct sctp_ifa *sctp_find_ifa_in_ep(struct sctp_inpcb *inp, struct sockaddr *addr, int hold_lock); 74163953Srrs 75347154Stuexenstruct sctp_ifa *sctp_find_ifa_by_addr(struct sockaddr *addr, uint32_t vrf_id, int holds_lock); 76167598Srrs 77163953Srrsuint32_t sctp_select_initial_TSN(struct sctp_pcb *); 78163953Srrs 79185694Srrsuint32_t sctp_select_a_tag(struct sctp_inpcb *, uint16_t lport, uint16_t rport, int); 80163953Srrs 81291904Stuexenint sctp_init_asoc(struct sctp_inpcb *, struct sctp_tcb *, uint32_t, uint32_t, uint16_t); 82163953Srrs 83163953Srrsvoid sctp_fill_random_store(struct sctp_pcb *); 84163953Srrs 85169420Srrsvoid 86233660Srrssctp_notify_stream_reset_add(struct sctp_tcb *stcb, uint16_t numberin, 87233660Srrs uint16_t numberout, int flag); 88233660Srrsvoid 89233660Srrs sctp_notify_stream_reset_tsn(struct sctp_tcb *stcb, uint32_t sending_tsn, uint32_t recv_tsn, int flag); 90233660Srrs 91233660Srrsvoid 92163953Srrssctp_timer_start(int, struct sctp_inpcb *, struct sctp_tcb *, 93163953Srrs struct sctp_nets *); 94163953Srrs 95169378Srrsvoid 96163953Srrssctp_timer_stop(int, struct sctp_inpcb *, struct sctp_tcb *, 97165220Srrs struct sctp_nets *, uint32_t); 98163953Srrs 99167598Srrsint 100167598Srrs sctp_dynamic_set_primary(struct sockaddr *sa, uint32_t vrf_id); 101167598Srrs 102163953Srrsvoid 103166023Srrs sctp_mtu_size_reset(struct sctp_inpcb *, struct sctp_association *, uint32_t); 104163953Srrs 105163953Srrsvoid 106298223Stuexensctp_wakeup_the_read_socket(struct sctp_inpcb *inp, struct sctp_tcb *stcb, 107298223Stuexen int so_locked 108298223Stuexen#if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 109298223Stuexen SCTP_UNUSED 110298223Stuexen#endif 111298223Stuexen); 112297662Srrs 113297662Srrsvoid 114163953Srrssctp_add_to_readq(struct sctp_inpcb *inp, 115163953Srrs struct sctp_tcb *stcb, 116163953Srrs struct sctp_queued_to_read *control, 117163953Srrs struct sockbuf *sb, 118172090Srrs int end, 119195918Srrs int inpread_locked, 120172090Srrs int so_locked 121172090Srrs#if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 122172090Srrs SCTP_UNUSED 123172090Srrs#endif 124172090Srrs); 125163953Srrs 126167598Srrsvoid sctp_iterator_worker(void); 127167598Srrs 128214939Stuexenuint32_t sctp_get_prev_mtu(uint32_t); 129228653Stuexenuint32_t sctp_get_next_mtu(uint32_t); 130163953Srrs 131163953Srrsvoid 132163953Srrs sctp_timeout_handler(void *); 133163953Srrs 134360735Stuexenint 135163953Srrssctp_calculate_rto(struct sctp_tcb *, struct sctp_association *, 136332212Stuexen struct sctp_nets *, struct timeval *, int); 137163953Srrs 138163953Srrsuint32_t sctp_calculate_len(struct mbuf *); 139163953Srrs 140163953Srrscaddr_t sctp_m_getptr(struct mbuf *, int, int, uint8_t *); 141163953Srrs 142163953Srrsstruct sctp_paramhdr * 143163953Srrssctp_get_next_param(struct mbuf *, int, 144163953Srrs struct sctp_paramhdr *, int); 145163953Srrs 146347154Stuexenstruct mbuf *sctp_add_pad_tombuf(struct mbuf *, int); 147163953Srrs 148347154Stuexenstruct mbuf *sctp_pad_lastmbuf(struct mbuf *, int, struct mbuf *); 149163953Srrs 150347154Stuexenvoid 151172090Srrssctp_ulp_notify(uint32_t, struct sctp_tcb *, uint32_t, void *, int 152172090Srrs#if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 153172090Srrs SCTP_UNUSED 154172090Srrs#endif 155172090Srrs); 156163953Srrs 157163953Srrsvoid 158163953Srrssctp_pull_off_control_to_new_inp(struct sctp_inpcb *old_inp, 159163953Srrs struct sctp_inpcb *new_inp, 160169208Srrs struct sctp_tcb *stcb, int waitflags); 161163953Srrs 162163953Srrs 163163953Srrsvoid sctp_stop_timers_for_shutdown(struct sctp_tcb *); 164163953Srrs 165347154Stuexenvoid 166235416Stuexensctp_report_all_outbound(struct sctp_tcb *, uint16_t, int, int 167172090Srrs#if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 168172090Srrs SCTP_UNUSED 169172090Srrs#endif 170172090Srrs); 171163953Srrs 172170138Srrsint sctp_expand_mapping_array(struct sctp_association *, uint32_t); 173163953Srrs 174347154Stuexenvoid 175235403Stuexensctp_abort_notification(struct sctp_tcb *, uint8_t, uint16_t, 176235360Stuexen struct sctp_abort_chunk *, int 177172090Srrs#if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 178172090Srrs SCTP_UNUSED 179172090Srrs#endif 180172090Srrs); 181163953Srrs 182163953Srrs/* We abort responding to an IP packet for some reason */ 183163953Srrsvoid 184237049Stuexensctp_abort_association(struct sctp_inpcb *, struct sctp_tcb *, struct mbuf *, 185237715Stuexen int, struct sockaddr *, struct sockaddr *, 186237715Stuexen struct sctphdr *, struct mbuf *, 187237049Stuexen uint8_t, uint32_t, 188237049Stuexen uint32_t, uint16_t); 189163953Srrs 190169352Srrs 191163953Srrs/* We choose to abort via user input */ 192163953Srrsvoid 193235360Stuexensctp_abort_an_association(struct sctp_inpcb *, struct sctp_tcb *, 194172090Srrs struct mbuf *, int 195172090Srrs#if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 196172090Srrs SCTP_UNUSED 197172090Srrs#endif 198172090Srrs); 199163953Srrs 200347154Stuexenvoid 201237715Stuexensctp_handle_ootb(struct mbuf *, int, int, 202237715Stuexen struct sockaddr *, struct sockaddr *, 203237715Stuexen struct sctphdr *, struct sctp_inpcb *, 204263237Stuexen struct mbuf *, 205284515Stuexen uint8_t, uint32_t, uint16_t, 206237049Stuexen uint32_t, uint16_t); 207163953Srrs 208347154Stuexenint 209170056Srrssctp_connectx_helper_add(struct sctp_tcb *stcb, struct sockaddr *addr, 210170056Srrs int totaddr, int *error); 211169352Srrs 212348174Stuexenint 213348174Stuexensctp_connectx_helper_find(struct sctp_inpcb *, struct sockaddr *, 214348174Stuexen unsigned int, unsigned int *, unsigned int *, unsigned int); 215169352Srrs 216163953Srrsint sctp_is_there_an_abort_here(struct mbuf *, int, uint32_t *); 217178251Srrs#ifdef INET6 218163953Srrsuint32_t sctp_is_same_scope(struct sockaddr_in6 *, struct sockaddr_in6 *); 219166675Srrs 220347154Stuexenstruct sockaddr_in6 *sctp_recover_scope(struct sockaddr_in6 *, struct sockaddr_in6 *); 221163953Srrs 222163953Srrs#define sctp_recover_scope_mac(addr, store) do { \ 223166675Srrs if ((addr->sin6_family == AF_INET6) && \ 224166675Srrs (IN6_IS_SCOPE_LINKLOCAL(&addr->sin6_addr))) { \ 225166675Srrs *store = *addr; \ 226166675Srrs if (addr->sin6_scope_id == 0) { \ 227166675Srrs if (!sa6_recoverscope(store)) { \ 228166675Srrs addr = store; \ 229166675Srrs } \ 230166675Srrs } else { \ 231166675Srrs in6_clearscope(&addr->sin6_addr); \ 232166675Srrs addr = store; \ 233166675Srrs } \ 234166675Srrs } \ 235166675Srrs} while (0) 236178251Srrs#endif 237163953Srrs 238163953Srrsint sctp_cmpaddr(struct sockaddr *, struct sockaddr *); 239163953Srrs 240163953Srrsvoid sctp_print_address(struct sockaddr *); 241163953Srrs 242163953Srrsint 243163953Srrssctp_release_pr_sctp_chunk(struct sctp_tcb *, struct sctp_tmit_chunk *, 244235416Stuexen uint8_t, int 245172090Srrs#if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) 246172090Srrs SCTP_UNUSED 247172090Srrs#endif 248172090Srrs); 249163953Srrs 250263237Stuexenstruct mbuf *sctp_generate_cause(uint16_t, char *); 251264679Stuexenstruct mbuf *sctp_generate_no_user_data_cause(uint32_t); 252163953Srrs 253347154Stuexenvoid 254170606Srrssctp_bindx_add_address(struct socket *so, struct sctp_inpcb *inp, 255170606Srrs struct sockaddr *sa, sctp_assoc_t assoc_id, 256170606Srrs uint32_t vrf_id, int *error, void *p); 257347154Stuexenvoid 258228653Stuexensctp_bindx_delete_address(struct sctp_inpcb *inp, 259170606Srrs struct sockaddr *sa, sctp_assoc_t assoc_id, 260170606Srrs uint32_t vrf_id, int *error); 261163953Srrs 262171572Srrsint sctp_local_addr_count(struct sctp_tcb *stcb); 263171572Srrs 264163953Srrs#ifdef SCTP_MBCNT_LOGGING 265163953Srrsvoid 266163953Srrssctp_free_bufspace(struct sctp_tcb *, struct sctp_association *, 267170744Srrs struct sctp_tmit_chunk *, int); 268163953Srrs 269163953Srrs#else 270163953Srrs#define sctp_free_bufspace(stcb, asoc, tp1, chk_cnt) \ 271163953Srrsdo { \ 272163953Srrs if (tp1->data != NULL) { \ 273268537Stuexen atomic_subtract_int(&((asoc)->chunks_on_out_queue), chk_cnt); \ 274163953Srrs if ((asoc)->total_output_queue_size >= tp1->book_size) { \ 275169420Srrs atomic_subtract_int(&((asoc)->total_output_queue_size), tp1->book_size); \ 276163953Srrs } else { \ 277163953Srrs (asoc)->total_output_queue_size = 0; \ 278163953Srrs } \ 279268537Stuexen if (stcb->sctp_socket && ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \ 280268537Stuexen (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \ 281275427Stuexen if (stcb->sctp_socket->so_snd.sb_cc >= tp1->book_size) { \ 282275427Stuexen atomic_subtract_int(&((stcb)->sctp_socket->so_snd.sb_cc), tp1->book_size); \ 283163953Srrs } else { \ 284275427Stuexen stcb->sctp_socket->so_snd.sb_cc = 0; \ 285163953Srrs } \ 286163953Srrs } \ 287268537Stuexen } \ 288163953Srrs} while (0) 289163953Srrs 290163953Srrs#endif 291163953Srrs 292163953Srrs#define sctp_free_spbufspace(stcb, asoc, sp) \ 293163953Srrsdo { \ 294268537Stuexen if (sp->data != NULL) { \ 295163953Srrs if ((asoc)->total_output_queue_size >= sp->length) { \ 296169420Srrs atomic_subtract_int(&(asoc)->total_output_queue_size, sp->length); \ 297163953Srrs } else { \ 298163953Srrs (asoc)->total_output_queue_size = 0; \ 299163953Srrs } \ 300268537Stuexen if (stcb->sctp_socket && ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \ 301268537Stuexen (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \ 302275427Stuexen if (stcb->sctp_socket->so_snd.sb_cc >= sp->length) { \ 303275427Stuexen atomic_subtract_int(&stcb->sctp_socket->so_snd.sb_cc,sp->length); \ 304163953Srrs } else { \ 305275427Stuexen stcb->sctp_socket->so_snd.sb_cc = 0; \ 306163953Srrs } \ 307163953Srrs } \ 308268537Stuexen } \ 309163953Srrs} while (0) 310163953Srrs 311163953Srrs#define sctp_snd_sb_alloc(stcb, sz) \ 312163953Srrsdo { \ 313163953Srrs atomic_add_int(&stcb->asoc.total_output_queue_size,sz); \ 314163953Srrs if ((stcb->sctp_socket != NULL) && \ 315163953Srrs ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \ 316163953Srrs (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \ 317275427Stuexen atomic_add_int(&stcb->sctp_socket->so_snd.sb_cc,sz); \ 318163953Srrs } \ 319163953Srrs} while (0) 320163953Srrs 321221328Stuexen/* functions to start/stop udp tunneling */ 322179157Srrsvoid sctp_over_udp_stop(void); 323179157Srrsint sctp_over_udp_start(void); 324163953Srrs 325163953Srrsint 326163953Srrssctp_soreceive(struct socket *so, struct sockaddr **psa, 327163953Srrs struct uio *uio, 328163953Srrs struct mbuf **mp0, 329163953Srrs struct mbuf **controlp, 330163953Srrs int *flagsp); 331163953Srrs 332163953Srrsvoid 333163953Srrs sctp_misc_ints(uint8_t from, uint32_t a, uint32_t b, uint32_t c, uint32_t d); 334163953Srrs 335163953Srrsvoid 336163953Srrssctp_wakeup_log(struct sctp_tcb *stcb, 337163953Srrs uint32_t wake_cnt, int from); 338163953Srrs 339164181Srrsvoid sctp_log_strm_del_alt(struct sctp_tcb *stcb, uint32_t, uint16_t, uint16_t, int); 340163953Srrs 341163953Srrsvoid sctp_log_nagle_event(struct sctp_tcb *stcb, int action); 342163953Srrs 343163953Srrs 344276914Stuexen#ifdef SCTP_MBUF_LOGGING 345163953Srrsvoid 346163953Srrs sctp_log_mb(struct mbuf *m, int from); 347163953Srrs 348163953Srrsvoid 349276914Stuexen sctp_log_mbc(struct mbuf *m, int from); 350276914Stuexen#endif 351276914Stuexen 352276914Stuexenvoid 353163953Srrssctp_sblog(struct sockbuf *sb, 354163953Srrs struct sctp_tcb *stcb, int from, int incr); 355163953Srrs 356163953Srrsvoid 357163953Srrssctp_log_strm_del(struct sctp_queued_to_read *control, 358163953Srrs struct sctp_queued_to_read *poschk, 359163953Srrs int from); 360163953Srrsvoid sctp_log_cwnd(struct sctp_tcb *stcb, struct sctp_nets *, int, uint8_t); 361163953Srrsvoid rto_logging(struct sctp_nets *net, int from); 362163953Srrs 363163953Srrsvoid sctp_log_closing(struct sctp_inpcb *inp, struct sctp_tcb *stcb, int16_t loc); 364163953Srrs 365163953Srrsvoid sctp_log_lock(struct sctp_inpcb *inp, struct sctp_tcb *stcb, uint8_t from); 366163953Srrsvoid sctp_log_maxburst(struct sctp_tcb *stcb, struct sctp_nets *, int, int, uint8_t); 367347676Stuexenvoid sctp_log_block(uint8_t, struct sctp_association *, ssize_t); 368163953Srrsvoid sctp_log_rwnd(uint8_t, uint32_t, uint32_t, uint32_t); 369163953Srrsvoid sctp_log_rwnd_set(uint8_t, uint32_t, uint32_t, uint32_t, uint32_t); 370167598Srrsint sctp_fill_stat_log(void *, size_t *); 371163953Srrsvoid sctp_log_fr(uint32_t, uint32_t, uint32_t, int); 372163953Srrsvoid sctp_log_sack(uint32_t, uint32_t, uint32_t, uint16_t, uint16_t, int); 373163953Srrsvoid sctp_log_map(uint32_t, uint32_t, uint32_t, int); 374205502Srrsvoid sctp_print_mapping_array(struct sctp_association *asoc); 375163953Srrsvoid sctp_clr_stat_log(void); 376163953Srrs 377163953Srrs 378163953Srrs#ifdef SCTP_AUDITING_ENABLED 379163953Srrsvoid 380163953Srrssctp_auditing(int, struct sctp_inpcb *, struct sctp_tcb *, 381163953Srrs struct sctp_nets *); 382163953Srrsvoid sctp_audit_log(uint8_t, uint8_t); 383163953Srrs 384163953Srrs#endif 385319408Stuexen#if defined(INET6) || defined(INET) 386319408Stuexenuint32_t sctp_min_mtu(uint32_t, uint32_t, uint32_t); 387319408Stuexenvoid sctp_hc_set_mtu(union sctp_sockstore *, uint16_t, uint32_t); 388319408Stuexenuint32_t sctp_hc_get_mtu(union sctp_sockstore *, uint16_t); 389319408Stuexen#endif 390163953Srrs#endif /* _KERNEL */ 391163953Srrs#endif 392