*** empty log message ***
[dyninst.git] / README
1
2         README for common Paradyn/DyninstAPI core directory hierarchy
3         =============================================================
4
5 This directory contains the "core" source code for both the Paradyn
6 parallel performance tools and the distinct DyninstAPI library for building
7 tools based on dynamic instrumentation.  It is divided into subdirectories
8 that represent major functional units of the system -- DyninstAPI-only
9 releases contain only those source subdirectories actually required by it.
10
11 Each of these directories contain source code that gets compiled into a single
12 executable:
13
14         igen            - interface generator
15         paradyn         - Paradyn GUI/controller
16         paradynd        - Paradyn daemon (i.e. instrumentation manager)
17         rthist          - real-time histogram visualization
18         visiClients     - Paradyn visi clients:
19                           tclVisi, barchart, phaseTable, tableVisi, terrain
20
21 There are also several libraries that get used in building the executables:
22
23         rtinst          - runtime instrumentation (linked into the application) 
24         thread          - the thread package used by Paradyn
25         util            - general utility library
26         visi            - external visualization interface
27         hist            - histogram library used by rthist
28
29 Two more directories contain the libraries that make up the DyninstAPI:
30
31         dyninstAPI      - the DyninstAPI library
32         dyninstAPI_RT   - runtime instrumentation (linked into the application)
33
34 The only Paradyn module required by the DyninstAPI is the util directory.
35
36 There is also a Makefile and several make configuration files at this level:
37         
38         Makefile        - A top level GNU Makefile to build the entire system
39                           for Unix systems *only*
40                           (make scripts for WindowsNT are found in ../scripts)
41
42         make.config     - A Makefile that defines global lists, flags, etc. that
43                           are included into all other Makefiles in the system.
44         make.library.tmpl - make configuration rules for libraries
45         make.program.tmpl - make configuration rules for executables
46
47         nmake.config    - These three files are for WindowsNT nmake, and
48                           they mimic the GNU make configuration files
49         nmake.library.tmpl
50         nmake.program.tmpl
51
52 The top-level Makefile has targets defined to build Paradyn ("make Paradyn"),
53 the DyninstAPI ("make DyninstAPI") or both (the default, "make").
54 Remember to read the section of the Developer's Guide describing build
55 configuation and appropriately edit make.config before building.
56 See the README file in the dyninstAPI subdirectory for further information
57 about building/installing the API library.
58
59 Subdirectories of the "core" directory are organized to promote modularity and
60 support compiling the system for multiple platforms in a single source tree.
61
62 Each directory contains the following files:
63         h       - a directory describing the exported interface of this 
64                   component.  This typically consists of one or more C++ header
65                   files, and one or more interface generator specifications
66                   (files ending in .I).
67
68         src     - a directory containing the source files for the component.
69                   Header files that are not part of the exported interface
70                   are in this directory.
71
72         docs    - a directory containing the documentation for this component
73                   of the system.  This generally consists of several man pages
74                   and a README file.
75
76         tests   - a directory containing any tests for that module
77                   (typically for library modules only)
78
79         build directories: <arch>-<vendor>-<os>
80                   There is one of these for each supported platform.  The 
81                   contents of this directory consist of a Makefile and the 
82                   machine derived files that are built as part of the process 
83                   of building the component.  These might includes .C and .h 
84                   files generated by igen, flex, and bison as well as object 
85                   files (.o's).
86
87 ==============================================================================
88 $Id: README,v 1.6 1999/05/29 22:23:05 wylie Exp $