qemu-timer.c

   1 /*
   2  * QEMU System Emulator
   3  *
   4  * Copyright (c) 2003-2008 Fabrice Bellard
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to deal
   8  * in the Software without restriction, including without limitation the rights
   9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10  * copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22  * THE SOFTWARE.
  23  */
  24
  25 #include "sysemu/sysemu.h"
  26 #include "monitor/monitor.h"
  27 #include "ui/console.h"
  28
  29 #include "hw/hw.h"
  30
  31 #include "qemu/timer.h"
  32 #ifdef CONFIG_POSIX
  33 #include <pthread.h>
  34 #endif
  35
  36 #ifdef CONFIG_PPOLL
  37 #include <poll.h>
  38 #endif
  39
  40 #ifdef CONFIG_PRCTL_PR_SET_TIMERSLACK
  41 #include <sys/prctl.h>
  42 #endif
  43
  44 /***********************************************************/
  45 /* timers */
  46
  47 typedef struct QEMUClock {
  48     /* We rely on BQL to protect the timerlists */
  49     QLIST_HEAD(, QEMUTimerList) timerlists;
  50
  51     NotifierList reset_notifiers;
  52     int64_t last;
  53
  54     QEMUClockType type;
  55     bool enabled;
  56 } QEMUClock;
  57
  58 QEMUTimerListGroup main_loop_tlg;
  59 QEMUClock qemu_clocks[QEMU_CLOCK_MAX];
  60
  61 /* A QEMUTimerList is a list of timers attached to a clock. More
  62  * than one QEMUTimerList can be attached to each clock, for instance
  63  * used by different AioContexts / threads. Each clock also has
  64  * a list of the QEMUTimerLists associated with it, in order that
  65  * reenabling the clock can call all the notifiers.
  66  */
  67
  68 struct QEMUTimerList {
  69     QEMUClock *clock;
  70     QemuMutex active_timers_lock;
  71     QEMUTimer *active_timers;
  72     QLIST_ENTRY(QEMUTimerList) list;
  73     QEMUTimerListNotifyCB *notify_cb;
  74     void *notify_opaque;
  75
  76     /* lightweight method to mark the end of timerlist's running */
  77     QemuEvent timers_done_ev;
  78 };
  79
  80 /**
  81  * qemu_clock_ptr:
  82  * @type: type of clock
  83  *
  84  * Translate a clock type into a pointer to QEMUClock object.
  85  *
  86  * Returns: a pointer to the QEMUClock object
  87  */
  88 static inline QEMUClock *qemu_clock_ptr(QEMUClockType type)
  89 {
  90     return &qemu_clocks[type];
  91 }
  92
  93 static bool timer_expired_ns(QEMUTimer *timer_head, int64_t current_time)
  94 {
  95     return timer_head && (timer_head->expire_time <= current_time);
  96 }
  97
  98 QEMUTimerList *timerlist_new(QEMUClockType type,
  99                              QEMUTimerListNotifyCB *cb,
 100                              void *opaque)
 101 {
 102     QEMUTimerList *timer_list;
 103     QEMUClock *clock = qemu_clock_ptr(type);
 104
 105     timer_list = g_malloc0(sizeof(QEMUTimerList));
 106     qemu_event_init(&timer_list->timers_done_ev, false);
 107     timer_list->clock = clock;
 108     timer_list->notify_cb = cb;
 109     timer_list->notify_opaque = opaque;
 110     qemu_mutex_init(&timer_list->active_timers_lock);
 111     QLIST_INSERT_HEAD(&clock->timerlists, timer_list, list);
 112     return timer_list;
 113 }
 114
 115 void timerlist_free(QEMUTimerList *timer_list)
 116 {
 117     assert(!timerlist_has_timers(timer_list));
 118     if (timer_list->clock) {
 119         QLIST_REMOVE(timer_list, list);
 120     }
 121     qemu_mutex_destroy(&timer_list->active_timers_lock);
 122     g_free(timer_list);
 123 }
 124
 125 static void qemu_clock_init(QEMUClockType type)
 126 {
 127     QEMUClock *clock = qemu_clock_ptr(type);
 128
 129     clock->type = type;
 130     clock->enabled = true;
 131     clock->last = INT64_MIN;
 132     QLIST_INIT(&clock->timerlists);
 133     notifier_list_init(&clock->reset_notifiers);
 134     main_loop_tlg.tl[type] = timerlist_new(type, NULL, NULL);
 135 }
 136
 137 bool qemu_clock_use_for_deadline(QEMUClockType type)
 138 {
 139     return !(use_icount && (type == QEMU_CLOCK_VIRTUAL));
 140 }
 141
 142 void qemu_clock_notify(QEMUClockType type)
 143 {
 144     QEMUTimerList *timer_list;
 145     QEMUClock *clock = qemu_clock_ptr(type);
 146     QLIST_FOREACH(timer_list, &clock->timerlists, list) {
 147         timerlist_notify(timer_list);
 148     }
 149 }
 150
 151 /* Disabling the clock will wait for related timerlists to stop
 152  * executing qemu_run_timers.  Thus, this functions should not
 153  * be used from the callback of a timer that is based on @clock.
 154  * Doing so would cause a deadlock.
 155  *
 156  * Caller should hold BQL.
 157  */
 158 void qemu_clock_enable(QEMUClockType type, bool enabled)
 159 {
 160     QEMUClock *clock = qemu_clock_ptr(type);
 161     QEMUTimerList *tl;
 162     bool old = clock->enabled;
 163     clock->enabled = enabled;
 164     if (enabled && !old) {
 165         qemu_clock_notify(type);
 166     } else if (!enabled && old) {
 167         QLIST_FOREACH(tl, &clock->timerlists, list) {
 168             qemu_event_wait(&tl->timers_done_ev);
 169         }
 170     }
 171 }
 172
 173 bool timerlist_has_timers(QEMUTimerList *timer_list)
 174 {
 175     return !!timer_list->active_timers;
 176 }
 177
 178 bool qemu_clock_has_timers(QEMUClockType type)
 179 {
 180     return timerlist_has_timers(
 181         main_loop_tlg.tl[type]);
 182 }
 183
 184 bool timerlist_expired(QEMUTimerList *timer_list)
 185 {
 186     int64_t expire_time;
 187
 188     qemu_mutex_lock(&timer_list->active_timers_lock);
 189     if (!timer_list->active_timers) {
 190         qemu_mutex_unlock(&timer_list->active_timers_lock);
 191         return false;
 192     }
 193     expire_time = timer_list->active_timers->expire_time;
 194     qemu_mutex_unlock(&timer_list->active_timers_lock);
 195
 196     return expire_time < qemu_clock_get_ns(timer_list->clock->type);
 197 }
 198
 199 bool qemu_clock_expired(QEMUClockType type)
 200 {
 201     return timerlist_expired(
 202         main_loop_tlg.tl[type]);
 203 }
 204
 205 /*
 206  * As above, but return -1 for no deadline, and do not cap to 2^32
 207  * as we know the result is always positive.
 208  */
 209
 210 int64_t timerlist_deadline_ns(QEMUTimerList *timer_list)
 211 {
 212     int64_t delta;
 213     int64_t expire_time;
 214
 215     if (!timer_list->clock->enabled) {
 216         return -1;
 217     }
 218
 219     /* The active timers list may be modified before the caller uses our return
 220      * value but ->notify_cb() is called when the deadline changes.  Therefore
 221      * the caller should notice the change and there is no race condition.
 222      */
 223     qemu_mutex_lock(&timer_list->active_timers_lock);
 224     if (!timer_list->active_timers) {
 225         qemu_mutex_unlock(&timer_list->active_timers_lock);
 226         return -1;
 227     }
 228     expire_time = timer_list->active_timers->expire_time;
 229     qemu_mutex_unlock(&timer_list->active_timers_lock);
 230
 231     delta = expire_time - qemu_clock_get_ns(timer_list->clock->type);
 232
 233     if (delta <= 0) {
 234         return 0;
 235     }
 236
 237     return delta;
 238 }
 239
 240 /* Calculate the soonest deadline across all timerlists attached
 241  * to the clock. This is used for the icount timeout so we
 242  * ignore whether or not the clock should be used in deadline
 243  * calculations.
 244  */
 245 int64_t qemu_clock_deadline_ns_all(QEMUClockType type)
 246 {
 247     int64_t deadline = -1;
 248     QEMUTimerList *timer_list;
 249     QEMUClock *clock = qemu_clock_ptr(type);
 250     QLIST_FOREACH(timer_list, &clock->timerlists, list) {
 251         deadline = qemu_soonest_timeout(deadline,
 252                                         timerlist_deadline_ns(timer_list));
 253     }
 254     return deadline;
 255 }
 256
 257 QEMUClockType timerlist_get_clock(QEMUTimerList *timer_list)
 258 {
 259     return timer_list->clock->type;
 260 }
 261
 262 QEMUTimerList *qemu_clock_get_main_loop_timerlist(QEMUClockType type)
 263 {
 264     return main_loop_tlg.tl[type];
 265 }
 266
 267 void timerlist_notify(QEMUTimerList *timer_list)
 268 {
 269     if (timer_list->notify_cb) {
 270         timer_list->notify_cb(timer_list->notify_opaque);
 271     } else {
 272         qemu_notify_event();
 273     }
 274 }
 275
 276 /* Transition function to convert a nanosecond timeout to ms
 277  * This is used where a system does not support ppoll
 278  */
 279 int qemu_timeout_ns_to_ms(int64_t ns)
 280 {
 281     int64_t ms;
 282     if (ns < 0) {
 283         return -1;
 284     }
 285
 286     if (!ns) {
 287         return 0;
 288     }
 289
 290     /* Always round up, because it's better to wait too long than to wait too
 291      * little and effectively busy-wait
 292      */
 293     ms = (ns + SCALE_MS - 1) / SCALE_MS;
 294
 295     /* To avoid overflow problems, limit this to 2^31, i.e. approx 25 days */
 296     if (ms > (int64_t) INT32_MAX) {
 297         ms = INT32_MAX;
 298     }
 299
 300     return (int) ms;
 301 }
 302
 303
 304 /* qemu implementation of g_poll which uses a nanosecond timeout but is
 305  * otherwise identical to g_poll
 306  */
 307 int qemu_poll_ns(GPollFD *fds, guint nfds, int64_t timeout)
 308 {
 309 #ifdef CONFIG_PPOLL
 310     if (timeout < 0) {
 311         return ppoll((struct pollfd *)fds, nfds, NULL, NULL);
 312     } else {
 313         struct timespec ts;
 314         ts.tv_sec = timeout / 1000000000LL;
 315         ts.tv_nsec = timeout % 1000000000LL;
 316         return ppoll((struct pollfd *)fds, nfds, &ts, NULL);
 317     }
 318 #elif defined(_WIN32)
 319     guint i;
 320     HANDLE handles[MAXIMUM_WAIT_OBJECTS];
 321     gint nhandles = 0;
 322     int num_completed = 0;
 323     gint timeout_ms = qemu_timeout_ns_to_ms(timeout);
 324
 325     for (i = 0; i < nfds; i++) {
 326         gint j;
 327
 328         if (fds[i].fd <= 0) {
 329             continue;
 330         }
 331
 332         /* don't add same handle several times
 333          */
 334         for (j = 0; j < nhandles; j++) {
 335             if (handles[j] == (HANDLE)fds[i].fd) {
 336                 break;
 337             }
 338         }
 339
 340         if (j == nhandles) {
 341             if (nhandles == MAXIMUM_WAIT_OBJECTS) {
 342                 fprintf(stderr, "Too many handles to wait for!\n");
 343                 break;
 344             } else {
 345                 handles[nhandles++] = (HANDLE)fds[i].fd;
 346             }
 347         }
 348     }
 349
 350     for (i = 0; i < nfds; ++i) {
 351         fds[i].revents = 0;
 352     }
 353
 354     if (timeout_ms == -1) {
 355         timeout_ms = INFINITE;
 356     }
 357
 358     if (nhandles == 0) {
 359         if (timeout_ms == INFINITE) {
 360             return -1;
 361         } else {
 362             SleepEx(timeout_ms, TRUE);
 363             return 0;
 364         }
 365     }
 366
 367     while (1) {
 368         DWORD res;
 369         gint j;
 370
 371         res = WaitForMultipleObjectsEx(nhandles, handles, FALSE,
 372             timeout_ms, TRUE);
 373
 374         if (res == WAIT_FAILED) {
 375             for (i = 0; i < nfds; ++i) {
 376                 fds[i].revents = 0;
 377             }
 378
 379             return -1;
 380         } else if ((res == WAIT_TIMEOUT) || (res == WAIT_IO_COMPLETION) ||
 381                    ((int)res < WAIT_OBJECT_0) ||
 382                    (res >= (WAIT_OBJECT_0 + nhandles))) {
 383             break;
 384         }
 385
 386         for (i = 0; i < nfds; ++i) {
 387             if (handles[res - WAIT_OBJECT_0] == (HANDLE)fds[i].fd) {
 388                 fds[i].revents = fds[i].events;
 389             }
 390         }
 391
 392         ++num_completed;
 393
 394         if (nhandles <= 1) {
 395             break;
 396         }
 397
 398         /* poll the rest of the handles
 399          */
 400         for (j = res - WAIT_OBJECT_0 + 1; j < nhandles; j++) {
 401             handles[j - 1] = handles[j];
 402         }
 403         --nhandles;
 404
 405         timeout_ms = 0;
 406     }
 407
 408     return num_completed;
 409 #else
 410     return g_poll(fds, nfds, qemu_timeout_ns_to_ms(timeout));
 411 #endif
 412 }
 413
 414
 415 void timer_init(QEMUTimer *ts,
 416                 QEMUTimerList *timer_list, int scale,
 417                 QEMUTimerCB *cb, void *opaque)
 418 {
 419     ts->timer_list = timer_list;
 420     ts->cb = cb;
 421     ts->opaque = opaque;
 422     ts->scale = scale;
 423     ts->expire_time = -1;
 424 }
 425
 426 void timer_free(QEMUTimer *ts)
 427 {
 428     g_free(ts);
 429 }
 430
 431 static void timer_del_locked(QEMUTimerList *timer_list, QEMUTimer *ts)
 432 {
 433     QEMUTimer **pt, *t;
 434
 435     ts->expire_time = -1;
 436     pt = &timer_list->active_timers;
 437     for(;;) {
 438         t = *pt;
 439         if (!t)
 440             break;
 441         if (t == ts) {
 442             *pt = t->next;
 443             break;
 444         }
 445         pt = &t->next;
 446     }
 447 }
 448
 449 static bool timer_mod_ns_locked(QEMUTimerList *timer_list,
 450                                 QEMUTimer *ts, int64_t expire_time)
 451 {
 452     QEMUTimer **pt, *t;
 453
 454     /* add the timer in the sorted list */
 455     pt = &timer_list->active_timers;
 456     for (;;) {
 457         t = *pt;
 458         if (!timer_expired_ns(t, expire_time)) {
 459             break;
 460         }
 461         pt = &t->next;
 462     }
 463     ts->expire_time = MAX(expire_time, 0);
 464     ts->next = *pt;
 465     *pt = ts;
 466
 467     return pt == &timer_list->active_timers;
 468 }
 469
 470 static void timerlist_rearm(QEMUTimerList *timer_list)
 471 {
 472     /* Interrupt execution to force deadline recalculation.  */
 473     qemu_clock_warp(timer_list->clock->type);
 474     timerlist_notify(timer_list);
 475 }
 476
 477 /* stop a timer, but do not dealloc it */
 478 void timer_del(QEMUTimer *ts)
 479 {
 480     QEMUTimerList *timer_list = ts->timer_list;
 481
 482     qemu_mutex_lock(&timer_list->active_timers_lock);
 483     timer_del_locked(timer_list, ts);
 484     qemu_mutex_unlock(&timer_list->active_timers_lock);
 485 }
 486
 487 /* modify the current timer so that it will be fired when current_time
 488    >= expire_time. The corresponding callback will be called. */
 489 void timer_mod_ns(QEMUTimer *ts, int64_t expire_time)
 490 {
 491     QEMUTimerList *timer_list = ts->timer_list;
 492     bool rearm;
 493
 494     qemu_mutex_lock(&timer_list->active_timers_lock);
 495     timer_del_locked(timer_list, ts);
 496     rearm = timer_mod_ns_locked(timer_list, ts, expire_time);
 497     qemu_mutex_unlock(&timer_list->active_timers_lock);
 498
 499     if (rearm) {
 500         timerlist_rearm(timer_list);
 501     }
 502 }
 503
 504 /* modify the current timer so that it will be fired when current_time
 505    >= expire_time or the current deadline, whichever comes earlier.
 506    The corresponding callback will be called. */
 507 void timer_mod_anticipate_ns(QEMUTimer *ts, int64_t expire_time)
 508 {
 509     QEMUTimerList *timer_list = ts->timer_list;
 510     bool rearm;
 511
 512     qemu_mutex_lock(&timer_list->active_timers_lock);
 513     if (ts->expire_time == -1 || ts->expire_time > expire_time) {
 514         if (ts->expire_time != -1) {
 515             timer_del_locked(timer_list, ts);
 516         }
 517         rearm = timer_mod_ns_locked(timer_list, ts, expire_time);
 518     } else {
 519         rearm = false;
 520     }
 521     qemu_mutex_unlock(&timer_list->active_timers_lock);
 522
 523     if (rearm) {
 524         timerlist_rearm(timer_list);
 525     }
 526 }
 527
 528 void timer_mod(QEMUTimer *ts, int64_t expire_time)
 529 {
 530     timer_mod_ns(ts, expire_time * ts->scale);
 531 }
 532
 533 void timer_mod_anticipate(QEMUTimer *ts, int64_t expire_time)
 534 {
 535     timer_mod_anticipate_ns(ts, expire_time * ts->scale);
 536 }
 537
 538 bool timer_pending(QEMUTimer *ts)
 539 {
 540     return ts->expire_time >= 0;
 541 }
 542
 543 bool timer_expired(QEMUTimer *timer_head, int64_t current_time)
 544 {
 545     return timer_expired_ns(timer_head, current_time * timer_head->scale);
 546 }
 547
 548 bool timerlist_run_timers(QEMUTimerList *timer_list)
 549 {
 550     QEMUTimer *ts;
 551     int64_t current_time;
 552     bool progress = false;
 553     QEMUTimerCB *cb;
 554     void *opaque;
 555
 556     qemu_event_reset(&timer_list->timers_done_ev);
 557     if (!timer_list->clock->enabled) {
 558         goto out;
 559     }
 560
 561     current_time = qemu_clock_get_ns(timer_list->clock->type);
 562     for(;;) {
 563         qemu_mutex_lock(&timer_list->active_timers_lock);
 564         ts = timer_list->active_timers;
 565         if (!timer_expired_ns(ts, current_time)) {
 566             qemu_mutex_unlock(&timer_list->active_timers_lock);
 567             break;
 568         }
 569
 570         /* remove timer from the list before calling the callback */
 571         timer_list->active_timers = ts->next;
 572         ts->next = NULL;
 573         ts->expire_time = -1;
 574         cb = ts->cb;
 575         opaque = ts->opaque;
 576         qemu_mutex_unlock(&timer_list->active_timers_lock);
 577
 578         /* run the callback (the timer list can be modified) */
 579         cb(opaque);
 580         progress = true;
 581     }
 582
 583 out:
 584     qemu_event_set(&timer_list->timers_done_ev);
 585     return progress;
 586 }
 587
 588 bool qemu_clock_run_timers(QEMUClockType type)
 589 {
 590     return timerlist_run_timers(main_loop_tlg.tl[type]);
 591 }
 592
 593 void timerlistgroup_init(QEMUTimerListGroup *tlg,
 594                          QEMUTimerListNotifyCB *cb, void *opaque)
 595 {
 596     QEMUClockType type;
 597     for (type = 0; type < QEMU_CLOCK_MAX; type++) {
 598         tlg->tl[type] = timerlist_new(type, cb, opaque);
 599     }
 600 }
 601
 602 void timerlistgroup_deinit(QEMUTimerListGroup *tlg)
 603 {
 604     QEMUClockType type;
 605     for (type = 0; type < QEMU_CLOCK_MAX; type++) {
 606         timerlist_free(tlg->tl[type]);
 607     }
 608 }
 609
 610 bool timerlistgroup_run_timers(QEMUTimerListGroup *tlg)
 611 {
 612     QEMUClockType type;
 613     bool progress = false;
 614     for (type = 0; type < QEMU_CLOCK_MAX; type++) {
 615         progress |= timerlist_run_timers(tlg->tl[type]);
 616     }
 617     return progress;
 618 }
 619
 620 int64_t timerlistgroup_deadline_ns(QEMUTimerListGroup *tlg)
 621 {
 622     int64_t deadline = -1;
 623     QEMUClockType type;
 624     for (type = 0; type < QEMU_CLOCK_MAX; type++) {
 625         if (qemu_clock_use_for_deadline(tlg->tl[type]->clock->type)) {
 626             deadline = qemu_soonest_timeout(deadline,
 627                                             timerlist_deadline_ns(
 628                                                 tlg->tl[type]));
 629         }
 630     }
 631     return deadline;
 632 }
 633
 634 int64_t qemu_clock_get_ns(QEMUClockType type)
 635 {
 636     int64_t now, last;
 637     QEMUClock *clock = qemu_clock_ptr(type);
 638
 639     switch (type) {
 640     case QEMU_CLOCK_REALTIME:
 641         return get_clock();
 642     default:
 643     case QEMU_CLOCK_VIRTUAL:
 644         if (use_icount) {
 645             return cpu_get_icount();
 646         } else {
 647             return cpu_get_clock();
 648         }
 649     case QEMU_CLOCK_HOST:
 650         now = get_clock_realtime();
 651         last = clock->last;
 652         clock->last = now;
 653         if (now < last) {
 654             notifier_list_notify(&clock->reset_notifiers, &now);
 655         }
 656         return now;
 657     }
 658 }
 659
 660 void qemu_clock_register_reset_notifier(QEMUClockType type,
 661                                         Notifier *notifier)
 662 {
 663     QEMUClock *clock = qemu_clock_ptr(type);
 664     notifier_list_add(&clock->reset_notifiers, notifier);
 665 }
 666
 667 void qemu_clock_unregister_reset_notifier(QEMUClockType type,
 668                                           Notifier *notifier)
 669 {
 670     notifier_remove(notifier);
 671 }
 672
 673 void init_clocks(void)
 674 {
 675     QEMUClockType type;
 676     for (type = 0; type < QEMU_CLOCK_MAX; type++) {
 677         qemu_clock_init(type);
 678     }
 679
 680 #ifdef CONFIG_PRCTL_PR_SET_TIMERSLACK
 681     prctl(PR_SET_TIMERSLACK, 1, 0, 0, 0);
 682 #endif
 683 }
 684
 685 uint64_t timer_expire_time_ns(QEMUTimer *ts)
 686 {
 687     return timer_pending(ts) ? ts->expire_time : -1;
 688 }
 689
 690 bool qemu_clock_run_all_timers(void)
 691 {
 692     bool progress = false;
 693     QEMUClockType type;
 694
 695     for (type = 0; type < QEMU_CLOCK_MAX; type++) {
 696         progress |= qemu_clock_run_timers(type);
 697     }
 698
 699     return progress;
 700 }