[qemu.git] / qemu-timer.h

#ifndef QEMU_TIMER_H
#define QEMU_TIMER_H

#include "qemu-common.h"
#include <time.h>
#include <sys/time.h>

#ifdef _WIN32
#include <windows.h>
#include <mmsystem.h>
#endif

/* timers */

#define SCALE_MS 1000000
#define SCALE_US 1000
#define SCALE_NS 1

typedef struct QEMUClock QEMUClock;
typedef void QEMUTimerCB(void *opaque);

/* The real time clock should be used only for stuff which does not
   change the virtual machine state, as it is run even if the virtual
   machine is stopped. The real time clock has a frequency of 1000
   Hz. */
extern QEMUClock *rt_clock;

/* The virtual clock is only run during the emulation. It is stopped
   when the virtual machine is stopped. Virtual timers use a high
   precision clock, usually cpu cycles (use ticks_per_sec). */
extern QEMUClock *vm_clock;

/* The host clock should be use for device models that emulate accurate
   real time sources. It will continue to run when the virtual machine
   is suspended, and it will reflect system time changes the host may
   undergo (e.g. due to NTP). The host clock has the same precision as
   the virtual clock. */
extern QEMUClock *host_clock;

int64_t qemu_get_clock_ns(QEMUClock *clock);
void qemu_clock_enable(QEMUClock *clock, int enabled);

QEMUTimer *qemu_new_timer(QEMUClock *clock, int scale,
                          QEMUTimerCB *cb, void *opaque);
void qemu_free_timer(QEMUTimer *ts);
void qemu_del_timer(QEMUTimer *ts);
void qemu_mod_timer(QEMUTimer *ts, int64_t expire_time);
int qemu_timer_pending(QEMUTimer *ts);
int qemu_timer_expired(QEMUTimer *timer_head, int64_t current_time);

void qemu_run_all_timers(void);
int qemu_alarm_pending(void);
int64_t qemu_next_deadline(void);
void configure_alarms(char const *opt);
void configure_icount(const char *option);
int qemu_calculate_timeout(void);
void init_clocks(void);
int init_timer_alarm(void);
void quit_timers(void);

static inline QEMUTimer *qemu_new_timer_ns(QEMUClock *clock, QEMUTimerCB *cb,
                                           void *opaque)
{
    return qemu_new_timer(clock, SCALE_NS, cb, opaque);
}

static inline QEMUTimer *qemu_new_timer_ms(QEMUClock *clock, QEMUTimerCB *cb,
                                           void *opaque)
{
    return qemu_new_timer(clock, SCALE_MS, cb, opaque);
}

static inline int64_t qemu_get_clock_ms(QEMUClock *clock)
{
    return qemu_get_clock_ns(clock) / SCALE_MS;
}

static inline int64_t get_ticks_per_sec(void)
{
    return 1000000000LL;
}

/* real time host monotonic timer */
static inline int64_t get_clock_realtime(void)
{
    struct timeval tv;

    gettimeofday(&tv, NULL);
    return tv.tv_sec * 1000000000LL + (tv.tv_usec * 1000);
}

/* Warning: don't insert tracepoints into these functions, they are
   also used by simpletrace backend and tracepoints would cause
   an infinite recursion! */
#ifdef _WIN32
extern int64_t clock_freq;

static inline int64_t get_clock(void)
{
    LARGE_INTEGER ti;
    QueryPerformanceCounter(&ti);
    return muldiv64(ti.QuadPart, get_ticks_per_sec(), clock_freq);
}

#else

extern int use_rt_clock;

static inline int64_t get_clock(void)
{
#if defined(__linux__) || (defined(__FreeBSD__) && __FreeBSD_version >= 500000) \
    || defined(__DragonFly__) || defined(__FreeBSD_kernel__)
    if (use_rt_clock) {
        struct timespec ts;
        clock_gettime(CLOCK_MONOTONIC, &ts);
        return ts.tv_sec * 1000000000LL + ts.tv_nsec;
    } else
#endif
    {
        /* XXX: using gettimeofday leads to problems if the date
           changes, so it should be avoided. */
        return get_clock_realtime();
    }
}
#endif

