blob: c679f6e3e08b4186ad161294412422a8e5b715c8 [file] [log] [blame]
njn00cfcfc2005-11-12 18:53:50 +00001usage: valgrind [options] prog-and-args
nethercotef4928da2004-06-15 10:54:40 +00002
njn97db7612009-08-04 02:32:55 +00003 tool-selection option, with default in [ ]:
sewardjb5f6f512005-03-10 23:59:00 +00004 --tool=<name> use the Valgrind tool named <name> [memcheck]
njn97db7612009-08-04 02:32:55 +00005
6 basic user options for all Valgrind tools, with defaults in [ ]:
nethercotea76368b2004-06-16 11:56:29 +00007 -h --help show this message
nethercotef4928da2004-06-15 10:54:40 +00008 --help-debug show this message, plus debugging options
9 --version show version
10 -q --quiet run silently; only print error msgs
sewardj2d9e8742009-08-07 15:46:56 +000011 -v --verbose be more verbose -- show misc extra info
njn374a36d2007-11-23 01:41:32 +000012 --trace-children=no|yes Valgrind-ise child processes (follow execve)? [no]
sewardj06421272009-11-05 08:55:13 +000013 --trace-children-skip=patt1,patt2,... specifies a list of executables
14 that --trace-children=yes should not trace into
sewardj9ab64a42010-12-06 11:40:04 +000015 --trace-children-skip-by-arg=patt1,patt2,... same as --trace-children-skip=
16 but check the argv[] entries for children, rather
17 than the exe name, to make a follow/no-follow decision
njn97db7612009-08-04 02:32:55 +000018 --child-silent-after-fork=no|yes omit child output between fork & exec? [no]
sewardj3b290482011-05-06 21:02:55 +000019 --vgdb=no|yes|full activate gdbserver? [yes]
20 full is slower but provides precise watchpoint/step
sewardj1568e172011-06-18 08:28:04 +000021 --vgdb-error=<number> invoke gdbserver after <number> errors [999999999]
22 to get started quickly, use --vgdb-error=0
23 and follow the on-screen directions
philippe180a7502014-04-20 13:41:10 +000024 --vgdb-stop-at=event1,event2,... invoke gdbserver for given events [none]
25 where event is one of startup exit valgrindabexit all none
nethercote0d588502004-06-21 13:27:11 +000026 --track-fds=no|yes track open file descriptors? [no]
thughes6233a382004-08-21 11:10:44 +000027 --time-stamp=no|yes add timestamps to log messages? [no]
njnce545552005-07-25 22:36:52 +000028 --log-fd=<number> log messages to file descriptor [2=stderr]
njn374a36d2007-11-23 01:41:32 +000029 --log-file=<file> log messages to <file>
njnce545552005-07-25 22:36:52 +000030 --log-socket=ipaddr:port log messages to socket ipaddr:port
nethercotef4928da2004-06-15 10:54:40 +000031
nethercotef4928da2004-06-15 10:54:40 +000032 user options for Valgrind tools that report errors:
sewardj8fd87582009-07-15 14:52:02 +000033 --xml=yes emit error output in XML (some tools only)
34 --xml-fd=<number> XML output to file descriptor
35 --xml-file=<file> XML output to <file>
36 --xml-socket=ipaddr:port XML output to socket ipaddr:port
37 --xml-user-comment=STR copy STR verbatim into XML output
nethercotef4928da2004-06-15 10:54:40 +000038 --demangle=no|yes automatically demangle C++ names? [yes]
njn20b4a152005-10-19 22:39:40 +000039 --num-callers=<number> show <number> callers in stack traces [12]
nethercotef4928da2004-06-15 10:54:40 +000040 --error-limit=no|yes stop showing new errors if too many? [yes]
sewardj365985f2006-05-13 01:54:15 +000041 --error-exitcode=<number> exit code to return if errors found [0=disable]
nethercotef4928da2004-06-15 10:54:40 +000042 --show-below-main=no|yes continue stack traces below main() [no]
bart73e9a012014-06-22 11:13:47 +000043 --defaultsupp=yes|no load default suppressions [yes]
nethercotef4928da2004-06-15 10:54:40 +000044 --suppressions=<filename> suppress errors described in <filename>
sewardj09272c72005-01-11 14:21:02 +000045 --gen-suppressions=no|yes|all print suppressions for errors? [no]
nethercotef4928da2004-06-15 10:54:40 +000046 --db-attach=no|yes start debugger when errors detected? [no]
bart0f212dc2009-08-20 18:38:59 +000047 --db-command=<command> command to start debugger [... -nw %f %p]
nethercotef4928da2004-06-15 10:54:40 +000048 --input-fd=<number> file descriptor for input [0=stdin]
njn97db7612009-08-04 02:32:55 +000049 --dsymutil=no|yes run dsymutil on Mac OS X when helpful? [no]
sewardj412ad6e2005-04-03 00:16:11 +000050 --max-stackframe=<number> assume stack switch for SP changes larger
51 than <number> bytes [2000000]
sewardj95d86c02007-12-18 01:49:23 +000052 --main-stacksize=<number> set size of main thread's stack (in bytes)
philippe3bcd51d2013-06-12 21:45:39 +000053 [min(max(current 'ulimit' value,1MB),16MB)]
nethercotef4928da2004-06-15 10:54:40 +000054
njn97db7612009-08-04 02:32:55 +000055 user options for Valgrind tools that replace malloc:
philipped99c26a2012-07-31 22:17:28 +000056 --alignment=<number> set minimum alignment of heap allocations [not used by this tool]
57 --redzone-size=<number> set minimum size of redzones added before/after
58 heap blocks (in bytes). [not used by this tool]
njn97db7612009-08-04 02:32:55 +000059
60 uncommon user options for all Valgrind tools:
sewardj14cdbf82010-10-12 00:44:05 +000061 --fullpath-after= (with nothing after the '=')
62 show full source paths in call stacks
63 --fullpath-after=string like --fullpath-after=, but only show the
64 part of the path after 'string'. Allows removal
65 of path prefixes. Use this flag multiple times
66 to specify a set of prefixes to remove.
sewardj8b6573d2012-12-05 22:15:14 +000067 --extra-debuginfo-path=path absolute path to search for additional
68 debug symbols, in addition to existing default
69 well known search paths.
sewardje5b6cc42013-07-02 20:47:24 +000070 --debuginfo-server=ipaddr:port also query this server
71 (valgrind-di-server) for debug symbols
72 --allow-mismatched-debuginfo=no|yes [no]
73 for the above two flags only, accept debuginfo
74 objects that don't "match" the main object
sewardj6dbcc632011-06-07 21:39:28 +000075 --smc-check=none|stack|all|all-non-file [stack]
76 checks for self-modifying code: none, only for
77 code found in stacks, for all code, or for all
78 code except that from file-backed mappings
philippea0a73932014-06-15 15:42:20 +000079 --read-inline-info=yes|no read debug info about inlined function calls
80 and use it to do better stack traces [no]
njn97db7612009-08-04 02:32:55 +000081 --read-var-info=yes|no read debug info on stack and global variables
82 and use it to print better error messages in
83 tools that make use of it (Memcheck, Helgrind,
bartf6122a02010-03-27 07:38:39 +000084 DRD) [no]
sewardj3b290482011-05-06 21:02:55 +000085 --vgdb-poll=<number> gdbserver poll max every <number> basic blocks [5000]
86 --vgdb-shadow-registers=no|yes let gdb see the shadow registers [no]
87 --vgdb-prefix=<prefix> prefix for vgdb FIFOs [/tmp/vgdb-pipe]
njn97db7612009-08-04 02:32:55 +000088 --run-libc-freeres=no|yes free up glibc memory at exit on Linux? [yes]
89 --sim-hints=hint1,hint2,... known hints:
sewardjcc3de2d2011-08-18 15:08:20 +000090 lax-ioctls, enable-outer, fuse-compatible [none]
bart78bfc712011-12-08 16:14:59 +000091 --fair-sched=no|yes|try schedule threads fairly on multicore systems [no]
njn97db7612009-08-04 02:32:55 +000092 --kernel-variant=variant1,variant2,... known variants: bproc [none]
93 handle non-standard kernel variants
philippe46207652013-01-20 17:11:58 +000094 --merge-recursive-frames=<number> merge frames between identical
95 program counters in max <number> frames) [0]
philippe8e1bee42013-10-18 00:08:20 +000096 --num-transtab-sectors=<number> size of translated code cache [16]
sewardja11ec172013-10-18 11:18:45 +000097 more sectors may increase performance, but use more memory.
philippee4d78122014-04-20 14:20:37 +000098 --aspace-minaddr=0xPP avoid mapping memory below 0xPP [guessed]
njn97db7612009-08-04 02:32:55 +000099 --show-emwarns=no|yes show warnings about emulation limits? [no]
sewardjf9ebc392010-05-09 22:30:43 +0000100 --require-text-symbol=:sonamepattern:symbolpattern abort run if the
101 stated shared object doesn't have the stated
102 text symbol. Patterns can contain ? and *.
philippe1e470b52012-05-11 19:33:46 +0000103 --soname-synonyms=syn1=pattern1,syn2=pattern2,... synonym soname
sewardj260c6482012-08-07 14:46:34 +0000104 specify patterns for function wrapping or replacement.
105 To use a non-libc malloc library that is
106 in the main exe: --soname-synonyms=somalloc=NONE
107 in libxyzzy.so: --soname-synonyms=somalloc=libxyzzy.so
sewardjc30cd9b2012-12-06 18:08:54 +0000108 --sigill-diagnostics=yes|no warn about illegal instructions? [yes]
sewardj49984ea2013-10-18 13:21:26 +0000109 --unw-stack-scan-thresh=<number> Enable stack-scan unwind if fewer
110 than <number> good frames found [0, meaning "disabled"]
111 NOTE: stack scanning is only available on arm-linux.
112 --unw-stack-scan-frames=<number> Max number of frames that can be
113 recovered by stack scanning [5]
njn97db7612009-08-04 02:32:55 +0000114
njn7eea51f2004-11-26 12:54:07 +0000115 user options for Nulgrind:
116 (none)
nethercotef4928da2004-06-15 10:54:40 +0000117
118 debugging options for all Valgrind tools:
njn97db7612009-08-04 02:32:55 +0000119 -d show verbose debugging output
njnb1cc5d62010-07-06 04:05:23 +0000120 --stats=no|yes show tool and core statistics [no]
nethercotef4928da2004-06-15 10:54:40 +0000121 --sanity-level=<number> level of sanity checking to do [1]
sewardjfa8ec112005-01-19 11:55:34 +0000122 --trace-flags=<XXXXXXXX> show generated code? (X = 0|1) [00000000]
123 --profile-flags=<XXXXXXXX> ditto, but for profiling (X = 0|1) [00000000]
sewardj17c5e2e2012-12-28 09:12:14 +0000124 --profile-interval=<number> show profile every <number> event checks
125 [0, meaning only at the end of the run]
sewardj33afdb52006-01-17 02:36:40 +0000126 --trace-notbelow=<number> only show BBs above <number> [999999999]
florian9aa15b72012-07-03 13:58:59 +0000127 --trace-notabove=<number> only show BBs below <number> [0]
nethercotef4928da2004-06-15 10:54:40 +0000128 --trace-syscalls=no|yes show all system calls? [no]
129 --trace-signals=no|yes show signal handling details? [no]
130 --trace-symtab=no|yes show symbol table details? [no]
sewardj8af928c2007-02-13 10:24:32 +0000131 --trace-symtab-patt=<patt> limit debuginfo tracing to obj name <patt>
sewardj1dd628a2005-05-03 16:44:31 +0000132 --trace-cfi=no|yes show call-frame-info details? [no]
sewardj8af928c2007-02-13 10:24:32 +0000133 --debug-dump=syms mimic /usr/bin/readelf --syms
134 --debug-dump=line mimic /usr/bin/readelf --debug-dump=line
135 --debug-dump=frames mimic /usr/bin/readelf --debug-dump=frames
sewardj0ec07f32006-01-12 12:32:32 +0000136 --trace-redir=no|yes show redirection details? [no]
nethercotef4928da2004-06-15 10:54:40 +0000137 --trace-sched=no|yes show thread scheduler details? [no]
sewardj6f089c72008-11-08 15:05:49 +0000138 --profile-heap=no|yes profile Valgrind's own space use
philippe06444372012-10-12 21:46:55 +0000139 --core-redzone-size=<number> set minimum size of redzones added before/after
philipped99c26a2012-07-31 22:17:28 +0000140 heap blocks allocated for Valgrind internal use (in bytes) [4]
nethercotef4928da2004-06-15 10:54:40 +0000141 --wait-for-gdb=yes|no pause on startup to wait for gdb attach
sewardj3477e8c2006-10-17 11:08:12 +0000142 --sym-offsets=yes|no show syms in form 'name+offset' ? [no]
sewardjb5f6f512005-03-10 23:59:00 +0000143 --command-line-only=no|yes only use command line options [no]
njn613812e2005-03-11 04:57:30 +0000144
njn97db7612009-08-04 02:32:55 +0000145 Vex options for all Valgrind tools:
146 --vex-iropt-verbosity=<0..9> [0]
147 --vex-iropt-level=<0..2> [2]
philippe5b240c22012-08-14 22:28:31 +0000148 --vex-iropt-register-updates=sp-at-mem-access
149 |unwindregs-at-mem-access
philippe0c0291a2012-08-01 22:03:12 +0000150 |allregs-at-mem-access
151 |allregs-at-each-insn [unwindregs-at-mem-access]
njn97db7612009-08-04 02:32:55 +0000152 --vex-iropt-unroll-thresh=<0..400> [120]
153 --vex-guest-max-insns=<1..100> [50]
154 --vex-guest-chase-thresh=<0..99> [10]
sewardj540cc4a2010-01-15 10:57:57 +0000155 --vex-guest-chase-cond=no|yes [no]
sewardjfa8ec112005-01-19 11:55:34 +0000156 --trace-flags and --profile-flags values (omit the middle space):
sewardj0dbb7de2004-11-26 12:37:10 +0000157 1000 0000 show conversion into IR
158 0100 0000 show after initial opt
159 0010 0000 show after instrumentation
160 0001 0000 show after second opt
161 0000 1000 show after tree building
162 0000 0100 show selecting insns
163 0000 0010 show after reg-alloc
164 0000 0001 show final assembly
sewardj17c5e2e2012-12-28 09:12:14 +0000165 0000 0000 show summary profile only
sewardje5b6cc42013-07-02 20:47:24 +0000166 (Nb: you need --trace-notbelow and/or --trace-notabove
167 with --trace-flags for full details)
sewardj0dbb7de2004-11-26 12:37:10 +0000168
nethercotef4928da2004-06-15 10:54:40 +0000169 debugging options for Valgrind tools that report errors
170 --dump-error=<number> show translation for basic block associated
171 with <number>'th error context [0=show none]
172
njn97db7612009-08-04 02:32:55 +0000173 debugging options for Valgrind tools that replace malloc:
174 --trace-malloc=no|yes show client malloc details? [no]
175
njn7eea51f2004-11-26 12:54:07 +0000176 debugging options for Nulgrind:
177 (none)
nethercotef4928da2004-06-15 10:54:40 +0000178
179 Extra options read from ~/.valgrindrc, $VALGRIND_OPTS, ./.valgrindrc
180
sewardj0f157dd2013-10-18 14:27:36 +0000181 Nulgrind is Copyright (C) 2002-2013, and GNU GPL'd, by Nicholas Nethercote.
182 Valgrind is Copyright (C) 2000-2013, and GNU GPL'd, by Julian Seward et al.
183 LibVEX is Copyright (C) 2004-2013, and GNU GPL'd, by OpenWorks LLP et al.
nethercotef4928da2004-06-15 10:54:40 +0000184
njn10b9aea2009-07-14 06:55:05 +0000185 Bug reports, feedback, admiration, abuse, etc, to: www.valgrind.org.
nethercotef4928da2004-06-15 10:54:40 +0000186