Why, when and how need to use Interlocked.Add? By Example

Try the code below.

 

class Test

  {

    public static void Add(ref long total, long finalResult) { total = finalResult; }

 

    static void Main()

    {

      int[] nums = Enumerable.Range(0, 1000000).ToArray();

      long total = 0;

 

      // First type parameter is the type of the source elements

      // Second type parameter is the type of the local data (subtotal)

      Parallel.ForEach<int, long>(nums, // source collection

                                  () => 0, // method to initialize the local variable

                                  (j, loop, subtotal) => // method invoked by the loop on each iteration

                                  {

                                    subtotal += nums[j]; //modify local variable

                                    return subtotal; // value to be passed to next iteration

                                  },

        // Method to be executed when all loops have completed.

        // finalResult is the final value of subtotal. supplied by the ForEach method.

                                    (finalResult) => Add(ref total, finalResult)

                                  );

 

      Console.WriteLine("The total from Parallel.ForEach is {0}", total);

      Console.WriteLine("Press any key to exit");

      Console.ReadKey();

    }

 

Run multiple times. What happen to the result?

  class Test

  {

    static void Main()

    {

      int[] nums = Enumerable.Range(0, 1000000).ToArray();

      long total = 0;

 

      // First type parameter is the type of the source elements

      // Second type parameter is the type of the local data (subtotal)

      Parallel.ForEach<int, long>(nums, // source collection

                                  () => 0, // method to initialize the local variable

                                  (j, loop, subtotal) => // method invoked by the loop on each iteration

                                  {

                                    subtotal += nums[j]; //modify local variable

                                    return subtotal; // value to be passed to next iteration

                                  },

        // Method to be executed when all loops have completed.

        // finalResult is the final value of subtotal. supplied by the ForEach method.

                                  (finalResult) => Interlocked.Add(ref total, finalResult)

                                  );

 

      Console.WriteLine("The total from Parallel.ForEach is {0}", total);

      Console.WriteLine("Press any key to exit");

      Console.ReadKey();

    }

  }

 

It is obvious that you cannot get the consistent result because of parallelism is not linear. Hence the Interlocked.Add is needed to get the result all the time.

About these ads

About chanmingman

Ming Man is a senior manager for a development company. With 20 years of experience in the IT field, he has developed system using Clipper, COBOL, VB5, VB6, VB.NET, Java and C #. He is familiar with the N-Tier design of business application and is also an expert with database experience in MS SQL, Oracle and AS 400.
This entry was posted in .Net. Bookmark the permalink.

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Connecting to %s