blob: 7a51c18996d97fa6228b79a545284c85c98bf99c [file] [log] [blame] [view] [edit]
<!-- Generated by zircon/scripts/update-docs-from-fidl, do not edit! -->
# zx_ticks_get
## Summary
Read the number of high-precision timer ticks since boot.
## Declaration
```c
#include <zircon/syscalls.h>
zx_ticks_t zx_ticks_get(void);
```
## Description
`zx_ticks_get()` returns the number of high-precision timer ticks since boot.
These ticks may be processor cycles, high speed timer, profiling timer, etc.
They are not guaranteed to continue advancing when the system is asleep.
## Rights
TODO(fxbug.dev/32253)
## Return value
`zx_ticks_get()` returns the number of high-precision timer ticks since boot.
## Errors
`zx_ticks_get()` does not report any error conditions.
## Notes
The returned value may be highly variable. Factors that can affect it include:
- Changes in processor frequency
- Migration between processors
- Reset of the processor cycle counter
- Reordering of instructions (if required, use a memory barrier)
## See also
[ticks_per_second](ticks_per_second.md)