1 /*******************************************************************************
2 * Copyright (c) 2013, 2015 Ericsson
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
10 * Alexandre Montplaisir - Initial API and implementation
11 * Patrick Tasse - Added lost events attribute
12 ******************************************************************************/
14 package org
.eclipse
.tracecompass
.tmf
.core
.statistics
;
16 import static org
.eclipse
.tracecompass
.common
.core
.NonNullUtils
.checkNotNull
;
18 import org
.eclipse
.jdt
.annotation
.NonNull
;
19 import org
.eclipse
.tracecompass
.statesystem
.core
.ITmfStateSystemBuilder
;
20 import org
.eclipse
.tracecompass
.statesystem
.core
.exceptions
.AttributeNotFoundException
;
21 import org
.eclipse
.tracecompass
.statesystem
.core
.exceptions
.StateValueTypeException
;
22 import org
.eclipse
.tracecompass
.statesystem
.core
.exceptions
.TimeRangeException
;
23 import org
.eclipse
.tracecompass
.statesystem
.core
.statevalue
.ITmfStateValue
;
24 import org
.eclipse
.tracecompass
.statesystem
.core
.statevalue
.TmfStateValue
;
25 import org
.eclipse
.tracecompass
.tmf
.core
.event
.ITmfEvent
;
26 import org
.eclipse
.tracecompass
.tmf
.core
.event
.ITmfLostEvent
;
27 import org
.eclipse
.tracecompass
.tmf
.core
.statesystem
.AbstractTmfStateProvider
;
28 import org
.eclipse
.tracecompass
.tmf
.core
.statesystem
.ITmfStateProvider
;
29 import org
.eclipse
.tracecompass
.tmf
.core
.statesystem
.TmfStateSystemAnalysisModule
;
30 import org
.eclipse
.tracecompass
.tmf
.core
.statistics
.TmfStateStatistics
.Attributes
;
31 import org
.eclipse
.tracecompass
.tmf
.core
.timestamp
.ITmfTimestamp
;
32 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.ITmfTrace
;
35 * The analysis module building the "event types" statistics state system.
37 * It is not in the extension point (and as such, not registered in the
38 * TmfAnalysisManager), as it is being handled by the TmfStatisticsModule.
40 * @author Alexandre Montplaisir
42 public class TmfStatisticsEventTypesModule
extends TmfStateSystemAnalysisModule
{
45 * The ID of this analysis module (which is also the ID of the state system)
47 public static final @NonNull String ID
= "org.eclipse.linuxtools.tmf.statistics.types"; //$NON-NLS-1$
49 private static final @NonNull String NAME
= "TMF Statistics, events per type"; //$NON-NLS-1$
54 public TmfStatisticsEventTypesModule() {
61 protected ITmfStateProvider
createStateProvider() {
62 return new StatsProviderEventTypes(checkNotNull(getTrace()));
66 protected String
getSsFileName() {
67 return "statistics-types.ht"; //$NON-NLS-1$
72 * The state provider for traces statistics that use TmfStateStatistics. It
73 * should work with any trace type for which we can use the state system.
75 * It will store number of events seen, per event types. The resulting
76 * attribute tree will look like this:
81 * | |-- (event name 1)
82 * | |-- (event name 2)
83 * | |-- (event name 3)
88 * Each (event name)'s value will be an integer, representing how many times
89 * this particular event type has been seen in the trace so far.
91 * The value of the lost_events attribute will be a long, representing the
92 * latest end time of any current or previous lost event time range, in
93 * nanoseconds. If the value at a specific time 't' is greater than 't',
94 * then there is at least one lost event time range that overlaps time 't'.
96 * @author Alexandre Montplaisir
99 class StatsProviderEventTypes
extends AbstractTmfStateProvider
{
102 * Version number of this input handler. Please bump this if you modify the
103 * contents of the generated state history in some way.
105 private static final int VERSION
= 3;
111 * The trace for which we build this state system
113 public StatsProviderEventTypes(@NonNull ITmfTrace trace
) {
114 super(trace
,"TMF Statistics, events per type"); //$NON-NLS-1$
118 public int getVersion() {
123 public StatsProviderEventTypes
getNewInstance() {
124 return new StatsProviderEventTypes(this.getTrace());
128 protected void eventHandle(ITmfEvent event
) {
129 ITmfStateSystemBuilder ss
= checkNotNull(getStateSystemBuilder());
132 /* Since this can be used for any trace types, normalize all the
133 * timestamp values to nanoseconds. */
134 final long ts
= event
.getTimestamp().normalize(0, ITmfTimestamp
.NANOSECOND_SCALE
).getValue();
136 final String eventName
= event
.getName();
139 /* Special handling for lost events */
140 if (event
instanceof ITmfLostEvent
) {
141 ITmfLostEvent le
= (ITmfLostEvent
) event
;
142 quark
= ss
.getQuarkAbsoluteAndAdd(Attributes
.EVENT_TYPES
, eventName
);
144 int curVal
= ss
.queryOngoingState(quark
).unboxInt();
149 ITmfStateValue value1
= TmfStateValue
.newValueInt((int) (curVal
+ le
.getNbLostEvents()));
150 ss
.modifyAttribute(ts
, value1
, quark
);
152 long lostEventsStartTime
= le
.getTimeRange().getStartTime().normalize(0, ITmfTimestamp
.NANOSECOND_SCALE
).getValue();
153 long lostEventsEndTime
= le
.getTimeRange().getEndTime().normalize(0, ITmfTimestamp
.NANOSECOND_SCALE
).getValue();
154 int lostEventsQuark
= ss
.getQuarkAbsoluteAndAdd(Attributes
.LOST_EVENTS
);
155 ITmfStateValue currentLostEventsEndTime
= ss
.queryOngoingState(lostEventsQuark
);
156 if (currentLostEventsEndTime
.isNull() || currentLostEventsEndTime
.unboxLong() < lostEventsStartTime
) {
157 ss
.modifyAttribute(lostEventsStartTime
, TmfStateValue
.newValueLong(lostEventsEndTime
), lostEventsQuark
);
158 } else if (currentLostEventsEndTime
.unboxLong() < lostEventsEndTime
) {
159 ss
.updateOngoingState(TmfStateValue
.newValueLong(lostEventsEndTime
), lostEventsQuark
);
164 /* Number of events of each type, globally */
165 quark
= ss
.getQuarkAbsoluteAndAdd(Attributes
.EVENT_TYPES
, eventName
);
166 ss
.incrementAttribute(ts
, quark
);
168 // /* Number of events per CPU */
169 // quark = ss.getQuarkRelativeAndAdd(currentCPUNode, Attributes.STATISTICS, Attributes.EVENT_TYPES, eventName);
170 // ss.incrementAttribute(ts, quark);
172 // /* Number of events per process */
173 // quark = ss.getQuarkRelativeAndAdd(currentThreadNode, Attributes.STATISTICS, Attributes.EVENT_TYPES, eventName);
174 // ss.incrementAttribute(ts, quark);
176 } catch (StateValueTypeException
| TimeRangeException
| AttributeNotFoundException e
) {