Skip to main content

[Code refactoring] ThreadStatic and NULL checks


ThreadStatic is used when you have content that needs to be static per thread. For example we can have a field that needs to be static per thread and not per application. In the example below we can see that _message field is decorated with ThreadStatic attribute. Each thread will have a different instance of this field.
public class Foo
{
  [ThreadStatic] 
  private static string _messageBuffer;
}
Great, until now we are good. But scrolling some lines below we find the following code:
public class Foo
{
  [ThreadStatic] 
  private static string _messageBuffer;
  
  public void DoSomeAction(string input)
  {
    if ( _messageBuffer == null )
    {
      _messageBuffer = string.Empty;
    }
    _messageBuffer += input;
  }
  
  public void DoMoreAction(string input)
  {
    if ( _messageBuffer == null )
    {
      _messageBuffer = string.Empty;
    }
    _messageBuffer += " " + input;
  }
...
}
This is not good. Why would you like to check at each call if the field is initialized or not. We refactor this as follow:
public class Foo
{
  [ThreadStatic] 
  private static string _messageBuffer = string.Empty;  
  
  public void DoSomeAction(string input)
  {
    _messageBuffer += input;
  }
  
  public void DoMoreAction(string input)
  {
    _messageBuffer += " " + input;
  }
}
Or we could add a static constructor. But surprise (!!!), when our methods are called we get NullReferenceException on our thread static filed. Surprised? Well, we check the code and we see that we initialize the field. But, the initialization is called only on one thread. Because of this, on the rest of the threads the field is not initialized.
Now we understood why the check of null was made on each method. We know the cause, but the old solution was not so good at all.
A solution for our problem would be to create a wrapper property over our field. We need only the getter that can check if the field is initialize or not. In this way the null check will exist only in one location.
public class Foo
{
  [ThreadStatic] 
  private static string _messageBuffer;
  
  private static string MessageBuffer
  {
    get
    {
      if ( _messageBuffer == null )
      {
        _messageBuffer = string.Empty;
      }
      
      return _messageBuffer;
    }
  }
  
  public void DoSomeAction(string input)
  {    
    MessageBuffer += input;
  }
  
  public void DoMoreAction(string input)
  {
    MessageBuffer += " " + input;
  }
}
We don't need a lock when we initialize the field because is unique per thread. This means that two different threads will have two different instance of this object.
If we have more fields that are thread static, we can add a Boolean that check if the thread static fields were initialized. In this way all the fields would be initialize from one shot.
public class Foo
{
  [ThreadStatic] 
  private static string _messageBuffer;
  [ThreadStatic] 
  private static int _messageCount;   
  [ThreadStatic] 
  private static StatusState _currentState;  
  [ThreadStatic] 
  private static bool _isInitialized = false;
  
  private static InitializePerThreadContent()
  {
    _messageBuffer = string.Empty;
    _messageCount = 1;
    _currentState = StatusState.Empty;
    _isInitialized = true;
  }
  
  private static string MessageBuffer
  {
    get
    {
      if ( !_isInitialized )
      {
        InitializePerThreadContent();
      }
      
      return _messageBuffer;
    }
  }
  
  private static string MessageCount
  {
    get
    {
      if ( !_isInitialized )
      {
        InitializePerThreadContent();
      }
      
      return _messageCount;
    }
  }
  
    private static string CurrentState
  {
    get
    {
      if ( !_isInitialized )
      {
        InitializePerThreadContent();
      }
      
      return _currentState;
    }
  }
  
  ...
}

Comments

  1. An alternative for your solution would be the use of the System.Threading.ThreadLocal class, present inside .NET framework since version 4.0.

    ReplyDelete

Post a Comment

Popular posts from this blog

Windows Docker Containers can make WIN32 API calls, use COM and ASP.NET WebForms

After the last post , I received two interesting questions related to Docker and Windows. People were interested if we do Win32 API calls from a Docker container and if there is support for COM. WIN32 Support To test calls to WIN32 API, let’s try to populate SYSTEM_INFO class. [StructLayout(LayoutKind.Sequential)] public struct SYSTEM_INFO { public uint dwOemId; public uint dwPageSize; public uint lpMinimumApplicationAddress; public uint lpMaximumApplicationAddress; public uint dwActiveProcessorMask; public uint dwNumberOfProcessors; public uint dwProcessorType; public uint dwAllocationGranularity; public uint dwProcessorLevel; public uint dwProcessorRevision; } ... [DllImport("kernel32")] static extern void GetSystemInfo(ref SYSTEM_INFO pSI); ... SYSTEM_INFO pSI = new SYSTEM_INFO(

Azure AD and AWS Cognito side-by-side

In the last few weeks, I was involved in multiple opportunities on Microsoft Azure and Amazon, where we had to analyse AWS Cognito, Azure AD and other solutions that are available on the market. I decided to consolidate in one post all features and differences that I identified for both of them that we should need to take into account. Take into account that Azure AD is an identity and access management services well integrated with Microsoft stack. In comparison, AWS Cognito is just a user sign-up, sign-in and access control and nothing more. The focus is not on the main features, is more on small things that can make a difference when you want to decide where we want to store and manage our users.  This information might be useful in the future when we need to decide where we want to keep and manage our users.  Feature Azure AD (B2C, B2C) AWS Cognito Access token lifetime Default 1h – the value is configurable 1h – cannot be modified

What to do when you hit the throughput limits of Azure Storage (Blobs)

In this post we will talk about how we can detect when we hit a throughput limit of Azure Storage and what we can do in that moment. Context If we take a look on Scalability Targets of Azure Storage ( https://azure.microsoft.com/en-us/documentation/articles/storage-scalability-targets/ ) we will observe that the limits are prety high. But, based on our business logic we can end up at this limits. If you create a system that is hitted by a high number of device, you can hit easily the total number of requests rate that can be done on a Storage Account. This limits on Azure is 20.000 IOPS (entities or messages per second) where (and this is very important) the size of the request is 1KB. Normally, if you make a load tests where 20.000 clients will hit different blobs storages from the same Azure Storage Account, this limits can be reached. How we can detect this problem? From client, we can detect that this limits was reached based on the HTTP error code that is returned by HTTP