Using the System.GC APIs to Improve Performance

Post by "winking",  08-19-2008, 10:21
-----------------------------------------------------

Using the System.GC APIs to Improve Performance

Post at http://blogs.msdn.com/clrperfblog/archive/2008/08/18/using-the-system-gc-apis-to-improve-performance.aspx

AddMemoryPressure and RemoveMemoryPressure
The Garbage Collector (GC) handles managed memory and only managed memory.  That means it’s up to you to manage any other resources your application holds onto (files, network or database connections, etc).  AddMemoryPressure and RemoveMemoryPressure, added in .NET 2.0, are used to give a hint to the GC about the size of these unmanaged resources.  

Consider the following contrived class which holds a handle to an open file (AllocHandle and FreeHandle are made-up functions for illustration purposes):

1. class FileHandleHolder
   
2. {
   
3.     protected IntPtr _fileHandle;
   
4. 
   
5.     public FileHandleHolder(string fileName)
   
6.     {
   
7.        _fileHandle = AllocHandle(fileName);
   
8.     }
   
9. 
   
10.     ~FileHandleHolder()
    
11.     {
    
12. FreeHandle(_fileHandle);
    
13.     }
    
14. }
    

复制代码

The handle itself is an IntPtr, which takes up much less memory than the file itself.  As far as the GC is concerned, an instance of FileHandleHolder doesn’t exert much memory pressure, so the GC tunes itself accordingly.  If however, fileHandle pointed to a 1 GB file, the GC still thinks there isn’t much memory pressure caused by this class, since the file is not on the managed heap.  So how do we trick the GC into taking into account our 1 GB file?  Let’s make two small changes to our FileHandleHolder class:

1. class FileHandleHolder
   
2. {
   
3.     protected IntPtr _fileHandle;
   
4. 
   
5.     public FileHandleHolder(string filename, long fileSize)
   
6.     {
   
7.        _fileHandle = AllocHandle(fileName);
   
8. GC.AddMemoryPressure(fileSize);
   
9.     }
   
10. 
    
11.     ~FileHandleHolder()
    
12.     {
    
13. FreeHandle(_fileHandle);
    
14. GC.RemoveMemoryPressure(fileSize);
    
15.     }
    
16. }

复制代码

Our first change is to the constructor.  We can pass the size of the actual file to GC.AddMemoryPressure.  This will tell the GC that this application has an additional 1 GB of memory pressure to it, and the GC will adjust its tuning accordingly.  The second change is to the finalizer.  We call GC.RemoveMemoryPressure to tell the GC there is 1 GB less pressure.

A word of warning, make sure you balance your Add/Removes, lest you cause the GC to start collecting more aggressively and hurting your performance.

Collect
We’ve all heard the advice: don’t call GC.Collect.  It interferes with the GC’s own tuning and unless you really know what you’re doing, you can hurt your application’s overall performance.  In .NET 3.5, we added an overload to GC.Collect that takes a GCCollectionMode enum value.  In places where you think you could benefit from a call to GC.Collect (Perf Guru Rico Mariani has some advice about that here: http://blogs.msdn.com/ricom/archive/2004/11/29/271829.aspx), you can call GC.Collect(2, GCCollectionMode.Optimized), which tells the GC to use its best judgment about whether to actually do a GC.   Based on the GC’s tuning to that point, it will decide if the GC heap will benefit from a collection or not.



SuppressFinalize
Finalizers are bad for performance.  After being marked no longer reachable from user code following a collection, your finalizable object stays in memory until its finalizer is run, and only after the next collection is the memory actually reclaimed.  And not just your finalizable object, the entire object graph your object references.

To avoid the need for finalizers, we recommend implementing the Dispose Pattern (http://msdn.microsoft.com/en-us/library/fs2xkftw.aspx).  This is where GC.SuppressFinalize comes in.  Let’s consider our FileHandleHolder class again, but this time have it use the Dispose Pattern:

1. 
   
2. class FileHandleHolder : IDisposable
   
3. {
   
4.     protected IntPtr _fileHandle;
   
5.     public FileHandleHolder(string filename, long fileSize)
   
6.     {
   
7.        _fileHandle = AllocHandle(fileName);
   
8. GC.AddMemoryPressure(fileSize);
   
9.     }
   
10. 
    
11.     ~FileHandleHolder()
    
12.     {
    
13. Dispose(false);
    
14.     }
    
15. 
    
16.     public void Dispose()
    
17.     {
    
18.        Dispose(true);
    
19.        GC.SuppressFinalize(this);
    
20.     }
    
21. 
    
22.     protected virtual void Dispose(bool disposing)
    
23.     {
    
24. FreeHandle(_fileHandle);
    
25. GC.RemoveMemoryPressure(fileSize);
    
26.     }
    
27. }
    
28. 
    

复制代码

Using the Dispose Pattern, the GC gets the hint that the memory pressure is removed sooner than waiting for it to be collected then finalized, and the GC can resume its tuning.  Stay tuned for my next blog post that will describe some of the new GC APIs added in .NET 3.5 SP1.

This post was authored by Chris Lyon of the CLR performance team at Microsoft Corporation.