Como fazer benchmark de código C++ com Google Benchmark
Everett Pompeii
O que é Benchmarking?
Benchmarking é a prática de testar o desempenho do seu código para ver quão rápido (latência) ou quanto (throughput) trabalho ele pode executar. Este passo frequentemente negligenciado no desenvolvimento de software é crucial para criar e manter um código rápido e performático. O benchmarking fornece as métricas necessárias para que os desenvolvedores compreendam o desempenho do seu código sob várias cargas de trabalho e condições. Pelas mesmas razões que você escreve testes unitários e de integração para evitar regressões de funcionalidades, você deve escrever benchmarks para evitar regressões de desempenho. Bugs de desempenho são bugs!
Escreva FizzBuzz em C++
Para escrevermos testes de desempenho, precisamos de algum código-fonte para testar. Para começar, vamos escrever um programa muito simples, FizzBuzz.
As regras para o FizzBuzz são as seguintes:
Escreva um programa que imprima os inteiros de
1
a100
(inclusive):
- Para múltiplos de três, imprima
Fizz
- Para múltiplos de cinco, imprima
Buzz
- Para múltiplos de três e cinco, imprima
FizzBuzz
- Para todos os outros, imprima o número
Existem muitas maneiras de escrever o FizzBuzz. Então vamos seguir com o meu favorito:
- Itere de
1
a100
, incrementando a cada iteração. - Para cada número, calcule o módulo (resto da divisão).
- Se o resto for
0
, então o número é um múltiplo do fator dado:- Se o resto for
0
para15
, então imprimaFizzBuzz
. - Se o resto for
0
para3
, então imprimaFizz
. - Se o resto for
0
para5
, então imprimaBuzz
.
- Se o resto for
- Caso contrário, apenas imprima o número.
Siga o Passo a Passo
Para seguir este tutorial passo a passo, você precisará instalar o git
, instalar o cmake
e instalar o GNU Compiler Collection (GCC) g++
.
🐰 O código-fonte deste post está disponível no GitHub.
Crie um arquivo C++ chamado game.cpp
,
e defina seu conteúdo para a implementação FizzBuzz acima.
Use g++
para criar um executável chamado game
e depois executá-lo.
A saída deve se parecer com:
🐰 Boom! Você está arrasando na entrevista de programação!
Antes de prosseguir, é importante discutir as diferenças entre micro-benchmarking e macro-benchmarking.
Micro-Benchmarking vs Macro-Benchmarking
Existem duas categorias importantes de benchmarks de software: micro-benchmarks e macro-benchmarks.
Os micro-benchmarks operam em um nível semelhante aos testes unitários.
Por exemplo, um benchmark para uma função que determina Fizz
, Buzz
, ou FizzBuzz
para um número individual seria um micro-benchmark.
Os macro-benchmarks operam em um nível semelhante aos testes de integração.
Por exemplo, um benchmark para uma função que executa o jogo inteiro de FizzBuzz, de 1
a 100
, seria um macro-benchmark.
Em geral, é melhor testar no menor nível de abstração possível. No caso dos benchmarks, isso os torna mais fáceis de manter, e ajuda a reduzir a quantidade de ruído nas medições. No entanto, assim como ter alguns testes de ponta a ponta pode ser muito útil para verificar se todo o sistema se junta conforme esperado, ter macro-benchmarks pode ser muito útil para garantir que os caminhos críticos através do seu software permaneçam com bom desempenho.
Benchmarking em C++
As duas opções populares para benchmarking em C++ são: Google Benchmark e Catch2.
O Google Benchmark é uma biblioteca de benchmarking robusta e versátil para C++ que permite aos desenvolvedores medir o desempenho de seu código com alta precisão. Um de seus principais benefícios é a facilidade de integração em projetos existentes, especialmente aqueles que já usam o GoogleTest. O Google Benchmark fornece métricas de desempenho detalhadas, incluindo a capacidade de medir o tempo de CPU, tempo de parede e uso de memória. Ele suporta uma ampla gama de cenários de benchmarking, desde benchmarks de funções simples até testes complexos e parametrizados.
Catch2 é um framework de testes moderno, apenas com cabeçalho, para C++ que simplifica o processo de escrever e executar testes. Um de seus principais benefícios é sua facilidade de uso, com uma sintaxe que é tanto intuitiva quanto expressiva, permitindo aos desenvolvedores escrever testes de forma rápida e clara. Catch2 suporta uma ampla gama de tipos de teste, incluindo testes unitários, testes de integração, testes no estilo de desenvolvimento orientado a comportamentos (BDD) e recursos básicos de micro-benchmarking.
Ambos são suportados pela Bencher. Então, por que escolher o Google Benchmark? O Google Benchmark integra-se perfeitamente com o GoogleTest, que é o padrão de fato para testes unitários no ecossistema C++. Eu sugiro usar o Google Benchmark para mensurar a latência do seu código, especialmente se você já estiver usando o GoogleTest. Ou seja, o Google Benchmark é excelente para medir o tempo de execução total.
Refatorar FizzBuzz
Para testar nossa aplicação FizzBuzz,
precisamos desacoplar nossa lógica da função main
do nosso programa.
Ferramentas de benchmark não conseguem avaliar a função main
.
Para fazer isso, precisamos fazer algumas alterações.
Vamos refatorar a lógica do FizzBuzz em algumas funções
dentro de um novo arquivo chamado play_game.cpp
:
fizz_buzz
: Recebe um inteiron
e executa a lógica real deFizz
,Buzz
,FizzBuzz
ou retorna o número como string.play_game
: Recebe um inteiron
, chamafizz_buzz
com esse número, e seshould_print
fortrue
, imprime o resultado.
Agora, vamos criar um arquivo de cabeçalho chamado play_game.h
e adicionar a declaração da função play_game
a ele:
Em seguida, atualize a função main
em game.cpp
para usar a definição da função play_game
do arquivo de cabeçalho:
A função main
do nosso programa itera através dos números de 1
a 100
inclusive e chama play_game
para cada número, com should_print
definido como true
.
Medindo Desempenho do FizzBuzz
Para medir o desempenho do nosso código, precisamos primeiro instalar o Google Benchmark.
Clone a biblioteca:
Entre no diretório recém-clonado:
Use o cmake
para criar um diretório de build onde será colocado o resultado do build:
Use o cmake
para gerar os arquivos de sistema de build e baixar quaisquer dependências:
Finalmente, construa a biblioteca:
Volte para o diretório pai:
Agora vamos criar um novo arquivo chamado benchmark_game.cpp
:
- Importe as definições de funções de
play_game.h
. - Importe o cabeçalho da biblioteca
benchmark
do Google. - Crie uma função chamada
BENCHMARK_game
que recebe uma referência parabenchmark::State
. - Itere sobre o objeto
benchmark::State
. - Para cada iteração, itere de
1
a100
, inclusivamente.- Chame
play_game
com o número atual eshould_print
definido comofalse
.
- Chame
- Passe a função
BENCHMARK_game
para o executorBENCHMARK
. - Execute o benchmark com
BENCHMARK_MAIN
.
Agora estamos prontos para medir o desempenho do nosso código:
🐰 Vamos lá! Temos nossas primeiras métricas de benchmark!
Finalmente, podemos descansar nossas cabeças de desenvolvedor cansadas… Brincadeira, nossos usuários querem um novo recurso!
Escreva FizzBuzzFibonacci em C++
Nossos Indicadores Chave de Performance (KPIs) caíram, então nosso Gerente de Produto (PM) quer que adicionemos um novo recurso. Após muito brainstorming e várias entrevistas com usuários, ficou decidido que o bom e velho FizzBuzz não é suficiente. As crianças de hoje querem um novo jogo, FizzBuzzFibonacci.
As regras para FizzBuzzFibonacci são as seguintes:
Escreva um programa que imprime os números inteiros de
1
a100
(inclusive):
- Para múltiplos de três, imprima
Fizz
- Para múltiplos de cinco, imprima
Buzz
- Para múltiplos de ambos três e cinco, imprima
FizzBuzz
- Para números que fazem parte da sequência de Fibonacci, apenas imprima
Fibonacci
- Para todos os outros, imprima o número
A Sequência de Fibonacci é uma série na qual cada número é a soma dos dois números precedentes.
Por exemplo, começando com 0
e 1
o próximo número na sequência de Fibonacci seria 1
.
Seguido por: 2
, 3
, 5
, 8
e assim por diante.
Números que fazem parte da Sequência de Fibonacci são conhecidos como números de Fibonacci. Então, teremos que escrever uma função que detecte números de Fibonacci.
Existem muitas maneiras de escrever a sequência de Fibonacci e, da mesma forma, muitas maneiras de detectar um número de Fibonacci. Então, vamos com a minha favorita:
- Crie uma função chamada
is_fibonacci_number
que recebe um inteiro e retorna um booleano. - Itere para todos os números de
0
até nosso número dadon
inclusive. - Inicialize nossa sequência de Fibonacci começando com
0
e1
como os númerosanterior
eatual
, respectivamente. - Itere enquanto o número
atual
for menor que a iteração atuali
. - Adicione o número
anterior
eatual
para obter o númeroseguinte
. - Atualize o número
anterior
para o númeroatual
. - Atualize o número
atual
para o númeroseguinte
. - Assim que
atual
for maior ou igual ao número dadon
, sairemos do loop. - Verifique se o número
atual
é igual ao número dadon
e, se for, retornetrue
. - Caso contrário, retorne
false
.
Agora precisaremos atualizar nossa função fizz_buzz
:
- Renomeie a função
fizz_buzz
parafizz_buzz_fibonacci
para torná-la mais descritiva. - Chame nossa função auxiliar
is_fibonacci_number
. - Se o resultado de
is_fibonacci_number
fortrue
, então retorneFibonacci
. - Se o resultado de
is_fibonacci_number
forfalse
, então execute a mesma lógica deFizz
,Buzz
,FizzBuzz
ou número, retornando o resultado.
Como renomeamos fizz_buzz
para fizz_buzz_fibonacci
, também precisamos atualizar nossa função play_game
:
Tanto nossa função main
quanto a função BENCHMARK_game
podem permanecer exatamente iguais.
Benchmarking FizzBuzzFibonacci
Agora podemos executar novamente nosso benchmark:
Voltando no histórico do terminal, podemos fazer uma comparação visual entre o desempenho dos nossos jogos FizzBuzz e FizzBuzzFibonacci: 1698 ns
vs 56190 ns
.
Seus números podem ser um pouco diferentes dos meus.
No entanto, a diferença entre os dois jogos provavelmente está na faixa de 50x.
Isso me parece bom! Especialmente para adicionar uma funcionalidade com um nome tão pomposo quanto Fibonacci ao nosso jogo.
As crianças vão adorar!
Expandir FizzBuzzFibonacci em C++
Nosso jogo é um sucesso! As crianças realmente adoram jogar FizzBuzzFibonacci.
Tanto que nossos executivos decidiram que querem uma sequência.
Mas este é o mundo moderno, precisamos de Receita Recorrente Anual (ARR) e não de compras únicas!
A nova visão para o nosso jogo é que ele seja infinito, sem mais viver entre os limites de 1
e 100
(mesmo que sejam inclusivos).
Não, estamos indo para novas fronteiras!
As regras para o Open World FizzBuzzFibonacci são as seguintes:
Escreva um programa que aceite qualquer número inteiro positivo e imprima:
- Para múltiplos de três, imprima
Fizz
- Para múltiplos de cinco, imprima
Buzz
- Para múltiplos de ambos três e cinco, imprima
FizzBuzz
- Para números que fazem parte da sequência de Fibonacci, apenas imprima
Fibonacci
- Para todos os outros, imprima o número
Para que nosso jogo funcione para qualquer número, precisaremos aceitar um argumento de linha de comando.
Atualize a função main
para ficar assim:
- Atualize a função
main
para aceitarargc
eargv
. - Pegue o primeiro argumento passado para nosso jogo e verifique se é um dígito.
- Se for, analise o primeiro argumento como um inteiro,
i
. - Jogue nosso jogo com o inteiro recém-analisado
i
.
- Se for, analise o primeiro argumento como um inteiro,
- Se a análise falhar ou nenhum argumento for passado, padrão é solicitar uma entrada válida.
Agora podemos jogar nosso jogo com qualquer número!
Recomplie nosso executável game
e depois
execute o executável seguido de um inteiro para jogar nosso jogo:
E se omitirmos ou fornecermos um número inválido:
Uau, esse foi um teste completo! CI aprovado. Nossos chefes estão emocionados. Vamos lançar! 🚀
O Fim
🐰 … o fim da sua carreira talvez?
Brincadeira! Tudo está pegando fogo! 🔥
Bem, a princípio, tudo parecia estar indo bem. Então, às 02:07 da madrugada de sábado, meu pager disparou:
📟 Seu jogo está pegando fogo! 🔥
Após sair da cama às pressas, tentei descobrir o que estava acontecendo. Eu tentei pesquisar nos logs, mas era difícil porque tudo continuava travando. Finalmente, encontrei o problema. As crianças! Elas adoravam tanto nosso jogo que jogavam até chegar a um milhão! Num lampejo de brilhantismo, adicionei dois novos benchmarks:
- Um micro-benchmark
BENCHMARK_game_100
para jogar com o número cem (100
) - Um micro-benchmark
BENCHMARK_game_1_000_000
para jogar com o número um milhão (1_000_000
)
Quando executei, obtive isso:
Espere por isso… espere por isso…
O quê! 1,249 ns
x 10,000
deveria ser 12,490,000 ns
e não 110,879,642 ns
🤯
Embora meu código da sequência de Fibonacci esteja funcionalmente correto, devo ter um bug de desempenho em algum lugar.
Corrigir FizzBuzzFibonacci em C++
Vamos dar outra olhada na função is_fibonacci_number
:
Agora que estou pensando sobre desempenho, percebo que tenho um loop desnecessário e extra.
Podemos eliminar completamente o loop for (int i = 0; i <= n; ++i)
e
apenas comparar o valor current
com o número fornecido (n
) 🤦
- Atualize nossa função
is_fibonacci_number
. - Inicialize nossa sequência de Fibonacci começando com
0
e1
como os númerosprevious
ecurrent
respectivamente. - Itere enquanto o número
current
for menor que o número fornecidon
. - Some o número
previous
e o númerocurrent
para obter o próximo número. - Atualize o número
previous
para o númerocurrent
. - Atualize o número
current
para o próximo número. - Assim que
current
for maior ou igual ao número fornecidon
, sairemos do loop. - Verifique se o número
current
é igual ao número fornecidon
e retorne esse resultado.
Agora, vamos rodar esses benchmarks novamente e ver como fomos:
Oh, uau! Nosso benchmark BENCHMARK_game
voltou para próximo do original FizzBuzz.
Gostaria de lembrar exatamente qual era aquela pontuação. Já se passaram três semanas entretanto.
Meu histórico do terminal não vai tão atrás, e o Google Benchmark não armazena seus resultados.
Mas acho que está próximo!
O benchmark BENCHMARK_game_100
caiu quase 50x para 34.4 ns
.
E o benchmark BENCHMARK_game_1_000_000
caiu mais de 1.500.000x! De 110,879,642 ns
para 61.6 ns
!
🐰 Ei, pelo menos pegamos esse bug de desempenho antes que chegasse à produção… ah, certo. Deixa pra lá…
Detecte Regressões de Desempenho em CI
Os executivos não ficaram felizes com a enxurrada de críticas negativas que nosso jogo recebeu devido ao meu pequeno bug de desempenho. Eles me disseram para não deixar isso acontecer de novo, e quando perguntei como, eles simplesmente me disseram para não fazê-lo novamente. Como eu deveria gerenciar isso‽
Felizmente, encontrei esta incrível ferramenta open source chamada Bencher. Existe um nível gratuito super generoso, então posso apenas usar Bencher Cloud para meus projetos pessoais. E no trabalho, onde tudo precisa estar em nossa nuvem privada, comecei a usar Bencher Auto-Hospedado.
Bencher tem adaptadores integrados, por isso é fácil de integrar ao CI. Após seguir o guia Rápido Início, consegui executar meus benchmarks e rastreá-los com o Bencher.
Usando este incrível dispositivo de viagem no tempo que um simpático coelho me deu, consegui voltar ao passado e reviver o que teria acontecido se estivéssemos usando o Bencher desde o início. Você pode ver onde fizemos pela primeira vez o push da implementação bugada de FizzBuzzFibonacci. Imediatamente recebi falhas no CI como um comentário na minha solicitação de pull. No mesmo dia, corrigi o bug de desempenho, eliminando aquele loop extra e desnecessário. Sem incêndios. Apenas usuários felizes.
Bencher: Benchmarking Contínuo
Bencher é um conjunto de ferramentas de benchmarking contínuas. Já teve algum impacto de regressão de desempenho nos seus usuários? Bencher poderia ter prevenido isso. Bencher permite que você detecte e previna regressões de desempenho antes que cheguem à produção.
- Execute: Execute seus benchmarks localmente ou no CI usando suas ferramentas de benchmarking favoritas. O CLI
bencher
simplesmente envolve seu harness de benchmark existente e armazena seus resultados. - Rastreie: Acompanhe os resultados de seus benchmarks ao longo do tempo. Monitore, consulte e faça gráficos dos resultados usando o console web do Bencher baseado na branch de origem, testbed e medida.
- Capture: Capture regressões de desempenho no CI. Bencher usa análises personalizáveis e de última geração para detectar regressões de desempenho antes que elas cheguem à produção.
Pelos mesmos motivos que os testes de unidade são executados no CI para prevenir regressões de funcionalidades, benchmarks deveriam ser executados no CI com o Bencher para prevenir regressões de desempenho. Bugs de desempenho são bugs!
Comece a capturar regressões de desempenho no CI — experimente o Bencher Cloud gratuitamente.