Как известно, C++ принимает, что программист всегда прав, и поэтому компиляторы C++ не вставляют в программу дополнительные проверки на, например, разыменование нулевого указателя или доступ вне границ массива. У этого есть хорошая сторона: программа на C++ выполняется максимально быстро, и плохая сторона: иногда мы проводим долгое время за отладкой, чтобы в конце найти какую-то глупую ошибку. Хотелось бы, чтобы компилятор подобные ошибки находил сам. И многие компиляторы это могут! В этом посте я расскажу о различных параметрах GCC, которые это делают. Эту тему ранее уже освещал zakharvoit в этой статье.

Все параметры, которые здесь будут приведены, надо добавлять к командной строке GCC. В различных IDE это можно сделать в настройках IDE или компилятора. Многие из параметров можно применять и с Clang (например, в Xcode). Для MSVC++, пожалуй, нет ничего лучше, чем Debug-режим и /W4.  

Предупреждения GCC

Конечно, первый шаг при ловле ошибок — это включить разные предупреждения компилятора. Уже одно это часто помогает. Как необходимый минимум можно назвать -Wall -Wextra -O2. Последний параметр нужен потому, что некоторые предупреждения включаются только вместе с оптимизацией. Далее я приведу ещё несколько полезных параметров, которые не включаются сами вместе с -Wall -Wextra.

• -pedantic — предупреждает об используемых нестандартных расширениях языка C++. Таким образом можно отсечь то, что может не поддерживаться на тестирующем сервере, и не тратить потом время на исправление кода. Лучше всего использовать вместе с -std=c++03 или -std=c++11. Например, -pedantic -std=c++03 выдаст предупреждение на

printf("%lf\n", 1.0);

— правильно писать

printf("%f\n", 1.0);

• -Wshadow — предупреждает, если имя объявленной переменной перекрывает такое же имя на более высоком уровне. Например, такой код вызовет предупреждение:

int n;
void solve()
{
    // Solve the problem
}
int main()
{
    int n; cin >> n;
    solve();
}

• -Wformat=2 — предупреждает, если тип аргумента printf()/scanf() не соответствует указанному в строке формата. Частично это уже включено с -Wall, но -Wformat=2 более строг.

• -Wfloat-equal — предупреждает, если два числа с плавающей точкой сравниваются так: a == b. Обычно правильно сравнивать так: fabs(a - b) < eps.

• -Wconversion — предупреждает, если при неявном преобразовании типов могут потеряться данные.¹ Чаще всего это случайное присваивание значения long long int в переменную типа int. У меня это предупреждение включено с тех пор, как я завалил задачу, написав pair<int, int> вместо pair<int, long long> :)
  
  ¹ Явное преобразование (например, (double)my_long_long_var) не вызовет предупреждения.

• -Wlogical-op — предупреждает о подозрительном использовании логических операторов там, где GCC ожидал бы побитовые операторы.

• -Wshift-overflow=2 — предупреждает о переполнении при операциях левого сдвига (GCC 6+).

• -Wduplicated-cond — предупреждает, если условие в if (…) else if (…) повторяется (GCC 6+).

Есть ещё -Wcast-qual и -Wcast-align, но они бывают полезны реже (хоть и не мешают). Подробнее о предупреждениях GCC можно прочитать здесь: https://gcc.gnu.org/onlinedocs/gcc/Warning-Options.html

Инструменты стандартной библиотеки

Кроме самого компилятора, есть ещё стандартная библиотека C/C++. Она тоже позволяет задать параметры, которые помогают при отладке программ.

• -D_GLIBCXX_DEBUG -D_GLIBCXX_DEBUG_PEDANTIC — эти параметры включают специальный отладочный режим стандартной библиотеки GNU C++. В этом режиме стандартные контейнеры и алгоритмы делают всевозможные проверки. Например, такой код:

int main()
{
    vector<int> v(3);
    cout << v[7] << endl;
}

