forked from eclipse-ee4j/glassfish-concurro
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ManagedThreadFactoryImpl.java
395 lines (347 loc) · 13.3 KB
/
ManagedThreadFactoryImpl.java
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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
/*
* Copyright (c) 2023, 2024 Contributors to the Eclipse Foundation.
* Copyright (c) 2010, 2018 Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2022, 2024 Payara Foundation and/or its affiliates.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package org.glassfish.concurro;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;
import java.util.List;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.concurrent.locks.Lock;
import java.util.concurrent.locks.ReentrantLock;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.glassfish.concurro.internal.ManagedFutureTask;
import org.glassfish.concurro.internal.ThreadExpiredException;
import org.glassfish.concurro.spi.ContextHandle;
import org.glassfish.concurro.spi.ContextSetupProvider;
import jakarta.enterprise.concurrent.ManagedThreadFactory;
import java.util.concurrent.ForkJoinPool;
import java.util.concurrent.ForkJoinWorkerThread;
/**
* Implementation of ManagedThreadFactory interface.
*/
public class ManagedThreadFactoryImpl implements ManagedThreadFactory {
private List<Thread> threads;
private boolean stopped = false;
private Lock lock; // protects threads and stopped
private String name;
final private ContextSetupProvider contextSetupProvider;
// A non-null ContextService should be provided if thread context should
// be setup before running the Runnable passed in through the newThread
// method.
// Context service could be null if the ManagedThreadFactoryImpl is
// used for creating threads for ManagedExecutorService, where it is
// not necessary to set up thread context at thread creation time. In that
// case, thread context is set up before running each task.
final private ContextServiceImpl contextService;
// If there is a need to save context earlier than during newThread() (e.g. jndi lookup ManagedThreadFactory),
// it is kept in savedContextHandleForSetup.
protected ContextHandle savedContextHandleForSetup = null;
private int priority;
private long hungTaskThreshold = 0L; // in milliseconds
private AtomicInteger threadIdSequence = new AtomicInteger();
public static final String MANAGED_THREAD_FACTORY_STOPPED = "ManagedThreadFactory is stopped";
public ManagedThreadFactoryImpl(String name) {
this(name, null, Thread.NORM_PRIORITY);
}
public ManagedThreadFactoryImpl(String name, ContextServiceImpl contextService) {
this(name, contextService, Thread.NORM_PRIORITY);
}
public ManagedThreadFactoryImpl(String name,
ContextServiceImpl contextService,
int priority) {
this.name = name;
this.contextService = contextService;
this.contextSetupProvider = contextService != null? contextService.getContextSetupProvider(): null;
this.priority = priority;
threads = new ArrayList<>();
lock = new ReentrantLock();
}
public String getName() {
return name;
}
public long getHungTaskThreshold() {
return hungTaskThreshold;
}
public void setHungTaskThreshold(long hungTaskThreshold) {
this.hungTaskThreshold = hungTaskThreshold;
}
@Override
public Thread newThread(Runnable r) {
lock.lock();
try {
if (stopped) {
// Do not create new thread and throw IllegalStateException if stopped
throw new IllegalStateException(MANAGED_THREAD_FACTORY_STOPPED);
}
ContextHandle contextHandleForSetup = null;
if (savedContextHandleForSetup != null) {
contextHandleForSetup = savedContextHandleForSetup;
} else if (contextSetupProvider != null) {
contextHandleForSetup = contextSetupProvider.saveContext(contextService);
}
Thread newThread = createThread(r, contextHandleForSetup);
newThread.setDaemon(true);
threads.add(newThread);
return newThread;
}
finally {
lock.unlock();
}
}
protected Thread createThread(final Runnable runnable, final ContextHandle contextHandleForSetup) {
return createThreadInternal(runnable, contextHandleForSetup);
}
private Thread createThreadInternal(final Runnable r, final ContextHandle contextHandleForSetup) {
ManagedThread newThread = new ManagedThread(r, contextHandleForSetup);
newThread.setPriority(priority);
return newThread;
}
protected ForkJoinWorkerThread createWorkerThread(final ForkJoinPool forkJoinPool, final ContextHandle contextHandleForSetup) {
return createWorkerThreadInternal(forkJoinPool, contextHandleForSetup);
}
private WorkerThread createWorkerThreadInternal(final ForkJoinPool forkJoinPool, final ContextHandle contextHandleForSetup) {
WorkerThread newThread = new WorkerThread(forkJoinPool, contextHandleForSetup);
newThread.setPriority(priority);
return newThread;
}
protected void removeThread(Thread t) {
lock.lock();
try {
threads.remove(t);
}
finally {
lock.unlock();
}
}
/**
* Return an array of threads in this ManagedThreadFactoryImpl
* @return an array of threads in this ManagedThreadFactoryImpl.
* It returns null if there is no thread.
*/
protected Collection<Thread> getThreads() {
Collection<Thread> result = null;
lock.lock();
try {
if (!threads.isEmpty()) {
result = new ArrayList<>(threads);
}
}
finally {
lock.unlock();
}
return result;
}
public void taskStarting(Thread t, ManagedFutureTask task) {
if (t instanceof ThreadWithTiming mt) {
// called in thread t, so no need to worry about synchronization
mt.notifyTaskStarting(task);
}
}
public void taskDone(Thread t) {
if (t instanceof ThreadWithTiming mt) {
// called in thread t, so no need to worry about synchronization
mt.notifyTaskDone();
}
}
/**
* Stop the ManagedThreadFactory instance. This should be used by the
* component that creates the ManagedThreadFactory when the component is
* stopped. All threads that this ManagedThreadFactory has created using
* the #newThread() method are interrupted.
*/
public void stop() {
lock.lock();
try {
stopped = true;
// interrupt all the threads created by this factory
Iterator<Thread> iter = threads.iterator();
while(iter.hasNext()) {
Thread t = iter.next();
try {
shutdown(t);
t.interrupt();
} catch (SecurityException ignore) {
}
}
}
finally {
lock.unlock();
}
}
/**
* Make contextSetupProvider available for extending classes if necessary to implement context saving in other
* moments than this implemention expects.
*
* @return contextSetupProvider
*/
protected ContextSetupProvider getContextSetupProvider() {
return contextSetupProvider;
}
@Override
public ForkJoinWorkerThread newThread(ForkJoinPool pool) {
lock.lock();
try {
if(stopped) {
// Do not create new ForkJoinWorkerThread and throw IllegalStateException if stopped
throw new IllegalStateException(MANAGED_THREAD_FACTORY_STOPPED);
}
ContextHandle contextHandleForSetup = null;
if (savedContextHandleForSetup != null) {
contextHandleForSetup = savedContextHandleForSetup;
} else if (contextSetupProvider != null) {
contextHandleForSetup = contextSetupProvider.saveContext(contextService);
}
ForkJoinWorkerThread newThread = createWorkerThread(pool, contextHandleForSetup);
threads.add(newThread);
return newThread;
} finally {
lock.unlock();
}
}
protected void shutdown(Thread t) {
if (t instanceof AbstractManagedThread mt) {
mt.shutdown(); // mark threads as shutting down
}
}
/**
* Thread aware of starting time and knowing, if it is hung.
*/
public interface ThreadWithTiming {
public void notifyTaskDone();
public void notifyTaskStarting(ManagedFutureTask task);
boolean isTaskHung(long now);
}
class WorkerThread extends ForkJoinWorkerThread implements ThreadWithTiming {
public static final long NOT_STARTED = -1;
volatile long taskStartTime = NOT_STARTED;
final ContextHandle contextHandleForSetup;
public WorkerThread(ForkJoinPool pool, ContextHandle contextHandleForSetup) {
super(pool);
this.contextHandleForSetup = contextHandleForSetup;
}
@Override
protected void onTermination(Throwable exception) {
super.onTermination(exception);
}
@Override
public void run() {
try {
if (contextHandleForSetup != null) {
contextSetupProvider.setup(contextHandleForSetup);
}
super.run();
} catch (ThreadExpiredException ex) {
Logger.getLogger("org.glassfish.concurro").log(Level.INFO, ex.toString());
} catch (Throwable t) {
Logger.getLogger("org.glassfish.concurro").log(Level.SEVERE, name, t);
}
}
@Override
public boolean isTaskHung(long now) {
return taskStartTime != NOT_STARTED && now - taskStartTime > hungTaskThreshold;
}
@Override
public void notifyTaskDone() {
taskStartTime = NOT_STARTED;
}
@Override
public void notifyTaskStarting(ManagedFutureTask task) {
taskStartTime = System.currentTimeMillis();
}
}
/**
* ManageableThread to be returned by {@code ManagedThreadFactory.newThread()}
*/
public class ManagedThread extends AbstractManagedThread implements ThreadWithTiming {
final ContextHandle contextHandleForSetup;
volatile ManagedFutureTask task = null;
volatile long taskStartTime = 0L;
public ManagedThread(Runnable target, ContextHandle contextHandleForSetup) {
super(target);
setName(name + "-Thread-" + threadIdSequence.incrementAndGet());
this.contextHandleForSetup = contextHandleForSetup;
}
@Override
public void run() {
ContextHandle handle = null;
try {
if (contextHandleForSetup != null) {
handle = contextSetupProvider.setup(contextHandleForSetup);
}
if (shutdown) {
// start thread in interrupted state if already marked for shutdown
this.interrupt();
}
super.run();
} catch (ThreadExpiredException ex) {
Logger.getLogger("org.glassfish.concurro").log(Level.INFO, ex.toString());
} catch (Throwable t) {
Logger.getLogger("org.glassfish.concurro").log(Level.SEVERE, name, t);
} finally {
if (handle != null) {
contextSetupProvider.reset(handle);
}
removeThread(this);
}
}
@Override
boolean cancelTask() {
if (task != null) {
return task.cancel(true);
}
return false;
}
@Override
public String getTaskIdentityName() {
if (task != null) {
return task.getTaskIdentityName();
}
return "null";
}
@Override
public long getTaskRunTime(long now) {
if (task != null && taskStartTime > 0) {
long taskRunTime = now - taskStartTime;
return taskRunTime > 0 ? taskRunTime : 0;
}
return 0;
}
@Override
public long getThreadStartTime() {
return threadStartTime;
}
@Override
public boolean isTaskHung(long now) {
if (hungTaskThreshold > 0) {
return getTaskRunTime(now) - hungTaskThreshold > 0;
}
return false;
}
@Override
public void notifyTaskDone() {
taskStartTime = 0L;
task = null;
}
@Override
public void notifyTaskStarting(ManagedFutureTask task) {
taskStartTime = System.currentTimeMillis();
this.task = task;
}
}
}