1 /*******************************************************************************
2 * Copyright (c) 2014, 2015 École Polytechnique de Montréal
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 * Geneviève Bastien - Initial API and implementation
11 * Guilliano Molaire - Provide the requirements of the analysis
12 *******************************************************************************/
14 package org
.eclipse
.tracecompass
.lttng2
.ust
.core
.analysis
.memory
;
16 import static org
.eclipse
.tracecompass
.common
.core
.NonNullUtils
.checkNotNull
;
20 import org
.eclipse
.jdt
.annotation
.NonNull
;
21 import org
.eclipse
.tracecompass
.internal
.lttng2
.ust
.core
.memoryusage
.MemoryUsageStateProvider
;
22 import org
.eclipse
.tracecompass
.internal
.lttng2
.ust
.core
.memoryusage
.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
;
32 import com
.google
.common
.collect
.ImmutableSet
;
35 * This analysis build a state system from the libc memory instrumentation on a
38 * @author Geneviève Bastien
40 public class UstMemoryAnalysisModule
extends TmfStateSystemAnalysisModule
{
43 * Analysis ID, it should match that in the plugin.xml file
45 public static String ID
= "org.eclipse.linuxtools.lttng2.ust.analysis.memory"; //$NON-NLS-1$
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
56 /** The requirements as an immutable set */
57 private static final @NonNull Set
<TmfAnalysisRequirement
> REQUIREMENTS
;
60 /* Initialize the requirements for the analysis: domain and events */
61 TmfAnalysisRequirement eventsReq
= new TmfAnalysisRequirement(SessionConfigStrings
.CONFIG_ELEMENT_EVENT
, REQUIRED_EVENTS
, ValuePriorityLevel
.MANDATORY
);
63 * In order to have these events, the libc wrapper with probes should be
66 eventsReq
.addInformation(Messages
.UstMemoryAnalysisModule_EventsLoadingInformation
);
67 eventsReq
.addInformation(Messages
.UstMemoryAnalysisModule_EventsLoadingExampleInformation
);
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
);
73 REQUIREMENTS
= checkNotNull(ImmutableSet
.of(domainReq
, eventsReq
));
77 protected ITmfStateProvider
createStateProvider() {
78 return new MemoryUsageStateProvider(checkNotNull(getTrace()));
82 public void setTrace(ITmfTrace trace
) throws TmfAnalysisException
{
83 if (!(trace
instanceof LttngUstTrace
)) {
84 throw new IllegalStateException("UstMemoryAnalysisModule: trace should be of type LttngUstTrace"); //$NON-NLS-1$
86 super.setTrace(trace
);
90 protected LttngUstTrace
getTrace() {
91 return (LttngUstTrace
) super.getTrace();
95 public Iterable
<TmfAnalysisRequirement
> getAnalysisRequirements() {