4 * Copyright (c) 2003-2008 Fabrice Bellard
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:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
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
25 #include "sysemu/sysemu.h"
26 #include "monitor/monitor.h"
27 #include "ui/console.h"
31 #include "qemu/timer.h"
44 /***********************************************************/
48 QEMUTimer *active_timers;
50 NotifierList reset_notifiers;
58 int64_t expire_time; /* in nanoseconds */
66 struct qemu_alarm_timer {
68 int (*start)(struct qemu_alarm_timer *t);
69 void (*stop)(struct qemu_alarm_timer *t);
70 void (*rearm)(struct qemu_alarm_timer *t, int64_t nearest_delta_ns);
71 #if defined(__linux__)
81 static struct qemu_alarm_timer *alarm_timer;
83 static bool timer_expired_ns(QEMUTimer *timer_head, int64_t current_time)
85 return timer_head && (timer_head->expire_time <= current_time);
88 static int64_t qemu_next_alarm_deadline(void)
90 int64_t delta = INT64_MAX;
93 if (!use_icount && vm_clock->enabled && vm_clock->active_timers) {
94 delta = vm_clock->active_timers->expire_time -
95 qemu_get_clock_ns(vm_clock);
97 if (host_clock->enabled && host_clock->active_timers) {
98 int64_t hdelta = host_clock->active_timers->expire_time -
99 qemu_get_clock_ns(host_clock);
100 if (hdelta < delta) {
104 if (rt_clock->enabled && rt_clock->active_timers) {
105 rtdelta = (rt_clock->active_timers->expire_time -
106 qemu_get_clock_ns(rt_clock));
107 if (rtdelta < delta) {
115 static void qemu_rearm_alarm_timer(struct qemu_alarm_timer *t)
117 int64_t nearest_delta_ns = qemu_next_alarm_deadline();
118 if (nearest_delta_ns < INT64_MAX) {
119 t->rearm(t, nearest_delta_ns);
123 /* TODO: MIN_TIMER_REARM_NS should be optimized */
124 #define MIN_TIMER_REARM_NS 250000
128 static int mm_start_timer(struct qemu_alarm_timer *t);
129 static void mm_stop_timer(struct qemu_alarm_timer *t);
130 static void mm_rearm_timer(struct qemu_alarm_timer *t, int64_t delta);
132 static int win32_start_timer(struct qemu_alarm_timer *t);
133 static void win32_stop_timer(struct qemu_alarm_timer *t);
134 static void win32_rearm_timer(struct qemu_alarm_timer *t, int64_t delta);
138 static int unix_start_timer(struct qemu_alarm_timer *t);
139 static void unix_stop_timer(struct qemu_alarm_timer *t);
140 static void unix_rearm_timer(struct qemu_alarm_timer *t, int64_t delta);
144 static int dynticks_start_timer(struct qemu_alarm_timer *t);
145 static void dynticks_stop_timer(struct qemu_alarm_timer *t);
146 static void dynticks_rearm_timer(struct qemu_alarm_timer *t, int64_t delta);
148 #endif /* __linux__ */
152 static struct qemu_alarm_timer alarm_timers[] = {
155 {"dynticks", dynticks_start_timer,
156 dynticks_stop_timer, dynticks_rearm_timer},
158 {"unix", unix_start_timer, unix_stop_timer, unix_rearm_timer},
160 {"mmtimer", mm_start_timer, mm_stop_timer, mm_rearm_timer},
161 {"dynticks", win32_start_timer, win32_stop_timer, win32_rearm_timer},
166 static void show_available_alarms(void)
170 printf("Available alarm timers, in order of precedence:\n");
171 for (i = 0; alarm_timers[i].name; i++)
172 printf("%s\n", alarm_timers[i].name);
175 void configure_alarms(char const *opt)
179 int count = ARRAY_SIZE(alarm_timers) - 1;
182 struct qemu_alarm_timer tmp;
184 if (is_help_option(opt)) {
185 show_available_alarms();
191 /* Reorder the array */
192 name = strtok(arg, ",");
194 for (i = 0; i < count && alarm_timers[i].name; i++) {
195 if (!strcmp(alarm_timers[i].name, name))
200 fprintf(stderr, "Unknown clock %s\n", name);
209 tmp = alarm_timers[i];
210 alarm_timers[i] = alarm_timers[cur];
211 alarm_timers[cur] = tmp;
215 name = strtok(NULL, ",");
221 /* Disable remaining timers */
222 for (i = cur; i < count; i++)
223 alarm_timers[i].name = NULL;
225 show_available_alarms();
232 QEMUClock *host_clock;
234 static QEMUClock *qemu_clock_new(int type)
238 clock = g_malloc0(sizeof(QEMUClock));
240 clock->enabled = true;
241 clock->last = INT64_MIN;
242 notifier_list_init(&clock->reset_notifiers);
246 void qemu_clock_enable(QEMUClock *clock, bool enabled)
248 bool old = clock->enabled;
249 clock->enabled = enabled;
250 if (enabled && !old) {
251 qemu_rearm_alarm_timer(alarm_timer);
255 int64_t qemu_clock_has_timers(QEMUClock *clock)
257 return !!clock->active_timers;
260 int64_t qemu_clock_expired(QEMUClock *clock)
262 return (clock->active_timers &&
263 clock->active_timers->expire_time < qemu_get_clock_ns(clock));
266 int64_t qemu_clock_deadline(QEMUClock *clock)
268 /* To avoid problems with overflow limit this to 2^32. */
269 int64_t delta = INT32_MAX;
271 if (clock->enabled && clock->active_timers) {
272 delta = clock->active_timers->expire_time - qemu_get_clock_ns(clock);
281 * As above, but return -1 for no deadline, and do not cap to 2^32
282 * as we know the result is always positive.
285 int64_t qemu_clock_deadline_ns(QEMUClock *clock)
289 if (!clock->enabled || !clock->active_timers) {
293 delta = clock->active_timers->expire_time - qemu_get_clock_ns(clock);
302 /* Transition function to convert a nanosecond timeout to ms
303 * This is used where a system does not support ppoll
305 int qemu_timeout_ns_to_ms(int64_t ns)
316 /* Always round up, because it's better to wait too long than to wait too
317 * little and effectively busy-wait
319 ms = (ns + SCALE_MS - 1) / SCALE_MS;
321 /* To avoid overflow problems, limit this to 2^31, i.e. approx 25 days */
322 if (ms > (int64_t) INT32_MAX) {
330 /* qemu implementation of g_poll which uses a nanosecond timeout but is
331 * otherwise identical to g_poll
333 int qemu_poll_ns(GPollFD *fds, guint nfds, int64_t timeout)
337 return ppoll((struct pollfd *)fds, nfds, NULL, NULL);
340 ts.tv_sec = timeout / 1000000000LL;
341 ts.tv_nsec = timeout % 1000000000LL;
342 return ppoll((struct pollfd *)fds, nfds, &ts, NULL);
345 return g_poll(fds, nfds, qemu_timeout_ns_to_ms(timeout));
350 QEMUTimer *qemu_new_timer(QEMUClock *clock, int scale,
351 QEMUTimerCB *cb, void *opaque)
355 ts = g_malloc0(sizeof(QEMUTimer));
363 void qemu_free_timer(QEMUTimer *ts)
368 /* stop a timer, but do not dealloc it */
369 void qemu_del_timer(QEMUTimer *ts)
373 /* NOTE: this code must be signal safe because
374 timer_expired() can be called from a signal. */
375 pt = &ts->clock->active_timers;
388 /* modify the current timer so that it will be fired when current_time
389 >= expire_time. The corresponding callback will be called. */
390 void qemu_mod_timer_ns(QEMUTimer *ts, int64_t expire_time)
396 /* add the timer in the sorted list */
397 /* NOTE: this code must be signal safe because
398 timer_expired() can be called from a signal. */
399 pt = &ts->clock->active_timers;
402 if (!timer_expired_ns(t, expire_time)) {
407 ts->expire_time = expire_time;
411 /* Rearm if necessary */
412 if (pt == &ts->clock->active_timers) {
413 if (!alarm_timer->pending) {
414 qemu_rearm_alarm_timer(alarm_timer);
416 /* Interrupt execution to force deadline recalculation. */
417 qemu_clock_warp(ts->clock);
424 void qemu_mod_timer(QEMUTimer *ts, int64_t expire_time)
426 qemu_mod_timer_ns(ts, expire_time * ts->scale);
429 bool timer_pending(QEMUTimer *ts)
432 for (t = ts->clock->active_timers; t != NULL; t = t->next) {
440 bool timer_expired(QEMUTimer *timer_head, int64_t current_time)
442 return timer_expired_ns(timer_head, current_time * timer_head->scale);
445 void qemu_run_timers(QEMUClock *clock)
448 int64_t current_time;
453 current_time = qemu_get_clock_ns(clock);
455 ts = clock->active_timers;
456 if (!timer_expired_ns(ts, current_time)) {
459 /* remove timer from the list before calling the callback */
460 clock->active_timers = ts->next;
463 /* run the callback (the timer list can be modified) */
468 int64_t qemu_get_clock_ns(QEMUClock *clock)
472 switch(clock->type) {
473 case QEMU_CLOCK_REALTIME:
476 case QEMU_CLOCK_VIRTUAL:
478 return cpu_get_icount();
480 return cpu_get_clock();
482 case QEMU_CLOCK_HOST:
483 now = get_clock_realtime();
487 notifier_list_notify(&clock->reset_notifiers, &now);
493 void qemu_register_clock_reset_notifier(QEMUClock *clock, Notifier *notifier)
495 notifier_list_add(&clock->reset_notifiers, notifier);
498 void qemu_unregister_clock_reset_notifier(QEMUClock *clock, Notifier *notifier)
500 notifier_remove(notifier);
503 void init_clocks(void)
506 rt_clock = qemu_clock_new(QEMU_CLOCK_REALTIME);
507 vm_clock = qemu_clock_new(QEMU_CLOCK_VIRTUAL);
508 host_clock = qemu_clock_new(QEMU_CLOCK_HOST);
512 uint64_t timer_expire_time_ns(QEMUTimer *ts)
514 return timer_pending(ts) ? ts->expire_time : -1;
517 void qemu_run_all_timers(void)
519 alarm_timer->pending = false;
522 qemu_run_timers(vm_clock);
523 qemu_run_timers(rt_clock);
524 qemu_run_timers(host_clock);
526 /* rearm timer, if not periodic */
527 if (alarm_timer->expired) {
528 alarm_timer->expired = false;
529 qemu_rearm_alarm_timer(alarm_timer);
534 static void CALLBACK host_alarm_handler(PVOID lpParam, BOOLEAN unused)
536 static void host_alarm_handler(int host_signum)
539 struct qemu_alarm_timer *t = alarm_timer;
548 #if defined(__linux__)
550 #include "qemu/compatfd.h"
552 static int dynticks_start_timer(struct qemu_alarm_timer *t)
556 struct sigaction act;
558 sigfillset(&act.sa_mask);
560 act.sa_handler = host_alarm_handler;
562 sigaction(SIGALRM, &act, NULL);
565 * Initialize ev struct to 0 to avoid valgrind complaining
566 * about uninitialized data in timer_create call
568 memset(&ev, 0, sizeof(ev));
569 ev.sigev_value.sival_int = 0;
570 ev.sigev_notify = SIGEV_SIGNAL;
571 #ifdef CONFIG_SIGEV_THREAD_ID
572 if (qemu_signalfd_available()) {
573 ev.sigev_notify = SIGEV_THREAD_ID;
574 ev._sigev_un._tid = qemu_get_thread_id();
576 #endif /* CONFIG_SIGEV_THREAD_ID */
577 ev.sigev_signo = SIGALRM;
579 if (timer_create(CLOCK_REALTIME, &ev, &host_timer)) {
580 perror("timer_create");
584 t->timer = host_timer;
589 static void dynticks_stop_timer(struct qemu_alarm_timer *t)
591 timer_t host_timer = t->timer;
593 timer_delete(host_timer);
596 static void dynticks_rearm_timer(struct qemu_alarm_timer *t,
597 int64_t nearest_delta_ns)
599 timer_t host_timer = t->timer;
600 struct itimerspec timeout;
603 if (nearest_delta_ns < MIN_TIMER_REARM_NS)
604 nearest_delta_ns = MIN_TIMER_REARM_NS;
606 /* check whether a timer is already running */
607 if (timer_gettime(host_timer, &timeout)) {
609 fprintf(stderr, "Internal timer error: aborting\n");
612 current_ns = timeout.it_value.tv_sec * 1000000000LL + timeout.it_value.tv_nsec;
613 if (current_ns && current_ns <= nearest_delta_ns)
616 timeout.it_interval.tv_sec = 0;
617 timeout.it_interval.tv_nsec = 0; /* 0 for one-shot timer */
618 timeout.it_value.tv_sec = nearest_delta_ns / 1000000000;
619 timeout.it_value.tv_nsec = nearest_delta_ns % 1000000000;
620 if (timer_settime(host_timer, 0 /* RELATIVE */, &timeout, NULL)) {
622 fprintf(stderr, "Internal timer error: aborting\n");
627 #endif /* defined(__linux__) */
631 static int unix_start_timer(struct qemu_alarm_timer *t)
633 struct sigaction act;
636 sigfillset(&act.sa_mask);
638 act.sa_handler = host_alarm_handler;
640 sigaction(SIGALRM, &act, NULL);
644 static void unix_rearm_timer(struct qemu_alarm_timer *t,
645 int64_t nearest_delta_ns)
647 struct itimerval itv;
650 if (nearest_delta_ns < MIN_TIMER_REARM_NS)
651 nearest_delta_ns = MIN_TIMER_REARM_NS;
653 itv.it_interval.tv_sec = 0;
654 itv.it_interval.tv_usec = 0; /* 0 for one-shot timer */
655 itv.it_value.tv_sec = nearest_delta_ns / 1000000000;
656 itv.it_value.tv_usec = (nearest_delta_ns % 1000000000) / 1000;
657 err = setitimer(ITIMER_REAL, &itv, NULL);
660 fprintf(stderr, "Internal timer error: aborting\n");
665 static void unix_stop_timer(struct qemu_alarm_timer *t)
667 struct itimerval itv;
669 memset(&itv, 0, sizeof(itv));
670 setitimer(ITIMER_REAL, &itv, NULL);
673 #endif /* !defined(_WIN32) */
678 static MMRESULT mm_timer;
679 static TIMECAPS mm_tc;
681 static void CALLBACK mm_alarm_handler(UINT uTimerID, UINT uMsg,
682 DWORD_PTR dwUser, DWORD_PTR dw1,
685 struct qemu_alarm_timer *t = alarm_timer;
694 static int mm_start_timer(struct qemu_alarm_timer *t)
696 timeGetDevCaps(&mm_tc, sizeof(mm_tc));
700 static void mm_stop_timer(struct qemu_alarm_timer *t)
703 timeKillEvent(mm_timer);
707 static void mm_rearm_timer(struct qemu_alarm_timer *t, int64_t delta)
709 int64_t nearest_delta_ms = delta / 1000000;
710 if (nearest_delta_ms < mm_tc.wPeriodMin) {
711 nearest_delta_ms = mm_tc.wPeriodMin;
712 } else if (nearest_delta_ms > mm_tc.wPeriodMax) {
713 nearest_delta_ms = mm_tc.wPeriodMax;
717 timeKillEvent(mm_timer);
719 mm_timer = timeSetEvent((UINT)nearest_delta_ms,
723 TIME_ONESHOT | TIME_CALLBACK_FUNCTION);
726 fprintf(stderr, "Failed to re-arm win32 alarm timer\n");
727 timeEndPeriod(mm_tc.wPeriodMin);
732 static int win32_start_timer(struct qemu_alarm_timer *t)
737 /* If you call ChangeTimerQueueTimer on a one-shot timer (its period
738 is zero) that has already expired, the timer is not updated. Since
739 creating a new timer is relatively expensive, set a bogus one-hour
740 interval in the dynticks case. */
741 success = CreateTimerQueueTimer(&hTimer,
747 WT_EXECUTEINTIMERTHREAD);
750 fprintf(stderr, "Failed to initialize win32 alarm timer: %ld\n",
759 static void win32_stop_timer(struct qemu_alarm_timer *t)
761 HANDLE hTimer = t->timer;
764 DeleteTimerQueueTimer(NULL, hTimer, NULL);
768 static void win32_rearm_timer(struct qemu_alarm_timer *t,
769 int64_t nearest_delta_ns)
771 HANDLE hTimer = t->timer;
772 int64_t nearest_delta_ms;
775 nearest_delta_ms = nearest_delta_ns / 1000000;
776 if (nearest_delta_ms < 1) {
777 nearest_delta_ms = 1;
779 /* ULONG_MAX can be 32 bit */
780 if (nearest_delta_ms > ULONG_MAX) {
781 nearest_delta_ms = ULONG_MAX;
783 success = ChangeTimerQueueTimer(NULL,
785 (unsigned long) nearest_delta_ms,
789 fprintf(stderr, "Failed to rearm win32 alarm timer: %ld\n",
798 static void quit_timers(void)
800 struct qemu_alarm_timer *t = alarm_timer;
806 static void reinit_timers(void)
808 struct qemu_alarm_timer *t = alarm_timer;
811 fprintf(stderr, "Internal timer error: aborting\n");
814 qemu_rearm_alarm_timer(t);
816 #endif /* CONFIG_POSIX */
818 int init_timer_alarm(void)
820 struct qemu_alarm_timer *t = NULL;
827 for (i = 0; alarm_timers[i].name; i++) {
828 t = &alarm_timers[i];
842 pthread_atfork(NULL, NULL, reinit_timers);