Eclipse Linux Tools: conhecendo os principais plugins

A plataforma Eclipse prov� um ambiente de desenvolvimento gr�fico para aplicaç�es de v�rias naturezas, possui uma s�rie de plug-ins para o desenvolvimento em outras linguagens de programaç�o, como C e C++, por meio do projeto Eclipse CDT (C/C++ Development Tools). Aliado a este tem-se o projeto do Eclipse Linux Tools, cujo o objetivo � disponibilizar uma interface simples para facilitar a an�lise e otimizaç�o de aplicaç�es nas linguagens C e C++.

O Eclipse Linux Tools � composto de uma s�rie de plug-ins que fazem interface com as ferramentas de linha de comando, que s�o usualmente utilizadas pelos desenvolvedores em Linux. S�o elas:

Valgrind: um framework de an�lise de programa em tempo de execuç�o que faz uso de um mecanismo de instrumentaç�o din�mica. � a base para construç�o das ferramentas: Helgrind, Cachegrind, Massif e Memcheck.
Oprofile e Perf: ferramentas de coleta e an�lise de informaç�es provenientes da PMU (Performance Monitor Unit), a qual possui unidades especiais respons�veis por coletar eventos de hardware nos processadores.
Gprof: o GNU Profiler � uma ferramenta de profiling de chamada de m�todos e execuç�o de funç�es.
Gcov: o GNU Coverage � uma ferramenta de cobertura de c�digo.

Este artigo faz um tour por essas ferramentas e mostra como elas s�o usadas dentro do Eclipse no desenvolvimento de aplicaç�es C e C++ no sistema operacional Linux. Ser�o mostradas as principais funcionalidades de cada ferramenta e exemplos dos relat�rios gerados.

No artigo foram usadas as seguintes vers�es dos componentes: Eclipse 4.5 (Mars), Linux Tools 4.0 e CDT 8.7, todos lançados no dia 24 de junho de 2015.

Consideraç�es iniciais

Para usar as ferramentas do Linux Tools descritas nesse artigo, algumas condiç�es s�o previamente requeridas:

Ter o seguinte ambiente de desenvolvimento instalado: Eclipse Mars e os plug-ins do CDT, al�m do Linux Tools;
Ter instalado o compilador GCC para compilar aplicaç�es C, ou G++ para compilar aplicaç�es C++;
Ter um projeto C ou C++ importado e compilado no workspace do Eclipse. Mais informaç�es podem ser encontradas na seç�o "C/C++ Development User Guide" (vide seç�o Links);
Ter instalado os bin�rios referente aos plug-ins usados. Na maioria das distribuiç�es Linux, os bin�rios das ferramentas Gcov e Gprof s�o instalados junto com o GCC. J� as outras ferramentas Perf, Oprofile e Valgrind est�o em pacotes separados que podem ser identificados pelo mesmo nome da ferramenta na maioria das distribuiç�es Linux como, por exemplo, no Fedora.

Instalaç�o do ambiente de desenvolvimento

A primeira coisa que precisamos fazer � baixar e extrair o pacote "Eclipse IDE for C/C++ Developers" (vide seç�o Links), que j� cont�m o Eclipse, CDT e Linux Tools. Para iniciar uma nova inst�ncia do IDE execute o arquivo "eclipse".

Para utilizar os plug-ins do Linux Tools � preciso criar uma configuraç�o de profile para cada um, sendo que cada configuraç�o � associada a um projeto espec�fico. A vantagem de utilizar configuraç�es espec�ficas por projeto � que cada um pode ter uma ou mais configuraç�es para cada plug-in, ou seja, cada configuraç�o pode ter par�metros e opç�es diferentes.

Atualmente, os plug-ins s�o divididos em tr�s categorias de profile: Code Coverage, Memory e Timing.

A categoria Code Coverage engloba o plug-in Gcov, a categoria Memory engloba tr�s funcionalidades do plug-in Valgrind, sendo elas: Memcheck, Helgrind e Massif. E por �ltimo, a categoria Timing cont�m os plug-ins Oprofile, Perf e Gprof e tamb�m a �ltima funcionalidade do Valgrind, chamada de CacheGrind.

Criaç�o e execuç�o de Profiles

Para visualizar as configuraç�es de profile dispon�veis, clique com o bot�o direito sobre o projeto, selecione a opç�o "Profiling Tools" e depois "Profiling Tools Configuration". Uma nova janela ser� aberta contendo as ferramentas de profile do Linux Tools. Para criar uma nova configuraç�o do Oprofile, por exemplo, clique duas vezes sobre o item "Profile Timing". Ap�s o item de configuraç�o ser criado mude para a aba "Timing" e no primeiro campo mude para utilizar o Oprofile. Para criar a configuraç�o de profile de outros plug-ins realize os mesmos passos, selecionando a categoria e o plug-in desejado.

