README

   1 #
   2 # README - Description of the "core" directory of the paradyn system.
   3 #
   4 # $log$
   5 #
   6 #
   7
   8 This directory contains the "core" source code for the paradyn performance
   9 tools.  It is divided into subdirectories that represent major functional
  10 units of the system:
  11
  12 Each of these directories contain source code that gets compiled into a single
  13 UNIX executable:
  14
  15         bininst         - binary instrumentor
  16         igen            - interface generator
  17         paradyn         - paradyn GUI/controller
  18         paradynd        - paradynd (i.e. instrumentation manager)
  19         paradyndIPS2    - paradynd for processing IPS-2 trace files
  20         paradyndPVM     - paradynd for PVM (Parallel Virtual Machine)
  21         paradyndSIM     - paradynd to generate simulated data (used in testing).
  22
  23 There are also several libraries that get used in building the executables:
  24
  25         rtinst          - runtime instrumentation (linked into the application)
  26         thread          - a thread package used by paradyn
  27         util            - utility library
  28         visi            - external visualization interface
  29
  30 There are also two Makefile's at this level:
  31
  32         Makefile        A top level makefile to build the entire system
  33         make.config     A Makefile that defines global lists, flags, etc that
  34                         will be included into all other Makefiles in the system.
  35
  36
  37 The subdirectories of the "core" directory are organized to promote modularity
  38 and support compiling the system for multiple platforms in a single source
  39 tree.
  40
  41 Each directory contains the following files:
  42         h       - a directory describing the exported interface of this
  43                   component.  This typically consists of one or more C++ header
  44                   files, and one or more interface generator specifications
  45                   (files ending in .I).
  46
  47         src     - a directory containing the source files for the component.
  48                   Header files that are not part of the exported interface
  49                   are in this directory.
  50
  51         docs    - a directory containing the documentation for this component
  52                   of the system.  This generally consists of several man pages
  53                   and a README file.
  54
  55         compilation directories: <arch>-<vendor>-<os>
  56                   There is one of these for each supported platform.  The
  57                   contents of this directory consist of a Makefile and the
  58                   machine derived files that are built as part of the process
  59                   of building the component.  These might includes .C and .h
  60                   files generated by igen, flex, and bison as well as object
  61                   files (.o's).