Commit | Line | Data |
---|---|---|
8c8bf09f ASL |
1 | /******************************************************************************* |
2 | * Copyright (c) 2009, 2010 Ericsson | |
3 | * | |
4 | * All rights reserved. This program and the accompanying materials are | |
5 | * made available under the terms of the Eclipse Public License v1.0 which | |
6 | * accompanies this distribution, and is available at | |
7 | * http://www.eclipse.org/legal/epl-v10.html | |
8 | * | |
9 | * Contributors: | |
10 | * Francois Chouinard - Initial API and implementation | |
11 | *******************************************************************************/ | |
12 | ||
13 | package org.eclipse.linuxtools.tmf.component; | |
14 | ||
8c8bf09f ASL |
15 | import java.util.Vector; |
16 | import java.util.concurrent.BlockingQueue; | |
17 | import java.util.concurrent.LinkedBlockingQueue; | |
9b635e61 | 18 | import java.util.concurrent.SynchronousQueue; |
8c8bf09f | 19 | |
ce785d7d | 20 | import org.eclipse.linuxtools.tmf.Tracer; |
8c8bf09f | 21 | import org.eclipse.linuxtools.tmf.event.TmfData; |
951d134a | 22 | import org.eclipse.linuxtools.tmf.request.ITmfDataRequest; |
9b635e61 | 23 | import org.eclipse.linuxtools.tmf.request.ITmfDataRequest.ExecutionType; |
951d134a | 24 | import org.eclipse.linuxtools.tmf.request.TmfCoalescedDataRequest; |
8c8bf09f ASL |
25 | import org.eclipse.linuxtools.tmf.request.TmfDataRequest; |
26 | import org.eclipse.linuxtools.tmf.request.TmfRequestExecutor; | |
27 | import org.eclipse.linuxtools.tmf.signal.TmfEndSynchSignal; | |
28 | import org.eclipse.linuxtools.tmf.signal.TmfSignalHandler; | |
29 | import org.eclipse.linuxtools.tmf.signal.TmfStartSynchSignal; | |
30 | import org.eclipse.linuxtools.tmf.trace.ITmfContext; | |
31 | ||
32 | /** | |
33 | * <b><u>TmfProvider</u></b> | |
34 | * <p> | |
35 | * The TmfProvider<T> is a provider for a data of type <T>. | |
36 | * <p> | |
12c155f5 FC |
37 | * This abstract class implements the housekeeking methods to register/ deregister the event provider and to handle |
38 | * generically the event requests. | |
8c8bf09f | 39 | * <p> |
12c155f5 FC |
40 | * The concrete class can either re-implement processRequest() entirely or just implement the hooks (initializeContext() |
41 | * and getNext()). | |
8c8bf09f ASL |
42 | * <p> |
43 | * TODO: Add support for providing multiple data types. | |
44 | */ | |
951d134a | 45 | public abstract class TmfDataProvider<T extends TmfData> extends TmfComponent implements ITmfDataProvider<T> { |
8c8bf09f | 46 | |
948b0607 FC |
47 | // ------------------------------------------------------------------------ |
48 | // Constants | |
49 | // ------------------------------------------------------------------------ | |
550d787e | 50 | |
00641a97 FC |
51 | public static final int DEFAULT_BLOCK_SIZE = 50000; |
52 | public static final int DEFAULT_QUEUE_SIZE = 1000; | |
53 | ||
948b0607 | 54 | // ------------------------------------------------------------------------ |
12c155f5 | 55 | // Attributes |
948b0607 | 56 | // ------------------------------------------------------------------------ |
8c8bf09f | 57 | |
12c155f5 FC |
58 | protected Class<T> fType; |
59 | protected boolean fLogData; | |
60 | protected boolean fLogError; | |
f6b14ce2 | 61 | |
00641a97 | 62 | protected int fQueueSize = DEFAULT_QUEUE_SIZE; |
12c155f5 FC |
63 | protected BlockingQueue<T> fDataQueue; |
64 | protected TmfRequestExecutor fExecutor; | |
948b0607 FC |
65 | |
66 | private int fSignalDepth = 0; | |
045df77d | 67 | private final Object fLock = new Object(); |
951d134a | 68 | |
c1c69938 FC |
69 | private int fRequestPendingCounter = 0; |
70 | ||
948b0607 FC |
71 | // ------------------------------------------------------------------------ |
72 | // Constructors | |
73 | // ------------------------------------------------------------------------ | |
74 | ||
12c155f5 | 75 | public TmfDataProvider() { |
00641a97 | 76 | super(); |
12c155f5 FC |
77 | fQueueSize = DEFAULT_QUEUE_SIZE; |
78 | fDataQueue = new LinkedBlockingQueue<T>(fQueueSize); | |
79 | fExecutor = new TmfRequestExecutor(); | |
80 | } | |
81 | ||
82 | public void init(String name, Class<T> dataType) { | |
83 | super.init(name); | |
84 | fType = dataType; | |
12c155f5 FC |
85 | fDataQueue = (fQueueSize > 1) ? new LinkedBlockingQueue<T>(fQueueSize) : new SynchronousQueue<T>(); |
86 | ||
87 | fExecutor = new TmfRequestExecutor(); | |
88 | fSignalDepth = 0; | |
89 | ||
90 | fLogData = Tracer.isEventTraced(); | |
91 | fLogError = Tracer.isErrorTraced(); | |
92 | ||
93 | TmfProviderManager.register(fType, this); | |
94 | } | |
95 | ||
948b0607 | 96 | protected TmfDataProvider(String name, Class<T> type, int queueSize) { |
00641a97 | 97 | this(); |
948b0607 | 98 | fQueueSize = queueSize; |
00641a97 | 99 | init(name, type); |
948b0607 FC |
100 | } |
101 | ||
102 | public TmfDataProvider(TmfDataProvider<T> other) { | |
00641a97 FC |
103 | this(); |
104 | init(other.getName(), other.fType); | |
105 | } | |
550d787e | 106 | |
00641a97 FC |
107 | public TmfDataProvider(String name, Class<T> type) { |
108 | this(name, type, DEFAULT_QUEUE_SIZE); | |
948b0607 FC |
109 | } |
110 | ||
111 | @Override | |
112 | public void dispose() { | |
113 | TmfProviderManager.deregister(fType, this); | |
114 | fExecutor.stop(); | |
115 | super.dispose(); | |
12c155f5 | 116 | // if (Tracer.isComponentTraced()) Tracer.traceComponent(this, "stopped"); |
948b0607 FC |
117 | } |
118 | ||
00641a97 FC |
119 | // ------------------------------------------------------------------------ |
120 | // Accessors | |
121 | // ------------------------------------------------------------------------ | |
122 | ||
948b0607 FC |
123 | public int getQueueSize() { |
124 | return fQueueSize; | |
125 | } | |
126 | ||
127 | public Class<?> getType() { | |
128 | return fType; | |
129 | } | |
130 | ||
131 | // ------------------------------------------------------------------------ | |
132 | // ITmfRequestHandler | |
133 | // ------------------------------------------------------------------------ | |
134 | ||
135 | @Override | |
136 | public void sendRequest(final ITmfDataRequest<T> request) { | |
137 | synchronized (fLock) { | |
138 | if (fSignalDepth > 0) { | |
139 | coalesceDataRequest(request); | |
140 | } else { | |
141 | dispatchRequest(request); | |
142 | } | |
143 | } | |
144 | } | |
145 | ||
146 | /** | |
147 | * This method queues the coalesced requests. | |
148 | * | |
149 | * @param thread | |
150 | */ | |
151 | @Override | |
c1c69938 | 152 | public void fireRequest() { |
948b0607 FC |
153 | synchronized (fLock) { |
154 | if (fRequestPendingCounter > 0) { | |
155 | return; | |
156 | } | |
157 | if (fPendingCoalescedRequests.size() > 0) { | |
158 | for (TmfDataRequest<T> request : fPendingCoalescedRequests) { | |
159 | dispatchRequest(request); | |
160 | } | |
161 | fPendingCoalescedRequests.clear(); | |
162 | } | |
163 | } | |
164 | } | |
165 | ||
166 | /** | |
12c155f5 FC |
167 | * Increments/decrements the pending requests counters and fires the request if necessary (counter == 0). Used for |
168 | * coalescing requests accross multiple TmfDataProvider. | |
948b0607 FC |
169 | * |
170 | * @param isIncrement | |
171 | */ | |
c1c69938 FC |
172 | @Override |
173 | public void notifyPendingRequest(boolean isIncrement) { | |
948b0607 | 174 | synchronized (fLock) { |
c1c69938 FC |
175 | if (isIncrement) { |
176 | if (fSignalDepth > 0) { | |
177 | fRequestPendingCounter++; | |
178 | } | |
179 | } else { | |
180 | if (fRequestPendingCounter > 0) { | |
181 | fRequestPendingCounter--; | |
182 | } | |
948b0607 | 183 | |
c1c69938 FC |
184 | // fire request if all pending requests are received |
185 | if (fRequestPendingCounter == 0) { | |
186 | fireRequest(); | |
187 | } | |
188 | } | |
189 | } | |
948b0607 FC |
190 | } |
191 | ||
192 | // ------------------------------------------------------------------------ | |
193 | // Coalescing (primitive test...) | |
194 | // ------------------------------------------------------------------------ | |
195 | ||
196 | protected Vector<TmfCoalescedDataRequest<T>> fPendingCoalescedRequests = new Vector<TmfCoalescedDataRequest<T>>(); | |
197 | ||
198 | protected void newCoalescedDataRequest(ITmfDataRequest<T> request) { | |
199 | synchronized (fLock) { | |
12c155f5 FC |
200 | TmfCoalescedDataRequest<T> coalescedRequest = new TmfCoalescedDataRequest<T>(fType, request.getIndex(), |
201 | request.getNbRequested(), request.getBlockSize(), request.getExecType()); | |
948b0607 FC |
202 | coalescedRequest.addRequest(request); |
203 | if (Tracer.isRequestTraced()) { | |
204 | Tracer.traceRequest(request, "coalesced with " + coalescedRequest.getRequestId()); //$NON-NLS-1$ | |
205 | } | |
206 | fPendingCoalescedRequests.add(coalescedRequest); | |
207 | } | |
208 | } | |
209 | ||
210 | protected void coalesceDataRequest(ITmfDataRequest<T> request) { | |
211 | synchronized (fLock) { | |
212 | for (TmfCoalescedDataRequest<T> coalescedRequest : fPendingCoalescedRequests) { | |
213 | if (coalescedRequest.isCompatible(request)) { | |
214 | coalescedRequest.addRequest(request); | |
215 | if (Tracer.isRequestTraced()) { | |
216 | Tracer.traceRequest(request, "coalesced with " + coalescedRequest.getRequestId()); //$NON-NLS-1$ | |
217 | } | |
218 | return; | |
219 | } | |
220 | } | |
221 | newCoalescedDataRequest(request); | |
222 | } | |
223 | } | |
224 | ||
225 | // ------------------------------------------------------------------------ | |
226 | // Request processing | |
227 | // ------------------------------------------------------------------------ | |
228 | ||
229 | private void dispatchRequest(final ITmfDataRequest<T> request) { | |
230 | if (request.getExecType() == ExecutionType.FOREGROUND) | |
231 | queueRequest(request); | |
232 | else | |
233 | queueBackgroundRequest(request, request.getBlockSize(), true); | |
234 | } | |
235 | ||
236 | protected void queueRequest(final ITmfDataRequest<T> request) { | |
237 | ||
238 | if (fExecutor.isShutdown()) { | |
239 | request.cancel(); | |
240 | return; | |
241 | } | |
242 | ||
243 | final TmfDataProvider<T> provider = this; | |
244 | ||
245 | // Process the request | |
246 | TmfThread thread = new TmfThread(request.getExecType()) { | |
247 | ||
248 | @Override | |
249 | public void run() { | |
250 | ||
251 | if (Tracer.isRequestTraced()) | |
252 | Tracer.trace("Request #" + request.getRequestId() + " is being serviced by " + provider.getName()); //$NON-NLS-1$//$NON-NLS-2$ | |
253 | ||
254 | // Extract the generic information | |
255 | request.start(); | |
256 | int nbRequested = request.getNbRequested(); | |
257 | int nbRead = 0; | |
258 | ||
259 | // Initialize the execution | |
260 | ITmfContext context = armRequest(request); | |
261 | if (context == null) { | |
262 | request.cancel(); | |
263 | return; | |
264 | } | |
265 | ||
266 | try { | |
267 | // Get the ordered events | |
268 | T data = getNext(context); | |
269 | if (Tracer.isRequestTraced()) | |
270 | Tracer.trace("Request #" + request.getRequestId() + " read first event"); //$NON-NLS-1$ //$NON-NLS-2$ | |
271 | while (data != null && !isCompleted(request, data, nbRead)) { | |
272 | if (fLogData) | |
273 | Tracer.traceEvent(provider, request, data); | |
274 | request.handleData(data); | |
275 | ||
276 | // To avoid an unnecessary read passed the last data | |
277 | // requested | |
278 | if (++nbRead < nbRequested) { | |
279 | data = getNext(context); | |
280 | } | |
281 | } | |
282 | if (Tracer.isRequestTraced()) | |
283 | Tracer.trace("Request #" + request.getRequestId() + " finished"); //$NON-NLS-1$//$NON-NLS-2$ | |
284 | ||
285 | if (request.isCancelled()) { | |
286 | request.cancel(); | |
287 | } else { | |
288 | request.done(); | |
289 | } | |
290 | } catch (Exception e) { | |
291 | request.fail(); | |
292 | } | |
293 | ||
294 | // Cleanup | |
295 | context.dispose(); | |
296 | } | |
297 | }; | |
298 | ||
299 | if (Tracer.isRequestTraced()) | |
300 | Tracer.traceRequest(request, "queued"); //$NON-NLS-1$ | |
301 | fExecutor.execute(thread); | |
302 | ||
303 | } | |
304 | ||
305 | protected void queueBackgroundRequest(final ITmfDataRequest<T> request, final int blockSize, final boolean indexing) { | |
306 | ||
307 | Thread thread = new Thread() { | |
308 | @Override | |
309 | public void run() { | |
310 | request.start(); | |
311 | ||
312 | final Integer[] CHUNK_SIZE = new Integer[1]; | |
313 | CHUNK_SIZE[0] = Math.min(request.getNbRequested(), blockSize + ((indexing) ? 1 : 0)); | |
314 | ||
315 | final Integer[] nbRead = new Integer[1]; | |
316 | nbRead[0] = 0; | |
317 | ||
318 | final Boolean[] isFinished = new Boolean[1]; | |
319 | isFinished[0] = Boolean.FALSE; | |
320 | ||
321 | while (!isFinished[0]) { | |
322 | ||
12c155f5 FC |
323 | TmfDataRequest<T> subRequest = new TmfDataRequest<T>(request.getDataType(), request.getIndex() |
324 | + nbRead[0], CHUNK_SIZE[0], blockSize, ExecutionType.BACKGROUND) { | |
948b0607 FC |
325 | @Override |
326 | public void handleData(T data) { | |
327 | super.handleData(data); | |
328 | request.handleData(data); | |
329 | if (getNbRead() > CHUNK_SIZE[0]) { | |
330 | System.out.println("ERROR - Read too many events"); //$NON-NLS-1$ | |
331 | } | |
332 | } | |
333 | ||
334 | @Override | |
335 | public void handleCompleted() { | |
336 | nbRead[0] += getNbRead(); | |
337 | if (nbRead[0] >= request.getNbRequested() || (getNbRead() < CHUNK_SIZE[0])) { | |
90de83da | 338 | if (this.isCancelled()) { |
948b0607 | 339 | request.cancel(); |
90de83da | 340 | } else if (this.isFailed()) { |
12c155f5 | 341 | request.fail(); |
948b0607 FC |
342 | } else { |
343 | request.done(); | |
344 | } | |
345 | isFinished[0] = Boolean.TRUE; | |
346 | } | |
347 | super.handleCompleted(); | |
348 | } | |
349 | }; | |
350 | ||
351 | if (!isFinished[0]) { | |
352 | queueRequest(subRequest); | |
353 | ||
354 | try { | |
355 | subRequest.waitForCompletion(); | |
356 | } catch (InterruptedException e) { | |
357 | e.printStackTrace(); | |
358 | } | |
359 | ||
360 | CHUNK_SIZE[0] = Math.min(request.getNbRequested() - nbRead[0], blockSize); | |
361 | } | |
362 | } | |
363 | } | |
364 | }; | |
365 | ||
366 | thread.start(); | |
367 | } | |
368 | ||
369 | /** | |
12c155f5 | 370 | * Initialize the provider based on the request. The context is provider specific and will be updated by getNext(). |
948b0607 FC |
371 | * |
372 | * @param request | |
12c155f5 | 373 | * @return an application specific context; null if request can't be serviced |
948b0607 FC |
374 | */ |
375 | public abstract ITmfContext armRequest(ITmfDataRequest<T> request); | |
376 | ||
377 | public abstract T getNext(ITmfContext context); | |
378 | ||
379 | /** | |
380 | * Checks if the data meets the request completion criteria. | |
381 | * | |
382 | * @param request | |
383 | * @param data | |
384 | * @return | |
385 | */ | |
386 | public boolean isCompleted(ITmfDataRequest<T> request, T data, int nbRead) { | |
387 | return request.isCompleted() || nbRead >= request.getNbRequested() || data.isNullRef(); | |
388 | } | |
389 | ||
390 | // ------------------------------------------------------------------------ | |
391 | // Signal handlers | |
392 | // ------------------------------------------------------------------------ | |
393 | ||
394 | @TmfSignalHandler | |
395 | public void startSynch(TmfStartSynchSignal signal) { | |
396 | synchronized (fLock) { | |
397 | fSignalDepth++; | |
398 | } | |
399 | } | |
400 | ||
401 | @TmfSignalHandler | |
402 | public void endSynch(TmfEndSynchSignal signal) { | |
045df77d | 403 | synchronized (fLock) { |
948b0607 FC |
404 | fSignalDepth--; |
405 | if (fSignalDepth == 0) { | |
406 | fireRequest(); | |
407 | } | |
045df77d | 408 | } |
948b0607 | 409 | } |
8c8bf09f ASL |
410 | |
411 | } |