-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathSophonAsset.Download.cs
644 lines (574 loc) · 29.7 KB
/
SophonAsset.Download.cs
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
using Hi3Helper.Sophon.Helper;
using Hi3Helper.Sophon.Infos;
using Hi3Helper.Sophon.Structs;
using System;
using System.Buffers;
using System.Diagnostics;
using System.IO;
using System.Linq;
using System.Net.Http;
using System.Security.Cryptography;
using System.Threading;
using System.Threading.Tasks;
#if !NET6_0_OR_GREATER
using System.Threading.Tasks.Dataflow;
#endif
// ReSharper disable AccessToModifiedClosure
// ReSharper disable ConvertIfStatementToNullCoalescingAssignment
// ReSharper disable UseAwaitUsing
// ReSharper disable InvalidXmlDocComment
// ReSharper disable IdentifierTypo
// ReSharper disable UnusedAutoPropertyAccessor.Global
using TaskExtensions = Hi3Helper.Sophon.Helper.TaskExtensions;
using ZstdStream = ZstdNet.DecompressionStream;
namespace Hi3Helper.Sophon
{
public partial class SophonAsset
{
private enum SourceStreamType
{
Internet,
CachedLocal,
OldReference
}
internal const int BufferSize = 256 << 10;
private const int ZstdBufferSize = 0; // Default
public string AssetName { get; internal set; }
public long AssetSize { get; internal set; }
public string AssetHash { get; internal set; }
public bool IsDirectory { get; internal set; }
public bool IsHasPatch { get; internal set; }
public SophonChunk[] Chunks { get; internal set; }
internal SophonDownloadSpeedLimiter DownloadSpeedLimiter { get; set; }
internal SophonChunksInfo SophonChunksInfo { get; set; }
internal SophonChunksInfo SophonChunksInfoAlt { get; set; }
/// <summary>
/// Perform a download process by file and run each chunk download sequentially.
/// </summary>
/// <param name="client">
/// The <see cref="HttpClient" /> to be used for downloading process.<br />Ensure that the maximum connection for the
/// <see cref="HttpClient" /> has been set to at least (Number of Threads/CPU core * 25%) or == Number of Threads/CPU
/// core
/// </param>
/// <param name="outStream">
/// Output <see cref="Stream" /> to write the file into.<br />
/// The <see cref="Stream" /> must be readable, writeable and seekable, also be able to be shared both on Read and
/// Write operation.
/// It's recommended to use <see cref="FileStream" /> or other stream similar to that and please use
/// <see cref="FileMode.OpenOrCreate" />,
/// <see cref="FileAccess.ReadWrite" /> and <see cref="FileShare.ReadWrite" /> if you're using
/// <see cref="FileStream" />.
/// </param>
/// <param name="writeInfoDelegate">
/// <inheritdoc cref="DelegateWriteStreamInfo" />
/// </param>
/// <param name="downloadInfoDelegate">
/// <inheritdoc cref="DelegateWriteDownloadInfo" />
/// </param>
/// <param name="downloadCompleteDelegate">
/// <inheritdoc cref="DelegateDownloadAssetComplete" />
/// </param>
/// <param name="token">
/// Cancellation token for handling cancellation while the routine is running.
/// </param>
public async
#if NET6_0_OR_GREATER
ValueTask
#else
Task
#endif
WriteToStreamAsync(HttpClient client,
Stream outStream,
DelegateWriteStreamInfo writeInfoDelegate = null,
DelegateWriteDownloadInfo downloadInfoDelegate = null,
DelegateDownloadAssetComplete downloadCompleteDelegate = null,
CancellationToken token = default)
{
this.EnsureOrThrowChunksState();
this.EnsureOrThrowStreamState(outStream);
if (outStream.Length > AssetSize)
{
outStream.SetLength(AssetSize);
}
foreach (SophonChunk chunk in Chunks)
{
await PerformWriteStreamThreadAsync(client, null, SourceStreamType.Internet, outStream, chunk, token,
writeInfoDelegate, downloadInfoDelegate, DownloadSpeedLimiter);
}
#if DEBUG
this.PushLogInfo($"Asset: {AssetName} | (Hash: {AssetHash} -> {AssetSize} bytes) has been completely downloaded!");
#endif
downloadCompleteDelegate?.Invoke(this);
}
/// <summary>
/// Perform a download process by file and run each chunk download in parallel instead of sequentially.
/// </summary>
/// <param name="client">
/// The <see cref="HttpClient" /> to be used for downloading process.<br />Ensure that the maximum connection for the
/// <see cref="HttpClient" /> has been set to at least (Number of Threads/CPU core * 25%) or == Number of Threads/CPU
/// core
/// </param>
/// <param name="outStreamFunc">
/// Output <see cref="Stream" /> to write the file into.<br />
/// The <see cref="Stream" /> must be readable, writeable and seekable, also be able to be shared both on Read and
/// Write operation.
/// It's recommended to use <see cref="FileStream" /> or other stream similar to that and please use
/// <see cref="FileMode.OpenOrCreate" />,
/// <see cref="FileAccess.ReadWrite" /> and <see cref="FileShare.ReadWrite" /> if you're using
/// <see cref="FileStream" />.
/// </param>
/// <param name="parallelOptions">
/// Parallelization settings to be used for downloading chunks and data hashing.
/// Remember that while using this method, the <seealso cref="CancellationToken" /> needs to be passed with
/// <c>CancellationToken</c> property.<br />
/// If it's being set to <c>null</c>, a default setting will be used as below:
/// <code>
/// CancellationToken = <paramref name="token" />,
/// MaxDegreeOfParallelism = [Number of CPU threads/cores available]
/// </code>
/// </param>
/// <param name="writeInfoDelegate">
/// <inheritdoc cref="DelegateWriteStreamInfo" />
/// </param>
/// <param name="downloadInfoDelegate">
/// <inheritdoc cref="DelegateWriteDownloadInfo" />
/// </param>
/// <param name="downloadCompleteDelegate">
/// <inheritdoc cref="DelegateDownloadAssetComplete" />
/// </param>
public async
#if NET6_0_OR_GREATER
ValueTask
#else
Task
#endif
WriteToStreamAsync(HttpClient client,
Func<Stream> outStreamFunc,
ParallelOptions parallelOptions = null,
DelegateWriteStreamInfo writeInfoDelegate = null,
DelegateWriteDownloadInfo downloadInfoDelegate = null,
DelegateDownloadAssetComplete downloadCompleteDelegate = null)
{
this.EnsureOrThrowChunksState();
using (Stream initStream = outStreamFunc())
{
this.EnsureOrThrowStreamState(initStream);
if (initStream.Length > AssetSize)
{
initStream.SetLength(AssetSize);
}
}
if (parallelOptions == null)
{
int maxChunksTask = Math.Min(8, Environment.ProcessorCount);
parallelOptions = new ParallelOptions
{
CancellationToken = default,
MaxDegreeOfParallelism = maxChunksTask
};
}
try
{
#if !NET6_0_OR_GREATER
using CancellationTokenSource actionToken = new CancellationTokenSource();
using CancellationTokenSource linkedToken = CancellationTokenSource.CreateLinkedTokenSource(actionToken.Token, parallelOptions.CancellationToken);
ActionBlock<SophonChunk> actionBlock = new ActionBlock<SophonChunk>(
async chunk =>
{
using Stream outStream = outStreamFunc();
await PerformWriteStreamThreadAsync(client,
null, SourceStreamType.Internet,
outStream, chunk, linkedToken.Token,
writeInfoDelegate,
downloadInfoDelegate,
DownloadSpeedLimiter);
},
new ExecutionDataflowBlockOptions
{
MaxDegreeOfParallelism = parallelOptions.MaxDegreeOfParallelism,
CancellationToken = linkedToken.Token
});
foreach (SophonChunk chunk in Chunks)
{
await actionBlock.SendAsync(chunk, linkedToken.Token);
}
actionBlock.Complete();
await actionBlock.Completion;
#else
await Parallel.ForEachAsync(Chunks, parallelOptions, async (chunk, threadToken) =>
{
await using Stream outStream = outStreamFunc();
await PerformWriteStreamThreadAsync(client,
null, SourceStreamType.Internet,
outStream, chunk, threadToken,
writeInfoDelegate,
downloadInfoDelegate,
DownloadSpeedLimiter);
});
#endif
}
catch (AggregateException ex)
{
// Throw all other exceptions
throw ex.Flatten().InnerExceptions.First();
}
#if DEBUG
this.PushLogInfo($"Asset: {AssetName} | (Hash: {AssetHash} -> {AssetSize} bytes) has been completely downloaded!");
#endif
downloadCompleteDelegate?.Invoke(this);
}
private async
#if NET6_0_OR_GREATER
ValueTask
#else
Task
#endif
PerformWriteStreamThreadAsync(HttpClient client,
Stream sourceStream,
SourceStreamType sourceStreamType,
Stream outStream,
SophonChunk chunk,
CancellationToken token,
DelegateWriteStreamInfo writeInfoDelegate,
DelegateWriteDownloadInfo downloadInfoDelegate,
SophonDownloadSpeedLimiter downloadSpeedLimiter)
{
long totalSizeFromOffset = chunk.ChunkOffset + chunk.ChunkSizeDecompressed;
bool isSkipChunk = outStream.Length >= totalSizeFromOffset;
if (isSkipChunk)
{
outStream.Position = chunk.ChunkOffset;
isSkipChunk = await chunk.CheckChunkMd5HashAsync(outStream, false, token);
}
if (isSkipChunk)
{
#if DEBUG
this.PushLogDebug($"Skipping chunk 0x{chunk.ChunkOffset:x8} -> L: 0x{chunk.ChunkSizeDecompressed:x8} for: {AssetName}");
#endif
writeInfoDelegate?.Invoke(chunk.ChunkSizeDecompressed);
downloadInfoDelegate?.Invoke(chunk.ChunkOldOffset != -1 ? 0 : chunk.ChunkSizeDecompressed, 0);
return;
}
await InnerWriteStreamToAsync(client, sourceStream, sourceStreamType, outStream, chunk, token,
writeInfoDelegate, downloadInfoDelegate, downloadSpeedLimiter);
}
private async
#if NET6_0_OR_GREATER
ValueTask
#else
Task
#endif
InnerWriteStreamToAsync(HttpClient client,
Stream sourceStream,
SourceStreamType sourceStreamType,
Stream outStream,
SophonChunk chunk,
CancellationToken token,
DelegateWriteStreamInfo writeInfoDelegate,
DelegateWriteDownloadInfo downloadInfoDelegate,
SophonDownloadSpeedLimiter downloadSpeedLimiter)
{
if (sourceStreamType != SourceStreamType.Internet && sourceStream == null)
{
throw new ArgumentNullException(nameof(sourceStream),
"Source stream cannot be null under OldReference or CachedLocal mode!");
}
if (sourceStreamType == SourceStreamType.OldReference && chunk.ChunkOldOffset < 0)
{
throw new
InvalidOperationException("SourceStreamType.OldReference cannot be used if chunk does not have chunk old offset reference!");
}
const int retryCount = TaskExtensions.DefaultRetryAttempt;
int currentRetry = 0;
long currentWriteOffset = 0;
long written = 0;
long thisInstanceDownloadLimitBase = downloadSpeedLimiter?.InitialRequestedSpeed ?? -1;
Stopwatch currentStopwatch = Stopwatch.StartNew();
double maximumBytesPerSecond;
double bitPerUnit;
CalculateBps();
if (downloadSpeedLimiter != null)
{
downloadSpeedLimiter.CurrentChunkProcessingChangedEvent += UpdateChunkRangesCountEvent;
downloadSpeedLimiter.DownloadSpeedChangedEvent += DownloadClientDownloadSpeedLimitChanged;
}
#if !NOSTREAMLOCK
if (outStream is FileStream fs)
{
fs.Lock(chunk.ChunkOffset, chunk.ChunkSizeDecompressed);
this.PushLogDebug($"Locked data stream from pos: 0x{chunk.ChunkOffset:x8} -> L: 0x{chunk.ChunkSizeDecompressed:x8} for chunk: {chunk.ChunkName} by asset: {AssetName}");
}
#endif
while (true)
{
bool allowDispose = false;
HttpResponseMessage httpResponseMessage = null;
Stream httpResponseStream = null;
using MD5 hashInstance = MD5.Create();
byte[] buffer = ArrayPool<byte>.Shared.Rent(BufferSize);
SourceStreamType currentSourceStreamType = sourceStreamType;
{
try
{
CancellationTokenSource innerTimeoutToken =
new CancellationTokenSource(TimeSpan.FromSeconds(TaskExtensions.DefaultTimeoutSec)
#if NET8_0_OR_GREATER
, TimeProvider.System
#endif
);
CancellationTokenSource cooperatedToken =
CancellationTokenSource.CreateLinkedTokenSource(token, innerTimeoutToken.Token);
#if DEBUG
this.PushLogDebug($"Init. by offset: 0x{chunk.ChunkOffset:x8} -> L: 0x{chunk.ChunkSizeDecompressed:x8} for chunk: {chunk.ChunkName}");
#endif
outStream.Position = chunk.ChunkOffset;
switch (sourceStreamType)
{
case SourceStreamType.Internet:
{
downloadSpeedLimiter?.IncrementChunkProcessedCount();
httpResponseMessage = await client.GetChunkAndIfAltAsync(
chunk.ChunkName,
SophonChunksInfo,
SophonChunksInfoAlt,
cooperatedToken.Token);
httpResponseStream = await httpResponseMessage
.EnsureSuccessStatusCode()
.Content
.ReadAsStreamAsync(
#if NET6_0_OR_GREATER
cooperatedToken.Token
#endif
);
sourceStream = httpResponseStream;
if (SophonChunksInfo.IsUseCompression)
{
sourceStream = new ZstdStream(httpResponseStream, ZstdBufferSize);
}
}
break;
case SourceStreamType.CachedLocal:
{
if (SophonChunksInfo.IsUseCompression)
{
sourceStream = new ZstdStream(sourceStream, ZstdBufferSize);
}
}
break;
case SourceStreamType.OldReference:
{
sourceStream.Position = chunk.ChunkOldOffset;
}
break;
default:
throw new ArgumentOutOfRangeException(nameof(sourceStreamType), sourceStreamType, null);
}
#if DEBUG
this.PushLogDebug($"[Complete init.] by offset: 0x{chunk.ChunkOffset:x8} -> L: 0x{chunk.ChunkSizeDecompressed:x8} for chunk: {chunk.ChunkName}");
#endif
long remain = chunk.ChunkSizeDecompressed;
while (remain > 0)
{
int toRead = Math.Min((int)remain, buffer.Length);
int read = await sourceStream.ReadAsync(
#if NET6_0_OR_GREATER
buffer.AsMemory(0, toRead)
#else
buffer, 0, toRead
#endif
, cooperatedToken.Token);
await outStream.WriteAsync(
#if NET6_0_OR_GREATER
buffer.AsMemory(0, read)
#else
buffer, 0, read
#endif
, cooperatedToken.Token);
currentWriteOffset += read;
remain -= read;
hashInstance.TransformBlock(buffer, 0, read, buffer, 0);
writeInfoDelegate?.Invoke(read);
if (currentSourceStreamType == SourceStreamType.Internet)
{
written += read;
}
// Add network activity read indicator
if (sourceStreamType != SourceStreamType.OldReference)
{
downloadInfoDelegate?.Invoke(read,
sourceStreamType == SourceStreamType.Internet ? read : 0);
}
currentRetry = 0;
innerTimeoutToken.Dispose();
cooperatedToken.Dispose();
innerTimeoutToken =
new CancellationTokenSource(TimeSpan.FromSeconds(TaskExtensions.DefaultTimeoutSec)
#if NET8_0_OR_GREATER
, TimeProvider.System
#endif
);
cooperatedToken =
CancellationTokenSource.CreateLinkedTokenSource(token, innerTimeoutToken.Token);
if (read == 0 && remain > 0)
{
throw new
InvalidDataException($"Chunk has remained data while the read is already 0 due to corrupted compressed data. Remained data: {remain} bytes");
}
if (currentSourceStreamType == SourceStreamType.Internet)
{
await ThrottleAsync();
}
}
hashInstance.TransformFinalBlock(buffer, 0, 0);
bool isHashVerified = hashInstance.Hash.AsSpan().SequenceEqual(chunk.ChunkHashDecompressed);
if (!isHashVerified)
{
writeInfoDelegate?.Invoke(-currentWriteOffset);
if (sourceStreamType != SourceStreamType.OldReference)
{
downloadInfoDelegate?.Invoke(-currentWriteOffset, 0);
}
allowDispose = true;
this.PushLogWarning($"Source data from type: {sourceStreamType} seems to be corrupted at transport.\r\nRestarting download for chunk: {chunk.ChunkName} | 0x{chunk.ChunkOffset:x8} -> L: 0x{chunk.ChunkSizeDecompressed:x8} for: {AssetName}");
sourceStreamType = SourceStreamType.Internet;
continue;
}
#if DEBUG
this.PushLogDebug($"Download completed! Chunk: {chunk.ChunkName} | 0x{chunk.ChunkOffset:x8} -> L: 0x{chunk.ChunkSizeDecompressed:x8} for: {AssetName}");
#endif
allowDispose = true;
return;
}
catch (OperationCanceledException) when (token.IsCancellationRequested)
{
allowDispose = true;
throw;
}
catch (Exception ex)
{
httpResponseMessage?.Dispose();
#if NET6_0_OR_GREATER
if (httpResponseStream != null)
{
await httpResponseStream.DisposeAsync();
}
if (sourceStream != null)
{
await sourceStream.DisposeAsync();
}
#else
sourceStream?.Dispose();
httpResponseStream?.Dispose();
#endif
sourceStream = null;
SourceStreamType lastSourceStreamType = sourceStreamType;
sourceStreamType = SourceStreamType.Internet;
if (currentRetry < retryCount)
{
writeInfoDelegate?.Invoke(-currentWriteOffset);
if (lastSourceStreamType != SourceStreamType.OldReference)
{
downloadInfoDelegate?.Invoke(-currentWriteOffset, 0);
}
currentWriteOffset = 0;
currentRetry++;
this.PushLogWarning($"An error has occurred while downloading chunk: {chunk.ChunkName} | 0x{chunk.ChunkOffset:x8} -> L: 0x{chunk.ChunkSizeDecompressed:x8} for: {AssetName}\r\n{ex}");
await Task.Delay(TimeSpan.FromSeconds(1), token);
continue;
}
allowDispose = true;
this.PushLogError($"An unhandled error has occurred while downloading chunk: {chunk.ChunkName} | 0x{chunk.ChunkOffset:x8} -> L: 0x{chunk.ChunkSizeDecompressed:x8} for: {AssetName}\r\n{ex}");
throw;
}
finally
{
if (downloadSpeedLimiter != null && currentSourceStreamType == SourceStreamType.Internet
&& downloadSpeedLimiter.CurrentChunkProcessing > 0)
{
downloadSpeedLimiter?.DecrementChunkProcessedCount();
}
if (allowDispose)
{
#if NET6_0_OR_GREATER
if (httpResponseStream != null)
{
await httpResponseStream.DisposeAsync();
}
if (sourceStream != null)
{
await sourceStream.DisposeAsync();
}
#else
sourceStream?.Dispose();
httpResponseStream?.Dispose();
#endif
}
ArrayPool<byte>.Shared.Return(buffer);
}
}
}
void CalculateBps()
{
if (thisInstanceDownloadLimitBase <= 0)
{
thisInstanceDownloadLimitBase = -1;
}
else
{
thisInstanceDownloadLimitBase = Math.Max(64 << 10, thisInstanceDownloadLimitBase);
}
#if NET6_0_OR_GREATER
double threadNum = Math.Clamp(downloadSpeedLimiter?.CurrentChunkProcessing ?? 1, 1, 16 << 10);
#else
double threadNum = downloadSpeedLimiter?.CurrentChunkProcessing ?? 1;
threadNum = threadNum switch
{
< 1 => 1,
> 16 << 10 => 16 << 10,
_ => threadNum
};
#endif
maximumBytesPerSecond = thisInstanceDownloadLimitBase / threadNum;
bitPerUnit = 940 - (threadNum - 2) / (16 - 2) * 400;
}
void DownloadClientDownloadSpeedLimitChanged(object sender, long e)
{
thisInstanceDownloadLimitBase = e == 0 ? -1 : e;
CalculateBps();
}
void UpdateChunkRangesCountEvent(object sender, int e)
{
CalculateBps();
}
async Task ThrottleAsync()
{
// Make sure the buffer isn't empty.
if (maximumBytesPerSecond <= 0 || written <= 0)
{
return;
}
long elapsedMilliseconds = currentStopwatch.ElapsedMilliseconds;
if (elapsedMilliseconds > 0)
{
// Calculate the current bps.
double bps = written * bitPerUnit / elapsedMilliseconds;
// If the bps are more then the maximum bps, try to throttle.
if (bps > maximumBytesPerSecond)
{
// Calculate the time to sleep.
double wakeElapsed = written * bitPerUnit / maximumBytesPerSecond;
double toSleep = wakeElapsed - elapsedMilliseconds;
if (toSleep > 1)
{
// The time to sleep is more than a millisecond, so sleep.
await Task.Delay(TimeSpan.FromMilliseconds(toSleep), token);
// A sleep has been done, reset.
currentStopwatch.Restart();
written = 0;
}
}
}
}
}
}
}