lib/librte_eal/linuxapp/eal/eal_alarm.c

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33 #include <stdio.h>
  34 #include <stdint.h>
  35 #include <signal.h>
  36 #include <errno.h>
  37 #include <string.h>
  38 #include <sys/queue.h>
  39 #include <sys/time.h>
  40 #include <sys/timerfd.h>
  41
  42 #include <rte_memory.h>
  43 #include <rte_memzone.h>
  44 #include <rte_interrupts.h>
  45 #include <rte_alarm.h>
  46 #include <rte_common.h>
  47 #include <rte_per_lcore.h>
  48 #include <rte_tailq.h>
  49 #include <rte_eal.h>
  50 #include <rte_launch.h>
  51 #include <rte_lcore.h>
  52 #include <rte_errno.h>
  53 #include <rte_malloc.h>
  54 #include <rte_spinlock.h>
  55 #include <eal_private.h>
  56
  57 #define NS_PER_US 1000
  58 #define US_PER_MS 1000
  59 #define MS_PER_S 1000
  60 #define US_PER_S (US_PER_MS * MS_PER_S)
  61
  62 struct alarm_entry {
  63         LIST_ENTRY(alarm_entry) next;
  64         struct timeval time;
  65         rte_eal_alarm_callback cb_fn;
  66         void *cb_arg;
  67         volatile int executing;
  68 };
  69
  70 static LIST_HEAD(alarm_list, alarm_entry) alarm_list = LIST_HEAD_INITIALIZER();
  71 static rte_spinlock_t alarm_list_lk = RTE_SPINLOCK_INITIALIZER;
  72
  73 static struct rte_intr_handle intr_handle = {.fd = -1 };
  74 static int handler_registered = 0;
  75 static void eal_alarm_callback(struct rte_intr_handle *hdl, void *arg);
  76
  77 int
  78 rte_eal_alarm_init(void)
  79 {
  80         intr_handle.type = RTE_INTR_HANDLE_ALARM;
  81         /* create a timerfd file descriptor */
  82         intr_handle.fd = timerfd_create(CLOCK_MONOTONIC, TFD_NONBLOCK);
  83         if (intr_handle.fd == -1)
  84                 goto error;
  85
  86         return 0;
  87
  88 error:
  89         rte_errno = errno;
  90         return -1;
  91 }
  92
  93 static void
  94 eal_alarm_callback(struct rte_intr_handle *hdl __rte_unused,
  95                 void *arg __rte_unused)
  96 {
  97         struct timeval now;
  98         struct alarm_entry *ap;
  99
 100         rte_spinlock_lock(&alarm_list_lk);
 101         while ((ap = LIST_FIRST(&alarm_list)) !=NULL &&
 102                         gettimeofday(&now, NULL) == 0 &&
 103                         (ap->time.tv_sec < now.tv_sec || (ap->time.tv_sec == now.tv_sec &&
 104                                                 ap->time.tv_usec <= now.tv_usec))){
 105                 ap->executing = 1;
 106                 rte_spinlock_unlock(&alarm_list_lk);
 107
 108                 ap->cb_fn(ap->cb_arg);
 109
 110                 rte_spinlock_lock(&alarm_list_lk);
 111                 LIST_REMOVE(ap, next);
 112                 rte_free(ap);
 113         }
 114
 115         if (!LIST_EMPTY(&alarm_list)) {
 116                 struct itimerspec atime = { .it_interval = { 0, 0 } };
 117
 118                 ap = LIST_FIRST(&alarm_list);
 119                 atime.it_value.tv_sec = ap->time.tv_sec;
 120                 atime.it_value.tv_nsec = ap->time.tv_usec * NS_PER_US;
 121                 /* perform borrow for subtraction if necessary */
 122                 if (now.tv_usec > ap->time.tv_usec)
 123                         atime.it_value.tv_sec--, atime.it_value.tv_nsec += US_PER_S * NS_PER_US;
 124
 125                 atime.it_value.tv_sec -= now.tv_sec;
 126                 atime.it_value.tv_nsec -= now.tv_usec * NS_PER_US;
 127                 timerfd_settime(intr_handle.fd, 0, &atime, NULL);
 128         }
 129         rte_spinlock_unlock(&alarm_list_lk);
 130 }
 131
 132 int
 133 rte_eal_alarm_set(uint64_t us, rte_eal_alarm_callback cb_fn, void *cb_arg)
 134 {
 135         struct timeval now;
 136         int ret = 0;
 137         struct alarm_entry *ap, *new_alarm;
 138
 139         /* Check parameters, including that us won't cause a uint64_t overflow */
 140         if (us < 1 || us > (UINT64_MAX - US_PER_S) || cb_fn == NULL)
 141                 return -EINVAL;
 142
 143         new_alarm = rte_malloc(NULL, sizeof(*new_alarm), 0);
 144         if (new_alarm == NULL)
 145                 return -ENOMEM;
 146
 147         /* use current time to calculate absolute time of alarm */
 148         gettimeofday(&now, NULL);
 149
 150         new_alarm->cb_fn = cb_fn;
 151         new_alarm->cb_arg = cb_arg;
 152         new_alarm->time.tv_usec = (now.tv_usec + us) % US_PER_S;
 153         new_alarm->time.tv_sec = now.tv_sec + ((now.tv_usec + us) / US_PER_S);
 154         new_alarm->executing = 0;
 155
 156         rte_spinlock_lock(&alarm_list_lk);
 157         if (!handler_registered) {
 158                 ret |= rte_intr_callback_register(&intr_handle,
 159                                 eal_alarm_callback, NULL);
 160                 handler_registered = (ret == 0) ? 1 : 0;
 161         }
 162
 163         if (LIST_EMPTY(&alarm_list))
 164                 LIST_INSERT_HEAD(&alarm_list, new_alarm, next);
 165         else {
 166                 LIST_FOREACH(ap, &alarm_list, next) {
 167                         if (ap->time.tv_sec > new_alarm->time.tv_sec ||
 168                                         (ap->time.tv_sec == new_alarm->time.tv_sec &&
 169                                                         ap->time.tv_usec > new_alarm->time.tv_usec)){
 170                                 LIST_INSERT_BEFORE(ap, new_alarm, next);
 171                                 break;
 172                         }
 173                         if (LIST_NEXT(ap, next) == NULL) {
 174                                 LIST_INSERT_AFTER(ap, new_alarm, next);
 175                                 break;
 176                         }
 177                 }
 178         }
 179
 180         if (LIST_FIRST(&alarm_list) == new_alarm) {
 181                 struct itimerspec alarm_time = {
 182                         .it_interval = {0, 0},
 183                         .it_value = {
 184                                 .tv_sec = us / US_PER_S,
 185                                 .tv_nsec = (us % US_PER_S) * NS_PER_US,
 186                         },
 187                 };
 188                 ret |= timerfd_settime(intr_handle.fd, 0, &alarm_time, NULL);
 189         }
 190         rte_spinlock_unlock(&alarm_list_lk);
 191
 192         return ret;
 193 }
 194
 195 int
 196 rte_eal_alarm_cancel(rte_eal_alarm_callback cb_fn, void *cb_arg)
 197 {
 198         struct alarm_entry *ap, *ap_prev;
 199         int count = 0;
 200
 201         if (!cb_fn)
 202                 return -1;
 203
 204         rte_spinlock_lock(&alarm_list_lk);
 205         /* remove any matches at the start of the list */
 206         while ((ap = LIST_FIRST(&alarm_list)) != NULL &&
 207                         cb_fn == ap->cb_fn && ap->executing == 0 &&
 208                         (cb_arg == (void *)-1 || cb_arg == ap->cb_arg)) {
 209                 LIST_REMOVE(ap, next);
 210                 rte_free(ap);
 211                 count++;
 212         }
 213         ap_prev = ap;
 214
 215         /* now go through list, removing entries not at start */
 216         LIST_FOREACH(ap, &alarm_list, next) {
 217                 /* this won't be true first time through */
 218                 if (cb_fn == ap->cb_fn &&  ap->executing == 0 &&
 219                                 (cb_arg == (void *)-1 || cb_arg == ap->cb_arg)) {
 220                         LIST_REMOVE(ap,next);
 221                         rte_free(ap);
 222                         count++;
 223                         ap = ap_prev;
 224                 }
 225                 ap_prev = ap;
 226         }
 227         rte_spinlock_unlock(&alarm_list_lk);
 228         return count;
 229 }
 230