README

LiTL: Lightweight Trace Library
=============================================
LiTL is a lightweight tool for recording events during the execution of 
scientific high-performance applications. LiTL is designed to record events on 
the user level only. Therefore, it consumes much less resources (CPU time, 
memory, and the disk space) as the alternative tools, e.g. FxT that gather 
events on both user and kernel levels. As a result, LiTL is well-suited for 
recording events on embedded systems like ARM architectures.

Installing LiTL
=============================================
At first, to configure LiTL the following script should be invoked:
    $ cmake . -DCMAKE_INSTALL_PREFIX=<LITL_INSTALL_DIR>

The configuration script contains many different options that can be set. 
However, we recommend to use the default settings.

Once LiTL is configured, the next two commands should be executed:
    $ make
    $ make install

Using LiTL
=============================================
litl_print
----------
  This tool is used to analyze trace files produced by LiTL as
    $ litl_print -f trace.file

litl_merge
----------
  This tool is used to merge severals traces into one archive as
    $ litl_merge -o archive.trace trace.0 trace.1 ... trace.n

litl_split
----------
  This tool is used to split an archive of traces into separate trace files as
    $ litl_split -f archive.trace -d output.dir