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