os.linux: Document Attribute Tree for StateProviders

Add documentation to headers for
KernelContextSwitch
KernelCpuUsage
KernelMemory
ActiveTid
InputOutput
Kernel

Change-Id: If95fc67f0a6b765267b4247328e3618b6c000315
Signed-off-by: Loïc Prieur-Drevon <loic.prieurdrevon@gmail.com>
Reviewed-on: https://git.eclipse.org/r/81200
Reviewed-by: Matthew Khouzam <matthew.khouzam@ericsson.com>
Reviewed-by: Hudson CI
Reviewed-by: Genevieve Bastien <gbastien+lttng@versatic.net>
Tested-by: Genevieve Bastien <gbastien+lttng@versatic.net>

diff --git a/analysis/org.eclipse.tracecompass.analysis.os.linux.core/src/org/eclipse/tracecompass/analysis/os/linux/core/contextswitch/KernelContextSwitchStateProvider.java b/analysis/org.eclipse.tracecompass.analysis.os.linux.core/src/org/eclipse/tracecompass/analysis/os/linux/core/contextswitch/KernelContextSwitchStateProvider.java
index 1902650cf4482230b79f79258ed335f90a8d57da..f87eeb8f250e7916042131c8be33428a40528f31 100644 (file)
--- a/analysis/org.eclipse.tracecompass.analysis.os.linux.core/src/org/eclipse/tracecompass/analysis/os/linux/core/contextswitch/KernelContextSwitchStateProvider.java
+++ b/analysis/org.eclipse.tracecompass.analysis.os.linux.core/src/org/eclipse/tracecompass/analysis/os/linux/core/contextswitch/KernelContextSwitchStateProvider.java
@@ -32,6 +32,13 @@ import org.eclipse.tracecompass.tmf.core.trace.TmfTraceUtils;
 /**
  * Class used to build a state system of the context switches of a trace
  *
+ * Attribute tree:
+ *
+ * <pre>
+ * |- CPUs
+ * |  |- <CPU number> -> Number of context switches
+ * </pre>
+ *
  * @author Alexis Cabana-Loriaux
  * @since 2.0
  */

diff --git a/analysis/org.eclipse.tracecompass.analysis.os.linux.core/src/org/eclipse/tracecompass/analysis/os/linux/core/cpuusage/KernelCpuUsageStateProvider.java b/analysis/org.eclipse.tracecompass.analysis.os.linux.core/src/org/eclipse/tracecompass/analysis/os/linux/core/cpuusage/KernelCpuUsageStateProvider.java
index 1c4540da0fc35c8076a9c2d91668318a91c8578d..1f3b01eb9dbbcd2b655951ddf23fd8e9ab13a0d0 100644 (file)
--- a/analysis/org.eclipse.tracecompass.analysis.os.linux.core/src/org/eclipse/tracecompass/analysis/os/linux/core/cpuusage/KernelCpuUsageStateProvider.java
+++ b/analysis/org.eclipse.tracecompass.analysis.os.linux.core/src/org/eclipse/tracecompass/analysis/os/linux/core/cpuusage/KernelCpuUsageStateProvider.java
@@ -43,6 +43,14 @@ import org.eclipse.tracecompass.tmf.core.trace.TmfTraceUtils;
  *
  * It requires only the 'sched_switch' events enabled on the trace.
  *
