轉(zhuǎn)自http://ffwmxr.blog.163.com/blog/static/66372722200981761742868/

WINDOWS完成端口編程
1、基本概念
2、WINDOWS完成端口的特點(diǎn)
3、完成端口（Completion Ports ）相關(guān)數(shù)據(jù)結(jié)構(gòu)和創(chuàng)建
4、完成端口線(xiàn)程的工作原理
5、Windows完成端口的實(shí)例代碼

WINDOWS完成端口編程
   摘要：開(kāi)發(fā)網(wǎng)絡(luò)程序從來(lái)都不是一件容易的事情，盡管只需要遵守很少的一些規(guī)則：創(chuàng)建socket，發(fā)起連接，接受連接，發(fā)送和接收數(shù)據(jù)，等等。真正的困難在于：讓你的程序可以適應(yīng)從單單一個(gè)連接到幾千個(gè)連接乃至于上萬(wàn)個(gè)連接。利用Windows完成端口進(jìn)行重疊I/O的技術(shù)，可以很方便地在Windows平臺(tái)上開(kāi)發(fā)出支持大量連接的網(wǎng)絡(luò)服務(wù)程序。本文介紹在Windows平臺(tái)上使用完成端口模型開(kāi)發(fā)的基本原理，同時(shí)給出實(shí)際的例子。本文主要關(guān)注C/S結(jié)構(gòu)的服務(wù)器端程序，因?yàn)橐话銇?lái)說(shuō)，開(kāi)發(fā)一個(gè)大容量、具有可擴(kuò)展性的winsock程序就是指服務(wù)程序。

1、基本概念
   設(shè)備---指windows操作系統(tǒng)上允許通信的任何東西，比如文件、目錄、串行口、并行口、郵件槽、命名管道、無(wú)名管道、套接字、控制臺(tái)、邏輯磁盤(pán)、物理磁盤(pán)等。絕大多數(shù)與設(shè)備打交道的函數(shù)都是CreateFile/ReadFile/WriteFile等，所以我們不能看到**File函數(shù)就只想到文件設(shè)備。

   與設(shè)備通信有兩種方式，同步方式和異步方式：同步方式下，當(dāng)調(diào)用ReadFile這類(lèi)函數(shù)時(shí)，函數(shù)會(huì)等待系統(tǒng)執(zhí)行完所要求的工作，然后才返回；異步方式下，ReadFile這類(lèi)函數(shù)會(huì)直接返回，系統(tǒng)自己去完成對(duì)設(shè)備的操作，然后以某種方式通知完成操作。

   重疊I/O----顧名思義，就是當(dāng)你調(diào)用了某個(gè)函數(shù)（比如ReadFile）就立刻返回接著做自己的其他動(dòng)作的時(shí)候，系統(tǒng)同時(shí)也在對(duì)I/0設(shè)備進(jìn)行你所請(qǐng)求的操作，在這段時(shí)間內(nèi)你的程序和系統(tǒng)的內(nèi)部動(dòng)作是重疊的，因此有更好的性能。所以，重疊I/O是在異步方式下使用I/O設(shè)備的。重疊I/O需要使用的一個(gè)非常重要的數(shù)據(jù)結(jié)構(gòu)：OVERLAPPED。

