Dump分析SpeechSynthesizer存在內(nèi)存泄漏

(OneNote Importer)將內(nèi)容從Evernote移到 OneNote

• 類(lèi)型：系統(tǒng)其它大小：2.2M語(yǔ)言：中文 評(píng)分：10.0
• 標(biāo)簽：

立即下載

.Net Framework 3.0帶了個(gè)System.Speech.dll，裝個(gè)語(yǔ)音包，然后就可以實(shí)現(xiàn)文字朗讀等功能。最近在使用的時(shí)候，發(fā)現(xiàn)隨著程序的運(yùn)行，程序占用的內(nèi)存一直在增長(zhǎng)，直到程序崩潰。

用WinDbg抓了個(gè)Dump，然后看了下，里面一堆沒(méi)有釋放的SPVTEXTFRAG、AudioDeviceOut+InItem、WAVEHDR、WaveHeader對(duì)象，于是寫(xiě)了一小段來(lái)測(cè)試：

1: //happyhippy.cnblogs.com
2: using System.Speech.Synthesis;
3: using (SpeechSynthesizer ss = new SpeechSynthesizer())
4: {
5: for (int i = 0; i < int.MaxValue; i++)
6: {
7: ss.Speak(i.ToString());
8: }
9: }

跑了幾個(gè)小時(shí)，然后抓了個(gè)內(nèi)存，開(kāi)始干活：

1. 看下內(nèi)存中有哪些對(duì)象

1: 0:000> .load clr20/sos.dll
2: 0:000> !dumpheap -stat
3: PDB symbol for mscorwks.dll not loaded
4: total 275193 objects
5: Statistics:
6: MT Count TotalSize Class Name
7: 70441ff8 1 12 System.RuntimeTypeHandle
8: 7043fc7c 1 12 System.__Filters
9: //。。。。。。。。。。。。中間省略了一堆。。。。。。。。。。。
10: 704431a8 18 1008 System.Collections.Hashtable
11: 7042c938 65 1560 System.Security.Policy.StrongNameMembershipCondition
12: 70441cd4 81 1620 System.RuntimeType
13: 70441784 16 1820 System.Char[]
14: 7042c6e4 232 6496 System.Security.SecurityElement
15: 70442b84 278 6672 System.Collections.ArrayList
16: 704435c4 17 75056 System.Byte[]
17: 5610529c 4297 85940 System.Speech.Internal.AlphabetConverter+PhoneMapData+ConversionUnit
18: 704432a4 18 181896 System.Collections.Hashtable+bucket[]
19: 70414324 376 319064 System.Object[]
20: 70440b54 13185 396696 System.String
21: 5610ab38 7538 693496 System.Speech.Synthesis.TtsEngine.SPVTEXTFRAG
22: 56105c50 63264 1012224 System.Speech.Internal.Synthesis.AudioDeviceOut+InItem
23: 560f2694 65652 2626080 System.Speech.Internal.Synthesis.WAVEHDR
24: 56105b6c 63264 3289728 System.Speech.Internal.Synthesis.WaveHeader
25: 002be948 56465 172964660 Free
26: Total 275193 objects
27: Fragmented blocks larger than 0.5 MB:
28: Addr Size Followed by
29: 1228c6d8 0.5MB 12311d7c System.Speech.Synthesis.TtsEngine.SPVTEXTFRAG
30: 123293e0 0.6MB 123baa64 System.Speech.Synthesis.TtsEngine.SPVTEXTFRAG
31: 124be36c 1.9MB 1269d898 System.Speech.Synthesis.TtsEngine.SPVTEXTFRAG
32: 126a39f0 1.3MB 127e6644 System.Speech.Synthesis.TtsEngine.SPVTEXTFRAG

列表中的第25行，172M的Free狀態(tài)的內(nèi)存。

最后4行(29~32)的內(nèi)存碎片，用DumpObj看了下，都是Free狀態(tài)。

2. 看看終結(jié)隊(duì)列中有哪些對(duì)象

