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) || defined(__APPLE__)
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)
70 sctp_map_assoc_state(int);
73 sctp_get_ifa_hash_val(struct sockaddr *addr);
75 struct sctp_ifa *sctp_find_ifa_in_ep(struct sctp_inpcb *inp, struct sockaddr *addr, int hold_lock);
77 struct sctp_ifa *sctp_find_ifa_by_addr(struct sockaddr *addr, uint32_t vrf_id, int holds_lock);
79 uint32_t sctp_select_initial_TSN(struct sctp_pcb *);
81 uint32_t sctp_select_a_tag(struct sctp_inpcb *, uint16_t lport, uint16_t rport, int);
83 int sctp_init_asoc(struct sctp_inpcb *, struct sctp_tcb *, uint32_t, uint32_t, uint16_t);
85 void sctp_fill_random_store(struct sctp_pcb *);
88 sctp_notify_stream_reset_add(struct sctp_tcb *stcb, uint16_t numberin,
89 uint16_t numberout, int flag);
91 sctp_notify_stream_reset_tsn(struct sctp_tcb *stcb, uint32_t sending_tsn, uint32_t recv_tsn, int flag);
94 sctp_timer_start(int, struct sctp_inpcb *, struct sctp_tcb *,
98 sctp_timer_stop(int, struct sctp_inpcb *, struct sctp_tcb *,
99 struct sctp_nets *, uint32_t);
102 sctp_dynamic_set_primary(struct sockaddr *sa, uint32_t vrf_id);
105 sctp_mtu_size_reset(struct sctp_inpcb *, struct sctp_association *, uint32_t);
108 sctp_wakeup_the_read_socket(struct sctp_inpcb *inp, struct sctp_tcb *stcb,
110 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING)
116 sctp_add_to_readq(struct sctp_inpcb *inp,
117 struct sctp_tcb *stcb,
118 struct sctp_queued_to_read *control,
123 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING)
128 void sctp_iterator_worker(void);
130 uint32_t sctp_get_prev_mtu(uint32_t);
131 uint32_t sctp_get_next_mtu(uint32_t);
134 sctp_timeout_handler(void *);
137 sctp_calculate_rto(struct sctp_tcb *, struct sctp_association *,
138 struct sctp_nets *, struct timeval *, int);
140 uint32_t sctp_calculate_len(struct mbuf *);
142 caddr_t sctp_m_getptr(struct mbuf *, int, int, uint8_t *);
144 struct sctp_paramhdr *
145 sctp_get_next_param(struct mbuf *, int,
146 struct sctp_paramhdr *, int);
148 struct mbuf *sctp_add_pad_tombuf(struct mbuf *, int);
150 struct mbuf *sctp_pad_lastmbuf(struct mbuf *, int, struct mbuf *);
153 sctp_ulp_notify(uint32_t, struct sctp_tcb *, uint32_t, void *, int
154 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING)
160 sctp_pull_off_control_to_new_inp(struct sctp_inpcb *old_inp,
161 struct sctp_inpcb *new_inp,
162 struct sctp_tcb *stcb, int waitflags);
165 void sctp_stop_timers_for_shutdown(struct sctp_tcb *);
168 sctp_report_all_outbound(struct sctp_tcb *, uint16_t, int, int
169 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING)
174 int sctp_expand_mapping_array(struct sctp_association *, uint32_t);
177 sctp_abort_notification(struct sctp_tcb *, uint8_t, uint16_t,
178 struct sctp_abort_chunk *, int
179 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING)
184 /* We abort responding to an IP packet for some reason */
186 sctp_abort_association(struct sctp_inpcb *, struct sctp_tcb *, struct mbuf *,
187 int, struct sockaddr *, struct sockaddr *,
188 struct sctphdr *, struct mbuf *,
193 /* We choose to abort via user input */
195 sctp_abort_an_association(struct sctp_inpcb *, struct sctp_tcb *,
197 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING)
203 sctp_handle_ootb(struct mbuf *, int, int,
204 struct sockaddr *, struct sockaddr *,
205 struct sctphdr *, struct sctp_inpcb *,
207 uint8_t, uint32_t, uint16_t,
211 sctp_connectx_helper_add(struct sctp_tcb *stcb, struct sockaddr *addr,
212 int totaddr, int *error);
215 sctp_connectx_helper_find(struct sctp_inpcb *inp, struct sockaddr *addr,
216 unsigned int *totaddr, unsigned int *num_v4, unsigned int *num_v6,
217 int *error, unsigned int limit, int *bad_addr);
219 int sctp_is_there_an_abort_here(struct mbuf *, int, uint32_t *);
221 uint32_t sctp_is_same_scope(struct sockaddr_in6 *, struct sockaddr_in6 *);
223 struct sockaddr_in6 *sctp_recover_scope(struct sockaddr_in6 *, struct sockaddr_in6 *);
225 #define sctp_recover_scope_mac(addr, store) do { \
226 if ((addr->sin6_family == AF_INET6) && \
227 (IN6_IS_SCOPE_LINKLOCAL(&addr->sin6_addr))) { \
229 if (addr->sin6_scope_id == 0) { \
230 if (!sa6_recoverscope(store)) { \
234 in6_clearscope(&addr->sin6_addr); \
241 int sctp_cmpaddr(struct sockaddr *, struct sockaddr *);
243 void sctp_print_address(struct sockaddr *);
246 sctp_release_pr_sctp_chunk(struct sctp_tcb *, struct sctp_tmit_chunk *,
248 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING)
253 struct mbuf *sctp_generate_cause(uint16_t, char *);
254 struct mbuf *sctp_generate_no_user_data_cause(uint32_t);
257 sctp_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);
261 sctp_bindx_delete_address(struct sctp_inpcb *inp,
262 struct sockaddr *sa, sctp_assoc_t assoc_id,
263 uint32_t vrf_id, int *error);
265 int sctp_local_addr_count(struct sctp_tcb *stcb);
267 #ifdef SCTP_MBCNT_LOGGING
269 sctp_free_bufspace(struct sctp_tcb *, struct sctp_association *,
270 struct sctp_tmit_chunk *, int);
273 #define sctp_free_bufspace(stcb, asoc, tp1, chk_cnt) \
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); \
280 (asoc)->total_output_queue_size = 0; \
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); \
287 stcb->sctp_socket->so_snd.sb_cc = 0; \
295 #define sctp_free_spbufspace(stcb, asoc, sp) \
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); \
301 (asoc)->total_output_queue_size = 0; \
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); \
308 stcb->sctp_socket->so_snd.sb_cc = 0; \
314 #define sctp_snd_sb_alloc(stcb, sz) \
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); \
324 /* functions to start/stop udp tunneling */
325 void sctp_over_udp_stop(void);
326 int sctp_over_udp_start(void);
329 sctp_soreceive(struct socket *so, struct sockaddr **psa,
332 struct mbuf **controlp,
336 sctp_misc_ints(uint8_t from, uint32_t a, uint32_t b, uint32_t c, uint32_t d);
339 sctp_wakeup_log(struct sctp_tcb *stcb,
340 uint32_t wake_cnt, int from);
342 void sctp_log_strm_del_alt(struct sctp_tcb *stcb, uint32_t, uint16_t, uint16_t, int);
344 void sctp_log_nagle_event(struct sctp_tcb *stcb, int action);
347 #ifdef SCTP_MBUF_LOGGING
349 sctp_log_mb(struct mbuf *m, int from);
352 sctp_log_mbc(struct mbuf *m, int from);
356 sctp_sblog(struct sockbuf *sb,
357 struct sctp_tcb *stcb, int from, int incr);
360 sctp_log_strm_del(struct sctp_queued_to_read *control,
361 struct sctp_queued_to_read *poschk,
363 void sctp_log_cwnd(struct sctp_tcb *stcb, struct sctp_nets *, int, uint8_t);
364 void rto_logging(struct sctp_nets *net, int from);
366 void sctp_log_closing(struct sctp_inpcb *inp, struct sctp_tcb *stcb, int16_t loc);
368 void sctp_log_lock(struct sctp_inpcb *inp, struct sctp_tcb *stcb, uint8_t from);
369 void sctp_log_maxburst(struct sctp_tcb *stcb, struct sctp_nets *, int, int, uint8_t);
370 void sctp_log_block(uint8_t, struct sctp_association *, size_t);
371 void sctp_log_rwnd(uint8_t, uint32_t, uint32_t, uint32_t);
372 void sctp_log_rwnd_set(uint8_t, uint32_t, uint32_t, uint32_t, uint32_t);
373 int sctp_fill_stat_log(void *, size_t *);
374 void sctp_log_fr(uint32_t, uint32_t, uint32_t, int);
375 void sctp_log_sack(uint32_t, uint32_t, uint32_t, uint16_t, uint16_t, int);
376 void sctp_log_map(uint32_t, uint32_t, uint32_t, int);
377 void sctp_print_mapping_array(struct sctp_association *asoc);
378 void sctp_clr_stat_log(void);
381 #ifdef SCTP_AUDITING_ENABLED
383 sctp_auditing(int, struct sctp_inpcb *, struct sctp_tcb *,
385 void sctp_audit_log(uint8_t, uint8_t);
388 uint32_t sctp_min_mtu(uint32_t, uint32_t, uint32_t);
389 void sctp_hc_set_mtu(union sctp_sockstore *, uint16_t, uint32_t);
390 uint32_t sctp_hc_get_mtu(union sctp_sockstore *, uint16_t);
391 void sctp_set_state(struct sctp_tcb *, int);
392 void sctp_add_substate(struct sctp_tcb *, int);