Viva64: разработка 64-битных приложений.

Евгений Рыжков
Viva64.com

Декабрь 2006

Viva64 – это инструмент для поиска ошибок и возможных проблем в С/C++ коде при переносе приложений на 64-битную платформу. Сейчас, когда необходимость выпуска 64-битных версий программного обеспечения осознали почти все разработчики, как никогда необходимо убедиться в качестве разрабатываемого продукта. И если традиционная 32-битная версия Вашего приложения протестирована на должном уровне, то перенос ее на 64-битную платформу может выявить неожиданные проблемы. Обзору проблем переноса приложений посвящены отдельные статьи, а в данном документе мы расскажем о том, как обеспечить необходимый уровень качества кода с помощью статического анализатора Viva64.

Обзор основных возможностей.

Столкнувшись с необходимостью переноса существующих приложений на новую 64-битную систему, разработчики программного обеспечения оказываются в необычном для себя положении. Программы, которые много лет работали как часы, начинают вести себя непредсказуемым образом. Конечно же, программе стало доступно больше оперативной памяти. Однако при попытке обработке больших, чем ранее, объемов данных, приложение может зависнуть, упасть или, что хуже, вместо файлов с результатами работы выдать пользователю файлы с мусором. Это происходит из-за того, что изменились размеры некоторых типов данных (прежде всего указателей). Однако обнаружить места в коде программы, где из-за этого изменилась последовательность выполнения кода, с помощью стандартных сообщений компилятора невозможно. Ведь компилятор не может выдавать диагностические сообщения на все потенциально некорректные конструкции, хотя программисту их все же необходимо найти.

На помощь приходит статический анализатор кода Viva64, который, интегрируясь в Visual Studio 2005, позволяет:

• выявить некорректные конструкции в коде (с точки зрения поддержки 64 бит);
• привести точную и полную диагностику вплоть до номера строки;
• осуществлять навигацию по некорректным участкам кода;
• проанализировать последствия, к которым может привести данная ошибка с помощью подробной справочной системы, интегрирующейся в MSDN;
• подсказать пути исправления ошибок на примерах из документации;
• проводить анализ кода всего проекта или решения (в терминологии Microsoft Visual Studio), а не только отдельных файлов;

Viva64 – это первый в мире анализатор кода на совместимость с 64-битными системами. Несмотря на то, что существовали ранее и существуют сейчас другие анализаторы кода (как правило, lint-подобные), Viva64 принципиально выделяется следующим:

• ориентация исключительно на поиск проблем в 64-битном коде, как при переносе 32-битных программ, так и при разработке новых приложений;
• полноценная интеграция с Microsoft Visual Studio - анализ файлов, навигация по коду, справочная система;
• минимум настроек - для работы с анализатором не надо изучать документацию по настройке, выбирать уровни проверки или задавать номера анализируемых правил;
• анализатор готов к работе сразу же после установки.

Посмотрим же на анализатор Viva64 в действии.

Установка и настройка.

Скачать анализатор можно с сайта www.Viva64.com. Незарегистрированная версия позволяет полностью оценить всю его мощь. Установка не вызывает никаких проблем, поэтому пользователь сразу мог бы приступить к настройке, если бы это был обычный анализатор кода. Однако в Viva64 наиболее важная настройка для пользователя лишь одна – это диалог ввода регистрационной информации. Да и эта настройка понадобиться только после того, как Вы сможете оценить все возможности инструмента. Как мы уже говорили, Viva64 интегрируется в Microsoft Visual Studio 2005 (рисунок 1) и позволяет сразу же приступить к работе. Что мы и сделаем.

 

Рисунок 1 – Интеграция Viva64 в Microsoft Visual Studio 2005.

Заметим лишь, что информацию о некоторых других настройках в случае необходимости пользователь может узнать из встроенной справочной системы.

В дистрибутив Viva64 входит тестовый пример PortSample – проект для Visual Studio 2005, который содержит простую программу, демонстрирующую некоторые классические ошибки. Этот пример устанавливается отдельно из папки Viva64 меню программ Windows.

Установим этот пример.

Принцип работы Viva64.

Откроем, скомпилируем и запустим 32-битную версию PortSample. Для чего в Visual Studio 2005 выберем тип платформы Win32 и пункт меню «Build». После запуска примера включим все галочки (рисунок 2) и нажмем кнопку «Run». Программа корректно отработает и через некоторое время выведет сообщение «Done». В программе при этом буду вызваны функции выбранные функции VXXX() с демонстрационным кодом.

Рисунок 2 – Окно тестового примера.

Теперь скомпилируем и запустим 64-битную версию того же примера, для чего выберем платформу x64 в настройках проекта Visual Studio. После нажатия на кнопку «Run» программа поведет себя непредсказуемым образом и, скорее всего, упадет (в зависимости от компьютера). Самое время для Viva64 проявить себя.

Откроем файл V1XX.cpp и выберем команду в меню Viva64 проверить текущий файл («Check current file»). Сначала выполнится препроцессорная обработка файла для раскрытия макроопределения, включения заголовочных файлов и т.д. В результате препроцессорной обработки получится файл с расширением «.i», находящийся в папке проекта. Для созданного файла будет запущен анализатор, который и выполнит проверку кода. После чего результаты работы анализатора будут размещены в окне вывода среды Visual Studio 2005. Обратим внимание, что выполнять анализ файла можно лишь для платформы x64. В случае попытки проверить файл для другой платформы (например, Win32) будет выведено сообщение об ошибке. Это сделано по той причине, что для разных платформ возможно использование разных веток выполнения программы, которые задаются с помощью #ifdef/#endif конструкций.

