Commit | Line | Data |
---|---|---|
306586b1 | 1 | /******************************************************************************* |
8967c8c0 | 2 | * Copyright (c) 2013, 2014 Ericsson |
306586b1 SD |
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 | * Simon Delisle - Initial API and implementation | |
11 | *******************************************************************************/ | |
12 | ||
9722e5d7 | 13 | package org.eclipse.tracecompass.tmf.ctf.core.tests.temp.request; |
306586b1 | 14 | |
ab346a2b BH |
15 | import static org.junit.Assert.assertEquals; |
16 | import static org.junit.Assert.assertFalse; | |
17 | import static org.junit.Assert.assertTrue; | |
18 | import static org.junit.Assert.fail; | |
306586b1 SD |
19 | |
20 | import java.util.ArrayList; | |
306586b1 SD |
21 | import java.util.LinkedList; |
22 | import java.util.List; | |
d291a715 | 23 | import java.util.concurrent.TimeUnit; |
306586b1 | 24 | |
c4d57ac1 AM |
25 | import org.eclipse.jdt.annotation.NonNull; |
26 | import org.eclipse.tracecompass.testtraces.ctf.CtfTestTrace; | |
2bdf0193 | 27 | import org.eclipse.tracecompass.tmf.core.event.ITmfEvent; |
2bdf0193 AM |
28 | import org.eclipse.tracecompass.tmf.core.request.ITmfEventRequest; |
29 | import org.eclipse.tracecompass.tmf.core.request.TmfEventRequest; | |
97c71024 | 30 | import org.eclipse.tracecompass.tmf.core.signal.TmfSelectionRangeUpdatedSignal; |
2bdf0193 AM |
31 | import org.eclipse.tracecompass.tmf.core.timestamp.ITmfTimestamp; |
32 | import org.eclipse.tracecompass.tmf.core.timestamp.TmfTimeRange; | |
33 | import org.eclipse.tracecompass.tmf.core.timestamp.TmfTimestamp; | |
c4d57ac1 | 34 | import org.eclipse.tracecompass.tmf.ctf.core.tests.shared.CtfTmfTestTraceUtils; |
9722e5d7 | 35 | import org.eclipse.tracecompass.tmf.ctf.core.trace.CtfTmfTrace; |
306586b1 SD |
36 | import org.junit.After; |
37 | import org.junit.Before; | |
b1b999ea | 38 | import org.junit.Ignore; |
50d6b86f | 39 | import org.junit.Rule; |
306586b1 | 40 | import org.junit.Test; |
50d6b86f AM |
41 | import org.junit.rules.TestRule; |
42 | import org.junit.rules.Timeout; | |
306586b1 SD |
43 | |
44 | /** | |
45 | * Test suite for the scheduler. | |
46 | */ | |
47 | public class TmfSchedulerTest { | |
48 | ||
50d6b86f AM |
49 | /** Time-out tests after 60 seconds */ |
50 | @Rule | |
d291a715 | 51 | public TestRule globalTimeout= new Timeout(1, TimeUnit.MINUTES); |
50d6b86f | 52 | |
306586b1 SD |
53 | // ------------------------------------------------------------------------ |
54 | // Constants | |
55 | // ------------------------------------------------------------------------ | |
56 | ||
c4d57ac1 | 57 | private static final @NonNull CtfTestTrace testTrace = CtfTestTrace.KERNEL; |
306586b1 SD |
58 | private static final int NB_EVENTS_TRACE = 695319; |
59 | private static final int NB_EVENTS_TIME_RANGE = 155133; | |
60 | ||
61 | // ------------------------------------------------------------------------ | |
62 | // Attributes | |
63 | // ------------------------------------------------------------------------ | |
64 | ||
65 | private CtfTmfTrace fixture; | |
66 | ||
67 | private long fStartTime; | |
68 | private long fEndTime; | |
69 | private TmfTimeRange fForegroundTimeRange; | |
70 | ||
ccf2bbb4 | 71 | private final List<String> fOrderList = new ArrayList<>(); |
306586b1 SD |
72 | private int fForegroundId = 0; |
73 | private int fBackgroundId = 0; | |
74 | ||
75 | /** | |
76 | * Perform pre-test initialization. | |
306586b1 SD |
77 | */ |
78 | @Before | |
c4d57ac1 AM |
79 | public void setUp() { |
80 | fixture = CtfTmfTestTraceUtils.getTrace(testTrace); | |
306586b1 SD |
81 | fixture.indexTrace(true); |
82 | fStartTime = fixture.getStartTime().normalize(0, ITmfTimestamp.NANOSECOND_SCALE).getValue(); | |
83 | fEndTime = fixture.getEndTime().normalize(0, ITmfTimestamp.NANOSECOND_SCALE).getValue(); | |
84 | ||
85 | long foregroundStartTime = fStartTime + ((fEndTime - fStartTime) / 4); | |
86 | long foregroundEndTime = fStartTime + ((fEndTime - fStartTime) / 2); | |
065cc19b AM |
87 | fForegroundTimeRange = new TmfTimeRange(new TmfTimestamp(foregroundStartTime, ITmfTimestamp.NANOSECOND_SCALE), |
88 | new TmfTimestamp(foregroundEndTime, ITmfTimestamp.NANOSECOND_SCALE)); | |
306586b1 SD |
89 | } |
90 | ||
91 | /** | |
92 | * Perform post-test clean-up. | |
93 | */ | |
94 | @After | |
95 | public void tearDown() { | |
96 | if (fixture != null) { | |
97 | fixture.dispose(); | |
98 | } | |
99 | } | |
100 | ||
101 | // ------------------------------------------------------------------------ | |
102 | // Tests cases | |
103 | // ------------------------------------------------------------------------ | |
104 | ||
105 | /** | |
106 | * Test one background request | |
107 | */ | |
108 | @Test | |
109 | public void backgroundRequest() { | |
110 | BackgroundRequest background = new BackgroundRequest(TmfTimeRange.ETERNITY); | |
111 | fixture.sendRequest(background); | |
112 | try { | |
113 | background.waitForCompletion(); | |
114 | } catch (InterruptedException e) { | |
115 | fail(); | |
116 | } | |
117 | assertEquals(NB_EVENTS_TRACE, background.getNbEvents()); | |
118 | } | |
119 | ||
120 | /** | |
121 | * Test one foreground request | |
122 | */ | |
123 | @Test | |
124 | public void foregroundRequest() { | |
125 | ForegroundRequest foreground = new ForegroundRequest(TmfTimeRange.ETERNITY); | |
126 | fixture.sendRequest(foreground); | |
127 | try { | |
128 | foreground.waitForCompletion(); | |
129 | } catch (InterruptedException e) { | |
130 | fail(); | |
131 | } | |
132 | assertEquals(NB_EVENTS_TRACE, foreground.getNbEvents()); | |
133 | } | |
134 | ||
135 | /** | |
136 | * Test one foreground and one background request for the entire trace at | |
137 | * the same time | |
138 | */ | |
139 | @Test | |
140 | public void TestMultiRequest1() { | |
141 | BackgroundRequest background = new BackgroundRequest(TmfTimeRange.ETERNITY); | |
142 | ForegroundRequest foreground = new ForegroundRequest(TmfTimeRange.ETERNITY); | |
143 | ||
144 | fixture.sendRequest(background); | |
145 | fixture.sendRequest(foreground); | |
146 | try { | |
147 | background.waitForCompletion(); | |
148 | foreground.waitForCompletion(); | |
149 | } catch (InterruptedException e) { | |
150 | fail(); | |
151 | } | |
152 | ||
153 | assertEquals(NB_EVENTS_TRACE, background.getNbEvents()); | |
154 | assertEquals(NB_EVENTS_TRACE, foreground.getNbEvents()); | |
155 | } | |
156 | ||
157 | /** | |
158 | * Test one background request for the entire trace and one foreground | |
159 | * request for smaller time range | |
160 | */ | |
161 | @Test | |
162 | public void TestMultiRequest2() { | |
163 | BackgroundRequest background2 = new BackgroundRequest(TmfTimeRange.ETERNITY); | |
164 | ForegroundRequest foreground2 = new ForegroundRequest(fForegroundTimeRange); | |
165 | ||
166 | fixture.sendRequest(background2); | |
167 | fixture.sendRequest(foreground2); | |
168 | try { | |
169 | background2.waitForCompletion(); | |
170 | foreground2.waitForCompletion(); | |
171 | } catch (InterruptedException e) { | |
172 | fail(); | |
173 | } | |
174 | ||
175 | assertEquals(NB_EVENTS_TRACE, background2.getNbEvents()); | |
176 | assertEquals(NB_EVENTS_TIME_RANGE, foreground2.getNbEvents()); | |
177 | } | |
178 | ||
179 | /** | |
180 | * Test two foreground request, one to select a time range and one to select | |
181 | * an event in this time range | |
182 | */ | |
183 | @Test | |
184 | public void TestMultiRequest3() { | |
185 | ForegroundRequest foreground3 = new ForegroundRequest(TmfTimeRange.ETERNITY); | |
186 | fixture.sendRequest(foreground3); | |
187 | ||
97c71024 | 188 | TmfSelectionRangeUpdatedSignal signal3 = new TmfSelectionRangeUpdatedSignal(this, new TmfTimestamp(fForegroundTimeRange.getStartTime())); |
306586b1 SD |
189 | fixture.broadcast(signal3); |
190 | ||
191 | try { | |
192 | foreground3.waitForCompletion(); | |
193 | } catch (InterruptedException e) { | |
194 | fail(); | |
195 | } | |
196 | ||
197 | assertEquals(NB_EVENTS_TRACE, foreground3.getNbEvents()); | |
198 | } | |
199 | ||
200 | /** | |
201 | * Test two foreground request, one to select a time range and one to select | |
202 | * an event before this time range | |
203 | */ | |
204 | @Test | |
205 | public void TestMultiRequest4() { | |
206 | ForegroundRequest foreground4 = new ForegroundRequest(fForegroundTimeRange); | |
207 | fixture.sendRequest(foreground4); | |
97c71024 | 208 | TmfSelectionRangeUpdatedSignal signal4 = new TmfSelectionRangeUpdatedSignal(this, new TmfTimestamp(fStartTime + ((fEndTime - fStartTime) / 8))); |
306586b1 SD |
209 | fixture.broadcast(signal4); |
210 | ||
211 | try { | |
212 | foreground4.waitForCompletion(); | |
213 | } catch (InterruptedException e) { | |
214 | fail(); | |
215 | } | |
216 | ||
217 | assertEquals(NB_EVENTS_TIME_RANGE, foreground4.getNbEvents()); | |
218 | } | |
219 | ||
220 | /** | |
221 | * Test two foreground request, one to select a time range and one to select | |
222 | * an event after this time range | |
223 | */ | |
224 | @Test | |
225 | public void TestMultiRequest5() { | |
226 | ForegroundRequest foreground5 = new ForegroundRequest(fForegroundTimeRange); | |
227 | fixture.sendRequest(foreground5); | |
97c71024 | 228 | TmfSelectionRangeUpdatedSignal signal5 = new TmfSelectionRangeUpdatedSignal(this, new TmfTimestamp(fEndTime - ((fEndTime - fStartTime) / 4))); |
306586b1 SD |
229 | fixture.broadcast(signal5); |
230 | ||
231 | try { | |
232 | foreground5.waitForCompletion(); | |
233 | } catch (InterruptedException e) { | |
234 | fail(); | |
235 | } | |
236 | ||
237 | assertEquals(NB_EVENTS_TIME_RANGE, foreground5.getNbEvents()); | |
238 | } | |
239 | ||
240 | /** | |
241 | * Test one background and one foreground request for the entire trace and | |
242 | * one foreground request to select an event | |
243 | */ | |
244 | @Test | |
245 | public void TestMultiRequest6() { | |
246 | BackgroundRequest background6 = new BackgroundRequest(TmfTimeRange.ETERNITY); | |
247 | ForegroundRequest foreground6 = new ForegroundRequest(TmfTimeRange.ETERNITY); | |
248 | ||
249 | fixture.sendRequest(background6); | |
250 | fixture.sendRequest(foreground6); | |
251 | ||
97c71024 | 252 | TmfSelectionRangeUpdatedSignal signal6 = new TmfSelectionRangeUpdatedSignal(this, new TmfTimestamp(fStartTime + ((fEndTime - fStartTime) / 8))); |
306586b1 SD |
253 | fixture.broadcast(signal6); |
254 | ||
255 | try { | |
256 | background6.waitForCompletion(); | |
257 | foreground6.waitForCompletion(); | |
258 | } catch (InterruptedException e) { | |
259 | fail(); | |
260 | } | |
261 | ||
262 | assertEquals(NB_EVENTS_TRACE, background6.getNbEvents()); | |
263 | assertEquals(NB_EVENTS_TRACE, foreground6.getNbEvents()); | |
264 | } | |
265 | ||
266 | /** | |
267 | * Four request, two foreground and two background | |
268 | */ | |
269 | @Test | |
270 | public void TestMultiRequest7() { | |
271 | ForegroundRequest foreground7 = new ForegroundRequest(TmfTimeRange.ETERNITY); | |
272 | ForegroundRequest foreground8 = new ForegroundRequest(fForegroundTimeRange); | |
273 | BackgroundRequest background7 = new BackgroundRequest(TmfTimeRange.ETERNITY); | |
274 | BackgroundRequest background8 = new BackgroundRequest(TmfTimeRange.ETERNITY); | |
275 | fixture.sendRequest(foreground7); | |
276 | fixture.sendRequest(foreground8); | |
277 | fixture.sendRequest(background7); | |
278 | fixture.sendRequest(background8); | |
279 | try { | |
280 | foreground7.waitForCompletion(); | |
281 | foreground8.waitForCompletion(); | |
282 | background7.waitForCompletion(); | |
283 | background8.waitForCompletion(); | |
284 | } catch (InterruptedException e) { | |
285 | fail(); | |
286 | } | |
287 | assertEquals(NB_EVENTS_TRACE, foreground7.getNbEvents()); | |
288 | assertEquals(NB_EVENTS_TIME_RANGE, foreground8.getNbEvents()); | |
289 | assertEquals(NB_EVENTS_TRACE, background7.getNbEvents()); | |
290 | assertEquals(NB_EVENTS_TRACE, background8.getNbEvents()); | |
291 | } | |
292 | ||
293 | /** | |
294 | * One long foreground request and one short foreground request, the short | |
295 | * one should finish first | |
296 | */ | |
297 | @Test | |
298 | public void preemptedForegroundRequest() { | |
299 | ForegroundRequest foreground9 = new ForegroundRequest(TmfTimeRange.ETERNITY); | |
065cc19b AM |
300 | TmfTimeRange shortTimeRange = new TmfTimeRange(new TmfTimestamp(fStartTime, ITmfTimestamp.NANOSECOND_SCALE), |
301 | new TmfTimestamp(fStartTime + ((fEndTime - fStartTime) / 16), ITmfTimestamp.NANOSECOND_SCALE)); | |
306586b1 SD |
302 | ForegroundRequest shortForeground = new ForegroundRequest(shortTimeRange); |
303 | fixture.sendRequest(foreground9); | |
8967c8c0 BH |
304 | try { |
305 | foreground9.waitForStart(); | |
306 | } catch (InterruptedException e) { | |
307 | fail(); | |
308 | } | |
306586b1 SD |
309 | fixture.sendRequest(shortForeground); |
310 | try { | |
311 | shortForeground.waitForCompletion(); | |
312 | } catch (InterruptedException e) { | |
313 | fail(); | |
314 | } | |
315 | assertFalse(foreground9.isCompleted()); | |
316 | } | |
317 | ||
318 | /** | |
319 | * One long background request and one short foreground request, the | |
320 | * foreground request should finish first | |
321 | */ | |
322 | @Test | |
323 | public void preemptedBackgroundRequest() { | |
324 | BackgroundRequest background9 = new BackgroundRequest(TmfTimeRange.ETERNITY); | |
325 | ForegroundRequest foreground10 = new ForegroundRequest(fForegroundTimeRange); | |
326 | fixture.sendRequest(background9); | |
327 | fixture.sendRequest(foreground10); | |
328 | try { | |
329 | foreground10.waitForCompletion(); | |
330 | } catch (InterruptedException e) { | |
331 | fail(); | |
332 | } | |
333 | assertTrue(foreground10.isCompleted()); | |
334 | assertFalse(background9.isCompleted()); | |
335 | } | |
336 | ||
337 | /** | |
338 | * Test if the scheduler is working as expected | |
339 | */ | |
b1b999ea | 340 | @Ignore |
306586b1 SD |
341 | @Test |
342 | public void executionOrder() { | |
ccf2bbb4 | 343 | List<String> expectedOrder = new LinkedList<>(); |
306586b1 SD |
344 | expectedOrder.add("FOREGROUND1"); |
345 | expectedOrder.add("FOREGROUND2"); | |
346 | expectedOrder.add("FOREGROUND3"); | |
347 | expectedOrder.add("FOREGROUND4"); | |
348 | expectedOrder.add("BACKGROUND1"); | |
349 | expectedOrder.add("FOREGROUND1"); | |
350 | expectedOrder.add("FOREGROUND2"); | |
351 | expectedOrder.add("FOREGROUND3"); | |
352 | expectedOrder.add("FOREGROUND4"); | |
353 | expectedOrder.add("BACKGROUND2"); | |
354 | ||
355 | fOrderList.clear(); | |
356 | fForegroundId = 0; | |
357 | fBackgroundId = 0; | |
358 | ||
359 | BackgroundRequest background1 = new BackgroundRequest(TmfTimeRange.ETERNITY); | |
360 | BackgroundRequest background2 = new BackgroundRequest(TmfTimeRange.ETERNITY); | |
361 | ||
362 | ForegroundRequest foreground1 = new ForegroundRequest(TmfTimeRange.ETERNITY); | |
363 | ForegroundRequest foreground2 = new ForegroundRequest(TmfTimeRange.ETERNITY); | |
364 | ForegroundRequest foreground3 = new ForegroundRequest(TmfTimeRange.ETERNITY); | |
365 | ForegroundRequest foreground4 = new ForegroundRequest(TmfTimeRange.ETERNITY); | |
366 | ||
367 | fixture.sendRequest(foreground1); | |
368 | fixture.sendRequest(foreground2); | |
369 | fixture.sendRequest(foreground3); | |
370 | fixture.sendRequest(foreground4); | |
371 | fixture.sendRequest(background1); | |
372 | fixture.sendRequest(background2); | |
373 | try { | |
374 | foreground1.waitForCompletion(); | |
375 | foreground2.waitForCompletion(); | |
376 | foreground3.waitForCompletion(); | |
377 | foreground4.waitForCompletion(); | |
378 | background1.waitForCompletion(); | |
379 | background2.waitForCompletion(); | |
380 | } catch (InterruptedException e) { | |
381 | fail(); | |
382 | } | |
383 | assertEquals(expectedOrder, fOrderList.subList(0, expectedOrder.size())); | |
384 | } | |
385 | ||
386 | // ------------------------------------------------------------------------ | |
387 | // Helper methods | |
388 | // ------------------------------------------------------------------------ | |
389 | ||
390 | private class BackgroundRequest extends TmfEventRequest { | |
306586b1 SD |
391 | private int nbEvents = 0; |
392 | private String backgroundName; | |
393 | ||
394 | BackgroundRequest(TmfTimeRange timeRange) { | |
7184fc40 AM |
395 | super(fixture.getEventType(), |
396 | timeRange, | |
397 | 0, | |
2740e05c | 398 | ITmfEventRequest.ALL_DATA, |
306586b1 SD |
399 | ExecutionType.BACKGROUND); |
400 | backgroundName = getExecType().toString() + ++fBackgroundId; | |
401 | } | |
402 | ||
403 | @Override | |
404 | public void handleData(final ITmfEvent event) { | |
405 | super.handleData(event); | |
ab346a2b BH |
406 | synchronized (fOrderList) { |
407 | if (fOrderList.isEmpty() || !fOrderList.get(fOrderList.size() - 1).equals(backgroundName)) { | |
408 | fOrderList.add(backgroundName); | |
409 | } | |
306586b1 SD |
410 | } |
411 | ++nbEvents; | |
412 | } | |
413 | ||
414 | public int getNbEvents() { | |
415 | return nbEvents; | |
416 | } | |
417 | } | |
418 | ||
419 | private class ForegroundRequest extends TmfEventRequest { | |
306586b1 SD |
420 | private int nbEvents = 0; |
421 | private String foregroundName; | |
422 | ||
423 | ForegroundRequest(TmfTimeRange timeRange) { | |
7184fc40 AM |
424 | super(fixture.getEventType(), |
425 | timeRange, | |
426 | 0, | |
2740e05c | 427 | ITmfEventRequest.ALL_DATA, |
306586b1 SD |
428 | ExecutionType.FOREGROUND); |
429 | foregroundName = getExecType().toString() + ++fForegroundId; | |
430 | } | |
431 | ||
432 | @Override | |
433 | public void handleData(final ITmfEvent event) { | |
434 | super.handleData(event); | |
ab346a2b BH |
435 | synchronized (fOrderList) { |
436 | if (fOrderList.isEmpty() || !fOrderList.get(fOrderList.size() - 1).equals(foregroundName)) { | |
437 | fOrderList.add(foregroundName); | |
438 | } | |
306586b1 SD |
439 | } |
440 | ++nbEvents; | |
441 | } | |
442 | ||
443 | public int getNbEvents() { | |
444 | return nbEvents; | |
445 | } | |
446 | } | |
9d63098b | 447 | } |