mcs/class/corlib/System.Threading/SpinWait.cs

   1 #if NET_4_0 || BOOTSTRAP_NET_4_0
   2 // SpinWait.cs
   3 //
   4 // Copyright (c) 2008 Jérémie "Garuma" Laval
   5 //
   6 // Permission is hereby granted, free of charge, to any person obtaining a copy
   7 // of this software and associated documentation files (the "Software"), to deal
   8 // in the Software without restriction, including without limitation the rights
   9 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10 // copies of the Software, and to permit persons to whom the Software is
  11 // furnished to do so, subject to the following conditions:
  12 //
  13 // The above copyright notice and this permission notice shall be included in
  14 // all copies or substantial portions of the Software.
  15 //
  16 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22 // THE SOFTWARE.
  23 //
  24 //
  25
  26 using System;
  27
  28 namespace System.Threading
  29 {
  30
  31         public struct SpinWait
  32         {
  33                 // The number of step until SpinOnce yield on multicore machine
  34                 const           int  step = 5;
  35                 static readonly bool isSingleCpu = (Environment.ProcessorCount == 1);
  36
  37                 int ntime;
  38
  39                 public void SpinOnce ()
  40                 {
  41                         // On a single-CPU system, spinning does no good
  42                         if (isSingleCpu) {
  43                                 Yield ();
  44                         } else {
  45                                 if (Interlocked.Increment (ref ntime) % step == 0) {
  46                                         Yield ();
  47                                 } else {
  48                                         // Multi-CPU system might be hyper-threaded, let other thread run
  49                                         Thread.SpinWait (2 * (ntime + 1));
  50                                 }
  51                         }
  52                 }
  53
  54                 public static void SpinUntil (Func<bool> predicate)
  55                 {
  56                         SpinWait sw = new SpinWait ();
  57                         while (!predicate ())
  58                                 sw.SpinOnce ();
  59                 }
  60
  61                 public static bool SpinUntil (Func<bool> predicate, TimeSpan ts)
  62                 {
  63                         return SpinUntil (predicate, (int)ts.TotalMilliseconds);
  64                 }
  65
  66                 public static bool SpinUntil (Func<bool> predicate, int milliseconds)
  67                 {
  68                         SpinWait sw = new SpinWait ();
  69                         Watch watch = Watch.StartNew ();
  70
  71                         while (!predicate ()) {
  72                                 if (watch.ElapsedMilliseconds > milliseconds)
  73                                         return false;
  74                                 sw.SpinOnce ();
  75                         }
  76
  77                         return true;
  78                 }
  79
  80                 void Yield ()
  81                 {
  82                         // Replace sched_yield by Thread.Sleep(0) which does almost the same thing
  83                         // (going back in kernel mode and yielding) but avoid the branching and unmanaged bridge
  84                         Thread.Sleep (0);
  85                 }
  86
  87                 public void Reset ()
  88                 {
  89                         ntime = 0;
  90                 }
  91
  92                 public bool NextSpinWillYield {
  93                         get {
  94                                 return isSingleCpu ? true : ntime % step == 0;
  95                         }
  96                 }
  97
  98                 public int Count {
  99                         get {
 100                                 return ntime;
 101                         }
 102                 }
 103         }
 104 }
 105 #endif