Analiza projekta 'ECE350Final'

U okviru predmeta Verifikacija softvera, analizirala sam projekat pod nazivom ECE350Final, koji je dostupan na adresi: ECE350Final. Analizirana je main grana, a hash koda commita je: 9f2178701f3656a61eb08b5a3cc241ee477ca802. Ovaj projekat implementira igru Durak u programskom jeziku C++.

Opis igre

Durak je popularna kartaška igra koja se igra sa špilom od 36 karata. Cilj igrača je da izbegnu da postanu „durak” (najgori igrač), odnosno da ostanu poslednji sa kartama u ruci.

Igra se odvija prema sledećim pravilima:

• Igrači se smenjuju u napadu i odbrani.
• Napadač postavlja kartu na sto.
• Odbrambeni igrač mora odgovoriti odgovarajućom kartom.
• Ukoliko odbrambeni igrač ne može da se odbrani, karta prelazi u njegove ruke.
• Igra traje dok neki igrač ne ostane bez karata.

Korišćeni alati

Za analizu i verifikaciju koda korišćeni su sledeći alati:

1. Catch2 – za pisanje i izvršavanje jedinčnih testova.
2. Valgrind Memcheck – za otkrivanje curenja memorije i problema s upravljanjem memorijom.
3. Valgrind Callgrind – za profilisanje performansi i analizu poziva funkcija.
4. Valgrind Massif – za analizu upotrebe memorije tokom izvršavanja programa.
5. Clang-Tidy – za statičku analizu koda i uočavanje potencijalnih grešaka.
6. CppCheck – za statičku analizu koda sa fokusom na sigurnost i kvalitet.

Jedinični testovi uz Catch2 i lcov

Jedinični testovi su napisani korišćenjem biblioteke Catch2 u kombinaciji sa alatom lcov kako bi se osigurala visoka pokrivenost koda i pouzdanost aplikacije. Catch2 je omogućio jednostavnu i čitljivu sintaksu za pisanje testova, dok je alat lcov korišćen za generisanje vizualnih izveštaja o pokrivenosti, što je pomoglo da se identifikuju i testiraju neobrađene grane koda. Ovaj proces je omogućio unapređenje kvaliteta koda i smanjenje mogućnosti grešaka, osiguravajući da aplikacija zadovolji sve funkcionalne i performansne zahteve.

Pokretanje testova

Da biste pokrenuli testove, pratite sledeće korake:

1. Klonirajte projekat pomoću sledeće komande:

   git clone https://github.com/MATF-Software-Verification/2024_Analysis_ECE350Final.git
   cd 2024_Analysis_ECE350Final

2. Instalirajte alat lcov:

   sudo apt install lcov

3. Pozicionirajte se u direktorijum sa jediničnim testovima:

   cd unit_test/

4. Dodajte +x privilegiju za skriptu run_tests.sh:

   chmod +x run_tests.sh

5. Pokrenite testove:

   ./run_tests.sh

Ovim postupkom možete pokrenuti testove i generisati izveštaje o pokrivenosti koda.

Prevođenje programa

Napomena: pre pokretanja svih Valgrind alata neophodno je da:

1. Klonirate projekat pomoću sledeće komande:

   git clone https://github.com/MATF-Software-Verification/2024_Analysis_ECE350Final.git
   cd 2024_Analysis_ECE350Final

2. Pozicionirate se u src folder:

   cd src

3. Prevedete program naredbom:

   make

Valgrind Memcheck

Nakon sto ste preveli program kao sto je opisano u delu Prevođenje programa, potrebno je da pratite sledeće korake:

1. Instalacija potrebnih alata

   sudo apt install valgrind

2. Pozicionirajte se u direktorijum gde se nalazi skript za pokretanje memcheck-a:

   cd ../valgrind/memcheck

3. Dodajte +x privilegiju za skriptu run_memcheck.sh:

   chmod +x run_memcheck.sh

