静的コード分析がGameDevスペースでどのように役立つか

ゲーム業界は立ち止まっておらず、日々急速に発展しています。業界の成長に伴い、開発の複雑さも増しています。コードとバグが増えています。したがって、最新のゲームプロジェクトでは、コードの品質に特別な注意を払う必要があります。今日は、コードを改善する方法の1つである静的分析と、PVS-Studioが大規模な（だけでなく）ゲームプロジェクトの開発で実際にどのように役立つかについて説明します。



「私が近年プログラマーとして行った最も重要なことは、静的なコード分析を積極的に追求することです。それで防いだ何百もの深刻なバグよりもさらに価値があるのは、ソフトウェアの信頼性とコードの見方に関する考え方の変化です。品質。 " -John Carmack



私たちは長年主要なゲーム開発者と協力してきましたが、この間、ゲーム業界にとって多くの興味深く有用なことを成し遂げてきました。ゲーム業界のクライアントのリストを考えると、これは驚くべきことではありません。クライアントに積極的なサポートを提供します。クライアントがPVS-Studioを独自の開発プロセスに統合し、アナライザーによって検出されたエラーを修正し、注文する特別な機能を作成するのを支援します。



さらに、GameDev方向でアナライザーの多くの独立した開発を行っており、さまざまなビデオゲームで見つかった興味深いバグについて人々に伝えることでPVS-Studioを普及させています。



当然、興味深い話がないわけではありません。この記事では、そのようないくつかの話について説明します。

PVS-StudioとUnity

私たちが製品を宣伝する方法の1つは、オープンソースプロジェクトのレビューに関する記事を書くことです。誰もがこれらの記事から恩恵を受けます。読者はおなじみのプロジェクトの興味深いエラーを見て、自分自身で新しいことを学ぶことができます。PVS-Studioの作業を実際のコードで示す機会があり、プロジェクト開発者はエラーについて学び、事前に修正できます。



Unityとの最初の真剣な知り合いは、このゲームエンジンの開発者がいくつかのコンポーネント、ライブラリ、デモのソースコードを公式リポジトリにリリースした2016年に始まりました。当然、そのような「おいしい」ケースを通過することはできず、レイアウトされたコードのチェックに関する記事を書きたかったのです。



その後、Unity3Dコード（当時はエンジンがそのように呼ばれていました）は非常に高品質であることがわかりましたが、記事を書く際にかなりの重大なエラーを見つけることができました。



2年後、別のイベントが発生しました。今回は、Unity開発者がエンジン自体のコードとエディターをリリースしてアクセスを開きました。そして、前回と同じように、エンジンのソースコードを通り過ぎて確認することができませんでした。そして、正当な理由があります。興味深い間違いもいくつか見つかりました。



しかし、記事を書くことはすべてからほど遠いです。私たちは引き続きPVS-Studioに取り組んでおり、GameDevは私たちにとって開発にとって最も重要な分野の1つです。したがって、Unityゲーム開発者には、プロジェクトの可能な限り最高の分析を取得してもらいたいと考えています。



Unityプロジェクトの分析の品質を向上させるためのステップの1つは、Unity ScriptingAPIで定義されたメソッドの注釈を作成することでした。



メソッドアノテーションは、PVS-Studioで使用される特別なメカニズムです。これにより、特定の方法について必要なすべての情報をアナライザーに提供できます。これは、アナライザーの開発者自身（つまり、私たち）によって特別なコードで記述されています。



この情報は、まったく異なる種類のものである可能性があります。たとえば、メソッドが渡されるパラメータにどのように影響するか、メモリを割り当てることができるかどうか、処理する必要のある値を返すかどうかなどです。したがって、注釈により、アナライザーはメソッドのロジックをよりよく理解できるようになり、それによって、新しくより複雑なエラーを検出できるようになります。



すでに多種多様な注釈を作成しており（たとえば、System名前名のメソッド用）、Unity ScriptingAPIのメソッド注釈でそれらを補足できました。



評価とともに注釈のリストに追加し始めました。方法はいくつありますか？最初に注釈を付ける必要があるのはどれですか？全部でたくさんの方法があり、私たちは最も頻繁に使用される方法に注釈を付けることから始めることにしました。