1: 0:000> !FinalizeQueue -detail
2: SyncBlocks to be cleaned up: 0
3: MTA Interfaces to be released: 0
4: STA Interfaces to be released: 0
5: ----------------------------------
6: generation 0 has 2973 finalizable objects (068fdec4->06900d38)
7: generation 1 has 11 finalizable objects (068fde98->068fdec4)
8: generation 2 has 60304 finalizable objects (068c3058->068fde98)
9: Ready for finalization 0 objects (06900d38->06900d38)
10: Statistics:
11: MT Count TotalSize Class Name
12: 7043a304 1 16 System.WeakReference
13: 7002d1c8 1 20 System.ComponentModel.AsyncOperation
14: 5610a9c0 1 20 System.Speech.Synthesis.SpeechSynthesizer
15: 5610576c 1 20 System.Speech.Internal.ObjectTokens.RegistryDataKey
16: 5610581c 1 24 System.Speech.Internal.ObjectTokens.ObjectToken
17: 56105ae8 1 56 System.Speech.Internal.Synthesis.AudioDeviceOut
18: 70427b90 4 80 Microsoft.Win32.SafeHandles.SafeWaitHandle
19: 561092e0 1 176 System.Speech.Internal.Synthesis.VoiceSynthesis
20: 7043b370 9 180 Microsoft.Win32.SafeHandles.SafeRegistryHandle
21: 70441128 4 224 System.Threading.Thread
22: 56105b6c 63264 3289728 System.Speech.Internal.Synthesis.WaveHeader
23: Total 63288 objects

我靠，內(nèi)存中3289728個(gè)WaveHeader全部掛在終結(jié)隊(duì)列中。一個(gè)可能的原因就是：WaveHeader對(duì)象中實(shí)現(xiàn)了析構(gòu)函數(shù)，并且程序使用完WaveHeader對(duì)象后，沒(méi)有手動(dòng)釋放(Dispose)，而是等著GC來(lái)自動(dòng)回收。

3. 用Reflector看WaveHeader的源代碼

1: internal sealed class WaveHeader : IDisposable
2: {
3: // Fields
4: internal int _dwBufferLength;
5: private GCHandle _gcHandle = new GCHandle();
6: private GCHandle _gcHandleWaveHdr = new GCHandle();
7: private WAVEHDR _waveHdr = new WAVEHDR();
8: internal const int WAVE_FORMAT_PCM = 1;
9: internal const int WHDR_BEGINLOOP = 4;
10: internal const int WHDR_DONE = 1;
11: internal const int WHDR_ENDLOOP = 8;
12: internal const int WHDR_INQUEUE = 0x10;
13: internal const int WHDR_PREPARED = 2;
14:
15: // Methods
16: internal WaveHeader(byte[] buffer)
17: {
18: this._dwBufferLength = buffer.Length;
19: this._gcHandle = GCHandle.Alloc(buffer, GCHandleType.Pinned);//申請(qǐng)內(nèi)存
20: }
21:
22: public void Dispose()
23: {
24: this.Dispose(true);
25: GC.SuppressFinalize(this);
26: }
27:
28: private void Dispose(bool disposing)
29: {
30: if (disposing)
31: {
32: this.ReleaseData();
33: if (this._gcHandleWaveHdr.IsAllocated)
34: {
35: this._gcHandleWaveHdr.Free();
36: }
37: }
38: }
39:
40: ~WaveHeader()
41: {
42: this.Dispose(false);
43: }
44:
45: internal void ReleaseData()
46: {
47: if (this._gcHandle.IsAllocated)
48: {
49: this._gcHandle.Free();
50: }
51: }
52:
53: // Properties
54: internal int SizeHDR
55: {
56: get
57: {
58: return Marshal.SizeOf(this._waveHdr);
59: }
60: }
61:
62: internal GCHandle WAVEHDR
63: {
64: get
65: {
66: if (!this._gcHandleWaveHdr.IsAllocated)
67: {
68: this._waveHdr.lpData = this._gcHandle.AddrOfPinnedObject();
69: this._waveHdr.dwBufferLength = (uint) this._dwBufferLength;
70: this._waveHdr.dwBytesRecorded = 0;
71: this._waveHdr.dwUser = 0;
72: this._waveHdr.dwFlags = 0;
73: this._waveHdr.dwLoops = 0;
74: this._waveHdr.lpNext = IntPtr.Zero;
75: this._gcHandleWaveHdr = GCHandle.Alloc(this._waveHdr, GCHandleType.Pinned);//申請(qǐng)內(nèi)存
76: }
77: return this._gcHandleWaveHdr;
78: }
79: }
80: }

