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_dll.h"
  46 #include "BPatch_Vector.h"
  47 #include "BPatch_sourceObj.h"
  48 #include "BPatch_point.h"
  49 #include "BPatch_type.h"
  50 #include "BPatch_module.h"
  51 #include "BPatch_function.h"
  52
  53 class AstNode;
  54 class process;
  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_bit_and,             // not supported yet
  77     BPatch_bit_or,              // not supported yet
  78     BPatch_bit_xor,             // not supported yet
  79     BPatch_left_shift,          // not supported yet
  80     BPatch_right_shift          // not supported yet
  81 } BPatch_binOp;
  82
  83 // for backwards compatability
  84 #define BPatch_addr BPatch_address
  85
  86 typedef enum {
  87     BPatch_negate,
  88     BPatch_address,
  89 #ifdef IBM_BPATCH_COMPAT
  90     BPatch_deref,
  91     BPatch_bit_compl            // not supported yet
  92 #else
  93     BPatch_deref
  94 #endif
  95 } BPatch_unOp;
  96
  97 class BPATCH_DLL_EXPORT BPatch_snippet {
  98 public:
  99 // The following members are for  internal use by the library only:
 100     AstNode     *ast; /* XXX It would be better if this was protected */
 101 // End members for internal use only.
 102
 103     BPatch_snippet() : ast(NULL) {};
 104     BPatch_snippet(const BPatch_snippet &);
 105     BPatch_snippet &operator=(const BPatch_snippet &);
 106
 107     virtual     ~BPatch_snippet();
 108
 109     float       getCost();
 110 };
 111
 112 class BPATCH_DLL_EXPORT BPatch_arithExpr: public BPatch_snippet {
 113 public:
 114     BPatch_arithExpr(BPatch_binOp op,
 115                      const BPatch_snippet &lOperand,
 116                      const BPatch_snippet &rOperand);
 117     BPatch_arithExpr(BPatch_unOp op, const BPatch_snippet &lOperand);
 118 };
 119
 120 class BPATCH_DLL_EXPORT BPatch_boolExpr : public BPatch_snippet {
 121 public:
 122     BPatch_boolExpr(BPatch_relOp op, const BPatch_snippet &lOperand,
 123                     const BPatch_snippet &rOperand);
 124 };
 125
 126 class BPATCH_DLL_EXPORT BPatch_constExpr : public BPatch_snippet {
 127 public:
 128 #ifdef IBM_BPATCH_COMPAT
 129     BPatch_constExpr(long long value);
 130     BPatch_constExpr(float value);
 131 #endif
 132     BPatch_constExpr(int value);
 133 #ifdef BPATCH_NOT_YET
 134     BPatch_constExpr(float value);
 135 #endif
 136     BPatch_constExpr(const char *value);
 137     BPatch_constExpr(const void *value);
 138 };
 139
 140 class BPATCH_DLL_EXPORT BPatch_funcCallExpr : public BPatch_snippet {
 141 public:
 142     BPatch_funcCallExpr(const BPatch_function& func,
 143                         const BPatch_Vector<BPatch_snippet *> &args);
 144 };
 145
 146 class BPATCH_DLL_EXPORT BPatch_funcJumpExpr : public BPatch_snippet {
 147 public:
 148      BPatch_funcJumpExpr(const BPatch_function& func);
 149 };
 150
 151 class BPATCH_DLL_EXPORT BPatch_ifExpr : public BPatch_snippet {
 152 public:
 153     BPatch_ifExpr(const BPatch_boolExpr &conditional,
 154                   const BPatch_snippet &tClase);
 155     BPatch_ifExpr(const BPatch_boolExpr &conditional,
 156                   const BPatch_snippet &tClase,
 157                   const BPatch_snippet &fClause);
 158 };
 159
 160 class BPATCH_DLL_EXPORT BPatch_nullExpr : public BPatch_snippet {
 161 public:
 162     BPatch_nullExpr();
 163 };
 164
 165 class BPATCH_DLL_EXPORT BPatch_paramExpr : public BPatch_snippet {
 166 public:
 167     BPatch_paramExpr(int n);
 168 };
 169
 170 class BPATCH_DLL_EXPORT BPatch_retExpr : public BPatch_snippet {
 171 public:
 172     BPatch_retExpr();
 173 };
 174
 175 class BPATCH_DLL_EXPORT BPatch_sequence : public BPatch_snippet {
 176 public:
 177     BPatch_sequence(const BPatch_Vector<BPatch_snippet *> &items);
 178 };
 179
 180 class BPATCH_DLL_EXPORT BPatch_variableExpr : public BPatch_snippet {
 181     char                *name;
 182     process             *proc;
 183     void                *address;
 184     int                 size;
 185     BPatch_point        *scope;
 186 public:
 187 // The following functions are for internal use by the library only:
 188     BPatch_variableExpr(char *name, process *in_process, void *in_address,
 189                         const BPatch_type *type);
 190     BPatch_variableExpr(process *in_process, void *in_address,
 191                         const BPatch_type *type, bool frameRelative = false,
 192                         BPatch_point *sc = NULL);
 193     BPatch_variableExpr(process *in_process, void *in_address,
 194                         int in_size);
 195     BPatch_variableExpr(char *in_name, process *in_process, AstNode *_ast,
 196                         const BPatch_type *type);
 197     BPatch_variableExpr(char *in_name,
 198                         process *in_process,
 199                         AstNode *_ast,
 200                         const BPatch_type *type,
 201                         void* in_address);
 202
 203 // Public functions for use by users of the library:
 204     bool readValue(void *dst);
 205     void readValue(void *dst, int len);
 206     bool writeValue(const void *src, bool saveWorld=false); //ccw 26 nov 2001
 207     void writeValue(const void *src, int len,bool saveWorld=false);
 208
 209     char *getName() { return name; }
 210     void *getBaseAddr() const { return address; }
 211
 212 #ifdef IBM_BPATCH_COMPAT
 213     const char *getName(char *buffer, int max) { return strncpy(buffer, name, max); }
 214     long long int getAddress() const { return (long long int) address; }
 215 #endif
 216
 217     unsigned int getSize() const { return size; }
 218     BPatch_type *getType();
 219     const BPatch_type *getType() const;
 220     void setType(BPatch_type *);
 221     void setSize(int sz) {  size = sz; }
 222     BPatch_Vector<BPatch_variableExpr *> *getComponents();
 223 };
 224
 225 class BPATCH_DLL_EXPORT BPatch_breakPointExpr : public BPatch_snippet {
 226 public:
 227     BPatch_breakPointExpr();
 228 };
 229
 230 // VG(11/05/01): This nullary snippet will return the effective
 231 // address of a memory access when inserted at an instrumentation
 232 // point that is a memory access.  In other words, the instruction at
 233 // the point where it is inserted is the one to get effective address
 234 // for.  Furthermore, there must be memory access information about
 235 // the inst. point; this basically means that the point must have been
 236 // created using a method that attaches that info to the point -
 237 // e.g. using findPoint(const BPatch_Set<BPatch_opCode>& ops) from
 238 // BPatch_function.
 239
 240 // VG(7/31/02): Since x86 can have 2 addresses per instruction, there is
 241 // now parameter for the constructor indicating which of these you want.
 242 // It defaults to the 1st access (#0).
 243
 244 // VG(8/14/02): added conditional parameter
 245 class BPATCH_DLL_EXPORT BPatch_effectiveAddressExpr : public BPatch_snippet
 246 {
 247 public:
 248   BPatch_effectiveAddressExpr(int _which = 0);
 249 };
 250
 251 // Number of bytes moved
 252 class BPATCH_DLL_EXPORT BPatch_bytesAccessedExpr : public BPatch_snippet
 253 {
 254 public:
 255   BPatch_bytesAccessedExpr(int _which = 0);
 256 };
 257
 258 // VG(8/11/2): It is possible to have a more general expression, say
 259 // machineConditionExpr, then have this reimplemented as ifExpr(machineConditionExpr, ...),
 260 // and have an optimization (fast path) for that case using the specialized
 261 // AST that supports this class. Memory instrumentation has no need for a standalone
 262 // machineConditionExpr, so that remains TBD...
 263 class BPATCH_DLL_EXPORT BPatch_ifMachineConditionExpr : public BPatch_snippet {
 264 public:
 265   BPatch_ifMachineConditionExpr(const BPatch_snippet &tClase);
 266 };
 267
 268 #endif /* _BPatch_snippet_h_ */