OrgZephyr/zephyr
OrgZephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity
zephyr/doc/services/debugging/thread-analyzer.rst

88 lines
3.7 KiB
ReStructuredText
Raw Normal View History

debug: thread_analyzer: Implement thread analyzer Thread analyzer is simple module that helps in printing thread information, like stacks usage statistics. Signed-off-by: Radoslaw Koppel <radoslaw.koppel@nordicsemi.no> Signed-off-by: Bartosz Gentkowski <bartosz.gentkowski@nordicsemi.no> Signed-off-by: Joakim Andersson <joakim.andersson@nordicsemi.no>
2020-03-04 22:08:44 +08:00
.. _thread_analyzer:
Thread analyzer
###################
The thread analyzer module enables all the Zephyr options required to track
doc: thread-analyzer: document THREAD_RUNTIME_STATS Add details about THREAD_RUNTIME_STATS and how it can be used and document how the feature can be used with an example. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2020-12-15 00:42:28 +08:00
the thread information, e.g. thread stack size usage and other runtime thread
runtime statistics.
debug: thread_analyzer: Implement thread analyzer Thread analyzer is simple module that helps in printing thread information, like stacks usage statistics. Signed-off-by: Radoslaw Koppel <radoslaw.koppel@nordicsemi.no> Signed-off-by: Bartosz Gentkowski <bartosz.gentkowski@nordicsemi.no> Signed-off-by: Joakim Andersson <joakim.andersson@nordicsemi.no>
2020-03-04 22:08:44 +08:00
The analysis is performed on demand when the application calls
doc: update function references to use :c:func: Following the change to use the C domain for parsing, update all existing :cpp:func: references to :c:func:. Remove the parentheses as well, if used, because they are not needed, this is already known to be a function, and how it is displayed in the documentation later is a semantic decision done by the output builder. Signed-off-by: Fabio Utzig <fabio.utzig@nordicsemi.no>
2020-08-24 22:35:45 +08:00
:c:func:`thread_analyzer_run` or :c:func:`thread_analyzer_print`.
debug: thread_analyzer: Implement thread analyzer Thread analyzer is simple module that helps in printing thread information, like stacks usage statistics. Signed-off-by: Radoslaw Koppel <radoslaw.koppel@nordicsemi.no> Signed-off-by: Bartosz Gentkowski <bartosz.gentkowski@nordicsemi.no> Signed-off-by: Joakim Andersson <joakim.andersson@nordicsemi.no>
2020-03-04 22:08:44 +08:00
doc: thread-analyzer: document THREAD_RUNTIME_STATS Add details about THREAD_RUNTIME_STATS and how it can be used and document how the feature can be used with an example. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2020-12-15 00:42:28 +08:00
For example, to build the synchronization sample with Thread Analyser enabled,
do the following:
.. zephyr-app-commands::
doc: samples: use :zephyr-app: for in-tree samples The zephyr-app-commands directive can output a helpful hint to the user when they are trying to build a sample that is in the Zephyr tree, telling them to ensure they are in the root folder of the Zephyr repo. Update all doc pages that were using :app: instead of :zephyr-app: so that the hint is displayed. Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-08-24 00:00:28 +08:00
:zephyr-app: samples/synchronization/
doc: thread-analyzer: document THREAD_RUNTIME_STATS Add details about THREAD_RUNTIME_STATS and how it can be used and document how the feature can be used with an example. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2020-12-15 00:42:28 +08:00
:board: qemu_x86
:goals: build
:gen-args: -DCONFIG_QEMU_ICOUNT=n -DCONFIG_THREAD_ANALYZER=y \
-DCONFIG_THREAD_ANALYZER_USE_PRINTK=y -DCONFIG_THREAD_ANALYZER_AUTO=y \
-DCONFIG_THREAD_ANALYZER_AUTO_INTERVAL=5
When you run the generated application in Qemu, you will get the additional
information from Thread Analyzer::
thread_a: Hello World from cpu 0 on qemu_x86!
Thread analyze:
thread_b : STACK: unused 740 usage 284 / 1024 (27 %); CPU: 0 %
thread_analyzer : STACK: unused 8 usage 504 / 512 (98 %); CPU: 0 %
thread_a : STACK: unused 648 usage 376 / 1024 (36 %); CPU: 98 %
kernel: Remove idle thread cpu index on single-core devices The idle thread got an index suffix in #23536 to make it easier to identify different idle threads on different cores. This looks out of place on single-core devices when the idle thread is listed next to other kernel threads, such as main. Remove the idle thread index on single-core platforms, and replace all references to this format in tests and documentation. Signed-off-by: Trond Einar Snekvik <Trond.Einar.Snekvik@nordicsemi.no>
2022-03-25 19:46:32 +08:00
idle : STACK: unused 204 usage 116 / 320 (36 %); CPU: 0 %
doc: thread-analyzer: document THREAD_RUNTIME_STATS Add details about THREAD_RUNTIME_STATS and how it can be used and document how the feature can be used with an example. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2020-12-15 00:42:28 +08:00
thread_b: Hello World from cpu 0 on qemu_x86!
thread_a: Hello World from cpu 0 on qemu_x86!
thread_b: Hello World from cpu 0 on qemu_x86!
thread_a: Hello World from cpu 0 on qemu_x86!
thread_b: Hello World from cpu 0 on qemu_x86!
thread_a: Hello World from cpu 0 on qemu_x86!
thread_b: Hello World from cpu 0 on qemu_x86!
thread_a: Hello World from cpu 0 on qemu_x86!
Thread analyze:
thread_b : STACK: unused 648 usage 376 / 1024 (36 %); CPU: 7 %
thread_analyzer : STACK: unused 8 usage 504 / 512 (98 %); CPU: 0 %
thread_a : STACK: unused 648 usage 376 / 1024 (36 %); CPU: 9 %
kernel: Remove idle thread cpu index on single-core devices The idle thread got an index suffix in #23536 to make it easier to identify different idle threads on different cores. This looks out of place on single-core devices when the idle thread is listed next to other kernel threads, such as main. Remove the idle thread index on single-core platforms, and replace all references to this format in tests and documentation. Signed-off-by: Trond Einar Snekvik <Trond.Einar.Snekvik@nordicsemi.no>
2022-03-25 19:46:32 +08:00
idle : STACK: unused 204 usage 116 / 320 (36 %); CPU: 82 %
doc: thread-analyzer: document THREAD_RUNTIME_STATS Add details about THREAD_RUNTIME_STATS and how it can be used and document how the feature can be used with an example. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2020-12-15 00:42:28 +08:00
thread_b: Hello World from cpu 0 on qemu_x86!
thread_a: Hello World from cpu 0 on qemu_x86!
thread_b: Hello World from cpu 0 on qemu_x86!
thread_a: Hello World from cpu 0 on qemu_x86!
thread_b: Hello World from cpu 0 on qemu_x86!
thread_a: Hello World from cpu 0 on qemu_x86!
thread_b: Hello World from cpu 0 on qemu_x86!
thread_a: Hello World from cpu 0 on qemu_x86!
Thread analyze:
thread_b : STACK: unused 648 usage 376 / 1024 (36 %); CPU: 7 %
thread_analyzer : STACK: unused 8 usage 504 / 512 (98 %); CPU: 0 %
thread_a : STACK: unused 648 usage 376 / 1024 (36 %); CPU: 8 %
kernel: Remove idle thread cpu index on single-core devices The idle thread got an index suffix in #23536 to make it easier to identify different idle threads on different cores. This looks out of place on single-core devices when the idle thread is listed next to other kernel threads, such as main. Remove the idle thread index on single-core platforms, and replace all references to this format in tests and documentation. Signed-off-by: Trond Einar Snekvik <Trond.Einar.Snekvik@nordicsemi.no>
2022-03-25 19:46:32 +08:00
idle : STACK: unused 204 usage 116 / 320 (36 %); CPU: 83 %
doc: thread-analyzer: document THREAD_RUNTIME_STATS Add details about THREAD_RUNTIME_STATS and how it can be used and document how the feature can be used with an example. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2020-12-15 00:42:28 +08:00
thread_b: Hello World from cpu 0 on qemu_x86!
thread_a: Hello World from cpu 0 on qemu_x86!
thread_b: Hello World from cpu 0 on qemu_x86!
debug: thread_analyzer: Implement thread analyzer Thread analyzer is simple module that helps in printing thread information, like stacks usage statistics. Signed-off-by: Radoslaw Koppel <radoslaw.koppel@nordicsemi.no> Signed-off-by: Bartosz Gentkowski <bartosz.gentkowski@nordicsemi.no> Signed-off-by: Joakim Andersson <joakim.andersson@nordicsemi.no>
2020-03-04 22:08:44 +08:00
Configuration
*************
Configure this module using the following options.
* ``THREAD_ANALYZER``: enable the module.
* ``THREAD_ANALYZER_USE_PRINTK``: use printk for thread statistics.
* ``THREAD_ANALYZER_USE_LOG``: use the logger for thread statistics.
* ``THREAD_ANALYZER_AUTO``: run the thread analyzer automatically.
You do not need to add any code to the application when using this option.
* ``THREAD_ANALYZER_AUTO_INTERVAL``: the time for which the module sleeps
between consecutive printing of thread analysis in automatic mode.
* ``THREAD_ANALYZER_AUTO_STACK_SIZE``: the stack for thread analyzer
automatic thread.
* ``THREAD_NAME``: enable this option in the kernel to print the name of the
thread instead of its ID.
doc: thread-analyzer: document THREAD_RUNTIME_STATS Add details about THREAD_RUNTIME_STATS and how it can be used and document how the feature can be used with an example. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2020-12-15 00:42:28 +08:00
* ``THREAD_RUNTIME_STATS``: enable this option to print thread runtime data such
as utilization (This options is automatically selected by THREAD_ANALYZER).
debug: thread_analyzer: Implement thread analyzer Thread analyzer is simple module that helps in printing thread information, like stacks usage statistics. Signed-off-by: Radoslaw Koppel <radoslaw.koppel@nordicsemi.no> Signed-off-by: Bartosz Gentkowski <bartosz.gentkowski@nordicsemi.no> Signed-off-by: Joakim Andersson <joakim.andersson@nordicsemi.no>
2020-03-04 22:08:44 +08:00
API documentation
*****************
.. doxygengroup:: thread_analyzer