如我們所料，的確定義了一個(gè)析構(gòu)函數(shù)（~WaveHeader()），WaveHealder實(shí)現(xiàn)了Dispose模式。

4. 進(jìn)一步分析，看看WaveHeader都申請(qǐng)了啥資源，為啥要實(shí)現(xiàn)Dispose模式

WaveHeader的構(gòu)造函數(shù)中，申請(qǐng)了一片Pinned狀態(tài)的內(nèi)存this._gcHandle = GCHandle.Alloc(buffer, GCHandleType.Pinned)，并且其WAVEHDR屬性的實(shí)現(xiàn)中，也通過(guò)延遲加載的方式申請(qǐng)了一片Pinned狀態(tài)的內(nèi)存this._gcHandleWaveHdr = GCHandle.Alloc(this._waveHdr, GCHandleType.Pinned)。

MSDN對(duì)GCHander的闡述如下：(FROM MSDN)

GCHandle 類(lèi)與 GCHandleType 枚舉結(jié)合使用以創(chuàng)建對(duì)應(yīng)于任何托管對(duì)象的句柄。此句柄可為以下四種類(lèi)型之一：Weak、WeakTrackResurrection、Normal 或 Pinned。分配了句柄以后，在非托管客戶端保留唯一的引用時(shí)，可以使用它防止垃圾回收器回收托管對(duì)象。如果沒(méi)有這樣的句柄，則在該對(duì)象代表非托管客戶端完成工作以前，有可能被垃圾回收器回收。 用 GCHandle 創(chuàng)建一個(gè)固定對(duì)象，該對(duì)象返回��個(gè)內(nèi)存地址，并防止垃圾回收器在內(nèi)存中移動(dòng)該對(duì)象。 超出范圍時(shí)，您必須通過(guò)調(diào)用Free方法顯式釋放它；否則，可能會(huì)發(fā)生內(nèi)存泄漏。當(dāng)您釋放固定的句柄時(shí)，如果沒(méi)有對(duì)關(guān)聯(lián)對(duì)象的其他引用，則關(guān)聯(lián)對(duì)象將解除固定，并可以被當(dāng)成垃圾回收。

也就是說(shuō)，通過(guò)GCHandler.Alloc申請(qǐng)的內(nèi)存，必須通過(guò)調(diào)用GCHandler.Free方法來(lái)手動(dòng)釋放。表面上看來(lái)，WaveHeader的實(shí)現(xiàn)中，的確有手動(dòng)釋放這些申請(qǐng)的內(nèi)存。

5. WaveHeader在哪兒使用

SpeechSynthesizer封裝了一對(duì)東西，有點(diǎn)兒繞，我順著Speak方法找了N久，沒(méi)有找到使用WaveHeader的地方。

只好換另一個(gè)思路：在上面的第1步中，我們可以看到，WaveHeader的MT Address為56105b6c，于是：

0:000> !dumpheap -MT 56105b6c
//。。。省卻6萬(wàn)多行。。。
127fabdc 56105b6c 52
12800a64 56105b6c 52 //找到一個(gè)還活著的對(duì)象
total 63264 objects
Statistics:
MT Count TotalSize Class Name
56105b6c 63264 3289728 System.Speech.Internal.Synthesis.WaveHeader
Total 63264 objects

然后找到一個(gè)還活著的對(duì)象(地址為12800a64)，看看它被誰(shuí)引用了：

