-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
ConnectionMultiplexer.cs
2916 lines (2612 loc) · 123 KB
/
ConnectionMultiplexer.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
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
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
using System;
using System.Collections;
using System.Collections.Generic;
using System.Diagnostics;
using System.IO;
using System.Linq;
using System.Net;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
using System.Reflection;
using System.IO.Compression;
using System.Runtime.CompilerServices;
using StackExchange.Redis.Profiling;
using Pipelines.Sockets.Unofficial;
using System.ComponentModel;
namespace StackExchange.Redis
{
/// <summary>
/// Represents an inter-related group of connections to redis servers
/// </summary>
public sealed partial class ConnectionMultiplexer : IInternalConnectionMultiplexer // implies : IConnectionMultiplexer and : IDisposable
{
[Flags]
private enum FeatureFlags
{
None,
PreventThreadTheft = 1,
}
private static FeatureFlags s_featureFlags;
/// <summary>
/// Enables or disables a feature flag; this should only be used under support guidance, and should not be rapidly toggled
/// </summary>
[EditorBrowsable(EditorBrowsableState.Never)]
[Browsable(false)]
public static void SetFeatureFlag(string flag, bool enabled)
{
if (Enum.TryParse<FeatureFlags>(flag, true, out var flags))
{
if (enabled) s_featureFlags |= flags;
else s_featureFlags &= ~flags;
}
}
static ConnectionMultiplexer()
{
bool value = false;
try
{ // attempt to detect a known problem scenario
value = SynchronizationContext.Current?.GetType()?.Name
== "LegacyAspNetSynchronizationContext";
}
catch { }
SetFeatureFlag(nameof(FeatureFlags.PreventThreadTheft), value);
}
/// <summary>
/// Returns the state of a feature flag; this should only be used under support guidance
/// </summary>
[EditorBrowsable(EditorBrowsableState.Never)]
[Browsable(false)]
public static bool GetFeatureFlag(string flag)
=> Enum.TryParse<FeatureFlags>(flag, true, out var flags)
&& (s_featureFlags & flags) == flags;
internal static bool PreventThreadTheft => (s_featureFlags & FeatureFlags.PreventThreadTheft) != 0;
private static TaskFactory _factory = null;
#if DEBUG
private static int _collectedWithoutDispose;
internal static int CollectedWithoutDispose => Thread.VolatileRead(ref _collectedWithoutDispose);
/// <summary>
/// Invoked by the garbage collector
/// </summary>
~ConnectionMultiplexer()
{
Interlocked.Increment(ref _collectedWithoutDispose);
}
#endif
bool IInternalConnectionMultiplexer.AllowConnect
{
get => AllowConnect;
set => AllowConnect = value;
}
bool IInternalConnectionMultiplexer.IgnoreConnect
{
get => IgnoreConnect;
set => IgnoreConnect = value;
}
/// <summary>
/// For debugging: when not enabled, servers cannot connect
/// </summary>
internal volatile bool AllowConnect = true;
/// <summary>
/// For debugging: when not enabled, end-connect is silently ignored (to simulate a long-running connect)
/// </summary>
internal volatile bool IgnoreConnect;
/// <summary>
/// Tracks overall connection multiplexer counts
/// </summary>
internal int _connectAttemptCount = 0, _connectCompletedCount = 0, _connectionCloseCount = 0;
/// <summary>
/// Provides a way of overriding the default Task Factory. If not set, it will use the default Task.Factory.
/// Useful when top level code sets it's own factory which may interfere with Redis queries.
/// </summary>
public static TaskFactory Factory
{
get => _factory ?? Task.Factory;
set => _factory = value;
}
/// <summary>
/// Get summary statistics associates with this server
/// </summary>
public ServerCounters GetCounters()
{
var snapshot = GetServerSnapshot();
var counters = new ServerCounters(null);
for (int i = 0; i < snapshot.Length; i++)
{
counters.Add(snapshot[i].GetCounters());
}
return counters;
}
/// <summary>
/// Gets the client-name that will be used on all new connections
/// </summary>
public string ClientName => RawConfig.ClientName ?? GetDefaultClientName();
private static string defaultClientName;
private static string GetDefaultClientName()
{
return defaultClientName ?? (defaultClientName = TryGetAzureRoleInstanceIdNoThrow()
?? Environment.MachineName
?? Environment.GetEnvironmentVariable("ComputerName")
?? "StackExchange.Redis");
}
/// <summary>
/// Tries to get the Roleinstance Id if Microsoft.WindowsAzure.ServiceRuntime is loaded.
/// In case of any failure, swallows the exception and returns null
/// </summary>
internal static string TryGetAzureRoleInstanceIdNoThrow()
{
string roleInstanceId;
// TODO: CoreCLR port pending https://github.com/dotnet/coreclr/issues/919
try
{
Assembly asm = null;
foreach (var asmb in AppDomain.CurrentDomain.GetAssemblies())
{
if (asmb.GetName().Name.Equals("Microsoft.WindowsAzure.ServiceRuntime"))
{
asm = asmb;
break;
}
}
if (asm == null)
return null;
var type = asm.GetType("Microsoft.WindowsAzure.ServiceRuntime.RoleEnvironment");
// https://msdn.microsoft.com/en-us/library/microsoft.windowsazure.serviceruntime.roleenvironment.isavailable.aspx
if (!(bool)type.GetProperty("IsAvailable").GetValue(null, null))
return null;
var currentRoleInstanceProp = type.GetProperty("CurrentRoleInstance");
var currentRoleInstanceId = currentRoleInstanceProp.GetValue(null, null);
roleInstanceId = currentRoleInstanceId.GetType().GetProperty("Id").GetValue(currentRoleInstanceId, null).ToString();
if (string.IsNullOrEmpty(roleInstanceId))
{
roleInstanceId = null;
}
}
catch (Exception)
{
//silently ignores the exception
roleInstanceId = null;
}
return roleInstanceId;
}
/// <summary>
/// Gets the configuration of the connection
/// </summary>
public string Configuration => RawConfig.ToString();
internal void OnConnectionFailed(EndPoint endpoint, ConnectionType connectionType, ConnectionFailureType failureType, Exception exception, bool reconfigure, string physicalName)
{
if (_isDisposed) return;
var handler = ConnectionFailed;
if (handler != null)
{
ConnectionMultiplexer.CompleteAsWorker(
new ConnectionFailedEventArgs(handler, this, endpoint, connectionType, failureType, exception, physicalName));
}
if (reconfigure)
{
ReconfigureIfNeeded(endpoint, false, "connection failed");
}
}
internal void OnInternalError(Exception exception, EndPoint endpoint = null, ConnectionType connectionType = ConnectionType.None, [CallerMemberName] string origin = null)
{
try
{
if (_isDisposed) return;
Trace("Internal error: " + origin + ", " + exception == null ? "unknown" : exception.Message);
var handler = InternalError;
if (handler != null)
{
ConnectionMultiplexer.CompleteAsWorker(
new InternalErrorEventArgs(handler, this, endpoint, connectionType, exception, origin));
}
}
catch
{ // our internal error event failed; whatcha gonna do, exactly?
}
}
internal void OnConnectionRestored(EndPoint endpoint, ConnectionType connectionType, string physicalName)
{
if (_isDisposed) return;
var handler = ConnectionRestored;
if (handler != null)
{
ConnectionMultiplexer.CompleteAsWorker(
new ConnectionFailedEventArgs(handler, this, endpoint, connectionType, ConnectionFailureType.None, null, physicalName));
}
ReconfigureIfNeeded(endpoint, false, "connection restored");
}
private void OnEndpointChanged(EndPoint endpoint, EventHandler<EndPointEventArgs> handler)
{
if (_isDisposed) return;
if (handler != null)
{
ConnectionMultiplexer.CompleteAsWorker(new EndPointEventArgs(handler, this, endpoint));
}
}
internal void OnConfigurationChanged(EndPoint endpoint) => OnEndpointChanged(endpoint, ConfigurationChanged);
internal void OnConfigurationChangedBroadcast(EndPoint endpoint) => OnEndpointChanged(endpoint, ConfigurationChangedBroadcast);
/// <summary>
/// A server replied with an error message;
/// </summary>
public event EventHandler<RedisErrorEventArgs> ErrorMessage;
internal void OnErrorMessage(EndPoint endpoint, string message)
{
if (_isDisposed) return;
var handler = ErrorMessage;
if (handler != null)
{
ConnectionMultiplexer.CompleteAsWorker(
new RedisErrorEventArgs(handler, this, endpoint, message)
);
}
}
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Usage", "CA2202:Do not dispose objects multiple times")]
private static void Write<T>(ZipArchive zip, string name, Task task, Action<T, StreamWriter> callback)
{
var entry = zip.CreateEntry(name, CompressionLevel.Optimal);
using (var stream = entry.Open())
using (var writer = new StreamWriter(stream))
{
TaskStatus status = task.Status;
switch (status)
{
case TaskStatus.RanToCompletion:
T val = ((Task<T>)task).Result;
callback(val, writer);
break;
case TaskStatus.Faulted:
writer.WriteLine(string.Join(", ", task.Exception.InnerExceptions.Select(x => x.Message)));
break;
default:
writer.WriteLine(status.ToString());
break;
}
}
}
/// <summary>
/// Write the configuration of all servers to an output stream
/// </summary>
/// <param name="destination">The destination stream to write the export to.</param>
/// <param name="options">The options to use for this export.</param>
public void ExportConfiguration(Stream destination, ExportOptions options = ExportOptions.All)
{
if (destination == null) throw new ArgumentNullException(nameof(destination));
// what is possible, given the command map?
ExportOptions mask = 0;
if (CommandMap.IsAvailable(RedisCommand.INFO)) mask |= ExportOptions.Info;
if (CommandMap.IsAvailable(RedisCommand.CONFIG)) mask |= ExportOptions.Config;
if (CommandMap.IsAvailable(RedisCommand.CLIENT)) mask |= ExportOptions.Client;
if (CommandMap.IsAvailable(RedisCommand.CLUSTER)) mask |= ExportOptions.Cluster;
options &= mask;
using (var zip = new ZipArchive(destination, ZipArchiveMode.Create, true))
{
var arr = GetServerSnapshot();
foreach (var server in arr)
{
const CommandFlags flags = CommandFlags.None;
if (!server.IsConnected) continue;
var api = GetServer(server.EndPoint);
List<Task> tasks = new List<Task>();
if ((options & ExportOptions.Info) != 0)
{
tasks.Add(api.InfoRawAsync(flags: flags));
}
if ((options & ExportOptions.Config) != 0)
{
tasks.Add(api.ConfigGetAsync(flags: flags));
}
if ((options & ExportOptions.Client) != 0)
{
tasks.Add(api.ClientListAsync(flags: flags));
}
if ((options & ExportOptions.Cluster) != 0)
{
tasks.Add(api.ClusterNodesRawAsync(flags: flags));
}
WaitAllIgnoreErrors(tasks.ToArray());
int index = 0;
var prefix = Format.ToString(server.EndPoint);
if ((options & ExportOptions.Info) != 0)
{
Write<string>(zip, prefix + "/info.txt", tasks[index++], WriteNormalizingLineEndings);
}
if ((options & ExportOptions.Config) != 0)
{
Write<KeyValuePair<string, string>[]>(zip, prefix + "/config.txt", tasks[index++], (settings, writer) =>
{
foreach (var setting in settings)
{
writer.WriteLine("{0}={1}", setting.Key, setting.Value);
}
});
}
if ((options & ExportOptions.Client) != 0)
{
Write<ClientInfo[]>(zip, prefix + "/clients.txt", tasks[index++], (clients, writer) =>
{
if (clients == null)
{
writer.WriteLine(NoContent);
}
else
{
foreach (var client in clients)
{
writer.WriteLine(client.Raw);
}
}
});
}
if ((options & ExportOptions.Cluster) != 0)
{
Write<string>(zip, prefix + "/nodes.txt", tasks[index++], WriteNormalizingLineEndings);
}
}
}
}
internal void MakeMaster(ServerEndPoint server, ReplicationChangeOptions options, LogProxy log)
{
var cmd = server.GetFeatures().ReplicaCommands ? RedisCommand.REPLICAOF : RedisCommand.SLAVEOF;
CommandMap.AssertAvailable(cmd);
if (!RawConfig.AllowAdmin) throw ExceptionFactory.AdminModeNotEnabled(IncludeDetailInExceptions, cmd, null, server);
if (server == null) throw new ArgumentNullException(nameof(server));
var srv = new RedisServer(this, server, null);
if (!srv.IsConnected) throw ExceptionFactory.NoConnectionAvailable(this, null, server, GetServerSnapshot(), command: cmd);
#pragma warning disable CS0618
const CommandFlags flags = CommandFlags.NoRedirect | CommandFlags.HighPriority;
#pragma warning restore CS0618
Message msg;
log?.WriteLine($"Checking {Format.ToString(srv.EndPoint)} is available...");
try
{
srv.Ping(flags); // if it isn't happy, we're not happy
}
catch (Exception ex)
{
log?.WriteLine($"Operation failed on {Format.ToString(srv.EndPoint)}, aborting: {ex.Message}");
throw;
}
var nodes = GetServerSnapshot();
RedisValue newMaster = Format.ToString(server.EndPoint);
RedisKey tieBreakerKey = default(RedisKey);
// try and write this everywhere; don't worry if some folks reject our advances
if ((options & ReplicationChangeOptions.SetTiebreaker) != 0 && !string.IsNullOrWhiteSpace(RawConfig.TieBreaker)
&& CommandMap.IsAvailable(RedisCommand.SET))
{
tieBreakerKey = RawConfig.TieBreaker;
foreach (var node in nodes)
{
if (!node.IsConnected) continue;
log?.WriteLine($"Attempting to set tie-breaker on {Format.ToString(node.EndPoint)}...");
msg = Message.Create(0, flags, RedisCommand.SET, tieBreakerKey, newMaster);
#pragma warning disable CS0618
node.WriteDirectFireAndForgetSync(msg, ResultProcessor.DemandOK);
#pragma warning restore CS0618
}
}
// stop replicating, promote to a standalone primary
log?.WriteLine($"Making {Format.ToString(srv.EndPoint)} a master...");
try
{
srv.ReplicaOf(null, flags);
}
catch (Exception ex)
{
log?.WriteLine($"Operation failed on {Format.ToString(srv.EndPoint)}, aborting: {ex.Message}");
throw;
}
// also, in case it was a replica a moment ago, and hasn't got the tie-breaker yet, we re-send the tie-breaker to this one
if (!tieBreakerKey.IsNull)
{
log?.WriteLine($"Resending tie-breaker to {Format.ToString(server.EndPoint)}...");
msg = Message.Create(0, flags, RedisCommand.SET, tieBreakerKey, newMaster);
#pragma warning disable CS0618
server.WriteDirectFireAndForgetSync(msg, ResultProcessor.DemandOK);
#pragma warning restore CS0618
}
// There's an inherent race here in zero-lantency environments (e.g. when Redis is on localhost) when a broadcast is specified
// The broadast can get back from redis and trigger a reconfigure before we get a chance to get to ReconfigureAsync() below
// This results in running an outdated reconfig and the .CompareExchange() (due to already running a reconfig) failing...making our needed reconfig a no-op.
// If we don't block *that* run, then *our* run (at low latency) gets blocked. Then we're waiting on the
// ConfigurationOptions.ConfigCheckSeconds interval to identify the current (created by this method call) topology correctly.
var blockingReconfig = Interlocked.CompareExchange(ref activeConfigCause, "Block: Pending Master Reconfig", null) == null;
// Try and broadcast the fact a change happened to all members
// We want everyone possible to pick it up.
// We broadcast before *and after* the change to remote members, so that they don't go without detecting a change happened.
// This eliminates the race of pub/sub *then* re-slaving happening, since a method both preceeds and follows.
void Broadcast(ReadOnlySpan<ServerEndPoint> serverNodes)
{
if ((options & ReplicationChangeOptions.Broadcast) != 0 && ConfigurationChangedChannel != null
&& CommandMap.IsAvailable(RedisCommand.PUBLISH))
{
RedisValue channel = ConfigurationChangedChannel;
foreach (var node in serverNodes)
{
if (!node.IsConnected) continue;
log?.WriteLine($"Broadcasting via {Format.ToString(node.EndPoint)}...");
msg = Message.Create(-1, flags, RedisCommand.PUBLISH, channel, newMaster);
#pragma warning disable CS0618
node.WriteDirectFireAndForgetSync(msg, ResultProcessor.Int64);
#pragma warning restore CS0618
}
}
}
// Send a message before it happens - because afterwards a new replica may be unresponsive
Broadcast(nodes);
if ((options & ReplicationChangeOptions.ReplicateToOtherEndpoints) != 0)
{
foreach (var node in nodes)
{
if (node == server || node.ServerType != ServerType.Standalone) continue;
log?.WriteLine($"Replicating to {Format.ToString(node.EndPoint)}...");
msg = RedisServer.CreateReplicaOfMessage(node, server.EndPoint, flags);
#pragma warning disable CS0618
node.WriteDirectFireAndForgetSync(msg, ResultProcessor.DemandOK);
#pragma warning restore CS0618
}
}
// ...and send one after it happens - because the first broadcast may have landed on a secondary client
// and it can reconfgure before any topology change actually happened. This is most likely to happen
// in low-latency environments.
Broadcast(nodes);
// and reconfigure the muxer
log?.WriteLine("Reconfiguring all endpoints...");
// Yes, there is a tiny latency race possible between this code and the next call, but it's far more minute than before.
// The effective gap between 0 and > 0 (likely off-box) latency is something that may never get hit here by anyone.
if (blockingReconfig)
{
Interlocked.Exchange(ref activeConfigCause, null);
}
if (!ReconfigureAsync(false, true, log, srv.EndPoint, "make master").ObserveErrors().Wait(5000))
{
log?.WriteLine("Verifying the configuration was incomplete; please verify");
}
}
internal void CheckMessage(Message message)
{
if (!RawConfig.AllowAdmin && message.IsAdmin)
throw ExceptionFactory.AdminModeNotEnabled(IncludeDetailInExceptions, message.Command, message, null);
if (message.Command != RedisCommand.UNKNOWN) CommandMap.AssertAvailable(message.Command);
// using >= here because we will be adding 1 for the command itself (which is an arg for the purposes of the multi-bulk protocol)
if (message.ArgCount >= PhysicalConnection.REDIS_MAX_ARGS) throw ExceptionFactory.TooManyArgs(message.CommandAndKey, message.ArgCount);
}
private const string NoContent = "(no content)";
private static void WriteNormalizingLineEndings(string source, StreamWriter writer)
{
if (source == null)
{
writer.WriteLine(NoContent);
}
else
{
using (var reader = new StringReader(source))
{
string line;
while ((line = reader.ReadLine()) != null)
writer.WriteLine(line); // normalize line endings
}
}
}
/// <summary>
/// Raised whenever a physical connection fails
/// </summary>
public event EventHandler<ConnectionFailedEventArgs> ConnectionFailed;
/// <summary>
/// Raised whenever an internal error occurs (this is primarily for debugging)
/// </summary>
public event EventHandler<InternalErrorEventArgs> InternalError;
/// <summary>
/// Raised whenever a physical connection is established
/// </summary>
public event EventHandler<ConnectionFailedEventArgs> ConnectionRestored;
/// <summary>
/// Raised when configuration changes are detected
/// </summary>
public event EventHandler<EndPointEventArgs> ConfigurationChanged;
/// <summary>
/// Raised when nodes are explicitly requested to reconfigure via broadcast;
/// this usually means master/replica changes
/// </summary>
public event EventHandler<EndPointEventArgs> ConfigurationChangedBroadcast;
/// <summary>
/// Gets the synchronous timeout associated with the connections
/// </summary>
public int TimeoutMilliseconds { get; }
/// <summary>
/// Gets the asynchronous timeout associated with the connections
/// </summary>
internal int AsyncTimeoutMilliseconds { get; }
/// <summary>
/// Gets all endpoints defined on the server
/// </summary>
/// <param name="configuredOnly">Whether to get only the endpoints specified explicitly in the config.</param>
public EndPoint[] GetEndPoints(bool configuredOnly = false)
{
if (configuredOnly) return RawConfig.EndPoints.ToArray();
return _serverSnapshot.GetEndPoints();
}
internal bool TryResend(int hashSlot, Message message, EndPoint endpoint, bool isMoved)
{
return ServerSelectionStrategy.TryResend(hashSlot, message, endpoint, isMoved);
}
/// <summary>
/// Wait for a given asynchronous operation to complete (or timeout)
/// </summary>
/// <param name="task">The task to wait on.</param>
public void Wait(Task task)
{
if (task == null) throw new ArgumentNullException(nameof(task));
try
{
if (!task.Wait(TimeoutMilliseconds)) throw new TimeoutException();
}
catch (AggregateException aex) when (IsSingle(aex))
{
throw aex.InnerExceptions[0];
}
}
/// <summary>
/// Wait for a given asynchronous operation to complete (or timeout)
/// </summary>
/// <typeparam name="T">The type contains in the task to wait on.</typeparam>
/// <param name="task">The task to wait on.</param>
public T Wait<T>(Task<T> task)
{
if (task == null) throw new ArgumentNullException(nameof(task));
try
{
if (!task.Wait(TimeoutMilliseconds)) throw new TimeoutException();
}
catch (AggregateException aex) when (IsSingle(aex))
{
throw aex.InnerExceptions[0];
}
return task.Result;
}
private static bool IsSingle(AggregateException aex)
{
try { return aex != null && aex.InnerExceptions.Count == 1; }
catch { return false; }
}
/// <summary>
/// Wait for the given asynchronous operations to complete (or timeout)
/// </summary>
/// <param name="tasks">The tasks to wait on.</param>
public void WaitAll(params Task[] tasks)
{
if (tasks == null) throw new ArgumentNullException(nameof(tasks));
if (tasks.Length == 0) return;
if (!Task.WaitAll(tasks, TimeoutMilliseconds)) throw new TimeoutException();
}
private bool WaitAllIgnoreErrors(Task[] tasks) => WaitAllIgnoreErrors(tasks, TimeoutMilliseconds);
private static bool WaitAllIgnoreErrors(Task[] tasks, int timeout)
{
if (tasks == null) throw new ArgumentNullException(nameof(tasks));
if (tasks.Length == 0) return true;
var watch = Stopwatch.StartNew();
try
{
// if none error, great
if (Task.WaitAll(tasks, timeout)) return true;
}
catch
{ }
// if we get problems, need to give the non-failing ones time to finish
// to be fair and reasonable
for (int i = 0; i < tasks.Length; i++)
{
var task = tasks[i];
if (!task.IsCanceled && !task.IsCompleted && !task.IsFaulted)
{
var remaining = timeout - checked((int)watch.ElapsedMilliseconds);
if (remaining <= 0) return false;
try
{
task.Wait(remaining);
}
catch
{ }
}
}
return false;
}
internal bool AuthSuspect { get; private set; }
internal void SetAuthSuspect() => AuthSuspect = true;
private static void LogWithThreadPoolStats(LogProxy log, string message, out int busyWorkerCount)
{
busyWorkerCount = 0;
if (log != null)
{
var sb = new StringBuilder();
sb.Append(message);
busyWorkerCount = PerfCounterHelper.GetThreadPoolStats(out string iocp, out string worker);
sb.Append(", IOCP: ").Append(iocp).Append(", WORKER: ").Append(worker);
log?.WriteLine(sb.ToString());
}
}
private static bool AllComplete(Task[] tasks)
{
for (int i = 0; i < tasks.Length; i++)
{
var task = tasks[i];
if (!task.IsCanceled && !task.IsCompleted && !task.IsFaulted)
return false;
}
return true;
}
private async Task<bool> WaitAllIgnoreErrorsAsync(Task[] tasks, int timeoutMilliseconds, LogProxy log, [CallerMemberName] string caller = null, [CallerLineNumber] int callerLineNumber = 0)
{
if (tasks == null) throw new ArgumentNullException(nameof(tasks));
if (tasks.Length == 0)
{
log?.WriteLine("No tasks to await");
return true;
}
if (AllComplete(tasks))
{
log?.WriteLine("All tasks are already complete");
return true;
}
var watch = Stopwatch.StartNew();
LogWithThreadPoolStats(log, "Awaiting task completion", out _);
try
{
// if none error, great
var remaining = timeoutMilliseconds - checked((int)watch.ElapsedMilliseconds);
if (remaining <= 0)
{
LogWithThreadPoolStats(log, "Timeout before awaiting for tasks", out _);
return false;
}
var allTasks = Task.WhenAll(tasks).ObserveErrors();
bool all = await allTasks.TimeoutAfter(timeoutMs: remaining).ObserveErrors().ForAwait();
LogWithThreadPoolStats(log, all ? "All tasks completed cleanly" : $"Not all tasks completed cleanly (from {caller}#{callerLineNumber}, timeout {timeoutMilliseconds}ms)", out _);
return all;
}
catch
{ }
// if we get problems, need to give the non-failing ones time to finish
// to be fair and reasonable
for (int i = 0; i < tasks.Length; i++)
{
var task = tasks[i];
if (!task.IsCanceled && !task.IsCompleted && !task.IsFaulted)
{
var remaining = timeoutMilliseconds - checked((int)watch.ElapsedMilliseconds);
if (remaining <= 0)
{
LogWithThreadPoolStats(log, "Timeout awaiting tasks", out _);
return false;
}
try
{
await Task.WhenAny(task, Task.Delay(remaining)).ObserveErrors().ForAwait();
}
catch
{ }
}
}
LogWithThreadPoolStats(log, "Finished awaiting tasks", out _);
return false;
}
/// <summary>
/// Raised when a hash-slot has been relocated
/// </summary>
public event EventHandler<HashSlotMovedEventArgs> HashSlotMoved;
internal void OnHashSlotMoved(int hashSlot, EndPoint old, EndPoint @new)
{
var handler = HashSlotMoved;
if (handler != null)
{
ConnectionMultiplexer.CompleteAsWorker(
new HashSlotMovedEventArgs(handler, this, hashSlot, old, @new));
}
}
/// <summary>
/// Compute the hash-slot of a specified key
/// </summary>
/// <param name="key">The key to get a hash slot ID for.</param>
public int HashSlot(RedisKey key) => ServerSelectionStrategy.HashSlot(key);
internal ServerEndPoint AnyConnected(ServerType serverType, uint startOffset, RedisCommand command, CommandFlags flags)
{
var tmp = GetServerSnapshot();
int len = tmp.Length;
ServerEndPoint fallback = null;
for (int i = 0; i < len; i++)
{
var server = tmp[(int)(((uint)i + startOffset) % len)];
if (server != null && server.ServerType == serverType && server.IsSelectable(command))
{
if (server.IsReplica)
{
switch (flags)
{
case CommandFlags.DemandReplica:
case CommandFlags.PreferReplica:
return server;
case CommandFlags.PreferMaster:
fallback = server;
break;
}
}
else
{
switch (flags)
{
case CommandFlags.DemandMaster:
case CommandFlags.PreferMaster:
return server;
case CommandFlags.PreferReplica:
fallback = server;
break;
}
}
}
}
return fallback;
}
private volatile bool _isDisposed;
internal bool IsDisposed => _isDisposed;
/// <summary>
/// Create a new ConnectionMultiplexer instance
/// </summary>
/// <param name="configuration">The string configuration to use for this multiplexer.</param>
/// <param name="log">The <see cref="TextWriter"/> to log to.</param>
public static Task<ConnectionMultiplexer> ConnectAsync(string configuration, TextWriter log = null)
{
SocketConnection.AssertDependencies();
return ConnectAsync(ConfigurationOptions.Parse(configuration), log);
}
private static async Task<ConnectionMultiplexer> ConnectImplAsync(ConfigurationOptions configuration, TextWriter log = null)
{
IDisposable killMe = null;
EventHandler<ConnectionFailedEventArgs> connectHandler = null;
ConnectionMultiplexer muxer = null;
using (var logProxy = LogProxy.TryCreate(log))
{
try
{
muxer = CreateMultiplexer(configuration, logProxy, out connectHandler);
killMe = muxer;
Interlocked.Increment(ref muxer._connectAttemptCount);
bool configured = await muxer.ReconfigureAsync(true, false, logProxy, null, "connect").ObserveErrors().ForAwait();
if (!configured)
{
throw ExceptionFactory.UnableToConnect(muxer, muxer.failureMessage);
}
killMe = null;
Interlocked.Increment(ref muxer._connectCompletedCount);
if (muxer.ServerSelectionStrategy.ServerType == ServerType.Sentinel)
{
// Initialize the Sentinel handlers
muxer.InitializeSentinel(logProxy);
}
return muxer;
}
finally
{
if (connectHandler != null) muxer.ConnectionFailed -= connectHandler;
if (killMe != null) try { killMe.Dispose(); } catch { }
}
}
}
/// <summary>
/// Create a new ConnectionMultiplexer instance
/// </summary>
/// <param name="configuration">The configuration options to use for this multiplexer.</param>
/// <param name="log">The <see cref="TextWriter"/> to log to.</param>
public static Task<ConnectionMultiplexer> ConnectAsync(ConfigurationOptions configuration, TextWriter log = null)
{
SocketConnection.AssertDependencies();
if (IsSentinel(configuration))
return SentinelMasterConnectAsync(configuration, log);
return ConnectImplAsync(PrepareConfig(configuration), log);
}
private static bool IsSentinel(ConfigurationOptions configuration)
{
return !string.IsNullOrEmpty(configuration?.ServiceName);
}
internal static ConfigurationOptions PrepareConfig(object configuration, bool sentinel = false)
{
if (configuration == null) throw new ArgumentNullException(nameof(configuration));
ConfigurationOptions config;
if (configuration is string s)
{
config = ConfigurationOptions.Parse(s);
}
else if (configuration is ConfigurationOptions configurationOptions)
{
config = (configurationOptions).Clone();
}
else
{
throw new ArgumentException("Invalid configuration object", nameof(configuration));
}
if (config.EndPoints.Count == 0) throw new ArgumentException("No endpoints specified", nameof(configuration));
if (sentinel)
{
config.SetSentinelDefaults();
return config;
}
config.SetDefaultPorts();
return config;
}
internal class LogProxy : IDisposable
{
public static LogProxy TryCreate(TextWriter writer)
=> writer == null ? null : new LogProxy(writer);
public override string ToString()
{
string s = null;
if (_log != null)
{
lock (SyncLock)
{
s = _log?.ToString();
}
}
return s ?? base.ToString();
}
private TextWriter _log;
public object SyncLock => this;
private LogProxy(TextWriter log) => _log = log;
public void WriteLine()
{
if (_log != null) // note: double-checked
{
lock (SyncLock)
{
_log?.WriteLine();
}
}
}
public void WriteLine(string message = null)
{
if (_log != null) // note: double-checked
{
lock (SyncLock)
{
_log?.WriteLine(message);
}
}
}
public void Dispose()
{
if (_log != null) // note: double-checked
{
lock (SyncLock) { _log = null; }
}
}
}
private static ConnectionMultiplexer CreateMultiplexer(ConfigurationOptions configuration, LogProxy log, out EventHandler<ConnectionFailedEventArgs> connectHandler)
{
var muxer = new ConnectionMultiplexer(configuration);
connectHandler = null;
if (log != null)
{
// create a detachable event-handler to log detailed errors if something happens during connect/handshake
connectHandler = (_, a) =>
{
try
{
lock (log.SyncLock) // keep the outer and any inner errors contiguous
{
var ex = a.Exception;
log?.WriteLine($"connection failed: {Format.ToString(a.EndPoint)} ({a.ConnectionType}, {a.FailureType}): {ex?.Message ?? "(unknown)"}");
while ((ex = ex.InnerException) != null)
{
log?.WriteLine($"> {ex.Message}");
}
}
}