Commit | Line | Data |
---|---|---|
dffc234f | 1 | /******************************************************************************* |
ed902a2b | 2 | * Copyright (c) 2014, 2015 École Polytechnique de Montréal |
dffc234f GB |
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 | * Geneviève Bastien - Initial API and implementation | |
11 | *******************************************************************************/ | |
12 | ||
e363eae1 | 13 | package org.eclipse.tracecompass.analysis.os.linux.ui.views.cpuusage; |
dffc234f | 14 | |
5db5a3a4 AM |
15 | import static org.eclipse.tracecompass.common.core.NonNullUtils.checkNotNull; |
16 | ||
dffc234f | 17 | import java.util.ArrayList; |
e9a0d1cb | 18 | import java.util.Collections; |
dffc234f GB |
19 | import java.util.HashMap; |
20 | import java.util.List; | |
21 | import java.util.Map; | |
22 | import java.util.Map.Entry; | |
23 | ||
24 | import org.eclipse.jface.viewers.Viewer; | |
25 | import org.eclipse.jface.viewers.ViewerComparator; | |
dffc234f GB |
26 | import org.eclipse.osgi.util.NLS; |
27 | import org.eclipse.swt.widgets.Composite; | |
e363eae1 AM |
28 | import org.eclipse.tracecompass.analysis.os.linux.core.cpuusage.KernelCpuUsageAnalysis; |
29 | import org.eclipse.tracecompass.analysis.os.linux.core.kernelanalysis.Attributes; | |
30 | import org.eclipse.tracecompass.analysis.os.linux.core.kernelanalysis.KernelAnalysis; | |
e894a508 | 31 | import org.eclipse.tracecompass.statesystem.core.ITmfStateSystem; |
1dd75589 | 32 | import org.eclipse.tracecompass.statesystem.core.StateSystemUtils; |
e894a508 AM |
33 | import org.eclipse.tracecompass.statesystem.core.exceptions.AttributeNotFoundException; |
34 | import org.eclipse.tracecompass.statesystem.core.exceptions.StateSystemDisposedException; | |
35 | import org.eclipse.tracecompass.statesystem.core.interval.ITmfStateInterval; | |
36 | import org.eclipse.tracecompass.statesystem.core.statevalue.ITmfStateValue; | |
2bdf0193 AM |
37 | import org.eclipse.tracecompass.tmf.core.statesystem.TmfStateSystemAnalysisModule; |
38 | import org.eclipse.tracecompass.tmf.core.trace.ITmfTrace; | |
b8585c7c | 39 | import org.eclipse.tracecompass.tmf.core.trace.TmfTraceUtils; |
2bdf0193 AM |
40 | import org.eclipse.tracecompass.tmf.ui.viewers.tree.AbstractTmfTreeViewer; |
41 | import org.eclipse.tracecompass.tmf.ui.viewers.tree.ITmfTreeColumnDataProvider; | |
42 | import org.eclipse.tracecompass.tmf.ui.viewers.tree.ITmfTreeViewerEntry; | |
43 | import org.eclipse.tracecompass.tmf.ui.viewers.tree.TmfTreeColumnData; | |
2bdf0193 | 44 | import org.eclipse.tracecompass.tmf.ui.viewers.tree.TmfTreeColumnData.ITmfColumnPercentageProvider; |
1dd75589 | 45 | import org.eclipse.tracecompass.tmf.ui.viewers.tree.TmfTreeViewerEntry; |
dffc234f GB |
46 | |
47 | /** | |
48 | * Tree viewer to display CPU usage information in a specified time range. It | |
49 | * shows the process's TID, its name, the time spent on the CPU during that | |
50 | * range, in % and absolute value. | |
51 | * | |
52 | * @author Geneviève Bastien | |
53 | */ | |
54 | public class CpuUsageComposite extends AbstractTmfTreeViewer { | |
55 | ||
d48661f2 GB |
56 | // Timeout between to wait for in the updateElements method |
57 | private static final long BUILD_UPDATE_TIMEOUT = 500; | |
58 | ||
e363eae1 | 59 | private KernelCpuUsageAnalysis fModule = null; |
e9a0d1cb | 60 | private String fSelectedThread = null; |
dffc234f GB |
61 | |
62 | private static final String[] COLUMN_NAMES = new String[] { | |
63 | Messages.CpuUsageComposite_ColumnTID, | |
64 | Messages.CpuUsageComposite_ColumnProcess, | |
65 | Messages.CpuUsageComposite_ColumnPercent, | |
66 | Messages.CpuUsageComposite_ColumnTime | |
67 | }; | |
68 | ||
69 | /* A map that saves the mapping of a thread ID to its executable name */ | |
70 | private final Map<String, String> fProcessNameMap = new HashMap<>(); | |
71 | ||
72 | /** Provides label for the CPU usage tree viewer cells */ | |
73 | protected static class CpuLabelProvider extends TreeLabelProvider { | |
74 | ||
75 | @Override | |
76 | public String getColumnText(Object element, int columnIndex) { | |
77 | CpuUsageEntry obj = (CpuUsageEntry) element; | |
78 | if (columnIndex == 0) { | |
79 | return obj.getTid(); | |
80 | } else if (columnIndex == 1) { | |
81 | return obj.getProcessName(); | |
82 | } else if (columnIndex == 2) { | |
83 | return String.format(Messages.CpuUsageComposite_TextPercent, obj.getPercent()); | |
84 | } else if (columnIndex == 3) { | |
85 | return NLS.bind(Messages.CpuUsageComposite_TextTime, obj.getTime()); | |
86 | } | |
87 | ||
88 | return element.toString(); | |
89 | } | |
90 | ||
91 | } | |
92 | ||
93 | /** | |
94 | * Constructor | |
95 | * | |
96 | * @param parent | |
97 | * The parent composite that holds this viewer | |
98 | */ | |
99 | public CpuUsageComposite(Composite parent) { | |
100 | super(parent, false); | |
101 | setLabelProvider(new CpuLabelProvider()); | |
102 | } | |
103 | ||
104 | @Override | |
105 | protected ITmfTreeColumnDataProvider getColumnDataProvider() { | |
106 | return new ITmfTreeColumnDataProvider() { | |
107 | ||
108 | @Override | |
109 | public List<TmfTreeColumnData> getColumnData() { | |
110 | /* All columns are sortable */ | |
111 | List<TmfTreeColumnData> columns = new ArrayList<>(); | |
112 | TmfTreeColumnData column = new TmfTreeColumnData(COLUMN_NAMES[0]); | |
113 | column.setComparator(new ViewerComparator() { | |
114 | @Override | |
115 | public int compare(Viewer viewer, Object e1, Object e2) { | |
116 | CpuUsageEntry n1 = (CpuUsageEntry) e1; | |
117 | CpuUsageEntry n2 = (CpuUsageEntry) e2; | |
118 | ||
119 | return n1.getTid().compareTo(n2.getTid()); | |
120 | ||
121 | } | |
122 | }); | |
123 | columns.add(column); | |
124 | column = new TmfTreeColumnData(COLUMN_NAMES[1]); | |
125 | column.setComparator(new ViewerComparator() { | |
126 | @Override | |
127 | public int compare(Viewer viewer, Object e1, Object e2) { | |
128 | CpuUsageEntry n1 = (CpuUsageEntry) e1; | |
129 | CpuUsageEntry n2 = (CpuUsageEntry) e2; | |
130 | ||
131 | return n1.getProcessName().compareTo(n2.getProcessName()); | |
132 | ||
133 | } | |
134 | }); | |
135 | columns.add(column); | |
136 | column = new TmfTreeColumnData(COLUMN_NAMES[2]); | |
137 | column.setComparator(new ViewerComparator() { | |
138 | @Override | |
139 | public int compare(Viewer viewer, Object e1, Object e2) { | |
140 | CpuUsageEntry n1 = (CpuUsageEntry) e1; | |
141 | CpuUsageEntry n2 = (CpuUsageEntry) e2; | |
142 | ||
143 | return n1.getPercent().compareTo(n2.getPercent()); | |
144 | ||
145 | } | |
146 | }); | |
147 | column.setPercentageProvider(new ITmfColumnPercentageProvider() { | |
148 | ||
149 | @Override | |
150 | public double getPercentage(Object data) { | |
151 | CpuUsageEntry parent = (CpuUsageEntry) data; | |
152 | return parent.getPercent() / 100; | |
153 | } | |
154 | }); | |
155 | columns.add(column); | |
156 | column = new TmfTreeColumnData(COLUMN_NAMES[3]); | |
157 | column.setComparator(new ViewerComparator() { | |
158 | @Override | |
159 | public int compare(Viewer viewer, Object e1, Object e2) { | |
160 | CpuUsageEntry n1 = (CpuUsageEntry) e1; | |
161 | CpuUsageEntry n2 = (CpuUsageEntry) e2; | |
162 | ||
163 | return n1.getTime().compareTo(n2.getTime()); | |
164 | ||
165 | } | |
166 | }); | |
167 | columns.add(column); | |
168 | ||
169 | return columns; | |
170 | } | |
171 | ||
172 | }; | |
173 | } | |
174 | ||
175 | // ------------------------------------------------------------------------ | |
176 | // Operations | |
177 | // ------------------------------------------------------------------------ | |
178 | ||
e9a0d1cb GB |
179 | @Override |
180 | protected void contentChanged(ITmfTreeViewerEntry rootEntry) { | |
181 | String selectedThread = fSelectedThread; | |
182 | if (selectedThread != null) { | |
183 | /* Find the selected thread among the inputs */ | |
184 | for (ITmfTreeViewerEntry entry : rootEntry.getChildren()) { | |
185 | if (entry instanceof CpuUsageEntry) { | |
186 | if (selectedThread.equals(((CpuUsageEntry) entry).getTid())) { | |
5db5a3a4 | 187 | List<ITmfTreeViewerEntry> list = checkNotNull(Collections.singletonList(entry)); |
e9a0d1cb GB |
188 | super.setSelection(list); |
189 | return; | |
190 | } | |
191 | } | |
192 | } | |
193 | } | |
194 | } | |
195 | ||
dffc234f GB |
196 | @Override |
197 | public void initializeDataSource() { | |
e363eae1 | 198 | fModule = TmfTraceUtils.getAnalysisModuleOfClass(getTrace(), KernelCpuUsageAnalysis.class, KernelCpuUsageAnalysis.ID); |
dffc234f GB |
199 | if (fModule == null) { |
200 | return; | |
201 | } | |
202 | fModule.schedule(); | |
203 | fModule.waitForInitialization(); | |
204 | fProcessNameMap.clear(); | |
205 | } | |
206 | ||
207 | @Override | |
208 | protected ITmfTreeViewerEntry updateElements(long start, long end, boolean isSelection) { | |
209 | if (isSelection || (start == end)) { | |
210 | return null; | |
211 | } | |
212 | if (getTrace() == null || fModule == null) { | |
213 | return null; | |
214 | } | |
d48661f2 | 215 | fModule.waitForInitialization(); |
dffc234f | 216 | ITmfStateSystem ss = fModule.getStateSystem(); |
dffc234f GB |
217 | if (ss == null) { |
218 | return null; | |
219 | } | |
220 | ||
d48661f2 GB |
221 | boolean complete = false; |
222 | long currentEnd = start; | |
223 | ||
224 | while (!complete && currentEnd < end) { | |
225 | complete = ss.waitUntilBuilt(BUILD_UPDATE_TIMEOUT); | |
226 | currentEnd = ss.getCurrentEndTime(); | |
227 | } | |
228 | ||
dffc234f GB |
229 | /* Initialize the data */ |
230 | Map<String, Long> cpuUsageMap = fModule.getCpuUsageInRange(Math.max(start, getStartTime()), Math.min(end, getEndTime())); | |
231 | ||
232 | TmfTreeViewerEntry root = new TmfTreeViewerEntry(""); //$NON-NLS-1$ | |
233 | List<ITmfTreeViewerEntry> entryList = root.getChildren(); | |
234 | ||
235 | for (Entry<String, Long> entry : cpuUsageMap.entrySet()) { | |
236 | /* | |
237 | * Process only entries representing the total of all CPUs and that | |
238 | * have time on CPU | |
239 | */ | |
240 | if (entry.getValue() == 0) { | |
241 | continue; | |
242 | } | |
e363eae1 | 243 | if (!entry.getKey().startsWith(KernelCpuUsageAnalysis.TOTAL)) { |
dffc234f GB |
244 | continue; |
245 | } | |
e363eae1 | 246 | String[] strings = entry.getKey().split(KernelCpuUsageAnalysis.SPLIT_STRING, 2); |
dffc234f | 247 | |
e363eae1 | 248 | if ((strings.length > 1) && !(strings[1].equals(KernelCpuUsageAnalysis.TID_ZERO))) { |
dffc234f GB |
249 | CpuUsageEntry obj = new CpuUsageEntry(strings[1], getProcessName(strings[1]), (double) entry.getValue() / (double) (end - start) * 100, entry.getValue()); |
250 | entryList.add(obj); | |
251 | } | |
252 | } | |
253 | ||
254 | return root; | |
255 | } | |
256 | ||
257 | /* | |
258 | * Get the process name from its TID by using the LTTng kernel analysis | |
259 | * module | |
260 | */ | |
261 | private String getProcessName(String tid) { | |
262 | String execName = fProcessNameMap.get(tid); | |
263 | if (execName != null) { | |
264 | return execName; | |
265 | } | |
72221aa4 AM |
266 | ITmfTrace trace = getTrace(); |
267 | if (trace == null) { | |
dffc234f GB |
268 | return tid; |
269 | } | |
e363eae1 | 270 | ITmfStateSystem kernelSs = TmfStateSystemAnalysisModule.getStateSystem(trace, KernelAnalysis.ID); |
dffc234f GB |
271 | if (kernelSs == null) { |
272 | return tid; | |
273 | } | |
274 | ||
275 | try { | |
276 | int cpusNode = kernelSs.getQuarkAbsolute(Attributes.THREADS); | |
277 | ||
278 | /* Get the quarks for each cpu */ | |
279 | List<Integer> cpuNodes = kernelSs.getSubAttributes(cpusNode, false); | |
280 | ||
281 | for (Integer tidQuark : cpuNodes) { | |
282 | if (kernelSs.getAttributeName(tidQuark).equals(tid)) { | |
283 | int execNameQuark; | |
284 | List<ITmfStateInterval> execNameIntervals; | |
285 | try { | |
286 | execNameQuark = kernelSs.getQuarkRelative(tidQuark, Attributes.EXEC_NAME); | |
1dd75589 | 287 | execNameIntervals = StateSystemUtils.queryHistoryRange(kernelSs, execNameQuark, getStartTime(), getEndTime()); |
dffc234f GB |
288 | } catch (AttributeNotFoundException e) { |
289 | /* No information on this thread (yet?), skip it for now */ | |
290 | continue; | |
291 | } catch (StateSystemDisposedException e) { | |
292 | /* State system is closing down, no point continuing */ | |
293 | break; | |
294 | } | |
295 | ||
296 | for (ITmfStateInterval execNameInterval : execNameIntervals) { | |
297 | if (!execNameInterval.getStateValue().isNull() && | |
298 | execNameInterval.getStateValue().getType() == ITmfStateValue.Type.STRING) { | |
299 | execName = execNameInterval.getStateValue().unboxStr(); | |
300 | fProcessNameMap.put(tid, execName); | |
301 | return execName; | |
302 | } | |
303 | } | |
304 | } | |
305 | } | |
306 | ||
307 | } catch (AttributeNotFoundException e) { | |
308 | /* can't find the process name, just return the tid instead */ | |
309 | } | |
310 | return tid; | |
311 | } | |
312 | ||
e9a0d1cb GB |
313 | /** |
314 | * Set the currently selected thread ID | |
315 | * | |
316 | * @param tid | |
317 | * The selected thread ID | |
318 | */ | |
319 | public void setSelectedThread(String tid) { | |
320 | fSelectedThread = tid; | |
321 | } | |
322 | ||
dffc234f | 323 | } |