void qemu_get_timer(QEMUFile *f, QEMUTimer *ts);
void qemu_put_timer(QEMUFile *f, QEMUTimer *ts);

/* ptimer.c */
typedef struct ptimer_state ptimer_state;
typedef void (*ptimer_cb)(void *opaque);

ptimer_state *ptimer_init(QEMUBH *bh);
void ptimer_set_period(ptimer_state *s, int64_t period);
void ptimer_set_freq(ptimer_state *s, uint32_t freq);
void ptimer_set_limit(ptimer_state *s, uint64_t limit, int reload);
uint64_t ptimer_get_count(ptimer_state *s);
void ptimer_set_count(ptimer_state *s, uint64_t count);
void ptimer_run(ptimer_state *s, int oneshot);
void ptimer_stop(ptimer_state *s);
void qemu_put_ptimer(QEMUFile *f, ptimer_state *s);
void qemu_get_ptimer(QEMUFile *f, ptimer_state *s);

/* icount */
int64_t qemu_icount_round(int64_t count);
extern int64_t qemu_icount;
extern int use_icount;
extern int icount_time_shift;
extern int64_t qemu_icount_bias;
int64_t cpu_get_icount(void);

/*******************************************/
/* host CPU ticks (if available) */

#if defined(_ARCH_PPC)

static inline int64_t cpu_get_real_ticks(void)
{
    int64_t retval;
#ifdef _ARCH_PPC64
    /* This reads timebase in one 64bit go and includes Cell workaround from:
       http://ozlabs.org/pipermail/linuxppc-dev/2006-October/027052.html
    */
    __asm__ __volatile__ ("mftb    %0\n\t"
                          "cmpwi   %0,0\n\t"
                          "beq-    $-8"
                          : "=r" (retval));
#else
    /* http://ozlabs.org/pipermail/linuxppc-dev/1999-October/003889.html */
    unsigned long junk;
    __asm__ __volatile__ ("mfspr   %1,269\n\t"  /* mftbu */
                          "mfspr   %L0,268\n\t" /* mftb */
                          "mfspr   %0,269\n\t"  /* mftbu */
                          "cmpw    %0,%1\n\t"
                          "bne     $-16"
                          : "=r" (retval), "=r" (junk));
#endif
    return retval;
}

#elif defined(__i386__)

static inline int64_t cpu_get_real_ticks(void)
{
    int64_t val;
    asm volatile ("rdtsc" : "=A" (val));
    return val;
}

#elif defined(__x86_64__)

static inline int64_t cpu_get_real_ticks(void)
{
    uint32_t low,high;
    int64_t val;
    asm volatile("rdtsc" : "=a" (low), "=d" (high));
    val = high;
    val <<= 32;
    val |= low;
    return val;
}

#elif defined(__hppa__)

static inline int64_t cpu_get_real_ticks(void)
{
    int val;
    asm volatile ("mfctl %%cr16, %0" : "=r"(val));
    return val;
}

#elif defined(__ia64)

static inline int64_t cpu_get_real_ticks(void)
{
    int64_t val;
    asm volatile ("mov %0 = ar.itc" : "=r"(val) :: "memory");
    return val;
}

#elif defined(__s390__)

static inline int64_t cpu_get_real_ticks(void)
{
    int64_t val;
    asm volatile("stck 0(%1)" : "=m" (val) : "a" (&val) : "cc");
    return val;
}

#elif defined(__sparc_v8plus__) || defined(__sparc_v8plusa__) || defined(__sparc_v9__)

