SymEval: Use MachRegister interface
[dyninst.git] / symEval / src / SymEval.h
1 /*
2  * Copyright (c) 1996-2007 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  * By your use of Paradyn, you understand and agree that we (or any
12  * other person or entity with proprietary rights in Paradyn) are
13  * under no obligation to provide either maintenance services,
14  * update services, notices of latent defects, or correction of
15  * defects for Paradyn.
16  * 
17  * This library is free software; you can redistribute it and/or
18  * modify it under the terms of the GNU Lesser General Public
19  * License as published by the Free Software Foundation; either
20  * version 2.1 of the License, or (at your option) any later version.
21  * 
22  * This library is distributed in the hope that it will be useful,
23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
25  * Lesser General Public License for more details.
26  * 
27  * You should have received a copy of the GNU Lesser General Public
28  * License along with this library; if not, write to the Free Software
29  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
30  */
31
32 // Stubs for now
33
34 #if !defined(SymEval_h)
35 #define SymEval_h
36
37 #include <map>
38
39 #include "Instruction.h"
40 #include "BinaryFunction.h"
41 #include "Dereference.h"
42 #include "Immediate.h"
43 #include "Absloc.h"
44 #include "AST.h"
45
46 #include "external/rose/rose-compat.h"
47
48 class SgAsmx86Instruction;
49 class SgAsmExpression;
50
51 namespace Dyninst {
52 namespace SymbolicEvaluation {
53
54 class SymEval {
55  public:
56   // Return type: mapping AbsRegions to ASTs
57   // We then can map Assignment::AbsRegions to 
58   // SymEval::AbsRegions and come up with the answer
59
60   typedef std::map<Assignment::Ptr, AST::Ptr> Result;
61     
62   // Single version: hand in an Assignment, get an AST
63   static AST::Ptr expand(const Assignment::Ptr &assignment);
64
65   // Hand in a set of Assignments (from the same instruction!)
66   // get back a map of Assignments->ASTs
67   // We assume the assignments are prepped in the input; whatever
68   // they point to is discarded.
69   static void expand(Result &res);
70   
71  private:
72   static SgAsmx86Instruction convert(const InstructionAPI::Instruction::Ptr &insn, uint64_t addr);
73   static X86InstructionKind convert(entryID opcode);
74   static SgAsmExpression *convert(const InstructionAPI::Operand &operand);
75   static SgAsmExpression *convert(const InstructionAPI::Expression::Ptr expression);
76
77   // Symbolically evaluate an instruction and assign 
78   // an AST representation to every written absloc
79   static void expandInsn(const InstructionAPI::Instruction::Ptr insn,
80                          const uint64_t addr,
81                          Result &res);
82   
83   friend class ExpressionConversionVisitor;
84 };
85
86 class ExpressionConversionVisitor : public InstructionAPI::Visitor {
87  public:
88     ExpressionConversionVisitor() { roseExpression = NULL; }
89
90     SgAsmExpression *getRoseExpression() { return roseExpression; }
91
92     virtual void visit(InstructionAPI::BinaryFunction *binfunc);
93     virtual void visit(InstructionAPI::Immediate *immed);
94     virtual void visit(InstructionAPI::RegisterAST *regast);
95     virtual void visit(InstructionAPI::Dereference *deref);
96
97  private:
98     SgAsmExpression *roseExpression;
99 };
100
101 };
102 };
103
104 #endif