⌛️ 🐲 🧗🏾 ビデオゲーム業界の静的分析：ソフトウェアエラーのトップ10 🕡 💪🏼 😌

ビデオゲーム業界でソフトウェアを開発していて、製品の品質を改善するために他に何ができるのか、開発プロセスを簡素化するために、静的分析を使用しないのではないかと考えている場合は、始めましょう。疑う？さて、私はあなたにこれを納得させようとします。ビデオゲーム業界のデベロッパーが犯している間違いに注目したい場合は、再び、あなたはそのアドレスに来ました-最も興味深いものがあなたのために特別に選ばれました。

静的解析を使用する理由

ビデオゲームの開発には多数の段階が含まれるという事実にもかかわらず、プログラミングは依然として主要な段階の1つです。たとえ何千行ものコードを書かなくても、さまざまなツールを使用する必要があります。その品質は使いやすさと最終結果に依存します。あなたがそのようなツール（たとえば、ゲームエンジン）の開発者であれば、すべてがすでに明確になっているはずです。

静的解析がソフトウェア開発全般に役立つのはなぜですか？

主な理由はいくつかあります。

修正エラーのコストと複雑さは、時間とともに増加します。静的分析の主な利点の1つは、開発の初期段階でのエラー検出です（コードの作成時にエラーを見つけることができます）。したがって、静的アナライザーを使用すると、頭痛になる前に多くのエラーを検出して修正することにより、自分と同僚の生活を簡素化できます。
静的分析を使用すると、さまざまなエラーパターン（コピーペースト、タイプミス、機能の誤用など）を特定できます。
原則として、静的分析は、動的分析では検出されにくい問題を特定するのに適しています。ただし、逆もまた真です。
さまざまな警告抑制機能（単一、パターン別など）、無関係な診断の無効化、分析からのファイルとディレクトリの無効化により、負の使用ポイント（たとえば、誤検出）は通常、深刻な静的アナライザーの開発チームによって「スムーズ化」されます。これにより、アナライザーを適切に構成することで、「ノイズ」の割合を大幅に減らすことができます。同僚のAndrei Karpovは、 EFLコアライブラリのチェックに関する記事で、アナライザーが構成されている場合、誤検知の数は10〜15％に過ぎないことを実証しました。

とにかく、これはすべて理論であり、おそらくより実用的な例に興味があるでしょう。さて、それらを以下に示します。

Unreal Engineの静的解析

ここまで読んだことがあるなら、アンリアルエンジンとは何か、エピックゲームズとはどんな会社なのかを伝えてはいけません。もしこれらの人たちがあなたの権限を楽しんでいないなら、それを使っている私に手紙を書いてください。

PVS-Studioチームは、Epic Gamesチームと数回協力し、Unreal Engineプロジェクトで静的解析を実装および使用し、アナライザーによって検出されたエラー/誤検知を修正するのを支援しました。双方にとって興味深い、そして有益な経験だったと確信しています。

結果の1つは、Unreal Engineに特別なフラグが追加されたことで、静的解析をUnreal Engineプロジェクトアセンブリシステムに簡単に統合できるようになりました。

鍵となるアイデアはシンプルです-人々はコードの品質を気にし、これに異なるアプローチを使用します。その1つは静的分析の導入でした。

静的解析に関するジョン・カーマック

ビデオゲーム業界で最も有名な開発者の1人であるジョンカーマックは、プログラマーとしての主な業績の1つとして、静的解析手法の積極的な使用をかつて認識していました。分析。 「あなたが知っている誰かが静的分析は初心者のためのツールであると次回言ったとき、彼にこの引用を見せてください。カーマックは、対応する記事で静的分析の知識を説明しました。これを読むことを強くお勧めします：動機と一般的な開発の両方について。

ゲームおよびゲームエンジンで静的分析を使用して検出されたエラー

おそらく、静的分析の利点を示す最良の方法の1つは、その機能を実際に示すことです。たとえば、PVS-Studioチームはこれを行い、オープンソースプロジェクトをチェックします。

誰にとってもメリット：

プロジェクト開発者にはエラーが通知され、修正できます。理想的には、もちろん、アプローチはログ/記事によるエラーの修正とは異なるべきです。プロジェクトを自分でチェックし、発行された警告を調べる価値があります。これは、記事の著者がプロジェクトにとって重要ではないエラーを見失ったり、意図せずにそれらに焦点を合わせたりする可能性がある場合にのみ重要です。
アナライザの開発者は、分析の結果に基づいてツールを改善し、エラーを検出するアナライザの機能を実証することもできます。
読者は、どのエラーパターンが許可されているかを確認し、経験を積んで、静的分析の方法を理解します。

