Add CMakeLists.txt
[dyninst.git] / README
1
2           README for common Paradyn/DyninstAPI directory hierarchy
3           =========================================================
4
5 This directory contains the "dyninst" 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         visiClients     - Paradyn visi clients (and tclVisi):
18                           barchart, histVisi, phaseTable, tableVisi, terrain
19
20 There are also several libraries that get used in building the executables:
21
22         pdutil          - Paradyn utility library (see also "common")
23         rtinst          - runtime instrumentation (loaded into the application) 
24         thread          - the thread package used by Paradyn
25         visi            - external visualization interface
26
27 One directory contains source for utilities common to both Paradyn & DyninstAPI.
28
29         common          - common utilities (e.g., Vector, String, Dictionary)
30
31 Two more directories contain the libraries that make up the DyninstAPI:
32
33         dyninstAPI      - the DyninstAPI library
34         dyninstAPI_RT   - runtime instrumentation (loaded into the application)
35
36 An additional directory contains the "dyner" DyninstAPI-based scripting tool:
37
38         dyner           - the dyner Tcl-scripting interface to DyninstAPI.
39
40 There is also a Makefile and several make configuration files at this level:
41         
42         Makefile        - A top level GNU Makefile to build the entire system
43                           for Unix systems *only*
44                           (make scripts for WindowsNT are found in ../scripts)
45
46         make.config     - A Makefile that defines global lists, flags, etc. that
47                           are included into all other Makefiles in the system.
48         make.library.tmpl - make configuration rules for libraries
49         make.program.tmpl - make configuration rules for executables
50         make.platform.tmpl - platform-specific make customizations
51
52         nmake.config    - These three files are for WindowsNT nmake, and
53                           they mimic the GNU make configuration files
54         nmake.library.tmpl
55         nmake.program.tmpl
56
57 The top-level Makefile has targets defined to build Paradyn ("make Paradyn"),
58 the DyninstAPI ("make DyninstAPI") or both (the default, "make").
59 Remember to read the section of the Developer's Guide describing build
60 configuation and appropriately edit make.config before building.
61 See the README file in the dyninstAPI subdirectory for further information
62 about building/installing the API library.
63
64 Subdirectories of the "dyninst" directory are organized to promote 
65 modularity and support compiling the system for multiple platforms 
66 in a single source tree.
67
68 Each directory contains the following files:
69         h       - a directory describing the exported interface of this 
70                   component.  This typically consists of one or more C++ header
71                   files, and one or more interface generator specifications
72                   (files ending in .I).
73
74         src     - a directory containing the source files for the component.
75                   Header files that are not part of the exported interface
76                   are in this directory.
77
78         docs    - a directory containing the documentation for this component
79                   of the system.  This generally consists of several man pages
80                   and a README file.
81
82         tests   - a directory containing any tests for that module
83                   (typically for library modules only)
84
85         build directories: <arch>-<vendor>-<os>
86                   There is one of these for each supported platform.  The 
87                   contents of this directory consist of a Makefile and the 
88                   machine derived files that are built as part of the process 
89                   of building the component.  These might includes .C and .h 
90                   files generated by igen, flex, and bison as well as object 
91                   files (.o's).
92
93 ==============================================================================