forked from GlaireDaggers/ReliableNetcode.NET
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathReliablePacketController.cs
More file actions
483 lines (384 loc) · 19.3 KB
/
Copy pathReliablePacketController.cs
File metadata and controls
483 lines (384 loc) · 19.3 KB
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
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using ReliableNetcode.Utils;
namespace ReliableNetcode
{
internal class ReliableConfig
{
public string Name;
public int MaxPacketSize;
public int FragmentThreshold;
public int MaxFragments;
public int FragmentSize;
public int SentPacketBufferSize;
public int ReceivedPacketBufferSize;
public int FragmentReassemblyBufferSize;
public float RTTSmoothFactor;
public float PacketLossSmoothingFactor;
public float BandwidthSmoothingFactor;
public int PacketHeaderSize;
public Action<byte[], int> TransmitPacketCallback;
public Action<ushort, byte[], int> ProcessPacketCallback;
public Action<ushort> AckPacketCallback;
public static ReliableConfig DefaultConfig()
{
var config = new ReliableConfig();
config.Name = "endpoint";
config.MaxPacketSize = 16 * 1024;
config.FragmentThreshold = 1024;
config.MaxFragments = 16;
config.FragmentSize = 1024;
config.SentPacketBufferSize = 256;
config.ReceivedPacketBufferSize = 256;
config.FragmentReassemblyBufferSize = 64;
config.RTTSmoothFactor = 0.25f;
config.PacketLossSmoothingFactor = 0.1f;
config.BandwidthSmoothingFactor = 0.1f;
config.PacketHeaderSize = 28;
return config;
}
}
internal class ReliablePacketController
{
public ReliableConfig config;
public float RTT
{
get { return rtt; }
}
public float PacketLoss
{
get { return packetLoss; }
}
public float SentBandwidthKBPS
{
get { return sentBandwidthKBPS; }
}
public float ReceivedBandwidthKBPS
{
get { return receivedBandwidthKBPS; }
}
public float AckedBandwidthKBPS
{
get { return ackedBandwidthKBPS; }
}
private double time;
private float rtt;
private float packetLoss;
private float sentBandwidthKBPS;
private float receivedBandwidthKBPS;
private float ackedBandwidthKBPS;
private ushort sequence;
private SequenceBuffer<SentPacketData> sentPackets;
private SequenceBuffer<ReceivedPacketData> receivedPackets;
private SequenceBuffer<FragmentReassemblyData> fragmentReassembly;
public ReliablePacketController(ReliableConfig config, double time)
{
this.config = config;
this.time = time;
this.sentPackets = new SequenceBuffer<SentPacketData>(config.SentPacketBufferSize);
this.receivedPackets = new SequenceBuffer<ReceivedPacketData>(config.ReceivedPacketBufferSize);
this.fragmentReassembly = new SequenceBuffer<FragmentReassemblyData>(config.FragmentReassemblyBufferSize);
}
public ushort NextPacketSequence()
{
return sequence;
}
public void Reset()
{
this.sequence = 0;
for (int i = 0; i < config.FragmentReassemblyBufferSize; i++) {
FragmentReassemblyData reassemblyData = fragmentReassembly.AtIndex(i);
if (reassemblyData != null) {
reassemblyData.PacketDataBuffer.SetSize(0);
}
}
sentPackets.Reset();
receivedPackets.Reset();
fragmentReassembly.Reset();
}
public void Update(double newTime)
{
this.time = newTime;
// calculate packet loss
{
uint baseSequence = (uint)((sentPackets.sequence - config.SentPacketBufferSize + 1) + 0xFFFF);
int numDropped = 0;
int numSamples = config.SentPacketBufferSize / 2;
for (int i = 0; i < numSamples; i++) {
ushort sequence = (ushort)(baseSequence + i);
var sentPacketData = sentPackets.Find(sequence);
if (sentPacketData != null && !sentPacketData.acked)
numDropped++;
}
float packetLoss = (float)numDropped / (float)numSamples;
if (Math.Abs(this.packetLoss - packetLoss) > 0.00001f) {
this.packetLoss += (packetLoss - this.packetLoss) * config.PacketLossSmoothingFactor;
}
else {
this.packetLoss = packetLoss;
}
}
// calculate sent bandwidth
{
uint baseSequence = (uint)((sentPackets.sequence - config.SentPacketBufferSize + 1) + 0xFFFF);
int bytesSent = 0;
double startTime = double.MaxValue;
double finishTime = 0.0;
int numSamples = config.SentPacketBufferSize / 2;
for (int i = 0; i < numSamples; i++) {
ushort sequence = (ushort)(baseSequence + i);
var sentPacketData = sentPackets.Find(sequence);
if (sentPacketData == null) continue;
bytesSent += (int)sentPacketData.packetBytes;
startTime = Math.Min(startTime, sentPacketData.time);
finishTime = Math.Max(finishTime, sentPacketData.time);
}
if (startTime != double.MaxValue && finishTime != 0.0) {
float sentBandwidth = (float)bytesSent / (float)(finishTime - startTime) * 8f / 1000f;
if (Math.Abs(this.sentBandwidthKBPS - sentBandwidth) > 0.00001f) {
this.sentBandwidthKBPS += (sentBandwidth - this.sentBandwidthKBPS) * config.BandwidthSmoothingFactor;
}
else {
this.sentBandwidthKBPS = sentBandwidth;
}
}
}
// calculate received bandwidth
lock (receivedPackets)
{
uint baseSequence = (uint)((receivedPackets.sequence - config.ReceivedPacketBufferSize + 1) + 0xFFFF);
int bytesReceived = 0;
double startTime = double.MaxValue;
double finishTime = 0.0;
int numSamples = config.ReceivedPacketBufferSize / 2;
for (int i = 0; i < numSamples; i++) {
ushort sequence = (ushort)(baseSequence + i);
var receivedPacketData = receivedPackets.Find(sequence);
if (receivedPacketData == null) continue;
bytesReceived += (int)receivedPacketData.packetBytes;
startTime = Math.Min(startTime, receivedPacketData.time);
finishTime = Math.Max(finishTime, receivedPacketData.time);
}
if (startTime != double.MaxValue && finishTime != 0.0) {
float receivedBandwidth = (float)bytesReceived / (float)(finishTime - startTime) * 8f / 1000f;
if (Math.Abs(this.receivedBandwidthKBPS - receivedBandwidth) > 0.00001f) {
this.receivedBandwidthKBPS += (receivedBandwidth - this.receivedBandwidthKBPS) * config.BandwidthSmoothingFactor;
}
else {
this.receivedBandwidthKBPS = receivedBandwidth;
}
}
}
// calculate acked bandwidth
{
uint baseSequence = (uint)((sentPackets.sequence - config.SentPacketBufferSize + 1) + 0xFFFF);
int bytesSent = 0;
double startTime = double.MaxValue;
double finishTime = 0.0;
int numSamples = config.SentPacketBufferSize / 2;
for (int i = 0; i < numSamples; i++) {
ushort sequence = (ushort)(baseSequence + i);
var sentPacketData = sentPackets.Find(sequence);
if (sentPacketData == null || sentPacketData.acked == false) continue;
bytesSent += (int)sentPacketData.packetBytes;
startTime = Math.Min(startTime, sentPacketData.time);
finishTime = Math.Max(finishTime, sentPacketData.time);
}
if (startTime != double.MaxValue && finishTime != 0.0) {
float ackedBandwidth = (float)bytesSent / (float)(finishTime - startTime) * 8f / 1000f;
if (Math.Abs(this.ackedBandwidthKBPS - ackedBandwidth) > 0.00001f) {
this.ackedBandwidthKBPS += (ackedBandwidth - this.ackedBandwidthKBPS) * config.BandwidthSmoothingFactor;
}
else {
this.ackedBandwidthKBPS = ackedBandwidth;
}
}
}
}
public void SendAck(byte channelID)
{
ushort ack;
uint ackBits;
lock( receivedPackets )
receivedPackets.GenerateAckBits(out ack, out ackBits);
byte[] transmitData = BufferPool.GetBuffer(16);
int headerBytes = PacketIO.WriteAckPacket(transmitData, channelID, ack, ackBits);
config.TransmitPacketCallback(transmitData, headerBytes);
BufferPool.ReturnBuffer(transmitData);
}
public ushort SendPacket(byte[] packetData, int length, byte channelID)
{
if (length > config.MaxPacketSize)
throw new ArgumentOutOfRangeException("Packet is too large to send, max packet size is " + config.MaxPacketSize + " bytes");
ushort sequence = this.sequence++;
ushort ack;
uint ackBits;
lock( receivedPackets )
receivedPackets.GenerateAckBits(out ack, out ackBits);
SentPacketData sentPacketData = sentPackets.Insert(sequence);
sentPacketData.time = this.time;
sentPacketData.packetBytes = (uint)(config.PacketHeaderSize + length);
sentPacketData.acked = false;
if (length <= config.FragmentThreshold) {
// regular packet
byte[] transmitData = BufferPool.GetBuffer(2048);
int headerBytes = PacketIO.WritePacketHeader(transmitData, channelID, sequence, ack, ackBits);
int transmitBufferLength = length + headerBytes;
Buffer.BlockCopy(packetData, 0, transmitData, headerBytes, length);
config.TransmitPacketCallback(transmitData, transmitBufferLength);
BufferPool.ReturnBuffer(transmitData);
}
else {
// fragmented packet
byte[] packetHeader = BufferPool.GetBuffer(Defines.MAX_PACKET_HEADER_BYTES);
int packetHeaderBytes = 0;
try {
packetHeaderBytes = PacketIO.WritePacketHeader(packetHeader, channelID, sequence, ack, ackBits);
}
catch {
throw;
}
int numFragments = (length / config.FragmentSize) + ((length % config.FragmentSize) != 0 ? 1 : 0);
//int fragmentBufferSize = Defines.FRAGMENT_HEADER_BYTES + Defines.MAX_PACKET_HEADER_BYTES + config.FragmentSize;
byte[] fragmentPacketData = BufferPool.GetBuffer(2048);
int qpos = 0;
byte prefixByte = 1;
prefixByte |= (byte)((channelID & 0x03) << 6);
for (int fragmentID = 0; fragmentID < numFragments; fragmentID++) {
using (var writer = ByteArrayReaderWriter.Get(fragmentPacketData)) {
writer.Write(prefixByte);
writer.Write(channelID);
writer.Write(sequence);
writer.Write((byte)fragmentID);
writer.Write((byte)(numFragments - 1));
if (fragmentID == 0) {
writer.WriteBuffer(packetHeader, packetHeaderBytes);
}
int bytesToCopy = config.FragmentSize;
if (qpos + bytesToCopy > length)
bytesToCopy = length - qpos;
for (int i = 0; i < bytesToCopy; i++)
writer.Write(packetData[qpos++]);
int fragmentPacketBytes = (int)writer.WritePosition;
config.TransmitPacketCallback(fragmentPacketData, fragmentPacketBytes);
}
}
BufferPool.ReturnBuffer(packetHeader);
BufferPool.ReturnBuffer(fragmentPacketData);
}
return sequence;
}
public void ReceivePacket(byte[] packetData, int bufferLength)
{
if (bufferLength > config.MaxPacketSize)
throw new ArgumentOutOfRangeException("Packet is larger than max packet size");
if (packetData == null)
throw new InvalidOperationException("Tried to receive null packet!");
if (bufferLength > packetData.Length)
throw new InvalidOperationException("Buffer length exceeds actual packet length!");
byte prefixByte = packetData[0];
if ((prefixByte & 1) == 0) {
// regular packet
ushort sequence;
ushort ack;
uint ackBits;
byte channelID;
int packetHeaderBytes = PacketIO.ReadPacketHeader(packetData, 0, bufferLength, out channelID, out sequence, out ack, out ackBits);
bool isStale;
lock( receivedPackets )
isStale = !receivedPackets.TestInsert(sequence);
if (!isStale && (prefixByte & 0x80) == 0) {
if (packetHeaderBytes >= bufferLength)
throw new FormatException("Buffer too small for packet data!");
ByteBuffer tempBuffer = ObjPool<ByteBuffer>.Get();
tempBuffer.SetSize(bufferLength - packetHeaderBytes);
tempBuffer.BufferCopy(packetData, packetHeaderBytes, 0, tempBuffer.Length);
// process packet
config.ProcessPacketCallback(sequence, tempBuffer.InternalBuffer, tempBuffer.Length);
// add to received buffer
lock (receivedPackets) {
ReceivedPacketData receivedPacketData = receivedPackets.Insert(sequence);
if (receivedPacketData == null)
throw new InvalidOperationException("Failed to insert received packet!");
receivedPacketData.time = this.time;
receivedPacketData.packetBytes = (uint)(config.PacketHeaderSize + bufferLength);
}
ObjPool<ByteBuffer>.Return(tempBuffer);
}
if (!isStale || (prefixByte & 0x80) != 0) {
for (int i = 0; i < 32; i++) {
if ((ackBits & 1) != 0) {
ushort ack_sequence = (ushort)(ack - i);
SentPacketData sentPacketData = sentPackets.Find(ack_sequence);
if (sentPacketData != null && !sentPacketData.acked) {
sentPacketData.acked = true;
if (config.AckPacketCallback != null)
config.AckPacketCallback(ack_sequence);
float rtt = (float)(this.time - sentPacketData.time) * 1000.0f;
if ((this.rtt == 0f && rtt > 0f) || Math.Abs(this.rtt - rtt) < 0.00001f) {
this.rtt = rtt;
}
else {
this.rtt += (rtt - this.rtt) * config.RTTSmoothFactor;
}
}
}
ackBits >>= 1;
}
}
}
else {
// fragment packet
int fragmentID;
int numFragments;
int fragmentBytes;
ushort sequence;
ushort ack;
uint ackBits;
byte fragmentChannelID;
int fragmentHeaderBytes = PacketIO.ReadFragmentHeader(packetData, 0, bufferLength, config.MaxFragments, config.FragmentSize,
out fragmentID, out numFragments, out fragmentBytes, out sequence, out ack, out ackBits, out fragmentChannelID);
FragmentReassemblyData reassemblyData = fragmentReassembly.Find(sequence);
if (reassemblyData == null) {
reassemblyData = fragmentReassembly.Insert(sequence);
// failed to insert into buffer (stale)
if (reassemblyData == null)
return;
reassemblyData.Sequence = sequence;
reassemblyData.Ack = 0;
reassemblyData.AckBits = 0;
reassemblyData.NumFragmentsReceived = 0;
reassemblyData.NumFragmentsTotal = numFragments;
reassemblyData.PacketBytes = 0;
Array.Clear(reassemblyData.FragmentReceived, 0, reassemblyData.FragmentReceived.Length);
}
if (numFragments != reassemblyData.NumFragmentsTotal)
return;
if (reassemblyData.FragmentReceived[fragmentID])
return;
reassemblyData.NumFragmentsReceived++;
reassemblyData.FragmentReceived[fragmentID] = true;
byte[] tempFragmentData = BufferPool.GetBuffer(2048);
Buffer.BlockCopy(packetData, fragmentHeaderBytes, tempFragmentData, 0, bufferLength - fragmentHeaderBytes);
reassemblyData.StoreFragmentData(fragmentChannelID, sequence, ack, ackBits, fragmentID, config.FragmentSize, tempFragmentData, bufferLength - fragmentHeaderBytes);
BufferPool.ReturnBuffer(tempFragmentData);
if (reassemblyData.NumFragmentsReceived == reassemblyData.NumFragmentsTotal) {
// grab internal buffer and pass it to ReceivePacket. Internal buffer will be packet marked as normal packet, so it will go through normal packet path
// copy into new buffer to remove preceding offset (used to simplify variable length header handling)
ByteBuffer temp = ObjPool<ByteBuffer>.Get();
temp.SetSize(reassemblyData.PacketDataBuffer.Length - reassemblyData.HeaderOffset);
Buffer.BlockCopy(reassemblyData.PacketDataBuffer.InternalBuffer, reassemblyData.HeaderOffset, temp.InternalBuffer, 0, temp.Length);
// receive packet
this.ReceivePacket(temp.InternalBuffer, temp.Length);
// return temp buffer
ObjPool<ByteBuffer>.Return(temp);
// clear reassembly
reassemblyData.PacketDataBuffer.SetSize(0);
fragmentReassembly.Remove(sequence);
}
}
}
}
}