mirror of
https://fuchsia.googlesource.com/third_party/pigweed.googlesource.com/pigweed/pigweed
synced 2024-09-20 13:51:05 +00:00
fbd6d5d792
pw_perf_test now has a backend for which it will use to time the tested components. This update includes an implementation with pw_chrono, which will be used for time-based measurements(nanoseconds). Change-Id: I9a1bb9cf0964caa4d911a1c7c016bab3a41f1e32 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/113890 Reviewed-by: Wyatt Hepler <hepler@google.com> Commit-Queue: Brian Barcenas <bbarcenas@google.com> Reviewed-by: Erik Gilling <konkers@google.com>
28 lines
1021 B
ReStructuredText
28 lines
1021 B
ReStructuredText
.. _module-pw_perf_test:
|
|
|
|
============
|
|
pw_perf_test
|
|
============
|
|
Pigweed's perf test module provides an easy way to measure performance on
|
|
any test setup. By using an API similar to GoogleTest, this module aims to bring
|
|
a robust and intuitive testing framework to our users.
|
|
|
|
.. note::
|
|
This module is still under construction. Some features may not be available
|
|
yet.
|
|
|
|
---------
|
|
Timer API
|
|
---------
|
|
In order to provide meaningful performance timings for given functions, events,
|
|
etc a timing interface must be implemented from scratch to be able to provide
|
|
for the testing needs. The timing API meets these needs by implementing
|
|
either clock cycle record keeping or second based recordings.
|
|
|
|
Time-Based Measurement
|
|
======================
|
|
In order to achieve time-based measurements, pw_perf_test depends on
|
|
:ref:'module-pw_chrono' for its timing needs. At the moment, the interface will
|
|
only measure performance in terms of nanoseconds. To see more information about
|
|
how pw_chrono works, see the module documentation.
|