Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Re-use cancellation tokens in the https middleware #31528

Merged
merged 3 commits into from
Apr 6, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
// Copyright (c) .NET Foundation. All rights reserved.
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.

using System.Collections.Concurrent;
davidfowl marked this conversation as resolved.
Show resolved Hide resolved
using System.Threading;

namespace Microsoft.AspNetCore.Server.Kestrel.Core.Internal
{
internal class CancellationTokenSourcePool
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't this be disposable and dispose all tokens in the queue?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I put a note about it in the PR description.

The implementation doesn't have a dispose. The cost of storing 1024 tokens is tiny and it'll be unrooted once the server is unrooted.

{
private const int MaxQueueSize = 1024;

private readonly ConcurrentQueue<PooledCancellationTokenSource> _queue = new();
private int _count;

public PooledCancellationTokenSource Rent()
{
if (_queue.TryDequeue(out var cts))
{
Interlocked.Decrement(ref _count);
return cts;
}
return new PooledCancellationTokenSource(this);
}

private bool Return(PooledCancellationTokenSource cts)
{
if (Interlocked.Increment(ref _count) > MaxQueueSize || !cts.TryReset())
{
Interlocked.Decrement(ref _count);
return false;
}

_queue.Enqueue(cts);
return true;
}

/// <summary>
/// A <see cref="CancellationTokenSource"/> with a back pointer to the pool it came from.
/// Dispose will return it to the pool.
/// </summary>
public class PooledCancellationTokenSource : CancellationTokenSource
{
private readonly CancellationTokenSourcePool _pool;

public PooledCancellationTokenSource(CancellationTokenSourcePool pool)
{
_pool = pool;
}

protected override void Dispose(bool disposing)
{
if (disposing)
{
// If we failed to return to the pool then dispose
if (!_pool.Return(this))
{
base.Dispose(disposing);
}
}
}
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,9 @@ internal class HttpsConnectionMiddleware
private readonly HttpsOptionsCallback? _httpsOptionsCallback;
private readonly object? _httpsOptionsCallbackState;

// Pool for cancellation tokens that cancel the handshake
private readonly CancellationTokenSourcePool _ctsPool = new();

public HttpsConnectionMiddleware(ConnectionDelegate next, HttpsConnectionAdapterOptions options)
: this(next, options, loggerFactory: NullLoggerFactory.Instance)
{
Expand Down Expand Up @@ -150,7 +153,9 @@ public async Task OnConnectionAsync(ConnectionContext context)

try
{
using var cancellationTokenSource = new CancellationTokenSource(_handshakeTimeout);
using var cancellationTokenSource = _ctsPool.Rent();
cancellationTokenSource.CancelAfter(_handshakeTimeout);

if (_httpsOptionsCallback is null)
{
await DoOptionsBasedHandshakeAsync(context, sslStream, feature, cancellationTokenSource.Token);
Expand Down