src/vppinfra/tw_timer_template.c

   1 /*
   2  * Copyright (c) 2016 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15
  16 /** @file
  17  *  @brief TW timer implementation TEMPLATE ONLY, do not compile directly
  18  *
  19  *
  20  */
  21 #if TW_START_STOP_TRACE_SIZE > 0
  22
  23 void TW (tw_timer_trace) (TWT (tw_timer_wheel) * tw, u32 timer_id,
  24                           u32 pool_index, u32 handle)
  25 {
  26   TWT (trace) * t = &tw->traces[tw->trace_index];
  27
  28   t->timer_id = timer_id;
  29   t->pool_index = pool_index;
  30   t->handle = handle;
  31
  32   tw->trace_index++;
  33   if (tw->trace_index == TW_START_STOP_TRACE_SIZE)
  34     {
  35       tw->trace_index = 0;
  36       tw->trace_wrapped++;
  37     }
  38 }
  39
  40 void TW (tw_search_trace) (TWT (tw_timer_wheel) * tw, u32 handle)
  41 {
  42   u32 i, start_pos;
  43   TWT (trace) * t;
  44   char *s = "bogus!";
  45
  46   /* reverse search for the supplied handle */
  47
  48   start_pos = tw->trace_index;
  49   if (start_pos == 0)
  50     start_pos = TW_START_STOP_TRACE_SIZE - 1;
  51   else
  52     start_pos--;
  53
  54   for (i = start_pos; i > 0; i--)
  55     {
  56       t = &tw->traces[i];
  57       if (t->handle == handle)
  58         {
  59           switch (t->timer_id)
  60             {
  61             case 0xFF:
  62               s = "stopped";
  63               break;
  64             case 0xFE:
  65               s = "expired";
  66               break;
  67             default:
  68               s = "started";
  69               break;
  70             }
  71           fformat (stderr, "handle 0x%x (%d) %s at trace %d\n",
  72                    handle, handle, s, i);
  73         }
  74     }
  75   if (tw->trace_wrapped > 0)
  76     {
  77       for (i = TW_START_STOP_TRACE_SIZE; i >= tw->trace_index; i--)
  78         {
  79           t = &tw->traces[i];
  80           if (t->handle == handle)
  81             {
  82               switch (t->timer_id)
  83                 {
  84                 case 0xFF:
  85                   s = "stopped";
  86                   break;
  87                 case 0xFE:
  88                   s = "expired";
  89                   break;
  90                 default:
  91                   s = "started";
  92                   break;
  93                 }
  94               fformat (stderr, "handle 0x%x (%d) %s at trace %d\n",
  95                        handle, handle, s, i);
  96             }
  97         }
  98     }
  99 }
 100 #endif /* TW_START_STOP_TRACE_SIZE > 0 */
 101
 102 static inline u32
 103 TW (make_internal_timer_handle) (u32 pool_index, u32 timer_id)
 104 {
 105   u32 handle;
 106
 107   ASSERT (timer_id < TW_TIMERS_PER_OBJECT);
 108 #if LOG2_TW_TIMERS_PER_OBJECT > 0
 109   ASSERT (pool_index < (1 << (32 - LOG2_TW_TIMERS_PER_OBJECT)));
 110
 111   handle = (timer_id << (32 - LOG2_TW_TIMERS_PER_OBJECT)) | (pool_index);
 112 #else
 113   handle = pool_index;
 114 #endif
 115   return handle;
 116 }
 117
 118 static inline void
 119 timer_addhead (TWT (tw_timer) * pool, u32 head_index, u32 new_index)
 120 {
 121   TWT (tw_timer) * head = pool_elt_at_index (pool, head_index);
 122   TWT (tw_timer) * old_first;
 123   u32 old_first_index;
 124   TWT (tw_timer) * new;
 125
 126   new = pool_elt_at_index (pool, new_index);
 127
 128   if (PREDICT_FALSE (head->next == head_index))
 129     {
 130       head->next = head->prev = new_index;
 131       new->next = new->prev = head_index;
 132       return;
 133     }
 134
 135   old_first_index = head->next;
 136   old_first = pool_elt_at_index (pool, old_first_index);
 137
 138   new->next = old_first_index;
 139   new->prev = old_first->prev;
 140   old_first->prev = new_index;
 141   head->next = new_index;
 142 }
 143
 144 static inline void
 145 timer_remove (TWT (tw_timer) * pool, TWT (tw_timer) * elt)
 146 {
 147   TWT (tw_timer) * next_elt, *prev_elt;
 148
 149   ASSERT (elt->user_handle != ~0);
 150
 151   next_elt = pool_elt_at_index (pool, elt->next);
 152   prev_elt = pool_elt_at_index (pool, elt->prev);
 153
 154   next_elt->prev = elt->prev;
 155   prev_elt->next = elt->next;
 156
 157   elt->prev = elt->next = ~0;
 158 }
 159
 160 static inline void
 161 timer_add (TWT (tw_timer_wheel) * tw, TWT (tw_timer) * t, u64 interval)
 162 {
 163 #if TW_TIMER_WHEELS > 1
 164   u16 slow_ring_offset;
 165   u32 carry;
 166 #endif
 167 #if TW_TIMER_WHEELS > 2
 168   u16 glacier_ring_offset;
 169 #endif
 170 #if TW_OVERFLOW_VECTOR > 0
 171   u64 interval_plus_time_to_wrap, triple_wrap_mask;
 172 #endif
 173   u16 fast_ring_offset;
 174   tw_timer_wheel_slot_t *ts;
 175
 176   /* Factor interval into 1..3 wheel offsets */
 177 #if TW_TIMER_WHEELS > 2
 178 #if TW_OVERFLOW_VECTOR > 0
 179   /*
 180    * This is tricky. Put a timer onto the overflow
 181    * vector if the interval PLUS the time
 182    * until the next triple-wrap exceeds one full revolution
 183    * of all three wheels.
 184    */
 185   triple_wrap_mask = (1 << (3 * TW_RING_SHIFT)) - 1;
 186   interval_plus_time_to_wrap =
 187     interval + (tw->current_tick & triple_wrap_mask);
 188   if ((interval_plus_time_to_wrap >= 1 << (3 * TW_RING_SHIFT)))
 189     {
 190       t->expiration_time = tw->current_tick + interval;
 191       ts = &tw->overflow;
 192       timer_addhead (tw->timers, ts->head_index, t - tw->timers);
 193 #if TW_START_STOP_TRACE_SIZE > 0
 194       TW (tw_timer_trace) (tw, timer_id, user_id, t - tw->timers);
 195 #endif
 196       return;
 197     }
 198 #endif
 199
 200   glacier_ring_offset = interval >> (2 * TW_RING_SHIFT);
 201   ASSERT ((u64) glacier_ring_offset < TW_SLOTS_PER_RING);
 202   interval -= (((u64) glacier_ring_offset) << (2 * TW_RING_SHIFT));
 203 #endif
 204 #if TW_TIMER_WHEELS > 1
 205   slow_ring_offset = interval >> TW_RING_SHIFT;
 206   ASSERT ((u64) slow_ring_offset < TW_SLOTS_PER_RING);
 207   interval -= (((u64) slow_ring_offset) << TW_RING_SHIFT);
 208 #endif
 209   fast_ring_offset = interval & TW_RING_MASK;
 210
 211   /*
 212    * Account for the current wheel positions(s)
 213    * This is made slightly complicated by the fact that the current
 214    * index vector will contain (TW_SLOTS_PER_RING, ...) when
 215    * the actual position is (0, ...)
 216    */
 217
 218   fast_ring_offset += tw->current_index[TW_TIMER_RING_FAST] & TW_RING_MASK;
 219
 220 #if TW_TIMER_WHEELS > 1
 221   carry = fast_ring_offset >= TW_SLOTS_PER_RING ? 1 : 0;
 222   fast_ring_offset %= TW_SLOTS_PER_RING;
 223   slow_ring_offset += (tw->current_index[TW_TIMER_RING_SLOW] & TW_RING_MASK)
 224     + carry;
 225   carry = slow_ring_offset >= TW_SLOTS_PER_RING ? 1 : 0;
 226   slow_ring_offset %= TW_SLOTS_PER_RING;
 227 #endif
 228
 229 #if TW_TIMER_WHEELS > 2
 230   glacier_ring_offset +=
 231     (tw->current_index[TW_TIMER_RING_GLACIER] & TW_RING_MASK) + carry;
 232   glacier_ring_offset %= TW_SLOTS_PER_RING;
 233 #endif
 234
 235 #if TW_TIMER_WHEELS > 2
 236   if (glacier_ring_offset !=
 237       (tw->current_index[TW_TIMER_RING_GLACIER] & TW_RING_MASK))
 238     {
 239       /* We'll need slow and fast ring offsets later */
 240       t->slow_ring_offset = slow_ring_offset;
 241       t->fast_ring_offset = fast_ring_offset;
 242
 243       ts = &tw->w[TW_TIMER_RING_GLACIER][glacier_ring_offset];
 244
 245       timer_addhead (tw->timers, ts->head_index, t - tw->timers);
 246 #if TW_START_STOP_TRACE_SIZE > 0
 247       TW (tw_timer_trace) (tw, timer_id, user_id, t - tw->timers);
 248 #endif
 249       return;
 250     }
 251 #endif
 252
 253 #if TW_TIMER_WHEELS > 1
 254   /* Timer expires more than 51.2 seconds from now? */
 255   if (slow_ring_offset !=
 256       (tw->current_index[TW_TIMER_RING_SLOW] & TW_RING_MASK))
 257     {
 258       /* We'll need the fast ring offset later... */
 259       t->fast_ring_offset = fast_ring_offset;
 260
 261       ts = &tw->w[TW_TIMER_RING_SLOW][slow_ring_offset];
 262
 263       timer_addhead (tw->timers, ts->head_index, t - tw->timers);
 264 #if TW_START_STOP_TRACE_SIZE > 0
 265       TW (tw_timer_trace) (tw, timer_id, user_id, t - tw->timers);
 266 #endif
 267       return;
 268     }
 269 #else
 270   fast_ring_offset %= TW_SLOTS_PER_RING;
 271 #endif
 272
 273   /* Timer expires less than one fast-ring revolution from now */
 274   ts = &tw->w[TW_TIMER_RING_FAST][fast_ring_offset];
 275
 276   timer_addhead (tw->timers, ts->head_index, t - tw->timers);
 277
 278 #if TW_FAST_WHEEL_BITMAP
 279   tw->fast_slot_bitmap = clib_bitmap_set (tw->fast_slot_bitmap,
 280                                           fast_ring_offset, 1);
 281 #endif
 282 #if TW_START_STOP_TRACE_SIZE > 0
 283   TW (tw_timer_trace) (tw, timer_id, user_id, t - tw->timers);
 284 #endif
 285 }
 286
 287 /**
 288  * @brief Start a Tw Timer
 289  * @param tw_timer_wheel_t * tw timer wheel object pointer
 290  * @param u32 user_id user defined timer id, presumably for a tw session
 291  * @param u32 timer_id app-specific timer ID. 4 bits.
 292  * @param u64 interval timer interval in ticks
 293  * @returns handle needed to cancel the timer
 294  */
 295 u32
 296 TW (tw_timer_start) (TWT (tw_timer_wheel) * tw, u32 user_id, u32 timer_id,
 297                      u64 interval)
 298 {
 299   TWT (tw_timer) * t;
 300
 301   ASSERT (interval);
 302
 303   pool_get (tw->timers, t);
 304   clib_memset (t, 0xff, sizeof (*t));
 305
 306   t->user_handle = TW (make_internal_timer_handle) (user_id, timer_id);
 307
 308   timer_add (tw, t, interval);
 309   return t - tw->timers;
 310 }
 311
 312 #if TW_TIMER_SCAN_FOR_HANDLE > 0
 313 int TW (scan_for_handle) (TWT (tw_timer_wheel) * tw, u32 handle)
 314 {
 315   int i, j;
 316   tw_timer_wheel_slot_t *ts;
 317   TWT (tw_timer) * t, *head;
 318   u32 next_index;
 319   int rv = 0;
 320
 321   for (i = 0; i < TW_TIMER_WHEELS; i++)
 322     {
 323       for (j = 0; j < TW_SLOTS_PER_RING; j++)
 324         {
 325           ts = &tw->w[i][j];
 326           head = pool_elt_at_index (tw->timers, ts->head_index);
 327           next_index = head->next;
 328
 329           while (next_index != ts->head_index)
 330             {
 331               t = pool_elt_at_index (tw->timers, next_index);
 332               if (next_index == handle)
 333                 {
 334                   clib_warning ("handle %d found in ring %d slot %d",
 335                                 handle, i, j);
 336                   clib_warning ("user handle 0x%x", t->user_handle);
 337                   rv = 1;
 338                 }
 339               next_index = t->next;
 340             }
 341         }
 342     }
 343   return rv;
 344 }
 345 #endif /* TW_TIMER_SCAN_FOR_HANDLE */
 346
 347 /**
 348  * @brief Stop a tw timer
 349  * @param tw_timer_wheel_t * tw timer wheel object pointer
 350  * @param u32 handle timer cancellation returned by tw_timer_start
 351  */
 352 void TW (tw_timer_stop) (TWT (tw_timer_wheel) * tw, u32 handle)
 353 {
 354   TWT (tw_timer) * t;
 355
 356 #if TW_TIMER_ALLOW_DUPLICATE_STOP
 357   /*
 358    * A vlib process may have its timer expire, and receive
 359    * an event before the expiration is processed.
 360    * That results in a duplicate tw_timer_stop.
 361    */
 362   if (pool_is_free_index (tw->timers, handle))
 363     return;
 364 #endif
 365 #if TW_START_STOP_TRACE_SIZE > 0
 366   TW (tw_timer_trace) (tw, ~0, ~0, handle);
 367 #endif
 368
 369   t = pool_elt_at_index (tw->timers, handle);
 370
 371   /* in case of idiotic handle (e.g. passing a listhead index) */
 372   ASSERT (t->user_handle != ~0);
 373
 374   timer_remove (tw->timers, t);
 375
 376   pool_put_index (tw->timers, handle);
 377 }
 378
 379 int TW (tw_timer_handle_is_free) (TWT (tw_timer_wheel) * tw, u32 handle)
 380 {
 381   return pool_is_free_index (tw->timers, handle);
 382 }
 383
 384 /**
 385  * @brief Update a tw timer
 386  * @param tw_timer_wheel_t * tw timer wheel object pointer
 387  * @param u32 handle timer returned by tw_timer_start
 388  * @param u32 interval timer interval in ticks
 389  */
 390 void TW (tw_timer_update) (TWT (tw_timer_wheel) * tw, u32 handle,
 391                            u64 interval)
 392 {
 393   TWT (tw_timer) * t;
 394   t = pool_elt_at_index (tw->timers, handle);
 395   timer_remove (tw->timers, t);
 396   timer_add (tw, t, interval);
 397 }
 398
 399 /**
 400  * @brief Initialize a tw timer wheel template instance
 401  * @param tw_timer_wheel_t * tw timer wheel object pointer
 402  * @param void * expired_timer_callback. Passed a u32 * vector of
 403  *   expired timer handles. The callback is optional.
 404  * @param f64 timer_interval_in_seconds
 405  */
 406 void
 407 TW (tw_timer_wheel_init) (TWT (tw_timer_wheel) * tw,
 408                           void *expired_timer_callback,
 409                           f64 timer_interval_in_seconds, u32 max_expirations)
 410 {
 411   int ring, slot;
 412   tw_timer_wheel_slot_t *ts;
 413   TWT (tw_timer) * t;
 414   clib_memset (tw, 0, sizeof (*tw));
 415   tw->expired_timer_callback = expired_timer_callback;
 416   tw->max_expirations = max_expirations;
 417   if (timer_interval_in_seconds == 0.0)
 418     {
 419       clib_warning ("timer interval is zero");
 420       abort ();
 421     }
 422   tw->timer_interval = timer_interval_in_seconds;
 423   tw->ticks_per_second = 1.0 / timer_interval_in_seconds;
 424
 425   vec_validate (tw->expired_timer_handles, 0);
 426   _vec_len (tw->expired_timer_handles) = 0;
 427
 428   for (ring = 0; ring < TW_TIMER_WHEELS; ring++)
 429     {
 430       for (slot = 0; slot < TW_SLOTS_PER_RING; slot++)
 431         {
 432           ts = &tw->w[ring][slot];
 433           pool_get (tw->timers, t);
 434           clib_memset (t, 0xff, sizeof (*t));
 435           t->next = t->prev = t - tw->timers;
 436           ts->head_index = t - tw->timers;
 437         }
 438     }
 439
 440 #if TW_OVERFLOW_VECTOR > 0
 441   ts = &tw->overflow;
 442   pool_get (tw->timers, t);
 443   clib_memset (t, 0xff, sizeof (*t));
 444   t->next = t->prev = t - tw->timers;
 445   ts->head_index = t - tw->timers;
 446 #endif
 447 }
 448
 449 /**
 450  * @brief Free a tw timer wheel template instance
 451  * @param tw_timer_wheel_t * tw timer wheel object pointer
 452  */
 453 void TW (tw_timer_wheel_free) (TWT (tw_timer_wheel) * tw)
 454 {
 455   int i, j;
 456   tw_timer_wheel_slot_t *ts;
 457   TWT (tw_timer) * head, *t;
 458   u32 next_index;
 459
 460   for (i = 0; i < TW_TIMER_WHEELS; i++)
 461     {
 462       for (j = 0; j < TW_SLOTS_PER_RING; j++)
 463         {
 464           ts = &tw->w[i][j];
 465           head = pool_elt_at_index (tw->timers, ts->head_index);
 466           next_index = head->next;
 467
 468           while (next_index != ts->head_index)
 469             {
 470               t = pool_elt_at_index (tw->timers, next_index);
 471               next_index = t->next;
 472               pool_put (tw->timers, t);
 473             }
 474           pool_put (tw->timers, head);
 475         }
 476     }
 477
 478 #if TW_OVERFLOW_VECTOR > 0
 479   ts = &tw->overflow;
 480   head = pool_elt_at_index (tw->timers, ts->head_index);
 481   next_index = head->next;
 482
 483   while (next_index != ts->head_index)
 484     {
 485       t = pool_elt_at_index (tw->timers, next_index);
 486       next_index = t->next;
 487       pool_put (tw->timers, t);
 488     }
 489   pool_put (tw->timers, head);
 490 #endif
 491
 492   clib_memset (tw, 0, sizeof (*tw));
 493 }
 494
 495 /**
 496  * @brief Advance a tw timer wheel. Calls the expired timer callback
 497  * as needed. This routine should be called once every timer_interval seconds
 498  * @param tw_timer_wheel_t * tw timer wheel template instance pointer
 499  * @param f64 now the current time, e.g. from vlib_time_now(vm)
 500  * @returns u32 * vector of expired user handles
 501  */
 502 static inline
 503   u32 * TW (tw_timer_expire_timers_internal) (TWT (tw_timer_wheel) * tw,
 504                                               f64 now,
 505                                               u32 * callback_vector_arg)
 506 {
 507   u32 nticks, i;
 508   tw_timer_wheel_slot_t *ts;
 509   TWT (tw_timer) * t, *head;
 510   u32 *callback_vector;
 511   u32 fast_wheel_index;
 512   u32 next_index;
 513   u32 slow_wheel_index __attribute__ ((unused));
 514   u32 glacier_wheel_index __attribute__ ((unused));
 515
 516   /* Called too soon to process new timer expirations? */
 517   if (PREDICT_FALSE (now < tw->next_run_time))
 518     return callback_vector_arg;
 519
 520   /* Number of ticks which have occurred */
 521   nticks = tw->ticks_per_second * (now - tw->last_run_time);
 522   if (nticks == 0)
 523     return callback_vector_arg;
 524
 525   /* Remember when we ran, compute next runtime */
 526   tw->next_run_time = (now + tw->timer_interval);
 527
 528   /* First call, or time jumped backwards? */
 529   if (PREDICT_FALSE
 530       ((tw->last_run_time == 0.0) || (now <= tw->last_run_time)))
 531     {
 532       tw->last_run_time = now;
 533       return callback_vector_arg;
 534     }
 535
 536   /*
 537    * Refuse to do anything if we're about to process way too many slots.
 538    * Should never come anywhere close to happening, with the possible exception
 539    * of cases involving a large forward jump in the timebase.
 540    */
 541   if (nticks > (1 << (TW_RING_SHIFT + 1)))
 542     {
 543       if (nticks / tw->ticks_per_second > 100e-3)
 544         clib_warning ("Excessive nticks %u at %.6f last run %.6f",
 545                       nticks, now, tw->last_run_time);
 546       tw->last_run_time = now;
 547       return callback_vector_arg;
 548     }
 549
 550   if (callback_vector_arg == 0)
 551     {
 552       _vec_len (tw->expired_timer_handles) = 0;
 553       callback_vector = tw->expired_timer_handles;
 554     }
 555   else
 556     callback_vector = callback_vector_arg;
 557
 558   for (i = 0; i < nticks; i++)
 559     {
 560       fast_wheel_index = tw->current_index[TW_TIMER_RING_FAST];
 561       if (TW_TIMER_WHEELS > 1)
 562         slow_wheel_index = tw->current_index[TW_TIMER_RING_SLOW];
 563       if (TW_TIMER_WHEELS > 2)
 564         glacier_wheel_index = tw->current_index[TW_TIMER_RING_GLACIER];
 565
 566 #if TW_OVERFLOW_VECTOR > 0
 567       /* Triple odometer-click? Process the overflow vector... */
 568       if (PREDICT_FALSE (fast_wheel_index == TW_SLOTS_PER_RING
 569                          && slow_wheel_index == TW_SLOTS_PER_RING
 570                          && glacier_wheel_index == TW_SLOTS_PER_RING))
 571         {
 572           u64 interval;
 573           u32 new_glacier_ring_offset, new_slow_ring_offset;
 574           u32 new_fast_ring_offset;
 575
 576           ts = &tw->overflow;
 577           head = pool_elt_at_index (tw->timers, ts->head_index);
 578           next_index = head->next;
 579
 580           /* Make slot empty */
 581           head->next = head->prev = ts->head_index;
 582
 583           /* traverse slot, place timers wherever they go */
 584           while (next_index != head - tw->timers)
 585             {
 586               t = pool_elt_at_index (tw->timers, next_index);
 587               next_index = t->next;
 588
 589               /* Remove from the overflow vector (hammer) */
 590               t->next = t->prev = ~0;
 591
 592               ASSERT (t->expiration_time >= tw->current_tick);
 593
 594               interval = t->expiration_time - tw->current_tick;
 595
 596               /* Right back onto the overflow vector? */
 597               if (interval >= (1 << (3 * TW_RING_SHIFT)))
 598                 {
 599                   ts = &tw->overflow;
 600                   timer_addhead (tw->timers, ts->head_index, t - tw->timers);
 601                   continue;
 602                 }
 603               /* Compute ring offsets */
 604               new_glacier_ring_offset = interval >> (2 * TW_RING_SHIFT);
 605
 606               interval -= (new_glacier_ring_offset << (2 * TW_RING_SHIFT));
 607
 608               /* Note: the wheels are at (0,0,0), no add-with-carry needed */
 609               new_slow_ring_offset = interval >> TW_RING_SHIFT;
 610               interval -= (new_slow_ring_offset << TW_RING_SHIFT);
 611               new_fast_ring_offset = interval & TW_RING_MASK;
 612               t->slow_ring_offset = new_slow_ring_offset;
 613               t->fast_ring_offset = new_fast_ring_offset;
 614
 615               /* Timer expires Right Now */
 616               if (PREDICT_FALSE (t->slow_ring_offset == 0 &&
 617                                  t->fast_ring_offset == 0 &&
 618                                  new_glacier_ring_offset == 0))
 619                 {
 620                   vec_add1 (callback_vector, t->user_handle);
 621 #if TW_START_STOP_TRACE_SIZE > 0
 622                   TW (tw_timer_trace) (tw, 0xfe, t->user_handle,
 623                                        t - tw->timers);
 624 #endif
 625                   pool_put (tw->timers, t);
 626                 }
 627               /* Timer moves to the glacier ring */
 628               else if (new_glacier_ring_offset)
 629                 {
 630                   ts = &tw->w[TW_TIMER_RING_GLACIER][new_glacier_ring_offset];
 631                   timer_addhead (tw->timers, ts->head_index, t - tw->timers);
 632                 }
 633               /* Timer moves to the slow ring */
 634               else if (t->slow_ring_offset)
 635                 {
 636                   /* Add to slow ring */
 637                   ts = &tw->w[TW_TIMER_RING_SLOW][t->slow_ring_offset];
 638                   timer_addhead (tw->timers, ts->head_index, t - tw->timers);
 639                 }
 640               /* Timer timer moves to the fast ring */
 641               else
 642                 {
 643                   ts = &tw->w[TW_TIMER_RING_FAST][t->fast_ring_offset];
 644                   timer_addhead (tw->timers, ts->head_index, t - tw->timers);
 645 #if TW_FAST_WHEEL_BITMAP
 646                   tw->fast_slot_bitmap =
 647                     clib_bitmap_set (tw->fast_slot_bitmap,
 648                                      t->fast_ring_offset, 1);
 649 #endif
 650                 }
 651             }
 652         }
 653 #endif
 654
 655 #if TW_TIMER_WHEELS > 2
 656       /*
 657        * Double odometer-click? Process one slot in the glacier ring...
 658        */
 659       if (PREDICT_FALSE (fast_wheel_index == TW_SLOTS_PER_RING
 660                          && slow_wheel_index == TW_SLOTS_PER_RING))
 661         {
 662           glacier_wheel_index %= TW_SLOTS_PER_RING;
 663           ts = &tw->w[TW_TIMER_RING_GLACIER][glacier_wheel_index];
 664
 665           head = pool_elt_at_index (tw->timers, ts->head_index);
 666           next_index = head->next;
 667
 668           /* Make slot empty */
 669           head->next = head->prev = ts->head_index;
 670
 671           /* traverse slot, deal timers into slow ring */
 672           while (next_index != head - tw->timers)
 673             {
 674               t = pool_elt_at_index (tw->timers, next_index);
 675               next_index = t->next;
 676
 677               /* Remove from glacier ring slot (hammer) */
 678               t->next = t->prev = ~0;
 679
 680               /* Timer expires Right Now */
 681               if (PREDICT_FALSE (t->slow_ring_offset == 0 &&
 682                                  t->fast_ring_offset == 0))
 683                 {
 684                   vec_add1 (callback_vector, t->user_handle);
 685 #if TW_START_STOP_TRACE_SIZE > 0
 686                   TW (tw_timer_trace) (tw, 0xfe, t->user_handle,
 687                                        t - tw->timers);
 688 #endif
 689                   pool_put (tw->timers, t);
 690                 }
 691               /* Timer expires during slow-wheel tick 0 */
 692               else if (PREDICT_FALSE (t->slow_ring_offset == 0))
 693                 {
 694                   ts = &tw->w[TW_TIMER_RING_FAST][t->fast_ring_offset];
 695                   timer_addhead (tw->timers, ts->head_index, t - tw->timers);
 696 #if TW_FAST_WHEEL_BITMAP
 697                   tw->fast_slot_bitmap =
 698                     clib_bitmap_set (tw->fast_slot_bitmap,
 699                                      t->fast_ring_offset, 1);
 700 #endif
 701                 }
 702               else              /* typical case */
 703                 {
 704                   /* Add to slow ring */
 705                   ts = &tw->w[TW_TIMER_RING_SLOW][t->slow_ring_offset];
 706                   timer_addhead (tw->timers, ts->head_index, t - tw->timers);
 707                 }
 708             }
 709         }
 710 #endif
 711
 712 #if TW_TIMER_WHEELS > 1
 713       /*
 714        * Single odometer-click? Process a slot in the slow ring,
 715        */
 716       if (PREDICT_FALSE (fast_wheel_index == TW_SLOTS_PER_RING))
 717         {
 718           slow_wheel_index %= TW_SLOTS_PER_RING;
 719           ts = &tw->w[TW_TIMER_RING_SLOW][slow_wheel_index];
 720
 721           head = pool_elt_at_index (tw->timers, ts->head_index);
 722           next_index = head->next;
 723
 724           /* Make slot empty */
 725           head->next = head->prev = ts->head_index;
 726
 727           /* traverse slot, deal timers into fast ring */
 728           while (next_index != head - tw->timers)
 729             {
 730               t = pool_elt_at_index (tw->timers, next_index);
 731               next_index = t->next;
 732
 733               /* Remove from sloe ring slot (hammer) */
 734               t->next = t->prev = ~0;
 735
 736               /* Timer expires Right Now */
 737               if (PREDICT_FALSE (t->fast_ring_offset == 0))
 738                 {
 739                   vec_add1 (callback_vector, t->user_handle);
 740 #if TW_START_STOP_TRACE_SIZE > 0
 741                   TW (tw_timer_trace) (tw, 0xfe, t->user_handle,
 742                                        t - tw->timers);
 743 #endif
 744                   pool_put (tw->timers, t);
 745                 }
 746               else              /* typical case */
 747                 {
 748                   /* Add to fast ring */
 749                   ts = &tw->w[TW_TIMER_RING_FAST][t->fast_ring_offset];
 750                   timer_addhead (tw->timers, ts->head_index, t - tw->timers);
 751 #if TW_FAST_WHEEL_BITMAP
 752                   tw->fast_slot_bitmap =
 753                     clib_bitmap_set (tw->fast_slot_bitmap,
 754                                      t->fast_ring_offset, 1);
 755 #endif
 756                 }
 757             }
 758         }
 759 #endif
 760
 761       /* Handle the fast ring */
 762       fast_wheel_index %= TW_SLOTS_PER_RING;
 763       ts = &tw->w[TW_TIMER_RING_FAST][fast_wheel_index];
 764
 765       head = pool_elt_at_index (tw->timers, ts->head_index);
 766       next_index = head->next;
 767
 768       /* Make slot empty */
 769       head->next = head->prev = ts->head_index;
 770
 771       /* Construct vector of expired timer handles to give the user */
 772       while (next_index != ts->head_index)
 773         {
 774           t = pool_elt_at_index (tw->timers, next_index);
 775           next_index = t->next;
 776           vec_add1 (callback_vector, t->user_handle);
 777 #if TW_START_STOP_TRACE_SIZE > 0
 778           TW (tw_timer_trace) (tw, 0xfe, t->user_handle, t - tw->timers);
 779 #endif
 780           pool_put (tw->timers, t);
 781         }
 782
 783       /* If any timers expired, tell the user */
 784       if (callback_vector_arg == 0 && vec_len (callback_vector))
 785         {
 786           /* The callback is optional. We return the u32 * handle vector */
 787           if (tw->expired_timer_callback)
 788             {
 789               tw->expired_timer_callback (callback_vector);
 790               vec_reset_length (callback_vector);
 791             }
 792           tw->expired_timer_handles = callback_vector;
 793         }
 794
 795 #if TW_FAST_WHEEL_BITMAP
 796       tw->fast_slot_bitmap = clib_bitmap_set (tw->fast_slot_bitmap,
 797                                               fast_wheel_index, 0);
 798 #endif
 799
 800       tw->current_tick++;
 801       fast_wheel_index++;
 802       tw->current_index[TW_TIMER_RING_FAST] = fast_wheel_index;
 803
 804 #if TW_TIMER_WHEELS > 1
 805       if (PREDICT_FALSE (fast_wheel_index == TW_SLOTS_PER_RING))
 806         slow_wheel_index++;
 807       tw->current_index[TW_TIMER_RING_SLOW] = slow_wheel_index;
 808 #endif
 809
 810 #if TW_TIMER_WHEELS > 2
 811       if (PREDICT_FALSE (slow_wheel_index == TW_SLOTS_PER_RING))
 812         glacier_wheel_index++;
 813       tw->current_index[TW_TIMER_RING_GLACIER] = glacier_wheel_index;
 814 #endif
 815
 816       if (vec_len (callback_vector) >= tw->max_expirations)
 817         break;
 818     }
 819
 820   if (callback_vector_arg == 0)
 821     tw->expired_timer_handles = callback_vector;
 822
 823   tw->last_run_time += i * tw->timer_interval;
 824   return callback_vector;
 825 }
 826
 827 u32 *TW (tw_timer_expire_timers) (TWT (tw_timer_wheel) * tw, f64 now)
 828 {
 829   return TW (tw_timer_expire_timers_internal) (tw, now, 0 /* no vector */ );
 830 }
 831
 832 u32 *TW (tw_timer_expire_timers_vec) (TWT (tw_timer_wheel) * tw, f64 now,
 833                                       u32 * vec)
 834 {
 835   return TW (tw_timer_expire_timers_internal) (tw, now, vec);
 836 }
 837
 838 #if TW_FAST_WHEEL_BITMAP
 839 /** Returns an approximation to the first timer expiration in
 840  * timer-ticks from "now". To avoid wasting an unjustifiable
 841  * amount of time on the problem, we maintain an approximate fast-wheel slot
 842  * occupancy bitmap. We don't worry about clearing fast wheel bits
 843  * when timers are removed from fast wheel slots.
 844  */
 845
 846 u32 TW (tw_timer_first_expires_in_ticks) (TWT (tw_timer_wheel) * tw)
 847 {
 848   u32 first_expiring_index, fast_ring_index;
 849   i32 delta;
 850
 851 #if TW_TIMER_WHEELS > 1
 852   fast_ring_index = tw->current_index[TW_TIMER_RING_FAST];
 853   if (fast_ring_index == TW_SLOTS_PER_RING)
 854     return 1;
 855
 856   first_expiring_index = clib_bitmap_next_set (tw->fast_slot_bitmap,
 857                                                fast_ring_index);
 858   if (first_expiring_index == ~0)
 859     first_expiring_index = TW_SLOTS_PER_RING;
 860
 861 #else
 862
 863   if (clib_bitmap_is_zero (tw->fast_slot_bitmap))
 864     return TW_SLOTS_PER_RING;
 865
 866   fast_ring_index = tw->current_index[TW_TIMER_RING_FAST];
 867   if (fast_ring_index == TW_SLOTS_PER_RING)
 868     fast_ring_index = 0;
 869
 870   first_expiring_index = clib_bitmap_next_set (tw->fast_slot_bitmap,
 871                                                fast_ring_index);
 872   if (first_expiring_index == ~0 && fast_ring_index != 0)
 873     first_expiring_index = clib_bitmap_first_set (tw->fast_slot_bitmap);
 874 #endif
 875
 876   ASSERT (first_expiring_index != ~0);
 877
 878   delta = (i32) first_expiring_index - (i32) fast_ring_index;
 879   if (delta < 0)
 880     delta += TW_SLOTS_PER_RING;
 881
 882   ASSERT (delta >= 0);
 883
 884   return (u32) delta;
 885 }
 886
 887 #endif
 888
 889 /*
 890  * fd.io coding-style-patch-verification: ON
 891  *
 892  * Local Variables:
 893  * eval: (c-set-style "gnu")
 894  * End:
 895  */