0:000> !gcroot 12800a64
Note: Roots found on stacks may be false positives. Run "!help gcroot" for
more info.
Scan Thread 0 OSTHread 3668
ESP:1df238:Root:01f67e1c(System.Speech.Internal.Synthesis.VoiceSynthesis)->
01f6841c(System.Speech.Internal.Synthesis.AudioDeviceOut)->
01f68570(System.Collections.Generic.List`1[[System.Speech.Internal.Synthesis.AudioDeviceOut+InItem, System.Speech]])->
02f91c10(System.Object[])->
020e4088(System.Speech.Internal.Synthesis.AudioDeviceOut+InItem)->
12800a64(System.Speech.Internal.Synthesis.WaveHeader)
Scan Thread 2 OSTHread 2c5c
Scan Thread 3 OSTHread 1160
Scan Thread 4 OSTHread 211c
Scan Thread 6 OSTHread 22d4
Scan Thread 7 OSTHread 2fcc
Scan Thread 8 OSTHread 377c
這里，我們終于可以看到路徑了：


SpeechSynthesizer
->VoiceSynthesis
->AudioDeviceOut
-> List<AudioDeviceOut + InItem>
-> AudioDeviceOut + InItem（內(nèi)部類(lèi)）
-> WaveHeader
終于找到目標(biāo)了：AudioDeviceOut。

6. 怎么使用WaveHeader

AudioDeviceOut的代碼頁(yè)有點(diǎn)長(zhǎng)，這里只截出部分使用WaveHeader的代碼：

1: internal override void Play(byte[] buffer)
2: {
3: if (this._deviceOpen)
4: {
5: int length = buffer.Length;
6: this._bytesWritten += length;
7: WaveHeader waveHeader = new WaveHeader(buffer);//上面第3節(jié)提到，這里通過(guò)GCHandler.Alloc申請(qǐng)了內(nèi)存
8: GCHandle wAVEHDR = waveHeader.WAVEHDR;//上面第3節(jié)提到，這里通過(guò)GCHandler.Alloc申請(qǐng)了內(nèi)存
9: MMSYSERR errorCode = SafeNativeMethods.waveOutPrepareHeader(this._hwo, wAVEHDR.AddrOfPinnedObject(), waveHeader.SizeHDR);
10: if (errorCode != MMSYSERR.NOERROR)
11: {
12: throw new AudioException(errorCode);
13: }
14: lock (this._noWriteOutLock)
15: {
16: if (!base._aborted)
17: {
18: lock (this._queueIn)
19: {
20: InItem item = new InItem(waveHeader);//InItem封裝了一下WaveHeader，也沒(méi)啥
21: this._queueIn.Add(item); //將Item加入到List中
22: this._evt.Reset();
23: }
24: errorCode = SafeNativeMethods.waveOutWrite(this._hwo, wAVEHDR.AddrOfPinnedObject(), waveHeader.SizeHDR);//P/Invoke向設(shè)備輸出數(shù)據(jù)
25: if (errorCode != MMSYSERR.NOERROR)
26: {
27: lock (this._queueIn)
28: {
29: this._queueIn.RemoveAt(this._queueIn.Count - 1);//如果出錯(cuò)了，從List刪除一個(gè)Item
30: throw new AudioException(errorCode);
31: }
32: }
33: }
34: }
35: }
36: }

在這里，Play方法了面，終于實(shí)例化了WaveHeader和WaveHDR(GCHandler)；但是實(shí)例化的WaveHeader又被InItem封裝了一下，加入到List<InItem> _queueIn中。
Play方法里面創(chuàng)建了WaveHeader，但是卻沒(méi)有看到釋放WaveHeader的代碼。

那我們?cè)賮?lái)看下，其他地方有沒(méi)有釋放WaveHeader的代碼：既然InItem/WaveHeader被加入到_queueIn中了，程序應(yīng)該還要使用WaveHeader；那么當(dāng)InItem從該_queueIn中移出的時(shí)候，應(yīng)該就會(huì)釋放WaveHeader了吧。順著這個(gè)思路繼續(xù)往下看。。。

很不幸，就在Play方法里面：當(dāng)判斷播放出錯(cuò)的時(shí)候，會(huì)把InItem從_queueIn中移出(上面第29行)，但是卻沒(méi)有釋放InItem/WaveHeader。

另一個(gè)將InItem從_queueIn中移出的地方是CallBackProc，AudioDeviceOut在構(gòu)造函數(shù)中初始化了一個(gè)委托：this._delegate = new SafeNativeMethods.WaveOutProc(this.CallBackProc); 從字面上理解，應(yīng)該是輸出聲音完畢后，調(diào)用這個(gè)回調(diào)函數(shù)，來(lái)釋放內(nèi)存：

1: private void CallBackProc(IntPtr hwo, MM_MSG uMsg, IntPtr dwInstance, IntPtr dwParam1, IntPtr dwParam2)
2: {
3: if (uMsg == MM_MSG.MM_WOM_DONE)
4: {
5: lock (this._queueIn)
6: {
7: InItem item = this._queueIn[0];
8: item.ReleaseData();//釋放InItem/WaveHeader
9: this._queueIn.RemoveAt(0); //移除InItem
10: this._queueOut.Add(item);
11: while (this._queueIn.Count > 0)
12: {
13: item = this._queueIn[0];
14: if (item._waveHeader != null)
15: {
16: break;
17: }
18: if ((this._asyncDispatch != null) && !base._aborted)
19: {
20: this._asyncDispatch.Post(item._userData);
21: }
22: this._queueIn.RemoveAt(0);//移除InItem，但是卻沒(méi)有釋放InItem/WaveHeader
23: }
24: }
25: if (this._queueIn.Count == 0)
26: {
27: this._evt.Set();
28: }
29: }
30: }

代碼中，可以看到，當(dāng)uMsg == MM_MSG.MM_WOM_DONE，才會(huì)執(zhí)行釋放操作。MM_MSG枚舉有三個(gè)可選值：MM_WOM_CLOSE = 0x3bc, MM_WOM_DONE = 0x3bd, MM_WOM_OPEN = 0x3bb，暫時(shí)不太清楚是回調(diào)函數(shù)的uMsg參數(shù) 否可能會(huì)傳入其他值；如果傳入了其他值，顯然InItem/WaveHeader有沒(méi)有被釋放。

即使uMsg == MM_MSG.MM_WOM_DONE，我們來(lái)看下釋放的代碼，上面第8~9行，從_queueIn中移除InItem/WaveHeader的時(shí)候，的確執(zhí)行了ReleaseData()來(lái)釋放內(nèi)存，但是看該方法的源代碼：

1: //happyhippy.cnblogs.com
2: //InItem
3: internal void ReleaseData()
4: {
5: if (this._waveHeader != null)
6: {
7: this._waveHeader.ReleaseData();
8: }
9: }
10: //WaveHeader
11: internal void ReleaseData()
12: {
13: if (this._gcHandle.IsAllocated)
14: {
15: this._gcHandle.Free();
16: }
17: }
18:

里面調(diào)用WaveHeader.ReleaseData()來(lái)釋放內(nèi)存，不是調(diào)用Dispose來(lái)釋放內(nèi)存。上面提到，Play方法中，第8行GCHandle wAVEHDR = waveHeader.WAVEHDR申請(qǐng)了內(nèi)存，但是ReleaseData()方法并沒(méi)有釋放該內(nèi)存。應(yīng)該調(diào)用Dispose來(lái)釋放內(nèi)存，而不是調(diào)用ReleaseData()。

然后在回過(guò)頭來(lái)看CallBackProc方法，從源代碼中可以看到，其只釋放了_queueIn中第一個(gè)InItem/WaveHeader，后續(xù)的InItem/WaveHeader從_queueIn中移除的時(shí)候，并沒(méi)有釋放內(nèi)存。

GCHandler.Alloc申請(qǐng)的內(nèi)存，必須通過(guò)調(diào)用Free方法顯式釋放它；否則，可能會(huì)發(fā)生內(nèi)存泄漏。

7. 解決辦法

無(wú)解。那封裝的一大坨，都是Internal。