2、WINDOWS完成端口的特點(diǎn)
   Win32重疊I/O(Overlapped I/O)機(jī)制允許發(fā)起一個(gè)操作，并在操作完成之后接收信息。對(duì)于那種需要很長(zhǎng)時(shí)間才能完成的操作來(lái)說(shuō)，重疊IO機(jī)制尤其有用，因?yàn)榘l(fā)起重疊操作的線(xiàn)程在重疊請(qǐng)求發(fā)出后就可以自由地做別的事情了。在WinNT和Win2000上，提供的真正可擴(kuò)展的I/O模型就是使用完成端口（Completion Port）的重疊I/O。完成端口---是一種WINDOWS內(nèi)核對(duì)象。完成端口用于異步方式的重疊I/0情況下，當(dāng)然重疊I/O不一定非得使用完成端口不可，同樣設(shè)備內(nèi)核對(duì)象、事件對(duì)象、告警I/0等也可使用。但是完成端口內(nèi)部提供了線(xiàn)程池的管理，可以避免反復(fù)創(chuàng)建線(xiàn)程的開(kāi)銷(xiāo)，同時(shí)可以根據(jù)CPU的個(gè)數(shù)靈活地決定線(xiàn)程個(gè)數(shù)，而且可以減少線(xiàn)程調(diào)度的次數(shù)從而提高性能。其實(shí)類(lèi)似于WSAAsyncSelect和select函數(shù)的機(jī)制更容易兼容Unix，但是難以實(shí)現(xiàn)我們想要的“擴(kuò)展性”。而且windows完成端口機(jī)制在操作系統(tǒng)的內(nèi)部已經(jīng)作了優(yōu)化，從而具備了更高的效率。所以，我們選擇完成端口開(kāi)始我們的服務(wù)器程序開(kāi)發(fā)。
   1）發(fā)起操作不一定完成：系統(tǒng)會(huì)在完成的時(shí)候通知你，通過(guò)用戶(hù)在完成端口上的等待，處理操作的結(jié)果。所以要有檢查完成端口和取操作結(jié)果的線(xiàn)程。在完成端口上守候的線(xiàn)程系統(tǒng)有優(yōu)化，除非在執(zhí)行的線(xiàn)程發(fā)生阻塞，不會(huì)有新的線(xiàn)程被激活，以此來(lái)減少線(xiàn)程切換造成的性能代價(jià)。所以如果程序中沒(méi)有太多的阻塞操作，就沒(méi)有必要啟動(dòng)太多的線(xiàn)程，使用CPU數(shù)量的兩倍，一般這么多線(xiàn)程就夠了。
   2）操作與相關(guān)數(shù)據(jù)的綁定方式：在提交數(shù)據(jù)的時(shí)候用戶(hù)對(duì)數(shù)據(jù)打上相應(yīng)的標(biāo)記，記錄操作的類(lèi)型，在用戶(hù)處理操作結(jié)果的時(shí)候，通過(guò)檢查自己打的標(biāo)記和系統(tǒng)的操作結(jié)果進(jìn)行相應(yīng)的處理。
   3）操作返回的方式：一般操作完成后要通知程序進(jìn)行后續(xù)處理。但寫(xiě)操作可以不通知用戶(hù)，此時(shí)如果用戶(hù)寫(xiě)操作不能馬上完成，寫(xiě)操作的相關(guān)數(shù)據(jù)會(huì)被暫存到非交換緩沖區(qū)中，在操作完成的時(shí)候，系統(tǒng)會(huì)自動(dòng)釋放緩沖區(qū)，此時(shí)發(fā)起完寫(xiě)操作，使用的內(nèi)存就可以釋放了。但如果占用非交換緩沖太多會(huì)使系統(tǒng)停止響應(yīng)。

3、完成端口（Completion Ports ）相關(guān)數(shù)據(jù)結(jié)構(gòu)和創(chuàng)建
    其實(shí)可以把完成端口看成系統(tǒng)維護(hù)的一個(gè)隊(duì)列，操作系統(tǒng)把重疊IO操作完成的事件通知放到該隊(duì)列里，由于是暴露 “操作完成”的事件通知，所以命名為“完成端口”（Completion Ports）。一個(gè)socket被創(chuàng)建后，就可以在任何時(shí)刻和一個(gè)完成端口聯(lián)系起來(lái)。

OVERLAPPED數(shù)據(jù)結(jié)構(gòu)
typedef struct _OVERLAPPED {
    ULONG_PTR Internal;  //被系統(tǒng)內(nèi)部賦值，用來(lái)表示系統(tǒng)狀態(tài)
    ULONG_PTR InternalHigh;  //被系統(tǒng)內(nèi)部賦值，表示傳輸?shù)淖止?jié)數(shù)
    union {
        struct {
            DWORD Offset;  //與OffsetHigh合成一個(gè)64位的整數(shù)，用來(lái)表示從文件頭部的多少字節(jié)開(kāi)始操作 
            DWORD OffsetHigh;  //如果不是對(duì)文件I/O來(lái)操作，則Offset必須設(shè)定為0 
         }; 
       PVOID Pointer;
    }; 
   HANDLE hEvent;  //如果不使用，就務(wù)必設(shè)為0；否則請(qǐng)賦一個(gè)有效的Event句柄
} OVERLAPPED, *LPOVERLAPPED;