4. Pokrenite skipt:

   ./run_memcheck.sh

Kada pokrenete skriptu na ovaj način, Valgrind analizira vaš program tokom njegove izvršne faze. To znači da će se sam program pokrenuti i izvršavati dok Valgrind prati memorijske greške. Potrebno je poznavati pravila igre, kako bi bilo moguce da se skript izvrsi do kraja.

Valgrind Callgrind

Nakon sto ste preveli program kao sto je opisano u delu Prevođenje programa, potrebno je da pratite sledeće korake:

1. Instalacija potrebnih alata

   sudo apt install valgrind
   sudo apt-get install kcachegrind

2. Pozicionirajte se u direktorijum gde se nalazi skript za pokretanje callgrind-a:

   cd ../valgrind/callgrind

3. Dodajte +x privilegiju za skriptu run_callgrind.sh:

   chmod +x run_callgrind.sh

4. Pokrenite skipt:

   ./run_callgrind.sh

Pokretanje skripte će se sam program pokrenuti i izvršavati pa je potrebno je poznavati pravila igre, kako bi bilo moguce da se skript izvrsi do kraja.

Valgrind Massif

Nakon sto ste preveli program kao sto je opisano u delu Prevođenje programa, potrebno je da pratite sledeće korake:

1. Instalacija potrebnih alata

   sudo apt install valgrind

2. Pozicionirajte se u direktorijum gde se nalazi skript za pokretanje massifa-a:

   cd ../valgrind/massif

3. Dodajte +x privilegiju za skriptu run_massif.sh:

   chmod +x run_massif.sh

4. Pokrenite skipt:

   ./run_massif.sh

Pokretanje skripte će se sam program pokrenuti i izvršavati pa je potrebno je poznavati pravila igre, kako bi bilo moguce da se skript izvrsi do kraja.

Clang-tidy

Clang-Tidy je statički analizator koda koji pomaže u otkrivanju grešaka, unapređenju kvaliteta koda i primeni kodnih standarda u C++ projektima.

Da biste pokrenuli Clang-tidy , pratite sledeće korake:

1. Klonirajte projekat pomoću sledeće komande:

   git clone https://github.com/MATF-Software-Verification/2024_Analysis_ECE350Final.git
   cd 2024_Analysis_ECE350Final

2. Instalacija potrebnih alata

   sudo apt-get install clang-tidy
   

3. Pozicionirajte se u direktorijum gde se nalazi skript za pokretanje clang-tidy:

   cd clang

4. Dodajte +x privilegiju za skriptu run_clang.sh:

   chmod +x run_clang.sh

5. Pokrenite skipt:

   ./run_clang.sh

CppCheck

Cppcheck je alat za statičku analizu C++ koda koji pomaže u pronalaženju grešaka, sigurnosnih propusta i potencijalnih problema u kodu, bez potrebe za izvršavanjem programa. Da biste pokrenuli CppCheck , pratite sledeće korake:

1. Klonirajte projekat pomoću sledeće komande:

   git clone https://github.com/MATF-Software-Verification/2024_Analysis_ECE350Final.git
   cd 2024_Analysis_ECE350Final

2. Instalacija potrebnih alata

   sudo apt install cppcheck
   

3. Pozicionirajte se u direktorijum gde se nalazi skript za pokretanje cppcheck-a:

   cd cppcheck

4. Dodajte +x privilegiju za skriptu run_cppCheck.sh:

   chmod +x run_cppCheck.sh

5. Pokrenite skipt:

   ./run_cppCheck.sh

Zaključak

Testiranje jedinica koda:

Testiranje klasa Card i Deck postiglo je visok nivo pokrivenosti koda, sa 95.3% pokrivenosti linija i 100% pokrivenosti funkcija, što potvrđuje stabilnost i ispravnost implementacije.

Uočene greške su ispravljene, a dodate funkcionalnosti omogućile su detaljno testiranje ključnih scenarija.

