Xenkoゲームエンジンのエラーを探す

C ++で記述されたオープンソースエンジンは、C＃で記述された同様のエンジンよりもはるかに優れています。 しかし、例外があります。 XenkoはC＃で書かれたエンジンの1つであり、オープンソースコードを持っています。 この興味深いことは、このエンジンのコードで見つけることができ、この記事で説明します。

分析されたプロジェクト

Xenko （旧称Paradox）は、C＃プログラミング言語を使用してゲームを開発できるクロスプラットフォームゲームエンジンです。 このエンジンにより、Android、iOS、Windowsデスクトップ、Windows Phone、PlayStation 4の異なるプラットフォーム用に2Dと3Dの両方のゲームを開発できます。将来、MacOSXとLinuxのサポートも計画されています。 エンジンのソースコードはGitHubのリポジトリから入手できます 。 ほとんどのコード（GitHubの情報によると89％）はC＃で記述されています。

分析ツール

プロジェクトはPVS-Studioアナライザーを使用して確認されました。 通常の間違い（ V3001など ）に加えて、最新のアナライザーリリースのルールによって診断された疑わしいコードフラグメントも明らかにしました。







すべての診断メッセージには、エラーの例、説明、およびそれらを修正する方法を提供するドキュメントが含まれています。 リンクからアナライザの最新バージョンをダウンロードできます。



根拠がないようにするために、何がおもしろいとわかったのかを見るよう提案します。

疑わしいコードスニペット

多くの場合、エラーは一見思われるよりも深刻な結果につながります。 それらの本質と修正方法をよりよく理解するために、診断ルールのドキュメントに精通することをお勧めします。

