ViewVC Help

View File | Revision Log | Show Annotations | Download File | Root Listing

root/jsr166/jsr166/src/jsr166y/ForkJoinWorkerThread.java

Comparing jsr166/src/jsr166y/ForkJoinWorkerThread.java (file contents):
Revision 1.38 by dl, Fri Jul 23 16:49:11 2010 UTC vs.
Revision 1.62 by jsr166, Mon Nov 29 20:58:06 2010 UTC

#	Line 6 | Line 6
6
7		package jsr166y;
8
9	–	import java.util.concurrent.*;
10	–
9		import java.util.Random;
10		import java.util.Collection;
11		import java.util.concurrent.locks.LockSupport;
12	+	import java.util.concurrent.RejectedExecutionException;
13
14		/**
15	<	* A thread managed by a {@link ForkJoinPool}.  This class is
16	<	* subclassable solely for the sake of adding functionality -- there
17	<	* are no overridable methods dealing with scheduling or execution.
18	<	* However, you can override initialization and termination methods
19	<	* surrounding the main task processing loop.  If you do create such a
20	<	* subclass, you will also need to supply a custom {@link
21	<	* ForkJoinPool.ForkJoinWorkerThreadFactory} to use it in a {@code
22	<	* ForkJoinPool}.
15	>	* A thread managed by a {@link ForkJoinPool}, which executes
16	>	* {@link ForkJoinTask}s.
17	>	* This class is subclassable solely for the sake of adding
18	>	* functionality -- there are no overridable methods dealing with
19	>	* scheduling or execution.  However, you can override initialization
20	>	* and termination methods surrounding the main task processing loop.
21	>	* If you do create such a subclass, you will also need to supply a
22	>	* custom {@link ForkJoinPool.ForkJoinWorkerThreadFactory} to use it
23	>	* in a {@code ForkJoinPool}.
24		*
25		* @since 1.7
26		* @author Doug Lea
#	Line 97 | Line 97 | public class ForkJoinWorkerThread extend
97		* technique for implementing efficient futures" SIGPLAN Notices,
98		* 1993 (http://portal.acm.org/citation.cfm?id=155354). It differs
99		* in that: (1) We only maintain dependency links across workers
100	<	* upon steals, rather than maintain per-task bookkeeping.  This
101	<	* may require a linear scan of workers array to locate stealers,
102	<	* but usually doesn't because stealers leave hints (that may
103	<	* become stale/wrong) of where to locate the kathem. This
104	<	* isolates cost to when it is needed, rather than adding to
105	<	* per-task overhead.  (2) It is "shallow", ignoring nesting and
106	<	* potentially cyclic mutual steals.  (3) It is intentionally
107	<	* racy: field currentJoin is updated only while actively joining,
108	<	* which means that we could miss links in the chain during
109	<	* long-lived tasks, GC stalls etc.  (4) We bound the number of
110	<	* attempts to find work (see MAX_HELP_DEPTH) and fall back to
111	<	* suspending the worker and if necessary replacing it with a
112	<	* spare (see ForkJoinPool.tryAwaitJoin).
100	>	* upon steals, rather than use per-task bookkeeping.  This may
101	>	* require a linear scan of workers array to locate stealers, but
102	>	* usually doesn't because stealers leave hints (that may become
103	>	* stale/wrong) of where to locate them. This isolates cost to
104	>	* when it is needed, rather than adding to per-task overhead.
105	>	* (2) It is "shallow", ignoring nesting and potentially cyclic
106	>	* mutual steals.  (3) It is intentionally racy: field currentJoin
107	>	* is updated only while actively joining, which means that we
108	>	* miss links in the chain during long-lived tasks, GC stalls etc
109	>	* (which is OK since blocking in such cases is usually a good
110	>	* idea).  (4) We bound the number of attempts to find work (see
111	>	* MAX_HELP_DEPTH) and fall back to suspending the worker and if
112	>	* necessary replacing it with a spare (see
113	>	* ForkJoinPool.awaitJoin).
114		*
115		* Efficient implementation of these algorithms currently relies
116		* on an uncomfortable amount of "Unsafe" mechanics. To maintain
#	Line 154 | Line 155 | public class ForkJoinWorkerThread extend
155		private static final Random seedGenerator = new Random();
156
157		/**
157	–	* The timeout value for suspending spares. Spare workers that
158	–	* remain unsignalled for more than this time may be trimmed
159	–	* (killed and removed from pool).  Since our goal is to avoid
160	–	* long-term thread buildup, the exact value of timeout does not
161	–	* matter too much so long as it avoids most false-alarm timeouts
162	–	* under GC stalls or momentarily high system load.
163	–	*/
164	–	private static final long SPARE_KEEPALIVE_NANOS =
165	–	5L * 1000L * 1000L * 1000L; // 5 secs
166	–
167	–	/**
158		* The maximum stolen->joining link depth allowed in helpJoinTask.
159		* Depths for legitimate chains are unbounded, but we use a fixed
160		* constant to avoid (otherwise unchecked) cycles and bound
#	Line 182 | Line 172 | public class ForkJoinWorkerThread extend
172
173		/**
174		* Maximum work-stealing queue array size.  Must be less than or
175	<	* equal to 1 << 28 to ensure lack of index wraparound. (This
176	<	* is less than usual bounds, because we need leftshift by 3
177	<	* to be in int range).
175	>	* equal to 1 << (31 - width of array entry) to ensure lack of
176	>	* index wraparound. The value is set in the static block
177	>	* at the end of this file after obtaining width.
178		*/
179	<	private static final int MAXIMUM_QUEUE_CAPACITY = 1 << 28;
179	>	private static final int MAXIMUM_QUEUE_CAPACITY;
180
181		/**
182		* The pool this thread works in. Accessed directly by ForkJoinTask.
#	Line 227 | Line 217 | public class ForkJoinWorkerThread extend
217		* Run state of this worker. In addition to the usual run levels,
218		* tracks if this worker is suspended as a spare, and if it was
219		* killed (trimmed) while suspended. However, "active" status is
220	<	* maintained separately.
220	>	* maintained separately and modified only in conjunction with
221	>	* CASes of the pool's runState (which are currently sadly
222	>	* manually inlined for performance.)  Accessed directly by pool
223	>	* to simplify checks for normal (zero) status.
224		*/
225	<	private volatile int runState;
225	>	volatile int runState;
226
227		private static final int TERMINATING = 0x01;
228		private static final int TERMINATED  = 0x02;
#	Line 237 | Line 230 | public class ForkJoinWorkerThread extend
230		private static final int TRIMMED     = 0x08; // killed while suspended
231
232		/**
233	<	* Number of LockSupport.park calls to block this thread for
234	<	* suspension or event waits. Used for internal instrumention;
242	<	* currently not exported but included because volatile write upon
243	<	* park also provides a workaround for a JVM bug.
244	<	*/
245	<	volatile int parkCount;
246	<
247	<	/**
248	<	* Number of steals, transferred and reset in pool callbacks pool
249	<	* when idle Accessed directly by pool.
233	>	* Number of steals. Directly accessed (and reset) by
234	>	* pool.tryAccumulateStealCount when idle.
235		*/
236		int stealCount;
237
#	Line 256 | Line 241 | public class ForkJoinWorkerThread extend
241		*/
242		private int seed;
243
259	–
244		/**
245		* Activity status. When true, this worker is considered active.
246		* Accessed directly by pool.  Must be false upon construction.
#	Line 265 | Line 249 | public class ForkJoinWorkerThread extend
249
250		/**
251		* True if use local fifo, not default lifo, for local polling.
252	<	* Shadows value from ForkJoinPool, which resets it if changed
269	<	* pool-wide.
252	>	* Shadows value from ForkJoinPool.
253		*/
254		private final boolean locallyFifo;
255
#	Line 284 | Line 267 | public class ForkJoinWorkerThread extend
267		int lastEventCount;
268
269		/**
270	<	* Encoded index and event count of next event waiter. Used only
271	<	* by ForkJoinPool for managing event waiters.
270	>	* Encoded index and event count of next event waiter. Accessed
271	>	* only by ForkJoinPool for managing event waiters.
272		*/
273		volatile long nextWaiter;
274
275		/**
276	+	* Number of times this thread suspended as spare. Accessed only
277	+	* by pool.
278	+	*/
279	+	int spareCount;
280	+
281	+	/**
282	+	* Encoded index and count of next spare waiter. Accessed only
283	+	* by ForkJoinPool for managing spares.
284	+	*/
285	+	volatile int nextSpare;
286	+
287	+	/**
288		* The task currently being joined, set only when actively trying
289	<	* to helpStealer. Written only by current thread, but read by
290	<	* others.
289	>	* to help other stealers in helpJoinTask. Written only by this
290	>	* thread, but read by others.
291		*/
292		private volatile ForkJoinTask<?> currentJoin;
293
294		/**
295		* The task most recently stolen from another worker (or
296	<	* submission queue).  Not volatile because always read/written in
297	<	* presence of related volatiles in those cases where it matters.
296	>	* submission queue).  Written only by this thread, but read by
297	>	* others.
298		*/
299	<	private ForkJoinTask<?> currentSteal;
299	>	private volatile ForkJoinTask<?> currentSteal;
300
301		/**
302		* Creates a ForkJoinWorkerThread operating in the given pool.
#	Line 312 | Line 307 | public class ForkJoinWorkerThread extend
307		protected ForkJoinWorkerThread(ForkJoinPool pool) {
308		this.pool = pool;
309		this.locallyFifo = pool.locallyFifo;
310	+	setDaemon(true);
311		// To avoid exposing construction details to subclasses,
312		// remaining initialization is in start() and onStart()
313		}
314
315		/**
316	<	* Performs additional initialization and starts this thread
316	>	* Performs additional initialization and starts this thread.
317		*/
318		final void start(int poolIndex, UncaughtExceptionHandler ueh) {
319		this.poolIndex = poolIndex;
320		if (ueh != null)
321		setUncaughtExceptionHandler(ueh);
326	–	setDaemon(true);
322		start();
323		}
324
#	Line 354 | Line 349 | public class ForkJoinWorkerThread extend
349		/**
350		* Initializes internal state after construction but before
351		* processing any tasks. If you override this method, you must
352	<	* invoke super.onStart() at the beginning of the method.
352	>	* invoke {@code super.onStart()} at the beginning of the method.
353		* Initialization requires care: Most fields must have legal
354		* default values, to ensure that attempted accesses from other
355		* threads work correctly even before this thread starts
#	Line 362 | Line 357 | public class ForkJoinWorkerThread extend
357		*/
358		protected void onStart() {
359		int rs = seedGenerator.nextInt();
360	<	seed = rs == 0? 1 : rs; // seed must be nonzero
360	>	seed = (rs == 0) ? 1 : rs; // seed must be nonzero
361
362		// Allocate name string and arrays in this thread
363		String pid = Integer.toString(pool.getPoolNumber());
#	Line 382 | Line 377 | public class ForkJoinWorkerThread extend
377		*/
378		protected void onTermination(Throwable exception) {
379		try {
380	+	ForkJoinPool p = pool;
381	+	if (active) {
382	+	int a; // inline p.tryDecrementActiveCount
383	+	active = false;
384	+	do {} while (!UNSAFE.compareAndSwapInt
385	+	(p, poolRunStateOffset, a = p.runState, a - 1));
386	+	}
387		cancelTasks();
388		setTerminated();
389	<	pool.workerTerminated(this);
389	>	p.workerTerminated(this);
390		} catch (Throwable ex) {        // Shouldn't ever happen
391		if (exception == null)      // but if so, at least rethrown
392		exception = ex;
#	Line 397 | Line 399 | public class ForkJoinWorkerThread extend
399		/**
400		* This method is required to be public, but should never be
401		* called explicitly. It performs the main run loop to execute
402	<	* ForkJoinTasks.
402	>	* {@link ForkJoinTask}s.
403		*/
404		public void run() {
405		Throwable exception = null;
#	Line 414 | Line 416 | public class ForkJoinWorkerThread extend
416		// helpers for run()
417
418		/**
419	<	* Find and execute tasks and check status while running
419	>	* Finds and executes tasks, and checks status while running.
420		*/
421		private void mainLoop() {
422	<	int emptyScans = 0; // consecutive times failed to find work
422	>	boolean ran = false; // true if ran a task on last step
423		ForkJoinPool p = pool;
424		for (;;) {
425	<	p.preStep(this, emptyScans);
425	>	p.preStep(this, ran);
426		if (runState != 0)
427	<	return;
428	<	ForkJoinTask<?> t; // try to get and run stolen or submitted task
427	<	if ((t = scan()) != null || (t = pollSubmission()) != null) {
428	<	t.tryExec();
429	<	if (base != sp)
430	<	runLocalTasks();
431	<	currentSteal = null;
432	<	emptyScans = 0;
433	<	}
434	<	else
435	<	++emptyScans;
427	>	break;
428	>	ran = tryExecSteal() || tryExecSubmission();
429		}
430		}
431
432		/**
433	<	* Runs local tasks until queue is empty or shut down.  Call only
434	<	* while active.
433	>	* Tries to steal a task and execute it.
434	>	*
435	>	* @return true if ran a task
436		*/
437	<	private void runLocalTasks() {
438	<	while (runState == 0) {
439	<	ForkJoinTask<?> t = locallyFifo? locallyDeqTask() : popTask();
440	<	if (t != null)
441	<	t.tryExec();
442	<	else if (base == sp)
443	<	break;
437	>	private boolean tryExecSteal() {
438	>	ForkJoinTask<?> t;
439	>	if ((t = scan()) != null) {
440	>	t.quietlyExec();
441	>	UNSAFE.putOrderedObject(this, currentStealOffset, null);
442	>	if (sp != base)
443	>	execLocalTasks();
444	>	return true;
445		}
446	+	return false;
447		}
448
449		/**
450	<	* If a submission exists, try to activate and take it
450	>	* If a submission exists, try to activate and run it.
451		*
452	<	* @return a task, if available
452	>	* @return true if ran a task
453		*/
454	<	private ForkJoinTask<?> pollSubmission() {
454	>	private boolean tryExecSubmission() {
455		ForkJoinPool p = pool;
456	+	// This loop is needed in case attempt to activate fails, in
457	+	// which case we only retry if there still appears to be a
458	+	// submission.
459		while (p.hasQueuedSubmissions()) {
460	<	if (active || (active = p.tryIncrementActiveCount())) {
461	<	ForkJoinTask<?> t = p.pollSubmission();
462	<	if (t != null) {
463	<	currentSteal = t;
464	<	return t;
460	>	ForkJoinTask<?> t; int a;
461	>	if (active || // inline p.tryIncrementActiveCount
462	>	(active = UNSAFE.compareAndSwapInt(p, poolRunStateOffset,
463	>	a = p.runState, a + 1))) {
464	>	if ((t = p.pollSubmission()) != null) {
465	>	UNSAFE.putOrderedObject(this, currentStealOffset, t);
466	>	t.quietlyExec();
467	>	UNSAFE.putOrderedObject(this, currentStealOffset, null);
468	>	if (sp != base)
469	>	execLocalTasks();
470	>	return true;
471		}
467	–	return scan(); // if missed, rescan
472		}
473		}
474	<	return null;
474	>	return false;
475	>	}
476	>
477	>	/**
478	>	* Runs local tasks until queue is empty or shut down.  Call only
479	>	* while active.
480	>	*/
481	>	private void execLocalTasks() {
482	>	while (runState == 0) {
483	>	ForkJoinTask<?> t = locallyFifo ? locallyDeqTask() : popTask();
484	>	if (t != null)
485	>	t.quietlyExec();
486	>	else if (sp == base)
487	>	break;
488	>	}
489		}
490
491		/*
492		* Intrinsics-based atomic writes for queue slots. These are
493	<	* basically the same as methods in AtomicObjectArray, but
493	>	* basically the same as methods in AtomicReferenceArray, but
494		* specialized for (1) ForkJoinTask elements (2) requirement that
495		* nullness and bounds checks have already been performed by
496		* callers and (3) effective offsets are known not to overflow
497		* from int to long (because of MAXIMUM_QUEUE_CAPACITY). We don't
498		* need corresponding version for reads: plain array reads are OK
499	<	* because they protected by other volatile reads and are
499	>	* because they are protected by other volatile reads and are
500		* confirmed by CASes.
501		*
502		* Most uses don't actually call these methods, but instead contain
#	Line 502 | Line 520 | public class ForkJoinWorkerThread extend
520		* range. This method is used only during resets and backouts.
521		*/
522		private static final void writeSlot(ForkJoinTask<?>[] q, int i,
523	<	ForkJoinTask<?> t) {
523	>	ForkJoinTask<?> t) {
524		UNSAFE.putObjectVolatile(q, (i << qShift) + qBase, t);
525		}
526
#	Line 535 | Line 553 | public class ForkJoinWorkerThread extend
553		ForkJoinTask<?> t;
554		ForkJoinTask<?>[] q;
555		int b, i;
556	<	if ((b = base) != sp &&
556	>	if (sp != (b = base) &&
557		(q = queue) != null && // must read q after b
558		(t = q[i = (q.length - 1) & b]) != null && base == b &&
559		UNSAFE.compareAndSwapObject(q, (i << qShift) + qBase, t, null)) {
#	Line 547 | Line 565 | public class ForkJoinWorkerThread extend
565
566		/**
567		* Tries to take a task from the base of own queue. Assumes active
568	<	* status.  Called only by current thread.
568	>	* status.  Called only by this thread.
569		*
570		* @return a task, or null if none
571		*/
#	Line 570 | Line 588 | public class ForkJoinWorkerThread extend
588
589		/**
590		* Returns a popped task, or null if empty. Assumes active status.
591	<	* Called only by current thread.
591	>	* Called only by this thread.
592		*/
593	<	final ForkJoinTask<?> popTask() {
594	<	int s;
595	<	ForkJoinTask<?>[] q;
596	<	if (base != (s = sp) && (q = queue) != null) {
597	<	int i = (q.length - 1) & --s;
598	<	ForkJoinTask<?> t = q[i];
599	<	if (t != null && UNSAFE.compareAndSwapObject
600	<	(q, (i << qShift) + qBase, t, null)) {
601	<	sp = s;
602	<	return t;
593	>	private ForkJoinTask<?> popTask() {
594	>	ForkJoinTask<?>[] q = queue;
595	>	if (q != null) {
596	>	int s;
597	>	while ((s = sp) != base) {
598	>	int i = (q.length - 1) & --s;
599	>	long u = (i << qShift) + qBase; // raw offset
600	>	ForkJoinTask<?> t = q[i];
601	>	if (t == null)   // lost to stealer
602	>	break;
603	>	if (UNSAFE.compareAndSwapObject(q, u, t, null)) {
604	>	/*
605	>	* Note: here and in related methods, as a
606	>	* performance (not correctness) issue, we'd like
607	>	* to encourage compiler not to arbitrarily
608	>	* postpone setting sp after successful CAS.
609	>	* Currently there is no intrinsic for arranging
610	>	* this, but using Unsafe putOrderedInt may be a
611	>	* preferable strategy on some compilers even
612	>	* though its main effect is a pre-, not post-
613	>	* fence. To simplify possible changes, the option
614	>	* is left in comments next to the associated
615	>	* assignments.
616	>	*/
617	>	sp = s; // putOrderedInt may encourage more timely write
618	>	// UNSAFE.putOrderedInt(this, spOffset, s);
619	>	return t;
620	>	}
621		}
622		}
623		return null;
#	Line 589 | Line 625 | public class ForkJoinWorkerThread extend
625
626		/**
627		* Specialized version of popTask to pop only if topmost element
628	<	* is the given task. Called only by current thread while
593	<	* active.
628	>	* is the given task. Called only by this thread while active.
629		*
630		* @param t the task. Caller must ensure non-null.
631		*/
632		final boolean unpushTask(ForkJoinTask<?> t) {
633		int s;
634	<	ForkJoinTask<?>[] q;
635	<	if (base != (s = sp) && (q = queue) != null &&
634	>	ForkJoinTask<?>[] q = queue;
635	>	if ((s = sp) != base && q != null &&
636		UNSAFE.compareAndSwapObject
637		(q, (((q.length - 1) & --s) << qShift) + qBase, t, null)) {
638	<	sp = s;
638	>	sp = s; // putOrderedInt may encourage more timely write
639	>	// UNSAFE.putOrderedInt(this, spOffset, s);
640		return true;
641		}
642		return false;
643		}
644
645		/**
646	<	* Returns next task or null if empty or contended
646	>	* Returns next task, or null if empty or contended.
647		*/
648		final ForkJoinTask<?> peekTask() {
649		ForkJoinTask<?>[] q = queue;
#	Line 649 | Line 685 | public class ForkJoinWorkerThread extend
685		* Computes next value for random victim probe in scan().  Scans
686		* don't require a very high quality generator, but also not a
687		* crummy one.  Marsaglia xor-shift is cheap and works well enough.
688	<	* Note: This is manually inlined in scan()
688	>	* Note: This is manually inlined in scan().
689		*/
690		private static final int xorShift(int r) {
691		r ^= r << 13;
#	Line 688 | Line 724 | public class ForkJoinWorkerThread extend
724		for (;;) {
725		ForkJoinWorkerThread v = ws[k & mask];
726		r ^= r << 13; r ^= r >>> 17; r ^= r << 5; // inline xorshift
727	<	if (v != null && v.base != v.sp) {
728	<	if (canSteal ||       // ensure active status
729	<	(canSteal = active = p.tryIncrementActiveCount())) {
730	<	int b = v.base;   // inline specialized deqTask
731	<	ForkJoinTask<?>[] q;
732	<	if (b != v.sp && (q = v.queue) != null) {
733	<	ForkJoinTask<?> t;
734	<	int i = (q.length - 1) & b;
735	<	long u = (i << qShift) + qBase; // raw offset
736	<	if ((t = q[i]) != null && v.base == b &&
737	<	UNSAFE.compareAndSwapObject(q, u, t, null)) {
738	<	currentSteal = t;
739	<	v.stealHint = poolIndex;
740	<	v.base = b + 1;
741	<	seed = r;
742	<	++stealCount;
743	<	return t;
744	<	}
727	>	ForkJoinTask<?>[] q; ForkJoinTask<?> t; int b, a;
728	>	if (v != null && (b = v.base) != v.sp &&
729	>	(q = v.queue) != null) {
730	>	int i = (q.length - 1) & b;
731	>	long u = (i << qShift) + qBase; // raw offset
732	>	int pid = poolIndex;
733	>	if ((t = q[i]) != null) {
734	>	if (!canSteal &&  // inline p.tryIncrementActiveCount
735	>	UNSAFE.compareAndSwapInt(p, poolRunStateOffset,
736	>	a = p.runState, a + 1))
737	>	canSteal = active = true;
738	>	if (canSteal && v.base == b++ &&
739	>	UNSAFE.compareAndSwapObject(q, u, t, null)) {
740	>	v.base = b;
741	>	v.stealHint = pid;
742	>	UNSAFE.putOrderedObject(this,
743	>	currentStealOffset, t);
744	>	seed = r;
745	>	++stealCount;
746	>	return t;
747		}
748		}
749		j = -n;
#	Line 725 | Line 763 | public class ForkJoinWorkerThread extend
763		// Run State management
764
765		// status check methods used mainly by ForkJoinPool
766	<	final boolean isTerminating() { return (runState & TERMINATING) != 0; }
767	<	final boolean isTerminated()  { return (runState & TERMINATED) != 0; }
768	<	final boolean isSuspended()   { return (runState & SUSPENDED) != 0; }
769	<	final boolean isTrimmed()     { return (runState & TRIMMED) != 0; }
766	>	final boolean isRunning()    { return runState == 0; }
767	>	final boolean isTerminated() { return (runState & TERMINATED) != 0; }
768	>	final boolean isSuspended()  { return (runState & SUSPENDED) != 0; }
769	>	final boolean isTrimmed()    { return (runState & TRIMMED) != 0; }
770	>
771	>	final boolean isTerminating() {
772	>	if ((runState & TERMINATING) != 0)
773	>	return true;
774	>	if (pool.isAtLeastTerminating()) { // propagate pool state
775	>	shutdown();
776	>	return true;
777	>	}
778	>	return false;
779	>	}
780
781		/**
782	<	* Sets state to TERMINATING, also resuming if suspended.
782	>	* Sets state to TERMINATING. Does NOT unpark or interrupt
783	>	* to wake up if currently blocked. Callers must do so if desired.
784		*/
785		final void shutdown() {
786		for (;;) {
787		int s = runState;
788	+	if ((s & (TERMINATING|TERMINATED)) != 0)
789	+	break;
790		if ((s & SUSPENDED) != 0) { // kill and wakeup if suspended
791		if (UNSAFE.compareAndSwapInt(this, runStateOffset, s,
792		(s & ~SUSPENDED) |
793	<	(TRIMMED|TERMINATING))) {
743	<	LockSupport.unpark(this);
793	>	(TRIMMED|TERMINATING)))
794		break;
745	–	}
795		}
796		else if (UNSAFE.compareAndSwapInt(this, runStateOffset, s,
797		s | TERMINATING))
#	Line 751 | Line 800 | public class ForkJoinWorkerThread extend
800		}
801
802		/**
803	<	* Sets state to TERMINATED. Called only by this thread.
803	>	* Sets state to TERMINATED. Called only by onTermination().
804		*/
805		private void setTerminated() {
806		int s;
#	Line 761 | Line 810 | public class ForkJoinWorkerThread extend
810		}
811
812		/**
813	<	* Instrumented version of park used by ForkJoinPool.awaitEvent
814	<	*/
766	<	final void doPark() {
767	<	++parkCount;
768	<	LockSupport.park(this);
769	<	}
770	<
771	<	/**
772	<	* If suspended, tries to set status to unsuspended and unparks.
813	>	* If suspended, tries to set status to unsuspended.
814	>	* Does NOT wake up if blocked.
815		*
816		* @return true if successful
817		*/
818	<	final boolean tryResumeSpare() {
819	<	int s = runState;
820	<	if ((s & SUSPENDED) != 0 &&
821	<	UNSAFE.compareAndSwapInt(this, runStateOffset, s,
822	<	s & ~SUSPENDED)) {
823	<	LockSupport.unpark(this);
782	<	return true;
818	>	final boolean tryUnsuspend() {
819	>	int s;
820	>	while (((s = runState) & SUSPENDED) != 0) {
821	>	if (UNSAFE.compareAndSwapInt(this, runStateOffset, s,
822	>	s & ~SUSPENDED))
823	>	return true;
824		}
825		return false;
826		}
827
828		/**
829	<	* Sets suspended status and blocks as spare until resumed,
830	<	* shutdown, or timed out.
790	<	*
791	<	* @return false if trimmed
829	>	* Sets suspended status and blocks as spare until resumed
830	>	* or shutdown.
831		*/
832	<	final boolean suspendAsSpare() {
833	<	for (;;) {               // set suspended unless terminating
832	>	final void suspendAsSpare() {
833	>	for (;;) {                  // set suspended unless terminating
834		int s = runState;
835		if ((s & TERMINATING) != 0) { // must kill
836		if (UNSAFE.compareAndSwapInt(this, runStateOffset, s,
837		s | (TRIMMED | TERMINATING)))
838	<	return false;
838	>	return;
839		}
840		else if (UNSAFE.compareAndSwapInt(this, runStateOffset, s,
841		s | SUSPENDED))
842		break;
843		}
844	<	boolean timed;
845	<	long nanos;
807	<	long startTime;
808	<	if (poolIndex < pool.parallelism) {
809	<	timed = false;
810	<	nanos = 0L;
811	<	startTime = 0L;
812	<	}
813	<	else {
814	<	timed = true;
815	<	nanos = SPARE_KEEPALIVE_NANOS;
816	<	startTime = System.nanoTime();
817	<	}
818	<	pool.accumulateStealCount(this);
819	<	lastEventCount = 0;      // reset upon resume
820	<	interrupted();           // clear/ignore interrupts
844	>	ForkJoinPool p = pool;
845	>	p.pushSpare(this);
846		while ((runState & SUSPENDED) != 0) {
847	<	++parkCount;
848	<	if (!timed)
847	>	if (p.tryAccumulateStealCount(this)) {
848	>	interrupted();          // clear/ignore interrupts
849	>	if ((runState & SUSPENDED) == 0)
850	>	break;
851		LockSupport.park(this);
825	–	else if ((nanos -= (System.nanoTime() - startTime)) > 0)
826	–	LockSupport.parkNanos(this, nanos);
827	–	else { // try to trim on timeout
828	–	int s = runState;
829	–	if (UNSAFE.compareAndSwapInt(this, runStateOffset, s,
830	–	(s & ~SUSPENDED) |
831	–	(TRIMMED|TERMINATING)))
832	–	return false;
852		}
853		}
835	–	return true;
854		}
855
856		// Misc support methods for ForkJoinPool
#	Line 842 | Line 860 | public class ForkJoinWorkerThread extend
860		* used by ForkJoinTask.
861		*/
862		final int getQueueSize() {
863	<	return -base + sp;
863	>	int n; // external calls must read base first
864	>	return (n = -base + sp) <= 0 ? 0 : n;
865		}
866
867		/**
#	Line 850 | Line 869 | public class ForkJoinWorkerThread extend
869		* thread.
870		*/
871		final void cancelTasks() {
872	<	ForkJoinTask<?> cj = currentJoin; // try to kill live tasks
873	<	if (cj != null) {
855	<	currentJoin = null;
872	>	ForkJoinTask<?> cj = currentJoin; // try to cancel ongoing tasks
873	>	if (cj != null && cj.status >= 0) {
874		cj.cancelIgnoringExceptions();
875	+	try {
876	+	this.interrupt(); // awaken wait
877	+	} catch (SecurityException ignore) {
878	+	}
879		}
880		ForkJoinTask<?> cs = currentSteal;
881	<	if (cs != null) {
860	<	currentSteal = null;
881	>	if (cs != null && cs.status >= 0)
882		cs.cancelIgnoringExceptions();
862	–	}
883		while (base != sp) {
884		ForkJoinTask<?> t = deqTask();
885		if (t != null)
#	Line 892 | Line 912 | public class ForkJoinWorkerThread extend
912		* @return a task, if available
913		*/
914		final ForkJoinTask<?> pollLocalTask() {
915	+	ForkJoinPool p = pool;
916		while (sp != base) {
917	<	if (active || (active = pool.tryIncrementActiveCount()))
918	<	return locallyFifo? locallyDeqTask() : popTask();
917	>	int a; // inline p.tryIncrementActiveCount
918	>	if (active ||
919	>	(active = UNSAFE.compareAndSwapInt(p, poolRunStateOffset,
920	>	a = p.runState, a + 1)))
921	>	return locallyFifo ? locallyDeqTask() : popTask();
922		}
923		return null;
924		}
#	Line 905 | Line 929 | public class ForkJoinWorkerThread extend
929		* @return a task, if available
930		*/
931		final ForkJoinTask<?> pollTask() {
932	<	ForkJoinTask<?> t;
933	<	return (t = pollLocalTask()) != null ? t : scan();
932	>	ForkJoinTask<?> t = pollLocalTask();
933	>	if (t == null) {
934	>	t = scan();
935	>	// cannot retain/track/help steal
936	>	UNSAFE.putOrderedObject(this, currentStealOffset, null);
937	>	}
938	>	return t;
939		}
940
941		/**
942		* Possibly runs some tasks and/or blocks, until task is done.
914	–	* The main body is basically a big spinloop, alternating between
915	–	* calls to helpJoinTask and pool.tryAwaitJoin with increased
916	–	* patience parameters until either the task is done without
917	–	* waiting, or we have, if necessary, created or resumed a
918	–	* replacement for this thread while it blocks.
943		*
944		* @param joinMe the task to join
945	<	* @return task status on exit
945	>	* @param timed true if use timed wait
946	>	* @param nanos wait time if timed
947		*/
948	<	final int joinTask(ForkJoinTask<?> joinMe) {
949	<	int stat;
948	>	final void joinTask(ForkJoinTask<?> joinMe, boolean timed, long nanos) {
949	>	// currentJoin only written by this thread; only need ordered store
950		ForkJoinTask<?> prevJoin = currentJoin;
951	<	currentJoin = joinMe;
952	<	if ((stat = joinMe.status) >= 0 &&
953	<	(sp == base || (stat = localHelpJoinTask(joinMe)) >= 0)) {
929	<	ForkJoinPool p = pool;
930	<	int helpRetries = 2;     // initial patience values
931	<	int awaitRetries = -1;   // -1 is sentinel for replace-check only
932	<	do {
933	<	helpJoinTask(joinMe, helpRetries);
934	<	if ((stat = joinMe.status) < 0)
935	<	break;
936	<	boolean busy = p.tryAwaitJoin(joinMe, awaitRetries);
937	<	if ((stat = joinMe.status) < 0)
938	<	break;
939	<	if (awaitRetries == -1)
940	<	awaitRetries = 0;
941	<	else if (busy)
942	<	++awaitRetries;
943	<	if (helpRetries < p.parallelism)
944	<	helpRetries <<= 1;
945	<	Thread.yield(); // tame unbounded loop
946	<	} while (joinMe.status >= 0);
947	<	}
948	<	currentJoin = prevJoin;
949	<	return stat;
950	<	}
951	<
952	<	/**
953	<	* Run tasks in local queue until given task is done.
954	<	*
955	<	* @param joinMe the task to join
956	<	* @return task status on exit
957	<	*/
958	<	private int localHelpJoinTask(ForkJoinTask<?> joinMe) {
959	<	int stat, s;
960	<	ForkJoinTask<?>[] q;
961	<	while ((stat = joinMe.status) >= 0 &&
962	<	base != (s = sp) && (q = queue) != null) {
963	<	ForkJoinTask<?> t;
964	<	int i = (q.length - 1) & --s;
965	<	long u = (i << qShift) + qBase; // raw offset
966	<	if ((t = q[i]) != null &&
967	<	UNSAFE.compareAndSwapObject(q, u, t, null)) {
968	<	/*
969	<	* This recheck (and similarly in helpJoinTask)
970	<	* handles cases where joinMe is independently
971	<	* cancelled or forced even though there is other work
972	<	* available. Back out of the pop by putting t back
973	<	* into slot before we commit by writing sp.
974	<	*/
975	<	if ((stat = joinMe.status) < 0) {
976	<	UNSAFE.putObjectVolatile(q, u, t);
977	<	break;
978	<	}
979	<	sp = s;
980	<	t.tryExec();
981	<	}
982	<	}
983	<	return stat;
951	>	UNSAFE.putOrderedObject(this, currentJoinOffset, joinMe);
952	>	pool.awaitJoin(joinMe, this, timed, nanos);
953	>	UNSAFE.putOrderedObject(this, currentJoinOffset, prevJoin);
954		}
955
956		/**
#	Line 988 | Line 958 | public class ForkJoinWorkerThread extend
958		* given task, or in turn one of its stealers.  Traces
959		* currentSteal->currentJoin links looking for a thread working on
960		* a descendant of the given task and with a non-empty queue to
961	<	* steal back and execute tasks from. Restarts search upon
962	<	* encountering chains that are stale, unknown, or of length
963	<	* greater than MAX_HELP_DEPTH links, to avoid unbounded cycles.
964	<	*
965	<	* The implementation is very branchy to cope with the restart
966	<	* cases.  Returns void, not task status (which must be reread by
967	<	* caller anyway) to slightly simplify control paths.
961	>	* steal back and execute tasks from.
962	>	*
963	>	* The implementation is very branchy to cope with potential
964	>	* inconsistencies or loops encountering chains that are stale,
965	>	* unknown, or of length greater than MAX_HELP_DEPTH links.  All
966	>	* of these cases are dealt with by just returning back to the
967	>	* caller, who is expected to retry if other join mechanisms also
968	>	* don't work out.
969		*
970		* @param joinMe the task to join
971	<	*/
972	<	final void helpJoinTask(ForkJoinTask<?> joinMe, int retries) {
973	<	ForkJoinWorkerThread[] ws = pool.workers;
974	<	int n;
975	<	if (ws == null || (n = ws.length) <= 1)
976	<	return;                   // need at least 2 workers
971	>	* @param running if false, then must update pool count upon
972	>	*  running a task
973	>	* @return value of running on exit
974	>	*/
975	>	final boolean helpJoinTask(ForkJoinTask<?> joinMe, boolean running) {
976	>	/*
977	>	* Initial checks to (1) abort if terminating; (2) clean out
978	>	* old cancelled tasks from local queue; (3) if joinMe is next
979	>	* task, run it; (4) omit scan if local queue nonempty (since
980	>	* it may contain non-descendents of joinMe).
981	>	*/
982	>	ForkJoinPool p = pool;
983	>	for (;;) {
984	>	ForkJoinTask<?>[] q;
985	>	int s;
986	>	if (joinMe.status < 0)
987	>	return running;
988	>	else if ((runState & TERMINATING) != 0) {
989	>	joinMe.cancelIgnoringExceptions();
990	>	return running;
991	>	}
992	>	else if ((s = sp) == base || (q = queue) == null)
993	>	break;                            // queue empty
994	>	else {
995	>	int i = (q.length - 1) & --s;
996	>	long u = (i << qShift) + qBase;   // raw offset
997	>	ForkJoinTask<?> t = q[i];
998	>	if (t == null)
999	>	break;                        // lost to a stealer
1000	>	else if (t != joinMe && t.status >= 0)
1001	>	return running;               // cannot safely help
1002	>	else if ((running ||
1003	>	(running = p.tryIncrementRunningCount())) &&
1004	>	UNSAFE.compareAndSwapObject(q, u, t, null)) {
1005	>	sp = s; // putOrderedInt may encourage more timely write
1006	>	// UNSAFE.putOrderedInt(this, spOffset, s);
1007	>	t.quietlyExec();
1008	>	}
1009	>	}
1010	>	}
1011
1012	<	restart:while (joinMe.status >= 0 && --retries >= 0) {
1012	>	int n;                                    // worker array size
1013	>	ForkJoinWorkerThread[] ws = p.workers;
1014	>	if (ws != null && (n = ws.length) > 1) {  // need at least 2 workers
1015		ForkJoinTask<?> task = joinMe;        // base of chain
1016		ForkJoinWorkerThread thread = this;   // thread with stolen task
1017	<	for (int depth = 0; depth < MAX_HELP_DEPTH; ++depth) {
1017	>
1018	>	outer:for (int d = 0; d < MAX_HELP_DEPTH; ++d) { // chain length
1019		// Try to find v, the stealer of task, by first using hint
1020		ForkJoinWorkerThread v = ws[thread.stealHint & (n - 1)];
1021		if (v == null || v.currentSteal != task) {
1022		for (int j = 0; ; ++j) {      // search array
1023	<	if (task.status < 0 || j == n)
1024	<	continue restart;     // stale or no stealer
1025	<	if ((v = ws[j]) != null && v.currentSteal == task) {
1026	<	thread.stealHint = j; // save for next time
1027	<	break;
1023	>	if (j < n) {
1024	>	ForkJoinTask<?> vs;
1025	>	if ((v = ws[j]) != null &&
1026	>	(vs = v.currentSteal) != null) {
1027	>	if (joinMe.status < 0)
1028	>	break outer;
1029	>	if (vs == task) {
1030	>	if (task.status < 0)
1031	>	break outer; // stale
1032	>	thread.stealHint = j;
1033	>	break;        // save hint for next time
1034	>	}
1035	>	}
1036		}
1037	+	else
1038	+	break outer;          // no stealer
1039		}
1040		}
1041	+
1042		// Try to help v, using specialized form of deqTask
1043	<	int b;
1044	<	ForkJoinTask<?>[] q;
1045	<	while ((b = v.base) != v.sp && (q = v.queue) != null) {
1043	>	for (;;) {
1044	>	if (joinMe.status < 0)
1045	>	break outer;
1046	>	int b = v.base;
1047	>	ForkJoinTask<?>[] q = v.queue;
1048	>	if (b == v.sp || q == null)
1049	>	break;                    // empty
1050		int i = (q.length - 1) & b;
1051		long u = (i << qShift) + qBase;
1052		ForkJoinTask<?> t = q[i];
1053	<	if (task.status < 0)          // stale
1054	<	continue restart;
1055	<	if (v.base == b) {            // recheck after reading t
1056	<	if (t == null)            // producer stalled
1057	<	continue restart;     // retry via restart
1058	<	if (UNSAFE.compareAndSwapObject(q, u, t, null)) {
1059	<	if (joinMe.status < 0) {
1060	<	UNSAFE.putObjectVolatile(q, u, t);
1061	<	return;           // back out on cancel
1062	<	}
1063	<	ForkJoinTask<?> prevSteal = currentSteal;
1064	<	currentSteal = t;
1065	<	v.stealHint = poolIndex;
1066	<	v.base = b + 1;
1067	<	t.tryExec();
1068	<	currentSteal = prevSteal;
1053	>	if (task.status < 0)
1054	>	break outer;              // stale
1055	>	if (t != null &&
1056	>	(running ||
1057	>	(running = p.tryIncrementRunningCount())) &&
1058	>	v.base == b++ &&
1059	>	UNSAFE.compareAndSwapObject(q, u, t, null)) {
1060	>	if (t != joinMe && joinMe.status < 0) {
1061	>	UNSAFE.putObjectVolatile(q, u, t);
1062	>	break outer;          // joinMe cancelled; back out
1063	>	}
1064	>	v.base = b;
1065	>	if (t.status >= 0) {
1066	>	ForkJoinTask<?> ps = currentSteal;
1067	>	int pid = poolIndex;
1068	>	v.stealHint = pid;
1069	>	UNSAFE.putOrderedObject(this,
1070	>	currentStealOffset, t);
1071	>	t.quietlyExec();
1072	>	UNSAFE.putOrderedObject(this,
1073	>	currentStealOffset, ps);
1074		}
1075		}
1076	<	if (joinMe.status < 0)
1077	<	return;
1076	>	else if ((runState & TERMINATING) != 0) {
1077	>	joinMe.cancelIgnoringExceptions();
1078	>	break outer;
1079	>	}
1080		}
1081	+
1082		// Try to descend to find v's stealer
1083		ForkJoinTask<?> next = v.currentJoin;
1084	<	if (next == null || task.status < 0)
1085	<	continue restart;             // no descendent or stale
1086	<	if (joinMe.status < 0)
1056	<	return;
1084	>	if (task.status < 0 || next == null || next == task ||
1085	>	joinMe.status < 0)
1086	>	break;                 // done, stale, dead-end, or cyclic
1087		task = next;
1088		thread = v;
1089		}
1090		}
1091	+	return running;
1092		}
1093
1094		/**
1095	+	* Implements ForkJoinTask.getSurplusQueuedTaskCount().
1096		* Returns an estimate of the number of tasks, offset by a
1097		* function of number of idle workers.
1098		*
#	Line 1115 | Line 1147 | public class ForkJoinWorkerThread extend
1147		* Runs tasks until {@code pool.isQuiescent()}.
1148		*/
1149		final void helpQuiescePool() {
1150	+	ForkJoinTask<?> ps = currentSteal; // to restore below
1151		for (;;) {
1152		ForkJoinTask<?> t = pollLocalTask();
1153	<	if (t != null || (t = scan()) != null) {
1154	<	t.tryExec();
1122	<	currentSteal = null;
1123	<	}
1153	>	if (t != null || (t = scan()) != null)
1154	>	t.quietlyExec();
1155		else {
1156		ForkJoinPool p = pool;
1157	+	int a; // to inline CASes
1158		if (active) {
1159	+	if (!UNSAFE.compareAndSwapInt
1160	+	(p, poolRunStateOffset, a = p.runState, a - 1))
1161	+	continue;   // retry later
1162		active = false; // inactivate
1163	<	do {} while (!p.tryDecrementActiveCount());
1163	>	UNSAFE.putOrderedObject(this, currentStealOffset, ps);
1164		}
1165		if (p.isQuiescent()) {
1166		active = true; // re-activate
1167	<	do {} while (!p.tryIncrementActiveCount());
1167	>	do {} while (!UNSAFE.compareAndSwapInt
1168	>	(p, poolRunStateOffset, a = p.runState, a+1));
1169		return;
1170		}
1171		}
#	Line 1139 | Line 1175 | public class ForkJoinWorkerThread extend
1175		// Unsafe mechanics
1176
1177		private static final sun.misc.Unsafe UNSAFE = getUnsafe();
1178	+	private static final long spOffset =
1179	+	objectFieldOffset("sp", ForkJoinWorkerThread.class);
1180		private static final long runStateOffset =
1181		objectFieldOffset("runState", ForkJoinWorkerThread.class);
1182	+	private static final long currentJoinOffset =
1183	+	objectFieldOffset("currentJoin", ForkJoinWorkerThread.class);
1184	+	private static final long currentStealOffset =
1185	+	objectFieldOffset("currentSteal", ForkJoinWorkerThread.class);
1186		private static final long qBase =
1187		UNSAFE.arrayBaseOffset(ForkJoinTask[].class);
1188	+	private static final long poolRunStateOffset = // to inline CAS
1189	+	objectFieldOffset("runState", ForkJoinPool.class);
1190	+
1191		private static final int qShift;
1192
1193		static {
#	Line 1150 | Line 1195 | public class ForkJoinWorkerThread extend
1195		if ((s & (s-1)) != 0)
1196		throw new Error("data type scale not a power of two");
1197		qShift = 31 - Integer.numberOfLeadingZeros(s);
1198	+	MAXIMUM_QUEUE_CAPACITY = 1 << (31 - qShift);
1199		}
1200
1201		private static long objectFieldOffset(String field, Class<?> klazz) {

Diff Legend

–	Removed lines
+	Added lines
<	Changed lines
>	Changed lines