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
25 #include "sysemu/sysemu.h"
26 #include "monitor/monitor.h"
27 #include "ui/console.h"
31 #include "qemu/timer.h"
44 #ifdef CONFIG_PRCTL_PR_SET_TIMERSLACK
45 #include <sys/prctl.h>
48 /***********************************************************/
52 QEMUTimerList
*main_loop_timerlist
;
53 QLIST_HEAD(, QEMUTimerList
) timerlists
;
55 NotifierList reset_notifiers
;
62 QEMUClock
*qemu_clocks
[QEMU_CLOCK_MAX
];
64 /* A QEMUTimerList is a list of timers attached to a clock. More
65 * than one QEMUTimerList can be attached to each clock, for instance
66 * used by different AioContexts / threads. Each clock also has
67 * a list of the QEMUTimerLists associated with it, in order that
68 * reenabling the clock can call all the notifiers.
71 struct QEMUTimerList
{
73 QEMUTimer
*active_timers
;
74 QLIST_ENTRY(QEMUTimerList
) list
;
77 struct qemu_alarm_timer
{
79 int (*start
)(struct qemu_alarm_timer
*t
);
80 void (*stop
)(struct qemu_alarm_timer
*t
);
81 void (*rearm
)(struct qemu_alarm_timer
*t
, int64_t nearest_delta_ns
);
82 #if defined(__linux__)
92 static struct qemu_alarm_timer
*alarm_timer
;
94 static bool timer_expired_ns(QEMUTimer
*timer_head
, int64_t current_time
)
96 return timer_head
&& (timer_head
->expire_time
<= current_time
);
99 static int64_t qemu_next_alarm_deadline(void)
101 int64_t delta
= INT64_MAX
;
105 if (!use_icount
&& vm_clock
->enabled
&&
106 vm_clock
->main_loop_timerlist
->active_timers
) {
107 delta
= vm_clock
->main_loop_timerlist
->active_timers
->expire_time
-
108 qemu_get_clock_ns(vm_clock
);
110 if (host_clock
->enabled
&&
111 host_clock
->main_loop_timerlist
->active_timers
) {
112 hdelta
= host_clock
->main_loop_timerlist
->active_timers
->expire_time
-
113 qemu_get_clock_ns(host_clock
);
114 if (hdelta
< delta
) {
118 if (rt_clock
->enabled
&&
119 rt_clock
->main_loop_timerlist
->active_timers
) {
120 rtdelta
= (rt_clock
->main_loop_timerlist
->active_timers
->expire_time
-
121 qemu_get_clock_ns(rt_clock
));
122 if (rtdelta
< delta
) {
130 static void qemu_rearm_alarm_timer(struct qemu_alarm_timer
*t
)
132 int64_t nearest_delta_ns
= qemu_next_alarm_deadline();
133 if (nearest_delta_ns
< INT64_MAX
) {
134 t
->rearm(t
, nearest_delta_ns
);
138 /* TODO: MIN_TIMER_REARM_NS should be optimized */
139 #define MIN_TIMER_REARM_NS 250000
143 static int mm_start_timer(struct qemu_alarm_timer
*t
);
144 static void mm_stop_timer(struct qemu_alarm_timer
*t
);
145 static void mm_rearm_timer(struct qemu_alarm_timer
*t
, int64_t delta
);
147 static int win32_start_timer(struct qemu_alarm_timer
*t
);
148 static void win32_stop_timer(struct qemu_alarm_timer
*t
);
149 static void win32_rearm_timer(struct qemu_alarm_timer
*t
, int64_t delta
);
153 static int unix_start_timer(struct qemu_alarm_timer
*t
);
154 static void unix_stop_timer(struct qemu_alarm_timer
*t
);
155 static void unix_rearm_timer(struct qemu_alarm_timer
*t
, int64_t delta
);
159 static int dynticks_start_timer(struct qemu_alarm_timer
*t
);
160 static void dynticks_stop_timer(struct qemu_alarm_timer
*t
);
161 static void dynticks_rearm_timer(struct qemu_alarm_timer
*t
, int64_t delta
);
163 #endif /* __linux__ */
167 static struct qemu_alarm_timer alarm_timers
[] = {
170 {"dynticks", dynticks_start_timer
,
171 dynticks_stop_timer
, dynticks_rearm_timer
},
173 {"unix", unix_start_timer
, unix_stop_timer
, unix_rearm_timer
},
175 {"mmtimer", mm_start_timer
, mm_stop_timer
, mm_rearm_timer
},
176 {"dynticks", win32_start_timer
, win32_stop_timer
, win32_rearm_timer
},
181 static void show_available_alarms(void)
185 printf("Available alarm timers, in order of precedence:\n");
186 for (i
= 0; alarm_timers
[i
].name
; i
++)
187 printf("%s\n", alarm_timers
[i
].name
);
190 void configure_alarms(char const *opt
)
194 int count
= ARRAY_SIZE(alarm_timers
) - 1;
197 struct qemu_alarm_timer tmp
;
199 if (is_help_option(opt
)) {
200 show_available_alarms();
206 /* Reorder the array */
207 name
= strtok(arg
, ",");
209 for (i
= 0; i
< count
&& alarm_timers
[i
].name
; i
++) {
210 if (!strcmp(alarm_timers
[i
].name
, name
))
215 fprintf(stderr
, "Unknown clock %s\n", name
);
224 tmp
= alarm_timers
[i
];
225 alarm_timers
[i
] = alarm_timers
[cur
];
226 alarm_timers
[cur
] = tmp
;
230 name
= strtok(NULL
, ",");
236 /* Disable remaining timers */
237 for (i
= cur
; i
< count
; i
++)
238 alarm_timers
[i
].name
= NULL
;
240 show_available_alarms();
245 static QEMUTimerList
*timerlist_new_from_clock(QEMUClock
*clock
)
247 QEMUTimerList
*timer_list
;
249 /* Assert if we do not have a clock. If you see this
250 * assertion in means that the clocks have not been
251 * initialised before a timerlist is needed. This
252 * normally happens if an AioContext is used before
253 * init_clocks() is called within main().
257 timer_list
= g_malloc0(sizeof(QEMUTimerList
));
258 timer_list
->clock
= clock
;
259 QLIST_INSERT_HEAD(&clock
->timerlists
, timer_list
, list
);
263 QEMUTimerList
*timerlist_new(QEMUClockType type
)
265 return timerlist_new_from_clock(qemu_clock_ptr(type
));
268 void timerlist_free(QEMUTimerList
*timer_list
)
270 assert(!timerlist_has_timers(timer_list
));
271 if (timer_list
->clock
) {
272 QLIST_REMOVE(timer_list
, list
);
273 if (timer_list
->clock
->main_loop_timerlist
== timer_list
) {
274 timer_list
->clock
->main_loop_timerlist
= NULL
;
280 static QEMUClock
*qemu_clock_new(QEMUClockType type
)
284 clock
= g_malloc0(sizeof(QEMUClock
));
286 clock
->enabled
= true;
287 clock
->last
= INT64_MIN
;
288 QLIST_INIT(&clock
->timerlists
);
289 notifier_list_init(&clock
->reset_notifiers
);
290 clock
->main_loop_timerlist
= timerlist_new_from_clock(clock
);
294 bool qemu_clock_use_for_deadline(QEMUClock
*clock
)
296 return !(use_icount
&& (clock
->type
== QEMU_CLOCK_VIRTUAL
));
299 void qemu_clock_enable(QEMUClock
*clock
, bool enabled
)
301 bool old
= clock
->enabled
;
302 clock
->enabled
= enabled
;
303 if (enabled
&& !old
) {
304 qemu_rearm_alarm_timer(alarm_timer
);
308 bool timerlist_has_timers(QEMUTimerList
*timer_list
)
310 return !!timer_list
->active_timers
;
313 bool qemu_clock_has_timers(QEMUClock
*clock
)
315 return timerlist_has_timers(clock
->main_loop_timerlist
);
318 bool timerlist_expired(QEMUTimerList
*timer_list
)
320 return (timer_list
->active_timers
&&
321 timer_list
->active_timers
->expire_time
<
322 qemu_get_clock_ns(timer_list
->clock
));
325 bool qemu_clock_expired(QEMUClock
*clock
)
327 return timerlist_expired(clock
->main_loop_timerlist
);
330 int64_t timerlist_deadline(QEMUTimerList
*timer_list
)
332 /* To avoid problems with overflow limit this to 2^32. */
333 int64_t delta
= INT32_MAX
;
335 if (timer_list
->clock
->enabled
&& timer_list
->active_timers
) {
336 delta
= timer_list
->active_timers
->expire_time
-
337 qemu_get_clock_ns(timer_list
->clock
);
345 int64_t qemu_clock_deadline(QEMUClock
*clock
)
347 return timerlist_deadline(clock
->main_loop_timerlist
);
351 * As above, but return -1 for no deadline, and do not cap to 2^32
352 * as we know the result is always positive.
355 int64_t timerlist_deadline_ns(QEMUTimerList
*timer_list
)
359 if (!timer_list
->clock
->enabled
|| !timer_list
->active_timers
) {
363 delta
= timer_list
->active_timers
->expire_time
-
364 qemu_get_clock_ns(timer_list
->clock
);
373 int64_t qemu_clock_deadline_ns(QEMUClock
*clock
)
375 return timerlist_deadline_ns(clock
->main_loop_timerlist
);
378 QEMUClock
*timerlist_get_clock(QEMUTimerList
*timer_list
)
380 return timer_list
->clock
;
383 QEMUTimerList
*qemu_clock_get_main_loop_timerlist(QEMUClock
*clock
)
385 return clock
->main_loop_timerlist
;
388 /* Transition function to convert a nanosecond timeout to ms
389 * This is used where a system does not support ppoll
391 int qemu_timeout_ns_to_ms(int64_t ns
)
402 /* Always round up, because it's better to wait too long than to wait too
403 * little and effectively busy-wait
405 ms
= (ns
+ SCALE_MS
- 1) / SCALE_MS
;
407 /* To avoid overflow problems, limit this to 2^31, i.e. approx 25 days */
408 if (ms
> (int64_t) INT32_MAX
) {
416 /* qemu implementation of g_poll which uses a nanosecond timeout but is
417 * otherwise identical to g_poll
419 int qemu_poll_ns(GPollFD
*fds
, guint nfds
, int64_t timeout
)
423 return ppoll((struct pollfd
*)fds
, nfds
, NULL
, NULL
);
426 ts
.tv_sec
= timeout
/ 1000000000LL;
427 ts
.tv_nsec
= timeout
% 1000000000LL;
428 return ppoll((struct pollfd
*)fds
, nfds
, &ts
, NULL
);
431 return g_poll(fds
, nfds
, qemu_timeout_ns_to_ms(timeout
));
436 void timer_init(QEMUTimer
*ts
,
437 QEMUTimerList
*timer_list
, int scale
,
438 QEMUTimerCB
*cb
, void *opaque
)
440 ts
->timer_list
= timer_list
;
446 QEMUTimer
*qemu_new_timer(QEMUClock
*clock
, int scale
,
447 QEMUTimerCB
*cb
, void *opaque
)
449 return timer_new_tl(clock
->main_loop_timerlist
,
453 void qemu_free_timer(QEMUTimer
*ts
)
458 /* stop a timer, but do not dealloc it */
459 void qemu_del_timer(QEMUTimer
*ts
)
463 /* NOTE: this code must be signal safe because
464 timer_expired() can be called from a signal. */
465 pt
= &ts
->timer_list
->active_timers
;
478 /* modify the current timer so that it will be fired when current_time
479 >= expire_time. The corresponding callback will be called. */
480 void qemu_mod_timer_ns(QEMUTimer
*ts
, int64_t expire_time
)
486 /* add the timer in the sorted list */
487 /* NOTE: this code must be signal safe because
488 timer_expired() can be called from a signal. */
489 pt
= &ts
->timer_list
->active_timers
;
492 if (!timer_expired_ns(t
, expire_time
)) {
497 ts
->expire_time
= expire_time
;
501 /* Rearm if necessary */
502 if (pt
== &ts
->timer_list
->active_timers
) {
503 if (!alarm_timer
->pending
) {
504 qemu_rearm_alarm_timer(alarm_timer
);
506 /* Interrupt execution to force deadline recalculation. */
507 qemu_clock_warp(ts
->timer_list
->clock
);
514 void qemu_mod_timer(QEMUTimer
*ts
, int64_t expire_time
)
516 qemu_mod_timer_ns(ts
, expire_time
* ts
->scale
);
519 bool timer_pending(QEMUTimer
*ts
)
522 for (t
= ts
->timer_list
->active_timers
; t
!= NULL
; t
= t
->next
) {
530 bool timer_expired(QEMUTimer
*timer_head
, int64_t current_time
)
532 return timer_expired_ns(timer_head
, current_time
* timer_head
->scale
);
535 bool timerlist_run_timers(QEMUTimerList
*timer_list
)
538 int64_t current_time
;
539 bool progress
= false;
541 if (!timer_list
->clock
->enabled
) {
545 current_time
= qemu_get_clock_ns(timer_list
->clock
);
547 ts
= timer_list
->active_timers
;
548 if (!timer_expired_ns(ts
, current_time
)) {
551 /* remove timer from the list before calling the callback */
552 timer_list
->active_timers
= ts
->next
;
555 /* run the callback (the timer list can be modified) */
562 bool qemu_run_timers(QEMUClock
*clock
)
564 return timerlist_run_timers(clock
->main_loop_timerlist
);
567 int64_t qemu_get_clock_ns(QEMUClock
*clock
)
571 switch(clock
->type
) {
572 case QEMU_CLOCK_REALTIME
:
575 case QEMU_CLOCK_VIRTUAL
:
577 return cpu_get_icount();
579 return cpu_get_clock();
581 case QEMU_CLOCK_HOST
:
582 now
= get_clock_realtime();
586 notifier_list_notify(&clock
->reset_notifiers
, &now
);
592 void qemu_register_clock_reset_notifier(QEMUClock
*clock
, Notifier
*notifier
)
594 notifier_list_add(&clock
->reset_notifiers
, notifier
);
597 void qemu_unregister_clock_reset_notifier(QEMUClock
*clock
, Notifier
*notifier
)
599 notifier_remove(notifier
);
602 void init_clocks(void)
605 for (type
= 0; type
< QEMU_CLOCK_MAX
; type
++) {
606 if (!qemu_clocks
[type
]) {
607 qemu_clocks
[type
] = qemu_clock_new(type
);
611 #ifdef CONFIG_PRCTL_PR_SET_TIMERSLACK
612 prctl(PR_SET_TIMERSLACK
, 1, 0, 0, 0);
616 uint64_t timer_expire_time_ns(QEMUTimer
*ts
)
618 return timer_pending(ts
) ? ts
->expire_time
: -1;
621 bool qemu_run_all_timers(void)
623 bool progress
= false;
624 alarm_timer
->pending
= false;
628 for (type
= 0; type
< QEMU_CLOCK_MAX
; type
++) {
629 progress
|= qemu_run_timers(qemu_clock_ptr(type
));
632 /* rearm timer, if not periodic */
633 if (alarm_timer
->expired
) {
634 alarm_timer
->expired
= false;
635 qemu_rearm_alarm_timer(alarm_timer
);
642 static void CALLBACK
host_alarm_handler(PVOID lpParam
, BOOLEAN unused
)
644 static void host_alarm_handler(int host_signum
)
647 struct qemu_alarm_timer
*t
= alarm_timer
;
656 #if defined(__linux__)
658 #include "qemu/compatfd.h"
660 static int dynticks_start_timer(struct qemu_alarm_timer
*t
)
664 struct sigaction act
;
666 sigfillset(&act
.sa_mask
);
668 act
.sa_handler
= host_alarm_handler
;
670 sigaction(SIGALRM
, &act
, NULL
);
673 * Initialize ev struct to 0 to avoid valgrind complaining
674 * about uninitialized data in timer_create call
676 memset(&ev
, 0, sizeof(ev
));
677 ev
.sigev_value
.sival_int
= 0;
678 ev
.sigev_notify
= SIGEV_SIGNAL
;
679 #ifdef CONFIG_SIGEV_THREAD_ID
680 if (qemu_signalfd_available()) {
681 ev
.sigev_notify
= SIGEV_THREAD_ID
;
682 ev
._sigev_un
._tid
= qemu_get_thread_id();
684 #endif /* CONFIG_SIGEV_THREAD_ID */
685 ev
.sigev_signo
= SIGALRM
;
687 if (timer_create(CLOCK_REALTIME
, &ev
, &host_timer
)) {
688 perror("timer_create");
692 t
->timer
= host_timer
;
697 static void dynticks_stop_timer(struct qemu_alarm_timer
*t
)
699 timer_t host_timer
= t
->timer
;
701 timer_delete(host_timer
);
704 static void dynticks_rearm_timer(struct qemu_alarm_timer
*t
,
705 int64_t nearest_delta_ns
)
707 timer_t host_timer
= t
->timer
;
708 struct itimerspec timeout
;
711 if (nearest_delta_ns
< MIN_TIMER_REARM_NS
)
712 nearest_delta_ns
= MIN_TIMER_REARM_NS
;
714 /* check whether a timer is already running */
715 if (timer_gettime(host_timer
, &timeout
)) {
717 fprintf(stderr
, "Internal timer error: aborting\n");
720 current_ns
= timeout
.it_value
.tv_sec
* 1000000000LL + timeout
.it_value
.tv_nsec
;
721 if (current_ns
&& current_ns
<= nearest_delta_ns
)
724 timeout
.it_interval
.tv_sec
= 0;
725 timeout
.it_interval
.tv_nsec
= 0; /* 0 for one-shot timer */
726 timeout
.it_value
.tv_sec
= nearest_delta_ns
/ 1000000000;
727 timeout
.it_value
.tv_nsec
= nearest_delta_ns
% 1000000000;
728 if (timer_settime(host_timer
, 0 /* RELATIVE */, &timeout
, NULL
)) {
730 fprintf(stderr
, "Internal timer error: aborting\n");
735 #endif /* defined(__linux__) */
739 static int unix_start_timer(struct qemu_alarm_timer
*t
)
741 struct sigaction act
;
744 sigfillset(&act
.sa_mask
);
746 act
.sa_handler
= host_alarm_handler
;
748 sigaction(SIGALRM
, &act
, NULL
);
752 static void unix_rearm_timer(struct qemu_alarm_timer
*t
,
753 int64_t nearest_delta_ns
)
755 struct itimerval itv
;
758 if (nearest_delta_ns
< MIN_TIMER_REARM_NS
)
759 nearest_delta_ns
= MIN_TIMER_REARM_NS
;
761 itv
.it_interval
.tv_sec
= 0;
762 itv
.it_interval
.tv_usec
= 0; /* 0 for one-shot timer */
763 itv
.it_value
.tv_sec
= nearest_delta_ns
/ 1000000000;
764 itv
.it_value
.tv_usec
= (nearest_delta_ns
% 1000000000) / 1000;
765 err
= setitimer(ITIMER_REAL
, &itv
, NULL
);
768 fprintf(stderr
, "Internal timer error: aborting\n");
773 static void unix_stop_timer(struct qemu_alarm_timer
*t
)
775 struct itimerval itv
;
777 memset(&itv
, 0, sizeof(itv
));
778 setitimer(ITIMER_REAL
, &itv
, NULL
);
781 #endif /* !defined(_WIN32) */
786 static MMRESULT mm_timer
;
787 static TIMECAPS mm_tc
;
789 static void CALLBACK
mm_alarm_handler(UINT uTimerID
, UINT uMsg
,
790 DWORD_PTR dwUser
, DWORD_PTR dw1
,
793 struct qemu_alarm_timer
*t
= alarm_timer
;
802 static int mm_start_timer(struct qemu_alarm_timer
*t
)
804 timeGetDevCaps(&mm_tc
, sizeof(mm_tc
));
808 static void mm_stop_timer(struct qemu_alarm_timer
*t
)
811 timeKillEvent(mm_timer
);
815 static void mm_rearm_timer(struct qemu_alarm_timer
*t
, int64_t delta
)
817 int64_t nearest_delta_ms
= delta
/ 1000000;
818 if (nearest_delta_ms
< mm_tc
.wPeriodMin
) {
819 nearest_delta_ms
= mm_tc
.wPeriodMin
;
820 } else if (nearest_delta_ms
> mm_tc
.wPeriodMax
) {
821 nearest_delta_ms
= mm_tc
.wPeriodMax
;
825 timeKillEvent(mm_timer
);
827 mm_timer
= timeSetEvent((UINT
)nearest_delta_ms
,
831 TIME_ONESHOT
| TIME_CALLBACK_FUNCTION
);
834 fprintf(stderr
, "Failed to re-arm win32 alarm timer\n");
835 timeEndPeriod(mm_tc
.wPeriodMin
);
840 static int win32_start_timer(struct qemu_alarm_timer
*t
)
845 /* If you call ChangeTimerQueueTimer on a one-shot timer (its period
846 is zero) that has already expired, the timer is not updated. Since
847 creating a new timer is relatively expensive, set a bogus one-hour
848 interval in the dynticks case. */
849 success
= CreateTimerQueueTimer(&hTimer
,
855 WT_EXECUTEINTIMERTHREAD
);
858 fprintf(stderr
, "Failed to initialize win32 alarm timer: %ld\n",
867 static void win32_stop_timer(struct qemu_alarm_timer
*t
)
869 HANDLE hTimer
= t
->timer
;
872 DeleteTimerQueueTimer(NULL
, hTimer
, NULL
);
876 static void win32_rearm_timer(struct qemu_alarm_timer
*t
,
877 int64_t nearest_delta_ns
)
879 HANDLE hTimer
= t
->timer
;
880 int64_t nearest_delta_ms
;
883 nearest_delta_ms
= nearest_delta_ns
/ 1000000;
884 if (nearest_delta_ms
< 1) {
885 nearest_delta_ms
= 1;
887 /* ULONG_MAX can be 32 bit */
888 if (nearest_delta_ms
> ULONG_MAX
) {
889 nearest_delta_ms
= ULONG_MAX
;
891 success
= ChangeTimerQueueTimer(NULL
,
893 (unsigned long) nearest_delta_ms
,
897 fprintf(stderr
, "Failed to rearm win32 alarm timer: %ld\n",
906 static void quit_timers(void)
908 struct qemu_alarm_timer
*t
= alarm_timer
;
914 static void reinit_timers(void)
916 struct qemu_alarm_timer
*t
= alarm_timer
;
919 fprintf(stderr
, "Internal timer error: aborting\n");
922 qemu_rearm_alarm_timer(t
);
924 #endif /* CONFIG_POSIX */
926 int init_timer_alarm(void)
928 struct qemu_alarm_timer
*t
= NULL
;
935 for (i
= 0; alarm_timers
[i
].name
; i
++) {
936 t
= &alarm_timers
[i
];
950 pthread_atfork(NULL
, NULL
, reinit_timers
);