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
|
/*
* Copyright 2009 - 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.opencl.util;
import com.jogamp.opencl.CLCommandQueue;
import com.jogamp.opencl.CLEventList;
import java.util.Collections;
import java.util.HashSet;
import java.util.Set;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.TimeUnit;
/**
* An utility for synchronizing multiple concurrent {@link CLCommandQueue}s.
* This Barrier can be reused after it has been broken.
* @author Michael Bien
*/
public class MultiQueueBarrier {
private CountDownLatch latch;
private final Set<CLCommandQueue> queues;
private final int count;
/**
* Creates a new MultiQueueBarrier with the given queueCount.
* It is recommented to use {@link #MultiQueueBarrier(CLCommandQueue... allowedQueues)} if possible
* which restricts the set of allowed queues for the barrier.
*/
public MultiQueueBarrier(final int queueCount) {
if(queueCount == 0) {
throw new IllegalArgumentException("queueCount was 0");
}
this.latch = new CountDownLatch(queueCount);
this.queues = null;
this.count = queueCount;
}
/**
* Creates a new MultiQueueBarrier for the given queues.
*/
public MultiQueueBarrier(final CLCommandQueue... allowedQueues) {
if(allowedQueues.length == 0) {
throw new IllegalArgumentException("allowedQueues was empty");
}
this.latch = new CountDownLatch(allowedQueues.length);
this.count = allowedQueues.length;
final HashSet<CLCommandQueue> set = new HashSet<CLCommandQueue>(allowedQueues.length);
for (final CLCommandQueue queue : allowedQueues) {
set.add(queue);
}
this.queues = Collections.unmodifiableSet(set);
}
/**
* Blocks the current Thread until all commands on the {@link CLCommandQueue} finished excecution.
* This method may be invoked concurrently without synchronization on the MultiQueueBarrier object
* as long each Thread passes a distinct CLCommandQueue as parameter to this method.
*/
public MultiQueueBarrier waitFor(final CLCommandQueue queue) {
checkQueue(queue);
queue.putBarrier();
synchronized(this) {
latch.countDown();
}
return this;
}
/**
* Blocks the current Thread until the given events on the {@link CLCommandQueue} occurred.
* This method may be invoked concurrently without synchronization on the MultiQueueBarrier object
* as long each Thread passes a distinct CLCommandQueue as parameter to this method.
*/
public MultiQueueBarrier waitFor(final CLCommandQueue queue, final CLEventList events) {
checkQueue(queue);
queue.putWaitForEvents(events, true);
synchronized(this) {
latch.countDown();
}
return this;
}
/**
* Blocks until all Threads which called {@link #waitFor}
* continue execution.
* This method blocks only once, all subsequent calls are ignored.
*/
public MultiQueueBarrier await() throws InterruptedException {
latch.await();
rebuildBarrierIfBroken();
return this;
}
/**
* @see #await()
* @param timeout the maximum time to wait
* @param unit the time unit of the {@code timeout} argument
*/
public boolean await(final long timeout, final TimeUnit unit) throws InterruptedException {
final boolean ret = latch.await(timeout, unit);
rebuildBarrierIfBroken();
return ret;
}
/**
* Resets this barrier and unblocks all waiting threads.
*/
public void resetBarrier() {
synchronized(this) {
while(latch.getCount() > 0) {
latch.countDown();
}
// thats OK. Another Thread can not rebuild the barrier since we have the lock.
// we have to rebuid it here in case there was no thread waiting.
latch = new CountDownLatch(count);
}
}
private void rebuildBarrierIfBroken() {
synchronized (this) {
if (latch.getCount() == 0) {
latch = new CountDownLatch(count);
}
}
}
/**
* Returns the current number of events which must occure before this barrier unblocks the waiting threads.
* This method is typically used for debugging and testing purposes.
*/
public long getCount() {
return latch.getCount();
}
private void checkQueue(final CLCommandQueue queue) throws IllegalArgumentException {
if (queues != null && !queues.contains(queue)) {
throw new IllegalArgumentException(queue + " is not in the allowedQueues Set: " + queues);
}
}
}
|