一般的に-有効性と利益の証拠ではないものは何ですか？

静的解析をすでに使用しているコマンド

誰かが開発プロセスに静的分析を導入するかどうかを考えている間、一部のチームはすでにそれを使用しており、利益を得ています！たとえば、Rocksteady、Epic Games、ZeniMax Media、Oculus、Codemasters、Wargamingなど（ソース）。

ビデオゲーム業界のトップ10コードのバグ

これはある種のメガグローバルな「トップ」ではなく、ゲームやゲームエンジンでPVS-Studioアナライザーによって検出されたエラーであり、私にとって最も興味深いと思われることをすぐに言及する価値があります。

いつものように、興味を引くために、まず上記のコードフラグメントのエラーを自分で見つけてから、アナライザーの警告と問題の説明を読むことをお勧めします。

10位

出典： X-Ray Engineの異常を探す

第10位は、STALKERゲームで使用されているX-Ray Engineゲームエンジンのエラーですこのシリーズのゲームをプレイした人は、ゲームプロセス中に発生した多くの面白い（そうではない）バグを覚えているでしょう。これは特にSTALKER：Clear Skyに当てはまります。ClearSkyは、パッチなしではプレイできませんでした（私はすべてのセーブを「殺した」バグを今でも覚えています）。ゲームエンジンの分析が示したように、コードには本当にバグがあり、多くのバグがあります。以下はその1つです。

BOOL CActor::net_Spawn(CSE_Abstract* DC) { .... m_States.empty(); .... }

PVS-Studio警告 ： V530関数 'empty'の戻り値を使用する必要があります。

問題は簡単です-返されたbooleanメソッドemptyを使用せず、コンテナが空かどうかを示します。上記の式にはメソッド呼び出し以外に何も存在しないという事実から判断すると、開発者はコンテナーをクリアしたかったのに、clearではなく空のメソッドを呼び出して間違えたと想定できます。

これは、トップ10にとっては単純すぎる間違いだと誰かが言うかもしれません。しかし、これは彼女の魅力です！そのため、側面から見ると、エラーは非常に単純で明白であるように見えますが、このような「単純な」エラーはさまざまなプロジェクトで発生する（および検出される）ことはありません。

9位

出典：待望のCryEngine Vテスト

ゲームエンジンのエラーのトピックを引き続き明らかにします。 9位はCryEngine Vのコードです。このエンジンのゲームでは、X-Rayエンジンのゲームほど多くのバグに気付きませんでしたが、「剖検」により、エンジンに多くの不審なコードフラグメントが含まれていることがわかりました。

 void CCryDXGLDeviceContext:: OMGetBlendState(...., FLOAT BlendFactor[4], ....) { CCryDXGLBlendState::ToInterface(ppBlendState, m_spBlendState); if ((*ppBlendState) != NULL) (*ppBlendState)->AddRef(); BlendFactor[0] = m_auBlendFactor[0]; BlendFactor[1] = m_auBlendFactor[1]; BlendFactor[2] = m_auBlendFactor[2]; BlendFactor[2] = m_auBlendFactor[3]; *pSampleMask = m_uSampleMask; }

PVS-Studio警告 ： V519 「BlendFactor [2]」変数には、連続して2回値が割り当てられます。おそらくこれは間違いです。

私たちの記事で繰り返し言及されているように、タイプミスから免れる人はいません。実際には、静的解析がコピー＆ペーストおよびタイプミスを検出する優れた仕事をすることも繰り返し確認されています。 m_auBlendFactor配列からBlendFactorに値をコピーしましたが、誤ってそれらを封印し、 BlendFactorを 2回書き込みました[2] 。この混乱のため、 m_auBlendFactor [3 ]の値はBlendFactor [2]に書き込まれ、値はBlendFactor [3]で変更されません。

8位

ソース：宇宙のユニコーン：「スペースエンジニア」のソースコードの確認

コースを少し変更し、C ++からC＃に移行します。これは、スペースエンジニアプロジェクトのコードです。これは、スペース構造の構築と維持に関するサンドボックスゲームです。私自身はゲームをプレイしませんでしたが、記事の解説者の一人が言ったように、「 私は結果にあまり驚いていません:) 」。さて、私は本当に面白いエラーを見つけることができました。以下はそのうちの2つです。

 public void Init(string cueName) { .... if (m_arcade.Hash == MyStringHash.NullOrEmpty && m_realistic.Hash == MyStringHash.NullOrEmpty) MySandboxGame.Log.WriteLine(string.Format( "Could not find any sound for '{0}'", cueName)); else { if (m_arcade.IsNull) string.Format( "Could not find arcade sound for '{0}'", cueName); if (m_realistic.IsNull) string.Format( "Could not find realistic sound for '{0}'", cueName); } }

