Windows完成端口程式設計

一 基本概念

裝置---Windows作業系統上允許通信的任何東西，比如檔案、目錄、串行口、并行口、郵件槽、命名管道、無名管道、套接字、控制台、邏輯磁盤、實體磁盤等。絕大多數與裝置打交道的函數都是CreateFile/ReadFile/WriteFile等。是以我們不能看到**File函數就隻想到檔案裝置。

與裝置通信有兩種方式，同步方式和異步方式。同步方式下，當調用ReadFile函數時，函數會等待系統執行完所要求的工作，然後才傳回；異步方式下，ReadFile這類函數會直接傳回，系統自己去完成對裝置的操作，然後以某種方式通知完成操作。

重疊I/O----顧名思義，當你調用了某個函數（比如ReadFile）就立刻傳回做自己的其他動作的時候，同時系統也在對I/0裝置進行你要求的操作，在這段時間内你的程式和系統的内部動作是重疊的，是以有更好的性能。是以，重疊I/O是用于異步方式下使用I/O裝置的。重疊I/O需要使用的一個非常重要的資料結構OVERLAPPED。

完成端口---是一種WINDOWS核心對象。完成端口用于異步方式的重疊I/0情況下，當然重疊I/O不一定非使用完成端口不可，還有裝置核心對象、事件對象、告警I/0等。但是完成端口内部提供了線程池的管理，可以避免反複建立線程的開銷，同時可以根據CPU的個數靈活的決定線程個數，而且可以讓減少線程排程的次數進而提高性能。

二 OVERLAPPED資料結構

typedef struct _OVERLAPPED

