aio / timers: Rename qemu_new_clock and expose clock types
[qemu/ar7.git] / qemu-timer.c
blob4117addcdef14eab817fe050a6914829ea2f742c
1 /*
2 * QEMU System Emulator
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
22 * THE SOFTWARE.
25 #include "sysemu/sysemu.h"
26 #include "monitor/monitor.h"
27 #include "ui/console.h"
29 #include "hw/hw.h"
31 #include "qemu/timer.h"
32 #ifdef CONFIG_POSIX
33 #include <pthread.h>
34 #endif
36 #ifdef _WIN32
37 #include <mmsystem.h>
38 #endif
40 /***********************************************************/
41 /* timers */
43 struct QEMUClock {
44 QEMUTimer *active_timers;
46 NotifierList reset_notifiers;
47 int64_t last;
49 int type;
50 bool enabled;
53 struct QEMUTimer {
54 int64_t expire_time; /* in nanoseconds */
55 QEMUClock *clock;
56 QEMUTimerCB *cb;
57 void *opaque;
58 QEMUTimer *next;
59 int scale;
62 struct qemu_alarm_timer {
63 char const *name;
64 int (*start)(struct qemu_alarm_timer *t);
65 void (*stop)(struct qemu_alarm_timer *t);
66 void (*rearm)(struct qemu_alarm_timer *t, int64_t nearest_delta_ns);
67 #if defined(__linux__)
68 timer_t timer;
69 int fd;
70 #elif defined(_WIN32)
71 HANDLE timer;
72 #endif
73 bool expired;
74 bool pending;
77 static struct qemu_alarm_timer *alarm_timer;
79 static bool timer_expired_ns(QEMUTimer *timer_head, int64_t current_time)
81 return timer_head && (timer_head->expire_time <= current_time);
84 static int64_t qemu_next_alarm_deadline(void)
86 int64_t delta = INT64_MAX;
87 int64_t rtdelta;
89 if (!use_icount && vm_clock->enabled && vm_clock->active_timers) {
90 delta = vm_clock->active_timers->expire_time -
91 qemu_get_clock_ns(vm_clock);
93 if (host_clock->enabled && host_clock->active_timers) {
94 int64_t hdelta = host_clock->active_timers->expire_time -
95 qemu_get_clock_ns(host_clock);
96 if (hdelta < delta) {
97 delta = hdelta;
100 if (rt_clock->enabled && rt_clock->active_timers) {
101 rtdelta = (rt_clock->active_timers->expire_time -
102 qemu_get_clock_ns(rt_clock));
103 if (rtdelta < delta) {
104 delta = rtdelta;
108 return delta;
111 static void qemu_rearm_alarm_timer(struct qemu_alarm_timer *t)
113 int64_t nearest_delta_ns = qemu_next_alarm_deadline();
114 if (nearest_delta_ns < INT64_MAX) {
115 t->rearm(t, nearest_delta_ns);
119 /* TODO: MIN_TIMER_REARM_NS should be optimized */
120 #define MIN_TIMER_REARM_NS 250000
122 #ifdef _WIN32
124 static int mm_start_timer(struct qemu_alarm_timer *t);
125 static void mm_stop_timer(struct qemu_alarm_timer *t);
126 static void mm_rearm_timer(struct qemu_alarm_timer *t, int64_t delta);
128 static int win32_start_timer(struct qemu_alarm_timer *t);
129 static void win32_stop_timer(struct qemu_alarm_timer *t);
130 static void win32_rearm_timer(struct qemu_alarm_timer *t, int64_t delta);
132 #else
134 static int unix_start_timer(struct qemu_alarm_timer *t);
135 static void unix_stop_timer(struct qemu_alarm_timer *t);
136 static void unix_rearm_timer(struct qemu_alarm_timer *t, int64_t delta);
138 #ifdef __linux__
140 static int dynticks_start_timer(struct qemu_alarm_timer *t);
141 static void dynticks_stop_timer(struct qemu_alarm_timer *t);
142 static void dynticks_rearm_timer(struct qemu_alarm_timer *t, int64_t delta);
144 #endif /* __linux__ */
146 #endif /* _WIN32 */
148 static struct qemu_alarm_timer alarm_timers[] = {
149 #ifndef _WIN32
150 #ifdef __linux__
151 {"dynticks", dynticks_start_timer,
152 dynticks_stop_timer, dynticks_rearm_timer},
153 #endif
154 {"unix", unix_start_timer, unix_stop_timer, unix_rearm_timer},
155 #else
156 {"mmtimer", mm_start_timer, mm_stop_timer, mm_rearm_timer},
157 {"dynticks", win32_start_timer, win32_stop_timer, win32_rearm_timer},
158 #endif
159 {NULL, }
162 static void show_available_alarms(void)
164 int i;
166 printf("Available alarm timers, in order of precedence:\n");
167 for (i = 0; alarm_timers[i].name; i++)
168 printf("%s\n", alarm_timers[i].name);
171 void configure_alarms(char const *opt)
173 int i;
174 int cur = 0;
175 int count = ARRAY_SIZE(alarm_timers) - 1;
176 char *arg;
177 char *name;
178 struct qemu_alarm_timer tmp;
180 if (is_help_option(opt)) {
181 show_available_alarms();
182 exit(0);
185 arg = g_strdup(opt);
187 /* Reorder the array */
188 name = strtok(arg, ",");
189 while (name) {
190 for (i = 0; i < count && alarm_timers[i].name; i++) {
191 if (!strcmp(alarm_timers[i].name, name))
192 break;
195 if (i == count) {
196 fprintf(stderr, "Unknown clock %s\n", name);
197 goto next;
200 if (i < cur)
201 /* Ignore */
202 goto next;
204 /* Swap */
205 tmp = alarm_timers[i];
206 alarm_timers[i] = alarm_timers[cur];
207 alarm_timers[cur] = tmp;
209 cur++;
210 next:
211 name = strtok(NULL, ",");
214 g_free(arg);
216 if (cur) {
217 /* Disable remaining timers */
218 for (i = cur; i < count; i++)
219 alarm_timers[i].name = NULL;
220 } else {
221 show_available_alarms();
222 exit(1);
226 QEMUClock *rt_clock;
227 QEMUClock *vm_clock;
228 QEMUClock *host_clock;
230 static QEMUClock *qemu_clock_new(int type)
232 QEMUClock *clock;
234 clock = g_malloc0(sizeof(QEMUClock));
235 clock->type = type;
236 clock->enabled = true;
237 clock->last = INT64_MIN;
238 notifier_list_init(&clock->reset_notifiers);
239 return clock;
242 void qemu_clock_enable(QEMUClock *clock, bool enabled)
244 bool old = clock->enabled;
245 clock->enabled = enabled;
246 if (enabled && !old) {
247 qemu_rearm_alarm_timer(alarm_timer);
251 int64_t qemu_clock_has_timers(QEMUClock *clock)
253 return !!clock->active_timers;
256 int64_t qemu_clock_expired(QEMUClock *clock)
258 return (clock->active_timers &&
259 clock->active_timers->expire_time < qemu_get_clock_ns(clock));
262 int64_t qemu_clock_deadline(QEMUClock *clock)
264 /* To avoid problems with overflow limit this to 2^32. */
265 int64_t delta = INT32_MAX;
267 if (clock->active_timers) {
268 delta = clock->active_timers->expire_time - qemu_get_clock_ns(clock);
270 if (delta < 0) {
271 delta = 0;
273 return delta;
276 QEMUTimer *qemu_new_timer(QEMUClock *clock, int scale,
277 QEMUTimerCB *cb, void *opaque)
279 QEMUTimer *ts;
281 ts = g_malloc0(sizeof(QEMUTimer));
282 ts->clock = clock;
283 ts->cb = cb;
284 ts->opaque = opaque;
285 ts->scale = scale;
286 return ts;
289 void qemu_free_timer(QEMUTimer *ts)
291 g_free(ts);
294 /* stop a timer, but do not dealloc it */
295 void qemu_del_timer(QEMUTimer *ts)
297 QEMUTimer **pt, *t;
299 /* NOTE: this code must be signal safe because
300 timer_expired() can be called from a signal. */
301 pt = &ts->clock->active_timers;
302 for(;;) {
303 t = *pt;
304 if (!t)
305 break;
306 if (t == ts) {
307 *pt = t->next;
308 break;
310 pt = &t->next;
314 /* modify the current timer so that it will be fired when current_time
315 >= expire_time. The corresponding callback will be called. */
316 void qemu_mod_timer_ns(QEMUTimer *ts, int64_t expire_time)
318 QEMUTimer **pt, *t;
320 qemu_del_timer(ts);
322 /* add the timer in the sorted list */
323 /* NOTE: this code must be signal safe because
324 timer_expired() can be called from a signal. */
325 pt = &ts->clock->active_timers;
326 for(;;) {
327 t = *pt;
328 if (!timer_expired_ns(t, expire_time)) {
329 break;
331 pt = &t->next;
333 ts->expire_time = expire_time;
334 ts->next = *pt;
335 *pt = ts;
337 /* Rearm if necessary */
338 if (pt == &ts->clock->active_timers) {
339 if (!alarm_timer->pending) {
340 qemu_rearm_alarm_timer(alarm_timer);
342 /* Interrupt execution to force deadline recalculation. */
343 qemu_clock_warp(ts->clock);
344 if (use_icount) {
345 qemu_notify_event();
350 void qemu_mod_timer(QEMUTimer *ts, int64_t expire_time)
352 qemu_mod_timer_ns(ts, expire_time * ts->scale);
355 bool timer_pending(QEMUTimer *ts)
357 QEMUTimer *t;
358 for (t = ts->clock->active_timers; t != NULL; t = t->next) {
359 if (t == ts) {
360 return true;
363 return false;
366 bool timer_expired(QEMUTimer *timer_head, int64_t current_time)
368 return timer_expired_ns(timer_head, current_time * timer_head->scale);
371 void qemu_run_timers(QEMUClock *clock)
373 QEMUTimer *ts;
374 int64_t current_time;
376 if (!clock->enabled)
377 return;
379 current_time = qemu_get_clock_ns(clock);
380 for(;;) {
381 ts = clock->active_timers;
382 if (!timer_expired_ns(ts, current_time)) {
383 break;
385 /* remove timer from the list before calling the callback */
386 clock->active_timers = ts->next;
387 ts->next = NULL;
389 /* run the callback (the timer list can be modified) */
390 ts->cb(ts->opaque);
394 int64_t qemu_get_clock_ns(QEMUClock *clock)
396 int64_t now, last;
398 switch(clock->type) {
399 case QEMU_CLOCK_REALTIME:
400 return get_clock();
401 default:
402 case QEMU_CLOCK_VIRTUAL:
403 if (use_icount) {
404 return cpu_get_icount();
405 } else {
406 return cpu_get_clock();
408 case QEMU_CLOCK_HOST:
409 now = get_clock_realtime();
410 last = clock->last;
411 clock->last = now;
412 if (now < last) {
413 notifier_list_notify(&clock->reset_notifiers, &now);
415 return now;
419 void qemu_register_clock_reset_notifier(QEMUClock *clock, Notifier *notifier)
421 notifier_list_add(&clock->reset_notifiers, notifier);
424 void qemu_unregister_clock_reset_notifier(QEMUClock *clock, Notifier *notifier)
426 notifier_remove(notifier);
429 void init_clocks(void)
431 if (!rt_clock) {
432 rt_clock = qemu_clock_new(QEMU_CLOCK_REALTIME);
433 vm_clock = qemu_clock_new(QEMU_CLOCK_VIRTUAL);
434 host_clock = qemu_clock_new(QEMU_CLOCK_HOST);
438 uint64_t timer_expire_time_ns(QEMUTimer *ts)
440 return timer_pending(ts) ? ts->expire_time : -1;
443 void qemu_run_all_timers(void)
445 alarm_timer->pending = false;
447 /* vm time timers */
448 qemu_run_timers(vm_clock);
449 qemu_run_timers(rt_clock);
450 qemu_run_timers(host_clock);
452 /* rearm timer, if not periodic */
453 if (alarm_timer->expired) {
454 alarm_timer->expired = false;
455 qemu_rearm_alarm_timer(alarm_timer);
459 #ifdef _WIN32
460 static void CALLBACK host_alarm_handler(PVOID lpParam, BOOLEAN unused)
461 #else
462 static void host_alarm_handler(int host_signum)
463 #endif
465 struct qemu_alarm_timer *t = alarm_timer;
466 if (!t)
467 return;
469 t->expired = true;
470 t->pending = true;
471 qemu_notify_event();
474 #if defined(__linux__)
476 #include "qemu/compatfd.h"
478 static int dynticks_start_timer(struct qemu_alarm_timer *t)
480 struct sigevent ev;
481 timer_t host_timer;
482 struct sigaction act;
484 sigfillset(&act.sa_mask);
485 act.sa_flags = 0;
486 act.sa_handler = host_alarm_handler;
488 sigaction(SIGALRM, &act, NULL);
491 * Initialize ev struct to 0 to avoid valgrind complaining
492 * about uninitialized data in timer_create call
494 memset(&ev, 0, sizeof(ev));
495 ev.sigev_value.sival_int = 0;
496 ev.sigev_notify = SIGEV_SIGNAL;
497 #ifdef CONFIG_SIGEV_THREAD_ID
498 if (qemu_signalfd_available()) {
499 ev.sigev_notify = SIGEV_THREAD_ID;
500 ev._sigev_un._tid = qemu_get_thread_id();
502 #endif /* CONFIG_SIGEV_THREAD_ID */
503 ev.sigev_signo = SIGALRM;
505 if (timer_create(CLOCK_REALTIME, &ev, &host_timer)) {
506 perror("timer_create");
507 return -1;
510 t->timer = host_timer;
512 return 0;
515 static void dynticks_stop_timer(struct qemu_alarm_timer *t)
517 timer_t host_timer = t->timer;
519 timer_delete(host_timer);
522 static void dynticks_rearm_timer(struct qemu_alarm_timer *t,
523 int64_t nearest_delta_ns)
525 timer_t host_timer = t->timer;
526 struct itimerspec timeout;
527 int64_t current_ns;
529 if (nearest_delta_ns < MIN_TIMER_REARM_NS)
530 nearest_delta_ns = MIN_TIMER_REARM_NS;
532 /* check whether a timer is already running */
533 if (timer_gettime(host_timer, &timeout)) {
534 perror("gettime");
535 fprintf(stderr, "Internal timer error: aborting\n");
536 exit(1);
538 current_ns = timeout.it_value.tv_sec * 1000000000LL + timeout.it_value.tv_nsec;
539 if (current_ns && current_ns <= nearest_delta_ns)
540 return;
542 timeout.it_interval.tv_sec = 0;
543 timeout.it_interval.tv_nsec = 0; /* 0 for one-shot timer */
544 timeout.it_value.tv_sec = nearest_delta_ns / 1000000000;
545 timeout.it_value.tv_nsec = nearest_delta_ns % 1000000000;
546 if (timer_settime(host_timer, 0 /* RELATIVE */, &timeout, NULL)) {
547 perror("settime");
548 fprintf(stderr, "Internal timer error: aborting\n");
549 exit(1);
553 #endif /* defined(__linux__) */
555 #if !defined(_WIN32)
557 static int unix_start_timer(struct qemu_alarm_timer *t)
559 struct sigaction act;
561 /* timer signal */
562 sigfillset(&act.sa_mask);
563 act.sa_flags = 0;
564 act.sa_handler = host_alarm_handler;
566 sigaction(SIGALRM, &act, NULL);
567 return 0;
570 static void unix_rearm_timer(struct qemu_alarm_timer *t,
571 int64_t nearest_delta_ns)
573 struct itimerval itv;
574 int err;
576 if (nearest_delta_ns < MIN_TIMER_REARM_NS)
577 nearest_delta_ns = MIN_TIMER_REARM_NS;
579 itv.it_interval.tv_sec = 0;
580 itv.it_interval.tv_usec = 0; /* 0 for one-shot timer */
581 itv.it_value.tv_sec = nearest_delta_ns / 1000000000;
582 itv.it_value.tv_usec = (nearest_delta_ns % 1000000000) / 1000;
583 err = setitimer(ITIMER_REAL, &itv, NULL);
584 if (err) {
585 perror("setitimer");
586 fprintf(stderr, "Internal timer error: aborting\n");
587 exit(1);
591 static void unix_stop_timer(struct qemu_alarm_timer *t)
593 struct itimerval itv;
595 memset(&itv, 0, sizeof(itv));
596 setitimer(ITIMER_REAL, &itv, NULL);
599 #endif /* !defined(_WIN32) */
602 #ifdef _WIN32
604 static MMRESULT mm_timer;
605 static TIMECAPS mm_tc;
607 static void CALLBACK mm_alarm_handler(UINT uTimerID, UINT uMsg,
608 DWORD_PTR dwUser, DWORD_PTR dw1,
609 DWORD_PTR dw2)
611 struct qemu_alarm_timer *t = alarm_timer;
612 if (!t) {
613 return;
615 t->expired = true;
616 t->pending = true;
617 qemu_notify_event();
620 static int mm_start_timer(struct qemu_alarm_timer *t)
622 timeGetDevCaps(&mm_tc, sizeof(mm_tc));
623 return 0;
626 static void mm_stop_timer(struct qemu_alarm_timer *t)
628 if (mm_timer) {
629 timeKillEvent(mm_timer);
633 static void mm_rearm_timer(struct qemu_alarm_timer *t, int64_t delta)
635 int64_t nearest_delta_ms = delta / 1000000;
636 if (nearest_delta_ms < mm_tc.wPeriodMin) {
637 nearest_delta_ms = mm_tc.wPeriodMin;
638 } else if (nearest_delta_ms > mm_tc.wPeriodMax) {
639 nearest_delta_ms = mm_tc.wPeriodMax;
642 if (mm_timer) {
643 timeKillEvent(mm_timer);
645 mm_timer = timeSetEvent((UINT)nearest_delta_ms,
646 mm_tc.wPeriodMin,
647 mm_alarm_handler,
648 (DWORD_PTR)t,
649 TIME_ONESHOT | TIME_CALLBACK_FUNCTION);
651 if (!mm_timer) {
652 fprintf(stderr, "Failed to re-arm win32 alarm timer\n");
653 timeEndPeriod(mm_tc.wPeriodMin);
654 exit(1);
658 static int win32_start_timer(struct qemu_alarm_timer *t)
660 HANDLE hTimer;
661 BOOLEAN success;
663 /* If you call ChangeTimerQueueTimer on a one-shot timer (its period
664 is zero) that has already expired, the timer is not updated. Since
665 creating a new timer is relatively expensive, set a bogus one-hour
666 interval in the dynticks case. */
667 success = CreateTimerQueueTimer(&hTimer,
668 NULL,
669 host_alarm_handler,
672 3600000,
673 WT_EXECUTEINTIMERTHREAD);
675 if (!success) {
676 fprintf(stderr, "Failed to initialize win32 alarm timer: %ld\n",
677 GetLastError());
678 return -1;
681 t->timer = hTimer;
682 return 0;
685 static void win32_stop_timer(struct qemu_alarm_timer *t)
687 HANDLE hTimer = t->timer;
689 if (hTimer) {
690 DeleteTimerQueueTimer(NULL, hTimer, NULL);
694 static void win32_rearm_timer(struct qemu_alarm_timer *t,
695 int64_t nearest_delta_ns)
697 HANDLE hTimer = t->timer;
698 int64_t nearest_delta_ms;
699 BOOLEAN success;
701 nearest_delta_ms = nearest_delta_ns / 1000000;
702 if (nearest_delta_ms < 1) {
703 nearest_delta_ms = 1;
705 /* ULONG_MAX can be 32 bit */
706 if (nearest_delta_ms > ULONG_MAX) {
707 nearest_delta_ms = ULONG_MAX;
709 success = ChangeTimerQueueTimer(NULL,
710 hTimer,
711 (unsigned long) nearest_delta_ms,
712 3600000);
714 if (!success) {
715 fprintf(stderr, "Failed to rearm win32 alarm timer: %ld\n",
716 GetLastError());
717 exit(-1);
722 #endif /* _WIN32 */
724 static void quit_timers(void)
726 struct qemu_alarm_timer *t = alarm_timer;
727 alarm_timer = NULL;
728 t->stop(t);
731 #ifdef CONFIG_POSIX
732 static void reinit_timers(void)
734 struct qemu_alarm_timer *t = alarm_timer;
735 t->stop(t);
736 if (t->start(t)) {
737 fprintf(stderr, "Internal timer error: aborting\n");
738 exit(1);
740 qemu_rearm_alarm_timer(t);
742 #endif /* CONFIG_POSIX */
744 int init_timer_alarm(void)
746 struct qemu_alarm_timer *t = NULL;
747 int i, err = -1;
749 if (alarm_timer) {
750 return 0;
753 for (i = 0; alarm_timers[i].name; i++) {
754 t = &alarm_timers[i];
756 err = t->start(t);
757 if (!err)
758 break;
761 if (err) {
762 err = -ENOENT;
763 goto fail;
766 atexit(quit_timers);
767 #ifdef CONFIG_POSIX
768 pthread_atfork(NULL, NULL, reinit_timers);
769 #endif
770 alarm_timer = t;
771 return 0;
773 fail:
774 return err;