Проверяем исходный код Appleseed

29 Сен 2015

Автор: Святослав Размыслов

Введение
Результаты проверки
Заключение

Большинство проектов, описанные нами в статьях, содержат десятки предупреждений анализатора PVS-Studio. Конечно же это малая часть из отчёта анализатора, отобранная для статьи, но бывают проекты, где всех предупреждений не так много, и из них интересных "ляпов" для статьи не набирается. Обычно это маленькие или уже неразвивающиеся проекты. В этой статье я расскажу о проверке проекта Appleseed, где с точки зрения PVS-Studio код очень качественный.

Введение

Appleseed - это современный движок с открытым исходным кодом и физически обоснованным рендерингом, созданный для воспроизведения фотореалистических изображений, анимаций и визуальных эффектов. Он предлагает набор инструментов, построенных на надёжных и открытых технологиях, как для отдельных пользователей, так и для небольших студий.

С помощью анализатора PVS-Studio в проекте Appleseed, состоящем примерно из 700 файлов с исходным кодом, найдено всего несколько интересных предупреждений 1-го и 2-го уровней.

Результаты проверки

V670 The uninitialized class member 'm_s0_cache' is used to initialize the 'm_s1_element_swapper' member. Remember that members are initialized in the order of their declarations inside a class. animatecamera cache.h 1009

class DualStageCache
  : public NonCopyable
{
  ....
    S1ElementSwapper    m_s1_element_swapper;     // <=Line 679
    S1Cache             m_s1_cache;

    S0ElementSwapper    m_s0_element_swapper;
    S0Cache             m_s0_cache;               // <=Line 683
};

FOUNDATION_DSCACHE_TEMPLATE_DEF(APPLESEED_EMPTY)
DualStageCache(
    KeyHasherType&      key_hasher,
    ElementSwapperType& element_swapper,
    const KeyType&      invalid_key,
    AllocatorType       allocator)
  : m_s1_element_swapper(m_s0_cache, element_swapper)//warning...
  // warning: referring to an uninitialized member
  , m_s1_cache(m_s1_element_swapper, allocator)
  , m_s0_element_swapper(m_s1_cache)
  , m_s0_cache(key_hasher, m_s0_element_swapper, invalid_key)
{
}

Анализатор обнаружил возможную ошибку в списке инициализации конструктора класса. Судя по комментарию "warning: referring to an uninitialized member", который уже присутствовал в коде, разработчики знают, что для инициализации поля 'm_s1_element_swapper' используется ещё неинициализированное поле 'm_s0_cache', но не исправляют. Согласно стандарту языка, порядок инициализация членов класса в конструкторе происходит в порядке их объявления в классе.

V605 Consider verifying the expression: m_variation_aov_index < ~0. An unsigned value is compared to the number -1. appleseed adaptivepixelrenderer.cpp 154

size_t m_variation_aov_index;
size_t m_samples_aov_index;

virtual void on_tile_end(
                         const Frame& frame,
                         Tile& tile,
                         TileStack& aov_tiles) APPLESEED_OVERRIDE
{
  ....
  if (m_variation_aov_index < ~0)                           // <=
    aov_tiles.set_pixel(x, y, m_variation_aov_index, ....);

  if (m_samples_aov_index != ~0)                            // <=
    aov_tiles.set_pixel(x, y, m_samples_aov_index, ....);
  ....
}

Результат инверсии '~0' является значение -1, имеющее тип int. Потом это число превращается в беззнаковый тип size_t. Не страшно, но не эстетично. В таких выражениях рекомендуется сразу указывать константу SIZE_MAX.

На первый взгляд явной ошибки здесь нет, но моё внимание привлекло использование двух разных условных операторов, хотя оба условия проверяют одно и то же. Условия являются истинными, если переменные не равны максимальному допустимому значению типа size_t (SIZE_MAX). Записаны эти проверки по-разному. Такой код является очень подозрительным, возможно, здесь имеет место логическая ошибка.

V668 There is no sense in testing the 'result' pointer against null, as the memory was allocated using the 'new' operator. The exception will be generated in the case of memory allocation error. appleseed string.cpp 58

