1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
|
/**
* Copyright 2010 JogAmp Community. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are
* permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this list of
* conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice, this list
* of conditions and the following disclaimer in the documentation and/or other materials
* provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY JogAmp Community ``AS IS'' AND ANY EXPRESS OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
* FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JogAmp Community OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* The views and conclusions contained in the software and documentation are those of the
* authors and should not be interpreted as representing official policies, either expressed
* or implied, of JogAmp Community.
*/
package com.jogamp.common.util;
import java.io.PrintStream;
import jogamp.common.Debug;
/**
* Helper class to provide a Runnable queue implementation with a Runnable wrapper
* which notifies after execution for the <code>invokeAndWait()</code> semantics.
*/
public abstract class TaskBase implements Runnable {
/** Enable via the property <code>jogamp.debug.TaskBase.TraceSource</code> */
private static final boolean TRACE_SOURCE;
static {
Debug.initSingleton();
TRACE_SOURCE = PropertyAccess.isPropertyDefined("jogamp.debug.TaskBase.TraceSource", true);
}
protected final Object syncObject;
protected final boolean catchExceptions;
protected final PrintStream exceptionOut;
protected final Throwable sourceStack;
protected Object attachment;
protected Throwable runnableException;
protected long tCreated, tStarted;
protected volatile long tExecuted;
protected volatile boolean isExecuted;
protected volatile boolean isFlushed;
protected volatile Thread execThread;
protected TaskBase(final Object syncObject, final boolean catchExceptions, final PrintStream exceptionOut) {
this.syncObject = syncObject;
this.catchExceptions = catchExceptions;
this.exceptionOut = exceptionOut;
this.sourceStack = TRACE_SOURCE ? new Throwable("Creation @") : null;
tCreated = System.currentTimeMillis();
tStarted = 0;
tExecuted = 0;
isExecuted = false;
isFlushed = false;
execThread = null;
}
protected final String getExceptionOutIntro() {
return catchExceptions ? "A caught" : "An uncaught";
}
protected final void printSourceTrace() {
if( null != sourceStack && null != exceptionOut ) {
sourceStack.printStackTrace(exceptionOut);
}
}
/** Returns the execution thread or {@code null} if not yet {@link #run()}. */
public final Thread getExecutionThread() {
return execThread;
}
/**
* Return the synchronization object if any.
* @see #RunnableTask(Runnable, Object, boolean)
*/
public final Object getSyncObject() {
return syncObject;
}
/**
* Attach a custom object to this task.
* Useful to piggybag further information, ie tag a task final.
*/
public final void setAttachment(final Object o) {
attachment = o;
}
/**
* Return the attachment object if any.
* @see #setAttachment(Object)
*/
public final Object getAttachment() {
return attachment;
}
@Override
public abstract void run();
/**
* Simply flush this task and notify a waiting executor.
* The executor which might have been blocked until notified
* will be unblocked and the task removed from the queue.
*
* @param t optional Throwable to be assigned for later {@link #getThrowable()} query in case of an error.
*
* @see #isFlushed()
* @see #isInQueue()
*/
public final void flush(final Throwable t) {
if(!isExecuted() && hasWaiter()) {
runnableException = t;
synchronized (syncObject) {
isFlushed = true;
syncObject.notifyAll();
}
}
}
/**
* @return !{@link #isExecuted()} && !{@link #isFlushed()}
*/
public final boolean isInQueue() { return !isExecuted() && !isFlushed(); }
/**
* @return True if executed, otherwise false;
*/
public final boolean isExecuted() { return isExecuted; }
/**
* @return True if flushed, otherwise false;
*/
public final boolean isFlushed() { return isFlushed; }
/**
* @return True if invoking thread waits until done,
* ie a <code>notifyObject</code> was passed, otherwise false;
*/
public final boolean hasWaiter() { return null != syncObject; }
/**
* @return A thrown exception while execution of the user action, if any and if caught
* @see #RunnableTask(Runnable, Object, boolean)
*/
public final Throwable getThrowable() { return runnableException; }
public final long getTimestampCreate() { return tCreated; }
public final long getTimestampBeforeExec() { return tStarted; }
public final long getTimestampAfterExec() { return tExecuted; }
public final long getDurationInQueue() { return tStarted - tCreated; }
public final long getDurationInExec() { return 0 < tExecuted ? tExecuted - tStarted : 0; }
public final long getDurationTotal() { return 0 < tExecuted ? tExecuted - tCreated : tStarted - tCreated; }
@Override
public String toString() {
return "RunnableTask[enqueued "+isInQueue()+"[executed "+isExecuted()+", flushed "+isFlushed()+"], tTotal "+getDurationTotal()+" ms, tExec "+getDurationInExec()+" ms, tQueue "+getDurationInQueue()+" ms, attachment "+attachment+", throwable "+getThrowable()+"]";
}
}
|
