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