development/Win32/vld/vld.ini

   1 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
   2 ;;
   3 ;;  Visual Leak Detector - Initialization/Configuration File
   4 ;;  Copyright (c) 2006 Dan Moulding
   5 ;;
   6 ;;  This library is free software; you can redistribute it and/or
   7 ;;  modify it under the terms of the GNU Lesser General Public
   8 ;;  License as published by the Free Software Foundation; either
   9 ;;  version 2.1 of the License, or (at your option) any later version.
  10 ;;
  11 ;;  This library is distributed in the hope that it will be useful,
  12 ;;  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 ;;  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 ;;  Lesser General Public License for more details.
  15 ;;
  16 ;;  You should have received a copy of the GNU Lesser General Public
  17 ;;  License along with this library; if not, write to the Free Software
  18 ;;  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19 ;;
  20 ;;  See COPYING.txt for the full terms of the GNU Lesser General Public License.
  21 ;;
  22 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  23
  24 ; Any options left blank or not present will revert to their default values.
  25 [Options]
  26
  27 ; The main on/off switch. If off, Visual Leak Detector will be completely
  28 ; disabled. It will do nothing but print a message to the debugger indicating
  29 ; that it has been turned off.
  30 ;
  31 ;  Valid Values: on, off
  32 ;  Default: on
  33 ;
  34 VLD = on
  35
  36 ; If yes, duplicate leaks (those that are identical) are not shown individually.
  37 ; Only the first such leak is shown, along with a number indicating the total
  38 ; number of duplicate leaks.
  39 ;
  40 ;   Valid Values: yes, no
  41 ;   Default: no
  42 ;
  43 AggregateDuplicates = yes
  44
  45 ; Lists any additional modules to be included in memory leak detection. This can
  46 ; be useful for checking for memory leaks in debug builds of 3rd party modules
  47 ; which can not be easily rebuilt with '#include "vld.h"'. This option should be
  48 ; used only if absolutely necessary and only if you really know what you are
  49 ; doing.
  50 ;
  51 ;   CAUTION: Avoid listing any modules that link with the release CRT libraries.
  52 ;     Only modules that link with the debug CRT libraries should be listed here.
  53 ;     Doing otherwise might result in false memory leak reports or even crashes.
  54 ;
  55 ;   Valid Values: Any list containing module names (i.e. names of EXEs or DLLs).
  56 ;   Default: None.
  57 ;
  58 ; Also track Qt's allocations: (not 100% sure that the reported leaks are correct)
  59 ;ForceIncludeModules = QtCored4.dll QtGuid4.dll
  60 ForceIncludeModules =
  61
  62 ; Maximum number of data bytes to display for each leaked block. If zero, then
  63 ; the data dump is completely suppressed and only call stacks are shown.
  64 ; Limiting this to a low number can be useful if any of the leaked blocks are
  65 ; very large and cause unnecessary clutter in the memory leak report.
  66 ;
  67 ;   Value Values: 0 - 4294967295
  68 ;   Default: 4294967295
  69 ;
  70 MaxDataDump =
  71
  72 ; Maximum number of call stack frames to trace back during leak detection.
  73 ; Limiting this to a low number can reduce the CPU utilization overhead imposed
  74 ; by memory leak detection, especially when using the slower "safe" stack
  75 ; walking method (see StackWalkMethod below).
  76 ;
  77 ;   Valid Values: 1 - 4294967295
  78 ;   Default: 4294967295
  79 ;
  80 MaxTraceFrames =
  81
  82 ; Sets the type of encoding to use for the generated memory leak report. This
  83 ; option is really only useful in conjuction with sending the report to a file.
  84 ; Sending a Unicode encoded report to the debugger is not useful because the
  85 ; debugger cannot display Unicode characters. Using Unicode encoding might be
  86 ; useful if the data contained in leaked blocks is likely to consist of Unicode
  87 ; text.
  88 ;
  89 ;   Valid Values: ascii, unicode
  90 ;   Default: ascii
  91 ;
  92 ReportEncoding = ascii
  93
  94 ; Sets the report file destination, if reporting to file is enabled. A relative
  95 ; path may be specified and is considered relative to the process' working
  96 ; directory.
  97 ;
  98 ;   Valid Values: Any valid path and filename.
  99 ;   Default: .\memory_leak_report.txt
 100 ;
 101 ReportFile =
 102
 103 ; Sets the report destination to either a file, the debugger, or both. If
 104 ; reporting to file is enabled, the report is sent to the file specified by the
 105 ; ReportFile option.
 106 ;
 107 ;   Valid Values: debugger, file, both
 108 ;   Default: debugger
 109 ;
 110 ReportTo = both
 111
 112 ; Turns on or off a self-test mode which is used to verify that VLD is able to
 113 ; detect memory leaks in itself. Intended to be used for debugging VLD itself,
 114 ; not for debugging other programs.
 115 ;
 116 ;   Valid Values: on, off
 117 ;   Default: off
 118 ;
 119 SelfTest = off
 120
 121 ; Selects the method to be used for walking the stack to obtain stack traces for
 122 ; allocated memory blocks. The "fast" method may not always be able to
 123 ; successfully trace completely through all call stacks. In such cases, the
 124 ; "safe" method may prove to more reliably obtain the full stack trace. The
 125 ; disadvantage is that the "safe" method is significantly slower than the "fast"
 126 ; method and will probably result in very noticeable performance degradation of
 127 ; the program being debugged.
 128 ;
 129 ;   Valid Values: fast, safe
 130 ;   Default: fast
 131 ;
 132 StackWalkMethod = fast
 133
 134 ; Determines whether memory leak detection should be initially enabled for all
 135 ; threads, or whether it should be initially disabled for all threads. If set
 136 ; to "yes", then any threads requiring memory leak detection to be enabled will
 137 ; need to call VLDEnable at some point to enable leak detection for those
 138 ; threads.
 139 ;
 140 ;   Valid Values: yes, no
 141 ;   Default: no
 142 ;
 143 StartDisabled = no
 144
 145 ; Determines whether or not all frames, including frames internal to the heap,
 146 ; are traced. There will always be a number of frames internal to Visual Leak
 147 ; Detector and C/C++ or Win32 heap APIs that aren't generally useful for
 148 ; determining the cause of a leak. Normally these frames are skipped during the
 149 ; stack trace, which somewhat reduces the time spent tracing and amount of data
 150 ; collected and stored in memory. Including all frames in the stack trace, all
 151 ; the way down into VLD's own code can, however, be useful for debugging VLD
 152 ; itself.
 153 ;
 154 ;   Valid Values: yes, no
 155 ;   Default: no
 156 ;
 157 TraceInternalFrames = no