...
| Scroll ignore |
|---|
Link to be provided outside of Bosch Internal document. This article cannot be provided outside of Bosch |
...
...
Information below is for CTS, SG, GK reference and must be kept internal only.
If you are part of CTS, SG or GK team, please hide this section when you have finished using this article!
...
Advanced information on BVMS dumps would include:
- introduction to dumps
- tools for dump creation
Introduction to dumps
For the Windows operating system, there are two types of dumps: user-mode dumps and kernel-mode dumps.
User-mode dumps
User-mode dumps are either created automatically by the Windows operating system in case of an application crash, or may also be created manually by using task manager or another tool like ntsd or procdump.
There are two types of user-mode dumps:
- full user-mode dumps
- minidumps
...
The recommended dump type for BVMS dumps are Minidumps, created with the "-ma" option.
Minidumps which are created with this option, contain full memory data (including virtual memory layout) as well as handle, thread and lock information.
This article is mainly about user-mode dumps - user-mode dumps are the dump type needed for BVMS issue analysis.
Kernel-mode dumps
Kernel-mode dumps are created when the Windows OS runs into a blue screen.
From BVMS maintenance perspective, kernel-mode dumps are not relevant.
The experience from the past years is, that not one single case was reported where BVMS caused a blue screen.
Dump contents
A user-mode dump is a full process image. It contains memory contents, thread information, acquired locks and crash reasons for both managed and unmanaged code.
Dump contents allow to track down the causes of these types of issues:
- Application crashes and their causes and origins (managed or unmanaged code)
- Memory or handle leaks and their origins
- Deadlocks, freezes and hangs and their origins
Tools for dump creation
There are a number of tools that can be used for dump creation:
- Task Manager
- ntsd
- Procdump
The recommended tool for creating BVMS dumps is Procdump.
The Procdump tool is recommended for the following reasons:
- Procdump is easier to use than ntsd
- Procdump can be used on different platforms (XP, Win2003 Server, Win7, Win2008 Server, Win8)
- Prodcump is an official Microsoft tool (as opposed to ntsd which was only part of Windows XP)
- Procdump can be used for all relevant dump creation scenarios - see details below
- Procdump supports several advanced options for triggering dump creation
Procdump is a command line tool which must be started from the command shell.
This article covers all important aspects of BVMS dump creation - error scenarios and corresponding dump creation methods.
Quick links:
BVMS dumps are needed to troubleshoot the following types of issues:
- Application crashes – dump is expected to provide more information about the cause of the crash and its origin.
- Memory or handle leaks – dump is expected to point to their origins
- Deadlocks, freezes and hangs – dump is expected to point to their origins
Recommended tool to create BVMS dumps.
The recommended tool is Procdump. It is a command line tool which must be started from the command shell. Bosch development team provides couple of .bat files that start Procdump with predefined parameters and cover the most common dump creation cases. The tool as well as the set of .bat files are attached to this article.
Batch files for dump creation
The batch file names follow a naming guideline: <Executable>_<Dump use case>
...
- ConfigClient
- ConfigWizard
- OperatorClient
- ManagementServer
- ArchivePlayer
- ExceptionTest
and <Dump use case> is one of:
- SingleDump
- TwoDumps
- DumpOnException
E.g.
- batch file OperatorClient_SingleDump.bat immediately creates a dump of the Operator Client process,
- while OperatorClient_TwoDumps.bat creates two dumps of the Operator Client process with a delay of 1 hour between the dumps.
- OperatorClient_DumpOnException.bat creates a dump of the Operator Client process as soon as it throws an unhandled exception.
Note that also batches for executable "ExceptionTest.exe" are provided. These batches can be used for testing purposes - ExceptionTest.exe is a little test application that simply crashes when being started.
...
Calling this batch will ensure that a dump is created when Windows Error Reporting is triggered by a crash.
To learn more about the advanced capabilities of the procdump tool, start batches ShowProcdumpHelp.bat and ShowProcdumpHelpSamples.bat. These batches display procdump options and some samples for how to use prodcump.
Error scenarios and corresponding dump creation methods
...
- application crashes which trigger windows error reporting
- memory or handle leaks
Issues which are hard to reproduce
- sporadic application crashes or crashes which do not trigger windows error reporting
- application sporadically becoming unresponsive (freezes/hangs)
Step-by-step guide
A. Dump creation for reproducible crashes that trigger Windows Error Reporting
To create a dump for a reproducible crash, follow these steps:
...
- Run the affected application/service (Operator Client, Configuration Client). Note: Management Server Service is running by default.
- Reproduce the steps that lead to the crash
- Leave the Windows crash dialog open
- Run the corresponding batch file for creating a single dump: *_SingleDump.bat. E.g. run OperatorClient_SingleDump.bat to create a single dump of the Operator Client process.
- Provide support with
- the resulting .dmp file
- a description of the steps to reproduce the problem
- a ConfigCollection
Note: attached you can find a configured example for this scenario and application Operator Client - BVMS_OC_dump_onException.zip
B. Dump creation for reproducible memory or handle leaks
To create a dump for a memory/handle leak, follow these steps:
1.Run the affected application/service (Operator Client, Configuration Client). Note: Management Server Service is running by default.
2. Run the corresponding batch file for creating two dumps: *_TwoDumps.bat. E.g. run OperatorClient_TwoDumps.bat to create two dumps of the Operator Client process.
...
3. Reproduce the steps that lead to the memory leak. Wait until the second dump was created.
4. Provide support with
- the resulting two .dmp files
- a description of the steps to reproduce the memory leak
- a ConfigCollection
Note: attached you can find a configured example for this scenario and application Operator Client, as well as additional examples - .zip
C. Dump creation for crashes/hangs/freezes that are hard to reproduce
...
- To deactivate the restarting option for Operator Client / Configuration Client: edit ..\Bosch\VMS\bin\ConfigClient.exe.config or ..\Bosch\VMS\bin\OperatorClient.exe.config.
- Navigate to section <appSettings>
- add a new entry <add key = "DisableExceptionHandling" value="TRUE" />.
...
- the resulting .dmp file
- a description of the steps to reproduce the crash
- a ConfigCollection
Note: attached you can find a configured example for this scenario and application Operator Client - BVMS_OC_dump_Just-In-Time-Debuger.zip
Note: after collecting the logs, please disable the debugger - delete the Auto and Debugger registry entries (they were created by command in point 2. Run ActivatePostmortemDebugging.bat )
...
...
Information below is for CTS, SG, GK reference and must be kept internal only.
If you are part of CTS, SG or GK team, please hide this section when you have finished using this article!
...
1.Don't click away the error dialog and Run *_SingleDump.bat to manually create a dump file
or
2. Run *_DumpOnException.bat before starting the Operator Client/Configuration Client/Management Server.
Method 1) should work in any case. Method 2) should work in most cases.
D. Dump creation for other hard-to-reproduce issues
Procdump offers several other triggers for creating dumps:
- CPU peaks
- Performance counter peaks
- Application hanging for x seconds
- Unhandled exceptions
See procdump help for details on how to create dumps for these special situations.
E. Dump creation with "user mode stack trace database"
In some cases, the information provided by a "normal" dump is not sufficient for development analysis. For these cases, the OperatorClient.exe file must be temporarily modified while taking the dump.
The steps below describe the required prerequisites and the modification steps:
Prerequisites
In order to create a dump with user mode stack trace database, you need to get the gflags.exe tool.
This tool is part of the "Debugging Tools for Windows" which is part of "Windows Driver Kit Version 7.1.0".
...
F. Dump creation with user mode stack trace database
To create a dump with user mode stack trace database, follow these steps:
- Copy file gflags.exe to folder <Program Files>\Bosch\VMS\bin
- Open a command shell and navigate to <Program Files>\Bosch\VMS\bin
- Activate user mode stack trace database in Operator Client by running command gflags.exe /i OperatorClient.exe +ust
- Reproduce the problem scenario and take the dump as described above
- Deactivate user mode stack trace database in Operator Client by running command gflags /i OperatorClient.exe -ust
...
| scroll-pdf | true |
|---|---|
| scroll-office | true |
| scroll-chm | true |
| scroll-docbook | true |
| scroll-eclipsehelp | true |
| scroll-epub | true |
| scroll-html | true |
You are using an Offline Version of these Article, please ensure to regularly check the corresponding online article on the Bosch Building Technologies Knowledge Base for any updates. Use the date and version information of the document as reference.
...