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
));
253 clock
->last
= INT64_MIN
;
254 notifier_list_init(&clock
->reset_notifiers
);
258 void qemu_clock_enable(QEMUClock
*clock
, int 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 int qemu_timer_pending(QEMUTimer
*ts
)
374 for (t
= ts
->clock
->active_timers
; t
!= NULL
; t
= t
->next
) {
381 int qemu_timer_expired(QEMUTimer
*timer_head
, int64_t current_time
)
383 return qemu_timer_expired_ns(timer_head
, current_time
* timer_head
->scale
);
386 void qemu_run_timers(QEMUClock
*clock
)
388 QEMUTimer
**ptimer_head
, *ts
;
389 int64_t current_time
;
394 current_time
= qemu_get_clock_ns(clock
);
395 ptimer_head
= &clock
->active_timers
;
398 if (!qemu_timer_expired_ns(ts
, current_time
)) {
401 /* remove timer from the list before calling the callback */
402 *ptimer_head
= ts
->next
;
405 /* run the callback (the timer list can be modified) */
410 int64_t qemu_get_clock_ns(QEMUClock
*clock
)
414 switch(clock
->type
) {
415 case QEMU_CLOCK_REALTIME
:
418 case QEMU_CLOCK_VIRTUAL
:
420 return cpu_get_icount();
422 return cpu_get_clock();
424 case QEMU_CLOCK_HOST
:
425 now
= get_clock_realtime();
429 notifier_list_notify(&clock
->reset_notifiers
, &now
);
435 void qemu_register_clock_reset_notifier(QEMUClock
*clock
, Notifier
*notifier
)
437 notifier_list_add(&clock
->reset_notifiers
, notifier
);
440 void qemu_unregister_clock_reset_notifier(QEMUClock
*clock
, Notifier
*notifier
)
442 notifier_remove(notifier
);
445 void init_clocks(void)
447 rt_clock
= qemu_new_clock(QEMU_CLOCK_REALTIME
);
448 vm_clock
= qemu_new_clock(QEMU_CLOCK_VIRTUAL
);
449 host_clock
= qemu_new_clock(QEMU_CLOCK_HOST
);
452 uint64_t qemu_timer_expire_time_ns(QEMUTimer
*ts
)
454 return qemu_timer_pending(ts
) ? ts
->expire_time
: -1;
457 void qemu_run_all_timers(void)
459 alarm_timer
->pending
= 0;
462 qemu_run_timers(vm_clock
);
463 qemu_run_timers(rt_clock
);
464 qemu_run_timers(host_clock
);
466 /* rearm timer, if not periodic */
467 if (alarm_timer
->expired
) {
468 alarm_timer
->expired
= 0;
469 qemu_rearm_alarm_timer(alarm_timer
);
474 static void CALLBACK
host_alarm_handler(PVOID lpParam
, BOOLEAN unused
)
476 static void host_alarm_handler(int host_signum
)
479 struct qemu_alarm_timer
*t
= alarm_timer
;
483 if (alarm_has_dynticks(t
) ||
484 qemu_next_alarm_deadline () <= 0) {
485 t
->expired
= alarm_has_dynticks(t
);
491 #if defined(__linux__)
493 #include "compatfd.h"
495 static int dynticks_start_timer(struct qemu_alarm_timer
*t
)
499 struct sigaction act
;
501 sigfillset(&act
.sa_mask
);
503 act
.sa_handler
= host_alarm_handler
;
505 sigaction(SIGALRM
, &act
, NULL
);
508 * Initialize ev struct to 0 to avoid valgrind complaining
509 * about uninitialized data in timer_create call
511 memset(&ev
, 0, sizeof(ev
));
512 ev
.sigev_value
.sival_int
= 0;
513 ev
.sigev_notify
= SIGEV_SIGNAL
;
514 #ifdef SIGEV_THREAD_ID
515 if (qemu_signalfd_available()) {
516 ev
.sigev_notify
= SIGEV_THREAD_ID
;
517 ev
._sigev_un
._tid
= qemu_get_thread_id();
519 #endif /* SIGEV_THREAD_ID */
520 ev
.sigev_signo
= SIGALRM
;
522 if (timer_create(CLOCK_REALTIME
, &ev
, &host_timer
)) {
523 perror("timer_create");
525 /* disable dynticks */
526 fprintf(stderr
, "Dynamic Ticks disabled\n");
531 t
->timer
= host_timer
;
536 static void dynticks_stop_timer(struct qemu_alarm_timer
*t
)
538 timer_t host_timer
= t
->timer
;
540 timer_delete(host_timer
);
543 static void dynticks_rearm_timer(struct qemu_alarm_timer
*t
,
544 int64_t nearest_delta_ns
)
546 timer_t host_timer
= t
->timer
;
547 struct itimerspec timeout
;
550 if (nearest_delta_ns
< MIN_TIMER_REARM_NS
)
551 nearest_delta_ns
= MIN_TIMER_REARM_NS
;
553 /* check whether a timer is already running */
554 if (timer_gettime(host_timer
, &timeout
)) {
556 fprintf(stderr
, "Internal timer error: aborting\n");
559 current_ns
= timeout
.it_value
.tv_sec
* 1000000000LL + timeout
.it_value
.tv_nsec
;
560 if (current_ns
&& current_ns
<= nearest_delta_ns
)
563 timeout
.it_interval
.tv_sec
= 0;
564 timeout
.it_interval
.tv_nsec
= 0; /* 0 for one-shot timer */
565 timeout
.it_value
.tv_sec
= nearest_delta_ns
/ 1000000000;
566 timeout
.it_value
.tv_nsec
= nearest_delta_ns
% 1000000000;
567 if (timer_settime(host_timer
, 0 /* RELATIVE */, &timeout
, NULL
)) {
569 fprintf(stderr
, "Internal timer error: aborting\n");
574 #endif /* defined(__linux__) */
578 static int unix_start_timer(struct qemu_alarm_timer
*t
)
580 struct sigaction act
;
583 sigfillset(&act
.sa_mask
);
585 act
.sa_handler
= host_alarm_handler
;
587 sigaction(SIGALRM
, &act
, NULL
);
591 static void unix_rearm_timer(struct qemu_alarm_timer
*t
,
592 int64_t nearest_delta_ns
)
594 struct itimerval itv
;
597 if (nearest_delta_ns
< MIN_TIMER_REARM_NS
)
598 nearest_delta_ns
= MIN_TIMER_REARM_NS
;
600 itv
.it_interval
.tv_sec
= 0;
601 itv
.it_interval
.tv_usec
= 0; /* 0 for one-shot timer */
602 itv
.it_value
.tv_sec
= nearest_delta_ns
/ 1000000000;
603 itv
.it_value
.tv_usec
= (nearest_delta_ns
% 1000000000) / 1000;
604 err
= setitimer(ITIMER_REAL
, &itv
, NULL
);
607 fprintf(stderr
, "Internal timer error: aborting\n");
612 static void unix_stop_timer(struct qemu_alarm_timer
*t
)
614 struct itimerval itv
;
616 memset(&itv
, 0, sizeof(itv
));
617 setitimer(ITIMER_REAL
, &itv
, NULL
);
620 #endif /* !defined(_WIN32) */
625 static MMRESULT mm_timer
;
626 static unsigned mm_period
;
628 static void CALLBACK
mm_alarm_handler(UINT uTimerID
, UINT uMsg
,
629 DWORD_PTR dwUser
, DWORD_PTR dw1
,
632 struct qemu_alarm_timer
*t
= alarm_timer
;
636 if (alarm_has_dynticks(t
) || qemu_next_alarm_deadline() <= 0) {
637 t
->expired
= alarm_has_dynticks(t
);
643 static int mm_start_timer(struct qemu_alarm_timer
*t
)
648 memset(&tc
, 0, sizeof(tc
));
649 timeGetDevCaps(&tc
, sizeof(tc
));
651 mm_period
= tc
.wPeriodMin
;
652 timeBeginPeriod(mm_period
);
654 flags
= TIME_CALLBACK_FUNCTION
;
655 if (alarm_has_dynticks(t
)) {
656 flags
|= TIME_ONESHOT
;
658 flags
|= TIME_PERIODIC
;
661 mm_timer
= timeSetEvent(1, /* interval (ms) */
662 mm_period
, /* resolution */
663 mm_alarm_handler
, /* function */
664 (DWORD_PTR
)t
, /* parameter */
668 fprintf(stderr
, "Failed to initialize win32 alarm timer: %ld\n",
670 timeEndPeriod(mm_period
);
677 static void mm_stop_timer(struct qemu_alarm_timer
*t
)
679 timeKillEvent(mm_timer
);
680 timeEndPeriod(mm_period
);
683 static void mm_rearm_timer(struct qemu_alarm_timer
*t
, int64_t delta
)
685 int64_t nearest_delta_ms
= delta
/ 1000000;
686 if (nearest_delta_ms
< 1) {
687 nearest_delta_ms
= 1;
689 /* UINT_MAX can be 32 bit */
690 if (nearest_delta_ms
> UINT_MAX
) {
691 nearest_delta_ms
= UINT_MAX
;
694 timeKillEvent(mm_timer
);
695 mm_timer
= timeSetEvent((unsigned int) nearest_delta_ms
,
699 TIME_ONESHOT
| TIME_CALLBACK_FUNCTION
);
702 fprintf(stderr
, "Failed to re-arm win32 alarm timer %ld\n",
705 timeEndPeriod(mm_period
);
710 static int win32_start_timer(struct qemu_alarm_timer
*t
)
715 /* If you call ChangeTimerQueueTimer on a one-shot timer (its period
716 is zero) that has already expired, the timer is not updated. Since
717 creating a new timer is relatively expensive, set a bogus one-hour
718 interval in the dynticks case. */
719 success
= CreateTimerQueueTimer(&hTimer
,
724 alarm_has_dynticks(t
) ? 3600000 : 1,
725 WT_EXECUTEINTIMERTHREAD
);
728 fprintf(stderr
, "Failed to initialize win32 alarm timer: %ld\n",
737 static void win32_stop_timer(struct qemu_alarm_timer
*t
)
739 HANDLE hTimer
= t
->timer
;
742 DeleteTimerQueueTimer(NULL
, hTimer
, NULL
);
746 static void win32_rearm_timer(struct qemu_alarm_timer
*t
,
747 int64_t nearest_delta_ns
)
749 HANDLE hTimer
= t
->timer
;
750 int64_t nearest_delta_ms
;
753 nearest_delta_ms
= nearest_delta_ns
/ 1000000;
754 if (nearest_delta_ms
< 1) {
755 nearest_delta_ms
= 1;
757 /* ULONG_MAX can be 32 bit */
758 if (nearest_delta_ms
> ULONG_MAX
) {
759 nearest_delta_ms
= ULONG_MAX
;
761 success
= ChangeTimerQueueTimer(NULL
,
763 (unsigned long) nearest_delta_ms
,
767 fprintf(stderr
, "Failed to rearm win32 alarm timer: %ld\n",
776 static void quit_timers(void)
778 struct qemu_alarm_timer
*t
= alarm_timer
;
783 int init_timer_alarm(void)
785 struct qemu_alarm_timer
*t
= NULL
;
788 for (i
= 0; alarm_timers
[i
].name
; i
++) {
789 t
= &alarm_timers
[i
];
801 /* first event is at time 0 */