mirror of
https://github.com/Zenithsiz/ftmemsim-valgrind.git
synced 2026-02-04 02:18:37 +00:00
3a803036f7
This patch changes the option parsing framework to allow a set of
core or tool (currently only memcheck) options to be changed dynamically.
Here is a summary of the new functionality (extracted from NEWS):
* It is now possible to dynamically change the value of many command
line options while your program (or its children) are running under
Valgrind.
To have the list of dynamically changeable options, run
valgrind --help-dyn-options
You can change the options from the shell by using vgdb to launch
the monitor command "v.clo <clo option>...".
The same monitor command can be used from a gdb connected
to the valgrind gdbserver.
Your program can also change the dynamically changeable options using
the client request VALGRIND_CLO_CHANGE(option).
Here is a brief description of the code changes.
* the command line options parsing macros are now checking a 'parsing' mode
to decide if the given option must be handled or not.
(more about the parsing mode below).
* the 'main' command option parsing code has been split in a function
'process_option' that can be called now by:
- early_process_cmd_line_options
(looping over args, calling process_option in mode "Early")
- main_process_cmd_line_options
(looping over args, calling process_option in mode "Processing")
- the new function VG_(process_dynamic_option) called from
gdbserver or from VALGRIND_CLO_CHANGE (calling
process_option in mode "Dynamic" or "Help")
* So, now, during startup, process_option is called twice for each arg:
- once during Early phase
- once during normal Processing
Then process_option can then be called again during execution.
So, the parsing mode is defined so that the option parsing code
behaves differently (e.g. allows or not to handle the option)
depending on the mode.
// Command line option parsing happens in the following modes:
// cloE : Early processing, used by coregrind m_main.c to parse the
// command line options that must be handled early on.
// cloP : Processing, used by coregrind and tools during startup, when
// doing command line options Processing.
// clodD : Dynamic, used to dynamically change options after startup.
// A subset of the command line options can be changed dynamically
// after startup.
// cloH : Help, special mode to produce the list of dynamically changeable
// options for --help-dyn-options.
typedef
enum {
cloE = 1,
cloP = 2,
cloD = 4,
cloH = 8
} Clo_Mode;
The option parsing macros in pub_tool_options.h have now all a new variant
*_CLOM with the mode(s) in which the given option is accepted.
The old variant is kept and calls the new variant with mode cloP.
The function VG_(check_clom) in the macro compares the current mode
with the modes allowed for the option, and returns True if qq_arg
should be further processed.
For example:
// String argument, eg. --foo=yes or --foo=no
(VG_(check_clom) \
(qq_mode, qq_arg, qq_option, \
VG_STREQN(VG_(strlen)(qq_option)+1, qq_arg, qq_option"=")) && \
({const HChar* val = &(qq_arg)[ VG_(strlen)(qq_option)+1 ]; \
if VG_STREQ(val, "yes") (qq_var) = True; \
else if VG_STREQ(val, "no") (qq_var) = False; \
else VG_(fmsg_bad_option)(qq_arg, "Invalid boolean value '%s'" \
" (should be 'yes' or 'no')\n", val); \
True; }))
VG_BOOL_CLOM(cloP, qq_arg, qq_option, qq_var)
To make an option dynamically excutable, it is typically enough to replace
VG_BOOL_CLO(...)
by
VG_BOOL_CLOM(cloPD, ...)
For example:
- else if VG_BOOL_CLO(arg, "--show-possibly-lost", tmp_show) {
+ else if VG_BOOL_CLOM(cloPD, arg, "--show-possibly-lost", tmp_show) {
cloPD means the option value is set/changed during the main command
Processing (P) and Dynamically during execution (D).
Note that the 'body/further processing' of a command is only executed when
the option is recognised and the current parsing mode is ok for this option.
161 lines
9.8 KiB
Plaintext
161 lines
9.8 KiB
Plaintext
usage: valgrind [options] prog-and-args
|
|
|
|
tool-selection option, with default in [ ]:
|
|
--tool=<name> use the Valgrind tool named <name> [memcheck]
|
|
|
|
basic user options for all Valgrind tools, with defaults in [ ]:
|
|
-h --help show this message
|
|
--help-debug show this message, plus debugging options
|
|
--help-dyn-options show the dynamically changeable options
|
|
--version show version
|
|
-q --quiet run silently; only print error msgs
|
|
-v --verbose be more verbose -- show misc extra info
|
|
--trace-children=no|yes Valgrind-ise child processes (follow execve)? [no]
|
|
--trace-children-skip=patt1,patt2,... specifies a list of executables
|
|
that --trace-children=yes should not trace into
|
|
--trace-children-skip-by-arg=patt1,patt2,... same as --trace-children-skip=
|
|
but check the argv[] entries for children, rather
|
|
than the exe name, to make a follow/no-follow decision
|
|
--child-silent-after-fork=no|yes omit child output between fork & exec? [no]
|
|
--vgdb=no|yes|full activate gdbserver? [yes]
|
|
full is slower but provides precise watchpoint/step
|
|
--vgdb-error=<number> invoke gdbserver after <number> errors [999999999]
|
|
to get started quickly, use --vgdb-error=0
|
|
and follow the on-screen directions
|
|
--vgdb-stop-at=event1,event2,... invoke gdbserver for given events [none]
|
|
where event is one of:
|
|
startup exit valgrindabexit all none
|
|
--track-fds=no|yes track open file descriptors? [no]
|
|
--time-stamp=no|yes add timestamps to log messages? [no]
|
|
--log-fd=<number> log messages to file descriptor [2=stderr]
|
|
--log-file=<file> log messages to <file>
|
|
--log-socket=ipaddr:port log messages to socket ipaddr:port
|
|
|
|
user options for Valgrind tools that report errors:
|
|
--xml=yes emit error output in XML (some tools only)
|
|
--xml-fd=<number> XML output to file descriptor
|
|
--xml-file=<file> XML output to <file>
|
|
--xml-socket=ipaddr:port XML output to socket ipaddr:port
|
|
--xml-user-comment=STR copy STR verbatim into XML output
|
|
--demangle=no|yes automatically demangle C++ names? [yes]
|
|
--num-callers=<number> show <number> callers in stack traces [12]
|
|
--error-limit=no|yes stop showing new errors if too many? [yes]
|
|
--exit-on-first-error=no|yes exit code on the first error found? [no]
|
|
--error-exitcode=<number> exit code to return if errors found [0=disable]
|
|
--error-markers=<begin>,<end> add lines with begin/end markers before/after
|
|
each error output in plain text mode [none]
|
|
--show-error-list=no|yes show detected errors list and
|
|
suppression counts at exit [no]
|
|
-s same as --show-error-list=yes
|
|
--keep-debuginfo=no|yes Keep symbols etc for unloaded code [no]
|
|
This allows saved stack traces (e.g. memory leaks)
|
|
to include file/line info for code that has been
|
|
dlclose'd (or similar)
|
|
--show-below-main=no|yes continue stack traces below main() [no]
|
|
--default-suppressions=yes|no
|
|
load default suppressions [yes]
|
|
--suppressions=<filename> suppress errors described in <filename>
|
|
--gen-suppressions=no|yes|all print suppressions for errors? [no]
|
|
--input-fd=<number> file descriptor for input [0=stdin]
|
|
--dsymutil=no|yes run dsymutil on Mac OS X when helpful? [yes]
|
|
--max-stackframe=<number> assume stack switch for SP changes larger
|
|
than <number> bytes [2000000]
|
|
--main-stacksize=<number> set size of main thread's stack (in bytes)
|
|
[min(max(current 'ulimit' value,1MB),16MB)]
|
|
|
|
user options for Valgrind tools that replace malloc:
|
|
--alignment=<number> set minimum alignment of heap allocations [not used by this tool]
|
|
--redzone-size=<number> set minimum size of redzones added before/after
|
|
heap blocks (in bytes). [not used by this tool]
|
|
--xtree-memory=none|allocs|full profile heap memory in an xtree [none]
|
|
and produces a report at the end of the execution
|
|
none: no profiling, allocs: current allocated
|
|
size/blocks, full: profile current and cumulative
|
|
allocated size/blocks and freed size/blocks.
|
|
--xtree-memory-file=<file> xtree memory report file [xtmemory.kcg.%p]
|
|
|
|
uncommon user options for all Valgrind tools:
|
|
--fullpath-after= (with nothing after the '=')
|
|
show full source paths in call stacks
|
|
--fullpath-after=string like --fullpath-after=, but only show the
|
|
part of the path after 'string'. Allows removal
|
|
of path prefixes. Use this flag multiple times
|
|
to specify a set of prefixes to remove.
|
|
--extra-debuginfo-path=path absolute path to search for additional
|
|
debug symbols, in addition to existing default
|
|
well known search paths.
|
|
--debuginfo-server=ipaddr:port also query this server
|
|
(valgrind-di-server) for debug symbols
|
|
--allow-mismatched-debuginfo=no|yes [no]
|
|
for the above two flags only, accept debuginfo
|
|
objects that don't "match" the main object
|
|
--smc-check=none|stack|all|all-non-file [all-non-file]
|
|
checks for self-modifying code: none, only for
|
|
code found in stacks, for all code, or for all
|
|
code except that from file-backed mappings
|
|
--read-inline-info=yes|no read debug info about inlined function calls
|
|
and use it to do better stack traces.
|
|
[yes] on Linux/Android/Solaris for the tools
|
|
Memcheck/Massif/Helgrind/DRD only.
|
|
[no] for all other tools and platforms.
|
|
--read-var-info=yes|no read debug info on stack and global variables
|
|
and use it to print better error messages in
|
|
tools that make use of it (Memcheck, Helgrind,
|
|
DRD) [no]
|
|
--vgdb-poll=<number> gdbserver poll max every <number> basic blocks [5000]
|
|
--vgdb-shadow-registers=no|yes let gdb see the shadow registers [no]
|
|
--vgdb-prefix=<prefix> prefix for vgdb FIFOs [.../vgdb-pipe]
|
|
--run-libc-freeres=no|yes free up glibc memory at exit on Linux? [yes]
|
|
--run-cxx-freeres=no|yes free up libstdc++ memory at exit on Linux
|
|
and Solaris? [yes]
|
|
--sim-hints=hint1,hint2,... activate unusual sim behaviours [none]
|
|
where hint is one of:
|
|
lax-ioctls lax-doors fuse-compatible enable-outer
|
|
no-inner-prefix no-nptl-pthread-stackcache fallback-llsc none
|
|
--fair-sched=no|yes|try schedule threads fairly on multicore systems [no]
|
|
--kernel-variant=variant1,variant2,...
|
|
handle non-standard kernel variants [none]
|
|
where variant is one of:
|
|
bproc android-no-hw-tls
|
|
android-gpu-sgx5xx android-gpu-adreno3xx none
|
|
--merge-recursive-frames=<number> merge frames between identical
|
|
program counters in max <number> frames) [0]
|
|
--num-transtab-sectors=<number> size of translated code cache [32]
|
|
more sectors may increase performance, but use more memory.
|
|
--avg-transtab-entry-size=<number> avg size in bytes of a translated
|
|
basic block [0, meaning use tool provided default]
|
|
--aspace-minaddr=0xPP avoid mapping memory below 0xPP [guessed]
|
|
--valgrind-stacksize=<number> size of valgrind (host) thread's stack
|
|
(in bytes) [1048576]
|
|
--show-emwarns=no|yes show warnings about emulation limits? [no]
|
|
--require-text-symbol=:sonamepattern:symbolpattern abort run if the
|
|
stated shared object doesn't have the stated
|
|
text symbol. Patterns can contain ? and *.
|
|
--soname-synonyms=syn1=pattern1,syn2=pattern2,... synonym soname
|
|
specify patterns for function wrapping or replacement.
|
|
To use a non-libc malloc library that is
|
|
in the main exe: --soname-synonyms=somalloc=NONE
|
|
in libxyzzy.so: --soname-synonyms=somalloc=libxyzzy.so
|
|
--sigill-diagnostics=yes|no warn about illegal instructions? [yes]
|
|
--unw-stack-scan-thresh=<number> Enable stack-scan unwind if fewer
|
|
than <number> good frames found [0, meaning "disabled"]
|
|
NOTE: stack scanning is only available on arm-linux.
|
|
--unw-stack-scan-frames=<number> Max number of frames that can be
|
|
recovered by stack scanning [5]
|
|
--resync-filter=no|yes|verbose [yes on MacOS, no on other OSes]
|
|
attempt to avoid expensive address-space-resync operations
|
|
--max-threads=<number> maximum number of threads that valgrind can
|
|
handle [500]
|
|
|
|
user options for Nulgrind:
|
|
(none)
|
|
|
|
Extra options read from ~/.valgrindrc, $VALGRIND_OPTS, ./.valgrindrc
|
|
|
|
Nulgrind is Copyright (C) 2002-2017, and GNU GPL'd, by Nicholas Nethercote.
|
|
Valgrind is Copyright (C) 2000-2017, and GNU GPL'd, by Julian Seward et al.
|
|
LibVEX is Copyright (C) 2004-2017, and GNU GPL'd, by OpenWorks LLP et al.
|
|
|
|
Bug reports, feedback, admiration, abuse, etc, to: www.valgrind.org.
|
|
|