lttng/org.eclipse.tracecompass.lttng2.ust.core/src/org/eclipse/tracecompass/lttng2/ust/core/analysis/memory/UstMemoryAnalysisModule.java

   1 /*******************************************************************************
   2  * Copyright (c) 2014, 2015 É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  *   Geneviève Bastien - Initial API and implementation
  11  *   Guilliano Molaire - Provide the requirements of the analysis
  12  *******************************************************************************/
  13
  14 package org.eclipse.tracecompass.lttng2.ust.core.analysis.memory;
  15
  16 import static org.eclipse.tracecompass.common.core.NonNullUtils.checkNotNull;
  17
  18 import java.util.Set;
  19
  20 import org.eclipse.jdt.annotation.NonNull;
  21 import org.eclipse.tracecompass.internal.lttng2.ust.core.analysis.memory.UstMemoryStateProvider;
  22 import org.eclipse.tracecompass.internal.lttng2.ust.core.analysis.memory.UstMemoryStrings;
  23 import org.eclipse.tracecompass.lttng2.control.core.session.SessionConfigStrings;
  24 import org.eclipse.tracecompass.lttng2.ust.core.trace.LttngUstTrace;
  25 import org.eclipse.tracecompass.tmf.core.analysis.TmfAnalysisRequirement;
  26 import org.eclipse.tracecompass.tmf.core.analysis.TmfAnalysisRequirement.ValuePriorityLevel;
  27 import org.eclipse.tracecompass.tmf.core.exceptions.TmfAnalysisException;
  28 import org.eclipse.tracecompass.tmf.core.statesystem.ITmfStateProvider;
  29 import org.eclipse.tracecompass.tmf.core.statesystem.TmfStateSystemAnalysisModule;
  30 import org.eclipse.tracecompass.tmf.core.trace.ITmfTrace;
  31
  32 import com.google.common.collect.ImmutableSet;
  33
  34 /**
  35  * This analysis build a state system from the libc memory instrumentation on a
  36  * UST trace
  37  *
  38  * @author Geneviève Bastien
  39  */
  40 public class UstMemoryAnalysisModule extends TmfStateSystemAnalysisModule {
  41
  42     /**
  43      * Analysis ID, it should match that in the plugin.xml file
  44      */
  45     public static final @NonNull String ID = "org.eclipse.linuxtools.lttng2.ust.analysis.memory"; //$NON-NLS-1$
  46
  47     private static final ImmutableSet<String> REQUIRED_EVENTS = ImmutableSet.of(
  48             UstMemoryStrings.MALLOC,
  49             UstMemoryStrings.FREE,
  50             UstMemoryStrings.CALLOC,
  51             UstMemoryStrings.REALLOC,
  52             UstMemoryStrings.MEMALIGN,
  53             UstMemoryStrings.POSIX_MEMALIGN
  54             );
  55
  56     /** The requirements as an immutable set */
  57     private static final @NonNull Set<TmfAnalysisRequirement> REQUIREMENTS;
  58
  59     static {
  60         /* Initialize the requirements for the analysis: domain and events */
  61         TmfAnalysisRequirement eventsReq = new TmfAnalysisRequirement(SessionConfigStrings.CONFIG_ELEMENT_EVENT, REQUIRED_EVENTS, ValuePriorityLevel.MANDATORY);
  62         /*
  63          * In order to have these events, the libc wrapper with probes should be
  64          * loaded
  65          */
  66         eventsReq.addInformation(Messages.UstMemoryAnalysisModule_EventsLoadingInformation);
  67         eventsReq.addInformation(Messages.UstMemoryAnalysisModule_EventsLoadingExampleInformation);
  68
  69         /* The domain type of the analysis */
  70         TmfAnalysisRequirement domainReq = new TmfAnalysisRequirement(SessionConfigStrings.CONFIG_ELEMENT_DOMAIN);
  71         domainReq.addValue(SessionConfigStrings.CONFIG_DOMAIN_TYPE_UST, ValuePriorityLevel.MANDATORY);
  72
  73         REQUIREMENTS = checkNotNull(ImmutableSet.of(domainReq, eventsReq));
  74     }
  75
  76     @Override
  77     protected ITmfStateProvider createStateProvider() {
  78         return new UstMemoryStateProvider(checkNotNull(getTrace()));
  79     }
  80
  81     /**
  82      * @since 1.0
  83      */
  84     @Override
  85     public boolean setTrace(ITmfTrace trace) throws TmfAnalysisException {
  86         if (!(trace instanceof LttngUstTrace)) {
  87             return false;
  88         }
  89         return super.setTrace(trace);
  90     }
  91
  92     @Override
  93     protected LttngUstTrace getTrace() {
  94         return (LttngUstTrace) super.getTrace();
  95     }
  96
  97     @Override
  98     public Iterable<TmfAnalysisRequirement> getAnalysisRequirements() {
  99         return REQUIREMENTS;
 100     }
 101 }