How to get a stacktrace with WinDbg

  • Revision slug: How_to_get_a_stacktrace_with_WinDbg
  • Revision title: How to get a stacktrace with WinDbg
  • Revision id: 339795
  • Created:
  • Creator: ethertank
  • Is current revision? No
  • Comment CleanUp, id.

Revision Content

Introduction

Sometimes you need to get a stacktrace (call stack) for a crash or hang but Talkback or Breakpad fail because it's a special crasher or a hang. This article describes how to get a stacktrace in those cases with WinDbg on Windows. (To get a stacktrace for Thunderbird or some other product, substitute the product name where ever you see Firefox in this instructions.)

Requirements

To get such a stacktrace you need to install the following software:

Debugging Tools for Windows

Microsoft distributes the Debugging Tools for Windows for free, those include WinDbg which you will need here. Download it from Install Debugging Tools for Windows 32-bit Version . (You'll want the 32-bit version, even if you are using a 64-bit version of Windows) Then install it, the standard settings in the installation process are fine.

A Firefox nightly or release

You need a Firefox version for which symbols are availables from the Mozilla symbol server to use with WinDbg. You can use any official nightly build or released version of Firefox from Mozilla. You can find the latest trunk nightly builds under http://ftp.mozilla.org/pub/mozilla.o.../latest-trunk/.

Debugging

To begin debugging, ensure that Firefox is not already running and open WinDbg from the Start menu. (Start->All Programs->Debugging Tools for Windows->WinDbg) Next, open the "File" menu and choose "Open Executable...". In the file chooser window that appears, open the firefox.exe executable in your Firefox program folder (C:\Program Files\Mozilla Firefox).

You should now see a "Command" text window with debug output at the top and an input box at the bottom. Before debugging can start, several commands must be entered into the one-line input box at the bottom of the Command window.

Tip: All commands must be entered exactly as written, one line at a time, into the bottom of the Command box.

  • Copying and pasting each line is the easiest method to avoid mistakes
  • Some commands start with a period (.) or a pipe character (|), which is required. (The keystroke for a pipe character on US keyboards is SHIFT+\)
  • Submit the log file on a bug or via the support site, even if nothing seems to happen during the debug process

Start debugging

Now that Firefox is opened in the debugger, you need to configure your WinDbg to download symbols from the Mozilla symbol server. To load the symbols, enter the three commands below, pressing enter after each one. (More details are available at Using the Mozilla symbol server.)

.sympath SRV*c:\symbols*http://symbols.mozilla.org/firefox;SRV*c:\symbols*http://msdl.microsoft.com/download/symbols
.symfix+ c:\symbols
.reload /f

Now wait for the symbols to download. This may take some time depending on your connection speed; the total size of the download is around 70MB. WinDbg will show "Busy" at the bottom of the application window until the download is complete.

Once the download is complete, you need to configure WinDbg to examine child processes, ignore a specific event caused by Flash Player, and record a log of loaded modules. You will also want to open a log file to save data you collect. To do this, enter these four commands, pressing enter after each one.

.logopen /t c:\firefox-debug.log
.childdbg 1
.tlist
sxn gp
|* lm

If you see firefox.exe listed in the output from .tlist more than once, then you are already running the application and need to close the running instance first before you start debugging, otherwise you won't get useful results.

Now run Firefox by opening the Debug menu and clicking Go. While Firefox is running, you will not be able to type any commands into the debugger. After it starts, try to reproduce the crash or hanging issue that you are seeing.

If Firefox fails to start, and you see lines of text followed by a command prompt in the debugger, a "breakpoint" may have been triggered. If you are prompted for a command but don't see an error about a crash, go back to the Debug menu and press Go.

Once the browser crashes, you will see an error (such as "Access violation") in the WinDbg Command window. If Firefox hangs and there is no command prompt available in the debugger, open the Debug menu and choose Break. Once the browser has crashed or been stopped, continue with the steps below.

After the crash or hang

You need to capture the debug information to include in a bug comment or support request. Enter these three commands, one at a time, to get the stacktrace, crash/hang analysis and log of loaded modules. (Again, press Enter after each command.)

|* ~* kp
|* !analyze -v -f
|* lm

After these steps are completed, find the file c:\firefox-debug-(Today's Date).txt on your hard drive. To provide the information to the development community, submit this file with a support request or attach it to a related bug on Bugzilla.

Producing a minidump

Sometimes the stacktrace alone is not enough information for a developer to figure out what went wrong. A developer may ask you for a "minidump" or a "full memory dump", which are files containing more information about the process. You can easily produce minidumps from WinDBG and provide them to developers.

FAQ

Q: I am running Windows 7 (32-bit or 64-bit) and I see an exception in the WinDbg command window that says 'ntdll32!LdrpDoDebuggerBreak+0x2c' or 'ntdll32!LdrpDoDebuggerBreak+0x30'. What do I do now?

A: If you see 'int 3' after either of those exceptions, you will need to execute the following commands in WinDbg.

bp ntdll!LdrpDoDebuggerBreak+0x30
bp ntdll!LdrpDoDebuggerBreak+0x2c
eb ntdll!LdrpDoDebuggerBreak+0x30 0x90
eb ntdll!LdrpDoDebuggerBreak+0x2c 0x90

Make sure you enter them one at a time and press enter after each one. If you use the 64-bit version of Windows, you need to replace "ntdll" in these commands with "ntdll32".

Q: The first four frames of my stack trace look like this:

0012fe20 7c90e89a ntdll!KiFastSystemCallRet
0012fe24 7c81cd96 ntdll!ZwTerminateProcess+0xc
0012ff20 7c81cdee kernel32!_ExitProcess+0x62

0012ff34 6000179e kernel32!ExitProcess+0x14

This looks wrong to me?!

A: You ran the application without the "Debug child processes also" check box being checked. You need to detach the debugger and open the application again, this time with the check box being checked.

Q: WinDbg tells me that it is unable to verify checksum for firefox.exe. Is this normal?

A: Yes, this is normal and can be ignored.

Q: Should I click yes or no when WinDbg asks me to "Save information for workspace?"

A: Click yes and WinDbg will save you from having to enter in the symbol location for Firefox.exe in the future. Click no if you'd rather not having WinDbg save this information.

Q: I'm seeing "wow64" on top of each thread, is that ok ?

A: No, you are running a 64 bit version of Windbg and trying to debug a 32 bit version of the mozilla software. Redownload and install the 32 bit version of windbg.

See also

Revision Source

<h2 id="Introduction">Introduction</h2>
<p>Sometimes you need to get a stacktrace (call stack) for a crash or hang but <a class="external" href="http://kb.mozillazine.org/Talkback">Talkback</a> or <a class="external" href="http://kb.mozillazine.org/Breakpad" title="http://kb.mozillazine.org/Breakpad">Breakpad</a> fail because it's a special crasher or a hang. This article describes how to get a stacktrace in those cases with WinDbg on Windows.  (To get a stacktrace for Thunderbird or some other product, substitute the product name where ever you see Firefox in this instructions.)</p>
<h2 id="Requirements" name="Requirements">Requirements</h2>
<p>To get such a stacktrace you need to install the following software:</p>
<h3 id="Debugging_Tools_for_Windows" name="Debugging_Tools_for_Windows">Debugging Tools for Windows</h3>
<p>Microsoft distributes the Debugging Tools for Windows for free, those include WinDbg which you will need here. Download it from <a class="external" href="http://www.microsoft.com/whdc/devtools/debugging/installx86.mspx">Install Debugging Tools for Windows </a><strong><a class="external" href="http://www.microsoft.com/whdc/devtools/debugging/installx86.mspx">32-bit Version</a></strong> .  (<em>You'll want the 32-bit version</em>, even if you are using a 64-bit version of Windows)  Then install it, the standard settings in the installation process are fine.</p>
<h3 id="A_Firefox_nightly_or_release" name="A_Firefox_nightly_or_release">A Firefox nightly or release</h3>
<p>You need a Firefox version for which symbols are availables from the <a href="/en-US/docs/Using_the_Mozilla_symbol_server" title="Using_the_Mozilla_symbol_server">Mozilla symbol server</a> to use with WinDbg. You can use any <a class="external" href="http://ftp.mozilla.org/pub/mozilla.org/firefox/nightly/">official nightly build</a> or released version of Firefox from Mozilla. You can find the latest trunk nightly builds under <a class="external" href="http://ftp.mozilla.org/pub/mozilla.org/firefox/nightly/latest-trunk/" rel="freelink">http://ftp.mozilla.org/pub/mozilla.o.../latest-trunk/</a>.</p>
<h2 id="Debugging" name="Debugging">Debugging</h2>
<p>To begin debugging, ensure that Firefox is not already running and open WinDbg from the Start menu.  (Start-&gt;All Programs-&gt;Debugging Tools for Windows-&gt;WinDbg)  Next, open the<strong> "File"</strong> menu and choose <strong>"Open Executable..."</strong>.  In the file chooser window that appears, open the firefox.exe executable in your Firefox program folder (C:\Program Files\Mozilla Firefox).</p>
<p>You should now see a "Command" text window with debug output at the top and an input box at the bottom.  Before debugging can start, several commands must be entered into the one-line input box at the bottom of the Command window.</p>

<div class="note">
  <p>Tip: All commands must be entered exactly as written, one line at a time, into the bottom of the Command box.</p>
  <ul>
    <li>Copying and pasting each line is the easiest method to avoid mistakes</li>
    <li>Some commands start with a period (.) or a pipe character (|), which is required.  (The keystroke for a pipe character on US keyboards is SHIFT+\)</li>
    <li>Submit the log file on a bug or via the support site, even if nothing seems to happen during the debug process</li>
  </ul>
</div>
<h3 id="Start_debugging">Start debugging</h3>
<p>Now that Firefox is opened in the debugger, you need to configure your WinDbg to download symbols from the Mozilla symbol server.  To load the symbols, enter the three commands below, pressing enter after each one.  (More details are available at <a href="/en-US/docs/Using_the_Mozilla_symbol_server" title="Using_the_Mozilla_symbol_server">Using the Mozilla symbol server</a>.)</p>
<pre>
.sympath SRV*c:\symbols*http://symbols.mozilla.org/firefox;SRV*c:\symbols*http://msdl.microsoft.com/download/symbols
.symfix+ c:\symbols
.reload /f
</pre>
<p>Now wait for the symbols to download.  This may take some time depending on your connection speed; the total size of the download is around 70MB.   WinDbg will show "Busy" at the bottom of the application window until the download is complete.</p>
<p>Once the download is complete, you need to configure WinDbg to examine child processes, ignore a specific event caused by Flash Player, and record a log of loaded modules.  You will also want to open a log file to save data you collect.  To do this, enter these four commands, pressing enter after each one.</p>
<pre>
.logopen /t c:\firefox-debug.log
.childdbg 1
.tlist
sxn gp
|* lm
</pre>
<p>If you see firefox.exe listed in the output from .tlist more than once, then you are already running the application and need to close the running instance first before you start debugging, otherwise you won't get useful results.</p>
<p>Now run Firefox by opening the <strong>Debug</strong> menu and clicking <strong>Go</strong>.  <strong>While Firefox is running, you will not be able to type any commands into the debugger.</strong>  After it starts, try to reproduce the crash or hanging issue that you are seeing.</p>
<div class="note">
  If Firefox fails to start, and you see lines of text followed by a command prompt in the debugger, a "breakpoint" may have been triggered.  If you are prompted for a command but don't see an error about a crash, go back to the <strong>Debug</strong> menu and press <strong>Go</strong>.</div>
<p>Once the browser crashes, you will see an error (such as "Access violation") in the WinDbg Command window.  If Firefox hangs and there is no command prompt available in the debugger, open the <strong>Debug </strong>menu and choose <strong>Break.</strong>  Once the browser has crashed or been stopped, continue with the steps below.</p>
<h3 id="After_the_crash_or_hang">After the crash or hang</h3>
<p>You need to capture the debug information to include in a bug comment or support request.  Enter these three commands, one at a time, to get the stacktrace, crash/hang analysis and log of loaded modules.  (Again, press Enter after each command.)</p>
<pre>
|* ~* kp
|* !analyze -v -f
|* lm</pre>
<p>After these steps are completed, find the file <strong>c:\firefox-debug-(Today's Date).txt</strong> on your hard drive.  To provide the information to the development community, submit this file with a <a class="external" href="http://support.mozilla.com/" title="http://support.mozilla.com/">support request</a> or attach it to a related bug on <a class="link-https" href="https://bugzilla.mozilla.org/" title="https://bugzilla.mozilla.org/">Bugzilla</a>.</p>
<h3 id="Producing_a_minidump">Producing a minidump</h3>
<p>Sometimes the stacktrace alone is not enough information for a developer to figure out what went wrong. A developer may ask you for a "minidump" or a "full memory dump", which are files containing more information about the process. <a href="/en-US/docs/Capturing_a_minidump" title="Capturing a minidump">You can easily produce minidumps from WinDBG and provide them to developers</a>.</p>
<p>FAQ</p>
<p>Q: I am running Windows 7 (32-bit or 64-bit) and I see an exception in the WinDbg command window that says 'ntdll32!LdrpDoDebuggerBreak+0x2c' or 'ntdll32!LdrpDoDebuggerBreak+0x30'. What do I do now?</p>
<p>A: If you see 'int 3' after either of those exceptions, you will need to execute the following commands in WinDbg.</p>
<pre>
<span style="font-size: small;">bp ntdll!LdrpDoDebuggerBreak+0x30
bp ntdll!LdrpDoDebuggerBreak+0x2c
eb ntdll!LdrpDoDebuggerBreak+0x30 0x90
eb ntdll!LdrpDoDebuggerBreak+0x2c 0x90</span>
</pre>
<p>Make sure you enter them one at a time and press enter after each one.  If you use the 64-bit version of Windows, you need to replace "ntdll" in these commands with "ntdll32".<br />
  <br />
  Q: The first four frames of my stack trace look like this:</p>
<pre>
0012fe20 7c90e89a ntdll!KiFastSystemCallRet
0012fe24 7c81cd96 ntdll!ZwTerminateProcess+0xc
0012ff20 7c81cdee kernel32!_ExitProcess+0x62

0012ff34 6000179e kernel32!ExitProcess+0x14
</pre>
<p>This looks wrong to me?!</p>
<p>A: You ran the application without the "Debug child processes also" check box being checked. You need to detach the debugger and open the application again, this time with the check box being checked.</p>
<p>Q: WinDbg tells me that it is unable to verify checksum for firefox.exe. Is this normal?</p>
<p>A: Yes, this is normal and can be ignored.</p>
<p>Q: Should I click yes or no when WinDbg asks me to "Save information for workspace?"</p>
<p>A: Click yes and WinDbg will save you from having to enter in the symbol location for Firefox.exe in the future. Click no if you'd rather not having WinDbg save this information.</p>
<p>Q: I'm seeing "wow64" on top of each thread, is that ok ?</p>
<p>A: No, you are running a 64 bit version of Windbg and trying to debug a 32 bit version of the mozilla software. Redownload and install the 32 bit version of windbg.</p>
<h2 id="See_also" name="See_also">See also</h2>
<ul>
  <li><a href="/en-US/docs/Using_the_Mozilla_symbol_server" title="Using_the_Mozilla_symbol_server">symbol server</a> Maps addresses to human readable strings.</li>
  <li><a href="/en-US/docs/Using_the_Mozilla_source_server" title="Using_the_Mozilla_source_server">source server</a> Maps addresses to source code lines</li>
</ul>
Revert to this revision