FD.io VPP  v21.06-3-gbb25fbf28
Vector Packet Processing
tw_timer_template.c
Go to the documentation of this file.
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;
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 __clib_export 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;
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 __clib_export 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 __clib_export int
380 TW (tw_timer_handle_is_free) (TWT (tw_timer_wheel) * tw, u32 handle)
381 {
382  return pool_is_free_index (tw->timers, handle);
383 }
384 
385 /**
386  * @brief Update a tw timer
387  * @param tw_timer_wheel_t * tw timer wheel object pointer
388  * @param u32 handle timer returned by tw_timer_start
389  * @param u32 interval timer interval in ticks
390  */
391 __clib_export void
392 TW (tw_timer_update) (TWT (tw_timer_wheel) * tw, u32 handle, u64 interval)
393 {
394  TWT (tw_timer) * t;
395  t = pool_elt_at_index (tw->timers, handle);
396  timer_remove (tw->timers, t);
397  timer_add (tw, t, interval);
398 }
399 
400 /**
401  * @brief Initialize a tw timer wheel template instance
402  * @param tw_timer_wheel_t * tw timer wheel object pointer
403  * @param void * expired_timer_callback. Passed a u32 * vector of
404  * expired timer handles. The callback is optional.
405  * @param f64 timer_interval_in_seconds
406  */
407 __clib_export void
408 TW (tw_timer_wheel_init) (TWT (tw_timer_wheel) * tw,
410  f64 timer_interval_in_seconds, u32 max_expirations)
411 {
412  int ring, slot;
414  TWT (tw_timer) * t;
415  clib_memset (tw, 0, sizeof (*tw));
416  tw->expired_timer_callback = expired_timer_callback;
417  tw->max_expirations = max_expirations;
418  if (timer_interval_in_seconds == 0.0)
419  {
420  clib_warning ("timer interval is zero");
421  abort ();
422  }
423  tw->timer_interval = timer_interval_in_seconds;
424  tw->ticks_per_second = 1.0 / timer_interval_in_seconds;
425 
426  vec_validate (tw->expired_timer_handles, 0);
427  _vec_len (tw->expired_timer_handles) = 0;
428 
429  for (ring = 0; ring < TW_TIMER_WHEELS; ring++)
430  {
431  for (slot = 0; slot < TW_SLOTS_PER_RING; slot++)
432  {
433  ts = &tw->w[ring][slot];
434  pool_get (tw->timers, t);
435  clib_memset (t, 0xff, sizeof (*t));
436  t->next = t->prev = t - tw->timers;
437  ts->head_index = t - tw->timers;
438  }
439  }
440 
441 #if TW_OVERFLOW_VECTOR > 0
442  ts = &tw->overflow;
443  pool_get (tw->timers, t);
444  clib_memset (t, 0xff, sizeof (*t));
445  t->next = t->prev = t - tw->timers;
446  ts->head_index = t - tw->timers;
447 #endif
448 }
449 
450 /**
451  * @brief Free a tw timer wheel template instance
452  * @param tw_timer_wheel_t * tw timer wheel object pointer
453  */
454 __clib_export void TW (tw_timer_wheel_free) (TWT (tw_timer_wheel) * tw)
455 {
456  int i, j;
458  TWT (tw_timer) * head, *t;
459  u32 next_index;
460 
461  for (i = 0; i < TW_TIMER_WHEELS; i++)
462  {
463  for (j = 0; j < TW_SLOTS_PER_RING; j++)
464  {
465  ts = &tw->w[i][j];
466  head = pool_elt_at_index (tw->timers, ts->head_index);
467  next_index = head->next;
468 
469  while (next_index != ts->head_index)
470  {
471  t = pool_elt_at_index (tw->timers, next_index);
472  next_index = t->next;
473  pool_put (tw->timers, t);
474  }
475  pool_put (tw->timers, head);
476  }
477  }
478 
479 #if TW_OVERFLOW_VECTOR > 0
480  ts = &tw->overflow;
481  head = pool_elt_at_index (tw->timers, ts->head_index);
482  next_index = head->next;
483 
484  while (next_index != ts->head_index)
485  {
486  t = pool_elt_at_index (tw->timers, next_index);
487  next_index = t->next;
488  pool_put (tw->timers, t);
489  }
490  pool_put (tw->timers, head);
491 #endif
492 
493  clib_memset (tw, 0, sizeof (*tw));
494 }
495 
496 /**
497  * @brief Advance a tw timer wheel. Calls the expired timer callback
498  * as needed. This routine should be called once every timer_interval seconds
499  * @param tw_timer_wheel_t * tw timer wheel template instance pointer
500  * @param f64 now the current time, e.g. from vlib_time_now(vm)
501  * @returns u32 * vector of expired user handles
502  */
503 static inline
504  u32 * TW (tw_timer_expire_timers_internal) (TWT (tw_timer_wheel) * tw,
505  f64 now,
506  u32 * callback_vector_arg)
507 {
508  u32 nticks, i;
510  TWT (tw_timer) * t, *head;
511  u32 *callback_vector;
512  u32 fast_wheel_index;
513  u32 next_index;
514  u32 slow_wheel_index __attribute__ ((unused));
515  u32 glacier_wheel_index __attribute__ ((unused));
516 
517  /* Called too soon to process new timer expirations? */
518  if (PREDICT_FALSE (now < tw->next_run_time))
519  return callback_vector_arg;
520 
521  /* Number of ticks which have occurred */
522  nticks = tw->ticks_per_second * (now - tw->last_run_time);
523  if (nticks == 0)
524  return callback_vector_arg;
525 
526  /* Remember when we ran, compute next runtime */
527  tw->next_run_time = (now + tw->timer_interval);
528 
529  /* First call, or time jumped backwards? */
530  if (PREDICT_FALSE
531  ((tw->last_run_time == 0.0) || (now <= tw->last_run_time)))
532  {
533  tw->last_run_time = now;
534  return callback_vector_arg;
535  }
536 
537  if (callback_vector_arg == 0)
538  {
539  _vec_len (tw->expired_timer_handles) = 0;
540  callback_vector = tw->expired_timer_handles;
541  }
542  else
543  callback_vector = callback_vector_arg;
544 
545  for (i = 0; i < nticks; i++)
546  {
547  fast_wheel_index = tw->current_index[TW_TIMER_RING_FAST];
548  if (TW_TIMER_WHEELS > 1)
549  slow_wheel_index = tw->current_index[TW_TIMER_RING_SLOW];
550  if (TW_TIMER_WHEELS > 2)
551  glacier_wheel_index = tw->current_index[TW_TIMER_RING_GLACIER];
552 
553 #if TW_OVERFLOW_VECTOR > 0
554  /* Triple odometer-click? Process the overflow vector... */
555  if (PREDICT_FALSE (fast_wheel_index == TW_SLOTS_PER_RING
556  && slow_wheel_index == TW_SLOTS_PER_RING
557  && glacier_wheel_index == TW_SLOTS_PER_RING))
558  {
559  u64 interval;
560  u32 new_glacier_ring_offset, new_slow_ring_offset;
561  u32 new_fast_ring_offset;
562 
563  ts = &tw->overflow;
564  head = pool_elt_at_index (tw->timers, ts->head_index);
565  next_index = head->next;
566 
567  /* Make slot empty */
568  head->next = head->prev = ts->head_index;
569 
570  /* traverse slot, place timers wherever they go */
571  while (next_index != head - tw->timers)
572  {
573  t = pool_elt_at_index (tw->timers, next_index);
574  next_index = t->next;
575 
576  /* Remove from the overflow vector (hammer) */
577  t->next = t->prev = ~0;
578 
579  ASSERT (t->expiration_time >= tw->current_tick);
580 
581  interval = t->expiration_time - tw->current_tick;
582 
583  /* Right back onto the overflow vector? */
584  if (interval >= (1 << (3 * TW_RING_SHIFT)))
585  {
586  ts = &tw->overflow;
587  timer_addhead (tw->timers, ts->head_index, t - tw->timers);
588  continue;
589  }
590  /* Compute ring offsets */
591  new_glacier_ring_offset = interval >> (2 * TW_RING_SHIFT);
592 
593  interval -= (new_glacier_ring_offset << (2 * TW_RING_SHIFT));
594 
595  /* Note: the wheels are at (0,0,0), no add-with-carry needed */
596  new_slow_ring_offset = interval >> TW_RING_SHIFT;
597  interval -= (new_slow_ring_offset << TW_RING_SHIFT);
598  new_fast_ring_offset = interval & TW_RING_MASK;
599  t->slow_ring_offset = new_slow_ring_offset;
600  t->fast_ring_offset = new_fast_ring_offset;
601 
602  /* Timer expires Right Now */
603  if (PREDICT_FALSE (t->slow_ring_offset == 0 &&
604  t->fast_ring_offset == 0 &&
605  new_glacier_ring_offset == 0))
606  {
607  vec_add1 (callback_vector, t->user_handle);
608 #if TW_START_STOP_TRACE_SIZE > 0
609  TW (tw_timer_trace) (tw, 0xfe, t->user_handle,
610  t - tw->timers);
611 #endif
612  pool_put (tw->timers, t);
613  }
614  /* Timer moves to the glacier ring */
615  else if (new_glacier_ring_offset)
616  {
617  ts = &tw->w[TW_TIMER_RING_GLACIER][new_glacier_ring_offset];
618  timer_addhead (tw->timers, ts->head_index, t - tw->timers);
619  }
620  /* Timer moves to the slow ring */
621  else if (t->slow_ring_offset)
622  {
623  /* Add to slow ring */
624  ts = &tw->w[TW_TIMER_RING_SLOW][t->slow_ring_offset];
625  timer_addhead (tw->timers, ts->head_index, t - tw->timers);
626  }
627  /* Timer timer moves to the fast ring */
628  else
629  {
630  ts = &tw->w[TW_TIMER_RING_FAST][t->fast_ring_offset];
631  timer_addhead (tw->timers, ts->head_index, t - tw->timers);
632 #if TW_FAST_WHEEL_BITMAP
633  tw->fast_slot_bitmap =
634  clib_bitmap_set (tw->fast_slot_bitmap,
635  t->fast_ring_offset, 1);
636 #endif
637  }
638  }
639  }
640 #endif
641 
642 #if TW_TIMER_WHEELS > 2
643  /*
644  * Double odometer-click? Process one slot in the glacier ring...
645  */
646  if (PREDICT_FALSE (fast_wheel_index == TW_SLOTS_PER_RING
647  && slow_wheel_index == TW_SLOTS_PER_RING))
648  {
649  glacier_wheel_index %= TW_SLOTS_PER_RING;
650  ts = &tw->w[TW_TIMER_RING_GLACIER][glacier_wheel_index];
651 
652  head = pool_elt_at_index (tw->timers, ts->head_index);
653  next_index = head->next;
654 
655  /* Make slot empty */
656  head->next = head->prev = ts->head_index;
657 
658  /* traverse slot, deal timers into slow ring */
659  while (next_index != head - tw->timers)
660  {
661  t = pool_elt_at_index (tw->timers, next_index);
662  next_index = t->next;
663 
664  /* Remove from glacier ring slot (hammer) */
665  t->next = t->prev = ~0;
666 
667  /* Timer expires Right Now */
668  if (PREDICT_FALSE (t->slow_ring_offset == 0 &&
669  t->fast_ring_offset == 0))
670  {
671  vec_add1 (callback_vector, t->user_handle);
672 #if TW_START_STOP_TRACE_SIZE > 0
673  TW (tw_timer_trace) (tw, 0xfe, t->user_handle,
674  t - tw->timers);
675 #endif
676  pool_put (tw->timers, t);
677  }
678  /* Timer expires during slow-wheel tick 0 */
679  else if (PREDICT_FALSE (t->slow_ring_offset == 0))
680  {
681  ts = &tw->w[TW_TIMER_RING_FAST][t->fast_ring_offset];
682  timer_addhead (tw->timers, ts->head_index, t - tw->timers);
683 #if TW_FAST_WHEEL_BITMAP
684  tw->fast_slot_bitmap =
685  clib_bitmap_set (tw->fast_slot_bitmap,
686  t->fast_ring_offset, 1);
687 #endif
688  }
689  else /* typical case */
690  {
691  /* Add to slow ring */
692  ts = &tw->w[TW_TIMER_RING_SLOW][t->slow_ring_offset];
693  timer_addhead (tw->timers, ts->head_index, t - tw->timers);
694  }
695  }
696  }
697 #endif
698 
699 #if TW_TIMER_WHEELS > 1
700  /*
701  * Single odometer-click? Process a slot in the slow ring,
702  */
703  if (PREDICT_FALSE (fast_wheel_index == TW_SLOTS_PER_RING))
704  {
705  slow_wheel_index %= TW_SLOTS_PER_RING;
706  ts = &tw->w[TW_TIMER_RING_SLOW][slow_wheel_index];
707 
708  head = pool_elt_at_index (tw->timers, ts->head_index);
709  next_index = head->next;
710 
711  /* Make slot empty */
712  head->next = head->prev = ts->head_index;
713 
714  /* traverse slot, deal timers into fast ring */
715  while (next_index != head - tw->timers)
716  {
717  t = pool_elt_at_index (tw->timers, next_index);
718  next_index = t->next;
719 
720  /* Remove from sloe ring slot (hammer) */
721  t->next = t->prev = ~0;
722 
723  /* Timer expires Right Now */
724  if (PREDICT_FALSE (t->fast_ring_offset == 0))
725  {
726  vec_add1 (callback_vector, t->user_handle);
727 #if TW_START_STOP_TRACE_SIZE > 0
728  TW (tw_timer_trace) (tw, 0xfe, t->user_handle,
729  t - tw->timers);
730 #endif
731  pool_put (tw->timers, t);
732  }
733  else /* typical case */
734  {
735  /* Add to fast ring */
736  ts = &tw->w[TW_TIMER_RING_FAST][t->fast_ring_offset];
737  timer_addhead (tw->timers, ts->head_index, t - tw->timers);
738 #if TW_FAST_WHEEL_BITMAP
739  tw->fast_slot_bitmap =
740  clib_bitmap_set (tw->fast_slot_bitmap,
741  t->fast_ring_offset, 1);
742 #endif
743  }
744  }
745  }
746 #endif
747 
748  /* Handle the fast ring */
749  fast_wheel_index %= TW_SLOTS_PER_RING;
750  ts = &tw->w[TW_TIMER_RING_FAST][fast_wheel_index];
751 
752  head = pool_elt_at_index (tw->timers, ts->head_index);
753  next_index = head->next;
754 
755  /* Make slot empty */
756  head->next = head->prev = ts->head_index;
757 
758  /* Construct vector of expired timer handles to give the user */
759  while (next_index != ts->head_index)
760  {
761  t = pool_elt_at_index (tw->timers, next_index);
762  next_index = t->next;
763  vec_add1 (callback_vector, t->user_handle);
764 #if TW_START_STOP_TRACE_SIZE > 0
765  TW (tw_timer_trace) (tw, 0xfe, t->user_handle, t - tw->timers);
766 #endif
767  pool_put (tw->timers, t);
768  }
769 
770  /* If any timers expired, tell the user */
771  if (callback_vector_arg == 0 && vec_len (callback_vector))
772  {
773  /* The callback is optional. We return the u32 * handle vector */
774  if (tw->expired_timer_callback)
775  {
776  tw->expired_timer_callback (callback_vector);
777  vec_reset_length (callback_vector);
778  }
779  tw->expired_timer_handles = callback_vector;
780  }
781 
782 #if TW_FAST_WHEEL_BITMAP
783  tw->fast_slot_bitmap = clib_bitmap_set (tw->fast_slot_bitmap,
784  fast_wheel_index, 0);
785 #endif
786 
787  tw->current_tick++;
788  fast_wheel_index++;
789  tw->current_index[TW_TIMER_RING_FAST] = fast_wheel_index;
790 
791 #if TW_TIMER_WHEELS > 1
792  if (PREDICT_FALSE (fast_wheel_index == TW_SLOTS_PER_RING))
793  slow_wheel_index++;
794  tw->current_index[TW_TIMER_RING_SLOW] = slow_wheel_index;
795 #endif
796 
797 #if TW_TIMER_WHEELS > 2
798  if (PREDICT_FALSE (slow_wheel_index == TW_SLOTS_PER_RING))
799  glacier_wheel_index++;
800  tw->current_index[TW_TIMER_RING_GLACIER] = glacier_wheel_index;
801 #endif
802 
803  if (vec_len (callback_vector) >= tw->max_expirations)
804  break;
805  }
806 
807  if (callback_vector_arg == 0)
808  tw->expired_timer_handles = callback_vector;
809 
810  tw->last_run_time += i * tw->timer_interval;
811  return callback_vector;
812 }
813 
814 __clib_export u32 *TW (tw_timer_expire_timers) (TWT (tw_timer_wheel) * tw,
815  f64 now)
816 {
817  return TW (tw_timer_expire_timers_internal) (tw, now, 0 /* no vector */ );
818 }
819 
820 __clib_export u32 *TW (tw_timer_expire_timers_vec) (TWT (tw_timer_wheel) * tw,
821  f64 now, u32 * vec)
822 {
823  return TW (tw_timer_expire_timers_internal) (tw, now, vec);
824 }
825 
826 #if TW_FAST_WHEEL_BITMAP
827 /** Returns an approximation to the first timer expiration in
828  * timer-ticks from "now". To avoid wasting an unjustifiable
829  * amount of time on the problem, we maintain an approximate fast-wheel slot
830  * occupancy bitmap. We don't worry about clearing fast wheel bits
831  * when timers are removed from fast wheel slots.
832  */
833 
834 __clib_export u32
835 TW (tw_timer_first_expires_in_ticks) (TWT (tw_timer_wheel) * tw)
836 {
837  u32 first_expiring_index, fast_ring_index;
838  i32 delta;
839 
840 #if TW_TIMER_WHEELS > 1
841  fast_ring_index = tw->current_index[TW_TIMER_RING_FAST];
842  if (fast_ring_index == TW_SLOTS_PER_RING)
843  return 1;
844 
845  first_expiring_index = clib_bitmap_next_set (tw->fast_slot_bitmap,
846  fast_ring_index);
847  if (first_expiring_index == ~0)
848  first_expiring_index = TW_SLOTS_PER_RING;
849 
850 #else
851 
852  if (clib_bitmap_is_zero (tw->fast_slot_bitmap))
853  return TW_SLOTS_PER_RING;
854 
855  fast_ring_index = tw->current_index[TW_TIMER_RING_FAST];
856  if (fast_ring_index == TW_SLOTS_PER_RING)
857  fast_ring_index = 0;
858 
859  first_expiring_index = clib_bitmap_next_set (tw->fast_slot_bitmap,
860  fast_ring_index);
861  if (first_expiring_index == ~0 && fast_ring_index != 0)
862  first_expiring_index = clib_bitmap_first_set (tw->fast_slot_bitmap);
863 #endif
864 
865  ASSERT (first_expiring_index != ~0);
866 
867  delta = (i32) first_expiring_index - (i32) fast_ring_index;
868  if (delta < 0)
869  delta += TW_SLOTS_PER_RING;
870 
871  ASSERT (delta >= 0);
872 
873  return (u32) delta;
874 }
875 
876 #endif
877 
878 /*
879  * fd.io coding-style-patch-verification: ON
880  *
881  * Local Variables:
882  * eval: (c-set-style "gnu")
883  * End:
884  */
vec_reset_length
#define vec_reset_length(v)
Reset vector length to zero NULL-pointer tolerant.
Definition: vec_bootstrap.h:194
tw_timer_wheel_free
__clib_export void TW() tw_timer_wheel_free(TWT(tw_timer_wheel) *tw)
Free a tw timer wheel template instance.
Definition: tw_timer_template.c:454
trace
static vlib_cli_command_t trace
(constructor) VLIB_CLI_COMMAND (trace)
Definition: vlib_api_cli.c:899
TW_RING_SHIFT
#define TW_RING_SHIFT
Definition: tcp_types.h:465
app_rx_mq_elt_::next
struct app_rx_mq_elt_ * next
Definition: application.h:100
next_index
nat44_ei_hairpin_src_next_t next_index
Definition: nat44_ei_hairpinning.c:412
tw_timer_stop
__clib_export void TW() tw_timer_stop(TWT(tw_timer_wheel) *tw, u32 handle)
Stop a tw timer.
Definition: tw_timer_template.c:352
make_internal_timer_handle
static u32 TW() make_internal_timer_handle(u32 pool_index, u32 timer_id)
Definition: tw_timer_template.c:103
pool_elt_at_index
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:553
clib_bitmap_first_set
static uword clib_bitmap_first_set(uword *ai)
Return the lowest numbered set bit in a bitmap.
Definition: bitmap.h:391
tw_timer_wheel_slot_t::head_index
u32 head_index
Listhead of timers which expire in this interval.
Definition: tw_timer_template.h:160
tw_timer_expire_timers_vec
__clib_export u32 *TW() tw_timer_expire_timers_vec(TWT(tw_timer_wheel) *tw, f64 now, u32 *vec)
Definition: tw_timer_template.c:820
u16
unsigned short u16
Definition: types.h:57
tw_timer_update
__clib_export void TW() tw_timer_update(TWT(tw_timer_wheel) *tw, u32 handle, u64 interval)
Update a tw timer.
Definition: tw_timer_template.c:392
pool_put
#define pool_put(P, E)
Free an object E in pool P.
Definition: pool.h:305
TW_TIMERS_PER_OBJECT
#define TW_TIMERS_PER_OBJECT
Definition: tcp_types.h:467
TW_RING_MASK
#define TW_RING_MASK
Definition: tcp_types.h:466
pool_put_index
#define pool_put_index(p, i)
Free pool element with given index.
Definition: pool.h:337
tw_timer_expire_timers_internal
static u32 *TW() tw_timer_expire_timers_internal(TWT(tw_timer_wheel) *tw, f64 now, u32 *callback_vector_arg)
Advance a tw timer wheel.
Definition: tw_timer_template.c:504
i32
signed int i32
Definition: types.h:77
pool_is_free_index
#define pool_is_free_index(P, I)
Use free bitmap to query whether given index is free.
Definition: pool.h:302
vec_len
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
Definition: vec_bootstrap.h:142
timer_add
static void timer_add(TWT(tw_timer_wheel) *tw, TWT(tw_timer) *t, u64 interval)
Definition: tw_timer_template.c:161
slot
u8 slot
Definition: pci_types.api:22
vec_add1
#define vec_add1(V, E)
Add 1 element to end of vector (unspecified alignment).
Definition: vec.h:606
timer_addhead
static void timer_addhead(TWT(tw_timer) *pool, u32 head_index, u32 new_index)
Definition: tw_timer_template.c:119
tw_timer_wheel_slot_t
Definition: tw_timer_template.h:157
PREDICT_FALSE
#define PREDICT_FALSE(x)
Definition: clib.h:124
LOG2_TW_TIMERS_PER_OBJECT
#define LOG2_TW_TIMERS_PER_OBJECT
Definition: tcp_types.h:468
app_rx_mq_elt_::prev
struct app_rx_mq_elt_ * prev
Definition: application.h:101
timer_remove
static void timer_remove(TWT(tw_timer) *pool, TWT(tw_timer) *elt)
Definition: tw_timer_template.c:145
i
sll srl srl sll sra u16x4 i
Definition: vector_sse42.h:261
TW_SLOTS_PER_RING
#define TW_SLOTS_PER_RING
Definition: tcp_types.h:464
f64
double f64
Definition: types.h:142
expired_timer_callback
static void expired_timer_callback(u32 *expired_timers)
Definition: wireguard_timer.c:281
pool_get
#define pool_get(P, E)
Allocate an object E from a pool P (unspecified alignment).
Definition: pool.h:255
tw_timer_wheel_init
__clib_export void TW() tw_timer_wheel_init(TWT(tw_timer_wheel) *tw, void *expired_timer_callback, f64 timer_interval_in_seconds, u32 max_expirations)
Initialize a tw timer wheel template instance.
Definition: tw_timer_template.c:408
TWT
#define TWT(a)
Definition: tw_timer_template.h:27
vec_validate
#define vec_validate(V, I)
Make sure vector is long enough for given index (no header, unspecified alignment)
Definition: vec.h:523
clib_bitmap_set
static uword * clib_bitmap_set(uword *ai, uword i, uword value)
Sets the ith bit of a bitmap to new_value Removes trailing zeros from the bitmap.
Definition: bitmap.h:167
interval
u16 interval
Definition: vrrp.api:34
tw_timer_start
__clib_export u32 TW() tw_timer_start(TWT(tw_timer_wheel) *tw, u32 user_id, u32 timer_id, u64 interval)
Start a Tw Timer.
Definition: tw_timer_template.c:296
u64
unsigned long u64
Definition: types.h:89
ASSERT
#define ASSERT(truth)
Definition: error_bootstrap.h:69
TW_TIMER_RING_FAST
@ TW_TIMER_RING_FAST
Fast timer ring ID.
Definition: tw_timer_template.h:165
u32
unsigned int u32
Definition: types.h:88
TW_TIMER_RING_GLACIER
@ TW_TIMER_RING_GLACIER
Glacier ring ID.
Definition: tw_timer_template.h:169
tw_timer_handle_is_free
__clib_export int TW() tw_timer_handle_is_free(TWT(tw_timer_wheel) *tw, u32 handle)
Definition: tw_timer_template.c:380
fformat
__clib_export word fformat(FILE *f, char *fmt,...)
Definition: format.c:466
elt
app_rx_mq_elt_t * elt
Definition: application.c:488
now
f64 now
Definition: nat44_ei_out2in.c:710
clib_memset
clib_memset(h->entries, 0, sizeof(h->entries[0]) *entries)
TW_TIMER_WHEELS
#define TW_TIMER_WHEELS
Definition: tcp_types.h:463
clib_warning
#define clib_warning(format, args...)
Definition: error.h:59
tw_timer_expire_timers
__clib_export u32 *TW() tw_timer_expire_timers(TWT(tw_timer_wheel) *tw, f64 now)
Definition: tw_timer_template.c:814
rv
int __clib_unused rv
Definition: application.c:491
TW_TIMER_RING_SLOW
@ TW_TIMER_RING_SLOW
Slow timer ring ID.
Definition: tw_timer_template.h:167
TW
#define TW(a)
Definition: tw_timer_template.h:31
TWT
Definition: tw_timer_template.h:118
clib_bitmap_is_zero
static uword clib_bitmap_is_zero(uword *ai)
predicate function; is an entire bitmap empty?
Definition: bitmap.h:57