人気のあるメソッドの検索は次のように実行されました。最初に、Unityの機能を使用するプロジェクトのプールをGitHubから収集し、次に、（Roslynに基づく）自作のユーティリティを使用して、関心のあるメソッドの呼び出しをカウントしました。その結果、最も頻繁に使用されるメソッドのクラスのリストが得られました。

• UnityEngine.Vector3
• UnityEngine.Mathf
• UnityEngine.Debug
• UnityEngine.GameObject
• UnityEngine.Material
• UnityEditor.EditorGUILayout
• UnityEngine.Component
• UnityEngine.Object
• UnityEngine.GUILayout
• UnityEngine.Quaternion
• ..。

次に、これらのクラスのメソッドに注釈を付ける必要があります。テストプロジェクトを作成し、ドキュメントを掘り下げて、これらのメソッドについて可能な限り多くの情報を取得しました。たとえば、プログラムがどのように動作するかを確認するために、さまざまな引数としてnullを渡してみました。



このようなチェック中に、文書化されていない興味深い情報が定期的に発見されました。さらに、エンジンにいくつかの興味深いバグが見つかりました。したがって、次のようなコードを実行する場合：

MeshRenderer renderer = cube.GetComponent<MeshRenderer>();
Material m = renderer.material;
List<int> outNames = null;
m.GetTexturePropertyNameIDs(outNames);

Unityエディター自体が直接クラッシュします（少なくともバージョン2019.3.10f1では）。もちろん、誰かがそのようなコードを書くことはありそうにありませんが、そのようなスクリプトを実行することによってUnityエディターを「ノックダウン」できるという事実自体が興味深いものです。



したがって、注釈が書き込まれます。分析を開始した後、すぐに新しいトリガーを発見しました。たとえば、アナライザはGetComponentメソッドへの奇妙な呼び出しを検出しました。

void OnEnable()
{
  GameObject uiManager = GameObject.Find("UIRoot");

  if (uiManager)
  {
    uiManager.GetComponent<UIManager>();
  }
}

アナライザーの警告： V3010関数「GetComponent」の戻り値を使用する必要があります。 --ADDITIONAL IN CURRENT UIEditorWindow.cs 22 GetComponent



メソッドは、その名前であっても、特定の値が返されることを意味します。この値そのものを何らかの方法で使用する必要があると想定するのは論理的です。これで（新しい注釈のおかげで）、アナライザーは、このメソッドへのそのような「孤立した」呼び出しが論理エラーを示している可能性があることを認識し、それについて警告します。



これは、新しい注釈を追加した後に一連のテストプロジェクトに表示された唯一のトリガーではありません。この記事が大きくなりすぎないように、残りの部分は説明しません。主なことは、PVS-Studioを使用したUnityプロジェクトの開発により、バグなしではるかに安全でクリーンなコードを記述できるようになったことです。



Unityメソッドの注釈を使用した作業について詳しく知りたい場合は、記事「PVS-StudioアナライザーがUnityプロジェクトでさらに多くのエラーを検出し始めた方法」を参照してください。

アンリアルエンジン4

2014年に、Unreal Engine 4の開発者がエンジンのソースコードを公開したとき、私たちはこのプロジェクトを回避できず、それに関する記事も書きました。エンジン開発者はこの記事を気に入って、見つけたバグを修正しました。しかし、これでは十分ではなかったため、アナライザーのライセンスをEpicGamesに販売することにしました。



Epic Gamesは、PVS-Studioを使用してエンジンを改善することに関心を持っていたため、合意に同意しました。アナライザーが警告を発行しないように、Unreal Engineコードを独自に修正し、EpicGamesの担当者がライセンスを購入します。私たちが行った仕事に対して私たちに報酬を与えてください。



なぜすべての警告を修正する必要があったのですか？重要なのは、静的分析の最大のメリットは、エラーが発生したらすぐに修正することで得られるということです。また、プロジェクトを初めてチェックするときは、原則として、数百（場合によっては数千）の警告が表示されます。これらすべてのアナライザー警告の中で、新しく作成されたコードに対して発行された警告は簡単に失われる可能性があります。



一見すると、この問題は非常に簡単に解決できます。座ってレポート全体を完全にバイパスし、エラーを徐々に修正するだけです。ただし、この方法はより直感的ですが、時間がかかる場合があります。抑制ファイルを使用する方法は、はるかに便利で高速です。