PVS-Studioの警告 ：

V3010関数 'Format'の戻り値を使用する必要があります。
V3010関数 'Format'の戻り値を使用する必要があります。

ご覧のとおり、メソッドの戻り値を無視する際のエラーは、C ++コードだけでなく、C＃でも見つかります。 String.Formatメソッドは、フォーマット文字列とフォーマットするオブジェクトに基づいて結果の文字列を構成し、結果をメソッドの戻り値として返します。上記のコードでは、 elseブランチにstring.Formatの 2つの呼び出しがありますが、それらの戻り値は使用されません。ほとんどの場合、 MySandboxGame.Log.WriteLineメソッドを使用するifステートメントのthen-ブランチで行われた方法と同様に、これらのメッセージを誓約する必要がありました。

7位

出典： Quake III Arena GPL Design Review

静的分析はタイプミスをうまく検出することを述べましたか？以下の例は、これの別の確認です。

 void Terrain_AddMovePoint(....) { .... x = ( v[ 0 ] - p->origin[ 0 ] ) / p->scale_x; y = ( v[ 1 ] - p->origin[ 1 ] ) / p->scale_x; .... }

PVS-Studio警告 ： V537 「scale_x」アイテムの使用の正確さを確認することを検討してください。

変数xとyに書き込みますが、両方の割り当てで式p-> scale_xが値を計算する式で使用されます。それは非常に疑わしく見え、2番目のケースでは、式p-> scale_xをp-> scale_yに置き換える必要があるようです。

6位

ソース： Unity C＃ソースコードの確認

Unity Technologiesは最近、独自のゲームエンジンであるUnityのソースコードを公開しました。私たちはそのようなイベントを通り抜けることができず、分析中に多くの興味深い場所を見つけました。以下はその1つです。

 public override bool IsValid() { .... return base.IsValid() && (pageSize >= 1 || pageSize <= 1000) && totalFilters <= 10; }

PVS-Studio警告 ： V3063評価される場合、条件式の一部は常にtrueです：pageSize <= 1000。

pageSizeの無効な範囲チェックがあります。ほとんどの場合、 pageSizeの値が[1;の範囲内にあることを確認する予定でした。 1000]。しかし、残念なタイプミスが行われました。演算子 '&&'の代わりに、プログラマーが誤って '||'を書きました。部分式は実際には何もチェックしません。

5位

ソース： Unity3Dオープンコンポーネントのエラーの分析

隣接する場所には、Unity3Dコンポーネントの興味深いバグがあります。ソース記事は、Unityエンジンのソースコードが開かれる1年以上前に書かれました。それでも、それでも面白いものを見つけることができました。

 public static CrawledMemorySnapshot Unpack(....) { .... var result = new CrawledMemorySnapshot { .... staticFields = packedSnapshot.typeDescriptions .Where(t => t.staticFieldBytes != null & t.staticFieldBytes.Length > 0) .Select(t => UnpackStaticFields(t)) .ToArray() .... }; .... }

PVS-Studio警告 ： V3080 null参照解除の可能性があります。「t.staticFieldBytes」の検査を検討してください。

Whereメソッドに引数として渡されたラムダ式に注目してください。コードから判断すると、 typeDescriptionsコレクションには、 staticFieldBytesメンバーがnullになる可能性のある要素が含まれる場合があります。そのため、 Lengthプロパティにアクセスする前に、 staticFieldBytes！= Nullを確認します。演算子は混乱しているだけで、「&&」の代わりに「＆」が使用されています。これは、左の式の評価結果（ true \ false ）に関係なく、右の式も評価されることを意味します。そのため、 staticFieldBytes == nullの場合、 LengthプロパティにアクセスするときにNullReferenceException型の例外がスローされます。「&&」を使用する場合、 staticFieldBytes == nullの場合、式の右側は評価されないため、このような状況は発生しません。

Unityがトップ10に2度ランクインした唯一のエンジンであるという事実にもかかわらず、これはマニアが素晴らしいゲームを作成するのを止めません。含む-「バグ」との戦いについて。

4位

ソース： Godotエンジンのソースコード分析

欠落しているキーワードに関連する興味深いエラーがある場合があります。例：例外オブジェクトは作成されますが、開発者がthrowキーワードの指定を忘れているため、いかなる方法でも使用されません。このようなエラーは、C＃プロジェクトおよびC ++プロジェクトで発生します。欠落しているキーワードは、Godot Engineゲームエンジンでも見つかりました。

 Variant Variant::get(const Variant& p_index, bool *r_valid) const { .... if (ie.type == InputEvent::ACTION) { if (str =="action") { valid=true; return ie.action.action; } else if (str == "pressed") { valid=true; ie.action.pressed; } } .... }

