windows線程池四種情形（win核心讀書筆記）

windows線程池四種情形（win核心讀書筆記）

　　Mircosoft從Windows2000引入線程池API，並在Vista後對線程池從新構架，引入新的線程池API。如下全部線程池函數均適用於Vista之後的版本。

　　用Windows提供的線程池函數有如下幾個好處：1，沒必要要用CreateThread建立線程；2，沒必要要管理本身線程；3，Windows封裝好的線程池，效率高，性能優越。

1　　異步方式調用函數

　　這種方式和咱們用CreateThread建立線程的用法差很少，給定一個線程函數模板實現功能，而後API去調用這些線程函數。簡單的線程函數模板以下：

1 VOID CALLBACK SimpleCallback(
2   [in, out]            PTP_CALLBACK_INSTANCE Instance,
3   [in, out, optional]  PVOID Context
4 );

 　　第一個參數暫不解釋，第二個參數是傳給毀掉函數的任意值。

　　對應的線程池API函數爲TrySubmitThreadpoolCallback，函數定義以下：

1 BOOL WINAPI TrySubmitThreadpoolCallback(
2   __in          PTP_SIMPLE_CALLBACK pfns,
3   __in_out_opt  PVOID pv,
4   __in_opt      PTP_CALLBACK_ENVIRON pcbe
5 );

 　　第一個參數是線程函數，第二個參數是給線程函數傳的值（Context），第三個參數用做對線程池定製。返回值爲TRUE表示線程後續將啓動，FALSE表示調用失敗。一個小例子爲：

 1 VOID NTAPI WorkThread(PTP_CALLBACK_INSTANCE Instance,PVOID Context)
 2 {
 3     AfxMessageBox(_T("this is a workthread"));
 4 }
 5 
 6 int _tmain(int argc, TCHAR* argv[], TCHAR* envp[])
 7 {
 8     ...
 9 
10     if (TrySubmitThreadpoolCallback(WorkThread,NULL,NULL))
11     {
12         AfxMessageBox(_T("TRUE"));
13     }
14     else
15     {
16         AfxMessageBox(_T("FALSE"));
17     }
18     ...
19 }

 

 　　利用TrySubmitThreadpoolCallback函數有可能失敗，這時線程將不會啓動。爲了確保線程可以啓動過，必須顯示建立一個工做項對象，知道把工做項提交到線程池中。建立工做項函數以下：

1 PTP_WORK WINAPI CreateThreadpoolWork(
2   __in          PTP_WORK_CALLBACK pfnwk,
3   __in_out_opt  PVOID pv,
4   __in_opt      PTP_CALLBACK_ENVIRON pcbe
5 );

　　第一個參數是線程函數，第二個參數是給線程函數傳的值（Context），第三個參數用做對線程池定製。這個函數使用的縣曾函數模板是：

1 VOID CALLBACK WorkCallback(
2   [in, out]            PTP_CALLBACK_INSTANCE Instance,
3   [in, out, optional]  PVOID Context,
4   [in, out]            PTP_WORK Work
5 );

　　建立工做項後，須要提交工做項給線程池，讓線程池分配線程處理該項。提交工做項請求的函數是SubmitThreadpoolWork，定義以下：

1 VOID WINAPI SubmitThreadpoolWork(
2   __in_out      PTP_WORK pwk
3 );

　　等待工做項完成的函數是WaitForThreadpoolWorkCallbacks，定義以下：

1 VOID WINAPI WaitForThreadpoolWorkCallbacks(
2   __in_out      PTP_WORK pwk,
3   __in          BOOL fCancelPendingCallbacks
4 );

　　　該函數的第二個參數，若是傳值爲TRUE，試圖取消提交的工做項。若是工做項已啓動，則等待；FALSE，當前線程掛起，直到工做項完成。

　　　取消工做項的函數是CloseThreadpoolWork，定義以下：

1 VOID WINAPI CloseThreadpoolWork(
2   __in_out      PTP_WORK pwk
3 );

