Как PVS-Studio защищает от поспешных правок кода
Хотя только недавно была заметка про проект CovidSim, есть хороший повод вновь про него вспомнить и продемонстрировать пользу регулярного использования PVS-Studio. Бывает, что все мы спешим и вносим правки в код, потеряв сосредоточенность. Статический анализатор может оказаться здесь хорошим помощником.
Всё началось с написания вот этих двух небольших заметок про открытый проект COVID-19 CovidSim Model:
- Пример, как в PVS-Studio появляются новые диагностики;
- Исследование COVID-19 и неинициализированная переменная.
После этого мы подумали и решили мониторить и этот проект с целью популяризации регулярного использования статических анализаторов кода. Подробнее про эту затею мой коллега писал в этой статье.
Только мы начали проверять этот проект, как результаты не заставили себя ждать :). Сейчас я покажу свежую ошибку, вызванную недавними неаккуратными правками кода. Конечно, мы не станем описывать в дальнейшем каждый баг и недочёт, обнаруженный анализатором. Будем писать только про что-то интересное.
Вот что получилось, после недавних модификаций файла CovidSim.cpp:
Кто-то решил создавать массивы не на стеке, а в куче. Но был невнимателен, внося изменения. Обратите внимание, что освобождение памяти находится после оператора return:
int GetXMLNode(....)
{
char* buf = new char[65536];
char* CloseNode = new char[2048];
char* CloseParent = new char[2048];
....
if (ResetFilePos) fseek(dat, CurPos, 0);
return ret; // <=
delete[] buf;
delete[] CloseNode;
delete[] CloseParent;
}В результате перед нами фрагмент недостижимого кода (unreachable code). И заодно утечка памяти.
Хорошо, что PVS-Studio тут же сообщает про эту ошибку: V779 Unreachable code detected. It is possible that an error is present. CovidSim.cpp 675
Используйте статический анализ регулярно и сможете устранить множество ошибок на самом раннем этапе! Согласитесь, лучше сразу исправить этот мелкий баг, чем гадать, почему вдруг программа начала потреблять слишком много оперативной памяти.
И последнее, что хочется отметить. Эта ошибка была бы невозможна, если не вручную управлять выделением и освобождением памяти, а применить RAII подход и использовать умные указатели.
Правильный и надёжный вариант кода:
std::unique_ptr<char[]> buf(new char[65536]);
std::unique_ptr<char[]> CloseNode(new char[2048]);
std::unique_ptr<char[]> CloseParent(new char[2048]);Спасибо за внимание. Следуйте за мной в мир С++ и багов :). Twitter.
0