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
.kernel
;
15 import java
.util
.Collection
;
16 import java
.util
.Collections
;
17 import java
.util
.List
;
19 import java
.util
.TreeSet
;
21 import org
.eclipse
.core
.runtime
.IProgressMonitor
;
22 import org
.eclipse
.jdt
.annotation
.NonNull
;
23 import org
.eclipse
.jdt
.annotation
.Nullable
;
24 import org
.eclipse
.tracecompass
.common
.core
.NonNullUtils
;
25 import org
.eclipse
.tracecompass
.statesystem
.core
.ITmfStateSystem
;
26 import org
.eclipse
.tracecompass
.statesystem
.core
.StateSystemUtils
;
27 import org
.eclipse
.tracecompass
.statesystem
.core
.exceptions
.AttributeNotFoundException
;
28 import org
.eclipse
.tracecompass
.statesystem
.core
.exceptions
.StateSystemDisposedException
;
29 import org
.eclipse
.tracecompass
.statesystem
.core
.exceptions
.TimeRangeException
;
30 import org
.eclipse
.tracecompass
.statesystem
.core
.interval
.ITmfStateInterval
;
31 import org
.eclipse
.tracecompass
.statesystem
.core
.statevalue
.ITmfStateValue
;
34 * Information provider utility class that retrieves thread-related information
35 * from a Linux Kernel Analysis
37 * @author Geneviève Bastien
40 public final class KernelThreadInformationProvider
{
42 private KernelThreadInformationProvider() {
46 * Get the ID of the thread running on the CPU at time ts
48 * TODO: This method may later be replaced by an aspect, when the aspect can
49 * resolve to something that is not an event
52 * The lttng kernel analysis instance to run this method on
54 * The CPU number the process is running on
56 * The timestamp at which we want the running process
57 * @return The TID of the thread running on CPU cpuId at time ts or
58 * {@code null} if either no thread is running or we do not know.
60 public static @Nullable Integer
getThreadOnCpu(KernelAnalysisModule module
, long cpuId
, long ts
) {
61 ITmfStateSystem ss
= module
.getStateSystem();
66 int cpuQuark
= ss
.getQuarkAbsolute(Attributes
.CPUS
, Long
.toString(cpuId
), Attributes
.CURRENT_THREAD
);
67 ITmfStateInterval interval
= ss
.querySingleState(ts
, cpuQuark
);
68 ITmfStateValue val
= interval
.getStateValue();
69 switch (val
.getType()) {
71 return val
.unboxInt();
79 } catch (AttributeNotFoundException
| StateSystemDisposedException
| TimeRangeException e
) {
85 * Get the TIDs of the threads from an analysis
88 * The lttng kernel analysis instance to run this method on
89 * @return The set of TIDs corresponding to the threads
91 public static Collection
<Integer
> getThreadIds(KernelAnalysisModule module
) {
92 ITmfStateSystem ss
= module
.getStateSystem();
94 return Collections
.EMPTY_SET
;
98 threadQuark
= ss
.getQuarkAbsolute(Attributes
.THREADS
);
99 Set
<@NonNull Integer
> tids
= new TreeSet
<>();
100 for (Integer quark
: ss
.getSubAttributes(threadQuark
, false)) {
101 tids
.add(Integer
.parseInt(ss
.getAttributeName(quark
)));
104 } catch (AttributeNotFoundException e
) {
106 return Collections
.EMPTY_SET
;
110 * Get the parent process ID of a thread
113 * The lttng kernel analysis instance to run this method on
115 * The thread ID of the process for which to get the parent
117 * The timestamp at which to get the parent
118 * @return The parent PID or {@code null} if the PPID is not found.
120 public static @Nullable Integer
getParentPid(KernelAnalysisModule module
, Integer threadId
, long ts
) {
122 ITmfStateSystem ss
= module
.getStateSystem();
128 ppidNode
= ss
.getQuarkAbsolute(Attributes
.THREADS
, threadId
.toString(), Attributes
.PPID
);
129 ITmfStateInterval ppidInterval
= ss
.querySingleState(ts
, ppidNode
);
130 ITmfStateValue ppidValue
= ppidInterval
.getStateValue();
132 switch (ppidValue
.getType()) {
134 ppid
= NonNullUtils
.checkNotNull(Integer
.valueOf(ppidValue
.unboxInt()));
143 } catch (AttributeNotFoundException
| StateSystemDisposedException
| TimeRangeException e
) {
149 * Get the executable name of the thread ID. If the thread ID was used
150 * multiple time or the name changed in between, it will return the last
151 * name the thread has taken, or {@code null} if no name is found
154 * The lttng kernel analysis instance to run this method on
156 * The thread ID of the process for which to get the name
157 * @return The last executable name of this process, or {@code null} if not
160 public static @Nullable String
getExecutableName(KernelAnalysisModule module
, Integer threadId
) {
161 String execName
= null;
162 ITmfStateSystem ss
= module
.getStateSystem();
166 Integer execNameNode
;
168 execNameNode
= ss
.getQuarkAbsolute(Attributes
.THREADS
, threadId
.toString(), Attributes
.EXEC_NAME
);
169 List
<ITmfStateInterval
> execNameIntervals
= StateSystemUtils
.queryHistoryRange(ss
, execNameNode
, ss
.getStartTime(), ss
.getCurrentEndTime());
171 ITmfStateValue execNameValue
;
172 for (ITmfStateInterval interval
: execNameIntervals
) {
173 execNameValue
= interval
.getStateValue();
174 switch (execNameValue
.getType()) {
176 execName
= execNameValue
.unboxStr();
186 } catch (AttributeNotFoundException
| StateSystemDisposedException
| TimeRangeException e
) {
192 * Get the status intervals for a given thread with a resolution
195 * The lttng kernel analysis instance to run this method on
197 * The ID of the thread to get the intervals for
199 * The start time of the requested range
201 * The end time of the requested range
203 * The resolution or the minimal time between the requested
204 * intervals. If interval times are smaller than resolution, only
205 * the first interval is returned, the others are ignored.
207 * A progress monitor for this task
208 * @return The list of status intervals for this thread, an empty list is
209 * returned if either the state system is {@code null} or the quark
212 public static List
<ITmfStateInterval
> getStatusIntervalsForThread(KernelAnalysisModule module
, Integer threadId
, long start
, long end
, long resolution
, IProgressMonitor monitor
) {
213 ITmfStateSystem ss
= module
.getStateSystem();
215 return Collections
.EMPTY_LIST
;
219 int threadQuark
= ss
.getQuarkAbsolute(Attributes
.THREADS
, threadId
.toString());
220 int statusQuark
= ss
.getQuarkRelative(threadQuark
, Attributes
.STATUS
);
221 List
<ITmfStateInterval
> statusIntervals
= StateSystemUtils
.queryHistoryRange(ss
, statusQuark
, Math
.max(start
, ss
.getStartTime()), Math
.min(end
- 1, ss
.getCurrentEndTime()), resolution
, monitor
);
222 return statusIntervals
;
223 } catch (AttributeNotFoundException
| StateSystemDisposedException
| TimeRangeException e
) {
225 return Collections
.EMPTY_LIST
;