Go to main content

man pages section 1: User Commands

Exit Print View

Updated: Wednesday, February 9, 2022
 
 

callgrind_annotate (1)

Name

callgrind_annotate - processing tool for the Callgrind

Synopsis

callgrind_annotate [options] [callgrind-out-file [source-files...]]

Description

CALLGRIND ANNOTATE(1)         callgrind_annotate         CALLGRIND ANNOTATE(1)



NAME
       callgrind_annotate - post-processing tool for the Callgrind

SYNOPSIS
       callgrind_annotate [options] [callgrind-out-file [source-files...]]

DESCRIPTION
       callgrind_annotate takes an output file produced by the Valgrind tool
       Callgrind and prints the information in an easy-to-read form.

OPTIONS
       -h --help
           Show summary of options.

       --version
           Show version of callgrind_annotate.

       --show=A,B,C [default: all]
           Only show figures for events A,B,C.

       --threshold=<0--100> [default: 99%]
           Percentage of counts (of primary sort event) we are interested in.

           callgrind_annotate stops printing functions when the sum of the
           cost percentage of the printed functions is bigger or equal to the
           given threshold percentage.

       --sort=A,B,C
           Sort columns by events A,B,C [event column order].

           Optionally, each event is followed by a : and a threshold, to
           specify different thresholds depending on the event.

           callgrind_annotate stops printing functions when the sum of the
           cost percentage of the printed functions for all the events is
           bigger or equal to the given event threshold percentages.

           When one or more thresholds are given via this option, the value of
           --threshold is ignored.

       --show-percs=<no|yes> [default: no]
           When enabled, a percentage is printed next to all event counts.
           This helps gauge the relative importance of each function and line.

       --auto=<yes|no> [default: yes]
           Annotate all source files containing functions that helped reach
           the event count threshold.

       --context=N [default: 8]
           Print N lines of context before and after annotated lines.

       --inclusive=<yes|no> [default: no]
           Add subroutine costs to functions calls.

       --tree=<none|caller|calling|both> [default: none]
           Print for each function their callers, the called functions or
           both.

       -I, --include=<dir>
           Add dir to the list of directories to search for source files.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+--------------------------+
       |ATTRIBUTE TYPE |     ATTRIBUTE VALUE      |
       +---------------+--------------------------+
       |Availability   | developer/debug/valgrind |
       +---------------+--------------------------+
       |Stability      | Uncommitted              |
       +---------------+--------------------------+

SEE ALSO
       valgrind(1), $INSTALL/share/doc/valgrind/html/index.html or
       http://www.valgrind.org/docs/manual/index.html.

AUTHOR
       Josef Weidendorfer <Josef.Weidendorfer@gmx.de>.

       This manual page was written by Philipp Frauenfelder
       <pfrauenf@debian.org>.



NOTES
       Source code for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This software was built from source available at
       https://github.com/oracle/solaris-userland.  The original community
       source was downloaded from
       ftp://sourceware.org/pub/valgrind/valgrind-3.18.1.tar.bz2.

       Further information about this software can be found on the open source
       community website at http://valgrind.org.



Release 3.18.0                    12/22/2021             CALLGRIND ANNOTATE(1)