聊一聊 Monitor.Wait 和 Pulse 的底层玩法

一：背景

1. 讲故事

在dump分析的过程中经常会看到许多线程卡在Monitor.Wait方法上，曾经也有不少人问我为什么用 !syncblk 看不到 Monitor.Wait 上的锁信息，刚好昨天有时间我就来研究一下。
二：Monitor.Wait 底层怎么玩的

1. 案例演示

为了方便报告，先上一段演示代码，Worker1 在执行的过程中必要唤醒 Worker2 执行，当 Worker2 执行完毕之后自己再继续执行，参考代码如下：

1.     internal class Program
2.     {
3.         static Person lockObject = new Person();
5.         static void Main()
6.         {
7.             Task.Run(() => { Worker1(); });
8.             Task.Run(() => { Worker2(); });
10.             Console.ReadLine();
11.         }
13.         static void Worker1()
14.         {
15.             lock (lockObject)
16.             {
17.                 Console.WriteLine($"{DateTime.Now} 1. 执行 worker1 的业务逻辑...");
18.                 Thread.Sleep(1000);
20.                 Console.WriteLine($"{DateTime.Now} 2. 等待 worker2 执行完毕...");
21.                 Monitor.Wait(lockObject);
23.                 Console.WriteLine($"{DateTime.Now} 4. 继续执行 worker1 的业务逻辑...");
24.             }
25.         }
27.         static void Worker2()
28.         {
29.             Thread.Sleep(10);
30.             lock (lockObject)
31.             {
32.                 Console.WriteLine($"{DateTime.Now} 3. worker2 的逻辑执行完毕...");
33.                 Monitor.Pulse(lockObject);
34.             }
35.         }
36.     }
38.     public class Person { }

复制代码

有了代码和输出之后，接下来就是分析底层玩法了。
2. 模型架构图

研究来研究去总得有个结果，千言万语绘成一张图，截图如下：

从图中可以看到这地方会涉及到一个焦点的数据布局 WaitEventLink，参考如下：

1. // Used inside Thread class to chain all events that a thread is waiting for by Object::Wait
2. struct WaitEventLink {
3.     SyncBlock         *m_WaitSB;           // 当前对象的 syncblock
4.     CLREvent          *m_EventWait;    // 当前线程的 m_EventWait
5.     PTR_Thread         m_Thread;       // Owner of this WaitEventLink.
6.     PTR_WaitEventLink  m_Next;         // Chain to the next waited SyncBlock.
7.     SLink              m_LinkSB;       // Chain to the next thread waiting on the same SyncBlock.
8.     DWORD              m_RefCount;     // How many times Object::Wait is called on the same SyncBlock.
9. };

复制代码

代码里对每一个字段都做了表述，还是非常清晰的，也看到了这里存在两个队列。

• m_Next：  当前线程要串联的 SyncBlock 队列，Node 是 WaitEventLink 布局。
  
• m_LinkSB：当前同步块串联的 Thread 队列，Node 是 m_LinkSB 地点。
  

3. 底层的源码验证

起首我们看下C#的 Monitor.Wait(lockObject) 底层是怎样实现的，它对应着 coreclr 的 ObjectNative::WaitTimeout 方法，焦点实现如下：

1. BOOL SyncBlock::Wait(INT32 timeOut)
2. {
3.         //步骤1
4.     WaitEventLink* walk = pCurThread->WaitEventLinkForSyncBlock(this);
6.         //步骤2
7.     CLREvent* hEvent = &(pCurThread->m_EventWait);
9.     waitEventLink.m_WaitSB = this;
10.     waitEventLink.m_EventWait = hEvent;
11.     waitEventLink.m_Thread = pCurThread;
12.     waitEventLink.m_Next = NULL;
13.     waitEventLink.m_LinkSB.m_pNext = NULL;
14.     waitEventLink.m_RefCount = 1;
15.     pWaitEventLink = &waitEventLink;
16.     walk->m_Next = pWaitEventLink;
18.     hEvent->Reset();
20.         //步骤3
21.     ThreadQueue::EnqueueThread(pWaitEventLink, this);
23.     isEnqueued = TRUE;
24.     PendingSync syncState(walk);
26.     OBJECTREF obj = m_Monitor.GetOwningObject();
28.     m_Monitor.IncrementTransientPrecious();
30.         //步骤4
31.     syncState.m_EnterCount = LeaveMonitorCompletely();
33.     isTimedOut = pCurThread->Block(timeOut, &syncState);
35.     return !isTimedOut;
36. }

复制代码

代码逻辑非常简单，大概步骤如下：

• 从当前线程的 m_WaitEventLink 所指向的队列中寻找 SyncBlock 节点，如果没有就返回尾部节点。
  
