CA2115: ネイティブリソースを使用しているときには GC.KeepAlive を呼び出します

2011-08-09

TypeName	CallGCKeepAliveWhenUsingNativeResources
CheckId	CA2115
カテゴリ	Microsoft.Security
互換性に影響する変更点	なし

原因

ファイナライザーを持つ型で宣言されたメソッドで、System.IntPtr フィールドまたは System.UIntPtr フィールドを参照していますが、GC.KeepAlive を呼び出していません。

規則の説明

ガベージコレクションは、マネージコードでオブジェクトが参照されなくなるとオブジェクトを終了します。アンマネージコードでのオブジェクト参照は、ガベージコレクションを防ぎません。この規則では、アンマネージコードでまだ使用されているのに、アンマネージリソースが終了されたときに発生する可能性のあるエラーを検出します。

この規則では、IntPtr と UIntPtr の各フィールドに、アンマネージリソースへのポインターが格納されていると仮定しています。ファイナライザーの目的はアンマネージリソースを解放することなので、この規則では、ポインターのフィールドによって示されるアンマネージリソースをファイナライザーが解放すると仮定します。また、この規則では、メソッドはポインターフィールドを参照し、アンマネージリソースをアンマネージコードに渡していると仮定します。

違反の修正方法

この規則違反を修正するには、KeepAlive の呼び出しをメソッドに追加し、現在のインスタンス (C# と C++ では this) を引数として渡します。この呼び出しは、ガベージコレクションからオブジェクトを保護するコードの最終行の後に指定します。 KeepAlive を呼び出した直後から、ガベージコレクションは、オブジェクトに対するマネージ参照がないと改めて仮定します。

警告を抑制する状況

この規則には、誤った規則違反がレポートされる仮定があります。次の場合、この規則による警告を抑制しても安全です。

メソッドから参照される IntPtr フィールドまたは UIntPtr フィールドのコンテンツをファイナライザーが解放しない場合。
メソッドが IntPtr フィールドまたは UIntPtr フィールドをアンマネージコードに渡さない場合。

警告を除外する前に、他のメッセージを慎重に再確認します。この規則では、再生やデバッグが困難なエラーが検出されます。

使用例

この例では、BadMethod が規則に違反しています。 GoodMethod に修正後のコードが格納されます。

using System;

namespace SecurityRulesLibrary
{
   class IntPtrFieldsAndFinalizeRequireGCKeepAlive
   {
      private IntPtr unmanagedResource;

      IntPtrFieldsAndFinalizeRequireGCKeepAlive()
      {
         GetUnmanagedResource (unmanagedResource);
      }

      // The finalizer frees the unmanaged resource.
      ~IntPtrFieldsAndFinalizeRequireGCKeepAlive()
      {
         FreeUnmanagedResource (unmanagedResource);
      }

      // Violates rule:CallGCKeepAliveWhenUsingNativeResources. 
      void BadMethod()
      {
         // Call some unmanaged code.
         CallUnmanagedCode(unmanagedResource);
      }

      // Satisfies the rule.
      void GoodMethod()
      {
         // Call some unmanaged code.
         CallUnmanagedCode(unmanagedResource);
         GC.KeepAlive(this);
      }

      // Methods that would typically make calls to unmanaged code.
      void GetUnmanagedResource(IntPtr p)
      {
        // Allocate the resource ...
      }
      void FreeUnmanagedResource(IntPtr p)
      {
        // Free the resource and set the pointer to null ...
      }
      void CallUnmanagedCode(IntPtr p)
      {
        // Use the resource in unmanaged code ...
      }

   }

}