src/plugins/igmp/igmp_timer.c

   1 /*
   2  *------------------------------------------------------------------
   3  * Copyright (c) 2017 Cisco and/or its affiliates.
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  *------------------------------------------------------------------
  16  */
  17
  18 #include <igmp/igmp_timer.h>
  19 #include <igmp/igmp.h>
  20
  21 /**
  22  * Default timer values as per RFC
  23  */
  24
  25 static igmp_timer_type_t igmp_default_timer_values[] = {
  26   [IGMP_TIMER_QUERY] = 60,
  27   [IGMP_TIMER_SRC] = (3 * 60),
  28   [IGMP_TIMER_LEAVE] = 60,
  29   [IGMP_TIMER_REPORT_INTERVAL] = 1,
  30 };
  31
  32 #define IGMP_N_TIMERS (IGMP_TIMER_REPORT_INTERVAL+1)
  33
  34 /**
  35  * Timer
  36  */
  37 typedef struct igmp_timer_t_
  38 {
  39   /** Expiration timer */
  40   f64 exp_time;
  41
  42   /** Call-back function to invoke on expiry */
  43   igmp_timer_function_t func;
  44
  45   /** index of the object that scheduled the timer */
  46   u32 obj;
  47
  48   /** Data registered by the client and passed back when the timer expires */
  49   void *data;
  50 } igmp_timer_t;
  51
  52 enum
  53 {
  54   IGMP_PROCESS_EVENT_UPDATE_TIMER = 1,
  55 } igmp_process_event_t;
  56
  57 /**
  58  * pool of timers
  59  */
  60 static igmp_timer_t *timer_pool;
  61
  62 /**
  63  * Vector of pending timers
  64  */
  65 static u32 *pending_timers;
  66
  67 u32
  68 igmp_timer_type_get (igmp_timer_type_t t)
  69 {
  70   ASSERT (t < IGMP_N_TIMERS);
  71   return (igmp_default_timer_values[t]);
  72 }
  73
  74 void
  75 igmp_timer_type_set (igmp_timer_type_t t, u32 v)
  76 {
  77   ASSERT (t < IGMP_N_TIMERS);
  78   igmp_default_timer_values[t] = v;
  79 }
  80
  81
  82 static int
  83 igmp_timer_compare (const void *_v1, const void *_v2)
  84 {
  85   const u32 *i1 = _v1, *i2 = _v2;
  86   const igmp_timer_t *t1, *t2;
  87   f64 dt;
  88
  89   t1 = pool_elt_at_index (timer_pool, *i1);
  90   t2 = pool_elt_at_index (timer_pool, *i2);
  91
  92   dt = t2->exp_time - t1->exp_time;
  93
  94   return (dt < 0 ? -1 : (dt > 0 ? +1 : 0));
  95 }
  96
  97 /** \brief igmp get next timer
  98     @param im - igmp main
  99
 100     Get next timer.
 101 */
 102 u32
 103 igmp_get_next_timer (void)
 104 {
 105   if (0 == vec_len (pending_timers))
 106     return (IGMP_TIMER_ID_INVALID);
 107
 108   return (pending_timers[vec_len (pending_timers) - 1]);
 109 }
 110
 111 void *
 112 igmp_timer_get_data (igmp_timer_id_t tid)
 113 {
 114   igmp_timer_t *timer;
 115
 116   timer = pool_elt_at_index (timer_pool, tid);
 117
 118   return (timer->data);
 119 }
 120
 121 void
 122 igmp_timer_set_data (igmp_timer_id_t tid, void *data)
 123 {
 124   igmp_timer_t *timer;
 125
 126   timer = pool_elt_at_index (timer_pool, tid);
 127
 128   timer->data = data;
 129 }
 130
 131 int
 132 igmp_timer_is_running (igmp_timer_id_t tid)
 133 {
 134   return (IGMP_TIMER_ID_INVALID == tid);
 135 }
 136
 137 /** \brief igmp timer process
 138     @param vm - vlib main
 139     @param rt - vlib runtime node
 140     @param f - vlib frame
 141
 142     Handle igmp timers.
 143 */
 144 static uword
 145 igmp_timer_process (vlib_main_t * vm, vlib_node_runtime_t * rt,
 146                     vlib_frame_t * f)
 147 {
 148   uword *event_data = 0, event_type;
 149   igmp_timer_id_t tid;
 150   igmp_timer_t *timer;
 151
 152   tid = IGMP_TIMER_ID_INVALID;
 153
 154   while (1)
 155     {
 156       /* suspend util timer expires */
 157       if (IGMP_TIMER_ID_INVALID != tid)
 158         {
 159           timer = pool_elt_at_index (timer_pool, tid);
 160           vlib_process_wait_for_event_or_clock
 161             (vm, timer->exp_time - vlib_time_now (vm));
 162         }
 163       else
 164         vlib_process_wait_for_event (vm);
 165
 166       event_type = vlib_process_get_events (vm, &event_data);
 167       vec_reset_length (event_data);
 168
 169       if (event_type == IGMP_PROCESS_EVENT_UPDATE_TIMER)
 170         goto next_timer;
 171
 172       /* timer expired */
 173       ASSERT (tid != IGMP_TIMER_ID_INVALID);
 174
 175       timer = pool_elt_at_index (timer_pool, tid);
 176       ASSERT (timer->func != NULL);
 177       timer->func (timer->obj, timer->data);
 178
 179     next_timer:
 180       tid = igmp_get_next_timer ();
 181     }
 182   return 0;
 183 }
 184
 185 /* *INDENT-OFF* */
 186 VLIB_REGISTER_NODE (igmp_timer_process_node) =
 187 {
 188   .function = igmp_timer_process,
 189   .type = VLIB_NODE_TYPE_PROCESS,
 190   .name = "igmp-timer-process",
 191   .n_next_nodes = 0,
 192 };
 193 /* *INDENT-ON* */
 194
 195 igmp_timer_id_t
 196 igmp_timer_schedule (f64 when, u32 obj, igmp_timer_function_t fn, void *data)
 197 {
 198   igmp_timer_t *timer;
 199   vlib_main_t *vm;
 200
 201   ASSERT (fn);
 202
 203   vm = vlib_get_main ();
 204   pool_get (timer_pool, timer);
 205
 206   timer->exp_time = vlib_time_now (vm) + when;
 207   timer->obj = obj;
 208   timer->func = fn;
 209   timer->data = data;
 210
 211   vec_add1 (pending_timers, timer - timer_pool);
 212
 213   vec_sort_with_function (pending_timers, igmp_timer_compare);
 214
 215   vlib_process_signal_event (vm, igmp_timer_process_node.index,
 216                              IGMP_PROCESS_EVENT_UPDATE_TIMER, 0);
 217
 218   return (timer - timer_pool);
 219 }
 220
 221 void
 222 igmp_timer_retire (igmp_timer_id_t * tid)
 223 {
 224   if (IGMP_TIMER_ID_INVALID == *tid)
 225     return;
 226   vec_del1 (pending_timers, vec_search (pending_timers, *tid));
 227   pool_put_index (timer_pool, *tid);
 228   *tid = IGMP_TIMER_ID_INVALID;
 229
 230   vlib_process_signal_event (vlib_get_main (),
 231                              igmp_timer_process_node.index,
 232                              IGMP_PROCESS_EVENT_UPDATE_TIMER, 0);
 233 }
 234
 235 /*
 236  * fd.io coding-style-patch-verification: ON
 237  *
 238  * Local Variables:
 239  * eval: (c-set-style "gnu")
 240  * End:
 241  */