diff --git a/Documentation/applications/testing/pthread_mutex_perf/index.rst b/Documentation/applications/testing/pthread_mutex_perf/index.rst new file mode 100644 index 0000000000000..9578633a9a761 --- /dev/null +++ b/Documentation/applications/testing/pthread_mutex_perf/index.rst @@ -0,0 +1,15 @@ +======= +Testing +======= + +The ``pthread_mutex_perf`` is a simple performance test to validate if some +specific kernel modification impacted the pthread_mutex_trylock(). + +Basically the test will run a busy-wait 1000000 trying to acquire a mutex +that is already locked. Then it will calculate the total time and the +average time, repeating this cycle 10 times. + +This test is not intended to confirm that pthread mutex is working, for that +it is better to use ostest. Its goal is to verify impact in the kernel that +could be considered a regression. +