{

ULONG_PTR Internal;//被系統内部指派，用來表示系統狀态

ULONG_PTR InternalHigh;// 被系統内部指派，傳輸的位元組數

union {

struct {

DWORD Offset;//和OffsetHigh合成一個64位的整數，用來表示從檔案頭部的多少位元組開始

DWORD OffsetHigh;//操作，如果不是對檔案I/O來操作，則必須設定為0

};

PVOID Pointer;

HANDLE hEvent;//如果不使用，就務必設為0,否則請賦一個有效的Event句柄

} OVERLAPPED, *LPOVERLAPPED;

下面是異步方式使用ReadFile的一個例子

OVERLAPPED Overlapped;

Overlapped.Offset=345;

Overlapped.OffsetHigh=0;

Overlapped.hEvent=0;

//假定其他參數都已經被初始化

ReadFile(hFile,buffer,sizeof(buffer),&dwNumBytesRead,&Overlapped);

這樣就完成了異步方式讀檔案的操作，然後ReadFile函數傳回，由作業系統做自己的事情吧

下面介紹幾個與OVERLAPPED結構相關的函數

等待重疊I/0操作完成的函數

BOOL GetOverlappedResult (HANDLE hFile,

LPOVERLAPPED lpOverlapped,//接受傳回的重疊I/0結構

LPDWORD lpcbTransfer,//成功傳輸了多少位元組數

BOOL fWait//TRUE隻有當操作完成才傳回，FALSE直接傳回，如果操作沒有完成，通過調//用GetLastError ()函數會傳回ERROR_IO_INCOMPLETE

);

宏HasOverlappedIoCompleted可以幫助我們測試重疊I/0操作是否完成，該宏對OVERLAPPED結構的Internal成員進行了測試，檢視是否等于STATUS_PENDING值。

三 完成端口的内部機制

建立完成端口

完成端口是一個核心對象，使用時他總是要和至少一個有效的裝置句柄進行關聯，完成端口是一個複雜的核心對象，建立它的函數是：

HANDLE CreateIoCompletionPort(IN HANDLE FileHandle,IN HANDLE ExistingCompletionPort,

IN ULONG_PTR CompletionKey,IN DWORD NumberOfConcurrentThreads);

通常建立工作分兩步：

第一步，建立一個新的完成端口核心對象，可以使用下面的函數：

HANDLE CreateNewCompletionPort(DWORD dwNumberOfThreads)

return CreateIoCompletionPort(INVALID_HANDLE_VALUE,NULL,NULL,dwNumberOfThreads);

第二步，将剛建立的完成端口和一個有效的裝置句柄關聯起來，可以使用下面的函數：

bool AssicoateDeviceWithCompletionPort(HANDLE hCompPort,HANDLE hDevice,DWORD dwCompKey)

HANDLE h=CreateIoCompletionPort(hDevice,hCompPort,dwCompKey,0);

return h==hCompPort;

說明

1） CreateIoCompletionPort函數也可以一次性的既建立完成端口對象，又關聯到一個有效的裝置句柄

2） CompletionKey是一個可以自己定義的參數，我們可以把一個結構的位址賦給它，然後在合适的時候取出來使用，最好要保證結構裡面的記憶體不是配置設定在棧上，除非你有十分的把握記憶體會保留到你要使用的那一刻。

3） NumberOfConcurrentThreads通常用來指定要允許同時運作的的線程的最大個數。通常我們指定為0，這樣系統會根據CPU的個數來自動确定。

建立和關聯的動作完成後，系統會将完成端口關聯的裝置句柄、完成鍵作為一條紀錄加入到這個完成端口的裝置清單中。如果你有多個完成端口，就會有多個對應的裝置清單。如果裝置句柄被關閉，則表中自動删除該紀錄。

完成端口線程的工作原理

完成端口可以幫助我們管理線程池，但是線程池中的線程需要我們使用_beginthreadex來建立，憑什麼通知完成端口管理我們的新線程呢？答案在函數GetQueuedCompletionStatus。該函數原型：

BOOL GetQueuedCompletionStatus(IN HANDLE CompletionPort,

OUT LPDWORD lpNumberOfBytesTransferred,

OUT PULONG_PTR lpCompletionKey,

OUT LPOVERLAPPED *lpOverlapped,

IN DWORD dwMilliseconds

這個函數試圖從指定的完成端口的I/0完成隊列中抽取紀錄。隻有當重疊I/O動作完成的時候，完成隊列中才有紀錄。凡是調用這個函數的線程将被放入到完成端口的等待線程隊列中，是以完成端口就可以在自己的線程池中幫助我們維護這個線程。

完成端口的I/0完成隊列中存放了當重疊I/0完成的結果---- 一條紀錄，該紀錄擁有四個字段，前三項就對應GetQueuedCompletionStatus函數的2、3、4參數，最後一個字段是錯誤資訊 dwError。我們也可以通過調用PostQueudCompletionStatus模拟完成了一個重疊I/0操作。

當I/0完成隊列中出現了紀錄，完成端口将會檢查等待線程隊列，該隊列中的線程都是通過調用GetQueuedCompletionStatus函數使自己加入隊列的。等待線程隊列很簡單，隻是儲存了這些線程的ID。完成端口會按照後進先出的原則将一個線程隊列的ID放入到釋放線程清單中，同時該線程将從等待GetQueuedCompletionStatus函數傳回的睡眠狀态中變為可排程狀态等待CPU的排程。

基本上情況就是如此，是以我們的線程要想成為完成端口管理的線程，就必須要調用

GetQueuedCompletionStatus函數。出于性能的優化，實際上完成端口還維護了一個暫停線程清單，具體細節可以參考《Windows進階程式設計指南》，我們現在知道的知識，已經足夠了。

線程間資料傳遞

線程間傳遞資料最常用的辦法是在_beginthreadex函數中将參數傳遞給線程函數，或者使用全局變量。但是完成端口還有自己的傳遞資料的方法，答案就在于CompletionKey和OVERLAPPED參數。

CompletionKey被儲存在完成端口的裝置表中，是和裝置句柄一一對應的，我們可以将與裝置句柄相關的資料儲存到CompletionKey中，或者将CompletionKey表示為結構指針，這樣就可以傳遞更加豐富的内容。這些内容隻能在一開始關聯完成端口和裝置句柄的時候做，是以不能在以後動态改變。

OVERLAPPED參數是在每次調用ReadFile這樣的支援重疊I/0的函數時傳遞給完成端口的。我們可以看到，如果我們不是對檔案裝置做操作，該結構的成員變量就對我們幾乎毫無作用。我們需要附加資訊，可以建立自己的結構，然後将OVERLAPPED結構變量作為我們結構變量的第一個成員，然後傳遞第一個成員變量的位址給ReadFile函數。因為類型比對，當然可以通過編譯。當GetQueuedCompletionStatus函數傳回時，我們可以擷取到第一個成員變量的位址，然後一個簡單的強制轉換，我們就可以把它當作完整的自定義結構的指針使用，這樣就可以傳遞很多附加的資料了。太好了！隻有一點要注意，如果跨線程傳遞，請注意将資料配置設定到堆上，并且接收端應該将資料用完後釋放。我們通常需要将ReadFile這樣的異步函數的所需要的緩沖區放到我們自定義的結構中，這樣當GetQueuedCompletionStatus被傳回時，我們的自定義結構的緩沖區變量中就存放了I/0操作的資料。

CompletionKey和OVERLAPPED參數，都可以通過GetQueuedCompletionStatus函數獲得。

線程的安全退出

很多線程為了不止一次的執行異步資料處理，需要使用如下語句

while (true){

.。。。。。。

GetQueuedCompletionStatus(...);

。。。。。。

}

那麼如何退出呢，答案就在于上面曾提到的PostQueudCompletionStatus函數，我們可以用它發送一個自定義的包含了OVERLAPPED成員變量的結構位址，裡面包含一個狀态變量，當狀态變量為退出标志時，線程就執行清除動作然後退出。