Added DLL linkage specification to class declarations to support building
[dyninst.git] / dyninstAPI / h / BPatch_point.h
1 /*
2  * Copyright (c) 1996 Barton P. Miller
3  * 
4  * We provide the Paradyn Parallel Performance Tools (below
5  * described as Paradyn") on an AS IS basis, and do not warrant its
6  * validity or performance.  We reserve the right to update, modify,
7  * or discontinue this software at any time.  We shall have no
8  * obligation to supply such updates or modifications or any other
9  * form of support to you.
10  * 
11  * This license is for research uses.  For such uses, there is no
12  * charge. We define "research use" to mean you may freely use it
13  * inside your organization for whatever purposes you see fit. But you
14  * may not re-distribute Paradyn or parts of Paradyn, in any form
15  * source or binary (including derivatives), electronic or otherwise,
16  * to any other organization or entity without our permission.
17  * 
18  * (for other uses, please contact us at paradyn@cs.wisc.edu)
19  * 
20  * All warranties, including without limitation, any warranty of
21  * merchantability or fitness for a particular purpose, are hereby
22  * excluded.
23  * 
24  * By your use of Paradyn, you understand and agree that we (or any
25  * other person or entity with proprietary rights in Paradyn) are
26  * under no obligation to provide either maintenance services,
27  * update services, notices of latent defects, or correction of
28  * defects for Paradyn.
29  * 
30  * Even if advised of the possibility of such damages, under no
31  * circumstances shall we (or any other person or entity with
32  * proprietary rights in the software licensed hereunder) be liable
33  * to you or any third party for direct, indirect, or consequential
34  * damages of any character regardless of type of action, including,
35  * without limitation, loss of profits, loss of use, loss of good
36  * will, or computer failure or malfunction.  You agree to indemnify
37  * us (and any other person or entity with proprietary rights in the
38  * software licensed hereunder) for any and all liability it may
39  * incur to third parties resulting from your use of Paradyn.
40  */
41
42 #ifndef _BPatch_point_h_
43 #define _BPatch_point_h_
44
45 #include "BPatch_dll.h"
46
47 class process;
48 class instPoint;
49 class BPatch_thread;
50 class BPatch_image;
51 class BPatch_function;
52
53
54 /*
55  * Used with BPatch_function::findPoint to specify which of the possible
56  * instrumentation points within a procedure should be returned.
57  */
58 typedef enum {
59     BPatch_entry,
60     BPatch_exit,
61     BPatch_subroutine,
62     BPatch_longJump,
63     BPatch_allLocations,
64     BPatch_instruction
65 } BPatch_procedureLocation;
66
67
68 class BPATCH_DLL_EXPORT BPatch_point {
69     friend class BPatch_thread;
70     friend class BPatch_image;
71     friend class BPatch_function;
72     friend class process;
73     friend BPatch_point* createInstructionInstPoint(process*proc,void*address);
74
75     process     *proc;
76     const BPatch_function       *func;
77     instPoint   *point;
78     BPatch_procedureLocation pointType;
79
80     BPatch_point(process *_proc, BPatch_function *_func, instPoint *_point,
81                  BPatch_procedureLocation _pointType) :
82         proc(_proc), func(_func), point(_point), pointType(_pointType) {};
83 public:
84     const BPatch_procedureLocation getPointType() { return pointType; }
85     const BPatch_function *getFunction() { return func; }
86     BPatch_function *getCalledFunction();
87     void            *getAddress();
88     int             getDisplacedInstructions(int maxSize, void *insns);
89
90     bool        usesTrap_NP();
91 };
92
93 #endif /* _BPatch_point_h_ */