1 /*******************************************************************************
2 * Copyright (c) 2015 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 * Alexandre Montplaisir - Initial API and implementation
11 ******************************************************************************/
13 package org
.eclipse
.tracecompass
.analysis
.os
.linux
.core
.trace
;
15 import java
.util
.Collection
;
17 import org
.eclipse
.jdt
.annotation
.NonNull
;
19 import com
.google
.common
.collect
.ImmutableList
;
22 * A kernel event layout to be used by default. This can be useful for
23 * data-driven traces for example, where they can provide whatever event names
26 * Due to historical reasons, the definitions are the same as LTTng event names.
28 * @author Alexandre Montplaisir
31 public class DefaultEventLayout
implements IKernelAnalysisEventLayout
{
34 private static final String IRQ_HANDLER_ENTRY
= "irq_handler_entry"; //$NON-NLS-1$
35 private static final String IRQ_HANDLER_EXIT
= "irq_handler_exit"; //$NON-NLS-1$
36 private static final String SOFTIRQ_ENTRY
= "softirq_entry"; //$NON-NLS-1$
37 private static final String SOFTIRQ_EXIT
= "softirq_exit"; //$NON-NLS-1$
38 private static final String SOFTIRQ_RAISE
= "softirq_raise"; //$NON-NLS-1$
39 private static final String HRTIMER_START
= "hrtimer_start"; //$NON-NLS-1$
40 private static final String HRTIMER_CANCEL
= "hrtimer_cancel"; //$NON-NLS-1$
41 private static final String HRTIMER_EXPIRE_ENTRY
= "hrtimer_expire_entry"; //$NON-NLS-1$
42 private static final String HRTIMER_EXPIRE_EXIT
= "hrtimer_expire_exit"; //$NON-NLS-1$
43 private static final String SCHED_SWITCH
= "sched_switch"; //$NON-NLS-1$
44 private static final String SCHED_PI_SETPRIO
= "sched_pi_setprio"; //$NON-NLS-1$
46 private static final String SCHED_TTWU
= "sched_ttwu"; //$NON-NLS-1$
47 private static final String SCHED_WAKING
= "sched_waking"; //$NON-NLS-1$
48 private static final String SCHED_WAKEUP
= "sched_wakeup"; //$NON-NLS-1$
49 private static final String SCHED_WAKEUP_NEW
= "sched_wakeup_new"; //$NON-NLS-1$
50 private static final Collection
<String
> SCHED_WAKEUP_EVENTS
=
51 ImmutableList
.of(SCHED_WAKEUP
, SCHED_WAKEUP_NEW
);
53 private static final String SCHED_PROCESS_FORK
= "sched_process_fork"; //$NON-NLS-1$
54 private static final String SCHED_PROCESS_EXIT
= "sched_process_exit"; //$NON-NLS-1$
55 private static final String SCHED_PROCESS_FREE
= "sched_process_free"; //$NON-NLS-1$
56 private static final String SCHED_PROCESS_EXEC
= "sched_process_exec"; //$NON-NLS-1$
57 private static final String STATEDUMP_PROCESS_STATE
= "lttng_statedump_process_state"; //$NON-NLS-1$
59 private static final String SYSCALL_ENTRY_PREFIX
= "sys_"; //$NON-NLS-1$
60 private static final String COMPAT_SYSCALL_ENTRY_PREFIX
= "compat_sys_"; //$NON-NLS-1$
61 private static final String SYSCALL_EXIT_PREFIX
= "exit_syscall"; //$NON-NLS-1$
64 private static final String IRQ
= "irq"; //$NON-NLS-1$
65 private static final String TID
= "tid"; //$NON-NLS-1$
66 private static final String VEC
= "vec"; //$NON-NLS-1$
67 private static final String PREV_TID
= "prev_tid"; //$NON-NLS-1$
68 private static final String PREV_STATE
= "prev_state"; //$NON-NLS-1$
69 private static final String NEXT_COMM
= "next_comm"; //$NON-NLS-1$
70 private static final String NEXT_TID
= "next_tid"; //$NON-NLS-1$
71 private static final String PARENT_TID
= "parent_tid"; //$NON-NLS-1$
72 private static final String CHILD_COMM
= "child_comm"; //$NON-NLS-1$
73 private static final String CHILD_TID
= "child_tid"; //$NON-NLS-1$
74 private static final String PRIO
= "prio"; //$NON-NLS-1$
75 private static final String NEW_PRIO
= "newprio"; //$NON-NLS-1$
76 private static final String NEXT_PRIO
= "next_prio"; //$NON-NLS-1$
77 private static final String COMM
= "comm"; //$NON-NLS-1$
78 private static final String NAME
= "name"; //$NON-NLS-1$
79 private static final String STATUS
= "status"; //$NON-NLS-1$
80 private static final String PREV_COMM
= "prev_comm"; //$NON-NLS-1$
81 private static final String FILENAME
= "filename"; //$NON-NLS-1$
82 private static final String HRTIMER
= "hrtimer"; //$NON-NLS-1$
83 private static final String FUNCTION
= "function"; //$NON-NLS-1$
84 private static final String EXPIRES
= "expires"; //$NON-NLS-1$
85 private static final String NOW
= "now"; //$NON-NLS-1$
86 private static final String SOFT_EXPIRES
= "softexpires"; //$NON-NLS-1$
87 private static final String KMEM_ALLOC
= "kmem_mm_page_alloc"; //$NON-NLS-1$
88 private static final String KMEM_FREE
= "kmem_mm_page_free"; //$NON-NLS-1$
91 * Constructor, to be used by classes extending this one. To get an instance
92 * of this class, INSTANCE should be used.
96 protected DefaultEventLayout() {
100 * The instance of this event layout
102 * This object is completely immutable, so no need to create additional
103 * instances via the constructor.
105 static final IKernelAnalysisEventLayout INSTANCE
= new DefaultEventLayout();
107 // ------------------------------------------------------------------------
109 // ------------------------------------------------------------------------
112 public String
eventIrqHandlerEntry() {
113 return IRQ_HANDLER_ENTRY
;
117 public String
eventIrqHandlerExit() {
118 return IRQ_HANDLER_EXIT
;
122 public String
eventSoftIrqEntry() {
123 return SOFTIRQ_ENTRY
;
127 public String
eventSoftIrqExit() {
132 public String
eventSoftIrqRaise() {
133 return SOFTIRQ_RAISE
;
137 public String
eventSchedSwitch() {
145 public String
eventSchedPiSetprio() {
146 return SCHED_PI_SETPRIO
;
150 public Collection
<String
> eventsSchedWakeup() {
151 return SCHED_WAKEUP_EVENTS
;
155 public String
eventSchedProcessFork() {
156 return SCHED_PROCESS_FORK
;
160 public String
eventSchedProcessExit() {
161 return SCHED_PROCESS_EXIT
;
165 public String
eventSchedProcessFree() {
166 return SCHED_PROCESS_FREE
;
170 public @NonNull String
eventStatedumpProcessState() {
171 return STATEDUMP_PROCESS_STATE
;
175 public String
eventSyscallEntryPrefix() {
176 return SYSCALL_ENTRY_PREFIX
;
180 public String
eventCompatSyscallEntryPrefix() {
181 return COMPAT_SYSCALL_ENTRY_PREFIX
;
185 public String
eventSyscallExitPrefix() {
186 return SYSCALL_EXIT_PREFIX
;
191 public String
eventCompatSyscallExitPrefix() {
192 return SYSCALL_EXIT_PREFIX
;
198 public String
eventKmemPageAlloc() {
206 public String
eventKmemPageFree() {
211 // ------------------------------------------------------------------------
213 // ------------------------------------------------------------------------
216 public String
fieldIrq() {
221 public String
fieldVec() {
226 public String
fieldTid() {
231 public String
fieldPrevTid() {
236 public String
fieldPrevState() {
241 public String
fieldNextComm() {
246 public String
fieldNextTid() {
251 public String
fieldChildComm() {
256 public String
fieldParentTid() {
261 public String
fieldChildTid() {
267 public String
fieldPrio() {
273 public String
fieldNewPrio() {
279 public String
fieldNextPrio() {
285 public String
fieldComm() {
291 public String
fieldName() {
297 public String
fieldStatus() {
303 public String
fieldPrevComm() {
309 public String
fieldFilename() {
315 public String
eventSchedProcessExec() {
316 return SCHED_PROCESS_EXEC
;
321 public String
eventSchedProcessWakeup() {
327 public String
eventSchedProcessWakeupNew() {
328 return SCHED_WAKEUP_NEW
;
333 public String
eventHRTimerStart() {
334 return HRTIMER_START
;
339 public String
eventHRTimerCancel() {
340 return HRTIMER_CANCEL
;
345 public String
eventHRTimerExpireEntry() {
346 return HRTIMER_EXPIRE_ENTRY
;
351 public String
eventHRTimerExpireExit() {
352 return HRTIMER_EXPIRE_EXIT
;
356 * Event indicating the source of the wakeup signal.
358 * @return The name of the event
361 public String
eventSchedProcessTTWU() {
367 public String
fieldHRtimer() {
373 public String
fieldHRtimerFunction() {
379 public String
fieldHRtimerExpires() {
385 public String
fieldHRtimerSoftexpires() {
391 public String
fieldHRtimerNow() {
396 * Event indicating the source of the wakeup signal.
398 * @return The name of the event
401 public String
eventSchedProcessWaking() {