diff options
| author | Arnaldo Carvalho de Melo <acme@redhat.com> | 2009-07-14 11:00:10 -0300 |
|---|---|---|
| committer | Arnaldo Carvalho de Melo <acme@redhat.com> | 2009-07-14 11:00:10 -0300 |
| commit | 19f2837af673694bfee8f9ef8caf9bea599c9bb1 (patch) | |
| tree | e4f86850ba636a55102dd3449f651ed8915f835c | |
| parent | 796f9955458a6640253fd8d4f9ae962c106852d9 (diff) | |
| download | tuna-19f2837af673694bfee8f9ef8caf9bea599c9bb1.tar.gz | |
oscilloscope: Add article about the oscilloscope and tuna
Written by Carsten Emde <Carsten.Emde@osadl.org>, who allowed its use as
documentation in this package.
Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com>
| -rw-r--r-- | MANIFEST | 3 | ||||
| -rw-r--r-- | docs/oscilloscope+tuna.html | 163 | ||||
| -rw-r--r-- | docs/oscilloscope+tuna.pdf | bin | 0 -> 139309 bytes | |||
| -rw-r--r-- | rpm/SPECS/tuna.spec | 5 |
4 files changed, 170 insertions, 1 deletions
@@ -19,3 +19,6 @@ po/POTFILES.in po/ja.po po/pt_BR.po ChangeLog +docs/oscilloscope+tuna.html +docs/oscilloscope+tuna.pdf + diff --git a/docs/oscilloscope+tuna.html b/docs/oscilloscope+tuna.html new file mode 100644 index 0000000..9bba9ae --- /dev/null +++ b/docs/oscilloscope+tuna.html @@ -0,0 +1,163 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE html + PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> +<head> + <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> + +<!-- +OSADL - The Open Source Automation Development Lab + + This website is powered by TYPO3 - inspiring people to share! + TYPO3 is a free open source Content Management Framework initially created by Kasper Skaarhoj and licensed under GNU/GPL. + TYPO3 is copyright 1998-2006 of Kasper Skaarhoj. Extensions are copyright of their respective owners. + Information and contribution at http://typo3.com/ and http://typo3.org/ +--> + + <base href="http://www.osadl.org/" /> + <link rel="SHORTCUT ICON" href="fileadmin/favicon.ico" /> + <link rel="stylesheet" type="text/css" href="typo3temp/stylesheet_de96f05ce7.css" /> +<script type="text/javascript" src="fileadmin/scripts/cookies.js"></script><script type="text/javascript" src="fileadmin/scripts/efa_fontsize.js"></script> + +<link href="fileadmin/template/../css/layout_3col_fixed.css" rel="stylesheet" type="text/css" /> +<!--[if lte IE 7]> +<link href="fileadmin/template/../css/explorer/iehacks_3col_fixed.css" rel="stylesheet" type="text/css" /> +<![endif]--> + + <link rel="alternate" type="application/rss+xml" title="RSS feed: OSADL News" href="http://www.osadl.org/" /> + <link rel="alternate" type="application/rss+xml" title="RSS feed: OSADL Last Changes" href="http://www.osadl.org/" /><meta name="description" content="OSADL promotes and supports the use of Open Source software in the automation and machine industry." /> +<meta name="keywords" content="Realtime,Linux,Real-time,Realtime Linux,Real-time Linux,Open Source,Software,OSS,FOSS,Kernel,Automation,Cooperative,Member,Membership,Academic Member,Purchase Community" /> +<meta name="robots" content="index,follow" /> +<meta name="copyright" content="Open Source Automation Development Lab, (c)2007-2009. All rights reserved." /> +<meta http-equiv="content-language" content="en" /> +<link rev="made" href="mailto:info at osadl.org" /> +<meta http-equiv="reply-to" content="info at osadl.org" /> +<meta name="author" content="Open Source Automation Development Lab contributors" /> +<meta name="revisit-after" content="1 days" /> +<meta name="DC.Description" content="OSADL promotes and supports the use of Open Source software in the automation and machine industry." /> +<meta name="DC.Subject" content="Realtime,Linux,Real-time,Realtime Linux,Real-time Linux,Open Source,Software,OSS,FOSS,Kernel,Automation,Cooperative,Member,Membership,Academic Member,Purchase Community" /> +<meta name="DC.Rights" content="Open Source Automation Development Lab, (c)2007-2009. All rights reserved." /> +<meta name="DC.Language" scheme="NISOZ39.50" content="en" /> +<meta name="DC.Creator" content="Open Source Automation Development Lab contributors" /> +<link rel="schema.dc" href="http://purl.org/metadata/dublin_core_elements" /> + + <title>You can tune a piano - and you can tuna Linux system, too!: OSADL - Open Source Automation Development Lab eG</title> + <meta name="generator" content="TYPO3 4.1 CMS" /> + <script type="text/javascript" src="typo3temp/javascript_f52d1a094f.js"></script> + +<script type="text/javascript"> + /*<![CDATA[*/ +<!-- + function openPic(url,winName,winParams) { // + var theWindow = window.open(url,winName,winParams); + if (theWindow) {theWindow.focus();} + } + +// --> + /*]]>*/ +</script> + + +</head> +<body> + +<script type="text/javascript">if (efa_fontSize) efa_fontSize.efaInit();</script> +<div id="page_margins"><!--###page_margins### begin --> +<div id="page" class="hold_floats"><!--###page### begin --> + + <table class="toptable" id="toptable"> + <tr> + <td class="topleft" id="topleft"><img src="fileadmin/dam/logos/osadl_logo.png" width="160" height="70" border="0" alt="" title="" /></td> + <td class="topcenter" id="topcenter">Open Source Automation Development Lab</td> + </tr> + </table> + + + <div id="col1_content" class="clearfix"></div> + <!--###col1### end --></div> +<!-- #col1: - Ende --> + +<!-- #col2: zweite Flaot-Spalte des Inhaltsbereiches --> + <div id="col2"><!--###col2### begin --> + <!--TYPO3SEARCH_begin--> + <div id="col2_content" class="clearfix"></div> + <hr class="hide" /> + + <!--TYPO3SEARCH_end--> + <!--###col2### end --></div> +<!-- #col2: - Ende --> + +<a id="content" name="content"></a> <!-- Skiplink-Anker: Content --> +<!-- #col3: Statische Spalte des Inhaltsbereiches --> + <div id="col3"><!--###col3### begin --> + <!--TYPO3SEARCH_begin--> + <div id="col3_content" class="clearfix"><!--###col3_content### begin --> + + <div id="col3_innen" class="floatbox"><a id="c508"></a> + +<div class="news-single-item"> + + <div class="news-single-timedata">2008-07-27 12:00 Age: 351 Days </div> + <h2>You can tune a piano - and you can tuna Linux system, too!</h2> + + <p class="news-single-author">By: Carsten Emde (Used by permission)</p> + <h3>New versatile tools are helping us to manage real-time challenges under Linux (but you still can't tuna fish).</h3> + <div class="news-single-img"><img src="uploads/pics/spike.gif" width="144" height="107" border="0" alt="" title="" /></a><p class="news-single-imgcaption">The "CyclictestoSCOPE" in action</p></div> + <p class="bodytext">Do you wish you had a built-in oscilloscope that continuously displays the latency of your system? Here is one - thanks to Arnaldo Carvalho de Melo who not only wrote the <strong>oscilloscope</strong> but also the graphical process inspection and modification tool <strong>tuna</strong> that is part of the same tool package. In addition, these tools are not only very versatile tools that help us to manage real-time challenges - they also are excellent examples of the power and the beauty of the Python script language and its libraries. <br />
</p> +<p class="bodytext">However, before we can install and run these tools, we must learn a little bit about <strong>cyclictest</strong> and its command line arguments, since this is where oscilloscope gets its data from.
</p> +<h5>Cyclictest<br /></h5> +<p class="bodytext">Cyclictest was initially written by Thomas Gleixner as an in-house tool to investigate possible regressions while developing the RT Preempt patches. Today, it is the state-of-the-art measurement tool to determine the internal worst-case latency of a Linux real-time system. No new version of the RT Preempt patches is ever released without having run cyclictest successfully on the new kernel. The git tree that contains the cyclictest tool can be cloned
</p> +<pre>KERNELGIT=git://git.kernel.org/pub/scm/linux/kernel/git<br />git clone $KERNELGIT/clrkwllms/rt-tests.git</pre> +<p class="bodytext">but the software is also available as tarball. On an RPM package system such as Redhat Enterprise Linux or Fedora, simply type
</p> +<pre>cd rt-tests<br />make release<br />mv rt-tests-*.tar.gz releases<br />make rpm<br />rpm -Uvh RPMS/i386/rt-tests-0*.i386.rpm</pre> +<p class="bodytext">to build and install it. Mandatory arguments of cyclictest are <strong>-n</strong> (use clock_nanosleep) and <strong>-p99</strong> (RT priority) on a uniprocessor and additional <strong>-a -t</strong> (one thread per CPU each on its own processor) on a multi-processor system. If in doubt, the <strong>-m</strong> option may be used to prevent the cyclictest memory from being paged to the swap area. In order to run as many consecutive threads as possible and to achieve the highest probability to meet a latency, the thread interval (<strong>-i</strong> option) should be about twice as long as the expected worst-case latency, and the thread delay (<strong>-d</strong> option) should be set to the interval divided by the number of CPUs. Here is an example of a cyclictest run on a Core 2 Duo, 64-bit, 2.4-GHz board:<br />
</p> +<pre># cyclictest -a -t -n -p99 -i100 -d50<br />560.44 586.11 606.12 211/1160 3727<br />T: 0 (18617) P:99 I:100 C:1011846111 Min: 2 Act: 4 Avg: 5 Max: 39<br />T: 1 (18618) P:98 I:150 C: 708641019 Min: 2 Act: 5 Avg: 11 Max: 57</pre> +<p class="bodytext">The test was running on a linux-2.6.24.7-rt15 kernel in parallel with repeated loops of "hackbench 25","ls -Ral /", and flood ping from outside. After having executed more than one billion cyclictest loops, the internal worst-case latency is still only 39 µs!<br />
</p> +<h5>Tuna<br /></h5> +<p class="bodytext">The tuna tool is downloaded from the git repository and installed using the command sequence (<strong>updated</strong> on February 2, 2009):
</p> +<pre>KERNELGIT=git://git.kernel.org/pub/scm/linux/kernel/git<br />git clone $KERNELGIT/acme/python-linux-procfs.git<br />cd python-linux-procfs <br />make rpm<br />rpm -Uvh rpm/RPMS/noarch/python-linux-procfs-*.noarch.rpm<br />cd -<br /></pre> +<pre>git clone $KERNELGIT/acme/tuna.git<br />cd tuna<br />make rpm<br />rpm -Uvh rpm/RPMS/noarch/tuna-*.noarch.rpm \<br /> rpm/RPMS/noarch/oscilloscope-*.noarch.rpm</pre> +<p class="bodytext">Start tuna simply by running it in an X Window environment. Now, what can you get from tuna? <img src="http://www.osadl.org/fileadmin/newsattachments/tuna.gif" alt="See tuna in action" title="See tuna in action" style="padding: 12px; width: 300px; height: 99px; float: left;" /></a>First, the output is very similar to the output of the well-known command line tool <strong>top</strong>. In addition, tuna has a much easier interface to arrange the display, to show threads etc. - <img style="padding: 12px; width: 128px; height: 95px; float: right;" src="http://www.osadl.org/fileadmin/newsattachments/tuna-cpu-options.gif" alt="tuna's CU options" title="tuna's CU options" /></a>but most importantly, it lets you modify many process settings such as the scheduling priority and policy (click on the right mouse button while the cursor is above one of the process lines). It also has a special menu (click on the right mouse button while the cursor is above the CPU Usage frame) to include or isolate the available processors.<br />
</p> +<h5>Oscilloscope<br /></h5> +<p class="bodytext">Finally, here comes the oscilloscope tool. It uses cyclictest's special <strong>-v</strong> option that causes the data to be continuously written to standard output path so they can be evaluated by another program connected via pipe. In this case, we can only run a single thread and, unfortunately, we cannot use the <strong>-i</strong> option explained above, since the oscilloscope has only a limited capacity (will be covered later). To get a first impression, run oscilloscope with the following command:
</p> +<pre>cyclictest -t1 -n -p99 -v | oscilloscope >/dev/null<br /></pre> +<p class="bodytext">Cool, isn't it? You may even increase the number of samples on screen using the <strong>-s</strong> option such as
</p> +<pre>cyclictest -t1 -n -p99 -v | oscilloscope -s1000 >/dev/null</pre> +<p class="bodytext"><img src="http://www.osadl.org/fileadmin/newsattachments/oscilloscope.gif" alt="The GUI of the oscilloscope" title="The GUI of the oscilloscope" style="padding: 12px; width: 300px; height: 186px; float: left;" />Unfortunately, this will not capture every possible latency, since the cyclictest thread only runs once per millisecond. If we run it faster, for example by specifying <strong>-i100</strong>, our oscilloscope will be unable to follow. We have, therefore, implemented cyclictest's <strong>-o</strong> option (oscilloscope mode). This option lets cyclictest reduce the output by the given factor and write only the maximum value that occurred during the specified period of time. The command
</p> +<pre>cyclictest -t1 -n -p99 -i100 -o10 -v | oscilloscope -s1000 >/dev/null</pre> +<p class="bodytext">will then probably be able to provide a much better picture of the worst-case latency of a given system - as a disadvantage, however, the statistics given in the oscilloscope display are incorrect: The numbers no longer reflect the original raw samples but are based on preprocessed reduced data. However, since this is in any case a more pessimistic view, there is no danger that we underestimate the worst-case latency of the system.
</p> + <hr class="clearer" /> +<pre>Online Article: http://www.osadl.org/Single-View.111+M5d6d15531f8.0.html</pre> + +</div> +</div> + <!--###col3_content### end --></div> + <!--###col3### end --></div> +<!-- #col3: - Ende --> + +<!--###main### end --></div> +<!-- #main: - Ende --> + +<!-- #Footer: Beginn Fußzeile --> +<div id="footer"><!--###footer### begin --> + <table width="100%"> + <tr> + <td id="footerleft"> </td> + <td id="footercenter"> </td> + <td id="footerright"> </td> + </tr> + <tr> + <td id="subfooterleft"> </td> + <td id="last_modified">This page was last modified on 2008-01-11 - 16:15</td> + <td id="subfooterright"> </td> + </tr> + </table> + <hr class="hide" /> +<!--###footer### end --></div> +<!-- #Footer: Ende --> +<!--###page### end --></div> +<!--###page_margins### end --></div> + +</body> +</html> diff --git a/docs/oscilloscope+tuna.pdf b/docs/oscilloscope+tuna.pdf Binary files differnew file mode 100644 index 0000000..7caa61f --- /dev/null +++ b/docs/oscilloscope+tuna.pdf diff --git a/rpm/SPECS/tuna.spec b/rpm/SPECS/tuna.spec index c926997..9eb2369 100644 --- a/rpm/SPECS/tuna.spec +++ b/rpm/SPECS/tuna.spec @@ -8,6 +8,7 @@ License: GPLv2 Summary: Application tuning GUI & command line utility Group: Applications/System Source: http://userweb.kernel.org/~acme/tuna/%{name}-%{version}.tar.bz2 +URL: http://userweb.kernel.org/~acme/tuna/ BuildArch: noarch BuildRequires: python-devel Requires: python-ethtool @@ -80,8 +81,10 @@ rm -rf %{buildroot} %{python_sitelib}/tuna/ %files -n oscilloscope -%defattr(0755,root,root,0755) +%defattr(-,root,root,-) %{_bindir}/oscilloscope +%doc docs/oscilloscope+tuna.html +%doc docs/oscilloscope+tuna.pdf %changelog * Fri Jul 10 2009 Arnaldo Carvalho de Melo <acme@redhat.com> - 0.9-1 |