Поскольку для работы анализатора Viva64 необходимо выполнить препроцессорную обработку (preprocessing) файла, то сначала необходимо убедиться, что файл компилируется для платформы x64 корректно, без сообщений об ошибках.

Использование Viva64: поиск, анализ и исправление ошибок в коде.

Приступим непосредственно к поиску ошибок, для чего при открытом примере PortSample выберем проверку текущего проекта “Check Current Project”. Результаты работы анализатора представлены в окне вывода (рисунок 3).

 

Рисунок 3 – Окно вывода.

Вот и первое сообщение об ошибке:

error V101: Implicit assignment type conversion to memsize type.

Переходим с помощью клавиши F4 на соответствующее место в коде.

  unsigned imageWidth = 1000;
  unsigned imageHeght = 1000;
  unsigned bytePerPixel = 3;
  unsigned maxFrameCountInBuffer;
  if (IsX64Platform()) {
    maxFrameCountInBuffer = 2000;
  } else {
    maxFrameCountInBuffer = 100;
  }
  size_t bufferSize = imageWidth * imageHeght *            // 34
                      bytePerPixel * maxFrameCountInBuffer;

Ошибка выдается на строку с объявлением переменной bufferSize. Мы видим, что для 64-битной платформы переменная maxFrameCountInBuffer имеет значение 2000. Это вполне допустимо, так как после перемножения всех переменных мы ожидаем получить 64-битное число (размер буфера), но… получим только 32-битное. В результате переменная bufferSize никогда не будет больше 4 гигабайт, хотя сама по себе она представлена 64-битным типом. Обратите внимание, что компилятор даже при самом высоком уровне диагностики ничего не выдает на эту строку. А Viva64 говорит, что здесь ошибка. Если Вы не уверены, что до конца понимаете проблему с разрядностью типов, то нажатие клавиши F1 откроет встроенную справочную систему Viva64, где приводится подробное описание ошибки с рекомендациями по исправлению.

Продолжим исследование примера, для чего нажмем F4 еще раз. Перейдем на сообщение:

error V102: Usage non memsize type for pointer arithmetic.

Рассмотрим код, который находится в 71 строке:

  int domainWidth;
  int domainHeght;
  int domainDepth;
  ...  
  char *buffer;
  ...  
  char *current = buffer;
  char *end = buffer;
  end += domainWidth * domainHeght * domainDepth; // 71

Здесь проблема другого вида. Как следует из описания ошибки, для арифметики с указателями используется тип для этого не предназначенный. В данном случае арифметика с указателями ведется с использованием 32-битного типа int, а не 64-битного, как следовало бы. Типы данных, использующиеся для работы с указателями, а также для хранения размеров объектов (например, массивов) в Viva64 называются memsize-типами. В справочной системе подробно рассматривается использование memsize-типов.

Посмотрим в справочной системе, как исправить данную ошибку. В ней приведены рекомендации по изменению типов, участвующих в подобной арифметике. Исправление данного примера заключается в изменении типа переменных domainWidth, domainHeigh, domainDepth на тип ptrdiff_t или использовании явных приведений типов.

Всего же анализатор выдаст на проект PortSample более десятка сообщений об ошибках. А что же компилятор? Компилятор Microsoft Visual C++ 8.0 с включенной диагностикой проблем переноса (ключ /Wp64) и максимальным уровнем диагностических сообщений (/W4) выдает на весь проект… лишь несколько диагностических сообщения, которые также ловятся анализатором Viva64. Это приводит к тому, что при переносе приложений на 64-битную платформу без использования Viva64 большинство ошибок так и останутся не обнаруженными.

Место Viva64 в процессе разработки программного обеспечения.

Существует для варианта использования Viva64 в процессе разработки: в случае переноса готового 32-битного приложения на 64-битную платформу и в случае разработки нового 64-битного приложения.

Перенос 32-битного приложения целесообразно выполнять так:

• подготовить проект в Visual Studio 2005, который корректно собирается для платформы Win32;
• добавить в проект новую платформу x64, собрать проект, исправив возникающие ошибки компиляции;
• включить максимальный уровень диагностики (/W4, warning level 4) и поиск проблем переноса (/Wp64, Detect 64-Bit Portability Issues), исправить диагностические сообщения;
• с помощью Viva64 выполнить поиск всех возможных ошибок, проанализировать их и исправить;
• перейти к тестированию приложения.

В случае разработки нового 64-битного приложения целесообразно не дожидаться окончания этапа разработки, а сразу же использовать Viva64 для контроля разрабатываемого кода. Причем проверять можно как весь проект или решение, так и отдельные наиболее важные участки кода.

Viva64 – не серебряная пуля, или что же дальше …

Необходимо заметить, что Viva64 не решает всех задач, возникающих при разработке 64-битного программного обеспечения:

• Viva64 не может заменить полноценного тестирования;
• Viva64 знает о многих ошибках, но не обо всех;
• Viva64 требует от разработчика понимания принципов работы компьютера.

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