2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 2001-2007, by Cisco Systems, Inc. All rights reserved.
5 * Copyright (c) 2008-2012, by Randall Stewart. All rights reserved.
6 * Copyright (c) 2008-2012, by Michael Tuexen. All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are met:
11 * a) Redistributions of source code must retain the above copyright notice,
12 * this list of conditions and the following disclaimer.
14 * b) Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in
16 * the documentation and/or other materials provided with the distribution.
18 * c) Neither the name of Cisco Systems, Inc. nor the names of its
19 * contributors may be used to endorse or promote products derived
20 * from this software without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
24 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
26 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
27 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
28 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
30 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
31 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
32 * THE POSSIBILITY OF SUCH DAMAGE.
35 #include <sys/cdefs.h>
36 __FBSDID("$FreeBSD$");
38 #ifndef _NETINET_SCTP_UTIL_H_
39 #define _NETINET_SCTP_UTIL_H_
41 #if defined(_KERNEL) || defined(__Userspace__)
43 #define SCTP_READ_LOCK_HELD 1
44 #define SCTP_READ_LOCK_NOT_HELD 0
46 #ifdef SCTP_ASOCLOG_OF_TSNS
47 void sctp_print_out_track_log(struct sctp_tcb *stcb);
50 #ifdef SCTP_MBUF_LOGGING
51 struct mbuf *sctp_m_free(struct mbuf *m);
52 void sctp_m_freem(struct mbuf *m);
54 #define sctp_m_free m_free
55 #define sctp_m_freem m_freem
58 #if defined(SCTP_LOCAL_TRACE_BUF)
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);
63 #define sctp_get_associd(stcb) ((sctp_assoc_t)stcb->asoc.assoc_id)
69 sctp_map_assoc_state(int);
72 sctp_get_ifa_hash_val(struct sockaddr *addr);
74 struct sctp_ifa *sctp_find_ifa_in_ep(struct sctp_inpcb *inp, struct sockaddr *addr, int hold_lock);
76 struct sctp_ifa *sctp_find_ifa_by_addr(struct sockaddr *addr, uint32_t vrf_id, int holds_lock);
78 uint32_t sctp_select_initial_TSN(struct sctp_pcb *);
80 uint32_t sctp_select_a_tag(struct sctp_inpcb *, uint16_t lport, uint16_t rport, int);
82 int sctp_init_asoc(struct sctp_inpcb *, struct sctp_tcb *, uint32_t, uint32_t, uint32_t, uint16_t);
84 void sctp_fill_random_store(struct sctp_pcb *);
87 sctp_notify_stream_reset_add(struct sctp_tcb *stcb, uint16_t numberin,
88 uint16_t numberout, int flag);
90 sctp_notify_stream_reset_tsn(struct sctp_tcb *stcb, uint32_t sending_tsn, uint32_t recv_tsn, int flag);
93 * NOTE: sctp_timer_start() will increment the reference count of any relevant
94 * structure the timer is referencing, in order to prevent a race condition
95 * between the timer executing and the structure being freed.
97 * When the timer fires or sctp_timer_stop() is called, these references are
101 sctp_timer_start(int, struct sctp_inpcb *, struct sctp_tcb *,
105 sctp_timer_stop(int, struct sctp_inpcb *, struct sctp_tcb *,
106 struct sctp_nets *, uint32_t);
109 sctp_dynamic_set_primary(struct sockaddr *sa, uint32_t vrf_id);
112 sctp_wakeup_the_read_socket(struct sctp_inpcb *inp, struct sctp_tcb *stcb,
118 sctp_add_to_readq(struct sctp_inpcb *inp,
119 struct sctp_tcb *stcb,
120 struct sctp_queued_to_read *control,
126 void sctp_iterator_worker(void);
128 uint32_t sctp_get_prev_mtu(uint32_t);
129 uint32_t sctp_get_next_mtu(uint32_t);
132 sctp_timeout_handler(void *);
135 sctp_calculate_rto(struct sctp_tcb *, struct sctp_association *,
136 struct sctp_nets *, struct timeval *, int);
138 uint32_t sctp_calculate_len(struct mbuf *);
140 caddr_t sctp_m_getptr(struct mbuf *, int, int, uint8_t *);
142 struct sctp_paramhdr *
143 sctp_get_next_param(struct mbuf *, int,
144 struct sctp_paramhdr *, int);
146 struct mbuf *sctp_add_pad_tombuf(struct mbuf *, int);
148 struct mbuf *sctp_pad_lastmbuf(struct mbuf *, int, struct mbuf *);
150 void sctp_ulp_notify(uint32_t, struct sctp_tcb *, uint32_t, void *, int);
153 sctp_pull_off_control_to_new_inp(struct sctp_inpcb *old_inp,
154 struct sctp_inpcb *new_inp,
155 struct sctp_tcb *stcb, int waitflags);
157 void sctp_stop_timers_for_shutdown(struct sctp_tcb *);
159 /* Stop all timers for association and remote addresses. */
160 void sctp_stop_association_timers(struct sctp_tcb *, bool);
162 void sctp_report_all_outbound(struct sctp_tcb *, uint16_t, int);
164 int sctp_expand_mapping_array(struct sctp_association *, uint32_t);
167 sctp_abort_notification(struct sctp_tcb *, bool, bool, uint16_t,
168 struct sctp_abort_chunk *, int);
170 /* We abort responding to an IP packet for some reason */
172 sctp_abort_association(struct sctp_inpcb *, struct sctp_tcb *, struct mbuf *,
173 int, struct sockaddr *, struct sockaddr *,
174 struct sctphdr *, struct mbuf *,
178 /* We choose to abort via user input */
180 sctp_abort_an_association(struct sctp_inpcb *, struct sctp_tcb *,
181 struct mbuf *, bool, int);
184 sctp_handle_ootb(struct mbuf *, int, int,
185 struct sockaddr *, struct sockaddr *,
186 struct sctphdr *, struct sctp_inpcb *,
188 uint8_t, uint32_t, uint16_t,
192 sctp_connectx_helper_add(struct sctp_tcb *stcb, struct sockaddr *addr,
193 int totaddr, int *error);
196 sctp_connectx_helper_find(struct sctp_inpcb *, struct sockaddr *,
197 unsigned int, unsigned int *, unsigned int *, unsigned int);
199 int sctp_is_there_an_abort_here(struct mbuf *, int, uint32_t *);
201 uint32_t sctp_is_same_scope(struct sockaddr_in6 *, struct sockaddr_in6 *);
203 struct sockaddr_in6 *sctp_recover_scope(struct sockaddr_in6 *, struct sockaddr_in6 *);
205 #define sctp_recover_scope_mac(addr, store) do { \
206 if ((addr->sin6_family == AF_INET6) && \
207 (IN6_IS_SCOPE_LINKLOCAL(&addr->sin6_addr))) { \
209 if (addr->sin6_scope_id == 0) { \
210 if (!sa6_recoverscope(store)) { \
214 in6_clearscope(&addr->sin6_addr); \
221 int sctp_cmpaddr(struct sockaddr *, struct sockaddr *);
223 void sctp_print_address(struct sockaddr *);
226 sctp_release_pr_sctp_chunk(struct sctp_tcb *, struct sctp_tmit_chunk *,
229 struct mbuf *sctp_generate_cause(uint16_t, char *);
230 struct mbuf *sctp_generate_no_user_data_cause(uint32_t);
233 sctp_bindx_add_address(struct socket *so, struct sctp_inpcb *inp,
234 struct sockaddr *sa, uint32_t vrf_id, int *error,
237 sctp_bindx_delete_address(struct sctp_inpcb *inp, struct sockaddr *sa,
238 uint32_t vrf_id, int *error);
240 int sctp_local_addr_count(struct sctp_tcb *stcb);
243 sctp_free_bufspace(struct sctp_tcb *, struct sctp_association *,
244 struct sctp_tmit_chunk *, int);
246 #define sctp_free_spbufspace(stcb, asoc, sp) \
248 if (sp->data != NULL) { \
249 if ((asoc)->total_output_queue_size >= sp->length) { \
250 atomic_subtract_int(&(asoc)->total_output_queue_size, sp->length); \
252 (asoc)->total_output_queue_size = 0; \
254 if (stcb->sctp_socket && ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \
255 (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \
256 if (stcb->sctp_socket->so_snd.sb_cc >= sp->length) { \
257 atomic_subtract_int(&stcb->sctp_socket->so_snd.sb_cc,sp->length); \
259 stcb->sctp_socket->so_snd.sb_cc = 0; \
265 #define sctp_snd_sb_alloc(stcb, sz) \
267 atomic_add_int(&stcb->asoc.total_output_queue_size,sz); \
268 if ((stcb->sctp_socket != NULL) && \
269 ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \
270 (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \
271 atomic_add_int(&stcb->sctp_socket->so_snd.sb_cc,sz); \
275 /* functions to start/stop udp tunneling */
276 void sctp_over_udp_stop(void);
277 int sctp_over_udp_start(void);
280 sctp_soreceive(struct socket *so, struct sockaddr **psa,
283 struct mbuf **controlp,
287 sctp_misc_ints(uint8_t from, uint32_t a, uint32_t b, uint32_t c, uint32_t d);
290 sctp_wakeup_log(struct sctp_tcb *stcb,
291 uint32_t wake_cnt, int from);
293 void sctp_log_strm_del_alt(struct sctp_tcb *stcb, uint32_t, uint16_t, uint16_t, int);
295 void sctp_log_nagle_event(struct sctp_tcb *stcb, int action);
297 #ifdef SCTP_MBUF_LOGGING
299 sctp_log_mb(struct mbuf *m, int from);
302 sctp_log_mbc(struct mbuf *m, int from);
306 sctp_sblog(struct sockbuf *sb,
307 struct sctp_tcb *stcb, int from, int incr);
310 sctp_log_strm_del(struct sctp_queued_to_read *control,
311 struct sctp_queued_to_read *poschk,
313 void sctp_log_cwnd(struct sctp_tcb *stcb, struct sctp_nets *, int, uint8_t);
314 void rto_logging(struct sctp_nets *net, int from);
316 void sctp_log_closing(struct sctp_inpcb *inp, struct sctp_tcb *stcb, int16_t loc);
318 void sctp_log_lock(struct sctp_inpcb *inp, struct sctp_tcb *stcb, uint8_t from);
319 void sctp_log_maxburst(struct sctp_tcb *stcb, struct sctp_nets *, int, int, uint8_t);
320 void sctp_log_block(uint8_t, struct sctp_association *, ssize_t);
321 void sctp_log_rwnd(uint8_t, uint32_t, uint32_t, uint32_t);
322 void sctp_log_rwnd_set(uint8_t, uint32_t, uint32_t, uint32_t, uint32_t);
323 int sctp_fill_stat_log(void *, size_t *);
324 void sctp_log_fr(uint32_t, uint32_t, uint32_t, int);
325 void sctp_log_sack(uint32_t, uint32_t, uint32_t, uint16_t, uint16_t, int);
326 void sctp_log_map(uint32_t, uint32_t, uint32_t, int);
327 void sctp_print_mapping_array(struct sctp_association *asoc);
328 void sctp_clr_stat_log(void);
330 #ifdef SCTP_AUDITING_ENABLED
332 sctp_auditing(int, struct sctp_inpcb *, struct sctp_tcb *,
334 void sctp_audit_log(uint8_t, uint8_t);
337 uint32_t sctp_min_mtu(uint32_t, uint32_t, uint32_t);
338 void sctp_hc_set_mtu(union sctp_sockstore *, uint16_t, uint32_t);
339 uint32_t sctp_hc_get_mtu(union sctp_sockstore *, uint16_t);
340 void sctp_set_state(struct sctp_tcb *, int);
341 void sctp_add_substate(struct sctp_tcb *, int);
342 uint32_t sctp_ticks_to_msecs(uint32_t);
343 uint32_t sctp_msecs_to_ticks(uint32_t);
344 uint32_t sctp_ticks_to_secs(uint32_t);
345 uint32_t sctp_secs_to_ticks(uint32_t);