в этом режиме выдаёт

 /usr/include/c++/4.9.2/debug/vector:357:error: attempt to subscript 
  container with out-of-bounds index 7, but container only holds 3 
  elements. 

А такой код:

int main()
{
    int arr[] = { 3, 1, 2 };
    cout << binary_search(arr, arr+3, 2) << endl;
}

выдаёт

 /usr/include/c++/4.9.2/bits/stl_algo.h:2267:error: elements in iterator
  range [__first, __last) are not partitioned by the value __val. 

• -D_FORTIFY_SOURCE=2 (только Linux/glibc) — этот параметр вставляет в программу разные проверки с уклоном в безопасность (переполнения буфера и т.д.). Например, с этим параметром такая программа:

int main()
{
    char s[9];
    strcpy(s, "too large");
    cout << s << endl;
}

выдаёт

 *** buffer overflow detected ***: ./a.out terminated 

Инструменты GCC

Сам компилятор GCC тоже содержит инструменты, которые помогают находить ошибки в программах.

• -fsanitize=address (только в GCC 4.8+ и Clang) — этот параметр встраивает в программу проверки доступов к памяти и ловит многие выходы за границы массивов. Например:

int arr[3];

int main()
{
    for (int i = 0; i <= 3; i++)
    {
        arr[i] = i;
        cout << arr[i] << " ";
    }
    cout << endl;
}

выдаёт

 =================================================================
 ==15496==ERROR: AddressSanitizer: global-buffer-overflow on address 0x00000060152c at pc 0x400ad4 bp 0x7fffbac43e00 sp 0x7fffbac43df0
 WRITE of size 4 at 0x00000060152c thread T0
 . . . 

• -fsanitize=undefined -fno-sanitize-recover (только в GCC 4.9+ и Clang) — похожий параметр, которая ловит неопределённое поведение (undefined behavior), например, доступ по нулевому указателю. Такой код:

int main()
{
    int *p;
    cout << *p << endl;
}

выдаёт

 x.cpp:12:14: runtime error: load of null pointer of type 'int' 

Ещё -fsanitize=undefined может находить деление на ноль, неправильные битовые сдвиги, целочисленные переполнения и выход из функции без возврата значения.

Эти два параметра описаны в https://gcc.gnu.org/onlinedocs/gcc/Debugging-Options.html. Есть ещё параметр -fstack-protector.

Всё вместе

Объединяя всё вместе, получаем

-Wall -Wextra -pedantic -std=c++11 -O2 -Wshadow -Wformat=2 -Wfloat-equal -Wconversion -Wlogical-op -Wshift-overflow=2 -Wduplicated-cond -Wcast-qual -Wcast-align -D_GLIBCXX_DEBUG -D_GLIBCXX_DEBUG_PEDANTIC -D_FORTIFY_SOURCE=2 -fsanitize=address -fsanitize=undefined -fno-sanitize-recover -fstack-protector

Это всё (или по выбору) можно добавить к командной строке GCC на своём компьютере. Получается, что на своём компьютере мы запускаем отладочную версию с разными проверками, а на сервере — обычную. Естественно, что отладочная версия на своём компьютере будет работать медленнее обычной — больше всего влияют параметры -fsanitize (могут замедлить в два раза и более). Но это легко учесть, и это небольшая плата за поиск ошибок. В зависимости от версии компилятора и операционной системы не все эти параметры будут работать — их можно просто убрать из списка.

Надеюсь, этот пост поможет кому-то тратить меньше времени на отладку и больше времени на решение задач. Удачи всем :)

UPD1: С -D_GLIBCXX_DEBUG обнаружена проблема, для которой есть обходной путь.

UPD2: Обновлён список параметров:

• Добавлен -fno-sanitize-recover (GCC 5+)
• Удалён -lmcheck (его заменяет -fsanitize=address)
• Удалён -ftrapv (его заменяет -fsanitize=undefined)
• Удалён -fwhole-program (работает нестабильно и не является отладочным параметром)

UPD3: Добавлены -Wshift-overflow=2 и -Wduplicated-cond (GCC 6+).