README

   1 This is the README for Aesalon.
   2
   3 Aesalon is a program to monitor the dynamically-allocated memory of another
   4 program. It uses ptrace and some trickery with DWARF debugging information to
   5 form a reference counter that is then used to display statistics on the memory
   6 allocated.
   7
   8 -- What is required to run aesalon
   9 In order to run the aesalon monitor on a program, it simply must have been
  10 compiled with debugging information, in the DWARF format. Beyond that, nothing
  11 else is required.
  12
  13 Currently, the only implemented graphical display utilizes Qt4. However,
  14 aesalon communicates information from the monitor to the display with TCP
  15 network sockets; therefore it is entirely possible to monitor a program
  16 remotely.
  17
  18 -- What is required to compile aesalon
  19 Aesalon is written in c++0x-compatible C++, and is mostly POSIX-compliant; it
  20 uses very few features that are not specified in the POSIX.1-2001. Therefore,
  21 g++ and libstdc++ should be sufficient. Beyond that, aesalon additionally
  22 requires a pthreads implementation to be installed. It is rare, however, for a
  23 standard Linux distribution to not have the required pacakges. Simply install
  24 g++ (only tested with version 4.4, but others should work), and cmake, the
  25 buildsystem generator (tested with 2.6 and 2.8).
  26
  27 -- How to compile aesalon
  28 First, edit the build.config file to change what is built, and what is not
  29 built. The only thing that most users will need to change is the PLATFORM
  30 variable. Currently, only x86 and x86_64 are actually supported, though ports
  31 to other platforms are certainly welcome.
  32
  33 Run 'cmake .' in the project root directory once you are done. This will
  34 generate the Makefiles required to actually build aesalon. Once that is done,
  35 run 'make', and that should be all that is required. The two symlinks in the
  36 project root directory (aesalon and aesalon_gui) should get you started.
  37
  38 Good luck, and happy hacking!
  39
  40  -- strange <kawk256@gmail.com>
  41