SourceAstSemantics.h

// Turn instruction semantics into a C source AST
#ifndef ROSE_BinaryAnalysis_InstructionSemantics_SourceAstSemantics_H
#define ROSE_BinaryAnalysis_InstructionSemantics_SourceAstSemantics_H
#include <featureTests.h>
#ifdef ROSE_ENABLE_BINARY_ANALYSIS
#include <Rose/BinaryAnalysis/BasicTypes.h>
 
#include <Rose/BinaryAnalysis/InstructionSemantics/BaseSemantics/SValue.h>
#include <Rose/BinaryAnalysis/InstructionSemantics/NullSemantics.h>
 
namespace Rose {
namespace BinaryAnalysis {
namespace InstructionSemantics {
 
namespace SourceAstSemantics {
 
//                                      Value type
 
typedef Sawyer::SharedPointer<class SValue> SValuePtr;
 
class SValue: public BaseSemantics::SValue {
public:
    using Super = BaseSemantics::SValue;
 
    using Ptr = SValuePtr;
 
protected:
    static size_t nVariables_;
    std::string ctext_;
 
protected:
    // An undefined or unspecified value is a C variable that's not initialized.
    explicit SValue(size_t nbits);
 
    // An integer value, various types depending on width
    SValue(size_t nbits, uint64_t number);
 
    // Copy constructor deep-copies the AST.
    SValue(const SValue &other);
    
public:
    static SValuePtr instance();
 
    static SValuePtr instance_undefined(size_t nbits);
 
    static SValuePtr instance_integer(size_t nbits, uint64_t value);
 
public:
    virtual BaseSemantics::SValuePtr bottom_(size_t nbits) const override;
    virtual BaseSemantics::SValuePtr undefined_(size_t nbits) const override;
    virtual BaseSemantics::SValuePtr unspecified_(size_t nbits) const override;
    virtual BaseSemantics::SValuePtr number_(size_t nbits, uint64_t value) const override;
    virtual BaseSemantics::SValuePtr boolean_(bool value) const override;
    virtual BaseSemantics::SValuePtr copy(size_t new_width=0) const override;
 
    virtual Sawyer::Optional<BaseSemantics::SValuePtr>
    createOptionalMerge(const BaseSemantics::SValuePtr&, const BaseSemantics::MergerPtr&, const SmtSolverPtr&) const override;
 
public:
    static SValuePtr promote(const BaseSemantics::SValuePtr&);
 
public:
    virtual bool isBottom() const override;
    virtual void hash(Combinatorics::Hasher&) const override;
    virtual void print(std::ostream&, BaseSemantics::Formatter&) const override;
 
public:
    // These are not needed since this domain never tries to compare semantic values.
    virtual bool may_equal(const BaseSemantics::SValuePtr &/*other*/,
                           const SmtSolverPtr& = SmtSolverPtr()) const override;
 
    virtual bool must_equal(const BaseSemantics::SValuePtr &/*other*/,
                            const SmtSolverPtr& = SmtSolverPtr()) const override;
 
    virtual void set_width(size_t /*nbits*/) override;
    virtual bool is_number() const override;
    virtual uint64_t get_number() const override;
 
public:
    static std::string unsignedTypeNameForSize(size_t nbits);
    static std::string signedTypeNameForSize(size_t nbits);
public:
    virtual const std::string& ctext() const;
    virtual void ctext(const std::string&);
};
 
//                                      State
 
// No state is necessary for this domain because all instruction side effects are immediately attached to the AST that's
//  being generated rather than being stored in some state.
 
typedef BaseSemantics::RegisterStateGeneric RegisterState;      
typedef BaseSemantics::RegisterStateGenericPtr RegisterStatePtr; 
typedef NullSemantics::MemoryState MemoryState;         
typedef NullSemantics::MemoryStatePtr MemoryStatePtr;   
typedef BaseSemantics::State State;                     
typedef BaseSemantics::StatePtr StatePtr;               
//                                      RiscOperators
 
typedef boost::shared_ptr<class RiscOperators> RiscOperatorsPtr;
 
class RiscOperators: public BaseSemantics::RiscOperators {
public:
    using Super = BaseSemantics::RiscOperators;
 
    using Ptr = RiscOperatorsPtr;
 
public:
    struct SideEffect {
        BaseSemantics::SValuePtr location;              
        BaseSemantics::SValuePtr temporary;             
        BaseSemantics::SValuePtr expression;            
        ~SideEffect();
 
