util/concurrent/ForkJoinWorkerThread.java

/*
 * 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/
 */

package java.util.concurrent;

/**
 * A thread managed by a {@link ForkJoinPool}, which executes
 * {@link ForkJoinTask}s.
 * This class is subclassable solely for the sake of adding
 * functionality -- there are no overridable methods dealing with
 * scheduling or execution.  However, you can override initialization
 * and termination methods surrounding the main task processing loop.
 * If you do create such a subclass, you will also need to supply a
 * custom {@link ForkJoinPool.ForkJoinWorkerThreadFactory} to
 * {@linkplain ForkJoinPool#ForkJoinPool use it} in a {@code ForkJoinPool}.
 *
 * @since 1.7
 * @author Doug Lea
 */
public class ForkJoinWorkerThread extends Thread {
    /*
     * ForkJoinWorkerThreads are managed by ForkJoinPools and perform
     * ForkJoinTasks. For explanation, see the internal documentation
     * of class ForkJoinPool.
     *
     * This class just maintains links to its pool and WorkQueue.  The
     * pool field is set immediately upon construction, but the
     * workQueue field is not set until a call to registerWorker
     * completes. This leads to a visibility race, that is tolerated
     * by requiring that the workQueue field is only accessed by the
     * owning thread.
     */

    final ForkJoinPool pool;                // the pool this thread works in
    final ForkJoinPool.WorkQueue workQueue; // work-stealing mechanics

    /**
     * Creates a ForkJoinWorkerThread operating in the given pool.
     *
     * @param pool the pool this thread works in
     * @throws NullPointerException if pool is null
     */
    protected ForkJoinWorkerThread(ForkJoinPool pool) {
        // Use a placeholder until a useful name can be set in registerWorker
        super("aForkJoinWorkerThread");
        this.pool = pool;
        this.workQueue = pool.registerWorker(this);
    }

    /**
     * Returns the pool hosting this thread.
     *
     * @return the pool
     */
    public ForkJoinPool getPool() {
        return pool;
    }

    /**
     * Returns the unique index number of this thread in its pool.
     * The returned value ranges from zero to the maximum number of
     * threads (minus one) that may exist in the pool, and does not
     * change during the lifetime of the thread.  This method may be
     * useful for applications that track status or collect results
     * per-worker-thread rather than per-task.
     *
     * @return the index number
     */
    public int getPoolIndex() {
        return workQueue.poolIndex >>> 1; // ignore odd/even tag bit
    }

    /**
     * Initializes internal state after construction but before
     * processing any tasks. If you override this method, you must
     * invoke {@code super.onStart()} at the beginning of the method.
     * Initialization requires care: Most fields must have legal
     * default values, to ensure that attempted accesses from other
     * threads work correctly even before this thread starts
     * processing tasks.
     */
    protected void onStart() {
    }

    /**
     * Performs cleanup associated with termination of this worker
     * thread.  If you override this method, you must invoke
     * {@code super.onTermination} at the end of the overridden method.
     *
     * @param exception the exception causing this thread to abort due
     * to an unrecoverable error, or {@code null} if completed normally
     */
    protected void onTermination(Throwable exception) {
    }

