subprojects/gst-plugins-bad/ext/sctp/usrsctp/usrsctplib/netinet/sctp_callout.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 2001-2007, by Cisco Systems, Inc. All rights reserved.
   5  * Copyright (c) 2008-2012, by Randall Stewart. All rights reserved.
   6  * Copyright (c) 2008-2012, by Michael Tuexen. All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  * 3. Neither the name of the project nor the names of its contributors
  17  *    may be used to endorse or promote products derived from this software
  18  *    without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
  21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
  24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30  * SUCH DAMAGE.
  31  */
  32
  33 #if defined(__FreeBSD__) && !defined(__Userspace__)
  34 #include <sys/cdefs.h>
  35 __FBSDID("$FreeBSD$");
  36 #endif
  37
  38 #ifndef _NETINET_SCTP_CALLOUT_
  39 #define _NETINET_SCTP_CALLOUT_
  40
  41 /*
  42  * NOTE: the following MACROS are required for locking the callout
  43  * queue along with a lock/mutex in the OS specific headers and
  44  * implementation files::
  45  * - SCTP_TIMERQ_LOCK()
  46  * - SCTP_TIMERQ_UNLOCK()
  47  * - SCTP_TIMERQ_LOCK_INIT()
  48  * - SCTP_TIMERQ_LOCK_DESTROY()
  49  */
  50
  51 #define _SCTP_NEEDS_CALLOUT_ 1
  52
  53 #define SCTP_TICKS_PER_FASTTIMO 20      /* called about every 20ms */
  54
  55 #if defined(__Userspace__)
  56 #if defined(_WIN32)
  57 #define SCTP_TIMERQ_LOCK()          EnterCriticalSection(&SCTP_BASE_VAR(timer_mtx))
  58 #define SCTP_TIMERQ_UNLOCK()        LeaveCriticalSection(&SCTP_BASE_VAR(timer_mtx))
  59 #define SCTP_TIMERQ_LOCK_INIT()     InitializeCriticalSection(&SCTP_BASE_VAR(timer_mtx))
  60 #define SCTP_TIMERQ_LOCK_DESTROY()  DeleteCriticalSection(&SCTP_BASE_VAR(timer_mtx))
  61 #else
  62 #ifdef INVARIANTS
  63 #define SCTP_TIMERQ_LOCK()          KASSERT(pthread_mutex_lock(&SCTP_BASE_VAR(timer_mtx)) == 0, ("%s: timer_mtx already locked", __func__))
  64 #define SCTP_TIMERQ_UNLOCK()        KASSERT(pthread_mutex_unlock(&SCTP_BASE_VAR(timer_mtx)) == 0, ("%s: timer_mtx not locked", __func__))
  65 #else
  66 #define SCTP_TIMERQ_LOCK()          (void)pthread_mutex_lock(&SCTP_BASE_VAR(timer_mtx))
  67 #define SCTP_TIMERQ_UNLOCK()        (void)pthread_mutex_unlock(&SCTP_BASE_VAR(timer_mtx))
  68 #endif
  69 #define SCTP_TIMERQ_LOCK_INIT()     (void)pthread_mutex_init(&SCTP_BASE_VAR(timer_mtx), &SCTP_BASE_VAR(mtx_attr))
  70 #define SCTP_TIMERQ_LOCK_DESTROY()  (void)pthread_mutex_destroy(&SCTP_BASE_VAR(timer_mtx))
  71 #endif
  72 #endif
  73
  74 uint32_t sctp_get_tick_count(void);
  75
  76 TAILQ_HEAD(calloutlist, sctp_callout);
  77
  78 struct sctp_callout {
  79         TAILQ_ENTRY(sctp_callout) tqe;
  80         uint32_t c_time;                /* ticks to the event */
  81         void *c_arg;            /* function argument */
  82         void (*c_func)(void *); /* function to call */
  83         int c_flags;            /* state of this entry */
  84 };
  85 typedef struct sctp_callout sctp_os_timer_t;
  86
  87 #define SCTP_CALLOUT_ACTIVE     0x0002  /* callout is currently active */
  88 #define SCTP_CALLOUT_PENDING    0x0004  /* callout is waiting for timeout */
  89
  90 void sctp_os_timer_init(sctp_os_timer_t *tmr);
  91 /* Returns 1 if pending timer was rescheduled, 0 otherwise. */
  92 int sctp_os_timer_start(sctp_os_timer_t *, uint32_t, void (*)(void *), void *);
  93 /* Returns 1 if pending timer was stopped, 0 otherwise. */
  94 int sctp_os_timer_stop(sctp_os_timer_t *);
  95 void sctp_handle_tick(uint32_t);
  96
  97 #define SCTP_OS_TIMER_INIT      sctp_os_timer_init
  98 /*
  99  * NOTE: The next two shouldn't be called directly outside of sctp_timer_start()
 100  * and sctp_timer_stop(), since they don't handle incrementing/decrementing
 101  * relevant reference counts.
 102  */
 103 #define SCTP_OS_TIMER_START     sctp_os_timer_start
 104 #define SCTP_OS_TIMER_STOP      sctp_os_timer_stop
 105 /* MT FIXME: Is the following correct? */
 106 #define SCTP_OS_TIMER_STOP_DRAIN SCTP_OS_TIMER_STOP
 107 #define SCTP_OS_TIMER_PENDING(tmr) ((tmr)->c_flags & SCTP_CALLOUT_PENDING)
 108 #define SCTP_OS_TIMER_ACTIVE(tmr) ((tmr)->c_flags & SCTP_CALLOUT_ACTIVE)
 109 #define SCTP_OS_TIMER_DEACTIVATE(tmr) ((tmr)->c_flags &= ~SCTP_CALLOUT_ACTIVE)
 110
 111 #if defined(__Userspace__)
 112 void sctp_start_timer_thread(void);
 113 void sctp_stop_timer_thread(void);
 114 #endif
 115 #if defined(__APPLE__) && !defined(__Userspace__)
 116 void sctp_timeout(void *);
 117 #endif
 118
 119 #endif