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