Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorElliott Baron2011-12-23 15:41:12 -0500
committerElliott Baron2011-12-23 15:41:52 -0500
commite5af7404c983ec8350a3ac2ab15173b774457347 (patch)
tree39323652309205cd005de1ae149c7bd2ee07b68d /valgrind
parent32af518c59501c776b0c29172eed23146a62f453 (diff)
downloadorg.eclipse.linuxtools-e5af7404c983ec8350a3ac2ab15173b774457347.tar.gz
org.eclipse.linuxtools-e5af7404c983ec8350a3ac2ab15173b774457347.tar.xz
org.eclipse.linuxtools-e5af7404c983ec8350a3ac2ab15173b774457347.zip
Regenerate Valgrind docs to include Helgrind.
Diffstat (limited to 'valgrind')
-rw-r--r--valgrind/org.eclipse.linuxtools.valgrind.doc/Linux_Tools_Project/Valgrind/User_Guide/Special-Cases.html8
-rw-r--r--valgrind/org.eclipse.linuxtools.valgrind.doc/Linux_Tools_Project/Valgrind/User_Guide/User-Guide.html7
-rw-r--r--valgrind/org.eclipse.linuxtools.valgrind.doc/Linux_Tools_Project/Valgrind/User_Guide/Using-Cachegrind.html8
-rw-r--r--valgrind/org.eclipse.linuxtools.valgrind.doc/Linux_Tools_Project/Valgrind/User_Guide/Using-Helgrind.html111
-rw-r--r--valgrind/org.eclipse.linuxtools.valgrind.doc/Linux_Tools_Project/Valgrind/User_Guide/Using-Massif.html2
-rw-r--r--valgrind/org.eclipse.linuxtools.valgrind.doc/Linux_Tools_Project/Valgrind/User_Guide/images/HelgrindOptions2.pngbin0 -> 9425 bytes
-rw-r--r--valgrind/org.eclipse.linuxtools.valgrind.doc/Linux_Tools_Project/Valgrind/User_Guide/images/HelgrindOutput.pngbin0 -> 56222 bytes
-rw-r--r--valgrind/org.eclipse.linuxtools.valgrind.doc/build-helper.xml6
-rw-r--r--valgrind/org.eclipse.linuxtools.valgrind.doc/toc.xml4
9 files changed, 131 insertions, 15 deletions
diff --git a/valgrind/org.eclipse.linuxtools.valgrind.doc/Linux_Tools_Project/Valgrind/User_Guide/Special-Cases.html b/valgrind/org.eclipse.linuxtools.valgrind.doc/Linux_Tools_Project/Valgrind/User_Guide/Special-Cases.html
index c02c4e4859..c12ec0cca2 100644
--- a/valgrind/org.eclipse.linuxtools.valgrind.doc/Linux_Tools_Project/Valgrind/User_Guide/Special-Cases.html
+++ b/valgrind/org.eclipse.linuxtools.valgrind.doc/Linux_Tools_Project/Valgrind/User_Guide/Special-Cases.html
@@ -12,7 +12,7 @@
</tr>
<tr>
<td style="width: 20%" align="left">
- <a href="Using-Cachegrind.html" title="Using Cachegrind">
+ <a href="Using-Helgrind.html" title="Using Helgrind">
<img alt="Previous" border="0" src="../../../images/prev.gif"/>
</a>
</td>
@@ -24,7 +24,7 @@
</td>
</tr>
<tr>
- <td style="width: 20%" align="left" valign="top">Using Cachegrind</td>
+ <td style="width: 20%" align="left" valign="top">Using Helgrind</td>
<td style="width: 60%" align="center"></td>
<td style="width: 20%" align="right" valign="top">Updating This Document</td>
</tr>
@@ -59,7 +59,7 @@
<table class="navigation" style="width: 100%;" border="0" summary="navigation">
<tr>
<td style="width: 20%" align="left">
- <a href="Using-Cachegrind.html" title="Using Cachegrind">
+ <a href="Using-Helgrind.html" title="Using Helgrind">
<img alt="Previous" border="0" src="../../../images/prev.gif"/>
</a>
</td>
@@ -75,7 +75,7 @@
</td>
</tr>
<tr>
- <td style="width: 20%" align="left" valign="top">Using Cachegrind</td>
+ <td style="width: 20%" align="left" valign="top">Using Helgrind</td>
<td style="width: 60%" align="center"></td>
<td style="width: 20%" align="right" valign="top">Updating This Document</td>
</tr>
diff --git a/valgrind/org.eclipse.linuxtools.valgrind.doc/Linux_Tools_Project/Valgrind/User_Guide/User-Guide.html b/valgrind/org.eclipse.linuxtools.valgrind.doc/Linux_Tools_Project/Valgrind/User_Guide/User-Guide.html
index f4d54eb892..a0c76b2e84 100644
--- a/valgrind/org.eclipse.linuxtools.valgrind.doc/Linux_Tools_Project/Valgrind/User_Guide/User-Guide.html
+++ b/valgrind/org.eclipse.linuxtools.valgrind.doc/Linux_Tools_Project/Valgrind/User_Guide/User-Guide.html
@@ -29,10 +29,11 @@
<p>
<b>Valgrind</b> is an instrumentation framework for building dynamic analysis tools that can be used to profile applications in detail. Valgrind tools are generally used to automatically detect many memory management and threading problems. The Valgrind suite also includes tools that allow you to build new profiling tools to suit your needs.
</p>
- <p>The Valgrind plug-in for Eclipse (documented herein) integrates several Valgrind tools into Eclipse. This allows Eclipse users to seamlessly include profiling capabilities into their workflow. At present, the Valgrind plug-in for Eclipse supports three Valgrind tools:
+ <p>The Valgrind plug-in for Eclipse (documented herein) integrates several Valgrind tools into Eclipse. This allows Eclipse users to seamlessly include profiling capabilities into their workflow. At present, the Valgrind plug-in for Eclipse supports four Valgrind tools:
<a href="Using-Memcheck.html#Using_Memcheck">Memcheck</a>,
- <a href="Using-Massif.html#Using_Massif">Massif</a>, and
- <a href="Using-Cachegrind.html#Using_Cachegrind">Cachegrind</a>.
+ <a href="Using-Massif.html#Using_Massif">Massif</a>,
+ <a href="Using-Cachegrind.html#Using_Cachegrind">Cachegrind</a> and
+ <a href="Using-Helgrind.html#Using_Helgrind">Helgrind</a>.
</p>
<p>For more information about Valgrind, refer to
<a href="http://www.valgrind.org/">http://www.valgrind.org/</a>.
diff --git a/valgrind/org.eclipse.linuxtools.valgrind.doc/Linux_Tools_Project/Valgrind/User_Guide/Using-Cachegrind.html b/valgrind/org.eclipse.linuxtools.valgrind.doc/Linux_Tools_Project/Valgrind/User_Guide/Using-Cachegrind.html
index 93031377a2..bea0991b15 100644
--- a/valgrind/org.eclipse.linuxtools.valgrind.doc/Linux_Tools_Project/Valgrind/User_Guide/Using-Cachegrind.html
+++ b/valgrind/org.eclipse.linuxtools.valgrind.doc/Linux_Tools_Project/Valgrind/User_Guide/Using-Cachegrind.html
@@ -18,7 +18,7 @@
</td>
<td style="width: 60%" align="center"></td>
<td style="width: 20%" align="right">
- <a href="Special-Cases.html" title="Special Cases">
+ <a href="Using-Helgrind.html" title="Using Helgrind">
<img alt="Next" border="0" src="../../../images/next.gif"/>
</a>
</td>
@@ -26,7 +26,7 @@
<tr>
<td style="width: 20%" align="left" valign="top">Using Massif</td>
<td style="width: 60%" align="center"></td>
- <td style="width: 20%" align="right" valign="top">Special Cases</td>
+ <td style="width: 20%" align="right" valign="top">Using Helgrind</td>
</tr>
</table><hr/>
<h1 id="Using_Cachegrind">Using Cachegrind</h1>
@@ -119,7 +119,7 @@
</a>
</td>
<td style="width: 20%" align="right">
- <a href="Special-Cases.html" title="Special Cases">
+ <a href="Using-Helgrind.html" title="Using Helgrind">
<img alt="Next" border="0" src="../../../images/next.gif"/>
</a>
</td>
@@ -127,7 +127,7 @@
<tr>
<td style="width: 20%" align="left" valign="top">Using Massif</td>
<td style="width: 60%" align="center"></td>
- <td style="width: 20%" align="right" valign="top">Special Cases</td>
+ <td style="width: 20%" align="right" valign="top">Using Helgrind</td>
</tr>
</table>
</body>
diff --git a/valgrind/org.eclipse.linuxtools.valgrind.doc/Linux_Tools_Project/Valgrind/User_Guide/Using-Helgrind.html b/valgrind/org.eclipse.linuxtools.valgrind.doc/Linux_Tools_Project/Valgrind/User_Guide/Using-Helgrind.html
new file mode 100644
index 0000000000..1879510f5b
--- /dev/null
+++ b/valgrind/org.eclipse.linuxtools.valgrind.doc/Linux_Tools_Project/Valgrind/User_Guide/Using-Helgrind.html
@@ -0,0 +1,111 @@
+<?xml version='1.0' encoding='utf-8' ?><!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">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
+ <title>Valgrind User Guide - Using Helgrind</title>
+ <link type="text/css" rel="stylesheet" href="../../../book.css"/>
+ </head>
+ <body>
+ <table class="navigation" style="width: 100%;" border="0" summary="navigation">
+ <tr>
+ <th style="width: 100%" align="center" colspan="3">Using Helgrind</th>
+ </tr>
+ <tr>
+ <td style="width: 20%" align="left">
+ <a href="Using-Cachegrind.html" title="Using Cachegrind">
+ <img alt="Previous" border="0" src="../../../images/prev.gif"/>
+ </a>
+ </td>
+ <td style="width: 60%" align="center"></td>
+ <td style="width: 20%" align="right">
+ <a href="Special-Cases.html" title="Special Cases">
+ <img alt="Next" border="0" src="../../../images/next.gif"/>
+ </a>
+ </td>
+ </tr>
+ <tr>
+ <td style="width: 20%" align="left" valign="top">Using Cachegrind</td>
+ <td style="width: 60%" align="center"></td>
+ <td style="width: 20%" align="right" valign="top">Special Cases</td>
+ </tr>
+ </table><hr/>
+ <h1 id="Using_Helgrind">Using Helgrind</h1>
+ <p>Helgrind is a tool that allows you to detect synchronisation errors in C, C++ and Fortran programs that use POSIX pthreads. For more information about Helgrind, refer to
+ <a href="http://valgrind.org/docs/manual/hg-manual.html">http://valgrind.org/docs/manual/hg-manual.html</a>.
+ </p>
+ <h2 id="Analyzing_Helgrind_Profile_Results">Analyzing Helgrind Profile Results</h2>
+ <p>All the synchronization errors found by Helgrind are displayed in the Valgrind view, which appears automatically after a profile run. Each displayed error can be expanded in the Valgrind view to display its stack trace.</p>
+ <p>
+ <br/>
+ <img border="0" src="images/HelgrindOutput.png"/>
+ </p>
+ <p>In some cases, Helgrind can determine which section of the source code causes a reported error. Whenever this is the case, double-clicking on the stack trace of the reported error will open the related source file and place the cursor on the line responsible for the error. This stack trace view is similar to the view that the Memcheck plug-in provides. </p>
+ <h2 id="Configuring_a_Helgrind_Profile_Run">Configuring a Helgrind Profile Run</h2>
+ <p>To configure a Helgrind profile run, navigate to <u>Profile As</u> &gt; <u>Profile Configurations</u> to access the
+ <b>
+ <i>Profile Configurations</i>
+ </b> menu. In the
+ <b>
+ <i>Valgrind Options</i>
+ </b> tab, navigate further to
+ <b>
+ <i>Helgrind Options</i>
+ </b>.
+ </p>
+ <p>
+ <br/>
+ <img border="0" src="images/HelgrindOptions2.png"/>
+ </p>
+ <p>The
+ <b>
+ <i>Helgrind Options</i>
+ </b> tab allows you to configure the following options:
+ </p>
+ <ul>
+ <li>
+ <b>
+ <i>track lockorders</i>
+ </b> : when enabled, allows Helgrind to perform lock order consistency checking.
+ </li>
+ </ul>
+ <ul>
+ <li>
+ <b>
+ <i>history level</i>
+ </b> defines how much information Helgrind will collect about earlier conflict accesses which can cause data races. This setting has three possible values - full, none and approx - where "full" means that Helgrind will collect and store any possible data, which is expensive in memory and speed; "none" means that no information about previous accesses will be collected; "approx" is a compromise between these two previous settings.
+ </li>
+ </ul>
+ <ul>
+ <li>
+ <b>
+ <i>conflict cache size</i>
+ </b> is a setting which only has an effect with history-level=full. It controls the size of the memory cache used by Helgrind to store previous conflicting accesses. Increasing the value by 1 means increasing Helgrind's memory requirement by 100 bytes.
+ </li>
+ </ul>
+ <p>For more information about each Helgrind option in the Valgrind plug-in for Eclipse, refer to man valgrind, section "HELGRIND OPTIONS".</p><hr/>
+ <table class="navigation" style="width: 100%;" border="0" summary="navigation">
+ <tr>
+ <td style="width: 20%" align="left">
+ <a href="Using-Cachegrind.html" title="Using Cachegrind">
+ <img alt="Previous" border="0" src="../../../images/prev.gif"/>
+ </a>
+ </td>
+ <td style="width: 60%" align="center">
+ <a href="User-Guide.html" title="Valgrind User Guide">
+ <img alt="Valgrind User Guide" border="0" src="../../../images/home.gif"/>
+ </a>
+ </td>
+ <td style="width: 20%" align="right">
+ <a href="Special-Cases.html" title="Special Cases">
+ <img alt="Next" border="0" src="../../../images/next.gif"/>
+ </a>
+ </td>
+ </tr>
+ <tr>
+ <td style="width: 20%" align="left" valign="top">Using Cachegrind</td>
+ <td style="width: 60%" align="center"></td>
+ <td style="width: 20%" align="right" valign="top">Special Cases</td>
+ </tr>
+ </table>
+ </body>
+</html> \ No newline at end of file
diff --git a/valgrind/org.eclipse.linuxtools.valgrind.doc/Linux_Tools_Project/Valgrind/User_Guide/Using-Massif.html b/valgrind/org.eclipse.linuxtools.valgrind.doc/Linux_Tools_Project/Valgrind/User_Guide/Using-Massif.html
index f71bc01533..731fc37335 100644
--- a/valgrind/org.eclipse.linuxtools.valgrind.doc/Linux_Tools_Project/Valgrind/User_Guide/Using-Massif.html
+++ b/valgrind/org.eclipse.linuxtools.valgrind.doc/Linux_Tools_Project/Valgrind/User_Guide/Using-Massif.html
@@ -57,7 +57,7 @@
<ul>
<li>
<b>Heap Tree</b>. Detailed snapshots are denoted by the <u>Show Heap Tree</u> icon (
- <img border="0" src="images/hierarchy.gif"/> ). Double-clicking any of these snapshots will modify the Valgrind view to display all detailed snapshots. Collapsing each detailed snapshot in this view will display a heirarchy of function calls (i.e. heap tree) detailing the heap allocations used during the snapshot.
+ <img border="0" src="images/Hierarchy.gif"/> ). Double-clicking any of these snapshots will modify the Valgrind view to display all detailed snapshots. Collapsing each detailed snapshot in this view will display a heirarchy of function calls (i.e. heap tree) detailing the heap allocations used during the snapshot.
<br/>
<img border="0" src="images/MassifTree.png"/>
<br/>Some functions within the heap tree list a related source file. Double-clicking these functions will open the listed source file and place the insertion point on the specific function responsible for the call.
diff --git a/valgrind/org.eclipse.linuxtools.valgrind.doc/Linux_Tools_Project/Valgrind/User_Guide/images/HelgrindOptions2.png b/valgrind/org.eclipse.linuxtools.valgrind.doc/Linux_Tools_Project/Valgrind/User_Guide/images/HelgrindOptions2.png
new file mode 100644
index 0000000000..8273268a1b
--- /dev/null
+++ b/valgrind/org.eclipse.linuxtools.valgrind.doc/Linux_Tools_Project/Valgrind/User_Guide/images/HelgrindOptions2.png
Binary files differ
diff --git a/valgrind/org.eclipse.linuxtools.valgrind.doc/Linux_Tools_Project/Valgrind/User_Guide/images/HelgrindOutput.png b/valgrind/org.eclipse.linuxtools.valgrind.doc/Linux_Tools_Project/Valgrind/User_Guide/images/HelgrindOutput.png
new file mode 100644
index 0000000000..f4524b8b1d
--- /dev/null
+++ b/valgrind/org.eclipse.linuxtools.valgrind.doc/Linux_Tools_Project/Valgrind/User_Guide/images/HelgrindOutput.png
Binary files differ
diff --git a/valgrind/org.eclipse.linuxtools.valgrind.doc/build-helper.xml b/valgrind/org.eclipse.linuxtools.valgrind.doc/build-helper.xml
index 9c78cb0049..a506044da0 100644
--- a/valgrind/org.eclipse.linuxtools.valgrind.doc/build-helper.xml
+++ b/valgrind/org.eclipse.linuxtools.valgrind.doc/build-helper.xml
@@ -8,16 +8,16 @@
<path id="wikitext.tasks.classpath">
<!-- Replace dir with the dir you have wikitext installed into.-->
- <fileset dir="/usr/share/eclipse/dropins/mylyn-wikitext/eclipse/plugins">
+ <fileset dir="/home/elliott/Downloads/eclipse-4.2M4/plugins">
<include name="org.eclipse.mylyn.wikitext.*core*.jar" />
</fileset>
</path>
- <taskdef classpathref="wikitext.tasks.classpath" resource="org/eclipse/mylyn/internal/wikitext/mediawiki/core/tasks/tasks.properties" />
<taskdef classpathref="wikitext.tasks.classpath" resource="org/eclipse/mylyn/wikitext/core/util/anttask/tasks.properties" />
+ <taskdef classpathref="wikitext.tasks.classpath" resource="org/eclipse/mylyn/internal/wikitext/mediawiki/core/tasks/tasks.properties" />
<target name="all" description="Generate Eclipse help content for the Linux Tools Valgrind user guide">
- <mediawiki-to-eclipse-help wikiBaseUrl="${help.doc.url.base}" title="Valgrind User Guide" formatoutput="true" dest="." templateExcludes="*eclipseproject*">
+ <mediawiki-to-eclipse-help wikiBaseUrl="${help.doc.url.base}" title="Valgrind User Guide" formatoutput="true" dest="." templateExcludes="*eclipseproject*, Infobox">
<path name="Linux_Tools_Project/Valgrind/User_Guide" title="Valgrind User Guide" generateToc="false" />
<stylesheet url="book.css" />
diff --git a/valgrind/org.eclipse.linuxtools.valgrind.doc/toc.xml b/valgrind/org.eclipse.linuxtools.valgrind.doc/toc.xml
index 63e8b29c95..3bb6786889 100644
--- a/valgrind/org.eclipse.linuxtools.valgrind.doc/toc.xml
+++ b/valgrind/org.eclipse.linuxtools.valgrind.doc/toc.xml
@@ -27,6 +27,10 @@
<topic href="Linux_Tools_Project/Valgrind/User_Guide/Using-Cachegrind.html#Analyzing_Cachegrind_Profile_Results" label="Analyzing Cachegrind Profile Results"></topic>
<topic href="Linux_Tools_Project/Valgrind/User_Guide/Using-Cachegrind.html#Configuring_a_Cachegrind_Profile_Run" label="Configuring a Cachegrind Profile Run"></topic>
</topic>
+ <topic href="Linux_Tools_Project/Valgrind/User_Guide/Using-Helgrind.html" label="Using Helgrind">
+ <topic href="Linux_Tools_Project/Valgrind/User_Guide/Using-Helgrind.html#Analyzing_Helgrind_Profile_Results" label="Analyzing Helgrind Profile Results"></topic>
+ <topic href="Linux_Tools_Project/Valgrind/User_Guide/Using-Helgrind.html#Configuring_a_Helgrind_Profile_Run" label="Configuring a Helgrind Profile Run"></topic>
+ </topic>
<topic href="Linux_Tools_Project/Valgrind/User_Guide/Special-Cases.html" label="Special Cases">
<topic href="Linux_Tools_Project/Valgrind/User_Guide/Special-Cases.html#Encountering_Errors" label="Encountering Errors"></topic>
<topic href="Linux_Tools_Project/Valgrind/User_Guide/Special-Cases.html#Profiling_Child_Processes" label="Profiling Child Processes"></topic>

Back to the top