Glavni izazov ostaje refaktorisanje main.cpp radi omogućavanja modularnog testiranja, što predstavlja prostor za dalja poboljšanja.

Valgrind Memcheck

Program izgleda vrlo dobro u pogledu upravljanja memorijom. Memcheck je potvrdio da nema curenja memorije, nevalidnog pristupa ili drugih problema sa memorijom. S obzirom na ovo, možemo biti sigurni da nema značajnih problema sa memorijom.

Valgrind Callgrind

Alat Callgrind je identifikovao nekoliko ključnih problema u performansama igre:

1. Visoka potrošnja resursa
   Funkcija dl_lookup_symbol_x uzrokuje značajan trošak resursa, što ukazuje na učestalo dinamičko povezivanje, verovatno zbog poziva spoljnog koda i učitavanja biblioteka.

2. Česta upotreba funkcija
   Funkcije kao što su Card::print(), defend, attact i manipulacija špilom karata najčešće se pozivaju, što ukazuje na potrebu za optimizacijom ključnih delova logike igre.

3. Intenzivna upotreba standardnih biblioteka
   Funkcije povezane sa std::ostream (ispis) i operacije sa std::vector izazivaju prekomerne alokacije memorije zbog čestih modifikacija vektora, što negativno utiče na performanse.

Preporuke za optimizaciju

• Optimizacija operacija sa std::vector
  Unapred rezervisati memoriju pomoću reserve kako bi se smanjio broj alokacija i manipulacija.

• Implementacija move semantike
  Korišćenje move semantike može smanjiti operacije kopiranja i povećati efikasnost, čime se izbegava nepotrebno trošenje resursa.

Valgrind Massif

• Glavna potrošnja memorije: Program alocira ukupno 72.862 bajta na heap-u, pri čemu 96,91% dolazi iz standardnih C++ biblioteka tokom inicijalizacije (dl init), što je očekivano ponašanje.

• Direktne alokacije memorije: Povezane su sa funkcijama Deck::askCard (ulazne operacije) i main (izlazne operacije).

• Efikasnost upravljanja memorijom:

  • Nema značajnih curenja memorije.
  • Dodatna memorija (extra-heap) raste u malim granicama, što ukazuje na efikasno upravljanje memorijom.

• Problemi s memorijom: Memorija koja se alocira tokom trajanja programa (npr. zbog velikog broja vektora) nije oslobađana do kraja, što uzrokuje stabilizaciju memorijske potrošnje na višem nivou.

Program pokazuje stabilnu potrošnju memorije, ali dodatna optimizacija, kao što je smanjenje učestalosti alokacija i dealokacija, može poboljšati efikasnost i skalabilnost. Primena ovih preporuka može značajno unaprediti efikasnost igre, smanjiti troškove resursa i poboljšati stabilnost i sigurnost koda.

Clang-tidy

Alat identifikuje probleme poput nepravilnog formatiranja, korišćenja zastarelih stilova, nedostatka inicijalizacije promenljivih, upotrebe "magic numbers" i nesigurnog kastovanja, te nudi preporuke za poboljšanje koda u skladu sa modernim standardima.

CppCheck

Alat Cppcheck je analizirao kod i detektovao nekoliko grešaka koje su klasifikovane u različite kategorije: greške vezane za const kvalifikator, eksplicitne konstruktore, negativne indekse i neiskorišćene funkcije. Međutim, većina ovih grešaka nije bila kritična ili relevantna za stabilnost programa. Konkretno, greške vezane za negativne indekse su bile opravdane u kontekstu validacije korisničkog unosa, a neiskorišćene funkcije su bile korišćene u testiranju. Na kraju, alat nije pronašao veće greške koje bi uticale na stabilnost programa.

Detaljne rezultate primene svih alata i sve zaključke možete pogledati fajlu u ProjectAnalysisReport.pdf.

Autor

Jelena Mitrović

Broj indeksa: 1019/2024

Kontakt: jelenamitrovic296@gmail.com