OrgApache/incubator-nuttx
OrgApache
/
incubator-nuttx
mirror of https://github.com/apache/incubator-nuttx.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Update trace command document

This commit is contained in:
Nakamura, Yuuichi 2020-10-18 23:16:39 +09:00 committed by Xiang Xiao
parent 87a7c0317e
commit e1b9c278f8
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
Documentation/guides/tasktraceuser.rst
View File

@ -41,6 +41,7 @@ The following configurations are configurable parameters for trace.
- Bit 0 = Enable instrumentation - Bit 0 = Enable instrumentation
- Bit 1 = Enable syscall instrumentation - Bit 1 = Enable syscall instrumentation
- Bit 2 = Enable IRQ instrumentation - Bit 2 = Enable IRQ instrumentation
- Bit 3 = Enable collecting syscall arguments
- ``CONFIG_SCHED_INSTRUMENTATION_NOTERAM_BUFSIZE`` - ``CONFIG_SCHED_INSTRUMENTATION_NOTERAM_BUFSIZE``
@ -232,7 +233,7 @@ The default value is given by the kernel configuration ``CONFIG_SCHED_INSTRUMENT
.. code-block:: .. code-block::
trace mode [{+|-}{o|s|i}...] trace mode [{+|-}{o|s|a|i}...]
- ``+o`` : Enable overwrite mode. - ``+o`` : Enable overwrite mode.
The trace buffer is a ring buffer and it can overwrite old data if no free space is available in the buffer. The trace buffer is a ring buffer and it can overwrite old data if no free space is available in the buffer.
@ -248,6 +249,11 @@ The default value is given by the kernel configuration ``CONFIG_SCHED_INSTRUMENT
- ``-s`` : Disable system call trace. - ``-s`` : Disable system call trace.
- ``+a`` : Enable recording the system call arguments.
It records the arguments passed to the issued system call to the trace data.
- ``-a`` : Disable recording the system call arguments.
- ``+i`` : Enable interrupt trace. - ``+i`` : Enable interrupt trace.
It records the event of enter/leave interrupt handler which is occured while the tracing. It records the event of enter/leave interrupt handler which is occured while the tracing.
All IRQs are recorded by default. ``trace irq`` command can filter the IRQs to be recorded. All IRQs are recorded by default. ``trace irq`` command can filter the IRQs to be recorded.
@ -266,6 +272,7 @@ If no command parameters are specified, display the current mode as the follows.
Overwrite : on (+o) Overwrite : on (+o)
Syscall trace : on (+s) Syscall trace : on (+s)
Filtered Syscalls : 16 Filtered Syscalls : 16
Syscall trace with args : on (+a)
IRQ trace : on (+i) IRQ trace : on (+i)
Filtered IRQs : 2 Filtered IRQs : 2