Update copyright to LGPL on all files
[dyninst.git] / instructionAPI / h / Dereference.h
1 /*
2  * Copyright (c) 1996-2009 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 #if !defined(DEREFERENCE_H)
33 #define DEREFERENCE_H
34
35 #include "Expression.h"
36 #include "Register.h"
37 #include <sstream>
38 #include "Visitor.h"
39
40 namespace Dyninst
41 {
42   namespace InstructionAPI
43   {
44     using std::vector;
45
46     /// A %Dereference object is a %Expression that dereferences another %ValueComputation.
47     ///
48     /// A %Dereference contains an %Expression representing an effective address computation.
49     /// Its use set is the same as the use set of the
50     /// %Expression being dereferenced.
51     ///
52     /// It is not possible, given the information in a single instruction, to evaluate
53     /// the result of a dereference.  \c eval may still be called on a %Expression
54     /// that includes dereferences, but the expected use case is as follows:
55     ///   - Determine the address being used in a dereference via the \c eval mechanism
56     ///   - Perform analysis to determine the contents of that address
57     ///   - If necessary, fill in the %Dereference node with the contents of that addresss, using \c setValue
58     ///
59     /// The type associated with a %Dereference node will be the type of the value \em read \em from \em memory,
60     /// not the type used for the address computation.  Two %Dereferences that access the same address but interpret
61     /// the contents of that memory as different types will produce different values.  The children of a %Dereference at
62     /// a given address are identical, regardless of the type of dereference being performed at that address.
63     /// For example, the %Expression shown in Figure 6 could have its root %Dereference, which interprets the memory being dereferenced
64     /// as a unsigned 16-bit integer, replaced with a %Dereference that
65     /// interprets the memory being dereferenced as any other type.  The remainder of the %Expression tree would, however, remain unchanged.
66     class INSTRUCTION_EXPORT Dereference : public Expression
67     {
68
69     public:
70       /// A %Dereference is constructed from a %Expression pointer (raw or shared) representing the address
71       /// to be dereferenced and a type
72       /// indicating how the memory at the address in question is to be interpreted.
73       Dereference(Expression::Ptr addr, Result_Type result_type) : Expression(result_type), addressToDereference(addr)
74       {
75       }
76       virtual ~Dereference() 
77       {
78       }
79       /// A %Dereference has one child, which represents the address being dereferenced.
80       /// \param children Appends the child of this %Dereference to \c children.
81       virtual void getChildren(vector<InstructionAST::Ptr>& children) const
82       {
83         children.push_back(addressToDereference);
84         return;
85       }
86       /// The use set of a %Dereference is the same as the use set of its children.
87       /// \param uses The use set of this %Dereference is inserted into \c uses.
88       virtual void getUses(set<InstructionAST::Ptr>& uses)
89       {
90         addressToDereference->getUses(uses);
91         return;
92       }
93       /// An %InstructionAST is used by a %Dereference if it is equivalent to the 
94       /// %Dereference or it is used by the lone child of the %Dereference
95       virtual bool isUsed(InstructionAST::Ptr findMe) const
96       {
97         return addressToDereference->isUsed(findMe) || *findMe == *this;
98       }
99       virtual std::string format() const
100       {
101         std::stringstream retVal;
102         retVal << "[" << addressToDereference->format() << "]";
103         return retVal.str();
104       }
105
106       virtual bool bind(Expression* expr, const Result& value)
107       {
108           if(Expression::bind(expr, value))
109           {
110               return true;
111           }
112           return addressToDereference->bind(expr, value);
113       }
114       virtual void apply(Visitor* v)
115       {
116           addressToDereference->apply(v);
117           v->visit(this);
118       }
119     
120
121     protected:
122       virtual bool isSameType(const InstructionAST& rhs) const
123       {
124         return dynamic_cast<const Dereference*>(&rhs) != NULL;
125       }
126       virtual bool isStrictEqual(const InstructionAST& rhs) const
127       {
128         const Dereference& other(dynamic_cast<const Dereference&>(rhs));
129         return *(other.addressToDereference) == *addressToDereference;
130       }
131   
132   
133     private:
134       Expression::Ptr addressToDereference;
135   
136     };
137   };
138 };
139
140
141
142 #endif // !defined(DEREFERENCE_H)