　　一個簡單的例子爲：

 1 VOID CALLBACK WorkThread1(PTP_CALLBACK_INSTANCE Instance,PVOID Context,PTP_WORK Work)
 2 {
 3     for (int i=0;i<5;i++)
 4     {
 5         AfxMessageBox(_T("this is a WorkCallback fun"));
 6         Sleep(1000);
 7     }
 8 }
 9 
10 int _tmain(int argc, TCHAR* argv[], TCHAR* envp[])
11 {
12     ...
13     PTP_WORK pw = CreateThreadpoolWork(WorkThread1,NULL,NULL);
14     SubmitThreadpoolWork(pw);
15     //給線程足夠多的時間啓動
16     Sleep(2000);
17     //TRUE，試圖取消提交的工做項。若是工做項已啓動，則等待；
18     //FALSE，當前線程掛起，直到工做項完成
19     WaitForThreadpoolWorkCallbacks(pw,TRUE);
20     CloseThreadpoolWork(pw);
21     ...
22 }

 

2　　每隔一段時間調用一次線程函數

　　先給出時間間隔線程函數模板

1 VOID CALLBACK TimerCallback(
2   [in, out]            PTP_CALLBACK_INSTANCE Instance,
3   [in, out, optional]  PVOID Context,
4   [in, out]            PTP_TIMER Timer
5 );

　　CreateThreadpoolTimer建立時間間隔計時器對象

1 PTP_TIMER WINAPI CreateThreadpoolTimer(
2   __in          PTP_TIMER_CALLBACK pfnti,
3   __in_out_opt  PVOID pv,
4   __in_opt      PTP_CALLBACK_ENVIRON pcbe
5 );

　　這個函數的參數和建立工做項的參數差很少。建立完畢後，調用SetThreadpoolTimer註冊計時器。

1 VOID WINAPI SetThreadpoolTimer(
2   __in_out      PTP_TIMER pti,
3   __in_opt      PFILETIME pftDueTime,
4   __in          DWORD msPeriod,
5   __in_opt      DWORD msWindowLength
6 );

　　第一個參數是CreateThreadpoolTimer的返回值，第二個參數是第一次調用的開始時間，若是傳值爲NULL，表示中止調用。-1，當即開始。其餘負值，表示調用SetThreadpoolTimer的相對時間。正值，表示，以1600年1月1日開始的絕對時間。第三個參數是調用時間間隔，0表示只調用一次。第4個參數用來個調用時間間隔增長隨機性，好比第3個參數傳遞5，第4個參數傳遞2，表示在5-7毫秒內隨機時間內調用回調函數。這樣能夠避免多個線程在同一時間調用上的衝突。

　　查看計時器是否被設置IsThreadpoolTimerSet

1 BOOL WINAPI IsThreadpoolTimerSet(
2   __in_out      PTP_TIMER pti
3 );

　　等待計時器完成WaitForThreadpoolTimerCallbacks

1 VOID WINAPI WaitForThreadpoolTimerCallbacks(
2   __in_out      PTP_TIMER pti,
3   __in          BOOL fCancelPendingCallbacks
4 );

　　關閉計時器CloseThreadpoolTimer

1 VOID WINAPI CloseThreadpoolTimer(
2   __in_out      PTP_TIMER pti
3 );

　　一個小例子：

 1 VOID CALLBACK WorkThread2(PTP_CALLBACK_INSTANCE Instance,PVOID Context,PTP_TIMER Timer)
 2 {
 3     AfxMessageBox(_T("this is a TimerCallback fun"));
 4 }
 5 
 6 
 7 int _tmain(int argc, TCHAR* argv[], TCHAR* envp[])
 8 {
 9     ...
10     PTP_TIMER pt = CreateThreadpoolTimer(WorkThread2,NULL,NULL);
11     ULARGE_INTEGER ulRelativeStartTime;
12     ulRelativeStartTime.QuadPart = (LONGLONG) -(10000000);  // start in 1 second
13     FILETIME ftRelativeStartTime;
14     ftRelativeStartTime.dwHighDateTime = ulRelativeStartTime.HighPart;
15     ftRelativeStartTime.dwLowDateTime  = ulRelativeStartTime.LowPart;
16     SetThreadpoolTimer(pt,&ftRelativeStartTime,2000,0);
17     if (IsThreadpoolTimerSet(pt))
18     {
19         AfxMessageBox(_T("IsThreadpoolTimerSet TRUE"));
20     }
21     Sleep(5000);
22     WaitForThreadpoolTimerCallbacks(pt,TRUE);
23     CloseThreadpoolTimer(pt);
24         ...
25 }

 3　　　內核對象觸發時調用一個函數

