git.ozlabs.org Git - ccan/blob - ccan/timer/timer.c

   1 /* LGPL (v2.1 or any later version) - see LICENSE file for details */
   2 #include <ccan/timer/timer.h>
   3 #include <ccan/array_size/array_size.h>
   4 #include <ccan/ilog/ilog.h>
   5 #include <ccan/likely/likely.h>
   6 #include <stdlib.h>
   7 #include <stdio.h>
   8
   9 #define PER_LEVEL (1ULL << TIMER_LEVEL_BITS)
  10
  11 struct timer_level {
  12         struct list_head list[PER_LEVEL];
  13 };
  14
  15 static uint64_t time_to_grains(struct timeabs t)
  16 {
  17         return t.ts.tv_sec * ((uint64_t)1000000000 / TIMER_GRANULARITY)
  18                 + (t.ts.tv_nsec / TIMER_GRANULARITY);
  19 }
  20
  21 static struct timeabs grains_to_time(uint64_t grains)
  22 {
  23         struct timeabs t;
  24
  25         t.ts.tv_sec = grains / (1000000000 / TIMER_GRANULARITY);
  26         t.ts.tv_nsec = (grains % (1000000000 / TIMER_GRANULARITY))
  27                 * TIMER_GRANULARITY;
  28         return t;
  29 }
  30
  31 void timers_init(struct timers *timers, struct timeabs start)
  32 {
  33         unsigned int i;
  34
  35         list_head_init(&timers->far);
  36         timers->base = time_to_grains(start);
  37         timers->first = -1ULL;
  38         for (i = 0; i < ARRAY_SIZE(timers->level); i++)
  39                 timers->level[i] = NULL;
  40 }
  41
  42 static unsigned int level_of(const struct timers *timers, uint64_t time)
  43 {
  44         uint64_t diff;
  45
  46         /* Level depends how far away it is. */
  47         diff = time - timers->base;
  48         return ilog64(diff / 2) / TIMER_LEVEL_BITS;
  49 }
  50
  51 static void timer_add_raw(struct timers *timers, struct timer *t)
  52 {
  53         struct list_head *l;
  54         unsigned int level = level_of(timers, t->time);
  55
  56         if (!timers->level[level])
  57                 l = &timers->far;
  58         else {
  59                 int off = (t->time >> (level*TIMER_LEVEL_BITS)) & (PER_LEVEL-1);
  60                 l = &timers->level[level]->list[off];
  61         }
  62
  63         list_add_tail(l, &t->list);
  64 }
  65
  66 void timer_init(struct timer *t)
  67 {
  68         list_node_init(&t->list);
  69 }
  70
  71 static bool list_node_initted(const struct list_node *n)
  72 {
  73         return n->prev == n;
  74 }
  75
  76 void timer_add(struct timers *timers, struct timer *t, struct timeabs when)
  77 {
  78         assert(list_node_initted(&t->list));
  79
  80         t->time = time_to_grains(when);
  81
  82         /* Added in the past?  Treat it as imminent. */
  83         if (t->time < timers->base)
  84                 t->time = timers->base;
  85         if (t->time < timers->first)
  86                 timers->first = t->time;
  87
  88         timer_add_raw(timers, t);
  89 }
  90
  91 /* FIXME: inline */
  92 void timer_del(struct timers *timers, struct timer *t)
  93 {
  94         list_del_init(&t->list);
  95 }
  96
  97 static void timers_far_get(struct timers *timers,
  98                            struct list_head *list,
  99                            uint64_t when)
 100 {
 101         struct timer *i, *next;
 102
 103         list_for_each_safe(&timers->far, i, next, list) {
 104                 if (i->time <= when) {
 105                         list_del_from(&timers->far, &i->list);
 106                         list_add_tail(list, &i->list);
 107                 }
 108         }
 109 }
 110
 111 static void add_level(struct timers *timers, unsigned int level)
 112 {
 113         struct timer_level *l;
 114         struct timer *t;
 115         unsigned int i;
 116         struct list_head from_far;
 117
 118         l = malloc(sizeof(*l));
 119         if (!l)
 120                 return;
 121
 122         for (i = 0; i < ARRAY_SIZE(l->list); i++)
 123                 list_head_init(&l->list[i]);
 124         timers->level[level] = l;
 125
 126         list_head_init(&from_far);
 127         timers_far_get(timers, &from_far,
 128                        timers->base + (1ULL << ((level+1)*TIMER_LEVEL_BITS)) - 1);
 129
 130         while ((t = list_pop(&from_far, struct timer, list)) != NULL)
 131                 timer_add_raw(timers, t);
 132 }
 133
 134 static const struct timer *find_first(const struct list_head *list,
 135                                       const struct timer *prev)
 136 {
 137         struct timer *t;
 138
 139         list_for_each(list, t, list) {
 140                 if (!prev || t->time < prev->time)
 141                         prev = t;
 142         }
 143         return prev;
 144 }
 145
 146 static const struct timer *get_first(const struct timers *timers)
 147 {
 148         unsigned int level, i, off;
 149         bool need_next;
 150         uint64_t base;
 151         const struct timer *found = NULL;
 152         struct list_head *h;
 153
 154         if (timers->first < timers->base) {
 155                 base = timers->base;
 156                 level = 0;
 157         } else {
 158                 /* May not be accurate, due to timer_del / expiry. */
 159                 level = level_of(timers, timers->first);
 160                 base = timers->first >> (TIMER_LEVEL_BITS * level);
 161         }
 162
 163 next:
 164         if (!timers->level[level])
 165                 return find_first(&timers->far, NULL);
 166
 167         need_next = false;
 168         off = base % PER_LEVEL;
 169         for (i = 0; i < PER_LEVEL; i++) {
 170                 h = &timers->level[level]->list[(i+off) % PER_LEVEL];
 171
 172                 if (!list_empty(h))
 173                         break;
 174
 175                 /* We haven't cascaded yet, so if we wrap, we'll need to
 176                  * check next level, too. */
 177                 if (i + off == PER_LEVEL)
 178                         need_next = true;
 179         }
 180         if (i == PER_LEVEL) {
 181                 level++;
 182                 base >>= TIMER_LEVEL_BITS;
 183                 goto next;
 184         }
 185
 186         /* Level 0 is exact, so they're all the same. */
 187         if (level == 0)
 188                 found = list_top(h, struct timer, list);
 189         else
 190                 found = find_first(h, NULL);
 191
 192         if (need_next) {
 193                 if (!timers->level[level+1]) {
 194                         found = find_first(&timers->far, found);
 195                 } else {
 196                         base >>= TIMER_LEVEL_BITS;
 197                         off = base % PER_LEVEL;
 198                         h = &timers->level[level+1]->list[off];
 199                         found = find_first(h, found);
 200                 }
 201         }
 202         return found;
 203 }
 204
 205 static bool update_first(struct timers *timers)
 206 {
 207         const struct timer *found = get_first(timers);
 208
 209         if (!found) {
 210                 timers->first = -1ULL;
 211                 return false;
 212         }
 213
 214         timers->first = found->time;
 215         return true;
 216 }
 217
 218 bool timer_earliest(struct timers *timers, struct timeabs *first)
 219 {
 220         if (!update_first(timers))
 221                 return false;
 222
 223         *first = grains_to_time(timers->first);
 224         return true;
 225 }
 226
 227 /* Assume no timers before 'time', cascade down and update base time. */
 228 static void timer_fast_forward(struct timers *timers, uint64_t time)
 229 {
 230         unsigned int level, changed;
 231         int need_level = -1;
 232         struct list_head list;
 233         struct timer *i;
 234
 235         /* How many bits changed between base and time?
 236          * Each time we wrap, we need to empty buckets from above. */
 237         if (time == timers->base)
 238                 return;
 239
 240         changed = ilog64_nz(time ^ timers->base);
 241         level = (changed - 1) / TIMER_LEVEL_BITS;
 242
 243         /* Buckets always empty downwards, so we could cascade manually,
 244          * but it's rarely very many so we just remove and re-add */
 245         list_head_init(&list);
 246
 247         do {
 248                 if (!timers->level[level]) {
 249                         /* We need any which belong on this level. */
 250                         timers_far_get(timers, &list,
 251                                        timers->base
 252                                        + (1ULL << ((level+1)*TIMER_LEVEL_BITS))-1);
 253                         need_level = level;
 254                 } else {
 255                         unsigned src;
 256
 257                         /* Get all timers from this bucket. */
 258                         src = (time >> (level * TIMER_LEVEL_BITS)) % PER_LEVEL;
 259                         list_append_list(&list,
 260                                          &timers->level[level]->list[src]);
 261                 }
 262         } while (level--);
 263
 264         /* Did we hit the last level?  If so, add. */
 265         if (need_level != -1)
 266                 add_level(timers, need_level);
 267
 268         /* Fast-forward the time, and re-add everyone. */
 269         timers->base = time;
 270         while ((i = list_pop(&list, struct timer, list)) != NULL)
 271                 timer_add_raw(timers, i);
 272 }
 273
 274 /* Returns an expired timer. */
 275 struct timer *timers_expire(struct timers *timers, struct timeabs expire)
 276 {
 277         uint64_t now = time_to_grains(expire);
 278         unsigned int off;
 279         struct timer *t;
 280
 281         assert(now >= timers->base);
 282
 283         if (!timers->level[0]) {
 284                 if (list_empty(&timers->far))
 285                         return NULL;
 286                 add_level(timers, 0);
 287         }
 288
 289         do {
 290                 if (timers->first > now) {
 291                         timer_fast_forward(timers, now);
 292                         return NULL;
 293                 }
 294
 295                 timer_fast_forward(timers, timers->first);
 296                 off = timers->base % PER_LEVEL;
 297
 298                 /* This *may* be NULL, if we deleted the first timer */
 299                 t = list_pop(&timers->level[0]->list[off], struct timer, list);
 300                 if (t)
 301                         list_node_init(&t->list);
 302         } while (!t && update_first(timers));
 303
 304         return t;
 305 }
 306
 307 static bool timer_list_check(const struct list_head *l,
 308                              uint64_t min, uint64_t max, uint64_t first,
 309                              const char *abortstr)
 310 {
 311         const struct timer *t;
 312
 313         if (!list_check(l, abortstr))
 314                 return false;
 315
 316         list_for_each(l, t, list) {
 317                 if (t->time < min || t->time > max) {
 318                         if (abortstr) {
 319                                 fprintf(stderr,
 320                                         "%s: timer %p %llu not %llu-%llu\n",
 321                                         abortstr, t, (long long)t->time,
 322                                         (long long)min, (long long)max);
 323                                 abort();
 324                         }
 325                         return false;
 326                 }
 327                 if (t->time < first) {
 328                         if (abortstr) {
 329                                 fprintf(stderr,
 330                                         "%s: timer %p %llu < minimum %llu\n",
 331                                         abortstr, t, (long long)t->time,
 332                                         (long long)first);
 333                                 abort();
 334                         }
 335                         return false;
 336                 }
 337         }
 338         return true;
 339 }
 340
 341 struct timers *timers_check(const struct timers *timers, const char *abortstr)
 342 {
 343         unsigned int l, i, off;
 344         uint64_t base;
 345
 346         l = 0;
 347         if (!timers->level[0])
 348                 goto past_levels;
 349
 350         /* First level is simple. */
 351         off = timers->base % PER_LEVEL;
 352         for (i = 0; i < PER_LEVEL; i++) {
 353                 struct list_head *h;
 354
 355                 h = &timers->level[l]->list[(i+off) % PER_LEVEL];
 356                 if (!timer_list_check(h, timers->base + i, timers->base + i,
 357                                       timers->first, abortstr))
 358                         return NULL;
 359         }
 360
 361         /* For other levels, "current" bucket has been emptied, and may contain
 362          * entries for the current + level_size bucket. */
 363         for (l = 1; l < ARRAY_SIZE(timers->level) && timers->level[l]; l++) {
 364                 uint64_t per_bucket = 1ULL << (TIMER_LEVEL_BITS * l);
 365
 366                 off = ((timers->base >> (l*TIMER_LEVEL_BITS)) % PER_LEVEL);
 367                 /* We start at *next* bucket. */
 368                 base = (timers->base & ~(per_bucket - 1)) + per_bucket;
 369
 370                 for (i = 1; i <= PER_LEVEL; i++) {
 371                         struct list_head *h;
 372
 373                         h = &timers->level[l]->list[(i+off) % PER_LEVEL];
 374                         if (!timer_list_check(h, base, base + per_bucket - 1,
 375                                               timers->first, abortstr))
 376                                 return NULL;
 377                         base += per_bucket;
 378                 }
 379         }
 380
 381 past_levels:
 382         base = (timers->base & ~((1ULL << (TIMER_LEVEL_BITS * l)) - 1))
 383                 + (1ULL << (TIMER_LEVEL_BITS * l)) - 1;
 384         if (!timer_list_check(&timers->far, base, -1ULL, timers->first,
 385                               abortstr))
 386                 return NULL;
 387
 388         return (struct timers *)timers;
 389 }
 390
 391 #ifdef CCAN_TIMER_DEBUG
 392 void timers_dump(const struct timers *timers, FILE *fp)
 393 {
 394         unsigned int l, i;
 395         uint64_t min, max, num;
 396         struct timer *t;
 397
 398         if (!fp)
 399                 fp = stderr;
 400
 401         fprintf(fp, "Base: %llu\n", timers->base);
 402
 403         for (l = 0; timers->level[l] && l < ARRAY_SIZE(timers->level); l++) {
 404                 fprintf(fp, "Level %i (+%llu):\n",
 405                         l, (uint64_t)1 << (TIMER_LEVEL_BITS * l));
 406                 for (i = 0; i < (1 << TIMER_LEVEL_BITS); i++) {
 407
 408                         if (list_empty(&timers->level[l]->list[i]))
 409                                 continue;
 410                         min = -1ULL;
 411                         max = 0;
 412                         num = 0;
 413                         list_for_each(&timers->level[l]->list[i], t, list) {
 414                                 if (t->time < min)
 415                                         min = t->time;
 416                                 if (t->time > max)
 417                                         max = t->time;
 418                                 num++;
 419                         }
 420                         fprintf(stderr, "  %llu (+%llu-+%llu)\n",
 421                                 num, min - timers->base, max - timers->base);
 422                 }
 423         }
 424
 425         min = -1ULL;
 426         max = 0;
 427         num = 0;
 428         list_for_each(&timers->far, t, list) {
 429                 if (t->time < min)
 430                         min = t->time;
 431                 if (t->time > max)
 432                         max = t->time;
 433                 num++;
 434         }
 435         fprintf(stderr, "Far: %llu (%llu-%llu)\n", num, min, max);
 436 }
 437 #endif
 438
 439 void timers_cleanup(struct timers *timers)
 440 {
 441         unsigned int l;
 442
 443         for (l = 0; l < ARRAY_SIZE(timers->level); l++)
 444                 free(timers->level[l]);
 445 }