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   /* Shouldn't happen */
 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   if (callback_vector_arg == 0)
 529     {
 530       _vec_len (tw->expired_timer_handles) = 0;
 531       callback_vector = tw->expired_timer_handles;
 532     }
 533   else
 534     callback_vector = callback_vector_arg;
 535
 536   for (i = 0; i < nticks; i++)
 537     {
 538       fast_wheel_index = tw->current_index[TW_TIMER_RING_FAST];
 539       if (TW_TIMER_WHEELS > 1)
 540         slow_wheel_index = tw->current_index[TW_TIMER_RING_SLOW];
 541       if (TW_TIMER_WHEELS > 2)
 542         glacier_wheel_index = tw->current_index[TW_TIMER_RING_GLACIER];
 543
 544 #if TW_OVERFLOW_VECTOR > 0
 545       /* Triple odometer-click? Process the overflow vector... */
 546       if (PREDICT_FALSE (fast_wheel_index == TW_SLOTS_PER_RING
 547                          && slow_wheel_index == TW_SLOTS_PER_RING
 548                          && glacier_wheel_index == TW_SLOTS_PER_RING))
 549         {
 550           u64 interval;
 551           u32 new_glacier_ring_offset, new_slow_ring_offset;
 552           u32 new_fast_ring_offset;
 553
 554           ts = &tw->overflow;
 555           head = pool_elt_at_index (tw->timers, ts->head_index);
 556           next_index = head->next;
 557
 558           /* Make slot empty */
 559           head->next = head->prev = ts->head_index;
 560
 561           /* traverse slot, place timers wherever they go */
 562           while (next_index != head - tw->timers)
 563             {
 564               t = pool_elt_at_index (tw->timers, next_index);
 565               next_index = t->next;
 566
 567               /* Remove from the overflow vector (hammer) */
 568               t->next = t->prev = ~0;
 569
 570               ASSERT (t->expiration_time >= tw->current_tick);
 571
 572               interval = t->expiration_time - tw->current_tick;
 573
 574               /* Right back onto the overflow vector? */
 575               if (interval >= (1 << (3 * TW_RING_SHIFT)))
 576                 {
 577                   ts = &tw->overflow;
 578                   timer_addhead (tw->timers, ts->head_index, t - tw->timers);
 579                   continue;
 580                 }
 581               /* Compute ring offsets */
 582               new_glacier_ring_offset = interval >> (2 * TW_RING_SHIFT);
 583
 584               interval -= (new_glacier_ring_offset << (2 * TW_RING_SHIFT));
 585
 586               /* Note: the wheels are at (0,0,0), no add-with-carry needed */
 587               new_slow_ring_offset = interval >> TW_RING_SHIFT;
 588               interval -= (new_slow_ring_offset << TW_RING_SHIFT);
 589               new_fast_ring_offset = interval & TW_RING_MASK;
 590               t->slow_ring_offset = new_slow_ring_offset;
 591               t->fast_ring_offset = new_fast_ring_offset;
 592
 593               /* Timer expires Right Now */
 594               if (PREDICT_FALSE (t->slow_ring_offset == 0 &&
 595                                  t->fast_ring_offset == 0 &&
 596                                  new_glacier_ring_offset == 0))
 597                 {
 598                   vec_add1 (callback_vector, t->user_handle);
 599 #if TW_START_STOP_TRACE_SIZE > 0
 600                   TW (tw_timer_trace) (tw, 0xfe, t->user_handle,
 601                                        t - tw->timers);
 602 #endif
 603                   pool_put (tw->timers, t);
 604                 }
 605               /* Timer moves to the glacier ring */
 606               else if (new_glacier_ring_offset)
 607                 {
 608                   ts = &tw->w[TW_TIMER_RING_GLACIER][new_glacier_ring_offset];
 609                   timer_addhead (tw->timers, ts->head_index, t - tw->timers);
 610                 }
 611               /* Timer moves to the slow ring */
 612               else if (t->slow_ring_offset)
 613                 {
 614                   /* Add to slow ring */
 615                   ts = &tw->w[TW_TIMER_RING_SLOW][t->slow_ring_offset];
 616                   timer_addhead (tw->timers, ts->head_index, t - tw->timers);
 617                 }
 618               /* Timer timer moves to the fast ring */
 619               else
 620                 {
 621                   ts = &tw->w[TW_TIMER_RING_FAST][t->fast_ring_offset];
 622                   timer_addhead (tw->timers, ts->head_index, t - tw->timers);
 623 #if TW_FAST_WHEEL_BITMAP
 624                   tw->fast_slot_bitmap =
 625                     clib_bitmap_set (tw->fast_slot_bitmap,
 626                                      t->fast_ring_offset, 1);
 627 #endif
 628                 }
 629             }
 630         }
 631 #endif
 632
 633 #if TW_TIMER_WHEELS > 2
 634       /*
 635        * Double odometer-click? Process one slot in the glacier ring...
 636        */
 637       if (PREDICT_FALSE (fast_wheel_index == TW_SLOTS_PER_RING
 638                          && slow_wheel_index == TW_SLOTS_PER_RING))
 639         {
 640           glacier_wheel_index %= TW_SLOTS_PER_RING;
 641           ts = &tw->w[TW_TIMER_RING_GLACIER][glacier_wheel_index];
 642
 643           head = pool_elt_at_index (tw->timers, ts->head_index);
 644           next_index = head->next;
 645
 646           /* Make slot empty */
 647           head->next = head->prev = ts->head_index;
 648
 649           /* traverse slot, deal timers into slow ring */
 650           while (next_index != head - tw->timers)
 651             {
 652               t = pool_elt_at_index (tw->timers, next_index);
 653               next_index = t->next;
 654
 655               /* Remove from glacier ring slot (hammer) */
 656               t->next = t->prev = ~0;
 657
 658               /* Timer expires Right Now */
 659               if (PREDICT_FALSE (t->slow_ring_offset == 0 &&
 660                                  t->fast_ring_offset == 0))
 661                 {
 662                   vec_add1 (callback_vector, t->user_handle);
 663 #if TW_START_STOP_TRACE_SIZE > 0
 664                   TW (tw_timer_trace) (tw, 0xfe, t->user_handle,
 665                                        t - tw->timers);
 666 #endif
 667                   pool_put (tw->timers, t);
 668                 }
 669               /* Timer expires during slow-wheel tick 0 */
 670               else if (PREDICT_FALSE (t->slow_ring_offset == 0))
 671                 {
 672                   ts = &tw->w[TW_TIMER_RING_FAST][t->fast_ring_offset];
 673                   timer_addhead (tw->timers, ts->head_index, t - tw->timers);
 674 #if TW_FAST_WHEEL_BITMAP
 675                   tw->fast_slot_bitmap =
 676                     clib_bitmap_set (tw->fast_slot_bitmap,
 677                                      t->fast_ring_offset, 1);
 678 #endif
 679                 }
 680               else              /* typical case */
 681                 {
 682                   /* Add to slow ring */
 683                   ts = &tw->w[TW_TIMER_RING_SLOW][t->slow_ring_offset];
 684                   timer_addhead (tw->timers, ts->head_index, t - tw->timers);
 685                 }
 686             }
 687         }
 688 #endif
 689
 690 #if TW_TIMER_WHEELS > 1
 691       /*
 692        * Single odometer-click? Process a slot in the slow ring,
 693        */
 694       if (PREDICT_FALSE (fast_wheel_index == TW_SLOTS_PER_RING))
 695         {
 696           slow_wheel_index %= TW_SLOTS_PER_RING;
 697           ts = &tw->w[TW_TIMER_RING_SLOW][slow_wheel_index];
 698
 699           head = pool_elt_at_index (tw->timers, ts->head_index);
 700           next_index = head->next;
 701
 702           /* Make slot empty */
 703           head->next = head->prev = ts->head_index;
 704
 705           /* traverse slot, deal timers into fast ring */
 706           while (next_index != head - tw->timers)
 707             {
 708               t = pool_elt_at_index (tw->timers, next_index);
 709               next_index = t->next;
 710
 711               /* Remove from sloe ring slot (hammer) */
 712               t->next = t->prev = ~0;
 713
 714               /* Timer expires Right Now */
 715               if (PREDICT_FALSE (t->fast_ring_offset == 0))
 716                 {
 717                   vec_add1 (callback_vector, t->user_handle);
 718 #if TW_START_STOP_TRACE_SIZE > 0
 719                   TW (tw_timer_trace) (tw, 0xfe, t->user_handle,
 720                                        t - tw->timers);
 721 #endif
 722                   pool_put (tw->timers, t);
 723                 }
 724               else              /* typical case */
 725                 {
 726                   /* Add to fast ring */
 727                   ts = &tw->w[TW_TIMER_RING_FAST][t->fast_ring_offset];
 728                   timer_addhead (tw->timers, ts->head_index, t - tw->timers);
 729 #if TW_FAST_WHEEL_BITMAP
 730                   tw->fast_slot_bitmap =
 731                     clib_bitmap_set (tw->fast_slot_bitmap,
 732                                      t->fast_ring_offset, 1);
 733 #endif
 734                 }
 735             }
 736         }
 737 #endif
 738
 739       /* Handle the fast ring */
 740       fast_wheel_index %= TW_SLOTS_PER_RING;
 741       ts = &tw->w[TW_TIMER_RING_FAST][fast_wheel_index];
 742
 743       head = pool_elt_at_index (tw->timers, ts->head_index);
 744       next_index = head->next;
 745
 746       /* Make slot empty */
 747       head->next = head->prev = ts->head_index;
 748
 749       /* Construct vector of expired timer handles to give the user */
 750       while (next_index != ts->head_index)
 751         {
 752           t = pool_elt_at_index (tw->timers, next_index);
 753           next_index = t->next;
 754           vec_add1 (callback_vector, t->user_handle);
 755 #if TW_START_STOP_TRACE_SIZE > 0
 756           TW (tw_timer_trace) (tw, 0xfe, t->user_handle, t - tw->timers);
 757 #endif
 758           pool_put (tw->timers, t);
 759         }
 760
 761       /* If any timers expired, tell the user */
 762       if (callback_vector_arg == 0 && vec_len (callback_vector))
 763         {
 764           /* The callback is optional. We return the u32 * handle vector */
 765           if (tw->expired_timer_callback)
 766             {
 767               tw->expired_timer_callback (callback_vector);
 768               vec_reset_length (callback_vector);
 769             }
 770           tw->expired_timer_handles = callback_vector;
 771         }
 772
 773 #if TW_FAST_WHEEL_BITMAP
 774       tw->fast_slot_bitmap = clib_bitmap_set (tw->fast_slot_bitmap,
 775                                               fast_wheel_index, 0);
 776 #endif
 777
 778       tw->current_tick++;
 779       fast_wheel_index++;
 780       tw->current_index[TW_TIMER_RING_FAST] = fast_wheel_index;
 781
 782 #if TW_TIMER_WHEELS > 1
 783       if (PREDICT_FALSE (fast_wheel_index == TW_SLOTS_PER_RING))
 784         slow_wheel_index++;
 785       tw->current_index[TW_TIMER_RING_SLOW] = slow_wheel_index;
 786 #endif
 787
 788 #if TW_TIMER_WHEELS > 2
 789       if (PREDICT_FALSE (slow_wheel_index == TW_SLOTS_PER_RING))
 790         glacier_wheel_index++;
 791       tw->current_index[TW_TIMER_RING_GLACIER] = glacier_wheel_index;
 792 #endif
 793
 794       if (vec_len (callback_vector) >= tw->max_expirations)
 795         break;
 796     }
 797
 798   if (callback_vector_arg == 0)
 799     tw->expired_timer_handles = callback_vector;
 800
 801   tw->last_run_time += i * tw->timer_interval;
 802   return callback_vector;
 803 }
 804
 805 u32 *TW (tw_timer_expire_timers) (TWT (tw_timer_wheel) * tw, f64 now)
 806 {
 807   return TW (tw_timer_expire_timers_internal) (tw, now, 0 /* no vector */ );
 808 }
 809
 810 u32 *TW (tw_timer_expire_timers_vec) (TWT (tw_timer_wheel) * tw, f64 now,
 811                                       u32 * vec)
 812 {
 813   return TW (tw_timer_expire_timers_internal) (tw, now, vec);
 814 }
 815
 816 #if TW_FAST_WHEEL_BITMAP
 817 /** Returns an approximation to the first timer expiration in
 818  * timer-ticks from "now". To avoid wasting an unjustifiable
 819  * amount of time on the problem, we maintain an approximate fast-wheel slot
 820  * occupancy bitmap. We don't worry about clearing fast wheel bits
 821  * when timers are removed from fast wheel slots.
 822  */
 823
 824 u32 TW (tw_timer_first_expires_in_ticks) (TWT (tw_timer_wheel) * tw)
 825 {
 826   u32 first_expiring_index, fast_ring_index;
 827   i32 delta;
 828
 829 #if TW_TIMER_WHEELS > 1
 830   fast_ring_index = tw->current_index[TW_TIMER_RING_FAST];
 831   if (fast_ring_index == TW_SLOTS_PER_RING)
 832     return 1;
 833
 834   first_expiring_index = clib_bitmap_next_set (tw->fast_slot_bitmap,
 835                                                fast_ring_index);
 836   if (first_expiring_index == ~0)
 837     first_expiring_index = TW_SLOTS_PER_RING;
 838
 839 #else
 840
 841   if (clib_bitmap_is_zero (tw->fast_slot_bitmap))
 842     return TW_SLOTS_PER_RING;
 843
 844   fast_ring_index = tw->current_index[TW_TIMER_RING_FAST];
 845   if (fast_ring_index == TW_SLOTS_PER_RING)
 846     fast_ring_index = 0;
 847
 848   first_expiring_index = clib_bitmap_next_set (tw->fast_slot_bitmap,
 849                                                fast_ring_index);
 850   if (first_expiring_index == ~0 && fast_ring_index != 0)
 851     first_expiring_index = clib_bitmap_first_set (tw->fast_slot_bitmap);
 852 #endif
 853
 854   ASSERT (first_expiring_index != ~0);
 855
 856   delta = (i32) first_expiring_index - (i32) fast_ring_index;
 857   if (delta < 0)
 858     delta += TW_SLOTS_PER_RING;
 859
 860   ASSERT (delta >= 0);
 861
 862   return (u32) delta;
 863 }
 864
 865 #endif
 866
 867 /*
 868  * fd.io coding-style-patch-verification: ON
 869  *
 870  * Local Variables:
 871  * eval: (c-set-style "gnu")
 872  * End:
 873  */