org.eclipse.tracecompass.analysis.os.linux.core/src/org/eclipse/tracecompass/analysis/os/linux/core/trace/DefaultEventLayout.java

   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
  31  */
  32 public class DefaultEventLayout implements IKernelAnalysisEventLayout{
  33
  34     /* Event names */
  35     private static final String IRQ_HANDLER_ENTRY = "irq_handler_entry"; //$NON-NLS-1$
  36     private static final String IRQ_HANDLER_EXIT = "irq_handler_exit"; //$NON-NLS-1$
  37     private static final String SOFTIRQ_ENTRY = "softirq_entry"; //$NON-NLS-1$
  38     private static final String SOFTIRQ_EXIT = "softirq_exit"; //$NON-NLS-1$
  39     private static final String SOFTIRQ_RAISE = "softirq_raise"; //$NON-NLS-1$
  40     private static final String SCHED_SWITCH = "sched_switch"; //$NON-NLS-1$
  41
  42     private static final Collection<String> SCHED_WAKEUP_EVENTS =
  43             checkNotNull(ImmutableList.of("sched_wakeup", "sched_wakeup_new")); //$NON-NLS-1$ //$NON-NLS-2$
  44
  45     private static final String SCHED_PROCESS_FORK = "sched_process_fork"; //$NON-NLS-1$
  46     private static final String SCHED_PROCESS_EXIT = "sched_process_exit"; //$NON-NLS-1$
  47     private static final String SCHED_PROCESS_FREE = "sched_process_free"; //$NON-NLS-1$
  48     private static final String STATEDUMP_PROCESS_STATE = "lttng_statedump_process_state"; //$NON-NLS-1$
  49
  50     private static final String SYSCALL_ENTRY_PREFIX = "sys_"; //$NON-NLS-1$
  51     private static final String COMPAT_SYSCALL_ENTRY_PREFIX = "compat_sys_"; //$NON-NLS-1$
  52     private static final String SYSCALL_EXIT_PREFIX = "exit_syscall"; //$NON-NLS-1$
  53
  54     /* Field names */
  55     private static final String IRQ = "irq"; //$NON-NLS-1$
  56     private static final String TID = "tid"; //$NON-NLS-1$
  57     private static final String VEC = "vec"; //$NON-NLS-1$
  58     private static final String PREV_TID = "prev_tid"; //$NON-NLS-1$
  59     private static final String PREV_STATE = "prev_state"; //$NON-NLS-1$
  60     private static final String NEXT_COMM = "next_comm"; //$NON-NLS-1$
  61     private static final String NEXT_TID = "next_tid"; //$NON-NLS-1$
  62     private static final String PARENT_TID = "parent_tid"; //$NON-NLS-1$
  63     private static final String CHILD_COMM = "child_comm"; //$NON-NLS-1$
  64     private static final String CHILD_TID = "child_tid"; //$NON-NLS-1$
  65
  66     /** All instances are the same. Only provide a static instance getter */
  67     private DefaultEventLayout() {
  68     }
  69
  70     /**
  71      * The instance of this event layout
  72      *
  73      * This object is completely immutable, so no need to create additional
  74      * instances via the constructor.
  75      */
  76     static final IKernelAnalysisEventLayout INSTANCE = new DefaultEventLayout();
  77
  78     // ------------------------------------------------------------------------
  79     // Event names
  80     // ------------------------------------------------------------------------
  81
  82     @Override
  83     public String eventIrqHandlerEntry() {
  84         return IRQ_HANDLER_ENTRY;
  85     }
  86
  87     @Override
  88     public String eventIrqHandlerExit() {
  89         return IRQ_HANDLER_EXIT;
  90     }
  91
  92     @Override
  93     public String eventSoftIrqEntry() {
  94         return SOFTIRQ_ENTRY;
  95     }
  96
  97     @Override
  98     public String eventSoftIrqExit() {
  99         return SOFTIRQ_EXIT;
 100     }
 101
 102     @Override
 103     public String eventSoftIrqRaise() {
 104         return SOFTIRQ_RAISE;
 105     }
 106
 107     @Override
 108     public String eventSchedSwitch() {
 109         return SCHED_SWITCH;
 110     }
 111
 112     @Override
 113     public Collection<String> eventsSchedWakeup() {
 114         return SCHED_WAKEUP_EVENTS;
 115     }
 116
 117     @Override
 118     public String eventSchedProcessFork() {
 119         return SCHED_PROCESS_FORK;
 120     }
 121
 122     @Override
 123     public String eventSchedProcessExit() {
 124         return SCHED_PROCESS_EXIT;
 125     }
 126
 127     @Override
 128     public String eventSchedProcessFree() {
 129         return SCHED_PROCESS_FREE;
 130     }
 131
 132     @Override
 133     public @NonNull String eventStatedumpProcessState() {
 134         return STATEDUMP_PROCESS_STATE;
 135     }
 136
 137     @Override
 138     public String eventSyscallEntryPrefix() {
 139         return SYSCALL_ENTRY_PREFIX;
 140     }
 141
 142     @Override
 143     public String eventCompatSyscallEntryPrefix() {
 144         return COMPAT_SYSCALL_ENTRY_PREFIX;
 145     }
 146
 147     @Override
 148     public String eventSyscallExitPrefix() {
 149         return SYSCALL_EXIT_PREFIX;
 150     }
 151
 152     // ------------------------------------------------------------------------
 153     // Event field names
 154     // ------------------------------------------------------------------------
 155
 156     @Override
 157     public String fieldIrq() {
 158         return IRQ;
 159     }
 160
 161     @Override
 162     public String fieldVec() {
 163         return VEC;
 164     }
 165
 166     @Override
 167     public String fieldTid() {
 168         return TID;
 169     }
 170
 171     @Override
 172     public String fieldPrevTid() {
 173         return PREV_TID;
 174     }
 175
 176     @Override
 177     public String fieldPrevState() {
 178         return PREV_STATE;
 179     }
 180
 181     @Override
 182     public String fieldNextComm() {
 183         return NEXT_COMM;
 184     }
 185
 186     @Override
 187     public String fieldNextTid() {
 188         return NEXT_TID;
 189     }
 190
 191     @Override
 192     public String fieldChildComm() {
 193         return CHILD_COMM;
 194     }
 195
 196     @Override
 197     public String fieldParentTid() {
 198         return PARENT_TID;
 199     }
 200
 201     @Override
 202     public String fieldChildTid() {
 203         return CHILD_TID;
 204     }
 205
 206 }