HAMMER 60I/Many: Mirroring
[dragonfly.git] / sys / netinet / sctputil.h
blobdb389fd79ca3a95f6d897ea8df59869328776750
1 /* $KAME: sctputil.h,v 1.14 2004/08/17 04:06:21 itojun Exp $ */
2 /* $DragonFly: src/sys/netinet/sctputil.h,v 1.6 2007/04/22 01:13:14 dillon Exp $ */
4 #ifndef _NETINET_SCTPUTIL_H_
5 #define _NETINET_SCTPUTIL_H_
7 /*
8 * Copyright (C) 2002, 2003, 2004 Cisco Systems Inc,
9 * All rights reserved.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 * 3. Neither the name of the project nor the names of its contributors
20 * may be used to endorse or promote products derived from this software
21 * without specific prior written permission.
23 * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 * SUCH DAMAGE.
36 #ifndef _SYS_TYPES_H_
37 #include <sys/types.h>
38 #endif
39 #ifndef _SYS_SOCKET_H_
40 #include <sys/socket.h>
41 #endif
43 #if defined(_KERNEL) || (defined(__APPLE__) && defined(KERNEL))
45 #ifdef SCTP_MBUF_DEBUG
46 #define sctp_m_freem(m) do { \
47 kprintf("m_freem(%p) m->nxtpkt:%p at %s[%d]\n", \
48 (m), (m)->m_next, __FILE__, __LINE__); \
49 m_freem(m); \
50 } while (0);
51 #else
52 #define sctp_m_freem m_freem
53 #endif
55 #ifdef __APPLE__
56 struct mbuf *sctp_m_copym(struct mbuf *m, int off, int len, int wait);
57 #else
58 #define sctp_m_copym m_copym
59 #endif /* __APPLE__ */
62 * Zone(pool) allocation routines: MUST be defined for each OS
63 * zone = zone/pool pointer
64 * name = string name of the zone/pool
65 * size = size of each zone/pool element
66 * number = number of elements in zone/pool
68 #if defined(__FreeBSD__) || defined(__DragonFly__)
69 #if __FreeBSD_version >= 500000
70 #include <vm/uma.h>
71 #else
72 #include <vm/vm_zone.h>
73 #endif
74 #elif defined(__NetBSD__) || defined(__OpenBSD__)
75 #include <sys/pool.h>
76 #endif
78 /* SCTP_ZONE_INIT: initialize the zone */
79 #if defined(__FreeBSD__) || defined(__DragonFly__)
80 #if __FreeBSD_version >= 500000
81 #define UMA_ZFLAG_FULL 0x0020
82 #define SCTP_ZONE_INIT(zone, name, size, number) { \
83 zone = uma_zcreate(name, size, NULL, NULL, NULL, NULL, UMA_ALIGN_PTR,\
84 UMA_ZFLAG_FULL); \
85 uma_zone_set_max(zone, number); \
87 #else
88 #define SCTP_ZONE_INIT(zone, name, size, number) \
89 zone = zinit(name, size, number, ZONE_INTERRUPT, 0);
90 #endif
91 #elif defined(__APPLE__)
92 #define SCTP_ZONE_INIT(zone, name, size, number) \
93 zone = (void *)zinit(size, number * size, number, name);
94 #elif defined(__OpenBSD__) || defined(__NetBSD__)
95 #define SCTP_ZONE_INIT(zone, name, size, number) \
96 pool_init(&(zone), size, 0, 0, 0, name, NULL);
97 #else
98 /* don't know this OS! */
99 force_comile_error;
100 #endif
102 /* SCTP_ZONE_GET: allocate element from the zone */
103 #if defined(__FreeBSD__)
104 #if __FreeBSD_version >= 500000
105 #define SCTP_ZONE_GET(zone) \
106 uma_zalloc(zone, M_NOWAIT);
107 #else
108 #define SCTP_ZONE_GET(zone) \
109 zalloci(zone);
110 #endif
111 #elif defined(__DragonFly__)
112 #define SCTP_ZONE_GET(zone) \
113 zalloc(zone);
114 #elif defined(__APPLE__)
115 #define SCTP_ZONE_GET(zone) \
116 zalloc(zone);
117 #elif defined(__NetBSD__) || defined(__OpenBSD__)
118 #define SCTP_ZONE_GET(zone) \
119 pool_get(&zone, PR_NOWAIT);
120 #else
121 /* don't know this OS! */
122 force_comile_error;
123 #endif
125 /* SCTP_ZONE_FREE: free element from the zone */
126 #if defined(__FreeBSD__)
127 #if __FreeBSD_version >= 500000
128 #define SCTP_ZONE_FREE(zone, element) \
129 uma_zfree(zone, element);
130 #else
131 #define SCTP_ZONE_FREE(zone, element) \
132 zfreei(zone, element);
133 #endif
134 #elif defined(__DragonFly__)
135 #define SCTP_ZONE_FREE(zone, element) \
136 zfree(zone, element);
137 #elif defined(__APPLE__)
138 #define SCTP_ZONE_FREE(zone, element) \
139 zfree(zone, element);
140 #elif defined(__NetBSD__) || defined(__OpenBSD__)
141 #define SCTP_ZONE_FREE(zone, element) \
142 pool_put(&zone, element);
143 #else
144 /* don't know this OS! */
145 force_comile_error;
146 #endif
148 #define sctp_get_associd(stcb) ((sctp_assoc_t)stcb->asoc.my_vtag)
151 * Function prototypes
154 struct mbuf;
155 struct ip;
156 struct sockbuf;
157 struct socket;
158 struct sockaddr_in6;
159 struct sctp_pcb;
160 struct sctp_tcb;
161 struct sctp_tmit_chunk;
162 struct sctpchunk_listhead;
163 struct sctphdr;
164 struct sctp_inpcb;
165 struct sctp_association;
166 struct sctp_nets;
168 struct ifaddr *sctp_find_ifa_by_addr(struct sockaddr *sa);
170 u_int32_t sctp_select_initial_TSN(struct sctp_pcb *);
172 u_int32_t sctp_select_a_tag(struct sctp_inpcb *);
174 int sctp_init_asoc(struct sctp_inpcb *, struct sctp_association *, int, uint32_t);
176 void sctp_fill_random_store(struct sctp_pcb *);
178 int sctp_timer_start(int, struct sctp_inpcb *, struct sctp_tcb *,
179 struct sctp_nets *);
181 int sctp_timer_stop(int, struct sctp_inpcb *, struct sctp_tcb *,
182 struct sctp_nets *);
184 u_int32_t sctp_calculate_sum(struct mbuf *, int32_t *, u_int32_t);
186 void sctp_mtu_size_reset(struct sctp_inpcb *, struct sctp_association *,
187 u_long);
189 int find_next_best_mtu(int);
191 u_int32_t sctp_calculate_rto(struct sctp_tcb *, struct sctp_association *,
192 struct sctp_nets *, struct timeval *);
194 u_int32_t sctp_calculate_len(struct mbuf *);
196 caddr_t sctp_m_getptr(struct mbuf *, int, int, u_int8_t *);
198 struct sctp_paramhdr *sctp_get_next_param(struct mbuf *, int,
199 struct sctp_paramhdr *, int);
201 int sctp_add_pad_tombuf(struct mbuf *, int);
203 int sctp_pad_lastmbuf(struct mbuf *, int);
205 void sctp_ulp_notify(u_int32_t, struct sctp_tcb *, u_int32_t, void *);
207 void sctp_report_all_outbound(struct sctp_tcb *);
209 int sctp_expand_mapping_array(struct sctp_association *);
211 void sctp_abort_notification(struct sctp_tcb *, int);
213 /* We abort responding to an IP packet for some reason */
214 void sctp_abort_association(struct sctp_inpcb *, struct sctp_tcb *,
215 struct mbuf *, int, struct sctphdr *, struct mbuf *);
217 /* We choose to abort via user input */
218 void sctp_abort_an_association(struct sctp_inpcb *, struct sctp_tcb *, int,
219 struct mbuf *);
221 void sctp_handle_ootb(struct mbuf *, int, int, struct sctphdr *,
222 struct sctp_inpcb *, struct mbuf *);
224 int sctp_is_there_an_abort_here(struct mbuf *, int, int *);
225 uint32_t sctp_is_same_scope(struct sockaddr_in6 *, struct sockaddr_in6 *);
226 struct sockaddr_in6 *sctp_recover_scope(struct sockaddr_in6 *,
227 struct sockaddr_in6 *);
229 int sctp_cmpaddr(struct sockaddr *, struct sockaddr *);
231 void sctp_print_address(struct sockaddr *);
232 void sctp_print_address_pkt(struct ip *, struct sctphdr *);
234 int sctp_sbappendaddr_nocheck(struct signalsockbuf *, struct sockaddr *,
235 struct mbuf *, struct mbuf *, u_int32_t, struct sctp_inpcb *);
238 int sctp_release_pr_sctp_chunk(struct sctp_tcb *, struct sctp_tmit_chunk *,
239 int, struct sctpchunk_listhead *);
241 struct mbuf *sctp_generate_invmanparam(int);
244 * this is an evil layer violation that I think is a hack.. but I stand
245 * alone on the tsvwg in this thought... everyone else considers it part
246 * of the sockets layer (along with all of the peeloff code :<)
248 u_int32_t sctp_get_first_vtag_from_sb(struct socket *);
251 void sctp_grub_through_socket_buffer(struct sctp_inpcb *, struct socket *,
252 struct socket *, struct sctp_tcb *);
254 void sctp_free_bufspace(struct sctp_tcb *, struct sctp_association *,
255 struct sctp_tmit_chunk *);
257 #ifdef SCTP_STAT_LOGGING
258 void sctp_log_strm_del_alt(u_int32_t, u_int16_t, int);
260 void sctp_log_strm_del(struct sctp_tmit_chunk *, struct sctp_tmit_chunk *, int);
261 void sctp_log_cwnd(struct sctp_nets *, int, uint8_t);
262 void sctp_log_maxburst(struct sctp_nets *, int, int, uint8_t);
263 void sctp_log_block(uint8_t, struct socket *, struct sctp_association *);
264 void sctp_log_rwnd(uint8_t, u_int32_t, u_int32_t, u_int32_t );
265 void sctp_log_mbcnt(uint8_t, u_int32_t, u_int32_t, u_int32_t, u_int32_t);
266 void sctp_log_rwnd_set(uint8_t, u_int32_t, u_int32_t, u_int32_t, u_int32_t);
267 int sctp_fill_stat_log(struct mbuf *);
268 void sctp_log_fr(uint32_t, uint32_t, uint32_t, int);
269 void sctp_log_map(uint32_t, uint32_t, uint32_t, int);
271 void sctp_clr_stat_log(void);
273 #endif
275 #ifdef SCTP_AUDITING_ENABLED
276 void sctp_auditing(int, struct sctp_inpcb *, struct sctp_tcb *,
277 struct sctp_nets *);
278 void sctp_audit_log(u_int8_t, u_int8_t);
280 #endif
282 #if defined(SCTP_BASE_FREEBSD) || defined(__DragonFly__)
283 /* Note: these are in <sys/time.h>, but not in kernel space */
284 #define timerclear(tvp) (tvp)->tv_sec = (tvp)->tv_usec = 0
285 #define timerisset(tvp) ((tvp)->tv_sec || (tvp)->tv_usec)
286 #define timercmp(tvp, uvp, cmp) \
287 (((tvp)->tv_sec == (uvp)->tv_sec) ? \
288 ((tvp)->tv_usec cmp (uvp)->tv_usec) : \
289 ((tvp)->tv_sec cmp (uvp)->tv_sec))
290 #define timeradd(tvp, uvp, vvp) \
291 do { \
292 (vvp)->tv_sec = (tvp)->tv_sec + (uvp)->tv_sec; \
293 (vvp)->tv_usec = (tvp)->tv_usec + (uvp)->tv_usec; \
294 if ((vvp)->tv_usec >= 1000000) { \
295 (vvp)->tv_sec++; \
296 (vvp)->tv_usec -= 1000000; \
298 } while (/* CONSTCOND */ 0)
299 #define timersub(tvp, uvp, vvp) \
300 do { \
301 (vvp)->tv_sec = (tvp)->tv_sec - (uvp)->tv_sec; \
302 (vvp)->tv_usec = (tvp)->tv_usec - (uvp)->tv_usec; \
303 if ((vvp)->tv_usec < 0) { \
304 (vvp)->tv_sec--; \
305 (vvp)->tv_usec += 1000000; \
307 } while (/* CONSTCOND */ 0)
308 #endif /* SCTP_BASE_FREEBSD */
310 #endif /* _KERNEL */
311 #endif