Outras abas relevantes para a configuraç�o do profile s�o "Main" e "Arguments".

A aba "Main" possui o campo "C/C++ Application", que permite escolher qual bin�rio ser� usado para o profile. Se a aplicaç�o tiver um �nico bin�rio, esse campo ser� automaticamente preenchido, caso contr�rio, selecione o bin�rio desejado clicando no bot�o "Search Project". J� a aba "Arguments" permite que par�metros sejam passados para o bin�rio caso precise de alguma entrada para ser executado.

Com a configuraç�o criada e o bin�rio selecionado clique no bot�o "Profile" para iniciar o profile da aplicaç�o.

Para que os plug-ins obtenham a maior quantidade de informaç�es da aplicaç�o � altamente recomendado que a flag de debug (-g) seja usada durante a compilaç�o. Para algumas ferramentas espec�ficas, como o Gcov e Gprof, al�m da flag de debug, � preciso que outras sejam usadas, como veremos a seguir.

Ferramentas de Profiles

Valgrind

V�rias ferramentas de prop�sito espec�fico foram constru�das a partir da plataforma, dentre as principais temos o Memcheck, Cachegrind, Massif e Helgrind, cuja finalidades s�o, respectivamente: a depuraç�o e an�lise de mem�ria, uso das mem�rias cache do processador, an�lise de alocaç�o de mem�ria no heap da aplicaç�o e comportamento de programas multi-thread com POSIX threads.

O Valgrind � executado pela linha de comando valgrind, e qualquer uma de suas sub-ferramentas � chamada utilizando a opç�o --tool. Ao reportar os erros encontrados, as ferramentas fornecem informaç�es do c�digo fonte e a linha onde est�o os problemas.

Memcheck � a ferramenta padr�o do Valgrind, isto �, se a opç�o --tool n�o for usada. Ele � um detector de erros de mem�ria capaz de encontrar problemas de gest�o de mem�ria ao n�vel do programa, que incluem:

Utilizaç�o de mem�ria n�o inicializada;
Erros na alocaç�o e desalocaç�o de mem�ria;
Vazamento de mem�ria (memory leak);
Leitura e escrita em �reas impr�prias da mem�ria.

Cachegrind simula como uma aplicaç�o interage com a cache e o preditor de saltos (branch predictor) do processador, conseguindo gerar uma descriç�o detalhada do comportamento das caches de instruç�es e dados nos seus v�rios n�veis hier�rquicos do processador. Ela � muito �til na an�lise de performance de algoritmos sens�veis � cache do sistema. A ferramenta disponibiliza uma tabela com snapshots onde s�o mostrados:

O n�mero de cache read e read misses de instruç�es;
O n�mero de cache read/writes e read/writes misses de dados nos n�veis L1 e Ln (�ltimo n�vel);
Refer�ncias de mem�rias;
N�mero de saltos (branches) condicionais e indiretos executados e mispredicted.

Massif � um analisador de utilizaç�o da heap feita pela a aplicaç�o, ou seja, ele mostra a quantidade de mem�ria alocada e desalocada ao longo do tempo, sendo muito �til para desenvolvedores acharem hotspots na alocaç�o de dados pela aplicaç�o, possibilitando uma an�lise detalhada que visa a reduç�o da quantidade de mem�ria usada. Ao executar o Massif, ele gera um gr�fico mostrando a utilizaç�o da heap ao longo da execuç�o da aplicaç�o e inclui informaç�es sobre quais partes s�o respons�veis pelas maiores alocaç�es de mem�ria.

E, por �ltimo, o Helgrind � utilizado para detectar uma grande lista de problemas em aplicaç�es que utilizam POSIX threads (tamb�m chamadas de Pthreads), como deadlocks de threads.

O plug-in Valgrind do Linux Tools integra as ferramentas apresentadas com a interface gr�fica do Eclipse. Para utiliz�-lo, crie uma nova configuraç�o de Profile Memory (conforme mostrado no t�pico Criaç�o e execuç�o de Profiles) e escolha uma das ferramentas do Valgrind. No artigo utilizaremos a funcionalidade Memory Check como exemplo.

Na aba "Memory" � poss�vel customizar as opç�es usadas pelo Valgrind durante o profiling da aplicaç�o, como mostra a Figura 1. Ap�s escolher as opç�es desejadas, clique no bot�o "Profile".

