lttng/org.eclipse.tracecompass.lttng2.kernel.core/src/org/eclipse/tracecompass/internal/lttng2/kernel/core/trace/layout/LttngEventLayout.java

   1 /*******************************************************************************
   2  * Copyright (c) 2012, 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.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 HRTIMER_START = "hrtimer_start";
  44     private static final String HRTIMER_CANCEL = "hrtimer_cancel";
  45     private static final String HRTIMER_EXPIRE_ENTRY = "hrtimer_expire_entry";
  46     private static final String HRTIMER_EXPIRE_EXIT = "hrtimer_expire_exit";
  47     private static final String SCHED_SWITCH = "sched_switch";
  48     private static final String SCHED_PI_SETPRIO = "sched_pi_setprio";
  49
  50     private static final String SCHED_TTWU = "sched_ttwu";
  51     private static final String SCHED_WAKEUP = "sched_wakeup";
  52     private static final String SCHED_WAKEUP_NEW = "sched_wakeup_new";
  53     private static final Collection<String> SCHED_WAKEUP_EVENTS =
  54             checkNotNull(ImmutableList.of(SCHED_WAKEUP, SCHED_WAKEUP_NEW));
  55
  56     private static final String SCHED_PROCESS_FORK = "sched_process_fork";
  57     private static final String SCHED_PROCESS_EXIT = "sched_process_exit";
  58     private static final String SCHED_PROCESS_FREE = "sched_process_free";
  59     private static final String SCHED_PROCESS_EXEC = "sched_process_exec";
  60     private static final String STATEDUMP_PROCESS_STATE = "lttng_statedump_process_state";
  61
  62     private static final String SYSCALL_ENTRY_PREFIX = "sys_";
  63     private static final String COMPAT_SYSCALL_ENTRY_PREFIX = "compat_sys_";
  64     private static final String SYSCALL_EXIT_PREFIX = "exit_syscall";
  65
  66     /* Field names */
  67     private static final String IRQ = "irq";
  68     private static final String TID = "tid";
  69     private static final String VEC = "vec";
  70     private static final String PREV_TID = "prev_tid";
  71     private static final String PREV_STATE = "prev_state";
  72     private static final String NEXT_COMM = "next_comm";
  73     private static final String NEXT_TID = "next_tid";
  74     private static final String PARENT_TID = "parent_tid";
  75     private static final String CHILD_COMM = "child_comm";
  76     private static final String CHILD_TID = "child_tid";
  77     private static final String PRIO = "prio";
  78     private static final String NEXT_PRIO = "next_prio";
  79     private static final String NEW_PRIO = "newprio";
  80     private static final String COMM = "comm";
  81     private static final String NAME = "name";
  82     private static final String STATUS = "status";
  83     private static final String PREV_COMM = "prev_comm";
  84     private static final String FILENAME = "filename";
  85     private static final String HRTIMER = "hrtimer";
  86     private static final String HRTIMER_FUNCTION = "function";
  87     private static final String HRTIMER_EXPIRES = "expires";
  88     private static final String HRTIMER_NOW = "now";
  89     private static final String HRTIMER_SOFT_EXPIRES = "softexpires";
  90
  91     /** All instances are the same. Only provide a static instance getter */
  92     protected LttngEventLayout() {
  93     }
  94
  95     private static final IKernelAnalysisEventLayout INSTANCE = new LttngEventLayout();
  96
  97     /**
  98      * Get an instance of this event layout
  99      *
 100      * This object is completely immutable, so no need to create additional
 101      * instances via the constructor.
 102      *
 103      * @return The instance
 104      */
 105     public static IKernelAnalysisEventLayout getInstance() {
 106         return INSTANCE;
 107     }
 108
 109     // ------------------------------------------------------------------------
 110     // Event names
 111     // ------------------------------------------------------------------------
 112
 113     @Override
 114     public String eventIrqHandlerEntry() {
 115         return IRQ_HANDLER_ENTRY;
 116     }
 117
 118     @Override
 119     public String eventIrqHandlerExit() {
 120         return IRQ_HANDLER_EXIT;
 121     }
 122
 123     @Override
 124     public String eventSoftIrqEntry() {
 125         return SOFTIRQ_ENTRY;
 126     }
 127
 128     @Override
 129     public String eventSoftIrqExit() {
 130         return SOFTIRQ_EXIT;
 131     }
 132
 133     @Override
 134     public String eventSoftIrqRaise() {
 135         return SOFTIRQ_RAISE;
 136     }
 137
 138     @Override
 139     public String eventSchedSwitch() {
 140         return SCHED_SWITCH;
 141     }
 142
 143     @Override
 144     public String eventSchedPiSetprio() {
 145         return SCHED_PI_SETPRIO;
 146     }
 147
 148     @Override
 149     public Collection<String> eventsSchedWakeup() {
 150         return SCHED_WAKEUP_EVENTS;
 151     }
 152
 153     @Override
 154     public String eventSchedProcessFork() {
 155         return SCHED_PROCESS_FORK;
 156     }
 157
 158     @Override
 159     public String eventSchedProcessExit() {
 160         return SCHED_PROCESS_EXIT;
 161     }
 162
 163     @Override
 164     public String eventSchedProcessFree() {
 165         return SCHED_PROCESS_FREE;
 166     }
 167
 168     @Override
 169     public @NonNull String eventStatedumpProcessState() {
 170         return STATEDUMP_PROCESS_STATE;
 171     }
 172
 173     @Override
 174     public String eventSyscallEntryPrefix() {
 175         return SYSCALL_ENTRY_PREFIX;
 176     }
 177
 178     @Override
 179     public String eventCompatSyscallEntryPrefix() {
 180         return COMPAT_SYSCALL_ENTRY_PREFIX;
 181     }
 182
 183     @Override
 184     public String eventSyscallExitPrefix() {
 185         return SYSCALL_EXIT_PREFIX;
 186     }
 187
 188     // ------------------------------------------------------------------------
 189     // Event field names
 190     // ------------------------------------------------------------------------
 191
 192     @Override
 193     public String fieldIrq() {
 194         return IRQ;
 195     }
 196
 197     @Override
 198     public String fieldVec() {
 199         return VEC;
 200     }
 201
 202     @Override
 203     public String fieldTid() {
 204         return TID;
 205     }
 206
 207     @Override
 208     public String fieldPrevTid() {
 209         return PREV_TID;
 210     }
 211
 212     @Override
 213     public String fieldPrevState() {
 214         return PREV_STATE;
 215     }
 216
 217     @Override
 218     public String fieldNextComm() {
 219         return NEXT_COMM;
 220     }
 221
 222     @Override
 223     public String fieldNextTid() {
 224         return NEXT_TID;
 225     }
 226
 227     @Override
 228     public String fieldChildComm() {
 229         return CHILD_COMM;
 230     }
 231
 232     @Override
 233     public String fieldParentTid() {
 234         return PARENT_TID;
 235     }
 236
 237     @Override
 238     public String fieldChildTid() {
 239         return CHILD_TID;
 240     }
 241
 242     @Override
 243     public String fieldPrio() {
 244         return PRIO;
 245     }
 246
 247     @Override
 248     public String fieldNewPrio() {
 249         return NEW_PRIO;
 250     }
 251
 252     @Override
 253     public String fieldNextPrio() {
 254         return NEXT_PRIO;
 255     }
 256
 257     @Override
 258     public String fieldComm() {
 259         return COMM;
 260     }
 261
 262     @Override
 263     public String fieldName() {
 264         return NAME;
 265     }
 266
 267     @Override
 268     public String fieldStatus() {
 269         return STATUS;
 270     }
 271
 272     @Override
 273     public String fieldPrevComm() {
 274         return PREV_COMM;
 275     }
 276
 277     @Override
 278     public String fieldFilename() {
 279         return FILENAME;
 280     }
 281
 282     @Override
 283     public String eventSchedProcessExec() {
 284         return SCHED_PROCESS_EXEC;
 285     }
 286
 287     @Override
 288     public String eventSchedProcessWakeup() {
 289         return SCHED_WAKEUP;
 290     }
 291
 292     @Override
 293     public String eventSchedProcessWakeupNew() {
 294         return SCHED_WAKEUP_NEW;
 295     }
 296
 297     @Override
 298     public String eventHRTimerStart() {
 299         return HRTIMER_START;
 300     }
 301
 302     @Override
 303     public String eventHRTimerCancel() {
 304         return HRTIMER_CANCEL;
 305     }
 306
 307     @Override
 308     public String eventHRTimerExpireEntry() {
 309         return HRTIMER_EXPIRE_ENTRY;
 310     }
 311
 312     @Override
 313     public String eventHRTimerExpireExit() {
 314         return HRTIMER_EXPIRE_EXIT;
 315     }
 316
 317     /**
 318      * Event indicating the source of the wakeup signal.
 319      *
 320      * @return The name of the event
 321      * @since 2.0
 322      */
 323     public String eventSchedProcessTTWU() {
 324         return SCHED_TTWU;
 325     }
 326
 327     @Override
 328     public String fieldHRtimer() {
 329         return HRTIMER;
 330     }
 331     @Override
 332     public String fieldHRtimerFunction() {
 333         return HRTIMER_FUNCTION;
 334     }
 335
 336     @Override
 337     public String fieldHRtimerExpires() {
 338         return HRTIMER_EXPIRES;
 339     }
 340
 341     @Override
 342     public String fieldHRtimerSoftexpires() {
 343         return HRTIMER_SOFT_EXPIRES;
 344     }
 345     @Override
 346     public String fieldHRtimerNow() {
 347         return HRTIMER_NOW;
 348     }
 349
 350 }