sctputil.h revision 167598
1/*-
2 * Copyright (c) 2001-2007, Cisco Systems, Inc. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are met:
6 *
7 * a) Redistributions of source code must retain the above copyright notice,
8 *   this list of conditions and the following disclaimer.
9 *
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.
13 *
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.
17 *
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.
29 */
30
31
32/* $KAME: sctputil.h,v 1.15 2005/03/06 16:04:19 itojun Exp $	 */
33
34#include <sys/cdefs.h>
35__FBSDID("$FreeBSD: head/sys/netinet/sctputil.h 167598 2007-03-15 11:27:14Z rrs $");
36#ifndef __sctputil_h__
37#define __sctputil_h__
38
39
40#if defined(_KERNEL)
41
42#ifdef SCTP_MBUF_LOGGING
43
44struct mbuf *sctp_m_free(struct mbuf *m);
45void sctp_m_freem(struct mbuf *m);
46
47#else
48#define sctp_m_free m_free
49#define sctp_m_freem m_freem
50#endif
51
52
53#define sctp_get_associd(stcb) ((sctp_assoc_t)stcb->asoc.assoc_id)
54
55
56/*
57 * Function prototypes
58 */
59struct sctp_ifa *
60         sctp_find_ifa_in_ep(struct sctp_inpcb *inp, struct sockaddr *addr, int hold_lock);
61struct sctp_ifa *
62sctp_find_ifa_in_ifn(struct sctp_ifn *sctp_ifnp, struct sockaddr *addr,
63    int holds_lock);
64
65struct sctp_ifa *
66         sctp_find_ifa_by_addr(struct sockaddr *addr, uint32_t vrf_id, int holds_lock);
67
68uint32_t sctp_select_initial_TSN(struct sctp_pcb *);
69
70uint32_t sctp_select_a_tag(struct sctp_inpcb *);
71
72int sctp_init_asoc(struct sctp_inpcb *, struct sctp_association *, int, uint32_t, uint32_t);
73
74void sctp_fill_random_store(struct sctp_pcb *);
75
76int
77sctp_timer_start(int, struct sctp_inpcb *, struct sctp_tcb *,
78    struct sctp_nets *);
79
80int
81sctp_timer_stop(int, struct sctp_inpcb *, struct sctp_tcb *,
82    struct sctp_nets *, uint32_t);
83
84int
85    sctp_dynamic_set_primary(struct sockaddr *sa, uint32_t vrf_id);
86
87uint32_t sctp_calculate_sum(struct mbuf *, int32_t *, uint32_t);
88
89void
90     sctp_mtu_size_reset(struct sctp_inpcb *, struct sctp_association *, uint32_t);
91
92void
93sctp_add_to_readq(struct sctp_inpcb *inp,
94    struct sctp_tcb *stcb,
95    struct sctp_queued_to_read *control,
96    struct sockbuf *sb,
97    int end);
98
99int
100sctp_append_to_readq(struct sctp_inpcb *inp,
101    struct sctp_tcb *stcb,
102    struct sctp_queued_to_read *control,
103    struct mbuf *m,
104    int end,
105    int new_cumack,
106    struct sockbuf *sb);
107
108
109void sctp_iterator_worker(void);
110
111int find_next_best_mtu(int);
112
113void
114     sctp_timeout_handler(void *);
115
116uint32_t
117sctp_calculate_rto(struct sctp_tcb *, struct sctp_association *,
118    struct sctp_nets *, struct timeval *);
119
120uint32_t sctp_calculate_len(struct mbuf *);
121
122caddr_t sctp_m_getptr(struct mbuf *, int, int, uint8_t *);
123
124struct sctp_paramhdr *
125sctp_get_next_param(struct mbuf *, int,
126    struct sctp_paramhdr *, int);
127
128int sctp_add_pad_tombuf(struct mbuf *, int);
129
130int sctp_pad_lastmbuf(struct mbuf *, int, struct mbuf *);
131
132void sctp_ulp_notify(uint32_t, struct sctp_tcb *, uint32_t, void *);
133
134void
135sctp_pull_off_control_to_new_inp(struct sctp_inpcb *old_inp,
136    struct sctp_inpcb *new_inp,
137    struct sctp_tcb *stcb);
138
139
140void sctp_stop_timers_for_shutdown(struct sctp_tcb *);
141
142void sctp_report_all_outbound(struct sctp_tcb *, int);
143
144int sctp_expand_mapping_array(struct sctp_association *);
145
146void sctp_abort_notification(struct sctp_tcb *, int);
147
148/* We abort responding to an IP packet for some reason */
149void
150sctp_abort_association(struct sctp_inpcb *, struct sctp_tcb *,
151    struct mbuf *, int, struct sctphdr *, struct mbuf *);
152
153/* We choose to abort via user input */
154void
155sctp_abort_an_association(struct sctp_inpcb *, struct sctp_tcb *, int,
156    struct mbuf *);
157
158void
159sctp_handle_ootb(struct mbuf *, int, int, struct sctphdr *,
160    struct sctp_inpcb *, struct mbuf *);
161
162int sctp_is_there_an_abort_here(struct mbuf *, int, uint32_t *);
163uint32_t sctp_is_same_scope(struct sockaddr_in6 *, struct sockaddr_in6 *);
164
165struct sockaddr_in6 *
166             sctp_recover_scope(struct sockaddr_in6 *, struct sockaddr_in6 *);
167
168#define sctp_recover_scope_mac(addr, store) do { \
169	 if ((addr->sin6_family == AF_INET6) && \
170	     (IN6_IS_SCOPE_LINKLOCAL(&addr->sin6_addr))) { \
171		*store = *addr; \
172		if (addr->sin6_scope_id == 0) { \
173			if (!sa6_recoverscope(store)) { \
174				addr = store; \
175			} \
176		} else { \
177			in6_clearscope(&addr->sin6_addr); \
178			addr = store; \
179		} \
180	 } \
181} while (0)
182
183
184int sctp_cmpaddr(struct sockaddr *, struct sockaddr *);
185
186void sctp_print_address(struct sockaddr *);
187void sctp_print_address_pkt(struct ip *, struct sctphdr *);
188
189void
190sctp_notify_partial_delivery_indication(struct sctp_tcb *stcb,
191    uint32_t error, int no_lock);
192
193int
194sctp_release_pr_sctp_chunk(struct sctp_tcb *, struct sctp_tmit_chunk *,
195    int, struct sctpchunk_listhead *);
196
197struct mbuf *sctp_generate_invmanparam(int);
198
199
200#ifdef SCTP_MBCNT_LOGGING
201void
202sctp_free_bufspace(struct sctp_tcb *, struct sctp_association *,
203    struct sctp_tmit_chunk *);
204
205#else
206#define sctp_free_bufspace(stcb, asoc, tp1, chk_cnt)  \
207do { \
208	if (tp1->data != NULL) { \
209                atomic_add_int(&((asoc)->chunks_on_out_queue), -chk_cnt); \
210		if ((asoc)->total_output_queue_size >= tp1->book_size) { \
211			atomic_add_int(&((asoc)->total_output_queue_size), -tp1->book_size); \
212		} else { \
213			(asoc)->total_output_queue_size = 0; \
214		} \
215   	        if (stcb->sctp_socket && ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \
216	            (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \
217			if (stcb->sctp_socket->so_snd.sb_cc >= tp1->book_size) { \
218				atomic_add_int(&((stcb)->sctp_socket->so_snd.sb_cc), -tp1->book_size); \
219			} else { \
220				stcb->sctp_socket->so_snd.sb_cc = 0; \
221			} \
222		} \
223        } \
224} while (0)
225
226#endif
227
228#define sctp_free_spbufspace(stcb, asoc, sp)  \
229do { \
230 	if (sp->data != NULL) { \
231                atomic_add_int(&(asoc)->chunks_on_out_queue, -1); \
232		if ((asoc)->total_output_queue_size >= sp->length) { \
233			atomic_add_int(&(asoc)->total_output_queue_size,sp->length); \
234		} else { \
235			(asoc)->total_output_queue_size = 0; \
236		} \
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 >= sp->length) { \
240				atomic_add_int(&stcb->sctp_socket->so_snd.sb_cc,sp->length); \
241			} else { \
242				stcb->sctp_socket->so_snd.sb_cc = 0; \
243			} \
244		} \
245        } \
246} while (0)
247
248#define sctp_snd_sb_alloc(stcb, sz)  \
249do { \
250	atomic_add_int(&stcb->asoc.total_output_queue_size,sz); \
251	if ((stcb->sctp_socket != NULL) && \
252	    ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \
253	     (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \
254		atomic_add_int(&stcb->sctp_socket->so_snd.sb_cc,sz); \
255	} \
256} while (0)
257
258
259int
260sctp_soreceive(struct socket *so, struct sockaddr **psa,
261    struct uio *uio,
262    struct mbuf **mp0,
263    struct mbuf **controlp,
264    int *flagsp);
265
266
267#ifdef SCTP_STAT_LOGGING
268void
269     sctp_misc_ints(uint8_t from, uint32_t a, uint32_t b, uint32_t c, uint32_t d);
270
271void
272sctp_wakeup_log(struct sctp_tcb *stcb,
273    uint32_t cumtsn,
274    uint32_t wake_cnt, int from);
275
276void sctp_log_strm_del_alt(struct sctp_tcb *stcb, uint32_t, uint16_t, uint16_t, int);
277
278void sctp_log_nagle_event(struct sctp_tcb *stcb, int action);
279
280
281void
282     sctp_log_mb(struct mbuf *m, int from);
283
284void
285sctp_sblog(struct sockbuf *sb,
286    struct sctp_tcb *stcb, int from, int incr);
287
288void
289sctp_log_strm_del(struct sctp_queued_to_read *control,
290    struct sctp_queued_to_read *poschk,
291    int from);
292void sctp_log_cwnd(struct sctp_tcb *stcb, struct sctp_nets *, int, uint8_t);
293void rto_logging(struct sctp_nets *net, int from);
294
295void sctp_log_closing(struct sctp_inpcb *inp, struct sctp_tcb *stcb, int16_t loc);
296
297void sctp_log_lock(struct sctp_inpcb *inp, struct sctp_tcb *stcb, uint8_t from);
298void sctp_log_maxburst(struct sctp_tcb *stcb, struct sctp_nets *, int, int, uint8_t);
299void sctp_log_block(uint8_t, struct socket *, struct sctp_association *, int);
300void sctp_log_rwnd(uint8_t, uint32_t, uint32_t, uint32_t);
301void sctp_log_mbcnt(uint8_t, uint32_t, uint32_t, uint32_t, uint32_t);
302void sctp_log_rwnd_set(uint8_t, uint32_t, uint32_t, uint32_t, uint32_t);
303int sctp_fill_stat_log(void *, size_t *);
304void sctp_log_fr(uint32_t, uint32_t, uint32_t, int);
305void sctp_log_sack(uint32_t, uint32_t, uint32_t, uint16_t, uint16_t, int);
306void sctp_log_map(uint32_t, uint32_t, uint32_t, int);
307
308void sctp_clr_stat_log(void);
309
310#endif
311
312#ifdef SCTP_AUDITING_ENABLED
313void
314sctp_auditing(int, struct sctp_inpcb *, struct sctp_tcb *,
315    struct sctp_nets *);
316void sctp_audit_log(uint8_t, uint8_t);
317
318#endif
319
320
321#endif				/* _KERNEL */
322#endif
323