How to use gprof tool
- Profiling can determine the parts in program code that are time consuming and need to be re-written.
- This helps make your program execution faster which is always desired.
The following 3 steps are used to get the gprof output:
- Have profiling enabled while compiling the code
- Execute the program code to produce the profiling data
- Run the gprof tool on the profiling data file (generated in the step above).
Step 1 - Have profiling enabled while compiling the code
- Profiling enabled while compilation
- Add ‘-pg’ option in the compilation step
- Usage: gcc -pg gprof_test.c gprof_test_2.c -o out_gprof
Step 2 - Execute the program code to produce the profiling data
- Execute the binary code
Step 3 - Run the gprof tool on the profiling data file (generated in the step above).
- In this step, the gprof tool is run with the executable name and the above generated ‘gmon.out’ as argument.
- Usage: gprof out_gprof gmon.out > gprof_result
Example Code:
File 1:
//test_gprof.c
#include<stdio.h>
#include<stdlib.h>
extern void new_func1(void);
void func1(void)
{
printf("\n Inside func1 \n");
int i = 0;
//exit(0); // Even if we exit, gmon.out file will be generated
sleep(10); // sleeps are not calculated in the result
for(;i<0xffffffff;i++);
new_func1();
return;
}
static void func2(void)
{
printf("\n Inside func2 \n");
int i = 0;
for(;i<0xffffffaa;i++);
return;
}
int main(void)
{
printf("\n Inside main()\n");
int i = 0;
for(;i<0xffffff;i++);
func1();
func2();
return 0;
}
File 2:
//test_gprof_new.c
#include<stdio.h>
void new_func1(void)
{
printf("\n Inside new_func1()\n");
int i = 0;
for(;i<0xffffffee;i++);
return;
}
Output:
Flat profile:
Each sample counts as 0.01 seconds.
% cumulative self self total
time seconds seconds calls s/call s/call name
34.24 10.39 10.39 1 10.39 20.49 func1
33.47 20.54 10.16 1 10.16 10.16 func2
33.31 30.65 10.10 1 10.10 10.10 new_func1
0.13 30.69 0.04 main
% the percentage of the total running time of the
time program used by this function.
cumulative a running sum of the number of seconds accounted
seconds for by this function and those listed above it.
self the number of seconds accounted for by this
seconds function alone. This is the major sort for this
listing.
calls the number of times this function was invoked, if
this function is profiled, else blank.
self the average number of milliseconds spent in this
ms/call function per call, if this function is profiled,
else blank.
total the average number of milliseconds spent in this
ms/call function and its descendents per call, if this
function is profiled, else blank.
name the name of the function. This is the minor sort
for this listing. The index shows the location of
the function in the gprof listing. If the index is
in parenthesis it shows where it would appear in
the gprof listing if it were to be printed.
^L
Copyright (C) 2012 Free Software Foundation, Inc.
Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved.
^L
Call graph (explanation follows)
granularity: each sample hit covers 2 byte(s) for 0.03% of 30.69 seconds
index % time self children called name
<spontaneous>
[1] 100.0 0.04 30.65 main [1]
10.39 10.10 1/1 func1 [2]
10.16 0.00 1/1 func2 [3]
-----------------------------------------------
10.39 10.10 1/1 main [1]
[2] 66.8 10.39 10.10 1 func1 [2]
10.10 0.00 1/1 new_func1 [4]
-----------------------------------------------
10.16 0.00 1/1 main [1]
[3] 33.1 10.16 0.00 1 func2 [3]
-----------------------------------------------
10.10 0.00 1/1 func1 [2]
[4] 32.9 10.10 0.00 1 new_func1 [4]
-----------------------------------------------
This table describes the call tree of the program, and was sorted by
the total amount of time spent in each function and its children.
Each entry in this table consists of several lines. The line with the
index number at the left hand margin lists the current function.
The lines above it list the functions that called this function,
and the lines below it list the functions this one called.
This line lists:
index A unique number given to each element of the table.
Index numbers are sorted numerically.
The index number is printed next to every function name so
it is easier to look up where the function is in the table.
% time This is the percentage of the `total' time that was spent
in this function and its children. Note that due to
different viewpoints, functions excluded by options, etc,
these numbers will NOT add up to 100%.
self This is the total amount of time spent in this function.
children This is the total amount of time propagated into this
function by its children.
called This is the number of times the function was called.
If the function called itself recursively, the number
only includes non-recursive calls, and is followed by
a `+' and the number of recursive calls.
name The name of the current function. The index number is
printed after it. If the function is a member of a
cycle, the cycle number is printed between the
function's name and the index number.
For the function's parents, the fields have the following meanings:
self This is the amount of time that was propagated directly
from the function into this parent.
children This is the amount of time that was propagated from
the function's children into this parent.
called This is the number of times this parent called the
function `/' the total number of times the function
was called. Recursive calls to the function are not
included in the number after the `/'.
name This is the name of the parent. The parent's index
number is printed after it. If the parent is a
member of a cycle, the cycle number is printed between
the name and the index number.
If the parents of the function cannot be determined, the word
`<spontaneous>' is printed in the `name' field, and all the other
fields are blank.
For the function's children, the fields have the following meanings:
self This is the amount of time that was propagated directly
from the child into the function.
children This is the amount of time that was propagated from the
child's children to the function.
called This is the number of times the function called
this child `/' the total number of times the child
was called. Recursive calls by the child are not
listed in the number after the `/'.
name This is the name of the child. The child's index
number is printed after it. If the child is a
member of a cycle, the cycle number is printed
between the name and the index number.
If there are any cycles (circles) in the call graph, there is an
entry for the cycle-as-a-whole. This entry shows who called the
cycle (as parents) and the members of the cycle (as children.)
The `+' recursive calls entry shows the number of function calls that
were internal to the cycle, and the calls entry for each member shows,
for that member, how many times it was called from other members of
the cycle.
^L
Copyright (C) 2012 Free Software Foundation, Inc.
Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved.
^L
Index by function name
[2] func1 [1] main
[3] func2 [4] new_func1
To verify gprof is add in binary:
gprof$ nm out_gprof | grep gmon
0000000000400590 T __gmon_start__
gprof$ nm out_gprof | grep clea
U _mcleanup@@GLIBC_2.2.5
No comments:
Post a Comment