• 将当前节点拼接到尾部。
  
• 新节点通过 EnqueueThread 方法送入到 m_LinkSB 所指向的队列，这里有一个小技巧，它只存放 WaitEventLink->m_LinkSB 地点，后续会通过 -0x20 来反推 WaitEventLink 布局首地点，从而来获取线程等待事件，参考代码如下：
  

1. inline PTR_WaitEventLink ThreadQueue::WaitEventLinkForLink(PTR_SLink pLink)
2. {
3.     LIMITED_METHOD_CONTRACT;
4.     SUPPORTS_DAC;
5.     return (PTR_WaitEventLink) (((PTR_BYTE) pLink) - offsetof(WaitEventLink, m_LinkSB));
6. }

复制代码

• 使用 LeaveMonitorCompletely 方法将 AwareLock 锁给开释掉，从而让等待这个 lock 的线程进入方法，即当前的 Worker2，简化后代码如下：
  

1. LONG LeaveMonitorCompletely()
2. {
3.     return m_Monitor.LeaveCompletely();
4. }
6. void Signal()
7. {
8.     m_SemEvent.SetMonitorEvent();
9. }
11. void CLREventBase::SetMonitorEvent(){
12.     Set();
13. }

复制代码

总而言之，Monitor.Wait 主要还是用来将Node追加到两大队列，接下来研究下 Monitor.Pulse 的内部实现，这个就比较简单了，无非就是在 m_LinkSB 指向的队列中提取一个Node而已，焦点代码如下：

1. void SyncBlock::Pulse()
2. {
3.     WaitEventLink* pWaitEventLink;
5.     if ((pWaitEventLink = ThreadQueue::DequeueThread(this)) != NULL)
6.         pWaitEventLink->m_EventWait->Set();
7. }
9. // Unlink the head of the Q.  We are always in the SyncBlock's critical
10. // section.
11. /* static */
12. inline WaitEventLink *ThreadQueue::DequeueThread(SyncBlock *psb)
13. {
14.     WaitEventLink* ret = NULL;
15.     SLink* pLink = psb->m_Link.m_pNext;
17.     if (pLink)
18.     {
19.         psb->m_Link.m_pNext = pLink->m_pNext;
20.         ret = WaitEventLinkForLink(pLink);
21.     }
22.     return ret;
23. }
25. inline PTR_WaitEventLink ThreadQueue::WaitEventLinkForLink(PTR_SLink pLink)
26. {
27.     return (PTR_WaitEventLink)(((PTR_BYTE)pLink) - offsetof(WaitEventLink, m_LinkSB));
28. }
30. class SyncBlock
31. {
32.   protected:
33.     SLink m_Link;
34. }

复制代码

上面的代码逻辑还是非常清晰的，从 SyncBlock.m_Link 所串联的 WaitEventLink 队列中提取第一个节点，但这个节点保存的是 WaitEventLink.m_LinkSB 地点，所以必要反向 -0x20 取到 WaitEventLink 首地点，可以用 windbg 来验证一下。

1. 0:017> dt coreclr!WaitEventLink
2.    +0x000 m_WaitSB         : Ptr64 SyncBlock
3.    +0x008 m_EventWait      : Ptr64 CLREvent
4.    +0x010 m_Thread         : Ptr64 Thread
5.    +0x018 m_Next           : Ptr64 WaitEventLink
6.    +0x020 m_LinkSB         : SLink
7.    +0x028 m_RefCount       : Uint4B

复制代码

取到首地点之后就就可以将当前线程的 m_EventWait 唤醒，这就是为什么调用 Monitor.Pulse(lockObject); 之后另一个线程唤醒的内部逻辑，有些朋友好奇那 Monitor.PulseAll 是不是会把这个队列中的所有 Node 上的 m_EventWait 都唤醒呢？哈哈，真聪明，源码如下：

1. void SyncBlock::PulseAll()
2. {
3.     WaitEventLink* pWaitEventLink;
5.     while ((pWaitEventLink = ThreadQueue::DequeueThread(this)) != NULL)
6.         pWaitEventLink->m_EventWait->Set();
7. }

复制代码

眼尖的朋友会有一个疑问，这个队列数据提取了，那另一个队列的数据是不是也要相应的改动，这个确实，它的逻辑是在Wait方法的 PendingSync syncState(walk); 析构函数里，感兴趣的朋友可以看一下内部的void Restore(BOOL bRemoveFromSB) 方法即可。
三：总结

花了半天研究这东西还是挺有意思的，重点还是要理解下那张图，理解了之后我相信你对 Monitor.Pluse 方法注释中所指的 waiting queue 会有一个新的体会。

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。