Сенсация от PVS-Studio: "Найден идеальный проект без единой ошибки!"

30 Апр 2014

Автор: Евгений Рыжков

К нам обратился пользователь, который сказал, что в его довольно большом проекте (2000 файлов) не находится ни единой ошибки! Ни ошибки общего назначения, ни 64-битной ошибки, ни какой-либо другой. Поскольку так не бывает, то через несколько уточняющих писем мы уже сидели на его удаленной машине и сами смотрели что происходит. Настройки были в порядке, никаких явно глупых сбоев в работе не было, то есть все было корректно. После нескольких проб картина стала ясна: "В проекте действительно нашим анализатором не выдается ни одной ошибки!" Хотите узнать почему такое случилось?

Вообще в анализаторе PVS-Studio есть много способов скрыть лишние сообщение. Их можно отключить по коду, можно спрятать сообщения, относящиеся к каким-то файлам по имени или тексту сообщения, можно спрятать сообщения от файлов в некоторой папке. Конечно кто-то может предположить, например, что пользователь добавил в исключения всю папку проекта? Такое действительно можно сделать, но мы это сразу проверили. Нет, такое объяснение не годилось.

Но поведение было такое, как будто весь проект добавлен в исключения. Мы стали смотреть промежуточные конфигурационные файлы (file.PVS-Studio.cfg), которые создаются перед запуском анализатора для каждого файла. Среди прочей информации туда добавляются папки, на сообщения из которых не стоит выдавать диагностические сообщения. Обычно эта часть файла выглядит так:

exclude-path = *\boost\*
exclude-path = *\zlib\*
...
exclude-path = c:\program files (x86)\microsoft visual studio 11.0
exclude-path = c:\program files (x86)\microsoft sdks
...

Часть папок – это системные папки, часть папки типовых библиотек, и иногда там бывают пользовательские папки.

Но в этот раз там оказалась папка проекта, хотя ее туда (казалось бы) никто не добавлял. Из-за этого и получалось, что ни одно сообщение анализатора не выдается на код.

Итак, что же произошло?

Для исключения из результатов анализа системных библиотек, мы автоматически добавляем в исключённые директории пути из Additional Includes, которые начинаются на "C:\Program Files", "C:\Program Files (x86)".

Пути в Additional Includes могут быть прописаны относительно директории, из которой запускается компилятор (обычно это директория проектного файла). Например, никто не мешает добавить в Additional Includes путь вида "../Common".

Перед проверкой путей на вложенность их в "Program Files", мы нормализовали их с помощью класса DirectoryInfo:

String NormIncludePath = 
  new DirectoryInfo(list[i].Trim('"')).FullName.ToLower();

Однако, если путь был относительным, то он одновременно восстанавливался классом DirectoryInfo относительно текущей директории процесса, что, безусловно, некорректно. Теперь представим ситуацию. Процесс IDE devenv.exe запускается из своей обычной рабочей папки. Например, мы просто открыли среду через ярлык на рабочем столе. Если при этом еще проект содержит в Additional Includes относительные пути, то такие пути не проходили фильтрацию, как системные. Ведь стандартная директория у devenv.exe - c:\Program Files (x86)\Microsoft Visual Studio 12.0\Common7\IDE\. И соответственно, попадали в исключения.

Исправить ошибку в коде очень просто, надо грамотно раскрыть относительный путь:

String NormIncludePath = list[i].Trim('"');
ExpandRelativePath(
  ref NormIncludePath, CompilerWorkingDirectory);
NormIncludePath = NormIncludePath.ToLower();

Итак, еще раз к чему могла привести эта ошибка в наших анализаторах. Если в вашем проекте используются относительные пути в Additional Includes, и вы запускаете среду определенным образом (через ярлык Visual Studio), то вы могли не получать части сообщений от анализатора. Эта ошибка была в PVS-Studio, но в новой версии нашего продукта ошибка исправлена.

P.S. К сожалению, идеальный проект, на котором наш анализатор не выдает ошибок, вряд ли существует. Во всяком случае мы продолжаем его искать.