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