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