static inline int64_t cpu_get_real_ticks (void)
{
#if defined(_LP64)
    uint64_t        rval;
    asm volatile("rd %%tick,%0" : "=r"(rval));
    return rval;
#else
    union {
        uint64_t i64;
        struct {
            uint32_t high;
            uint32_t low;
        }       i32;
    } rval;
    asm volatile("rd %%tick,%1; srlx %1,32,%0"
                 : "=r"(rval.i32.high), "=r"(rval.i32.low));
    return rval.i64;
#endif
}

#elif defined(__mips__) && \
    ((defined(__mips_isa_rev) && __mips_isa_rev >= 2) || defined(__linux__))
/*
 * binutils wants to use rdhwr only on mips32r2
 * but as linux kernel emulate it, it's fine
 * to use it.
 *
 */
#define MIPS_RDHWR(rd, value) {                         \
        __asm__ __volatile__ (".set   push\n\t"         \
                              ".set mips32r2\n\t"       \
                              "rdhwr  %0, "rd"\n\t"     \
                              ".set   pop"              \
                              : "=r" (value));          \
    }

static inline int64_t cpu_get_real_ticks(void)
{
    /* On kernels >= 2.6.25 rdhwr <reg>, $2 and $3 are emulated */
    uint32_t count;
    static uint32_t cyc_per_count = 0;

    if (!cyc_per_count) {
        MIPS_RDHWR("$3", cyc_per_count);
    }

    MIPS_RDHWR("$2", count);
    return (int64_t)(count * cyc_per_count);
}

#elif defined(__alpha__)

static inline int64_t cpu_get_real_ticks(void)
{
    uint64_t cc;
    uint32_t cur, ofs;

    asm volatile("rpcc %0" : "=r"(cc));
    cur = cc;
    ofs = cc >> 32;
    return cur - ofs;
}

#else
/* The host CPU doesn't have an easily accessible cycle counter.
   Just return a monotonically increasing value.  This will be
   totally wrong, but hopefully better than nothing.  */
static inline int64_t cpu_get_real_ticks (void)
{
    static int64_t ticks = 0;
    return ticks++;
}
#endif

#ifdef NEED_CPU_H
/* Deterministic execution requires that IO only be performed on the last
   instruction of a TB so that interrupts take effect immediately.  */
static inline int can_do_io(CPUState *env)
{
    if (!use_icount)
        return 1;

    /* If not executing code then assume we are ok.  */
    if (!env->current_tb)
        return 1;

    return env->can_do_io != 0;
}
#endif

#ifdef CONFIG_PROFILER
static inline int64_t profile_getclock(void)
{
    return cpu_get_real_ticks();
}

extern int64_t qemu_time, qemu_time_start;
extern int64_t tlb_flush_time;
extern int64_t dev_time;
#endif

#endif
Commit	Line	Data
87ecb68b PB	1	#ifndef QEMU_TIMER_H
	2	#define QEMU_TIMER_H
	3
29e922b6	4	#include "qemu-common.h"
c57c846a BS	5	#include <time.h>
	6	#include <sys/time.h>
	7
	8	#ifdef _WIN32
	9	#include <windows.h>
	10	#include <mmsystem.h>
	11	#endif
29e922b6	12
87ecb68b PB	13	/* timers */
87ecb68b PB	14
0ce1b948 PB	15	#define SCALE_MS 1000000
	16	#define SCALE_US 1000
	17	#define SCALE_NS 1
	18
87ecb68b PB	19	typedef struct QEMUClock QEMUClock;
	20	typedef void QEMUTimerCB(void *opaque);
	21
	22	/* The real time clock should be used only for stuff which does not
	23	change the virtual machine state, as it is run even if the virtual
	24	machine is stopped. The real time clock has a frequency of 1000
	25	Hz. */
	26	extern QEMUClock *rt_clock;
	27
	28	/* The virtual clock is only run during the emulation. It is stopped
	29	when the virtual machine is stopped. Virtual timers use a high
	30	precision clock, usually cpu cycles (use ticks_per_sec). */
	31	extern QEMUClock *vm_clock;
	32
