lttng: Add interface to abstract the event layout away
[deliverable/tracecompass.git] / org.eclipse.tracecompass.lttng2.kernel.core / src / org / eclipse / tracecompass / internal / lttng2 / kernel / core / trace / layout / LttngEventLayout.java
1 /*******************************************************************************
2 * Copyright (c) 2012, 2014 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 ******************************************************************************/
12
13 package org.eclipse.tracecompass.internal.lttng2.kernel.core.trace.layout;
14
15 import java.util.Collection;
16
17 import org.eclipse.jdt.annotation.NonNull;
18
19 import com.google.common.collect.ImmutableList;
20
21 /**
22 * This file defines all the known event and field names for LTTng 2.0 kernel
23 * traces.
24 *
25 * These should not be externalized, since they need to match exactly what the
26 * tracer outputs. If you want to localize them in a view, you should do a
27 * mapping in the view itself.
28 *
29 * @author Alexandre Montplaisir
30 */
31 @SuppressWarnings("nls")
32 public class LttngEventLayout implements IKernelAnalysisEventLayout {
33
34 /* Event names */
35 private static final String EXIT_SYSCALL = "exit_syscall";
36 private static final String IRQ_HANDLER_ENTRY = "irq_handler_entry";
37 private static final String IRQ_HANDLER_EXIT = "irq_handler_exit";
38 private static final String SOFTIRQ_ENTRY = "softirq_entry";
39 private static final String SOFTIRQ_EXIT = "softirq_exit";
40 private static final String SOFTIRQ_RAISE = "softirq_raise";
41 private static final String SCHED_SWITCH = "sched_switch";
42
43 @SuppressWarnings("null")
44 private static final @NonNull Collection<String> SCHED_WAKEUP_EVENTS = ImmutableList.of("sched_wakeup", "sched_wakeup_new");
45
46 private static final String SCHED_PROCESS_FORK = "sched_process_fork";
47 private static final String SCHED_PROCESS_EXIT = "sched_process_exit";
48 private static final String SCHED_PROCESS_FREE = "sched_process_free";
49 private static final String STATEDUMP_PROCESS_STATE = "lttng_statedump_process_state";
50
51 private static final String SYSCALL_PREFIX = "sys_";
52 private static final String COMPAT_SYSCALL_PREFIX = "compat_sys_";
53
54 /* Field names */
55 private static final String IRQ = "irq";
56 private static final String TID = "tid";
57 private static final String VEC = "vec";
58 private static final String PREV_TID = "prev_tid";
59 private static final String PREV_STATE = "prev_state";
60 private static final String NEXT_COMM = "next_comm";
61 private static final String NEXT_TID = "next_tid";
62 private static final String PARENT_TID = "parent_tid";
63 private static final String CHILD_COMM = "child_comm";
64 private static final String CHILD_TID = "child_tid";
65
66 /** All instances are the same. Only provide a static instance getter */
67 private LttngEventLayout() {
68 }
69
70 private static final IKernelAnalysisEventLayout INSTANCE = new LttngEventLayout();
71
72 /**
73 * Get an instance of this event layout
74 *
75 * This object is completely immutable, so no need to create additional
76 * instances via the constructor.
77 *
78 * @return The instance
79 */
80 public static IKernelAnalysisEventLayout getInstance() {
81 return INSTANCE;
82 }
83
84 // ------------------------------------------------------------------------
85 // Event names
86 // ------------------------------------------------------------------------
87
88 @Override
89 public String eventIrqHandlerEntry() {
90 return IRQ_HANDLER_ENTRY;
91 }
92
93 @Override
94 public String eventIrqHandlerExit() {
95 return IRQ_HANDLER_EXIT;
96 }
97
98 @Override
99 public String eventSoftIrqEntry() {
100 return SOFTIRQ_ENTRY;
101 }
102
103 @Override
104 public String eventSoftIrqExit() {
105 return SOFTIRQ_EXIT;
106 }
107
108 @Override
109 public String eventSoftIrqRaise() {
110 return SOFTIRQ_RAISE;
111 }
112
113 @Override
114 public String eventSchedSwitch() {
115 return SCHED_SWITCH;
116 }
117
118 @Override
119 public Collection<String> eventsSchedWakeup() {
120 return SCHED_WAKEUP_EVENTS;
121 }
122
123 @Override
124 public String eventSchedProcessFork() {
125 return SCHED_PROCESS_FORK;
126 }
127
128 @Override
129 public String eventSchedProcessExit() {
130 return SCHED_PROCESS_EXIT;
131 }
132
133 @Override
134 public String eventSchedProcessFree() {
135 return SCHED_PROCESS_FREE;
136 }
137
138 @Override
139 public String eventStatedumpProcessState() {
140 return STATEDUMP_PROCESS_STATE;
141 }
142 @Override
143 public String eventSyscallExit() {
144 return EXIT_SYSCALL;
145 }
146
147 @Override
148 public String eventSyscallEntryPrefix() {
149 return SYSCALL_PREFIX;
150 }
151
152 @Override
153 public String eventCompatSyscallEntryPrefix() {
154 return COMPAT_SYSCALL_PREFIX;
155 }
156
157 // ------------------------------------------------------------------------
158 // Event field names
159 // ------------------------------------------------------------------------
160
161 @Override
162 public String fieldIrq() {
163 return IRQ;
164 }
165
166 @Override
167 public String fieldVec() {
168 return VEC;
169 }
170
171 @Override
172 public String fieldTid() {
173 return TID;
174 }
175
176 @Override
177 public String fieldPrevTid() {
178 return PREV_TID;
179 }
180
181 @Override
182 public String fieldPrevState() {
183 return PREV_STATE;
184 }
185
186 @Override
187 public String fieldNextComm() {
188 return NEXT_COMM;
189 }
190
191 @Override
192 public String fieldNextTid() {
193 return NEXT_TID;
194 }
195
196 @Override
197 public String fieldChildComm() {
198 return CHILD_COMM;
199 }
200
201 @Override
202 public String fieldParentTid() {
203 return PARENT_TID;
204 }
205
206 @Override
207 public String fieldChildTid() {
208 return CHILD_TID;
209 }
210
211 }
This page took 0.035746 seconds and 5 git commands to generate.