2 * Copyright (c) 2001-2008, by Cisco Systems, Inc. All rights reserved.
3 * Copyright (c) 2008-2011, by Randall Stewart. All rights reserved.
4 * Copyright (c) 2008-2011, by Michael Tuexen. All rights reserved.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are met:
9 * a) Redistributions of source code must retain the above copyright notice,
10 * this list of conditions and the following disclaimer.
12 * b) Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in
14 * the documentation and/or other materials provided with the distribution.
16 * c) Neither the name of Cisco Systems, Inc. nor the names of its
17 * contributors may be used to endorse or promote products derived
18 * from this software without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
22 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
30 * THE POSSIBILITY OF SUCH DAMAGE.
33 /* $KAME: sctp_var.h,v 1.24 2005/03/06 16:04:19 itojun Exp $ */
35 #include <sys/cdefs.h>
36 __FBSDID("$FreeBSD$");
38 #ifndef _NETINET_SCTP_VAR_H_
39 #define _NETINET_SCTP_VAR_H_
41 #include <netinet/sctp_uio.h>
43 #if defined(_KERNEL) || defined(__Userspace__)
45 extern struct pr_usrreqs sctp_usrreqs;
48 #define sctp_feature_on(inp, feature) (inp->sctp_features |= feature)
49 #define sctp_feature_off(inp, feature) (inp->sctp_features &= ~feature)
50 #define sctp_is_feature_on(inp, feature) ((inp->sctp_features & feature) == feature)
51 #define sctp_is_feature_off(inp, feature) ((inp->sctp_features & feature) == 0)
53 #define sctp_stcb_feature_on(inp, stcb, feature) {\
55 stcb->asoc.sctp_features |= feature; \
57 inp->sctp_features |= feature; \
60 #define sctp_stcb_feature_off(inp, stcb, feature) {\
62 stcb->asoc.sctp_features &= ~feature; \
64 inp->sctp_features &= ~feature; \
67 #define sctp_stcb_is_feature_on(inp, stcb, feature) \
69 ((stcb->asoc.sctp_features & feature) == feature)) || \
71 ((inp->sctp_features & feature) == feature)))
72 #define sctp_stcb_is_feature_off(inp, stcb, feature) \
74 ((stcb->asoc.sctp_features & feature) == 0)) || \
76 ((inp->sctp_features & feature) == 0)))
78 /* managing mobility_feature in inpcb (by micchie) */
79 #define sctp_mobility_feature_on(inp, feature) (inp->sctp_mobility_features |= feature)
80 #define sctp_mobility_feature_off(inp, feature) (inp->sctp_mobility_features &= ~feature)
81 #define sctp_is_mobility_feature_on(inp, feature) (inp->sctp_mobility_features & feature)
82 #define sctp_is_mobility_feature_off(inp, feature) ((inp->sctp_mobility_features & feature) == 0)
84 #define sctp_maxspace(sb) (max((sb)->sb_hiwat,SCTP_MINIMAL_RWND))
86 #define sctp_sbspace(asoc, sb) ((long) ((sctp_maxspace(sb) > (asoc)->sb_cc) ? (sctp_maxspace(sb) - (asoc)->sb_cc) : 0))
88 #define sctp_sbspace_failedmsgs(sb) ((long) ((sctp_maxspace(sb) > (sb)->sb_cc) ? (sctp_maxspace(sb) - (sb)->sb_cc) : 0))
90 #define sctp_sbspace_sub(a,b) ((a > b) ? (a - b) : 0)
93 * I tried to cache the readq entries at one point. But the reality
94 * is that it did not add any performance since this meant we had to
95 * lock the STCB on read. And at that point once you have to do an
96 * extra lock, it really does not matter if the lock is in the ZONE
97 * stuff or in our code. Note that this same problem would occur with
98 * an mbuf cache as well so it is not really worth doing, at least
102 #define sctp_free_a_readq(_stcb, _readq) { \
103 SCTP_ZONE_FREE(SCTP_BASE_INFO(ipi_zone_readq), (_readq)); \
104 SCTP_DECR_READQ_COUNT(); \
107 #define sctp_alloc_a_readq(_stcb, _readq) { \
108 (_readq) = SCTP_ZONE_GET(SCTP_BASE_INFO(ipi_zone_readq), struct sctp_queued_to_read); \
110 SCTP_INCR_READQ_COUNT(); \
114 #define sctp_free_a_strmoq(_stcb, _strmoq, _so_locked) { \
115 if ((_strmoq)->holds_key_ref) { \
116 sctp_auth_key_release(stcb, sp->auth_keyid, _so_locked); \
117 (_strmoq)->holds_key_ref = 0; \
119 SCTP_ZONE_FREE(SCTP_BASE_INFO(ipi_zone_strmoq), (_strmoq)); \
120 SCTP_DECR_STRMOQ_COUNT(); \
123 #define sctp_alloc_a_strmoq(_stcb, _strmoq) { \
124 (_strmoq) = SCTP_ZONE_GET(SCTP_BASE_INFO(ipi_zone_strmoq), struct sctp_stream_queue_pending); \
126 memset(_strmoq, 0, sizeof(struct sctp_stream_queue_pending)); \
127 SCTP_INCR_STRMOQ_COUNT(); \
128 (_strmoq)->holds_key_ref = 0; \
132 #define sctp_free_a_chunk(_stcb, _chk, _so_locked) { \
133 if ((_chk)->holds_key_ref) {\
134 sctp_auth_key_release((_stcb), (_chk)->auth_keyid, _so_locked); \
135 (_chk)->holds_key_ref = 0; \
138 SCTP_TCB_LOCK_ASSERT((_stcb)); \
139 if ((_chk)->whoTo) { \
140 sctp_free_remote_addr((_chk)->whoTo); \
141 (_chk)->whoTo = NULL; \
143 if (((_stcb)->asoc.free_chunk_cnt > SCTP_BASE_SYSCTL(sctp_asoc_free_resc_limit)) || \
144 (SCTP_BASE_INFO(ipi_free_chunks) > SCTP_BASE_SYSCTL(sctp_system_free_resc_limit))) { \
145 SCTP_ZONE_FREE(SCTP_BASE_INFO(ipi_zone_chunk), (_chk)); \
146 SCTP_DECR_CHK_COUNT(); \
148 TAILQ_INSERT_TAIL(&(_stcb)->asoc.free_chunks, (_chk), sctp_next); \
149 (_stcb)->asoc.free_chunk_cnt++; \
150 atomic_add_int(&SCTP_BASE_INFO(ipi_free_chunks), 1); \
153 SCTP_ZONE_FREE(SCTP_BASE_INFO(ipi_zone_chunk), (_chk)); \
154 SCTP_DECR_CHK_COUNT(); \
158 #define sctp_alloc_a_chunk(_stcb, _chk) { \
159 if (TAILQ_EMPTY(&(_stcb)->asoc.free_chunks)) { \
160 (_chk) = SCTP_ZONE_GET(SCTP_BASE_INFO(ipi_zone_chunk), struct sctp_tmit_chunk); \
162 SCTP_INCR_CHK_COUNT(); \
163 (_chk)->whoTo = NULL; \
164 (_chk)->holds_key_ref = 0; \
167 (_chk) = TAILQ_FIRST(&(_stcb)->asoc.free_chunks); \
168 TAILQ_REMOVE(&(_stcb)->asoc.free_chunks, (_chk), sctp_next); \
169 atomic_subtract_int(&SCTP_BASE_INFO(ipi_free_chunks), 1); \
170 (_chk)->holds_key_ref = 0; \
171 SCTP_STAT_INCR(sctps_cached_chk); \
172 (_stcb)->asoc.free_chunk_cnt--; \
177 #define sctp_free_remote_addr(__net) { \
179 if (SCTP_DECREMENT_AND_CHECK_REFCOUNT(&(__net)->ref_count)) { \
180 (void)SCTP_OS_TIMER_STOP(&(__net)->rxt_timer.timer); \
181 (void)SCTP_OS_TIMER_STOP(&(__net)->pmtu_timer.timer); \
182 (void)SCTP_OS_TIMER_STOP(&(__net)->fr_timer.timer); \
183 if ((__net)->ro.ro_rt) { \
184 RTFREE((__net)->ro.ro_rt); \
185 (__net)->ro.ro_rt = NULL; \
187 if ((__net)->src_addr_selected) { \
188 sctp_free_ifa((__net)->ro._s_addr); \
189 (__net)->ro._s_addr = NULL; \
191 (__net)->src_addr_selected = 0; \
192 (__net)->dest_state = SCTP_ADDR_NOT_REACHABLE; \
193 SCTP_ZONE_FREE(SCTP_BASE_INFO(ipi_zone_net), (__net)); \
194 SCTP_DECR_RADDR_COUNT(); \
199 #define sctp_sbfree(ctl, stcb, sb, m) { \
200 SCTP_SAVE_ATOMIC_DECREMENT(&(sb)->sb_cc, SCTP_BUF_LEN((m))); \
201 SCTP_SAVE_ATOMIC_DECREMENT(&(sb)->sb_mbcnt, MSIZE); \
202 if (((ctl)->do_not_ref_stcb == 0) && stcb) {\
203 SCTP_SAVE_ATOMIC_DECREMENT(&(stcb)->asoc.sb_cc, SCTP_BUF_LEN((m))); \
204 SCTP_SAVE_ATOMIC_DECREMENT(&(stcb)->asoc.my_rwnd_control_len, MSIZE); \
206 if (SCTP_BUF_TYPE(m) != MT_DATA && SCTP_BUF_TYPE(m) != MT_HEADER && \
207 SCTP_BUF_TYPE(m) != MT_OOBDATA) \
208 atomic_subtract_int(&(sb)->sb_ctl,SCTP_BUF_LEN((m))); \
211 #define sctp_sballoc(stcb, sb, m) { \
212 atomic_add_int(&(sb)->sb_cc,SCTP_BUF_LEN((m))); \
213 atomic_add_int(&(sb)->sb_mbcnt, MSIZE); \
215 atomic_add_int(&(stcb)->asoc.sb_cc,SCTP_BUF_LEN((m))); \
216 atomic_add_int(&(stcb)->asoc.my_rwnd_control_len, MSIZE); \
218 if (SCTP_BUF_TYPE(m) != MT_DATA && SCTP_BUF_TYPE(m) != MT_HEADER && \
219 SCTP_BUF_TYPE(m) != MT_OOBDATA) \
220 atomic_add_int(&(sb)->sb_ctl,SCTP_BUF_LEN((m))); \
224 #define sctp_ucount_incr(val) { \
228 #define sctp_ucount_decr(val) { \
236 #define sctp_mbuf_crush(data) do { \
239 while(_m && (SCTP_BUF_LEN(_m) == 0)) { \
240 (data) = SCTP_BUF_NEXT(_m); \
241 SCTP_BUF_NEXT(_m) = NULL; \
247 #define sctp_flight_size_decrease(tp1) do { \
248 if (tp1->whoTo->flight_size >= tp1->book_size) \
249 tp1->whoTo->flight_size -= tp1->book_size; \
251 tp1->whoTo->flight_size = 0; \
254 #define sctp_flight_size_increase(tp1) do { \
255 (tp1)->whoTo->flight_size += (tp1)->book_size; \
258 #ifdef SCTP_FS_SPEC_LOG
259 #define sctp_total_flight_decrease(stcb, tp1) do { \
260 if (stcb->asoc.fs_index > SCTP_FS_SPEC_LOG_SIZE) \
261 stcb->asoc.fs_index = 0;\
262 stcb->asoc.fslog[stcb->asoc.fs_index].total_flight = stcb->asoc.total_flight; \
263 stcb->asoc.fslog[stcb->asoc.fs_index].tsn = tp1->rec.data.TSN_seq; \
264 stcb->asoc.fslog[stcb->asoc.fs_index].book = tp1->book_size; \
265 stcb->asoc.fslog[stcb->asoc.fs_index].sent = tp1->sent; \
266 stcb->asoc.fslog[stcb->asoc.fs_index].incr = 0; \
267 stcb->asoc.fslog[stcb->asoc.fs_index].decr = 1; \
268 stcb->asoc.fs_index++; \
269 tp1->window_probe = 0; \
270 if (stcb->asoc.total_flight >= tp1->book_size) { \
271 stcb->asoc.total_flight -= tp1->book_size; \
272 if (stcb->asoc.total_flight_count > 0) \
273 stcb->asoc.total_flight_count--; \
275 stcb->asoc.total_flight = 0; \
276 stcb->asoc.total_flight_count = 0; \
280 #define sctp_total_flight_increase(stcb, tp1) do { \
281 if (stcb->asoc.fs_index > SCTP_FS_SPEC_LOG_SIZE) \
282 stcb->asoc.fs_index = 0;\
283 stcb->asoc.fslog[stcb->asoc.fs_index].total_flight = stcb->asoc.total_flight; \
284 stcb->asoc.fslog[stcb->asoc.fs_index].tsn = tp1->rec.data.TSN_seq; \
285 stcb->asoc.fslog[stcb->asoc.fs_index].book = tp1->book_size; \
286 stcb->asoc.fslog[stcb->asoc.fs_index].sent = tp1->sent; \
287 stcb->asoc.fslog[stcb->asoc.fs_index].incr = 1; \
288 stcb->asoc.fslog[stcb->asoc.fs_index].decr = 0; \
289 stcb->asoc.fs_index++; \
290 (stcb)->asoc.total_flight_count++; \
291 (stcb)->asoc.total_flight += (tp1)->book_size; \
296 #define sctp_total_flight_decrease(stcb, tp1) do { \
297 tp1->window_probe = 0; \
298 if (stcb->asoc.total_flight >= tp1->book_size) { \
299 stcb->asoc.total_flight -= tp1->book_size; \
300 if (stcb->asoc.total_flight_count > 0) \
301 stcb->asoc.total_flight_count--; \
303 stcb->asoc.total_flight = 0; \
304 stcb->asoc.total_flight_count = 0; \
308 #define sctp_total_flight_increase(stcb, tp1) do { \
309 (stcb)->asoc.total_flight_count++; \
310 (stcb)->asoc.total_flight += (tp1)->book_size; \
322 void sctp_close(struct socket *so);
323 int sctp_disconnect(struct socket *so);
325 void sctp_ctlinput __P((int, struct sockaddr *, void *));
326 int sctp_ctloutput __P((struct socket *, struct sockopt *));
329 void sctp_input_with_port __P((struct mbuf *, int, uint16_t));
333 void sctp_input __P((struct mbuf *, int));
336 void sctp_pathmtu_adjustment __P((struct sctp_inpcb *, struct sctp_tcb *, struct sctp_nets *, uint16_t));
337 void sctp_drain __P((void));
338 void sctp_init __P((void));
340 void sctp_finish(void);
342 int sctp_flush(struct socket *, int);
343 int sctp_shutdown __P((struct socket *));
345 __P((struct sctp_inpcb *, struct ip *ip, struct sctphdr *,
346 struct sockaddr *, struct sctp_tcb *,
347 struct sctp_nets *));
349 int sctp_bindx(struct socket *, int, struct sockaddr_storage *,
350 int, int, struct proc *);
352 /* can't use sctp_assoc_t here */
353 int sctp_peeloff(struct socket *, struct socket *, int, caddr_t, int *);
355 int sctp_ingetaddr(struct socket *,
359 int sctp_peeraddr(struct socket *,
363 int sctp_listen(struct socket *, int, struct thread *);
365 int sctp_accept(struct socket *, struct sockaddr **);
369 #endif /* !_NETINET_SCTP_VAR_H_ */