| 5 |
|
*/ |
| 6 |
|
|
| 7 |
|
package jsr166y; |
| 8 |
< |
import java.util.*; |
| 8 |
> |
|
| 9 |
|
import java.util.concurrent.*; |
| 10 |
< |
import java.util.concurrent.atomic.*; |
| 11 |
< |
import java.util.concurrent.locks.*; |
| 12 |
< |
import sun.misc.Unsafe; |
| 13 |
< |
import java.lang.reflect.*; |
| 10 |
> |
|
| 11 |
> |
import java.util.Collection; |
| 12 |
|
|
| 13 |
|
/** |
| 14 |
|
* A thread managed by a {@link ForkJoinPool}. This class is |
| 15 |
|
* subclassable solely for the sake of adding functionality -- there |
| 16 |
< |
* are no overridable methods dealing with scheduling or |
| 17 |
< |
* execution. However, you can override initialization and termination |
| 18 |
< |
* methods surrounding the main task processing loop. If you do |
| 19 |
< |
* create such a subclass, you will also need to supply a custom |
| 20 |
< |
* ForkJoinWorkerThreadFactory to use it in a ForkJoinPool. |
| 16 |
> |
* are no overridable methods dealing with scheduling or execution. |
| 17 |
> |
* However, you can override initialization and termination methods |
| 18 |
> |
* surrounding the main task processing loop. If you do create such a |
| 19 |
> |
* subclass, you will also need to supply a custom {@link |
| 20 |
> |
* ForkJoinPool.ForkJoinWorkerThreadFactory} to use it in a {@code |
| 21 |
> |
* ForkJoinPool}. |
| 22 |
|
* |
| 23 |
|
* @since 1.7 |
| 24 |
|
* @author Doug Lea |
| 66 |
|
* which gives threads a chance to activate if necessary before |
| 67 |
|
* stealing (see below). |
| 68 |
|
* |
| 69 |
+ |
* This approach also enables support for "async mode" where local |
| 70 |
+ |
* task processing is in FIFO, not LIFO order; simply by using a |
| 71 |
+ |
* version of deq rather than pop when locallyFifo is true (as set |
| 72 |
+ |
* by the ForkJoinPool). This allows use in message-passing |
| 73 |
+ |
* frameworks in which tasks are never joined. |
| 74 |
+ |
* |
| 75 |
|
* Efficient implementation of this approach currently relies on |
| 76 |
|
* an uncomfortable amount of "Unsafe" mechanics. To maintain |
| 77 |
|
* correct orderings, reads and writes of variable base require |
| 144 |
|
private static final int MAXIMUM_QUEUE_CAPACITY = 1 << 28; |
| 145 |
|
|
| 146 |
|
/** |
| 147 |
< |
* The pool this thread works in. Accessed directly by ForkJoinTask |
| 147 |
> |
* The pool this thread works in. Accessed directly by ForkJoinTask. |
| 148 |
|
*/ |
| 149 |
|
final ForkJoinPool pool; |
| 150 |
|
|
| 172 |
|
* Activity status. When true, this worker is considered active. |
| 173 |
|
* Must be false upon construction. It must be true when executing |
| 174 |
|
* tasks, and BEFORE stealing a task. It must be false before |
| 175 |
< |
* calling pool.sync |
| 175 |
> |
* calling pool.sync. |
| 176 |
|
*/ |
| 177 |
|
private boolean active; |
| 178 |
|
|
| 195 |
|
|
| 196 |
|
/** |
| 197 |
|
* Index of this worker in pool array. Set once by pool before |
| 198 |
< |
* running, and accessed directly by pool during cleanup etc |
| 198 |
> |
* running, and accessed directly by pool during cleanup etc. |
| 199 |
|
*/ |
| 200 |
|
int poolIndex; |
| 201 |
|
|
| 272 |
|
final boolean shutdownNow() { return transitionRunStateTo(TERMINATING); } |
| 273 |
|
|
| 274 |
|
/** |
| 275 |
< |
* Transitions to at least the given state. Returns true if not |
| 276 |
< |
* already at least at given state. |
| 275 |
> |
* Transitions to at least the given state. |
| 276 |
> |
* |
| 277 |
> |
* @return {@code true} if not already at least at given state |
| 278 |
|
*/ |
| 279 |
|
private boolean transitionRunStateTo(int state) { |
| 280 |
|
for (;;) { |
| 299 |
|
} |
| 300 |
|
|
| 301 |
|
/** |
| 302 |
< |
* Tries to set status to active; fails on contention. |
| 302 |
> |
* Tries to set status to inactive; fails on contention. |
| 303 |
|
*/ |
| 304 |
|
private boolean tryInactivate() { |
| 305 |
|
if (active) { |
| 316 |
|
* one. Marsaglia xor-shift is cheap and works well. |
| 317 |
|
*/ |
| 318 |
|
private static int xorShift(int r) { |
| 319 |
< |
r ^= r << 1; |
| 320 |
< |
r ^= r >>> 3; |
| 321 |
< |
r ^= r << 10; |
| 316 |
< |
return r; |
| 319 |
> |
r ^= (r << 13); |
| 320 |
> |
r ^= (r >>> 17); |
| 321 |
> |
return r ^ (r << 5); |
| 322 |
|
} |
| 323 |
|
|
| 324 |
|
// Lifecycle methods |
| 376 |
|
/** |
| 377 |
|
* Performs cleanup associated with termination of this worker |
| 378 |
|
* thread. If you override this method, you must invoke |
| 379 |
< |
* super.onTermination at the end of the overridden method. |
| 379 |
> |
* {@code super.onTermination} at the end of the overridden method. |
| 380 |
|
* |
| 381 |
|
* @param exception the exception causing this thread to abort due |
| 382 |
< |
* to an unrecoverable error, or null if completed normally |
| 382 |
> |
* to an unrecoverable error, or {@code null} if completed normally |
| 383 |
|
*/ |
| 384 |
|
protected void onTermination(Throwable exception) { |
| 385 |
|
// Execute remaining local tasks unless aborting or terminating |
| 386 |
< |
while (exception == null && !pool.isTerminating() && base != sp) { |
| 386 |
> |
while (exception == null && pool.isProcessingTasks() && base != sp) { |
| 387 |
|
try { |
| 388 |
|
ForkJoinTask<?> t = popTask(); |
| 389 |
|
if (t != null) |
| 390 |
|
t.quietlyExec(); |
| 391 |
< |
} catch(Throwable ex) { |
| 391 |
> |
} catch (Throwable ex) { |
| 392 |
|
exception = ex; |
| 393 |
|
} |
| 394 |
|
} |
| 395 |
|
// Cancel other tasks, transition status, notify pool, and |
| 396 |
|
// propagate exception to uncaught exception handler |
| 397 |
|
try { |
| 398 |
< |
do;while (!tryInactivate()); // ensure inactive |
| 398 |
> |
do {} while (!tryInactivate()); // ensure inactive |
| 399 |
|
cancelTasks(); |
| 400 |
|
runState = TERMINATED; |
| 401 |
|
pool.workerTerminated(this); |
| 415 |
|
* Caller must ensure q is non-null and index is in range. |
| 416 |
|
*/ |
| 417 |
|
private static void setSlot(ForkJoinTask<?>[] q, int i, |
| 418 |
< |
ForkJoinTask<?> t){ |
| 418 |
> |
ForkJoinTask<?> t) { |
| 419 |
|
UNSAFE.putOrderedObject(q, (i << qShift) + qBase, t); |
| 420 |
|
} |
| 421 |
|
|
| 476 |
|
} |
| 477 |
|
|
| 478 |
|
/** |
| 479 |
+ |
* Tries to take a task from the base of own queue, activating if |
| 480 |
+ |
* necessary, failing only if empty. Called only by current thread. |
| 481 |
+ |
* |
| 482 |
+ |
* @return a task, or null if none |
| 483 |
+ |
*/ |
| 484 |
+ |
final ForkJoinTask<?> locallyDeqTask() { |
| 485 |
+ |
int b; |
| 486 |
+ |
while (sp != (b = base)) { |
| 487 |
+ |
if (tryActivate()) { |
| 488 |
+ |
ForkJoinTask<?>[] q = queue; |
| 489 |
+ |
int i = (q.length - 1) & b; |
| 490 |
+ |
ForkJoinTask<?> t = q[i]; |
| 491 |
+ |
if (t != null && casSlotNull(q, i, t)) { |
| 492 |
+ |
base = b + 1; |
| 493 |
+ |
return t; |
| 494 |
+ |
} |
| 495 |
+ |
} |
| 496 |
+ |
} |
| 497 |
+ |
return null; |
| 498 |
+ |
} |
| 499 |
+ |
|
| 500 |
+ |
/** |
| 501 |
|
* Returns a popped task, or null if empty. Ensures active status |
| 502 |
|
* if non-null. Called only by current thread. |
| 503 |
|
*/ |
| 537 |
|
} |
| 538 |
|
|
| 539 |
|
/** |
| 540 |
< |
* Returns next task. |
| 540 |
> |
* Returns next task or null if empty or contended |
| 541 |
|
*/ |
| 542 |
|
final ForkJoinTask<?> peekTask() { |
| 543 |
|
ForkJoinTask<?>[] q = queue; |
| 544 |
|
if (q == null) |
| 545 |
|
return null; |
| 546 |
|
int mask = q.length - 1; |
| 547 |
< |
int i = locallyFifo? base : (sp - 1); |
| 547 |
> |
int i = locallyFifo ? base : (sp - 1); |
| 548 |
|
return q[i & mask]; |
| 549 |
|
} |
| 550 |
|
|
| 607 |
|
ForkJoinWorkerThread v = ws[mask & idx]; |
| 608 |
|
if (v == null || v.sp == v.base) { |
| 609 |
|
if (probes <= mask) |
| 610 |
< |
idx = (probes++ < 0)? r : (idx + 1); |
| 610 |
> |
idx = (probes++ < 0) ? r : (idx + 1); |
| 611 |
|
else |
| 612 |
|
break; |
| 613 |
|
} |
| 628 |
|
* @return a task, if available |
| 629 |
|
*/ |
| 630 |
|
final ForkJoinTask<?> pollTask() { |
| 631 |
< |
ForkJoinTask<?> t = locallyFifo? deqTask() : popTask(); |
| 631 |
> |
ForkJoinTask<?> t = locallyFifo ? locallyDeqTask() : popTask(); |
| 632 |
|
if (t == null && (t = scan()) != null) |
| 633 |
|
++stealCount; |
| 634 |
|
return t; |
| 640 |
|
* @return a task, if available |
| 641 |
|
*/ |
| 642 |
|
final ForkJoinTask<?> pollLocalTask() { |
| 643 |
< |
return locallyFifo? deqTask() : popTask(); |
| 643 |
> |
return locallyFifo ? locallyDeqTask() : popTask(); |
| 644 |
|
} |
| 645 |
|
|
| 646 |
|
/** |
| 675 |
|
* |
| 676 |
|
* @return the number of tasks drained |
| 677 |
|
*/ |
| 678 |
< |
final int drainTasksTo(Collection<ForkJoinTask<?>> c) { |
| 678 |
> |
final int drainTasksTo(Collection<? super ForkJoinTask<?>> c) { |
| 679 |
|
int n = 0; |
| 680 |
|
ForkJoinTask<?> t; |
| 681 |
|
while (base != sp && (t = deqTask()) != null) { |
| 696 |
|
} |
| 697 |
|
|
| 698 |
|
/** |
| 699 |
< |
* Returns true if at least one worker in the given array appears |
| 700 |
< |
* to have at least one queued task. |
| 699 |
> |
* Returns {@code true} if at least one worker in the given array |
| 700 |
> |
* appears to have at least one queued task. |
| 701 |
> |
* |
| 702 |
|
* @param ws array of workers |
| 703 |
|
*/ |
| 704 |
|
static boolean hasQueuedTasks(ForkJoinWorkerThread[] ws) { |
| 721 |
|
* Returns an estimate of the number of tasks in the queue. |
| 722 |
|
*/ |
| 723 |
|
final int getQueueSize() { |
| 724 |
< |
int n = sp - base; |
| 725 |
< |
return n < 0? 0 : n; // suppress momentarily negative values |
| 724 |
> |
// suppress momentarily negative values |
| 725 |
> |
return Math.max(0, sp - base); |
| 726 |
|
} |
| 727 |
|
|
| 728 |
|
/** |
| 735 |
|
} |
| 736 |
|
|
| 737 |
|
/** |
| 738 |
< |
* Scans, returning early if joinMe done |
| 738 |
> |
* Scans, returning early if joinMe done. |
| 739 |
|
*/ |
| 740 |
|
final ForkJoinTask<?> scanWhileJoining(ForkJoinTask<?> joinMe) { |
| 741 |
|
ForkJoinTask<?> t = pollTask(); |
| 747 |
|
} |
| 748 |
|
|
| 749 |
|
/** |
| 750 |
< |
* Runs tasks until pool isQuiescent. |
| 750 |
> |
* Runs tasks until {@code pool.isQuiescent()}. |
| 751 |
|
*/ |
| 752 |
|
final void helpQuiescePool() { |
| 753 |
|
for (;;) { |
| 757 |
|
else if (tryInactivate() && pool.isQuiescent()) |
| 758 |
|
break; |
| 759 |
|
} |
| 760 |
< |
do;while (!tryActivate()); // re-activate on exit |
| 760 |
> |
do {} while (!tryActivate()); // re-activate on exit |
| 761 |
> |
} |
| 762 |
> |
|
| 763 |
> |
// Unsafe mechanics |
| 764 |
> |
|
| 765 |
> |
private static final sun.misc.Unsafe UNSAFE = getUnsafe(); |
| 766 |
> |
private static final long spOffset = |
| 767 |
> |
objectFieldOffset("sp", ForkJoinWorkerThread.class); |
| 768 |
> |
private static final long runStateOffset = |
| 769 |
> |
objectFieldOffset("runState", ForkJoinWorkerThread.class); |
| 770 |
> |
private static final long qBase; |
| 771 |
> |
private static final int qShift; |
| 772 |
> |
|
| 773 |
> |
static { |
| 774 |
> |
qBase = UNSAFE.arrayBaseOffset(ForkJoinTask[].class); |
| 775 |
> |
int s = UNSAFE.arrayIndexScale(ForkJoinTask[].class); |
| 776 |
> |
if ((s & (s-1)) != 0) |
| 777 |
> |
throw new Error("data type scale not a power of two"); |
| 778 |
> |
qShift = 31 - Integer.numberOfLeadingZeros(s); |
| 779 |
> |
} |
| 780 |
> |
|
| 781 |
> |
private static long objectFieldOffset(String field, Class<?> klazz) { |
| 782 |
> |
try { |
| 783 |
> |
return UNSAFE.objectFieldOffset(klazz.getDeclaredField(field)); |
| 784 |
> |
} catch (NoSuchFieldException e) { |
| 785 |
> |
// Convert Exception to corresponding Error |
| 786 |
> |
NoSuchFieldError error = new NoSuchFieldError(field); |
| 787 |
> |
error.initCause(e); |
| 788 |
> |
throw error; |
| 789 |
> |
} |
| 790 |
|
} |
| 791 |
|
|
| 792 |
< |
// Temporary Unsafe mechanics for preliminary release |
| 793 |
< |
private static Unsafe getUnsafe() throws Throwable { |
| 792 |
> |
/** |
| 793 |
> |
* Returns a sun.misc.Unsafe. Suitable for use in a 3rd party package. |
| 794 |
> |
* Replace with a simple call to Unsafe.getUnsafe when integrating |
| 795 |
> |
* into a jdk. |
| 796 |
> |
* |
| 797 |
> |
* @return a sun.misc.Unsafe |
| 798 |
> |
*/ |
| 799 |
> |
private static sun.misc.Unsafe getUnsafe() { |
| 800 |
|
try { |
| 801 |
< |
return Unsafe.getUnsafe(); |
| 801 |
> |
return sun.misc.Unsafe.getUnsafe(); |
| 802 |
|
} catch (SecurityException se) { |
| 803 |
|
try { |
| 804 |
|
return java.security.AccessController.doPrivileged |
| 805 |
< |
(new java.security.PrivilegedExceptionAction<Unsafe>() { |
| 806 |
< |
public Unsafe run() throws Exception { |
| 807 |
< |
return getUnsafePrivileged(); |
| 805 |
> |
(new java.security |
| 806 |
> |
.PrivilegedExceptionAction<sun.misc.Unsafe>() { |
| 807 |
> |
public sun.misc.Unsafe run() throws Exception { |
| 808 |
> |
java.lang.reflect.Field f = sun.misc |
| 809 |
> |
.Unsafe.class.getDeclaredField("theUnsafe"); |
| 810 |
> |
f.setAccessible(true); |
| 811 |
> |
return (sun.misc.Unsafe) f.get(null); |
| 812 |
|
}}); |
| 813 |
|
} catch (java.security.PrivilegedActionException e) { |
| 814 |
< |
throw e.getCause(); |
| 814 |
> |
throw new RuntimeException("Could not initialize intrinsics", |
| 815 |
> |
e.getCause()); |
| 816 |
|
} |
| 817 |
|
} |
| 818 |
|
} |
| 751 |
– |
|
| 752 |
– |
private static Unsafe getUnsafePrivileged() |
| 753 |
– |
throws NoSuchFieldException, IllegalAccessException { |
| 754 |
– |
Field f = Unsafe.class.getDeclaredField("theUnsafe"); |
| 755 |
– |
f.setAccessible(true); |
| 756 |
– |
return (Unsafe) f.get(null); |
| 757 |
– |
} |
| 758 |
– |
|
| 759 |
– |
private static long fieldOffset(String fieldName) |
| 760 |
– |
throws NoSuchFieldException { |
| 761 |
– |
return UNSAFE.objectFieldOffset |
| 762 |
– |
(ForkJoinWorkerThread.class.getDeclaredField(fieldName)); |
| 763 |
– |
} |
| 764 |
– |
|
| 765 |
– |
static final Unsafe UNSAFE; |
| 766 |
– |
static final long baseOffset; |
| 767 |
– |
static final long spOffset; |
| 768 |
– |
static final long runStateOffset; |
| 769 |
– |
static final long qBase; |
| 770 |
– |
static final int qShift; |
| 771 |
– |
static { |
| 772 |
– |
try { |
| 773 |
– |
UNSAFE = getUnsafe(); |
| 774 |
– |
baseOffset = fieldOffset("base"); |
| 775 |
– |
spOffset = fieldOffset("sp"); |
| 776 |
– |
runStateOffset = fieldOffset("runState"); |
| 777 |
– |
qBase = UNSAFE.arrayBaseOffset(ForkJoinTask[].class); |
| 778 |
– |
int s = UNSAFE.arrayIndexScale(ForkJoinTask[].class); |
| 779 |
– |
if ((s & (s-1)) != 0) |
| 780 |
– |
throw new Error("data type scale not a power of two"); |
| 781 |
– |
qShift = 31 - Integer.numberOfLeadingZeros(s); |
| 782 |
– |
} catch (Throwable e) { |
| 783 |
– |
throw new RuntimeException("Could not initialize intrinsics", e); |
| 784 |
– |
} |
| 785 |
– |
} |
| 819 |
|
} |
