summaryrefslogtreecommitdiff
path: root/mcs/class/corlib/System.Threading/SemaphoreSlim.cs
blob: 3a75238f4dfe390f68e1987546f77a826f7db304 (plain)
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
// SemaphoreSlim.cs
//
// Copyright (c) 2008 Jérémie "Garuma" Laval
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
//
//

using System;
using System.Diagnostics;
#if NET_4_5
using System.Threading.Tasks;
#endif

#if NET_4_0
namespace System.Threading
{
	[System.Diagnostics.DebuggerDisplayAttribute ("Current Count = {currCount}")]
	public class SemaphoreSlim : IDisposable
	{
		const int spinCount = 10;
		const int deepSleepTime = 20;

		readonly int maxCount;
		int currCount;
		bool isDisposed;

		EventWaitHandle handle;

		public SemaphoreSlim (int initialCount) : this (initialCount, int.MaxValue)
		{
		}

		public SemaphoreSlim (int initialCount, int maxCount)
		{
			if (initialCount < 0 || initialCount > maxCount || maxCount < 0)
				throw new ArgumentOutOfRangeException ("The initialCount  argument is negative, initialCount is greater than maxCount, or maxCount is not positive.");

			this.maxCount = maxCount;
			this.currCount = initialCount;
			this.handle = new ManualResetEvent (initialCount > 0);
		}

		public void Dispose ()
		{
			Dispose(true);
		}

		protected virtual void Dispose (bool disposing)
		{
			isDisposed = true;
		}

		void CheckState ()
		{
			if (isDisposed)
				throw new ObjectDisposedException ("The SemaphoreSlim has been disposed.");
		}

		public int CurrentCount {
			get {
				return currCount;
			}
		}

		public int Release ()
		{
			return Release(1);
		}

		public int Release (int releaseCount)
		{
			CheckState ();
			if (releaseCount < 1)
				throw new ArgumentOutOfRangeException ("releaseCount", "releaseCount is less than 1");

			// As we have to take care of the max limit we resort to CAS
			int oldValue, newValue;
			do {
				oldValue = currCount;
				newValue = (currCount + releaseCount);
				newValue = newValue > maxCount ? maxCount : newValue;
			} while (Interlocked.CompareExchange (ref currCount, newValue, oldValue) != oldValue);

			handle.Set ();

			return oldValue;
		}

		public void Wait ()
		{
			Wait (CancellationToken.None);
		}

		public bool Wait (TimeSpan timeout)
		{
			return Wait ((int)timeout.TotalMilliseconds, CancellationToken.None);
		}

		public bool Wait (int millisecondsTimeout)
		{
			return Wait (millisecondsTimeout, CancellationToken.None);
		}

		public void Wait (CancellationToken cancellationToken)
		{
			Wait (-1, cancellationToken);
		}

		public bool Wait (TimeSpan timeout, CancellationToken cancellationToken)
		{
			CheckState();
			return Wait ((int)timeout.TotalMilliseconds, cancellationToken);
		}

		public bool Wait (int millisecondsTimeout, CancellationToken cancellationToken)
		{
			CheckState ();
			if (millisecondsTimeout < -1)
				throw new ArgumentOutOfRangeException ("millisecondsTimeout",
				                                       "millisecondsTimeout is a negative number other than -1");

			Watch sw = Watch.StartNew ();

			Func<bool> stopCondition = () => millisecondsTimeout >= 0 && sw.ElapsedMilliseconds > millisecondsTimeout;

			do {
				bool shouldWait;
				int result;

				do {
					cancellationToken.ThrowIfCancellationRequested ();
					if (stopCondition ())
						return false;

					shouldWait = true;
					result = currCount;

					if (result > 0)
						shouldWait = false;
					else
						break;
				} while (Interlocked.CompareExchange (ref currCount, result - 1, result) != result);

				if (!shouldWait) {
					if (result == 1)
						handle.Reset ();
					break;
				}

				SpinWait wait = new SpinWait ();

				while (Thread.VolatileRead (ref currCount) <= 0) {
					cancellationToken.ThrowIfCancellationRequested ();
					if (stopCondition ())
						return false;

					if (wait.Count > spinCount)
						handle.WaitOne (Math.Min (Math.Max (millisecondsTimeout - (int)sw.ElapsedMilliseconds, 1), deepSleepTime));
					else
						wait.SpinOnce ();
				}
			} while (true);

			return true;
		}

		public WaitHandle AvailableWaitHandle {
			get {
				return handle;
			}
		}

#if NET_4_5
		public Task WaitAsync ()
		{
			return Task.Factory.StartNew (() => Wait ());
		}

		public Task WaitAsync (CancellationToken cancellationToken)
		{
			return Task.Factory.StartNew (() => Wait (cancellationToken), cancellationToken);
		}

		public Task<bool> WaitAsync (int millisecondsTimeout)
		{
			return Task.Factory.StartNew (() => Wait (millisecondsTimeout));
		}

		public Task<bool> WaitAsync (TimeSpan timeout)
		{
			return Task.Factory.StartNew (() => Wait (timeout));
		}

		public Task<bool> WaitAsync (int millisecondsTimeout, CancellationToken cancellationToken)
		{
			return Task.Factory.StartNew (() => Wait (millisecondsTimeout, cancellationToken), cancellationToken);
		}

		public Task<bool> WaitAsync (TimeSpan timeout, CancellationToken cancellationToken)
		{
			return Task.Factory.StartNew (() => Wait (timeout, cancellationToken), cancellationToken);
		}
#endif

	}
}
#endif