2 * Copyright (c) 2001-2007, by Cisco Systems, Inc. All rights reserved.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are met:
7 * a) Redistributions of source code must retain the above copyright notice,
8 * this list of conditions and the following disclaimer.
10 * b) Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in
12 * the documentation and/or other materials provided with the distribution.
14 * c) Neither the name of Cisco Systems, Inc. nor the names of its
15 * contributors may be used to endorse or promote products derived
16 * from this software without specific prior written permission.
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
20 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
22 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
28 * THE POSSIBILITY OF SUCH DAMAGE.
32 /* $KAME: sctputil.h,v 1.15 2005/03/06 16:04:19 itojun Exp $ */
34 #include <sys/cdefs.h>
35 __FBSDID("$FreeBSD$");
36 #ifndef __sctputil_h__
37 #define __sctputil_h__
40 #if defined(_KERNEL) || defined(__Userspace__)
42 #define SCTP_READ_LOCK_HELD 1
43 #define SCTP_READ_LOCK_NOT_HELD 0
45 #ifdef SCTP_ASOCLOG_OF_TSNS
46 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);
55 #define sctp_m_free m_free
56 #define sctp_m_freem m_freem
59 #if defined(SCTP_LOCAL_TRACE_BUF) || defined(__APPLE__)
61 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);
65 #define sctp_get_associd(stcb) ((sctp_assoc_t)stcb->asoc.assoc_id)
72 sctp_get_ifa_hash_val(struct sockaddr *addr);
75 sctp_find_ifa_in_ep(struct sctp_inpcb *inp, struct sockaddr *addr, int hold_lock);
78 sctp_find_ifa_by_addr(struct sockaddr *addr, uint32_t vrf_id, int holds_lock);
80 uint32_t sctp_select_initial_TSN(struct sctp_pcb *);
82 uint32_t sctp_select_a_tag(struct sctp_inpcb *, uint16_t lport, uint16_t rport, int);
84 int sctp_init_asoc(struct sctp_inpcb *, struct sctp_tcb *, uint32_t, uint32_t);
86 void sctp_fill_random_store(struct sctp_pcb *);
89 sctp_timer_start(int, struct sctp_inpcb *, struct sctp_tcb *,
93 sctp_timer_stop(int, struct sctp_inpcb *, struct sctp_tcb *,
94 struct sctp_nets *, uint32_t);
97 sctp_dynamic_set_primary(struct sockaddr *sa, uint32_t vrf_id);
100 sctp_mtu_size_reset(struct sctp_inpcb *, struct sctp_association *, uint32_t);
103 sctp_add_to_readq(struct sctp_inpcb *inp,
104 struct sctp_tcb *stcb,
105 struct sctp_queued_to_read *control,
110 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING)
116 sctp_append_to_readq(struct sctp_inpcb *inp,
117 struct sctp_tcb *stcb,
118 struct sctp_queued_to_read *control,
125 void sctp_iterator_worker(void);
127 uint32_t sctp_get_prev_mtu(uint32_t);
128 uint32_t sctp_get_next_mtu(struct sctp_inpcb *, uint32_t);
131 sctp_timeout_handler(void *);
134 sctp_calculate_rto(struct sctp_tcb *, struct sctp_association *,
135 struct sctp_nets *, struct timeval *, int);
137 uint32_t sctp_calculate_len(struct mbuf *);
139 caddr_t sctp_m_getptr(struct mbuf *, int, int, uint8_t *);
141 struct sctp_paramhdr *
142 sctp_get_next_param(struct mbuf *, int,
143 struct sctp_paramhdr *, int);
145 int sctp_add_pad_tombuf(struct mbuf *, int);
147 int sctp_pad_lastmbuf(struct mbuf *, int, struct mbuf *);
150 sctp_ulp_notify(uint32_t, struct sctp_tcb *, uint32_t, void *, int
151 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING)
157 sctp_pull_off_control_to_new_inp(struct sctp_inpcb *old_inp,
158 struct sctp_inpcb *new_inp,
159 struct sctp_tcb *stcb, int waitflags);
162 void sctp_stop_timers_for_shutdown(struct sctp_tcb *);
165 sctp_report_all_outbound(struct sctp_tcb *, int, int
166 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING)
171 int sctp_expand_mapping_array(struct sctp_association *, uint32_t);
174 sctp_abort_notification(struct sctp_tcb *, int, int
175 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING)
180 /* We abort responding to an IP packet for some reason */
182 sctp_abort_association(struct sctp_inpcb *, struct sctp_tcb *,
183 struct mbuf *, int, struct sctphdr *, struct mbuf *, uint32_t, uint16_t);
186 /* We choose to abort via user input */
188 sctp_abort_an_association(struct sctp_inpcb *, struct sctp_tcb *, int,
190 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING)
196 sctp_handle_ootb(struct mbuf *, int, int, struct sctphdr *,
197 struct sctp_inpcb *, struct mbuf *, uint32_t, uint16_t);
200 sctp_connectx_helper_add(struct sctp_tcb *stcb, struct sockaddr *addr,
201 int totaddr, int *error);
204 sctp_connectx_helper_find(struct sctp_inpcb *inp, struct sockaddr *addr,
205 int *totaddr, int *num_v4, int *num_v6, int *error, int limit, int *bad_addr);
207 int sctp_is_there_an_abort_here(struct mbuf *, int, uint32_t *);
210 uint32_t sctp_is_same_scope(struct sockaddr_in6 *, struct sockaddr_in6 *);
212 struct sockaddr_in6 *
213 sctp_recover_scope(struct sockaddr_in6 *, struct sockaddr_in6 *);
215 #define sctp_recover_scope_mac(addr, store) do { \
216 if ((addr->sin6_family == AF_INET6) && \
217 (IN6_IS_SCOPE_LINKLOCAL(&addr->sin6_addr))) { \
219 if (addr->sin6_scope_id == 0) { \
220 if (!sa6_recoverscope(store)) { \
224 in6_clearscope(&addr->sin6_addr); \
231 int sctp_cmpaddr(struct sockaddr *, struct sockaddr *);
233 void sctp_print_address(struct sockaddr *);
234 void sctp_print_address_pkt(struct ip *, struct sctphdr *);
237 sctp_release_pr_sctp_chunk(struct sctp_tcb *, struct sctp_tmit_chunk *,
239 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING)
244 struct mbuf *sctp_generate_invmanparam(int);
247 sctp_bindx_add_address(struct socket *so, struct sctp_inpcb *inp,
248 struct sockaddr *sa, sctp_assoc_t assoc_id,
249 uint32_t vrf_id, int *error, void *p);
251 sctp_bindx_delete_address(struct socket *so, struct sctp_inpcb *inp,
252 struct sockaddr *sa, sctp_assoc_t assoc_id,
253 uint32_t vrf_id, int *error);
255 int sctp_local_addr_count(struct sctp_tcb *stcb);
257 #ifdef SCTP_MBCNT_LOGGING
259 sctp_free_bufspace(struct sctp_tcb *, struct sctp_association *,
260 struct sctp_tmit_chunk *, int);
263 #define sctp_free_bufspace(stcb, asoc, tp1, chk_cnt) \
265 if (tp1->data != NULL) { \
266 atomic_subtract_int(&((asoc)->chunks_on_out_queue), chk_cnt); \
267 if ((asoc)->total_output_queue_size >= tp1->book_size) { \
268 atomic_subtract_int(&((asoc)->total_output_queue_size), tp1->book_size); \
270 (asoc)->total_output_queue_size = 0; \
272 if (stcb->sctp_socket && ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \
273 (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \
274 if (stcb->sctp_socket->so_snd.sb_cc >= tp1->book_size) { \
275 atomic_subtract_int(&((stcb)->sctp_socket->so_snd.sb_cc), tp1->book_size); \
277 stcb->sctp_socket->so_snd.sb_cc = 0; \
285 #define sctp_free_spbufspace(stcb, asoc, sp) \
287 if (sp->data != NULL) { \
288 if ((asoc)->total_output_queue_size >= sp->length) { \
289 atomic_subtract_int(&(asoc)->total_output_queue_size, sp->length); \
291 (asoc)->total_output_queue_size = 0; \
293 if (stcb->sctp_socket && ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \
294 (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \
295 if (stcb->sctp_socket->so_snd.sb_cc >= sp->length) { \
296 atomic_subtract_int(&stcb->sctp_socket->so_snd.sb_cc,sp->length); \
298 stcb->sctp_socket->so_snd.sb_cc = 0; \
304 #define sctp_snd_sb_alloc(stcb, sz) \
306 atomic_add_int(&stcb->asoc.total_output_queue_size,sz); \
307 if ((stcb->sctp_socket != NULL) && \
308 ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \
309 (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \
310 atomic_add_int(&stcb->sctp_socket->so_snd.sb_cc,sz); \
314 /* new functions to start/stop udp tunneling */
315 void sctp_over_udp_stop(void);
316 int sctp_over_udp_start(void);
319 sctp_soreceive(struct socket *so, struct sockaddr **psa,
322 struct mbuf **controlp,
326 /* For those not passing mbufs, this does the
327 * translations for you. Caller owns memory
328 * of size controllen returned in controlp.
331 sctp_l_soreceive(struct socket *so,
332 struct sockaddr **name,
340 sctp_misc_ints(uint8_t from, uint32_t a, uint32_t b, uint32_t c, uint32_t d);
343 sctp_wakeup_log(struct sctp_tcb *stcb,
345 uint32_t wake_cnt, int from);
347 void sctp_log_strm_del_alt(struct sctp_tcb *stcb, uint32_t, uint16_t, uint16_t, int);
349 void sctp_log_nagle_event(struct sctp_tcb *stcb, int action);
353 sctp_log_mb(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 socket *, struct sctp_association *, int);
371 void sctp_log_rwnd(uint8_t, uint32_t, uint32_t, uint32_t);
372 void sctp_log_mbcnt(uint8_t, uint32_t, uint32_t, uint32_t, uint32_t);
373 void sctp_log_rwnd_set(uint8_t, uint32_t, uint32_t, uint32_t, uint32_t);
374 int sctp_fill_stat_log(void *, size_t *);
375 void sctp_log_fr(uint32_t, uint32_t, uint32_t, int);
376 void sctp_log_sack(uint32_t, uint32_t, uint32_t, uint16_t, uint16_t, int);
377 void sctp_log_map(uint32_t, uint32_t, uint32_t, int);
378 void sctp_print_mapping_array(struct sctp_association *asoc);
379 void sctp_clr_stat_log(void);
382 #ifdef SCTP_AUDITING_ENABLED
384 sctp_auditing(int, struct sctp_inpcb *, struct sctp_tcb *,
386 void sctp_audit_log(uint8_t, uint8_t);