Commit | Line | Data |
---|---|---|
e693075d | 1 | /******************************************************************************* |
ed902a2b | 2 | * Copyright (c) 2014, 2015 École Polytechnique de Montréal |
e693075d FR |
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 | * François Rajotte - Initial API and implementation | |
11 | * Geneviève Bastien - Revision of the initial implementation | |
12 | *******************************************************************************/ | |
13 | ||
e363eae1 | 14 | package org.eclipse.tracecompass.analysis.os.linux.core.cpuusage; |
e693075d | 15 | |
d0c7e4ba AM |
16 | import static org.eclipse.tracecompass.common.core.NonNullUtils.checkNotNull; |
17 | ||
e693075d FR |
18 | import java.util.HashMap; |
19 | import java.util.Map; | |
20 | ||
e363eae1 AM |
21 | import org.eclipse.jdt.annotation.Nullable; |
22 | import org.eclipse.tracecompass.analysis.os.linux.core.kernelanalysis.Attributes; | |
23 | import org.eclipse.tracecompass.analysis.os.linux.core.trace.IKernelAnalysisEventLayout; | |
24 | import org.eclipse.tracecompass.internal.analysis.os.linux.core.Activator; | |
d0c7e4ba | 25 | import org.eclipse.tracecompass.statesystem.core.ITmfStateSystemBuilder; |
e894a508 AM |
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; | |
2bdf0193 AM |
29 | import org.eclipse.tracecompass.tmf.core.event.ITmfEvent; |
30 | import org.eclipse.tracecompass.tmf.core.event.ITmfEventField; | |
1786026d | 31 | import org.eclipse.tracecompass.tmf.core.event.aspect.TmfCpuAspect; |
2bdf0193 AM |
32 | import org.eclipse.tracecompass.tmf.core.statesystem.AbstractTmfStateProvider; |
33 | import org.eclipse.tracecompass.tmf.core.trace.ITmfTrace; | |
1786026d | 34 | import org.eclipse.tracecompass.tmf.core.trace.TmfTraceUtils; |
e693075d FR |
35 | |
36 | /** | |
37 | * Creates a state system with the total time spent on CPU for each thread and | |
38 | * for each CPU from a kernel trace. | |
39 | * | |
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. | |
44 | * | |
45 | * It requires only the 'sched_switch' events enabled on the trace. | |
46 | * | |
47 | * @author François Rajotte | |
e693075d | 48 | */ |
e363eae1 | 49 | public class KernelCpuUsageStateProvider extends AbstractTmfStateProvider { |
e693075d | 50 | |
96811390 | 51 | private static final int VERSION = 2; |
e693075d FR |
52 | |
53 | /* For each CPU, maps the last time a thread was scheduled in */ | |
1786026d | 54 | private final Map<Integer, Long> fLastStartTimes = new HashMap<>(); |
e693075d | 55 | private final long fTraceStart; |
e363eae1 | 56 | private final IKernelAnalysisEventLayout fLayout; |
e693075d FR |
57 | |
58 | /** | |
59 | * Constructor | |
60 | * | |
61 | * @param trace | |
62 | * The trace from which to get the CPU usage | |
7411cd67 AM |
63 | * @param layout |
64 | * The event layout to use for this state provider. | |
e693075d | 65 | */ |
e363eae1 AM |
66 | public KernelCpuUsageStateProvider(ITmfTrace trace, IKernelAnalysisEventLayout layout) { |
67 | super(trace, ITmfEvent.class, "Kernel CPU usage"); //$NON-NLS-1$ | |
e693075d | 68 | fTraceStart = trace.getStartTime().getValue(); |
7411cd67 | 69 | fLayout = layout; |
e693075d FR |
70 | } |
71 | ||
72 | // ------------------------------------------------------------------------ | |
73 | // ITmfStateProvider | |
74 | // ------------------------------------------------------------------------ | |
75 | ||
76 | @Override | |
77 | public int getVersion() { | |
78 | return VERSION; | |
79 | } | |
80 | ||
81 | @Override | |
e363eae1 AM |
82 | public KernelCpuUsageStateProvider getNewInstance() { |
83 | return new KernelCpuUsageStateProvider(this.getTrace(), this.fLayout); | |
e693075d FR |
84 | } |
85 | ||
86 | @Override | |
e363eae1 AM |
87 | protected void eventHandle(@Nullable ITmfEvent event) { |
88 | if (event == null) { | |
89 | return; | |
90 | } | |
e693075d FR |
91 | final String eventName = event.getType().getName(); |
92 | ||
7411cd67 | 93 | if (eventName.equals(fLayout.eventSchedSwitch())) { |
b1aad44e GB |
94 | Object cpuObj = TmfTraceUtils.resolveEventAspectOfClassForEvent(event.getTrace(), TmfCpuAspect.class, event); |
95 | if (cpuObj == null) { | |
1786026d GB |
96 | /* We couldn't find any CPU information, ignore this event */ |
97 | return; | |
98 | } | |
b1aad44e | 99 | Integer cpu = (Integer) cpuObj; |
1786026d | 100 | |
e693075d FR |
101 | /* |
102 | * Fields: string prev_comm, int32 prev_tid, int32 prev_prio, int64 | |
103 | * prev_state, string next_comm, int32 next_tid, int32 next_prio | |
104 | */ | |
e693075d FR |
105 | ITmfEventField content = event.getContent(); |
106 | long ts = event.getTimestamp().getValue(); | |
e693075d | 107 | |
7411cd67 | 108 | Long prevTid = (Long) content.getField(fLayout.fieldPrevTid()).getValue(); |
e693075d FR |
109 | |
110 | try { | |
e363eae1 AM |
111 | final ITmfStateSystemBuilder ss = checkNotNull(getStateSystemBuilder()); |
112 | ||
d0c7e4ba | 113 | Integer currentCPUNode = ss.getQuarkRelativeAndAdd(getNodeCPUs(ss), cpu.toString()); |
e693075d FR |
114 | |
115 | /* | |
116 | * This quark contains the value of the cumulative time spent on | |
117 | * the source CPU by the currently running thread | |
118 | */ | |
119 | Integer cumulativeTimeQuark = ss.getQuarkRelativeAndAdd(currentCPUNode, prevTid.toString()); | |
120 | Long startTime = fLastStartTimes.get(cpu); | |
121 | /* | |
122 | * If start time is null, we haven't seen the start of the | |
123 | * process, so we assume beginning of the trace | |
124 | */ | |
125 | if (startTime == null) { | |
126 | startTime = fTraceStart; | |
127 | } | |
128 | ||
129 | /* | |
130 | * We add the time from startTime until now to the cumulative | |
131 | * time of the thread | |
132 | */ | |
133 | if (startTime != null) { | |
134 | ITmfStateValue value = ss.queryOngoingState(cumulativeTimeQuark); | |
135 | ||
136 | /* | |
137 | * Modify cumulative time for this CPU/TID combo: The total | |
138 | * time changes when the process is scheduled out. Nothing | |
139 | * happens when the process is scheduled in. | |
140 | */ | |
96811390 | 141 | long prevCumulativeTime = Math.max(0, value.unboxLong()); |
e693075d FR |
142 | long newCumulativeTime = prevCumulativeTime + (ts - startTime); |
143 | ||
144 | value = TmfStateValue.newValueLong(newCumulativeTime); | |
145 | ss.modifyAttribute(ts, value, cumulativeTimeQuark); | |
146 | fLastStartTimes.put(cpu, ts); | |
147 | } | |
148 | } catch (AttributeNotFoundException e) { | |
149 | Activator.getDefault().logError("Attribute not found in LttngKernelCpuStateProvider", e); //$NON-NLS-1$ | |
150 | } | |
151 | ||
152 | } | |
153 | } | |
154 | ||
155 | /* Shortcut for the "current CPU" attribute node */ | |
d0c7e4ba AM |
156 | private static int getNodeCPUs(ITmfStateSystemBuilder ssb) { |
157 | return ssb.getQuarkAbsoluteAndAdd(Attributes.CPUS); | |
e693075d FR |
158 | } |
159 | ||
160 | } |