21d5d12b JK	33	/* The host clock should be use for device models that emulate accurate
	34	real time sources. It will continue to run when the virtual machine
	35	is suspended, and it will reflect system time changes the host may
	36	undergo (e.g. due to NTP). The host clock has the same precision as
	37	the virtual clock. */
	38	extern QEMUClock *host_clock;
	39
41c872b6	40	int64_t qemu_get_clock_ns(QEMUClock *clock);
db1a4972	41	void qemu_clock_enable(QEMUClock *clock, int enabled);
87ecb68b	42
4a998740 PB	43	QEMUTimer qemu_new_timer(QEMUClock clock, int scale,
4a998740 PB	44	QEMUTimerCB cb, void opaque);
87ecb68b PB	45	void qemu_free_timer(QEMUTimer *ts);
	46	void qemu_del_timer(QEMUTimer *ts);
	47	void qemu_mod_timer(QEMUTimer *ts, int64_t expire_time);
	48	int qemu_timer_pending(QEMUTimer *ts);
2430ffe4	49	int qemu_timer_expired(QEMUTimer *timer_head, int64_t current_time);
87ecb68b	50
db1a4972 PB	51	void qemu_run_all_timers(void);
	52	int qemu_alarm_pending(void);
	53	int64_t qemu_next_deadline(void);
	54	void configure_alarms(char const *opt);
	55	void configure_icount(const char *option);
	56	int qemu_calculate_timeout(void);
	57	void init_clocks(void);
	58	int init_timer_alarm(void);
	59	void quit_timers(void);
	60
0ce1b948 PB	61	static inline QEMUTimer qemu_new_timer_ns(QEMUClock clock, QEMUTimerCB *cb,
	62	void *opaque)
	63	{
4a998740	64	return qemu_new_timer(clock, SCALE_NS, cb, opaque);
0ce1b948 PB	65	}
	66
	67	static inline QEMUTimer qemu_new_timer_ms(QEMUClock clock, QEMUTimerCB *cb,
	68	void *opaque)
	69	{
4a998740	70	return qemu_new_timer(clock, SCALE_MS, cb, opaque);
0ce1b948 PB	71	}
	72
	73	static inline int64_t qemu_get_clock_ms(QEMUClock *clock)
	74	{
	75	return qemu_get_clock_ns(clock) / SCALE_MS;
	76	}
	77
274dfed8 AL	78	static inline int64_t get_ticks_per_sec(void)
	79	{
	80	return 1000000000LL;
	81	}
87ecb68b	82
c57c846a BS	83	/* real time host monotonic timer */
	84	static inline int64_t get_clock_realtime(void)
	85	{
	86	struct timeval tv;
	87
	88	gettimeofday(&tv, NULL);
	89	return tv.tv_sec * 1000000000LL + (tv.tv_usec * 1000);
	90	}
	91
	92	/* Warning: don't insert tracepoints into these functions, they are
	93	also used by simpletrace backend and tracepoints would cause
	94	an infinite recursion! */
	95	#ifdef _WIN32
	96	extern int64_t clock_freq;
	97
	98	static inline int64_t get_clock(void)
	99	{
	100	LARGE_INTEGER ti;
	101	QueryPerformanceCounter(&ti);
	102	return muldiv64(ti.QuadPart, get_ticks_per_sec(), clock_freq);
	103	}
	104
	105	#else
	106
	107	extern int use_rt_clock;
	108
	109	static inline int64_t get_clock(void)
	110	{
	111	#if defined(__linux__) \|\| (defined(__FreeBSD__) && __FreeBSD_version >= 500000) \
	112	\|\| defined(__DragonFly__) \|\| defined(__FreeBSD_kernel__)
	113	if (use_rt_clock) {
	114	struct timespec ts;
	115	clock_gettime(CLOCK_MONOTONIC, &ts);
	116	return ts.tv_sec * 1000000000LL + ts.tv_nsec;
	117	} else
	118	#endif
	119	{
	120	/* XXX: using gettimeofday leads to problems if the date
	121	changes, so it should be avoided. */
	122	return get_clock_realtime();
	123	}
	124	}
	125	#endif
