2 // This file is part of the aMule Project.
4 // Copyright (c) 2003-2008 aMule Team ( admin@amule.org / http://www.amule.org )
5 // Copyright (c) 2002-2008 Merkur ( devs@emule-project.net / http://www.emule-project.net )
7 // Any parts of this program derived from the xMule, lMule or eMule project,
8 // or contributed by third-party developers are copyrighted by their
11 // This program is free software; you can redistribute it and/or modify
12 // it under the terms of the GNU General Public License as published by
13 // the Free Software Foundation; either version 2 of the License, or
14 // (at your option) any later version.
16 // This program is distributed in the hope that it will be useful,
17 // but WITHOUT ANY WARRANTY; without even the implied warranty of
18 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 // GNU General Public License for more details.
21 // You should have received a copy of the GNU General Public License
22 // along with this program; if not, write to the Free Software
23 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
26 #include "UploadQueue.h" // Interface declarations
28 #include <protocol/Protocols.h>
29 #include <protocol/ed2k/Client2Client/TCP.h>
30 #include <common/Macros.h>
31 #include <common/Constants.h>
35 #include "Types.h" // Do_not_auto_remove (win32)
38 #include <winsock.h> // Do_not_auto_remove
40 #include <sys/types.h> // Do_not_auto_remove
41 #include <netinet/in.h> // Do_not_auto_remove
42 #include <arpa/inet.h> // Do_not_auto_remove
45 #include "ServerConnect.h" // Needed for CServerConnect
46 #include "KnownFile.h" // Needed for CKnownFile
47 #include "Packet.h" // Needed for CPacket
48 #include "ClientTCPSocket.h" // Needed for CClientTCPSocket
49 #include "SharedFileList.h" // Needed for CSharedFileList
50 #include "updownclient.h" // Needed for CUpDownClient
51 #include "amule.h" // Needed for theApp
52 #include "Preferences.h"
53 #include "ClientList.h"
54 #include "Statistics.h" // Needed for theStats
56 #include <common/Format.h>
57 #include "UploadBandwidthThrottler.h"
58 #include "GuiEvents.h" // Needed for Notify_*
61 //TODO rewrite the whole networkcode, use overlapped sockets
63 CUploadQueue::CUploadQueue()
65 m_nLastStartUpload
= 0;
66 lastupslotHighID
= true;
67 m_allowKicking
= true;
71 void CUploadQueue::AddUpNextClient(CUpDownClient
* directadd
)
73 CClientPtrList::iterator toadd
= m_waitinglist
.end();
74 CClientPtrList::iterator toaddlow
= m_waitinglist
.end();
76 uint32_t bestscore
= 0;
77 uint32_t bestlowscore
= 0;
79 CUpDownClient
* newclient
;
80 // select next client or use given client
82 // Track if we purged any clients from the queue, as to only send one notify in total
85 CClientPtrList::iterator it
= m_waitinglist
.begin();
86 for (; it
!= m_waitinglist
.end(); ) {
87 CClientPtrList::iterator tmp_it
= it
++;
88 CUpDownClient
* cur_client
= *tmp_it
;
91 if ( (::GetTickCount() - cur_client
->GetLastUpRequest() > MAX_PURGEQUEUETIME
) || !theApp
->sharedfiles
->GetFileByID(cur_client
->GetUploadFileID()) ) {
93 cur_client
->ClearWaitStartTime();
94 RemoveFromWaitingQueue(tmp_it
);
95 if (!cur_client
->GetSocket()) {
96 if(cur_client
->Disconnected(wxT("AddUpNextClient - purged"))) {
97 cur_client
->Safe_Delete();
104 suspendlist::iterator it2
= std::find( suspended_uploads_list
.begin(),
105 suspended_uploads_list
.end(),
106 cur_client
->GetUploadFileID() );
107 if (cur_client
->IsBanned() || it2
!= suspended_uploads_list
.end() ) { // Banned client or suspended upload ?
112 uint32_t cur_score
= cur_client
->GetScore(true);
113 if (cur_score
> bestscore
) {
114 bestscore
= cur_score
;
117 cur_score
= cur_client
->GetScore(false);
118 if ((cur_score
> bestlowscore
) && !cur_client
->m_bAddNextConnect
){
119 bestlowscore
= cur_score
;
125 // Update the count on GUI if any clients were purged
127 Notify_ShowQueueCount(m_waitinglist
.size());
130 if (bestlowscore
> bestscore
){
131 newclient
= *toaddlow
;
132 newclient
->m_bAddNextConnect
= true;
135 if (toadd
== m_waitinglist
.end()) {
140 lastupslotHighID
= true; // VQB LowID alternate
141 RemoveFromWaitingQueue(toadd
);
142 Notify_ShowQueueCount(m_waitinglist
.size());
144 //prevent another potential access of a suspended upload
146 suspendlist::iterator it
= std::find( suspended_uploads_list
.begin(),
147 suspended_uploads_list
.end(),
148 directadd
->GetUploadFileID() );
149 if ( it
!= suspended_uploads_list
.end() ) {
152 newclient
= directadd
;
156 if (IsDownloading(newclient
)) {
159 // tell the client that we are now ready to upload
160 if (!newclient
->IsConnected()) {
161 newclient
->SetUploadState(US_CONNECTING
);
162 if (!newclient
->TryToConnect(true)) {
166 CPacket
* packet
= new CPacket(OP_ACCEPTUPLOADREQ
, 0, OP_EDONKEYPROT
);
167 theStats::AddUpOverheadFileRequest(packet
->GetPacketSize());
168 AddDebugLogLineM( false, logLocalClient
, wxT("Local Client: OP_ACCEPTUPLOADREQ to ") + newclient
->GetFullIP() );
169 newclient
->SendPacket(packet
,true);
170 newclient
->SetUploadState(US_UPLOADING
);
172 newclient
->SetUpStartTime();
173 newclient
->ResetSessionUp();
175 theApp
->uploadBandwidthThrottler
->AddToStandardList(m_uploadinglist
.size(), newclient
->GetSocket());
176 m_uploadinglist
.push_back(newclient
);
177 theStats::AddUploadingClient();
180 CKnownFile
* reqfile
= (CKnownFile
*) newclient
->GetUploadFile();
182 reqfile
->statistic
.AddAccepted();
184 Notify_UploadCtrlAddClient(newclient
);
187 void CUploadQueue::Process()
189 // Check if someone's waiting, if there is a slot for him,
190 // or if we should try to free a slot for him
191 uint32 tick
= GetTickCount();
192 // Nobody waiting or upload started recently
193 // (Actually instead of "empty" it should check for "no HighID clients queued",
194 // but the cost for that outweights the benefit. As it is, a slot will be freed
195 // even if it can't be taken because all of the queue is LowID. But just one,
196 // and the kicked client will instantly get it back if he has HighID.)
197 if (m_waitinglist
.empty() || tick
- m_nLastStartUpload
< 1000) {
198 m_allowKicking
= false;
199 // Already a slot free, try to fill it
200 } else if (m_uploadinglist
.size() < GetMaxSlots()) {
201 m_allowKicking
= false;
202 m_nLastStartUpload
= tick
;
204 // All slots taken, try to free one
206 m_allowKicking
= true;
209 // The loop that feeds the upload slots with data.
210 CClientPtrList::iterator it
= m_uploadinglist
.begin();
211 while (it
!= m_uploadinglist
.end()) {
212 // Get the client. Note! Also updates pos as a side effect.
213 CUpDownClient
* cur_client
= *it
++;
215 // It seems chatting or friend slots can get stuck at times in upload.. This needs looked into..
216 if (!cur_client
->GetSocket()) {
217 RemoveFromUploadQueue(cur_client
, true);
218 if(cur_client
->Disconnected(_T("CUploadQueue::Process"))){
219 cur_client
->Safe_Delete();
222 cur_client
->SendBlockData();
226 // Save used bandwidth for speed calculations
227 uint64 sentBytes
= theApp
->uploadBandwidthThrottler
->GetNumberOfSentBytesSinceLastCallAndReset();
228 (void)theApp
->uploadBandwidthThrottler
->GetNumberOfSentBytesOverheadSinceLastCallAndReset();
232 theStats::AddSentBytes(sentBytes
);
237 uint16
CUploadQueue::GetMaxSlots() const
239 uint16 nMaxSlots
= 0;
240 float kBpsUpPerClient
= (float)thePrefs::GetSlotAllocation();
241 if (thePrefs::GetMaxUpload() == UNLIMITED
) {
242 float kBpsUp
= theStats::GetUploadRate() / 1024.0f
;
243 nMaxSlots
= (uint16
)(kBpsUp
/ kBpsUpPerClient
) + 2;
245 if (thePrefs::GetMaxUpload() >= 10) {
246 nMaxSlots
= (uint16
)floor((float)thePrefs::GetMaxUpload() / kBpsUpPerClient
+ 0.5);
247 // floor(x + 0.5) is a way of doing round(x) that works with gcc < 3 ...
248 if (nMaxSlots
< MIN_UP_CLIENTS_ALLOWED
) {
249 nMaxSlots
=MIN_UP_CLIENTS_ALLOWED
;
252 nMaxSlots
= MIN_UP_CLIENTS_ALLOWED
;
255 if (nMaxSlots
> MAX_UP_CLIENTS_ALLOWED
) {
256 nMaxSlots
= MAX_UP_CLIENTS_ALLOWED
;
262 CUploadQueue::~CUploadQueue()
264 wxASSERT(m_waitinglist
.empty());
265 wxASSERT(m_uploadinglist
.empty());
269 bool CUploadQueue::IsOnUploadQueue(const CUpDownClient
* client
) const
271 return std::find(m_waitinglist
.begin(), m_waitinglist
.end(), client
)
272 != m_waitinglist
.end();
276 bool CUploadQueue::IsDownloading(CUpDownClient
* client
) const
278 return std::find(m_uploadinglist
.begin(), m_uploadinglist
.end(), client
)
279 != m_uploadinglist
.end();
283 CUpDownClient
* CUploadQueue::GetWaitingClientByIP_UDP(uint32 dwIP
, uint16 nUDPPort
, bool bIgnorePortOnUniqueIP
, bool* pbMultipleIPs
)
285 CUpDownClient
* pMatchingIPClient
= NULL
;
289 CClientPtrList::iterator it
= m_waitinglist
.begin();
290 for (; it
!= m_waitinglist
.end(); ++it
) {
291 CUpDownClient
* cur_client
= *it
;
293 if ((dwIP
== cur_client
->GetIP()) && (nUDPPort
== cur_client
->GetUDPPort())) {
295 } else if ((dwIP
== cur_client
->GetIP()) && bIgnorePortOnUniqueIP
) {
296 pMatchingIPClient
= cur_client
;
302 *pbMultipleIPs
= cMatches
> 1;
305 if (pMatchingIPClient
&& cMatches
== 1) {
306 return pMatchingIPClient
;
313 void CUploadQueue::AddClientToQueue(CUpDownClient
* client
)
315 if (theApp
->serverconnect
->IsConnected() && theApp
->serverconnect
->IsLowID() && !theApp
->serverconnect
->IsLocalServer(client
->GetServerIP(),client
->GetServerPort()) && client
->GetDownloadState() == DS_NONE
&& !client
->IsFriend() && theStats::GetWaitingUserCount() > 50) {
316 // Well, all that issues finish in the same: don't allow to add to the queue
320 if ( client
->IsBanned() ) {
324 client
->AddAskedCount();
325 client
->SetLastUpRequest();
327 // Find all clients with the same user-hash
328 CClientList::SourceList found
= theApp
->clientlist
->GetClientsByHash( client
->GetUserHash() );
330 CClientList::SourceList::iterator it
= found
.begin();
331 while (it
!= found
.end()) {
332 CUpDownClient
* cur_client
= *it
++;
334 if ( IsOnUploadQueue( cur_client
) ) {
335 if ( cur_client
== client
) {
336 if ( client
->m_bAddNextConnect
&& ( ( m_uploadinglist
.size() < thePrefs::GetMaxUpload() ) || ( thePrefs::GetMaxUpload() == UNLIMITED
) ) ) {
337 if (lastupslotHighID
) {
338 client
->m_bAddNextConnect
= false;
339 RemoveFromWaitingQueue(client
, true);
340 AddUpNextClient(client
);
341 lastupslotHighID
= false; // LowID alternate
346 client
->SendRankingInfo();
347 Notify_QlistRefreshClient(client
);
351 // Hash-clash, remove unidentified clients (possibly both)
353 if ( !cur_client
->IsIdentified() ) {
354 // Cur_client isn't identifed, remove it
355 theApp
->clientlist
->AddTrackClient( cur_client
);
357 RemoveFromWaitingQueue( cur_client
);
358 if ( !cur_client
->GetSocket() ) {
359 if (cur_client
->Disconnected( wxT("AddClientToQueue - same userhash") ) ) {
360 cur_client
->Safe_Delete();
365 if ( !client
->IsIdentified() ) {
366 // New client isn't identified, remove it
367 theApp
->clientlist
->AddTrackClient( client
);
369 if ( !client
->GetSocket() ) {
370 if ( client
->Disconnected( wxT("AddClientToQueue - same userhash") ) ) {
371 client
->Safe_Delete();
381 // Count the number of clients with the same IP-address
382 found
= theApp
->clientlist
->GetClientsByIP( client
->GetIP() );
385 for ( it
= found
.begin(); it
!= found
.end(); it
++ ) {
386 if ( ( *it
== client
) || IsOnUploadQueue( *it
) ) {
391 // We do not accept more than 3 clients from the same IP
394 } else if ( theApp
->clientlist
->GetClientsFromIP(client
->GetIP()) >= 3 ) {
399 CKnownFile
* reqfile
= (CKnownFile
*) client
->GetUploadFile();
401 reqfile
->statistic
.AddRequest();
404 // TODO find better ways to cap the list
405 if (m_waitinglist
.size() >= (thePrefs::GetQueueSize())) {
409 if (client
->IsDownloading()) {
410 // he's already downloading and wants probably only another file
411 CPacket
* packet
= new CPacket(OP_ACCEPTUPLOADREQ
, 0, OP_EDONKEYPROT
);
412 theStats::AddUpOverheadFileRequest(packet
->GetPacketSize());
413 AddDebugLogLineM( false, logLocalClient
, wxT("Local Client: OP_ACCEPTUPLOADREQ to ") + client
->GetFullIP() );
414 client
->SendPacket(packet
,true);
418 uint32 tick
= GetTickCount();
419 // if possible start upload right away
420 if (m_waitinglist
.empty() && tick
- m_nLastStartUpload
>= 1000 && m_uploadinglist
.size() < GetMaxSlots()) {
421 AddUpNextClient(client
);
422 m_nLastStartUpload
= tick
;
424 m_waitinglist
.push_back(client
);
425 theStats::AddWaitingClient();
426 client
->ClearWaitStartTime();
427 client
->ClearAskedCount();
428 client
->SetUploadState(US_ONUPLOADQUEUE
);
429 client
->SendRankingInfo();
430 Notify_QlistAddClient(client
);
431 Notify_ShowQueueCount(m_waitinglist
.size());
436 bool CUploadQueue::RemoveFromUploadQueue(CUpDownClient
* client
, bool updatewindow
)
438 // Keep track of this client
439 theApp
->clientlist
->AddTrackClient(client
);
441 CClientPtrList::iterator it
= std::find(m_uploadinglist
.begin(),
442 m_uploadinglist
.end(), client
);
444 if (it
!= m_uploadinglist
.end()) {
446 Notify_UploadCtrlRemoveClient(client
);
448 m_uploadinglist
.erase(it
);
449 theStats::RemoveUploadingClient();
450 if( client
->GetTransferredUp() ) {
451 theStats::AddSuccessfulUpload();
452 theStats::AddUploadTime(client
->GetUpStartTimeDelay() / 1000);
454 theStats::AddFailedUpload();
456 client
->SetUploadState(US_NONE
);
457 client
->ClearUploadBlockRequests();
465 bool CUploadQueue::CheckForTimeOver(CUpDownClient
* client
)
467 // Don't kick anybody if there's no need to
468 if (!m_allowKicking
) {
471 // First, check if it is a VIP slot (friend or Release-Prio).
472 if (client
->GetFriendSlot()) {
473 return false; // never drop the friend
475 // Release-Prio and nobody on queue for it?
476 if (client
->GetUploadFile()->GetUpPriority() == PR_POWERSHARE
) {
477 // Keep it unless half of the UL slots are occupied with friends or Release uploads.
479 for (CClientPtrList::iterator it
= m_uploadinglist
.begin(); it
!= m_uploadinglist
.end(); ++it
) {
480 CUpDownClient
* cur_client
= *it
;
481 if (cur_client
->GetFriendSlot() || cur_client
->GetUploadFile()->GetUpPriority() == PR_POWERSHARE
) {
485 // allow if VIP uploads occupy at most half of the possible upload slots
486 if (vips
<= GetMaxSlots() / 2) {
489 // Otherwise normal rules apply.
493 bool kickHim
= false;
495 if (thePrefs::TransferFullChunks()) {
496 // "Transfer full chunks": drop client after 10 MB upload, or after an hour.
497 // (so average UL speed should at least be 2.84 kB/s)
498 // We don't track what he is downloading, but if it's all from one chunk he gets it.
499 if (client
->GetUpStartTimeDelay() > 3600000 // time: 1h
500 || client
->GetSessionUp() > 10485760) { // data: 10MB
504 uint32 clientScore
= client
->GetScore(true,true);
505 CClientPtrList::iterator it
= m_waitinglist
.begin();
506 for (; it
!= m_waitinglist
.end(); ++it
) {
507 if (clientScore
< (*it
)->GetScore(true,false)) {
515 m_allowKicking
= false; // kick max one client per cycle
522 uint16
CUploadQueue::GetWaitingPosition(const CUpDownClient
*client
) const
524 if ( !IsOnUploadQueue(client
) ) {
529 const uint32 myscore
= client
->GetScore(false);
530 CClientPtrList::const_iterator it
= m_waitinglist
.begin();
531 for (; it
!= m_waitinglist
.end(); ++it
) {
532 if ((*it
)->GetScore(false) > myscore
) {
542 * This function removes a file indicated by filehash from suspended_uploads_list.
544 void CUploadQueue::ResumeUpload( const CMD4Hash
& filehash
)
546 //Find the position of the filehash in the list and remove it.
547 suspendlist::iterator it
= std::find( suspended_uploads_list
.begin(),
548 suspended_uploads_list
.end(),
550 if ( it
!= suspended_uploads_list
.end() )
551 suspended_uploads_list
.erase( it
);
553 AddLogLineM( false, CFormat( _("Resuming uploads of file: %s" ) )
554 % filehash
.Encode() );
558 * This function adds a file indicated by filehash to suspended_uploads_list
560 void CUploadQueue::SuspendUpload( const CMD4Hash
& filehash
)
562 AddLogLineM( false, CFormat( _("Suspending upload of file: %s" ) )
563 % filehash
.Encode() );
565 //Append the filehash to the list.
566 suspended_uploads_list
.push_back(filehash
);
567 wxString base16hash
= filehash
.Encode();
569 CClientPtrList::iterator it
= m_uploadinglist
.begin();
570 while (it
!= m_uploadinglist
.end()) {
571 CUpDownClient
*potential
= *it
++;
572 //check if the client is uploading the file we need to suspend
573 if(potential
->GetUploadFileID() == filehash
) {
574 //remove the unlucky client from the upload queue and add to the waiting queue
575 RemoveFromUploadQueue(potential
, true);
577 m_waitinglist
.push_back(potential
);
578 theStats::AddWaitingClient();
579 potential
->SetUploadState(US_ONUPLOADQUEUE
);
580 potential
->SendRankingInfo();
581 Notify_QlistRefreshClient(potential
);
582 Notify_ShowQueueCount(m_waitinglist
.size());
587 bool CUploadQueue::RemoveFromWaitingQueue(CUpDownClient
* client
, bool updatewindow
)
589 CClientPtrList::iterator it
= std::find(m_waitinglist
.begin(),
590 m_waitinglist
.end(), client
);
592 if (it
!= m_waitinglist
.end()) {
593 RemoveFromWaitingQueue(it
);
595 Notify_ShowQueueCount(m_waitinglist
.size());
604 void CUploadQueue::RemoveFromWaitingQueue(CClientPtrList::iterator pos
)
606 CUpDownClient
* todelete
= *pos
;
607 m_waitinglist
.erase(pos
);
608 theStats::RemoveWaitingClient();
609 if( todelete
->IsBanned() ) {
612 Notify_QlistRemoveClient(todelete
);
613 todelete
->SetUploadState(US_NONE
);
616 // File_checked_for_headers