+ * Attribute tree:
+ *
+ * <pre>
+ * |- CPUS
+ * |  |- <CPU number>
+ * |  |  |- <TID> -> cumulative time spent on the source CPU by the currently running thread (ns)
+ * </pre>
+ *
  * @author François Rajotte
  */
 public class KernelCpuUsageStateProvider extends AbstractTmfStateProvider {

diff --git a/analysis/org.eclipse.tracecompass.analysis.os.linux.core/src/org/eclipse/tracecompass/analysis/os/linux/core/kernelmemoryusage/KernelMemoryStateProvider.java b/analysis/org.eclipse.tracecompass.analysis.os.linux.core/src/org/eclipse/tracecompass/analysis/os/linux/core/kernelmemoryusage/KernelMemoryStateProvider.java
index dc061eac07520c85f973e569ca1e8c60103f1558..2847bd2bd76f1dffc27543966f6f9dce07adbd53 100644 (file)
--- a/analysis/org.eclipse.tracecompass.analysis.os.linux.core/src/org/eclipse/tracecompass/analysis/os/linux/core/kernelmemoryusage/KernelMemoryStateProvider.java
+++ b/analysis/org.eclipse.tracecompass.analysis.os.linux.core/src/org/eclipse/tracecompass/analysis/os/linux/core/kernelmemoryusage/KernelMemoryStateProvider.java
@@ -31,6 +31,13 @@ import org.eclipse.tracecompass.tmf.core.trace.ITmfTrace;
  *
  * The state provider also contains code that can query the state system.
  *
+ * Attribute tree:
+ *
+ * <pre>
+ * |- <TID number> -> current memory usage
+ * |  |- THREAD_LOWEST_MEMORY_VALUE -> lowest memory value for thread
+ * </pre>
+ *
  * @author Samuel Gagnon
  * @since 2.0
  */

diff --git a/analysis/org.eclipse.tracecompass.analysis.os.linux.core/src/org/eclipse/tracecompass/analysis/os/linux/core/tid/ActiveTidStateProvider.java b/analysis/org.eclipse.tracecompass.analysis.os.linux.core/src/org/eclipse/tracecompass/analysis/os/linux/core/tid/ActiveTidStateProvider.java
index 78a5ee7ac5840868ea660b4fdef4a71b528efeef..33cfea6eb38ce7d678826f00f051a1c2491e03aa 100644 (file)
--- a/analysis/org.eclipse.tracecompass.analysis.os.linux.core/src/org/eclipse/tracecompass/analysis/os/linux/core/tid/ActiveTidStateProvider.java
+++ b/analysis/org.eclipse.tracecompass.analysis.os.linux.core/src/org/eclipse/tracecompass/analysis/os/linux/core/tid/ActiveTidStateProvider.java
@@ -36,6 +36,12 @@ import org.eclipse.tracecompass.tmf.core.trace.TmfTraceUtils;
  *
  * Note 2: this is deliberately only package visible.
  *
+ * Attribute tree:
+ *
+ * <pre>
+ * |- <CPU number> -> Active TID number
+ * </pre>
+ *
  * @author Matthew Khouzam
  */
 class ActiveTidStateProvider extends AbstractTmfStateProvider {

diff --git a/analysis/org.eclipse.tracecompass.analysis.os.linux.core/src/org/eclipse/tracecompass/internal/analysis/os/linux/core/inputoutput/InputOutputStateProvider.java b/analysis/org.eclipse.tracecompass.analysis.os.linux.core/src/org/eclipse/tracecompass/internal/analysis/os/linux/core/inputoutput/InputOutputStateProvider.java
index 4a021070631022cd570c9109cf2c99a944c8b70d..e9e71bef486b0e2e35e8a200d8bd96faff378006 100644 (file)
--- a/analysis/org.eclipse.tracecompass.analysis.os.linux.core/src/org/eclipse/tracecompass/internal/analysis/os/linux/core/inputoutput/InputOutputStateProvider.java
+++ b/analysis/org.eclipse.tracecompass.analysis.os.linux.core/src/org/eclipse/tracecompass/internal/analysis/os/linux/core/inputoutput/InputOutputStateProvider.java
@@ -41,6 +41,35 @@ import com.google.common.collect.ImmutableMap;
 /**
  * State provider for the I/O analysis
  *
+ * Attribute tree:
+ *
+ * <pre>
+ * |- SYSTEM_CALLS
+ * |  |- <TID> -> System Call Name
+ * |- THREADS
+ * |  |- <TID number>
+ * |  |  |- BYTES_READ
+ * |  |  |- BYTES_WRITTEN
+ * |- Disks
+ * |  |- <Disk number> -> Disk Name
+ * |  |  |- SECTORS_READ
+ * |  |  |- SECTORS_WRITTEN
+ * |  |  |- WAITING_QUEUE -> Root for the Attribute pool for waiting queue
+ * |  |  |  |- <slot #1> -> Status
+ * |  |  |  |  |- CURRENT_REQUEST
+ * |  |  |  |  |- REQUEST_SIZE
+ * |  |  |  |  |- MERGED_IN
+ * |  |  |  |- <slot #2>
+ * |  |  |- WAITING_QUEUE_LENGTH
+ * |  |  |- DRIVER_QUEUE -> Root for the Attribute pool for driver queue
+ * |  |  |  |- <slot #1> -> Status
+ * |  |  |  |  |- CURRENT_REQUEST
+ * |  |  |  |  |- REQUEST_SIZE
+ * |  |  |  |  |- ISSUED_FROM
+ * |  |  |  |- <slot #2>
+ * |  |  |- DRIVER_QUEUE_LENGTH
+ * </pre>
+ *
  * @author Houssem Daoud
  * @since 2.0
  */

diff --git a/analysis/org.eclipse.tracecompass.analysis.os.linux.core/src/org/eclipse/tracecompass/internal/analysis/os/linux/core/kernel/KernelStateProvider.java b/analysis/org.eclipse.tracecompass.analysis.os.linux.core/src/org/eclipse/tracecompass/internal/analysis/os/linux/core/kernel/KernelStateProvider.java
index 4d2d1a192becf7766b18ecb3d9f3f15fcab16d1a..94a9933a549cf59f13c7f9c5e68600010c15ac95 100644 (file)
--- a/analysis/org.eclipse.tracecompass.analysis.os.linux.core/src/org/eclipse/tracecompass/internal/analysis/os/linux/core/kernel/KernelStateProvider.java
+++ b/analysis/org.eclipse.tracecompass.analysis.os.linux.core/src/org/eclipse/tracecompass/internal/analysis/os/linux/core/kernel/KernelStateProvider.java
@@ -49,6 +49,24 @@ import com.google.common.collect.ImmutableMap;
  * This is the state change input plugin for the state system which handles the
  * kernel traces.
  *
+ * Attribute tree:
+ *
+ * <pre>
+ * |- CPUs
+ * |  |- <CPU number> -> CPU Status
+ * |  |  |- CURRENT_THREAD
+ * |  |  |- SOFT_IRQS
+ * |  |  |  |- <Soft IRQ number> -> Soft IRQ Status
+ * |  |  |- IRQS
+ * |  |  |  |- <IRQ number> -> IRQ Status
+ * |- THREADS
+ * |  |- <Thread number> -> Thread Status
+ * |  |  |- PPID
+ * |  |  |- EXEC_NAME
+ * |  |  |- PRIO
+ * |  |  |- SYSTEM_CALL
+ * </pre>
+ *
  * @author Alexandre Montplaisir
  */
 public class KernelStateProvider extends AbstractTmfStateProvider {