Slicer3:Performance Analysis - Revision history

Grundlett: Text replacement - "http://www.slicer.org/slicerWiki/index.php/" to "https://www.slicer.org/wiki/"

2017-07-10T18:07:39Z

Text replacement - "http://www.slicer.org/slicerWiki/index.php/" to "https://www.slicer.org/wiki/"

Marianna: Protected "Slicer3:Performance Analysis" [edit=sysop:move=sysop]

2008-05-22T15:05:19Z

Protected "Slicer3:Performance Analysis" [edit=sysop:move=sysop]

Marianna: Unprotected "Slicer3:Performance Analysis"

2008-05-19T22:17:03Z

Unprotected "Slicer3:Performance Analysis"

Marianna: Replacing page with ''''Note:''' We are migrating this content to the slicer.org domain - The newer page is [http://www.slicer.org/slicerWiki/index.php/Slicer3:Performance...'

2008-05-19T22:16:54Z

Replacing page with '<big>'''Note:''' We are migrating this content to the slicer.org domain - <font color="orange">The newer page is [http://www.slicer.org/slicerWiki/index.php/Slicer3:Performance...'

Pieper: /* Quantify Info */

2007-05-21T22:45:44Z

Quantify Info

Hayes: /* Callgrind / KCachegrind */

2007-03-13T17:01:35Z

Callgrind / KCachegrind

Hayes at 19:40, 12 March 2007

2007-03-12T19:40:42Z

Pieper: /* Quantify Info */

2007-02-08T18:02:49Z

Quantify Info

Pieper: /* Quantify Info */

2007-02-08T17:38:59Z

Quantify Info

Pieper: /* Sample Files */

2007-02-08T16:14:17Z

Sample Files

← Older revision		Revision as of 18:07, 10 July 2017
Line 1:		Line 1:
−	<big>'''Note:''' We are migrating this content to the slicer.org domain - <font color="orange">The newer page is [~~http~~://www.slicer.org/~~slicerWiki/index.php~~/Slicer3:Performance_Analysis here]</font></big>	+	<big>'''Note:''' We are migrating this content to the slicer.org domain - <font color="orange">The newer page is [https://www.slicer.org/wiki/Slicer3:Performance_Analysis here]</font></big>

← Older revision		Revision as of 22:16, 19 May 2008
Line 1:		Line 1:
−	~~{\| class="toccolours" style="margin-right: 25px" align="right"~~	+	<big>'''Note:''' We are migrating this content to the slicer.org domain - <font color="orange">The newer page is [http://www.slicer.org/slicerWiki/index.php/Slicer3:Performance_Analysis here]</font></big>
−	~~! bgcolor="#ccccff" align="center" \| Slicer3~~
−	\|-
−	\|
−	~~[[Slicer3\|Home]]~~
−	\|-
−	\|
−	~~[[Slicer3:About\|About]]~~
−	\|-
−	\|
−	~~[[Slicer3:FAQ\|FAQ]]~~
−	\|-
−	\|
−	~~[[Slicer3:Status\|Status]]~~
−	\|-
−	\|
−	~~[[Slicer3:Downloads\|Downloads]]~~
−	\|-
−	\|
−	~~[[Slicer3:Documentation\|Documentation]]~~
−	\|-
−	\|
−	~~[[Slicer3:Community_Support\|Community Support]]~~
−	\|-
−	\|
−	~~[[Slicer3:Developers\|Developers]]~~
−	\|-
−	\|
−	~~[[Slicer3:Acknowledgements\|Acknowledgements]]~~
−	\|-
−	\|
−	~~[[Slicer3:Links\|Links]]~~
−	\|}
−
−	~~== Slicer 3 Performance Analysis ==~~
−
−	We are looking into performance analysis on the Slicer3 codebase in order to streamline execution where possible, identify parts of the program to optimize, and determine which parts of Slicer3 are using the most system resources. We are currently in the process of determining which profilers to use on the various Slicer platforms.
−
−	~~== Tools ==~~
−
−	~~=== Statistical Profilers ===~~
−
−	* [http://www.cs.utah.edu/dept/old/texinfo/as/gprof_toc.html GNU gprof]
−	** gprof is not a good profiler for our needs because it doesn't support profiling multithreaded code.
−	* [http://oprofile.sourceforge.net/ oprofile]
−	* [http://developer.apple.com/tools/sharkoptimize.html Shark 4 (OSX)]
−
−	~~=== Profilers for Multi-threaded Applications ===~~
−
−	* See the pages on [[ITK Registration Optimization]]
−
−	~~=== Runtime Instrumentation ===~~
−
−	* [http://kcachegrind.sourceforge.net/cgi-bin/show.cgi Callgrind / KcacheGrind]
−
−	An initial [http://www.na-mic.org:8000/websvn/filedetails.php?repname=Slicer3&path=%2Ftrunk%2FCMake%2FSlicer3ValgrindSuppressions.supp&rev=0&sc=0 valgrind suppressions file for slicer] is in subversion. It includes an example command line to run it with slicer that also uses the VTK, ITK, KWWidgets suppression files.
−
−	~~=== Sample Usage ===~~
−
−	~~===== Callgrind / KCachegrind =====~~
−
−	~~The most basic way to run callgrind is to just run it with your program as an argument, like this:~~
−
−	~~callgrind ./myProgram~~
−
−	~~This will produce a file in the directory which you ran callgrind from named callgrind.out.~~<~~pid~~> where <pid> is the process ID of the program that you ran. You can either look at this file itself, or load it into KCachegrind, which is a graphical viewer for profile data. You can run KCachegrind by typing:
−
−	~~kcachegrind~~
−
−	and the graphical user interface will open. You can then either open your callgrind.out file, or if you started KCachegrind from the same directory as your callgrind.out file, it should open it automatically for you.
−
−	~~This will produce a ton of data to sift through. If you are only interested in a particular block of code, you can restrict callgrind to only profile a specific section of code. There~~ are ~~two ways to do~~ this~~. The first way is~~ to ~~pass~~ the ~~function name you're interested in to callgrind, e~~.~~g.:~~
−
−	~~callgrind~~ -~~-toggle-collect~~="~~myFunctionName()~~"
−
−	The ~~second way to do this~~ is to use the CALLGRIND_TOGGLE_COLLECT macros in your code. To do this, you need to include valgrind/callgrind.h, and put CALLGRIND_TOGGLE_COLLECT before and after the block of code you're interested in. Callgrind also has a feature where you can delay starting the instrumentation until just before you start collecting data, which will make things run a lot faster. If you were interested in profiling the function 'foo()', you would need something like this:
−
−	~~#include "valgrind/callgrind.h"~~
−	~~CALLGRIND_START_INSTRUMENTATION();~~
−	~~CALLGRIND_TOGGLE_COLLECT();~~
−	~~// the code I want to profile~~
−	~~foo();~~
−	~~CALLGRIND_TOGGLE_COLLECT();~~
−	~~CALLGRIND_STOP_INSTRUMENTATION();~~
−
−	~~After you insert the code, recompile, and run callgrind with these flags:~~
−
−	~~callgrind --collect-atstart=no --instr-atstart=no ./myProgram~~
−
−	~~== Targets ==~~
−
−	* DICOM reader / GDCM
−	* vtkITK
−	* ImageReslice
−	* ITK resampler w/ deformable transform
−
−	~~== Sample Files ==~~
−	~~oprofile:~~
−	* [[Slicer3:Performance_Analysis/Sample1\|oprofile; run Slicer3 and exit]]
−	* [[Slicer3:Performance_Analysis/Sample2\|oprofile; run Slicer3, load DICOM, exit]]
−
−	~~KCachegrind:~~
−
−	* [http://www.~~na-mic~~.org/~~Wiki/images/6/65~~/~~Kcache1~~.~~png KCachegrind; run Slicer3, load DICOM, exit]~~
−	* [http://~~www.na-mic.org/Wiki/images/7/7a/Kcache2.png KCachegrind; run~~ Slicer3~~, load DICOM, exit]~~
−
−	~~== Quantify Info ==~~
−
−	~~Note~~: ~~this is not yet working.~~ ~~For me, it crashes trying to load.~~
−
−	~~An evaluation copy of Rational PurifyPlus is available from www.ibm.com.~~
−
−	~~To use this on windows, follow the install info then be sure to do the following:~~
−	* Turn off incremental linking in CMake
−	** in the CMAKE_EXE_LINKER_FLAGS and CMAKE_MODULE_LINKER_FLAGS
−	*** change /INCREMENTAL:YES to /INCREMENTAL:NO
−	*** add /fixed:NO
−	* rebuild Slicer3-real.exe
−	* create a shell with the slicer3 environment set
−	** e.g. source Slicer3-build/bin/Debug/Slicer3SetupPaths.sh
−	* in that shell, run
−	** Quantify: c:/Program\ Files/Rational/purifyplus/quantifyw.exe
−	** Purify: c:/~~Program Files/Rational/purifyplus/purifyw.exe~~
−
−	~~== Debugger Based Profiling ==~~
−
−	Here's a simple Visual Studio macro that creates a text box showing every function visited for a particular line of code. That is, if you stop the program right before it executes something like a call to Modified, this will show you every line of code that is visited when executing this code.
−
−	~~' This macro single steps to the next line~~
−	~~Sub SingleStepToNextLine()~~
−	~~Dim bppane As EnvDTE.OutputWindowPane~~
−	~~bppane = Utilities.GetOutputWindowPane("Debugger")~~
−	~~Dim line As String~~
−	~~Dim lastLine As String~~
−	~~Dim thisLine As String~~
−	~~line = DTE.Debugger.CurrentStackFrame.FunctionName~~
−	~~lastLine = line~~
−	~~DTE.Debugger.StepInto()~~
−	~~While DTE.Debugger.CurrentStackFrame.FunctionName <~~> ~~line~~
−	~~thisLine = DTE.Debugger.CurrentStackFrame.FunctionName~~
−	~~If thisLine~~ <> ~~lastLine Then~~
−	~~lastLine = thisLine~~
−	~~bppane.OutputString(thisLine + vbCrLf)~~
−	~~End If~~
−	~~DTE.Debugger.StepInto()~~
−	~~End While~~
−	~~End Sub~~

← Older revision		Revision as of 22:45, 21 May 2007
Line 122:		Line 122:
	** Quantify: c:/Program\ Files/Rational/purifyplus/quantifyw.exe		** Quantify: c:/Program\ Files/Rational/purifyplus/quantifyw.exe
	** Purify: c:/Program Files/Rational/purifyplus/purifyw.exe		** Purify: c:/Program Files/Rational/purifyplus/purifyw.exe
		+
		+	== Debugger Based Profiling ==
		+
		+	Here's a simple Visual Studio macro that creates a text box showing every function visited for a particular line of code. That is, if you stop the program right before it executes something like a call to Modified, this will show you every line of code that is visited when executing this code.
		+
		+	' This macro single steps to the next line
		+	Sub SingleStepToNextLine()
		+	Dim bppane As EnvDTE.OutputWindowPane
		+	bppane = Utilities.GetOutputWindowPane("Debugger")
		+	Dim line As String
		+	Dim lastLine As String
		+	Dim thisLine As String
		+	line = DTE.Debugger.CurrentStackFrame.FunctionName
		+	lastLine = line
		+	DTE.Debugger.StepInto()
		+	While DTE.Debugger.CurrentStackFrame.FunctionName <> line
		+	thisLine = DTE.Debugger.CurrentStackFrame.FunctionName
		+	If thisLine <> lastLine Then
		+	lastLine = thisLine
		+	bppane.OutputString(thisLine + vbCrLf)
		+	End If
		+	DTE.Debugger.StepInto()
		+	End While
		+	End Sub

@@ Line 82: / Line 82: @@
   foo();
   CALLGRIND_TOGGLE_COLLECT();
-  CALLGRIND_START_INSTRUMENTATION();
+  CALLGRIND_STOP_INSTRUMENTATION();
 After you insert the code, recompile, and run callgrind with these flags:

← Older revision		Revision as of 19:40, 12 March 2007
Line 55:		Line 55:

	An initial [http://www.na-mic.org:8000/websvn/filedetails.php?repname=Slicer3&path=%2Ftrunk%2FCMake%2FSlicer3ValgrindSuppressions.supp&rev=0&sc=0 valgrind suppressions file for slicer] is in subversion. It includes an example command line to run it with slicer that also uses the VTK, ITK, KWWidgets suppression files.		An initial [http://www.na-mic.org:8000/websvn/filedetails.php?repname=Slicer3&path=%2Ftrunk%2FCMake%2FSlicer3ValgrindSuppressions.supp&rev=0&sc=0 valgrind suppressions file for slicer] is in subversion. It includes an example command line to run it with slicer that also uses the VTK, ITK, KWWidgets suppression files.
		+
		+	=== Sample Usage ===
		+
		+	===== Callgrind / KCachegrind =====
		+
		+	The most basic way to run callgrind is to just run it with your program as an argument, like this:
		+
		+	callgrind ./myProgram
		+
		+	This will produce a file in the directory which you ran callgrind from named callgrind.out.<pid> where <pid> is the process ID of the program that you ran. You can either look at this file itself, or load it into KCachegrind, which is a graphical viewer for profile data. You can run KCachegrind by typing:
		+
		+	kcachegrind
		+
		+	and the graphical user interface will open. You can then either open your callgrind.out file, or if you started KCachegrind from the same directory as your callgrind.out file, it should open it automatically for you.
		+
		+	This will produce a ton of data to sift through. If you are only interested in a particular block of code, you can restrict callgrind to only profile a specific section of code. There are two ways to do this. The first way is to pass the function name you're interested in to callgrind, e.g.:
		+
		+	callgrind --toggle-collect="myFunctionName()"
		+
		+	The second way to do this is to use the CALLGRIND_TOGGLE_COLLECT macros in your code. To do this, you need to include valgrind/callgrind.h, and put CALLGRIND_TOGGLE_COLLECT before and after the block of code you're interested in. Callgrind also has a feature where you can delay starting the instrumentation until just before you start collecting data, which will make things run a lot faster. If you were interested in profiling the function 'foo()', you would need something like this:
		+
		+	#include "valgrind/callgrind.h"
		+	CALLGRIND_START_INSTRUMENTATION();
		+	CALLGRIND_TOGGLE_COLLECT();
		+	// the code I want to profile
		+	foo();
		+	CALLGRIND_TOGGLE_COLLECT();
		+	CALLGRIND_START_INSTRUMENTATION();
		+
		+	After you insert the code, recompile, and run callgrind with these flags:
		+
		+	callgrind --collect-atstart=no --instr-atstart=no ./myProgram

	== Targets ==		== Targets ==

← Older revision	Revision as of 15:05, 22 May 2008
(No difference)

← Older revision	Revision as of 22:17, 19 May 2008
(No difference)

@@ Line 75: / Line 75: @@
 == Quantify Info ==
-Note: this is not yet working.  For me, it dies trying to instrument KWWidgets.dll
+Note: this is not yet working.  For me, it crashes trying to load.
 An evaluation copy of Rational PurifyPlus is available from www.ibm.com.

@@ Line 81: / Line 81: @@
 To use this on windows, follow the install info then be sure to do the following:
 * Turn off incremental linking in CMake
-** in the CMAKE_EXE_LINKER_FLAGS
+** in the CMAKE_EXE_LINKER_FLAGS and CMAKE_MODULE_LINKER_FLAGS
 *** change /INCREMENTAL:YES to /INCREMENTAL:NO
 *** add /fixed:NO

← Older revision		Revision as of 16:14, 8 February 2007
Line 72:		Line 72:
	* [http://www.na-mic.org/Wiki/images/6/65/Kcache1.png KCachegrind; run Slicer3, load DICOM, exit]		* [http://www.na-mic.org/Wiki/images/6/65/Kcache1.png KCachegrind; run Slicer3, load DICOM, exit]
	* [http://www.na-mic.org/Wiki/images/7/7a/Kcache2.png KCachegrind; run Slicer3, load DICOM, exit]		* [http://www.na-mic.org/Wiki/images/7/7a/Kcache2.png KCachegrind; run Slicer3, load DICOM, exit]
		+
		+	== Quantify Info ==
		+
		+	Note: this is not yet working. For me, it dies trying to instrument KWWidgets.dll
		+
		+	An evaluation copy of Rational PurifyPlus is available from www.ibm.com.
		+
		+	To use this on windows, follow the install info then be sure to do the following:
		+	* Turn off incremental linking in CMake
		+	** in the CMAKE_EXE_LINKER_FLAGS
		+	*** change /INCREMENTAL:YES to /INCREMENTAL:NO
		+	*** add /fixed:NO
		+	* rebuild Slicer3-real.exe
		+	* create a shell with the slicer3 environment set
		+	** e.g. source Slicer3-build/bin/Debug/Slicer3SetupPaths.sh
		+	* in that shell, run
		+	** Quantify: c:/Program\ Files/Rational/purifyplus/quantifyw.exe
		+	** Purify: c:/Program Files/Rational/purifyplus/purifyw.exe