PVS-Studioの 警告： V607所有者なしの表現「ie.action.pressed」。

上記のコードスニペットでは、 ie.typeとstrの値に応じて、 Variant型の特定の値を返したいことがわかり ます。一度だけ、リターン式は正常に記述されました-return ie.action.action; 、 returnステートメントを忘れた2回目のため、目的の値は返されず、メソッドは引き続き実行されます。

3位

ソース： PVS-Studio：Doom 3コードの分析

それで、「トップ3」に到達しました。クロームを閉じることは、Doom 3ゲームのソースコードの小さな断片です。上で述べたように、エラーは横から見ると単純に見え、そのような間違いをどのように行うかが明確ではないという事実は、何も意味しません-実際には、どのタイプのエラーが発生しないでしょうか...

 void Sys_GetCurrentMemoryStatus( sysMemoryStats_t &stats ) { .... memset( &statex, sizeof( statex ), 0 ); .... }

PVS-Studio警告 ： V575 「memset」関数は「0」要素を処理します。 3番目の引数を調べます。

問題をよりよく理解するには、 memset関数のシグネチャを思い出す価値があります。

 void* memset(void* dest, int ch, size_t count);

関数のシグネチャとその呼び出しを比較すると、最後の2つの引数が混同されていることがわかります。その結果、リセットが必要な一部のメモリブロックは変更されません。

2位

2位は、XenkoゲームエンジンのC＃コードで見つかったエラーです。

出典： Xenkoゲームエンジンのエラーを探しています

 private static ImageDescription CreateDescription(TextureDimension dimension, int width, int height, int depth, ....) { .... } public static Image New3D(int width, int height, int depth, ....) { return new Image(CreateDescription(TextureDimension.Texture3D, width, width, depth, mipMapCount, format, 1), dataPointer, 0, null, false); }

PVS-Studio警告 ： V3065パラメーター 'height'はメソッドの本体内では使用されません。

CreateDescriptionメソッドに引数を渡すことでエラーが発生しました。そのシグネチャを見ると、2番目、3番目、4番目のパラメーターがそれぞれwidth 、 height 、 depthと呼ばれていることがわかります。呼び出されると、引数width 、 width、およびdepthが渡されます。疑わしい？そのため、アナライザーは、この場所が警告を発するほど疑わしいと判断しました。

一位

出典：待望のアンリアルエンジン4検証

Unreal Engineゲームエンジンからの今日の「トップ10」エラーを見出します。「 2017年のC ++プロジェクトのトップ10エラー」の記事の場合のように、以下のエラーを見たとき、最も興味深いエラーのリストを導くのはだれかをすぐに理解しました。

 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) { .... }

PVS-Studio警告 ： V564 「＆」演算子はブール型の値に適用されます。括弧を含めるのを忘れているか、「&&」演算子を使用することを意図している可能性があります。

アナライザーの警告と上記のコードを比較して、「ここで「&&」の代わりに「＆」を使用するのはどこですか？」ただし、 VertInfluencedByActiveBone関数の最後のパラメーターにデフォルト値があり、 ifステートメントの条件式を簡素化することに注意を払うと、すべてがより明確になります。

 if (!foo(....) && !foo(....) && !foo(....) & arg)

最後の部分式に特に注意してください。

 !VertInfluencedByActiveBone(Owner, SourceComponent, VertIndex[2]) &BoneIndex3

デフォルト値を持つパラメーターはトリックを演じました-デフォルト値がない場合、このコードはコンパイルされません。しかし、そうであるため、すべてが正常にコンパイルされ、エラーも同様に正常にマスクされます。これは疑わしい場所であり、アナライザーは気付きました-中置演算 '＆'。左オペランドはbool型で、右オペランドはint32です。

おわりに

静的解析がゲームやゲームエンジンの開発に役立つこと、そしてコード（および結果として最終製品）の品質を改善するという質問に対するもう1つの答えであることを示すことができたと思います。ビデオゲーム業界で開発している場合は、静的分析について同僚に伝え、この記事を表示するだけです。どこから始めるべきか考えていますか？ PVS-Studioから始めます。

この記事を英語圏の聴衆と共有したい場合は、翻訳へのリンクを使用してください：セルゲイヴァシリエフ。ビデオゲーム開発の静的分析：ソフトウェアバグのトップ10

記事を読んで質問がありますか？

多くの場合、記事には同じ質問が寄せられます。ここで回答を収集しました： PVS-Studioバージョン2015に関する記事の読者からの質問への回答。リストをご覧ください。

ビデオゲーム業界の静的分析：ソフトウェアエラーのトップ10