C#番外篇-SpinWait

SpinWait封裝常見旋轉邏輯。在單處理器計算機上，始終使用 「生成」 而不是 「繁忙等待」，在裝有超執行緒技術的 Intel 處理器的計算機上，這有助於防止硬體執行緒不足。SpinWait 封裝了一種很好的旋轉和真正的生成。

SpinWait是一個值型別，這意味著低階別程式碼可以使用 SpinWait，而不必擔心不必要的分配開銷。SpinWait 對於普通應用程式通常不起作用。在大多數情況下，應使用由 .NET Framework 提供的同步類，如 Monitor 。但在需要自旋等待的大多數情況下， SpinWait 型別應優先於 Thread.SpinWait 方法。

System.Threading.SpinWait 是一種輕型同步型別，可用於低階方案，以避免執行核心事件所需的高成本上下文切換和核心轉換。在多核計算機上，如果不得長時間保留資源，更高效的做法是，先讓等待執行緒在使用者模式下旋轉幾十或幾百個週期，再重試獲取資源。如果資源在旋轉後可用，便節省了幾千個週期。如果資源仍不可用，那麼也只花了幾個週期，仍可以進入基於核心的等待。這種「旋轉後等待」的組合有時稱為「兩階段等待操作」 。

SpinWait 旨在與包裝核心事件（如 ManualResetEvent）的 .NET Framework 型別結合使用。SpinWait 本身也可以僅在一個程式中用於提供基本的旋轉功能。

SpinWait 不僅僅只是空迴圈。謹慎實現後，它可以提供適用於一般情況的正確旋轉行為，並且本身能夠在旋轉時間夠長（大致是核心轉換所需的時間長度）時自行啟動上下文切換。例如，在單核計算機上，SpinWait 會立即生成執行緒的時間片，因為旋轉會阻止所有執行緒取得進展。即使在多核計算機上，SpinWait 也會生成時間片，以防等待執行緒阻止優先順序較高的執行緒或垃圾回收器。因此，若要在兩階段等待操作中使用 SpinWait，建議在 SpinWait 本身啟動上下文切換前，先呼叫核心等待。SpinWait 提供每次呼叫 SpinOnce 前都可以檢查的 NextSpinWillYield 屬性。如果此屬性返回 true，啟動自己的等待操作。

---

看完官方說明一臉懵逼，將上面的語言用通俗的話來說，Thread.Sleep方法在執行時，會將阻止的時間的CPU切換至其他等待的程序，等到Thread.Sleep等待時間到後，再獲取CPU的控制權繼續執行下一步操作；SpinWait提供了While迴圈方法，在等待通過迴圈來阻止當前CPU的釋放，一直等待當前方法執行完成然後釋放。我們都知道程序在切換的時候會有時間與記憶體的消耗，所以儘可能使用SpinWait替代Thread.Sleep。

現在我們看下SpinWait結構中的程式碼：

/// <summary>
/// 迴圈一次
/// </summary>
/// <remarks>
/// This is typically called in a loop, and may change in behavior based on  the number of times a
/// <see cref="SpinOnce"/> has been called thus far on this instance.
/// </remarks>
public void SpinOnce()
{
    if (NextSpinWillYield)
    {
        int yieldsSoFar = (m_count >= YIELD_THRESHOLD ? m_count -  YIELD_THRESHOLD : m_count);
        //③迴圈到20次時，執行Thread.Sleep(01)
        if ((yieldsSoFar % SLEEP_1_EVERY_HOW_MANY_TIMES) ==  (SLEEP_1_EVERY_HOW_MANY_TIMES - 1))
        {
            //當前執行緒掛起，讓出cpu
            //所有掛起的執行緒都有機會競爭當前時間片段，不限制執行緒優先順序
            Thread.Sleep(1);
        }
        //②執行Thread.Yield()5次後，執行Thread.Sleep(0)   
        else if ((yieldsSoFar % SLEEP_0_EVERY_HOW_MANY_TIMES) ==  (SLEEP_0_EVERY_HOW_MANY_TIMES - 1))
        {
            //當前執行緒掛起，讓出cpu
            //(只允許那些優先順序相等或更高的執行緒使用當前的CPU。
            //如果沒有，那當前執行緒會重新使用CPU時間片)
            //（上面已說明，後續補充實現）
            Thread.Sleep(0);
        }
        else
        {
            //當前執行緒掛起（執行狀態->就緒狀態）， 讓出cpu，
            //（後續補充實現邏輯）
            Thread.Yield();
        }
    }
    else
    {
        //執行緒等待
        //4,8,16,32,64...位運算，2的n次方
        //①迴圈10次
        Thread.SpinWait(4 << m_count);
    }
    // m_count 遞增; m_count 達到最大值後回滾Count =10
    m_count = (m_count == int.MaxValue ? YIELD_THRESHOLD : m_count + 1);
}

/// <summary>
/// 重置迴圈計數器
/// </summary>
public void Reset()
{
    m_count = 0;
}
#region Static Methods
/// <summary>
/// 迴圈.直到condition返回True
/// </summary>
public static void SpinUntil(Func<bool> condition)
{
    SpinUntil(condition, Timeout.Infinite);
}
/// <summary>
/// 迴圈，直到condition返回True或者時間達到timeout
/// </summary>
public static bool SpinUntil(Func<bool> condition, TimeSpan timeout)
{
    //校驗時間格式是否正確
    Int64 totalMilliseconds = (Int64)timeout.TotalMilliseconds;
    if (totalMilliseconds < -1 || totalMilliseconds > Int32.MaxValue)
    {
        throw new System.ArgumentOutOfRangeException(
            "timeout", timeout, "SpinWait_SpinUntil_TimeoutWrong");
    }
    return SpinUntil(condition, (int)timeout.TotalMilliseconds);
}
/// <summary>
/// 直到condition返回True或者時間達到timeout.
/// </summary>
public static bool SpinUntil(Func<bool> condition, int millisecondsTimeout)
{
    //校驗時間格式
    if (millisecondsTimeout < Timeout.Infinite)
    {
        throw new ArgumentOutOfRangeException(
           "millisecondsTimeout", millisecondsTimeout,  "SpinWait_SpinUntil_TimeoutWrong");
    }
    //空值校驗
    if (condition == null)
    {
        throw new ArgumentNullException("condition",  "SpinWait_SpinUntil_ArgumentNull");
    }
    uint startTime = 0;
    if (millisecondsTimeout != 0 && millisecondsTimeout != Timeout.Infinite)
    {
        //自上次啟動計算機以來所經過的時間（以毫秒為單位）。
        startTime = TimeoutHelper.GetTime();
    }
    SpinWait spinner = new SpinWait();
    while (!condition())
    {
        if (millisecondsTimeout == 0)
        {
            return false;
        }
        spinner.SpinOnce();
        //計時
        if (millisecondsTimeout != Timeout.Infinite &&  spinner.NextSpinWillYield)
        {
            if (millisecondsTimeout <= (TimeoutHelper.GetTime() - startTime))
            {
                return false;
            }
        }
    }
    return true;
}
#endregion