    /**
     * This method is required to be public, but should never be
     * called explicitly. It performs the main run loop to execute
     * {@link ForkJoinTask}s.
     */
    public void run() {
        Throwable exception = null;
        try {
            onStart();
            pool.runWorker(workQueue);
        } catch (Throwable ex) {
            exception = ex;
        } finally {
            try {
                onTermination(exception);
            } catch (Throwable ex) {
                if (exception == null)
                    exception = ex;
            } finally {
                pool.deregisterWorker(this, exception);
            }
        }
    }
}
Revision:	1.59
Committed:	Thu May 23 01:29:19 2013 UTC (11 years ago) by jsr166
Branch:	MAIN
Changes since 1.58:	+6 -5 lines
Log Message:	improve spec for getPoolIndex
#	User	Rev	Content
1	jsr166	1.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	jsr166	1.46	* http://creativecommons.org/publicdomain/zero/1.0/
5	jsr166	1.1	*/
6
7			package java.util.concurrent;
8
9			/**
10	jsr166	1.40	* A thread managed by a {@link ForkJoinPool}, which executes
11			* {@link ForkJoinTask}s.
12			* This class is subclassable solely for the sake of adding
13			* functionality -- there are no overridable methods dealing with
14			* scheduling or execution. However, you can override initialization
15			* and termination methods surrounding the main task processing loop.
16			* If you do create such a subclass, you will also need to supply a
17	jsr166	1.57	* custom {@link ForkJoinPool.ForkJoinWorkerThreadFactory} to
18			* {@linkplain ForkJoinPool#ForkJoinPool use it} in a {@code ForkJoinPool}.
19	jsr166	1.1	*
20			* @since 1.7
21			* @author Doug Lea
22			*/
23			public class ForkJoinWorkerThread extends Thread {
24			/*
25	dl	1.14	* ForkJoinWorkerThreads are managed by ForkJoinPools and perform
26	dl	1.52	* ForkJoinTasks. For explanation, see the internal documentation
27			* of class ForkJoinPool.
28	dl	1.55	*
29			* This class just maintains links to its pool and WorkQueue. The
30	dl	1.56	* pool field is set immediately upon construction, but the
31			* workQueue field is not set until a call to registerWorker
32			* completes. This leads to a visibility race, that is tolerated
33			* by requiring that the workQueue field is only accessed by the
34			* owning thread.
35	jsr166	1.1	*/
36
37	dl	1.52	final ForkJoinPool pool; // the pool this thread works in
38	dl	1.56	final ForkJoinPool.WorkQueue workQueue; // work-stealing mechanics
39	dl	1.54
40			/**
41	jsr166	1.1	* Creates a ForkJoinWorkerThread operating in the given pool.
42			*
43			* @param pool the pool this thread works in
44			* @throws NullPointerException if pool is null
45			*/
46			protected ForkJoinWorkerThread(ForkJoinPool pool) {
47	dl	1.56	// Use a placeholder until a useful name can be set in registerWorker
48			super("aForkJoinWorkerThread");
49	dl	1.55	this.pool = pool;
50	dl	1.56	this.workQueue = pool.registerWorker(this);
51	dl	1.14	}
52
53	jsr166	1.1	/**
54			* Returns the pool hosting this thread.
55			*
56			* @return the pool
57			*/
58			public ForkJoinPool getPool() {
59			return pool;
60			}
61
62			/**
63	jsr166	1.59	* Returns the unique index number of this thread in its pool.
64			* The returned value ranges from zero to the maximum number of
65			* threads (minus one) that may exist in the pool, and does not
66			* change during the lifetime of the thread. This method may be
67			* useful for applications that track status or collect results
68			* per-worker-thread rather than per-task.
69	jsr166	1.1	*
70			* @return the index number
71			*/
72			public int getPoolIndex() {
73	dl	1.58	return workQueue.poolIndex >>> 1; // ignore odd/even tag bit
74	dl	1.45	}
75
76	jsr166	1.1	/**
77	dl	1.14	* Initializes internal state after construction but before
78			* processing any tasks. If you override this method, you must
79	jsr166	1.39	* invoke {@code super.onStart()} at the beginning of the method.
80	dl	1.14	* Initialization requires care: Most fields must have legal
81			* default values, to ensure that attempted accesses from other
82			* threads work correctly even before this thread starts
83			* processing tasks.
84	jsr166	1.1	*/
85	dl	1.14	protected void onStart() {
86			}
87	jsr166	1.1
88			/**
89	dl	1.14	* Performs cleanup associated with termination of this worker
90			* thread. If you override this method, you must invoke
91			* {@code super.onTermination} at the end of the overridden method.
92	jsr166	1.4	*
93	dl	1.14	* @param exception the exception causing this thread to abort due
94			* to an unrecoverable error, or {@code null} if completed normally
95	jsr166	1.1	*/
96	dl	1.14	protected void onTermination(Throwable exception) {
97	jsr166	1.1	}
98
99			/**
100			* This method is required to be public, but should never be
101			* called explicitly. It performs the main run loop to execute
102	jsr166	1.40	* {@link ForkJoinTask}s.
103	jsr166	1.1	*/
104			public void run() {
105			Throwable exception = null;
106			try {
107			onStart();
108	dl	1.53	pool.runWorker(workQueue);
109	jsr166	1.1	} catch (Throwable ex) {
110			exception = ex;
111			} finally {
112	dl	1.52	try {
113			onTermination(exception);
114			} catch (Throwable ex) {
115			if (exception == null)
116			exception = ex;
117			} finally {
118			pool.deregisterWorker(this, exception);
119	dl	1.45	}
120			}
121	jsr166	1.1	}
122			}