ファイルの抑制はPVS-Studioの特別な機能です、これにより、アナライザのトリガーを特別なファイルで「非表示」にすることができます。この場合、非表示の警告は後続のログに表示されません。個別に表示できます。



最初のチェック後に多数のトリガーを受け取ったので、検出されたすべてのトリガーを数回クリックするだけで抑制ファイルに追加できます。次にアナライザーでチェックすると、トリガーが1つもないクリーンなログを受け取ります。



古い警告はログに記録されなくなったため、新しい警告が表示されたらすぐに簡単に見つけることができます。コードを作成しました->アナライザーで確認しました->新しい警告が表示されました->エラーを修正しました。これが、アナライザーを最大限に活用する方法です。



同時に、suppressファイルにあるアラームを忘れないでください。以前と同じであり、重大なエラーや脆弱性に関する警告が含まれている可能性があります。したがって、定期的にこれらの警告に戻り、警告の数を減らすことは価値があります。



もちろん、このシナリオは便利ですが、Epic Gamesの開発者は、コードをすぐに修正することを望んでおり、それを私たちに引き渡しました。



そして、私たちは仕事に取り掛かりました。プロジェクトコードを確認したところ、1821年にLevel_1とLevel_2の1つのレベルの警告が見つかりました。このような大量の警告を解析するには、深刻な作業が必要です。このプロセス全体を容易にするために、CIサーバーで継続的なコード分析を設定します。



毎晩、Unreal Engine 4の現在のバージョンがサーバー上でコンパイルされ、ビルドの直後に分析が自動的に開始されました。したがって、私たちのスタッフが午前中に仕事に来たとき、彼らは常に新鮮なアナライザーレポートを手元に持っていて、警告の修正の進捗状況を追跡することができました。さらに、このようなシステムでは、サーバー上で手動で実行することにより、いつでもビルドの安定性を確認できました。



プロセス全体で17営業日かかりました。警告を修正するスケジュールは次のとおりです。





実際、このチャートは私たちの仕事を完全には反映していません。すべての警告を修正した後、最新のプルリクエストを受け入れるまでさらに2日間待ちました。この間ずっと、Unreal Engineの最新バージョンを自動的にチェックし続け、その結果、新しいコードが補充され続けました。そして、あなたはどう思いますか？この2日間で、PVS-Studioはコードにさらに4つのエラーを検出しました。それらの1つは特に深刻であり、未定義の動作につながる可能性があります。



もちろん、これらのエラーも修正しました。Unreal Engineの開発者は、あと1つだけ行う必要があります。それは、私たちと同じ方法で自動分析を構成することです。その瞬間から、彼らは新しく書かれたコードに対して発行された警告を毎日見始めました。これにより、開発の初期段階で、出現した瞬間でもコードのバグを修正することができました。



Unreal Engineコードの開発方法について詳しくは、UnrealEngineの公式ブログまたはWebサイトをご覧ください。

さまざまなゲームの分析

さまざまなオープンソースプロジェクトをチェックして、それらについての記事を書いていることを述べましたか？ですから、ゲームプロジェクトに関する同様の記事がたくさんあります！VVVVVV、Space Engineers、Command＆Conquer、osuなどのゲームについて書きました。そして（非常に古い記事）Doom3。また、ビデオゲーム業界で最も興味深いバグトップ10をまとめました。



また、おそらくほとんどの有名なオープンソースエンジンもチェックしました。 UnityとUnrealEngine 4に加えて、Godot、Bullet、Amazon Lumberyard、Cry EngineVなどのプロジェクトが私たちの目に留まりました。と他の多く。



このすべての最良の部分は、私たちが説明したバグの多くがその後プロジェクト開発者自身によって修正されたことです。あなたが開発しているツールが、現実の、目に見える、そして具体的な利益を世界にもたらしていると感じるのは良いことです。



ビデオゲームの開発に関連するすべての記事のリストは、ブログの特別なページで見ることができます。

結論

これで私の短い記事は終わりです。バグやエラーのない、クリーンで正しく機能するコードをお祈りします。



静的分析のトピックに興味がありますか？プロジェクトにエラーがないか確認しますか？PVS-Studioをお試しください。

この記事を英語を話す聴衆と共有したい場合は、翻訳リンクを使用してください：GeorgeGribkov。静的コード分析がGameDev業界でどのように役立つか。