analysis/org.eclipse.tracecompass.analysis.os.linux.core/src/org/eclipse/tracecompass/internal/analysis/os/linux/core/kernel/handlers/SchedSwitchHandler.java

   1 /*******************************************************************************
   2  * Copyright (c) 2015 Ericsson
   3  *
   4  * All rights reserved. This program and the accompanying materials
   5  * are made available under the terms of the Eclipse Public License v1.0
   6  * which accompanies this distribution, and is available at
   7  * http://www.eclipse.org/legal/epl-v10.html
   8  *
   9  * Contributors:
  10  *    Matthew Khouzam - Initial API and implementation
  11  *******************************************************************************/
  12
  13 package org.eclipse.tracecompass.internal.analysis.os.linux.core.kernel.handlers;
  14
  15 import static org.eclipse.tracecompass.common.core.NonNullUtils.checkNotNull;
  16
  17 import org.eclipse.tracecompass.analysis.os.linux.core.kernel.Attributes;
  18 import org.eclipse.tracecompass.analysis.os.linux.core.kernel.LinuxValues;
  19 import org.eclipse.tracecompass.analysis.os.linux.core.kernel.StateValues;
  20 import org.eclipse.tracecompass.analysis.os.linux.core.trace.IKernelAnalysisEventLayout;
  21 import org.eclipse.tracecompass.statesystem.core.ITmfStateSystemBuilder;
  22 import org.eclipse.tracecompass.statesystem.core.exceptions.AttributeNotFoundException;
  23 import org.eclipse.tracecompass.statesystem.core.statevalue.ITmfStateValue;
  24 import org.eclipse.tracecompass.statesystem.core.statevalue.TmfStateValue;
  25 import org.eclipse.tracecompass.tmf.core.event.ITmfEvent;
  26 import org.eclipse.tracecompass.tmf.core.event.ITmfEventField;
  27
  28 /**
  29  * Scheduler switch event handler
  30  */
  31 public class SchedSwitchHandler extends KernelEventHandler {
  32
  33     /**
  34      * Constructor
  35      *
  36      * @param layout
  37      *            event layout
  38      */
  39     public SchedSwitchHandler(IKernelAnalysisEventLayout layout) {
  40         super(layout);
  41     }
  42
  43     @Override
  44     public void handleEvent(ITmfStateSystemBuilder ss, ITmfEvent event) throws AttributeNotFoundException {
  45         Integer cpu = KernelEventHandlerUtils.getCpu(event);
  46         if (cpu == null) {
  47             return;
  48         }
  49
  50         ITmfEventField content = event.getContent();
  51         Integer prevTid = ((Long) content.getField(getLayout().fieldPrevTid()).getValue()).intValue();
  52         Long prevState = checkNotNull((Long) content.getField(getLayout().fieldPrevState()).getValue());
  53         String nextProcessName = checkNotNull((String) content.getField(getLayout().fieldNextComm()).getValue());
  54         Integer nextTid = ((Long) content.getField(getLayout().fieldNextTid()).getValue()).intValue();
  55         Integer nextPrio = ((Long) content.getField(getLayout().fieldNextPrio()).getValue()).intValue();
  56
  57         int nodeThreads = KernelEventHandlerUtils.getNodeThreads(ss);
  58         int formerThreadNode = ss.getQuarkRelativeAndAdd(nodeThreads, prevTid.toString());
  59         int newCurrentThreadNode = ss.getQuarkRelativeAndAdd(nodeThreads, nextTid.toString());
  60
  61         long timestamp = KernelEventHandlerUtils.getTimestamp(event);
  62         /* Set the status of the process that got scheduled out. */
  63         setOldProcessStatus(ss, prevState, formerThreadNode, timestamp);
  64
  65         /* Set the status of the new scheduled process */
  66         KernelEventHandlerUtils.setProcessToRunning(timestamp, newCurrentThreadNode, ss);
  67
  68         /* Set the exec name of the new process */
  69         setNewProcessExecName(ss, nextProcessName, newCurrentThreadNode, timestamp);
  70
  71         /* Set the current prio for the new process */
  72         setNewProcessPio(ss, nextPrio, newCurrentThreadNode, timestamp);
  73
  74         /* Make sure the PPID and system_call sub-attributes exist */
  75         ss.getQuarkRelativeAndAdd(newCurrentThreadNode, Attributes.SYSTEM_CALL);
  76         ss.getQuarkRelativeAndAdd(newCurrentThreadNode, Attributes.PPID);
  77
  78         /* Set the current scheduled process on the relevant CPU */
  79         int currentCPUNode = KernelEventHandlerUtils.getCurrentCPUNode(cpu, ss);
  80         setCpuProcess(ss, nextTid, timestamp, currentCPUNode);
  81
  82         /* Set the status of the CPU itself */
  83         setCpuStatus(ss, nextTid, newCurrentThreadNode, timestamp, currentCPUNode);
  84     }
  85
  86     private static void setOldProcessStatus(ITmfStateSystemBuilder ss, Long prevState, Integer formerThreadNode, long timestamp) throws AttributeNotFoundException {
  87         ITmfStateValue value;
  88         /*
  89          * Empirical observations and look into the linux code have
  90          * shown that the TASK_STATE_MAX flag is used internally and
  91          * |'ed with other states, most often the running state, so it
  92          * is ignored from the prevState value.
  93          *
  94          * Since Linux 4.1, the TASK_NOLOAD state was created and
  95          * TASK_STATE_MAX is now 2048. We use TASK_NOLOAD as the new max
  96          * because it does not modify the displayed state value.
  97          */
  98         int state = (int) (prevState & (LinuxValues.TASK_NOLOAD - 1));
  99
 100         if (isRunning(state)) {
 101             value = StateValues.PROCESS_STATUS_WAIT_FOR_CPU_VALUE;
 102         } else if (isWaiting(state)) {
 103             value = StateValues.PROCESS_STATUS_WAIT_BLOCKED_VALUE;
 104         } else if (isDead(state)) {
 105             value = TmfStateValue.nullValue();
 106         } else {
 107             value = StateValues.PROCESS_STATUS_WAIT_UNKNOWN_VALUE;
 108         }
 109         int quark = ss.getQuarkRelativeAndAdd(formerThreadNode, Attributes.STATUS);
 110         ss.modifyAttribute(timestamp, value, quark);
 111
 112     }
 113
 114     private static boolean isDead(int state) {
 115         return (state & LinuxValues.TASK_DEAD) != 0;
 116     }
 117
 118     private static boolean isWaiting(int state) {
 119         return (state & (LinuxValues.TASK_INTERRUPTIBLE | LinuxValues.TASK_UNINTERRUPTIBLE)) != 0;
 120     }
 121
 122     private static boolean isRunning(int state) {
 123         // special case, this means ALL STATES ARE 0
 124         // this is effectively an anti-state
 125         return state == 0;
 126     }
 127
 128     private static void setCpuStatus(ITmfStateSystemBuilder ss, Integer nextTid, Integer newCurrentThreadNode, long timestamp, int currentCPUNode) throws AttributeNotFoundException {
 129         int quark;
 130         ITmfStateValue value;
 131         if (nextTid > 0) {
 132             /* Check if the entering process is in kernel or user mode */
 133             quark = ss.getQuarkRelativeAndAdd(newCurrentThreadNode, Attributes.SYSTEM_CALL);
 134             ITmfStateValue queryOngoingState = ss.queryOngoingState(quark);
 135             if (queryOngoingState.isNull()) {
 136                 value = StateValues.CPU_STATUS_RUN_USERMODE_VALUE;
 137             } else {
 138                 value = StateValues.CPU_STATUS_RUN_SYSCALL_VALUE;
 139             }
 140         } else {
 141             value = StateValues.CPU_STATUS_IDLE_VALUE;
 142         }
 143         quark = ss.getQuarkRelativeAndAdd(currentCPUNode, Attributes.STATUS);
 144         ss.modifyAttribute(timestamp, value, quark);
 145     }
 146
 147     private static void setCpuProcess(ITmfStateSystemBuilder ss, Integer nextTid, long timestamp, int currentCPUNode) throws AttributeNotFoundException {
 148         int quark;
 149         ITmfStateValue value;
 150         quark = ss.getQuarkRelativeAndAdd(currentCPUNode, Attributes.CURRENT_THREAD);
 151         value = TmfStateValue.newValueInt(nextTid);
 152         ss.modifyAttribute(timestamp, value, quark);
 153     }
 154
 155     private static void setNewProcessPio(ITmfStateSystemBuilder ss, Integer nextPrio, Integer newCurrentThreadNode, long timestamp) throws AttributeNotFoundException {
 156         int quark;
 157         ITmfStateValue value;
 158         quark = ss.getQuarkRelativeAndAdd(newCurrentThreadNode, Attributes.PRIO);
 159         value = TmfStateValue.newValueInt(nextPrio);
 160         ss.modifyAttribute(timestamp, value, quark);
 161     }
 162
 163     private static void setNewProcessExecName(ITmfStateSystemBuilder ss, String nextProcessName, Integer newCurrentThreadNode, long timestamp) throws AttributeNotFoundException {
 164         int quark;
 165         ITmfStateValue value;
 166         quark = ss.getQuarkRelativeAndAdd(newCurrentThreadNode, Attributes.EXEC_NAME);
 167         value = TmfStateValue.newValueString(nextProcessName);
 168         ss.modifyAttribute(timestamp, value, quark);
 169     }
 170
 171 }