From 035ea3c1d4eabc9b1d36d1fdba912afd16cdd2d9 Mon Sep 17 00:00:00 2001 From: David Anderson Date: Sat, 3 Jun 2006 16:25:55 +0000 Subject: [PATCH] *** empty log message *** svn path=/trunk/boinc/; revision=10246 --- doc/app_debug_win.php | 207 +++++++++++++++++------------------------- 1 file changed, 81 insertions(+), 126 deletions(-) diff --git a/doc/app_debug_win.php b/doc/app_debug_win.php index ad4132912d..2aa6c0214a 100644 --- a/doc/app_debug_win.php +++ b/doc/app_debug_win.php @@ -49,61 +49,60 @@ being used, when the crash occured, and what the internal version of the Windows debugger technology is being used.

Symbol search paths are used to inform the debugger where it might be able to -find the symbol files related to the modules loaded in memory. Entries prefixed with -'srv*' are used to denote a web based symbol store. DbgHelp will use them if -symsrv can be loaded at the time of the crash. +find the symbol files related to the modules loaded in memory. + Entries prefixed with 'srv*' are used to denote a web based symbol store. +DbgHelp will use them if symsrv can be loaded at the time of the crash.

If you see a load library failure for either dbghelp.dll or symsrv.dll then there is a pretty good chance that most of the data in the dump will be useless.

Module List

- - - - -
- 
+"; block_start(); echo "
 ModLoad: 00400000 00060000 C:\\BOINCSRC\\Main\\boinc_samples\\win_build\\Release\\uppercase_5.10_windows_intelx86.exe (PDB Symbols Loaded)
 ModLoad: 7c800000 000c0000 C:\\WINDOWS\\system32\\ntdll.dll (5.2.3790.1830) (PDB Symbols Loaded)
     File Version   : 5.2.3790.1830 (srv03_sp1_rtm.050324-1447)
     Company Name   : Microsoft Corporation
     Product Name   : Microsoft® Windows® Operating System
     Product Version: 5.2.3790.1830
-
-
+"; block_end(); echo "

-Information about which modules were loaded into the processes memory space can be found -here. The first hexadecimal value is the address in memory in which the module was loaded; +Information about which modules were loaded into the processes memory +space can be found here. +The first hexadecimal value is the address in memory in which the module was loaded; the second hexadecimal is the size of the module.

-If a version record was found inside the module, it'll be dumped out as part of the module -list dump. +If a version record was found inside the module, +it'll be dumped out as part of the module list dump.

-If the correct symbol file can be found, it'll display what symbol file type is in use. +If the correct symbol file can be found, +it'll display what symbol file type is in use. The three most common symbol types in modern software are 'PDB', 'exports', and -'-no symbols-'. Symbol files are pretty large and so most projects do not like to include -them as part of the APP VERSION package. Luckily Microsoft has created a technology called -Symbol Stores which enable an application to be able to grab its symbol file from a web -server at the time of a crash in a compressed format. We will describe setting up a -symbol store later in this document. +'-no symbols-'. +Symbol files are pretty large and so most projects do not like to include +them as part of the APP VERSION package. +Luckily Microsoft has created a technology called +Symbol Stores which enable an application to be able to +grab its symbol file from a web +server at the time of a crash in a compressed format. + We will describe setting up a symbol store later in this document.

-PDB files are generated at compilation time and usually have to be turned on for release -builds. This file will contain all the needed information to generate a pretty good +PDB files are generated at compilation time and usually have +to be turned on for release builds. +This file will contain all the needed information to generate a pretty good callstack which you can use to diagnose problems.

-Export symbols usually only appear on DLLs since DLLs can export function pointers via -the export table. When you see this in the module list you’ll only see functions which +Export symbols usually only appear on DLLs since DLLs +can export function pointers via the export table. +When you see this in the module list you’ll only see functions which are listed in the export table in the callstack.

No symbols means that the runtime debugger could not determine a way to give you any -symbolic information. You’ll only receive function pointers in the callstack. +symbolic information. +You’ll only receive function pointers in the callstack.

