線程池 -> 【Windows核心編程(第五版)】

新博客地址: vonsdite.cn

 

Mircosoft從Windows2000引入線程池API,並在Vista後對線程池重新構架,引入新的線程池API。以下所有線程池函數均適用於Vista以後的版本。

 

使用線程池的好處

用Windows提供的線程池函數有以下幾個好處:

1. 不必要用CreateThread創建線程;

2. 不必要管理自己線程;

3. Windows封裝好的線程池,效率高,性能優越。

 

1. 異步方式調用函數

  這種方式和我們用CreateThread創建線程的用法差不多,給定一個線程函數模板實現功能,然後API去調用這些線程函數。簡單的線程函數模板如下:

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

第一個參數暫不解釋;

第二個參數是傳給毀掉函數的任意值。

 

對應的線程池API函數爲TrySubmitThreadpoolCallback,函數定義如下:

BOOL WINAPI TrySubmitThreadpoolCallback(
  __in          PTP_SIMPLE_CALLBACK pfns,
  __in_out_opt  PVOID pv,
  __in_opt      PTP_CALLBACK_ENVIRON pcbe
);

第一個參數是線程函數;

第二個參數是給線程函數傳的值(Context);

第三個參數用作對線程池定製。

返回值爲TRUE表示線程後續將啓動,FALSE表示調用失敗。

一個小例子爲:

#include <iostream>
#include <windows.h>
#include <winbase.h>
#include <strsafe.h>
using namespace std;
 
 
extern "C" BOOL WINAPI TrySubmitThreadpoolCallback(
   PTP_SIMPLE_CALLBACK  pfns,
     PVOID                pv,
    PTP_CALLBACK_ENVIRON pcbe
    );
 
 
void CALLBACK MyProc(PTP_CALLBACK_INSTANCE instance,PVOID pContext)
{
    SYSTEMTIME tm;
    GetLocalTime(&tm);
    char strText[MAX_PATH];
    StringCchPrintfA(strText,MAX_PATH,"MyProc is runing within thread ID is %d ,current time %d:%d"   \
                     ,GetCurrentThreadId(),tm.wHour,tm.wMinute);
    cout<<strText<<endl;
 
}
 
int main(int argc, char *argv[])
{
 
    cout<<"Call the TrySubmitThreadpoolCallback function to execute myproc,"   \
                  "thread ID of caller is "<<GetCurrentThreadId()<<endl;
    TrySubmitThreadpoolCallback(MyProc,NULL,NULL);
 
    SleepEx(INFINITE,FALSE);
    return 0;
}

 

利用TrySubmitThreadpoolCallback函數有可能失敗,這時線程將不會啓動。

爲了確保線程能夠啓動過,必須顯示創建一個工作項對象,直到把工作項提交到線程池中。

創建工作項函數如下:

PTP_WORK WINAPI CreateThreadpoolWork(
  __in         PTP_WORK_CALLBACK pfnwk,
  __inout_opt  PVOID pv,
  __in_opt     PTP_CALLBACK_ENVIRON pcbe
);

第一個參數是線程函數;

第二個參數是給線程函數傳的值(Context);

第三個參數用作對線程池定製。這個函數使用的線程函數模板是:

VOID CALLBACK WorkCallback(
  __inout      PTP_CALLBACK_INSTANCE Instance,
  __inout_opt  PVOID Context,
  __inout      PTP_WORK Work
);

 

創建工作項後,需要提交工作項給線程池,讓線程池分配線程處理該項。

提交工作項請求的函數是SubmitThreadpoolWork,定義如下:

VOID WINAPI SubmitThreadpoolWork(
  __inout  PTP_WORK pwk
);


等待工作項完成的函數是WaitForThreadpoolWorkCallbacks,定義如下:

VOID WINAPI WaitForThreadpoolWorkCallbacks(
  __inout  PTP_WORK pwk,
  __in     BOOL fCancelPendingCallbacks
);

該函數的第二個參數,如果傳值爲TRUE,試圖取消提交的工作項。

如果工作項已啓動,則等待;FALSE,當前線程掛起,直到工作項完成。

 

取消工作項的函數是CloseThreadpoolWork,定義如下:

VOID WINAPI CloseThreadpoolWork(
  __inout  PTP_WORK pwk
);

 

 一個簡單的例子爲:

 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 );

 一個小例子:

#define _WIN32_WINNT 0x0600
#include <iostream>
#include <windows.h>
#include <winbase.h>
#include <strsafe.h>
#include <threadpoolapiset.h>
using namespace std;
 
 
 
 
void CALLBACK MyProc(PTP_CALLBACK_INSTANCE instance,PVOID pContext,PTP_WORK Work)
{
    SYSTEMTIME tm;
    GetLocalTime(&tm);
    char strText[MAX_PATH];
    StringCchPrintfA(strText,MAX_PATH,"MyProc is runing within thread ID is %d ,current time %d:%d"   \
                     ,GetCurrentThreadId(),tm.wHour,tm.wMinute);
    cout<<strText<<endl;
 
}
 
 
 
