May 31
[deliverable/tracecompass.git] / org.eclipse.linuxtools.lttng.ui / src / org / eclipse / linuxtools / lttng / ui / views / common / AbsTimeUpdateView.java
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 * Alvaro Sanchez-Leon (alvsan09@gmail.com) - Initial API and implementation
11 *******************************************************************************/
12 package org.eclipse.linuxtools.lttng.ui.views.common;
13
14 import java.util.Arrays;
15
16 import org.eclipse.linuxtools.lttng.control.LttngCoreProviderFactory;
17 import org.eclipse.linuxtools.lttng.control.LttngSyntheticEventProvider;
18 import org.eclipse.linuxtools.lttng.event.LttngSyntheticEvent;
19 import org.eclipse.linuxtools.lttng.event.LttngSyntheticEvent.SequenceInd;
20 import org.eclipse.linuxtools.lttng.event.LttngTimestamp;
21 import org.eclipse.linuxtools.lttng.request.ILttngSyntEventRequest;
22 import org.eclipse.linuxtools.lttng.request.IRequestStatusListener;
23 import org.eclipse.linuxtools.lttng.request.LttngSyntEventRequest;
24 import org.eclipse.linuxtools.lttng.request.RequestCompletedSignal;
25 import org.eclipse.linuxtools.lttng.request.RequestStartedSignal;
26 import org.eclipse.linuxtools.lttng.state.evProcessor.ITransEventProcessor;
27 import org.eclipse.linuxtools.lttng.ui.TraceDebug;
28 import org.eclipse.linuxtools.lttng.ui.model.trange.ItemContainer;
29 import org.eclipse.linuxtools.lttng.ui.views.resources.model.ResourceModelFactory;
30 import org.eclipse.linuxtools.tmf.event.TmfEvent;
31 import org.eclipse.linuxtools.tmf.event.TmfTimeRange;
32 import org.eclipse.linuxtools.tmf.event.TmfTimestamp;
33 import org.eclipse.linuxtools.tmf.experiment.TmfExperiment;
34 import org.eclipse.linuxtools.tmf.request.TmfDataRequest;
35 import org.eclipse.linuxtools.tmf.signal.TmfRangeSynchSignal;
36 import org.eclipse.linuxtools.tmf.signal.TmfSignalHandler;
37 import org.eclipse.linuxtools.tmf.signal.TmfSignalManager;
38 import org.eclipse.linuxtools.tmf.signal.TmfTimeSynchSignal;
39 import org.eclipse.linuxtools.tmf.ui.viewers.timeAnalysis.ITimeAnalysisViewer;
40 import org.eclipse.linuxtools.tmf.ui.viewers.timeAnalysis.TmfTimeScaleSelectionEvent;
41 import org.eclipse.linuxtools.tmf.ui.viewers.timeAnalysis.TmfTimeSelectionEvent;
42 import org.eclipse.linuxtools.tmf.ui.viewers.timeAnalysis.model.ITmfTimeAnalysisEntry;
43 import org.eclipse.linuxtools.tmf.ui.views.TmfView;
44 import org.eclipse.swt.widgets.Display;
45
46 /**
47 * <p>
48 * Abstract class used as a base for views handling specific time range data
49 * requests
50 * </p>
51 * <p>
52 * The class handles a single element queue of data requests, i.e. request can
53 * be triggered from different sources e.g. opening a file as well as a new
54 * selected time window
55 * </p>
56 *
57 * @author alvaro
58 *
59 */
60 public abstract class AbsTimeUpdateView extends TmfView implements
61 IRequestStatusListener {
62
63 // ========================================================================
64 // Data
65 // ========================================================================
66 /**
67 * One second in nanoseconds
68 */
69 private static final long INITIAL_WINDOW_OFFSET = 1000000000L; /*
70 * 1 sec //
71 * in ns //
72 */
73 // private static final long INITIAL_WINDOW_OFFSET = 100000000L; /* 100 ms
74 // in ns */
75 /**
76 * Number of events before a GUI refresh
77 */
78 private static final Long INPUT_CHANGED_REFRESH = 3000L;
79 private static final long DEFAULT_OFFSET = 0L;
80 private static final int DEFAULT_CHUNK = 1;
81
82 protected boolean synch = true; // time synchronisation, used to be an
83 // option
84 protected ITimeAnalysisViewer tsfviewer = null;
85
86 // ========================================================================
87 // Constructor
88 // ========================================================================
89 public AbsTimeUpdateView(String viewID) {
90 super(viewID);
91 // freqState = UiCommonFactory.getQueue(this);
92 }
93
94 // ========================================================================
95 // Methods
96 // ========================================================================
97 /*
98 * (non-Javadoc)
99 *
100 * @seeorg.eclipse.linuxtools.lttng.state.IStateDataRequestListener#
101 * processingStarted(org.eclipse.linuxtools.lttng.state.StateDataRequest)
102 */
103 @TmfSignalHandler
104 public synchronized void processingStarted(RequestStartedSignal signal) {
105 LttngSyntEventRequest request = signal.getRequest();
106 if (request != null) {
107 // update queue with the id of the current request.
108 // freqState.requestStarted(request);
109
110 // if there was no new request then this one is still on
111 // prepare for the reception of new data
112 waitCursor(true);
113
114 // no new time range for zoom orders
115 TmfTimeRange trange = null;
116 // Time Range will be used to filter out events which are
117 // not visible in one pixel
118 trange = request.getRange();
119
120 // indicate if the data model needs to be cleared e.g. a new
121 // experiment is being selected
122 boolean clearData = request.isclearDataInd();
123 // Indicate if current data needs to be cleared and if so
124 // specify the new experiment time range that applies
125 ModelUpdatePrep(trange, clearData);
126 }
127 }
128
129 /*
130 * (non-Javadoc)
131 *
132 * @seeorg.eclipse.linuxtools.lttng.state.IStateDataRequestListener#
133 * processingCompleted(org.eclipse.linuxtools.lttng.state.StateDataRequest)
134 */
135 @TmfSignalHandler
136 public void processingCompleted(RequestCompletedSignal signal) {
137 ILttngSyntEventRequest request = signal.getRequest();
138
139 if (request == null) {
140 return;
141 }
142
143 // Update wait cursor
144 waitCursor(false);
145
146 // No data refresh actions for cancelled requests.
147 if (request.isCancelled() || request.isFailed()) {
148 if (TraceDebug.isDEBUG()) {
149 TmfTimeRange trange = request.getRange();
150 if (request.isCancelled()) {
151 TraceDebug.debug("Request cancelled "
152 + trange.getStartTime() + "-" + trange.getEndTime()
153 + " Handled Events: " + request.getSynEventCount()
154 + " " + request.toString(), 15);
155 } else if (request.isFailed()) {
156 TraceDebug.debug("Request Failed " + trange.getStartTime()
157 + "-" + trange.getEndTime() + " Handled Events: "
158 + request.getSynEventCount() + " "
159 + request.toString());
160 }
161 }
162
163 return;
164 } else {
165 modelInputChanged(request, true);
166 }
167 }
168
169 /**
170 * Registers as listener of time selection from other views
171 *
172 * @param signal
173 */
174 public void synchToTime(TmfTimeSynchSignal signal) {
175 if (synch) {
176 Object source = signal.getSource();
177 if (signal != null && source != null && source != this) {
178 // Internal value is expected in nano seconds.
179 long selectedTime = signal.getCurrentTime().getValue();
180 if (tsfviewer != null) {
181 tsfviewer.setSelectedTime(selectedTime, true, source);
182 }
183 }
184 }
185 }
186
187 /**
188 * Process the reception of time window adjustment in this view if the
189 * source of the update is not this view.
190 *
191 * @param signal
192 * @param clearingData
193 */
194 public void synchToTimeRange(TmfRangeSynchSignal signal, boolean clearingData) {
195 if (synch) {
196 Object source = signal.getSource();
197 if (signal != null && source != null && source != this) {
198 // Internal value is expected in nano seconds.
199 TmfTimeRange trange = signal.getCurrentRange();
200 TmfExperiment<?> experiment = TmfExperiment.getCurrentExperiment();
201 if (experiment == null) {
202 TraceDebug.debug("Current selected experiment is null");
203 return;
204 }
205
206 // Clearing of process data is configurable
207 dataRequest(trange, experiment.getTimeRange(), clearingData);
208 }
209 }
210 }
211
212 /**
213 * Trigger time synchronisation to other views this method shall be called
214 * when a check has been performed to note that an actual change of time has
215 * been performed vs a pure re-selection of the same time
216 *
217 * @param time
218 * @param source
219 */
220 protected void synchTimeNotification(long time, Object source) {
221 // if synchronisation selected
222 if (synch) {
223 // Notify other views
224 TmfSignalManager.dispatchSignal(new TmfTimeSynchSignal(source, new LttngTimestamp(time)));
225 }
226 }
227
228 /**
229 * Common implementation of ITmfTimeSelectionListener, not used by all the
230 * views extending this abstract class
231 *
232 * @param event
233 */
234 protected void tsfTmProcessSelEvent(TmfTimeSelectionEvent event) {
235 Object source = event.getSource();
236 if (source == null) {
237 return;
238 }
239
240 ParamsUpdater paramUpdater = getParamsUpdater();
241 Long savedSelTime = paramUpdater.getSelectedTime();
242
243 long selTimens = event.getSelectedTime();
244
245 // make sure the new selected time is different than saved before
246 // executing update
247 if (savedSelTime == null || savedSelTime != selTimens) {
248 // Notify listener views.
249 synchTimeNotification(selTimens, source);
250
251 // Update the parameter updater to save the selected time
252 paramUpdater.setSelectedTime(selTimens);
253
254 if (TraceDebug.isDEBUG()) {
255 TraceDebug.debug("Selected Time: " + new LttngTimestamp(selTimens) + "\n\t\t" + getName());
256 }
257 }
258 }
259
260 /**
261 * Common implementation of ITmfTimeScaleSelectionListener, not used by all
262 * the views extending this abstract class
263 *
264 * @param event
265 */
266 protected synchronized void tsfTmProcessTimeScaleEvent(TmfTimeScaleSelectionEvent event) {
267 // source needed to keep track of source values
268 Object source = event.getSource();
269
270 if (source != null) {
271 // Update the parameter updater before carrying out a read request
272 ParamsUpdater paramUpdater = getParamsUpdater();
273 boolean newParams = paramUpdater.processTimeScaleEvent(event);
274
275 if (newParams) {
276 // Read the updated time window
277 TmfTimeRange trange = paramUpdater.getTrange();
278 if (trange != null) {
279
280 // Notify listener views. to perform data requests
281 // upon this notification
282 synchTimeRangeNotification(trange, paramUpdater.getSelectedTime(), source);
283 }
284 }
285 }
286 }
287
288 /**
289 * Inform registered listeners about the new time range
290 *
291 * @param trange
292 * @param selectedTime
293 * @param source
294 */
295 protected void synchTimeRangeNotification(TmfTimeRange trange, Long selectedTime, Object source) {
296 // if synchronisation selected
297 if (synch) {
298 // Notify other views
299 TmfSignalManager.dispatchSignal(new TmfRangeSynchSignal(source, trange, new LttngTimestamp(selectedTime)));
300 }
301 }
302
303 /**
304 * @param zoomedTRange
305 * @param experimentTRange
306 */
307 public void dataRequest(TmfTimeRange zoomedTRange,
308 TmfTimeRange experimentTRange, boolean clearingData) {
309
310 // timeRange is the Experiment time range
311 boolean sent = processDataRequest(zoomedTRange, experimentTRange, clearingData);
312
313 if (sent) {
314 waitCursor(true);
315 }
316 }
317
318 /**
319 * send data request directly e.g. doesn't use a queue
320 *
321 * @param requestTrange
322 * @param listener
323 * @param experimentTRange
324 * @param processor
325 * @return
326 */
327 private boolean processDataRequest(TmfTimeRange requestTrange,
328 TmfTimeRange experimentTRange, boolean clearingData) {
329 // Validate input
330 if (requestTrange == null || experimentTRange == null) {
331 TraceDebug.debug("Invalid input");
332 return false;
333 }
334
335 LttngSyntEventRequest request = new LttngSyntEventRequest(
336 requestTrange, DEFAULT_OFFSET, TmfDataRequest.ALL_DATA,
337 DEFAULT_CHUNK, this, experimentTRange, getEventProcessor()) {
338
339 Long fCount = getSynEventCount();
340 ITransEventProcessor processor = getProcessor();
341 TmfTimestamp frunningTimeStamp;
342
343 /*
344 * (non-Javadoc)
345 *
346 * @see
347 * org.eclipse.linuxtools.lttng.request.LttngSyntEventRequest#handleData
348 * ()
349 */
350 @Override
351 public void handleData() {
352 TmfEvent[] result = getData();
353
354 TmfEvent evt = (result.length > 0) ? result[0] : null;
355 if (evt != null) {
356 LttngSyntheticEvent synEvent = (LttngSyntheticEvent) evt;
357 // process event
358 SequenceInd indicator = synEvent.getSynType();
359 if (indicator == SequenceInd.BEFORE
360 || indicator == SequenceInd.AFTER) {
361 processor.process(evt, synEvent.getTraceModel());
362 } else if (indicator == SequenceInd.STARTREQ) {
363 handleRequestStarted();
364 } else if (indicator == SequenceInd.ENDREQ) {
365 processor.process(evt, synEvent.getTraceModel());
366 // handleCompleted();
367 }
368
369 if (indicator == SequenceInd.BEFORE) {
370 fCount++;
371 if (fCount != 0 && fCount % INPUT_CHANGED_REFRESH == 0) {
372 // send partial update
373 modelInputChanged(this, false);
374
375 if (TraceDebug.isDEBUG()) {
376 frunningTimeStamp = evt.getTimestamp();
377 TraceDebug.debug("handled: " + fCount + " sequence: " + synEvent.getSynType());
378 }
379
380 }
381 }
382 }
383 }
384
385 public void handleRequestStarted() {
386 notifyStarting();
387 }
388
389 @Override
390 public void handleCompleted() {
391 super.handleCompleted();
392
393 // Data is not complete and should be handled as such
394 if (isFailed() || isCancelled()) {
395 modelIncomplete(this);
396 }
397
398 if (TraceDebug.isDEBUG()) {
399 if (frunningTimeStamp != null) {
400 TraceDebug.debug("Last event time stamp: "
401 + frunningTimeStamp.getValue());
402 }
403 }
404 }
405 };
406
407 // obtain singleton core provider
408 LttngSyntheticEventProvider provider = LttngCoreProviderFactory
409 .getEventProvider();
410
411 // send the request to TMF
412 request.startRequestInd(provider);
413 request.setclearDataInd(clearingData);
414 return true;
415 }
416
417 /**
418 * Returns an initial smaller window to allow the user to select the area of
419 * interest
420 *
421 * @param experimentTRange
422 * @return
423 */
424 protected TmfTimeRange getInitTRange(TmfTimeRange experimentTRange) {
425 TmfTimestamp expStartTime = experimentTRange.getStartTime();
426 TmfTimestamp expEndTime = experimentTRange.getEndTime();
427 TmfTimestamp initialEndOfWindow = new LttngTimestamp(expStartTime
428 .getValue()
429 + INITIAL_WINDOW_OFFSET);
430 if (initialEndOfWindow.compareTo(expEndTime, false) < 0) {
431 return new TmfTimeRange(expStartTime, initialEndOfWindow);
432 }
433
434 // The original size of the experiment is smaller than proposed adjusted
435 // time
436 return experimentTRange;
437 }
438
439 /**
440 * Request the Time Analysis widget to enable or disable the wait cursor
441 * e.g. data request in progress or data request completed
442 *
443 * @param waitInd
444 */
445 protected void waitCursor(final boolean waitInd) {
446 if (tsfviewer != null) {
447 Display display = tsfviewer.getControl().getDisplay();
448
449 // Perform the updates on the UI thread
450 display.asyncExec(new Runnable() {
451 public void run() {
452 tsfviewer.waitCursor(waitInd);
453 }
454 });
455 }
456 }
457
458 /**
459 * View preparation to override the current local information
460 *
461 * @param timeRange
462 * - new total time range e.g. Experiment level
463 * @param clearAllData
464 */
465 protected void ModelUpdatePrep(TmfTimeRange timeRange, boolean clearAllData) {
466 ItemContainer<?> itemContainer = getItemContainer();
467 if (clearAllData) {
468 // start fresh e.g. new experiment selected
469 itemContainer.clearItems();
470 } else {
471 // clear children but keep processes
472 itemContainer.clearChildren();
473 }
474
475 // Obtain the current resource array
476 ITmfTimeAnalysisEntry[] itemArr = itemContainer.readItems();
477
478 // clean up data and boundaries
479 displayModel(itemArr, -1, -1, false, -1, -1, null);
480
481 ParamsUpdater updater = getParamsUpdater();
482 if (updater != null) {
483 // Start over
484 updater.setEventsDiscarded(0);
485
486 // Update new visible time range if available
487 if (timeRange != null) {
488 updater.update(timeRange.getStartTime().getValue(), timeRange.getEndTime().getValue());
489 }
490 }
491 }
492
493 /**
494 * Initialize the model and view before reloading items
495 *
496 * @param boundaryRange
497 * @param visibleRange
498 * @param source
499 */
500 protected void ModelUpdateInit(TmfTimeRange boundaryRange, TmfTimeRange visibleRange, Object source) {
501 // Update the view boundaries
502 if (boundaryRange != null) {
503 ItemContainer<?> itemContainer = getItemContainer();
504 if (itemContainer != null) {
505 itemContainer.clearItems();
506 // Obtain the current process array
507 ITmfTimeAnalysisEntry[] itemArr = itemContainer.readItems();
508
509 long startTime = boundaryRange.getStartTime().getValue();
510 long endTime = boundaryRange.getEndTime().getValue();
511
512 // Update the view part
513 displayModel(itemArr, startTime, endTime, true, visibleRange.getStartTime().getValue(), visibleRange
514 .getEndTime().getValue(), source);
515 }
516 }
517
518 // update the view filtering parameters
519 if (visibleRange != null) {
520 ParamsUpdater updater = getParamsUpdater();
521 if (updater != null) {
522 // Start over
523 updater.setEventsDiscarded(0);
524 // Update new visible time range if available
525 updater.update(visibleRange.getStartTime().getValue(), visibleRange.getEndTime().getValue());
526 }
527 }
528 }
529
530 /**
531 * Actions taken by the view to refresh its widget(s) with the updated data
532 * model
533 *
534 * @param request
535 * @param complete
536 * true: yes, false: partial update
537 */
538 protected void modelInputChanged(ILttngSyntEventRequest request, boolean complete) {
539 long experimentStartTime = -1;
540 long experimentEndTime = -1;
541 TmfTimeRange experimentTimeRange = request.getExperimentTimeRange();
542 if (experimentTimeRange != null) {
543 experimentStartTime = experimentTimeRange.getStartTime().getValue();
544 experimentEndTime = experimentTimeRange.getEndTime().getValue();
545 }
546
547 // Obtain the current resource list
548 ITmfTimeAnalysisEntry[] itemArr = getItemContainer().readItems();
549
550 if (itemArr != null) {
551 // Sort the array by pid
552 Arrays.sort(itemArr);
553
554 // Update the view part
555 displayModel(itemArr, experimentStartTime, experimentEndTime, false, request.getRange().getStartTime()
556 .getValue(), request.getRange().getEndTime().getValue(), request.getSource());
557 }
558
559 if (complete) {
560 // reselect to original time
561 ParamsUpdater paramUpdater = ResourceModelFactory.getParamsUpdater();
562 if (paramUpdater != null && tsfviewer != null) {
563 final Long selTime = paramUpdater.getSelectedTime();
564 if (selTime != null) {
565 TraceDebug.debug("View: " + getName() + "\n\t\tRestoring the selected time to: " + selTime);
566 Display display = tsfviewer.getControl().getDisplay();
567 display.asyncExec(new Runnable() {
568 public void run() {
569 tsfviewer.setSelectedTime(selTime, false, this);
570 }
571 });
572 }
573
574 if (TraceDebug.isDEBUG()) {
575 int eventCount = 0;
576 Long count = request.getSynEventCount();
577 for (int pos = 0; pos < itemArr.length; pos++) {
578 eventCount += itemArr[pos].getTraceEvents().size();
579 }
580
581 int discarded = getParamsUpdater().getEventsDiscarded();
582 int discardedOutofOrder = paramUpdater.getEventsDiscardedWrongOrder();
583 TmfTimeRange range = request.getRange();
584 StringBuilder sb = new StringBuilder("View: " + getName() + ", Events handled: " + count
585 + ", Events loaded in view: " + eventCount + ", Number of events discarded: " + discarded
586 + "\n\tNumber of events discarded with start time earlier than next good time: "
587 + discardedOutofOrder);
588
589 sb.append("\n\t\tRequested Time Range: " + range.getStartTime() + "-" + range.getEndTime());
590 sb.append("\n\t\tExperiment Time Range: " + experimentStartTime + "-" + experimentEndTime);
591 TraceDebug.debug(sb.toString());
592 }
593 }
594
595 }
596 }
597
598 // /**
599 // * Obtains the remainder fraction on unit Seconds of the entered value in
600 // * nanoseconds. e.g. input: 1241207054171080214 ns The number of seconds
601 // can
602 // * be obtain by removing the last 9 digits: 1241207054 the fractional
603 // * portion of seconds, expressed in ns is: 171080214
604 // *
605 // * @param v
606 // * @return
607 // */
608 // protected String formatNs(long v) {
609 // StringBuffer str = new StringBuffer();
610 // boolean neg = v < 0;
611 // if (neg) {
612 // v = -v;
613 // str.append('-');
614 // }
615 //
616 // String strVal = String.valueOf(v);
617 // if (v < 1000000000) {
618 // return strVal;
619 // }
620 //
621 // // Extract the last nine digits (e.g. fraction of a S expressed in ns
622 // return strVal.substring(strVal.length() - 9);
623 // }
624
625 /**
626 * The request was stopped, the data is incomplete
627 *
628 * @param request
629 */
630 protected abstract void modelIncomplete(ILttngSyntEventRequest request);
631
632 /**
633 * Returns the Event processor instance related to a specific view
634 *
635 * @return
636 */
637 protected abstract ITransEventProcessor getEventProcessor();
638
639 /**
640 * To be overridden by some sub-classes although may not be needed in some
641 * e.g. statistics view
642 *
643 * @param items
644 * @param startBoundTime
645 * @param endBoundTime
646 * @param updateTimeBounds
647 * - Time bounds updated needed e.g. if a new Experiment or trace
648 * is selected
649 * @param startVisibleWindow
650 * @param endVisibleWindow
651 * @param source
652 */
653 protected abstract void displayModel(final ITmfTimeAnalysisEntry[] items, final long startBoundTime,
654 final long endBoundTime, final boolean updateTimeBounds, final long startVisibleWindow,
655 final long endVisibleWindow, final Object source);
656
657 /**
658 * To be overridden by some sub-classes although may not be needed in some
659 * e.g. statistics view
660 *
661 * @return
662 */
663 protected abstract ParamsUpdater getParamsUpdater();
664
665 /**
666 * Returns the model's item container
667 *
668 * @return
669 */
670 protected abstract ItemContainer<?> getItemContainer();
671 }
This page took 0.046976 seconds and 5 git commands to generate.