From 0589e681e31b158943bd414c2293579fac9f12d2 Mon Sep 17 00:00:00 2001
From: Matthew Khouzam <matthew.khouzam@ericsson.com>
Date: Fri, 16 Oct 2015 22:35:45 -0400
Subject: [PATCH] analysis: add javadoc to LinuxValues.java

Sources LKML and LWN to find human readable explanations of all the flags.

Change-Id: Icd0f44afeb3bf443f16d984f034d088aa2ba8a74
Signed-off-by: Matthew Khouzam <matthew.khouzam@ericsson.com>
Reviewed-on: https://git.eclipse.org/r/58389
Reviewed-by: Hudson CI
Reviewed-by: Patrick Tasse <patrick.tasse@gmail.com>
Tested-by: Patrick Tasse <patrick.tasse@gmail.com>
---
 .../core/kernelanalysis/LinuxValues.java      | 47 ++++++++++++++++++-
 1 file changed, 45 insertions(+), 2 deletions(-)

diff --git a/analysis/org.eclipse.tracecompass.analysis.os.linux.core/src/org/eclipse/tracecompass/internal/analysis/os/linux/core/kernelanalysis/LinuxValues.java b/analysis/org.eclipse.tracecompass.analysis.os.linux.core/src/org/eclipse/tracecompass/internal/analysis/os/linux/core/kernelanalysis/LinuxValues.java
index 9b38e1a009..d3791c2cd1 100644
--- a/analysis/org.eclipse.tracecompass.analysis.os.linux.core/src/org/eclipse/tracecompass/internal/analysis/os/linux/core/kernelanalysis/LinuxValues.java
+++ b/analysis/org.eclipse.tracecompass.analysis.os.linux.core/src/org/eclipse/tracecompass/internal/analysis/os/linux/core/kernelanalysis/LinuxValues.java
@@ -17,7 +17,6 @@ package org.eclipse.tracecompass.internal.analysis.os.linux.core.kernelanalysis;
  *
  * @author Alexandre Montplaisir
  */
-@SuppressWarnings("javadoc")
 public interface LinuxValues {
 
     /**
@@ -47,15 +46,59 @@ public interface LinuxValues {
      */
     int TASK_STATE_RUNNING = 0;
 
+    /**
+     * The process is in an interruptible sleep, (waiting for an event to
+     * complete)
+     */
     int TASK_INTERRUPTIBLE = 1;
 
+    /**
+     * The process is in an uninteruptible sleep, (usually waiting on IO)
+     */
     int TASK_UNINTERRUPTIBLE = 2;
 
+    /**
+     * The process is stopped, it is waiting for a SIGCONT
+     */
+    int TASK_STOPPED__ = 4;
+
+    /**
+     * The process is being monitored by other processes like a debugger
+     */
+    int TASK_TRACED__ = 8;
+
+    /**
+     * The task is terminated. It is lingering waiting for a parent to reap it.
+     */
+    int EXIT_ZOMBIE = 16;
+
+    /**
+     * The final state, the process reaches this state when being reaped. This
+     * state should not be seen.
+     */
+    int EXIT_DEAD = 32;
+
     /**
      * The task is dead, that means the PID can be re-used.
      */
     int TASK_DEAD = 64;
 
+    /**
+     * The task will wake up only on kill signals
+     */
+    int TASK_WAKEKILL = 128;
+
+    /**
+     * A task is being woken up, should not appear in sched switch, but if we
+     * poll.
+     */
+    int TASK_WAKING = 256;
+
+    /**
+     * A very deep sleep that can only be woken by an unpark wakeup
+     */
+    int TASK_PARK = 512;
+
     /**
      * This is the maximum value + 1 that the task state can be. TASK_STATE_MAX
      * - 1 is useful to mask the task state.
@@ -94,6 +137,7 @@ public interface LinuxValues {
      * SoftIRQ definitions
      *
      * From linux/interrupt.h
+     *
      * <pre>
      * enum
      * {
@@ -141,5 +185,4 @@ public interface LinuxValues {
 
     /** Interrupted because of RCU */
     int SOFTIRQ_RCU = 9;
-
 }
-- 
2.34.1