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
39 #include <sys/param.h>
47 #include "qemu-timer.h"
49 /***********************************************************/
52 #define QEMU_CLOCK_REALTIME 0
53 #define QEMU_CLOCK_VIRTUAL 1
54 #define QEMU_CLOCK_HOST 2
60 QEMUTimer
*active_timers
;
62 NotifierList reset_notifiers
;
68 int64_t expire_time
; /* in nanoseconds */
72 struct QEMUTimer
*next
;
75 struct qemu_alarm_timer
{
77 int (*start
)(struct qemu_alarm_timer
*t
);
78 void (*stop
)(struct qemu_alarm_timer
*t
);
79 void (*rearm
)(struct qemu_alarm_timer
*t
, int64_t nearest_delta_ns
);
80 #if defined(__linux__)
90 static struct qemu_alarm_timer
*alarm_timer
;
92 static bool qemu_timer_expired_ns(QEMUTimer
*timer_head
, int64_t current_time
)
94 return timer_head
&& (timer_head
->expire_time
<= current_time
);
97 int qemu_alarm_pending(void)
99 return alarm_timer
->pending
;
102 static inline int alarm_has_dynticks(struct qemu_alarm_timer
*t
)
107 static int64_t qemu_next_alarm_deadline(void)
109 int64_t delta
= INT64_MAX
;
112 if (!use_icount
&& vm_clock
->enabled
&& vm_clock
->active_timers
) {
113 delta
= vm_clock
->active_timers
->expire_time
-
114 qemu_get_clock_ns(vm_clock
);
116 if (host_clock
->enabled
&& host_clock
->active_timers
) {
117 int64_t hdelta
= host_clock
->active_timers
->expire_time
-
118 qemu_get_clock_ns(host_clock
);
119 if (hdelta
< delta
) {
123 if (rt_clock
->enabled
&& rt_clock
->active_timers
) {
124 rtdelta
= (rt_clock
->active_timers
->expire_time
-
125 qemu_get_clock_ns(rt_clock
));
126 if (rtdelta
< delta
) {
134 static void qemu_rearm_alarm_timer(struct qemu_alarm_timer
*t
)
136 int64_t nearest_delta_ns
;
137 assert(alarm_has_dynticks(t
));
138 if (!rt_clock
->active_timers
&&
139 !vm_clock
->active_timers
&&
140 !host_clock
->active_timers
) {
143 nearest_delta_ns
= qemu_next_alarm_deadline();
144 t
->rearm(t
, nearest_delta_ns
);
147 /* TODO: MIN_TIMER_REARM_NS should be optimized */
148 #define MIN_TIMER_REARM_NS 250000
152 static int mm_start_timer(struct qemu_alarm_timer
*t
);
153 static void mm_stop_timer(struct qemu_alarm_timer
*t
);
154 static void mm_rearm_timer(struct qemu_alarm_timer
*t
, int64_t delta
);
156 static int win32_start_timer(struct qemu_alarm_timer
*t
);
157 static void win32_stop_timer(struct qemu_alarm_timer
*t
);
158 static void win32_rearm_timer(struct qemu_alarm_timer
*t
, int64_t delta
);
162 static int unix_start_timer(struct qemu_alarm_timer
*t
);
163 static void unix_stop_timer(struct qemu_alarm_timer
*t
);
164 static void unix_rearm_timer(struct qemu_alarm_timer
*t
, int64_t delta
);
168 static int dynticks_start_timer(struct qemu_alarm_timer
*t
);
169 static void dynticks_stop_timer(struct qemu_alarm_timer
*t
);
170 static void dynticks_rearm_timer(struct qemu_alarm_timer
*t
, int64_t delta
);
172 #endif /* __linux__ */
176 static struct qemu_alarm_timer alarm_timers
[] = {
179 {"dynticks", dynticks_start_timer
,
180 dynticks_stop_timer
, dynticks_rearm_timer
},
182 {"unix", unix_start_timer
, unix_stop_timer
, unix_rearm_timer
},
184 {"mmtimer", mm_start_timer
, mm_stop_timer
, mm_rearm_timer
},
185 {"dynticks", win32_start_timer
, win32_stop_timer
, win32_rearm_timer
},
190 static void show_available_alarms(void)
194 printf("Available alarm timers, in order of precedence:\n");
195 for (i
= 0; alarm_timers
[i
].name
; i
++)
196 printf("%s\n", alarm_timers
[i
].name
);
199 void configure_alarms(char const *opt
)
203 int count
= ARRAY_SIZE(alarm_timers
) - 1;
206 struct qemu_alarm_timer tmp
;
208 if (!strcmp(opt
, "?")) {
209 show_available_alarms();
215 /* Reorder the array */
216 name
= strtok(arg
, ",");
218 for (i
= 0; i
< count
&& alarm_timers
[i
].name
; i
++) {
219 if (!strcmp(alarm_timers
[i
].name
, name
))
224 fprintf(stderr
, "Unknown clock %s\n", name
);
233 tmp
= alarm_timers
[i
];
234 alarm_timers
[i
] = alarm_timers
[cur
];
235 alarm_timers
[cur
] = tmp
;
239 name
= strtok(NULL
, ",");
245 /* Disable remaining timers */
246 for (i
= cur
; i
< count
; i
++)
247 alarm_timers
[i
].name
= NULL
;
249 show_available_alarms();
256 QEMUClock
*host_clock
;
258 static QEMUClock
*qemu_new_clock(int type
)
262 clock
= g_malloc0(sizeof(QEMUClock
));
265 clock
->last
= INT64_MIN
;
266 notifier_list_init(&clock
->reset_notifiers
);
270 void qemu_clock_enable(QEMUClock
*clock
, int enabled
)
272 bool old
= clock
->enabled
;
273 clock
->enabled
= enabled
;
274 if (enabled
&& !old
) {
275 qemu_rearm_alarm_timer(alarm_timer
);
279 int64_t qemu_clock_has_timers(QEMUClock
*clock
)
281 return !!clock
->active_timers
;
284 int64_t qemu_clock_expired(QEMUClock
*clock
)
286 return (clock
->active_timers
&&
287 clock
->active_timers
->expire_time
< qemu_get_clock_ns(clock
));
290 int64_t qemu_clock_deadline(QEMUClock
*clock
)
292 /* To avoid problems with overflow limit this to 2^32. */
293 int64_t delta
= INT32_MAX
;
295 if (clock
->active_timers
) {
296 delta
= clock
->active_timers
->expire_time
- qemu_get_clock_ns(clock
);
304 QEMUTimer
*qemu_new_timer(QEMUClock
*clock
, int scale
,
305 QEMUTimerCB
*cb
, void *opaque
)
309 ts
= g_malloc0(sizeof(QEMUTimer
));
317 void qemu_free_timer(QEMUTimer
*ts
)
322 /* stop a timer, but do not dealloc it */
323 void qemu_del_timer(QEMUTimer
*ts
)
327 /* NOTE: this code must be signal safe because
328 qemu_timer_expired() can be called from a signal. */
329 pt
= &ts
->clock
->active_timers
;
342 /* modify the current timer so that it will be fired when current_time
343 >= expire_time. The corresponding callback will be called. */
344 void qemu_mod_timer_ns(QEMUTimer
*ts
, int64_t expire_time
)
350 /* add the timer in the sorted list */
351 /* NOTE: this code must be signal safe because
352 qemu_timer_expired() can be called from a signal. */
353 pt
= &ts
->clock
->active_timers
;
356 if (!qemu_timer_expired_ns(t
, expire_time
)) {
361 ts
->expire_time
= expire_time
;
365 /* Rearm if necessary */
366 if (pt
== &ts
->clock
->active_timers
) {
367 if (!alarm_timer
->pending
) {
368 qemu_rearm_alarm_timer(alarm_timer
);
370 /* Interrupt execution to force deadline recalculation. */
371 qemu_clock_warp(ts
->clock
);
378 void qemu_mod_timer(QEMUTimer
*ts
, int64_t expire_time
)
380 qemu_mod_timer_ns(ts
, expire_time
* ts
->scale
);
383 int qemu_timer_pending(QEMUTimer
*ts
)
386 for (t
= ts
->clock
->active_timers
; t
!= NULL
; t
= t
->next
) {
393 int qemu_timer_expired(QEMUTimer
*timer_head
, int64_t current_time
)
395 return qemu_timer_expired_ns(timer_head
, current_time
* timer_head
->scale
);
398 void qemu_run_timers(QEMUClock
*clock
)
400 QEMUTimer
**ptimer_head
, *ts
;
401 int64_t current_time
;
406 current_time
= qemu_get_clock_ns(clock
);
407 ptimer_head
= &clock
->active_timers
;
410 if (!qemu_timer_expired_ns(ts
, current_time
)) {
413 /* remove timer from the list before calling the callback */
414 *ptimer_head
= ts
->next
;
417 /* run the callback (the timer list can be modified) */
422 int64_t qemu_get_clock_ns(QEMUClock
*clock
)
426 switch(clock
->type
) {
427 case QEMU_CLOCK_REALTIME
:
430 case QEMU_CLOCK_VIRTUAL
:
432 return cpu_get_icount();
434 return cpu_get_clock();
436 case QEMU_CLOCK_HOST
:
437 now
= get_clock_realtime();
441 notifier_list_notify(&clock
->reset_notifiers
, &now
);
447 void qemu_register_clock_reset_notifier(QEMUClock
*clock
, Notifier
*notifier
)
449 notifier_list_add(&clock
->reset_notifiers
, notifier
);
452 void qemu_unregister_clock_reset_notifier(QEMUClock
*clock
, Notifier
*notifier
)
454 notifier_remove(notifier
);
457 void init_clocks(void)
459 rt_clock
= qemu_new_clock(QEMU_CLOCK_REALTIME
);
460 vm_clock
= qemu_new_clock(QEMU_CLOCK_VIRTUAL
);
461 host_clock
= qemu_new_clock(QEMU_CLOCK_HOST
);
464 uint64_t qemu_timer_expire_time_ns(QEMUTimer
*ts
)
466 return qemu_timer_pending(ts
) ? ts
->expire_time
: -1;
469 void qemu_run_all_timers(void)
471 alarm_timer
->pending
= 0;
474 qemu_run_timers(vm_clock
);
475 qemu_run_timers(rt_clock
);
476 qemu_run_timers(host_clock
);
478 /* rearm timer, if not periodic */
479 if (alarm_timer
->expired
) {
480 alarm_timer
->expired
= 0;
481 qemu_rearm_alarm_timer(alarm_timer
);
486 static void CALLBACK
host_alarm_handler(PVOID lpParam
, BOOLEAN unused
)
488 static void host_alarm_handler(int host_signum
)
491 struct qemu_alarm_timer
*t
= alarm_timer
;
495 if (alarm_has_dynticks(t
) ||
496 qemu_next_alarm_deadline () <= 0) {
497 t
->expired
= alarm_has_dynticks(t
);
503 #if defined(__linux__)
505 #include "compatfd.h"
507 static int dynticks_start_timer(struct qemu_alarm_timer
*t
)
511 struct sigaction act
;
513 sigfillset(&act
.sa_mask
);
515 act
.sa_handler
= host_alarm_handler
;
517 sigaction(SIGALRM
, &act
, NULL
);
520 * Initialize ev struct to 0 to avoid valgrind complaining
521 * about uninitialized data in timer_create call
523 memset(&ev
, 0, sizeof(ev
));
524 ev
.sigev_value
.sival_int
= 0;
525 ev
.sigev_notify
= SIGEV_SIGNAL
;
526 #ifdef SIGEV_THREAD_ID
527 if (qemu_signalfd_available()) {
528 ev
.sigev_notify
= SIGEV_THREAD_ID
;
529 ev
._sigev_un
._tid
= qemu_get_thread_id();
531 #endif /* SIGEV_THREAD_ID */
532 ev
.sigev_signo
= SIGALRM
;
534 if (timer_create(CLOCK_REALTIME
, &ev
, &host_timer
)) {
535 perror("timer_create");
537 /* disable dynticks */
538 fprintf(stderr
, "Dynamic Ticks disabled\n");
543 t
->timer
= host_timer
;
548 static void dynticks_stop_timer(struct qemu_alarm_timer
*t
)
550 timer_t host_timer
= t
->timer
;
552 timer_delete(host_timer
);
555 static void dynticks_rearm_timer(struct qemu_alarm_timer
*t
,
556 int64_t nearest_delta_ns
)
558 timer_t host_timer
= t
->timer
;
559 struct itimerspec timeout
;
562 if (nearest_delta_ns
< MIN_TIMER_REARM_NS
)
563 nearest_delta_ns
= MIN_TIMER_REARM_NS
;
565 /* check whether a timer is already running */
566 if (timer_gettime(host_timer
, &timeout
)) {
568 fprintf(stderr
, "Internal timer error: aborting\n");
571 current_ns
= timeout
.it_value
.tv_sec
* 1000000000LL + timeout
.it_value
.tv_nsec
;
572 if (current_ns
&& current_ns
<= nearest_delta_ns
)
575 timeout
.it_interval
.tv_sec
= 0;
576 timeout
.it_interval
.tv_nsec
= 0; /* 0 for one-shot timer */
577 timeout
.it_value
.tv_sec
= nearest_delta_ns
/ 1000000000;
578 timeout
.it_value
.tv_nsec
= nearest_delta_ns
% 1000000000;
579 if (timer_settime(host_timer
, 0 /* RELATIVE */, &timeout
, NULL
)) {
581 fprintf(stderr
, "Internal timer error: aborting\n");
586 #endif /* defined(__linux__) */
590 static int unix_start_timer(struct qemu_alarm_timer
*t
)
592 struct sigaction act
;
595 sigfillset(&act
.sa_mask
);
597 act
.sa_handler
= host_alarm_handler
;
599 sigaction(SIGALRM
, &act
, NULL
);
603 static void unix_rearm_timer(struct qemu_alarm_timer
*t
,
604 int64_t nearest_delta_ns
)
606 struct itimerval itv
;
609 if (nearest_delta_ns
< MIN_TIMER_REARM_NS
)
610 nearest_delta_ns
= MIN_TIMER_REARM_NS
;
612 itv
.it_interval
.tv_sec
= 0;
613 itv
.it_interval
.tv_usec
= 0; /* 0 for one-shot timer */
614 itv
.it_value
.tv_sec
= nearest_delta_ns
/ 1000000000;
615 itv
.it_value
.tv_usec
= (nearest_delta_ns
% 1000000000) / 1000;
616 err
= setitimer(ITIMER_REAL
, &itv
, NULL
);
619 fprintf(stderr
, "Internal timer error: aborting\n");
624 static void unix_stop_timer(struct qemu_alarm_timer
*t
)
626 struct itimerval itv
;
628 memset(&itv
, 0, sizeof(itv
));
629 setitimer(ITIMER_REAL
, &itv
, NULL
);
632 #endif /* !defined(_WIN32) */
637 static MMRESULT mm_timer
;
638 static unsigned mm_period
;
640 static void CALLBACK
mm_alarm_handler(UINT uTimerID
, UINT uMsg
,
641 DWORD_PTR dwUser
, DWORD_PTR dw1
,
644 struct qemu_alarm_timer
*t
= alarm_timer
;
648 if (alarm_has_dynticks(t
) || qemu_next_alarm_deadline() <= 0) {
649 t
->expired
= alarm_has_dynticks(t
);
655 static int mm_start_timer(struct qemu_alarm_timer
*t
)
660 memset(&tc
, 0, sizeof(tc
));
661 timeGetDevCaps(&tc
, sizeof(tc
));
663 mm_period
= tc
.wPeriodMin
;
664 timeBeginPeriod(mm_period
);
666 flags
= TIME_CALLBACK_FUNCTION
;
667 if (alarm_has_dynticks(t
)) {
668 flags
|= TIME_ONESHOT
;
670 flags
|= TIME_PERIODIC
;
673 mm_timer
= timeSetEvent(1, /* interval (ms) */
674 mm_period
, /* resolution */
675 mm_alarm_handler
, /* function */
676 (DWORD_PTR
)t
, /* parameter */
680 fprintf(stderr
, "Failed to initialize win32 alarm timer: %ld\n",
682 timeEndPeriod(mm_period
);
689 static void mm_stop_timer(struct qemu_alarm_timer
*t
)
691 timeKillEvent(mm_timer
);
692 timeEndPeriod(mm_period
);
695 static void mm_rearm_timer(struct qemu_alarm_timer
*t
, int64_t delta
)
697 int64_t nearest_delta_ms
= delta
/ 1000000;
698 if (nearest_delta_ms
< 1) {
699 nearest_delta_ms
= 1;
701 /* UINT_MAX can be 32 bit */
702 if (nearest_delta_ms
> UINT_MAX
) {
703 nearest_delta_ms
= UINT_MAX
;
706 timeKillEvent(mm_timer
);
707 mm_timer
= timeSetEvent((unsigned int) nearest_delta_ms
,
711 TIME_ONESHOT
| TIME_CALLBACK_FUNCTION
);
714 fprintf(stderr
, "Failed to re-arm win32 alarm timer %ld\n",
717 timeEndPeriod(mm_period
);
722 static int win32_start_timer(struct qemu_alarm_timer
*t
)
727 /* If you call ChangeTimerQueueTimer on a one-shot timer (its period
728 is zero) that has already expired, the timer is not updated. Since
729 creating a new timer is relatively expensive, set a bogus one-hour
730 interval in the dynticks case. */
731 success
= CreateTimerQueueTimer(&hTimer
,
736 alarm_has_dynticks(t
) ? 3600000 : 1,
737 WT_EXECUTEINTIMERTHREAD
);
740 fprintf(stderr
, "Failed to initialize win32 alarm timer: %ld\n",
749 static void win32_stop_timer(struct qemu_alarm_timer
*t
)
751 HANDLE hTimer
= t
->timer
;
754 DeleteTimerQueueTimer(NULL
, hTimer
, NULL
);
758 static void win32_rearm_timer(struct qemu_alarm_timer
*t
,
759 int64_t nearest_delta_ns
)
761 HANDLE hTimer
= t
->timer
;
762 int64_t nearest_delta_ms
;
765 nearest_delta_ms
= nearest_delta_ns
/ 1000000;
766 if (nearest_delta_ms
< 1) {
767 nearest_delta_ms
= 1;
769 /* ULONG_MAX can be 32 bit */
770 if (nearest_delta_ms
> ULONG_MAX
) {
771 nearest_delta_ms
= ULONG_MAX
;
773 success
= ChangeTimerQueueTimer(NULL
,
775 (unsigned long) nearest_delta_ms
,
779 fprintf(stderr
, "Failed to rearm win32 alarm timer: %ld\n",
788 static void quit_timers(void)
790 struct qemu_alarm_timer
*t
= alarm_timer
;
795 int init_timer_alarm(void)
797 struct qemu_alarm_timer
*t
= NULL
;
800 for (i
= 0; alarm_timers
[i
].name
; i
++) {
801 t
= &alarm_timers
[i
];
813 /* first event is at time 0 */