1 |
/* |
2 |
* Written by Doug Lea with assistance from members of JCP JSR-166 |
3 |
* Expert Group and released to the public domain, as explained at |
4 |
* http://creativecommons.org/publicdomain/zero/1.0/ |
5 |
*/ |
6 |
|
7 |
package java.util.concurrent; |
8 |
|
9 |
import java.util.Collection; |
10 |
import java.util.concurrent.locks.AbstractQueuedSynchronizer; |
11 |
|
12 |
/** |
13 |
* A counting semaphore. Conceptually, a semaphore maintains a set of |
14 |
* permits. Each {@link #acquire} blocks if necessary until a permit is |
15 |
* available, and then takes it. Each {@link #release} adds a permit, |
16 |
* potentially releasing a blocking acquirer. |
17 |
* However, no actual permit objects are used; the {@code Semaphore} just |
18 |
* keeps a count of the number available and acts accordingly. |
19 |
* |
20 |
* <p>Semaphores are often used to restrict the number of threads than can |
21 |
* access some (physical or logical) resource. For example, here is |
22 |
* a class that uses a semaphore to control access to a pool of items: |
23 |
* <pre> {@code |
24 |
* class Pool { |
25 |
* private static final int MAX_AVAILABLE = 100; |
26 |
* private final Semaphore available = new Semaphore(MAX_AVAILABLE, true); |
27 |
* |
28 |
* public Object getItem() throws InterruptedException { |
29 |
* available.acquire(); |
30 |
* return getNextAvailableItem(); |
31 |
* } |
32 |
* |
33 |
* public void putItem(Object x) { |
34 |
* if (markAsUnused(x)) |
35 |
* available.release(); |
36 |
* } |
37 |
* |
38 |
* // Not a particularly efficient data structure; just for demo |
39 |
* |
40 |
* protected Object[] items = ... whatever kinds of items being managed |
41 |
* protected boolean[] used = new boolean[MAX_AVAILABLE]; |
42 |
* |
43 |
* protected synchronized Object getNextAvailableItem() { |
44 |
* for (int i = 0; i < MAX_AVAILABLE; ++i) { |
45 |
* if (!used[i]) { |
46 |
* used[i] = true; |
47 |
* return items[i]; |
48 |
* } |
49 |
* } |
50 |
* return null; // not reached |
51 |
* } |
52 |
* |
53 |
* protected synchronized boolean markAsUnused(Object item) { |
54 |
* for (int i = 0; i < MAX_AVAILABLE; ++i) { |
55 |
* if (item == items[i]) { |
56 |
* if (used[i]) { |
57 |
* used[i] = false; |
58 |
* return true; |
59 |
* } else |
60 |
* return false; |
61 |
* } |
62 |
* } |
63 |
* return false; |
64 |
* } |
65 |
* }}</pre> |
66 |
* |
67 |
* <p>Before obtaining an item each thread must acquire a permit from |
68 |
* the semaphore, guaranteeing that an item is available for use. When |
69 |
* the thread has finished with the item it is returned back to the |
70 |
* pool and a permit is returned to the semaphore, allowing another |
71 |
* thread to acquire that item. Note that no synchronization lock is |
72 |
* held when {@link #acquire} is called as that would prevent an item |
73 |
* from being returned to the pool. The semaphore encapsulates the |
74 |
* synchronization needed to restrict access to the pool, separately |
75 |
* from any synchronization needed to maintain the consistency of the |
76 |
* pool itself. |
77 |
* |
78 |
* <p>A semaphore initialized to one, and which is used such that it |
79 |
* only has at most one permit available, can serve as a mutual |
80 |
* exclusion lock. This is more commonly known as a <em>binary |
81 |
* semaphore</em>, because it only has two states: one permit |
82 |
* available, or zero permits available. When used in this way, the |
83 |
* binary semaphore has the property (unlike many {@link java.util.concurrent.locks.Lock} |
84 |
* implementations), that the "lock" can be released by a |
85 |
* thread other than the owner (as semaphores have no notion of |
86 |
* ownership). This can be useful in some specialized contexts, such |
87 |
* as deadlock recovery. |
88 |
* |
89 |
* <p>The constructor for this class optionally accepts a |
90 |
* <em>fairness</em> parameter. When set false, this class makes no |
91 |
* guarantees about the order in which threads acquire permits. In |
92 |
* particular, <em>barging</em> is permitted, that is, a thread |
93 |
* invoking {@link #acquire} can be allocated a permit ahead of a |
94 |
* thread that has been waiting - logically the new thread places itself at |
95 |
* the head of the queue of waiting threads. When fairness is set true, the |
96 |
* semaphore guarantees that threads invoking any of the {@link |
97 |
* #acquire() acquire} methods are selected to obtain permits in the order in |
98 |
* which their invocation of those methods was processed |
99 |
* (first-in-first-out; FIFO). Note that FIFO ordering necessarily |
100 |
* applies to specific internal points of execution within these |
101 |
* methods. So, it is possible for one thread to invoke |
102 |
* {@code acquire} before another, but reach the ordering point after |
103 |
* the other, and similarly upon return from the method. |
104 |
* Also note that the untimed {@link #tryAcquire() tryAcquire} methods do not |
105 |
* honor the fairness setting, but will take any permits that are |
106 |
* available. |
107 |
* |
108 |
* <p>Generally, semaphores used to control resource access should be |
109 |
* initialized as fair, to ensure that no thread is starved out from |
110 |
* accessing a resource. When using semaphores for other kinds of |
111 |
* synchronization control, the throughput advantages of non-fair |
112 |
* ordering often outweigh fairness considerations. |
113 |
* |
114 |
* <p>This class also provides convenience methods to {@link |
115 |
* #acquire(int) acquire} and {@link #release(int) release} multiple |
116 |
* permits at a time. Beware of the increased risk of indefinite |
117 |
* postponement when these methods are used without fairness set true. |
118 |
* |
119 |
* <p>Memory consistency effects: Actions in a thread prior to calling |
120 |
* a "release" method such as {@code release()} |
121 |
* <a href="package-summary.html#MemoryVisibility"><i>happen-before</i></a> |
122 |
* actions following a successful "acquire" method such as {@code acquire()} |
123 |
* in another thread. |
124 |
* |
125 |
* @since 1.5 |
126 |
* @author Doug Lea |
127 |
*/ |
128 |
public class Semaphore implements java.io.Serializable { |
129 |
private static final long serialVersionUID = -3222578661600680210L; |
130 |
/** All mechanics via AbstractQueuedSynchronizer subclass */ |
131 |
private final Sync sync; |
132 |
|
133 |
/** |
134 |
* Synchronization implementation for semaphore. Uses AQS state |
135 |
* to represent permits. Subclassed into fair and nonfair |
136 |
* versions. |
137 |
*/ |
138 |
abstract static class Sync extends AbstractQueuedSynchronizer { |
139 |
private static final long serialVersionUID = 1192457210091910933L; |
140 |
|
141 |
Sync(int permits) { |
142 |
setState(permits); |
143 |
} |
144 |
|
145 |
final int getPermits() { |
146 |
return getState(); |
147 |
} |
148 |
|
149 |
final int nonfairTryAcquireShared(int acquires) { |
150 |
for (;;) { |
151 |
int available = getState(); |
152 |
int remaining = available - acquires; |
153 |
if (remaining < 0 || |
154 |
compareAndSetState(available, remaining)) |
155 |
return remaining; |
156 |
} |
157 |
} |
158 |
|
159 |
protected final boolean tryReleaseShared(int releases) { |
160 |
for (;;) { |
161 |
int current = getState(); |
162 |
int next = current + releases; |
163 |
if (next < current) // overflow |
164 |
throw new Error("Maximum permit count exceeded"); |
165 |
if (compareAndSetState(current, next)) |
166 |
return true; |
167 |
} |
168 |
} |
169 |
|
170 |
final void reducePermits(int reductions) { |
171 |
for (;;) { |
172 |
int current = getState(); |
173 |
int next = current - reductions; |
174 |
if (next > current) // underflow |
175 |
throw new Error("Permit count underflow"); |
176 |
if (compareAndSetState(current, next)) |
177 |
return; |
178 |
} |
179 |
} |
180 |
|
181 |
final int drainPermits() { |
182 |
for (;;) { |
183 |
int current = getState(); |
184 |
if (current == 0 || compareAndSetState(current, 0)) |
185 |
return current; |
186 |
} |
187 |
} |
188 |
} |
189 |
|
190 |
/** |
191 |
* NonFair version |
192 |
*/ |
193 |
static final class NonfairSync extends Sync { |
194 |
private static final long serialVersionUID = -2694183684443567898L; |
195 |
|
196 |
NonfairSync(int permits) { |
197 |
super(permits); |
198 |
} |
199 |
|
200 |
protected int tryAcquireShared(int acquires) { |
201 |
return nonfairTryAcquireShared(acquires); |
202 |
} |
203 |
} |
204 |
|
205 |
/** |
206 |
* Fair version |
207 |
*/ |
208 |
static final class FairSync extends Sync { |
209 |
private static final long serialVersionUID = 2014338818796000944L; |
210 |
|
211 |
FairSync(int permits) { |
212 |
super(permits); |
213 |
} |
214 |
|
215 |
protected int tryAcquireShared(int acquires) { |
216 |
for (;;) { |
217 |
if (hasQueuedPredecessors()) |
218 |
return -1; |
219 |
int available = getState(); |
220 |
int remaining = available - acquires; |
221 |
if (remaining < 0 || |
222 |
compareAndSetState(available, remaining)) |
223 |
return remaining; |
224 |
} |
225 |
} |
226 |
} |
227 |
|
228 |
/** |
229 |
* Creates a {@code Semaphore} with the given number of |
230 |
* permits and nonfair fairness setting. |
231 |
* |
232 |
* @param permits the initial number of permits available. |
233 |
* This value may be negative, in which case releases |
234 |
* must occur before any acquires will be granted. |
235 |
*/ |
236 |
public Semaphore(int permits) { |
237 |
sync = new NonfairSync(permits); |
238 |
} |
239 |
|
240 |
/** |
241 |
* Creates a {@code Semaphore} with the given number of |
242 |
* permits and the given fairness setting. |
243 |
* |
244 |
* @param permits the initial number of permits available. |
245 |
* This value may be negative, in which case releases |
246 |
* must occur before any acquires will be granted. |
247 |
* @param fair {@code true} if this semaphore will guarantee |
248 |
* first-in first-out granting of permits under contention, |
249 |
* else {@code false} |
250 |
*/ |
251 |
public Semaphore(int permits, boolean fair) { |
252 |
sync = fair ? new FairSync(permits) : new NonfairSync(permits); |
253 |
} |
254 |
|
255 |
/** |
256 |
* Acquires a permit from this semaphore, blocking until one is |
257 |
* available, or the thread is {@linkplain Thread#interrupt interrupted}. |
258 |
* |
259 |
* <p>Acquires a permit, if one is available and returns immediately, |
260 |
* reducing the number of available permits by one. |
261 |
* |
262 |
* <p>If no permit is available then the current thread becomes |
263 |
* disabled for thread scheduling purposes and lies dormant until |
264 |
* one of two things happens: |
265 |
* <ul> |
266 |
* <li>Some other thread invokes the {@link #release} method for this |
267 |
* semaphore and the current thread is next to be assigned a permit; or |
268 |
* <li>Some other thread {@linkplain Thread#interrupt interrupts} |
269 |
* the current thread. |
270 |
* </ul> |
271 |
* |
272 |
* <p>If the current thread: |
273 |
* <ul> |
274 |
* <li>has its interrupted status set on entry to this method; or |
275 |
* <li>is {@linkplain Thread#interrupt interrupted} while waiting |
276 |
* for a permit, |
277 |
* </ul> |
278 |
* then {@link InterruptedException} is thrown and the current thread's |
279 |
* interrupted status is cleared. |
280 |
* |
281 |
* @throws InterruptedException if the current thread is interrupted |
282 |
*/ |
283 |
public void acquire() throws InterruptedException { |
284 |
sync.acquireSharedInterruptibly(1); |
285 |
} |
286 |
|
287 |
/** |
288 |
* Acquires a permit from this semaphore, blocking until one is |
289 |
* available. |
290 |
* |
291 |
* <p>Acquires a permit, if one is available and returns immediately, |
292 |
* reducing the number of available permits by one. |
293 |
* |
294 |
* <p>If no permit is available then the current thread becomes |
295 |
* disabled for thread scheduling purposes and lies dormant until |
296 |
* some other thread invokes the {@link #release} method for this |
297 |
* semaphore and the current thread is next to be assigned a permit. |
298 |
* |
299 |
* <p>If the current thread is {@linkplain Thread#interrupt interrupted} |
300 |
* while waiting for a permit then it will continue to wait, but the |
301 |
* time at which the thread is assigned a permit may change compared to |
302 |
* the time it would have received the permit had no interruption |
303 |
* occurred. When the thread does return from this method its interrupt |
304 |
* status will be set. |
305 |
*/ |
306 |
public void acquireUninterruptibly() { |
307 |
sync.acquireShared(1); |
308 |
} |
309 |
|
310 |
/** |
311 |
* Acquires a permit from this semaphore, only if one is available at the |
312 |
* time of invocation. |
313 |
* |
314 |
* <p>Acquires a permit, if one is available and returns immediately, |
315 |
* with the value {@code true}, |
316 |
* reducing the number of available permits by one. |
317 |
* |
318 |
* <p>If no permit is available then this method will return |
319 |
* immediately with the value {@code false}. |
320 |
* |
321 |
* <p>Even when this semaphore has been set to use a |
322 |
* fair ordering policy, a call to {@code tryAcquire()} <em>will</em> |
323 |
* immediately acquire a permit if one is available, whether or not |
324 |
* other threads are currently waiting. |
325 |
* This "barging" behavior can be useful in certain |
326 |
* circumstances, even though it breaks fairness. If you want to honor |
327 |
* the fairness setting, then use |
328 |
* {@link #tryAcquire(long, TimeUnit) tryAcquire(0, TimeUnit.SECONDS) } |
329 |
* which is almost equivalent (it also detects interruption). |
330 |
* |
331 |
* @return {@code true} if a permit was acquired and {@code false} |
332 |
* otherwise |
333 |
*/ |
334 |
public boolean tryAcquire() { |
335 |
return sync.nonfairTryAcquireShared(1) >= 0; |
336 |
} |
337 |
|
338 |
/** |
339 |
* Acquires a permit from this semaphore, if one becomes available |
340 |
* within the given waiting time and the current thread has not |
341 |
* been {@linkplain Thread#interrupt interrupted}. |
342 |
* |
343 |
* <p>Acquires a permit, if one is available and returns immediately, |
344 |
* with the value {@code true}, |
345 |
* reducing the number of available permits by one. |
346 |
* |
347 |
* <p>If no permit is available then the current thread becomes |
348 |
* disabled for thread scheduling purposes and lies dormant until |
349 |
* one of three things happens: |
350 |
* <ul> |
351 |
* <li>Some other thread invokes the {@link #release} method for this |
352 |
* semaphore and the current thread is next to be assigned a permit; or |
353 |
* <li>Some other thread {@linkplain Thread#interrupt interrupts} |
354 |
* the current thread; or |
355 |
* <li>The specified waiting time elapses. |
356 |
* </ul> |
357 |
* |
358 |
* <p>If a permit is acquired then the value {@code true} is returned. |
359 |
* |
360 |
* <p>If the current thread: |
361 |
* <ul> |
362 |
* <li>has its interrupted status set on entry to this method; or |
363 |
* <li>is {@linkplain Thread#interrupt interrupted} while waiting |
364 |
* to acquire a permit, |
365 |
* </ul> |
366 |
* then {@link InterruptedException} is thrown and the current thread's |
367 |
* interrupted status is cleared. |
368 |
* |
369 |
* <p>If the specified waiting time elapses then the value {@code false} |
370 |
* is returned. If the time is less than or equal to zero, the method |
371 |
* will not wait at all. |
372 |
* |
373 |
* @param timeout the maximum time to wait for a permit |
374 |
* @param unit the time unit of the {@code timeout} argument |
375 |
* @return {@code true} if a permit was acquired and {@code false} |
376 |
* if the waiting time elapsed before a permit was acquired |
377 |
* @throws InterruptedException if the current thread is interrupted |
378 |
*/ |
379 |
public boolean tryAcquire(long timeout, TimeUnit unit) |
380 |
throws InterruptedException { |
381 |
return sync.tryAcquireSharedNanos(1, unit.toNanos(timeout)); |
382 |
} |
383 |
|
384 |
/** |
385 |
* Releases a permit, returning it to the semaphore. |
386 |
* |
387 |
* <p>Releases a permit, increasing the number of available permits by |
388 |
* one. If any threads are trying to acquire a permit, then one is |
389 |
* selected and given the permit that was just released. That thread |
390 |
* is (re)enabled for thread scheduling purposes. |
391 |
* |
392 |
* <p>There is no requirement that a thread that releases a permit must |
393 |
* have acquired that permit by calling {@link #acquire}. |
394 |
* Correct usage of a semaphore is established by programming convention |
395 |
* in the application. |
396 |
*/ |
397 |
public void release() { |
398 |
sync.releaseShared(1); |
399 |
} |
400 |
|
401 |
/** |
402 |
* Acquires the given number of permits from this semaphore, |
403 |
* blocking until all are available, |
404 |
* or the thread is {@linkplain Thread#interrupt interrupted}. |
405 |
* |
406 |
* <p>Acquires the given number of permits, if they are available, |
407 |
* and returns immediately, reducing the number of available permits |
408 |
* by the given amount. |
409 |
* |
410 |
* <p>If insufficient permits are available then the current thread becomes |
411 |
* disabled for thread scheduling purposes and lies dormant until |
412 |
* one of two things happens: |
413 |
* <ul> |
414 |
* <li>Some other thread invokes one of the {@link #release() release} |
415 |
* methods for this semaphore, the current thread is next to be assigned |
416 |
* permits and the number of available permits satisfies this request; or |
417 |
* <li>Some other thread {@linkplain Thread#interrupt interrupts} |
418 |
* the current thread. |
419 |
* </ul> |
420 |
* |
421 |
* <p>If the current thread: |
422 |
* <ul> |
423 |
* <li>has its interrupted status set on entry to this method; or |
424 |
* <li>is {@linkplain Thread#interrupt interrupted} while waiting |
425 |
* for a permit, |
426 |
* </ul> |
427 |
* then {@link InterruptedException} is thrown and the current thread's |
428 |
* interrupted status is cleared. |
429 |
* Any permits that were to be assigned to this thread are instead |
430 |
* assigned to other threads trying to acquire permits, as if |
431 |
* permits had been made available by a call to {@link #release()}. |
432 |
* |
433 |
* @param permits the number of permits to acquire |
434 |
* @throws InterruptedException if the current thread is interrupted |
435 |
* @throws IllegalArgumentException if {@code permits} is negative |
436 |
*/ |
437 |
public void acquire(int permits) throws InterruptedException { |
438 |
if (permits < 0) throw new IllegalArgumentException(); |
439 |
sync.acquireSharedInterruptibly(permits); |
440 |
} |
441 |
|
442 |
/** |
443 |
* Acquires the given number of permits from this semaphore, |
444 |
* blocking until all are available. |
445 |
* |
446 |
* <p>Acquires the given number of permits, if they are available, |
447 |
* and returns immediately, reducing the number of available permits |
448 |
* by the given amount. |
449 |
* |
450 |
* <p>If insufficient permits are available then the current thread becomes |
451 |
* disabled for thread scheduling purposes and lies dormant until |
452 |
* some other thread invokes one of the {@link #release() release} |
453 |
* methods for this semaphore, the current thread is next to be assigned |
454 |
* permits and the number of available permits satisfies this request. |
455 |
* |
456 |
* <p>If the current thread is {@linkplain Thread#interrupt interrupted} |
457 |
* while waiting for permits then it will continue to wait and its |
458 |
* position in the queue is not affected. When the thread does return |
459 |
* from this method its interrupt status will be set. |
460 |
* |
461 |
* @param permits the number of permits to acquire |
462 |
* @throws IllegalArgumentException if {@code permits} is negative |
463 |
*/ |
464 |
public void acquireUninterruptibly(int permits) { |
465 |
if (permits < 0) throw new IllegalArgumentException(); |
466 |
sync.acquireShared(permits); |
467 |
} |
468 |
|
469 |
/** |
470 |
* Acquires the given number of permits from this semaphore, only |
471 |
* if all are available at the time of invocation. |
472 |
* |
473 |
* <p>Acquires the given number of permits, if they are available, and |
474 |
* returns immediately, with the value {@code true}, |
475 |
* reducing the number of available permits by the given amount. |
476 |
* |
477 |
* <p>If insufficient permits are available then this method will return |
478 |
* immediately with the value {@code false} and the number of available |
479 |
* permits is unchanged. |
480 |
* |
481 |
* <p>Even when this semaphore has been set to use a fair ordering |
482 |
* policy, a call to {@code tryAcquire} <em>will</em> |
483 |
* immediately acquire a permit if one is available, whether or |
484 |
* not other threads are currently waiting. This |
485 |
* "barging" behavior can be useful in certain |
486 |
* circumstances, even though it breaks fairness. If you want to |
487 |
* honor the fairness setting, then use {@link #tryAcquire(int, |
488 |
* long, TimeUnit) tryAcquire(permits, 0, TimeUnit.SECONDS) } |
489 |
* which is almost equivalent (it also detects interruption). |
490 |
* |
491 |
* @param permits the number of permits to acquire |
492 |
* @return {@code true} if the permits were acquired and |
493 |
* {@code false} otherwise |
494 |
* @throws IllegalArgumentException if {@code permits} is negative |
495 |
*/ |
496 |
public boolean tryAcquire(int permits) { |
497 |
if (permits < 0) throw new IllegalArgumentException(); |
498 |
return sync.nonfairTryAcquireShared(permits) >= 0; |
499 |
} |
500 |
|
501 |
/** |
502 |
* Acquires the given number of permits from this semaphore, if all |
503 |
* become available within the given waiting time and the current |
504 |
* thread has not been {@linkplain Thread#interrupt interrupted}. |
505 |
* |
506 |
* <p>Acquires the given number of permits, if they are available and |
507 |
* returns immediately, with the value {@code true}, |
508 |
* reducing the number of available permits by the given amount. |
509 |
* |
510 |
* <p>If insufficient permits are available then |
511 |
* the current thread becomes disabled for thread scheduling |
512 |
* purposes and lies dormant until one of three things happens: |
513 |
* <ul> |
514 |
* <li>Some other thread invokes one of the {@link #release() release} |
515 |
* methods for this semaphore, the current thread is next to be assigned |
516 |
* permits and the number of available permits satisfies this request; or |
517 |
* <li>Some other thread {@linkplain Thread#interrupt interrupts} |
518 |
* the current thread; or |
519 |
* <li>The specified waiting time elapses. |
520 |
* </ul> |
521 |
* |
522 |
* <p>If the permits are acquired then the value {@code true} is returned. |
523 |
* |
524 |
* <p>If the current thread: |
525 |
* <ul> |
526 |
* <li>has its interrupted status set on entry to this method; or |
527 |
* <li>is {@linkplain Thread#interrupt interrupted} while waiting |
528 |
* to acquire the permits, |
529 |
* </ul> |
530 |
* then {@link InterruptedException} is thrown and the current thread's |
531 |
* interrupted status is cleared. |
532 |
* Any permits that were to be assigned to this thread, are instead |
533 |
* assigned to other threads trying to acquire permits, as if |
534 |
* the permits had been made available by a call to {@link #release()}. |
535 |
* |
536 |
* <p>If the specified waiting time elapses then the value {@code false} |
537 |
* is returned. If the time is less than or equal to zero, the method |
538 |
* will not wait at all. Any permits that were to be assigned to this |
539 |
* thread, are instead assigned to other threads trying to acquire |
540 |
* permits, as if the permits had been made available by a call to |
541 |
* {@link #release()}. |
542 |
* |
543 |
* @param permits the number of permits to acquire |
544 |
* @param timeout the maximum time to wait for the permits |
545 |
* @param unit the time unit of the {@code timeout} argument |
546 |
* @return {@code true} if all permits were acquired and {@code false} |
547 |
* if the waiting time elapsed before all permits were acquired |
548 |
* @throws InterruptedException if the current thread is interrupted |
549 |
* @throws IllegalArgumentException if {@code permits} is negative |
550 |
*/ |
551 |
public boolean tryAcquire(int permits, long timeout, TimeUnit unit) |
552 |
throws InterruptedException { |
553 |
if (permits < 0) throw new IllegalArgumentException(); |
554 |
return sync.tryAcquireSharedNanos(permits, unit.toNanos(timeout)); |
555 |
} |
556 |
|
557 |
/** |
558 |
* Releases the given number of permits, returning them to the semaphore. |
559 |
* |
560 |
* <p>Releases the given number of permits, increasing the number of |
561 |
* available permits by that amount. |
562 |
* If any threads are trying to acquire permits, then one |
563 |
* is selected and given the permits that were just released. |
564 |
* If the number of available permits satisfies that thread's request |
565 |
* then that thread is (re)enabled for thread scheduling purposes; |
566 |
* otherwise the thread will wait until sufficient permits are available. |
567 |
* If there are still permits available |
568 |
* after this thread's request has been satisfied, then those permits |
569 |
* are assigned in turn to other threads trying to acquire permits. |
570 |
* |
571 |
* <p>There is no requirement that a thread that releases a permit must |
572 |
* have acquired that permit by calling {@link Semaphore#acquire acquire}. |
573 |
* Correct usage of a semaphore is established by programming convention |
574 |
* in the application. |
575 |
* |
576 |
* @param permits the number of permits to release |
577 |
* @throws IllegalArgumentException if {@code permits} is negative |
578 |
*/ |
579 |
public void release(int permits) { |
580 |
if (permits < 0) throw new IllegalArgumentException(); |
581 |
sync.releaseShared(permits); |
582 |
} |
583 |
|
584 |
/** |
585 |
* Returns the current number of permits available in this semaphore. |
586 |
* |
587 |
* <p>This method is typically used for debugging and testing purposes. |
588 |
* |
589 |
* @return the number of permits available in this semaphore |
590 |
*/ |
591 |
public int availablePermits() { |
592 |
return sync.getPermits(); |
593 |
} |
594 |
|
595 |
/** |
596 |
* Acquires and returns all permits that are immediately available. |
597 |
* |
598 |
* @return the number of permits acquired |
599 |
*/ |
600 |
public int drainPermits() { |
601 |
return sync.drainPermits(); |
602 |
} |
603 |
|
604 |
/** |
605 |
* Shrinks the number of available permits by the indicated |
606 |
* reduction. This method can be useful in subclasses that use |
607 |
* semaphores to track resources that become unavailable. This |
608 |
* method differs from {@code acquire} in that it does not block |
609 |
* waiting for permits to become available. |
610 |
* |
611 |
* @param reduction the number of permits to remove |
612 |
* @throws IllegalArgumentException if {@code reduction} is negative |
613 |
*/ |
614 |
protected void reducePermits(int reduction) { |
615 |
if (reduction < 0) throw new IllegalArgumentException(); |
616 |
sync.reducePermits(reduction); |
617 |
} |
618 |
|
619 |
/** |
620 |
* Returns {@code true} if this semaphore has fairness set true. |
621 |
* |
622 |
* @return {@code true} if this semaphore has fairness set true |
623 |
*/ |
624 |
public boolean isFair() { |
625 |
return sync instanceof FairSync; |
626 |
} |
627 |
|
628 |
/** |
629 |
* Queries whether any threads are waiting to acquire. Note that |
630 |
* because cancellations may occur at any time, a {@code true} |
631 |
* return does not guarantee that any other thread will ever |
632 |
* acquire. This method is designed primarily for use in |
633 |
* monitoring of the system state. |
634 |
* |
635 |
* @return {@code true} if there may be other threads waiting to |
636 |
* acquire the lock |
637 |
*/ |
638 |
public final boolean hasQueuedThreads() { |
639 |
return sync.hasQueuedThreads(); |
640 |
} |
641 |
|
642 |
/** |
643 |
* Returns an estimate of the number of threads waiting to acquire. |
644 |
* The value is only an estimate because the number of threads may |
645 |
* change dynamically while this method traverses internal data |
646 |
* structures. This method is designed for use in monitoring of the |
647 |
* system state, not for synchronization control. |
648 |
* |
649 |
* @return the estimated number of threads waiting for this lock |
650 |
*/ |
651 |
public final int getQueueLength() { |
652 |
return sync.getQueueLength(); |
653 |
} |
654 |
|
655 |
/** |
656 |
* Returns a collection containing threads that may be waiting to acquire. |
657 |
* Because the actual set of threads may change dynamically while |
658 |
* constructing this result, the returned collection is only a best-effort |
659 |
* estimate. The elements of the returned collection are in no particular |
660 |
* order. This method is designed to facilitate construction of |
661 |
* subclasses that provide more extensive monitoring facilities. |
662 |
* |
663 |
* @return the collection of threads |
664 |
*/ |
665 |
protected Collection<Thread> getQueuedThreads() { |
666 |
return sync.getQueuedThreads(); |
667 |
} |
668 |
|
669 |
/** |
670 |
* Returns a string identifying this semaphore, as well as its state. |
671 |
* The state, in brackets, includes the String {@code "Permits ="} |
672 |
* followed by the number of permits. |
673 |
* |
674 |
* @return a string identifying this semaphore, as well as its state |
675 |
*/ |
676 |
public String toString() { |
677 |
return super.toString() + "[Permits = " + sync.getPermits() + "]"; |
678 |
} |
679 |
} |