emule中節點加入Kad網路過程（原始碼詳解）

emule中節點加入Kad網路過程（原始碼詳解）

程式啟動：

EmuleDlg.cpp中函數BOOL CemuleDlg::OnInitDialog()，此函數用於對話方塊的初始化，在這個函數裡添加了定時器：VERIFY( (m_hTimer = ::SetTimer(NULL, NULL, 300, StartupTimer)) != NULL );

在這裡添加了函數void CALLBACK CemuleDlg::StartupTimer(HWND /*hwnd*/, UINT /*uiMsg*/, UINT /*idEvent*/, DWORD /*dwTime*/)，

case 2:

theApp.Kad_Dlg->status++;

if(!theApp.listensocket->StartListening())

ASSERT(0);

if(!theApp.clientudp->Create())

ASSERT(0);

theApp.Kad_Dlg->status++;

break;

在StartupTimer這個函數裡，添加了一個ListenSocket的偵聽端，並且在本地節點建立了一個CClientUDPSocket* clientudp;

然後程式啟動。

順便說一句，在CEmule類中定義了許多的類的執行個體，這都在今後使用到：

UploadBandwidthThrottler* uploadBandwidthThrottler;

CClientList* clientlist;

CClientUDPSocket* clientudp;

CListenSocket* listensocket;

CSharedFileList* sharedfiles;

CDownloadQueue* downloadqueue;

CUploadQueue* uploadqueue;

CServerList* serverlist;

LastCommonRouteFinder* lastCommonRouteFinder;

CServerConnect* serverconnect;

CIPFilter* ipfilter;

CClientCreditsList* clientcredits;

CSearchList* searchlist;

CKnownFileList* knownfiles;

CMMServer* mmserver;

AppState m_app_state; // defines application state for shutdown

CMutex hashing_mut;

CString m_strCurVersionLong;

CPeerCacheFinder* m_pPeerCache;

CFriendList* friendlist;

CFirewallOpener* m_pFirewallOpener;//hyper added

節點加入網路：

Emule串連Kad網路時，調用函數：Kademlia::CKademlia::Start(); Start()這個函數沒有做什麼實際意義上的事情，主要是new了幾個類：

m_pInstance = new CKademlia();

m_pInstance->m_pPrefs = pPrefs;

m_pInstance->m_pUDPListener = NULL;

m_pInstance->m_pRoutingZone = NULL;

m_pInstance->m_pIndexed = new CIndexed();

m_pInstance->m_pRoutingZone = new CRoutingZone();

m_pInstance->m_pUDPListener = new CKademliaUDPListener();

並且更改了幾個定時器的時間。

接著程式轉入到routingzone.cpp中執行。

在上面那部分的Start ()函數體內部初始化了CRoutingZone這個類，這個類的建構函式CRoutingZone::CRoutingZone()體中調用函數 Init(NULL, 0, CUInt128((ULONG)0));來初始化根節點（應該就是本地節點）。

在void CRoutingZone::Init(CRoutingZone *pSuper_zone, int iLevel, const CUInt128 &uZone_index)函數體內部建立了一個新的m_pBin = new CRoutingBin();接著調用函數StartTime（），用來開始這個地區。在StartTime（）函數內部添加事件CKademlia::AddEvent(this);

在調用完函數StartTime（）函數後，從檔案中讀取以前儲存的連絡人。

在調用完函數Kademlia::CKademlia::Start();之後，Kademlia開始處理，轉入函數Kademlia:: CKademlia::Process()開始執行，在函數void CKademlia::Process()中調用函數pZone->OnSmallTimer();即CRoutingZone中 OnSmallTimer().。

CRoutingZone中OnSmallTimer()，在此函數體內，當判斷連絡人為非空時，調用函數 CKademlia::GetUDPListener()->SendMyDetails_KADEMLIA2(KADEMLIA2_HELLO_REQ, pContact->GetIPAddress(), pContact->GetUDPPort());來發送本地節點的一些資訊，其中函數的第一個參數是訊息的類型， KADEMLIA2_HELLO_REQ表明是Kademlia 2.0網路的加入請求，相當於TCP/IP中的ACK，即表明這個訊息是用來加入網路的。第二個參數是本地節點的IP，第三個節點是本地節點的連接埠。

接著轉入KademliaUDPListener.cpp中函數void CKademliaUDPListener::SendMyDetails_KADEMLIA2(byte byOpcode, uint32 uIP, uint16 uUDPPort)運行，主要是調用函數SendPacket(byPacket, uLen, uIP, uUDPPort);，SendPacket(byPacket, uLen, uIP, uUDPPort);函數在KademliaUDPListener.cpp內部，此函數體內部調用函數theApp.clientudp-> SendPacket(pPacket, ntohl(uDestinationHost), uDestinationPort);來發送包。

