mods/additions largely under the USE_STL_VECTOR and IBM_BPATCH_COMPAT flags
[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 class BPatch_memoryAccess;
53
54 /*
55  * Provide these definitions for backwards compatability.
56  *
57  */
58 #define BPatch_entry BPatch_locEntry
59 #define BPatch_exit BPatch_locExit
60 #define BPatch_subroutine BPatch_locSubroutine
61 #define BPatch_longJump BPatch_locLongJump
62 #define BPatch_allLocations BPatch_locAllLocations
63 #define BPatch_instruction BPatch_locInstruction
64
65 /*
66  * Used with BPatch_function::findPoint to specify which of the possible
67  * instrumentation points within a procedure should be returned.
68  */
69 typedef enum eBPatch_procedureLocation {
70     BPatch_locEntry,
71     BPatch_locExit,
72     BPatch_locSubroutine,
73     BPatch_locLongJump,
74     BPatch_locAllLocations,
75     BPatch_locInstruction,
76     BPatch_locSourceBlockEntry,         // not yet used
77     BPatch_locSourceBlockExit,          // not yet used
78     BPatch_locSourceLoopEntry,          // not yet used
79     BPatch_locSourceLoopExit,           // not yet used
80     BPatch_locBasicBlockEntry,          // not yet used
81     BPatch_locBasicBlockExit,           // not yet used
82     BPatch_locSourceLoop,               // not yet used
83     BPatch_locBasicBlockLoopEntry,      // not yet used
84     BPatch_locBasicBlockLoopExit,       // not yet used
85     BPatch_locVarInitStart,             // not yet used
86     BPatch_locVarInitEnd,               // not yet used
87     BPatch_locStatement         // not yet used
88 } BPatch_procedureLocation;
89
90
91 /* VG (09/07/01) Created */
92
93 typedef enum eBPatch_opCode {
94   BPatch_opLoad,
95   BPatch_opStore,
96   BPatch_opPrefetch
97 } BPatch_opCode;
98
99 /* VG(09/17/01) Added memory access pointer */
100
101 /* VG(11/06/01) Moved constructor to implementation file because it
102    needs to link instPoint back pointer (and we don't want to include
103    that here) */
104 class BPATCH_DLL_EXPORT BPatch_point {
105     friend class BPatch_thread;
106     friend class BPatch_image;
107     friend class BPatch_function;
108     friend class process;
109     friend BPatch_point* createInstructionInstPoint(process*proc,void*address,
110                                                     BPatch_point** alternative);
111     friend BPatch_point* createInstPointForMemAccess(process *proc,
112                                                      void *addr,
113                                                      BPatch_memoryAccess* ma,
114                                                      BPatch_point** alternative);
115     process     *proc;
116     const BPatch_function       *func;
117     instPoint   *point;
118     BPatch_procedureLocation pointType;
119     BPatch_memoryAccess *memacc;
120
121     BPatch_point(process *_proc, BPatch_function *_func, instPoint *_point,
122                  BPatch_procedureLocation _pointType, BPatch_memoryAccess* _ma = NULL);
123 public:
124     //~BPatch_point() { delete memacc; };
125
126     const BPatch_procedureLocation getPointType() { return pointType; }
127     const BPatch_function *getFunction() { return func; }
128     BPatch_function *getCalledFunction();
129     void            *getAddress();
130     const BPatch_memoryAccess* getMemoryAccess() const { return memacc; }
131
132 #ifdef IBM_BPATCH_COMPAT
133     void *getPointAddress() { return getAddress(); }
134
135     int getPointLine() { return -1; }
136
137     BPatch_function     *getContainingFunction() { return const_cast<BPatch_function*>(getFunction()); };
138 #endif
139
140     int             getDisplacedInstructions(int maxSize, void *insns);
141
142     bool        usesTrap_NP();
143 };
144
145 #endif /* _BPatch_point_h_ */