README

   1 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   2                                WARNING
   3
   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:
   6
   7                        NO GUARANTEES WHATSOEVER
   8
   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.
  15
  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'.
  21
  22 2.4 series of kernels were never tested on SMP as such the module will
  23 refuse to build for them.
  24
  25 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  26                This is APC - graphical CPU load meter.
  27
  28 It is more suitable/accurate in situations where applications generate
  29 "short" periodic bursts of activity.
  30
  31 It works by measuring the time spent in  the kernels idle handler. CPU
  32 load time is taken to mean:
  33
  34      time spent in idle handler
  35 1 -  --------------------------
  36         total time elapsed
  37
  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.
  42
  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.
  47
  48 Note that  dyntick  kernels  will most   likely produce  different but
  49 nonetheless still incorrect accounting.
  50
  51 Kernel (starting with version 2.6.21) comes with a document describing
  52 the  way accounting is currently  done and problems with this approach
  53 (Documentation/cpu-load.txt)
  54
  55 Following thread describes a take on addressing the issue properly:
  56 http://marc.info/?t=117480935100001&r=1&w=2
  57
  58 Apart    from   being inaccurate,  `/proc/stat'  exports monotonically
  59 increasing load times but _NOT_  real time[1], so there's omni-present
  60 sub-jiffy error. Not to mention that jiffy resolution is somewhat low.
  61
  62 If you depend on sorta-kinda semi-correct load meter in situation when
  63 `/proc/stat'  is disconnected with reality  APC might present a better
  64 choice.
  65
  66 The kernel  module part  of APC   tries to insert  itself  as  a power
  67 management idle  handler and when  invoked measure  how  much time  is
  68 spent executing previous/default one - this information is represented
  69 by yellow color, values  obtained via `/proc/stat' are represented  by
  70 red.
  71
  72 You  can use `-help' command  line option to   get a brief overview of
  73 tunable parameters.
  74
  75 Tested on[2]:
  76
  77 Linux 2.4.30   - AMD Athlon(tm) Processor (1.4 Ghz)
  78 Linux 2.6.17.6
  79 Linux 2.6.19.2 - AMD Athlon(tm)64 X2 Dual Core Processor  3800+
  80 Linux 2.6.18   - AMD Athlon(tm)64 3800+
  81 Linux 2.6.18.3 - PowerPC 7447A
  82 Linux 2.6.20.1 - PowerPC 7447A
  83 Linux 2.6.19   - [some Core 2 Duo]
  84
  85 It's possible  that RMClock[3]  does something similar(load  measuring
  86 wise) on Microsoft Windows.
  87
  88 [1] Unlike `/proc/uptime'. But this one is useless for SMP
  89 [2] SMP not tested on 2.4 kernels, nor QUIRK mode. SMP on PPC wasn't
  90     tested either
  91 [3] http://cpu.rightmark.org/products/rmclock.shtml
  92
  93 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  94 To build you will need:
  95
  96 OCaml  - http://caml.inria.fr/ocaml/
  97 LablGL - http://wwwfun.kurims.kyoto-u.ac.jp/soft/lsl/lablgl.html
  98          (and by extension some OpenGL implementation)
  99 GLUT   - http://www.opengl.org/resources/libraries/glut/
 100          http://freeglut.sourceforge.net/
 101 GCC    - http://gcc.gnu.org/
 102
 103 Plus all what is required to build a kernel module.
 104
 105 Process:
 106
 107 <untar and go to directory with sources>
 108 $ sh build.linux
 109
 110 # if following step fails(on X86) read next section before trying to
 111 # execute mknod
 112 $ su -c 'insmod mod/itc.ko' - 2.6 Kernels
 113 $ su -c 'insmod mod/itc.o'  - 2.4 Kernels
 114
 115 $ su -c "chmod +r /dev/itc"
 116
 117 [make sure you are in X]
 118 $ ./apc
 119
 120 ``````````````````````````````````````````````````````````````````````
 121 Following applies only to Linux running on X86.
 122
 123 If the module fails to load consult dmesg(8). Most likely cause is the
 124 lack of exported `default_idle'  function. Few workarounds follow.  If
 125 dmesg(8) reports "itc: Unknown symbol  default_idle" you might want to
 126 try patching the module sources:
 127
 128 $ (cd mod && patch -p0 <itc.patch && make)
 129
 130 Workarounds
 131
 132     Variant 1
 133         Add `idle=halt' to the  kernel command line (method depends on
 134         the boot-loader) and reboot.
 135
 136     Variant 2 (DANGEROUS)
 137         --------------------------------------------------------------
 138         Kernel 2.6
 139         $ func=$(awk '/default_idle$/ {print "0x" $1}' /proc/kallsyms)
 140         $ su -c "/sbin/insmod mod/itc.ko idle_func=$func"
 141
 142         --------------------------------------------------------------
 143         Kernel 2.4
 144         $ func=$(awk '/default_idle$/ {print "0x" $1}' /proc/ksyms)
 145         $ su -c "/sbin/insmod mod/itc.o idle_func=$func"
 146
 147 ======================================================================