1 usage: valgrind [options] prog-and-args
3 tool-selection option, with default in [ ]:
4 --tool=<name> use the Valgrind tool named <name> [memcheck]
6 memcheck cachegrind callgrind helgrind drd
7 massif dhat lackey none exp-bbv
9 basic user options for all Valgrind tools, with defaults in [ ]:
10 -h --help show this message
11 --help-debug show this message, plus debugging options
12 --help-dyn-options show the dynamically changeable options
13 --version show version
14 -q --quiet run silently; only print error msgs
15 -v --verbose be more verbose -- show misc extra info
16 --trace-children=no|yes Valgrind-ise child processes (follow execve)? [no]
17 --trace-children-skip=patt1,patt2,... specifies a list of executables
18 that --trace-children=yes should not trace into
19 --trace-children-skip-by-arg=patt1,patt2,... same as --trace-children-skip=
20 but check the argv[] entries for children, rather
21 than the exe name, to make a follow/no-follow decision
22 --child-silent-after-fork=no|yes omit child output between fork & exec? [no]
23 --vgdb=no|yes|full activate gdbserver? [yes]
24 full is slower but provides precise watchpoint/step
25 --vgdb-error=<number> invoke gdbserver after <number> errors [999999999]
26 to get started quickly, use --vgdb-error=0
27 and follow the on-screen directions
28 --vgdb-stop-at=event1,event2,... invoke gdbserver for given events [none]
29 where event is one of:
30 startup exit abexit valgrindabexit all none
31 --track-fds=no|yes|all track open file descriptors? [no]
32 all includes reporting stdin, stdout and stderr
33 --time-stamp=no|yes add timestamps to log messages? [no]
34 --log-fd=<number> log messages to file descriptor [2=stderr]
35 --log-file=<file> log messages to <file>
36 --log-socket=ipaddr:port log messages to socket ipaddr:port
38 user options for Valgrind tools that report errors:
39 --xml=yes emit error output in XML (some tools only)
40 --xml-fd=<number> XML output to file descriptor
41 --xml-file=<file> XML output to <file>
42 --xml-socket=ipaddr:port XML output to socket ipaddr:port
43 --xml-user-comment=STR copy STR verbatim into XML output
44 --demangle=no|yes automatically demangle decorated names? [yes]
45 supported languages: C++, D, Rust, Java, Ada
46 --num-callers=<number> show <number> callers in stack traces [12]
47 --error-limit=no|yes stop showing new errors if too many? [yes]
48 --exit-on-first-error=no|yes exit code on the first error found? [no]
49 --error-exitcode=<number> exit code to return if errors found [0=disable]
50 --error-markers=<begin>,<end> add lines with begin/end markers before/after
51 each error output in plain text mode [none]
52 --show-error-list=no|yes|all show detected errors list and
53 suppression counts at exit [no].
54 all means to also print suppressed errors.
55 -s same as --show-error-list=yes
56 --keep-debuginfo=no|yes Keep symbols etc for unloaded code [no]
57 This allows saved stack traces (e.g. memory leaks)
58 to include file/line info for code that has been
59 dlclose'd (or similar)
60 --show-below-main=no|yes continue stack traces below main() [no]
61 --default-suppressions=yes|no
62 load default suppressions [yes]
63 --suppressions=<filename> suppress errors described in <filename>
64 --gen-suppressions=no|yes|all print suppressions for errors? [no]
65 --input-fd=<number> file descriptor for input [0=stdin]
66 --dsymutil=no|yes run dsymutil on Mac OS X when helpful? [yes]
67 --max-stackframe=<number> assume stack switch for SP changes larger
68 than <number> bytes [2000000]
69 --main-stacksize=<number> set size of main thread's stack (in bytes)
70 [min(max(current 'ulimit' value,1MB),16MB)]
72 user options for Valgrind tools that replace malloc:
73 --alignment=<number> set minimum alignment of heap allocations [not used by this tool]
74 --redzone-size=<number> set minimum size of redzones added before/after
75 heap blocks (in bytes). [not used by this tool]
76 --xtree-memory=none|allocs|full profile heap memory in an xtree [none]
77 and produces a report at the end of the execution
78 none: no profiling, allocs: current allocated
79 size/blocks, full: profile current and cumulative
80 allocated size/blocks and freed size/blocks.
81 --xtree-memory-file=<file> xtree memory report file [xtmemory.kcg.%p]
82 --realloc-zero-bytes-frees=yes|no [yes on Linux glibc, no otherwise]
83 should calls to realloc with a size of 0
84 free memory and return NULL or
85 allocate/resize and return non-NULL
87 uncommon user options for all Valgrind tools:
88 --fullpath-after= (with nothing after the '=')
89 show full source paths in call stacks
90 --fullpath-after=string like --fullpath-after=, but only show the
91 part of the path after 'string'. Allows removal
92 of path prefixes. Use this flag multiple times
93 to specify a set of prefixes to remove.
94 --extra-debuginfo-path=path absolute path to search for additional
95 debug symbols, in addition to existing default
96 well known search paths.
97 --debuginfo-server=ipaddr:port also query this server
98 (valgrind-di-server) for debug symbols
99 --allow-mismatched-debuginfo=no|yes [no]
100 for the above two flags only, accept debuginfo
101 objects that don't "match" the main object
102 --smc-check=none|stack|all|all-non-file [all-non-file]
103 checks for self-modifying code: none, only for
104 code found in stacks, for all code, or for all
105 code except that from file-backed mappings
106 --read-inline-info=yes|no read debug info about inlined function calls
107 and use it to do better stack traces.
108 [yes] on Linux/Android/Solaris for the tools
109 Memcheck/Massif/Helgrind/DRD only.
110 [no] for all other tools and platforms.
111 --read-var-info=yes|no read debug info on stack and global variables
112 and use it to print better error messages in
113 tools that make use of it (Memcheck, Helgrind,
115 --vgdb-poll=<number> gdbserver poll max every <number> basic blocks [5000]
116 --vgdb-shadow-registers=no|yes let gdb see the shadow registers [no]
117 --vgdb-prefix=<prefix> prefix for vgdb FIFOs [.../vgdb-pipe]
118 --run-libc-freeres=no|yes free up glibc memory at exit on Linux? [yes]
119 --run-cxx-freeres=no|yes free up libstdc++ memory at exit on Linux
121 --sim-hints=hint1,hint2,... activate unusual sim behaviours [none]
122 where hint is one of:
123 lax-ioctls lax-doors fuse-compatible enable-outer
124 no-inner-prefix no-nptl-pthread-stackcache fallback-llsc none
125 --scheduling-quantum=<number> thread-scheduling timeslice in number of
126 basic blocks [100000]
127 --fair-sched=no|yes|try schedule threads fairly on multicore systems [no]
128 --kernel-variant=variant1,variant2,...
129 handle non-standard kernel variants [none]
130 where variant is one of:
131 bproc android-no-hw-tls
132 android-gpu-sgx5xx android-gpu-adreno3xx none
133 --merge-recursive-frames=<number> merge frames between identical
134 program counters in max <number> frames) [0]
135 --num-transtab-sectors=<number> size of translated code cache [32]
136 more sectors may increase performance, but use more memory.
137 --avg-transtab-entry-size=<number> avg size in bytes of a translated
138 basic block [0, meaning use tool provided default]
139 --aspace-minaddr=0xPP avoid mapping memory below 0xPP [guessed]
140 --valgrind-stacksize=<number> size of valgrind (host) thread's stack
142 --show-emwarns=no|yes show warnings about emulation limits? [no]
143 --require-text-symbol=:sonamepattern:symbolpattern abort run if the
144 stated shared object doesn't have the stated
145 text symbol. Patterns can contain ? and *.
146 --soname-synonyms=syn1=pattern1,syn2=pattern2,... synonym soname
147 specify patterns for function wrapping or replacement.
148 To use a non-libc malloc library that is
149 in the main exe: --soname-synonyms=somalloc=NONE
150 in libxyzzy.so: --soname-synonyms=somalloc=libxyzzy.so
151 --sigill-diagnostics=yes|no warn about illegal instructions? [yes]
152 --unw-stack-scan-thresh=<number> Enable stack-scan unwind if fewer
153 than <number> good frames found [0, meaning "disabled"]
154 NOTE: stack scanning is only available on arm-linux.
155 --unw-stack-scan-frames=<number> Max number of frames that can be
156 recovered by stack scanning [5]
157 --resync-filter=no|yes|verbose [yes on MacOS, no on other OSes]
158 attempt to avoid expensive address-space-resync operations
159 --max-threads=<number> maximum number of threads that valgrind can
162 user options for Nulgrind:
165 Extra options read from ~/.valgrindrc, $VALGRIND_OPTS, ./.valgrindrc
167 Nulgrind is Copyright (C) 2000, and GNU GPL'd, by Nicholas Nethercote et al.
168 Valgrind is Copyright (C) 2000, and GNU GPL'd, by Julian Seward et al.
169 LibVEX is Copyright (C) 2000, and GNU GPL'd, by OpenWorks LLP et al.
171 Bug reports, feedback, admiration, abuse, etc, to: www.valgrind.org.