|
1 /*- |
|
2 * Copyright (c) 2001-2007, by Cisco Systems, Inc. All rights reserved. |
|
3 * Copyright (c) 2008-2012, by Randall Stewart. All rights reserved. |
|
4 * Copyright (c) 2008-2012, by Michael Tuexen. All rights reserved. |
|
5 * |
|
6 * Redistribution and use in source and binary forms, with or without |
|
7 * modification, are permitted provided that the following conditions are met: |
|
8 * |
|
9 * a) Redistributions of source code must retain the above copyright notice, |
|
10 * this list of conditions and the following disclaimer. |
|
11 * |
|
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. |
|
15 * |
|
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. |
|
19 * |
|
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. |
|
31 */ |
|
32 |
|
33 #ifdef __FreeBSD__ |
|
34 #include <sys/cdefs.h> |
|
35 __FBSDID("$FreeBSD: head/sys/netinet/sctputil.h 243186 2012-11-17 20:04:04Z tuexen $"); |
|
36 #endif |
|
37 |
|
38 #ifndef _NETINET_SCTP_UTIL_H_ |
|
39 #define _NETINET_SCTP_UTIL_H_ |
|
40 |
|
41 #if defined(_KERNEL) || defined(__Userspace__) |
|
42 |
|
43 #define SCTP_READ_LOCK_HELD 1 |
|
44 #define SCTP_READ_LOCK_NOT_HELD 0 |
|
45 |
|
46 #ifdef SCTP_ASOCLOG_OF_TSNS |
|
47 void sctp_print_out_track_log(struct sctp_tcb *stcb); |
|
48 #endif |
|
49 |
|
50 #ifdef SCTP_MBUF_LOGGING |
|
51 struct mbuf *sctp_m_free(struct mbuf *m); |
|
52 void sctp_m_freem(struct mbuf *m); |
|
53 #else |
|
54 #define sctp_m_free m_free |
|
55 #define sctp_m_freem m_freem |
|
56 #endif |
|
57 |
|
58 #if defined(SCTP_LOCAL_TRACE_BUF) || defined(__APPLE__) |
|
59 void |
|
60 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); |
|
61 #endif |
|
62 |
|
63 #define sctp_get_associd(stcb) ((sctp_assoc_t)stcb->asoc.assoc_id) |
|
64 |
|
65 |
|
66 /* |
|
67 * Function prototypes |
|
68 */ |
|
69 uint32_t |
|
70 sctp_get_ifa_hash_val(struct sockaddr *addr); |
|
71 |
|
72 struct sctp_ifa * |
|
73 sctp_find_ifa_in_ep(struct sctp_inpcb *inp, struct sockaddr *addr, int hold_lock); |
|
74 |
|
75 struct sctp_ifa * |
|
76 sctp_find_ifa_by_addr(struct sockaddr *addr, uint32_t vrf_id, int holds_lock); |
|
77 |
|
78 uint32_t sctp_select_initial_TSN(struct sctp_pcb *); |
|
79 |
|
80 uint32_t sctp_select_a_tag(struct sctp_inpcb *, uint16_t lport, uint16_t rport, int); |
|
81 |
|
82 int sctp_init_asoc(struct sctp_inpcb *, struct sctp_tcb *, uint32_t, uint32_t); |
|
83 |
|
84 void sctp_fill_random_store(struct sctp_pcb *); |
|
85 |
|
86 void |
|
87 sctp_notify_stream_reset_add(struct sctp_tcb *stcb, uint16_t numberin, |
|
88 uint16_t numberout, int flag); |
|
89 void |
|
90 sctp_notify_stream_reset_tsn(struct sctp_tcb *stcb, uint32_t sending_tsn, uint32_t recv_tsn, int flag); |
|
91 |
|
92 void |
|
93 sctp_timer_start(int, struct sctp_inpcb *, struct sctp_tcb *, |
|
94 struct sctp_nets *); |
|
95 |
|
96 void |
|
97 sctp_timer_stop(int, struct sctp_inpcb *, struct sctp_tcb *, |
|
98 struct sctp_nets *, uint32_t); |
|
99 |
|
100 int |
|
101 sctp_dynamic_set_primary(struct sockaddr *sa, uint32_t vrf_id); |
|
102 |
|
103 void |
|
104 sctp_mtu_size_reset(struct sctp_inpcb *, struct sctp_association *, uint32_t); |
|
105 |
|
106 void |
|
107 sctp_add_to_readq(struct sctp_inpcb *inp, |
|
108 struct sctp_tcb *stcb, |
|
109 struct sctp_queued_to_read *control, |
|
110 struct sockbuf *sb, |
|
111 int end, |
|
112 int inpread_locked, |
|
113 int so_locked |
|
114 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) |
|
115 SCTP_UNUSED |
|
116 #endif |
|
117 ); |
|
118 |
|
119 int |
|
120 sctp_append_to_readq(struct sctp_inpcb *inp, |
|
121 struct sctp_tcb *stcb, |
|
122 struct sctp_queued_to_read *control, |
|
123 struct mbuf *m, |
|
124 int end, |
|
125 int new_cumack, |
|
126 struct sockbuf *sb); |
|
127 |
|
128 |
|
129 void sctp_iterator_worker(void); |
|
130 |
|
131 uint32_t sctp_get_prev_mtu(uint32_t); |
|
132 uint32_t sctp_get_next_mtu(uint32_t); |
|
133 |
|
134 void |
|
135 sctp_timeout_handler(void *); |
|
136 |
|
137 uint32_t |
|
138 sctp_calculate_rto(struct sctp_tcb *, struct sctp_association *, |
|
139 struct sctp_nets *, struct timeval *, int, int); |
|
140 |
|
141 uint32_t sctp_calculate_len(struct mbuf *); |
|
142 |
|
143 caddr_t sctp_m_getptr(struct mbuf *, int, int, uint8_t *); |
|
144 |
|
145 struct sctp_paramhdr * |
|
146 sctp_get_next_param(struct mbuf *, int, |
|
147 struct sctp_paramhdr *, int); |
|
148 |
|
149 int sctp_add_pad_tombuf(struct mbuf *, int); |
|
150 |
|
151 int sctp_pad_lastmbuf(struct mbuf *, int, struct mbuf *); |
|
152 |
|
153 void sctp_ulp_notify(uint32_t, struct sctp_tcb *, uint32_t, void *, int |
|
154 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) |
|
155 SCTP_UNUSED |
|
156 #endif |
|
157 ); |
|
158 |
|
159 void |
|
160 sctp_pull_off_control_to_new_inp(struct sctp_inpcb *old_inp, |
|
161 struct sctp_inpcb *new_inp, |
|
162 struct sctp_tcb *stcb, int waitflags); |
|
163 |
|
164 |
|
165 void sctp_stop_timers_for_shutdown(struct sctp_tcb *); |
|
166 |
|
167 void sctp_report_all_outbound(struct sctp_tcb *, uint16_t, int, int |
|
168 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) |
|
169 SCTP_UNUSED |
|
170 #endif |
|
171 ); |
|
172 |
|
173 int sctp_expand_mapping_array(struct sctp_association *, uint32_t); |
|
174 |
|
175 void sctp_abort_notification(struct sctp_tcb *, uint8_t, uint16_t, |
|
176 struct sctp_abort_chunk *, int |
|
177 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) |
|
178 SCTP_UNUSED |
|
179 #endif |
|
180 ); |
|
181 |
|
182 /* We abort responding to an IP packet for some reason */ |
|
183 void |
|
184 sctp_abort_association(struct sctp_inpcb *, struct sctp_tcb *, struct mbuf *, |
|
185 int, struct sockaddr *, struct sockaddr *, |
|
186 struct sctphdr *, struct mbuf *, |
|
187 #if defined(__FreeBSD__) |
|
188 uint8_t, uint32_t, |
|
189 #endif |
|
190 uint32_t, uint16_t); |
|
191 |
|
192 |
|
193 /* We choose to abort via user input */ |
|
194 void |
|
195 sctp_abort_an_association(struct sctp_inpcb *, struct sctp_tcb *, |
|
196 struct mbuf *, int |
|
197 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) |
|
198 SCTP_UNUSED |
|
199 #endif |
|
200 ); |
|
201 |
|
202 void sctp_handle_ootb(struct mbuf *, int, int, |
|
203 struct sockaddr *, struct sockaddr *, |
|
204 struct sctphdr *, struct sctp_inpcb *, |
|
205 #if defined(__FreeBSD__) |
|
206 uint8_t, uint32_t, |
|
207 #endif |
|
208 uint32_t, uint16_t); |
|
209 |
|
210 int sctp_connectx_helper_add(struct sctp_tcb *stcb, struct sockaddr *addr, |
|
211 int totaddr, int *error); |
|
212 |
|
213 struct sctp_tcb * |
|
214 sctp_connectx_helper_find(struct sctp_inpcb *inp, struct sockaddr *addr, |
|
215 int *totaddr, int *num_v4, int *num_v6, int *error, int limit, int *bad_addr); |
|
216 |
|
217 int sctp_is_there_an_abort_here(struct mbuf *, int, uint32_t *); |
|
218 #ifdef INET6 |
|
219 uint32_t sctp_is_same_scope(struct sockaddr_in6 *, struct sockaddr_in6 *); |
|
220 |
|
221 #if defined(SCTP_EMBEDDED_V6_SCOPE) |
|
222 struct sockaddr_in6 * |
|
223 sctp_recover_scope(struct sockaddr_in6 *, struct sockaddr_in6 *); |
|
224 |
|
225 #ifdef SCTP_KAME |
|
226 #define sctp_recover_scope_mac(addr, store) do { \ |
|
227 if ((addr->sin6_family == AF_INET6) && \ |
|
228 (IN6_IS_SCOPE_LINKLOCAL(&addr->sin6_addr))) { \ |
|
229 *store = *addr; \ |
|
230 if (addr->sin6_scope_id == 0) { \ |
|
231 if (!sa6_recoverscope(store)) { \ |
|
232 addr = store; \ |
|
233 } \ |
|
234 } else { \ |
|
235 in6_clearscope(&addr->sin6_addr); \ |
|
236 addr = store; \ |
|
237 } \ |
|
238 } \ |
|
239 } while (0) |
|
240 #else |
|
241 #define sctp_recover_scope_mac(addr, store) do { \ |
|
242 if ((addr->sin6_family == AF_INET6) && \ |
|
243 (IN6_IS_SCOPE_LINKLOCAL(&addr->sin6_addr))) { \ |
|
244 *store = *addr; \ |
|
245 if (addr->sin6_scope_id == 0) { \ |
|
246 if (!in6_recoverscope(store, &store->sin6_addr, \ |
|
247 NULL)) { \ |
|
248 addr = store; \ |
|
249 } \ |
|
250 } else { \ |
|
251 in6_clearscope(&addr->sin6_addr); \ |
|
252 addr = store; \ |
|
253 } \ |
|
254 } \ |
|
255 } while (0) |
|
256 #endif |
|
257 #endif |
|
258 #endif |
|
259 |
|
260 int sctp_cmpaddr(struct sockaddr *, struct sockaddr *); |
|
261 |
|
262 void sctp_print_address(struct sockaddr *); |
|
263 |
|
264 int |
|
265 sctp_release_pr_sctp_chunk(struct sctp_tcb *, struct sctp_tmit_chunk *, |
|
266 uint8_t, int |
|
267 #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING) |
|
268 SCTP_UNUSED |
|
269 #endif |
|
270 ); |
|
271 |
|
272 struct mbuf *sctp_generate_invmanparam(int); |
|
273 |
|
274 void sctp_bindx_add_address(struct socket *so, struct sctp_inpcb *inp, |
|
275 struct sockaddr *sa, sctp_assoc_t assoc_id, |
|
276 uint32_t vrf_id, int *error, void *p); |
|
277 void sctp_bindx_delete_address(struct sctp_inpcb *inp, |
|
278 struct sockaddr *sa, sctp_assoc_t assoc_id, |
|
279 uint32_t vrf_id, int *error); |
|
280 |
|
281 int sctp_local_addr_count(struct sctp_tcb *stcb); |
|
282 |
|
283 #ifdef SCTP_MBCNT_LOGGING |
|
284 void |
|
285 sctp_free_bufspace(struct sctp_tcb *, struct sctp_association *, |
|
286 struct sctp_tmit_chunk *, int); |
|
287 |
|
288 #else |
|
289 #define sctp_free_bufspace(stcb, asoc, tp1, chk_cnt) \ |
|
290 do { \ |
|
291 if (tp1->data != NULL) { \ |
|
292 atomic_subtract_int(&((asoc)->chunks_on_out_queue), chk_cnt); \ |
|
293 if ((asoc)->total_output_queue_size >= tp1->book_size) { \ |
|
294 atomic_subtract_int(&((asoc)->total_output_queue_size), tp1->book_size); \ |
|
295 } else { \ |
|
296 (asoc)->total_output_queue_size = 0; \ |
|
297 } \ |
|
298 if (stcb->sctp_socket && ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \ |
|
299 (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \ |
|
300 if (stcb->sctp_socket->so_snd.sb_cc >= tp1->book_size) { \ |
|
301 atomic_subtract_int(&((stcb)->sctp_socket->so_snd.sb_cc), tp1->book_size); \ |
|
302 } else { \ |
|
303 stcb->sctp_socket->so_snd.sb_cc = 0; \ |
|
304 } \ |
|
305 } \ |
|
306 } \ |
|
307 } while (0) |
|
308 |
|
309 #endif |
|
310 |
|
311 #define sctp_free_spbufspace(stcb, asoc, sp) \ |
|
312 do { \ |
|
313 if (sp->data != NULL) { \ |
|
314 if ((asoc)->total_output_queue_size >= sp->length) { \ |
|
315 atomic_subtract_int(&(asoc)->total_output_queue_size, sp->length); \ |
|
316 } else { \ |
|
317 (asoc)->total_output_queue_size = 0; \ |
|
318 } \ |
|
319 if (stcb->sctp_socket && ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \ |
|
320 (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \ |
|
321 if (stcb->sctp_socket->so_snd.sb_cc >= sp->length) { \ |
|
322 atomic_subtract_int(&stcb->sctp_socket->so_snd.sb_cc,sp->length); \ |
|
323 } else { \ |
|
324 stcb->sctp_socket->so_snd.sb_cc = 0; \ |
|
325 } \ |
|
326 } \ |
|
327 } \ |
|
328 } while (0) |
|
329 |
|
330 #define sctp_snd_sb_alloc(stcb, sz) \ |
|
331 do { \ |
|
332 atomic_add_int(&stcb->asoc.total_output_queue_size,sz); \ |
|
333 if ((stcb->sctp_socket != NULL) && \ |
|
334 ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \ |
|
335 (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \ |
|
336 atomic_add_int(&stcb->sctp_socket->so_snd.sb_cc,sz); \ |
|
337 } \ |
|
338 } while (0) |
|
339 |
|
340 /* functions to start/stop udp tunneling */ |
|
341 #if defined(__APPLE__) || defined(__FreeBSD__) |
|
342 void sctp_over_udp_stop(void); |
|
343 int sctp_over_udp_start(void); |
|
344 #endif |
|
345 #if defined(__Windows__) |
|
346 void sctp_over_udp_restart(void); |
|
347 #endif |
|
348 |
|
349 int |
|
350 sctp_soreceive(struct socket *so, struct sockaddr **psa, |
|
351 struct uio *uio, |
|
352 struct mbuf **mp0, |
|
353 struct mbuf **controlp, |
|
354 int *flagsp); |
|
355 |
|
356 void |
|
357 sctp_misc_ints(uint8_t from, uint32_t a, uint32_t b, uint32_t c, uint32_t d); |
|
358 |
|
359 void |
|
360 sctp_wakeup_log(struct sctp_tcb *stcb, |
|
361 uint32_t wake_cnt, int from); |
|
362 |
|
363 void sctp_log_strm_del_alt(struct sctp_tcb *stcb, uint32_t, uint16_t, uint16_t, int); |
|
364 |
|
365 void sctp_log_nagle_event(struct sctp_tcb *stcb, int action); |
|
366 |
|
367 |
|
368 void |
|
369 sctp_log_mb(struct mbuf *m, int from); |
|
370 |
|
371 void |
|
372 sctp_sblog(struct sockbuf *sb, |
|
373 struct sctp_tcb *stcb, int from, int incr); |
|
374 |
|
375 void |
|
376 sctp_log_strm_del(struct sctp_queued_to_read *control, |
|
377 struct sctp_queued_to_read *poschk, |
|
378 int from); |
|
379 void sctp_log_cwnd(struct sctp_tcb *stcb, struct sctp_nets *, int, uint8_t); |
|
380 void rto_logging(struct sctp_nets *net, int from); |
|
381 |
|
382 void sctp_log_closing(struct sctp_inpcb *inp, struct sctp_tcb *stcb, int16_t loc); |
|
383 |
|
384 void sctp_log_lock(struct sctp_inpcb *inp, struct sctp_tcb *stcb, uint8_t from); |
|
385 void sctp_log_maxburst(struct sctp_tcb *stcb, struct sctp_nets *, int, int, uint8_t); |
|
386 void sctp_log_block(uint8_t, struct sctp_association *, int); |
|
387 void sctp_log_rwnd(uint8_t, uint32_t, uint32_t, uint32_t); |
|
388 void sctp_log_mbcnt(uint8_t, uint32_t, uint32_t, uint32_t, uint32_t); |
|
389 void sctp_log_rwnd_set(uint8_t, uint32_t, uint32_t, uint32_t, uint32_t); |
|
390 int sctp_fill_stat_log(void *, size_t *); |
|
391 void sctp_log_fr(uint32_t, uint32_t, uint32_t, int); |
|
392 void sctp_log_sack(uint32_t, uint32_t, uint32_t, uint16_t, uint16_t, int); |
|
393 void sctp_log_map(uint32_t, uint32_t, uint32_t, int); |
|
394 void sctp_print_mapping_array(struct sctp_association *asoc); |
|
395 void sctp_clr_stat_log(void); |
|
396 |
|
397 |
|
398 #ifdef SCTP_AUDITING_ENABLED |
|
399 void |
|
400 sctp_auditing(int, struct sctp_inpcb *, struct sctp_tcb *, |
|
401 struct sctp_nets *); |
|
402 void sctp_audit_log(uint8_t, uint8_t); |
|
403 |
|
404 #endif |
|
405 #endif /* _KERNEL */ |
|
406 #endif |