Process Information

- - - - -
- 
+"; block_start(); echo "
 *** Dump of the Process Statistics: ***
 
 - I/O Operations Counters -
@@ -124,67 +123,50 @@ PagefileUsage: 26218496, PeakPagefileUsage: 33697792
 
 - Working Set Size -
 WorkingSetSize: 19210240, PeakWorkingSetSize: 26361856, PageFaultCount: 6729
-
-
+"; block_end(); echo "

-This is some overall useful information about the process. Most of the time the -'Virtual Memory', 'Pagefile', and 'Working Set' are the most useful indicications +This is some overall useful information about the process. +Most of the time the 'Virtual Memory', 'Pagefile', and 'Working Set' +are the most useful indications of whether or not the process was under low available memory pressure from the OS.

Thread Information

- - - - -
- 
+"; block_start(); echo "
 *** Dump of the Worker thread (a4): ***
-
-
+"; block_end(); echo "

This identifies the thread for which additional information is going to be -displayed. Both the thread name and thread ID are displayed. To set the thread +displayed. +Both the thread name and thread ID are displayed. +To set the thread name for any thread you have created in your program just call diagnostics_set_thread_name() as defined in diagnostics.h to set the thread name for the currently executing thread.

General Information
- - - - -
- 
+"; block_start(); echo "
 - Information -
 Status: Waiting, Wait Reason: UserRequest, Kernel Time: 0.000000, User Time: 0.000000, Wait Time: 38241696.000000
-
-
+"; block_end(); echo "

-Status shows what state the thread was in when the snapshot was taken. If the -thread is waiting, wait reason will describe why the thread is waiting. If the -thread is running both the base thread priority and current thread priority will -be displayed. +Status shows what state the thread was in when the snapshot was taken. +If the thread is waiting, wait reason will describe why the thread is waiting. +If the thread is running both the base thread priority +and current thread priority will be displayed.

Kernel time, user time, and wait time describe how much time, in nanoseconds, the thread has spent in each of those states.

Unhandled Exception Record
- - - - -
- 
+"; block_start(); echo "
 - Unhandled Exception Record -
 Reason: Breakpoint Encountered (0x80000003) at address 0x7C822583
-
-
+"; block_end(); echo "

This section if included in the thread describes what event ocurred that caused -the runtime debugger to engage. Structured Exceptions in Windows are not the same -thing as C++ exceptions. Unless you are using a compiler that knows about both types +the runtime debugger to engage. +Structured Exceptions in Windows are not the same thing as C++ exceptions. +Unless you are using a compiler that knows about both types it is unlikely that a C++ catch is going to actually catch this type of exception.

Further information about Structured Exception Handling can be found @@ -192,8 +174,8 @@ Further information about Structured Exception Handling can be found here.

-It is important to note that both hardware and software exceptions can bubble up from -the operating system through this mechinism. +It is important to note that both hardware and software exceptions can +bubble up from the operating system through this mechinism.

