lttng/org.eclipse.tracecompass.lttng2.kernel.core/src/org/eclipse/tracecompass/lttng2/kernel/core/trace/LttngKernelTrace.java

   1 /*******************************************************************************
   2  * Copyright (c) 2012, 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  *   Matthew Khouzam - Improved validation
  12  ******************************************************************************/
  13
  14 package org.eclipse.tracecompass.lttng2.kernel.core.trace;
  15
  16 import java.util.Collection;
  17 import java.util.Map;
  18
  19 import org.eclipse.core.resources.IProject;
  20 import org.eclipse.core.resources.IResource;
  21 import org.eclipse.core.runtime.IStatus;
  22 import org.eclipse.core.runtime.Status;
  23 import org.eclipse.jdt.annotation.NonNull;
  24 import org.eclipse.tracecompass.analysis.os.linux.core.kernelanalysis.KernelTidAspect;
  25 import org.eclipse.tracecompass.analysis.os.linux.core.kernelanalysis.ThreadPriorityAspect;
  26 import org.eclipse.tracecompass.analysis.os.linux.core.trace.IKernelAnalysisEventLayout;
  27 import org.eclipse.tracecompass.analysis.os.linux.core.trace.IKernelTrace;
  28 import org.eclipse.tracecompass.common.core.NonNullUtils;
  29 import org.eclipse.tracecompass.internal.lttng2.kernel.core.Activator;
  30 import org.eclipse.tracecompass.internal.lttng2.kernel.core.trace.layout.Lttng26EventLayout;
  31 import org.eclipse.tracecompass.internal.lttng2.kernel.core.trace.layout.Lttng27EventLayout;
  32 import org.eclipse.tracecompass.internal.lttng2.kernel.core.trace.layout.LttngEventLayout;
  33 import org.eclipse.tracecompass.internal.lttng2.kernel.core.trace.layout.PerfEventLayout;
  34 import org.eclipse.tracecompass.tmf.core.event.ITmfEvent;
  35 import org.eclipse.tracecompass.tmf.core.event.aspect.ITmfEventAspect;
  36 import org.eclipse.tracecompass.tmf.core.exceptions.TmfTraceException;
  37 import org.eclipse.tracecompass.tmf.core.trace.TraceValidationStatus;
  38 import org.eclipse.tracecompass.tmf.ctf.core.trace.CtfTmfTrace;
  39 import org.eclipse.tracecompass.tmf.ctf.core.trace.CtfTraceValidationStatus;
  40 import org.eclipse.tracecompass.tmf.ctf.core.trace.CtfUtils;
  41
  42 import com.google.common.collect.ImmutableSet;
  43
  44 /**
  45  * This is the specification of CtfTmfTrace for use with LTTng 2.x kernel
  46  * traces.
  47  *
  48  * @author Alexandre Montplaisir
  49  */
  50 public class LttngKernelTrace extends CtfTmfTrace implements IKernelTrace {
  51
  52     /**
  53      * Supported Linux kernel tracers
  54      */
  55     private enum OriginTracer {
  56         LTTNG(LttngEventLayout.getInstance()),
  57         LTTNG26(Lttng26EventLayout.getInstance()),
  58         LTTNG27(Lttng27EventLayout.INSTANCE),
  59         PERF(PerfEventLayout.getInstance());
  60
  61         private final @NonNull IKernelAnalysisEventLayout fLayout;
  62
  63         private OriginTracer(@NonNull IKernelAnalysisEventLayout layout) {
  64             fLayout = layout;
  65         }
  66     }
  67
  68     /**
  69      * Event aspects available for all Lttng Kernel traces
  70      */
  71     private static final @NonNull Collection<ITmfEventAspect> LTTNG_KERNEL_ASPECTS;
  72
  73     static {
  74         ImmutableSet.Builder<ITmfEventAspect> builder = ImmutableSet.builder();
  75         builder.addAll(CtfTmfTrace.CTF_ASPECTS);
  76         builder.add(KernelTidAspect.INSTANCE);
  77         builder.add(ThreadPriorityAspect.INSTANCE);
  78         LTTNG_KERNEL_ASPECTS = NonNullUtils.checkNotNull(builder.build());
  79     }
  80
  81     /**
  82      * CTF metadata identifies trace type and tracer version pretty well, we are
  83      * quite confident in the inferred trace type.
  84      */
  85     private static final int CONFIDENCE = 100;
  86
  87     /** The tracer which originated this trace */
  88     private OriginTracer fOriginTracer = null;
  89
  90     /**
  91      * Default constructor
  92      */
  93     public LttngKernelTrace() {
  94         super();
  95     }
  96
  97     @Override
  98     public @NonNull IKernelAnalysisEventLayout getKernelEventLayout() {
  99         OriginTracer tracer = fOriginTracer;
 100         if (tracer == null) {
 101             throw new IllegalStateException("Cannot get the layout of a non-initialized trace!"); //$NON-NLS-1$
 102         }
 103         return tracer.fLayout;
 104     }
 105
 106     @Override
 107     public void initTrace(IResource resource, String path,
 108             Class<? extends ITmfEvent> eventType) throws TmfTraceException {
 109         super.initTrace(resource, path, eventType);
 110         fOriginTracer = getTracerFromEnv();
 111     }
 112
 113     /**
 114      * Identify which tracer generated a trace from its metadata.
 115      */
 116     private OriginTracer getTracerFromEnv() {
 117         String tracerName = CtfUtils.getTracerName(this);
 118         int tracerMajor = CtfUtils.getTracerMajorVersion(this);
 119         int tracerMinor = CtfUtils.getTracerMinorVersion(this);
 120
 121         if ("perf".equals(tracerName)) { //$NON-NLS-1$
 122             return OriginTracer.PERF;
 123
 124         } else if ("lttng-modules".equals(tracerName)) { //$NON-NLS-1$
 125             /* Look for specific versions of LTTng */
 126             if (tracerMajor >= 2) {
 127                 if (tracerMinor >= 7) {
 128                     return OriginTracer.LTTNG27;
 129                 } else if (tracerMinor >= 6) {
 130                     return OriginTracer.LTTNG26;
 131                 }
 132             }
 133         }
 134
 135         /* Use base LTTng layout as default */
 136         return OriginTracer.LTTNG;
 137     }
 138
 139     /**
 140      * {@inheritDoc}
 141      * <p>
 142      * This implementation sets the confidence to 100 if the trace is a valid
 143      * CTF trace in the "kernel" domain.
 144      */
 145     @Override
 146     public IStatus validate(final IProject project, final String path) {
 147         IStatus status = super.validate(project, path);
 148         if (status instanceof CtfTraceValidationStatus) {
 149             Map<String, String> environment = ((CtfTraceValidationStatus) status).getEnvironment();
 150             /* Make sure the domain is "kernel" in the trace's env vars */
 151             String domain = environment.get("domain"); //$NON-NLS-1$
 152             if (domain == null || !domain.equals("\"kernel\"")) { //$NON-NLS-1$
 153                 return new Status(IStatus.ERROR, Activator.PLUGIN_ID, Messages.LttngKernelTrace_DomainError);
 154             }
 155             return new TraceValidationStatus(CONFIDENCE, Activator.PLUGIN_ID);
 156         }
 157         return status;
 158     }
 159
 160     @Override
 161     public Iterable<ITmfEventAspect> getEventAspects() {
 162          return LTTNG_KERNEL_ASPECTS;
 163     }
 164
 165 }