1 /*******************************************************************************
2 * Copyright (c) 2014 É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 * François Rajotte - Initial API and implementation
11 * Geneviève Bastien - Revision of the initial implementation
12 *******************************************************************************/
14 package org
.eclipse
.tracecompass
.lttng2
.kernel
.core
.analysis
.cpuusage
;
16 import static org
.eclipse
.tracecompass
.common
.core
.NonNullUtils
.checkNotNull
;
18 import java
.util
.HashMap
;
21 import org
.eclipse
.jdt
.annotation
.NonNull
;
22 import org
.eclipse
.tracecompass
.internal
.lttng2
.kernel
.core
.Activator
;
23 import org
.eclipse
.tracecompass
.internal
.lttng2
.kernel
.core
.Attributes
;
24 import org
.eclipse
.tracecompass
.internal
.lttng2
.kernel
.core
.trace
.layout
.IKernelAnalysisEventLayout
;
25 import org
.eclipse
.tracecompass
.statesystem
.core
.ITmfStateSystemBuilder
;
26 import org
.eclipse
.tracecompass
.statesystem
.core
.exceptions
.AttributeNotFoundException
;
27 import org
.eclipse
.tracecompass
.statesystem
.core
.statevalue
.ITmfStateValue
;
28 import org
.eclipse
.tracecompass
.statesystem
.core
.statevalue
.TmfStateValue
;
29 import org
.eclipse
.tracecompass
.tmf
.core
.event
.ITmfEvent
;
30 import org
.eclipse
.tracecompass
.tmf
.core
.event
.ITmfEventField
;
31 import org
.eclipse
.tracecompass
.tmf
.core
.event
.aspect
.TmfCpuAspect
;
32 import org
.eclipse
.tracecompass
.tmf
.core
.statesystem
.AbstractTmfStateProvider
;
33 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.ITmfTrace
;
34 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.TmfTraceUtils
;
37 * Creates a state system with the total time spent on CPU for each thread and
38 * for each CPU from a kernel trace.
40 * This state system in itself keeps the total time on CPU since last time the
41 * process was scheduled out. The state system queries will only be accurate
42 * when the process is not in a running state. To have exact CPU usage when
43 * running, this state system needs to be used along the LTTng Kernel analysis.
45 * It requires only the 'sched_switch' events enabled on the trace.
47 * @author François Rajotte
50 public class LttngKernelCpuUsageStateProvider
extends AbstractTmfStateProvider
{
52 private static final int VERSION
= 2;
54 /* For each CPU, maps the last time a thread was scheduled in */
55 private final Map
<Integer
, Long
> fLastStartTimes
= new HashMap
<>();
56 private final long fTraceStart
;
57 private final @NonNull IKernelAnalysisEventLayout fLayout
;
63 * The trace from which to get the CPU usage
65 * The event layout to use for this state provider.
67 public LttngKernelCpuUsageStateProvider(@NonNull ITmfTrace trace
,
68 @NonNull IKernelAnalysisEventLayout layout
) {
69 super(trace
, ITmfEvent
.class, "LTTng Kernel CPU usage"); //$NON-NLS-1$
70 fTraceStart
= trace
.getStartTime().getValue();
74 // ------------------------------------------------------------------------
76 // ------------------------------------------------------------------------
79 public int getVersion() {
84 public LttngKernelCpuUsageStateProvider
getNewInstance() {
85 return new LttngKernelCpuUsageStateProvider(this.getTrace(), this.fLayout
);
89 protected void eventHandle(ITmfEvent event
) {
90 final ITmfStateSystemBuilder ss
= checkNotNull(getStateSystemBuilder());
91 final String eventName
= event
.getType().getName();
93 if (eventName
.equals(fLayout
.eventSchedSwitch())) {
95 Iterable
<TmfCpuAspect
> aspects
= TmfTraceUtils
.getEventAspectsOfClass(event
.getTrace(), TmfCpuAspect
.class);
96 for (TmfCpuAspect aspect
: aspects
) {
97 if (!aspect
.resolve(event
).equals(TmfCpuAspect
.CPU_UNAVAILABLE
)) {
98 cpu
= aspect
.resolve(event
);
103 /* We couldn't find any CPU information, ignore this event */
108 * Fields: string prev_comm, int32 prev_tid, int32 prev_prio, int64
109 * prev_state, string next_comm, int32 next_tid, int32 next_prio
111 ITmfEventField content
= event
.getContent();
112 long ts
= event
.getTimestamp().getValue();
114 Long prevTid
= (Long
) content
.getField(fLayout
.fieldPrevTid()).getValue();
117 Integer currentCPUNode
= ss
.getQuarkRelativeAndAdd(getNodeCPUs(ss
), cpu
.toString());
120 * This quark contains the value of the cumulative time spent on
121 * the source CPU by the currently running thread
123 Integer cumulativeTimeQuark
= ss
.getQuarkRelativeAndAdd(currentCPUNode
, prevTid
.toString());
124 Long startTime
= fLastStartTimes
.get(cpu
);
126 * If start time is null, we haven't seen the start of the
127 * process, so we assume beginning of the trace
129 if (startTime
== null) {
130 startTime
= fTraceStart
;
134 * We add the time from startTime until now to the cumulative
137 if (startTime
!= null) {
138 ITmfStateValue value
= ss
.queryOngoingState(cumulativeTimeQuark
);
141 * Modify cumulative time for this CPU/TID combo: The total
142 * time changes when the process is scheduled out. Nothing
143 * happens when the process is scheduled in.
145 long prevCumulativeTime
= Math
.max(0, value
.unboxLong());
146 long newCumulativeTime
= prevCumulativeTime
+ (ts
- startTime
);
148 value
= TmfStateValue
.newValueLong(newCumulativeTime
);
149 ss
.modifyAttribute(ts
, value
, cumulativeTimeQuark
);
150 fLastStartTimes
.put(cpu
, ts
);
152 } catch (AttributeNotFoundException e
) {
153 Activator
.getDefault().logError("Attribute not found in LttngKernelCpuStateProvider", e
); //$NON-NLS-1$
159 /* Shortcut for the "current CPU" attribute node */
160 private static int getNodeCPUs(ITmfStateSystemBuilder ssb
) {
161 return ssb
.getQuarkAbsoluteAndAdd(Attributes
.CPUS
);