-
Notifications
You must be signed in to change notification settings - Fork 295
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
525cf04
commit 16b34bf
Showing
2 changed files
with
165 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
164 changes: 164 additions & 0 deletions
164
CommunityToolkit.Mvvm.SourceGenerators/Helpers/ObjectPool{T}.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,164 @@ | ||
// Licensed to the .NET Foundation under one or more agreements. | ||
// The .NET Foundation licenses this file to you under the MIT license. | ||
// See the LICENSE file in the project root for more information. | ||
|
||
// Ported from Roslyn, see: https://github.com/dotnet/roslyn/blob/main/src/Dependencies/PooledObjects/ObjectPool%601.cs. | ||
|
||
using System; | ||
using System.Diagnostics; | ||
using System.Runtime.CompilerServices; | ||
using System.Threading; | ||
|
||
namespace Microsoft.CodeAnalysis.PooledObjects; | ||
|
||
/// <summary> | ||
/// <para> | ||
/// Generic implementation of object pooling pattern with predefined pool size limit. The main purpose | ||
/// is that limited number of frequently used objects can be kept in the pool for further recycling. | ||
/// </para> | ||
/// <para> | ||
/// Notes: | ||
/// <list type="number"> | ||
/// <item> | ||
/// It is not the goal to keep all returned objects. Pool is not meant for storage. If there | ||
/// is no space in the pool, extra returned objects will be dropped. | ||
/// </item> | ||
/// <item> | ||
/// It is implied that if object was obtained from a pool, the caller will return it back in | ||
/// a relatively short time. Keeping checked out objects for long durations is ok, but | ||
/// reduces usefulness of pooling. Just new up your own. | ||
/// </item> | ||
/// </list> | ||
/// </para> | ||
/// <para> | ||
/// Not returning objects to the pool in not detrimental to the pool's work, but is a bad practice. | ||
/// Rationale: if there is no intent for reusing the object, do not use pool - just use "new". | ||
/// </para> | ||
/// </summary> | ||
/// <typeparam name="T">The type of objects to pool.</typeparam> | ||
internal sealed class ObjectPool<T> | ||
where T : class | ||
{ | ||
/// <summary> | ||
/// The factory is stored for the lifetime of the pool. We will call this only when pool needs to | ||
/// expand. compared to "new T()", Func gives more flexibility to implementers and faster than "new T()". | ||
/// </summary> | ||
private readonly Func<T> factory; | ||
|
||
/// <summary> | ||
/// The array of cached items. | ||
/// </summary> | ||
private readonly Element[] items; | ||
|
||
/// <summary> | ||
/// Storage for the pool objects. The first item is stored in a dedicated field | ||
/// because we expect to be able to satisfy most requests from it. | ||
/// </summary> | ||
private T? firstItem; | ||
|
||
/// <summary> | ||
/// Creates a new <see cref="ObjectPool{T}"/> instance with the specified parameters. | ||
/// </summary> | ||
/// <param name="factory">The input factory to produce <typeparamref name="T"/> items.</param> | ||
public ObjectPool(Func<T> factory) | ||
: this(factory, Environment.ProcessorCount * 2) | ||
{ | ||
} | ||
|
||
/// <summary> | ||
/// Creates a new <see cref="ObjectPool{T}"/> instance with the specified parameters. | ||
/// </summary> | ||
/// <param name="factory">The input factory to produce <typeparamref name="T"/> items.</param> | ||
/// <param name="size">The pool size to use.</param> | ||
public ObjectPool(Func<T> factory, int size) | ||
{ | ||
this.factory = factory; | ||
this.items = new Element[size - 1]; | ||
} | ||
|
||
/// <summary> | ||
/// Produces a <typeparamref name="T"/> instance. | ||
/// </summary> | ||
/// <returns>The returned <typeparamref name="T"/> item to use.</returns> | ||
[MethodImpl(MethodImplOptions.AggressiveInlining)] | ||
public T Allocate() | ||
{ | ||
T? item = this.firstItem; | ||
|
||
if (item is null || item != Interlocked.CompareExchange(ref this.firstItem, null, item)) | ||
{ | ||
item = AllocateSlow(); | ||
} | ||
|
||
return item; | ||
} | ||
|
||
/// <summary> | ||
/// Returns a given <typeparamref name="T"/> instance to the pool. | ||
/// </summary> | ||
/// <param name="obj">The <typeparamref name="T"/> instance to return.</param> | ||
[MethodImpl(MethodImplOptions.AggressiveInlining)] | ||
public void Free(T obj) | ||
{ | ||
if (this.firstItem is null) | ||
{ | ||
this.firstItem = obj; | ||
} | ||
else | ||
{ | ||
FreeSlow(obj); | ||
} | ||
} | ||
|
||
/// <summary> | ||
/// Allocates a new <typeparamref name="T"/> item. | ||
/// </summary> | ||
/// <returns>The returned <typeparamref name="T"/> item to use.</returns> | ||
[MethodImpl(MethodImplOptions.NoInlining)] | ||
private T AllocateSlow() | ||
{ | ||
foreach (ref Element element in this.items.AsSpan()) | ||
{ | ||
T? instance = element.Value; | ||
|
||
if (instance is not null) | ||
{ | ||
if (instance == Interlocked.CompareExchange(ref element.Value, null, instance)) | ||
{ | ||
return instance; | ||
} | ||
} | ||
} | ||
|
||
return this.factory(); | ||
} | ||
|
||
/// <summary> | ||
/// Frees a given <typeparamref name="T"/> item. | ||
/// </summary> | ||
/// <param name="obj">The <typeparamref name="T"/> item to return to the pool.</param> | ||
[MethodImpl(MethodImplOptions.NoInlining)] | ||
private void FreeSlow(T obj) | ||
{ | ||
foreach (ref Element element in this.items.AsSpan()) | ||
{ | ||
if (element.Value is null) | ||
{ | ||
element.Value = obj; | ||
|
||
break; | ||
} | ||
} | ||
} | ||
|
||
/// <summary> | ||
/// A container for a produced item (using a <see langword="struct"/> wrapper to avoid covariance checks). | ||
/// </summary> | ||
private struct Element | ||
{ | ||
/// <summary> | ||
/// The value held at the current element. | ||
/// </summary> | ||
internal T? Value; | ||
} | ||
} |