Static code analysis of the projects built on Unreal Engine
Download as PPTX, PDF0 likes129 views
Документ описывает статический анализ кода проектов, построенных на Unreal Engine, с акцентом на обнаружение ошибок и улучшение качества кода. Основные положения включают преимущества статического анализа, такие как раннее выявление ошибок, и недостатки, включая ложные срабатывания. Также обсуждаются способы интеграции статического анализа в процесс разработки с использованием инструментов и методов для улучшения кода.
![Недостатки статического анализа
void OutstandingIssue(const char *strCount)
{
unsigned nCount;
sscanf_s(strCount, "%u", &nCount);
int array[10];
memset(array, 0, nCount * sizeof(int));
}
15](https://image.slidesharecdn.com/staticcodeanalysisoftheprojectsbuiltonunrealengineilyagainulin-191216115713/85/Static-code-analysis-of-the-projects-built-on-Unreal-Engine-15-320.jpg)
![bool VertInfluencedByActiveBone(
FParticleEmitterInstance* Owner, USkeletalMeshComponent* InSkelMeshComponent,
int32 InVertexIndex, int32* OutBoneIndex = NULL);
void UParticleModuleLocationSkelVertSurface::Spawn(....)
{
int32 BoneIndex1, BoneIndex2, BoneIndex3;
BoneIndex1 = BoneIndex2 = BoneIndex3 = INDEX_NONE;
if(!VertInfluencedByActiveBone(
Owner, SourceComponent, VertIndex[0], &BoneIndex1) &&
!VertInfluencedByActiveBone(
Owner, SourceComponent, VertIndex[1], &BoneIndex2) &&
!VertInfluencedByActiveBone(
Owner, SourceComponent, VertIndex[2]) &BoneIndex3)
{
....
}
45](https://image.slidesharecdn.com/staticcodeanalysisoftheprojectsbuiltonunrealengineilyagainulin-191216115713/85/Static-code-analysis-of-the-projects-built-on-Unreal-Engine-45-320.jpg)
![bool VertInfluencedByActiveBone(
FParticleEmitterInstance* Owner, USkeletalMeshComponent* InSkelMeshComponent,
int32 InVertexIndex, int32* OutBoneIndex = NULL);
void UParticleModuleLocationSkelVertSurface::Spawn(....)
{
int32 BoneIndex1, BoneIndex2, BoneIndex3;
BoneIndex1 = BoneIndex2 = BoneIndex3 = INDEX_NONE;
if(!VertInfluencedByActiveBone(
Owner, SourceComponent, VertIndex[0], &BoneIndex1) &&
!VertInfluencedByActiveBone(
Owner, SourceComponent, VertIndex[1], &BoneIndex2) &&
!VertInfluencedByActiveBone(
Owner, SourceComponent, VertIndex[2]) &BoneIndex3)
{
....
}
46](https://image.slidesharecdn.com/staticcodeanalysisoftheprojectsbuiltonunrealengineilyagainulin-191216115713/85/Static-code-analysis-of-the-projects-built-on-Unreal-Engine-46-320.jpg)
Static code analysis of the projects built on Unreal Engine
- 1. Статический анализ кода проектов, построенных на движке Unreal Engine Илья Гайнулин PVS-Studio gainulin@viva64.com
- 2. Ищу ошибки в твоём коде 2
- 3. Результат неправильного приведения типов в проекте ShareX 3
- 4. Результат неправильного приведения типов в проекте ShareX Как было: float pixelWeight = color.Alpha / 255; Как поправили: float pixelWeight = (float)color.Alpha / 255; 4 тип Byte
- 5. Сотрудничество с Epic Games 5
- 6. Что такое статический анализ? Это анализ программного обеспечения, производимый без реального выполнения исследуемых программ. 6
- 7. Для чего нужен статический анализ? • Обнаружение ошибок в коде на ранних этапах разработки программного обеспечения • Получение рекомендаций по оформлению кода, проверка правописания • Подсчёт различных метрик программного обеспечения 7
- 8. Стоимость исправления дефекта Исправь раньше, сократи затраты! 8
- 9. Для чего нужен статический анализ? • Обнаружение ошибок в коде на ранних этапах разработки программного обеспечения • Получение рекомендаций по оформлению кода, проверка правописания • Подсчёт различных метрик программного обеспечения 9
- 10. Преимущества статического анализа? • Раннее обнаружение потенциальных проблем в коде • Полное покрытие кода • Простота использования 10
- 13. Преимущества статического анализа? 13 Mono V3012 The '?:' operator, regardless of its conditional expression, always returns one and the same value: Color.FromArgb (150, 179, 225). ProfessionalColorTable.cs 258
- 14. Недостатки статического анализа • Неизбежное появление ложно-позитивных срабатываний • Статический анализ, как правило, слаб в диагностике утечек памяти и параллельных ошибок 14
- 15. Недостатки статического анализа void OutstandingIssue(const char *strCount) { unsigned nCount; sscanf_s(strCount, "%u", &nCount); int array[10]; memset(array, 0, nCount * sizeof(int)); } 15
- 16. Статические анализаторы — это не изолированные инструменты и редкие проверки, а часть DevOps 16 Написание кода Компиляция Unit тесты Интеграционные тесты Развёртывание Планирование Commit кода
- 17. Статические анализаторы — это не изолированные инструменты и редкие проверки, а часть DevOps 17 Написание кода Компиляция Полный статический анализ на билд сервере Unit тесты Интеграционные тесты Развёртывание Планирование Commit кода
- 18. Статические анализаторы — это не изолированные инструменты и редкие проверки, а часть DevOps 18
- 19. Статические анализаторы — это не изолированные инструменты и редкие проверки, а часть DevOps Написание кода Компиляция Полный статический анализ на билд сервере Unit тесты Интеграционные тесты Развёртывание Планирование Инкрементальный статический анализ на машине разработчика Commit кода 19
- 20. Инкрементальный анализ • Сокращение времени анализа, так как анализируется только исправленный или новый код • Хорошо подходит для раннего обнаружения ошибок 20
- 21. Способы проведения статического анализа UE проекта • Отслеживания запусков компилятора • Прямая интеграция с системой сборки 21
- 22. 22 Invoking CL.exe compiler MSBuild Unreal Build Tool Building Unreal Engine projects Build finished Gathering information Самый простой способ проверить UE проект – это отловить все вызовы компилятора
- 23. Отслеживание запусков компилятора из GUI приложения 23
- 24. Отслеживание запусков компилятора из GUI приложения 24
- 25. Отслеживание запусков компилятора из GUI приложения 25
- 26. Прямая интеграция в сборочную систему и VS • Возможность проводить анализ напрямую из IDE Visual Studio • Автоматический запуск анализа при осуществлении сборки UE проекта • Возможность осуществлять инкрементальный анализ 26
- 27. Обычный сценарий сборки C++ проекта в VS 27
- 28. Обычный сценарий сборки C++ проекта в VS 28
- 29. Особенность сборки UE проекта • Использование не стандартной сборочной системы для Visual Studio - MSBuild, а собственной – UnrealBuildTool (UBT) • Использование проектных файлов с расширением .uproject 29
- 30. Особенность сборки UE проекта 30
- 31. В чём проблема? • В проектном файле могут отсутствовать пути до исходных файлов, которые необходимо проверять • Присутствуют не все параметры компиляции, необходимые для правильного препроцессирования 31
- 32. Какое решение? • Встроить в UBT запуск статического анализатора, то есть написать свой toolchain для сборочной системы • Передавать какой-нибудь параметр сборочной системе UBT при запуске, указывающий о необходимости проведения анализа 32
- 34. Несколько ограничений существующего toolchain’а • Только сборка или только анализ проекта • Нет анализа .cpp файла, если был изменён подключённый .h файл 34
- 35. Анализ проекта после его сборки • Модификация скриптов Build.bat и Rebuild.bat 35
- 36. Анализ проекта после его сборки 36
- 37. Анализ проекта после его сборки 37
- 38. Анализ .cpp файла при модификации подключённого .h • Удаление и восстановление кэш файла, используемого UBT 38
- 39. Анализ .cpp файла при модификации подключённого .h 39
- 40. Примеры ошибок в коде движка Unreal Engine static bool PositionIsInside(....) { return Position.X >= Control.Center.X - BoxSize.X * 0.5f && Position.X <= Control.Center.X + BoxSize.X * 0.5f && Position.Y >= Control.Center.Y - BoxSize.Y * 0.5f && Position.Y >= Control.Center.Y - BoxSize.Y * 0.5f; } 40
- 41. Примеры ошибок в коде движка Unreal Engine static bool PositionIsInside(....) { return Position.X >= Control.Center.X - BoxSize.X * 0.5f && Position.X <= Control.Center.X + BoxSize.X * 0.5f && Position.Y >= Control.Center.Y - BoxSize.Y * 0.5f && Position.Y >= Control.Center.Y - BoxSize.Y * 0.5f; } Предупреждение PVS-Studio: V501 There are identical sub-expressions 'Position.Y >= Control.Center.Y — BoxSize.Y * 0.5f' to the left and to the right of the '&&' operator. svirtualjoystick.cpp 97 41
- 42. Примеры ошибок в коде движка Unreal Engine static bool PositionIsInside(....) { return Position.X >= Control.Center.X - BoxSize.X * 0.5f && Position.X <= Control.Center.X + BoxSize.X * 0.5f && Position.Y >= Control.Center.Y - BoxSize.Y * 0.5f && Position.Y >= Control.Center.Y - BoxSize.Y * 0.5f; Position.Y <= Control.Center.Y + BoxSize.Y * 0.5f; } Предупреждение PVS-Studio: V501 There are identical sub-expressions 'Position.Y >= Control.Center.Y — BoxSize.Y * 0.5f' to the left and to the right of the '&&' operator. svirtualjoystick.cpp 97 42
- 43. enum ECubeFace; ECubeFace CubeFace; friend FArchive& operator<<(FArchive& Ar, FResolveParams& ResolveParams) { .... if(Ar.IsLoading()) { ResolveParams.CubeFace = (ECubeFace)ResolveParams.CubeFace; } .... } 43
- 44. enum ECubeFace; ECubeFace CubeFace; friend FArchive& operator<<(FArchive& Ar, FResolveParams& ResolveParams) { .... if(Ar.IsLoading()) { ResolveParams.CubeFace = (ECubeFace)ResolveParams.CubeFace; } .... } Предупреждение PVS-Studio: V570 The 'ResolveParams.CubeFace' variable is assigned to itself. rhi.h 1279 44
- 45. bool VertInfluencedByActiveBone( FParticleEmitterInstance* Owner, USkeletalMeshComponent* InSkelMeshComponent, int32 InVertexIndex, int32* OutBoneIndex = NULL); void UParticleModuleLocationSkelVertSurface::Spawn(....) { int32 BoneIndex1, BoneIndex2, BoneIndex3; BoneIndex1 = BoneIndex2 = BoneIndex3 = INDEX_NONE; if(!VertInfluencedByActiveBone( Owner, SourceComponent, VertIndex[0], &BoneIndex1) && !VertInfluencedByActiveBone( Owner, SourceComponent, VertIndex[1], &BoneIndex2) && !VertInfluencedByActiveBone( Owner, SourceComponent, VertIndex[2]) &BoneIndex3) { .... } 45
- 46. bool VertInfluencedByActiveBone( FParticleEmitterInstance* Owner, USkeletalMeshComponent* InSkelMeshComponent, int32 InVertexIndex, int32* OutBoneIndex = NULL); void UParticleModuleLocationSkelVertSurface::Spawn(....) { int32 BoneIndex1, BoneIndex2, BoneIndex3; BoneIndex1 = BoneIndex2 = BoneIndex3 = INDEX_NONE; if(!VertInfluencedByActiveBone( Owner, SourceComponent, VertIndex[0], &BoneIndex1) && !VertInfluencedByActiveBone( Owner, SourceComponent, VertIndex[1], &BoneIndex2) && !VertInfluencedByActiveBone( Owner, SourceComponent, VertIndex[2]) &BoneIndex3) { .... } 46
- 47. Сообщение анализатора к хитрой ошибке Предупреждение PVS-Studio: V564 The '&' operator is applied to bool type value. You've probably forgotten to include parentheses or intended to use the '&&' operator. particlemodules_location.cpp 2120 47
- 48. void GetRenderData(....) { .... FT_Bitmap* Bitmap = nullptr; if( Slot->bitmap.pixel_mode == FT_PIXEL_MODE_MONO ) { FT_Bitmap NewBitmap; .... Bitmap = &NewBitmap; } .... OutRenderData.RawPixels.AddUninitialized( Bitmap->rows * Bitmap->width ); .... } 48
- 49. void GetRenderData(....) { .... FT_Bitmap* Bitmap = nullptr; if( Slot->bitmap.pixel_mode == FT_PIXEL_MODE_MONO ) { FT_Bitmap NewBitmap; .... Bitmap = &NewBitmap; } .... OutRenderData.RawPixels.AddUninitialized( Bitmap->rows * Bitmap->width ); .... } 49 PVS-Studio: V506 Pointer to local variable 'NewBitmap' is stored outside the scope of this variable. Such a pointer will become invalid. fontcache.cpp 466
- 50. void UGameplayStatics::DeactivateReverbEffect(....) { if (Gengine || !GEngine->UseSound()) { return; } UWorld* ThisWorld = GEngine->GetWorldFromContextObject(....); .... } 50
- 51. void UGameplayStatics::DeactivateReverbEffect(....) { if (Gengine || !GEngine->UseSound()) { return; } UWorld* ThisWorld = GEngine->GetWorldFromContextObject(....); .... } PVS-Studio: V522 Dereferencing of the null pointer 'GEngine' might take place. Check the logical condition. gameplaystatics.cpp 988 51
- 52. void UGameplayStatics::DeactivateReverbEffect(....) { if (Gengine || !GEngine->UseSound()) if (Gengine == nullptr || !GEngine->UseSound()) { return; } UWorld* ThisWorld = GEngine->GetWorldFromContextObject(....); .... } PVS-Studio: V522 Dereferencing of the null pointer 'GEngine' might take place. Check the logical condition. gameplaystatics.cpp 988 52
- 53. template< typename DefinitionType > FORCENOINLINE void Set(....) { .... if ( DefinitionPtr == NULL ) { WidgetStyleValues.Add( PropertyName, MakeShareable( new DefinitionType( InStyleDefintion ) ) ); } else { WidgetStyleValues.Add( PropertyName, MakeShareable( new DefinitionType( InStyleDefintion ) ) ); } } 53
- 54. template< typename DefinitionType > FORCENOINLINE void Set(....) { .... if ( DefinitionPtr == NULL ) { WidgetStyleValues.Add( PropertyName, MakeShareable( new DefinitionType( InStyleDefintion ) ) ); } else { WidgetStyleValues.Add( PropertyName, MakeShareable( new DefinitionType( InStyleDefintion ) ) ); } } 54 PVS-Studio: V523 The 'then' statement is equivalent to the 'else' statement. paths.cpp 703
- 55. Заключение • Статический анализ UE проектов это не так сложно • Статический анализ должен сочетаться с другими методами тестирования 55