ClientUDPSocket.cpp中函數theApp.clientudp->SendPacket(pPacket, ntohl(uDestinationHost), uDestinationPort);體內部將剛才的訊息包（或者叫資料包）加入到controlpacket_queue的隊尾， controlpacket_queue.AddTail(newpending); controlpacket_queue是一個鏈表，類型是CTypedPtrList<CPtrList, UDPPack*> controlpacket_queue;，是通過模板來實現的。接著繼續調用函數theApp.uploadBandwidthThrottler- >QueueForSendingControlPacket(this);此時資料包在鏈表UploadBandwidthThrottler* uploadBandwidthThrottler;中排隊。

類UploadBandwidthThrottler繼承自CWinThread類，主要是作為線程來啟動並執行。類在初始化，在建構函式中調用函數 UINT AFX_CDECL UploadBandwidthThrottler::RunProc(LPVOID pParam)，這個函數調用uploadBandwidthThrottler->RunInternal();，RunInternal()函 數主要用來發送來自socket的資料包，函數體內調用兩個函數：

SocketSentBytes socketSentBytes = socket->SendControlData(allowedDataRate > 0?(UINT)(bytesToSpend - spentBytes):1, minFragSize);

以及

SocketSentBytes socketSentBytes = socket->SendFileAndControlData(neededBytes, minFragSize);

其中的socket類型是ThrottledFileSocket*，在類ThrottledFileSocket中這兩個函數被定義為虛函數，而 且在這個類內部沒有具體實現，它們的實現在類CClientUDPSocket中，類CClientUDPSocket繼承自CAsyncSocket以 及ThrottledControlSocket，如下代碼：

class CClientUDPSocket : public CAsyncSocket, public ThrottledControlSocket // ZZ:UploadBandWithThrottler (UDP)。

socket->SendControlData(allowedDataRate > 0?(UINT)(bytesToSpend - spentBytes):1, minFragSize);

以及

SocketSentBytes socketSentBytes = socket->SendFileAndControlData(neededBytes, minFragSize);的實現體在ClientUDPSocket.cpp中424行：