　　內核對象觸發線程函數模板

1 VOID CALLBACK WaitCallback(
2   [in, out]            PTP_CALLBACK_INSTANCE Instance,
3   [in, out, optional]  PVOID Context,
4   [in, out]            PTP_WAIT Wait,
5   [in]                 TP_WAIT_RESULT WaitResult
6 );

　　CreateThreadpoolWait建立線程池等待對象

1 PTP_WAIT WINAPI CreateThreadpoolWait(
2   __in          PTP_WAIT_CALLBACK pfnwa,
3   __in_out_opt  PVOID pv,
4   __in_opt      PTP_CALLBACK_ENVIRON pcbe
5 );

 　　將內核對象綁定到線程池

1 VOID WINAPI SetThreadpoolWait(
2   __in_out      PTP_WAIT pwa,
3   __in_opt      HANDLE h,
4   __in_opt      PFILETIME pftTimeout
5 );

　　第一個參數是CreateThreadpoolWait的返回值，第二個參數是內核對象句柄，第三個參數是表示線程池要花多長時間等待內核對象被觸發，0表示不等待，NULL表示無限等待，負值表示相對時間，正值表示絕對時間。

　　　WaitCallback最後一個參數表示回調函數被調用的緣由。若是WaitResult是WAIT_OBJECT_0，表示SetThreadpoolWait的內核對象在超時以前被觸發；WAIT_TIMEOUT表示超時；WAIT_ABANDONED_0表示內核對象是一個互斥信號量，且別拋棄。

　　等待完成

1 VOID WINAPI WaitForThreadpoolWaitCallbacks(
2   __in_out      PTP_WAIT pwa,
3   __in          BOOL fCancelPendingCallbacks
4 );

 　　關閉

1 VOID WINAPI CloseThreadpoolWait(
2   __in_out      PTP_WAIT pwa
3 );

　　小例子：

 1 VOID CALLBACK WorkThread3(PTP_CALLBACK_INSTANCE Instance,PVOID Context,PTP_WAIT Wait,TP_WAIT_RESULT WaitResult)
 2 {
 3     AfxMessageBox(_T("this is a WaitCallback fun"));
 4 }
 5 
 6 int _tmain(int argc, TCHAR* argv[], TCHAR* envp[])
 7 {
 8     ...
 9 　　PTP_WAIT pw = CreateThreadpoolWait(WorkThread3,NULL,NULL);
10     HANDLE h = CreateEvent(NULL,TRUE,FALSE,NULL);
11     //關聯內核對象
12     SetThreadpoolWait(pw,h,NULL);
13     //0表示不等待，NULL表示無限等待，負值表示相對時間，正值表示絕對時間
14     Sleep(1000);
15     //觸發內核對象
16     SetEvent(h);
17     Sleep(1000);
18     WaitForThreadpoolWaitCallbacks(pw,TRUE);
19     CloseThreadpoolWait(pw);
20     CloseHandle(h);
21     ...
22 }

 

4　　異步IO完成時調用函數

　　回調函數模板原型：

1 VOID CALLBACK IoCompletionCallback(
2   [in, out]            PTP_CALLBACK_INSTANCE Instance,
3   [in, out, optional]  PVOID Context,
4   [in, out, optional]  PVOID Overlapped,
5   [in]                 ULONG IoResult,
6   [in]                 ULONG_PTR NumberOfBytesTransferred,
7   [in, out]            PTP_IO Io
8 );

 

　　建立線程池IO對象

