1 /*******************************************************************************
2 * Copyright (c) 2014, 2015 École Polytechnique de Montréal
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 * Geneviève Bastien - Initial API and implementation
11 *******************************************************************************/
13 package org
.eclipse
.tracecompass
.analysis
.os
.linux
.core
.tests
.kernelanalysis
;
15 import static org
.eclipse
.tracecompass
.common
.core
.NonNullUtils
.checkNotNull
;
16 import static org
.junit
.Assert
.assertEquals
;
17 import static org
.junit
.Assert
.assertNotNull
;
18 import static org
.junit
.Assert
.assertNull
;
19 import static org
.junit
.Assert
.assertTrue
;
20 import static org
.junit
.Assert
.fail
;
23 import java
.util
.Collection
;
24 import java
.util
.List
;
26 import org
.eclipse
.core
.runtime
.IPath
;
27 import org
.eclipse
.core
.runtime
.IProgressMonitor
;
28 import org
.eclipse
.core
.runtime
.IStatus
;
29 import org
.eclipse
.core
.runtime
.NullProgressMonitor
;
30 import org
.eclipse
.jdt
.annotation
.NonNull
;
31 import org
.eclipse
.tracecompass
.analysis
.os
.linux
.core
.kernelanalysis
.KernelAnalysisModule
;
32 import org
.eclipse
.tracecompass
.analysis
.os
.linux
.core
.kernelanalysis
.KernelThreadInformationProvider
;
33 import org
.eclipse
.tracecompass
.analysis
.os
.linux
.core
.kernelanalysis
.StateValues
;
34 import org
.eclipse
.tracecompass
.analysis
.os
.linux
.core
.tests
.Activator
;
35 import org
.eclipse
.tracecompass
.statesystem
.core
.interval
.ITmfStateInterval
;
36 import org
.eclipse
.tracecompass
.statesystem
.core
.statevalue
.ITmfStateValue
;
37 import org
.eclipse
.tracecompass
.statesystem
.core
.statevalue
.TmfStateValue
;
38 import org
.eclipse
.tracecompass
.tmf
.core
.analysis
.IAnalysisModule
;
39 import org
.eclipse
.tracecompass
.tmf
.core
.event
.TmfEvent
;
40 import org
.eclipse
.tracecompass
.tmf
.core
.exceptions
.TmfTraceException
;
41 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfTraceOpenedSignal
;
42 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.ITmfTrace
;
43 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.TmfTrace
;
44 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.TmfTraceManager
;
45 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.TmfTraceUtils
;
46 import org
.eclipse
.tracecompass
.tmf
.tests
.stubs
.trace
.xml
.TmfXmlTraceStub
;
47 import org
.junit
.After
;
48 import org
.junit
.Before
;
49 import org
.junit
.Test
;
51 import com
.google
.common
.collect
.ImmutableSet
;
54 * Test analysis-specific methods for the {@link KernelAnalysisModule} class.
56 * @author Geneviève Bastien
58 public class KernelThreadInformationProviderTest
{
60 private static final @NonNull String LTTNG_KERNEL_FILE
= "testfiles/lttng_kernel_analysis.xml";
62 private ITmfTrace fTrace
;
63 private KernelAnalysisModule fModule
;
65 private static void deleteSuppFiles(ITmfTrace trace
) {
66 /* Remove supplementary files */
67 File suppDir
= new File(TmfTraceManager
.getSupplementaryFileDir(trace
));
68 for (File file
: suppDir
.listFiles()) {
74 * Setup the trace for the tests
78 ITmfTrace trace
= new TmfXmlTraceStub();
79 IPath filePath
= Activator
.getAbsoluteFilePath(LTTNG_KERNEL_FILE
);
80 IStatus status
= trace
.validate(null, filePath
.toOSString());
82 fail(status
.getException().getMessage());
85 trace
.initTrace(null, filePath
.toOSString(), TmfEvent
.class);
86 } catch (TmfTraceException e
) {
89 deleteSuppFiles(trace
);
90 ((TmfTrace
) trace
).traceOpened(new TmfTraceOpenedSignal(this, trace
, null));
91 IAnalysisModule module
= null;
92 for (IAnalysisModule mod
: TmfTraceUtils
.getAnalysisModulesOfClass(trace
, KernelAnalysisModule
.class)) {
95 assertNotNull(module
);
97 module
.waitForCompletion();
98 fModule
= TmfTraceUtils
.getAnalysisModuleOfClass(trace
, KernelAnalysisModule
.class, KernelAnalysisModule
.ID
);
106 public void tearDown() {
107 deleteSuppFiles(fTrace
);
113 * {@link KernelThreadInformationProvider#getThreadIds(KernelAnalysisModule)}
117 public void testGetThreadQuarks() {
118 KernelAnalysisModule module
= checkNotNull(fModule
);
119 Collection
<Integer
> threadIds
= KernelThreadInformationProvider
.getThreadIds(module
);
120 assertEquals(ImmutableSet
.<Integer
>of(10,11,20,21,30,100), threadIds
);
125 * {@link KernelThreadInformationProvider#getThreadOnCpu(KernelAnalysisModule, long, long)}
129 public void testGetThreadOnCpu() {
130 KernelAnalysisModule module
= checkNotNull(fModule
);
132 /* Check with invalid timestamps */
133 Integer tid
= KernelThreadInformationProvider
.getThreadOnCpu(module
, 0, -1);
136 tid
= KernelThreadInformationProvider
.getThreadOnCpu(module
, 0, 80);
139 /* Check with invalid cpus */
140 tid
= KernelThreadInformationProvider
.getThreadOnCpu(module
, 2, 20);
143 tid
= KernelThreadInformationProvider
.getThreadOnCpu(module
, -1, 20);
146 /* Check valid values */
147 tid
= KernelThreadInformationProvider
.getThreadOnCpu(module
, 0, 4);
150 tid
= KernelThreadInformationProvider
.getThreadOnCpu(module
, 0, 15);
153 tid
= KernelThreadInformationProvider
.getThreadOnCpu(module
, 1, 15);
154 assertEquals(Integer
.valueOf(11), tid
);
156 tid
= KernelThreadInformationProvider
.getThreadOnCpu(module
, 1, 29);
157 assertEquals(Integer
.valueOf(20), tid
);
159 tid
= KernelThreadInformationProvider
.getThreadOnCpu(module
, 1, 30);
160 assertEquals(Integer
.valueOf(21), tid
);
162 tid
= KernelThreadInformationProvider
.getThreadOnCpu(module
, 0, 59);
163 assertEquals(Integer
.valueOf(11), tid
);
165 tid
= KernelThreadInformationProvider
.getThreadOnCpu(module
, 1, 59);
166 assertEquals(Integer
.valueOf(30), tid
);
168 tid
= KernelThreadInformationProvider
.getThreadOnCpu(module
, 0, 60);
169 assertEquals(Integer
.valueOf(11), tid
);
171 tid
= KernelThreadInformationProvider
.getThreadOnCpu(module
, 1, 60);
172 assertEquals(Integer
.valueOf(21), tid
);
178 * {@link KernelThreadInformationProvider#getParentPid(KernelAnalysisModule, Integer, long)}
182 public void testGetPpid() {
183 KernelAnalysisModule module
= checkNotNull(fModule
);
185 /* Check with invalid timestamps */
186 Integer ppid
= KernelThreadInformationProvider
.getParentPid(module
, 11, -1);
189 ppid
= KernelThreadInformationProvider
.getParentPid(module
, 11, 80);
192 /* Check with invalid cpus */
193 ppid
= KernelThreadInformationProvider
.getParentPid(module
, -4, 20);
196 ppid
= KernelThreadInformationProvider
.getParentPid(module
, 12, 20);
199 /* Check values with no parent */
200 ppid
= KernelThreadInformationProvider
.getParentPid(module
, 10, 20);
201 assertEquals(Integer
.valueOf(0), ppid
);
203 ppid
= KernelThreadInformationProvider
.getParentPid(module
, 30, 60);
204 assertEquals(Integer
.valueOf(0), ppid
);
206 /* Check parent determined at statedump */
207 ppid
= KernelThreadInformationProvider
.getParentPid(module
, 11, 4);
210 ppid
= KernelThreadInformationProvider
.getParentPid(module
, 11, 5);
211 assertEquals(Integer
.valueOf(10), ppid
);
213 /* Check parent after process fork */
214 ppid
= KernelThreadInformationProvider
.getParentPid(module
, 21, 25);
215 assertEquals(Integer
.valueOf(20), ppid
);
217 ppid
= KernelThreadInformationProvider
.getParentPid(module
, 21, 70);
218 assertEquals(Integer
.valueOf(20), ppid
);
223 * Test the {@link KernelThreadInformationProvider#getExecutableName(KernelAnalysisModule, Integer)} method
226 public void testGetExecutableName() {
227 KernelAnalysisModule module
= checkNotNull(fModule
);
229 /* Check with invalid threads */
230 String execName
= KernelThreadInformationProvider
.getExecutableName(module
, 101);
231 assertNull(execName
);
233 execName
= KernelThreadInformationProvider
.getExecutableName(module
, -2);
234 assertNull(execName
);
236 /* Check valid value */
237 execName
= KernelThreadInformationProvider
.getExecutableName(module
, 20);
238 assertEquals("proc20", execName
);
240 /* Check valid value with process name change in history */
241 execName
= KernelThreadInformationProvider
.getExecutableName(module
, 21);
242 assertEquals("proc21", execName
);
246 private static void testIntervals(String info
, List
<ITmfStateInterval
> intervals
, ITmfStateValue
[] values
) {
247 assertEquals(info
+ " interval count", values
.length
, intervals
.size());
248 for (int i
= 0; i
< values
.length
; i
++) {
249 assertEquals(info
+ " interval " + i
, values
[i
], intervals
.get(i
).getStateValue());
255 * {@link KernelThreadInformationProvider#getStatusIntervalsForThread(KernelAnalysisModule, Integer, long, long, long, IProgressMonitor)}
259 public void testGetStatusIntervalsForThread() {
260 KernelAnalysisModule module
= checkNotNull(fModule
);
262 IProgressMonitor monitor
= new NullProgressMonitor();
263 Integer process21
= 21;
264 Integer process20
= 20;
266 /* Check invalid time ranges */
267 List
<ITmfStateInterval
> intervals
= KernelThreadInformationProvider
.getStatusIntervalsForThread(module
, process21
, -15, -5, 3, monitor
);
268 assertTrue(intervals
.isEmpty());
270 intervals
= KernelThreadInformationProvider
.getStatusIntervalsForThread(module
, process21
, 80, 1500000000L, 50, monitor
);
271 assertTrue(intervals
.isEmpty());
273 /* Check invalid quarks */
274 intervals
= KernelThreadInformationProvider
.getStatusIntervalsForThread(module
, -1, 0, 70L, 3, monitor
);
275 assertTrue(intervals
.isEmpty());
277 intervals
= KernelThreadInformationProvider
.getStatusIntervalsForThread(module
, 0, 0, 70L, 3, monitor
);
278 assertTrue(intervals
.isEmpty());
280 /* Check different time ranges and resolutions */
281 ITmfStateValue
[] values
= { TmfStateValue
.nullValue(), StateValues
.PROCESS_STATUS_WAIT_FOR_CPU_VALUE
,
282 StateValues
.PROCESS_STATUS_RUN_SYSCALL_VALUE
, StateValues
.PROCESS_STATUS_WAIT_FOR_CPU_VALUE
,
283 StateValues
.PROCESS_STATUS_RUN_SYSCALL_VALUE
};
284 intervals
= KernelThreadInformationProvider
.getStatusIntervalsForThread(module
, process21
, 0, 70L, 3, monitor
);
285 testIntervals("tid 21 [0,70,3]", intervals
, values
);
287 ITmfStateValue
[] values2
= { TmfStateValue
.nullValue(), StateValues
.PROCESS_STATUS_RUN_SYSCALL_VALUE
,
288 StateValues
.PROCESS_STATUS_RUN_SYSCALL_VALUE
};
289 intervals
= KernelThreadInformationProvider
.getStatusIntervalsForThread(module
, process21
, 1, 70L, 30, monitor
);
290 testIntervals("tid 21 [0,70,30]", intervals
, values2
);
292 ITmfStateValue
[] values3
= { StateValues
.PROCESS_STATUS_WAIT_FOR_CPU_VALUE
,
293 StateValues
.PROCESS_STATUS_RUN_SYSCALL_VALUE
};
294 intervals
= KernelThreadInformationProvider
.getStatusIntervalsForThread(module
, process21
, 25, 50L, 3, monitor
);
295 testIntervals("tid 21 [25,50,3]", intervals
, values3
);
297 ITmfStateValue
[] values4
= { TmfStateValue
.nullValue(), StateValues
.PROCESS_STATUS_WAIT_UNKNOWN_VALUE
,
298 StateValues
.PROCESS_STATUS_RUN_USERMODE_VALUE
, StateValues
.PROCESS_STATUS_WAIT_FOR_CPU_VALUE
};
299 intervals
= KernelThreadInformationProvider
.getStatusIntervalsForThread(module
, process20
, 0, 70L, 3, monitor
);
300 testIntervals("tid 20 [0,70,3]", intervals
, values4
);
302 ITmfStateValue
[] values5
= { TmfStateValue
.nullValue(), StateValues
.PROCESS_STATUS_WAIT_FOR_CPU_VALUE
};
303 intervals
= KernelThreadInformationProvider
.getStatusIntervalsForThread(module
, process20
, 1, 70L, 30, monitor
);
304 testIntervals("tid 20 [0,70,30]", intervals
, values5
);
306 ITmfStateValue
[] values6
= { StateValues
.PROCESS_STATUS_RUN_USERMODE_VALUE
,
307 StateValues
.PROCESS_STATUS_WAIT_FOR_CPU_VALUE
};
308 intervals
= KernelThreadInformationProvider
.getStatusIntervalsForThread(module
, process20
, 25, 50L, 3, monitor
);
309 testIntervals("tid 20 [25,50,3]", intervals
, values6
);