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