Initial InstructionAPI checkin
[dyninst.git] / instructionAPI / h / Operand.h
1
2 #if !defined(OPERAND_H)
3 #define OPERAND_H
4
5 #include "Expression.h"
6 #include "Register.h"
7 #include <set>
8 #include <string>
9
10 namespace Dyninst
11 {
12   namespace Instruction
13   {
14
15     /// An %Operand object contains an AST built from %RegisterAST and %Immediate leaves,
16     /// and information about whether the %Operand
17     /// is read, written, or both. This allows us to determine which of the registers
18     /// that appear in the %Operand are read and which are written, as well as whether
19     /// any memory accesses are reads, writes, or both.
20     /// An %Operand, given full knowledge of the values of the leaves of the AST, and knowledge of
21     /// the logic associated with the tree's internal nodes, can determine the
22     /// result of any computations that are encoded in it.  It will rarely be the case
23     /// that an %Instruction is built with its %Operands' state fully specified.  This mechanism is
24     /// instead intended to allow a user to fill in knowledge about the state of the processor
25     /// at the time the %Instruction is executed.
26     
27     class Operand
28     {
29     public:
30       /// \brief Create an operand from a %Expression and flags describing whether the %ValueComputation
31       /// is read, written or both.
32       /// \param val Reference-counted pointer to the %Expression that will be contained in the %Operand being constructed
33       /// \param read True if this operand is read
34       /// \param written True if this operand is written
35       Operand(Expression::Ptr val, bool read, bool written) : op_value(val), m_isRead(read), m_isWritten(written) 
36       {
37       }
38
39       /// \brief Get the registers read by this operand
40       /// \param[out] regsRead Has the registers read inserted into it
41       void getReadSet(std::set<RegisterAST::Ptr>& regsRead) const;
42       /// \brief Get the registers written by this operand
43       /// \param[out] regsRead Has the registers written  inserted into it
44       void getWriteSet(std::set<RegisterAST::Ptr>& regsWritten) const;
45
46       bool isRead(Expression::Ptr candidate) const;
47       bool isWritten(Expression::Ptr candidate) const;
48       
49       /// Returns true if this operand reads memory
50       bool readsMemory() const;
51       /// Returns true if this operand writes memory
52       bool writesMemory() const;
53       /// \brief Inserts the effective addresses read by this operand into memAccessors
54       /// \param[out] memAccessors If this is a memory read operand, insert the \c %Expression::Ptr representing
55       /// the address being read into \c memAccessors.
56       void addEffectiveReadAddresses(std::set<Expression::Ptr>& memAccessors) const;
57       /// \brief Inserts the effective addresses written by this operand into memAccessors
58       /// \param[out] memAccessors If this is a memory write operand, insert the \c %Expression::Ptr representing
59       /// the address being written into \c memAccessors.
60       void addEffectiveWriteAddresses(std::set<Expression::Ptr>& memAccessors) const;
61       /// \brief Return a printable string representation of the operand
62       /// \return The operand in a disassembly format
63       std::string format() const;
64
65       Expression::Ptr getValue() const;
66       
67     private:
68       Expression::Ptr op_value;
69       bool m_isRead;
70       bool m_isWritten;
71     };
72   };
73 };
74
75
76
77
78 #endif //!defined(OPERAND_H)