|
NAME | SYNOPSIS | DESCRIPTION | OPTIONS | SEE ALSO | AUTHOR | COLOPHON |
|
|
|
CG_ANNOTATE(1) cg_annotate CG_ANNOTATE(1)
cg_annotate - post-processing tool for Cachegrind
cg_annotate [options] cachegrind-out-file [source-files...]
cg_annotate takes an output file produced by the Valgrind tool
Cachegrind and prints the information in an easy-to-read form.
-h --help
Show the help message.
--version
Show the version number.
--show=A,B,C [default: all, using order in cachegrind.out.<pid>]
Specifies which events to show (and the column order).
Default is to use all present in the cachegrind.out.<pid>
file (and use the order in the file). Useful if you want to
concentrate on, for example, I cache misses
(--show=I1mr,ILmr), or data read misses (--show=D1mr,DLmr),
or LL data misses (--show=DLmr,DLmw). Best used in
conjunction with --sort.
--sort=A,B,C [default: order in cachegrind.out.<pid>]
Specifies the events upon which the sorting of the
function-by-function entries will be based.
--threshold=X [default: 0.1%]
Sets the threshold for the function-by-function summary. A
function is shown if it accounts for more than X% of the
counts for the primary sort event. If auto-annotating, also
affects which files are annotated.
Note: thresholds can be set for more than one of the events
by appending any events for the --sort option with a colon
and a number (no spaces, though). E.g. if you want to see
each function that covers more than 1% of LL read misses or
1% of LL write misses, use this option:
--sort=DLmr:1,DLmw:1
--show-percs=<no|yes> [default: yes]
When enabled, a percentage is printed next to all event
counts. This helps gauge the relative importance of each
function and line.
--auto=<no|yes> [default: yes]
When enabled, automatically annotates every file that is
mentioned in the function-by-function summary that can be
found. Also gives a list of those that couldn't be found.
--context=N [default: 8]
Print N lines of context before and after each annotated
line. Avoids printing large sections of source files that
were not executed. Use a large number (e.g. 100000) to show
all source lines.
-I<dir> --include=<dir> [default: none]
Adds a directory to the list in which to search for files.
Multiple -I/--include options can be given to add multiple
directories.
valgrind(1), $INSTALL/share/doc/valgrind/html/index.html or
http://www.valgrind.org/docs/manual/index.html.
Nicholas Nethercote.
This page is part of the valgrind (a system for debugging and
profiling Linux programs) project. Information about the project
can be found at ⟨http://www.valgrind.org/⟩. If you have a bug
report for this manual page, see
⟨http://www.valgrind.org/support/bug_reports.html⟩. This page
was obtained from the project's upstream Git repository
⟨http://sourceware.org/git/valgrind.git⟩ on 2022-12-17. (At that
time, the date of the most recent commit that was found in the
repository was 2022-11-18.) If you discover any rendering
problems in this HTML version of the page, or you believe there
is a better or more up-to-date source for the page, or you have
corrections or improvements to the information in this COLOPHON
(which is not part of the original manual page), send a mail to
man-pages@man7.org
Release 3.21.0.GIT 12/17/2022 CG_ANNOTATE(1)
Pages that refer to this page: cg_diff(1), cg_merge(1), valgrind(1)
|
HTML rendering created 2022-12-18 by Michael Kerrisk, author of The Linux Programming Interface, maintainer of the Linux man-pages project. For details of in-depth Linux/UNIX system programming training courses that I teach, look here. Hosting by jambit GmbH. |
|