INSTALL

This document contains a basic outline for how to install the
PEBIL binary instrumentation package. Direct any questions or
comments to michaell@sdsc.edu

1. System Requirements

   Operating System        Linux
   Binary Format           Elf
   Architecture            ia32 or x86_64


2. set up environment

   You will need to set the following variables (assuming the installation is
   at /path/to/PEBIL/):

   A. bash:
   $ export PEBIL_ROOT=/path/to/PEBIL
   $ export PATH=${PATH}:${PEBIL_ROOT}/bin:${PEBIL_ROOT}/scripts
   $ export LD_LIBRARY_PATH=${LD_LIBRARY_PATH}:${PEBIL_ROOT}/lib

   This functionality is also encapsulated in bashrc, so you can try:
   $ . bashrc

   B. csh:
   % setenv PEBIL_ROOT /path/to/PEBIL/
   % setenv PATH ${PATH}:${PEBIL_ROOT}/bin:${PEBIL_ROOT}/scripts
   % setenv LD_LIBRARY_PATH ${LD_LIBRARY_PATH}:${PEBIL_ROOT}/lib


3. PEBIL can be built using either autoconf configure script and the
resulting makefile or with cmake. 
   A. run the configure script. The mpi compiler detection isn't perfect 
   so setting the MPICC variable might be helpful. Some other
   useful flags might be to use --enable-mpi=no if you don't want MPI
   support or --enable-static=yes if your system doesn't support shared
   libraries (TODO: static support sucks)

   $ ./configure [MPICC=...] [--enable-mpi=no] [--enable-static=yes]

   B. [NO LONGER SUPPORTED] run cmake. If you use this option you will also need to
   configure/build the udis library.

   $ cmake .
   $ cd external/udis86-1.7
   $ ./configure; make
   $ cd -


4. build

   $ make clean all install

   NOTE: The install target copies things to /path/to/PEBIL/lib/ and 
   /path/to/PEBIL/bin/ (ie, it doesn't do what most install targets
   do in that it doesn't try to system directories and ignores the
   --prefix option to configure).


5. run PEBIL
   For some ideas on what command line options are available:
   $ pebil --help

   Examples:
   $ pebil --typ jbb --app testapps/dynTest.gnu
   $ pebil --lib lib --typ ide src/pebil
   $ pebil --typ crp --trk $PEBIL_ROOT/scripts/inputlist/test.wrap --app cg.A.8