Commit | Line | Data |
---|---|---|
e363eae1 AM |
1 | /******************************************************************************* |
2 | * Copyright (c) 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 | ******************************************************************************/ | |
12 | ||
13 | package org.eclipse.tracecompass.analysis.os.linux.core.trace; | |
14 | ||
15 | import static org.eclipse.tracecompass.common.core.NonNullUtils.checkNotNull; | |
16 | ||
17 | import java.util.Collection; | |
18 | ||
19 | import org.eclipse.jdt.annotation.NonNull; | |
20 | ||
21 | import com.google.common.collect.ImmutableList; | |
22 | ||
23 | /** | |
24 | * A kernel event layout to be used by default. This can be useful for | |
25 | * data-driven traces for example, where they can provide whatever event names | |
26 | * they want. | |
27 | * | |
28 | * Due to historical reasons, the definitions are the same as LTTng event names. | |
29 | * | |
30 | * @author Alexandre Montplaisir | |
dbc7991d | 31 | * @since 1.0 |
e363eae1 | 32 | */ |
698fde87 | 33 | public class DefaultEventLayout implements IKernelAnalysisEventLayout { |
e363eae1 AM |
34 | |
35 | /* Event names */ | |
36 | private static final String IRQ_HANDLER_ENTRY = "irq_handler_entry"; //$NON-NLS-1$ | |
37 | private static final String IRQ_HANDLER_EXIT = "irq_handler_exit"; //$NON-NLS-1$ | |
38 | private static final String SOFTIRQ_ENTRY = "softirq_entry"; //$NON-NLS-1$ | |
39 | private static final String SOFTIRQ_EXIT = "softirq_exit"; //$NON-NLS-1$ | |
40 | private static final String SOFTIRQ_RAISE = "softirq_raise"; //$NON-NLS-1$ | |
a8b8de05 BH |
41 | private static final String HRTIMER_START = "hrtimer_start"; //$NON-NLS-1$ |
42 | private static final String HRTIMER_CANCEL = "hrtimer_cancel"; //$NON-NLS-1$ | |
fb3a499b FG |
43 | private static final String HRTIMER_EXPIRE_ENTRY = "hrtimer_expire_entry"; //$NON-NLS-1$ |
44 | private static final String HRTIMER_EXPIRE_EXIT = "hrtimer_expire_exit"; //$NON-NLS-1$ | |
e363eae1 | 45 | private static final String SCHED_SWITCH = "sched_switch"; //$NON-NLS-1$ |
3bf563da | 46 | private static final String SCHED_PI_SETPRIO = "sched_pi_setprio"; //$NON-NLS-1$ |
e363eae1 | 47 | |
fb3a499b | 48 | private static final String SCHED_TTWU = "sched_ttwu"; //$NON-NLS-1$ |
e8e92916 | 49 | private static final String SCHED_WAKING = "sched_waking"; //$NON-NLS-1$ |
fb3a499b FG |
50 | private static final String SCHED_WAKEUP = "sched_wakeup"; //$NON-NLS-1$ |
51 | private static final String SCHED_WAKEUP_NEW = "sched_wakeup_new"; //$NON-NLS-1$ | |
e363eae1 | 52 | private static final Collection<String> SCHED_WAKEUP_EVENTS = |
0926f3f3 | 53 | checkNotNull(ImmutableList.of(SCHED_WAKEUP, SCHED_WAKEUP_NEW)); |
e363eae1 AM |
54 | |
55 | private static final String SCHED_PROCESS_FORK = "sched_process_fork"; //$NON-NLS-1$ | |
56 | private static final String SCHED_PROCESS_EXIT = "sched_process_exit"; //$NON-NLS-1$ | |
57 | private static final String SCHED_PROCESS_FREE = "sched_process_free"; //$NON-NLS-1$ | |
fb3a499b | 58 | private static final String SCHED_PROCESS_EXEC = "sched_process_exec"; //$NON-NLS-1$ |
e363eae1 AM |
59 | private static final String STATEDUMP_PROCESS_STATE = "lttng_statedump_process_state"; //$NON-NLS-1$ |
60 | ||
61 | private static final String SYSCALL_ENTRY_PREFIX = "sys_"; //$NON-NLS-1$ | |
62 | private static final String COMPAT_SYSCALL_ENTRY_PREFIX = "compat_sys_"; //$NON-NLS-1$ | |
63 | private static final String SYSCALL_EXIT_PREFIX = "exit_syscall"; //$NON-NLS-1$ | |
64 | ||
65 | /* Field names */ | |
66 | private static final String IRQ = "irq"; //$NON-NLS-1$ | |
67 | private static final String TID = "tid"; //$NON-NLS-1$ | |
68 | private static final String VEC = "vec"; //$NON-NLS-1$ | |
69 | private static final String PREV_TID = "prev_tid"; //$NON-NLS-1$ | |
70 | private static final String PREV_STATE = "prev_state"; //$NON-NLS-1$ | |
71 | private static final String NEXT_COMM = "next_comm"; //$NON-NLS-1$ | |
72 | private static final String NEXT_TID = "next_tid"; //$NON-NLS-1$ | |
73 | private static final String PARENT_TID = "parent_tid"; //$NON-NLS-1$ | |
74 | private static final String CHILD_COMM = "child_comm"; //$NON-NLS-1$ | |
75 | private static final String CHILD_TID = "child_tid"; //$NON-NLS-1$ | |
3bf563da CM |
76 | private static final String PRIO = "prio"; //$NON-NLS-1$ |
77 | private static final String NEW_PRIO = "newprio"; //$NON-NLS-1$ | |
78 | private static final String NEXT_PRIO = "next_prio"; //$NON-NLS-1$ | |
fb3a499b FG |
79 | private static final String COMM = "comm"; //$NON-NLS-1$ |
80 | private static final String NAME = "name"; //$NON-NLS-1$ | |
81 | private static final String STATUS = "status"; //$NON-NLS-1$ | |
82 | private static final String PREV_COMM = "prev_comm"; //$NON-NLS-1$ | |
83 | private static final String FILENAME = "filename"; //$NON-NLS-1$ | |
a8b8de05 BH |
84 | private static final String HRTIMER = "hrtimer"; //$NON-NLS-1$ |
85 | private static final String FUNCTION = "function"; //$NON-NLS-1$ | |
86 | private static final String EXPIRES = "expires"; //$NON-NLS-1$ | |
87 | private static final String NOW = "now"; //$NON-NLS-1$ | |
88 | private static final String SOFT_EXPIRES = "softexpires"; //$NON-NLS-1$ | |
e363eae1 | 89 | |
698fde87 GB |
90 | /** |
91 | * Constructor, to be used by classes extending this one. To get an instance | |
92 | * of this class, INSTANCE should be used. | |
93 | * | |
94 | * @since 2.0 | |
95 | */ | |
96 | protected DefaultEventLayout() { | |
e363eae1 AM |
97 | } |
98 | ||
99 | /** | |
100 | * The instance of this event layout | |
101 | * | |
102 | * This object is completely immutable, so no need to create additional | |
103 | * instances via the constructor. | |
104 | */ | |
105 | static final IKernelAnalysisEventLayout INSTANCE = new DefaultEventLayout(); | |
106 | ||
107 | // ------------------------------------------------------------------------ | |
108 | // Event names | |
109 | // ------------------------------------------------------------------------ | |
110 | ||
111 | @Override | |
112 | public String eventIrqHandlerEntry() { | |
113 | return IRQ_HANDLER_ENTRY; | |
114 | } | |
115 | ||
116 | @Override | |
117 | public String eventIrqHandlerExit() { | |
118 | return IRQ_HANDLER_EXIT; | |
119 | } | |
120 | ||
121 | @Override | |
122 | public String eventSoftIrqEntry() { | |
123 | return SOFTIRQ_ENTRY; | |
124 | } | |
125 | ||
126 | @Override | |
127 | public String eventSoftIrqExit() { | |
128 | return SOFTIRQ_EXIT; | |
129 | } | |
130 | ||
131 | @Override | |
132 | public String eventSoftIrqRaise() { | |
133 | return SOFTIRQ_RAISE; | |
134 | } | |
135 | ||
136 | @Override | |
137 | public String eventSchedSwitch() { | |
138 | return SCHED_SWITCH; | |
139 | } | |
140 | ||
dbc7991d AM |
141 | /** |
142 | * @since 1.0 | |
143 | */ | |
3bf563da CM |
144 | @Override |
145 | public String eventSchedPiSetprio() { | |
146 | return SCHED_PI_SETPRIO; | |
147 | } | |
148 | ||
e363eae1 AM |
149 | @Override |
150 | public Collection<String> eventsSchedWakeup() { | |
151 | return SCHED_WAKEUP_EVENTS; | |
152 | } | |
153 | ||
154 | @Override | |
155 | public String eventSchedProcessFork() { | |
156 | return SCHED_PROCESS_FORK; | |
157 | } | |
158 | ||
159 | @Override | |
160 | public String eventSchedProcessExit() { | |
161 | return SCHED_PROCESS_EXIT; | |
162 | } | |
163 | ||
164 | @Override | |
165 | public String eventSchedProcessFree() { | |
166 | return SCHED_PROCESS_FREE; | |
167 | } | |
168 | ||
169 | @Override | |
170 | public @NonNull String eventStatedumpProcessState() { | |
171 | return STATEDUMP_PROCESS_STATE; | |
172 | } | |
173 | ||
174 | @Override | |
175 | public String eventSyscallEntryPrefix() { | |
176 | return SYSCALL_ENTRY_PREFIX; | |
177 | } | |
178 | ||
179 | @Override | |
180 | public String eventCompatSyscallEntryPrefix() { | |
181 | return COMPAT_SYSCALL_ENTRY_PREFIX; | |
182 | } | |
183 | ||
184 | @Override | |
185 | public String eventSyscallExitPrefix() { | |
186 | return SYSCALL_EXIT_PREFIX; | |
187 | } | |
188 | ||
01f2a507 AM |
189 | /** @since 2.0 */ |
190 | @Override | |
191 | public String eventCompatSyscallExitPrefix() { | |
192 | return SYSCALL_EXIT_PREFIX; | |
193 | } | |
194 | ||
e363eae1 AM |
195 | // ------------------------------------------------------------------------ |
196 | // Event field names | |
197 | // ------------------------------------------------------------------------ | |
198 | ||
199 | @Override | |
200 | public String fieldIrq() { | |
201 | return IRQ; | |
202 | } | |
203 | ||
204 | @Override | |
205 | public String fieldVec() { | |
206 | return VEC; | |
207 | } | |
208 | ||
209 | @Override | |
210 | public String fieldTid() { | |
211 | return TID; | |
212 | } | |
213 | ||
214 | @Override | |
215 | public String fieldPrevTid() { | |
216 | return PREV_TID; | |
217 | } | |
218 | ||
219 | @Override | |
220 | public String fieldPrevState() { | |
221 | return PREV_STATE; | |
222 | } | |
223 | ||
224 | @Override | |
225 | public String fieldNextComm() { | |
226 | return NEXT_COMM; | |
227 | } | |
228 | ||
229 | @Override | |
230 | public String fieldNextTid() { | |
231 | return NEXT_TID; | |
232 | } | |
233 | ||
234 | @Override | |
235 | public String fieldChildComm() { | |
236 | return CHILD_COMM; | |
237 | } | |
238 | ||
239 | @Override | |
240 | public String fieldParentTid() { | |
241 | return PARENT_TID; | |
242 | } | |
243 | ||
244 | @Override | |
245 | public String fieldChildTid() { | |
246 | return CHILD_TID; | |
247 | } | |
248 | ||
fb3a499b | 249 | /** @since 1.0 */ |
3bf563da CM |
250 | @Override |
251 | public String fieldPrio() { | |
252 | return PRIO; | |
253 | } | |
254 | ||
fb3a499b | 255 | /** @since 1.0 */ |
3bf563da CM |
256 | @Override |
257 | public String fieldNewPrio() { | |
258 | return NEW_PRIO; | |
259 | } | |
260 | ||
fb3a499b | 261 | /** @since 1.0 */ |
3bf563da CM |
262 | @Override |
263 | public String fieldNextPrio() { | |
264 | return NEXT_PRIO; | |
265 | } | |
266 | ||
fb3a499b FG |
267 | /** @since 2.0 */ |
268 | @Override | |
269 | public String fieldComm() { | |
270 | return COMM; | |
271 | } | |
272 | ||
273 | /** @since 2.0 */ | |
274 | @Override | |
275 | public String fieldName() { | |
276 | return NAME; | |
277 | } | |
278 | ||
279 | /** @since 2.0 */ | |
280 | @Override | |
281 | public String fieldStatus() { | |
282 | return STATUS; | |
283 | } | |
284 | ||
285 | /** @since 2.0 */ | |
286 | @Override | |
287 | public String fieldPrevComm() { | |
288 | return PREV_COMM; | |
289 | } | |
290 | ||
291 | /** @since 2.0 */ | |
292 | @Override | |
293 | public String fieldFilename() { | |
294 | return FILENAME; | |
295 | } | |
296 | ||
297 | /** @since 2.0 */ | |
298 | @Override | |
299 | public String eventSchedProcessExec() { | |
300 | return SCHED_PROCESS_EXEC; | |
301 | } | |
302 | ||
303 | /** @since 2.0 */ | |
304 | @Override | |
305 | public String eventSchedProcessWakeup() { | |
306 | return SCHED_WAKEUP; | |
307 | } | |
308 | ||
309 | /** @since 2.0 */ | |
310 | @Override | |
311 | public String eventSchedProcessWakeupNew() { | |
312 | return SCHED_WAKEUP_NEW; | |
313 | } | |
314 | ||
a8b8de05 BH |
315 | /** @since 2.0 */ |
316 | @Override | |
317 | public String eventHRTimerStart() { | |
318 | return HRTIMER_START; | |
319 | } | |
320 | ||
321 | /** @since 2.0 */ | |
322 | @Override | |
323 | public String eventHRTimerCancel() { | |
324 | return HRTIMER_CANCEL; | |
325 | } | |
326 | ||
fb3a499b FG |
327 | /** @since 2.0 */ |
328 | @Override | |
329 | public String eventHRTimerExpireEntry() { | |
330 | return HRTIMER_EXPIRE_ENTRY; | |
331 | } | |
332 | ||
333 | /** @since 2.0 */ | |
334 | @Override | |
335 | public String eventHRTimerExpireExit() { | |
336 | return HRTIMER_EXPIRE_EXIT; | |
337 | } | |
338 | ||
339 | /** | |
340 | * Event indicating the source of the wakeup signal. | |
341 | * | |
342 | * @return The name of the event | |
343 | * @since 2.0 | |
344 | */ | |
345 | public String eventSchedProcessTTWU() { | |
346 | return SCHED_TTWU; | |
347 | } | |
348 | ||
a8b8de05 BH |
349 | /** @since 2.0 */ |
350 | @Override | |
351 | public String fieldHRtimer() { | |
352 | return HRTIMER; | |
353 | } | |
354 | ||
355 | /** @since 2.0 */ | |
356 | @Override | |
357 | public String fieldHRtimerFunction() { | |
358 | return FUNCTION; | |
359 | } | |
360 | ||
361 | /** @since 2.0 */ | |
362 | @Override | |
363 | public String fieldHRtimerExpires() { | |
364 | return EXPIRES; | |
365 | } | |
366 | ||
367 | /** @since 2.0 */ | |
368 | @Override | |
369 | public String fieldHRtimerSoftexpires() { | |
370 | return SOFT_EXPIRES; | |
371 | } | |
372 | ||
373 | /** @since 2.0 */ | |
374 | @Override | |
375 | public String fieldHRtimerNow() { | |
376 | return NOW; | |
377 | } | |
378 | ||
e8e92916 FG |
379 | /** |
380 | * Event indicating the source of the wakeup signal. | |
381 | * | |
382 | * @return The name of the event | |
383 | * @since 2.0 | |
384 | */ | |
385 | public String eventSchedProcessWaking() { | |
386 | return SCHED_WAKING; | |
387 | } | |
388 | ||
e363eae1 | 389 | } |