dev-manual: Edits to "Running User-Space Tools" section.
(From yocto-docs rev: bb3e5efe23d1bc890ad203e1c936937fb4fd8958) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
parent
7bc64bda4f
commit
ef14eb8f98
|
@ -1276,14 +1276,14 @@
|
||||||
your development experience.
|
your development experience.
|
||||||
These tools are aids in developing and debugging applications and images.
|
These tools are aids in developing and debugging applications and images.
|
||||||
You can run these user-space tools from within the Eclipse IDE through the
|
You can run these user-space tools from within the Eclipse IDE through the
|
||||||
<filename>YoctoTools</filename> menu.
|
"YoctoTools" menu.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
Once you pick a tool, you need to configure it for the remote target.
|
Once you pick a tool, you need to configure it for the remote target.
|
||||||
Every tool needs to have the connection configured.
|
Every tool needs to have the connection configured.
|
||||||
You must select an existing TCF-based RSE connection to the remote target.
|
You must select an existing TCF-based RSE connection to the remote target.
|
||||||
If one does not exist, click <filename>New</filename> to create one.
|
If one does not exist, click "New" to create one.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
|
@ -1298,10 +1298,10 @@
|
||||||
You must compile and install the <filename>oprofile-viewer</filename> from the source code
|
You must compile and install the <filename>oprofile-viewer</filename> from the source code
|
||||||
on your local host machine.
|
on your local host machine.
|
||||||
Furthermore, in order to convert the target's sample format data into a form that the
|
Furthermore, in order to convert the target's sample format data into a form that the
|
||||||
host can use, you must have <filename>oprofile</filename> version 0.9.4 or
|
host can use, you must have OProfile version 0.9.4 or
|
||||||
greater installed on the host.</para>
|
greater installed on the host.</para>
|
||||||
<para>You can locate both the viewer and server from
|
<para>You can locate both the viewer and server from
|
||||||
<ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/oprofileui/'></ulink>
|
<ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/oprofileui/'></ulink>.
|
||||||
You can also find more information on setting up and
|
You can also find more information on setting up and
|
||||||
using this tool in the
|
using this tool in the
|
||||||
"<ulink url='&YOCTO_DOCS_PROF_URL;#profile-manual-oprofile'>OProfile</ulink>"
|
"<ulink url='&YOCTO_DOCS_PROF_URL;#profile-manual-oprofile'>OProfile</ulink>"
|
||||||
|
@ -1311,64 +1311,71 @@
|
||||||
<listitem><para><emphasis><filename>Lttng2.0 ust trace import</filename>:</emphasis>
|
<listitem><para><emphasis><filename>Lttng2.0 ust trace import</filename>:</emphasis>
|
||||||
Selecting this tool transfers the remote target's
|
Selecting this tool transfers the remote target's
|
||||||
<filename>Lttng</filename> tracing data back to the local host machine
|
<filename>Lttng</filename> tracing data back to the local host machine
|
||||||
and uses the <filename>Lttng</filename> Eclipse plug-in to graphically
|
and uses the Lttng Eclipse plug-in to graphically
|
||||||
display the output.
|
display the output.
|
||||||
For information on how to use <filename>Lttng</filename> to trace an application,
|
For information on how to use Lttng to trace an application,
|
||||||
see <ulink url='http://lttng.org/documentation'></ulink>.
|
see <ulink url='http://lttng.org/documentation'></ulink>
|
||||||
|
and the
|
||||||
|
"<ulink url='&YOCTO_DOCS_PROF_URL;#lttng-linux-trace-toolkit-next-generation'>LTTng (Linux Trace Toolkit, next generation)</ulink>"
|
||||||
|
section, which is in the Yocto Project Profiling and Tracing Manual.
|
||||||
<note>Do not use <filename>Lttng-user space (legacy)</filename> tool.
|
<note>Do not use <filename>Lttng-user space (legacy)</filename> tool.
|
||||||
This tool no longer has any upstream support.</note>
|
This tool no longer has any upstream support.</note>
|
||||||
</para>
|
</para>
|
||||||
<para>Before you use the <filename>Lttng2.0 ust trace import</filename> tool,
|
<para>Before you use the <filename>Lttng2.0 ust trace import</filename> tool,
|
||||||
you need to setup the <filename>Lttng</filename> Eclipse plug-in and create a
|
you need to setup the Lttng Eclipse plug-in and create a
|
||||||
<filename>Tracing</filename> project.
|
Tracing project.
|
||||||
Do the following:
|
Do the following:
|
||||||
<orderedlist>
|
<orderedlist>
|
||||||
<listitem><para>Select <filename>Window -> Open Perspective -> Other</filename>
|
<listitem><para>Select "Open Perspective" from the
|
||||||
and then select <filename>Tracing</filename>.</para></listitem>
|
"Window" menu and then select "Tracing".</para></listitem>
|
||||||
<listitem><para>Click <filename>OK</filename> to change the Eclipse perspective
|
<listitem><para>Click "OK" to change the Eclipse perspective
|
||||||
into the <filename>Tracing</filename> perspective.</para></listitem>
|
into the Tracing perspective.</para></listitem>
|
||||||
<listitem><para>Create a new <filename>Tracing</filename> project by selecting
|
<listitem><para>Create a new Tracing project by selecting
|
||||||
<filename>File -> New -> Project</filename>.</para></listitem>
|
"Project" from the "File -> New" menu.</para></listitem>
|
||||||
<listitem><para>Choose <filename>Tracing -> Tracing Project</filename>.
|
<listitem><para>Choose "Tracing Project" from the
|
||||||
|
"Tracing" menu.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para>Generate your tracing data on the remote target.
|
<listitem><para>Generate your tracing data on the remote target.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para>Click
|
<listitem><para>Select "Lttng2.0 ust trace import" from
|
||||||
<filename>Yocto Project Tools -> Lttng2.0 ust trace import</filename>
|
the "Yocto Project Tools" menu to
|
||||||
to start the data import process.</para></listitem>
|
start the data import process.</para></listitem>
|
||||||
<listitem><para>Specify your remote connection name.</para></listitem>
|
<listitem><para>Specify your remote connection name.</para></listitem>
|
||||||
<listitem><para>For the Ust directory path, specify the location of
|
<listitem><para>For the Ust directory path, specify the location of
|
||||||
your remote tracing data.
|
your remote tracing data.
|
||||||
Make sure the location ends with <filename>ust</filename> (e.g.
|
Make sure the location ends with <filename>ust</filename> (e.g.
|
||||||
<filename>/usr/mysession/ust</filename>.</para></listitem>
|
<filename>/usr/mysession/ust</filename>).</para></listitem>
|
||||||
<listitem><para>Click <filename>OK</filename> to complete the import process.
|
<listitem><para>Click "OK" to complete the import process.
|
||||||
The data is now in the local tracing project you created.</para></listitem>
|
The data is now in the local tracing project you created.</para></listitem>
|
||||||
<listitem><para>Right click on the data and then use the menu to
|
<listitem><para>Right click on the data and then use the menu to
|
||||||
<filename>Select Trace Type... -> Common Trace Format -> Generic CTF Trace</filename>
|
Select "Generic CTF Trace" from the
|
||||||
to map the tracing type.</para></listitem>
|
"Trace Type... -> Common Trace Format" menu to map
|
||||||
<listitem><para>Right click the mouse and select <filename>Open</filename>
|
the tracing type.</para></listitem>
|
||||||
to bring up the Eclipse <filename>Lttng</filename> Trace Viewer so you
|
<listitem><para>Right click the mouse and select "Open"
|
||||||
|
to bring up the Eclipse Lttng Trace Viewer so you
|
||||||
view the tracing data.</para></listitem>
|
view the tracing data.</para></listitem>
|
||||||
</orderedlist></para></listitem>
|
</orderedlist></para></listitem>
|
||||||
<listitem><para><emphasis><filename>PowerTOP</filename>:</emphasis> Selecting this tool runs
|
<listitem><para><emphasis><filename>PowerTOP</filename>:</emphasis> Selecting this tool runs
|
||||||
<filename>powertop</filename> on the remote target machine and displays the results in a
|
PowerTOP on the remote target machine and displays the results in a
|
||||||
new view called <filename>powertop</filename>.</para>
|
new view called PowerTOP.</para>
|
||||||
<para><filename>Time to gather data(sec):</filename> is the time passed in seconds before data
|
<para>The "Time to gather data(sec):" field is the time passed in seconds before data
|
||||||
is gathered from the remote target for analysis.</para>
|
is gathered from the remote target for analysis.</para>
|
||||||
<para><filename>show pids in wakeups list:</filename> corresponds to the
|
<para>The "show pids in wakeups list:" field corresponds to the
|
||||||
<filename>-p</filename> argument
|
<filename>-p</filename> argument
|
||||||
passed to <filename>powertop</filename>.</para></listitem>
|
passed to <filename>PowerTOP</filename>.</para></listitem>
|
||||||
<listitem><para><emphasis><filename>LatencyTOP and Perf</filename>:</emphasis>
|
<listitem><para><emphasis><filename>LatencyTOP and Perf</filename>:</emphasis>
|
||||||
<filename>latencytop</filename> identifies system latency, while
|
LatencyTOP identifies system latency, while
|
||||||
<filename>perf</filename> monitors the system's
|
Perf monitors the system's performance counter registers.
|
||||||
performance counter registers.
|
|
||||||
Selecting either of these tools causes an RSE terminal view to appear
|
Selecting either of these tools causes an RSE terminal view to appear
|
||||||
from which you can run the tools.
|
from which you can run the tools.
|
||||||
Both tools refresh the entire screen to display results while they run.
|
Both tools refresh the entire screen to display results while they run.
|
||||||
For more informationi on setting up and using <filename>perf</filename>,
|
For more information on setting up and using <filename>perf</filename>,
|
||||||
see the
|
see the
|
||||||
"<ulink url='&YOCTO_DOCS_PROF_URL;#profile-manual-perf'>perf</ulink>"
|
"<ulink url='&YOCTO_DOCS_PROF_URL;#profile-manual-perf'>perf</ulink>"
|
||||||
section in the Yocto Project Profiling and Tracing Manual.
|
section in the Yocto Project Profiling and Tracing Manual.
|
||||||
|
For information on LatencyTOP, see the
|
||||||
|
<ulink url='https://latencytop.org/'>LatencyTOP</ulink>
|
||||||
|
website.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
</itemizedlist>
|
</itemizedlist>
|
||||||
</para>
|
</para>
|
||||||
|
|
Loading…
Reference in New Issue