Figura 1. Tela com aba de opç�es globais do plug-in Valgrind.

A Figura 2 mostra a tela do Valgrind com o resultado da an�lise de uma aplicaç�o utilizando o Memcheck, que continha problemas na hora de desalocar mem�ria. Um ponteiro foi inicializado com o operador new e no final do programa a mem�ria foi desalocada com o operador free, ao inv�s de delete. Nesse caso, o Memcheck marcar� o problema na linha de c�digo onde a desalocaç�o de mem�ria foi feita de maneira equivocada e ir� sugerir uma troca do operador free por delete para solucionar o problema.

Figura 2. Tela de exibiç�o de dados do plug-in Valgrind.

Gcov

� um programa de cobertura de c�digo que gera contagens exatas do n�mero de vezes que cada instruç�o de um programa � executada. Atualmente, o Gcov � distribu�do como utilit�rio padr�o da su�te do GCC (GNU Compiler Collection).

A utilizaç�o do Gcov ajuda a criar programas mais eficientes e descobre quais partes do c�digo est�o sendo menos usadas e quais n�o s�o usadas em nenhum momento. Com essas informaç�es fica mais f�cil saber em quais partes da aplicaç�o deve-se investir maior esforço para ter um retorno significativo na performance.

Ao executar o plug-in Gcov do Linux Tools, as seguintes informaç�es sobre a aplicaç�o s�o mostradas:

Com qual frequ�ncia cada linha do c�digo � executada;
Quais funç�es s�o usadas;
Qual a porcentagem do c�digo fonte est� sendo realmente utilizado.

Para que Gcov funcione corretamente � necess�rio compilar a aplicaç�o usando as flags -ftest-coverage e -fprofile-arcs do GCC.

A flag -ftest-coverage adiciona instruç�es no bin�rio para contagem do n�mero de vezes que cada linha de c�digo � executada. J� a flag -fprofile-arcs adiciona c�digo instrumentado para cada ramificaç�o da aplicaç�o executada. Al�m da utilizaç�o de ambas, para utilizar o Gcov � preciso compilar a aplicaç�o sem opç�es de otimizaç�o (por exemplo, -O3, -Ofast, etc.), pois esta pode n�o fornecer informaç�es necess�rias para a an�lise de partes do programa que est�o consumindo grande quantidade de tempo.

Para utilizar o plug-in Gcov crie uma nova configuraç�o de Profile Code Coverage e escolha o Gcov como ferramenta. Como a tela de configuraç�o do Gcov n�o possui nenhuma opç�o para configurar, como mostra a Figura 3, clique no bot�o "Profile".

Figura 3. Tela com aba de opç�es globais do plug-in Gcov

A Figura 4 mostra o resultado do profile de uma aplicaç�o com tr�s funç�es: main, sum_add e sum_sub. As duas primeiras foram usadas no decorrer da execuç�o do programa, por�m, a funç�o sum_sub n�o � utilizada em nenhum momento, por isso a coluna Coverage mostra o valor de 0% de cobertura para aquela funç�o espec�fica e zero linhas executadas. Caso esta aplicaç�o precise ser otimizada, o desenvolvedor n�o precisaria gastar esforços otimizando a funç�o sum_sub e poderia at� analisar se realmente precisa mant�-la no c�digo.

Figura 4. Tela de exibiç�o de dados do plug-in Gcov.

Gprof

Gprof � uma ferramenta de an�lise de performance que mostra o quanto de recurso de processamento � utilizado em cada trecho de c�digo. Atualmente, essa ferramenta do projeto GNU faz parte do conjunto de ferramentas bin�rias GNU Binutils.

A sua utilizaç�o permite a an�lise din�mica de aplicaç�es atrav�s da coleta de informaç�es e identificaç�o de trechos de c�digo mais executados, al�m do tempo consumido por cada funç�o. Este tipo de informaç�o permite analisar a quantidade de funç�es existentes no c�digo, a quantidade de vezes que cada funç�o � usada e a porcentagem de tempo gasto para executar cada funç�o.

O plug-in Gprof do Linux Tools mostra as seguintes informaç�es sobre a aplicaç�o:

A quantidade de chamadas que cada funç�o recebeu;
O tempo gasto em cada chamada;
A porcentagem do tempo gasto em uma determinada funç�o em relaç�o a execuç�o total de aplicaç�o.

Para que o Gprof funcione corretamente � necess�rio compilar a aplicaç�o usando a flag -pg do GCC para coletar as informaç�es necess�rias da aplicaç�o.

