lttng/org.eclipse.tracecompass.lttng2.ust.ui/src/org/eclipse/tracecompass/internal/lttng2/ust/ui/views/memusage/MemoryUsageViewer.java

   1 /**********************************************************************
   2  * Copyright (c) 2014 Ericsson, École Polytechnique de Montréal
   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  *   Bernd Hufmann - Initial API and implementation
  11  *   Geneviève Bastien - Create and use base class for XY plots
  12  **********************************************************************/
  13
  14 package org.eclipse.tracecompass.internal.lttng2.ust.ui.views.memusage;
  15
  16 import static org.eclipse.tracecompass.common.core.NonNullUtils.checkNotNull;
  17
  18 import java.util.HashMap;
  19 import java.util.List;
  20 import java.util.Map;
  21
  22 import org.eclipse.core.runtime.IProgressMonitor;
  23 import org.eclipse.swt.widgets.Composite;
  24 import org.eclipse.tracecompass.internal.lttng2.ust.core.analysis.memory.UstMemoryStrings;
  25 import org.eclipse.tracecompass.internal.tmf.core.Activator;
  26 import org.eclipse.tracecompass.lttng2.ust.core.analysis.memory.UstMemoryAnalysisModule;
  27 import org.eclipse.tracecompass.statesystem.core.ITmfStateSystem;
  28 import org.eclipse.tracecompass.statesystem.core.exceptions.AttributeNotFoundException;
  29 import org.eclipse.tracecompass.statesystem.core.exceptions.StateSystemDisposedException;
  30 import org.eclipse.tracecompass.statesystem.core.exceptions.StateValueTypeException;
  31 import org.eclipse.tracecompass.statesystem.core.exceptions.TimeRangeException;
  32 import org.eclipse.tracecompass.statesystem.core.statevalue.ITmfStateValue;
  33 import org.eclipse.tracecompass.tmf.core.statesystem.TmfStateSystemAnalysisModule;
  34 import org.eclipse.tracecompass.tmf.core.trace.ITmfTrace;
  35 import org.eclipse.tracecompass.tmf.core.trace.TmfTraceUtils;
  36 import org.eclipse.tracecompass.tmf.ui.viewers.xycharts.linecharts.TmfCommonXLineChartViewer;
  37
  38 /**
  39  * Memory usage view
  40  *
  41  * @author Matthew Khouzam
  42  */
  43 @SuppressWarnings("restriction")
  44 public class MemoryUsageViewer extends TmfCommonXLineChartViewer {
  45
  46     private TmfStateSystemAnalysisModule fModule = null;
  47
  48     private final Map<Integer, double[]> fYValues = new HashMap<>();
  49     private final Map<Integer, Integer> fMemoryQuarks = new HashMap<>();
  50     private final Map<Integer, String> fSeriesName = new HashMap<>();
  51
  52     private static final int BYTES_TO_KB = 1024;
  53
  54     // Timeout between updates in the updateData thread
  55     private static final long BUILD_UPDATE_TIMEOUT = 500;
  56
  57     /**
  58      * Constructor
  59      *
  60      * @param parent
  61      *            parent view
  62      */
  63     public MemoryUsageViewer(Composite parent) {
  64         super(parent, Messages.MemoryUsageViewer_Title, Messages.MemoryUsageViewer_XAxis, Messages.MemoryUsageViewer_YAxis);
  65     }
  66
  67     @Override
  68     protected void initializeDataSource() {
  69         ITmfTrace trace = getTrace();
  70         if (trace != null) {
  71             fModule = TmfTraceUtils.getAnalysisModuleOfClass(trace, TmfStateSystemAnalysisModule.class, UstMemoryAnalysisModule.ID);
  72             if (fModule == null) {
  73                 return;
  74             }
  75             fModule.schedule();
  76         }
  77     }
  78
  79     @Override
  80     protected void updateData(long start, long end, int nb, IProgressMonitor monitor) {
  81         try {
  82             if (getTrace() == null || fModule == null) {
  83                 return;
  84             }
  85             if (!fModule.waitForInitialization()) {
  86                 return;
  87             }
  88             ITmfStateSystem ss = fModule.getStateSystem();
  89             /* Don't wait for the module completion, when it's ready, we'll know */
  90             if (ss == null) {
  91                 return;
  92             }
  93
  94             double[] xvalues = getXAxis(start, end, nb);
  95             setXAxis(xvalues);
  96
  97             boolean complete = false;
  98             long currentEnd = start;
  99
 100             while (!complete && currentEnd < end) {
 101                 if (monitor.isCanceled()) {
 102                     return;
 103                 }
 104                 complete = ss.waitUntilBuilt(BUILD_UPDATE_TIMEOUT);
 105                 currentEnd = ss.getCurrentEndTime();
 106                 List<Integer> tidQuarks = ss.getSubAttributes(-1, false);
 107                 long traceStart = getStartTime();
 108                 long traceEnd = getEndTime();
 109                 long offset = this.getTimeOffset();
 110
 111                 /* Initialize quarks and series names */
 112                 for (int quark : tidQuarks) {
 113                     fYValues.put(quark, new double[xvalues.length]);
 114                     fMemoryQuarks.put(quark, ss.getQuarkRelative(quark, UstMemoryStrings.UST_MEMORY_MEMORY_ATTRIBUTE));
 115                     int procNameQuark = ss.getQuarkRelative(quark, UstMemoryStrings.UST_MEMORY_PROCNAME_ATTRIBUTE);
 116                     try {
 117                         ITmfStateValue procnameValue = ss.querySingleState(start, procNameQuark).getStateValue();
 118                         String procname = ""; //$NON-NLS-1$
 119                         if (!procnameValue.isNull()) {
 120                             procname = procnameValue.unboxStr();
 121                         }
 122                         String seriesName = procname + ' ' + '(' + ss.getAttributeName(quark) + ')';
 123                         fSeriesName.put(quark, seriesName.trim());
 124                     } catch (TimeRangeException e) {
 125                         fSeriesName.put(quark, '(' + ss.getAttributeName(quark) + ')');
 126                     }
 127                 }
 128
 129                 /*
 130                  * TODO: It should only show active threads in the time range.
 131                  * If a tid does not have any memory value (only 1 interval in
 132                  * the time range with value null or 0), then its series should
 133                  * not be displayed.
 134                  */
 135                 double yvalue = 0.0;
 136                 for (int i = 0; i < xvalues.length; i++) {
 137                     if (monitor.isCanceled()) {
 138                         return;
 139                     }
 140                     double x = xvalues[i];
 141                     long time = (long) x + offset;
 142                     // make sure that time is in the trace range after double to
 143                     // long conversion
 144                     time = time < traceStart ? traceStart : time;
 145                     time = time > traceEnd ? traceEnd : time;
 146
 147                     for (int quark : tidQuarks) {
 148                         double[] values = checkNotNull(fYValues.get(quark));
 149                         try {
 150                             Integer memQuark = checkNotNull(fMemoryQuarks.get(quark));
 151                             yvalue = ss.querySingleState(time, memQuark.intValue()).getStateValue().unboxLong() / BYTES_TO_KB;
 152                             values[i] = yvalue;
 153                         } catch (TimeRangeException e) {
 154                             values[i] = 0;
 155                         }
 156                     }
 157                 }
 158                 for (int quark : tidQuarks) {
 159                     setSeries(fSeriesName.get(quark), fYValues.get(quark));
 160                 }
 161                 updateDisplay();
 162             }
 163         } catch (AttributeNotFoundException | StateValueTypeException e) {
 164             Activator.logError("Error updating the data of the Memory usage view", e); //$NON-NLS-1$
 165         } catch (StateSystemDisposedException e) {
 166             /* State system is closing down, no point continuing */
 167         }
 168     }
 169
 170 }