int main(int argc, char *argv[])
{
 
    PTP_WORK pWork =  CreateThreadpoolWork(MyProc,NULL,NULL);
    cout<<"thread ID of caller is "<<GetCurrentThreadId()<<endl;
    for(int i= 0; i !=5 ;++i)
    {
            SubmitThreadpoolWork(pWork);
    }
 
    WaitForThreadpoolWorkCallbacks(pWork,FALSE);
    CloseThreadpoolWork(pWork);
 
    return 0;
}


 

 

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

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

VOID CALLBACK WaitCallback(
  __inout      PTP_CALLBACK_INSTANCE Instance,
  __inout_opt  PVOID Context,
  __inout      PTP_WAIT Wait,
  __in         TP_WAIT_RESULT WaitResult
);

 CreateThreadpoolWait創建線程池等待對象

PTP_WAIT WINAPI CreateThreadpoolWait(
  __in         PTP_WAIT_CALLBACK pfnwa,
  __inout_opt  PVOID pv,
  __in_opt     PTP_CALLBACK_ENVIRON pcbe
);


 將內核對象綁定到線程池

VOID WINAPI SetThreadpoolWait(
  __inout   PTP_WAIT pwa,
  __in_opt  HANDLE h,
  __in_opt  PFILETIME pftTimeout
);

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

WaitCallback最後一個參數表示回調函數被調用的原因。如果WaitResult是WAIT_OBJECT_0,表示SetThreadpoolWait的內核對象在超時之前被觸發;WAIT_TIMEOUT表示超時;WAIT_ABANDONED_0表示內核對象是一個互斥信號量,且別拋棄。

等待完成

 VOID WINAPI WaitForThreadpoolWaitCallbacks(
  __in_out      PTP_WAIT pwa,
  __in          BOOL fCancelPendingCallbacks
);

   關閉

VOID WINAPI CloseThreadpoolWait(
in_out      PTP_WAIT pwa
);

  小例子:

 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 );

  例子:

#define _WIN32_WINNT 0x0600
#include <iostream>
#include <windows.h>
#include <winbase.h>
#include <strsafe.h>
#include <threadpoolapiset.h>
using namespace std;
 
typedef struct MYOVERLAPPED
{
    OVERLAPPED overlapped;
    enum{read,write}modle;
    LPVOID pBuffer;
    DWORD dwNumByte;
};
 
 
VOID CALLBACK MyIoCompletionFunc(PTP_CALLBACK_INSTANCE instance,PVOID pContext,PVOID pOverlapped,    \
                                 ULONG IoResult,ULONG NumOfTransferred,PTP_IO Io)
{
    char * strBuffer = (char*) (((MYOVERLAPPED*)pOverlapped)->pBuffer);
    if(IoResult == NO_ERROR)
    {
        cout<<"Reading file completion!!"<<endl<<endl;
        cout<<strBuffer<<endl;
    }
}
 
int main(int argc,char *argv[])
{
    char * str_filename = "C:\\Users\\Administrator\\Desktop\\1.txt";
    HANDLE hFile = CreateFileA(str_filename,GENERIC_READ,FILE_SHARE_READ,NULL,OPEN_EXISTING,    \
                               FILE_FLAG_OVERLAPPED|FILE_FLAG_NO_BUFFERING,NULL);
    if(!hFile && GetLastError() == ERROR_FILE_NOT_FOUND)
    {
        cout<<"Failed to found the file \""<<str_filename<<"\" !"<<endl;
    }
    PTP_IO pIo = CreateThreadpoolIo(hFile,MyIoCompletionFunc,NULL,NULL);
    if(pIo)
    {
        StartThreadpoolIo(pIo);
    }
    MYOVERLAPPED overlap;
    ZeroMemory(&overlap,sizeof(MYOVERLAPPED));
    LARGE_INTEGER fileSize;
    GetFileSizeEx(hFile,&fileSize);
    DWORD dwSize = (64-fileSize.QuadPart%64)+fileSize.QuadPart;
    char *strBuffer =  (char *)VirtualAlloc(NULL,dwSize,MEM_COMMIT,PAGE_READWRITE);//new char[fileSize.LowPart];
    overlap.modle = MYOVERLAPPED::read;
    overlap.pBuffer = strBuffer;
    overlap.dwNumByte = fileSize.QuadPart;
 
    DWORD dwReaded;
    if(!ReadFile(hFile,strBuffer,dwSize,&dwReaded,(LPOVERLAPPED)&overlap))
    {
        if(ERROR_IO_PENDING == GetLastError())
        {
            cout<<"Post IRP of reading to the file device"<<endl;
        }
        else
        {
            cout<<"Read file failed!"<<endl;
        }
    }
    Sleep(2000);
    WaitForThreadpoolIoCallbacks(pIo,FALSE);
    SleepEx(INFINITE,FALSE);
 
 
    return 0;
}

 

 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 );
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章