Add INSTALL and README files.

2 files changed, 107 insertions, 0 deletions

diff --git a/INSTALL b/INSTALL
new file mode 100644
index 0000000..5d83e45
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,33 @@
+
+Linux Installation
+
+There is not yet installation scripts. run the tool from the source tree.
+
+PyTimechart uses Python,wx and Chaco as its basis.
+
+PyTimechart has been tested on linux (fedora 11,ubuntu 9.10/10.04) and windows (pythonxy, EPD)
+
+Linux installation
+
+python-chaco is now working on ubuntu-10.04 (was broken on 9.10)
+sudo apt-get install python-chaco
+Manual Linux installation
+
+If distribution packages are ot working, you may need to semi manually install Chaco and its dependancies. Use easy_install
+Install Documentation at Enthought
+
+Basically, you need to make those commands work:
+yum install python-setuptools-devel libXt-devel libXtst-devel numpy scipy swig gcc-c++ wxPython
+easy_install Traits  
+easy_install TraitsGUI  
+easy_install TraitsBackendWX  
+easy_install Enable  
+easy_install Chaco  
+And resolve the dependancy problem as they happen. Please modify this wiki as you find more dependancies.
+
+Enthought also provides an commercial easy to use python distribution called EPD.
+Windows installation
+
+The easiest way is to install pythonxy
+
+Please download the installer, and then dont forget to activate ETS and wxwindows modules.
diff --git a/README b/README
new file mode 100644
index 0000000..276fd95
--- /dev/null
+++ b/README
@@ -0,0 +1,74 @@
+PyTimechart, a tool to display ftrace (or perf) traces
+
+This is a reimplemetation of some of the main features of timechart from Arjan Van de Ven.
+
+On top of original timechart features, pytimechart adds:
+a parser for ftrace traces
+a gui for fast navigation, even with big traces
+* integrates irq traces to view how irq handlers influences the system.
+
+See INSTALL for installation procedures.
+
+
+Color Codes, Interpretation
+
+As a prototype, this software is not a model of easy to use UI. We still need at least a legend…
+
+Process states
+
+light grey: Long running process
+dark grey: Process that is running, but interrupted frequently. Most likely, changing the zoom level will help you to understand why.
+light yellow: The process is waiting for CPU, it is in the RUNNING state, but is scheduled out.
+The number inside the process state box is the CPU number on which this process is running.
+CPU state
+
+The C state is represented with level of blue dark blue is C6 and light blue is C2
+The number inside the box is the C state.
+Wake events
+
+When you activate wake events, some arrows are shown from one process line to another. This represents wake events. For some reason, the process A as woken up the Process B. Several wake up reason are possible:
+Process A is sending data to Process B via a fifo or a file
+Process A is releasing a semaphore also hold by Process B
+Process A is an actually an ISR, spawning a BH/tasklet/work
+etc.
+
+Usage
+
+Launch from the desktop icon or program menu, and you will be prompted for a trace.txt file.
+A sample one is given.
+
+You can zoom horizontaly (strech the view) with the scroll wheel, and pan with left button.
+Use control + scroll wheel to zoom on each axis
+
+The left pane allows you to control what is displayed:
+
+you can filter out process that do not contribute much or are not visible in current view.
+you can choose to display or not wake up relationships between processes
+
+Generating trace.txt
+
+Kernel Config
+
+Please ensure that the following option are enabled in your .config
+CONFIG_FUNCTION_TRACER=y
+CONFIG_SYSPROF_TRACER=y  
+CONFIG_SCHED_TRACER=y  
+CONFIG_POWER_TRACER=y  
+CONFIG_WORKQUEUE_TRACER=y
+You can find them in menuconfig:
+–> Kernel hacking –> Tracers
+
+Scripts
+
+See scripts in examples/
+as root:
+Use start.sh to start the tracer. It may print error if you did not have all patches installed and activated.
+Use stop.sh to stop the tracer and generate a trace.txt file in home directory
+use the provided cmdline to trace the boot process. The traces will begin just after the ftrace system is initialized. Then only use stop.sh to get the trace.
+Function Tracing
+
+Please refer to ftrace documentation to see how is working function tracing.
+
+First, it is neccesary to enable function tracing in menuconfig: ‘’‘CONFIG_FUNCTION_TRACER’‘’ at:
+-> Kernel hacking -> Tracers
+Here is an example of a trace configuration script that will show at the spi subsystem, and max3110 spi to rs232 driver behaviour. We allocated 50MB of buffer to allow a lot of