Restructuring of declararations required because of include conflicts when
[dyninst.git] / dyninstAPI / README
1
2 This is the version 2.0 release of the Dyninst API.  Currently, the API
3 library is available for the Alpha/Digital UNIX, MIPS/Irix, POWER/AIX,
4 Sparc/Solaris, x86/Linux, x86/Windows NT, and x86/Solaris platforms.
5
6 Documentation for the API can be found at:
7
8     http://www.cs.umd.edu/projects/dyninstAPI/
9
10 The core/dyninstAPI/tests directory contains the source code for programs
11 that test the API functions.  These programs are useful as examples of how
12 to use the API.  See the README file in that directory for how to run or
13 rebuild them.
14
15 Setting up the environment
16 --------------------------
17
18 Before compiling or using the Dyninst API library, you should set the
19 environment variables PLATFORM and DYNINST_ROOT.  PLATFORM should be set to
20 one of the following values depending upon what operating system you are
21 running on:
22
23     alpha-dec-osf4.0            Digital UNIX on an Alpha processor
24     i386-unknown-linux2.2       Linux 2.2 on an Intel x86 processor
25     i386-unknown-nt4.0          Windows NT on an Intel x86 processor
26     i386-unknown-solaris2.6     Solaris 2.6 on an Intel x86 processor
27     mips-sgi-irix6.5            Irix 6.5
28     rs6000-ibm-aix4.2           AIX Version 4.2
29     sparc-sun-solaris2.6        Solaris 2.6 on a SPARC processor
30
31 DYNINST_ROOT should be set to the pathname of the top of the library source
32 tree (the "core" directory, one level up from where this README file is
33 located).
34
35 On all platforms except AIX, it is also necessary to set the environment
36 variable DYNINSTAPI_RT_LIB to the full pathname of the file
37 libdyninstAPI_RT.so.1 (on Windows NT, libdyninstAPI_RT.dll).  If you have
38 correctly set the DYNINST_ROOT and PLATFORM environment variables, then
39 the proper pathname is:
40
41     $DYNINST_ROOT/lib/$PLATFORM/libdyninstAPI_RT.so.1
42
43 On Windows NT, you may instead simply put the directory
44 %DYNINST_ROOT%/lib/%PLATFORM% in your path.
45
46 Building the Dyninst API from source
47 ------------------------------------
48
49 If you downloaded the source distribution of this package, you can build the
50 Dyninst API libraries by running "make" in the core directory (one level up
51 from where this README file is located).  However, note the steps below
52 which must be taken to set up your environment before you do so.  The
53 top-level makefile contains directives for compiling the Paradyn parallel
54 performance tool, from which the Dyninst API was derived.  If you have
55 downloaded only the Dyninst API, you will see a number of messages about
56 missing directories.  These directories are needed only for making Paradyn,
57 so you should ignore these messages.  If you downloaded the entire Paradyn
58 distribution, you can make only the API libraries by running "make
59 dynInstAPI" in the core directory.
60
61 Building the library on Windows NT
62 ----------------------------------
63
64 If you have received this file as part of the source code distribution of
65 the library and wish to compile on Windows NT, you will need to obtain and
66 install the ONC RPC package for Windows NT.  You can get this from the
67 following URL:
68
69     ftp://grilled.cs.wisc.edu/paradyn/etc/oncrpc112winnt.tar.gz
70
71 After installing ONC RPC, you should create a file named "make.config.local"
72 in the core directory, and include a line in it to set the RPCPKG variable to
73 the location in which you installed ONC RPC.  For instance, if you installed
74 it in C:\SUNRPC:
75
76     RPCPKG = C:\SUNRPC
77
78 -----------------------------------------------------------------------------
79
80 This software is derived from the Paradyn system and therefore subject to
81 the same copyright.  A copy of the Paradyn copyright appears at the end of
82 this file.
83
84         The Dyninst API team
85         4/11/2000
86
87 ----------------------- Start of Paradyn Copyright --------------------------
88 Copyright (c) 1996 Barton P. Miller
89
90 We provide the Paradyn Parallel Performance Tools (below
91 described as Paradyn") on an AS IS basis, and do not warrant its
92 validity or performance.  We reserve the right to update, modify,
93 or discontinue this software at any time.  We shall have no
94 obligation to supply such updates or modifications or any other
95 form of support to you.
96
97 This license is for research uses.  For such uses, there is no
98 charge. We define "research use" to mean you may freely use it
99 inside your organization for whatever purposes you see fit. But you
100 may not re-distribute Paradyn or parts of Paradyn, in any form
101 source or binary (including derivatives), electronic or otherwise,
102 to any other organization or entity without our permission.
103
104 (for other uses, please contact us at paradyn@cs.wisc.edu)
105
106 All warranties, including without limitation, any warranty of
107 merchantability or fitness for a particular purpose, are hereby
108 excluded.
109
110 By your use of Paradyn, you understand and agree that we (or any
111 other person or entity with proprietary rights in Paradyn) are
112 under no obligation to provide either maintenance services,
113 update services, notices of latent defects, or correction of
114 defects for Paradyn.
115
116 Even if advised of the possibility of such damages, under no
117 circumstances shall we (or any other person or entity with
118 proprietary rights in the software licensed hereunder) be liable
119 to you or any third party for direct, indirect, or consequential
120 damages of any character regardless of type of action, including,
121 without limitation, loss of profits, loss of use, loss of good
122 will, or computer failure or malfunction.  You agree to indemnify
123 us (and any other person or entity with proprietary rights in the
124 software licensed hereunder) for any and all liability it may
125 incur to third parties resulting from your use of Paradyn.
126