1 /* $KAME: sctputil.h,v 1.14 2004/08/17 04:06:21 itojun Exp $ */
2 /* $DragonFly: src/sys/netinet/sctputil.h,v 1.3 2006/01/14 11:33:50 swildner Exp $ */
8 * Copyright (C) 2002, 2003, 2004 Cisco Systems Inc,
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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
36 #if defined(_KERNEL) || (defined(__APPLE__) && defined(KERNEL))
38 #ifdef SCTP_MBUF_DEBUG
39 #define sctp_m_freem(m) do { \
40 printf("m_freem(%p) m->nxtpkt:%p at %s[%d]\n", \
41 (m), (m)->m_next, __FILE__, __LINE__); \
45 #define sctp_m_freem m_freem
49 struct mbuf *sctp_m_copym(struct mbuf *m, int off, int len, int wait);
51 #define sctp_m_copym m_copym
52 #endif /* __APPLE__ */
55 * Zone(pool) allocation routines: MUST be defined for each OS
56 * zone = zone/pool pointer
57 * name = string name of the zone/pool
58 * size = size of each zone/pool element
59 * number = number of elements in zone/pool
61 #if defined(__FreeBSD__) || defined(__DragonFly__)
62 #if __FreeBSD_version >= 500000
65 #include <vm/vm_zone.h>
67 #elif defined(__NetBSD__) || defined(__OpenBSD__)
71 /* SCTP_ZONE_INIT: initialize the zone */
72 #if defined(__FreeBSD__) || defined(__DragonFly__)
73 #if __FreeBSD_version >= 500000
74 #define UMA_ZFLAG_FULL 0x0020
75 #define SCTP_ZONE_INIT(zone, name, size, number) { \
76 zone = uma_zcreate(name, size, NULL, NULL, NULL, NULL, UMA_ALIGN_PTR,\
78 uma_zone_set_max(zone, number); \
81 #define SCTP_ZONE_INIT(zone, name, size, number) \
82 zone = zinit(name, size, number, ZONE_INTERRUPT, 0);
84 #elif defined(__APPLE__)
85 #define SCTP_ZONE_INIT(zone, name, size, number) \
86 zone = (void *)zinit(size, number * size, number, name);
87 #elif defined(__OpenBSD__) || defined(__NetBSD__)
88 #define SCTP_ZONE_INIT(zone, name, size, number) \
89 pool_init(&(zone), size, 0, 0, 0, name, NULL);
91 /* don't know this OS! */
95 /* SCTP_ZONE_GET: allocate element from the zone */
96 #if defined(__FreeBSD__)
97 #if __FreeBSD_version >= 500000
98 #define SCTP_ZONE_GET(zone) \
99 uma_zalloc(zone, M_NOWAIT);
101 #define SCTP_ZONE_GET(zone) \
104 #elif defined(__DragonFly__)
105 #define SCTP_ZONE_GET(zone) \
107 #elif defined(__APPLE__)
108 #define SCTP_ZONE_GET(zone) \
110 #elif defined(__NetBSD__) || defined(__OpenBSD__)
111 #define SCTP_ZONE_GET(zone) \
112 pool_get(&zone, PR_NOWAIT);
114 /* don't know this OS! */
118 /* SCTP_ZONE_FREE: free element from the zone */
119 #if defined(__FreeBSD__)
120 #if __FreeBSD_version >= 500000
121 #define SCTP_ZONE_FREE(zone, element) \
122 uma_zfree(zone, element);
124 #define SCTP_ZONE_FREE(zone, element) \
125 zfreei(zone, element);
127 #elif defined(__DragonFly__)
128 #define SCTP_ZONE_FREE(zone, element) \
129 zfree(zone, element);
130 #elif defined(__APPLE__)
131 #define SCTP_ZONE_FREE(zone, element) \
132 zfree(zone, element);
133 #elif defined(__NetBSD__) || defined(__OpenBSD__)
134 #define SCTP_ZONE_FREE(zone, element) \
135 pool_put(&zone, element);
137 /* don't know this OS! */
141 #define sctp_get_associd(stcb) ((sctp_assoc_t)stcb->asoc.my_vtag)
144 * Function prototypes
146 struct ifaddr *sctp_find_ifa_by_addr(struct sockaddr *sa);
148 u_int32_t sctp_select_initial_TSN(struct sctp_pcb *);
150 u_int32_t sctp_select_a_tag(struct sctp_inpcb *);
152 int sctp_init_asoc(struct sctp_inpcb *, struct sctp_association *, int, uint32_t);
154 void sctp_fill_random_store(struct sctp_pcb *);
156 int sctp_timer_start(int, struct sctp_inpcb *, struct sctp_tcb *,
159 int sctp_timer_stop(int, struct sctp_inpcb *, struct sctp_tcb *,
162 u_int32_t sctp_calculate_sum(struct mbuf *, int32_t *, u_int32_t);
164 void sctp_mtu_size_reset(struct sctp_inpcb *, struct sctp_association *,
167 int find_next_best_mtu(int);
169 u_int32_t sctp_calculate_rto(struct sctp_tcb *, struct sctp_association *,
170 struct sctp_nets *, struct timeval *);
172 u_int32_t sctp_calculate_len(struct mbuf *);
174 caddr_t sctp_m_getptr(struct mbuf *, int, int, u_int8_t *);
176 struct sctp_paramhdr *sctp_get_next_param(struct mbuf *, int,
177 struct sctp_paramhdr *, int);
179 int sctp_add_pad_tombuf(struct mbuf *, int);
181 int sctp_pad_lastmbuf(struct mbuf *, int);
183 void sctp_ulp_notify(u_int32_t, struct sctp_tcb *, u_int32_t, void *);
185 void sctp_report_all_outbound(struct sctp_tcb *);
187 int sctp_expand_mapping_array(struct sctp_association *);
189 void sctp_abort_notification(struct sctp_tcb *, int);
191 /* We abort responding to an IP packet for some reason */
192 void sctp_abort_association(struct sctp_inpcb *, struct sctp_tcb *,
193 struct mbuf *, int, struct sctphdr *, struct mbuf *);
195 /* We choose to abort via user input */
196 void sctp_abort_an_association(struct sctp_inpcb *, struct sctp_tcb *, int,
199 void sctp_handle_ootb(struct mbuf *, int, int, struct sctphdr *,
200 struct sctp_inpcb *, struct mbuf *);
202 int sctp_is_there_an_abort_here(struct mbuf *, int, int *);
203 uint32_t sctp_is_same_scope(struct sockaddr_in6 *, struct sockaddr_in6 *);
204 struct sockaddr_in6 *sctp_recover_scope(struct sockaddr_in6 *,
205 struct sockaddr_in6 *);
207 int sctp_cmpaddr(struct sockaddr *, struct sockaddr *);
209 void sctp_print_address(struct sockaddr *);
210 void sctp_print_address_pkt(struct ip *, struct sctphdr *);
212 int sbappendaddr_nocheck(struct sockbuf *, struct sockaddr *,
213 struct mbuf *, struct mbuf *, u_int32_t, struct sctp_inpcb *);
216 int sctp_release_pr_sctp_chunk(struct sctp_tcb *, struct sctp_tmit_chunk *,
217 int, struct sctpchunk_listhead *);
219 struct mbuf *sctp_generate_invmanparam(int);
222 * this is an evil layer violation that I think is a hack.. but I stand
223 * alone on the tsvwg in this thought... everyone else considers it part
224 * of the sockets layer (along with all of the peeloff code :<)
226 u_int32_t sctp_get_first_vtag_from_sb(struct socket *);
229 void sctp_grub_through_socket_buffer(struct sctp_inpcb *, struct socket *,
230 struct socket *, struct sctp_tcb *);
232 void sctp_free_bufspace(struct sctp_tcb *, struct sctp_association *,
233 struct sctp_tmit_chunk *);
235 #ifdef SCTP_STAT_LOGGING
236 void sctp_log_strm_del_alt(u_int32_t, u_int16_t, int);
238 void sctp_log_strm_del(struct sctp_tmit_chunk *, struct sctp_tmit_chunk *, int);
239 void sctp_log_cwnd(struct sctp_nets *, int, uint8_t);
240 void sctp_log_maxburst(struct sctp_nets *, int, int, uint8_t);
241 void sctp_log_block(uint8_t, struct socket *, struct sctp_association *);
242 void sctp_log_rwnd(uint8_t, u_int32_t, u_int32_t, u_int32_t );
243 void sctp_log_mbcnt(uint8_t, u_int32_t, u_int32_t, u_int32_t, u_int32_t);
244 void sctp_log_rwnd_set(uint8_t, u_int32_t, u_int32_t, u_int32_t, u_int32_t);
245 int sctp_fill_stat_log(struct mbuf *);
246 void sctp_log_fr(uint32_t, uint32_t, uint32_t, int);
247 void sctp_log_map(uint32_t, uint32_t, uint32_t, int);
249 void sctp_clr_stat_log(void);
253 #ifdef SCTP_AUDITING_ENABLED
254 void sctp_auditing(int, struct sctp_inpcb *, struct sctp_tcb *,
256 void sctp_audit_log(u_int8_t, u_int8_t);
260 #if defined(SCTP_BASE_FREEBSD) || defined(__DragonFly__)
261 /* Note: these are in <sys/time.h>, but not in kernel space */
262 #define timerclear(tvp) (tvp)->tv_sec = (tvp)->tv_usec = 0
263 #define timerisset(tvp) ((tvp)->tv_sec || (tvp)->tv_usec)
264 #define timercmp(tvp, uvp, cmp) \
265 (((tvp)->tv_sec == (uvp)->tv_sec) ? \
266 ((tvp)->tv_usec cmp (uvp)->tv_usec) : \
267 ((tvp)->tv_sec cmp (uvp)->tv_sec))
268 #define timeradd(tvp, uvp, vvp) \
270 (vvp)->tv_sec = (tvp)->tv_sec + (uvp)->tv_sec; \
271 (vvp)->tv_usec = (tvp)->tv_usec + (uvp)->tv_usec; \
272 if ((vvp)->tv_usec >= 1000000) { \
274 (vvp)->tv_usec -= 1000000; \
276 } while (/* CONSTCOND */ 0)
277 #define timersub(tvp, uvp, vvp) \
279 (vvp)->tv_sec = (tvp)->tv_sec - (uvp)->tv_sec; \
280 (vvp)->tv_usec = (tvp)->tv_usec - (uvp)->tv_usec; \
281 if ((vvp)->tv_usec < 0) { \
283 (vvp)->tv_usec += 1000000; \
285 } while (/* CONSTCOND */ 0)
286 #endif /* SCTP_BASE_FREEBSD */