-
Notifications
You must be signed in to change notification settings - Fork 874
Expand file tree
/
Copy pathNpgsqlMultiHostDataSource.cs
More file actions
465 lines (403 loc) · 18 KB
/
NpgsqlMultiHostDataSource.cs
File metadata and controls
465 lines (403 loc) · 18 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
using Npgsql.Internal;
using Npgsql.Util;
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Diagnostics.CodeAnalysis;
using System.Threading;
using System.Threading.Tasks;
using System.Transactions;
namespace Npgsql;
/// <summary>
/// An <see cref="NpgsqlDataSource" /> which manages connections for multiple hosts, is aware of their states (primary, secondary,
/// offline...) and can perform failover and load balancing across them.
/// </summary>
/// <remarks>
/// See <see href="https://www.npgsql.org/doc/failover-and-load-balancing.html" />.
/// </remarks>
public sealed class NpgsqlMultiHostDataSource : NpgsqlDataSource
{
internal override bool OwnsConnectors => false;
readonly NpgsqlDataSource[] _pools;
internal NpgsqlDataSource[] Pools => _pools;
readonly MultiHostDataSourceWrapper[] _wrappers;
volatile int _roundRobinIndex = -1;
internal NpgsqlMultiHostDataSource(NpgsqlConnectionStringBuilder settings, NpgsqlDataSourceConfiguration dataSourceConfig)
: base(settings, dataSourceConfig, reportMetrics: false)
{
var hosts = settings.Host!.Split(',');
_pools = new NpgsqlDataSource[hosts.Length];
for (var i = 0; i < hosts.Length; i++)
{
var poolSettings = settings.Clone();
var host = hosts[i].AsSpan().Trim();
if (NpgsqlConnectionStringBuilder.TrySplitHostPort(host, out var newHost, out var newPort))
{
poolSettings.Host = newHost;
poolSettings.Port = newPort;
}
else
poolSettings.Host = host.ToString();
_pools[i] = settings.Pooling
? new PoolingDataSource(poolSettings, dataSourceConfig)
: new UnpooledDataSource(poolSettings, dataSourceConfig);
}
var targetSessionAttributeValues = Enum.GetValues<TargetSessionAttributes>();
var highestValue = 0;
foreach (var value in targetSessionAttributeValues)
if ((int)value > highestValue)
highestValue = (int)value;
_wrappers = new MultiHostDataSourceWrapper[highestValue + 1];
foreach (var targetSessionAttribute in targetSessionAttributeValues)
_wrappers[(int)targetSessionAttribute] = new(this, targetSessionAttribute);
}
/// <summary>
/// Returns a new, unopened connection from this data source.
/// </summary>
/// <param name="targetSessionAttributes">Specifies the server type (e.g. primary, standby).</param>
public NpgsqlConnection CreateConnection(TargetSessionAttributes targetSessionAttributes)
=> NpgsqlConnection.FromDataSource(_wrappers[(int)targetSessionAttributes]);
/// <summary>
/// Returns a new, opened connection from this data source.
/// </summary>
/// <param name="targetSessionAttributes">Specifies the server type (e.g. primary, standby).</param>
public NpgsqlConnection OpenConnection(TargetSessionAttributes targetSessionAttributes)
{
var connection = CreateConnection(targetSessionAttributes);
try
{
connection.Open();
return connection;
}
catch
{
connection.Dispose();
throw;
}
}
/// <summary>
/// Returns a new, opened connection from this data source.
/// </summary>
/// <param name="targetSessionAttributes">Specifies the server type (e.g. primary, standby).</param>
/// <param name="cancellationToken">
/// An optional token to cancel the asynchronous operation. The default value is <see cref="CancellationToken.None"/>.
/// </param>
public async ValueTask<NpgsqlConnection> OpenConnectionAsync(
TargetSessionAttributes targetSessionAttributes,
CancellationToken cancellationToken = default)
{
var connection = CreateConnection(targetSessionAttributes);
try
{
await connection.OpenAsync(cancellationToken).ConfigureAwait(false);
return connection;
}
catch
{
await connection.DisposeAsync().ConfigureAwait(false);
throw;
}
}
/// <summary>
/// Returns an <see cref="NpgsqlDataSource" /> that wraps this multi-host one with the given server type.
/// </summary>
/// <param name="targetSessionAttributes">Specifies the server type (e.g. primary, standby).</param>
public NpgsqlDataSource WithTargetSession(TargetSessionAttributes targetSessionAttributes)
=> _wrappers[(int)targetSessionAttributes];
static bool IsPreferred(DatabaseState state, TargetSessionAttributes preferredType)
=> state switch
{
DatabaseState.Offline => false,
DatabaseState.Unknown => true, // We will check compatibility again after refreshing the database state
DatabaseState.PrimaryReadWrite when preferredType is
TargetSessionAttributes.Primary or
TargetSessionAttributes.PreferPrimary or
TargetSessionAttributes.ReadWrite
=> true,
DatabaseState.PrimaryReadOnly when preferredType is
TargetSessionAttributes.Primary or
TargetSessionAttributes.PreferPrimary or
TargetSessionAttributes.ReadOnly
=> true,
DatabaseState.Standby when preferredType is
TargetSessionAttributes.Standby or
TargetSessionAttributes.PreferStandby or
TargetSessionAttributes.ReadOnly
=> true,
_ => preferredType == TargetSessionAttributes.Any
};
static bool IsOnline(DatabaseState state, TargetSessionAttributes preferredType)
{
Debug.Assert(preferredType is TargetSessionAttributes.PreferPrimary or TargetSessionAttributes.PreferStandby);
return state != DatabaseState.Offline;
}
async ValueTask<NpgsqlConnector?> TryGetIdleOrNew(
NpgsqlConnection conn,
TimeSpan timeoutPerHost,
bool async,
TargetSessionAttributes preferredType, Func<DatabaseState, TargetSessionAttributes, bool> stateValidator,
int poolIndex,
IList<Exception> exceptions,
CancellationToken cancellationToken)
{
var pools = _pools;
for (var i = 0; i < pools.Length; i++)
{
var pool = pools[poolIndex];
poolIndex++;
if (poolIndex == pools.Length)
poolIndex = 0;
var databaseState = pool.GetDatabaseState();
if (!stateValidator(databaseState, preferredType))
continue;
NpgsqlConnector? connector = null;
try
{
if (pool.TryGetIdleConnector(out connector))
{
if (databaseState == DatabaseState.Unknown)
{
databaseState = await connector.QueryDatabaseState(new NpgsqlTimeout(timeoutPerHost), async, cancellationToken).ConfigureAwait(false);
Debug.Assert(databaseState != DatabaseState.Unknown);
if (!stateValidator(databaseState, preferredType))
{
pool.Return(connector);
continue;
}
}
return connector;
}
else
{
connector = await pool.OpenNewConnector(conn, new NpgsqlTimeout(timeoutPerHost), async, cancellationToken).ConfigureAwait(false);
if (connector is not null)
{
if (databaseState == DatabaseState.Unknown)
{
// While opening a new connector we might have refreshed the database state, check again
databaseState = pool.GetDatabaseState();
if (databaseState == DatabaseState.Unknown)
databaseState = await connector.QueryDatabaseState(new NpgsqlTimeout(timeoutPerHost), async, cancellationToken).ConfigureAwait(false);
Debug.Assert(databaseState != DatabaseState.Unknown);
if (!stateValidator(databaseState, preferredType))
{
pool.Return(connector);
continue;
}
}
return connector;
}
}
}
catch (OperationCanceledException oce) when (cancellationToken.IsCancellationRequested && oce.CancellationToken == cancellationToken)
{
if (connector is not null)
pool.Return(connector);
throw;
}
catch (Exception ex)
{
exceptions.Add(ex);
if (connector is not null)
pool.Return(connector);
}
}
return null;
}
async ValueTask<NpgsqlConnector?> TryGet(
NpgsqlConnection conn,
TimeSpan timeoutPerHost,
bool async,
TargetSessionAttributes preferredType,
Func<DatabaseState, TargetSessionAttributes, bool> stateValidator,
int poolIndex,
IList<Exception> exceptions,
CancellationToken cancellationToken)
{
var pools = _pools;
for (var i = 0; i < pools.Length; i++)
{
var pool = pools[poolIndex];
poolIndex++;
if (poolIndex == pools.Length)
poolIndex = 0;
var databaseState = pool.GetDatabaseState();
if (!stateValidator(databaseState, preferredType))
continue;
NpgsqlConnector? connector = null;
try
{
connector = await pool.Get(conn, new NpgsqlTimeout(timeoutPerHost), async, cancellationToken).ConfigureAwait(false);
if (databaseState == DatabaseState.Unknown)
{
// Get might have opened a new physical connection and refreshed the database state, check again
databaseState = pool.GetDatabaseState();
if (databaseState == DatabaseState.Unknown)
databaseState = await connector.QueryDatabaseState(new NpgsqlTimeout(timeoutPerHost), async, cancellationToken).ConfigureAwait(false);
Debug.Assert(databaseState != DatabaseState.Unknown);
if (!stateValidator(databaseState, preferredType))
{
pool.Return(connector);
continue;
}
}
return connector;
}
catch (Exception ex)
{
exceptions.Add(ex);
if (connector is not null)
pool.Return(connector);
}
}
return null;
}
internal override async ValueTask<NpgsqlConnector> Get(
NpgsqlConnection conn,
NpgsqlTimeout timeout,
bool async,
CancellationToken cancellationToken)
{
CheckDisposed();
var exceptions = new List<Exception>();
var poolIndex = conn.Settings.LoadBalanceHosts ? GetRoundRobinIndex() : 0;
var timeoutPerHost = timeout.IsSet ? timeout.CheckAndGetTimeLeft() : TimeSpan.Zero;
var preferredType = GetTargetSessionAttributes(conn);
var checkUnpreferred = preferredType is TargetSessionAttributes.PreferPrimary or TargetSessionAttributes.PreferStandby;
var connector = await TryGetIdleOrNew(conn, timeoutPerHost, async, preferredType, IsPreferred, poolIndex, exceptions, cancellationToken).ConfigureAwait(false) ??
(checkUnpreferred ?
await TryGetIdleOrNew(conn, timeoutPerHost, async, preferredType, IsOnline, poolIndex, exceptions, cancellationToken).ConfigureAwait(false)
: null) ??
await TryGet(conn, timeoutPerHost, async, preferredType, IsPreferred, poolIndex, exceptions, cancellationToken).ConfigureAwait(false) ??
(checkUnpreferred ?
await TryGet(conn, timeoutPerHost, async, preferredType, IsOnline, poolIndex, exceptions, cancellationToken).ConfigureAwait(false)
: null);
return connector ?? throw NoSuitableHostsException(exceptions);
}
static NpgsqlException NoSuitableHostsException(IList<Exception> exceptions)
{
return exceptions.Count == 0
? new NpgsqlException("No suitable host was found.")
: exceptions[0] is PostgresException firstException && AllEqual(firstException, exceptions)
? firstException
: new NpgsqlException("Unable to connect to a suitable host. Check inner exception for more details.",
new AggregateException(exceptions));
static bool AllEqual(PostgresException first, IList<Exception> exceptions)
{
foreach (var x in exceptions)
if (x is not PostgresException ex || ex.SqlState != first.SqlState)
return false;
return true;
}
}
int GetRoundRobinIndex()
{
while (true)
{
var index = Interlocked.Increment(ref _roundRobinIndex);
if (index >= 0)
return index % _pools.Length;
// Worst case scenario - we've wrapped around integer counter
if (index == int.MinValue)
{
// This is the thread which wrapped around the counter - reset it to 0
_roundRobinIndex = 0;
return 0;
}
// This is not the thread which wrapped around the counter - just wait until it's 0 or more
var sw = new SpinWait();
while (_roundRobinIndex < 0)
sw.SpinOnce();
}
}
internal override void Return(NpgsqlConnector connector)
=> throw new NpgsqlException("Npgsql bug: a connector was returned to " + nameof(NpgsqlMultiHostDataSource));
internal override bool TryGetIdleConnector([NotNullWhen(true)] out NpgsqlConnector? connector)
=> throw new NpgsqlException("Npgsql bug: trying to get an idle connector from " + nameof(NpgsqlMultiHostDataSource));
internal override ValueTask<NpgsqlConnector?> OpenNewConnector(NpgsqlConnection conn, NpgsqlTimeout timeout, bool async, CancellationToken cancellationToken)
=> throw new NpgsqlException("Npgsql bug: trying to open a new connector from " + nameof(NpgsqlMultiHostDataSource));
/// <inheritdoc />
public override void Clear()
{
foreach (var pool in _pools)
pool.Clear();
}
/// <summary>
/// Clears the database state (primary, secondary, offline...) for all data sources managed by this multi-host data source.
/// Can be useful to make Npgsql retry a PostgreSQL instance which was previously detected to be offline.
/// </summary>
public void ClearDatabaseStates()
{
foreach (var pool in _pools)
{
pool.UpdateDatabaseState(default, default, default, ignoreTimeStamp: true);
}
}
internal override (int Total, int Idle, int Busy) Statistics
{
get
{
var numConnectors = 0;
var idleCount = 0;
foreach (var pool in _pools)
{
var stat = pool.Statistics;
numConnectors += stat.Total;
idleCount += stat.Idle;
}
return (numConnectors, idleCount, numConnectors - idleCount);
}
}
internal override bool TryRentEnlistedPending(
Transaction transaction,
NpgsqlConnection connection,
[NotNullWhen(true)] out NpgsqlConnector? connector)
{
lock (_pendingEnlistedConnectors)
{
if (!_pendingEnlistedConnectors.TryGetValue(transaction, out var list))
{
connector = null;
return false;
}
var preferredType = GetTargetSessionAttributes(connection);
// First try to get a valid preferred connector.
if (TryGetValidConnector(list, preferredType, IsPreferred, out connector))
{
return true;
}
// Can't get valid preferred connector. Try to get an unpreferred connector, if supported.
if ((preferredType == TargetSessionAttributes.PreferPrimary || preferredType == TargetSessionAttributes.PreferStandby)
&& TryGetValidConnector(list, preferredType, IsOnline, out connector))
{
return true;
}
connector = null;
return false;
}
bool TryGetValidConnector(List<NpgsqlConnector> list, TargetSessionAttributes preferredType,
Func<DatabaseState, TargetSessionAttributes, bool> validationFunc, [NotNullWhen(true)] out NpgsqlConnector? connector)
{
for (var i = list.Count - 1; i >= 0; i--)
{
connector = list[i];
var lastKnownState = connector.DataSource.GetDatabaseState(ignoreExpiration: true);
Debug.Assert(lastKnownState != DatabaseState.Unknown);
if (validationFunc(lastKnownState, preferredType))
{
list.RemoveAt(i);
if (list.Count == 0)
_pendingEnlistedConnectors.Remove(transaction);
return true;
}
}
connector = null;
return false;
}
}
static TargetSessionAttributes GetTargetSessionAttributes(NpgsqlConnection connection)
=> connection.Settings.TargetSessionAttributesParsed ??
(PostgresEnvironment.TargetSessionAttributes is { } s
? NpgsqlConnectionStringBuilder.ParseTargetSessionAttributes(s.ToLowerInvariant())
: TargetSessionAttributes.Any);
}