db1a4972	126
87ecb68b PB	127	void qemu_get_timer(QEMUFile f, QEMUTimer ts);
	128	void qemu_put_timer(QEMUFile f, QEMUTimer ts);
	129
	130	/* ptimer.c */
	131	typedef struct ptimer_state ptimer_state;
	132	typedef void (ptimer_cb)(void opaque);
	133
	134	ptimer_state ptimer_init(QEMUBH bh);
	135	void ptimer_set_period(ptimer_state *s, int64_t period);
	136	void ptimer_set_freq(ptimer_state *s, uint32_t freq);
	137	void ptimer_set_limit(ptimer_state *s, uint64_t limit, int reload);
	138	uint64_t ptimer_get_count(ptimer_state *s);
	139	void ptimer_set_count(ptimer_state *s, uint64_t count);
	140	void ptimer_run(ptimer_state *s, int oneshot);
	141	void ptimer_stop(ptimer_state *s);
	142	void qemu_put_ptimer(QEMUFile f, ptimer_state s);
	143	void qemu_get_ptimer(QEMUFile f, ptimer_state s);
	144
29e922b6 BS	145	/* icount */
	146	int64_t qemu_icount_round(int64_t count);
	147	extern int64_t qemu_icount;
	148	extern int use_icount;
	149	extern int icount_time_shift;
	150	extern int64_t qemu_icount_bias;
	151	int64_t cpu_get_icount(void);
	152
	153	/*******************************************/
	154	/* host CPU ticks (if available) */
	155
	156	#if defined(_ARCH_PPC)
	157
	158	static inline int64_t cpu_get_real_ticks(void)
	159	{
	160	int64_t retval;
	161	#ifdef _ARCH_PPC64
	162	/* This reads timebase in one 64bit go and includes Cell workaround from:
	163	http://ozlabs.org/pipermail/linuxppc-dev/2006-October/027052.html
	164	*/
	165	__asm__ __volatile__ ("mftb %0\n\t"
	166	"cmpwi %0,0\n\t"
	167	"beq- $-8"
	168	: "=r" (retval));
	169	#else
	170	/* http://ozlabs.org/pipermail/linuxppc-dev/1999-October/003889.html */
	171	unsigned long junk;
4a9590f3 AG	172	__asm__ __volatile__ ("mfspr %1,269\n\t" /* mftbu */
	173	"mfspr %L0,268\n\t" /* mftb */
	174	"mfspr %0,269\n\t" /* mftbu */
29e922b6 BS	175	"cmpw %0,%1\n\t"
	176	"bne $-16"
	177	: "=r" (retval), "=r" (junk));
	178	#endif
	179	return retval;
	180	}
	181
	182	#elif defined(__i386__)
	183
	184	static inline int64_t cpu_get_real_ticks(void)
	185	{
	186	int64_t val;
	187	asm volatile ("rdtsc" : "=A" (val));
	188	return val;
	189	}
	190
	191	#elif defined(__x86_64__)
	192
	193	static inline int64_t cpu_get_real_ticks(void)
	194	{
	195	uint32_t low,high;
	196	int64_t val;
	197	asm volatile("rdtsc" : "=a" (low), "=d" (high));
	198	val = high;
	199	val <<= 32;
	200	val \|= low;
	201	return val;
	202	}
	203
	204	#elif defined(__hppa__)
	205
	206	static inline int64_t cpu_get_real_ticks(void)
	207	{
	208	int val;
	209	asm volatile ("mfctl %%cr16, %0" : "=r"(val));
	210	return val;
	211	}
	212
	213	#elif defined(__ia64)
	214
	215	static inline int64_t cpu_get_real_ticks(void)
	216	{
	217	int64_t val;
	218	asm volatile ("mov %0 = ar.itc" : "=r"(val) :: "memory");
	219	return val;
	220	}
	221
	222	#elif defined(__s390__)
	223
	224	static inline int64_t cpu_get_real_ticks(void)
	225	{
	226	int64_t val;
	227	asm volatile("stck 0(%1)" : "=m" (val) : "a" (&val) : "cc");
	228	return val;
	229	}
	230
	231	#elif defined(__sparc_v8plus__) \|\| defined(__sparc_v8plusa__) \|\| defined(__sparc_v9__)
	232
	233	static inline int64_t cpu_get_real_ticks (void)
	234	{
	235	#if defined(_LP64)
	236	uint64_t rval;
	237	asm volatile("rd %%tick,%0" : "=r"(rval));
	238	return rval;
239	#else
240	union {
241	uint64_t i64;
242	struct {
243	uint32_t high;
244	uint32_t low;
245	} i32;
246	} rval;
247	asm volatile("rd %%tick,%1; srlx %1,32,%0"
248	: "=r"(rval.i32.high), "=r"(rval.i32.low));
249	return rval.i64;
250	#endif
251	}
252
253	#elif defined(__mips__) && \
254	((defined(__mips_isa_rev) && __mips_isa_rev >= 2) \|\| defined(__linux__))
255	/*
256	* binutils wants to use rdhwr only on mips32r2
257	* but as linux kernel emulate it, it's fine
258	* to use it.
259	*
260	*/
261	#define MIPS_RDHWR(rd, value) { \
262	__asm__ __volatile__ (".set push\n\t" \
263	".set mips32r2\n\t" \
264	"rdhwr %0, "rd"\n\t" \
265	".set pop" \
266	: "=r" (value)); \
267	}
268
269	static inline int64_t cpu_get_real_ticks(void)
270	{
271	/* On kernels >= 2.6.25 rdhwr <reg>, $2 and $3 are emulated */
272	uint32_t count;
273	static uint32_t cyc_per_count = 0;
274
275	if (!cyc_per_count) {
276	MIPS_RDHWR("$3", cyc_per_count);
277	}
278
279	MIPS_RDHWR("$2", count);
280	return (int64_t)(count * cyc_per_count);
281	}
282
14a6063a RH	283	#elif defined(__alpha__)
	284
	285	static inline int64_t cpu_get_real_ticks(void)
	286	{
	287	uint64_t cc;
	288	uint32_t cur, ofs;
	289
	290	asm volatile("rpcc %0" : "=r"(cc));
	291	cur = cc;
	292	ofs = cc >> 32;
	293	return cur - ofs;
	294	}
	295
29e922b6 BS	296	#else
	297	/* The host CPU doesn't have an easily accessible cycle counter.
	298	Just return a monotonically increasing value. This will be
	299	totally wrong, but hopefully better than nothing. */
	300	static inline int64_t cpu_get_real_ticks (void)
	301	{
	302	static int64_t ticks = 0;
	303	return ticks++;
	304	}
	305	#endif
	306
	307	#ifdef NEED_CPU_H
	308	/* Deterministic execution requires that IO only be performed on the last
	309	instruction of a TB so that interrupts take effect immediately. */
	310	static inline int can_do_io(CPUState *env)
	311	{
	312	if (!use_icount)
	313	return 1;
	314
	315	/* If not executing code then assume we are ok. */
	316	if (!env->current_tb)
	317	return 1;
	318
	319	return env->can_do_io != 0;
	320	}
	321	#endif
	322
2d8ebcf9 RH	323	#ifdef CONFIG_PROFILER
	324	static inline int64_t profile_getclock(void)
	325	{
	326	return cpu_get_real_ticks();
	327	}
	328
	329	extern int64_t qemu_time, qemu_time_start;
	330	extern int64_t tlb_flush_time;
	331	extern int64_t dev_time;
	332	#endif
	333
87ecb68b	334	#endif