char* duplicate_string(const char* s)
{
    assert(s);

    char* result = new char[strlen(s) + 1];

    if (result)
        strcpy(result, s);

    return result;
}

Анализатор обнаружил ситуацию, когда значение указателя возвращаемого оператором 'new' сравнивается с нулём. Следует обратить внимание, что если оператор 'new' не смог выделить память, то согласно стандарту языка Си++, генерируется исключение std::bad_alloc().

Таким образом, в проекте Appleseed, который компилируется в Visual Studio 2013, скорее всего проверка указателя на ноль является бессмысленной. И когда-нибудь использование этой функции может привести к неожиданному результату. Предполагается, что функция duplicate_string() вернёт nullptr, если не сможет создать дубликат строки. Вместо этого она сгенерирует исключение, к которому могут быть не готовы другие части программы.

V719 The switch statement does not cover all values of the 'InputFormat' enum: InputFormatEntity. appleseed inputarray.cpp 92

enum InputFormat
{
    InputFormatScalar,
    InputFormatSpectralReflectance,
    InputFormatSpectralIlluminance,
    InputFormatSpectralReflectanceWithAlpha,
    InputFormatSpectralIlluminanceWithAlpha,
    InputFormatEntity
};

size_t add_size(size_t size) const
{
    switch (m_format)
    {
      case InputFormatScalar:
        ....
      case InputFormatSpectralReflectance:
      case InputFormatSpectralIlluminance:
        ....
      case InputFormatSpectralReflectanceWithAlpha:
      case InputFormatSpectralIlluminanceWithAlpha:
        ....
    }

    return size;
}

А где же случай для InputFormatEntity? Данный блок switch() не содержит ни секцию по умолчанию, ни действия для переменной со значением 'InputFormatEntity'. Ошибка ли это или автор посчитал нужным пропустить это значение?

Таких мест найдено ещё два:

V719 The switch statement does not cover all values of the 'InputFormat' enum: InputFormatEntity. appleseed inputarray.cpp 121
V719 The switch statement does not cover all values of the 'InputFormat' enum: InputFormatEntity. appleseed inputarray.cpp 182

При отсутствии секции 'default' и обработки всех значений переменной, можно в каком-нибудь месте потенциально пропустить добавление кода для нового значения 'InputFormat' и долго не знать об этом.

V205 Explicit conversion of pointer type to 32-bit integer type: (unsigned long int) strvalue appleseed snprintf.cpp 885

#define UINTPTR_T unsigned long int

int
portable_vsnprintf(char *str, size_t size, const char *format,
                                                    va_list args)
{
  const char *strvalue;
  ....
  fmtint(str, &len, size,
              (UINTPTR_T)strvalue, 16, width,               // <=
              precision, flags);
  ....
}

Напоследок в Appleseed была найдена серьёзная ошибка, проявляющая себя в 64-х битной версии программы. Проект является кроссплатформенным и компилируется под Windows и Linux. Для получения проектных файлов используется Cmake. В документации по сборке в Windows предлагается использовать "Visual Studio 12 Win64", поэтому кроме диагностик общего назначения (GA, General Analysis), я посмотрел и диагностики 64-битных ошибок (64, Viva64) анализатора PVS-Studio.

Полный код определения макроса 'UINTPTR_T' выглядит следующим образом:

/* Support for uintptr_t. */
#ifndef UINTPTR_T
#if HAVE_UINTPTR_T || defined(uintptr_t)
#define UINTPTR_T uintptr_t
#else
#define UINTPTR_T unsigned long int
#endif /* HAVE_UINTPTR_T || defined(uintptr_t) */
#endif /* !defined(UINTPTR_T) */

Тип uintptr_t является беззнаковым целочисленным memsize-типом и способен безопасно хранить в себе указатель в независимости от разрядности платформы, но для сборки в Windows был определён тип "unsigned long int". Размер типа зависит от модели данных, и в отличие от Linux, в Windows тип 'long' всегда является 32-битным, поэтому в платформе Win64 указатель не будет помещаться в переменную этого типа.

Заключение

Для своего объёма, проект, проверенный с помощью PVS-Studio, содержит мало серьёзных предупреждений анализатора, за это он получает медальку "Clear Code" и может больше не бояться единорога)