summaryrefslogtreecommitdiffstats
path: root/src/OSSupport/SocketThreads.cpp
blob: 269f1d452869e5db51683899b41d71af8b6cb83b (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688

// cSocketThreads.cpp

// Implements the cSocketThreads class representing the heart of MCS's client networking.
// This object takes care of network communication, groups sockets into threads and uses as little threads as possible for full read / write support
// For more detail, see http://forum.mc-server.org/showthread.php?tid=327

#include "Globals.h"
#include "SocketThreads.h"
#include "Errors.h"





///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// cSocketThreads:

cSocketThreads::cSocketThreads(void)
{
}





cSocketThreads::~cSocketThreads()
{
	for (cSocketThreadList::iterator itr = m_Threads.begin(); itr != m_Threads.end(); ++itr)
	{
		delete *itr;
	}  // for itr - m_Threads[]
	m_Threads.clear();
}






bool cSocketThreads::AddClient(const cSocket & a_Socket, cCallback * a_Client)
{
	// Add a (socket, client) pair for processing, data from a_Socket is to be sent to a_Client
	
	// Try to add to existing threads:
	cCSLock Lock(m_CS);
	for (cSocketThreadList::iterator itr = m_Threads.begin(); itr != m_Threads.end(); ++itr)
	{
		if ((*itr)->IsValid() && (*itr)->HasEmptySlot())
		{
			(*itr)->AddClient(a_Socket, a_Client);
			return true;
		}
	}
	
	// No thread has free space, create a new one:
	LOGD("Creating a new cSocketThread (currently have %d)", m_Threads.size());
	cSocketThread * Thread = new cSocketThread(this);
	if (!Thread->Start())
	{
		// There was an error launching the thread (but it was already logged along with the reason)
		LOGERROR("A new cSocketThread failed to start");
		delete Thread;
		return false;
	}
	Thread->AddClient(a_Socket, a_Client);
	m_Threads.push_back(Thread);
	return true;
}





void cSocketThreads::RemoveClient(const cCallback * a_Client)
{
	// Remove the associated socket and the client from processing

	cCSLock Lock(m_CS);
	for (cSocketThreadList::iterator itr = m_Threads.begin(); itr != m_Threads.end(); ++itr)
	{
		if ((*itr)->RemoveClient(a_Client))
		{
			return;
		}
	}  // for itr - m_Threads[]

	ASSERT(!"Removing an unknown client");
}





void cSocketThreads::NotifyWrite(const cCallback * a_Client)
{
	// Notifies the thread responsible for a_Client that the client has something to write

	cCSLock Lock(m_CS);
	for (cSocketThreadList::iterator itr = m_Threads.begin(); itr != m_Threads.end(); ++itr)
	{
		if ((*itr)->NotifyWrite(a_Client))
		{
			return;
		}
	}  // for itr - m_Threads[]
	
	// Cannot assert - this normally happens if a client disconnects and has pending packets, the cServer::cNotifyWriteThread will call this on invalid clients too
	// ASSERT(!"Notifying write to an unknown client");
}





void cSocketThreads::Write(const cCallback * a_Client, const AString & a_Data)
{
	// Puts a_Data into outgoing data queue for a_Client
	cCSLock Lock(m_CS);
	for (cSocketThreadList::iterator itr = m_Threads.begin(); itr != m_Threads.end(); ++itr)
	{
		if ((*itr)->Write(a_Client, a_Data))
		{
			return;
		}
	}  // for itr - m_Threads[]
	
	// This may be perfectly legal, if the socket has been destroyed and the client is finishing up
	// ASSERT(!"Writing to an unknown socket");
}





////////////////////////////////////////////////////////////////////////////////
// cSocketThreads::cSocketThread:

cSocketThreads::cSocketThread::cSocketThread(cSocketThreads * a_Parent) :
	cIsThread("cSocketThread"),
	m_Parent(a_Parent),
	m_NumSlots(0)
{
	// Nothing needed yet
}





cSocketThreads::cSocketThread::~cSocketThread()
{
	m_ShouldTerminate = true;

	// Notify the thread:
	ASSERT(m_ControlSocket2.IsValid());
	m_ControlSocket2.Send("a", 1);

	// Wait for the thread to finish:
	Wait();
	
	// Close the control sockets:
	m_ControlSocket1.CloseSocket();
	m_ControlSocket2.CloseSocket();
}





void cSocketThreads::cSocketThread::AddClient(const cSocket & a_Socket, cCallback * a_Client)
{
	ASSERT(m_Parent->m_CS.IsLockedByCurrentThread());
	ASSERT(m_NumSlots < MAX_SLOTS);  // Use HasEmptySlot() to check before adding
	
	m_Slots[m_NumSlots].m_Client = a_Client;
	m_Slots[m_NumSlots].m_Socket = a_Socket;
	m_Slots[m_NumSlots].m_Socket.SetNonBlocking();
	m_Slots[m_NumSlots].m_Outgoing.clear();
	m_Slots[m_NumSlots].m_State = sSlot::ssNormal;
	m_NumSlots++;
	
	// Notify the thread of the change:
	ASSERT(m_ControlSocket2.IsValid());
	m_ControlSocket2.Send("a", 1);
}





bool cSocketThreads::cSocketThread::RemoveClient(const cCallback * a_Client)
{
	ASSERT(m_Parent->m_CS.IsLockedByCurrentThread());
	
	if (m_NumSlots == 0)
	{
		return false;
	}
	
	for (int i = m_NumSlots - 1; i >= 0 ; --i)
	{
		if (m_Slots[i].m_Client != a_Client)
		{
			continue;
		}
		
		// Found the slot:
		if (m_Slots[i].m_State == sSlot::ssRemoteClosed)
		{
			// The remote has already closed the socket, remove the slot altogether:
			m_Slots[i] = m_Slots[--m_NumSlots];
		}
		else
		{
			// Query and queue the last batch of outgoing data:
			AString Data;
			m_Slots[i].m_Client->GetOutgoingData(Data);
			m_Slots[i].m_Outgoing.append(Data);
			if (m_Slots[i].m_Outgoing.empty())
			{
				// No more outgoing data, shut the socket down immediately:
				m_Slots[i].m_Socket.ShutdownReadWrite();
				m_Slots[i].m_State = sSlot::ssShuttingDown;
			}
			else
			{
				// More data to send, shut down reading and wait for the rest to get sent:
				m_Slots[i].m_State = sSlot::ssWritingRestOut;
			}
			m_Slots[i].m_Client = NULL;
		}
		
		// Notify the thread of the change:
		ASSERT(m_ControlSocket2.IsValid());
		m_ControlSocket2.Send("r", 1);
		return true;
	}  // for i - m_Slots[]
	
	// Not found
	return false;
}





bool cSocketThreads::cSocketThread::HasClient(const cCallback * a_Client) const
{
	ASSERT(m_Parent->m_CS.IsLockedByCurrentThread());

	for (int i = m_NumSlots - 1; i >= 0; --i)
	{
		if (m_Slots[i].m_Client == a_Client)
		{
			return true;
		}
	}  // for i - m_Slots[]
	return false;
}





bool cSocketThreads::cSocketThread::HasSocket(const cSocket * a_Socket) const
{
	for (int i = m_NumSlots - 1; i >= 0; --i)
	{
		if (m_Slots[i].m_Socket == *a_Socket)
		{
			return true;
		}
	}  // for i - m_Slots[]
	return false;
}





bool cSocketThreads::cSocketThread::NotifyWrite(const cCallback * a_Client)
{
	ASSERT(m_Parent->m_CS.IsLockedByCurrentThread());

	if (HasClient(a_Client))
	{
		// Notify the thread that there's another packet in the queue:
		ASSERT(m_ControlSocket2.IsValid());
		m_ControlSocket2.Send("q", 1);
		return true;
	}
	return false;
}





bool cSocketThreads::cSocketThread::Write(const cCallback * a_Client, const AString & a_Data)
{
	ASSERT(m_Parent->m_CS.IsLockedByCurrentThread());
	for (int i = m_NumSlots - 1; i >= 0; --i)
	{
		if (m_Slots[i].m_Client == a_Client)
		{
			m_Slots[i].m_Outgoing.append(a_Data);
			
			// Notify the thread that there's data in the queue:
			ASSERT(m_ControlSocket2.IsValid());
			m_ControlSocket2.Send("q", 1);
			
			return true;
		}
	}  // for i - m_Slots[]
	return false;
}





bool cSocketThreads::cSocketThread::Start(void)
{
	// Create the control socket listener
	m_ControlSocket2 = cSocket::CreateSocket(cSocket::IPv4);
	if (!m_ControlSocket2.IsValid())
	{
		LOGERROR("Cannot create a Control socket for a cSocketThread (\"%s\"); continuing, but server may be unreachable from now on.", cSocket::GetLastErrorString().c_str());
		return false;
	}
	if (!m_ControlSocket2.BindToLocalhostIPv4(cSocket::ANY_PORT))
	{
		LOGERROR("Cannot bind a Control socket for a cSocketThread (\"%s\"); continuing, but server may be unreachable from now on.", cSocket::GetLastErrorString().c_str());
		m_ControlSocket2.CloseSocket();
		return false;
	}
	if (!m_ControlSocket2.Listen(1))
	{
		LOGERROR("Cannot listen on a Control socket for a cSocketThread (\"%s\"); continuing, but server may be unreachable from now on.", cSocket::GetLastErrorString().c_str());
		m_ControlSocket2.CloseSocket();
		return false;
	}
	if (m_ControlSocket2.GetPort() == 0)
	{
		LOGERROR("Cannot determine Control socket port (\"%s\"); conitnuing, but the server may be unreachable from now on.", cSocket::GetLastErrorString().c_str());
		m_ControlSocket2.CloseSocket();
		return false;
	}

	// Start the thread
	if (!super::Start())
	{
		LOGERROR("Cannot start new cSocketThread");
		m_ControlSocket2.CloseSocket();
		return false;
	}
	
	// Finish connecting the control socket by accepting connection from the thread's socket
	cSocket tmp = m_ControlSocket2.AcceptIPv4();
	if (!tmp.IsValid())
	{
		LOGERROR("Cannot link Control sockets for a cSocketThread (\"%s\"); continuing, but server may be unreachable from now on.", cSocket::GetLastErrorString().c_str());
		m_ControlSocket2.CloseSocket();
		return false;
	}
	m_ControlSocket2.CloseSocket();
	m_ControlSocket2 = tmp;
	
	return true;
}





void cSocketThreads::cSocketThread::Execute(void)
{
	// Connect the "client" part of the Control socket:
	m_ControlSocket1 = cSocket::CreateSocket(cSocket::IPv4);
	ASSERT(m_ControlSocket2.GetPort() != 0);  // We checked in the Start() method, but let's be sure
	if (!m_ControlSocket1.ConnectToLocalhostIPv4(m_ControlSocket2.GetPort()))
	{
		LOGERROR("Cannot connect Control sockets for a cSocketThread (\"%s\"); continuing, but the server may be unreachable from now on.", cSocket::GetLastErrorString().c_str());
		m_ControlSocket2.CloseSocket();
		return;
	}
	
	// The main thread loop:
	while (!m_ShouldTerminate)
	{
		// Read outgoing data from the clients:
		QueueOutgoingData();
		
		// Put sockets into the sets
		fd_set fdRead;
		fd_set fdWrite;
		cSocket::xSocket Highest = m_ControlSocket1.GetSocket();
		PrepareSets(&fdRead, &fdWrite, Highest);
		
		// Wait for the sockets:
		timeval Timeout;
		Timeout.tv_sec = 5;
		Timeout.tv_usec = 0;
		if (select(Highest + 1, &fdRead, &fdWrite, NULL, &Timeout) == -1)
		{
			LOG("select() call failed in cSocketThread: \"%s\"", cSocket::GetLastErrorString().c_str());
			continue;
		}
		
		// Perform the IO:
		ReadFromSockets(&fdRead);
		WriteToSockets(&fdWrite);
		CleanUpShutSockets();
	}  // while (!mShouldTerminate)
}





void cSocketThreads::cSocketThread::PrepareSets(fd_set * a_Read, fd_set * a_Write, cSocket::xSocket & a_Highest)
{
	FD_ZERO(a_Read);
	FD_ZERO(a_Write);
	FD_SET(m_ControlSocket1.GetSocket(), a_Read);

	cCSLock Lock(m_Parent->m_CS);
	for (int i = m_NumSlots - 1; i >= 0; --i)
	{
		if (!m_Slots[i].m_Socket.IsValid())
		{
			continue;
		}
		if (m_Slots[i].m_State == sSlot::ssRemoteClosed)
		{
			// This socket won't provide nor consume any data anymore, don't put it in the Set
			continue;
		}
		cSocket::xSocket s = m_Slots[i].m_Socket.GetSocket();
		FD_SET(s, a_Read);
		if (s > a_Highest)
		{
			a_Highest = s;
		}
		if (!m_Slots[i].m_Outgoing.empty())
		{
			// There's outgoing data for the socket, put it in the Write set
			FD_SET(s, a_Write);
		}
	}  // for i - m_Slots[]
}





void cSocketThreads::cSocketThread::ReadFromSockets(fd_set * a_Read)
{
	// Read on available sockets:

	// Reset Control socket state:
	if (FD_ISSET(m_ControlSocket1.GetSocket(), a_Read))
	{
		char Dummy[128];
		m_ControlSocket1.Receive(Dummy, sizeof(Dummy), 0);
	}

	// Read from clients:
	cCSLock Lock(m_Parent->m_CS);
	for (int i = m_NumSlots - 1; i >= 0; --i)
	{
		cSocket::xSocket Socket = m_Slots[i].m_Socket.GetSocket();
		if (!cSocket::IsValidSocket(Socket) || !FD_ISSET(Socket, a_Read))
		{
			continue;
		}
		char Buffer[1024];
		int Received = m_Slots[i].m_Socket.Receive(Buffer, ARRAYCOUNT(Buffer), 0);
		if (Received <= 0)
		{
			if (cSocket::GetLastError() != cSocket::ErrWouldBlock)
			{
				// The socket has been closed by the remote party
				switch (m_Slots[i].m_State)
				{
					case sSlot::ssNormal:
					{
						// Notify the callback that the remote has closed the socket; keep the slot
						m_Slots[i].m_Client->SocketClosed();
						m_Slots[i].m_State = sSlot::ssRemoteClosed;
						break;
					}
					case sSlot::ssWritingRestOut:
					case sSlot::ssShuttingDown:
					case sSlot::ssShuttingDown2:
					{
						// Force-close the socket and remove the slot:
						m_Slots[i].m_Socket.CloseSocket();
						m_Slots[i] = m_Slots[--m_NumSlots];
						break;
					}
					default:
					{
						LOG("%s: Unexpected socket state: %d (%s)",
							__FUNCTION__, m_Slots[i].m_Socket.GetSocket(), m_Slots[i].m_Socket.GetIPString().c_str()
						);
						ASSERT(!"Unexpected socket state");
						break;
					}
				}  // switch (m_Slots[i].m_State)
			}
		}
		else
		{
			if (m_Slots[i].m_Client != NULL)
			{
				m_Slots[i].m_Client->DataReceived(Buffer, Received);
			}
		}
	}  // for i - m_Slots[]
}





void cSocketThreads::cSocketThread::WriteToSockets(fd_set * a_Write)
{
	// Write to available client sockets:
	cCSLock Lock(m_Parent->m_CS);
	for (int i = m_NumSlots - 1; i >= 0; --i)
	{
		cSocket::xSocket Socket = m_Slots[i].m_Socket.GetSocket();
		if (!cSocket::IsValidSocket(Socket) || !FD_ISSET(Socket, a_Write))
		{
			continue;
		}
		if (m_Slots[i].m_Outgoing.empty())
		{
			// Request another chunk of outgoing data:
			if (m_Slots[i].m_Client != NULL)
			{
				AString Data;
				m_Slots[i].m_Client->GetOutgoingData(Data);
				m_Slots[i].m_Outgoing.append(Data);
			}
			if (m_Slots[i].m_Outgoing.empty())
			{
				// No outgoing data is ready
				if (m_Slots[i].m_State == sSlot::ssWritingRestOut)
				{
					m_Slots[i].m_State = sSlot::ssShuttingDown;
					m_Slots[i].m_Socket.ShutdownReadWrite();
				}
				continue;
			}
		}  // if (outgoing data is empty)
		
		if (m_Slots[i].m_State == sSlot::ssRemoteClosed)
		{
			continue;
		}
		
		if (!SendDataThroughSocket(m_Slots[i].m_Socket, m_Slots[i].m_Outgoing))
		{
			int Err = cSocket::GetLastError();
			LOGWARNING("Error %d while writing to client \"%s\", disconnecting. \"%s\"", Err, m_Slots[i].m_Socket.GetIPString().c_str(), GetOSErrorString(Err).c_str());
			m_Slots[i].m_Socket.CloseSocket();
			if (m_Slots[i].m_Client != NULL)
			{
				m_Slots[i].m_Client->SocketClosed();
			}
			continue;
		}
		
		if (m_Slots[i].m_Outgoing.empty() && (m_Slots[i].m_State == sSlot::ssWritingRestOut))
		{
			m_Slots[i].m_State = sSlot::ssShuttingDown;
			m_Slots[i].m_Socket.ShutdownReadWrite();
		}

		// _X: If there's data left, it means the client is not reading fast enough, the server would unnecessarily spin in the main loop with zero actions taken; so signalling is disabled
		// This means that if there's data left, it will be sent only when there's incoming data or someone queues another packet (for any socket handled by this thread)
		/*
		// If there's any data left, signalize the Control socket:
		if (!m_Slots[i].m_Outgoing.empty())
		{
			ASSERT(m_ControlSocket2.IsValid());
			m_ControlSocket2.Send("q", 1);
		}
		*/
	}  // for i - m_Slots[i]
}





bool cSocketThreads::cSocketThread::SendDataThroughSocket(cSocket & a_Socket, AString & a_Data)
{
	// Send data in smaller chunks, so that the OS send buffers aren't overflown easily
	while (!a_Data.empty())
	{
		size_t NumToSend = std::min(a_Data.size(), (size_t)1024);
		int Sent = a_Socket.Send(a_Data.data(), NumToSend);
		if (Sent < 0)
		{
			int Err = cSocket::GetLastError();
			if (Err == cSocket::ErrWouldBlock)
			{
				// The OS send buffer is full, leave the outgoing data for the next time
				return true;
			}
			// An error has occured
			return false;
		}
		if (Sent == 0)
		{
			a_Socket.CloseSocket();
			return true;
		}
		a_Data.erase(0, Sent);
	}
	return true;
}





void cSocketThreads::cSocketThread::CleanUpShutSockets(void)
{
	cCSLock Lock(m_Parent->m_CS);
	for (int i = m_NumSlots - 1; i >= 0; i--)
	{
		switch (m_Slots[i].m_State)
		{
			case sSlot::ssShuttingDown2:
			{
				// The socket has reached the shutdown timeout, close it and clear its slot:
				m_Slots[i].m_Socket.CloseSocket();
				m_Slots[i] = m_Slots[--m_NumSlots];
				break;
			}
			case sSlot::ssShuttingDown:
			{
				// The socket has been shut down for a single thread loop, let it loop once more before closing:
				m_Slots[i].m_State = sSlot::ssShuttingDown2;
				break;
			}
			default: break;
		}
	}  // for i - m_Slots[]
}




void cSocketThreads::cSocketThread::QueueOutgoingData(void)
{
	cCSLock Lock(m_Parent->m_CS);
	for (int i = 0; i < m_NumSlots; i++)
	{
		if (m_Slots[i].m_Client != NULL)
		{
			AString Data;
			m_Slots[i].m_Client->GetOutgoingData(Data);
			m_Slots[i].m_Outgoing.append(Data);
		}
		if (m_Slots[i].m_Outgoing.empty())
		{
			// No outgoing data is ready
			if (m_Slots[i].m_State == sSlot::ssWritingRestOut)
			{
				// The socket doesn't want to be kept alive anymore, and doesn't have any remaining data to send.
				// Shut it down and then close it after a timeout, or when the other side agrees
				m_Slots[i].m_State = sSlot::ssShuttingDown;
				m_Slots[i].m_Socket.ShutdownReadWrite();
			}
			continue;
		}
	}
}