1 /**********************************************************************
2 * Copyright (c) 2013, 2014 Ericsson
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
10 * Matthew Khouzam - Initial API and implementation
11 * Alexandre Montplaisir - Add UST callstack state system
12 * Marc-Andre Laperle - Handle BufferOverflowException (Bug 420203)
13 **********************************************************************/
15 package org
.eclipse
.tracecompass
.lttng2
.ust
.core
.trace
;
17 import java
.util
.Collection
;
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
.jdt
.annotation
.Nullable
;
26 import org
.eclipse
.tracecompass
.common
.core
.NonNullUtils
;
27 import org
.eclipse
.tracecompass
.internal
.lttng2
.ust
.core
.Activator
;
28 import org
.eclipse
.tracecompass
.internal
.lttng2
.ust
.core
.trace
.layout
.LttngUst20EventLayout
;
29 import org
.eclipse
.tracecompass
.internal
.lttng2
.ust
.core
.trace
.layout
.LttngUst27EventLayout
;
30 import org
.eclipse
.tracecompass
.internal
.lttng2
.ust
.core
.trace
.layout
.LttngUst28EventLayout
;
31 import org
.eclipse
.tracecompass
.lttng2
.ust
.core
.analysis
.debuginfo
.UstDebugInfoAspect
;
32 import org
.eclipse
.tracecompass
.lttng2
.ust
.core
.trace
.layout
.ILttngUstEventLayout
;
33 import org
.eclipse
.tracecompass
.tmf
.core
.event
.ITmfEvent
;
34 import org
.eclipse
.tracecompass
.tmf
.core
.event
.aspect
.ITmfEventAspect
;
35 import org
.eclipse
.tracecompass
.tmf
.core
.exceptions
.TmfTraceException
;
36 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.TraceValidationStatus
;
37 import org
.eclipse
.tracecompass
.tmf
.ctf
.core
.trace
.CtfTmfTrace
;
38 import org
.eclipse
.tracecompass
.tmf
.ctf
.core
.trace
.CtfTraceValidationStatus
;
39 import org
.eclipse
.tracecompass
.tmf
.ctf
.core
.trace
.CtfUtils
;
41 import com
.google
.common
.collect
.ImmutableSet
;
44 * Class to contain LTTng-UST traces
46 * @author Matthew Khouzam
48 public class LttngUstTrace
extends CtfTmfTrace
{
51 * Name of the tracer that generates this trace type, as found in the CTF
56 public static final String TRACER_NAME
= "lttng-ust"; //$NON-NLS-1$
58 private static final int CONFIDENCE
= 100;
60 private static final @NonNull Collection
<ITmfEventAspect
> LTTNG_UST_ASPECTS
;
63 ImmutableSet
.Builder
<ITmfEventAspect
> builder
= ImmutableSet
.builder();
64 builder
.addAll(CtfTmfTrace
.CTF_ASPECTS
);
65 builder
.add(UstDebugInfoAspect
.INSTANCE
);
66 LTTNG_UST_ASPECTS
= NonNullUtils
.checkNotNull(builder
.build());
69 private @Nullable ILttngUstEventLayout fLayout
= null;
74 public LttngUstTrace() {
79 * Get the event layout to use with this trace. This normally depends on the
82 * @return The event layout
85 public @NonNull ILttngUstEventLayout
getEventLayout() {
86 ILttngUstEventLayout layout
= fLayout
;
88 throw new IllegalStateException("Cannot get the layout of a non-initialized trace!"); //$NON-NLS-1$
94 public void initTrace(IResource resource
, String path
,
95 Class
<?
extends ITmfEvent
> eventType
) throws TmfTraceException
{
96 super.initTrace(resource
, path
, eventType
);
98 /* Determine the event layout to use from the tracer's version */
99 fLayout
= getLayoutFromEnv();
102 private @NonNull ILttngUstEventLayout
getLayoutFromEnv() {
103 String tracerName
= CtfUtils
.getTracerName(this);
104 int tracerMajor
= CtfUtils
.getTracerMajorVersion(this);
105 int tracerMinor
= CtfUtils
.getTracerMinorVersion(this);
107 if (TRACER_NAME
.equals(tracerName
)) {
108 if (tracerMajor
>= 2) {
109 if (tracerMinor
>= 8) {
110 return LttngUst28EventLayout
.getInstance();
111 } else if (tracerMinor
>= 7) {
112 return LttngUst27EventLayout
.getInstance();
114 return LttngUst20EventLayout
.getInstance();
118 /* Fallback to the UST 2.0 layout and hope for the best */
119 return LttngUst20EventLayout
.getInstance();
123 public Iterable
<ITmfEventAspect
> getEventAspects() {
124 return LTTNG_UST_ASPECTS
;
130 * This implementation sets the confidence to 100 if the trace is a valid
131 * CTF trace in the "ust" domain.
134 public IStatus
validate(final IProject project
, final String path
) {
135 IStatus status
= super.validate(project
, path
);
136 if (status
instanceof CtfTraceValidationStatus
) {
137 Map
<String
, String
> environment
= ((CtfTraceValidationStatus
) status
).getEnvironment();
138 /* Make sure the domain is "ust" in the trace's env vars */
139 String domain
= environment
.get("domain"); //$NON-NLS-1$
140 if (domain
== null || !domain
.equals("\"ust\"")) { //$NON-NLS-1$
141 return new Status(IStatus
.ERROR
, Activator
.PLUGIN_ID
, Messages
.LttngUstTrace_DomainError
);
143 return new TraceValidationStatus(CONFIDENCE
, Activator
.PLUGIN_ID
);