        // Default constructor. Not normally used, but needed by <code>std::vector</code>. (DON'T DOCUMENT)
        SideEffect();
 
        // Used internally, not neede by users since data members are public.
        SideEffect(const BaseSemantics::SValuePtr &location, const BaseSemantics::SValuePtr &temporary,
                   const BaseSemantics::SValuePtr &expression);
 
        bool isValid() const;
 
        bool isSubstitution() const;
    };
 
    typedef std::vector<SideEffect> SideEffects;
 
private:
    SideEffects sideEffects_;                           // Side effects, including substitutions
    bool executionHalted_;                              // Stop adding inputs and outputs?
 
protected:
    RiscOperators(const BaseSemantics::SValuePtr &protoval, const SmtSolverPtr&);
 
    RiscOperators(const BaseSemantics::StatePtr&, const SmtSolverPtr&);
 
public:
    static RiscOperatorsPtr instanceFromRegisters(const RegisterDictionaryPtr&, const SmtSolverPtr &solver = SmtSolverPtr());
 
    static RiscOperatorsPtr instanceFromProtoval(const BaseSemantics::SValuePtr &protoval,
                                                 const SmtSolverPtr &solver = SmtSolverPtr());
 
    static RiscOperatorsPtr instanceFromState(const BaseSemantics::StatePtr&, const SmtSolverPtr&);
 
    // Virtual constructors
public:
    virtual BaseSemantics::RiscOperatorsPtr create(const BaseSemantics::SValuePtr &protoval,
                                                   const SmtSolverPtr &solver = SmtSolverPtr()) const override;
 
    virtual BaseSemantics::RiscOperatorsPtr create(const BaseSemantics::StatePtr&,
                                                   const SmtSolverPtr &solver = SmtSolverPtr()) const override;
 
    // Dynamic pointer casts
public:
    static RiscOperatorsPtr promote(const BaseSemantics::RiscOperatorsPtr&);
 
    // Supporting functions
public:
    BaseSemantics::SValuePtr makeSValue(size_t nbits, SgNode*, const std::string &ctext = "");
 
    BaseSemantics::SValuePtr saveSideEffect(const BaseSemantics::SValuePtr &expression,
                                            const BaseSemantics::SValuePtr &location = BaseSemantics::SValuePtr());
 
    BaseSemantics::SValuePtr substitute(const BaseSemantics::SValuePtr &expression);
 
    const SideEffects& sideEffects() const;
 
    void resetState();
 
    std::string registerVariableName(RegisterDescriptor);
 
    void reset();
 
    void haltExecution() { executionHalted_ = true; }
 
    BaseSemantics::SValuePtr makeMask(size_t nBits, size_t nSet, size_t sa=0);
 
