diff options
author | Amit Kucheria <amit.kucheria@linaro.org> | 2014-04-09 15:13:56 +0530 |
---|---|---|
committer | Amit Kucheria <amit.kucheria@linaro.org> | 2014-04-09 15:13:56 +0530 |
commit | 07733d5332ca33891c2fef8824b4af480ff6d66d (patch) | |
tree | 8a67c8bb39ab72594fb9f187708fd5f141b6927a | |
parent | a5ad3ba8caeadfdd092ab105c8df75ca6fd2ab15 (diff) |
Populate the README file with basic information about the tool and its usage
Signed-off-by: Amit Kucheria <amit.kucheria@linaro.org>
-rw-r--r-- | README | 41 |
1 files changed, 41 insertions, 0 deletions
@@ -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 + |