org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/statistics/TmfStatisticsTotalsModule.java

   1 /*******************************************************************************
   2  * Copyright (c) 2013, 2015 Ericsson
   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  *   Alexandre Montplaisir - Initial API and implementation
  11  ******************************************************************************/
  12
  13 package org.eclipse.tracecompass.tmf.core.statistics;
  14
  15 import static org.eclipse.tracecompass.common.core.NonNullUtils.checkNotNull;
  16
  17 import org.eclipse.jdt.annotation.NonNull;
  18 import org.eclipse.tracecompass.statesystem.core.ITmfStateSystemBuilder;
  19 import org.eclipse.tracecompass.statesystem.core.exceptions.AttributeNotFoundException;
  20 import org.eclipse.tracecompass.statesystem.core.exceptions.StateValueTypeException;
  21 import org.eclipse.tracecompass.statesystem.core.exceptions.TimeRangeException;
  22 import org.eclipse.tracecompass.tmf.core.event.ITmfEvent;
  23 import org.eclipse.tracecompass.tmf.core.event.ITmfLostEvent;
  24 import org.eclipse.tracecompass.tmf.core.statesystem.AbstractTmfStateProvider;
  25 import org.eclipse.tracecompass.tmf.core.statesystem.ITmfStateProvider;
  26 import org.eclipse.tracecompass.tmf.core.statesystem.TmfStateSystemAnalysisModule;
  27 import org.eclipse.tracecompass.tmf.core.statistics.TmfStateStatistics.Attributes;
  28 import org.eclipse.tracecompass.tmf.core.timestamp.ITmfTimestamp;
  29 import org.eclipse.tracecompass.tmf.core.trace.ITmfTrace;
  30
  31 /**
  32  * The analysis module building the "totals" statistics state system.
  33  *
  34  * It is not in the extension point (and as such, not registered in the
  35  * TmfAnalysisManager), as it is being handled by the TmfStatisticsModule.
  36  *
  37  * @author Alexandre Montplaisir
  38  */
  39 public class TmfStatisticsTotalsModule extends TmfStateSystemAnalysisModule {
  40
  41     /**
  42      * The ID of this analysis module (which is also the ID of the state system)
  43      */
  44     public static final @NonNull String ID = "org.eclipse.linuxtools.tmf.statistics.totals"; //$NON-NLS-1$
  45
  46     private static final @NonNull String NAME = "TMF Statistics, event totals"; //$NON-NLS-1$
  47
  48     /**
  49      * Constructor
  50      */
  51     public TmfStatisticsTotalsModule() {
  52         super();
  53         setId(ID);
  54         setName(NAME);
  55     }
  56
  57     @Override
  58     protected ITmfStateProvider createStateProvider() {
  59         return new StatsProviderTotals(checkNotNull(getTrace()));
  60     }
  61
  62     @Override
  63     protected String getSsFileName() {
  64         return "statistics-totals.ht"; //$NON-NLS-1$
  65     }
  66
  67
  68     /**
  69      * The state provider for traces statistics that use TmfStateStatistics. It
  70      * should work with any trace type for which we can use the state system.
  71      *
  72      * Only one attribute will be stored, containing the total of events seen so
  73      * far. The resulting attribute tree will look like this:
  74      *
  75      * <pre>
  76      * (root)
  77      *   \-- total
  78      * </pre>
  79      *
  80      * @author Alexandre Montplaisir
  81      * @version 1.0
  82      */
  83     class StatsProviderTotals extends AbstractTmfStateProvider {
  84
  85         /**
  86          * Version number of this input handler. Please bump this if you modify the
  87          * contents of the generated state history in some way.
  88          */
  89         private static final int VERSION = 2;
  90
  91         /**
  92          * Constructor
  93         *
  94          * @param trace
  95          *            The trace for which we build this state system
  96          */
  97         public StatsProviderTotals(@NonNull ITmfTrace trace) {
  98             super(trace, NAME);
  99         }
 100
 101         @Override
 102         public int getVersion() {
 103             return VERSION;
 104         }
 105
 106         @Override
 107         public StatsProviderTotals getNewInstance() {
 108             return new StatsProviderTotals(this.getTrace());
 109         }
 110
 111         @Override
 112         protected void eventHandle(ITmfEvent event) {
 113             /* Do not count lost events in the total */
 114             if (event instanceof ITmfLostEvent) {
 115                 return;
 116             }
 117
 118             ITmfStateSystemBuilder ss = checkNotNull(getStateSystemBuilder());
 119
 120             /* Since this can be used for any trace types, normalize all the
 121              * timestamp values to nanoseconds. */
 122             final long ts = event.getTimestamp().normalize(0, ITmfTimestamp.NANOSECOND_SCALE).getValue();
 123
 124             try {
 125                 /* Total number of events */
 126                 int quark = ss.getQuarkAbsoluteAndAdd(Attributes.TOTAL);
 127                 ss.incrementAttribute(ts, quark);
 128
 129             } catch (StateValueTypeException | TimeRangeException | AttributeNotFoundException e) {
 130                 e.printStackTrace();
 131             }
 132         }
 133     }
 134
 135 }