timer_add_raw(timers, t);
}
-/* Take timers from level and distribute them down one. */
-static void cascade(struct timers *timers, unsigned int level)
-{
- struct timer *i;
- struct list_head from_far, *list;
-
- if (level == ARRAY_SIZE(timers->level) || !timers->level[level]) {
- list_head_init(&from_far);
- timers_far_get(timers, &from_far,
- timers->base
- + (1ULL << (level*TIMER_LEVEL_BITS))-1);
- list = &from_far;
- if (level != ARRAY_SIZE(timers->level))
- add_level(timers, level);
- } else {
- unsigned src;
-
- src = (timers->base >> (level * TIMER_LEVEL_BITS)) % PER_LEVEL;
- if (src == 0)
- cascade(timers, level + 1);
- list = &timers->level[level]->list[src];
- }
-
- while ((i = list_pop(list, struct timer, list)) != NULL) {
- unsigned dst;
-
- assert(i->time >= timers->base);
- assert(i->time < (timers->base
- + (1ULL << ((level+1)*TIMER_LEVEL_BITS))));
-
- dst = (i->time >> ((level-1)*TIMER_LEVEL_BITS)) % PER_LEVEL;
- list_add_tail(&timers->level[level-1]->list[dst], &i->list);
- }
-}
-
static const struct timer *find_first(const struct list_head *list,
const struct timer *prev)
{
return (struct timers *)timers;
}
-//#ifdef CCAN_TIMER_DEBUG
+#ifdef CCAN_TIMER_DEBUG
void timers_dump(const struct timers *timers, FILE *fp)
{
unsigned int l, i;
}
fprintf(stderr, "Far: %llu (%llu-%llu)\n", num, min, max);
}
-//#endif
+#endif
void timers_cleanup(struct timers *timers)
{
*
* This sets up a timers struct: any timers added before @start will be
* set to expire immediately.
+ *
+ * Example:
+ * struct timers timeouts;
+ *
+ * timers_init(&timeouts, time_now());
*/
void timers_init(struct timers *timers, struct timespec start);
* @timers: the struct timers
*
* This frees any timer layers allocated during use.
+ *
+ * Example:
+ * timers_cleanup(&timeouts);
*/
void timers_cleanup(struct timers *timers);
*
* This efficiently adds @timer to @timers, to expire @when (rounded to
* TIMER_GRANULARITY nanoseconds).
+ *
+ * Example:
+ * struct timer t;
+ *
+ * // Timeout in 100ms.
+ * timer_add(&timeouts, &t, time_add(time_now(), time_from_msec(100)));
*/
void timer_add(struct timers *timers, struct timer *timer,
struct timespec when);
* @timer: the timer previously added with timer_add()
*
* This efficiently removes @timer from @timers.
+ *
+ * Example:
+ * timer_del(&timeouts, &t);
*/
void timer_del(struct timers *timers, struct timer *timer);
* This returns false, and doesn't alter @first if there are no
* timers. Otherwise, it sets @first to the expiry time of the first
* timer (rounded to TIMER_GRANULARITY nanoseconds), and returns true.
+ *
+ * Example:
+ * struct timespec next = { (time_t)-1ULL, -1UL };
+ * timer_earliest(&timeouts, &next);
*/
bool timer_earliest(struct timers *timers, struct timespec *first);
/**
- * timer_expire - update timers structure and remove expired timers.
+ * timers_expire - update timers structure and remove expired timers.
* @timers: the struct timers
* @expire: the current time
* @list: the list for expired timers.
*
* You should not move @expire backwards, though it need not move
* forwards.
+ *
+ * Example:
+ * struct list_head expired;
+ *
+ * timers_expire(&timeouts, time_now(), &expired);
+ * if (!list_empty(&expired))
+ * printf("Timer expired!\n");
*/
void timers_expire(struct timers *timers,
struct timespec expire,
*
* Returns the timers struct if it is consistent, NULL if not (it can
* never return NULL if @abortstr is set).
+ *
+ * Example:
+ * timers_check(&timeouts, "After timer_expire");
*/
struct timers *timers_check(const struct timers *t, const char *abortstr);