public bool CanHandleRequest(TexImage image, IRequest request) { .... return SupportFormat(compress.Format) && SupportFormat(image.Format); .... return SupportFormat(converting.Format) && SupportFormat(converting.Format); //<= .... }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

PVS-Studio警告： V3001 「&&」演算子の左側と右側には、同一のサブ式「SupportFormat（converting.Format）」があります。 SiliconStudio.TextureConverter DxtTexLib.cs 141



多くの場合、人々は「まあ、条件を2回チェックしましたが、問題はありません。」 一見、はい、そして時々そうです。 しかし、多くの場合、問題は異なります。条件が混同されるため、論理エラーが発生し、プログラムロジックが計画に対応しません。 ここにあります。 サブ条件は、 'SupportFormat（converting.Format）'メソッドを呼び出すことによって2回チェックされますが、2番目のケースでは、呼び出しは次の形式である可能性があります： 'SupportFormat（image.Format）'。 その後、式全体は次の形式を取ります。

 return SupportFormat(converting.Format) && SupportFormat(image.Format);
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

同様のエラー（同じメソッドのエラー）：

 public enum Rescaling { Box = 0, Bicubic = 1, Bilinear = 2, BSpline = 3, CatmullRom = 4, Lanczos3 = 5, Nearest, } public bool CanHandleRequest(TexImage image, IRequest request) { .... return rescale.Filter == Filter.Rescaling.Box || rescale.Filter == Filter.Rescaling.Bicubic || //<= rescale.Filter == Filter.Rescaling.Bicubic || //<= rescale.Filter == Filter.Rescaling.Nearest; .... }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

PVS-Studio警告： V3001 '||'の左と右に同一のサブ式 'rescale.Filter == Filter.Rescaling.Bicubic'があります 演算子。 SiliconStudio.TextureConverter DxtTexLib.cs 148



この記事に記載されているコードでは、エラーは肉眼で確認できます。 しかし、このコードを含むファイルでは、控えめに言っても印象的ではありません。 これは、部分的に書式設定の「メリット」によるものです。ファイルでは、この式は1行で記述されるため、コードを詳細に確認せずに部分式を複製しても気付かない場合があります。 列挙の別の要素、たとえば 'BSpline'を意味したと思います。



一般に、大きな式では、次の例に見られるように、同様の間違いを犯すのは非常に簡単です。 アナライザーの警告とコードの説明を読まずに、自分でエラーを見つけてください。

 public static ContainmentType BoxContainsSphere( ref BoundingBox box, ref BoundingSphere sphere) { .... if ((((box.Minimum.X + sphere.Radius <= sphere.Center.X) && (sphere.Center.X <= box.Maximum.X - sphere.Radius)) && ((box.Maximum.X - box.Minimum.X > sphere.Radius) && (box.Minimum.Y + sphere.Radius <= sphere.Center.Y))) && (((sphere.Center.Y <= box.Maximum.Y - sphere.Radius) && (box.Maximum.Y - box.Minimum.Y > sphere.Radius)) && (((box.Minimum.Z + sphere.Radius <= sphere.Center.Z) && (sphere.Center.Z <= box.Maximum.Z - sphere.Radius)) && (box.Maximum.X - box.Minimum.X > sphere.Radius)))) .... }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

PVS-Studioの 警告 ： V3001 「&&」演算子の左側と右側に同一の副次式「box.Maximum.X-box.Minimum.X> sphere.Radius」があります。 SiliconStudio.Core.Mathematics Collision.cs 1322



このコードを理解することは明らかに簡単ではありません...部分式を単純な文字に置き換えて（括弧を省略して）式を単純化してみましょう。 次に、次のコードを取得します。

 if (A && B && C && D && E && F && G && H && C)
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

部分式の数は依然として印象的ですが、エラーを見つけるのは簡単です。 「box.Maximum.X-box.Minimum.X> sphere.Radius」に対応する部分式「C」は、コード内でダブルチェックされます。 元の式を注意深く見ると、実際には、この部分式の代わりに、次のようになっていることが理解できます。

 box.Maximum.Z - box.Minimum.Z > sphere.Radius
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

どうぞ

 .... /// <exception cref="System.ArgumentNullException"> /// key is null.</exception> public bool Remove(KeyValuePair<TKey, Tvalue> item) { if (item.Key == null || item.Key == null) throw new ArgumentException(); .... }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

PVS-Studio警告： V3001 「||」の左側と右側に同一のサブ式「item.Key == null」があります 演算子。 SiliconStudio.Core MultiValueSortedDictionary.cs 318



少なくとも-状態は奇妙に見えます。 ここでは別の部分式も暗示されていると推測できますが、注釈で判断します。 これはタイプミスであることが判明しましたが、どのように許可されるかは完全には明らかではありません。 いずれにしても、コードを修正する必要があります。



多くの場合、オブジェクトが自分自身に割り当てられると、割り当てに間違いが生じます。 そのような場合、側面から見て、コードの修正方法を言うのは難しい場合があります。 これらの場所のいくつかを見てみましょう。

 public ParameterComposedKey(ParameterKey key, string name, int indexer) { Key = key; Name = name; Indexer = indexer; unchecked { hashCode = hashCode = Key.GetHashCode(); hashCode = (hashCode * 397) ^ Name.GetHashCode(); hashCode = (hashCode * 397) ^ Indexer; } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

PVS-Studio警告： V3005 「hashCode」変数はそれ自体に割り当てられます。 SiliconStudio.Xenko ParameterKeys.cs 346



hashCodeフィールドはそれ自体に割り当てられます。 少なくともこれは不必要な割り当てですが、ほとんどの場合、ハッシュ方法に間違いがあります。 いくつかの修正オプションが表示されます。

1. 不要な割り当てを削除します。
2. 最初の割り当てを次のようなサブ式に置き換えます（hashCode * 397）。
3. おそらく、「Indexer」プロパティの「GetHashCode（）」メソッドも呼び出す必要があります。

この場合の対処方法は、コードの作成者次第です。



コードには、常に真または偽の意味を持つ式がありました。 同様のケースがV3022診断によって検出され、次に、その助けを借りて検出できるコードの一部を以下に示します。

 private void SetTime(CompressedTimeSpan timeSpan) { .... while (....) { var moveNextFrame = currentKeyFrame.MoveNext(); if (!moveNextFrame) { .... break; } var keyFrame = moveNextFrame ? currentKeyFrame.Current : data.ValueNext; .... } .... }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

PVS-Studio警告： V3022式 'moveNextFrame'は常にtrueです。 SiliconStudio.Xenko.Engine AnimationChannel.cs 314



三項演算子では、変数 'moveNextFrame'は常にtrueです。 それ以外の場合は、問題のステートメントが実行される前にループが終了します。 したがって、実行がまだ三項演算子に到達する場合、「keyFrame」オブジェクトは常に同じ値-「currentKeyFrame.Current」を持ちます。



同様の状況を追跡するコードスニペットの警告：

• V3022式 'inputTexture.Dimension == TextureDimension.TextureCube'は常にtrueです。 SiliconStudio.Xenko.Engine LambertianPrefilteringNoCompute.cs 66
• V3022式 'inputTexture.Dimension == TextureDimension.TextureCube'は常にtrueです。 SiliconStudio.Xenko.Engine LambertianPrefilteringSH.cs 72

レビューを継続します。

 public enum Diff3ChangeType { None, Children, MergeFromAsset1, MergeFromAsset2, MergeFromAsset1And2, Conflict, ConflictType, ConflictArraySize, InvalidNodeType, } private static bool CheckVisitChildren(Diff3Node diff3) { return diff3.ChangeType == Diff3ChangeType.Children || diff3.ChangeType != Diff3ChangeType.None; }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

警告PVS-Studio： V3023この式の検査を検討してください。 表現が過剰であるか、誤植が含まれています。 SiliconStudio.Assets Diff3Node.cs 70



この式は冗長であるか、エラーが含まれています。 最初の部分式が真の場合、2番目の部分式も常に真になります（ただし、実行は計算に達しません）。 この式は、「diff3.ChangeType！= Diff3ChangeType.None」に簡略化できます。 おそらく、検討中のケースでは、不必要なチェックだけが実装されていますが、間違った変数がチェックされた場合、別のエラーを示している場合もあります。 詳細については、診断のドキュメントを参照してください。



書式設定文字列の興味深い場所がいくつかありました。

 public string ToString(string format, IFormatProvider formatProvider) { if (format == null) return ToString(formatProvider); return string.Format(formatProvider, "Red:{1} Green:{2} Blue:{3}", R.ToString(format, formatProvider), G.ToString(format, formatProvider), B.ToString(format, formatProvider)); }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

警告PVS-Studio： V3025の形式が正しくありません 。 「フォーマット」関数を呼び出すときに、異なる数のフォーマット項目が予想されます。 予想：4.現在：3. SiliconStudio.Core.Mathematics Color3.cs 765



フォーマット文字列パラメーターは{0}でインデックス付けされます。ここでは、インデックス付けは{1}で始まります。 この場合、フォーマット文字列には4つの引数が必要ですが、3つしか表示されないため、「FormatException」タイプの例外がスローされます。 このエラーを修正するには、フォーマット文字列のインデックスに正しく番号を付ける必要があります。

 "Red:{0} Green:{1} Blue:{2}"
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

別の例：

 public static bool IsValidNamespace(string text, out string error) { .... error = items.Where(s => !IsIdentifier(s)) .Select(item => string.Format("[{0}]", item, text)) .FirstOrDefault(); .... }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

警告PVS-Studio： V3025の形式が正しくありません 。 「フォーマット」関数を呼び出すときに、異なる数のフォーマット項目が予想されます。 予想：1.現在：2. SiliconStudio.Core.Design NamingHelper.cs 56



正反対は真です-形式文字列には1つの引数が必要ですが、メソッドには2-「アイテム」と「テキスト」が含まれます。 この場合、不必要な引数は単純に無視されますが、そのようなコードは疑念につながるはずです。 最良の場合、2番目の引数は単に不要であり、最悪の場合は削除できます-形式文字列が正しくありません。

 private bool requestedExit; public void MainLoop(IGameDebuggerHost gameDebuggerHost) { .... while (!requestedExit) { Thread.Sleep(10); } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

PVS-Studio警告： V3032この式で待機することは、コンパイラがいくつかの変数を最適化する可能性があるため、信頼できません。 これを回避するには、揮発性変数または同期プリミティブを使用します。 SiliconStudio.Xenko.Debugger GameDebuggerTarget.cs 225



このループは、外部から特定のイベントを予期し、変数 'requestedExit'の値が 'false'である限り実行する必要があります。 ただし、最適化の後、コンパイラは変数 'requestedExit'の値をキャッシュできるため、このループは無限になる可能性があります。 これらのエラーは、「デバッグ」バージョンと「リリース」バージョンの動作が異なる可能性があるのは最適化中のキャッシングが原因であるため、キャッチするのはかなり困難です。 エラーを修正するには、フィールドを宣言するときに「volatile」修飾子を追加するか、専用の同期ツールを使用します。 詳細については、 この診断のドキュメントを参照してください 。



次の奇妙なコード：

 private void QuickSort(List<TexImage> list, int left, int right) { int i = left; int j = right; double pivotValue = ((left + right) / 2); int x = list[(int)pivotValue].DataSize; .... }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

PVS-Studio警告： V3041式は暗黙的に 'int'型から 'double'型にキャストされました。 分数部分の損失を避けるために、明示的な型キャストの使用を検討してください。 例：double A =（double）（X）/ Y;。 SiliconStudio.TextureConverter AtlasTexLibrary.cs 422



上記のフラグメントを除いて、変数「pivotValue」はどこでも使用されていません。 この変数は 'double'型ですが、初期化式に含まれるすべての変数の型は整数であるため、初期化されると整数除算が実行されます。 さらに、この変数の「int」型への変換がさらに実行されます。 したがって、変数 'pivotValue'を宣言するときにすぐに型 'int'を使用するか、初期化式を使用して配列のインデックスを計算できます。 いずれにせよ、コードは奇妙に見え、単純化する必要があります。



次の警告は、WPFサブシステムに関連しています。

 public static readonly DependencyProperty KeyProperty = DependencyProperty.Register("Key", typeof(object), typeof(TextBoxKeyUpCommandBehavior), new PropertyMetadata(Key.Enter)); public Key Key { get { return (Key)GetValue(KeyProperty); } set { SetValue(KeyProperty, value); } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

警告PVS-Studio： V3046 WPF：DependencyPropertyに登録されたタイプは、アクセスに使用されるプロパティのタイプと一致しません。 SiliconStudio.Presentation TextBoxKeyUpCommandBehavior.cs 18



依存関係プロパティを登録するときに、プロパティが「オブジェクト」タイプの値を格納することが示されました。 したがって、任意のタイプの値をこのプロパティに書き込むことができますが、アクセスしようとすると、プロパティに書き込まれたオブジェクトのタイプを「キー」タイプにキャストできない場合、例外が発生する可能性があります。 プロパティを保存型として登録する場合、「Key」を指定する必要があるという事実は、値「Key.Enter」がプロパティのデフォルト値として指定されているという事実からも明らかです。

新しい診断ルール

記事の冒頭で述べたように、プロジェクトは、PVS-Studioの最新リリースで追加された新しい診断メッセージによって特定された場所を検出することに成功しました。 これらの場所の一部の概要を以下に示します。



メソッドパラメータの1つが上書きされるコードのいくつかの部分が一致しましたが、それ以前は、その値はまったく使用されていませんでした。 したがって、メソッドに入ってきた値は単に失われます。

 internal delegate void InternalValueChangedDelegate( InternalValue internalValue, object oldValue); private static InternalValueChangedDelegate CreateInternalValueChangedEvent( ParameterKey key, InternalValueChangedDelegate internalEvent, ValueChangedDelegate originalEvent) { internalEvent = (internalValue, oldValue) => originalEvent(key, internalValue, oldValue); return internalEvent; }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

PVS-Studio警告： V3061パラメーター 'internalEvent'は、使用される前に常にメソッド本体で書き換えられます。 SiliconStudio.Xenko ParameterCollection.cs 1158



「internalEvent」オブジェクトはどこでも使用されず、すぐに上書きされてからメソッドから返されるため、このコードは奇妙に見えます。 次に、一般的にメソッドシグネチャからこのパラメーターを削除し、メソッドの本体を次の形式に単純化することができます。

 return (internalValue, oldValue) => originalEvent(key, internalValue, oldValue);
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

しかし、エラーがより興味深い可能性があり、実際、このメソッドはデリゲートのチェーンを作成することを目的としていました。 この場合、問題の解決策は、記号「=」を「+ =」に修正することです。



パラメーターの書き換えに関して、さらに2つのケースがありました。

 private void Load(TexImage image, DxtTextureLibraryData libraryData, LoadingRequest loader) { .... libraryData = new DxtTextureLibraryData(); //<= image.LibraryData[this] = libraryData; libraryData.Image = new ScratchImage(); .... }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

PVS-Studio警告： V3061パラメーター 'libraryData'は、使用される前に常にメソッド本体で書き換えられます。 SiliconStudio.TextureConverter DxtTexLib.cs 213



「libraryData」パラメーターは、その値がどこかで使用される前に上書きされます。 ただし、修飾子 'ref'または 'out'でマークされていません。 メソッドによって受け入れられた値が単に失われるため、これは非常に奇妙です。



同様のコードに対して発行された警告： V3061パラメーター 'libraryData'は、使用される前に常にメソッド本体で書き換えられます。 SiliconStudio.TextureConverter FITexLib.cs 244



反対の状況-メソッドは値が使用されない引数を取ります：

 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'はメソッドの本体内では使用されません。 SiliconStudio.Xenko Image.cs 473



アナライザーの警告からわかるように、「height」パラメーターはどこでも使用されていません。 代わりに、パラメータ「幅」が2回「CreateDescription」メソッドに渡されますが、これはエラーを示している可能性があります。 'CreateDescription'メソッドの正しい呼び出しは次のようになります。

 CreateDescription(TextureDimension.Texture3D, width, height, depth, mipMapCount, format, 1)
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

おわりに

C＃で記述されたゲームエンジンをチェックアウトするのは興味深いことでした。 誰もが間違いを犯し、さまざまなツールがその数を最小限に抑え、静的アナライザーもそのようなツールの1つです。 そして、エラーがすぐに見つかると、修正にかかる費用は安くなります。



もちろん、プロジェクトで見つかったすべてのエラーが記事に記載されているわけではありません。 第一に、これにより記事のサイズが大幅に増加します。第二に、診断メッセージの一部は特定のものです。 したがって、特定のタイプのプロジェクトに関連するものは、すべての人にとって関心があるわけではありません。 しかし、もちろん、開発者（およびおそらく好奇心programmer盛なプログラマー）は、アナライザーによって検出されたすべての疑わしい場所を見ることに興味があります。 これは、試用版のアナライザをダウンロードすることで実行できます。







この記事を英語圏の聴衆と共有したい場合は、翻訳へのリンクを使用してください：Sergey Vasiliev。 Xenkoゲームエンジンでエラーをキャッチ 。