Представим ситуацию: у вас имеется большой и взрослый проект с legacy-кодом. Вы установили статический анализатор, проверили код вашего проекта и получили отчёт о найденных ошибках. Сколько там их будет? По нашей статистике – несколько тысяч. В видео расскажем, как исправить ситуацию, затратив на это минимум ресурсов.

1. Как исправить сотни ошибок в
legacy-коде и не умереть
(на примере Unreal Engine 4)
Георгий Грибков

2. Докладчик
Георгий Грибков
Программист C++, разработчик
статического анализатора кода PVS-Studio
Помогаю нашим клиентам бороться с
ошибками
Автор статей о поиске ошибок
в проектах с открытым
исходным кодом
gribkov@viva64.com
2

3.  Как бороться с ошибками legacy-коде?
Проблематика
3

4.  Как бороться с ошибками legacy-коде?
 Стоит ли вообще это делать?
Проблематика
4

5.  Как бороться с ошибками legacy-коде?
 Стоит ли вообще это делать?
 Что делать, если ошибок сотни или даже тысячи?
Проблематика
5

6.  Как бороться с ошибками legacy-коде?
 Стоит ли вообще это делать?
 Что делать, если ошибок сотни или даже тысячи?
(обычно так и бывает)
Проблематика
6

7.  Как бороться с ошибками legacy-коде?
 Стоит ли вообще это делать?
 Что делать, если ошибок сотни или даже тысячи?
(обычно так и бывает)
 Как не затратить на это много-много человеко-часов?
Проблематика
7

8.  Как бороться с ошибками legacy-коде?
 Стоит ли вообще это делать?
 Что делать, если ошибок сотни или даже тысячи?
(обычно так и бывает)
 Как не затратить на это много-много человеко-часов?
 И всё-таки, как вы работали с Unreal Engine?
Проблематика
8

9. Борьба с ошибками в legacy
9

10. Стоит ли бороться с ошибками в legacy-коде?
10

11. 11
ДА!

12.  Старые ошибки – всё еще ошибки
 Старые уязвимости – всё еще уязвимости
 Висящее ружье рано или поздно
выстреливает
Почему?
12

13. 13
Ariane 4

14. 14
14
Ariane 4 113 успешных запусков

15. 15
15
Ariane 5

16. 16
16
Ariane 5
370 000 000 $ на воздух!

17.  Модульное тестирование
 Интеграционное тестирование
 Системное тестирование
 …
Способы поиска ошибок
17

18.  Модульное тестирование
 Интеграционное тестирование
 Системное тестирование
 …
 Динамический анализ
 Статический анализ
Способы поиска ошибок
18

19.  Модульное тестирование
 Интеграционное тестирование
 Системное тестирование
 …
 Динамический анализ
 Статический анализ
Способы поиска ошибок
19

20. Статический анализ – это code review в
автоматическом режиме
Статический анализ: что это?
20

21. Как он может помочь команде?
21

22. Как он может помочь команде?
22
Статанализ

23. 23
Погодите-ка…

24. О, ужас!
24
Legacy-то уже здесь!!!

25. 1. Настроить непрерывный анализ
2.
3.
Как легко справиться со старыми ошибками
25

26. 1. Настроить непрерывный анализ
2. Защититься от появления новых ошибок
3.
Как легко справиться со старыми ошибками
26

27. 1. Настроить непрерывный анализ
2. Защититься от появления новых ошибок
3. Обработать отчёт анализатора постепенно и
малыми затратами
Как легко справиться со старыми ошибками
27

28. Как 2 наших программиста
исправили 2000 срабатываний в Unreal Engine 4
за 17 рабочих дней
28

29. 29
С чего всё началось

30. С чего всё началось
30

31.  Мой босс нашел ошибки в
UE 4 и написал статью
 Разработчикам из Epic
Games понравилось
 Они захотели исправить
больше ошибок и передали
это дело нам
С чего всё началось
31

32. 32
Первая проверка
(или как мы огребли)

33.  Самый удобный способ: проверить проект
через Visual Studio
 Хорошо, что UE имеет набор скриптов для
генерации .vcxproj-файлов
Первая проверка
33

34. 1.Генерируем проектные
файлы
2.Собираем проект
3.Запускаем анализ из Visual
Studio
4.???????
5.
Первая попытка анализа
34

35. 1.Генерируем проектные
файлы
2.Собираем проект
3.Запускаем анализ из Visual
Studio
4.???????
5.EPIC GAMES FAIL
Первая попытка анализа
35

36.  Сгенерированные проектные файлы – лишь
обёртка
 Эти обёртки вызывают Unreal Build Tool
 Unreal Build Tool вызывает cl.exe (или clang
при сборке под Linux)
Как устроена сборка Unreal Engine
36

37.  Сгенерированные проектные файлы – лишь
обёртка
 Эти обёртки вызывают Unreal Build Tool
 Unreal Build Tool вызывает cl.exe (или clang
при сборке под Linux)
 Из-за этих прослоек анализатор не может
собрать параметры компиляции
Как устроена сборка Unreal Engine
37

38. 38
Вторая проверка
(или как мы всё сделали правильно)

