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

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