下面是異步方式使用ReadFile的一個(gè)例子
OVERLAPPED Overlapped;
Overlapped.Offset=345;
Overlapped.OffsetHigh=0;
Overlapped.hEvent=0;
//假定其他參數(shù)都已經(jīng)被初始化
ReadFile(hFile,buffer,sizeof(buffer),&dwNumBytesRead,&Overlapped);
這樣就完成了異步方式讀文件的操作，然后ReadFile函數(shù)返回，由操作系統(tǒng)做自己的事情。

下面介紹幾個(gè)與OVERLAPPED結(jié)構(gòu)相關(guān)的函數(shù)。

等待重疊I/0操作完成的函數(shù)
BOOL GetOverlappedResult (
HANDLE hFile,
LPOVERLAPPED lpOverlapped, //接受返回的重疊I/0結(jié)構(gòu)
LPDWORD lpcbTransfer, //成功傳輸了多少字節(jié)數(shù)
BOOL fWait  //TRUE只有當(dāng)操作完成才返回，F(xiàn)ALSE直接返回，如果操作沒(méi)有完成，
                    //通過(guò)用GetLastError( )函數(shù)會(huì)返回ERROR_IO_INCOMPLETE
);

而宏HasOverlappedIoCompleted可以幫助我們測(cè)試重疊I/0操作是否完成，該宏對(duì)OVERLAPPED結(jié)構(gòu)的Internal成員進(jìn)行了測(cè)試，查看是否等于STATUS_PENDING值。

   一般來(lái)說(shuō)，一個(gè)應(yīng)用程序可以創(chuàng)建多個(gè)工作線(xiàn)程來(lái)處理完成端口上的通知事件。工作線(xiàn)程的數(shù)量依賴(lài)于程序的具體需要。但是在理想的情況下，應(yīng)該對(duì)應(yīng)一個(gè)CPU 創(chuàng)建一個(gè)線(xiàn)程。因?yàn)樵谕瓿啥丝诶硐肽Ｐ椭校總€(gè)線(xiàn)程都可以從系統(tǒng)獲得一個(gè)“原子”性的時(shí)間片，輪番運(yùn)行并檢查完成端口，線(xiàn)程的切換是額外的開(kāi)銷(xiāo)。但在實(shí)際開(kāi)發(fā)的時(shí)候，還要考慮這些線(xiàn)程是否牽涉到其他堵塞操作的情況。如果某線(xiàn)程進(jìn)行堵塞操作，系統(tǒng)則將其掛起，讓別的線(xiàn)程獲得運(yùn)行時(shí)間。因此，如果有這樣的情況，可以多創(chuàng)建幾個(gè)線(xiàn)程來(lái)盡量利用時(shí)間。

創(chuàng)建完成端口的函數(shù)
完成端口是一個(gè)內(nèi)核對(duì)象，使用時(shí)它總是要和至少一個(gè)有效的設(shè)備句柄相關(guān)聯(lián)，完成端口是一個(gè)復(fù)雜的內(nèi)核對(duì)象，創(chuàng)建它的函數(shù)是：
HANDLE CreateIoCompletionPort(
    IN HANDLE FileHandle,
    IN HANDLE ExistingCompletionPort,
    IN ULONG_PTR CompletionKey,
    IN DWORD NumberOfConcurrentThreads
    );

通常創(chuàng)建工作分兩步：
第一步，創(chuàng)建一個(gè)新的完成端口內(nèi)核對(duì)象，可以使用下面的函數(shù)：
       HANDLE CreateNewCompletionPort(DWORD dwNumberOfThreads)
       {    
          return CreateIoCompletionPort(INVALID_HANDLE_VALUE,NULL,NULL,dwNumberOfThreads);
       };      
第二步，將剛創(chuàng)建的完成端口和一個(gè)有效的設(shè)備句柄關(guān)聯(lián)起來(lái)，可以使用下面的函數(shù)：
       bool AssicoateDeviceWithCompletionPort(HANDLE hCompPort,HANDLE hDevice,DWORD dwCompKey)
       {
          HANDLE h=CreateIoCompletionPort(hDevice,hCompPort,dwCompKey,0);
          return h==hCompPort;
       };
