Mirrors_Framework/nuttx
1
0
Fork 0
mirror of https://github.com/apache/nuttx.git synced 2025-12-17 10:16:49 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

docs/getprime: Add documentation for getprime example.

Browse Source 
Added documentation for `getprime` example as part of #11081.

Signed-off-by: Matteo Golin <matteo.golin@gmail.com>
This commit is contained in:
Matteo Golin
2025-05-16 20:43:48 -04:00
committed by Alan C. Assis
parent 4f57ebce66
commit 1107d4183c
1 changed files with 30 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
Documentation/applications/testing/getprime/index.rst
View File

@@ -1,3 +1,30 @@
=============================
``getprime`` getprime example
=============================
======================
``getprime`` benchmark
======================
This application is used to benchmark processing time using multithreading. Each
thread that is spawned will find all prime numbers in the range of 1 to 10,000.
To use ``getprime``, pass the number of threads you'd like to run as the only
argument. After the threads finish processing, the duration of the test is
printed to the console.
.. code:: console
nsh> getprime 3
Set thread priority to 10
Set thread policy to SCHED_RR
Start thread #0
Start thread #1
Start thread #2
thread #0 started, looking for primes < 10000, doing 10 run(s)
thread #1 started, looking for primes < 10000, doing 10 run(s)
thread #2 started, looking for primes < 10000, doing 10 run(s)
thread #0 finished, found 1230 primes, last one was 9973
thread #1 finished, found 1230 primes, last one was 9973
thread #2 finished, found 1230 primes, last one was 9973
Done
getprime took 89040 msec
This program can be used to see performance differences between boards,
single-core vs SMP, thread scheduling settings, etc.