Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
cgprof(1)		     Linux Reference Manual		       cgprof(1)

NAME
     cgprof - generate colored call graph for profiled executables

SYNOPSIS
     cgprof [-h] [-T dev] [-g gmon_data] [gprof_file]

DESCRIPTION
     cgprof generate a function calling graph for a profiled executable. The ex-
     ecutable  must  have  been  compiled and linked to output data suitable for
     gprof(1) (look at -pg option of gcc(1)). If no -T option is  given,  output
     is  dot(1) commands. All the results are printed on standard output. cgprof
     takes gprof_file as input, or standard input.

     The result is a directed acyclic graph (DAG), where nodes	represent  func-
     tions traversed during the program execution, and edges function calls (ar-
     row is from the caller to the called).

     Node colors represent the cumulative execution time spent by a function and
     its  children. Colors range from intense red (100 % time) to pale violet (0
     %), like a rainbow. A node is white filled when it has  no  time  execution
     data  available,  which  may be the case for profiling functions or not in-
     strumented functions.

     cgprof helps to have a better understanding of program structure and execu-
     tion. It makes hot spots identification visual and intuitive, and	provides
     a minimum code coverage function.

OPTIONS
     -h     Display this help text.

     -T dev
	    This  option  sets	the output format to dev. Possible values of dev
	    are :

	    X	   X11 output, with direct previewing using dotty(1).

	    ps	   Postscript output, using dot(1) processor. The  drawing  will
		   be sized to fill one landscape page.

EXAMPLE
     to print a report from execution of test_hash, run the following command:

	   $ cc -pg -o test_hash test_hash.c
	   $ test_hash < test_data
	   $ gprof test_hash | cgprof -Tps | lpr

SEE ALSO
     gprof(1), dot(1), dotty(1), cc(1).

HISTORY
     cgprof  is inspired by a gprof2dot, a similar tool from AT&T Research Labs,
     distributed part of graphviz (http://www.graphviz.org) which includes  also
     dot tools.

AUTHOR
     Marc Vertes <mvertes@free.fr>

cgprof-1.2			December 16, 2004		       cgprof(1)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=cgprof&sektion=1&manpath=FreeBSD+Ports+15.1.quarterly>

home | help