Para utiliz�-lo crie uma nova configuraç�o de Profile Timing e escolha o Gprof como ferramenta. Como a sua tela de configuraç�o n�o possui nenhuma opç�o, como mostra a Figura 5, clique no bot�o "Profile".

Figura 5. Tela com aba de opç�es globais do plug-in Gprof

A Figura 6 mostra o mesmo exemplo usado na seç�o do Gcov, por�m com a funç�o sum_sub sendo utilizada. Na tela � mostrada a quantidade de vezes em que cada funç�o foi chamada e a porcentagem de tempo utilizado por elas em relaç�o ao tempo de execuç�o total, que ocorreu em quase todo o tempo na funç�o main (90,96% do tempo). Assim, caso o desenvolvedor queira melhorar a performance desta aplicaç�o, ele dever� investir um maior esforço nesta funç�o.

Ao expandir cada funç�o na tela do Gprof � mostrado a quantidade de tempo gasto em cada linha de c�digo, por exemplo, sum_add (main.c:112) refere-se a linha 112 do arquivo main.c. Para ir at� esta linha no c�digo fonte basta clicar duas vezes sobre esse item na tela.

Figura 6. Tela de exibiç�o de dados do plug-in Gprof

Oprofile

� uma ferramenta de profiling muito utilizada por desenvolvedores no Linux para acessar informaç�es geradas por um hardware dedicado chamado de PMU (Performance Monitor Unit), que hoje se encontra na maioria dos processadores de uso geral. � respons�vel por registrar eventos da execuç�o e performance do processador, por exemplo, mem�rias referenciadas, acessos a mem�ria cache do processador, n�mero de interrupç�es de hardware e ciclos de CPU gastos na execuç�o das instruç�es. Estes eventos podem ser usados no c�lculo de m�tricas de desempenho de aplicaç�es tais como cache misses, misprediç�o de saltos condicionais, acesso a mem�ria e stalls de instruç�es nas v�rias unidades de processamento da CPU. Tamb�m, a partir da observaç�o de alguns eventos, � poss�vel descobrir �reas no c�digo mais executadas (ou que gastam maior tempo de execuç�o) e gargalos que provocam uma m� performance da aplicaç�o. Esta ferramenta deve ser executada em dois passos: o primeiro � coletar as informaç�es de eventos da PMU, para depois gerar um relat�rio para visualizaç�o dos dados. O plug-in OProfile do Linux Tools integra esta ferramenta de profiling na interface gr�fica do Eclipse, facilitando a utilizaç�o por desenvolvedores de v�rios n�veis de experi�ncia.

Para utilizar o plug-in crie uma nova configuraç�o de Profile Timing e escolha o Oprofile como ferramenta. Por padr�o, o plug-in ir� produzir dados sobre os ciclos de processamento gastos na aplicaç�o e mostra os valores em hierarquia por m�todos. Mude as opç�es padr�es caso seja necess�rio:

Na aba "Global" (veja Figura 7) pode-se escolher entre utilizar o operf (que � atualmente a opç�o padr�o) ou o opcontrol. Ambos s�o comandos usados para coletar informaç�es sobre os eventos de hardware, por�m, o desenvolvimento do opcontrol foi encerrado pela comunidade e, ent�o, n�o � recomendado o seu uso. Pode-se executar mais de uma vez a aplicaç�o, de forma que o resultado apresentado seja a soma das rodadas.
Na aba "Events" (veja Figura 8) � poss�vel personalizar quais eventos ser�o monitorados durante a execuç�o da aplicaç�o. Para modificar desmarque a opç�o "Use default events", selecione a opç�o "Enabled" e selecione os eventos desejados.

Ap�s terminar a configuraç�o do profile, clique no bot�o "Profile" para iniciar a an�lise da aplicaç�o.

Figura 7. Tela com aba de opç�es globais do plug-in Oprofile

Figura 8. Tela de seleç�o de eventos do plug-in Oprofile

Ao final do processamento � aberta uma tela contendo os dados coletados, como mostra a Figura 9. O resultado � exibido por porcentagem da ocorr�ncia do evento e � dividido em dois blocos principais: ocorr�ncia no execut�vel da aplicaç�o e ocorr�ncia no kernel do Linux e em bibliotecas compartilhadas do sistema. Essa porcentagem de ocorr�ncias � detalhada em mais tr�s n�veis: por funç�o, arquivo fonte (ou bin�rio) e por linha do c�digo (ou s�mbolo do bin�rio).

