sctputil.h revision 171943
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 32/* $KAME: sctputil.h,v 1.15 2005/03/06 16:04:19 itojun Exp $ */ 33 34#include <sys/cdefs.h> 35__FBSDID("$FreeBSD: head/sys/netinet/sctputil.h 171943 2007-08-24 00:53:53Z rrs $"); 36#ifndef __sctputil_h__ 37#define __sctputil_h__ 38 39 40#if defined(_KERNEL) 41 42 43#ifdef SCTP_ASOCLOG_OF_TSNS 44void sctp_print_out_track_log(struct sctp_tcb *stcb); 45 46#endif 47 48#ifdef SCTP_MBUF_LOGGING 49struct mbuf *sctp_m_free(struct mbuf *m); 50void sctp_m_freem(struct mbuf *m); 51 52#else 53#define sctp_m_free m_free 54#define sctp_m_freem m_freem 55#endif 56 57#if defined(SCTP_LOCAL_TRACE_BUF) || defined(__APPLE__) 58void 59 sctp_log_trace(uint32_t fr, const char *str, uint32_t a, uint32_t b, uint32_t c, uint32_t d, uint32_t e, uint32_t f); 60 61#endif 62 63#define sctp_get_associd(stcb) ((sctp_assoc_t)stcb->asoc.assoc_id) 64 65 66/* 67 * Function prototypes 68 */ 69uint32_t 70sctp_get_ifa_hash_val(struct sockaddr *addr); 71 72struct sctp_ifa * 73 sctp_find_ifa_in_ep(struct sctp_inpcb *inp, struct sockaddr *addr, int hold_lock); 74 75struct sctp_ifa * 76 sctp_find_ifa_by_addr(struct sockaddr *addr, uint32_t vrf_id, int holds_lock); 77 78uint32_t sctp_select_initial_TSN(struct sctp_pcb *); 79 80uint32_t sctp_select_a_tag(struct sctp_inpcb *); 81 82int sctp_init_asoc(struct sctp_inpcb *, struct sctp_tcb *, int, uint32_t, uint32_t); 83 84void sctp_fill_random_store(struct sctp_pcb *); 85 86void 87sctp_timer_start(int, struct sctp_inpcb *, struct sctp_tcb *, 88 struct sctp_nets *); 89 90void 91sctp_timer_stop(int, struct sctp_inpcb *, struct sctp_tcb *, 92 struct sctp_nets *, uint32_t); 93 94int 95 sctp_dynamic_set_primary(struct sockaddr *sa, uint32_t vrf_id); 96 97uint32_t sctp_calculate_sum(struct mbuf *, int32_t *, uint32_t); 98 99void 100 sctp_mtu_size_reset(struct sctp_inpcb *, struct sctp_association *, uint32_t); 101 102void 103sctp_add_to_readq(struct sctp_inpcb *inp, 104 struct sctp_tcb *stcb, 105 struct sctp_queued_to_read *control, 106 struct sockbuf *sb, 107 int end); 108 109int 110sctp_append_to_readq(struct sctp_inpcb *inp, 111 struct sctp_tcb *stcb, 112 struct sctp_queued_to_read *control, 113 struct mbuf *m, 114 int end, 115 int new_cumack, 116 struct sockbuf *sb); 117 118 119void sctp_iterator_worker(void); 120 121int find_next_best_mtu(int); 122 123void 124 sctp_timeout_handler(void *); 125 126uint32_t 127sctp_calculate_rto(struct sctp_tcb *, struct sctp_association *, 128 struct sctp_nets *, struct timeval *, int); 129 130uint32_t sctp_calculate_len(struct mbuf *); 131 132caddr_t sctp_m_getptr(struct mbuf *, int, int, uint8_t *); 133 134struct sctp_paramhdr * 135sctp_get_next_param(struct mbuf *, int, 136 struct sctp_paramhdr *, int); 137 138int sctp_add_pad_tombuf(struct mbuf *, int); 139 140int sctp_pad_lastmbuf(struct mbuf *, int, struct mbuf *); 141 142void sctp_ulp_notify(uint32_t, struct sctp_tcb *, uint32_t, void *); 143 144void 145sctp_pull_off_control_to_new_inp(struct sctp_inpcb *old_inp, 146 struct sctp_inpcb *new_inp, 147 struct sctp_tcb *stcb, int waitflags); 148 149 150void sctp_stop_timers_for_shutdown(struct sctp_tcb *); 151 152void sctp_report_all_outbound(struct sctp_tcb *, int); 153 154int sctp_expand_mapping_array(struct sctp_association *, uint32_t); 155 156void sctp_abort_notification(struct sctp_tcb *, int); 157 158/* We abort responding to an IP packet for some reason */ 159void 160sctp_abort_association(struct sctp_inpcb *, struct sctp_tcb *, 161 struct mbuf *, int, struct sctphdr *, struct mbuf *, uint32_t); 162 163 164/* We choose to abort via user input */ 165void 166sctp_abort_an_association(struct sctp_inpcb *, struct sctp_tcb *, int, 167 struct mbuf *); 168 169void 170sctp_handle_ootb(struct mbuf *, int, int, struct sctphdr *, 171 struct sctp_inpcb *, struct mbuf *, uint32_t); 172 173int 174sctp_connectx_helper_add(struct sctp_tcb *stcb, struct sockaddr *addr, 175 int totaddr, int *error); 176 177struct sctp_tcb * 178sctp_connectx_helper_find(struct sctp_inpcb *inp, struct sockaddr *addr, 179 int *totaddr, int *num_v4, int *num_v6, int *error, int limit, int *bad_addr); 180 181int sctp_is_there_an_abort_here(struct mbuf *, int, uint32_t *); 182uint32_t sctp_is_same_scope(struct sockaddr_in6 *, struct sockaddr_in6 *); 183 184struct sockaddr_in6 * 185 sctp_recover_scope(struct sockaddr_in6 *, struct sockaddr_in6 *); 186 187#define sctp_recover_scope_mac(addr, store) do { \ 188 if ((addr->sin6_family == AF_INET6) && \ 189 (IN6_IS_SCOPE_LINKLOCAL(&addr->sin6_addr))) { \ 190 *store = *addr; \ 191 if (addr->sin6_scope_id == 0) { \ 192 if (!sa6_recoverscope(store)) { \ 193 addr = store; \ 194 } \ 195 } else { \ 196 in6_clearscope(&addr->sin6_addr); \ 197 addr = store; \ 198 } \ 199 } \ 200} while (0) 201 202 203int sctp_cmpaddr(struct sockaddr *, struct sockaddr *); 204 205void sctp_print_address(struct sockaddr *); 206void sctp_print_address_pkt(struct ip *, struct sctphdr *); 207 208void 209sctp_notify_partial_delivery_indication(struct sctp_tcb *stcb, 210 uint32_t error, int no_lock, uint32_t strseq); 211 212int 213sctp_release_pr_sctp_chunk(struct sctp_tcb *, struct sctp_tmit_chunk *, 214 int, struct sctpchunk_listhead *); 215 216struct mbuf *sctp_generate_invmanparam(int); 217 218void 219sctp_bindx_add_address(struct socket *so, struct sctp_inpcb *inp, 220 struct sockaddr *sa, sctp_assoc_t assoc_id, 221 uint32_t vrf_id, int *error, void *p); 222void 223sctp_bindx_delete_address(struct socket *so, struct sctp_inpcb *inp, 224 struct sockaddr *sa, sctp_assoc_t assoc_id, 225 uint32_t vrf_id, int *error); 226 227int sctp_local_addr_count(struct sctp_tcb *stcb); 228 229#ifdef SCTP_MBCNT_LOGGING 230void 231sctp_free_bufspace(struct sctp_tcb *, struct sctp_association *, 232 struct sctp_tmit_chunk *, int); 233 234#else 235#define sctp_free_bufspace(stcb, asoc, tp1, chk_cnt) \ 236do { \ 237 if (tp1->data != NULL) { \ 238 atomic_subtract_int(&((asoc)->chunks_on_out_queue), chk_cnt); \ 239 if ((asoc)->total_output_queue_size >= tp1->book_size) { \ 240 atomic_subtract_int(&((asoc)->total_output_queue_size), tp1->book_size); \ 241 } else { \ 242 (asoc)->total_output_queue_size = 0; \ 243 } \ 244 if (stcb->sctp_socket && ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \ 245 (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \ 246 if (stcb->sctp_socket->so_snd.sb_cc >= tp1->book_size) { \ 247 atomic_subtract_int(&((stcb)->sctp_socket->so_snd.sb_cc), tp1->book_size); \ 248 } else { \ 249 stcb->sctp_socket->so_snd.sb_cc = 0; \ 250 } \ 251 } \ 252 } \ 253} while (0) 254 255#endif 256 257#define sctp_free_spbufspace(stcb, asoc, sp) \ 258do { \ 259 if (sp->data != NULL) { \ 260 atomic_subtract_int(&(asoc)->chunks_on_out_queue, 1); \ 261 if ((asoc)->total_output_queue_size >= sp->length) { \ 262 atomic_subtract_int(&(asoc)->total_output_queue_size, sp->length); \ 263 } else { \ 264 (asoc)->total_output_queue_size = 0; \ 265 } \ 266 if (stcb->sctp_socket && ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \ 267 (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \ 268 if (stcb->sctp_socket->so_snd.sb_cc >= sp->length) { \ 269 atomic_subtract_int(&stcb->sctp_socket->so_snd.sb_cc,sp->length); \ 270 } else { \ 271 stcb->sctp_socket->so_snd.sb_cc = 0; \ 272 } \ 273 } \ 274 } \ 275} while (0) 276 277#define sctp_snd_sb_alloc(stcb, sz) \ 278do { \ 279 atomic_add_int(&stcb->asoc.total_output_queue_size,sz); \ 280 if ((stcb->sctp_socket != NULL) && \ 281 ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \ 282 (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \ 283 atomic_add_int(&stcb->sctp_socket->so_snd.sb_cc,sz); \ 284 } \ 285} while (0) 286 287 288int 289sctp_soreceive(struct socket *so, struct sockaddr **psa, 290 struct uio *uio, 291 struct mbuf **mp0, 292 struct mbuf **controlp, 293 int *flagsp); 294 295 296/* For those not passing mbufs, this does the 297 * translations for you. Caller owns memory 298 * of size controllen returned in controlp. 299 */ 300int 301sctp_l_soreceive(struct socket *so, 302 struct sockaddr **name, 303 struct uio *uio, 304 char **controlp, 305 int *controllen, 306 int *flag); 307 308 309void 310 sctp_misc_ints(uint8_t from, uint32_t a, uint32_t b, uint32_t c, uint32_t d); 311 312void 313sctp_wakeup_log(struct sctp_tcb *stcb, 314 uint32_t cumtsn, 315 uint32_t wake_cnt, int from); 316 317void sctp_log_strm_del_alt(struct sctp_tcb *stcb, uint32_t, uint16_t, uint16_t, int); 318 319void sctp_log_nagle_event(struct sctp_tcb *stcb, int action); 320 321 322void 323 sctp_log_mb(struct mbuf *m, int from); 324 325void 326sctp_sblog(struct sockbuf *sb, 327 struct sctp_tcb *stcb, int from, int incr); 328 329void 330sctp_log_strm_del(struct sctp_queued_to_read *control, 331 struct sctp_queued_to_read *poschk, 332 int from); 333void sctp_log_cwnd(struct sctp_tcb *stcb, struct sctp_nets *, int, uint8_t); 334void rto_logging(struct sctp_nets *net, int from); 335 336void sctp_log_closing(struct sctp_inpcb *inp, struct sctp_tcb *stcb, int16_t loc); 337 338void sctp_log_lock(struct sctp_inpcb *inp, struct sctp_tcb *stcb, uint8_t from); 339void sctp_log_maxburst(struct sctp_tcb *stcb, struct sctp_nets *, int, int, uint8_t); 340void sctp_log_block(uint8_t, struct socket *, struct sctp_association *, int); 341void sctp_log_rwnd(uint8_t, uint32_t, uint32_t, uint32_t); 342void sctp_log_mbcnt(uint8_t, uint32_t, uint32_t, uint32_t, uint32_t); 343void sctp_log_rwnd_set(uint8_t, uint32_t, uint32_t, uint32_t, uint32_t); 344int sctp_fill_stat_log(void *, size_t *); 345void sctp_log_fr(uint32_t, uint32_t, uint32_t, int); 346void sctp_log_sack(uint32_t, uint32_t, uint32_t, uint16_t, uint16_t, int); 347void sctp_log_map(uint32_t, uint32_t, uint32_t, int); 348 349void sctp_clr_stat_log(void); 350 351 352#ifdef SCTP_AUDITING_ENABLED 353void 354sctp_auditing(int, struct sctp_inpcb *, struct sctp_tcb *, 355 struct sctp_nets *); 356void sctp_audit_log(uint8_t, uint8_t); 357 358#endif 359 360 361#endif /* _KERNEL */ 362#endif 363