TBS based build system
[apc.git] / README
blob8e390bdc22fe697a3c1c690ab278e4947d8fc7c8
1 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2                                WARNING
4 The kernel module part of this program messes with internal affairs of
5 the kernel, while best effort was put into making it safe, there are:
7                        NO GUARANTEES WHATSOEVER
9 Furthermore  removing the  previous    versions  of the  module   (via
10 rmmod(8))      caused  one  particular      kernel   version to  panic
11 (2.6.8-2-686-SMP  form Debian), to  the best  of  my current knowledge
12 panics are only possible on SMP machines (and with maxcpus > 1).  Pair
13 of safety nets were added and this  particular kernel no longer panics
14 upon module removal, but, again, three words in caps above apply.
16 The module expects certain things not to happen at particular point in
17 execution, otherwise the information kernel  module exports can not be
18 trusted.   Those `things' did  happen on aforementioned Debian kernel,
19 so if you need to run APC there you might want to uncomment first line
20 of `mod/itc-mod.c'.
22 2.4 series of kernels were never tested on SMP as such the module will
23 refuse to build for them.
25 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
26                This is APC - graphical CPU load meter.
28 It is more suitable/accurate in situations where applications generate
29 "short" periodic bursts of activity.
31 It works by measuring the time spent in  the kernels idle handler. CPU
32 load time is taken to mean:
34      time spent in idle handler
35 1 -  --------------------------
36         total time elapsed
38 Con Kolivas  in  his post on   LKML (http://lkml.org/lkml/2007/2/12/7)
39 described  the way   Linux  gathers information   that it exports   to
40 `/proc/stat' (at least for "boring"  architectures), this method is by
41 no means accurate and can "lie" in either direction.
43 You can witness this  by running the `hog'  example and, if  stars are
44 aligned  correctly, you will notice  that something is wrong with what
45 `/proc/stat' claims. Since most of the CPU monitoring applications use
46 `/proc/stat' they will produce incorrect results too.
48 Kernel (starting with version 2.6.21) comes with a document describing
49 the  way accounting is currently  done and problems with this approach
50 (Documentation/cpu-load.txt)
52 Following thread describes a take on addressing the issue properly:
53 http://marc.info/?t=117480935100001&r=1&w=2
55 Apart    from   being inaccurate,  `/proc/stat'  exports monotonically
56 increasing load times but _NOT_  real time[1], so there's omni-present
57 sub-jiffy error. Not to mention that jiffy resolution is somewhat low.
59 If you depend on sorta-kinda semi-correct load meter in situation when
60 `/proc/stat'  is disconnected with reality  APC might present a better
61 choice.
63 The kernel  module part  of APC   tries to insert  itself  as  a power
64 management idle  handler and when  invoked measure  how  much time  is
65 spent executing previous/default one - this information is represented
66 by yellow color, values  obtained via `/proc/stat' are represented  by
67 red.
69 You  can use `-help' command  line option to   get a brief overview of
70 tunable parameters.
72 Tested on[2]:
74 Linux 2.4.30   - AMD Athlon(tm) Processor (1.4 Ghz)
75 Linux 2.6.17.6
76 Linux 2.6.19.2 - AMD Athlon(tm)64 X2 Dual Core Processor  3800+
77 Linux 2.6.18   - AMD Athlon(tm)64 3800+
78 Linux 2.6.18.3 - PowerPC 7447A
79 Linux 2.6.20.1 - PowerPC 7447A
80 Linux 2.6.19   - [some Core 2 Duo]
82 It's possible  that RMClock[3]  does something similar(load  measuring
83 wise) on Microsoft Windows.
85 [1] Unlike `/proc/uptime'. But this one is useless for SMP
86 [2] SMP not tested on 2.4 kernels, nor QUIRK mode. SMP on PPC wasn't
87     tested either
88 [3] http://cpu.rightmark.org/products/rmclock.shtml
90 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
91 To build you will need:
93 OCaml  - http://caml.inria.fr/ocaml/
94 LablGL - http://wwwfun.kurims.kyoto-u.ac.jp/soft/lsl/lablgl.html
95          (and by extension some OpenGL implementation)
96 GLUT   - http://www.opengl.org/resources/libraries/glut/
97          http://freeglut.sourceforge.net/
98 GCC    - http://gcc.gnu.org/
100 Plus all what is required to build a kernel module.
102 Process:
104 <untar and go to directory with sources>
105 $ sh build.linux
107 # if following step fails(on X86) read next section before trying to
108 # execute mknod
109 $ su -c 'insmod mod/itc.ko' - 2.6 Kernels
110 $ su -c 'insmod mod/itc.o'  - 2.4 Kernels
112 $ su -c "chmod +r /dev/itc"
114 [make sure you are in X]
115 $ ./apc
117 ``````````````````````````````````````````````````````````````````````
118 Following applies only to Linux running on X86.
120 If the module fails to load consult dmesg(8). Most likely cause is the
121 lack of exported `default_idle'  function. Few workarounds follow.  If
122 dmesg(8) reports "itc: Unknown symbol  default_idle" you might want to
123 try patching the module sources:
125 $ (cd mod && patch -p0 <itc.patch && make)
127 Workarounds
129     Variant 1
130         Add `idle=halt' to the  kernel command line (method depends on
131         the boot-loader) and reboot.
133     Variant 2 (DANGEROUS)
134         --------------------------------------------------------------
135         Kernel 2.6
136         $ func=$(awk '/default_idle$/ {print "0x" $1}' /proc/kallsyms)
137         $ su -c "/sbin/insmod mod/itc.ko idle_func=$func"
139         --------------------------------------------------------------
140         Kernel 2.4
141         $ func=$(awk '/default_idle$/ {print "0x" $1}' /proc/ksyms)
142         $ su -c "/sbin/insmod mod/itc.o idle_func=$func"
144 ======================================================================