michael@0: /*-
michael@0:  * Copyright (c) 2001-2007, by Cisco Systems, Inc. All rights reserved.
michael@0:  * Copyright (c) 2008-2012, by Randall Stewart. All rights reserved.
michael@0:  * Copyright (c) 2008-2012, by Michael Tuexen. All rights reserved.
michael@0:  *
michael@0:  * Redistribution and use in source and binary forms, with or without
michael@0:  * modification, are permitted provided that the following conditions are met:
michael@0:  *
michael@0:  * a) Redistributions of source code must retain the above copyright notice,
michael@0:  *    this list of conditions and the following disclaimer.
michael@0:  *
michael@0:  * b) Redistributions in binary form must reproduce the above copyright
michael@0:  *    notice, this list of conditions and the following disclaimer in
michael@0:  *    the documentation and/or other materials provided with the distribution.
michael@0:  *
michael@0:  * c) Neither the name of Cisco Systems, Inc. nor the names of its
michael@0:  *    contributors may be used to endorse or promote products derived
michael@0:  *    from this software without specific prior written permission.
michael@0:  *
michael@0:  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
michael@0:  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
michael@0:  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
michael@0:  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
michael@0:  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
michael@0:  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
michael@0:  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
michael@0:  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
michael@0:  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
michael@0:  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
michael@0:  * THE POSSIBILITY OF SUCH DAMAGE.
michael@0:  */
michael@0: 
michael@0: #ifdef __FreeBSD__
michael@0: #include <sys/cdefs.h>
michael@0: __FBSDID("$FreeBSD: head/sys/netinet/sctputil.h 243186 2012-11-17 20:04:04Z tuexen $");
michael@0: #endif
michael@0: 
michael@0: #ifndef _NETINET_SCTP_UTIL_H_
michael@0: #define _NETINET_SCTP_UTIL_H_
michael@0: 
michael@0: #if defined(_KERNEL) || defined(__Userspace__)
michael@0: 
michael@0: #define SCTP_READ_LOCK_HELD 1
michael@0: #define SCTP_READ_LOCK_NOT_HELD 0
michael@0: 
michael@0: #ifdef SCTP_ASOCLOG_OF_TSNS
michael@0: void sctp_print_out_track_log(struct sctp_tcb *stcb);
michael@0: #endif
michael@0: 
michael@0: #ifdef SCTP_MBUF_LOGGING
michael@0: struct mbuf *sctp_m_free(struct mbuf *m);
michael@0: void sctp_m_freem(struct mbuf *m);
michael@0: #else
michael@0: #define sctp_m_free m_free
michael@0: #define sctp_m_freem m_freem
michael@0: #endif
michael@0: 
michael@0: #if defined(SCTP_LOCAL_TRACE_BUF) || defined(__APPLE__)
michael@0: void
michael@0: sctp_log_trace(uint32_t fr, const char *str SCTP_UNUSED, uint32_t a, uint32_t b, uint32_t c, uint32_t d, uint32_t e, uint32_t f);
michael@0: #endif
michael@0: 
michael@0: #define sctp_get_associd(stcb) ((sctp_assoc_t)stcb->asoc.assoc_id)
michael@0: 
michael@0: 
michael@0: /*
michael@0:  * Function prototypes
michael@0:  */
michael@0: uint32_t
michael@0: sctp_get_ifa_hash_val(struct sockaddr *addr);
michael@0: 
michael@0: struct sctp_ifa *
michael@0: sctp_find_ifa_in_ep(struct sctp_inpcb *inp, struct sockaddr *addr, int hold_lock);
michael@0: 
michael@0: struct sctp_ifa *
michael@0: sctp_find_ifa_by_addr(struct sockaddr *addr, uint32_t vrf_id, int holds_lock);
michael@0: 
michael@0: uint32_t sctp_select_initial_TSN(struct sctp_pcb *);
michael@0: 
michael@0: uint32_t sctp_select_a_tag(struct sctp_inpcb *, uint16_t lport, uint16_t rport, int);
michael@0: 
michael@0: int sctp_init_asoc(struct sctp_inpcb *, struct sctp_tcb *, uint32_t, uint32_t);
michael@0: 
michael@0: void sctp_fill_random_store(struct sctp_pcb *);
michael@0: 
michael@0: void
michael@0: sctp_notify_stream_reset_add(struct sctp_tcb *stcb, uint16_t numberin,
michael@0: 			     uint16_t numberout, int flag);
michael@0: void
michael@0: sctp_notify_stream_reset_tsn(struct sctp_tcb *stcb, uint32_t sending_tsn, uint32_t recv_tsn, int flag);
michael@0: 
michael@0: void
michael@0: sctp_timer_start(int, struct sctp_inpcb *, struct sctp_tcb *,
michael@0:     struct sctp_nets *);
michael@0: 
michael@0: void
michael@0: sctp_timer_stop(int, struct sctp_inpcb *, struct sctp_tcb *,
michael@0:     struct sctp_nets *, uint32_t);
michael@0: 
michael@0: int
michael@0: sctp_dynamic_set_primary(struct sockaddr *sa, uint32_t vrf_id);
michael@0: 
michael@0: void
michael@0: sctp_mtu_size_reset(struct sctp_inpcb *, struct sctp_association *, uint32_t);
michael@0: 
michael@0: void
michael@0: sctp_add_to_readq(struct sctp_inpcb *inp,
michael@0:     struct sctp_tcb *stcb,
michael@0:     struct sctp_queued_to_read *control,
michael@0:     struct sockbuf *sb,
michael@0:     int end,
michael@0:     int inpread_locked,
michael@0:     int so_locked
michael@0: #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING)
michael@0:     SCTP_UNUSED
michael@0: #endif
michael@0:     );
michael@0: 
michael@0: int
michael@0: sctp_append_to_readq(struct sctp_inpcb *inp,
michael@0:     struct sctp_tcb *stcb,
michael@0:     struct sctp_queued_to_read *control,
michael@0:     struct mbuf *m,
michael@0:     int end,
michael@0:     int new_cumack,
michael@0:     struct sockbuf *sb);
michael@0: 
michael@0: 
michael@0: void sctp_iterator_worker(void);
michael@0: 
michael@0: uint32_t sctp_get_prev_mtu(uint32_t);
michael@0: uint32_t sctp_get_next_mtu(uint32_t);
michael@0: 
michael@0: void
michael@0: sctp_timeout_handler(void *);
michael@0: 
michael@0: uint32_t
michael@0: sctp_calculate_rto(struct sctp_tcb *, struct sctp_association *,
michael@0:     struct sctp_nets *, struct timeval *, int, int);
michael@0: 
michael@0: uint32_t sctp_calculate_len(struct mbuf *);
michael@0: 
michael@0: caddr_t sctp_m_getptr(struct mbuf *, int, int, uint8_t *);
michael@0: 
michael@0: struct sctp_paramhdr *
michael@0: sctp_get_next_param(struct mbuf *, int,
michael@0:     struct sctp_paramhdr *, int);
michael@0: 
michael@0: int sctp_add_pad_tombuf(struct mbuf *, int);
michael@0: 
michael@0: int sctp_pad_lastmbuf(struct mbuf *, int, struct mbuf *);
michael@0: 
michael@0: void sctp_ulp_notify(uint32_t, struct sctp_tcb *, uint32_t, void *, int
michael@0: #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING)
michael@0:     SCTP_UNUSED
michael@0: #endif
michael@0:     );
michael@0: 
michael@0: void
michael@0: sctp_pull_off_control_to_new_inp(struct sctp_inpcb *old_inp,
michael@0:     struct sctp_inpcb *new_inp,
michael@0:     struct sctp_tcb *stcb, int waitflags);
michael@0: 
michael@0: 
michael@0: void sctp_stop_timers_for_shutdown(struct sctp_tcb *);
michael@0: 
michael@0: void sctp_report_all_outbound(struct sctp_tcb *, uint16_t, int, int
michael@0: #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING)
michael@0:     SCTP_UNUSED
michael@0: #endif
michael@0:     );
michael@0: 
michael@0: int sctp_expand_mapping_array(struct sctp_association *, uint32_t);
michael@0: 
michael@0: void sctp_abort_notification(struct sctp_tcb *, uint8_t, uint16_t,
michael@0: 			     struct sctp_abort_chunk *, int
michael@0: #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING)
michael@0:     SCTP_UNUSED
michael@0: #endif
michael@0:     );
michael@0: 
michael@0: /* We abort responding to an IP packet for some reason */
michael@0: void
michael@0: sctp_abort_association(struct sctp_inpcb *, struct sctp_tcb *, struct mbuf *,
michael@0:                        int, struct sockaddr *, struct sockaddr *,
michael@0:                        struct sctphdr *, struct mbuf *,
michael@0: #if defined(__FreeBSD__)
michael@0:                        uint8_t, uint32_t,
michael@0: #endif
michael@0:                        uint32_t, uint16_t);
michael@0: 
michael@0: 
michael@0: /* We choose to abort via user input */
michael@0: void
michael@0: sctp_abort_an_association(struct sctp_inpcb *, struct sctp_tcb *,
michael@0:     struct mbuf *, int
michael@0: #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING)
michael@0:     SCTP_UNUSED
michael@0: #endif
michael@0: );
michael@0: 
michael@0: void sctp_handle_ootb(struct mbuf *, int, int,
michael@0:                       struct sockaddr *, struct sockaddr *,
michael@0:                       struct sctphdr *, struct sctp_inpcb *,
michael@0: #if defined(__FreeBSD__)
michael@0:                       uint8_t, uint32_t,
michael@0: #endif
michael@0:                       uint32_t, uint16_t);
michael@0: 
michael@0: int sctp_connectx_helper_add(struct sctp_tcb *stcb, struct sockaddr *addr,
michael@0:     int totaddr, int *error);
michael@0: 
michael@0: struct sctp_tcb *
michael@0: sctp_connectx_helper_find(struct sctp_inpcb *inp, struct sockaddr *addr,
michael@0:     int *totaddr, int *num_v4, int *num_v6, int *error, int limit, int *bad_addr);
michael@0: 
michael@0: int sctp_is_there_an_abort_here(struct mbuf *, int, uint32_t *);
michael@0: #ifdef INET6
michael@0: uint32_t sctp_is_same_scope(struct sockaddr_in6 *, struct sockaddr_in6 *);
michael@0: 
michael@0: #if defined(SCTP_EMBEDDED_V6_SCOPE)
michael@0: struct sockaddr_in6 *
michael@0: sctp_recover_scope(struct sockaddr_in6 *, struct sockaddr_in6 *);
michael@0: 
michael@0: #ifdef SCTP_KAME
michael@0: #define sctp_recover_scope_mac(addr, store) do { \
michael@0: 	 if ((addr->sin6_family == AF_INET6) && \
michael@0: 	     (IN6_IS_SCOPE_LINKLOCAL(&addr->sin6_addr))) { \
michael@0: 		*store = *addr; \
michael@0: 		if (addr->sin6_scope_id == 0) { \
michael@0: 			if (!sa6_recoverscope(store)) { \
michael@0: 				addr = store; \
michael@0: 			} \
michael@0: 		} else { \
michael@0: 			in6_clearscope(&addr->sin6_addr); \
michael@0: 			addr = store; \
michael@0: 		} \
michael@0: 	 } \
michael@0: } while (0)
michael@0: #else
michael@0: #define sctp_recover_scope_mac(addr, store) do { \
michael@0: 	 if ((addr->sin6_family == AF_INET6) && \
michael@0: 	     (IN6_IS_SCOPE_LINKLOCAL(&addr->sin6_addr))) { \
michael@0: 		*store = *addr; \
michael@0: 	 	if (addr->sin6_scope_id == 0) { \
michael@0: 			if (!in6_recoverscope(store, &store->sin6_addr, \
michael@0: 					      NULL)) { \
michael@0: 				addr = store; \
michael@0: 			} \
michael@0: 		} else { \
michael@0: 			in6_clearscope(&addr->sin6_addr); \
michael@0: 			addr = store; \
michael@0: 		} \
michael@0: 	 } \
michael@0: } while (0)
michael@0: #endif
michael@0: #endif
michael@0: #endif
michael@0: 
michael@0: int sctp_cmpaddr(struct sockaddr *, struct sockaddr *);
michael@0: 
michael@0: void sctp_print_address(struct sockaddr *);
michael@0: 
michael@0: int
michael@0: sctp_release_pr_sctp_chunk(struct sctp_tcb *, struct sctp_tmit_chunk *,
michael@0:     uint8_t, int
michael@0: #if !defined(__APPLE__) && !defined(SCTP_SO_LOCK_TESTING)
michael@0:     SCTP_UNUSED
michael@0: #endif
michael@0: );
michael@0: 
michael@0: struct mbuf *sctp_generate_invmanparam(int);
michael@0: 
michael@0: void sctp_bindx_add_address(struct socket *so, struct sctp_inpcb *inp,
michael@0: 			    struct sockaddr *sa, sctp_assoc_t assoc_id,
michael@0: 			    uint32_t vrf_id, int *error, void *p);
michael@0: void sctp_bindx_delete_address(struct sctp_inpcb *inp,
michael@0: 			       struct sockaddr *sa, sctp_assoc_t assoc_id,
michael@0: 			       uint32_t vrf_id, int *error);
michael@0: 
michael@0: int sctp_local_addr_count(struct sctp_tcb *stcb);
michael@0: 
michael@0: #ifdef SCTP_MBCNT_LOGGING
michael@0: void
michael@0: sctp_free_bufspace(struct sctp_tcb *, struct sctp_association *,
michael@0:     struct sctp_tmit_chunk *, int);
michael@0: 
michael@0: #else
michael@0: #define sctp_free_bufspace(stcb, asoc, tp1, chk_cnt)  \
michael@0: do { \
michael@0: 	if (tp1->data != NULL) { \
michael@0:                 atomic_subtract_int(&((asoc)->chunks_on_out_queue), chk_cnt); \
michael@0: 		if ((asoc)->total_output_queue_size >= tp1->book_size) { \
michael@0: 			atomic_subtract_int(&((asoc)->total_output_queue_size), tp1->book_size); \
michael@0: 		} else { \
michael@0: 			(asoc)->total_output_queue_size = 0; \
michael@0: 		} \
michael@0:    	        if (stcb->sctp_socket && ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \
michael@0: 	            (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \
michael@0: 			if (stcb->sctp_socket->so_snd.sb_cc >= tp1->book_size) { \
michael@0: 				atomic_subtract_int(&((stcb)->sctp_socket->so_snd.sb_cc), tp1->book_size); \
michael@0: 			} else { \
michael@0: 				stcb->sctp_socket->so_snd.sb_cc = 0; \
michael@0: 			} \
michael@0: 		} \
michael@0:         } \
michael@0: } while (0)
michael@0: 
michael@0: #endif
michael@0: 
michael@0: #define sctp_free_spbufspace(stcb, asoc, sp)  \
michael@0: do { \
michael@0:  	if (sp->data != NULL) { \
michael@0: 		if ((asoc)->total_output_queue_size >= sp->length) { \
michael@0: 			atomic_subtract_int(&(asoc)->total_output_queue_size, sp->length); \
michael@0: 		} else { \
michael@0: 			(asoc)->total_output_queue_size = 0; \
michael@0: 		} \
michael@0:    	        if (stcb->sctp_socket && ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \
michael@0: 	            (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \
michael@0: 			if (stcb->sctp_socket->so_snd.sb_cc >= sp->length) { \
michael@0: 				atomic_subtract_int(&stcb->sctp_socket->so_snd.sb_cc,sp->length); \
michael@0: 			} else { \
michael@0: 				stcb->sctp_socket->so_snd.sb_cc = 0; \
michael@0: 			} \
michael@0: 		} \
michael@0:         } \
michael@0: } while (0)
michael@0: 
michael@0: #define sctp_snd_sb_alloc(stcb, sz)  \
michael@0: do { \
michael@0: 	atomic_add_int(&stcb->asoc.total_output_queue_size,sz); \
michael@0: 	if ((stcb->sctp_socket != NULL) && \
michael@0: 	    ((stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_TCPTYPE) || \
michael@0: 	     (stcb->sctp_ep->sctp_flags & SCTP_PCB_FLAGS_IN_TCPPOOL))) { \
michael@0: 		atomic_add_int(&stcb->sctp_socket->so_snd.sb_cc,sz); \
michael@0: 	} \
michael@0: } while (0)
michael@0: 
michael@0: /* functions to start/stop udp tunneling */
michael@0: #if defined(__APPLE__) || defined(__FreeBSD__)
michael@0: void sctp_over_udp_stop(void);
michael@0: int sctp_over_udp_start(void);
michael@0: #endif
michael@0: #if defined(__Windows__)
michael@0: void sctp_over_udp_restart(void);
michael@0: #endif
michael@0: 
michael@0: int
michael@0: sctp_soreceive(struct socket *so, struct sockaddr **psa,
michael@0:     struct uio *uio,
michael@0:     struct mbuf **mp0,
michael@0:     struct mbuf **controlp,
michael@0:     int *flagsp);
michael@0: 
michael@0: void
michael@0: sctp_misc_ints(uint8_t from, uint32_t a, uint32_t b, uint32_t c, uint32_t d);
michael@0: 
michael@0: void
michael@0: sctp_wakeup_log(struct sctp_tcb *stcb,
michael@0:     uint32_t wake_cnt, int from);
michael@0: 
michael@0: void sctp_log_strm_del_alt(struct sctp_tcb *stcb, uint32_t, uint16_t, uint16_t, int);
michael@0: 
michael@0: void sctp_log_nagle_event(struct sctp_tcb *stcb, int action);
michael@0: 
michael@0: 
michael@0: void
michael@0: sctp_log_mb(struct mbuf *m, int from);
michael@0: 
michael@0: void
michael@0: sctp_sblog(struct sockbuf *sb,
michael@0:     struct sctp_tcb *stcb, int from, int incr);
michael@0: 
michael@0: void
michael@0: sctp_log_strm_del(struct sctp_queued_to_read *control,
michael@0:     struct sctp_queued_to_read *poschk,
michael@0:     int from);
michael@0: void sctp_log_cwnd(struct sctp_tcb *stcb, struct sctp_nets *, int, uint8_t);
michael@0: void rto_logging(struct sctp_nets *net, int from);
michael@0: 
michael@0: void sctp_log_closing(struct sctp_inpcb *inp, struct sctp_tcb *stcb, int16_t loc);
michael@0: 
michael@0: void sctp_log_lock(struct sctp_inpcb *inp, struct sctp_tcb *stcb, uint8_t from);
michael@0: void sctp_log_maxburst(struct sctp_tcb *stcb, struct sctp_nets *, int, int, uint8_t);
michael@0: void sctp_log_block(uint8_t, struct sctp_association *, int);
michael@0: void sctp_log_rwnd(uint8_t, uint32_t, uint32_t, uint32_t);
michael@0: void sctp_log_mbcnt(uint8_t, uint32_t, uint32_t, uint32_t, uint32_t);
michael@0: void sctp_log_rwnd_set(uint8_t, uint32_t, uint32_t, uint32_t, uint32_t);
michael@0: int sctp_fill_stat_log(void *, size_t *);
michael@0: void sctp_log_fr(uint32_t, uint32_t, uint32_t, int);
michael@0: void sctp_log_sack(uint32_t, uint32_t, uint32_t, uint16_t, uint16_t, int);
michael@0: void sctp_log_map(uint32_t, uint32_t, uint32_t, int);
michael@0: void sctp_print_mapping_array(struct sctp_association *asoc);
michael@0: void sctp_clr_stat_log(void);
michael@0: 
michael@0: 
michael@0: #ifdef SCTP_AUDITING_ENABLED
michael@0: void
michael@0: sctp_auditing(int, struct sctp_inpcb *, struct sctp_tcb *,
michael@0:     struct sctp_nets *);
michael@0: void sctp_audit_log(uint8_t, uint8_t);
michael@0: 
michael@0: #endif
michael@0: #endif				/* _KERNEL */
michael@0: #endif