Click here to Skip to main content
Click here to Skip to main content

VSDebugHelper - Capture memory snapshot of a debugged process to a file

, 15 Apr 2011 CPOL
Rate this:
Please Sign up or sign in to vote.
The VsDebugHelper add-in allows to capture a buffer from the program being debugged into a data file and back.

Introduction

At times I need to look into a processing step of a pipeline, either to identify a performance improvement or as part of impact analysis. If the step is covered by a unit test, then it is a bit easier to analyze, but alas, this is not always the case.

In such instances, a general approach is to isolate a buffer of data being processed and extract it to a data file. Then the data can be analyzed separately or the data can be used to create a unit test. In the latter case, the unit test can be used to test the performance improvement.

There are generally two ways of capturing the buffer: either modify the source code to add the data dump procedure (e.g., fopen/fwrite/fclose), or restart the debug session with WinDBG and using the writemem extension.

Both of the above methods are robust but inefficient as both require restarting of the debug session and one of them requires recompilation of the sources, which may be time consuming.

Hence the VsDebugHelper add-in was born. The VsDebugHelper add-in allows to capture a buffer from the program being debugged into a data file and back.

Using the VsDebugHelper Add-in

The steps to use the add-in are rather simple:

  • Make sure VsDebugHelper is loaded by checking Tools\Addin manager...
  • Start debugging the application and break on the desired location
  • Use one or more of the commands from VsDebugHelper

Once loaded, the plug-in adds two commands to the Visual Studio environment, which can be executed from the Visual Studio Command Window.

VsDebugHelper Commands

The following commands are inspired by the WinDBG extension, and provide the following functionality:

  • writemem - Write memory to file
  • Usage: writemem <filename> <address> <length>

    • filename - destination file name.
    • address - starting address of the buffer.
    • length - length of the data to be copied.
  • readmem - Read memory from file
  • Usage: readmem <filename> <address> <length>

    • filename - source file name.
    • address - starting address of the buffer.
    • length - length of the data to be copied.

    Note: To see the effect of readmem in Visual Studio, you need to 'step' after readmem is called.

Both the address and length arguments can be variable names or an expression.

VsDebugHelper Example Usage

Here is an example of how VsDebugHelper can capture a buffer of pixels:

std::auto_ptr<lum8> grayPixels(new lum8[width*height]);
...
std::auto_ptr<rgba> colorPixels(new rgba[width*height]);
...

alt text

Note that the arguments are variables and expressions of expressions, which are evaluated by the debugger. If you run into any issues, first double check that all expressions can be resolved in the Watch window.

And here is how the raw data is displayed by an external viewer (IrfranView):

alt text

alt text

Installation

Installation by Direct Download

Proceed with the download and install at the top of the article. After the installation, confirm the add-in is installed and set to be loaded at startup, as shown below:

alt text

Installation Through Extension Manager

Alternately, the add-in can be installed from within Visual Studio through the use of the Extension Manager as shown below:

Add-in Internals

Visual Studio has a number of extensibility technologies, but useful documentation is very difficult to find. Additionally, there is significant disconnect as to what is available to managed extensions vs. unmanaged extensions. It is rather clear that Visual Studio is an unmanaged application, yet there is no information on how to interact from an unmanaged add-in. And interestingly enough, extensibility functionality for 'Visualizer' has been clearly cut off.

Besides being a nuisance, the above boils down to an issue that there is no way to work through Visual Studio to modify a region of memory. Hence when the readmem command is used (to load a buffer from file), the Watch and Memory window displays will be out of sync with the actual memory contents.

Overall, the sequence of execution is pretty simple. Visual Studio calls the CommandTarget interface and its implementation will dispatch the call to the ICommand implementation based on the command string. The ICommand implementation is responsible for parsing the command parameters and etc. A simplified diagram is shown below:

alt text

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Share

About the Author

Igor Okulist

United States United States
No Biography provided

Comments and Discussions

 
Questionwritemem Failed PinmemberMember 954640017-May-13 7:18 
AnswerRe: writemem Failed PinmemberIgor Okulist18-May-13 10:33 
GeneralRe: writemem Failed PinmemberMember 954640020-May-13 5:35 
GeneralRe: writemem Failed PinmemberIgor Okulist20-May-13 6:39 
GeneralRe: writemem Failed PinmemberMember 954640020-May-13 6:56 
GeneralRe: writemem Failed PinmemberIgor Okulist20-May-13 7:02 
GeneralRe: writemem Failed PinmemberMember 954640021-Aug-13 8:13 
GeneralRe: writemem Failed PinmemberIgor Okulist22-Aug-13 18:52 
GeneralRe: writemem Failed Pinmemberchk20-Nov-13 0:47 
GeneralRe: writemem Failed PinmemberIgor Okulist20-Nov-13 11:14 
GeneralRe: writemem Failed PinmemberIgor Okulist20-May-13 7:05 
BugVSDebugHelper locks up when saving memory from a crash dump PinmemberMember 41995799-May-12 4:53 
GeneralRe: VSDebugHelper locks up when saving memory from a crash dump PinmemberIgor Okulist9-May-12 16:52 
GeneralRe: VSDebugHelper locks up when saving memory from a crash dump PinmemberMember 419957910-May-12 4:49 
GeneralRe: VSDebugHelper locks up when saving memory from a crash dump PinmemberIgor Okulist16-May-12 21:15 
GeneralRe: VSDebugHelper locks up when saving memory from a crash dump Pinmemberjmenter2-Aug-12 5:36 
GeneralRe: VSDebugHelper locks up when saving memory from a crash dump PinmemberIgor Okulist25-Aug-12 16:10 
QuestionVery Helpful Pinmembertharaka_t26-Apr-12 18:58 
AnswerRe: Very Helpful PinmemberIgor Okulist27-Apr-12 14:41 
Thanks for vote.
 
Regarding your question -- it's a bit too generic, but there have
been a few articles posted on codeproject recently (run a search).
 
Try them out, but do post a questions if there are specific issues.
 
Regards,
Igor
GeneralRe: Very Helpful Pinmembertharaka_t30-Apr-12 22:53 
GeneralRe: Very Helpful PinmemberIgor Okulist3-May-12 12:19 
GeneralRe: Very Helpful Pinmembertharaka_t7-May-12 6:40 
GeneralRe: Very Helpful PinmemberIgor Okulist9-May-12 16:57 
GeneralRe: Very Helpful Pinmembertharaka_t23-May-12 22:08 
GeneralMy vote of 5 Pinmemberlinuxjr5-Apr-11 17:24 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Mobile
Web01 | 2.8.141029.1 | Last Updated 15 Apr 2011
Article Copyright 2011 by Igor Okulist
Everything else Copyright © CodeProject, 1999-2014
Terms of Service
Layout: fixed | fluid