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 int qemu_alarm_pending(void)
92 return alarm_timer
->pending
;
95 static inline int alarm_has_dynticks(struct qemu_alarm_timer
*t
)
100 static int64_t qemu_next_alarm_deadline(void)
102 int64_t delta
= INT64_MAX
;
105 if (!use_icount
&& vm_clock
->enabled
&& vm_clock
->active_timers
) {
106 delta
= vm_clock
->active_timers
->expire_time
-
107 qemu_get_clock_ns(vm_clock
);
109 if (host_clock
->enabled
&& host_clock
->active_timers
) {
110 int64_t hdelta
= host_clock
->active_timers
->expire_time
-
111 qemu_get_clock_ns(host_clock
);
112 if (hdelta
< delta
) {
116 if (rt_clock
->enabled
&& rt_clock
->active_timers
) {
117 rtdelta
= (rt_clock
->active_timers
->expire_time
-
118 qemu_get_clock_ns(rt_clock
));
119 if (rtdelta
< delta
) {
127 static void qemu_rearm_alarm_timer(struct qemu_alarm_timer
*t
)
129 int64_t nearest_delta_ns
;
130 assert(alarm_has_dynticks(t
));
131 if (!rt_clock
->active_timers
&&
132 !vm_clock
->active_timers
&&
133 !host_clock
->active_timers
) {
136 nearest_delta_ns
= qemu_next_alarm_deadline();
137 t
->rearm(t
, nearest_delta_ns
);
140 /* TODO: MIN_TIMER_REARM_NS should be optimized */
141 #define MIN_TIMER_REARM_NS 250000
145 static int mm_start_timer(struct qemu_alarm_timer
*t
);
146 static void mm_stop_timer(struct qemu_alarm_timer
*t
);
147 static void mm_rearm_timer(struct qemu_alarm_timer
*t
, int64_t delta
);
149 static int win32_start_timer(struct qemu_alarm_timer
*t
);
150 static void win32_stop_timer(struct qemu_alarm_timer
*t
);
151 static void win32_rearm_timer(struct qemu_alarm_timer
*t
, int64_t delta
);
155 static int unix_start_timer(struct qemu_alarm_timer
*t
);
156 static void unix_stop_timer(struct qemu_alarm_timer
*t
);
157 static void unix_rearm_timer(struct qemu_alarm_timer
*t
, int64_t delta
);
161 static int dynticks_start_timer(struct qemu_alarm_timer
*t
);
162 static void dynticks_stop_timer(struct qemu_alarm_timer
*t
);
163 static void dynticks_rearm_timer(struct qemu_alarm_timer
*t
, int64_t delta
);
165 #endif /* __linux__ */
169 static struct qemu_alarm_timer alarm_timers
[] = {
172 {"dynticks", dynticks_start_timer
,
173 dynticks_stop_timer
, dynticks_rearm_timer
},
175 {"unix", unix_start_timer
, unix_stop_timer
, unix_rearm_timer
},
177 {"mmtimer", mm_start_timer
, mm_stop_timer
, mm_rearm_timer
},
178 {"dynticks", win32_start_timer
, win32_stop_timer
, win32_rearm_timer
},
183 static void show_available_alarms(void)
187 printf("Available alarm timers, in order of precedence:\n");
188 for (i
= 0; alarm_timers
[i
].name
; i
++)
189 printf("%s\n", alarm_timers
[i
].name
);
192 void configure_alarms(char const *opt
)
196 int count
= ARRAY_SIZE(alarm_timers
) - 1;
199 struct qemu_alarm_timer tmp
;
201 if (!strcmp(opt
, "?")) {
202 show_available_alarms();
208 /* Reorder the array */
209 name
= strtok(arg
, ",");
211 for (i
= 0; i
< count
&& alarm_timers
[i
].name
; i
++) {
212 if (!strcmp(alarm_timers
[i
].name
, name
))
217 fprintf(stderr
, "Unknown clock %s\n", name
);
226 tmp
= alarm_timers
[i
];
227 alarm_timers
[i
] = alarm_timers
[cur
];
228 alarm_timers
[cur
] = tmp
;
232 name
= strtok(NULL
, ",");
238 /* Disable remaining timers */
239 for (i
= cur
; i
< count
; i
++)
240 alarm_timers
[i
].name
= NULL
;
242 show_available_alarms();
249 QEMUClock
*host_clock
;
251 static QEMUClock
*qemu_new_clock(int type
)
255 clock
= g_malloc0(sizeof(QEMUClock
));
258 clock
->last
= INT64_MIN
;
259 notifier_list_init(&clock
->reset_notifiers
);
263 void qemu_clock_enable(QEMUClock
*clock
, int enabled
)
265 bool old
= clock
->enabled
;
266 clock
->enabled
= enabled
;
267 if (enabled
&& !old
) {
268 qemu_rearm_alarm_timer(alarm_timer
);
272 int64_t qemu_clock_has_timers(QEMUClock
*clock
)
274 return !!clock
->active_timers
;
277 int64_t qemu_clock_expired(QEMUClock
*clock
)
279 return (clock
->active_timers
&&
280 clock
->active_timers
->expire_time
< qemu_get_clock_ns(clock
));
283 int64_t qemu_clock_deadline(QEMUClock
*clock
)
285 /* To avoid problems with overflow limit this to 2^32. */
286 int64_t delta
= INT32_MAX
;
288 if (clock
->active_timers
) {
289 delta
= clock
->active_timers
->expire_time
- qemu_get_clock_ns(clock
);
297 QEMUTimer
*qemu_new_timer(QEMUClock
*clock
, int scale
,
298 QEMUTimerCB
*cb
, void *opaque
)
302 ts
= g_malloc0(sizeof(QEMUTimer
));
310 void qemu_free_timer(QEMUTimer
*ts
)
315 /* stop a timer, but do not dealloc it */
316 void qemu_del_timer(QEMUTimer
*ts
)
320 /* NOTE: this code must be signal safe because
321 qemu_timer_expired() can be called from a signal. */
322 pt
= &ts
->clock
->active_timers
;
335 /* modify the current timer so that it will be fired when current_time
336 >= expire_time. The corresponding callback will be called. */
337 void qemu_mod_timer_ns(QEMUTimer
*ts
, int64_t expire_time
)
343 /* add the timer in the sorted list */
344 /* NOTE: this code must be signal safe because
345 qemu_timer_expired() can be called from a signal. */
346 pt
= &ts
->clock
->active_timers
;
349 if (!qemu_timer_expired_ns(t
, expire_time
)) {
354 ts
->expire_time
= expire_time
;
358 /* Rearm if necessary */
359 if (pt
== &ts
->clock
->active_timers
) {
360 if (!alarm_timer
->pending
) {
361 qemu_rearm_alarm_timer(alarm_timer
);
363 /* Interrupt execution to force deadline recalculation. */
364 qemu_clock_warp(ts
->clock
);
371 void qemu_mod_timer(QEMUTimer
*ts
, int64_t expire_time
)
373 qemu_mod_timer_ns(ts
, expire_time
* ts
->scale
);
376 int qemu_timer_pending(QEMUTimer
*ts
)
379 for (t
= ts
->clock
->active_timers
; t
!= NULL
; t
= t
->next
) {
386 int qemu_timer_expired(QEMUTimer
*timer_head
, int64_t current_time
)
388 return qemu_timer_expired_ns(timer_head
, current_time
* timer_head
->scale
);
391 void qemu_run_timers(QEMUClock
*clock
)
393 QEMUTimer
**ptimer_head
, *ts
;
394 int64_t current_time
;
399 current_time
= qemu_get_clock_ns(clock
);
400 ptimer_head
= &clock
->active_timers
;
403 if (!qemu_timer_expired_ns(ts
, current_time
)) {
406 /* remove timer from the list before calling the callback */
407 *ptimer_head
= ts
->next
;
410 /* run the callback (the timer list can be modified) */
415 int64_t qemu_get_clock_ns(QEMUClock
*clock
)
419 switch(clock
->type
) {
420 case QEMU_CLOCK_REALTIME
:
423 case QEMU_CLOCK_VIRTUAL
:
425 return cpu_get_icount();
427 return cpu_get_clock();
429 case QEMU_CLOCK_HOST
:
430 now
= get_clock_realtime();
434 notifier_list_notify(&clock
->reset_notifiers
, &now
);
440 void qemu_register_clock_reset_notifier(QEMUClock
*clock
, Notifier
*notifier
)
442 notifier_list_add(&clock
->reset_notifiers
, notifier
);
445 void qemu_unregister_clock_reset_notifier(QEMUClock
*clock
, Notifier
*notifier
)
447 notifier_remove(notifier
);
450 void init_clocks(void)
452 rt_clock
= qemu_new_clock(QEMU_CLOCK_REALTIME
);
453 vm_clock
= qemu_new_clock(QEMU_CLOCK_VIRTUAL
);
454 host_clock
= qemu_new_clock(QEMU_CLOCK_HOST
);
457 uint64_t qemu_timer_expire_time_ns(QEMUTimer
*ts
)
459 return qemu_timer_pending(ts
) ? ts
->expire_time
: -1;
462 void qemu_run_all_timers(void)
464 alarm_timer
->pending
= 0;
467 qemu_run_timers(vm_clock
);
468 qemu_run_timers(rt_clock
);
469 qemu_run_timers(host_clock
);
471 /* rearm timer, if not periodic */
472 if (alarm_timer
->expired
) {
473 alarm_timer
->expired
= 0;
474 qemu_rearm_alarm_timer(alarm_timer
);
479 static void CALLBACK
host_alarm_handler(PVOID lpParam
, BOOLEAN unused
)
481 static void host_alarm_handler(int host_signum
)
484 struct qemu_alarm_timer
*t
= alarm_timer
;
488 if (alarm_has_dynticks(t
) ||
489 qemu_next_alarm_deadline () <= 0) {
490 t
->expired
= alarm_has_dynticks(t
);
496 #if defined(__linux__)
498 #include "compatfd.h"
500 static int dynticks_start_timer(struct qemu_alarm_timer
*t
)
504 struct sigaction act
;
506 sigfillset(&act
.sa_mask
);
508 act
.sa_handler
= host_alarm_handler
;
510 sigaction(SIGALRM
, &act
, NULL
);
513 * Initialize ev struct to 0 to avoid valgrind complaining
514 * about uninitialized data in timer_create call
516 memset(&ev
, 0, sizeof(ev
));
517 ev
.sigev_value
.sival_int
= 0;
518 ev
.sigev_notify
= SIGEV_SIGNAL
;
519 #ifdef SIGEV_THREAD_ID
520 if (qemu_signalfd_available()) {
521 ev
.sigev_notify
= SIGEV_THREAD_ID
;
522 ev
._sigev_un
._tid
= qemu_get_thread_id();
524 #endif /* SIGEV_THREAD_ID */
525 ev
.sigev_signo
= SIGALRM
;
527 if (timer_create(CLOCK_REALTIME
, &ev
, &host_timer
)) {
528 perror("timer_create");
530 /* disable dynticks */
531 fprintf(stderr
, "Dynamic Ticks disabled\n");
536 t
->timer
= host_timer
;
541 static void dynticks_stop_timer(struct qemu_alarm_timer
*t
)
543 timer_t host_timer
= t
->timer
;
545 timer_delete(host_timer
);
548 static void dynticks_rearm_timer(struct qemu_alarm_timer
*t
,
549 int64_t nearest_delta_ns
)
551 timer_t host_timer
= t
->timer
;
552 struct itimerspec timeout
;
555 if (nearest_delta_ns
< MIN_TIMER_REARM_NS
)
556 nearest_delta_ns
= MIN_TIMER_REARM_NS
;
558 /* check whether a timer is already running */
559 if (timer_gettime(host_timer
, &timeout
)) {
561 fprintf(stderr
, "Internal timer error: aborting\n");
564 current_ns
= timeout
.it_value
.tv_sec
* 1000000000LL + timeout
.it_value
.tv_nsec
;
565 if (current_ns
&& current_ns
<= nearest_delta_ns
)
568 timeout
.it_interval
.tv_sec
= 0;
569 timeout
.it_interval
.tv_nsec
= 0; /* 0 for one-shot timer */
570 timeout
.it_value
.tv_sec
= nearest_delta_ns
/ 1000000000;
571 timeout
.it_value
.tv_nsec
= nearest_delta_ns
% 1000000000;
572 if (timer_settime(host_timer
, 0 /* RELATIVE */, &timeout
, NULL
)) {
574 fprintf(stderr
, "Internal timer error: aborting\n");
579 #endif /* defined(__linux__) */
583 static int unix_start_timer(struct qemu_alarm_timer
*t
)
585 struct sigaction act
;
588 sigfillset(&act
.sa_mask
);
590 act
.sa_handler
= host_alarm_handler
;
592 sigaction(SIGALRM
, &act
, NULL
);
596 static void unix_rearm_timer(struct qemu_alarm_timer
*t
,
597 int64_t nearest_delta_ns
)
599 struct itimerval itv
;
602 if (nearest_delta_ns
< MIN_TIMER_REARM_NS
)
603 nearest_delta_ns
= MIN_TIMER_REARM_NS
;
605 itv
.it_interval
.tv_sec
= 0;
606 itv
.it_interval
.tv_usec
= 0; /* 0 for one-shot timer */
607 itv
.it_value
.tv_sec
= nearest_delta_ns
/ 1000000000;
608 itv
.it_value
.tv_usec
= (nearest_delta_ns
% 1000000000) / 1000;
609 err
= setitimer(ITIMER_REAL
, &itv
, NULL
);
612 fprintf(stderr
, "Internal timer error: aborting\n");
617 static void unix_stop_timer(struct qemu_alarm_timer
*t
)
619 struct itimerval itv
;
621 memset(&itv
, 0, sizeof(itv
));
622 setitimer(ITIMER_REAL
, &itv
, NULL
);
625 #endif /* !defined(_WIN32) */
630 static MMRESULT mm_timer
;
631 static unsigned mm_period
;
633 static void CALLBACK
mm_alarm_handler(UINT uTimerID
, UINT uMsg
,
634 DWORD_PTR dwUser
, DWORD_PTR dw1
,
637 struct qemu_alarm_timer
*t
= alarm_timer
;
641 if (alarm_has_dynticks(t
) || qemu_next_alarm_deadline() <= 0) {
642 t
->expired
= alarm_has_dynticks(t
);
648 static int mm_start_timer(struct qemu_alarm_timer
*t
)
653 memset(&tc
, 0, sizeof(tc
));
654 timeGetDevCaps(&tc
, sizeof(tc
));
656 mm_period
= tc
.wPeriodMin
;
657 timeBeginPeriod(mm_period
);
659 flags
= TIME_CALLBACK_FUNCTION
;
660 if (alarm_has_dynticks(t
)) {
661 flags
|= TIME_ONESHOT
;
663 flags
|= TIME_PERIODIC
;
666 mm_timer
= timeSetEvent(1, /* interval (ms) */
667 mm_period
, /* resolution */
668 mm_alarm_handler
, /* function */
669 (DWORD_PTR
)t
, /* parameter */
673 fprintf(stderr
, "Failed to initialize win32 alarm timer: %ld\n",
675 timeEndPeriod(mm_period
);
682 static void mm_stop_timer(struct qemu_alarm_timer
*t
)
684 timeKillEvent(mm_timer
);
685 timeEndPeriod(mm_period
);
688 static void mm_rearm_timer(struct qemu_alarm_timer
*t
, int64_t delta
)
690 int64_t nearest_delta_ms
= delta
/ 1000000;
691 if (nearest_delta_ms
< 1) {
692 nearest_delta_ms
= 1;
694 /* UINT_MAX can be 32 bit */
695 if (nearest_delta_ms
> UINT_MAX
) {
696 nearest_delta_ms
= UINT_MAX
;
699 timeKillEvent(mm_timer
);
700 mm_timer
= timeSetEvent((unsigned int) nearest_delta_ms
,
704 TIME_ONESHOT
| TIME_CALLBACK_FUNCTION
);
707 fprintf(stderr
, "Failed to re-arm win32 alarm timer %ld\n",
710 timeEndPeriod(mm_period
);
715 static int win32_start_timer(struct qemu_alarm_timer
*t
)
720 /* If you call ChangeTimerQueueTimer on a one-shot timer (its period
721 is zero) that has already expired, the timer is not updated. Since
722 creating a new timer is relatively expensive, set a bogus one-hour
723 interval in the dynticks case. */
724 success
= CreateTimerQueueTimer(&hTimer
,
729 alarm_has_dynticks(t
) ? 3600000 : 1,
730 WT_EXECUTEINTIMERTHREAD
);
733 fprintf(stderr
, "Failed to initialize win32 alarm timer: %ld\n",
742 static void win32_stop_timer(struct qemu_alarm_timer
*t
)
744 HANDLE hTimer
= t
->timer
;
747 DeleteTimerQueueTimer(NULL
, hTimer
, NULL
);
751 static void win32_rearm_timer(struct qemu_alarm_timer
*t
,
752 int64_t nearest_delta_ns
)
754 HANDLE hTimer
= t
->timer
;
755 int64_t nearest_delta_ms
;
758 nearest_delta_ms
= nearest_delta_ns
/ 1000000;
759 if (nearest_delta_ms
< 1) {
760 nearest_delta_ms
= 1;
762 /* ULONG_MAX can be 32 bit */
763 if (nearest_delta_ms
> ULONG_MAX
) {
764 nearest_delta_ms
= ULONG_MAX
;
766 success
= ChangeTimerQueueTimer(NULL
,
768 (unsigned long) nearest_delta_ms
,
772 fprintf(stderr
, "Failed to rearm win32 alarm timer: %ld\n",
781 static void quit_timers(void)
783 struct qemu_alarm_timer
*t
= alarm_timer
;
788 int init_timer_alarm(void)
790 struct qemu_alarm_timer
*t
= NULL
;
793 for (i
= 0; alarm_timers
[i
].name
; i
++) {
794 t
= &alarm_timers
[i
];
806 /* first event is at time 0 */