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     BPatch_deref,
  90     BPatch_bit_compl,           // not supported yet
  91 } BPatch_unOp;
  92
  93 class BPATCH_DLL_EXPORT BPatch_snippet {
  94 public:
  95 // The following members are for  internal use by the library only:
  96     AstNode     *ast; /* XXX It would be better if this was protected */
  97 // End members for internal use only.
  98
  99     BPatch_snippet() : ast(NULL) {};
 100     BPatch_snippet(const BPatch_snippet &);
 101     BPatch_snippet &operator=(const BPatch_snippet &);
 102
 103     virtual     ~BPatch_snippet();
 104
 105     float       getCost();
 106 };
 107
 108 class BPATCH_DLL_EXPORT BPatch_arithExpr: public BPatch_snippet {
 109 public:
 110     BPatch_arithExpr(BPatch_binOp op,
 111                      const BPatch_snippet &lOperand,
 112                      const BPatch_snippet &rOperand);
 113     BPatch_arithExpr(BPatch_unOp op, const BPatch_snippet &lOperand);
 114 };
 115
 116 class BPATCH_DLL_EXPORT BPatch_boolExpr : public BPatch_snippet {
 117 public:
 118     BPatch_boolExpr(BPatch_relOp op, const BPatch_snippet &lOperand,
 119                     const BPatch_snippet &rOperand);
 120 };
 121
 122 class BPATCH_DLL_EXPORT BPatch_constExpr : public BPatch_snippet {
 123 public:
 124 #ifdef IBM_BPATCH_COMPAT
 125     BPatch_constExpr(long long value);
 126     BPatch_constExpr(float value);
 127 #endif
 128     BPatch_constExpr(int value);
 129 #ifdef BPATCH_NOT_YET
 130     BPatch_constExpr(float value);
 131 #endif
 132     BPatch_constExpr(const char *value);
 133     BPatch_constExpr(const void *value);
 134 };
 135
 136 class BPATCH_DLL_EXPORT BPatch_funcCallExpr : public BPatch_snippet {
 137 public:
 138     BPatch_funcCallExpr(const BPatch_function& func,
 139                         const BPatch_Vector<BPatch_snippet *> &args);
 140 };
 141
 142 class BPATCH_DLL_EXPORT BPatch_funcJumpExpr : public BPatch_snippet {
 143 public:
 144      BPatch_funcJumpExpr(const BPatch_function& func);
 145 };
 146
 147 class BPATCH_DLL_EXPORT BPatch_ifExpr : public BPatch_snippet {
 148 public:
 149     BPatch_ifExpr(const BPatch_boolExpr &conditional,
 150                   const BPatch_snippet &tClase);
 151     BPatch_ifExpr(const BPatch_boolExpr &conditional,
 152                   const BPatch_snippet &tClase,
 153                   const BPatch_snippet &fClause);
 154 };
 155
 156 class BPATCH_DLL_EXPORT BPatch_nullExpr : public BPatch_snippet {
 157 public:
 158     BPatch_nullExpr();
 159 };
 160
 161 class BPATCH_DLL_EXPORT BPatch_paramExpr : public BPatch_snippet {
 162 public:
 163     BPatch_paramExpr(int n);
 164 };
 165
 166 class BPATCH_DLL_EXPORT BPatch_retExpr : public BPatch_snippet {
 167 public:
 168     BPatch_retExpr();
 169 };
 170
 171 class BPATCH_DLL_EXPORT BPatch_sequence : public BPatch_snippet {
 172 public:
 173     BPatch_sequence(const BPatch_Vector<BPatch_snippet *> &items);
 174 };
 175
 176 class BPATCH_DLL_EXPORT BPatch_variableExpr : public BPatch_snippet {
 177     char                *name;
 178     process             *proc;
 179     void                *address;
 180     int                 size;
 181     BPatch_point        *scope;
 182 public:
 183 // The following functions are for internal use by the library only:
 184     BPatch_variableExpr(char *name, process *in_process, void *in_address,
 185                         const BPatch_type *type);
 186     BPatch_variableExpr(process *in_process, void *in_address,
 187                         const BPatch_type *type, bool frameRelative = false,
 188                         BPatch_point *sc = NULL);
 189     BPatch_variableExpr(process *in_process, void *in_address,
 190                         int in_size);
 191     BPatch_variableExpr(char *in_name, process *in_process, AstNode *_ast,
 192                         const BPatch_type *type);
 193
 194 // Public functions for use by users of the library:
 195     bool readValue(void *dst);
 196     void readValue(void *dst, int len);
 197     bool writeValue(const void *src);
 198     void writeValue(const void *src, int len);
 199
 200     char *getName() { return name; }
 201     void *getBaseAddr() const { return address; }
 202
 203 #ifdef IBM_BPATCH_COMPAT
 204     const char *getName(char *buffer, int max) { return strncpy(buffer, name, max); }
 205     long long int getAddress() const { return (long long int) address; }
 206 #endif
 207
 208     unsigned int getSize() const { return size; }
 209     BPatch_type *getType();
 210     void setType(BPatch_type *);
 211     void setSize(int sz) {  size = sz; }
 212     BPatch_Vector<BPatch_variableExpr *> *getComponents();
 213 };
 214
 215 class BPATCH_DLL_EXPORT BPatch_breakPointExpr : public BPatch_snippet {
 216 public:
 217     BPatch_breakPointExpr();
 218 };
 219
 220 #endif /* _BPatch_snippet_h_ */