Documentation/4.1/Developers/Tutorials/Debug Instructions - Revision history

UpdateBot: Prepend documentation/versioncheck template. See http://na-mic.org/Mantis/view.php?id=2887

2013-06-14T07:27:26Z

Prepend documentation/versioncheck template. See http://na-mic.org/Mantis/view.php?id=2887

2012-10-05T14:21:43Z

Windows

2012-07-02T06:28:42Z

Windows

2012-06-04T17:19:26Z

Analyze a segmentation fault

2012-06-04T15:49:55Z

GDB debug by attaching to running process [RECOMMENDED]

2012-05-18T19:46:50Z

GDB debug by attaching to running process [RECOMMENDED]

2012-05-18T19:37:18Z

2012-05-17T14:58:13Z

Added link to Ubuntu 10.10+ process information

2012-05-17T13:47:42Z

Added fix for Ubuntu 10.10+ attaching to a running process

2012-05-16T20:08:58Z

GDB debug by attaching to running process

← Older revision		Revision as of 07:27, 14 June 2013
Line 1:		Line 1:
		+	<noinclude>{{documentation/versioncheck}}</noinclude>
	==Background==		==Background==
	The executable Slicer application ''Slicer-Superbuild/Slicer-build/Slicer'' (or Slicer.exe) is the [[Documentation/{{documentation/version}}/Developers/Launcher\|launcher]] of the real application binary ''Slicer-Superbuild/Slicer-build/bin/SlicerQT-real''.		The executable Slicer application ''Slicer-Superbuild/Slicer-build/Slicer'' (or Slicer.exe) is the [[Documentation/{{documentation/version}}/Developers/Launcher\|launcher]] of the real application binary ''Slicer-Superbuild/Slicer-build/bin/SlicerQT-real''.

← Older revision		Revision as of 14:21, 5 October 2012
Line 101:		Line 101:

	Note the buildlog.txt files for checking if anything went wrong.		Note the buildlog.txt files for checking if anything went wrong.
		+
		+	== Mac (Xcode) ==
		+
		+	[[image:Xcode-scheme-Screen Shot 2012-10-05 at 10.13.30 AM.png\|thumb\|right\|200px]]
		+
		+	As of slicer 4.2, we do not support building using Xcode, however if you build slicer using traditional unix Makefiles you can still debug using the powerful source debugging features of Xcode. You may need to set up a dummy project in Xcode just to enable some of the menu options.
		+
		+	You can use the Attach to Process option in the Xcode Product menu for debugging. This will allow you to get browsable stack traces for crashes.
		+
		+	To set a breakpoint in code that is not crashing, you can set it via the command line interface. For the lldb debugger, first attach to the process and break the program. Then at the (lldb) prompt, stop at a method as follows:
		+
		+	breakpoint set -M vtkMRMLScene::Clear
		+
		+	then you can single step and/or set other breakpoints in that file.
		+
		+
		+	To debug startup issues you can set up a 'Scheme' and select the Slicer.app in your Slicer-build directory (see screen shot). You can set up multiple schemes with different command line arguments and executables (for example to debug tests).
		+
		+	Also on the mac, the [http://en.wikipedia.org/wiki/Instruments_%28application%29 Instruments] tool is very useful for profiling.

	==Debugging a Test==		==Debugging a Test==

@@ Line 82: / Line 82: @@
 The launcher gets configured with a special --VisualStudio option for this purpose.
 Note that because CMake re-creates the solution file from within the build process, visual studio will sometimes need to stop and reload the project, requiring manual button pressing on your part.  To avoid this, you can use a script to kick off the build and then re-start the IDE.
@@ Line 99: / Line 101: @@
 Note the buildlog.txt files for checking if anything went wrong.
 ==Debugging a Test==
 Once VisualStudio is open with the Slicer environment loaded, it is possible to run and debug tests.

@@ Line 7: / Line 7: @@
   $ ./Slicer
   ... make it crash
-  $ ./Slicer --gdb ./bin/SlicerQT-real
+  $ ./Slicer --gdb ./bin/SlicerApp-real
   (gdb) core core
   (gdb) backtrace
   ...
 ===GDB debug with launch arguments===
 The Slicer app launcher provides options to start other programs with the Slicer environment settings.

@@ Line 27: / Line 27: @@
 ) Then, you can attach the process to <code>gdb</code> using the following command:
-  $ "gdb --pid $PIDABOVE"
+  $ gdb --pid $PIDABOVE
 If not using the <code>--attach-process</code>, the <code>PID</code> could be obtain using the following command:

@@ Line 18: / Line 18: @@
 ===GDB debug by attaching to running process [RECOMMENDED] ===
-Now, run "ps -Afww | grep SlicerApp-real" and note the PID of this binary.
+) Running Slicer with the following command line argument will allow you to easily obtain the associated PID:
-Now, run "gdb --pid $PIDABOVE"
+ $ ./Slicer --attach-process
 In Ubuntu 10.10, Ubuntu introduced a patch to disallow ptracing of non-child processes by non-root users -ie. only a process which is a parent of another process can ptrace it for normal users.
 You can temporarily disable this restriction by:

@@ Line 31: / Line 31: @@
 to read:
 *<code>kernel.yama.ptrace_scope = 0</code>
 ===GDB debug by using exec-wrapper===

← Older revision		Revision as of 13:47, 17 May 2012
Line 23:		Line 23:

	Now, run "gdb --pid $PIDABOVE"		Now, run "gdb --pid $PIDABOVE"
		+
		+	In Ubuntu 10.10, Ubuntu introduced a patch to disallow ptracing of non-child processes by non-root users -ie. only a process which is a parent of another process can ptrace it for normal users.
		+	You can temporarily disable this restriction by:
		+	$ echo 0 \| sudo tee /proc/sys/kernel/yama/ptrace_scope
		+	To permanently allow it to edit /etc/sysctl.d/10-ptrace.conf and change the line:
		+	*<code>kernel.yama.ptrace_scope = 1</code>
		+	to read:
		+	*<code>kernel.yama.ptrace_scope = 0</code>

	===GDB debug by using exec-wrapper===		===GDB debug by using exec-wrapper===

@@ Line 17: / Line 17: @@
 *<code>--gdb</code>: runs GDB then executes SlicerQT-real from within the debugger environment.
-===GDB debug by attaching to running process===
+===GDB debug by attaching to running process [RECOMMENDED] ===
 Run ./Slicer-build/Slicer