1 /* 2 * CPU timers state API 3 * 4 * Copyright 2020 SUSE LLC 5 * 6 * This work is licensed under the terms of the GNU GPL, version 2 or later. 7 * See the COPYING file in the top-level directory. 8 * 9 */ 10 #ifndef SYSEMU_CPU_TIMERS_H 11 #define SYSEMU_CPU_TIMERS_H 12 13 #include "qemu/timer.h" 14 15 /* init the whole cpu timers API, including icount, ticks, and cpu_throttle */ 16 void cpu_timers_init(void); 17 18 /* icount - Instruction Counter API */ 19 20 /* 21 * icount enablement state: 22 * 23 * 0 = Disabled - Do not count executed instructions. 24 * 1 = Enabled - Fixed conversion of insn to ns via "shift" option 25 * 2 = Enabled - Runtime adaptive algorithm to compute shift 26 */ 27 #ifdef CONFIG_TCG 28 extern int use_icount; 29 #define icount_enabled() (use_icount) 30 #else 31 #define icount_enabled() 0 32 #endif 33 34 /* 35 * Update the icount with the executed instructions. Called by 36 * cpus-tcg vCPU thread so the main-loop can see time has moved forward. 37 */ 38 void icount_update(CPUState *cpu); 39 40 /* get raw icount value */ 41 int64_t icount_get_raw(void); 42 43 /* return the virtual CPU time in ns, based on the instruction counter. */ 44 int64_t icount_get(void); 45 /* 46 * convert an instruction counter value to ns, based on the icount shift. 47 * This shift is set as a fixed value with the icount "shift" option 48 * (precise mode), or it is constantly approximated and corrected at 49 * runtime in adaptive mode. 50 */ 51 int64_t icount_to_ns(int64_t icount); 52 53 /** 54 * icount_configure: configure the icount options, including "shift" 55 * @opts: Options to parse 56 * @errp: pointer to a NULL-initialized error object 57 * 58 * Return: true on success, else false setting @errp with error 59 */ 60 bool icount_configure(QemuOpts *opts, Error **errp); 61 62 /* used by tcg vcpu thread to calc icount budget */ 63 int64_t icount_round(int64_t count); 64 65 /* if the CPUs are idle, start accounting real time to virtual clock. */ 66 void icount_start_warp_timer(void); 67 void icount_account_warp_timer(void); 68 void icount_notify_exit(void); 69 70 /* 71 * CPU Ticks and Clock 72 */ 73 74 /* Caller must hold BQL */ 75 void cpu_enable_ticks(void); 76 /* Caller must hold BQL */ 77 void cpu_disable_ticks(void); 78 79 /* 80 * return the time elapsed in VM between vm_start and vm_stop. 81 * cpu_get_ticks() uses units of the host CPU cycle counter. 82 */ 83 int64_t cpu_get_ticks(void); 84 85 /* 86 * Returns the monotonic time elapsed in VM, i.e., 87 * the time between vm_start and vm_stop 88 */ 89 int64_t cpu_get_clock(void); 90 91 void qemu_timer_notify_cb(void *opaque, QEMUClockType type); 92 93 /* get the VIRTUAL clock and VM elapsed ticks via the cpus accel interface */ 94 int64_t cpus_get_virtual_clock(void); 95 int64_t cpus_get_elapsed_ticks(void); 96 97 #endif /* SYSEMU_CPU_TIMERS_H */ 98