SocketSentBytes CClientUDPSocket::SendControlData(uint32 maxNumberOfBytesToSend, uint32 /*minFragSize*/){ // ZZ:UploadBandWithThrottler (UDP)

在它們內部調用了函數SendTo，if (!SendTo(sendbuffer, cur_packet->packet->size+2, cur_packet->dwIP, cur_packet->nPort))（在ClientUDPSocket.cpp中440行）。這個函數是類CClientUDPSocket 的成員函數。int CClientUDPSocket::SendTo(char* lpBuf,int nBufLen,uint32 dwIP, uint16 nPort)，在這個函數體內調用類CAsyncSocket的成員函數uint32 result = CAsyncSocket::SendTo(lpBuf,nBufLen,nPort,ipstr(dwIP));，類CAsyncSocket是MFC 的類庫中的一個類。

至此，本地節點加入網路的請求就發送完畢。

下面講述本地節點在接收到來自其他節點的回應後在本地採取的一些措施從而把自己加入到網路內。

當網路事件發生時（即本地網卡接收到資料包），“socket視窗”接收WM_SOCKET_NOTIFY訊息，訊息處理函數OnSocketNotify被調用，。“socket視窗”的定義和訊息處理是MFC實現的，其中OnSocketNotify函數定義如下：

LRESULT CSocketWnd::OnSocketNotify(WPARAM wParam, LPARAM lParam)

{

CSocket::AuxQueueAdd(WM_SOCKET_NOTIFY, wParam, lParam);

CSocket::ProcessAuxQueue();

return 0L;

}

在CSocket::ProcessAuxQueue();函數中回調CAsyncSocket的成員函數DoCallBack，DoCallBack呼叫事件處理函數OnReceive。

int PASCAL CSocket::ProcessAuxQueue()

{

……………………//省略部分

if (pMsg->message == WM_SOCKET_NOTIFY)

{

CAsyncSocket::DoCallBack(pMsg->wParam, pMsg->lParam);

}

………………//省略部分

return nCount;

}

void PASCAL CAsyncSocket::DoCallBack(WPARAM wParam, LPARAM lParam)

{

……………………//省略部分

pSocket->OnReceive(nErrorCode);

/*pSocket類型是：CClientUDPSocket，因為類CClientUDPSocket繼承了類 CAsyncSocket，而OnReceive在CAsyncSocket定義的虛函數，OnReceive在CClientUDPSocket中重新 做了實現，因此調用的時候會轉到CClientUDPSocket中OnReceive執行。*/

}

void CClientUDPSocket::OnReceive(int nErrorCode)

{

……………………

case OP_KADEMLIAHEADER:

{

// theStats.AddDownDataOverheadKad(length);

if (length >= 2)

Kademlia::CKademlia::ProcessPacket(buffer, length, ntohl(sockAddr.sin_addr.S_un.S_addr), ntohs(sockAddr.sin_port));

else

throw CString(_T("Kad packet too short"));

break;

}

……………………

}

接著調用在kademlia.cpp中定義的函數ProcessPacket。

void CKademlia::ProcessPacket(const byte *pbyData, uint32 uLenData, uint32 uIP, uint16 uPort)

{

if( m_pInstance && m_pInstance->m_pUDPListener )

m_pInstance->m_pUDPListener->ProcessPacket( pbyData, uLenData, uIP, uPort);

}

轉入KademliaUDPListener類中ProcessPacket函數運行。

void CKademliaUDPListener::ProcessPacket(const byte* pbyData, uint32 uLenData, uint32 uIP, uint16 uUDPPort)

{

//………………………………省略部分

switch (byOpcode)

{

………………………………//省略部分

case KADEMLIA_RES:

if (thePrefs.GetDebugClientKadUDPLevel() > 0)

DebugRecv("KADEMLIA_RES", uIP, uUDPPort);

Process_KADEMLIA_RES(pbyPacketData, uLenPacket, uIP, uUDPPort);

break;

………………………………//省略部分

}

}

轉入函數Process_KADEMLIA_RES(pbyPacketData, uLenPacket, uIP, uUDPPort);執行：

void CKademliaUDPListener::Process_KADEMLIA_RES (const byte *pbyPacketData, uint32 uLenPacket, uint32 uIP, uint16 uUDPPort)

{

//……………………

if(CKademlia::GetPrefs()->GetRecheckIP())

{

FirewalledCheck(uIP, uUDPPort);

if (thePrefs.GetDebugClientKadUDPLevel() > 0)

DebugSend("KADEMLIA_HELLO_REQ", uIP, uUDPPort);

SendMyDetails(KADEMLIA_HELLO_REQ, uIP, uUDPPort);

}

if(::IsGoodIPPort(ntohl(uIPResult),uUDPPortResult))

{

pRoutingZone->Add(uIDResult, uIPResult, uUDPPortResult, uTCPPortResult, 0);

pResults->push_back(new CContact(uIDResult, uIPResult, uUDPPortResult, uTCPPortResult, uTarget, 0));

}

}

}

CSearchManager::ProcessResponse(uTarget, uIP, uUDPPort, pResults);

}

在這個函數體內部主要包括對4個函數的調用，分別是：

SendMyDetails(KADEMLIA_HELLO_REQ, uIP, uUDPPort);

pRoutingZone->Add(uIDResult, uIPResult, uUDPPortResult, uTCPPortResult, 0);

pResults->push_back(new CContact(uIDResult, uIPResult, uUDPPortResult, uTCPPortResult, uTarget, 0));

CSearchManager::ProcessResponse(uTarget, uIP, uUDPPort, pResults);

其中第一個函數是在判斷自己在防火牆或者NAT之後重新發送本地節點資訊的函數，包括重新得到的IP地址以及連接埠。

第二和第三個函數用來添加此節點作為連絡人之一。

第三個函數是將此訊息轉入到CSearchManager中相應處理響應的函數進行處理。

void CSearchManager::ProcessResponse(const CUInt128 &uTarget, uint32 uFromIP, uint16 uFromPort, ContactList *plistResults)

{

pSearch->ProcessResponse(uFromIP, uFromPort, plistResults);// pSearch是 CSearch類的指標

}

進一步轉入到pSearch->ProcessResponse(uFromIP, uFromPort, plistResults)中執行。

void CSearch::ProcessResponse(uint32 uFromIP, uint16 uFromPort, ContactList *plistResults)

{

// Not interested in responses for FIND_NODE.

// Once we get a results we stop the search.

// These contacts are added to contacts by UDPListener.

if (m_uType == NODE)

{

// Note we got an answer

m_uAnswers++;

// We clear the possible list to force the search to stop.

// We do this so the user has time to visually see the results.

m_mapPossible.clear();

delete plistResults;

// Update search on the GUI.

//IMPREVIEW theApp.emuledlg->kademliawnd->searchList->SearchRef(this);

return;

}

}

在這個函數內部我們將響應的節點數目增加一。

後面陸續接收到的訊息處理流程與上述情形相似，只是對於不同的訊息採取的響應以及動作並不相