說(shuō)明如下：
1）CreateIoCompletionPort函數(shù)也可以一次性的既創(chuàng)建完成端口對(duì)象，又關(guān)聯(lián)到一個(gè)有效的設(shè)備句柄。
2）CompletionKey是一個(gè)可以自己定義的參數(shù)，我們可以把一個(gè)結(jié)構(gòu)的地址賦給它，然后在合適的時(shí)候取出來(lái)使用，最好要保證結(jié)構(gòu)里面的內(nèi)存不是分配在棧上，除非你有十分的把握內(nèi)存會(huì)保留到你要使用的那一刻。
3）NumberOfConcurrentThreads用來(lái)指定要允許同時(shí)運(yùn)行的的線(xiàn)程的最大個(gè)數(shù)，通常我們指定為0，這樣系統(tǒng)會(huì)根據(jù)CPU的個(gè)數(shù)來(lái)自動(dòng)確定。
4）創(chuàng)建和關(guān)聯(lián)的動(dòng)作完成后，系統(tǒng)會(huì)將完成端口關(guān)聯(lián)的設(shè)備句柄、完成鍵作為一條紀(jì)錄加入到這個(gè)完成端口的設(shè)備列表中。如果你有多個(gè)完成端口，就會(huì)有多個(gè)對(duì)應(yīng)的設(shè)備列表。如果設(shè)備句柄被關(guān)閉，則表中該紀(jì)錄會(huì)被自動(dòng)刪除。

4、完成端口線(xiàn)程的工作原理

1）完成端口管理線(xiàn)程池
   完成端口可以幫助我們管理線(xiàn)程池，但是線(xiàn)程池中的線(xiàn)程需要我們自己使用_beginthreadex來(lái)創(chuàng)建，憑什么通知完成端口管理我們的新線(xiàn)程呢？答案在函數(shù)GetQueuedCompletionStatus。該函數(shù)原型：
