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__
43 #ifdef SCTP_ASOCLOG_OF_TSNS
44 void sctp_print_out_track_log(struct sctp_tcb *stcb);
48 #ifdef SCTP_MBUF_LOGGING
49 struct mbuf *sctp_m_free(struct mbuf *m);
50 void sctp_m_freem(struct mbuf *m);
53 #define sctp_m_free m_free
54 #define sctp_m_freem m_freem
58 #define sctp_get_associd(stcb) ((sctp_assoc_t)stcb->asoc.assoc_id)
65 sctp_get_ifa_hash_val(struct sockaddr *addr);
68 sctp_find_ifa_in_ep(struct sctp_inpcb *inp, struct sockaddr *addr, int hold_lock);
71 sctp_find_ifa_by_addr(struct sockaddr *addr, uint32_t vrf_id, int holds_lock);
73 uint32_t sctp_select_initial_TSN(struct sctp_pcb *);
75 uint32_t sctp_select_a_tag(struct sctp_inpcb *);
77 int sctp_init_asoc(struct sctp_inpcb *, struct sctp_tcb *, int, uint32_t, uint32_t);
79 void sctp_fill_random_store(struct sctp_pcb *);
82 sctp_timer_start(int, struct sctp_inpcb *, struct sctp_tcb *,
86 sctp_timer_stop(int, struct sctp_inpcb *, struct sctp_tcb *,
87 struct sctp_nets *, uint32_t);
90 sctp_dynamic_set_primary(struct sockaddr *sa, uint32_t vrf_id);
92 uint32_t sctp_calculate_sum(struct mbuf *, int32_t *, uint32_t);
95 sctp_mtu_size_reset(struct sctp_inpcb *, struct sctp_association *, uint32_t);
98 sctp_add_to_readq(struct sctp_inpcb *inp,
99 struct sctp_tcb *stcb,
100 struct sctp_queued_to_read *control,
105 sctp_append_to_readq(struct sctp_inpcb *inp,
106 struct sctp_tcb *stcb,
107 struct sctp_queued_to_read *control,
114 void sctp_iterator_worker(void);
116 int find_next_best_mtu(int);
119 sctp_timeout_handler(void *);
122 sctp_calculate_rto(struct sctp_tcb *, struct sctp_association *,
123 struct sctp_nets *, struct timeval *);
125 uint32_t sctp_calculate_len(struct mbuf *);
127 caddr_t sctp_m_getptr(struct mbuf *, int, int, uint8_t *);
129 struct sctp_paramhdr *
130 sctp_get_next_param(struct mbuf *, int,
131 struct sctp_paramhdr *, int);
133 int sctp_add_pad_tombuf(struct mbuf *, int);
135 int sctp_pad_lastmbuf(struct mbuf *, int, struct mbuf *);
137 void sctp_ulp_notify(uint32_t, struct sctp_tcb *, uint32_t, void *);
140 sctp_pull_off_control_to_new_inp(struct sctp_inpcb *old_inp,
141 struct sctp_inpcb *new_inp,
142 struct sctp_tcb *stcb, int waitflags);
145 void sctp_stop_timers_for_shutdown(struct sctp_tcb *);
147 void sctp_report_all_outbound(struct sctp_tcb *, int);
149 int sctp_expand_mapping_array(struct sctp_association *, uint32_t);
151 void sctp_abort_notification(struct sctp_tcb *, int);
153 /* We abort responding to an IP packet for some reason */
155 sctp_abort_association(struct sctp_inpcb *, struct sctp_tcb *,
156 struct mbuf *, int, struct sctphdr *, struct mbuf *, uint32_t);
159 /* We choose to abort via user input */
161 sctp_abort_an_association(struct sctp_inpcb *, struct sctp_tcb *, int,
165 sctp_handle_ootb(struct mbuf *, int, int, struct sctphdr *,
166 struct sctp_inpcb *, struct mbuf *, uint32_t);
169 sctp_connectx_helper_add(struct sctp_tcb *stcb, struct sockaddr *addr,
170 int totaddr, int *error);
173 sctp_connectx_helper_find(struct sctp_inpcb *inp, struct sockaddr *addr,
174 int *totaddr, int *num_v4, int *num_v6, int *error, int limit, int *bad_addr);
176 int sctp_is_there_an_abort_here(struct mbuf *, int, uint32_t *);
177 uint32_t sctp_is_same_scope(struct sockaddr_in6 *, struct sockaddr_in6 *);
179 struct sockaddr_in6 *
180 sctp_recover_scope(struct sockaddr_in6 *, struct sockaddr_in6 *);
182 #define sctp_recover_scope_mac(addr, store) do { \
183 if ((addr->sin6_family == AF_INET6) && \
184 (IN6_IS_SCOPE_LINKLOCAL(&addr->sin6_addr))) { \
186 if (addr->sin6_scope_id == 0) { \
187 if (!sa6_recoverscope(store)) { \
191 in6_clearscope(&addr->sin6_addr); \
198 int sctp_cmpaddr(struct sockaddr *, struct sockaddr *);
200 void sctp_print_address(struct sockaddr *);
201 void sctp_print_address_pkt(struct ip *, struct sctphdr *);
204 sctp_notify_partial_delivery_indication(struct sctp_tcb *stcb,
205 uint32_t error, int no_lock, uint32_t strseq);
208 sctp_release_pr_sctp_chunk(struct sctp_tcb *, struct sctp_tmit_chunk *,
209 int, struct sctpchunk_listhead *);
211 struct mbuf *sctp_generate_invmanparam(int);
214 sctp_bindx_add_address(struct socket *so, struct sctp_inpcb *inp,
215 struct sockaddr *sa, sctp_assoc_t assoc_id,
216 uint32_t vrf_id, int *error, void *p);
218 sctp_bindx_delete_address(struct socket *so, struct sctp_inpcb *inp,
219 struct sockaddr *sa, sctp_assoc_t assoc_id,
220 uint32_t vrf_id, int *error);
222 #ifdef SCTP_MBCNT_LOGGING
224 sctp_free_bufspace(struct sctp_tcb *, struct sctp_association *,
225 struct sctp_tmit_chunk *, int);
228 #define sctp_free_bufspace(stcb, asoc, tp1, chk_cnt) \
230 if (tp1->data != NULL) { \
231 atomic_subtract_int(&((asoc)->chunks_on_out_queue), chk_cnt); \
232 if ((asoc)->total_output_queue_size >= tp1->book_size) { \
233 atomic_subtract_int(&((asoc)->total_output_queue_size), tp1->book_size); \
235 (asoc)->total_output_queue_size = 0; \
237 if (stcb->sctp_socket && ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \
238 (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \
239 if (stcb->sctp_socket->so_snd.sb_cc >= tp1->book_size) { \
240 atomic_subtract_int(&((stcb)->sctp_socket->so_snd.sb_cc), tp1->book_size); \
242 stcb->sctp_socket->so_snd.sb_cc = 0; \
250 #define sctp_free_spbufspace(stcb, asoc, sp) \
252 if (sp->data != NULL) { \
253 atomic_subtract_int(&(asoc)->chunks_on_out_queue, 1); \
254 if ((asoc)->total_output_queue_size >= sp->length) { \
255 atomic_subtract_int(&(asoc)->total_output_queue_size, sp->length); \
257 (asoc)->total_output_queue_size = 0; \
259 if (stcb->sctp_socket && ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \
260 (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \
261 if (stcb->sctp_socket->so_snd.sb_cc >= sp->length) { \
262 atomic_subtract_int(&stcb->sctp_socket->so_snd.sb_cc,sp->length); \
264 stcb->sctp_socket->so_snd.sb_cc = 0; \
270 #define sctp_snd_sb_alloc(stcb, sz) \
272 atomic_add_int(&stcb->asoc.total_output_queue_size,sz); \
273 if ((stcb->sctp_socket != NULL) && \
274 ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \
275 (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \
276 atomic_add_int(&stcb->sctp_socket->so_snd.sb_cc,sz); \
282 sctp_soreceive(struct socket *so, struct sockaddr **psa,
285 struct mbuf **controlp,
289 /* For those not passing mbufs, this does the
290 * translations for you. Caller owns memory
291 * of size controllen returned in controlp.
294 sctp_l_soreceive(struct socket *so,
295 struct sockaddr **name,
303 sctp_misc_ints(uint8_t from, uint32_t a, uint32_t b, uint32_t c, uint32_t d);
306 sctp_wakeup_log(struct sctp_tcb *stcb,
308 uint32_t wake_cnt, int from);
310 void sctp_log_strm_del_alt(struct sctp_tcb *stcb, uint32_t, uint16_t, uint16_t, int);
312 void sctp_log_nagle_event(struct sctp_tcb *stcb, int action);
316 sctp_log_mb(struct mbuf *m, int from);
319 sctp_sblog(struct sockbuf *sb,
320 struct sctp_tcb *stcb, int from, int incr);
323 sctp_log_strm_del(struct sctp_queued_to_read *control,
324 struct sctp_queued_to_read *poschk,
326 void sctp_log_cwnd(struct sctp_tcb *stcb, struct sctp_nets *, int, uint8_t);
327 void rto_logging(struct sctp_nets *net, int from);
329 void sctp_log_closing(struct sctp_inpcb *inp, struct sctp_tcb *stcb, int16_t loc);
331 void sctp_log_lock(struct sctp_inpcb *inp, struct sctp_tcb *stcb, uint8_t from);
332 void sctp_log_maxburst(struct sctp_tcb *stcb, struct sctp_nets *, int, int, uint8_t);
333 void sctp_log_block(uint8_t, struct socket *, struct sctp_association *, int);
334 void sctp_log_rwnd(uint8_t, uint32_t, uint32_t, uint32_t);
335 void sctp_log_mbcnt(uint8_t, uint32_t, uint32_t, uint32_t, uint32_t);
336 void sctp_log_rwnd_set(uint8_t, uint32_t, uint32_t, uint32_t, uint32_t);
337 int sctp_fill_stat_log(void *, size_t *);
338 void sctp_log_fr(uint32_t, uint32_t, uint32_t, int);
339 void sctp_log_sack(uint32_t, uint32_t, uint32_t, uint16_t, uint16_t, int);
340 void sctp_log_map(uint32_t, uint32_t, uint32_t, int);
342 void sctp_clr_stat_log(void);
345 #ifdef SCTP_AUDITING_ENABLED
347 sctp_auditing(int, struct sctp_inpcb *, struct sctp_tcb *,
349 void sctp_audit_log(uint8_t, uint8_t);