Added BPatch_thread::oneTimeCode, BPatch_thread::loadLibrary, and other
[dyninst.git] / dyninstAPI / h / BPatch_snippet.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_snippet_h_
43 #define _BPatch_snippet_h_
44
45 #include "BPatch_Vector.h"
46 #include "BPatch_point.h"
47
48 class AstNode;
49 class function_base;
50 class process;
51
52 class BPatch_function;
53 class BPatch_point;
54 class BPatch_type;
55
56 typedef enum {
57     BPatch_lt,
58     BPatch_eq,
59     BPatch_gt,
60     BPatch_le,
61     BPatch_ne,
62     BPatch_ge,
63     BPatch_and,
64     BPatch_or
65 } BPatch_relOp;
66
67 typedef enum {
68     BPatch_assign,
69     BPatch_plus,
70     BPatch_minus,
71     BPatch_divide,
72     BPatch_times,
73     BPatch_mod,
74     BPatch_ref,
75     BPatch_seq
76 } BPatch_binOp;
77
78 typedef enum {
79     BPatch_negate,
80     BPatch_address
81 } BPatch_unOp;
82
83
84 class BPatch_function {
85     process *proc;
86 public:
87 // The following are for  internal use by the library only:
88     function_base *func;
89     BPatch_function(process *_proc, function_base *_func) :
90         proc(_proc), func(_func) {};
91
92 // For users of the library:
93     char        *getName(char *s, int len);
94
95     BPatch_Vector<BPatch_point *>
96         *findPoint(const BPatch_procedureLocation loc);
97 };
98
99
100 class BPatch_snippet {
101 public:
102 // The following members are for  internal use by the library only:
103     AstNode     *ast; /* XXX It would be better if this was protected */
104 // End members for internal use only.
105
106     BPatch_snippet() : ast(NULL) {};
107     BPatch_snippet(const BPatch_snippet &);
108     BPatch_snippet &operator=(const BPatch_snippet &);
109
110     virtual     ~BPatch_snippet();
111
112     float       getCost();
113 };
114
115 class BPatch_arithExpr: public BPatch_snippet {
116 public:
117     BPatch_arithExpr(BPatch_binOp op,
118                      const BPatch_snippet &lOperand,
119                      const BPatch_snippet &rOperand);
120 };
121
122 class BPatch_boolExpr : public BPatch_snippet {
123 public:
124     BPatch_boolExpr(BPatch_relOp op, const BPatch_snippet &lOperand,
125                     const BPatch_snippet &rOperand);
126 };
127
128 class BPatch_constExpr : public BPatch_snippet {
129 public:
130     BPatch_constExpr(int value);
131 #ifdef BPATCH_NOT_YET
132     BPatch_constExpr(float value);
133 #endif
134     BPatch_constExpr(const char *value);
135 };
136
137 class BPatch_funcCallExpr : public BPatch_snippet {
138 public:
139     BPatch_funcCallExpr(const BPatch_function& func,
140                         const BPatch_Vector<BPatch_snippet *> &args);
141 };
142
143 class BPatch_ifExpr : public BPatch_snippet {
144 public:
145     BPatch_ifExpr(const BPatch_boolExpr &conditional,
146                   const BPatch_snippet &tClase);
147     BPatch_ifExpr(const BPatch_boolExpr &conditional,
148                   const BPatch_snippet &tClase,
149                   const BPatch_snippet &fClause);
150 };
151
152 class BPatch_nullExpr : public BPatch_snippet {
153 public:
154     BPatch_nullExpr();
155 };
156
157 class BPatch_paramExpr : public BPatch_snippet {
158 public:
159     BPatch_paramExpr(int n);
160 };
161
162 class BPatch_retExpr : public BPatch_snippet {
163 public:
164     BPatch_retExpr();
165 };
166
167 class BPatch_sequence : public BPatch_snippet {
168 public:
169     BPatch_sequence(const BPatch_Vector<BPatch_snippet *> &items);
170 };
171
172 class BPatch_variableExpr : public BPatch_snippet {
173     process     *proc;
174     void        *address;
175     int         size;
176 public:
177 // The following functions are for internal use by the library only:
178     BPatch_variableExpr(process *in_process, void *in_address,
179                         const BPatch_type *type);
180     BPatch_variableExpr(process *in_process, void *in_address,
181                         int in_size);
182
183 // Public functions for use by users of the library:
184     void readValue(void *dst);
185     void readValue(void *dst, int len);
186     void writeValue(const void *src);
187     void writeValue(const void *src, int len);
188
189     void *getBaseAddr() const { return address; }
190 };
191
192 class BPatch_breakPointExpr : public BPatch_snippet {
193 public:
194     BPatch_breakPointExpr();
195 };
196
197 #endif /* _BPatch_snippet_h_ */