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
32 #include "qemu-timer.h"
35 #include <sys/param.h>
42 /***********************************************************/
45 #define QEMU_CLOCK_REALTIME 0
46 #define QEMU_CLOCK_VIRTUAL 1
47 #define QEMU_CLOCK_HOST 2
53 QEMUTimer
*active_timers
;
55 NotifierList reset_notifiers
;
61 int64_t expire_time
; /* in nanoseconds */
65 struct QEMUTimer
*next
;
68 struct qemu_alarm_timer
{
70 int (*start
)(struct qemu_alarm_timer
*t
);
71 void (*stop
)(struct qemu_alarm_timer
*t
);
72 void (*rearm
)(struct qemu_alarm_timer
*t
, int64_t nearest_delta_ns
);
73 #if defined(__linux__)
83 static struct qemu_alarm_timer
*alarm_timer
;
85 static bool qemu_timer_expired_ns(QEMUTimer
*timer_head
, int64_t current_time
)
87 return timer_head
&& (timer_head
->expire_time
<= current_time
);
90 static inline int alarm_has_dynticks(struct qemu_alarm_timer
*t
)
95 static int64_t qemu_next_alarm_deadline(void)
97 int64_t delta
= INT64_MAX
;
100 if (!use_icount
&& vm_clock
->enabled
&& vm_clock
->active_timers
) {
101 delta
= vm_clock
->active_timers
->expire_time
-
102 qemu_get_clock_ns(vm_clock
);
104 if (host_clock
->enabled
&& host_clock
->active_timers
) {
105 int64_t hdelta
= host_clock
->active_timers
->expire_time
-
106 qemu_get_clock_ns(host_clock
);
107 if (hdelta
< delta
) {
111 if (rt_clock
->enabled
&& rt_clock
->active_timers
) {
112 rtdelta
= (rt_clock
->active_timers
->expire_time
-
113 qemu_get_clock_ns(rt_clock
));
114 if (rtdelta
< delta
) {
122 static void qemu_rearm_alarm_timer(struct qemu_alarm_timer
*t
)
124 int64_t nearest_delta_ns
;
125 assert(alarm_has_dynticks(t
));
126 if (!rt_clock
->active_timers
&&
127 !vm_clock
->active_timers
&&
128 !host_clock
->active_timers
) {
131 nearest_delta_ns
= qemu_next_alarm_deadline();
132 t
->rearm(t
, nearest_delta_ns
);
135 /* TODO: MIN_TIMER_REARM_NS should be optimized */
136 #define MIN_TIMER_REARM_NS 250000
140 static int mm_start_timer(struct qemu_alarm_timer
*t
);
141 static void mm_stop_timer(struct qemu_alarm_timer
*t
);
142 static void mm_rearm_timer(struct qemu_alarm_timer
*t
, int64_t delta
);
144 static int win32_start_timer(struct qemu_alarm_timer
*t
);
145 static void win32_stop_timer(struct qemu_alarm_timer
*t
);
146 static void win32_rearm_timer(struct qemu_alarm_timer
*t
, int64_t delta
);
150 static int unix_start_timer(struct qemu_alarm_timer
*t
);
151 static void unix_stop_timer(struct qemu_alarm_timer
*t
);
152 static void unix_rearm_timer(struct qemu_alarm_timer
*t
, int64_t delta
);
156 static int dynticks_start_timer(struct qemu_alarm_timer
*t
);
157 static void dynticks_stop_timer(struct qemu_alarm_timer
*t
);
158 static void dynticks_rearm_timer(struct qemu_alarm_timer
*t
, int64_t delta
);
160 #endif /* __linux__ */
164 static struct qemu_alarm_timer alarm_timers
[] = {
167 {"dynticks", dynticks_start_timer
,
168 dynticks_stop_timer
, dynticks_rearm_timer
},
170 {"unix", unix_start_timer
, unix_stop_timer
, unix_rearm_timer
},
172 {"mmtimer", mm_start_timer
, mm_stop_timer
, mm_rearm_timer
},
173 {"dynticks", win32_start_timer
, win32_stop_timer
, win32_rearm_timer
},
178 static void show_available_alarms(void)
182 printf("Available alarm timers, in order of precedence:\n");
183 for (i
= 0; alarm_timers
[i
].name
; i
++)
184 printf("%s\n", alarm_timers
[i
].name
);
187 void configure_alarms(char const *opt
)
191 int count
= ARRAY_SIZE(alarm_timers
) - 1;
194 struct qemu_alarm_timer tmp
;
196 if (!strcmp(opt
, "?")) {
197 show_available_alarms();
203 /* Reorder the array */
204 name
= strtok(arg
, ",");
206 for (i
= 0; i
< count
&& alarm_timers
[i
].name
; i
++) {
207 if (!strcmp(alarm_timers
[i
].name
, name
))
212 fprintf(stderr
, "Unknown clock %s\n", name
);
221 tmp
= alarm_timers
[i
];
222 alarm_timers
[i
] = alarm_timers
[cur
];
223 alarm_timers
[cur
] = tmp
;
227 name
= strtok(NULL
, ",");
233 /* Disable remaining timers */
234 for (i
= cur
; i
< count
; i
++)
235 alarm_timers
[i
].name
= NULL
;
237 show_available_alarms();
244 QEMUClock
*host_clock
;
246 static QEMUClock
*qemu_new_clock(int type
)
250 clock
= g_malloc0(sizeof(QEMUClock
));
252 clock
->enabled
= true;
253 clock
->last
= INT64_MIN
;
254 notifier_list_init(&clock
->reset_notifiers
);
258 void qemu_clock_enable(QEMUClock
*clock
, bool enabled
)
260 bool old
= clock
->enabled
;
261 clock
->enabled
= enabled
;
262 if (enabled
&& !old
) {
263 qemu_rearm_alarm_timer(alarm_timer
);
267 int64_t qemu_clock_has_timers(QEMUClock
*clock
)
269 return !!clock
->active_timers
;
272 int64_t qemu_clock_expired(QEMUClock
*clock
)
274 return (clock
->active_timers
&&
275 clock
->active_timers
->expire_time
< qemu_get_clock_ns(clock
));
278 int64_t qemu_clock_deadline(QEMUClock
*clock
)
280 /* To avoid problems with overflow limit this to 2^32. */
281 int64_t delta
= INT32_MAX
;
283 if (clock
->active_timers
) {
284 delta
= clock
->active_timers
->expire_time
- qemu_get_clock_ns(clock
);
292 QEMUTimer
*qemu_new_timer(QEMUClock
*clock
, int scale
,
293 QEMUTimerCB
*cb
, void *opaque
)
297 ts
= g_malloc0(sizeof(QEMUTimer
));
305 void qemu_free_timer(QEMUTimer
*ts
)
310 /* stop a timer, but do not dealloc it */
311 void qemu_del_timer(QEMUTimer
*ts
)
315 /* NOTE: this code must be signal safe because
316 qemu_timer_expired() can be called from a signal. */
317 pt
= &ts
->clock
->active_timers
;
330 /* modify the current timer so that it will be fired when current_time
331 >= expire_time. The corresponding callback will be called. */
332 void qemu_mod_timer_ns(QEMUTimer
*ts
, int64_t expire_time
)
338 /* add the timer in the sorted list */
339 /* NOTE: this code must be signal safe because
340 qemu_timer_expired() can be called from a signal. */
341 pt
= &ts
->clock
->active_timers
;
344 if (!qemu_timer_expired_ns(t
, expire_time
)) {
349 ts
->expire_time
= expire_time
;
353 /* Rearm if necessary */
354 if (pt
== &ts
->clock
->active_timers
) {
355 if (!alarm_timer
->pending
) {
356 qemu_rearm_alarm_timer(alarm_timer
);
358 /* Interrupt execution to force deadline recalculation. */
359 qemu_clock_warp(ts
->clock
);
366 void qemu_mod_timer(QEMUTimer
*ts
, int64_t expire_time
)
368 qemu_mod_timer_ns(ts
, expire_time
* ts
->scale
);
371 bool qemu_timer_pending(QEMUTimer
*ts
)
374 for (t
= ts
->clock
->active_timers
; t
!= NULL
; t
= t
->next
) {
382 bool qemu_timer_expired(QEMUTimer
*timer_head
, int64_t current_time
)
384 return qemu_timer_expired_ns(timer_head
, current_time
* timer_head
->scale
);
387 void qemu_run_timers(QEMUClock
*clock
)
389 QEMUTimer
**ptimer_head
, *ts
;
390 int64_t current_time
;
395 current_time
= qemu_get_clock_ns(clock
);
396 ptimer_head
= &clock
->active_timers
;
399 if (!qemu_timer_expired_ns(ts
, current_time
)) {
402 /* remove timer from the list before calling the callback */
403 *ptimer_head
= ts
->next
;
406 /* run the callback (the timer list can be modified) */
411 int64_t qemu_get_clock_ns(QEMUClock
*clock
)
415 switch(clock
->type
) {
416 case QEMU_CLOCK_REALTIME
:
419 case QEMU_CLOCK_VIRTUAL
:
421 return cpu_get_icount();
423 return cpu_get_clock();
425 case QEMU_CLOCK_HOST
:
426 now
= get_clock_realtime();
430 notifier_list_notify(&clock
->reset_notifiers
, &now
);
436 void qemu_register_clock_reset_notifier(QEMUClock
*clock
, Notifier
*notifier
)
438 notifier_list_add(&clock
->reset_notifiers
, notifier
);
441 void qemu_unregister_clock_reset_notifier(QEMUClock
*clock
, Notifier
*notifier
)
443 notifier_remove(notifier
);
446 void init_clocks(void)
448 rt_clock
= qemu_new_clock(QEMU_CLOCK_REALTIME
);
449 vm_clock
= qemu_new_clock(QEMU_CLOCK_VIRTUAL
);
450 host_clock
= qemu_new_clock(QEMU_CLOCK_HOST
);
453 uint64_t qemu_timer_expire_time_ns(QEMUTimer
*ts
)
455 return qemu_timer_pending(ts
) ? ts
->expire_time
: -1;
458 void qemu_run_all_timers(void)
460 alarm_timer
->pending
= false;
463 qemu_run_timers(vm_clock
);
464 qemu_run_timers(rt_clock
);
465 qemu_run_timers(host_clock
);
467 /* rearm timer, if not periodic */
468 if (alarm_timer
->expired
) {
469 alarm_timer
->expired
= false;
470 qemu_rearm_alarm_timer(alarm_timer
);
475 static void CALLBACK
host_alarm_handler(PVOID lpParam
, BOOLEAN unused
)
477 static void host_alarm_handler(int host_signum
)
480 struct qemu_alarm_timer
*t
= alarm_timer
;
484 if (alarm_has_dynticks(t
) ||
485 qemu_next_alarm_deadline () <= 0) {
486 t
->expired
= alarm_has_dynticks(t
);
492 #if defined(__linux__)
494 #include "compatfd.h"
496 static int dynticks_start_timer(struct qemu_alarm_timer
*t
)
500 struct sigaction act
;
502 sigfillset(&act
.sa_mask
);
504 act
.sa_handler
= host_alarm_handler
;
506 sigaction(SIGALRM
, &act
, NULL
);
509 * Initialize ev struct to 0 to avoid valgrind complaining
510 * about uninitialized data in timer_create call
512 memset(&ev
, 0, sizeof(ev
));
513 ev
.sigev_value
.sival_int
= 0;
514 ev
.sigev_notify
= SIGEV_SIGNAL
;
515 #ifdef SIGEV_THREAD_ID
516 if (qemu_signalfd_available()) {
517 ev
.sigev_notify
= SIGEV_THREAD_ID
;
518 ev
._sigev_un
._tid
= qemu_get_thread_id();
520 #endif /* SIGEV_THREAD_ID */
521 ev
.sigev_signo
= SIGALRM
;
523 if (timer_create(CLOCK_REALTIME
, &ev
, &host_timer
)) {
524 perror("timer_create");
526 /* disable dynticks */
527 fprintf(stderr
, "Dynamic Ticks disabled\n");
532 t
->timer
= host_timer
;
537 static void dynticks_stop_timer(struct qemu_alarm_timer
*t
)
539 timer_t host_timer
= t
->timer
;
541 timer_delete(host_timer
);
544 static void dynticks_rearm_timer(struct qemu_alarm_timer
*t
,
545 int64_t nearest_delta_ns
)
547 timer_t host_timer
= t
->timer
;
548 struct itimerspec timeout
;
551 if (nearest_delta_ns
< MIN_TIMER_REARM_NS
)
552 nearest_delta_ns
= MIN_TIMER_REARM_NS
;
554 /* check whether a timer is already running */
555 if (timer_gettime(host_timer
, &timeout
)) {
557 fprintf(stderr
, "Internal timer error: aborting\n");
560 current_ns
= timeout
.it_value
.tv_sec
* 1000000000LL + timeout
.it_value
.tv_nsec
;
561 if (current_ns
&& current_ns
<= nearest_delta_ns
)
564 timeout
.it_interval
.tv_sec
= 0;
565 timeout
.it_interval
.tv_nsec
= 0; /* 0 for one-shot timer */
566 timeout
.it_value
.tv_sec
= nearest_delta_ns
/ 1000000000;
567 timeout
.it_value
.tv_nsec
= nearest_delta_ns
% 1000000000;
568 if (timer_settime(host_timer
, 0 /* RELATIVE */, &timeout
, NULL
)) {
570 fprintf(stderr
, "Internal timer error: aborting\n");
575 #endif /* defined(__linux__) */
579 static int unix_start_timer(struct qemu_alarm_timer
*t
)
581 struct sigaction act
;
584 sigfillset(&act
.sa_mask
);
586 act
.sa_handler
= host_alarm_handler
;
588 sigaction(SIGALRM
, &act
, NULL
);
592 static void unix_rearm_timer(struct qemu_alarm_timer
*t
,
593 int64_t nearest_delta_ns
)
595 struct itimerval itv
;
598 if (nearest_delta_ns
< MIN_TIMER_REARM_NS
)
599 nearest_delta_ns
= MIN_TIMER_REARM_NS
;
601 itv
.it_interval
.tv_sec
= 0;
602 itv
.it_interval
.tv_usec
= 0; /* 0 for one-shot timer */
603 itv
.it_value
.tv_sec
= nearest_delta_ns
/ 1000000000;
604 itv
.it_value
.tv_usec
= (nearest_delta_ns
% 1000000000) / 1000;
605 err
= setitimer(ITIMER_REAL
, &itv
, NULL
);
608 fprintf(stderr
, "Internal timer error: aborting\n");
613 static void unix_stop_timer(struct qemu_alarm_timer
*t
)
615 struct itimerval itv
;
617 memset(&itv
, 0, sizeof(itv
));
618 setitimer(ITIMER_REAL
, &itv
, NULL
);
621 #endif /* !defined(_WIN32) */
626 static MMRESULT mm_timer
;
627 static unsigned mm_period
;
629 static void CALLBACK
mm_alarm_handler(UINT uTimerID
, UINT uMsg
,
630 DWORD_PTR dwUser
, DWORD_PTR dw1
,
633 struct qemu_alarm_timer
*t
= alarm_timer
;
637 if (alarm_has_dynticks(t
) || qemu_next_alarm_deadline() <= 0) {
638 t
->expired
= alarm_has_dynticks(t
);
644 static int mm_start_timer(struct qemu_alarm_timer
*t
)
649 memset(&tc
, 0, sizeof(tc
));
650 timeGetDevCaps(&tc
, sizeof(tc
));
652 mm_period
= tc
.wPeriodMin
;
653 timeBeginPeriod(mm_period
);
655 flags
= TIME_CALLBACK_FUNCTION
;
656 if (alarm_has_dynticks(t
)) {
657 flags
|= TIME_ONESHOT
;
659 flags
|= TIME_PERIODIC
;
662 mm_timer
= timeSetEvent(1, /* interval (ms) */
663 mm_period
, /* resolution */
664 mm_alarm_handler
, /* function */
665 (DWORD_PTR
)t
, /* parameter */
669 fprintf(stderr
, "Failed to initialize win32 alarm timer: %ld\n",
671 timeEndPeriod(mm_period
);
678 static void mm_stop_timer(struct qemu_alarm_timer
*t
)
680 timeKillEvent(mm_timer
);
681 timeEndPeriod(mm_period
);
684 static void mm_rearm_timer(struct qemu_alarm_timer
*t
, int64_t delta
)
686 int64_t nearest_delta_ms
= delta
/ 1000000;
687 if (nearest_delta_ms
< 1) {
688 nearest_delta_ms
= 1;
690 /* UINT_MAX can be 32 bit */
691 if (nearest_delta_ms
> UINT_MAX
) {
692 nearest_delta_ms
= UINT_MAX
;
695 timeKillEvent(mm_timer
);
696 mm_timer
= timeSetEvent((unsigned int) nearest_delta_ms
,
700 TIME_ONESHOT
| TIME_CALLBACK_FUNCTION
);
703 fprintf(stderr
, "Failed to re-arm win32 alarm timer %ld\n",
706 timeEndPeriod(mm_period
);
711 static int win32_start_timer(struct qemu_alarm_timer
*t
)
716 /* If you call ChangeTimerQueueTimer on a one-shot timer (its period
717 is zero) that has already expired, the timer is not updated. Since
718 creating a new timer is relatively expensive, set a bogus one-hour
719 interval in the dynticks case. */
720 success
= CreateTimerQueueTimer(&hTimer
,
725 alarm_has_dynticks(t
) ? 3600000 : 1,
726 WT_EXECUTEINTIMERTHREAD
);
729 fprintf(stderr
, "Failed to initialize win32 alarm timer: %ld\n",
738 static void win32_stop_timer(struct qemu_alarm_timer
*t
)
740 HANDLE hTimer
= t
->timer
;
743 DeleteTimerQueueTimer(NULL
, hTimer
, NULL
);
747 static void win32_rearm_timer(struct qemu_alarm_timer
*t
,
748 int64_t nearest_delta_ns
)
750 HANDLE hTimer
= t
->timer
;
751 int64_t nearest_delta_ms
;
754 nearest_delta_ms
= nearest_delta_ns
/ 1000000;
755 if (nearest_delta_ms
< 1) {
756 nearest_delta_ms
= 1;
758 /* ULONG_MAX can be 32 bit */
759 if (nearest_delta_ms
> ULONG_MAX
) {
760 nearest_delta_ms
= ULONG_MAX
;
762 success
= ChangeTimerQueueTimer(NULL
,
764 (unsigned long) nearest_delta_ms
,
768 fprintf(stderr
, "Failed to rearm win32 alarm timer: %ld\n",
777 static void quit_timers(void)
779 struct qemu_alarm_timer
*t
= alarm_timer
;
784 int init_timer_alarm(void)
786 struct qemu_alarm_timer
*t
= NULL
;
789 for (i
= 0; alarm_timers
[i
].name
; i
++) {
790 t
= &alarm_timers
[i
];
802 /* first event is at time 0 */