No exemplo da Figura 9, 78.06% do evento CPU_CLK_UNHALTED (ciclos de rel�gio do processador) ocorreu enquanto uma instruç�o do execut�vel era processada e o restante no Kernel e em bibliotecas do sistema. Sendo que 76.04% do evento aconteceu dentro da funç�o BZ2_bzDecompress (no c�digo fonte bzlib.c). A captura de tela n�o mostra, mas expandindo o BZ2_bzDecompress � mostrado uma lista de linhas onde aconteceram esses eventos, sendo que a linha 618 representa 54.75% deles. Percebe-se tamb�m que apenas 2.15% est� relacionada com chamadas para a Lib C (/usr/lib64/libc.2.20.so) e outros 19.78% com chamadas do sistema (system calls). Ou seja, se existe um gargalo de execuç�o, ele est� em uma �nica funç�o (BZ2_bzDecompress).

Figura 9. Tela de exibiç�o de dados do plug-in Oprofile

Perf

Da mesma forma que o Oprofile, a ferramenta de linha de comando Perf tamb�m utiliza eventos de hardware para a an�lise de desempenho da aplicaç�o. Ele foi desenvolvido juntamente com o c�digo fonte do Kernel do Linux e faz uso do seu subsistema de performance (desde a vers�o 2.6) e de eventos de software e tracepoints gerados pelo Kernel. O resultado do profile � bem preciso e r�pido por n�o fazer a instrumentaç�o do c�digo.

Para utilizar o plug-in, crie uma nova configuraç�o de Profile Timing e escolha o Perf como ferramenta.

Para customizar as opç�es que ser�o usadas por ele para fazer o profile da aplicaç�o, clique na aba "Perf Options". A Figura 10 mostra as opç�es que vem marcadas por padr�o, dentre as quais merecem atenç�o:

Com a opç�o "Show source Disassembly view" habilitada, ap�s a execuç�o do profile ser� mostrada a tela "Perf Source Disassembly", onde � exibido o c�digo assembly do execut�vel da aplicaç�o.
Com a opç�o "Show Stat View" habilitada ser� usado o comando perf stat para fazer a contagem estat�stica da ocorr�ncia dos eventos, isto �, n�o ser�o coletadas informaç�es de correspond�ncia entre os eventos e os s�mbolos, funç�es e linhas de c�digo da aplicaç�o. Ao final da execuç�o do profile ser� mostrada a tela "Perf Statistics". Ao fazer o profile da aplicaç�o duas ou mais vezes usando a opç�o perf stat, � poss�vel fazer uma comparaç�o entre os resultados das �ltimas duas execuç�es clicando em "view menu" na tela do "Perf Statistics" e selecione a opç�o "Compare Latest".

Figura 10. Tela de opç�es do plug-in Perf

Al�m de personalizar as opç�es gerais que ser�o usadas pelo Perf, � poss�vel modificar quais eventos ser�o analisados. Para isso, mude para a aba "Perf Events" e desmarque a opç�o "Default Event", como � mostrado na Figura 11. Nesta aba � poss�vel navegar entre as v�rias categorias de eventos, tais como Kernel PMU Events, Hardware Events, Hardware cache event.

Figura 11. Tela para seleç�o de eventos no plug-in Perf

Ap�s terminar a configuraç�o do profile, clique no bot�o "Profile" para iniciar a an�lise da aplicaç�o.

A Figura 12 mostra a tela de resultados de uma sess�o de profile com o plug-in Perf. Nela � exibida a quantidade de amostras coletadas dos eventos e a porcentagem de ocorr�ncias, tanto no execut�vel da aplicaç�o quanto nas bibliotecas de sistema e Kernel do Linux. Esta tela de resultados � similar � do plug-in Oprofile, que vimos na Figura 9.

Figura 12. Tela de exibiç�o de dados do plug-in Perf

Podemos concluir que o uso dessas ferramentas ajuda muito no desenvolvimento e na aplicaç�o de boas pr�ticas, pois como elas mostram os poss�veis problemas de desempenho do sistema, fica f�cil saber onde podemos melhorar o c�digo.

At� a pr�xima!

Links

Projeto C/C++
http://help.eclipse.org/mars/index.jsp.

Eclipse IDE for C/C++ Developers
https://eclipse.org/downloads

Valgrind
http://valgrind.org

Gcov
https://gcc.gnu.org/onlinedocs/gcc/Gcov.html

Gprof
https://sourceware.org/binutils/docs/gprof

OProfile
http://oprofile.sourceforge.net

Perf
https://perf.wiki.kernel.org/index.php/Main_Page