轉自http://ffwmxr.blog.163.com/blog/static/66372722200981761742868/
WINDOWS完成端口編程
1、基本概念
2、WINDOWS完成端口的特點
3、完成端口（Completion Ports ）相關數據結構和創建
4、完成端口線程的工作原理
5、Windows完成端口的實例代碼
WINDOWS完成端口編程
摘要：開發網絡程序從來都不是一件容易的事情，盡管只需要遵守很少的一些規則：創建socket，發起連接，接受連接，發送和接收數據，等等。真正的困難在于：讓你的程序可以適應從單單一個連接到幾千個連接乃至于上萬個連接。利用Windows完成端口進行重疊I/O的技術，可以很方便地在Windows平臺上開發出支持大量連接的網絡服務程序。本文介紹在Windows平臺上使用完成端口模型開發的基本原理，同時給出實際的例子。本文主要關注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來操作，則Offset必須設定為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）創建和關聯的動作完成后，系統會將完成端口關聯的設備句柄、完成鍵作為一條紀錄加入到這個完成端口的設備列表中。如果你有多個完成端口，就會有多個對應的設備列表。如果設備句柄被關閉，則表中該紀錄會被自動刪除。
4、完成端口線程的工作原理
1）完成端口管理線程池
完成端口可以幫助我們管理線程池，但是線程池中的線程需要我們自己使用_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高級編程指南》，我們現在知道的知識，已經足夠了。
2）線程間數據傳遞
完成端口線程間傳遞數據最常用的辦法是在_beginthreadex函數中將參數傳遞給線程函數，或者使用全局變量。但完成端口也有自己的傳遞數據的方法，答案就在于CompletionKey和OVERLAPPED參數。
CompletionKey被保存在完成端口的設備表中，是和設備句柄一一對應的，我們可以將與設備句柄相關的數據保存到CompletionKey中，或者將CompletionKey表示為結構指針，這樣就可以傳遞更加豐富的內容。這些內容只能在一開始關聯完成端口和設備句柄的時候做，因此不能在以后動態改變。
OVERLAPPED參數是在每次調用ReadFile這樣的支持重疊I/0的函數時傳遞給完成端口的。我們可以看到，如果我們不是對文件設備做操作，該結構的成員變量就對我們幾乎毫無作用。我們需要附加信息，可以創建自己的結構，然后將OVERLAPPED結構變量作為我們結構變量的第一個成員，然后傳遞第一個成員變量的地址給ReadFile這樣的函數。因為類型匹配，當然可以通過編譯。當GetQueuedCompletionStatus函數返回時，我們可以獲取到第一個成員變量的地址，然后一個簡單的強制轉換，我們就可以把它當作完整的自定義結構的指針使用，這樣就可以傳遞很多附加的數據了。太好了！只有一點要注意，如果跨線程傳遞，請注意將數據分配到堆上，并且接收端應該將數據用完后釋放。我們通常需要將ReadFile這樣的異步函數的所需要的緩沖區放到我們自定義的結構中，這樣當GetQueuedCompletionStatus被返回時，我們的自定義結構的緩沖區變量中就存放了I/0操作的數據。CompletionKey和OVERLAPPED參數，都可以通過GetQueuedCompletionStatus函數獲得。
3）線程的安全退出
很多線程為了不止一次地執行異步數據處理，需要使用如下語句
while (true)
{
......
GetQueuedCompletionStatus(...);
......
}
那么線程如何退出呢，答案就在于上面曾提到過的PostQueudCompletionStatus函數，我們可以向它發送一個自定義的包含了OVERLAPPED成員變量的結構地址，里面含一個狀態變量，當狀態變量為退出標志時，線程就執行清除動作然后退出。
5、Windows完成端口的實例代碼
DWORD WINAPI WorkerThread(LPVOID lpParam)
{
ULONG_PTR *PerHandleKey;
OVERLAPPED *Overlap;
OVERLAPPEDPLUS *OverlapPlus;
OVERLAPPEDPLUS *newolp;
DWORD dwBytesXfered;
while (1)
{
ret = GetQueuedCompletionStatus(hIocp, &dwBytesXfered, (PULONG_PTR)&PerHandleKey, &Overlap, INFINITE);
if (ret == 0)
{
// Operation failed
continue;
}
OverlapPlus = CONTAINING_RECORD(Overlap, OVERLAPPEDPLUS, ol);
switch (OverlapPlus->OpCode)
{
case OP_ACCEPT:
// Client socket is contained in OverlapPlus.sclient
// Add client to completion port
CreateIoCompletionPort((HANDLE)OverlapPlus->sclient, hIocp, (ULONG_PTR)0, 0);
// Need a new OVERLAPPEDPLUS structure
// for the newly accepted socket. Perhaps
// keep a look aside list of free structures.
newolp = AllocateOverlappedPlus();
if (!newolp)
{
// Error
}
newolp->s = OverlapPlus->sclient;
newolp->OpCode = OP_READ;
// This function divpares the data to be sent
PrepareSendBuffer(&newolp->wbuf);
ret = WSASend(newolp->s, &newolp->wbuf, 1, &newolp->dwBytes, 0, &newolp.ol, NULL);
if (ret == SOCKET_ERROR)
{
if (WSAGetLastError() != WSA_IO_PENDING)
{
// Error
}
}
// Put structure in look aside list for later use
FreeOverlappedPlus(OverlapPlus);
// Signal accept thread to issue another AcceptEx
SetEvent(hAcceptThread);
break;
case OP_READ:
// Process the data read
// Repost the read if necessary, reusing the same
// receive buffer as before
memset(&OverlapPlus->ol, 0, sizeof(OVERLAPPED));
ret = WSARecv(OverlapPlus->s, &OverlapPlus->wbuf, 1, &OverlapPlus->dwBytes, &OverlapPlus->dwFlags, &OverlapPlus->ol, NULL);
if (ret == SOCKET_ERROR)
{
if (WSAGetLastError() != WSA_IO_PENDING)
{
// Error
}
}
break;
case OP_WRITE:
// Process the data sent, etc.
break;
} // switch
} // while
} // WorkerThread
查看以上代碼，注意如果Overlapped操作立刻失敗（比如，返回SOCKET_ERROR或其他非WSA_IO_PENDING的錯誤），則沒有任何完成通知時間會被放到完成端口隊列里。反之，則一定有相應的通知時間被放到完成端口隊列。更完善的關于Winsock的完成端口機制，可以參考 MSDN的Microsoft PlatForm SDK，那里有完成端口的例子。