About This Release

This is an early technical preview release (v1.0.0.2) of the preSCAN tool. This release has not been tested extensively and is not supported. Please send any feedback using the link in Contact Information section.  

Where to download ?

Certain legacy Citrix tools are now available on request only. Please submit the request here - https://forms.gle/obA39PEz5qpDiSPq8

Once we verify your request, we will provide access to the download location. 

Description

preSCAN is a memory dump file verification utility. It is helpful to first check a memory dump file with preSCAN to ensure it contains the expected type of dump data, before sending it off to Citrix technical support for further analysis.

Dump files may be caused by memory corruption (heap/pool corruption), and these dump files may sometimes require additional data before they can be used for valid analysis. There are also other issues (beyond memory corruption) that may deem a memory dump file unsuitable for analysis.

preSCAN helps to check the dump file and verify its integrity, so that if any issues are identified they can be dealt with immediately.

Prerequisites

No prerequisites. However, you can achieve optimal functionality by using the newest debugging libraries available from Microsoft. By default, preSCAN utilizes the debugging libraries that ships with the operating system.

It’s recommended to install the newest version of the Debugging Tools for Windows and then place the corresponding x64/x86 preSCAN binaries in the same directory as the WinDbg.exe binaries. For example, if the Debugging Tools for Windows installs to:

    C:\Program Files (x86)\Windows Kits\10\Debuggers 

Then copy preSCAN.exe & libPreSCAN.dll to:

    C:\Program Files (x86)\Windows Kits\10\Debuggers\x86

    C:\Program Files (x86)\Windows Kits\10\Debuggers\x64

Then you can run preSCAN directly from that location to make use of the newest debugging libraries.

Installing preSCAN

No installation is required. Simply copy the preSCAN files to any desired location on the system and execute from there. There are 2 required files (preSCAN.exe & libPreSCAN.dll) and they both need to exist in the same directory.

Please refer the section Prereqisites above for details on how to use preSCAN together with Debugging Tools for Windows.

How to Use preSCAN

To run the tool, double-click on the preSCAN.exe executable.

To verify a Windows memory dump file (.*dmp):

• Click on the File menu and then click on the Verify Dump Integrity sub-menu
• Choose a dump file to verify (this may take several minutes) and view the results
• If the dump file is deemed to be a valid memory dump file, it indicates at the top and any additional details are shown below:

• Scroll towards the bottom of the output to look for any additional information or recommendations (such as Microsoft or Citrix articles that provide additional data collection methods)
• An error message similar to below will be presented if the dump file is considered to be “corrupted”:

Note: This version of preSCAN doesn't indicate whether the dump file is truncated (this functionality will be included in a later release). 

Security Permissions Required by preSCAN

User account permission is sufficient.

Data Modified by preSCAN

preSCAN doesn't modify any data on the system. It may utilize temporary symbol files which are cached in the Windows Temp directory. 

How to Undo the Changes Made by preSCAN

• Delete any temporary symbol files in the default Windows Temp directory
• Delete preSCAN.exe & libPreSCAN.dll binaries

Uninstalling preSCAN

• Delete any temporary symbol files in the default Windows Temp directory
• Delete the preSCAN.exe & libPreSCAN.dll binaries

Known Issues

Currently the tool does not identify “truncated” memory dump files.

Contact Information

Questions?  Concerns?  Send any feedback for this tool to supporttools@citrix.com.

Disclaimer

These software applications are provided to you as is with no representations, warranties or conditions of any kind.  You may use and distribute it at your own risk. CITRIX DISCLAIMS ALL WARRANTIES WHATSOEVER, EXPRESS, IMPLIED, WRITTEN, ORAL OR STATUTORY, INCLUDING WITHOUT LIMITATION WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NONINFRINGEMENT. Without limiting the generality of the foregoing, you acknowledge and agree that (a) the software application may exhibit errors, design flaws or other problems, possibly resulting in loss of data or damage to property; (b) it may not be possible to make the software application fully functional; and (c) Citrix may, without notice or liability to you, cease to make available the current version and/or any future versions of the software application.  In no event should the code be used to support of ultra-hazardous activities, including but not limited to life support or blasting activities.  NEITHER CITRIX NOR ITS AFFILIATES OR AGENTS WILL BE LIABLE, UNDER BREACH OF CONTRACT OR ANY OTHER THEORY OF LIABILITY, FOR ANY DAMAGES WHATSOEVER ARISING FROM USE OF THE SOFTWARE APPLICATION, INCLUDING WITHOUT LIMITATION DIRECT, SPECIAL, INCIDENTAL, PUNITIVE, CONSEQUENTIAL OR OTHER DAMAGES, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.  You agree to indemnify and defend Citrix against any and all claims arising from your use, modification or distribution of the code.