BOOL GetQueuedCompletionStatus(
    IN HANDLE CompletionPort,
    OUT LPDWORD lpNumberOfBytesTransferred,
    OUT PULONG_PTR lpCompletionKey,
    OUT LPOVERLAPPED *lpOverlapped,
    IN DWORD dwMilliseconds
); 

   這個(gè)函數(shù)試圖從指定的完成端口的I/0完成隊(duì)列中提取紀(jì)錄。只有當(dāng)重疊I/O動(dòng)作完成的時(shí)候，完成隊(duì)列中才有紀(jì)錄。凡是調(diào)用這個(gè)函數(shù)的線(xiàn)程將會(huì)被放入到完成端口的等待線(xiàn)程隊(duì)列中，因此完成端口就可以在自己的線(xiàn)程池中幫助我們維護(hù)這個(gè)線(xiàn)程。完成端口的I/0完成隊(duì)列中存放了當(dāng)重疊I/0完成的結(jié)果---- 一條紀(jì)錄，該紀(jì)錄擁有四個(gè)字段，前三項(xiàng)就對(duì)應(yīng)GetQueuedCompletionStatus函數(shù)的2、3、4參數(shù)，最后一個(gè)字段是錯(cuò)誤信息dwError。我們也可以通過(guò)調(diào)用PostQueudCompletionStatus模擬完成一個(gè)重疊I/0操作。 

   當(dāng)I/0完成隊(duì)列中出現(xiàn)了紀(jì)錄，完成端口將會(huì)檢查等待線(xiàn)程隊(duì)列，該隊(duì)列中的線(xiàn)程都是通過(guò)調(diào)用GetQueuedCompletionStatus函數(shù)使自己加入隊(duì)列的。等待線(xiàn)程隊(duì)列很簡(jiǎn)單，只是保存了這些線(xiàn)程的ID。完成端口按照后進(jìn)先出的原則將一個(gè)線(xiàn)程隊(duì)列的ID放入到釋放線(xiàn)程列表中，同時(shí)該線(xiàn)程將從等待GetQueuedCompletionStatus函數(shù)返回的睡眠狀態(tài)中變?yōu)榭烧{(diào)度狀態(tài)等待CPU的調(diào)度。所以我們的線(xiàn)程要想成為完成端口管理的線(xiàn)程，就必須要調(diào)用GetQueuedCompletionStatus函數(shù)。出于性能的優(yōu)化，實(shí)際上完成端口還維護(hù)了一個(gè)暫停線(xiàn)程列表，具體細(xì)節(jié)可以參考《Windows高級(jí)編程指南》，我們現(xiàn)在知道的知識(shí)，已經(jīng)足夠了。

2）線(xiàn)程間數(shù)據(jù)傳遞
   完成端口線(xiàn)程間傳遞數(shù)據(jù)最常用的辦法是在_beginthreadex函數(shù)中將參數(shù)傳遞給線(xiàn)程函數(shù)，或者使用全局變量。但完成端口也有自己的傳遞數(shù)據(jù)的方法，答案就在于CompletionKey和OVERLAPPED參數(shù)。
CompletionKey被保存在完成端口的設(shè)備表中，是和設(shè)備句柄一一對(duì)應(yīng)的，我們可以將與設(shè)備句柄相關(guān)的數(shù)據(jù)保存到CompletionKey中，或者將CompletionKey表示為結(jié)構(gòu)指針，這樣就可以傳遞更加豐富的內(nèi)容。這些內(nèi)容只能在一開(kāi)始關(guān)聯(lián)完成端口和設(shè)備句柄的時(shí)候做，因此不能在以后動(dòng)態(tài)改變。

   OVERLAPPED參數(shù)是在每次調(diào)用ReadFile這樣的支持重疊I/0的函數(shù)時(shí)傳遞給完成端口的。我們可以看到，如果我們不是對(duì)文件設(shè)備做操作，該結(jié)構(gòu)的成員變量就對(duì)我們幾乎毫無(wú)作用。我們需要附加信息，可以創(chuàng)建自己的結(jié)構(gòu)，然后將OVERLAPPED結(jié)構(gòu)變量作為我們結(jié)構(gòu)變量的第一個(gè)成員，然后傳遞第一個(gè)成員變量的地址給ReadFile這樣的函數(shù)。因?yàn)轭?lèi)型匹配，當(dāng)然可以通過(guò)編譯。當(dāng)GetQueuedCompletionStatus函數(shù)返回時(shí)，我們可以獲取到第一個(gè)成員變量的地址，然后一個(gè)簡(jiǎn)單的強(qiáng)制轉(zhuǎn)換，我們就可以把它當(dāng)作完整的自定義結(jié)構(gòu)的指針使用，這樣就可以傳遞很多附加的數(shù)據(jù)了。太好了！只有一點(diǎn)要注意，如果跨線(xiàn)程傳遞，請(qǐng)注意將數(shù)據(jù)分配到堆上，并且接收端應(yīng)該將數(shù)據(jù)用完后釋放。我們通常需要將ReadFile這樣的異步函數(shù)的所需要的緩沖區(qū)放到我們自定義的結(jié)構(gòu)中，這樣當(dāng)GetQueuedCompletionStatus被返回時(shí)，我們的自定義結(jié)構(gòu)的緩沖區(qū)變量中就存放了I/0操作的數(shù)據(jù)。CompletionKey和OVERLAPPED參數(shù)，都可以通過(guò)GetQueuedCompletionStatus函數(shù)獲得。

3）線(xiàn)程的安全退出
   很多線(xiàn)程為了不止一次地執(zhí)行異步數(shù)據(jù)處理，需要使用如下語(yǔ)句
while (true)
{
       ......
       GetQueuedCompletionStatus(...); 
       ......
}
那么線(xiàn)程如何退出呢，答案就在于上面曾提到過(guò)的PostQueudCompletionStatus函數(shù)，我們可以向它發(fā)送一個(gè)自定義的包含了OVERLAPPED成員變量的結(jié)構(gòu)地址，里面含一個(gè)狀態(tài)變量，當(dāng)狀態(tài)變量為退出標(biāo)志時(shí)，線(xiàn)程就執(zhí)行清除動(dòng)作然后退出。

5、Windows完成端口的實(shí)例代碼
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的錯(cuò)誤），則沒(méi)有任何完成通知時(shí)間會(huì)被放到完成端口隊(duì)列里。反之，則一定有相應(yīng)的通知時(shí)間被放到完成端口隊(duì)列。更完善的關(guān)于Winsock的完成端口機(jī)制，可以參考 MSDN的Microsoft PlatForm SDK，那里有完成端口的例子。