README

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