The example above shows that EXCEPTION_BREAKPOINT(PlatformSDK\\Include\\winbase.h) was raised at 0x7C822583. @@ -201,21 +183,15 @@ EXCEPTION_BREAKPOINT is defined as STATUS_BREAKPOINT(PlatformSDK\\Include\\ntsta which is defined as ((NTSTATUS)0x80000003L).

Registers
- - - - -
- 
+"; block_start(); echo "
 - Registers -
 eax=00000000 ebx=00000000 ecx=77e4245b edx=7c82ed54 esi=77e88bfe edi=00459f40
 eip=7c822583 esp=00aafd64 ebp=00aaffb4
 cs=001b  ss=0023  ds=0023  es=0023  fs=003b  gs=0000             efl=00000202
-
-
+"; block_end(); echo "

-This is a basic dump of the processor registers at the time the exception was raised and -will look different for each process type. +This is a basic dump of the processor registers at the time the +exception was raised and will look different for each process type.

In this example these are the registers and flags for the Intel based x86 processor.

@@ -230,13 +206,11 @@ ChildEBP RetAddr Args to Child 00aaffb4 0042684e 77e66063 00000000 00000000 00000000 uppercase_5.10_windows_intelx86!worker+0x0 (c:\boincsrc\main\boinc_samples\uppercase\upper_case.c:181) 00aaffb8 77e66063 00000000 00000000 00000000 00000000 uppercase_5.10_windows_intelx86!foobar+0x0 (c:\boincsrc\main\boinc\api\graphics_impl.c:75) FPO: [1,0,0] 00aaffec 00000000 00426840 00000000 00000000 00000000 kernel32!_BaseThreadStart@8+0x0 (c:\boincsrc\main\boinc\api\graphics_impl.c:75) - - - - +"; block_end(); echo "

-This describes the state in which the thread was in at the time of the exception. ChildEBP and -RetAddr are not really useful unless you can reproduce the issue using the same OS version. +This describes the state in which the thread was in at the time of the exception. +ChildEBP and RetAddr are not really useful unless you can reproduce +the issue using the same OS version.

Args to Child are the first four parameters passed to the function.

@@ -252,81 +226,62 @@ The next piece of information has the following format:

Function ordinals only apply to functions that are publically exported from a DLL.
Symbol Offset
If the symbol file being used has private symbols stripped, then the symbol displayed may - not be the correct symbol. You can use the symbol offset to lookup the correct symbol + not be the correct symbol. + You can use the symbol offset to lookup the correct symbol from the object file or some other tool that can map symbols to source.
File/Line Information
Source file and line number information is not available in all symbol file formats, but - if it is there it'll be displayed. PDB files are generally the best symbol file format - to use.
+ if it is there it'll be displayed. + PDB files are generally the best symbol file format to use.

Debug Message Dump

- - - - -
- 
+"; block_start(); echo "
 *** Debug Message Dump ****
-
-
+"; block_end(); echo "

This feature is disabled by default.

-What is allows for is capturing the debugger viewport data at runtime just as though you were -running the application within a debugger. Since all applications use the same block of memory -is can slow down any and all applications that want to write to the debugger viewport, even on -release builds which is why it is disabled by default. Video capture, edit, and playback +What is allows for is capturing the debugger viewport data at runtime +just as though you were running the application within a debugger. +Since all applications use the same block of memory is can +slow down any and all applications that want to write to the debugger viewport, +even on release builds which is why it is disabled by default. +Video capture, edit, and playback software tends to dump data to the viewport even when running a release build.

The following regedit script demonstrates how to enable the debug message dump: - - - - -
- 
+"; block_start(); echo "
 Windows Registry Editor Version 5.00
 
 [HKEY_CURRENT_USER\Software\Space Sciences Laboratory, U.C. Berkeley\BOINC Diagnostics]
 \"CaptureMessages\"=dword:00000001
-
-
+"; block_end(); echo " To disable able the message capture use this regedit script: - - - - -
- 
+"; block_start(); echo "
 Windows Registry Editor Version 5.00
 
 [HKEY_CURRENT_USER\Software\Space Sciences Laboratory, U.C. Berkeley\BOINC Diagnostics]
 \"CaptureMessages\"=dword:00000000
-
-
+"; block_end(); echo "

Foreground Window Data

- - - - -
- 
+"; block_start(); echo "
 *** Foreground Window Data ***
     Window Name      : 
     Window Class     : 
     Window Process ID: 16f8
     Window Thread ID : ae8
-
-
+"; block_end(); echo "

-This shows which window has the user input focus. The feature was originally meant to +This shows which window has the user input focus. +The feature was originally meant to detect potiential problems with 3rd party application injecting code into BOINC applications and displaying UI to the user.

This feature turns out to be problematic since the foreground window might be hung which would mean that trying to get the window name and class would cause the runtime -debugger to hang as well. This feature will probably be removed in the future. +debugger to hang as well. +This feature will probably be removed in the future.

Symbol Stores

Introduction