1 PTP_IO WINAPI CreateThreadpoolIo(
2   __in          HANDLE fl,
3   __in          PTP_WIN32_IO_CALLBACK pfnio,
4   __in_out_opt  PVOID pv,
5   __in_opt      PTP_CALLBACK_ENVIRON pcbe
6 );

　　第一個參數是具備OVERLAPPED標識的設備（文件、socket）句柄。其餘三項很少說。

　　將線程池IO對象與線程池內部的完成端口關聯：

1 VOID WINAPI StartThreadpoolIo(
2   __in_out      PTP_IO pio
3 );

　　取消或解除與線程池關聯：　　

1 VOID WINAPI CancelThreadpoolIo(
2   __in_out      PTP_IO pio
3 );
4 
5 
6 VOID WINAPI CloseThreadpoolIo(
7   __in_out      PTP_IO pio
8 );

 

　　等待線程池內核對象返回

1 VOID WINAPI WaitForThreadpoolIoCallbacks(
2   __in_out      PTP_IO pio,
3   __in          BOOL fCancelPendingCallbacks
4 );

　　例子：

 1 VOID CALLBACK WorkThread4(PTP_CALLBACK_INSTANCE Instance,PVOID Context,PVOID Overlapped,ULONG IoResult,ULONG_PTR NumberOfBytesTransferred,PTP_IO Io)
 2 {
 3     AfxMessageBox(_T("this is a IoCompletionCallback fun"));
 4 }
 5 
 6 int _tmain(int argc, TCHAR* argv[], TCHAR* envp[])
 7 {
 8     ...
 9 　　//打開D盤下文件a.txt
10     HANDLE h = CreateFile(_T("D:\\a.txt"), GENERIC_READ,FILE_SHARE_READ, NULL, OPEN_EXISTING, 
11         FILE_FLAG_NO_BUFFERING | FILE_FLAG_OVERLAPPED, NULL);
12     //建立線程池IO對象
13     PTP_IO pi = CreateThreadpoolIo(h,WorkThread4,NULL,NULL);
14     //將線程池IO對象與線程池內部IOCP關聯
15     StartThreadpoolIo(pi);
16     OVERLAPPED ol;
17     ZeroMemory(&ol,sizeof(OVERLAPPED));
18     char c[1024];
19     DWORD readbytes = 0;
20     //異步讀取ReadFile
21     if (!ReadFile(h,c,1024,&readbytes,&ol))
22     {
23         if (ERROR_IO_PENDING != GetLastError())
24         {
25             //若是不是ERROR_IO_PENDING，代表ReadFile出錯，關閉IOCP關聯
26             CancelThreadpoolIo(pi);
27         }
28     }
29     Sleep(2000);
30     WaitForThreadpoolIoCallbacks(pi,TRUE);
31     CloseThreadpoolIo(pi);
32     ...
33 }

 5　　回調函數的終止操做

　　回調函數內部可使用如下幾個API，當回調函數返回後，線程池將釋放鎖。 

　　此外，還有CallbackMayRunLong函數，通知線程池當前任務運行時間比較長。若是CallbackMayRunLong函數返回TRUE，表示線程池中還有其餘線程可用。返回FALSE，表示線程池中無其餘任務可用。

6　　對線程池進行配置

 　　這裏說的線程池配置是對函數TrySubmitThreadpoolCallback用到的線程池（其餘幾種WORK\WAIT\TIMER\IO都用到內核對象，內核對象是不開源的），其餘幾種用到的都是系統默認的線程池，生命週期和進程一致。

　　建立一個線程池 CreateThreadpool

1 PTP_POOL WINAPI CreateThreadpool(
2   PVOID reserved
3 );

 

 　　設置私有線程池的上下線程數量

1 BOOL WINAPI SetThreadpoolThreadMinimum(
2   __in_out      PTP_POOL ptpp,
3   __in          DWORD cthrdMic
4 );
5 
6 VOID WINAPI SetThreadpoolThreadMaximum(
7   __in_out      PTP_POOL ptpp,
8   __in          DWORD cthrdMost
9 );

　　關閉線程池

1 VOID WINAPI CloseThreadpool(
2   __in_out      PTP_POOL ptpp
3 );