analysis/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 java.util.Collection;
  16
  17 import org.eclipse.jdt.annotation.NonNull;
  18
  19 import com.google.common.collect.ImmutableList;
  20
  21 /**
  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
  24  * they want.
  25  *
  26  * Due to historical reasons, the definitions are the same as LTTng event names.
  27  *
  28  * @author Alexandre Montplaisir
  29  * @since 1.0
  30  */
  31 public class DefaultEventLayout implements IKernelAnalysisEventLayout {
  32
  33     /* Event names */
  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$
  45
  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);
  52
  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$
  58
  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$
  62
  63     /* Field names */
  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$
  89
  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() {
  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
 141     /**
 142      * @since 1.0
 143      */
 144     @Override
 145     public String eventSchedPiSetprio() {
 146         return SCHED_PI_SETPRIO;
 147     }
 148
 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
 189     /** @since 2.0 */
 190     @Override
 191     public String eventCompatSyscallExitPrefix() {
 192         return SYSCALL_EXIT_PREFIX;
 193     }
 194     /**
 195      * @since 2.0
 196      */
 197     @Override
 198     public String eventKmemPageAlloc() {
 199         return KMEM_ALLOC;
 200     }
 201
 202     /**
 203      * @since 2.0
 204      */
 205     @Override
 206     public String eventKmemPageFree() {
 207         return KMEM_FREE;
 208
 209     }
 210
 211     // ------------------------------------------------------------------------
 212     // Event field names
 213     // ------------------------------------------------------------------------
 214
 215     @Override
 216     public String fieldIrq() {
 217         return IRQ;
 218     }
 219
 220     @Override
 221     public String fieldVec() {
 222         return VEC;
 223     }
 224
 225     @Override
 226     public String fieldTid() {
 227         return TID;
 228     }
 229
 230     @Override
 231     public String fieldPrevTid() {
 232         return PREV_TID;
 233     }
 234
 235     @Override
 236     public String fieldPrevState() {
 237         return PREV_STATE;
 238     }
 239
 240     @Override
 241     public String fieldNextComm() {
 242         return NEXT_COMM;
 243     }
 244
 245     @Override
 246     public String fieldNextTid() {
 247         return NEXT_TID;
 248     }
 249
 250     @Override
 251     public String fieldChildComm() {
 252         return CHILD_COMM;
 253     }
 254
 255     @Override
 256     public String fieldParentTid() {
 257         return PARENT_TID;
 258     }
 259
 260     @Override
 261     public String fieldChildTid() {
 262         return CHILD_TID;
 263     }
 264
 265     /** @since 1.0 */
 266     @Override
 267     public String fieldPrio() {
 268         return PRIO;
 269     }
 270
 271     /** @since 1.0 */
 272     @Override
 273     public String fieldNewPrio() {
 274         return NEW_PRIO;
 275     }
 276
 277     /** @since 1.0 */
 278     @Override
 279     public String fieldNextPrio() {
 280         return NEXT_PRIO;
 281     }
 282
 283     /** @since 2.0 */
 284     @Override
 285     public String fieldComm() {
 286         return COMM;
 287     }
 288
 289     /** @since 2.0 */
 290     @Override
 291     public String fieldName() {
 292         return NAME;
 293     }
 294
 295     /** @since 2.0 */
 296     @Override
 297     public String fieldStatus() {
 298         return STATUS;
 299     }
 300
 301     /** @since 2.0 */
 302     @Override
 303     public String fieldPrevComm() {
 304         return PREV_COMM;
 305     }
 306
 307     /** @since 2.0 */
 308     @Override
 309     public String fieldFilename() {
 310         return FILENAME;
 311     }
 312
 313     /** @since 2.0 */
 314     @Override
 315     public String eventSchedProcessExec() {
 316         return SCHED_PROCESS_EXEC;
 317     }
 318
 319     /** @since 2.0 */
 320     @Override
 321     public String eventSchedProcessWakeup() {
 322         return SCHED_WAKEUP;
 323     }
 324
 325     /** @since 2.0 */
 326     @Override
 327     public String eventSchedProcessWakeupNew() {
 328         return SCHED_WAKEUP_NEW;
 329     }
 330
 331     /** @since 2.0 */
 332     @Override
 333     public String eventHRTimerStart() {
 334         return HRTIMER_START;
 335     }
 336
 337     /** @since 2.0 */
 338     @Override
 339     public String eventHRTimerCancel() {
 340         return HRTIMER_CANCEL;
 341     }
 342
 343     /** @since 2.0 */
 344     @Override
 345     public String eventHRTimerExpireEntry() {
 346         return HRTIMER_EXPIRE_ENTRY;
 347     }
 348
 349     /** @since 2.0 */
 350     @Override
 351     public String eventHRTimerExpireExit() {
 352         return HRTIMER_EXPIRE_EXIT;
 353     }
 354
 355     /**
 356      * Event indicating the source of the wakeup signal.
 357      *
 358      * @return The name of the event
 359      * @since 2.0
 360      */
 361     public String eventSchedProcessTTWU() {
 362         return SCHED_TTWU;
 363     }
 364
 365     /** @since 2.0 */
 366     @Override
 367     public String fieldHRtimer() {
 368         return HRTIMER;
 369     }
 370
 371     /** @since 2.0 */
 372     @Override
 373     public String fieldHRtimerFunction() {
 374         return FUNCTION;
 375     }
 376
 377     /** @since 2.0 */
 378     @Override
 379     public String fieldHRtimerExpires() {
 380         return EXPIRES;
 381     }
 382
 383     /** @since 2.0 */
 384     @Override
 385     public String fieldHRtimerSoftexpires() {
 386         return SOFT_EXPIRES;
 387     }
 388
 389     /** @since 2.0 */
 390     @Override
 391     public String fieldHRtimerNow() {
 392         return NOW;
 393     }
 394
 395     /**
 396      * Event indicating the source of the wakeup signal.
 397      *
 398      * @return The name of the event
 399      * @since 2.0
 400      */
 401     public String eventSchedProcessWaking() {
 402         return SCHED_WAKING;
 403     }
 404
 405 }