Windows完成端口（IOCP）簡介

WINDOWS完成端口編程
1、基本概念
2、WINDOWS完成端口的特點

3、完成端口（Completion Ports ）相關數據結構和創建

4、完成端口線程的工作原理

總結

WINDOWS完成端口編程
      摘要：開發網絡程序從來都不是一件容易的事情，儘管只需要遵守很少的一些規則;創建socket,發起連接，接受連接，發送和接受數據。真正的困難在於：讓你的程序可以適應從單單一個連接到幾千個連接乃至於上萬個連接。利用Windows平臺完成端口進行重疊I/O的技術和Linux在2.6版本的內核中引入的EPOll技術，可以很方便在在在Windows和Linux平臺上開發出支持大量連接的網絡服務程序。本文介紹在Windows和Linux平臺上使用的完成端口和EPoll模型開發的基本原理，同時給出實際的例子。本文主要關注C/S結構的服務器端程序，因爲一般來說，開發一個大容量，具可擴展性的winsock程序一般就是指服務程序。

1、基本概念
設備---windows操作系統上允許通信的任何東西，比如文件、目錄、串行口、並行口、郵件槽、命名管道、無名管道、套接字、控制檯、邏輯磁盤、物理磁盤等。絕大多數與設備打交道的函數都是CreateFile/ReadFile/WriteFile等。所以我們不能看到**File函數就只想到文件設備。與設備通信有兩種方式，同步方式和異步方式。同步方式下，當調用ReadFile函數時，函數會等待系統執行完所要求的工作，然後才返回；異步方式下，ReadFile這類函數會直接返回，系統自己去完成對設備的操作，然後以某種方式通知完成操作。
重疊I/O----顧名思義，當你調用了某個函數（比如ReadFile）就立刻返回做自己的其他動作的時候，同時系統也在對I/0設備進行你要求的操作，在這段時間內你的程序和系統的內部動作是重疊的，因此有更好的性能。所以，重疊I/O是用於異步方式下使用I/O設備的。重疊I/O需要使用的一個非常重要的數據結構OVERLAPPED。

2、WINDOWS完成端口的特點
Win32重疊I/O(Overlapped I/O)機制允許發起一個操作，然後在操作完成之後接受到信息。對於那種需要很長時間才能完成的操作來說，重疊IO機制尤其有用，因爲發起重疊操作的線程在重疊請求發出後就可以自由的做別的事情了。在WinNT和Win2000上，提供的真正的可擴展的I/O模型就是使用完成端口（Completion Port）的重疊I/O.完成端口---是一種WINDOWS內核對象。完成端口用於異步方式的重疊I/0情況下，當然重疊I/O不一定非使用完成端口不可，還有設備內核對象、事件對象、告警I/0等。但是完成端口內部提供了線程池的管理，可以避免反覆創建線程的開銷，同時可以根據CPU的個數靈活的決定線程個數，而且可以讓減少線程調度的次數從而提高性能其實類似於WSAAsyncSelect和select函數的機制更容易兼容Unix，但是難以實現我們想要的“擴展性”。而且windows的完成端口機制在操作系統內部已經作了優化，提供了更高的效率。所以，我們選擇完成端口開始我們的服務器程序的開發。
1、發起操作不一定完成，系統會在完成的時候通知你，通過用戶在完成端口上的等待，處理操作的結果。所以要有檢查完成端口，取操作結果的線程。在完成端口上守候的線程系統有優化，除非在執行的線程阻塞，不會有新的線程被激活，以此來減少線程切換造成的性能代價。所以如果程序中沒有太多的阻塞操作，沒有必要啓動太多的線程，CPU數量的兩倍，一般這樣來啓動線程。
2、操作與相關數據的綁定方式：在提交數據的時候用戶對數據打相應的標記，記錄操作的類型，在用戶處理操作結果的時候，通過檢查自己打的標記和系統的操作結果進行相應的處理。
3、操作返回的方式:一般操作完成後要通知程序進行後續處理。但寫操作可以不通知用戶，此時如果用戶寫操作不能馬上完成，寫操作的相關數據會被暫存到到非交換緩衝區中，在操作完成的時候，系統會自動釋放緩衝區。此時發起完寫操作，使用的內存就可以釋放了。此時如果佔用非交換緩衝太多會使系統停止響應。

3、完成端口（Completion Ports ）相關數據結構和創建
其實可以把完成端口看成系統維護的一個隊列，操作系統把重疊IO操作完成的事件通知放到該隊列裏，由於是暴露 “操作完成”的事件通知，所以命名爲“完成端口”（COmpletion Ports）。一個socket被創建後，可以在任何時刻和一個完成端口聯繫起來。
完成端口相關最重要的是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值。
      一般來說，一個應用程序可以創建多個工作線程來處理完成端口上的通知事件。工作線程的數量依賴於程序的具體需要。但是在理想的情況下，應該對應一個 CPU 創建一個線程。因爲在完成端口理想模型中，每個線程都可以從系統獲得一個“原子”性的時間片，輪番運行並檢查完成端口，線程的切換是額外的開銷。在實際開發的時候，還要考慮這些線程是否牽涉到其他堵塞操作的情況。如果某線程進行堵塞操作，系統則將其掛起，讓別的線程獲得運行時間。因此，如果有這樣的情況，可以多創建幾個線程來儘量利用時間。
應用完成端口：
創建完成端口：完成端口是一個內核對象，使用時他總是要和至少一個有效的設備句柄進行關聯，完成端口是一個複雜的內核對象，創建它的函數是：
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的個數來自動確定。創建和關聯的動作完成後，系統會將完成端口關聯的設備句柄、完成鍵作爲一條紀錄加入到這個完成端口的設備列表中。如果你有多個完成端口，就會有多個對應的設備列表。如果設備句柄被關閉，則表中自動刪除該紀錄。

4、完成端口線程的工作原理
完成端口可以幫助我們管理線程池，但是線程池中的線程需要我們使用_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成員變量的結構地址，裏面包含一個狀態變量，當狀態變量爲退出標誌時，線程就執行清除動作然後退出。