clock: Get rid of clock_get_ns()
v2 cover clock: Get rid of clock_get_ns()
This patchseries makes some changes to the clock API:
* Remove clock_get_ns()
* Add clock_ticks_to_ns() to return number of nanoseconds it will take the clock to tick N times
* clock_display_freq() to return prettily-formatted string for showing humans the approximate clock frequency
This is based on discussions we had about these APIs a little while back. The core driver here is that the clock objects internally store the period in units of 2^-32 ns, so both clock_get_ns() and clock_get_hz() are inherently returning a rounded-off result, which can be badly inaccurate for fast clocks or if you want to multiply it by a large tick count.
Ideally I'd like to get rid of clock_get_hz() as well, but that looks trickier than handling clock_get_ns().
Patch 4 borrows a lot of the concept from one of Philippe's that he sent out previously.
NB: tested with 'make check' and 'make check-acceptance' only.
Changes v1->v2:
* In patch 1, saturate return value to INT64_MAX (and update docs to explain this and why)
Patches 2-4 have been reviewed, only patch 1 needs review.
thanks
-- PMM
Peter Maydell (4):
clock: Introduce clock_ticks_to_ns()
target/mips: Don't use clock_get_ns() in clock period calculation
clock: Remove clock_get_ns()
clock: Define and use new clock_display_freq()
docs/devel/clocks.rst | 51 ++++++++++++++++++++++++++++++++++++---- include/hw/clock.h | 53 +++++++++++++++++++++++++++++++++++++++--- hw/core/clock.c | 6 +++++ softmmu/qdev-monitor.c | 6 ++--- target/mips/cpu.c | 4 ++-- 5 files changed, 108 insertions(+), 12 deletions(-)
Signature · 1 line
2.20.1
PATCH v2 1/4 clock: Introduce clock_ticks_to_ns()
The clock_get_ns() API claims to return the period of a clock in nanoseconds. Unfortunately since it returns an integer and a clock's period is represented in units of 2^-32 nanoseconds, the result is often an approximation, and calculating a clock expiry deadline by multiplying clock_get_ns() by a number-of-ticks is unacceptably inaccurate.
Introduce a new API clock_ticks_to_ns() which returns the number of nanoseconds it takes the clock to make a given number of ticks. This function can do the complete calculation internally and will thus give a more accurate result.
---
The 64x64->128 multiply is a bit painful for 32-bit and I guess in theory since we know we only want bits [95:32] of the result we could special-case it, but TBH I don't think 32-bit hosts merit much optimization effort these days.
Changes in v2: saturate the result to INT64_MAX.
--- docs/devel/clocks.rst | 29 +++++++++++++++++++++++++++++ include/hw/clock.h | 41 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 70 insertions(+)
docs/devel/clocks.rst +29 -0
@@ -258,6 +258,35 @@ Here is an example: clock_get_ns(dev->my_clk_input)); } +Calculating expiry deadlines +---------------------------- + +A commonly required operation for a clock is to calculate how long +it will take for the clock to tick N times; this can then be used +to set a timer expiry deadline. Use the function ``clock_ticks_to_ns()``, +which takes an unsigned 64-bit count of ticks and returns the length +of time in nanoseconds required for the clock to tick that many times. + +It is important not to try to calculate expiry deadlines using a +shortcut like multiplying a "period of clock in nanoseconds" value +by the tick count, because clocks can have periods which are not a +whole number of nanoseconds, and the accumulated error in the +multiplication can be significant. + +For a clock with a very long period and a large number of ticks, +the result of this function could in theory be too large to fit in +a 64-bit value. To avoid overflow in this case, ``clock_ticks_to_ns()`` +saturates the result to INT64_MAX (because this is the largest valid +input to the QEMUTimer APIs). Since INT64_MAX nanoseconds is almost +300 years, anything with an expiry later than that is in the "will +never happen" category. Callers of ``clock_ticks_to_ns()`` should +therefore generally not special-case the possibility of a saturated +result but just allow the timer to be set to that far-future value. +(If you are performing further calculations on the returned value +rather than simply passing it to a QEMUTimer function like +``timer_mod_ns()`` then you should be careful to avoid overflow +in those calculations, of course.) + Changing a clock period -----------------------
include/hw/clock.h +41 -0
53 lines not on this page · raw message
Signature · 1 line
2.20.1
Re: [PATCH v2 1/4] clock: Introduce clock_ticks_to_ns()
Quoted 19 lines · Peter Maydell
The
clock_get_ns()API claims to return the period of a clock in nanoseconds. Unfortunately since it returns an integer and a clock's period is represented in units of 2^-32 nanoseconds, the result is often an approximation, and calculating a clock expiry deadline by multiplyingclock_get_ns()by a number-of-ticks is unacceptably inaccurate.Introduce a new API
clock_ticks_to_ns()which returns the number of nanoseconds it takes the clock to make a given number of ticks. This function can do the complete calculation internally and will thus give a more accurate result.Signed-off-by Peter Maydell <[email protected]>---
The 64x64->128 multiply is a bit painful for 32-bit and I guess in theory since we know we only want bits [95:32] of the result we could special-case it, but TBH I don't think 32-bit hosts merit much optimization effort these days.
Quoted 5 lines
Changes in v2: saturate the result to
INT64_MAX.--- docs/devel/clocks.rst | 29 +++++++++++++++++++++++++++++ include/hw/clock.h | 41 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 70 insertions(+)
r~
Re: [PATCH v2 1/4] clock: Introduce clock_ticks_to_ns()
In reply to Peter MaydellQuoted 7 lines · Peter Maydell
The
clock_get_ns()API claims to return the period of a clock in nanoseconds. Unfortunately since it returns an integer and a clock's period is represented in units of 2^-32 nanoseconds, the result is often an approximation, and calculating a clock expiry deadline by multiplyingclock_get_ns()by a number-of-ticks is unacceptably inaccurate.
Quoted 6 lines
Introduce a new API
clock_ticks_to_ns()which returns the number of nanoseconds it takes the clock to make a given number of ticks. This function can do the complete calculation internally and will thus give a more accurate result.Signed-off-by Peter Maydell <[email protected]>
Quoted 112 lines
---
The 64x64->128 multiply is a bit painful for 32-bit and I guess in theory since we know we only want bits [95:32] of the result we could special-case it, but TBH I don't think 32-bit hosts merit much optimization effort these days.Changes in v2: saturate the result to
INT64_MAX.--- docs/devel/clocks.rst | 29 +++++++++++++++++++++++++++++ include/hw/clock.h | 41 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 70 insertions(+)docs/devel/clocks.rst +29
-0@@ -258,6 +258,35 @@ Here is an example: clock_get_ns(dev->my_clk_input)); } +Calculating expiry deadlines +---------------------------- + +A commonly required operation for a clock is to calculate how long +it will take for the clock to tick N times; this can then be used +to set a timer expiry deadline. Use the function ``clock_ticks_to_ns()``, +which takes an unsigned 64-bit count of ticks and returns the length +of time in nanoseconds required for the clock to tick that many times. + +It is important not to try to calculate expiry deadlines using a +shortcut like multiplying a "period of clock in nanoseconds" value +by the tick count, because clocks can have periods which are not a +whole number of nanoseconds, and the accumulated error in the +multiplication can be significant. + +For a clock with a very long period and a large number of ticks, +the result of this function could in theory be too large to fit in +a 64-bit value. To avoid overflow in this case, ``clock_ticks_to_ns()`` +saturates the result to INT64_MAX (because this is the largest valid +input to the QEMUTimer APIs). Since INT64_MAX nanoseconds is almost +300 years, anything with an expiry later than that is in the "will +never happen" category. Callers of ``clock_ticks_to_ns()`` should +therefore generally not special-case the possibility of a saturated +result but just allow the timer to be set to that far-future value. +(If you are performing further calculations on the returned value +rather than simply passing it to a QEMUTimer function like +``timer_mod_ns()`` then you should be careful to avoid overflow +in those calculations, of course.) + Changing a clock period -----------------------include/hw/clock.h +41
-0@@ -16,6 +16,8 @@#include "qom/object.h" #include "qemu/queue.h" +#include "qemu/host-utils.h" +#include "qemu/bitops.h" #define TYPE_CLOCK "clock"OBJECT_DECLARE_SIMPLE_TYPE (Clock,CLOCK )@@ -218,6 +220,45 @@ static inline unsigned clock_get_ns(Clock *clk)return CLOCK_PERIOD_TO_NS (clock_get (clk)); } +/** +* clock_ticks_to_ns: +* @clk: the clock to query +* @ticks: number of ticks +* +* Returns the length of time in nanoseconds for this clock +* to tick @ticks times. Because a clock can have a period +* which is not a whole number of nanoseconds, it is important +* to use this function when calculating things like timer +* expiry deadlines, rather than attempting to obtain a "period +* in nanoseconds" value and then multiplying that by a number +* of ticks. +* +* The result could in theory be too large to fit in a 64-bit +* value if the number of ticks and the clock period are both +* large; to avoid overflow the result will be saturated to INT64_MAX +* (because this is the largest valid input to the QEMUTimer APIs). +* Since INT64_MAX nanoseconds is almost 300 years, anything with +* an expiry later than that is in the "will never happen" category +* and callers can reasonably not special-case the saturated result. +*/ +static inline uint64_t clock_ticks_to_ns (const Clock *clk,uint64_t ticks) +{ +uint64_t ns_low, ns_high; + +/* +* clk->period is the period in units of 2^-32 ns, so +* (clk->period * ticks) is the required length of time in those +* units, and we can convert to nanoseconds by multiplying by +* 2^32, which is the same as shifting the 128-bit multiplication +* result right by 32. +*/ +mulu64 (&ns_low, &ns_high, clk->period, ticks); +if (ns_high &MAKE_64BIT_MASK (31 ,33 )) { +return INT64_MAX ; + } +return ns_low >>32 | ns_high <<32 ; +} +/** * clock_is_enabled: * @clk: a clock
PATCH v2 2/4 target/mips: Don't use clock_get_ns() in clock period calculation
In reply to Peter MaydellCurrently the MIPS code uses the old clock_get_ns() API to calculate a time length in nanoseconds:
cpu->cp0_count_rate * clock_get_ns(MIPS_CPU(cpu)->clock)
This relies on the clock having a period which is an exact number of nanoseconds.
Switch to the new clock_ticks_to_ns() function, which does the multiplication internally at a higher precision.
--- target/mips/cpu.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
target/mips/cpu.c +2 -2
@@ -380,8 +380,8 @@ static void mips_cp0_period_set(MIPSCPU *cpu) {CPUMIPSState *env = &cpu->env; - env->cp0_count_ns = cpu->cp0_count_rate - *clock_get_ns (MIPS_CPU (cpu)->clock); + env->cp0_count_ns =clock_ticks_to_ns (MIPS_CPU (cpu)->clock, + cpu->cp0_count_rate);assert (env->cp0_count_ns); }
Signature · 1 line
2.20.1
PATCH v2 3/4 clock: Remove clock_get_ns()
In reply to Peter MaydellRemove the now-unused clock_get_ns() API and the CLOCK_PERIOD_TO_NS() macro that only it was using.
--- docs/devel/clocks.rst | 17 +++++++++++++---- include/hw/clock.h | 6 ------ 2 files changed, 13 insertions(+), 10 deletions(-)
docs/devel/clocks.rst +13 -4
@@ -238,8 +238,17 @@ object during device instance init. For example: Fetching clock frequency/period ------------------------------- -To get the current state of a clock, use the functions ``clock_get()``, -``clock_get_ns()`` or ``clock_get_hz()``. +To get the current state of a clock, use the functions ``clock_get()`` +or ``clock_get_hz()``. + +``clock_get()`` returns the period of the clock in its fully precise +internal representation, as an unsigned 64-bit integer in units of +2^-32 nanoseconds. (For many purposes ``clock_ticks_to_ns()`` will +be more convenient; see the section below on expiry deadlines.) + +``clock_get_hz()`` returns the frequency of the clock, rounded to the +next lowest integer. This implies some inaccuracy due to the rounding, +so be cautious about using it in calculations. It is also possible to register a callback on clock frequency changes. Here is an example:
@@ -254,8 +263,8 @@ Here is an example: */ /* do something with the new period */ - fprintf(stdout, "device new period is %" PRIu64 "ns\n", - clock_get_ns(dev->my_clk_input)); + fprintf(stdout, "device new period is %" PRIu64 "* 2^-32 ns\n", + clock_get(dev->my_clk_input)); } Calculating expiry deadlines
include/hw/clock.h +0 -6
@@ -40,7 +40,6 @@ typedef void ClockCallback(void *opaque);* macro helpers to convert to hertz / nanosecond */ #define CLOCK_PERIOD_FROM_NS (ns) ((ns) * (CLOCK_PERIOD_1SEC / 1000000000llu)) -#define CLOCK_PERIOD_TO_NS (per) ((per) / (CLOCK_PERIOD_1SEC / 1000000000llu))#define CLOCK_PERIOD_FROM_HZ (hz) (((hz) != 0) ? CLOCK_PERIOD_1SEC / (hz) : 0u)#define CLOCK_PERIOD_TO_HZ (per) (((per) != 0) ? CLOCK_PERIOD_1SEC / (per) : 0u)
@@ -215,11 +214,6 @@ static inline unsigned clock_get_hz(Clock *clk)return CLOCK_PERIOD_TO_HZ (clock_get (clk)); } -static inline unsigned clock_get_ns (Clock *clk) -{ -return CLOCK_PERIOD_TO_NS (clock_get (clk)); -} -/** * clock_ticks_to_ns: * @clk: the clock to query
Signature · 1 line
2.20.1
PATCH v2 4/4 clock: Define and use new clock_display_freq()
In reply to Peter MaydellIt's common to want to print a human-readable indication of a clock's frequency. Provide a utility function in the clock API to return a string which is a displayable representation of the frequency, and use it in qdev-monitor.c.
Before:
(qemu) info qtree
[...]
dev: xilinx,zynq_slcr, id ""
clock-in "ps_clk" freq_hz=3.333333e+07
mmio 00000000f8000000/0000000000001000After:
dev: xilinx,zynq_slcr, id ""
clock-in "ps_clk" freq_hz=33.3 MHz
mmio 00000000f8000000/0000000000001000---
This is based on Philippe's patch
"qdev-monitor: Display frequencies scaled to SI unit"
but I have abstracted out the "prettified string" into the clock API.
--- docs/devel/clocks.rst | 5 +++++ include/hw/clock.h | 12 ++++++++++++ hw/core/clock.c | 6 ++++++ softmmu/qdev-monitor.c | 6 +++--- 4 files changed, 26 insertions(+), 3 deletions(-)
docs/devel/clocks.rst +5 -0
@@ -267,6 +267,11 @@ Here is an example: clock_get(dev->my_clk_input)); } +If you are only interested in the frequency for displaying it to +humans (for instance in debugging), use ``clock_display_freq()``, +which returns a prettified string-representation, e.g. "33.3 MHz". +The caller must free the string with g_free() after use. + Calculating expiry deadlines ----------------------------
include/hw/clock.h +12 -0
@@ -264,4 +264,16 @@ static inline bool clock_is_enabled(const Clock *clk) return clock_get(clk) != 0; } +/** +* clock_display_freq: return human-readable representation of clock frequency +* @clk: clock +* +* Return a string which has a human-readable representation of the +* clock's frequency, e.g. "33.3 MHz". This is intended for debug +* and display purposes. +* +* The caller is responsible for freeing the string with g_free(). +*/ +char *clock_display_freq (Clock *clk); +#endif /* QEMU_HW_CLOCK_H */
hw/core/clock.c +6 -0
@@ -12,6 +12,7 @@*/ #include "qemu/osdep.h" +#include "qemu/cutils.h" #include "hw/clock.h" #include "trace.h"
@@ -111,6 +112,11 @@ static void clock_disconnect(Clock *clk)QLIST_REMOVE (clk, sibling); } +char *clock_display_freq (Clock *clk) +{ +return freq_to_str (clock_get_hz (clk)); +} +static void clock_initfn (Object *obj) {Clock *clk =CLOCK (obj);
softmmu/qdev-monitor.c +3 -3
@@ -732,11 +732,11 @@ static void qdev_print(Monitor *mon, DeviceState *dev, int indent) } } QLIST_FOREACH(ncl, &dev->clocks, node) { -qdev_printf ("clock-%s%s \"%s\" freq_hz=%e\n" , + g_autofree char *freq_str = clock_display_freq(ncl->clock); +qdev_printf ("clock-%s%s \"%s\" freq_hz=%s\n" , ncl->output ?"out" :"in" , ncl->alias ?" (alias)" :"" , - ncl->name, -CLOCK_PERIOD_TO_HZ (1.0 *clock_get (ncl->clock))); + ncl->name, freq_str); } class =object_get_class (OBJECT (dev)); do {
Signature · 1 line
2.20.1
Quoted 14 lines · Peter Maydell
This patchseries makes some changes to the clock API:
* Removeclock_get_ns()
* Addclock_ticks_to_ns()to return number of nanoseconds it will take the clock to tick N times
*clock_display_freq()to return prettily-formatted string for showing humans the approximate clock frequencyThis is based on discussions we had about these APIs a little while back. The core driver here is that the clock objects internally store the period in units of 2^-32 ns, so both
clock_get_ns()andclock_get_hz()are inherently returning a rounded-off result, which can be badly inaccurate for fast clocks or if you want to multiply it by a large tick count.
Quoted 7 lines
Ideally I'd like to get rid of
clock_get_hz()as well, but that looks trickier than handlingclock_get_ns().Patch 4 borrows a lot of the concept from one of Philippe's that he sent out previously.
NB: tested with 'make check' and 'make check-acceptance' only.
Tested using loongson3-virt @2GHz
https://lists.gnu.org/archive/html/qemu-devel/2020-12/msg04036.html
Without your series:
qemu-system-mips64el: target/mips/cpu.c:385: mips_cp0_period_set:
Assertion `env->cp0_count_ns' failed.
Aborted (core dumped)
With: OK (cpu are not displayed in 'info qtree).
Thanks!
Phil.
Quoted 8 lines · Philippe Mathieu-Daudé
Quoted 7 lines · Peter Maydell
This patchseries makes some changes to the clock API:
* Removeclock_get_ns()
* Addclock_ticks_to_ns()to return number of nanoseconds it will take the clock to tick N times
*clock_display_freq()to return prettily-formatted string for showing humans the approximate clock frequency
...
Quoted 4 lines
Tested using loongson3-virt @2GHz
https://lists.gnu.org/archive/html/qemu-devel/2020-12/msg04036.html
Quoted 8 lines
Without your series:
qemu-system-mips64el:target/mips/cpu.c:385:mips_cp0_period_set:
Assertion `env->cp0_count_ns' failed.
Aborted (core dumped)With: OK (cpu are not displayed in 'info qtree').
Reviewed-by Philippe Mathieu-Daudé <[email protected]>
I meant:
But now I reviewed, so confirming:
Thanks!
Phil.
Quoted 13 lines · Peter Maydell
This patchseries makes some changes to the clock API:
* Removeclock_get_ns()
* Addclock_ticks_to_ns()to return number of nanoseconds it will take the clock to tick N times
*clock_display_freq()to return prettily-formatted string for showing humans the approximate clock frequencyThis is based on discussions we had about these APIs a little while back. The core driver here is that the clock objects internally store the period in units of 2^-32 ns, so both
clock_get_ns()andclock_get_hz()are inherently returning a rounded-off result, which can be badly inaccurate for fast clocks or if you want to multiply it by a large tick count.
...
Quoted 6 lines
Peter Maydell (4):
clock: Introduceclock_ticks_to_ns()
target/mips: Don't useclock_get_ns()in clock period calculation
clock: Removeclock_get_ns()
clock: Define and use newclock_display_freq()
Quoted 6 lines
docs/devel/clocks.rst | 51 ++++++++++++++++++++++++++++++++++++---- include/hw/clock.h | 53 +++++++++++++++++++++++++++++++++++++++--- hw/core/clock.c | 6 +++++ softmmu/qdev-monitor.c | 6 ++--- target/mips/cpu.c | 4 ++-- 5 files changed, 108 insertions(+), 12 deletions(-)
Until someone else prefers otherwise, I plan to queue this series via the MIPS tree, as I can add the patch which increases the Loongson3v frequency to 2GHz on top (the unique machine using a frequency over 1GHz).
Thanks,
Phil.
Quoted 28 lines · Philippe Mathieu-Daudé
Quoted 13 lines · Peter Maydell
This patchseries makes some changes to the clock API:
* Removeclock_get_ns()
* Addclock_ticks_to_ns()to return number of nanoseconds it will take the clock to tick N times
*clock_display_freq()to return prettily-formatted string for showing humans the approximate clock frequencyThis is based on discussions we had about these APIs a little while back. The core driver here is that the clock objects internally store the period in units of 2^-32 ns, so both
clock_get_ns()andclock_get_hz()are inherently returning a rounded-off result, which can be badly inaccurate for fast clocks or if you want to multiply it by a large tick count....
Quoted 6 lines
Peter Maydell (4):
clock: Introduceclock_ticks_to_ns()
target/mips: Don't useclock_get_ns()in clock period calculation
clock: Removeclock_get_ns()
clock: Define and use newclock_display_freq()Quoted 6 lines
docs/devel/clocks.rst | 51 ++++++++++++++++++++++++++++++++++++---- include/hw/clock.h | 53 +++++++++++++++++++++++++++++++++++++++--- hw/core/clock.c | 6 +++++ softmmu/qdev-monitor.c | 6 ++--- target/mips/cpu.c | 4 ++-- 5 files changed, 108 insertions(+), 12 deletions(-)
Quoted 4 lines
Until someone else prefers otherwise, I plan to queue this series via the MIPS tree, as I can add the patch which increases the Loongson3v frequency to 2GHz on top (the unique machine using a frequency over 1GHz).
Thanks, series applied to mips-next.