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)
112 if (!use_icount
&& vm_clock
->active_timers
) {
113 delta
= vm_clock
->active_timers
->expire_time
-
114 qemu_get_clock_ns(vm_clock
);
118 if (host_clock
->active_timers
) {
119 int64_t hdelta
= host_clock
->active_timers
->expire_time
-
120 qemu_get_clock_ns(host_clock
);
121 if (hdelta
< delta
) {
125 if (rt_clock
->active_timers
) {
126 rtdelta
= (rt_clock
->active_timers
->expire_time
-
127 qemu_get_clock_ns(rt_clock
));
128 if (rtdelta
< delta
) {
136 static void qemu_rearm_alarm_timer(struct qemu_alarm_timer
*t
)
138 int64_t nearest_delta_ns
;
139 assert(alarm_has_dynticks(t
));
140 if (!rt_clock
->active_timers
&&
141 !vm_clock
->active_timers
&&
142 !host_clock
->active_timers
) {
145 nearest_delta_ns
= qemu_next_alarm_deadline();
146 t
->rearm(t
, nearest_delta_ns
);
149 /* TODO: MIN_TIMER_REARM_NS should be optimized */
150 #define MIN_TIMER_REARM_NS 250000
154 static int mm_start_timer(struct qemu_alarm_timer
*t
);
155 static void mm_stop_timer(struct qemu_alarm_timer
*t
);
156 static void mm_rearm_timer(struct qemu_alarm_timer
*t
, int64_t delta
);
158 static int win32_start_timer(struct qemu_alarm_timer
*t
);
159 static void win32_stop_timer(struct qemu_alarm_timer
*t
);
160 static void win32_rearm_timer(struct qemu_alarm_timer
*t
, int64_t delta
);
164 static int unix_start_timer(struct qemu_alarm_timer
*t
);
165 static void unix_stop_timer(struct qemu_alarm_timer
*t
);
166 static void unix_rearm_timer(struct qemu_alarm_timer
*t
, int64_t delta
);
170 static int dynticks_start_timer(struct qemu_alarm_timer
*t
);
171 static void dynticks_stop_timer(struct qemu_alarm_timer
*t
);
172 static void dynticks_rearm_timer(struct qemu_alarm_timer
*t
, int64_t delta
);
174 #endif /* __linux__ */
178 static struct qemu_alarm_timer alarm_timers
[] = {
181 {"dynticks", dynticks_start_timer
,
182 dynticks_stop_timer
, dynticks_rearm_timer
},
184 {"unix", unix_start_timer
, unix_stop_timer
, unix_rearm_timer
},
186 {"mmtimer", mm_start_timer
, mm_stop_timer
, NULL
},
187 {"mmtimer2", mm_start_timer
, mm_stop_timer
, mm_rearm_timer
},
188 {"dynticks", win32_start_timer
, win32_stop_timer
, win32_rearm_timer
},
189 {"win32", win32_start_timer
, win32_stop_timer
, NULL
},
194 static void show_available_alarms(void)
198 printf("Available alarm timers, in order of precedence:\n");
199 for (i
= 0; alarm_timers
[i
].name
; i
++)
200 printf("%s\n", alarm_timers
[i
].name
);
203 void configure_alarms(char const *opt
)
207 int count
= ARRAY_SIZE(alarm_timers
) - 1;
210 struct qemu_alarm_timer tmp
;
212 if (!strcmp(opt
, "?")) {
213 show_available_alarms();
219 /* Reorder the array */
220 name
= strtok(arg
, ",");
222 for (i
= 0; i
< count
&& alarm_timers
[i
].name
; i
++) {
223 if (!strcmp(alarm_timers
[i
].name
, name
))
228 fprintf(stderr
, "Unknown clock %s\n", name
);
237 tmp
= alarm_timers
[i
];
238 alarm_timers
[i
] = alarm_timers
[cur
];
239 alarm_timers
[cur
] = tmp
;
243 name
= strtok(NULL
, ",");
249 /* Disable remaining timers */
250 for (i
= cur
; i
< count
; i
++)
251 alarm_timers
[i
].name
= NULL
;
253 show_available_alarms();
260 QEMUClock
*host_clock
;
262 static QEMUClock
*qemu_new_clock(int type
)
266 clock
= g_malloc0(sizeof(QEMUClock
));
269 clock
->last
= INT64_MIN
;
270 notifier_list_init(&clock
->reset_notifiers
);
274 void qemu_clock_enable(QEMUClock
*clock
, int enabled
)
276 clock
->enabled
= enabled
;
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 static 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_list_remove(&clock
->reset_notifiers
, 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;
473 /* rearm timer, if not periodic */
474 if (alarm_timer
->expired
) {
475 alarm_timer
->expired
= 0;
476 qemu_rearm_alarm_timer(alarm_timer
);
480 qemu_run_timers(vm_clock
);
481 qemu_run_timers(rt_clock
);
482 qemu_run_timers(host_clock
);
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
;
496 #define DISP_FREQ 1000
498 static int64_t delta_min
= INT64_MAX
;
499 static int64_t delta_max
, delta_cum
, last_clock
, delta
, ti
;
501 ti
= qemu_get_clock_ns(vm_clock
);
502 if (last_clock
!= 0) {
503 delta
= ti
- last_clock
;
504 if (delta
< delta_min
)
506 if (delta
> delta_max
)
509 if (++count
== DISP_FREQ
) {
510 printf("timer: min=%" PRId64
" us max=%" PRId64
" us avg=%" PRId64
" us avg_freq=%0.3f Hz\n",
511 muldiv64(delta_min
, 1000000, get_ticks_per_sec()),
512 muldiv64(delta_max
, 1000000, get_ticks_per_sec()),
513 muldiv64(delta_cum
, 1000000 / DISP_FREQ
, get_ticks_per_sec()),
514 (double)get_ticks_per_sec() / ((double)delta_cum
/ DISP_FREQ
));
516 delta_min
= INT64_MAX
;
524 if (alarm_has_dynticks(t
) ||
525 qemu_next_alarm_deadline () <= 0) {
526 t
->expired
= alarm_has_dynticks(t
);
532 #if defined(__linux__)
534 #include "compatfd.h"
536 static int dynticks_start_timer(struct qemu_alarm_timer
*t
)
540 struct sigaction act
;
542 sigfillset(&act
.sa_mask
);
544 act
.sa_handler
= host_alarm_handler
;
546 sigaction(SIGALRM
, &act
, NULL
);
549 * Initialize ev struct to 0 to avoid valgrind complaining
550 * about uninitialized data in timer_create call
552 memset(&ev
, 0, sizeof(ev
));
553 ev
.sigev_value
.sival_int
= 0;
554 ev
.sigev_notify
= SIGEV_SIGNAL
;
555 #ifdef SIGEV_THREAD_ID
556 if (qemu_signalfd_available()) {
557 ev
.sigev_notify
= SIGEV_THREAD_ID
;
558 ev
._sigev_un
._tid
= qemu_get_thread_id();
560 #endif /* SIGEV_THREAD_ID */
561 ev
.sigev_signo
= SIGALRM
;
563 if (timer_create(CLOCK_REALTIME
, &ev
, &host_timer
)) {
564 perror("timer_create");
566 /* disable dynticks */
567 fprintf(stderr
, "Dynamic Ticks disabled\n");
572 t
->timer
= host_timer
;
577 static void dynticks_stop_timer(struct qemu_alarm_timer
*t
)
579 timer_t host_timer
= t
->timer
;
581 timer_delete(host_timer
);
584 static void dynticks_rearm_timer(struct qemu_alarm_timer
*t
,
585 int64_t nearest_delta_ns
)
587 timer_t host_timer
= t
->timer
;
588 struct itimerspec timeout
;
591 if (nearest_delta_ns
< MIN_TIMER_REARM_NS
)
592 nearest_delta_ns
= MIN_TIMER_REARM_NS
;
594 /* check whether a timer is already running */
595 if (timer_gettime(host_timer
, &timeout
)) {
597 fprintf(stderr
, "Internal timer error: aborting\n");
600 current_ns
= timeout
.it_value
.tv_sec
* 1000000000LL + timeout
.it_value
.tv_nsec
;
601 if (current_ns
&& current_ns
<= nearest_delta_ns
)
604 timeout
.it_interval
.tv_sec
= 0;
605 timeout
.it_interval
.tv_nsec
= 0; /* 0 for one-shot timer */
606 timeout
.it_value
.tv_sec
= nearest_delta_ns
/ 1000000000;
607 timeout
.it_value
.tv_nsec
= nearest_delta_ns
% 1000000000;
608 if (timer_settime(host_timer
, 0 /* RELATIVE */, &timeout
, NULL
)) {
610 fprintf(stderr
, "Internal timer error: aborting\n");
615 #endif /* defined(__linux__) */
619 static int unix_start_timer(struct qemu_alarm_timer
*t
)
621 struct sigaction act
;
624 sigfillset(&act
.sa_mask
);
626 act
.sa_handler
= host_alarm_handler
;
628 sigaction(SIGALRM
, &act
, NULL
);
632 static void unix_rearm_timer(struct qemu_alarm_timer
*t
,
633 int64_t nearest_delta_ns
)
635 struct itimerval itv
;
638 if (nearest_delta_ns
< MIN_TIMER_REARM_NS
)
639 nearest_delta_ns
= MIN_TIMER_REARM_NS
;
641 itv
.it_interval
.tv_sec
= 0;
642 itv
.it_interval
.tv_usec
= 0; /* 0 for one-shot timer */
643 itv
.it_value
.tv_sec
= nearest_delta_ns
/ 1000000000;
644 itv
.it_value
.tv_usec
= (nearest_delta_ns
% 1000000000) / 1000;
645 err
= setitimer(ITIMER_REAL
, &itv
, NULL
);
648 fprintf(stderr
, "Internal timer error: aborting\n");
653 static void unix_stop_timer(struct qemu_alarm_timer
*t
)
655 struct itimerval itv
;
657 memset(&itv
, 0, sizeof(itv
));
658 setitimer(ITIMER_REAL
, &itv
, NULL
);
661 #endif /* !defined(_WIN32) */
666 static MMRESULT mm_timer
;
667 static unsigned mm_period
;
669 static void CALLBACK
mm_alarm_handler(UINT uTimerID
, UINT uMsg
,
670 DWORD_PTR dwUser
, DWORD_PTR dw1
,
673 struct qemu_alarm_timer
*t
= alarm_timer
;
677 if (alarm_has_dynticks(t
) || qemu_next_alarm_deadline() <= 0) {
678 t
->expired
= alarm_has_dynticks(t
);
684 static int mm_start_timer(struct qemu_alarm_timer
*t
)
689 memset(&tc
, 0, sizeof(tc
));
690 timeGetDevCaps(&tc
, sizeof(tc
));
692 mm_period
= tc
.wPeriodMin
;
693 timeBeginPeriod(mm_period
);
695 flags
= TIME_CALLBACK_FUNCTION
;
696 if (alarm_has_dynticks(t
)) {
697 flags
|= TIME_ONESHOT
;
699 flags
|= TIME_PERIODIC
;
702 mm_timer
= timeSetEvent(1, /* interval (ms) */
703 mm_period
, /* resolution */
704 mm_alarm_handler
, /* function */
705 (DWORD_PTR
)t
, /* parameter */
709 fprintf(stderr
, "Failed to initialize win32 alarm timer: %ld\n",
711 timeEndPeriod(mm_period
);
718 static void mm_stop_timer(struct qemu_alarm_timer
*t
)
720 timeKillEvent(mm_timer
);
721 timeEndPeriod(mm_period
);
724 static void mm_rearm_timer(struct qemu_alarm_timer
*t
, int64_t delta
)
726 int nearest_delta_ms
= (delta
+ 999999) / 1000000;
727 if (nearest_delta_ms
< 1) {
728 nearest_delta_ms
= 1;
731 timeKillEvent(mm_timer
);
732 mm_timer
= timeSetEvent(nearest_delta_ms
,
736 TIME_ONESHOT
| TIME_CALLBACK_FUNCTION
);
739 fprintf(stderr
, "Failed to re-arm win32 alarm timer %ld\n",
742 timeEndPeriod(mm_period
);
747 static int win32_start_timer(struct qemu_alarm_timer
*t
)
752 /* If you call ChangeTimerQueueTimer on a one-shot timer (its period
753 is zero) that has already expired, the timer is not updated. Since
754 creating a new timer is relatively expensive, set a bogus one-hour
755 interval in the dynticks case. */
756 success
= CreateTimerQueueTimer(&hTimer
,
761 alarm_has_dynticks(t
) ? 3600000 : 1,
762 WT_EXECUTEINTIMERTHREAD
);
765 fprintf(stderr
, "Failed to initialize win32 alarm timer: %ld\n",
774 static void win32_stop_timer(struct qemu_alarm_timer
*t
)
776 HANDLE hTimer
= t
->timer
;
779 DeleteTimerQueueTimer(NULL
, hTimer
, NULL
);
783 static void win32_rearm_timer(struct qemu_alarm_timer
*t
,
784 int64_t nearest_delta_ns
)
786 HANDLE hTimer
= t
->timer
;
787 int nearest_delta_ms
;
790 nearest_delta_ms
= (nearest_delta_ns
+ 999999) / 1000000;
791 if (nearest_delta_ms
< 1) {
792 nearest_delta_ms
= 1;
794 success
= ChangeTimerQueueTimer(NULL
,
800 fprintf(stderr
, "Failed to rearm win32 alarm timer: %ld\n",
809 static void alarm_timer_on_change_state_rearm(void *opaque
, int running
,
813 qemu_rearm_alarm_timer((struct qemu_alarm_timer
*) opaque
);
816 static void quit_timers(void)
818 struct qemu_alarm_timer
*t
= alarm_timer
;
823 int init_timer_alarm(void)
825 struct qemu_alarm_timer
*t
= NULL
;
828 for (i
= 0; alarm_timers
[i
].name
; i
++) {
829 t
= &alarm_timers
[i
];
841 /* first event is at time 0 */
845 qemu_add_vm_change_state_handler(alarm_timer_on_change_state_rearm
, t
);
853 int qemu_calculate_timeout(void)