InstructionAPI migration and bugfixes - - - - - - - - - - - - - - - - -
[dyninst.git] / instructionAPI / h / Operand.h
1 /*
2  * Copyright (c) 2007-2008 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(OPERAND_H)
33 #define OPERAND_H
34
35 #include "Expression.h"
36 #include "Register.h"
37 #include <set>
38 #include <string>
39
40 namespace Dyninst
41 {
42   namespace InstructionAPI
43   {
44
45     /// An %Operand object contains an AST built from %RegisterAST and %Immediate leaves,
46     /// and information about whether the %Operand
47     /// is read, written, or both. This allows us to determine which of the registers
48     /// that appear in the %Operand are read and which are written, as well as whether
49     /// any memory accesses are reads, writes, or both.
50     /// An %Operand, given full knowledge of the values of the leaves of the AST, and knowledge of
51     /// the logic associated with the tree's internal nodes, can determine the
52     /// result of any computations that are encoded in it.  It will rarely be the case
53     /// that an %Instruction is built with its %Operands' state fully specified.  This mechanism is
54     /// instead intended to allow a user to fill in knowledge about the state of the processor
55     /// at the time the %Instruction is executed.
56     
57     class Operand
58     {
59     public:
60       /// \brief Create an operand from a %Expression and flags describing whether the %ValueComputation
61       /// is read, written or both.
62       /// \param val Reference-counted pointer to the %Expression that will be contained in the %Operand being constructed
63       /// \param read True if this operand is read
64       /// \param written True if this operand is written
65       Operand(Expression::Ptr val, bool read, bool written) : op_value(val), m_isRead(read), m_isWritten(written) 
66       {
67       }
68       virtual ~Operand()
69       {
70         op_value.reset();
71       }
72       Operand(const Operand& o) :
73       op_value(o.op_value), m_isRead(o.m_isRead), m_isWritten(o.m_isWritten)
74       {
75       }
76       const Operand& operator=(const Operand& rhs)
77       {
78         op_value = rhs.op_value;
79         m_isRead = rhs.m_isRead;
80         m_isWritten = rhs.m_isWritten;
81         return *this;
82       }
83       
84
85       /// \brief Get the registers read by this operand
86       /// \param regsRead Has the registers read inserted into it
87       void getReadSet(std::set<RegisterAST::Ptr>& regsRead) const;
88       /// \brief Get the registers written by this operand
89       /// \param regsWritten Has the registers written  inserted into it
90       void getWriteSet(std::set<RegisterAST::Ptr>& regsWritten) const;
91
92       /// Returns true if this operand is read
93       bool isRead(Expression::Ptr candidate) const;
94       /// Returns true if this operand is written
95       bool isWritten(Expression::Ptr candidate) const;
96       
97       /// Returns true if this operand reads memory
98       bool readsMemory() const;
99       /// Returns true if this operand writes memory
100       bool writesMemory() const;
101       /// \brief Inserts the effective addresses read by this operand into memAccessors
102       /// \param memAccessors If this is a memory read operand, insert the \c %Expression::Ptr representing
103       /// the address being read into \c memAccessors.
104       void addEffectiveReadAddresses(std::set<Expression::Ptr>& memAccessors) const;
105       /// \brief Inserts the effective addresses written by this operand into memAccessors
106       /// \param memAccessors If this is a memory write operand, insert the \c %Expression::Ptr representing
107       /// the address being written into \c memAccessors.
108       void addEffectiveWriteAddresses(std::set<Expression::Ptr>& memAccessors) const;
109       /// \brief Return a printable string representation of the operand
110       /// \return The operand in a disassembly format
111       std::string format() const;
112       /// The \c getValue method returns an %Expression::Ptr to the AST contained by the operand.
113       Expression::Ptr getValue() const;
114       
115     private:
116       Expression::Ptr op_value;
117       bool m_isRead;
118       bool m_isWritten;
119     };
120   };
121 };
122
123
124
125
126 #endif //!defined(OPERAND_H)