From 07733d5332ca33891c2fef8824b4af480ff6d66d Mon Sep 17 00:00:00 2001 From: Amit Kucheria Date: Wed, 9 Apr 2014 15:13:56 +0530 Subject: Populate the README file with basic information about the tool and its usage Signed-off-by: Amit Kucheria --- README | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) diff --git a/README b/README index e69de29..3a8eb49 100644 --- a/README +++ b/README @@ -0,0 +1,41 @@ +Introduction +------------ + +The purpose of idlestat is to measure how long we have been in the different +idle and operating states. + +Idlestat uses kernel's FTRACE function to monitor and capture C-state and +P-state transitions of CPUs over a time interval. It extracts the following +information from trace file: + - Times when CPUs entered and exited a certain C-state + - Times when CPUs entered and exited a certain P-state + - Raised IRQs + +Following a successful run, idlestat calculates and reports the following +information: + - Total, average, minimum and maximum time spent in each C-state, + per-CPU. + - Total, average, minimum and maximum time spent in each P-state, + per-CPU. + - Total, average, minimum and maximum time during which all CPUs in + a cluster were in the same C-state, per-cluster. + - Number of times a certain IRQ caused a CPU to exit idle state, + per-CPU and per-IRQ + +Requirements +------------ + +1. It must be run as root in order to access /sys/kernel/debug. +2. It requires tracing to be enabled in the kernel + +Example Usage +------------- + +./idlestat -d -o myoutput -t 10 + +where, + +-d : dump the states at the end +-o : output file to store the traces +-t : the duration in seconds + -- cgit v1.2.3