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
|
// 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.
using System.Diagnostics;
namespace System.Threading
{
/// <summary>
/// Provides callbacks to objects whose lifetime is managed by <see cref="DeferredDisposableLifetime{T}"/>.
/// </summary>
internal interface IDeferredDisposable
{
/// <summary>
/// Called when the object's refcount reaches zero.
/// </summary>
/// <param name="disposed">
/// Indicates whether the object has been disposed.
/// </param>
/// <remarks>
/// If the refount reaches zero before the object is disposed, this method will be called with
/// <paramref name="disposed"/> set to false. If the object is then disposed, this method will be
/// called again, with <paramref name="disposed"/> set to true. If the refcount reaches zero
/// after the object has already been disposed, this will be called a single time, with
/// <paramref name="disposed"/> set to true.
/// </remarks>
void OnFinalRelease(bool disposed);
}
/// <summary>
/// Manages the lifetime of an object which implements IDisposable, but which must defer the actual
/// cleanup of state until all existing uses of the object are complete.
/// </summary>
/// <typeparam name="T">The type of object whose lifetime will be managed.</typeparam>
/// <remarks>
/// This type maintains a reference count, and tracks whether the object has been disposed. When
/// Callbacks are made to <see cref="IDeferredDisposable.OnFinalRelease(bool)"/> when the refcount
/// reaches zero. Objects that need to defer cleanup until they have been disposed *and* they have
/// no more references can do so in <see cref="IDeferredDisposable.OnFinalRelease(bool)"/> when
/// 'disposed' is true.
/// </remarks>
internal struct DeferredDisposableLifetime<T> where T : class, IDeferredDisposable
{
//
// _count is positive until Dispose is called, after which it's (-1 - refcount).
//
private int _count;
public bool AddRef(T obj)
{
while (true)
{
int oldCount = Volatile.Read(ref _count);
// Have we been disposed?
if (oldCount < 0)
throw new ObjectDisposedException(typeof(T).ToString());
int newCount = checked(oldCount + 1);
if (Interlocked.CompareExchange(ref _count, newCount, oldCount) == oldCount)
return true;
}
}
public void Release(T obj)
{
while (true)
{
int oldCount = Volatile.Read(ref _count);
if (oldCount > 0)
{
// We haven't been disposed. Decrement _count.
int newCount = oldCount - 1;
if (Interlocked.CompareExchange(ref _count, newCount, oldCount) == oldCount)
{
if (newCount == 0)
obj.OnFinalRelease(disposed: false);
return;
}
}
else
{
Debug.Assert(oldCount != 0 && oldCount != -1);
// We've been disposed. Increment _count.
int newCount = oldCount + 1;
if (Interlocked.CompareExchange(ref _count, newCount, oldCount) == oldCount)
{
if (newCount == -1)
obj.OnFinalRelease(disposed: true);
return;
}
}
}
}
public void Dispose(T obj)
{
while (true)
{
int oldCount = Volatile.Read(ref _count);
if (oldCount < 0)
return; // already disposed
int newCount = -1 - oldCount;
if (Interlocked.CompareExchange(ref _count, newCount, oldCount) == oldCount)
{
if (newCount == -1)
obj.OnFinalRelease(disposed: true);
return;
}
}
}
}
}
|