1 /*******************************************************************************
2 * Copyright (c) 2014, 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 *******************************************************************************/
13 package org
.eclipse
.tracecompass
.lttng2
.ust
.core
.tests
.callstack
;
15 import static org
.eclipse
.tracecompass
.common
.core
.NonNullUtils
.checkNotNull
;
16 import static org
.junit
.Assert
.assertEquals
;
17 import static org
.junit
.Assert
.assertFalse
;
18 import static org
.junit
.Assert
.assertNotNull
;
19 import static org
.junit
.Assert
.assertTrue
;
20 import static org
.junit
.Assert
.fail
;
23 import java
.util
.List
;
24 import java
.util
.concurrent
.TimeUnit
;
26 import org
.eclipse
.jdt
.annotation
.NonNull
;
27 import org
.eclipse
.tracecompass
.internal
.lttng2
.ust
.core
.callstack
.LttngUstCallStackProvider
;
28 import org
.eclipse
.tracecompass
.statesystem
.core
.ITmfStateSystem
;
29 import org
.eclipse
.tracecompass
.statesystem
.core
.StateSystemUtils
;
30 import org
.eclipse
.tracecompass
.statesystem
.core
.exceptions
.AttributeNotFoundException
;
31 import org
.eclipse
.tracecompass
.statesystem
.core
.exceptions
.StateSystemDisposedException
;
32 import org
.eclipse
.tracecompass
.statesystem
.core
.interval
.ITmfStateInterval
;
33 import org
.eclipse
.tracecompass
.statesystem
.core
.statevalue
.ITmfStateValue
;
34 import org
.eclipse
.tracecompass
.testtraces
.ctf
.CtfTestTrace
;
35 import org
.eclipse
.tracecompass
.tmf
.core
.exceptions
.TmfAnalysisException
;
36 import org
.eclipse
.tracecompass
.tmf
.core
.statesystem
.ITmfStateProvider
;
37 import org
.eclipse
.tracecompass
.tmf
.core
.statesystem
.TmfStateSystemAnalysisModule
;
38 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.TmfTraceManager
;
39 import org
.eclipse
.tracecompass
.tmf
.ctf
.core
.tests
.shared
.CtfTmfTestTraceUtils
;
40 import org
.eclipse
.tracecompass
.tmf
.ctf
.core
.trace
.CtfTmfTrace
;
41 import org
.junit
.After
;
42 import org
.junit
.Before
;
43 import org
.junit
.Rule
;
44 import org
.junit
.Test
;
45 import org
.junit
.rules
.TestRule
;
46 import org
.junit
.rules
.Timeout
;
49 * Base class for the UST callstack state provider tests.
51 * @author Alexandre Montplaisir
53 public abstract class AbstractProviderTest
{
55 /** Time-out tests after 20 seconds */
56 @Rule public TestRule globalTimeout
= new Timeout(20, TimeUnit
.SECONDS
);
58 // ------------------------------------------------------------------------
60 // ------------------------------------------------------------------------
62 private static final @NonNull CtfTestTrace otherUstTrace
= CtfTestTrace
.HELLO_LOST
;
64 private CtfTmfTrace fTrace
= null;
65 private ITmfStateSystem fSS
= null;
66 private TestLttngCallStackModule fModule
;
69 // ------------------------------------------------------------------------
71 // ------------------------------------------------------------------------
74 * @return The test trace to use for this test
76 protected abstract @NonNull CtfTestTrace
getTestTrace();
79 * @return The name of the executable process in that particular trace
81 protected abstract String
getProcName();
84 * Get the list of timestamps to query in that trace.
87 * Which of the test timestamps?
88 * @return That particular timestamp
90 protected abstract long getTestTimestamp(int index
);
92 // ------------------------------------------------------------------------
94 // ------------------------------------------------------------------------
97 * Perform pre-class initialization.
100 public void setUp() {
101 CtfTestTrace testTrace
= getTestTrace();
103 CtfTmfTrace trace
= CtfTmfTestTraceUtils
.getTrace(testTrace
);
105 fModule
= new TestLttngCallStackModule();
107 assertTrue(fModule
.setTrace(trace
));
108 } catch (TmfAnalysisException e
) {
112 assertTrue(fModule
.waitForCompletion());
114 fSS
= fModule
.getStateSystem();
119 * Perform post-class clean-up.
122 public void tearDown() {
124 if (fTrace
!= null) {
126 File suppDir
= new File(TmfTraceManager
.getSupplementaryFileDir(fTrace
));
127 deleteDirectory(suppDir
);
131 // ------------------------------------------------------------------------
133 // ------------------------------------------------------------------------
136 * Test the handling of generic UST traces who do not contain the required
140 public void testOtherUstTrace() {
141 /* Initialize the trace and analysis module */
143 CtfTmfTrace ustTrace
= CtfTmfTestTraceUtils
.getTrace(otherUstTrace
);
144 TestLttngCallStackModule module
= null;
146 module
= new TestLttngCallStackModule();
148 assertTrue(module
.setTrace(ustTrace
));
149 } catch (TmfAnalysisException e
) {
153 assertTrue(module
.waitForCompletion());
155 /* Make sure the generated state system exists, but is empty */
156 ITmfStateSystem ss
= module
.getStateSystem();
158 assertTrue(ss
.getStartTime() >= ustTrace
.getStartTime().toNanos());
159 assertEquals(0, ss
.getNbAttributes());
161 if (module
!= null) {
165 suppDir
= new File(TmfTraceManager
.getSupplementaryFileDir(ustTrace
));
168 deleteDirectory(suppDir
);
169 assertFalse(suppDir
.exists());
173 * Test that the callstack state system is there and contains data.
176 public void testConstruction() {
178 assertTrue(fSS
.getNbAttributes() > 0);
182 * Test the callstack at the beginning of the state system.
185 public void testCallStackBegin() {
186 long start
= fSS
.getStartTime();
187 String
[] cs
= getCallStack(fSS
, getProcName(), start
);
188 assertEquals(1, cs
.length
);
190 assertEquals("40472b", cs
[0]);
194 * Test the callstack somewhere in the trace.
197 public void testCallStack1() {
198 String
[] cs
= getCallStack(fSS
, getProcName(), getTestTimestamp(0));
199 assertEquals(2, cs
.length
);
201 assertEquals("40472b", cs
[0]);
202 assertEquals("403d60", cs
[1]);
206 * Test the callstack somewhere in the trace.
209 public void testCallStack2() {
210 String
[] cs
= getCallStack(fSS
, getProcName(), getTestTimestamp(1));
211 assertEquals(3, cs
.length
);
213 assertEquals("40472b", cs
[0]);
214 assertEquals("403b14", cs
[1]);
215 assertEquals("401b23", cs
[2]);
219 * Test the callstack somewhere in the trace.
222 public void testCallStack3() {
223 String
[] cs
= getCallStack(fSS
, getProcName(), getTestTimestamp(2));
224 assertEquals(4, cs
.length
);
226 assertEquals("40472b", cs
[0]);
227 assertEquals("4045c8", cs
[1]);
228 assertEquals("403760", cs
[2]);
229 assertEquals("401aac", cs
[3]);
233 * Test the callstack at the end of the trace/state system.
236 public void testCallStackEnd() {
237 long end
= fSS
.getCurrentEndTime();
238 String
[] cs
= getCallStack(fSS
, getProcName(), end
);
239 assertEquals(3, cs
.length
);
241 assertEquals("40472b", cs
[0]);
242 assertEquals("4045c8", cs
[1]);
243 assertEquals("403760", cs
[2]);
246 // ------------------------------------------------------------------------
248 // ------------------------------------------------------------------------
250 /** Empty and delete a directory */
251 private static void deleteDirectory(File dir
) {
252 /* Assuming the dir only contains file or empty directories */
253 for (File file
: dir
.listFiles()) {
259 /** Get the callstack for the given timestamp, for this particular trace */
260 private static String
[] getCallStack(ITmfStateSystem ss
, String processName
, long timestamp
) {
262 int stackAttribute
= ss
.getQuarkAbsolute("Threads", processName
, "CallStack");
263 List
<ITmfStateInterval
> state
= ss
.queryFullState(timestamp
);
264 int depth
= state
.get(stackAttribute
).getStateValue().unboxInt();
266 int stackTop
= ss
.getQuarkRelative(stackAttribute
, String
.valueOf(depth
));
267 ITmfStateValue expectedValue
= state
.get(stackTop
).getStateValue();
268 ITmfStateInterval interval
= StateSystemUtils
.querySingleStackTop(ss
, timestamp
, stackAttribute
);
269 assertNotNull(interval
);
270 assertEquals(expectedValue
, interval
.getStateValue());
272 String
[] ret
= new String
[depth
];
273 for (int i
= 0; i
< depth
; i
++) {
274 int quark
= ss
.getQuarkRelative(stackAttribute
, String
.valueOf(i
+ 1));
275 ret
[i
] = state
.get(quark
).getStateValue().unboxStr();
279 } catch (AttributeNotFoundException e
) {
280 fail(e
.getMessage());
281 } catch (StateSystemDisposedException e
) {
282 fail(e
.getMessage());
288 private class TestLttngCallStackModule
extends TmfStateSystemAnalysisModule
{
291 protected ITmfStateProvider
createStateProvider() {
292 return new LttngUstCallStackProvider(checkNotNull(getTrace()));