La creación de perfiles es un aspecto importante de la programación de software. A través de la creación de perfiles, se pueden determinar las partes del código del programa que consumen mucho tiempo y necesitan ser reescritas. Esto ayuda a que la ejecución de su programa sea más rápida, lo que siempre se desea.
En proyectos muy grandes, la creación de perfiles puede salvarle el día no solo al determinar las partes de su programa que tienen una ejecución más lenta de lo esperado, sino que también puede ayudar encontrará muchas otras estadísticas a través de las cuales se pueden detectar y resolver muchos errores potenciales.
En este artículo, exploraremos la herramienta de generación de perfiles GNU 'gprof'.
Cómo usar gprof
Usar la herramienta gprof no es nada complejo. Solo necesita hacer lo siguiente en un alto nivel:
- Habilite la generación de perfiles mientras compila el código
- Ejecutar el código del programa para generar los datos de perfil
- Ejecute la herramienta gprof en el archivo de datos de generación de perfiles (generado en el paso anterior).
El último paso anterior produce un archivo de análisis que está en forma legible por humanos. Este archivo contiene un par de tablas (perfil plano y gráfico de llamadas) además de otra información. Mientras que el perfil plano brinda una descripción general de la información de tiempo de las funciones, como el consumo de tiempo para la ejecución de una función en particular, cuántas veces se llamó, etc. Por otro lado, el gráfico de llamadas se enfoca en cada función como las funciones a través de las cuales un determinado se llamó a la función, qué funciones se llamaron desde dentro de esta función en particular, etc. De esta manera, también se puede tener una idea del tiempo de ejecución empleado en las subrutinas.
Tratemos de entender los tres pasos enumerados anteriormente a través de un ejemplo práctico. El siguiente código de prueba se utilizará a lo largo del artículo:
//test_gprof.c
#include<stdio.h>
void new_func1(void);
void func1(void)
{
printf("\n Inside func1 \n");
int i = 0;
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;
} //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;
} Tenga en cuenta que los bucles 'for' dentro de las funciones están ahí para consumir algo de tiempo de ejecución.
Paso 1:creación de perfiles habilitada durante la compilación
En este primer paso, debemos asegurarnos de que la generación de perfiles esté habilitada cuando se complete la compilación del código. Esto es posible al agregar la opción '-pg' en el paso de compilación.
Desde la página man de gcc:
-pg :genera código adicional para escribir información de perfil adecuada para el programa de análisis gprof. Debe usar esta opción al compilar los archivos de origen sobre los que desea obtener datos, y también debe usarla al vincular.
Entonces, compilemos nuestro código con la opción '-pg':
$ gcc -Wall -pg test_gprof.c test_gprof_new.c -o test_gprof $
Tenga en cuenta:la opción '-pg' se puede usar con el comando gcc que compila (opción -c), el comando gcc que vincula (opción -o en archivos de objetos) y con el comando gcc que hace ambas cosas (como en el ejemplo anterior) .
Paso 2:Ejecutar el código
En el segundo paso, se ejecuta el archivo binario producido como resultado del paso 1 (arriba) para que se pueda generar la información de perfil.
$ ls test_gprof test_gprof.c test_gprof_new.c $ ./test_gprof Inside main() Inside func1 Inside new_func1() Inside func2 $ ls gmon.out test_gprof test_gprof.c test_gprof_new.c $
Entonces vemos que cuando se ejecutó el binario, se generó un nuevo archivo 'gmon.out' en el directorio de trabajo actual.
Tenga en cuenta que durante la ejecución, si el programa cambia el directorio de trabajo actual (usando chdir), se generará gmon.out en el nuevo directorio de trabajo actual. Además, su programa debe tener permisos suficientes para que gmon.out se cree en el directorio de trabajo actual.
Paso 3:Ejecute la herramienta gprof
En este paso, la herramienta gprof se ejecuta con el nombre del ejecutable y el 'gmon.out' generado anteriormente como argumento. Esto produce un archivo de análisis que contiene toda la información de perfil deseada.
$ gprof test_gprof gmon.out > analysis.txt
Tenga en cuenta que se puede especificar explícitamente el archivo de salida (como en el ejemplo anterior) o la información se produce en la salida estándar.
$ ls analysis.txt gmon.out test_gprof test_gprof.c test_gprof_new.c
Entonces vemos que se generó un archivo llamado 'analysis.txt'.
En una nota relacionada, también debe comprender cómo depurar su programa C usando gdb.
Comprender la información de perfil
Como se produjo anteriormente, toda la información de perfil ahora está presente en 'analysis.txt'. Echemos un vistazo a este archivo de texto:
Flat profile:
Each sample counts as 0.01 seconds.
% cumulative self self total
time seconds seconds calls s/call s/call name
33.86 15.52 15.52 1 15.52 15.52 func2
33.82 31.02 15.50 1 15.50 15.50 new_func1
33.29 46.27 15.26 1 15.26 30.75 func1
0.07 46.30 0.03 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.
Call graph (explanation follows)
granularity: each sample hit covers 2 byte(s) for 0.02% of 46.30 seconds
index % time self children called name
[1] 100.0 0.03 46.27 main [1]
15.26 15.50 1/1 func1 [2]
15.52 0.00 1/1 func2 [3]
-----------------------------------------------
15.26 15.50 1/1 main [1]
[2] 66.4 15.26 15.50 1 func1 [2]
15.50 0.00 1/1 new_func1 [4]
-----------------------------------------------
15.52 0.00 1/1 main [1]
[3] 33.5 15.52 0.00 1 func2 [3]
-----------------------------------------------
15.50 0.00 1/1 func1 [2]
[4] 33.5 15.50 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 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
`' 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.
Index by function name
[2] func1 [1] main
[3] func2 [4] new_func1 Entonces (como ya se discutió) vemos que este archivo está dividido en dos partes:
1. Perfil plano
2. Gráfico de llamadas
Las columnas individuales para (perfil plano y gráfico de llamadas) están muy bien explicadas en el resultado.
Personaliza la salida de gprof usando banderas
Hay varios indicadores disponibles para personalizar la salida de la herramienta gprof. Algunos de ellos se discuten a continuación:
1. Suprime la impresión de funciones declaradas estáticamente (privadas) usando -a
Si hay algunas funciones estáticas cuya información de perfil no necesita, esto se puede lograr usando la opción -a:
$ gprof -a test_gprof gmon.out > analysis.txt
Ahora si vemos ese archivo de análisis:
Flat profile:
Each sample counts as 0.01 seconds.
% cumulative self self total
time seconds seconds calls s/call s/call name
67.15 30.77 30.77 2 15.39 23.14 func1
33.82 46.27 15.50 1 15.50 15.50 new_func1
0.07 46.30 0.03 main
...
...
...
Call graph (explanation follows)
granularity: each sample hit covers 2 byte(s) for 0.02% of 46.30 seconds
index %time self children called name
[1] 100.0 0.03 46.27 main [1]
30.77 15.50 2/2 func1 [2]
-----------------------------------------------------
30.77 15.50 2/2 main [1]
[2] 99.9 30.77 15.50 2 func1 [2]
15.50 0.00 1/1 new_func1 [3]
----------------------------------------------------
15.50 0.00 1/1 func1 [2]
[3] 33.5 15.50 0.00 1 new_func1 [3]
-----------------------------------------------
...
...
... Entonces vemos que no hay información relacionada con func2 (que se define como estática)
2. Suprima anuncios publicitarios detallados usando -b
Como ya habrás visto, gprof produce una salida con mucha información detallada, por lo que, en caso de que esta información no sea necesaria, se puede lograr con el indicador -b.
$ gprof -b test_gprof gmon.out > analysis.txt
Ahora si vemos el archivo de análisis:
Flat profile:
Each sample counts as 0.01 seconds.
% cumulative self self total
time seconds seconds calls s/call s/call name
33.86 15.52 15.52 1 15.52 15.52 func2
33.82 31.02 15.50 1 15.50 15.50 new_func1
33.29 46.27 15.26 1 15.26 30.75 func1
0.07 46.30 0.03 main
Call graph
granularity: each sample hit covers 2 byte(s) for 0.02% of 46.30 seconds
index % time self children called name
[1] 100.0 0.03 46.27 main [1]
15.26 15.50 1/1 func1 [2]
15.52 0.00 1/1 func2 [3]
-----------------------------------------------
15.26 15.50 1/1 main [1]
[2] 66.4 15.26 15.50 1 func1 [2]
15.50 0.00 1/1 new_func1 [4]
-----------------------------------------------
15.52 0.00 1/1 main [1]
[3] 33.5 15.52 0.00 1 func2 [3]
-----------------------------------------------
15.50 0.00 1/1 func1 [2]
[4] 33.5 15.50 0.00 1 new_func1 [4]
-----------------------------------------------
Index by function name
[2] func1 [1] main
[3] func2 [4] new_func1 Entonces vemos que toda la información detallada no está presente en el archivo de análisis.
3. Imprimir solo perfil plano usando -p
En caso de que solo se requiera un perfil plano, entonces:
$ gprof -p -b test_gprof gmon.out > analysis.txt
Tenga en cuenta que he usado (y usaré) la opción -b para evitar información adicional en el resultado del análisis.
Ahora, si vemos el resultado del análisis:
Flat profile: Each sample counts as 0.01 seconds. % cumulative self self total time seconds seconds calls s/call s/call name 33.86 15.52 15.52 1 15.52 15.52 func2 33.82 31.02 15.50 1 15.50 15.50 new_func1 33.29 46.27 15.26 1 15.26 30.75 func1 0.07 46.30 0.03 main
Entonces vemos que solo había un perfil plano en la salida.
4. Imprimir información relacionada con una función específica en perfil plano
Esto se puede lograr proporcionando el nombre de la función junto con la opción -p:
$ gprof -pfunc1 -b test_gprof gmon.out > analysis.txt
Ahora, si vemos el resultado del análisis:
Flat profile: Each sample counts as 0.01 seconds. % cumulative self self total time seconds seconds calls s/call s/call name 103.20 15.26 15.26 1 15.26 15.26 func1
Entonces vemos que se muestra un perfil plano que contiene información relacionada solo con la función func1.
5. Suprimir el perfil plano en la salida usando -P
Si no se requiere un perfil plano, se puede suprimir usando la opción -P:
$ gprof -P -b test_gprof gmon.out > analysis.txt
Ahora, si vemos el resultado del análisis:
Call graph granularity: each sample hit covers 2 byte(s) for 0.02% of 46.30 seconds
index % time self children called name
[1] 100.0 0.03 46.27 main [1]
15.26 15.50 1/1 func1 [2]
15.52 0.00 1/1 func2 [3]
-----------------------------------------------
15.26 15.50 1/1 main [1]
[2] 66.4 15.26 15.50 1 func1 [2]
15.50 0.00 1/1 new_func1 [4]
-----------------------------------------------
15.52 0.00 1/1 main [1]
[3] 33.5 15.52 0.00 1 func2 [3]
-----------------------------------------------
15.50 0.00 1/1 func1 [2]
[4] 33.5 15.50 0.00 1 new_func1 [4]
-----------------------------------------------
Index by function name
[2] func1 [1] main
[3] func2 [4] new_func1 Entonces vemos que se suprimió el perfil plano y solo se mostró el gráfico de llamadas en la salida.
Además, si hay un requisito para imprimir un perfil plano pero excluyendo una función en particular, esto también es posible usando el indicador -P al pasar el nombre de la función (para excluir) junto con él.
$ gprof -Pfunc1 -b test_gprof gmon.out > analysis.txt
En el ejemplo anterior, intentamos excluir 'func1' pasándolo junto con la opción -P a gprof. Ahora veamos el resultado del análisis:
Flat profile: Each sample counts as 0.01 seconds. % cumulative self self total time seconds seconds calls s/call s/call name 50.76 15.52 15.52 1 15.52 15.52 func2 50.69 31.02 15.50 1 15.50 15.50 new_func1 0.10 31.05 0.03 main
Entonces vemos que se mostró el perfil plano pero se suprimió la información sobre func1.
6. Imprima solo la información del gráfico de llamadas usando -q
gprof -q -b test_gprof gmon.out > analysis.txt
En el ejemplo anterior, se utilizó la opción -q. Veamos qué efecto produce en el resultado del análisis:
Call graph
granularity: each sample hit covers 2 byte(s) for 0.02% of 46.30 seconds
index % time self children called name
[1] 100.0 0.03 46.27 main [1]
15.26 15.50 1/1 func1 [2]
15.52 0.00 1/1 func2 [3]
-----------------------------------------------
15.26 15.50 1/1 main [1]
[2] 66.4 15.26 15.50 1 func1 [2]
15.50 0.00 1/1 new_func1 [4]
-----------------------------------------------
15.52 0.00 1/1 main [1]
[3] 33.5 15.52 0.00 1 func2 [3]
-----------------------------------------------
15.50 0.00 1/1 func1 [2]
[4] 33.5 15.50 0.00 1 new_func1 [4]
-----------------------------------------------
Index by function name
[2] func1 [1] main
[3] func2 [4] new_func1 Entonces vemos que solo se imprimió el gráfico de llamadas en la salida.
7. Imprima solo información de funciones específicas en el gráfico de llamadas.
Esto es posible pasando el nombre de la función junto con la opción -q.
$ gprof -qfunc1 -b test_gprof gmon.out > analysis.txt
Ahora, si vemos el resultado del análisis:
Call graph
granularity: each sample hit covers 2 byte(s) for 0.02% of 46.30 seconds
index % time self children called name
15.26 15.50 1/1 main [1]
[2] 66.4 15.26 15.50 1 func1 [2]
15.50 0.00 1/1 new_func1 [4]
-----------------------------------------------
15.50 0.00 1/1 func1 [2]
[4] 33.5 15.50 0.00 1 new_func1 [4]
-----------------------------------------------
Index by function name
[2] func1 (1) main
(3) func2 [4] new_func1 Entonces vemos que la información relacionada solo con func1 se mostró en el gráfico de llamadas.
8. Suprimir el gráfico de llamadas usando -Q
Si la información del gráfico de llamadas no se requiere en la salida del análisis, se puede usar la opción -Q.
$ gprof -Q -b test_gprof gmon.out > analysis.txt
Ahora, si vemos el resultado del análisis:
Flat profile: Each sample counts as 0.01 seconds. % cumulative self self total time seconds seconds calls s/call s/call name 33.86 15.52 15.52 1 15.52 15.52 func2 33.82 31.02 15.50 1 15.50 15.50 new_func1 33.29 46.27 15.26 1 15.26 30.75 func1 0.07 46.30 0.03 main
Entonces vemos que solo hay un perfil plano en la salida. Se eliminó todo el gráfico de llamadas.
Además, si se desea suprimir una función específica del gráfico de llamadas, esto se puede lograr pasando el nombre de la función deseada junto con la opción -Q a la herramienta gprof.
$ gprof -Qfunc1 -b test_gprof gmon.out > analysis.txt
En el ejemplo anterior, el nombre de función func1 se pasa a la opción -Q.
Ahora, si vemos el resultado del análisis:
Call graph
granularity: each sample hit covers 2 byte(s) for 0.02% of 46.30 seconds
index % time self children called name
[1] 100.0 0.03 46.27 main [1]
15.26 15.50 1/1 func1 [2]
15.52 0.00 1/1 func2 [3]
-----------------------------------------------
15.52 0.00 1/1 main [1]
[3] 33.5 15.52 0.00 1 func2 [3]
-----------------------------------------------
15.50 0.00 1/1 func1 [2]
[4] 33.5 15.50 0.00 1 new_func1 [4]
-----------------------------------------------
Index by function name
(2) func1 [1] main
[3] func2 [4] new_func1 Entonces vemos que se suprimió la información del gráfico de llamadas relacionada con func1.