Commit | Line | Data |
---|---|---|
1c0de632 | 1 | /******************************************************************************* |
61759503 | 2 | * Copyright (c) 2012, 2013 Ericsson |
1c0de632 AM |
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 | * Alexandre Montplaisir - Initial API and implementation | |
11 | ******************************************************************************/ | |
12 | ||
13 | package org.eclipse.linuxtools.tmf.core.statistics; | |
14 | ||
f3f93fa6 | 15 | import java.util.Collection; |
1c0de632 | 16 | import java.util.HashMap; |
f3f93fa6 AM |
17 | import java.util.LinkedList; |
18 | import java.util.List; | |
1c0de632 | 19 | import java.util.Map; |
f3f93fa6 | 20 | import java.util.TreeMap; |
1c0de632 AM |
21 | |
22 | import org.eclipse.linuxtools.tmf.core.event.ITmfEvent; | |
6debe8aa | 23 | import org.eclipse.linuxtools.tmf.core.event.ITmfLostEvent; |
fd3f1eff | 24 | import org.eclipse.linuxtools.tmf.core.request.ITmfEventRequest; |
1c0de632 | 25 | import org.eclipse.linuxtools.tmf.core.request.TmfEventRequest; |
3bd46eef AM |
26 | import org.eclipse.linuxtools.tmf.core.timestamp.ITmfTimestamp; |
27 | import org.eclipse.linuxtools.tmf.core.timestamp.TmfTimeRange; | |
28 | import org.eclipse.linuxtools.tmf.core.timestamp.TmfTimestamp; | |
1c0de632 AM |
29 | import org.eclipse.linuxtools.tmf.core.trace.ITmfTrace; |
30 | ||
31 | /** | |
32 | * Implementation of ITmfStatistics which uses event requests to the trace to | |
33 | * retrieve its information. | |
34 | * | |
35 | * There is almost no setup time, but queries themselves are longer than with a | |
36 | * TmfStateStatistics. Queries are O(n * m), where n is the size of the trace, | |
37 | * and m is the portion of the trace covered by the selected interval. | |
38 | * | |
39 | * @author Alexandre Montplaisir | |
40 | * @since 2.0 | |
41 | */ | |
42 | public class TmfEventsStatistics implements ITmfStatistics { | |
43 | ||
8b260d9f AM |
44 | /* All timestamps should be stored in nanoseconds in the statistics backend */ |
45 | private static final int SCALE = ITmfTimestamp.NANOSECOND_SCALE; | |
46 | ||
1c0de632 AM |
47 | private final ITmfTrace trace; |
48 | ||
49 | /* Event request objects for the time-range request. */ | |
50 | private StatsTotalRequest totalRequest = null; | |
51 | private StatsPerTypeRequest perTypeRequest = null; | |
52 | ||
53 | /** | |
54 | * Constructor | |
55 | * | |
56 | * @param trace | |
57 | * The trace for which we are building the statistics | |
58 | */ | |
59 | public TmfEventsStatistics(ITmfTrace trace) { | |
60 | this.trace = trace; | |
61 | } | |
62 | ||
1a4205d9 AM |
63 | @Override |
64 | public void dispose() { | |
65 | cancelOngoingRequests(); | |
66 | } | |
67 | ||
f3f93fa6 AM |
68 | @Override |
69 | public List<Long> histogramQuery(long start, long end, int nb) { | |
70 | final long[] borders = new long[nb]; | |
71 | final long increment = (end - start) / nb; | |
72 | ||
73 | long curTime = start; | |
74 | for (int i = 0; i < nb; i++) { | |
75 | borders[i] = curTime; | |
76 | curTime += increment; | |
77 | } | |
78 | ||
79 | HistogramQueryRequest req = new HistogramQueryRequest(borders, end); | |
80 | sendAndWait(req); | |
81 | ||
a4524c1b | 82 | List<Long> results = new LinkedList<>(req.getResults()); |
f3f93fa6 AM |
83 | return results; |
84 | ||
85 | } | |
86 | ||
1c0de632 AM |
87 | private synchronized void cancelOngoingRequests() { |
88 | if (totalRequest != null && totalRequest.isRunning()) { | |
89 | totalRequest.cancel(); | |
90 | } | |
91 | if (perTypeRequest != null && perTypeRequest.isRunning()) { | |
92 | perTypeRequest.cancel(); | |
93 | } | |
94 | } | |
95 | ||
96 | @Override | |
97 | public long getEventsTotal() { | |
98 | StatsTotalRequest request = new StatsTotalRequest(trace, TmfTimeRange.ETERNITY); | |
99 | sendAndWait(request); | |
100 | ||
101 | long total = request.getResult(); | |
102 | return total; | |
103 | } | |
104 | ||
105 | @Override | |
106 | public Map<String, Long> getEventTypesTotal() { | |
107 | StatsPerTypeRequest request = new StatsPerTypeRequest(trace, TmfTimeRange.ETERNITY); | |
108 | sendAndWait(request); | |
109 | ||
110 | Map<String, Long> stats = request.getResults(); | |
111 | return stats; | |
112 | } | |
113 | ||
114 | @Override | |
8b260d9f AM |
115 | public long getEventsInRange(long start, long end) { |
116 | ITmfTimestamp startTS = new TmfTimestamp(start, SCALE); | |
117 | ITmfTimestamp endTS = new TmfTimestamp(end, SCALE); | |
118 | TmfTimeRange range = new TmfTimeRange(startTS, endTS); | |
119 | ||
1c0de632 AM |
120 | StatsTotalRequest request = new StatsTotalRequest(trace, range); |
121 | sendAndWait(request); | |
122 | ||
123 | long total = request.getResult(); | |
124 | return total; | |
125 | } | |
126 | ||
127 | @Override | |
8b260d9f AM |
128 | public Map<String, Long> getEventTypesInRange(long start, long end) { |
129 | ITmfTimestamp startTS = new TmfTimestamp(start, SCALE); | |
130 | ITmfTimestamp endTS = new TmfTimestamp(end, SCALE); | |
131 | TmfTimeRange range = new TmfTimeRange(startTS, endTS); | |
132 | ||
1c0de632 AM |
133 | StatsPerTypeRequest request = new StatsPerTypeRequest(trace, range); |
134 | sendAndWait(request); | |
135 | ||
136 | Map<String, Long> stats = request.getResults(); | |
137 | return stats; | |
138 | } | |
139 | ||
140 | private void sendAndWait(TmfEventRequest request) { | |
141 | trace.sendRequest(request); | |
142 | try { | |
143 | request.waitForCompletion(); | |
144 | } catch (InterruptedException e) { | |
145 | e.printStackTrace(); | |
146 | } | |
147 | } | |
148 | ||
149 | ||
150 | /** | |
151 | * Event request to get the total number of events | |
152 | */ | |
153 | private class StatsTotalRequest extends TmfEventRequest { | |
154 | ||
155 | /* Total number of events the request has found */ | |
156 | private long total; | |
157 | ||
158 | public StatsTotalRequest(ITmfTrace trace, TmfTimeRange range) { | |
2740e05c | 159 | super(trace.getEventType(), range, 0, ITmfEventRequest.ALL_DATA, |
fd3f1eff | 160 | ITmfEventRequest.ExecutionType.BACKGROUND); |
1c0de632 AM |
161 | total = 0; |
162 | } | |
163 | ||
164 | public long getResult() { | |
165 | return total; | |
166 | } | |
167 | ||
168 | @Override | |
169 | public void handleData(final ITmfEvent event) { | |
170 | super.handleData(event); | |
6debe8aa AM |
171 | if (!(event instanceof ITmfLostEvent) && event.getTrace() == trace) { |
172 | total += 1; | |
1c0de632 AM |
173 | } |
174 | } | |
175 | } | |
176 | ||
177 | ||
178 | /** | |
179 | * Event request to get the counts per event type | |
180 | */ | |
181 | private class StatsPerTypeRequest extends TmfEventRequest { | |
182 | ||
183 | /* Map in which the results are saved */ | |
184 | private final Map<String, Long> stats; | |
185 | ||
186 | public StatsPerTypeRequest(ITmfTrace trace, TmfTimeRange range) { | |
2740e05c | 187 | super(trace.getEventType(), range, 0, ITmfEventRequest.ALL_DATA, |
fd3f1eff | 188 | ITmfEventRequest.ExecutionType.BACKGROUND); |
a4524c1b | 189 | this.stats = new HashMap<>(); |
1c0de632 AM |
190 | } |
191 | ||
192 | public Map<String, Long> getResults() { | |
193 | return stats; | |
194 | } | |
195 | ||
196 | @Override | |
5419a136 AM |
197 | public void handleData(final ITmfEvent event) { |
198 | super.handleData(event); | |
6debe8aa | 199 | if (event != null && event.getTrace() == trace) { |
e8f9ac01 | 200 | String eventType = event.getType().getName(); |
6debe8aa AM |
201 | /* |
202 | * Special handling for lost events: instead of counting just | |
203 | * one, we will count how many actual events it represents. | |
204 | */ | |
205 | if (event instanceof ITmfLostEvent) { | |
206 | ITmfLostEvent le = (ITmfLostEvent) event; | |
e8f9ac01 | 207 | incrementStats(eventType, le.getNbLostEvents()); |
6debe8aa | 208 | return; |
1c0de632 | 209 | } |
6debe8aa AM |
210 | |
211 | /* For standard event types, just increment by one */ | |
6debe8aa | 212 | incrementStats(eventType, 1L); |
1c0de632 AM |
213 | } |
214 | } | |
215 | ||
6debe8aa AM |
216 | private void incrementStats(String key, long count) { |
217 | if (stats.containsKey(key)) { | |
218 | long curValue = stats.get(key); | |
219 | stats.put(key, curValue + count); | |
1c0de632 | 220 | } else { |
6debe8aa | 221 | stats.put(key, count); |
1c0de632 AM |
222 | } |
223 | } | |
224 | } | |
225 | ||
f3f93fa6 AM |
226 | /** |
227 | * Event request for histogram queries. It is much faster to do one event | |
228 | * request then set the results accordingly than doing thousands of them one | |
229 | * by one. | |
230 | */ | |
231 | private class HistogramQueryRequest extends TmfEventRequest { | |
232 | ||
233 | /** Map of <borders, number of events> */ | |
234 | private final TreeMap<Long, Long> results; | |
235 | ||
236 | /** | |
237 | * New histogram request | |
238 | * | |
239 | * @param borders | |
240 | * The array of borders (not including the end time). The | |
241 | * first element should be the start time of the queries. | |
242 | * @param endTime | |
243 | * The end time of the query. Not used in the results map, | |
244 | * but we need to know when to stop the event request. | |
245 | */ | |
246 | public HistogramQueryRequest(long[] borders, long endTime) { | |
247 | super(trace.getEventType(), | |
248 | new TmfTimeRange( | |
249 | new TmfTimestamp(borders[0], SCALE), | |
250 | new TmfTimestamp(endTime, SCALE)), | |
7184fc40 | 251 | 0, |
2740e05c | 252 | ITmfEventRequest.ALL_DATA, |
fd3f1eff | 253 | ITmfEventRequest.ExecutionType.BACKGROUND); |
f3f93fa6 AM |
254 | |
255 | /* Prepare the results map, with all counts at 0 */ | |
a4524c1b | 256 | results = new TreeMap<>(); |
f3f93fa6 AM |
257 | for (long border : borders) { |
258 | results.put(border, 0L); | |
259 | } | |
260 | } | |
261 | ||
262 | public Collection<Long> getResults() { | |
263 | return results.values(); | |
264 | } | |
265 | ||
266 | @Override | |
5419a136 AM |
267 | public void handleData(ITmfEvent event) { |
268 | super.handleData(event); | |
f3f93fa6 AM |
269 | if ((event != null) && (event.getTrace() == trace)) { |
270 | long ts = event.getTimestamp().normalize(0, SCALE).getValue(); | |
271 | Long key = results.floorKey(ts); | |
272 | if (key != null) { | |
273 | incrementValue(key); | |
274 | } | |
275 | } | |
276 | } | |
277 | ||
278 | private void incrementValue(Long key) { | |
279 | long value = results.get(key); | |
280 | value++; | |
281 | results.put(key, value); | |
282 | } | |
283 | } | |
284 | ||
1c0de632 | 285 | } |