- COMP.CS.300
- 6. Puut (esim. keot)
- 6.4 Valgrind
- 6.4.2 Valgrind-harjoitus
Valgrind-harjoitus¶
Tavoite:
Opin käyttämään valgrind
-työkalua muistinhallinnan ongelmien
jäljittämiseen ja tulkitsemaan tämän työkalun tulosteita.
Tämä on tärkeää siksi, että lopuissa projekteissa yksi läpäisyvaatimus on,
että ohjelmassa ei ole muistin käsittelyyn liittyviä ongelmia.
Siitä on tarkoitus varmistua ohjelman
testausvaiheessa valgrind
-työkalun avulla.
Ohjeita:
Ota esille ohjelmakoodipohja: wk04_trees/valgrind
.
Tutkitaan seuraavaa pientä ohjelmaa, josta jo pintapuolisesti tutkimalla huomataan useita muistin käsittelyyn liittyviä ongelmatilanteita:
#include <iostream>
using namespace std;
int main() {
int number1;
int number2 = 111;
int *ptr1 = new int;
int *ptr2 = new int(222);
cout << number1 << " "
<< number2 << " "
<< *ptr1 << " "
<< *ptr2 << endl;
delete ptr1;
*ptr1 = 333;
}
Tehtävässä vertaillaan valgrind
-työkalun käyttöä Qt Creatorissa
ja komentorivillä.
Komennon valgrind
suorittaminen Qt Creatorissa¶
Avaa wk04_trees/valgrind
projekti Qt Creatorissa.
Jos haluat, voit suorittaa ohjelman. Application Output -ikkunaan pitäisi tulostua “exited with code 0”, eli ohjelman suoritus päättyi paluuarvolla EXIT_SUCCESS, mikä tarkoitaa, että kaikki meni hyvin (siitä huolimatta, että ohjelmassa ei oikeastaan ole mitään muuta kuin virheitä). Huomaa, että kun ohjelmassa on näin paljon muistinkäsittelyyn liittyviä ongelmia kuin tässä esimerkkiohjelmassa, niin ei ole mitenkään taattua, että sen suorittaminen sujuu ongelmitta. Tehtävää laadittaessa ohjelman on pystynyt suorittamaan loppuun asti linux-desktopille asennetulla kääntäjäversiolla, mutta emme voi taata, että ohjelma toimii samoin kaikissa ympäristöissä.
Suorita valgrind
valitsemalla Analyze > Valgrind Memory Analyzer
.
Ohjelma käynnistyy, mutta tällä kertaa Application Output -ikkunaan
tulostuu “Analyzing finished”.
Lisäksi Qt Creatorissa aukeaa ikkuna Memcheck, jonka mustassa yläpalkissa
pitäisi lukea “Memory Analyzer Tool finished, 8 issues were found”.
Tässä tehtävässä tutkimme tämän ikkunan sisältöä.
Jos Qt Creatorisi ei näytä otsikoiden Issue ja Location alla mitään,
klikkaa ikkunan mustassa yläpalkissa olevaa filtteriä esittävää
kuvaketta ja rastita kohta “External Errors”, niin
valgrind
-työkalun löytämät 8 ongelmaa ilmestyvät listaan.
Komennon valgrind
suorittaminen komentorivillä¶
Käynnistä komentorivikäyttöliittymä ja navigoi hakemistoon, jossa em. ohjelmakoodi on talletettuna (edellisen kohdan projektihakemisto).
Käännä lähdekoodisi käsin syöttämällä Linux-komentoriville käännöskäsky:
g++ -std=c++11 -Wall -g main.cc
Jos lähdekoodissa ei ollut virheitä, syntyy tuloksena suoritettava ohjelma (konekielitiedosto) nimeltä
a.out
.Jos haluat, voit kokeilla ohjelman suorittamista kirjoittamalla Linux-komentoriville käskyn:
./a.out
Suorita seuraavaksi
valgrind
-komento valmiiksi käännetylle ohjelmalle:valgrind --quiet --leak-check=full ./a.out
Jos ohjelmassa ei ole muistinkäsittelyyn liittyviä ongelmia, näytölle ei tulostu mitään ylimääräistä oman ohjelmasi tulosteiden lisäksi.
Koska tässä esimerkkiohjelmassa oli muistinkäsittelyongelmia,
valgrind
tulostaa käsittämättömän määrän informaatiota, jota alamme nyt tutkia. Sinun pitää katsoa tulostetta alusta alkaen, eli vieritä terminaalia ylöspäin niin pitkälle, että näet kirjoittamasivalgrind
-komennon. (Vinkki: terminaali-ikkuna kannattaa myös venyttää mahdollisimman korkeaksi työskentelyn helpottamiseksi.)
Asettele Qt Creator ja terminaali-ikkuna näytölle rinnakkain niin, että näet molemmat yhtä aikaa. Tämä helpottaa työskentelyäsi.
Lopuksi, kokeile vielä suorittaa Qt Creatorissa
Analyze > Valgrind Memory Analyzer with GDB
.
Huomaat, että tämä käynnistää valgrind
-työkalun debuggaustilassa, jolloin
ohjelmakoodia voi askeltaa rivi kerrallaan, kuten debuggerissa yleensäkin.
Nyt Application Output -ikkunasta löytyy samannäköinen
tuloste kuin terminaali-ikkunastakin.
Kun lopetat, varmista, että debuggeri on suljettu!
Useimmiten Qt Creator siirtyy Edit-tilasta Debug-tilaan, kun
suoritat komennon valgrind
.
Joskus voi käydä niin, että Qt Creator ei toimi näin, vaan Memcheck-ikkunan
näkymiseksi sinun pitää itse siirtyä Edit-tilasta Debug-tilaan.
Tämän “ominaisuuden” (?) ilmentyessä on hyvä ymmärtää, että valgrind
suoritetaan Qt Creatorissa aina Debug-tilassa.