/** ORACLE PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
**/
/**
*
*
*
*
* Written by Doug Lea with assistance from members of JCP JSR-166
* Expert Group and released to the public domain, as explained at
*http://creativecommons.org/publicdomain/zero/1.0/
*/
packagejava.util.concurrent;import java.util.*;import java.util.concurrent.locks.*;import java.util.concurrent.atomic.*;/*** A counting semaphore. Conceptually, a semaphore maintains a set of
* permits. Each {@link#acquire} blocks if necessary until a permit is
* available, and then takes it. Each {@link#release} adds a permit,
* potentially releasing a blocking acquirer.
* However, no actual permit objects are used; the {@codeSemaphore} just
* keeps a count of the number available and acts accordingly.
*
*
Semaphores are often used to restrict the number of threads than can
* access some (physical or logical) resource. For example, here is
* a class that uses a semaphore to control access to a pool of items:
*
* class Pool {
* private static final int MAX_AVAILABLE = 100;
* private final Semaphore available = new Semaphore(MAX_AVAILABLE, true);
*
* public Object getItem() throws InterruptedException {
* available.acquire();
* return getNextAvailableItem();
* }
*
* public void putItem(Object x) {
* if (markAsUnused(x))
* available.release();
* }
*
* // Not a particularly efficient data structure; just for demo
*
* protected Object[] items = ... whatever kinds of items being managed
* protected boolean[] used = new boolean[MAX_AVAILABLE];
*
* protected synchronized Object getNextAvailableItem() {
* for (int i = 0; i < MAX_AVAILABLE; ++i) {
* if (!used[i]) {
* used[i] = true;
* return items[i];
* }
* }
* return null; // not reached
* }
*
* protected synchronized boolean markAsUnused(Object item) {
* for (int i = 0; i < MAX_AVAILABLE; ++i) {
* if (item == items[i]) {
* if (used[i]) {
* used[i] = false;
* return true;
* } else
* return false;
* }
* }
* return false;
* }
*
* }
*
*
*
Before obtaining an item each thread must acquire a permit from
* the semaphore, guaranteeing that an item is available for use. When
* the thread has finished with the item it is returned back to the
* pool and a permit is returned to the semaphore, allowing another
* thread to acquire that item. Note that no synchronization lock is
* held when {@link#acquire} is called as that would prevent an item
* from being returned to the pool. The semaphore encapsulates the
* synchronization needed to restrict access to the pool, separately
* from any synchronization needed to maintain the consistency of the
* pool itself.
*
*
A semaphore initialized to one, and which is used such that it
* only has at most one permit available, can serve as a mutual
* exclusion lock. This is more commonly known as a binary
* semaphore, because it only has two states: one permit
* available, or zero permits available. When used in this way, the
* binary semaphore has the property (unlike many {@linkLock}
* implementations), that the "lock" can be released by a
* thread other than the owner (as semaphores have no notion of
* ownership). This can be useful in some specialized contexts, such
* as deadlock recovery.
*
*
The constructor for this class optionally accepts a
* fairness parameter. When set false, this class makes no
* guarantees about the order in which threads acquire permits. In
* particular, barging is permitted, that is, a thread
* invoking {@link#acquire} can be allocated a permit ahead of a
* thread that has been waiting - logically the new thread places itself at
* the head of the queue of waiting threads. When fairness is set true, the
* semaphore guarantees that threads invoking any of the {@link* #acquire() acquire} methods are selected to obtain permits in the order in
* which their invocation of those methods was processed
* (first-in-first-out; FIFO). Note that FIFO ordering necessarily
* applies to specific internal points of execution within these
* methods. So, it is possible for one thread to invoke
* {@codeacquire} before another, but reach the ordering point after
* the other, and similarly upon return from the method.
* Also note that the untimed {@link#tryAcquire() tryAcquire} methods do not
* honor the fairness setting, but will take any permits that are
* available.
*
*
Generally, semaphores used to control resource access should be
* initialized as fair, to ensure that no thread is starved out from
* accessing a resource. When using semaphores for other kinds of
* synchronization control, the throughput advantages of non-fair
* ordering often outweigh fairness considerations.
*
*
This class also provides convenience methods to {@link* #acquire(int) acquire} and {@link#release(int) release} multiple
* permits at a time. Beware of the increased risk of indefinite
* postponement when these methods are used without fairness set true.
*
*
Memory consistency effects: Actions in a thread prior to calling
* a "release" method such as {@coderelease()}
* actions following a successful "acquire" method such as {@codeacquire()}
* in another thread.
*
*@since1.5
*@authorDoug Lea
**/
public class Semaphore implementsjava.io.Serializable {private static final long serialVersionUID = -3222578661600680210L;/**All mechanics via AbstractQueuedSynchronizer subclass*/
private finalSync sync;/*** Synchronization implementation for semaphore. Uses AQS state
* to represent permits. Subclassed into fair and nonfair
* versions.*/
abstract static class Sync extendsAbstractQueuedSynchronizer {private static final long serialVersionUID = 1192457210091910933L;
Sync(intpermits) {
setState(permits);
}final intgetPermits() {returngetState();
}final int nonfairTryAcquireShared(intacquires) {for(;;) {int available =getState();int remaining = available -acquires;if (remaining < 0 ||compareAndSetState(available, remaining))returnremaining;
}
}protected final boolean tryReleaseShared(intreleases) {for(;;) {int current =getState();int next = current +releases;if (next < current) //overflow
throw new Error("Maximum permit count exceeded");if(compareAndSetState(current, next))return true;
}
}final void reducePermits(intreductions) {for(;;) {int current =getState();int next = current -reductions;if (next > current) //underflow
throw new Error("Permit count underflow");if(compareAndSetState(current, next))return;
}
}final intdrainPermits() {for(;;) {int current =getState();if (current == 0 || compareAndSetState(current, 0))returncurrent;
}
}
}/*** NonFair version*/
static final class NonfairSync extendsSync {private static final long serialVersionUID = -2694183684443567898L;
NonfairSync(intpermits) {super(permits);
}protected int tryAcquireShared(intacquires) {returnnonfairTryAcquireShared(acquires);
}
}/*** Fair version*/
static final class FairSync extendsSync {private static final long serialVersionUID = 2014338818796000944L;
FairSync(intpermits) {super(permits);
}protected int tryAcquireShared(intacquires) {for(;;) {if(hasQueuedPredecessors())return -1;int available =getState();int remaining = available -acquires;if (remaining < 0 ||compareAndSetState(available, remaining))returnremaining;
}
}
}/*** Creates a {@codeSemaphore} with the given number of
* permits and nonfair fairness setting.
*
*@parampermits the initial number of permits available.
* This value may be negative, in which case releases
* must occur before any acquires will be granted.*/
public Semaphore(intpermits) {
sync= newNonfairSync(permits);
}/*** Creates a {@codeSemaphore} with the given number of
* permits and the given fairness setting.
*
*@parampermits the initial number of permits available.
* This value may be negative, in which case releases
* must occur before any acquires will be granted.
*@paramfair {@codetrue} if this semaphore will guarantee
* first-in first-out granting of permits under contention,
* else {@codefalse}*/
public Semaphore(int permits, booleanfair) {
sync= fair ? new FairSync(permits) : newNonfairSync(permits);
}/*** Acquires a permit from this semaphore, blocking until one is
* available, or the thread is {@linkplainThread#interrupt interrupted}.
*
*
Acquires a permit, if one is available and returns immediately,
* reducing the number of available permits by one.
*
*
If no permit is available then the current thread becomes
* disabled for thread scheduling purposes and lies dormant until
* one of two things happens:
*
*
Some other thread invokes the {@link#release} method for this* semaphore and the current thread is next to be assigned a permit; or
*
Some other thread {@linkplainThread#interrupt interrupts}* the current thread.
*
*
*
If the current thread:
*
*
has its interrupted status set on entry to this method; or*
is {@linkplainThread#interrupt interrupted} while waiting* for a permit,
*
* then {@linkInterruptedException} is thrown and the current thread's
* interrupted status is cleared.
*
*@throwsInterruptedException if the current thread is interrupted*/
public void acquire() throwsInterruptedException {
sync.acquireSharedInterruptibly(1);
}/*** Acquires a permit from this semaphore, blocking until one is
* available.
*
*
Acquires a permit, if one is available and returns immediately,
* reducing the number of available permits by one.
*
*
If no permit is available then the current thread becomes
* disabled for thread scheduling purposes and lies dormant until
* some other thread invokes the {@link#release} method for this
* semaphore and the current thread is next to be assigned a permit.
*
*
If the current thread is {@linkplainThread#interrupt interrupted}
* while waiting for a permit then it will continue to wait, but the
* time at which the thread is assigned a permit may change compared to
* the time it would have received the permit had no interruption
* occurred. When the thread does return from this method its interrupt
* status will be set.*/
public voidacquireUninterruptibly() {
sync.acquireShared(1);
}/*** Acquires a permit from this semaphore, only if one is available at the
* time of invocation.
*
*
Acquires a permit, if one is available and returns immediately,
* with the value {@codetrue},
* reducing the number of available permits by one.
*
*
If no permit is available then this method will return
* immediately with the value {@codefalse}.
*
*
Even when this semaphore has been set to use a
* fair ordering policy, a call to {@codetryAcquire()} will
* immediately acquire a permit if one is available, whether or not
* other threads are currently waiting.
* This "barging" behavior can be useful in certain
* circumstances, even though it breaks fairness. If you want to honor
* the fairness setting, then use
* {@link#tryAcquire(long, TimeUnit) tryAcquire(0, TimeUnit.SECONDS) }
* which is almost equivalent (it also detects interruption).
*
*@return{@codetrue} if a permit was acquired and {@codefalse}
* otherwise*/
public booleantryAcquire() {return sync.nonfairTryAcquireShared(1) >= 0;
}/*** Acquires a permit from this semaphore, if one becomes available
* within the given waiting time and the current thread has not
* been {@linkplainThread#interrupt interrupted}.
*
*
Acquires a permit, if one is available and returns immediately,
* with the value {@codetrue},
* reducing the number of available permits by one.
*
*
If no permit is available then the current thread becomes
* disabled for thread scheduling purposes and lies dormant until
* one of three things happens:
*
*
Some other thread invokes the {@link#release} method for this* semaphore and the current thread is next to be assigned a permit; or
*
Some other thread {@linkplainThread#interrupt interrupts}* the current thread; or
*
The specified waiting time elapses.*
*
*
If a permit is acquired then the value {@codetrue} is returned.
*
*
If the current thread:
*
*
has its interrupted status set on entry to this method; or*
is {@linkplainThread#interrupt interrupted} while waiting* to acquire a permit,
*
* then {@linkInterruptedException} is thrown and the current thread's
* interrupted status is cleared.
*
*
If the specified waiting time elapses then the value {@codefalse}
* is returned. If the time is less than or equal to zero, the method
* will not wait at all.
*
*@paramtimeout the maximum time to wait for a permit
*@paramunit the time unit of the {@codetimeout} argument
*@return{@codetrue} if a permit was acquired and {@codefalse}
* if the waiting time elapsed before a permit was acquired
*@throwsInterruptedException if the current thread is interrupted*/
public boolean tryAcquire(longtimeout, TimeUnit unit)throwsInterruptedException {return sync.tryAcquireSharedNanos(1, unit.toNanos(timeout));
}/*** Releases a permit, returning it to the semaphore.
*
*
Releases a permit, increasing the number of available permits by
* one. If any threads are trying to acquire a permit, then one is
* selected and given the permit that was just released. That thread
* is (re)enabled for thread scheduling purposes.
*
*
There is no requirement that a thread that releases a permit must
* have acquired that permit by calling {@link#acquire}.
* Correct usage of a semaphore is established by programming convention
* in the application.*/
public voidrelease() {
sync.releaseShared(1);
}/*** Acquires the given number of permits from this semaphore,
* blocking until all are available,
* or the thread is {@linkplainThread#interrupt interrupted}.
*
*
Acquires the given number of permits, if they are available,
* and returns immediately, reducing the number of available permits
* by the given amount.
*
*
If insufficient permits are available then the current thread becomes
* disabled for thread scheduling purposes and lies dormant until
* one of two things happens:
*
*
Some other thread invokes one of the {@link#release() release}* methods for this semaphore, the current thread is next to be assigned
* permits and the number of available permits satisfies this request; or
*
Some other thread {@linkplainThread#interrupt interrupts}* the current thread.
*
*
*
If the current thread:
*
*
has its interrupted status set on entry to this method; or*
is {@linkplainThread#interrupt interrupted} while waiting* for a permit,
*
* then {@linkInterruptedException} is thrown and the current thread's
* interrupted status is cleared.
* Any permits that were to be assigned to this thread are instead
* assigned to other threads trying to acquire permits, as if
* permits had been made available by a call to {@link#release()}.
*
*@parampermits the number of permits to acquire
*@throwsInterruptedException if the current thread is interrupted
*@throwsIllegalArgumentException if {@codepermits} is negative*/
public void acquire(int permits) throwsInterruptedException {if (permits < 0) throw newIllegalArgumentException();
sync.acquireSharedInterruptibly(permits);
}/*** Acquires the given number of permits from this semaphore,
* blocking until all are available.
*
*
Acquires the given number of permits, if they are available,
* and returns immediately, reducing the number of available permits
* by the given amount.
*
*
If insufficient permits are available then the current thread becomes
* disabled for thread scheduling purposes and lies dormant until
* some other thread invokes one of the {@link#release() release}
* methods for this semaphore, the current thread is next to be assigned
* permits and the number of available permits satisfies this request.
*
*
If the current thread is {@linkplainThread#interrupt interrupted}
* while waiting for permits then it will continue to wait and its
* position in the queue is not affected. When the thread does return
* from this method its interrupt status will be set.
*
*@parampermits the number of permits to acquire
*@throwsIllegalArgumentException if {@codepermits} is negative
**/
public void acquireUninterruptibly(intpermits) {if (permits < 0) throw newIllegalArgumentException();
sync.acquireShared(permits);
}/*** Acquires the given number of permits from this semaphore, only
* if all are available at the time of invocation.
*
*
Acquires the given number of permits, if they are available, and
* returns immediately, with the value {@codetrue},
* reducing the number of available permits by the given amount.
*
*
If insufficient permits are available then this method will return
* immediately with the value {@codefalse} and the number of available
* permits is unchanged.
*
*
Even when this semaphore has been set to use a fair ordering
* policy, a call to {@codetryAcquire} will
* immediately acquire a permit if one is available, whether or
* not other threads are currently waiting. This
* "barging" behavior can be useful in certain
* circumstances, even though it breaks fairness. If you want to
* honor the fairness setting, then use {@link#tryAcquire(int,
* long, TimeUnit) tryAcquire(permits, 0, TimeUnit.SECONDS) }
* which is almost equivalent (it also detects interruption).
*
*@parampermits the number of permits to acquire
*@return{@codetrue} if the permits were acquired and
* {@codefalse} otherwise
*@throwsIllegalArgumentException if {@codepermits} is negative*/
public boolean tryAcquire(intpermits) {if (permits < 0) throw newIllegalArgumentException();return sync.nonfairTryAcquireShared(permits) >= 0;
}/*** Acquires the given number of permits from this semaphore, if all
* become available within the given waiting time and the current
* thread has not been {@linkplainThread#interrupt interrupted}.
*
*
Acquires the given number of permits, if they are available and
* returns immediately, with the value {@codetrue},
* reducing the number of available permits by the given amount.
*
*
If insufficient permits are available then
* the current thread becomes disabled for thread scheduling
* purposes and lies dormant until one of three things happens:
*
*
Some other thread invokes one of the {@link#release() release}* methods for this semaphore, the current thread is next to be assigned
* permits and the number of available permits satisfies this request; or
*
Some other thread {@linkplainThread#interrupt interrupts}* the current thread; or
*
The specified waiting time elapses.*
*
*
If the permits are acquired then the value {@codetrue} is returned.
*
*
If the current thread:
*
*
has its interrupted status set on entry to this method; or*
is {@linkplainThread#interrupt interrupted} while waiting* to acquire the permits,
*
* then {@linkInterruptedException} is thrown and the current thread's
* interrupted status is cleared.
* Any permits that were to be assigned to this thread, are instead
* assigned to other threads trying to acquire permits, as if
* the permits had been made available by a call to {@link#release()}.
*
*
If the specified waiting time elapses then the value {@codefalse}
* is returned. If the time is less than or equal to zero, the method
* will not wait at all. Any permits that were to be assigned to this
* thread, are instead assigned to other threads trying to acquire
* permits, as if the permits had been made available by a call to
* {@link#release()}.
*
*@parampermits the number of permits to acquire
*@paramtimeout the maximum time to wait for the permits
*@paramunit the time unit of the {@codetimeout} argument
*@return{@codetrue} if all permits were acquired and {@codefalse}
* if the waiting time elapsed before all permits were acquired
*@throwsInterruptedException if the current thread is interrupted
*@throwsIllegalArgumentException if {@codepermits} is negative*/
public boolean tryAcquire(int permits, longtimeout, TimeUnit unit)throwsInterruptedException {if (permits < 0) throw newIllegalArgumentException();returnsync.tryAcquireSharedNanos(permits, unit.toNanos(timeout));
}/*** Releases the given number of permits, returning them to the semaphore.
*
*
Releases the given number of permits, increasing the number of
* available permits by that amount.
* If any threads are trying to acquire permits, then one
* is selected and given the permits that were just released.
* If the number of available permits satisfies that thread's request
* then that thread is (re)enabled for thread scheduling purposes;
* otherwise the thread will wait until sufficient permits are available.
* If there are still permits available
* after this thread's request has been satisfied, then those permits
* are assigned in turn to other threads trying to acquire permits.
*
*
There is no requirement that a thread that releases a permit must
* have acquired that permit by calling {@linkSemaphore#acquire acquire}.
* Correct usage of a semaphore is established by programming convention
* in the application.
*
*@parampermits the number of permits to release
*@throwsIllegalArgumentException if {@codepermits} is negative*/
public void release(intpermits) {if (permits < 0) throw newIllegalArgumentException();
sync.releaseShared(permits);
}/*** Returns the current number of permits available in this semaphore.
*
*
This method is typically used for debugging and testing purposes.
*
*@returnthe number of permits available in this semaphore*/
public intavailablePermits() {returnsync.getPermits();
}/*** Acquires and returns all permits that are immediately available.
*
*@returnthe number of permits acquired*/
public intdrainPermits() {returnsync.drainPermits();
}/*** Shrinks the number of available permits by the indicated
* reduction. This method can be useful in subclasses that use
* semaphores to track resources that become unavailable. This
* method differs from {@codeacquire} in that it does not block
* waiting for permits to become available.
*
*@paramreduction the number of permits to remove
*@throwsIllegalArgumentException if {@codereduction} is negative*/
protected void reducePermits(intreduction) {if (reduction < 0) throw newIllegalArgumentException();
sync.reducePermits(reduction);
}/*** Returns {@codetrue} if this semaphore has fairness set true.
*
*@return{@codetrue} if this semaphore has fairness set true*/
public booleanisFair() {return sync instanceofFairSync;
}/*** Queries whether any threads are waiting to acquire. Note that
* because cancellations may occur at any time, a {@codetrue}
* return does not guarantee that any other thread will ever
* acquire. This method is designed primarily for use in
* monitoring of the system state.
*
*@return{@codetrue} if there may be other threads waiting to
* acquire the lock*/
public final booleanhasQueuedThreads() {returnsync.hasQueuedThreads();
}/*** Returns an estimate of the number of threads waiting to acquire.
* The value is only an estimate because the number of threads may
* change dynamically while this method traverses internal data
* structures. This method is designed for use in monitoring of the
* system state, not for synchronization control.
*
*@returnthe estimated number of threads waiting for this lock*/
public final intgetQueueLength() {returnsync.getQueueLength();
}/*** Returns a collection containing threads that may be waiting to acquire.
* Because the actual set of threads may change dynamically while
* constructing this result, the returned collection is only a best-effort
* estimate. The elements of the returned collection are in no particular
* order. This method is designed to facilitate construction of
* subclasses that provide more extensive monitoring facilities.
*
*@returnthe collection of threads*/
protected CollectiongetQueuedThreads() {returnsync.getQueuedThreads();
}/*** Returns a string identifying this semaphore, as well as its state.
* The state, in brackets, includes the String {@code"Permits ="}
* followed by the number of permits.
*
*@returna string identifying this semaphore, as well as its state*/
publicString toString() {return super.toString() + "[Permits = " + sync.getPermits() + "]";
}
}
179
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
