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 #ifndef _NETINET_SCTP_UTIL_H_
36 #define _NETINET_SCTP_UTIL_H_
38 #if defined(_KERNEL) || defined(__Userspace__)
40 #define SCTP_READ_LOCK_HELD 1
41 #define SCTP_READ_LOCK_NOT_HELD 0
43 #ifdef SCTP_ASOCLOG_OF_TSNS
44 void sctp_print_out_track_log(struct sctp_tcb *stcb);
47 #ifdef SCTP_MBUF_LOGGING
48 struct mbuf *sctp_m_free(struct mbuf *m);
49 void sctp_m_freem(struct mbuf *m);
51 #define sctp_m_free m_free
52 #define sctp_m_freem m_freem
55 #if defined(SCTP_LOCAL_TRACE_BUF)
57 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);
60 #define sctp_get_associd(stcb) ((sctp_assoc_t)stcb->asoc.assoc_id)
66 sctp_map_assoc_state(int);
69 sctp_get_ifa_hash_val(struct sockaddr *addr);
71 struct sctp_ifa *sctp_find_ifa_in_ep(struct sctp_inpcb *inp, struct sockaddr *addr, int hold_lock);
73 struct sctp_ifa *sctp_find_ifa_by_addr(struct sockaddr *addr, uint32_t vrf_id, int holds_lock);
75 uint32_t sctp_select_initial_TSN(struct sctp_pcb *);
77 uint32_t sctp_select_a_tag(struct sctp_inpcb *, uint16_t lport, uint16_t rport, int);
79 int sctp_init_asoc(struct sctp_inpcb *, struct sctp_tcb *, uint32_t, uint32_t, uint32_t, uint16_t);
81 void sctp_fill_random_store(struct sctp_pcb *);
84 * NOTE: sctp_timer_start() will increment the reference count of any relevant
85 * structure the timer is referencing, in order to prevent a race condition
86 * between the timer executing and the structure being freed.
88 * When the timer fires or sctp_timer_stop() is called, these references are
92 sctp_timer_start(int, struct sctp_inpcb *, struct sctp_tcb *,
96 sctp_timer_stop(int, struct sctp_inpcb *, struct sctp_tcb *,
97 struct sctp_nets *, uint32_t);
100 sctp_dynamic_set_primary(struct sockaddr *sa, uint32_t vrf_id);
103 sctp_wakeup_the_read_socket(struct sctp_inpcb *inp, struct sctp_tcb *stcb,
109 sctp_add_to_readq(struct sctp_inpcb *inp,
110 struct sctp_tcb *stcb,
111 struct sctp_queued_to_read *control,
117 void sctp_iterator_worker(void);
119 uint32_t sctp_get_prev_mtu(uint32_t);
120 uint32_t sctp_get_next_mtu(uint32_t);
123 sctp_timeout_handler(void *);
126 sctp_calculate_rto(struct sctp_tcb *, struct sctp_association *,
127 struct sctp_nets *, struct timeval *, int);
129 uint32_t sctp_calculate_len(struct mbuf *);
131 caddr_t sctp_m_getptr(struct mbuf *, int, int, uint8_t *);
133 struct sctp_paramhdr *
134 sctp_get_next_param(struct mbuf *, int,
135 struct sctp_paramhdr *, int);
137 struct mbuf *sctp_add_pad_tombuf(struct mbuf *, int);
139 struct mbuf *sctp_pad_lastmbuf(struct mbuf *, int, struct mbuf *);
141 void sctp_ulp_notify(uint32_t, struct sctp_tcb *, uint32_t, void *, int);
144 sctp_pull_off_control_to_new_inp(struct sctp_inpcb *old_inp,
145 struct sctp_inpcb *new_inp,
146 struct sctp_tcb *stcb, int waitflags);
148 void sctp_stop_timers_for_shutdown(struct sctp_tcb *);
150 /* Stop all timers for association and remote addresses. */
151 void sctp_stop_association_timers(struct sctp_tcb *, bool);
153 void sctp_report_all_outbound(struct sctp_tcb *, uint16_t, int);
155 int sctp_expand_mapping_array(struct sctp_association *, uint32_t);
158 sctp_abort_notification(struct sctp_tcb *, bool, bool, uint16_t,
159 struct sctp_abort_chunk *, int);
161 /* We abort responding to an IP packet for some reason */
163 sctp_abort_association(struct sctp_inpcb *, struct sctp_tcb *, struct mbuf *,
164 int, struct sockaddr *, struct sockaddr *,
165 struct sctphdr *, struct mbuf *,
169 /* We choose to abort via user input */
171 sctp_abort_an_association(struct sctp_inpcb *, struct sctp_tcb *,
172 struct mbuf *, bool, int);
175 sctp_handle_ootb(struct mbuf *, int, int,
176 struct sockaddr *, struct sockaddr *,
177 struct sctphdr *, struct sctp_inpcb *,
179 uint8_t, uint32_t, uint16_t,
183 sctp_connectx_helper_add(struct sctp_tcb *stcb, struct sockaddr *addr,
184 int totaddr, int *error);
187 sctp_connectx_helper_find(struct sctp_inpcb *, struct sockaddr *,
188 unsigned int, unsigned int *, unsigned int *, unsigned int);
190 int sctp_is_there_an_abort_here(struct mbuf *, int, uint32_t *);
192 uint32_t sctp_is_same_scope(struct sockaddr_in6 *, struct sockaddr_in6 *);
194 struct sockaddr_in6 *sctp_recover_scope(struct sockaddr_in6 *, struct sockaddr_in6 *);
196 #define sctp_recover_scope_mac(addr, store) do { \
197 if ((addr->sin6_family == AF_INET6) && \
198 (IN6_IS_SCOPE_LINKLOCAL(&addr->sin6_addr))) { \
200 if (addr->sin6_scope_id == 0) { \
201 if (!sa6_recoverscope(store)) { \
205 in6_clearscope(&addr->sin6_addr); \
212 int sctp_cmpaddr(struct sockaddr *, struct sockaddr *);
214 void sctp_print_address(struct sockaddr *);
217 sctp_release_pr_sctp_chunk(struct sctp_tcb *, struct sctp_tmit_chunk *,
220 struct mbuf *sctp_generate_cause(uint16_t, char *);
221 struct mbuf *sctp_generate_no_user_data_cause(uint32_t);
224 sctp_bindx_add_address(struct socket *so, struct sctp_inpcb *inp,
225 struct sockaddr *sa, uint32_t vrf_id, int *error,
228 sctp_bindx_delete_address(struct sctp_inpcb *inp, struct sockaddr *sa,
229 uint32_t vrf_id, int *error);
231 int sctp_local_addr_count(struct sctp_tcb *stcb);
234 sctp_free_bufspace(struct sctp_tcb *, struct sctp_association *,
235 struct sctp_tmit_chunk *, int);
237 #define sctp_free_spbufspace(stcb, asoc, sp) \
239 if (sp->data != NULL) { \
240 if ((asoc)->total_output_queue_size >= sp->length) { \
241 atomic_subtract_int(&(asoc)->total_output_queue_size, sp->length); \
243 (asoc)->total_output_queue_size = 0; \
245 if (stcb->sctp_socket && ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \
246 (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \
247 SCTP_SB_DECR(&stcb->sctp_socket->so_snd, sp->length); \
252 #define sctp_snd_sb_alloc(stcb, sz) \
254 atomic_add_int(&stcb->asoc.total_output_queue_size,sz); \
255 if ((stcb->sctp_socket != NULL) && \
256 ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \
257 (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \
258 SCTP_SB_INCR(&stcb->sctp_socket->so_snd, sz); \
262 /* functions to start/stop udp tunneling */
263 void sctp_over_udp_stop(void);
264 int sctp_over_udp_start(void);
267 sctp_soreceive(struct socket *so, struct sockaddr **psa,
270 struct mbuf **controlp,
274 sctp_misc_ints(uint8_t from, uint32_t a, uint32_t b, uint32_t c, uint32_t d);
277 sctp_wakeup_log(struct sctp_tcb *stcb,
278 uint32_t wake_cnt, int from);
280 void sctp_log_strm_del_alt(struct sctp_tcb *stcb, uint32_t, uint16_t, uint16_t, int);
282 void sctp_log_nagle_event(struct sctp_tcb *stcb, int action);
284 #ifdef SCTP_MBUF_LOGGING
286 sctp_log_mb(struct mbuf *m, int from);
289 sctp_log_mbc(struct mbuf *m, int from);
293 sctp_sblog(struct sockbuf *sb,
294 struct sctp_tcb *stcb, int from, int incr);
297 sctp_log_strm_del(struct sctp_queued_to_read *control,
298 struct sctp_queued_to_read *poschk,
300 void sctp_log_cwnd(struct sctp_tcb *stcb, struct sctp_nets *, int, uint8_t);
301 void rto_logging(struct sctp_nets *net, int from);
303 void sctp_log_closing(struct sctp_inpcb *inp, struct sctp_tcb *stcb, int16_t loc);
305 void sctp_log_lock(struct sctp_inpcb *inp, struct sctp_tcb *stcb, uint8_t from);
306 void sctp_log_maxburst(struct sctp_tcb *stcb, struct sctp_nets *, int, int, uint8_t);
307 void sctp_log_block(uint8_t, struct sctp_association *, ssize_t);
308 void sctp_log_rwnd(uint8_t, uint32_t, uint32_t, uint32_t);
309 void sctp_log_rwnd_set(uint8_t, uint32_t, uint32_t, uint32_t, uint32_t);
310 int sctp_fill_stat_log(void *, size_t *);
311 void sctp_log_fr(uint32_t, uint32_t, uint32_t, int);
312 void sctp_log_sack(uint32_t, uint32_t, uint32_t, uint16_t, uint16_t, int);
313 void sctp_log_map(uint32_t, uint32_t, uint32_t, int);
314 void sctp_print_mapping_array(struct sctp_association *asoc);
315 void sctp_clr_stat_log(void);
317 #ifdef SCTP_AUDITING_ENABLED
319 sctp_auditing(int, struct sctp_inpcb *, struct sctp_tcb *,
321 void sctp_audit_log(uint8_t, uint8_t);
324 uint32_t sctp_min_mtu(uint32_t, uint32_t, uint32_t);
325 void sctp_hc_set_mtu(union sctp_sockstore *, uint16_t, uint32_t);
326 uint32_t sctp_hc_get_mtu(union sctp_sockstore *, uint16_t);
327 void sctp_set_state(struct sctp_tcb *, int);
328 void sctp_add_substate(struct sctp_tcb *, int);
329 uint32_t sctp_ticks_to_msecs(uint32_t);
330 uint32_t sctp_msecs_to_ticks(uint32_t);
331 uint32_t sctp_ticks_to_secs(uint32_t);
332 uint32_t sctp_secs_to_ticks(uint32_t);