Cómo medir el rendimiento del código C++ con Google Benchmark
Everett Pompeii
¿Qué es la Evaluación Comparativa?
La evaluación comparativa es la práctica de probar el rendimiento de tu código para ver qué tan rápido (latencia) o cuánto (rendimiento) trabajo puede hacer. Este paso, a menudo pasado por alto en el desarrollo de software, es crucial para crear y mantener un código rápido y de alto rendimiento. La evaluación comparativa proporciona las métricas necesarias para que los desarrolladores comprendan cómo se comporta su código bajo diversas cargas de trabajo y condiciones. Por las mismas razones por las cuales escribes pruebas unitarias y de integración para prevenir regresiones de características, debes escribir evaluaciones comparativas para prevenir regresiones de rendimiento. ¡Los errores de rendimiento son errores!
Escribe FizzBuzz en C++
Para escribir evaluaciones comparativas, necesitamos algún código fuente para comparar. Para empezar, vamos a escribir un programa muy simple, FizzBuzz.
Las reglas para FizzBuzz son las siguientes:
Escribe un programa que imprima los números enteros del
1
al100
(incluyendo ambos):
- Para múltiplos de tres, imprime
Fizz
- Para múltiplos de cinco, imprime
Buzz
- Para múltiplos de ambos, tres y cinco, imprime
FizzBuzz
- Para todos los demás, imprime el número
Hay muchas formas de escribir FizzBuzz. Así que vamos a elegir mi favorita:
- Itera desde
1
hasta100
, incrementando después de cada iteración. - Para cada número, calcula el módulo (resto después de la división).
- Si el resto es
0
, entonces el número es un múltiplo del factor dado:- Si el resto es
0
para15
, entonces imprimeFizzBuzz
. - Si el resto es
0
para3
, entonces imprimeFizz
. - Si el resto es
0
para5
, entonces imprimeBuzz
.
- Si el resto es
- De lo contrario, solo imprime el número.
Siga paso a paso
Para seguir este tutorial paso a paso, necesitará instalar git
, instalar cmake
, y instalar la Colección de Compiladores de GNU (GCC) g++
.
🐰 El código fuente de este post está disponible en GitHub.
Cree un archivo C++ llamado game.cpp
,
y establezca su contenido a la implementación de FizzBuzz anterior.
Utilice g++
para construir un ejecutable llamado game
y luego ejecútelo.
La salida debería verse como:
🐰 ¡Boom! ¡Estás dominando la entrevista de codificación!
Antes de avanzar más, es importante discutir las diferencias entre micro-benchmarking y macro-benchmarking.
Micro-Benchmarking vs Macro-Benchmarking
Existen dos categorías principales de benchmarks de software: micro-benchmarks y macro-benchmarks.
Los micro-benchmarks operan a un nivel similar a las pruebas unitarias.
Por ejemplo, un benchmark para una función que determina Fizz
, Buzz
, o FizzBuzz
para un único número sería un micro-benchmark.
Los macro-benchmarks operan a un nivel similar a las pruebas de integración.
Por ejemplo, un benchmark para una función que juega el juego completo de FizzBuzz, desde 1
hasta 100
, sería un macro-benchmark.
Generalmente, es mejor probar al nivel más bajo de abstracción posible. En el caso de los benchmarks, esto los hace más fáciles de mantener, y ayuda a reducir la cantidad de ruido en las mediciones. Sin embargo, al igual que tener algunas pruebas de extremo a extremo puede ser muy útil para verificar la cordura todo el sistema se junta como se esperaba, tener macro-benchmarks puede ser muy útil para asegurarse de que los caminos críticos a través de su software se mantienen con buen rendimiento.
Pruebas de rendimiento en C++
Las dos opciones populares para pruebas de rendimiento en C++ son: Google Benchmark y Catch2.
Google Benchmark es una biblioteca de benchmarking robusta y versátil para C++ que permite a los desarrolladores medir el rendimiento de su código con alta precisión. Uno de sus beneficios clave es su facilidad de integración en proyectos existentes, especialmente aquellos que ya utilizan GoogleTest. Google Benchmark proporciona métricas de rendimiento detalladas, incluyendo la capacidad de medir el tiempo de CPU, el tiempo de reloj y el uso de memoria. Soporta una amplia gama de escenarios de benchmarking, desde pruebas de funciones simples hasta pruebas complejas y parametrizadas.
Catch2 es un marco de pruebas moderno, solo de cabecera, para C++ que simplifica el proceso de escribir y ejecutar pruebas. Uno de sus beneficios primarios es su facilidad de uso, con una sintaxis que es tanto intuitiva como expresiva, permitiendo a los desarrolladores escribir pruebas de manera rápida y clara. Catch2 soporta una amplia gama de tipos de pruebas, incluyendo pruebas unitarias, pruebas de integración, pruebas en estilo de desarrollo guiado por comportamiento (BDD) y características básicas de micro-benchmarking.
Both are support by Bencher. Entonces, ¿por qué elegir Google Benchmark? Google Benchmark se integra perfectamente con GoogleTest, que es el estándar de facto para pruebas unitarias en el ecosistema de C++. Sugiero usar Google Benchmark para evaluar la latencia de tu código, especialmente si ya estás utilizando GoogleTest. Es decir, Google Benchmark es ideal para medir el tiempo de reloj de pared.
Refactorizar FizzBuzz
Para probar nuestra aplicación FizzBuzz, necesitamos desacoplar nuestra lógica de la función main
de nuestro programa. Los entornos de prueba de rendimiento no pueden evaluar la función main
. Para lograr esto, necesitamos hacer algunos cambios.
Vamos a refactorizar nuestra lógica de FizzBuzz en un par de funciones dentro de un nuevo archivo llamado play_game.cpp
:
fizz_buzz
: Toma un número enteron
y realiza la lógica deFizz
,Buzz
,FizzBuzz
o número, devolviendo el resultado como una cadena.play_game
: Toma un número enteron
, llama afizz_buzz
con ese número, y sishould_print
estrue
, imprime el resultado.
Ahora, vamos a crear un archivo de encabezado llamado play_game.h
y agregarle la declaración de la función play_game
:
Luego actualiza la función main
en game.cpp
para usar la definición de la función play_game
desde el archivo de encabezado:
La función main
de nuestro programa itera a través de los números del 1
al 100
inclusive y llama a play_game
para cada número, con should_print
configurado en true
.
Benchmarking FizzBuzz
Para evaluar el rendimiento de nuestro código, primero necesitamos instalar Google Benchmark.
Clona la biblioteca:
Entra en el directorio recién clonado:
Usa cmake
para crear un directorio de compilación para colocar la salida de la compilación:
Usa cmake
para generar archivos del sistema de compilación y descargar cualquier dependencia:
Finalmente, compila la biblioteca:
Regresa al directorio principal:
Ahora creemos un nuevo archivo llamado benchmark_game.cpp
:
- Importa las definiciones de funciones de
play_game.h
. - Importa el encabezado de la biblioteca
benchmark
de Google. - Crea una función llamada
BENCHMARK_game
que tome una referencia abenchmark::State
. - Itera sobre el objeto
benchmark::State
. - Para cada iteración, itera de
1
a100
inclusivamente.- Llama a
play_game
con el número actual yshould_print
configurado afalse
.
- Llama a
- Pasa la función
BENCHMARK_game
al ejecutorBENCHMARK
. - Ejecuta el benchmark con
BENCHMARK_MAIN
.
Ahora estamos listos para evaluar el rendimiento de nuestro código:
🐰 ¡Vamos a darle ritmo a nuestra primera métrica de benchmark!
Finalmente, podemos descansar nuestras cansadas cabezas de desarrolladores… Es broma, ¡nuestros usuarios quieren una nueva característica!
Escribe FizzBuzzFibonacci en C++
Nuestros Indicadores Clave de Rendimiento (KPI) están bajos, por lo que nuestro Gerente de Producto (PM) quiere que agreguemos una nueva característica. Después de mucho brainstorming y muchas entrevistas con usuarios, se decide que el buen viejo FizzBuzz no es suficiente. Los niños de hoy quieren un nuevo juego, FizzBuzzFibonacci.
Las reglas para FizzBuzzFibonacci son las siguientes:
Escribe un programa que imprima los enteros del
1
al100
(inclusive):
- Para múltiplos de tres, imprime
Fizz
- Para múltiplos de cinco, imprime
Buzz
- Para múltiplos de tres y cinco, imprime
FizzBuzz
- Para números que sean parte de la secuencia de Fibonacci, solo imprime
Fibonacci
- Para todos los demás, imprime el número
La secuencia de Fibonacci es una serie en la que cada número es la suma de los dos números anteriores.
Por ejemplo, comenzando con 0
y 1
el siguiente número en la secuencia de Fibonacci sería 1
.
Seguido de: 2
, 3
, 5
, 8
y así sucesivamente.
Los números que forman parte de la secuencia de Fibonacci se conocen como números de Fibonacci. Por lo tanto, tendremos que escribir una función que detecte los números de Fibonacci.
Hay muchas formas de escribir la secuencia de Fibonacci y de igual forma muchas maneras de detectar un número de Fibonacci. Así que elegiremos mi forma favorita:
- Crea una función llamada
is_fibonacci_number
que tome un entero y devuelva un booleano. - Itera para todos los números desde
0
hasta nuestro número dadon
inclusive. - Inicializa nuestra secuencia de Fibonacci comenzando con
0
y1
como los númerosprevious
ycurrent
respectivamente. - Itera mientras el número
current
sea menor que la iteración actuali
. - Suma el número
previous
y el númerocurrent
para obtener el númeronext
. - Actualiza el número
previous
al númerocurrent
. - Actualiza el número
current
al númeronext
. - Una vez que
current
sea mayor o igual al número dadon
, saldremos del bucle. - Verifica si el número
current
es igual al número dadon
y, si es así, devuelvetrue
. - De lo contrario, devuelve
false
.
Ahora necesitaremos actualizar nuestra función fizz_buzz
:
- Renombra la función
fizz_buzz
afizz_buzz_fibonacci
para hacerla más descriptiva. - Llama a nuestra función auxiliar
is_fibonacci_number
. - Si el resultado de
is_fibonacci_number
estrue
, entonces devuelveFibonacci
. - Si el resultado de
is_fibonacci_number
esfalse
, entonces realiza la misma lógica deFizz
,Buzz
,FizzBuzz
o el número devolviendo el resultado.
Dado que renombramos fizz_buzz
a fizz_buzz_fibonacci
, también necesitamos actualizar nuestra función play_game
:
Tanto nuestra función main
como la función BENCHMARK_game
pueden permanecer exactamente iguales.
Evaluación de rendimiento de FizzBuzzFibonacci
Ahora podemos volver a ejecutar nuestra evaluación de rendimiento:
Volviendo a revisar nuestro historial del terminal, podemos hacer una comparación visual entre el rendimiento de nuestros juegos FizzBuzz y FizzBuzzFibonacci: 1698 ns
vs 56190 ns
. Tus números serán un poco diferentes a los míos. Sin embargo, es probable que la diferencia entre los dos juegos esté en el rango de 50 veces. ¡Eso me parece bien! Especialmente por añadir una característica que suena tan elegante como Fibonacci a nuestro juego. ¡A los niños les encantará!
Expandir FizzBuzzFibonacci en C++
¡Nuestro juego es un éxito! A los niños realmente les encanta jugar a FizzBuzzFibonacci.
¡Tanto que ha llegado la noticia de que los ejecutivos quieren una secuela!
¡Pero este es el mundo moderno, necesitamos Ingresos Recurrentes Anuales (ARR) no compras únicas!
La nueva visión para nuestro juego es que sea abierto, ya no más viviendo entre los límites de 1
y 100
(incluso si son inclusivos).
¡No, estamos en nuevos horizontes!
Las reglas para Open World FizzBuzzFibonacci son las siguientes:
Escribe un programa que tome cualquier número entero positivo e imprima:
- Para múltiplos de tres, imprime
Fizz
- Para múltiplos de cinco, imprime
Buzz
- Para múltiplos de tres y cinco, imprime
FizzBuzz
- Para números que son parte de la secuencia Fibonacci, sólo imprime
Fibonacci
- Para todos los demás, imprime el número
Para que nuestro juego funcione con cualquier número, necesitaremos aceptar un argumento desde la línea de comandos.
Actualice la función main
para que se vea así:
- Actualice la función
main
para tomarargc
yargv
. - Obtenga el primer argumento pasado a nuestro juego y verifique si es un dígito.
- Si es así, analice el primer argumento como un entero,
i
. - Juegue nuestro juego con el nuevo entero analizado
i
.
- Si es así, analice el primer argumento como un entero,
- Si la conversión falla o no se pasa ningún argumento, por defecto solicitar una entrada válida.
¡Ahora podemos jugar nuestro juego con cualquier número!
Recompile nuestro ejecutable game
y
ejecute el ejecutable seguido de un entero para jugar nuestro juego:
Y si omitimos o proporcionamos un número inválido:
¡Vaya, eso fue una prueba exhaustiva! La integración continua pasa. Nuestros jefes están encantados. ¡Vamos a lanzarlo! 🚀
El Fin
🐰 … ¿el fin de tu carrera tal vez?
¡Solo bromeaba! ¡Todo está en llamas! 🔥
Bueno, al principio todo parecía ir bien. Y luego a las 02:07 AM del sábado, mi buscapersonas sonó:
📟 ¡Tu juego está en llamas! 🔥
Después de salir de la cama a la carrera, traté de averiguar qué estaba pasando. Intenté buscar en los registros, pero eso fue difícil porque todo seguía fallando. Finalmente, encontré el problema. ¡Los niños! Les encantaba tanto nuestro juego, que lo estaban jugando hasta llegar al millón! En un destello de genialidad, agregué dos nuevos benchmarks:
- Un micro-benchmark
BENCHMARK_game_100
para jugar el juego con el número cien (100
) - Un micro-benchmark
BENCHMARK_game_1_000_000
para jugar el juego con el número un millón (1_000_000
)
Cuando lo ejecuté, obtuve esto:
Espéralo… espéralo…
¿Qué! 1,249 ns
x 10,000
debería ser 12,490,000 ns
no 110,879,642 ns
🤯
Aunque mi código de secuencia de Fibonacci es funcionalmente correcto, debe haber un error de rendimiento en alguna parte.
Corrige FizzBuzzFibonacci en C++
Echemos otro vistazo a esa función is_fibonacci_number
:
Ahora que estoy pensando en el rendimiento, me doy cuenta de que tengo un bucle innecesario y extra. Podemos deshacernos completamente del bucle for (int i = 0; i <= n; ++i)
y solo comparar el valor current
con el número dado (n
) 🤦
- Actualiza nuestra función
is_fibonacci_number
. - Inicializa nuestra secuencia de Fibonacci comenzando con
0
y1
como los númerosprevious
ycurrent
respectivamente. - Itera mientras el número
current
sea menor que el número dadon
. - Suma el número
previous
y elcurrent
para obtener el númeronext
. - Actualiza el número
previous
al númerocurrent
. - Actualiza el número
current
al númeronext
. - Una vez que
current
sea mayor o igual al número dadon
, saldremos del bucle. - Verifica si el número
current
es igual al número dadon
y devuelve ese resultado.
Ahora volvamos a ejecutar esos benchmarks y veamos cómo nos fue:
¡Oh, wow! Nuestro benchmark BENCHMARK_game
ha vuelto a donde estaba para el FizzBuzz original.
Desearía poder recordar exactamente cuál era ese puntaje. Sin embargo, han pasado tres semanas.
El historial de mi terminal no llega tan lejos, y Google Benchmark no almacena sus resultados.
¡Pero creo que está cerca!
El benchmark BENCHMARK_game_100
ha bajado casi 50 veces a 34.4 ns
.
¡Y el benchmark BENCHMARK_game_1_000_000
ha bajado más de 1,500,000 veces! 110,879,642 ns
a 61.6 ns
!
🐰 Al menos encontramos este error de rendimiento antes de que llegara a producción… oh, cierto. No importa…
Detectar Retrocesos de Rendimiento en CI
Los ejecutivos no estaban contentos con la avalancha de críticas negativas que recibió nuestro juego debido a mi pequeño error de rendimiento. Me dijeron que no dejara que volviera a ocurrir, y cuando les pregunté cómo, simplemente me dijeron que no volviera a hacerlo. ¡¿Cómo se supone que debería manejar eso‽
Afortunadamente, he encontrado esta increíble herramienta de código abierto llamada Bencher. Hay un nivel gratuito súper generoso, así que puedo usar Bencher Cloud para mis proyectos personales. Y en el trabajo, donde todo debe estar en nuestra nube privada, he comenzado a usar Bencher Self-Hosted.
Bencher tiene adaptadores incorporados, por lo que es fácil de integrar en CI. Después de seguir la guía de inicio rápido, ya puedo ejecutar mis referencias y seguir su progreso con Bencher.
Usando este práctico dispositivo de viaje en el tiempo que un amable conejo me dio, pude retroceder en el tiempo y reproducir lo que habría sucedido si hubiéramos estado utilizando Bencher todo el tiempo. Puedes ver dónde publicamos por primera vez la implementación defectuosa de FizzBuzzFibonacci. Inmediatamente recibí fallas en CI como un comentario en mi solicitud de extracción. Ese mismo día, arreglé el error de rendimiento, eliminando ese bucle extra innecesario. No hubo incendios. Solo usuarios contentos.
Bencher: Benchmarking continuo
Bencher es un conjunto de herramientas de benchmarking continuo. ¿Alguna vez has tenido un impacto de regresión de rendimiento en tus usuarios? Bencher podría haber evitado que eso sucediera. Bencher te permite detectar y prevenir las regresiones de rendimiento antes de que lleguen a producción.
- Ejecutar: Ejecute sus benchmarks localmente o en CI usando sus herramientas de benchmarking favoritas. La CLI
bencher
simplemente envuelve su arnés de benchmarks existente y almacena sus resultados. - Seguir: Sigue los resultados de tus benchmarks con el tiempo. Monitoriza, realiza consultas y representa gráficamente los resultados utilizando la consola web de Bencher basándose en la rama de origen, el banco de pruebas y la medida.
- Capturar: Captura las regresiones de rendimiento en CI. Bencher utiliza analíticas de vanguardia y personalizables para detectar regresiones de rendimiento antes de que lleguen a producción.
Por las mismas razones que las pruebas unitarias se ejecutan en CI para prevenir regresiones funcionales, los benchmarks deberían ejecutarse en CI con Bencher para prevenir regresiones de rendimiento. ¡Los errores de rendimiento son errores!
Empiece a capturar regresiones de rendimiento en CI — prueba Bencher Cloud gratis.