xref: /freebsd/sys/netinet/sctp_var.h (revision f7c4bd95ba735bd6a5454b4953945a99cefbb80c)
1 /*-
2  * Copyright (c) 2001-2007, by 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 /* $KAME: sctp_var.h,v 1.24 2005/03/06 16:04:19 itojun Exp $	 */
32 
33 #include <sys/cdefs.h>
34 __FBSDID("$FreeBSD$");
35 
36 #ifndef _NETINET_SCTP_VAR_H_
37 #define _NETINET_SCTP_VAR_H_
38 
39 #include <netinet/sctp_uio.h>
40 
41 #if defined(_KERNEL) || defined(__Userspace__)
42 
43 extern struct pr_usrreqs sctp_usrreqs;
44 
45 
46 #define sctp_feature_on(inp, feature)  (inp->sctp_features |= feature)
47 #define sctp_feature_off(inp, feature) (inp->sctp_features &= ~feature)
48 #define sctp_is_feature_on(inp, feature) ((inp->sctp_features & feature) == feature)
49 #define sctp_is_feature_off(inp, feature) ((inp->sctp_features & feature) == 0)
50 
51 
52 /* managing mobility_feature in inpcb (by micchie) */
53 #define sctp_mobility_feature_on(inp, feature)  (inp->sctp_mobility_features |= feature)
54 #define sctp_mobility_feature_off(inp, feature) (inp->sctp_mobility_features &= ~feature)
55 #define sctp_is_mobility_feature_on(inp, feature) (inp->sctp_mobility_features & feature)
56 #define sctp_is_mobility_feature_off(inp, feature) ((inp->sctp_mobility_features & feature) == 0)
57 
58 #define sctp_maxspace(sb) (max((sb)->sb_hiwat,SCTP_MINIMAL_RWND))
59 
60 #define	sctp_sbspace(asoc, sb) ((long) ((sctp_maxspace(sb) > (asoc)->sb_cc) ? (sctp_maxspace(sb) - (asoc)->sb_cc) : 0))
61 
62 #define	sctp_sbspace_failedmsgs(sb) ((long) ((sctp_maxspace(sb) > (sb)->sb_cc) ? (sctp_maxspace(sb) - (sb)->sb_cc) : 0))
63 
64 #define sctp_sbspace_sub(a,b) ((a > b) ? (a - b) : 0)
65 
66 /*
67  * I tried to cache the readq entries at one point. But the reality
68  * is that it did not add any performance since this meant we had to
69  * lock the STCB on read. And at that point once you have to do an
70  * extra lock, it really does not matter if the lock is in the ZONE
71  * stuff or in our code. Note that this same problem would occur with
72  * an mbuf cache as well so it is not really worth doing, at least
73  * right now :-D
74  */
75 
76 #define sctp_free_a_readq(_stcb, _readq) { \
77 	SCTP_ZONE_FREE(SCTP_BASE_INFO(ipi_zone_readq), (_readq)); \
78 	SCTP_DECR_READQ_COUNT(); \
79 }
80 
81 #define sctp_alloc_a_readq(_stcb, _readq) { \
82 	(_readq) = SCTP_ZONE_GET(SCTP_BASE_INFO(ipi_zone_readq), struct sctp_queued_to_read); \
83 	if ((_readq)) { \
84  	     SCTP_INCR_READQ_COUNT(); \
85 	} \
86 }
87 
88 #define sctp_free_a_strmoq(_stcb, _strmoq) { \
89 	SCTP_ZONE_FREE(SCTP_BASE_INFO(ipi_zone_strmoq), (_strmoq)); \
90 	SCTP_DECR_STRMOQ_COUNT(); \
91 }
92 
93 #define sctp_alloc_a_strmoq(_stcb, _strmoq) { \
94 	(_strmoq) = SCTP_ZONE_GET(SCTP_BASE_INFO(ipi_zone_strmoq), struct sctp_stream_queue_pending); \
95 	if ((_strmoq)) { \
96 		SCTP_INCR_STRMOQ_COUNT(); \
97  	} \
98 }
99 
100 
101 #define sctp_free_a_chunk(_stcb, _chk) { \
102         if(_stcb) { \
103           SCTP_TCB_LOCK_ASSERT((_stcb)); \
104           if ((_chk)->whoTo) { \
105                   sctp_free_remote_addr((_chk)->whoTo); \
106                   (_chk)->whoTo = NULL; \
107           } \
108           if (((_stcb)->asoc.free_chunk_cnt > SCTP_BASE_SYSCTL(sctp_asoc_free_resc_limit)) || \
109                (SCTP_BASE_INFO(ipi_free_chunks) > SCTP_BASE_SYSCTL(sctp_system_free_resc_limit))) { \
110 	 	SCTP_ZONE_FREE(SCTP_BASE_INFO(ipi_zone_chunk), (_chk)); \
111 	 	SCTP_DECR_CHK_COUNT(); \
112 	  } else { \
113 	 	TAILQ_INSERT_TAIL(&(_stcb)->asoc.free_chunks, (_chk), sctp_next); \
114 	 	(_stcb)->asoc.free_chunk_cnt++; \
115 	 	atomic_add_int(&SCTP_BASE_INFO(ipi_free_chunks), 1); \
116           } \
117         } else { \
118 		SCTP_ZONE_FREE(SCTP_BASE_INFO(ipi_zone_chunk), (_chk)); \
119 		SCTP_DECR_CHK_COUNT(); \
120 	} \
121 }
122 
123 #define sctp_alloc_a_chunk(_stcb, _chk) { \
124 	if (TAILQ_EMPTY(&(_stcb)->asoc.free_chunks))  { \
125 		(_chk) = SCTP_ZONE_GET(SCTP_BASE_INFO(ipi_zone_chunk), struct sctp_tmit_chunk); \
126 		if ((_chk)) { \
127 			SCTP_INCR_CHK_COUNT(); \
128                         (_chk)->whoTo = NULL; \
129 		} \
130 	} else { \
131 		(_chk) = TAILQ_FIRST(&(_stcb)->asoc.free_chunks); \
132 		TAILQ_REMOVE(&(_stcb)->asoc.free_chunks, (_chk), sctp_next); \
133 		atomic_subtract_int(&SCTP_BASE_INFO(ipi_free_chunks), 1); \
134                 SCTP_STAT_INCR(sctps_cached_chk); \
135 		(_stcb)->asoc.free_chunk_cnt--; \
136 	} \
137 }
138 
139 
140 
141 #define sctp_free_remote_addr(__net) { \
142 	if ((__net)) {  \
143 		if (atomic_fetchadd_int(&(__net)->ref_count, -1) == 1) { \
144 			(void)SCTP_OS_TIMER_STOP(&(__net)->rxt_timer.timer); \
145 			(void)SCTP_OS_TIMER_STOP(&(__net)->pmtu_timer.timer); \
146 			(void)SCTP_OS_TIMER_STOP(&(__net)->fr_timer.timer); \
147                         if ((__net)->ro.ro_rt) { \
148 				RTFREE((__net)->ro.ro_rt); \
149 				(__net)->ro.ro_rt = NULL; \
150                         } \
151 			if ((__net)->src_addr_selected) { \
152 				sctp_free_ifa((__net)->ro._s_addr); \
153 				(__net)->ro._s_addr = NULL; \
154 			} \
155                         (__net)->src_addr_selected = 0; \
156 			(__net)->dest_state = SCTP_ADDR_NOT_REACHABLE; \
157 			SCTP_ZONE_FREE(SCTP_BASE_INFO(ipi_zone_net), (__net)); \
158 			SCTP_DECR_RADDR_COUNT(); \
159 		} \
160 	} \
161 }
162 
163 #define sctp_sbfree(ctl, stcb, sb, m) { \
164 	uint32_t val; \
165 	val = atomic_fetchadd_int(&(sb)->sb_cc,-(SCTP_BUF_LEN((m)))); \
166 	if (val < SCTP_BUF_LEN((m))) { \
167 	   panic("sb_cc goes negative"); \
168 	} \
169 	val = atomic_fetchadd_int(&(sb)->sb_mbcnt,-(MSIZE)); \
170 	if (val < MSIZE) { \
171 	    panic("sb_mbcnt goes negative"); \
172 	} \
173 	if (((ctl)->do_not_ref_stcb == 0) && stcb) {\
174 	  val = atomic_fetchadd_int(&(stcb)->asoc.sb_cc,-(SCTP_BUF_LEN((m)))); \
175 	  if (val < SCTP_BUF_LEN((m))) {\
176 	     panic("stcb->sb_cc goes negative"); \
177 	  } \
178 	  val = atomic_fetchadd_int(&(stcb)->asoc.my_rwnd_control_len,-(MSIZE)); \
179 	  if (val < MSIZE) { \
180 	     panic("asoc->mbcnt goes negative"); \
181 	  } \
182 	} \
183 	if (SCTP_BUF_TYPE(m) != MT_DATA && SCTP_BUF_TYPE(m) != MT_HEADER && \
184 	    SCTP_BUF_TYPE(m) != MT_OOBDATA) \
185 		atomic_subtract_int(&(sb)->sb_ctl,SCTP_BUF_LEN((m))); \
186 }
187 
188 
189 #define sctp_sballoc(stcb, sb, m) { \
190 	atomic_add_int(&(sb)->sb_cc,SCTP_BUF_LEN((m))); \
191 	atomic_add_int(&(sb)->sb_mbcnt, MSIZE); \
192 	if (stcb) { \
193 		atomic_add_int(&(stcb)->asoc.sb_cc,SCTP_BUF_LEN((m))); \
194 		atomic_add_int(&(stcb)->asoc.my_rwnd_control_len, MSIZE); \
195 	} \
196 	if (SCTP_BUF_TYPE(m) != MT_DATA && SCTP_BUF_TYPE(m) != MT_HEADER && \
197 	    SCTP_BUF_TYPE(m) != MT_OOBDATA) \
198 		atomic_add_int(&(sb)->sb_ctl,SCTP_BUF_LEN((m))); \
199 }
200 
201 
202 #define sctp_ucount_incr(val) { \
203 	val++; \
204 }
205 
206 #define sctp_ucount_decr(val) { \
207 	if (val > 0) { \
208 		val--; \
209 	} else { \
210 		val = 0; \
211 	} \
212 }
213 
214 #define sctp_mbuf_crush(data) do { \
215 	struct mbuf *_m; \
216 	_m = (data); \
217 	while(_m && (SCTP_BUF_LEN(_m) == 0)) { \
218 		(data)  = SCTP_BUF_NEXT(_m); \
219 		SCTP_BUF_NEXT(_m) = NULL; \
220 		sctp_m_free(_m); \
221 		_m = (data); \
222 	} \
223 } while (0)
224 
225 #define sctp_flight_size_decrease(tp1) do { \
226 	if (tp1->whoTo->flight_size >= tp1->book_size) \
227 		tp1->whoTo->flight_size -= tp1->book_size; \
228 	else \
229 		tp1->whoTo->flight_size = 0; \
230 } while (0)
231 
232 #define sctp_flight_size_increase(tp1) do { \
233        (tp1)->whoTo->flight_size += (tp1)->book_size; \
234 } while (0)
235 
236 #ifdef SCTP_FS_SPEC_LOG
237 #define sctp_total_flight_decrease(stcb, tp1) do { \
238         if(stcb->asoc.fs_index > SCTP_FS_SPEC_LOG_SIZE) \
239 		stcb->asoc.fs_index = 0;\
240 	stcb->asoc.fslog[stcb->asoc.fs_index].total_flight = stcb->asoc.total_flight; \
241 	stcb->asoc.fslog[stcb->asoc.fs_index].tsn = tp1->rec.data.TSN_seq; \
242 	stcb->asoc.fslog[stcb->asoc.fs_index].book = tp1->book_size; \
243 	stcb->asoc.fslog[stcb->asoc.fs_index].sent = tp1->sent; \
244 	stcb->asoc.fslog[stcb->asoc.fs_index].incr = 0; \
245 	stcb->asoc.fslog[stcb->asoc.fs_index].decr = 1; \
246 	stcb->asoc.fs_index++; \
247         tp1->window_probe = 0; \
248 	if (stcb->asoc.total_flight >= tp1->book_size) { \
249 		stcb->asoc.total_flight -= tp1->book_size; \
250 		if (stcb->asoc.total_flight_count > 0) \
251 			stcb->asoc.total_flight_count--; \
252 	} else { \
253 		stcb->asoc.total_flight = 0; \
254 		stcb->asoc.total_flight_count = 0; \
255 	} \
256 } while (0)
257 
258 #define sctp_total_flight_increase(stcb, tp1) do { \
259         if(stcb->asoc.fs_index > SCTP_FS_SPEC_LOG_SIZE) \
260 		stcb->asoc.fs_index = 0;\
261 	stcb->asoc.fslog[stcb->asoc.fs_index].total_flight = stcb->asoc.total_flight; \
262 	stcb->asoc.fslog[stcb->asoc.fs_index].tsn = tp1->rec.data.TSN_seq; \
263 	stcb->asoc.fslog[stcb->asoc.fs_index].book = tp1->book_size; \
264 	stcb->asoc.fslog[stcb->asoc.fs_index].sent = tp1->sent; \
265 	stcb->asoc.fslog[stcb->asoc.fs_index].incr = 1; \
266 	stcb->asoc.fslog[stcb->asoc.fs_index].decr = 0; \
267 	stcb->asoc.fs_index++; \
268        (stcb)->asoc.total_flight_count++; \
269        (stcb)->asoc.total_flight += (tp1)->book_size; \
270 } while (0)
271 
272 #else
273 
274 #define sctp_total_flight_decrease(stcb, tp1) do { \
275 	if (stcb->asoc.total_flight >= tp1->book_size) { \
276 		stcb->asoc.total_flight -= tp1->book_size; \
277 		if (stcb->asoc.total_flight_count > 0) \
278 			stcb->asoc.total_flight_count--; \
279 	} else { \
280 		stcb->asoc.total_flight = 0; \
281 		stcb->asoc.total_flight_count = 0; \
282 	} \
283 } while (0)
284 
285 #define sctp_total_flight_increase(stcb, tp1) do { \
286        (stcb)->asoc.total_flight_count++; \
287        (stcb)->asoc.total_flight += (tp1)->book_size; \
288 } while (0)
289 
290 #endif
291 
292 
293 struct sctp_nets;
294 struct sctp_inpcb;
295 struct sctp_tcb;
296 struct sctphdr;
297 
298 
299 void sctp_close(struct socket *so);
300 int sctp_disconnect(struct socket *so);
301 
302 void sctp_ctlinput __P((int, struct sockaddr *, void *));
303 int sctp_ctloutput __P((struct socket *, struct sockopt *));
304 void sctp_input_with_port __P((struct mbuf *, int, uint16_t));
305 void sctp_input __P((struct mbuf *, int));
306 void sctp_pathmtu_adjustment __P((struct sctp_inpcb *, struct sctp_tcb *, struct sctp_nets *, uint16_t));
307 void sctp_drain __P((void));
308 void sctp_init __P((void));
309 
310 void sctp_finish(void);
311 
312 int sctp_flush(struct socket *, int);
313 int sctp_shutdown __P((struct socket *));
314 void sctp_notify
315 __P((struct sctp_inpcb *, struct ip *ip, struct sctphdr *,
316     struct sockaddr *, struct sctp_tcb *,
317     struct sctp_nets *));
318 
319 	int sctp_bindx(struct socket *, int, struct sockaddr_storage *,
320         int, int, struct proc *);
321 
322 /* can't use sctp_assoc_t here */
323 	int sctp_peeloff(struct socket *, struct socket *, int, caddr_t, int *);
324 
325 	int sctp_ingetaddr(struct socket *,
326         struct sockaddr **
327 );
328 
329 	int sctp_peeraddr(struct socket *,
330         struct sockaddr **
331 );
332 
333 	int sctp_listen(struct socket *, int, struct thread *);
334 
335 	int sctp_accept(struct socket *, struct sockaddr **);
336 
337 #endif				/* _KERNEL */
338 
339 #endif				/* !_NETINET_SCTP_VAR_H_ */
340