    // Override all operator methods from base class.  These are the RISC operators that are invoked by a Dispatcher.
public:
    virtual BaseSemantics::SValuePtr unspecified_(size_t nbits) override;
    virtual void hlt() override;
    virtual void cpuid() override;
    virtual BaseSemantics::SValuePtr rdtsc() override;
    virtual BaseSemantics::SValuePtr and_(const BaseSemantics::SValuePtr &a_,
                                          const BaseSemantics::SValuePtr &b_) override;
    virtual BaseSemantics::SValuePtr or_(const BaseSemantics::SValuePtr &a_,
                                         const BaseSemantics::SValuePtr &b_) override;
    virtual BaseSemantics::SValuePtr xor_(const BaseSemantics::SValuePtr &a_,
                                          const BaseSemantics::SValuePtr &b_) override;
    virtual BaseSemantics::SValuePtr invert(const BaseSemantics::SValuePtr &a_) override;
    virtual BaseSemantics::SValuePtr extract(const BaseSemantics::SValuePtr &a_,
                                             size_t begin_bit, size_t end_bit) override;
    virtual BaseSemantics::SValuePtr concat(const BaseSemantics::SValuePtr &a_,
                                            const BaseSemantics::SValuePtr &b_) override;
    virtual BaseSemantics::SValuePtr leastSignificantSetBit(const BaseSemantics::SValuePtr &a_) override;
    virtual BaseSemantics::SValuePtr mostSignificantSetBit(const BaseSemantics::SValuePtr &a_) override;
    virtual BaseSemantics::SValuePtr rotateLeft(const BaseSemantics::SValuePtr &a_,
                                                const BaseSemantics::SValuePtr &sa_) override;
    virtual BaseSemantics::SValuePtr rotateRight(const BaseSemantics::SValuePtr &a_,
                                                 const BaseSemantics::SValuePtr &sa_) override;
    virtual BaseSemantics::SValuePtr shiftLeft(const BaseSemantics::SValuePtr &a_,
                                               const BaseSemantics::SValuePtr &sa_) override;
    virtual BaseSemantics::SValuePtr shiftRight(const BaseSemantics::SValuePtr &a_,
                                                const BaseSemantics::SValuePtr &sa_) override;
    virtual BaseSemantics::SValuePtr shiftRightArithmetic(const BaseSemantics::SValuePtr &a_,
                                                          const BaseSemantics::SValuePtr &sa_) override;
    virtual BaseSemantics::SValuePtr equalToZero(const BaseSemantics::SValuePtr &a_) override;
    virtual BaseSemantics::SValuePtr iteWithStatus(const BaseSemantics::SValuePtr &sel_,
                                                   const BaseSemantics::SValuePtr &a_,
                                                   const BaseSemantics::SValuePtr &b_,
                                                   IteStatus&) override;
    virtual BaseSemantics::SValuePtr unsignedExtend(const BaseSemantics::SValuePtr &a_, size_t new_width) override;
    virtual BaseSemantics::SValuePtr signExtend(const BaseSemantics::SValuePtr &a_, size_t new_width) override;
    virtual BaseSemantics::SValuePtr add(const BaseSemantics::SValuePtr &a_,
                                         const BaseSemantics::SValuePtr &b_) override;
    virtual BaseSemantics::SValuePtr addWithCarries(const BaseSemantics::SValuePtr &a_,
                                                    const BaseSemantics::SValuePtr &b_,
                                                    const BaseSemantics::SValuePtr &c_,
                                                    BaseSemantics::SValuePtr &carry_out/*out*/) override;
    virtual BaseSemantics::SValuePtr negate(const BaseSemantics::SValuePtr &a_) override;
    virtual BaseSemantics::SValuePtr signedDivide(const BaseSemantics::SValuePtr &a_,
                                                  const BaseSemantics::SValuePtr &b_) override;
    virtual BaseSemantics::SValuePtr signedModulo(const BaseSemantics::SValuePtr &a_,
                                                  const BaseSemantics::SValuePtr &b_) override;
    virtual BaseSemantics::SValuePtr signedMultiply(const BaseSemantics::SValuePtr &a_,
                                                    const BaseSemantics::SValuePtr &b_) override;
    virtual BaseSemantics::SValuePtr unsignedDivide(const BaseSemantics::SValuePtr &a_,
                                                    const BaseSemantics::SValuePtr &b_) override;
    virtual BaseSemantics::SValuePtr unsignedModulo(const BaseSemantics::SValuePtr &a_,
                                                    const BaseSemantics::SValuePtr &b_) override;
    virtual BaseSemantics::SValuePtr unsignedMultiply(const BaseSemantics::SValuePtr &a_,
                                                      const BaseSemantics::SValuePtr &b_) override;
    virtual void interrupt(int majr, int minr) override;
    virtual BaseSemantics::SValuePtr readRegister(RegisterDescriptor reg,
                                                  const BaseSemantics::SValuePtr &dflt) override;
    virtual BaseSemantics::SValuePtr peekRegister(RegisterDescriptor reg,
                                                  const BaseSemantics::SValuePtr &dflt) override;
    virtual void writeRegister(RegisterDescriptor reg, const BaseSemantics::SValuePtr &a) override;
    virtual BaseSemantics::SValuePtr readMemory(RegisterDescriptor segreg,
                                                const BaseSemantics::SValuePtr &addr,
                                                const BaseSemantics::SValuePtr &dflt,
                                                const BaseSemantics::SValuePtr &cond) override;
    virtual BaseSemantics::SValuePtr peekMemory(RegisterDescriptor segreg,
                                                const BaseSemantics::SValuePtr &addr,
                                                const BaseSemantics::SValuePtr &dflt) override;
    virtual void writeMemory(RegisterDescriptor segreg,
                             const BaseSemantics::SValuePtr &addr,
                             const BaseSemantics::SValuePtr &data,
                             const BaseSemantics::SValuePtr &cond) override;
};
 
    
} // namespace
} // namespace
} // namespace
} // namespace
 
#endif
#endif