tmf: Rename packages to org.eclipse.tracecompass.*
[deliverable/tracecompass.git] / org.eclipse.tracecompass.lttng2.kernel.core / src / org / eclipse / linuxtools / lttng2 / kernel / core / analysis / LttngKernelAnalysisModule.java
CommitLineData
4bc53929 1/*******************************************************************************
60ae41e1 2 * Copyright (c) 2013, 2014 École Polytechnique de Montréal
4bc53929
GB
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
52cb603c 11 * Mathieu Rail - Provide the requirements of the analysis
4bc53929
GB
12 *******************************************************************************/
13
e3366401 14package org.eclipse.linuxtools.lttng2.kernel.core.analysis;
4bc53929
GB
15
16import org.eclipse.jdt.annotation.NonNull;
52cb603c 17import org.eclipse.linuxtools.internal.lttng2.kernel.core.LttngStrings;
4bc53929 18import org.eclipse.linuxtools.internal.lttng2.kernel.core.stateprovider.LttngKernelStateProvider;
52cb603c 19import org.eclipse.linuxtools.lttng2.control.core.session.SessionConfigStrings;
2bdf0193
AM
20import org.eclipse.tracecompass.tmf.core.analysis.TmfAnalysisRequirement;
21import org.eclipse.tracecompass.tmf.core.analysis.TmfAnalysisRequirement.ValuePriorityLevel;
22import org.eclipse.tracecompass.tmf.core.statesystem.ITmfStateProvider;
23import org.eclipse.tracecompass.tmf.core.statesystem.TmfStateSystemAnalysisModule;
4bc53929 24
52cb603c
GM
25import com.google.common.collect.ImmutableSet;
26
4bc53929
GB
27/**
28 * State System Module for lttng kernel traces
29 *
30 * @author Geneviève Bastien
31 * @since 3.0
32 */
33public class LttngKernelAnalysisModule extends TmfStateSystemAnalysisModule {
34
35 /**
36 * The file name of the History Tree
37 */
72221aa4 38 public static final @NonNull String HISTORY_TREE_FILE_NAME = "stateHistory.ht"; //$NON-NLS-1$
4bc53929
GB
39
40 /** The ID of this analysis module */
72221aa4 41 public static final @NonNull String ID = "org.eclipse.linuxtools.lttng2.kernel.analysis"; //$NON-NLS-1$
4bc53929 42
eb00d54d
MK
43 /*
44 * TODO: Decide which events should be mandatory for the analysis, once the
45 * appropriate error messages and session setup are in place.
46 */
47 private static final ImmutableSet<String> REQUIRED_EVENTS = ImmutableSet.of();
48
49 private static final ImmutableSet<String> OPTIONAL_EVENTS = ImmutableSet.of(
52cb603c
GM
50 LttngStrings.EXIT_SYSCALL,
51 LttngStrings.IRQ_HANDLER_ENTRY,
52 LttngStrings.IRQ_HANDLER_EXIT,
53 LttngStrings.SOFTIRQ_ENTRY,
54 LttngStrings.SOFTIRQ_EXIT,
55 LttngStrings.SOFTIRQ_RAISE,
52cb603c
GM
56 LttngStrings.SCHED_PROCESS_FORK,
57 LttngStrings.SCHED_PROCESS_EXIT,
58 LttngStrings.SCHED_PROCESS_FREE,
eb00d54d 59 LttngStrings.SCHED_SWITCH,
52cb603c
GM
60 LttngStrings.STATEDUMP_PROCESS_STATE,
61 LttngStrings.SCHED_WAKEUP,
eb00d54d 62 LttngStrings.SCHED_WAKEUP_NEW,
26683871 63
eb00d54d 64 /* FIXME Add the prefix for syscalls */
52cb603c
GM
65 LttngStrings.SYSCALL_PREFIX
66 );
67
68 /** The requirements as an immutable set */
69 private static final ImmutableSet<TmfAnalysisRequirement> REQUIREMENTS;
70
71 static {
72 /* initialize the requirement: domain and events */
73 TmfAnalysisRequirement domainReq = new TmfAnalysisRequirement(SessionConfigStrings.CONFIG_ELEMENT_DOMAIN);
74 domainReq.addValue(SessionConfigStrings.CONFIG_DOMAIN_TYPE_KERNEL, ValuePriorityLevel.MANDATORY);
75
26683871
GB
76 TmfAnalysisRequirement eventReq = new TmfAnalysisRequirement(SessionConfigStrings.CONFIG_ELEMENT_EVENT, REQUIRED_EVENTS, ValuePriorityLevel.MANDATORY);
77 eventReq.addValues(OPTIONAL_EVENTS, ValuePriorityLevel.OPTIONAL);
78
79 REQUIREMENTS = ImmutableSet.of(domainReq, eventReq);
4bc53929
GB
80 }
81
4bc53929
GB
82 @Override
83 @NonNull
84 protected ITmfStateProvider createStateProvider() {
85 return new LttngKernelStateProvider(getTrace());
86 }
87
4bc53929
GB
88 @Override
89 @NonNull
90 protected String getSsFileName() {
91 return HISTORY_TREE_FILE_NAME;
92 }
93
94 @Override
95 protected String getFullHelpText() {
e3366401 96 return Messages.LttngKernelAnalysisModule_Help;
4bc53929
GB
97 }
98
52cb603c
GM
99 @Override
100 public Iterable<TmfAnalysisRequirement> getAnalysisRequirements() {
101 return REQUIREMENTS;
102 }
4bc53929 103}
This page took 0.03928 seconds and 5 git commands to generate.