39.  Что, если отлавливать непосредственно
вызовы компилятора?
Вторая проверка
39

40.  Что, если отлавливать непосредственно
вызовы компилятора?
 Хорошо, что у нас есть специальная утилита
для мониторинга компиляции
Вторая проверка
40

41. Вторая попытка анализа
41
1. Перед сборкой запускаем утилиту
мониторинга компиляции
2. Утилита собирает все
необходимые данные
3. Сразу после окончания сборки
запускается анализ
4. ???????
5.

42. 1. Перед сборкой запускаем утилиту
мониторинга компиляции
2. Утилита собирает все
необходимые данные
3. Сразу после окончания сборки
запускается анализ
4. ???????
5. EPIC WIN!!!
Вторая попытка анализа
42

43. 43
Результаты анализа

44. Результаты анализа
44
 1192 предупреждения наивысшего уровня
(Level 1)
 629 предупреждений второго уровня
(Level 2)
 Суммарно 1821 предупреждения
(без Level 3)

45. 45
45

46. Почему тысячи срабатываний – это классика?
46
 Notepad++ – 5 241 срабатывание

47. Почему тысячи срабатываний – это классика?
47
 WinMerge – 8 786 срабатываний

48. Почему тысячи срабатываний – это классика?
48
 Media Player Classic Home Cinema – 33 370 срабатываний

49. 49
Что делать дальше?

50. Как справиться со старыми ошибками
50

51. 1. Настроить непрерывный анализ
51

52. 1. Настроить непрерывный анализ
52

53. 1. Настроить непрерывный анализ
53

54. 1. Настроить непрерывный анализ
54

55. 1. Настроить непрерывный анализ
55

56. 1. Настроить непрерывный анализ
56

57. 1. Настроить непрерывный анализ
57

58. 1. Настроить непрерывный анализ
58

59. Как справиться со старыми ошибками
59

60. 2. Защититься от появления новых ошибок
60
Статанализ

61. 2. Защититься от появления новых ошибок
61
 Как разглядеть новые срабатывания среди
старых?
 Способ 1: инкрементальный анализ
 Способ 2: массовое подавление
предупреждений (suppress-базы)

62. Как работать с suppress-базой
62
 Прячем все старые срабатывания
 При следующем прогоне получаем 0
предупреждений
 С этого момента свежие ошибки будут
обнаруживаться сразу

63. Как работать с suppress-базой
63

64. Как работать с suppress-базой
64

65. Как работать с suppress-базой
65
Старые предупреждения никуда не деваются!
Мы лишь работаем с ними отдельно от
новых

66. Инкрементальный анализ или suppress-базы?
66
 Работая с Unreal Engine 4, мы использовали
только инкрементальный анализ
 Suppress-базы удобнее, если проект
развивается непосредственно вами
 Можно использовать оба способа
одновременно

67. Как справиться со старыми ошибками
67

68. 3. Как работать с огромным отчётом
68
Два принципа:
 Принцип Парето (80/20)
 Метод храповика

69. Принцип Парето
69

70. Принцип Парето
70
 Чтобы исправить 80% ошибок, достаточно
рассмотреть 20% предупреждений
 Эти доли уже заранее разделены и готовы к
использованию

71. Принцип Парето
71
 Media Player Classic Home Cinema – 33 370 срабатываний

72. Принцип Парето
72
 33 370 срабатываний –> 1 935 срабатываний

73. 20% предупреждений в Unreal Engine
73
 1192 предупреждения наивысшего уровня
(Level 1)
 629 предупреждений второго уровня
(Level 2)
 Суммарно 1821 предупреждение
(без Level 3)

74. Метод храповика
74

75.  Суммарное количество предупреждений
закладывается в систему контроля версий
 Допускаются только те изменения, которые не
увеличивают это количество
Метод храповика
75

76. Как работает метод храповика
76

77. Как работает метод храповика
77

78.  Иван Пономарёв — Непрерывный статический
анализ кода
Полезный доклад по теме
78

79. 79
Графики количества
предупреждений

80.  Ожидание
График количества предупреждений
0
5
10
15
20
25
1 2 3 4 5
Warnings
80

81.  Ожидание
График количества предупреждений
81
0
5
10
15
20
25
1 2 3 4 5
Warnings
0
5
10
15
20
25
1 2 3 4 5
Warnings
 Реальность

82. Прогресс для Unreal Engine 4
82

83. Небольшой десерт
83
 После исправления всех ошибок мы
обнаружили еще две:

84. Пример графика для метода храповика
84

85.  Разработчики из Epic Games остались довольны
 Теперь они регулярно пользуются статическим
анализом
 Ну а мы… а мы написали про это еще одну статью :)
Итого
85

86. Подведение итогов
86

87. 87
Хотите почистить legacy-код?
Используйте статический анализ!

88. Если предупреждений тысячи:
88
1. Настройте непрерывный анализ
2. Защититесь от новых ошибок
3. Обработайте отчёт анализатора постепенно
(принцип Парето и метод храповика)

89. Попробуйте статический анализ!

90. Попробуйте статический анализ!
e-mail:
gribkov@viva64.com

91. Попробуйте статический анализ!
e-mail:
gribkov@viva64.com
Вопросы и ответы