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 import static org.eclipse.tracecompass.common.core.NonNullUtils.nullToEmptyString;
  18
  19 import java.util.Set;
  20
  21 import org.eclipse.jdt.annotation.NonNull;
  22 import org.eclipse.jdt.annotation.Nullable;
  23 import org.eclipse.tracecompass.internal.lttng2.ust.core.analysis.memory.UstMemoryStateProvider;
  24 import org.eclipse.tracecompass.lttng2.control.core.session.SessionConfigStrings;
  25 import org.eclipse.tracecompass.lttng2.ust.core.trace.LttngUstTrace;
  26 import org.eclipse.tracecompass.lttng2.ust.core.trace.layout.ILttngUstEventLayout;
  27 import org.eclipse.tracecompass.tmf.core.analysis.TmfAnalysisRequirement;
  28 import org.eclipse.tracecompass.tmf.core.analysis.TmfAnalysisRequirement.ValuePriorityLevel;
  29 import org.eclipse.tracecompass.tmf.core.exceptions.TmfAnalysisException;
  30 import org.eclipse.tracecompass.tmf.core.statesystem.ITmfStateProvider;
  31 import org.eclipse.tracecompass.tmf.core.statesystem.TmfStateSystemAnalysisModule;
  32 import org.eclipse.tracecompass.tmf.core.trace.ITmfTrace;
  33
  34 import com.google.common.collect.ImmutableSet;
  35
  36 /**
  37  * This analysis build a state system from the libc memory instrumentation on a
  38  * UST trace
  39  *
  40  * @author Geneviève Bastien
  41  */
  42 public class UstMemoryAnalysisModule extends TmfStateSystemAnalysisModule {
  43
  44     /**
  45      * Analysis ID, it should match that in the plugin.xml file
  46      */
  47     public static final @NonNull String ID = "org.eclipse.linuxtools.lttng2.ust.analysis.memory"; //$NON-NLS-1$
  48
  49     /** The analysis's requirements. Only set after the trace is set. */
  50     private @Nullable Set<TmfAnalysisRequirement> fAnalysisRequirements;
  51
  52     @Override
  53     protected ITmfStateProvider createStateProvider() {
  54         return new UstMemoryStateProvider(checkNotNull(getTrace()));
  55     }
  56
  57     /**
  58      * @since 1.0
  59      */
  60     @Override
  61     public boolean setTrace(ITmfTrace trace) throws TmfAnalysisException {
  62         if (!(trace instanceof LttngUstTrace)) {
  63             return false;
  64         }
  65         /*
  66          * setTrace() calls getAnalysisRequirements, so we need the field set
  67          * for the check to work.
  68          */
  69         fAnalysisRequirements = requirementsForTrace((LttngUstTrace) trace);
  70         boolean traceIsSet = super.setTrace(trace);
  71         if (!traceIsSet) {
  72             /* Unset the requirements, the trace was not good after all. */
  73             fAnalysisRequirements = null;
  74         }
  75         return traceIsSet;
  76     }
  77
  78     @Override
  79     protected LttngUstTrace getTrace() {
  80         return (LttngUstTrace) super.getTrace();
  81     }
  82
  83     private static Set<TmfAnalysisRequirement> requirementsForTrace(LttngUstTrace trace) {
  84         /*
  85          * Compute the list of required events, whose exact names can change
  86          * depending on the tracer's version.
  87          */
  88         ILttngUstEventLayout layout = trace.getEventLayout();
  89         Set<String> requiredEvents = ImmutableSet.of(
  90                 layout.eventLibcMalloc(),
  91                 layout.eventLibcFree(),
  92                 layout.eventLibcCalloc(),
  93                 layout.eventLibcRealloc(),
  94                 layout.eventLibcMemalign(),
  95                 layout.eventLibcPosixMemalign()
  96               );
  97
  98         /* Initialize the requirements for the analysis: domain and events */
  99         TmfAnalysisRequirement eventsReq = new TmfAnalysisRequirement(SessionConfigStrings.CONFIG_ELEMENT_EVENT, requiredEvents, ValuePriorityLevel.MANDATORY);
 100         /*
 101          * In order to have these events, the libc wrapper with probes should be
 102          * loaded
 103          */
 104         eventsReq.addInformation(nullToEmptyString(Messages.UstMemoryAnalysisModule_EventsLoadingInformation));
 105         eventsReq.addInformation(nullToEmptyString(Messages.UstMemoryAnalysisModule_EventsLoadingExampleInformation));
 106
 107         /* The domain type of the analysis */
 108         TmfAnalysisRequirement domainReq = new TmfAnalysisRequirement(SessionConfigStrings.CONFIG_ELEMENT_DOMAIN);
 109         domainReq.addValue(SessionConfigStrings.CONFIG_DOMAIN_TYPE_UST, ValuePriorityLevel.MANDATORY);
 110
 111         return checkNotNull(ImmutableSet.of(domainReq, eventsReq));
 112     }
 113
 114     @Override
 115     public Iterable<TmfAnalysisRequirement> getAnalysisRequirements() {
 116         Set<TmfAnalysisRequirement> reqs = fAnalysisRequirements;
 117         if (reqs == null) {
 118             throw new IllegalStateException("Cannot get the analysis requirements without an assigned trace."); //$NON-NLS-1$
 119         }
 120         return reqs;
 121     }
 122 }