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