2022-10-10 18:20:10 +00:00
|
|
|
.. _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.
|
2022-10-20 21:24:39 +00:00
|
|
|
|
|
|
|
|
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.
|
