ConcreteSemantics.h

#ifndef ROSE_BinaryAnalysis_InstructionSemantics_ConcreteSemantics_H
#define ROSE_BinaryAnalysis_InstructionSemantics_ConcreteSemantics_H
#include <featureTests.h>
#ifdef ROSE_ENABLE_BINARY_ANALYSIS
#include <Rose/BinaryAnalysis/BasicTypes.h>
 
#include <Rose/BinaryAnalysis/InstructionSemantics/BaseSemantics.h>
#include <Rose/BinaryAnalysis/MemoryMap.h>
 
#include <Sawyer/BitVector.h>
 
namespace Rose {
namespace BinaryAnalysis {
namespace InstructionSemantics {
 
namespace ConcreteSemantics {
 
//                                      Value type
 
typedef Sawyer::SharedPointer<class SValue> SValuePtr;
 
typedef BaseSemantics::Formatter Formatter;             // we might extend this in the future
 
class SValue: public BaseSemantics::SValue {
public:
    using Super = BaseSemantics::SValue;
 
    using Ptr = SValuePtr;
 
protected:
    Sawyer::Container::BitVector bits_;
 
    // Real constructors
protected:
    explicit SValue(size_t nbits);
    SValue(size_t nbits, uint64_t number);
 
    // Static allocating constructors
public:
    static SValuePtr instance();
 
    static SValuePtr instance(size_t nbits);
 
    static SValuePtr instance(size_t nbits, uint64_t value);
 
    // Virtual allocating constructors
public:
    BaseSemantics::SValuePtr undefined_(size_t nbits) const override;
    BaseSemantics::SValuePtr unspecified_(size_t nbits) const override;
    BaseSemantics::SValuePtr bottom_(size_t nbits) const override;
    BaseSemantics::SValuePtr number_(size_t nbits, uint64_t value) const override;
    BaseSemantics::SValuePtr boolean_(bool value) const override;
    BaseSemantics::SValuePtr copy(size_t new_width=0) const override;
 
    Sawyer::Optional<BaseSemantics::SValuePtr>
    createOptionalMerge(const BaseSemantics::SValuePtr &other, const BaseSemantics::MergerPtr&,
                        const SmtSolverPtr&) const override;
 
    // Dynamic pointer casts
public:
    static SValuePtr promote(const BaseSemantics::SValuePtr&);
 
    // Override virtual methods...
public:
    void hash(Combinatorics::Hasher&) const override;
    bool isBottom() const override;
    void print(std::ostream&, BaseSemantics::Formatter&) const override;
 
    // Override legacy virtual methods. These snake_case names may eventually go away, but for now they're the ones you should
    // override. Be sure to use "override" in your own code in order to be notified when we finally remove these.
public:
    // See mayEqual
    bool may_equal(const BaseSemantics::SValuePtr &other,
                   const SmtSolverPtr &solver = SmtSolverPtr()) const override;
 
    // See mustEqual
    bool must_equal(const BaseSemantics::SValuePtr &other,
                    const SmtSolverPtr &solver = SmtSolverPtr()) const override;
 
    // See nBits
    void set_width(size_t nbits) override;
 
    // See isConcrete
    bool is_number() const override {
        return true;
    }
 
    // See toUnsigned and toSigned
    uint64_t get_number() const override;
 
    // Additional methods first declared in this class...
public:
    virtual const Sawyer::Container::BitVector& bits() const { return bits_; }
    virtual void bits(const Sawyer::Container::BitVector&);
};
 
 
//                                      Register State
 
typedef BaseSemantics::RegisterStateGeneric RegisterState;
typedef BaseSemantics::RegisterStateGenericPtr RegisterStatePtr;
 
 
//                                      Memory State
 
typedef boost::shared_ptr<class MemoryState> MemoryStatePtr;
 
class MemoryState: public BaseSemantics::MemoryState {
public:
    using Super = BaseSemantics::MemoryState;
 
    using Ptr = MemoryStatePtr;
 
private:
    MemoryMap::Ptr map_;
    Address pageSize_;
 
    // Real constructors
protected:
    explicit MemoryState(const BaseSemantics::SValuePtr &addrProtoval, const BaseSemantics::SValuePtr &valProtoval);
    MemoryState(const MemoryState &other);
 
    // Static allocating constructors
public:
    static  MemoryStatePtr instance(const BaseSemantics::SValuePtr &addrProtoval, const BaseSemantics::SValuePtr &valProtoval);
 
    static MemoryStatePtr instance(const MemoryStatePtr &other);
 
    // Virtual constructors
public:
    BaseSemantics::MemoryStatePtr create(const BaseSemantics::SValuePtr &addrProtoval,
                                         const BaseSemantics::SValuePtr &valProtoval) const override;
 
    BaseSemantics::AddressSpacePtr clone() const override;
 
    // Dynamic pointer casts
public:
    static MemoryStatePtr promote(const BaseSemantics::AddressSpacePtr&);
 
    // Methods we inherited
public:
    void clear() override;
 
    void hash(Combinatorics::Hasher&, BaseSemantics::RiscOperators *addrOps,
              BaseSemantics::RiscOperators *valOps) const override;
 
    void print(std::ostream&, Formatter&) const override;
 
    BaseSemantics::SValuePtr readMemory(const BaseSemantics::SValuePtr &addr, const BaseSemantics::SValuePtr &dflt,
                                        BaseSemantics::RiscOperators *addrOps,
                                        BaseSemantics::RiscOperators *valOps) override;
 
    BaseSemantics::SValuePtr peekMemory(const BaseSemantics::SValuePtr &addr, const BaseSemantics::SValuePtr &dflt,
                                        BaseSemantics::RiscOperators *addrOps,
                                        BaseSemantics::RiscOperators *valOps) override;
 
    void writeMemory(const BaseSemantics::SValuePtr &addr, const BaseSemantics::SValuePtr &value,
                     BaseSemantics::RiscOperators *addrOps, BaseSemantics::RiscOperators *valOps) override;
 
    bool merge(const BaseSemantics::AddressSpacePtr &other, BaseSemantics::RiscOperators *addrOps,
               BaseSemantics::RiscOperators *valOps) override;
 
protected:
    BaseSemantics::SValuePtr readOrPeekMemory(const BaseSemantics::SValuePtr &addr,
                                              const BaseSemantics::SValuePtr &dflt,
                                              BaseSemantics::RiscOperators *addrOps,
                                              BaseSemantics::RiscOperators *valOps,
                                              bool allowSideEffects);
 
    // Methods first declared in this class
public:
    const MemoryMap::Ptr memoryMap() const { return map_; }
 
    void memoryMap(const MemoryMap::Ptr&, Sawyer::Optional<unsigned> padAccess = Sawyer::Nothing());
 
    Address pageSize() const { return pageSize_; }
    void pageSize(Address nBytes);
    void allocatePage(Address va);
 
};
 
 
//                                      Complete semantic state
 
typedef BaseSemantics::State State;
typedef BaseSemantics::StatePtr StatePtr;
 
 
//                                      RISC operators
 
typedef boost::shared_ptr<class RiscOperators> RiscOperatorsPtr;
 
class RiscOperators: public BaseSemantics::RiscOperators {
public:
    using Super = BaseSemantics::RiscOperators;
 
    using Ptr = RiscOperatorsPtr;
 
    // Real constructors
protected:
    RiscOperators(const BaseSemantics::SValuePtr &protoval, const SmtSolverPtr&);
 
    RiscOperators(const BaseSemantics::StatePtr&, const SmtSolverPtr&);
 
    // Static allocating constructors
public:
    ~RiscOperators();
 
    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 &solver = SmtSolverPtr());
 
    // Virtual constructors
public:
    BaseSemantics::RiscOperatorsPtr create(const BaseSemantics::SValuePtr &protoval,
                                           const SmtSolverPtr &solver = SmtSolverPtr()) const override;
 
    BaseSemantics::RiscOperatorsPtr create(const BaseSemantics::StatePtr&,
                                           const SmtSolverPtr &solver = SmtSolverPtr()) const override;
 
    // Dynamic pointer casts
public:
    static RiscOperatorsPtr promote(const BaseSemantics::RiscOperatorsPtr&);
 
    // New methods for constructing values, so we don't have to write so many SValue::promote calls in the RiscOperators
    // implementations.
protected:
    SValuePtr svalueNumber(size_t nbits, uint64_t value);
    SValuePtr svalueNumber(const Sawyer::Container::BitVector&);
    SValuePtr svalueBoolean(bool b);
    SValuePtr svalueZero(size_t nbits);
 
    // Override methods from base class.  These are the RISC operators that are invoked by a Dispatcher.
public:
    void interrupt(int majr, int minr) override;
    BaseSemantics::SValuePtr and_(const BaseSemantics::SValuePtr &a_,
                                  const BaseSemantics::SValuePtr &b_) override;
    BaseSemantics::SValuePtr or_(const BaseSemantics::SValuePtr &a_,
                                 const BaseSemantics::SValuePtr &b_) override;
    BaseSemantics::SValuePtr xor_(const BaseSemantics::SValuePtr &a_,
                                  const BaseSemantics::SValuePtr &b_) override;
    BaseSemantics::SValuePtr invert(const BaseSemantics::SValuePtr &a_) override;
    BaseSemantics::SValuePtr extract(const BaseSemantics::SValuePtr &a_,
                                     size_t begin_bit, size_t end_bit) override;
    BaseSemantics::SValuePtr concat(const BaseSemantics::SValuePtr &a_,
                                    const BaseSemantics::SValuePtr &b_) override;
    BaseSemantics::SValuePtr leastSignificantSetBit(const BaseSemantics::SValuePtr &a_) override;
    BaseSemantics::SValuePtr mostSignificantSetBit(const BaseSemantics::SValuePtr &a_) override;
    BaseSemantics::SValuePtr rotateLeft(const BaseSemantics::SValuePtr &a_,
                                        const BaseSemantics::SValuePtr &sa_) override;
    BaseSemantics::SValuePtr rotateRight(const BaseSemantics::SValuePtr &a_,
                                         const BaseSemantics::SValuePtr &sa_) override;
    BaseSemantics::SValuePtr shiftLeft(const BaseSemantics::SValuePtr &a_,
                                       const BaseSemantics::SValuePtr &sa_) override;
    BaseSemantics::SValuePtr shiftRight(const BaseSemantics::SValuePtr &a_,
                                        const BaseSemantics::SValuePtr &sa_) override;
    BaseSemantics::SValuePtr shiftRightArithmetic(const BaseSemantics::SValuePtr &a_,
                                                  const BaseSemantics::SValuePtr &sa_) override;
    BaseSemantics::SValuePtr equalToZero(const BaseSemantics::SValuePtr &a_) override;
    BaseSemantics::SValuePtr iteWithStatus(const BaseSemantics::SValuePtr &sel_,
                                           const BaseSemantics::SValuePtr &a_,
                                           const BaseSemantics::SValuePtr &b_,
                                           IteStatus&) override;
    BaseSemantics::SValuePtr unsignedExtend(const BaseSemantics::SValuePtr &a_, size_t new_width) override;
    BaseSemantics::SValuePtr signExtend(const BaseSemantics::SValuePtr &a_, size_t new_width) override;
    BaseSemantics::SValuePtr add(const BaseSemantics::SValuePtr &a_,
                                 const BaseSemantics::SValuePtr &b_) override;
    BaseSemantics::SValuePtr addWithCarries(const BaseSemantics::SValuePtr &a_,
                                            const BaseSemantics::SValuePtr &b_,
                                            const BaseSemantics::SValuePtr &c_,
                                            BaseSemantics::SValuePtr &carry_out/*out*/) override;
    BaseSemantics::SValuePtr negate(const BaseSemantics::SValuePtr &a_) override;
    BaseSemantics::SValuePtr signedDivide(const BaseSemantics::SValuePtr &a_,
                                          const BaseSemantics::SValuePtr &b_) override;
    BaseSemantics::SValuePtr signedModulo(const BaseSemantics::SValuePtr &a_,
                                          const BaseSemantics::SValuePtr &b_) override;
    BaseSemantics::SValuePtr signedMultiply(const BaseSemantics::SValuePtr &a_,
                                            const BaseSemantics::SValuePtr &b_) override;
    BaseSemantics::SValuePtr unsignedDivide(const BaseSemantics::SValuePtr &a_,
                                            const BaseSemantics::SValuePtr &b_) override;
    BaseSemantics::SValuePtr unsignedModulo(const BaseSemantics::SValuePtr &a_,
                                            const BaseSemantics::SValuePtr &b_) override;
    BaseSemantics::SValuePtr unsignedMultiply(const BaseSemantics::SValuePtr &a_,
                                              const BaseSemantics::SValuePtr &b_) override;
 
    BaseSemantics::SValuePtr fpToInteger(const BaseSemantics::SValuePtr &, BaseSemantics::ValueKind) override;
    BaseSemantics::SValuePtr fpFromInteger(const BaseSemantics::SValuePtr &, BaseSemantics::ValueKind) override;
    BaseSemantics::SValuePtr fpConvert(const BaseSemantics::SValuePtr &, BaseSemantics::ValueKind) override;
 
    BaseSemantics::SValuePtr fpToInteger(const BaseSemantics::SValue::Ptr &,
                                         SgAsmFloatType*, const BaseSemantics::SValue::Ptr &) override;
 
    template<class FloatOp>
    BaseSemantics::SValuePtr
    fpBinaryOp(const BaseSemantics::SValuePtr &a, const BaseSemantics::SValuePtr &b, FloatOp operation);
 
    BaseSemantics::SValuePtr fpAdd(const BaseSemantics::SValuePtr &, const BaseSemantics::SValuePtr &) override;
    BaseSemantics::SValuePtr fpSubtract(const BaseSemantics::SValuePtr &, const BaseSemantics::SValuePtr &) override;
    BaseSemantics::SValuePtr fpMultiply(const BaseSemantics::SValuePtr &, const BaseSemantics::SValuePtr &) override;
    BaseSemantics::SValuePtr fpDivide(const BaseSemantics::SValuePtr &, const BaseSemantics::SValuePtr &) override;
    BaseSemantics::SValuePtr fpModulo(const BaseSemantics::SValuePtr &, const BaseSemantics::SValuePtr &) override;
 
    BaseSemantics::SValuePtr fpRoundTowardZero(const BaseSemantics::SValuePtr &a, SgAsmFloatType*) override;
 
    BaseSemantics::SValuePtr readMemory(RegisterDescriptor segreg,
                                        const BaseSemantics::SValuePtr &addr,
                                        const BaseSemantics::SValuePtr &dflt,
                                        const BaseSemantics::SValuePtr &cond) override;
    BaseSemantics::SValuePtr peekMemory(RegisterDescriptor segreg,
                                        const BaseSemantics::SValuePtr &addr,
                                        const BaseSemantics::SValuePtr &dflt) override;
    void writeMemory(RegisterDescriptor segreg,
                     const BaseSemantics::SValuePtr &addr,
                     const BaseSemantics::SValuePtr &data,
                     const BaseSemantics::SValuePtr &cond) override;
 
protected:
    // handles readMemory and peekMemory
    BaseSemantics::SValuePtr readOrPeekMemory(RegisterDescriptor segreg, const BaseSemantics::SValuePtr &address,
                                              const BaseSemantics::SValuePtr &dflt, bool allowSideEffects);
 
    // Convert expression to double
    double exprToDouble(const BaseSemantics::SValuePtr &expr, SgAsmFloatType*);
 
    // Convert double to expression
    BaseSemantics::SValuePtr doubleToExpr(double d, SgAsmFloatType*);
};
 
} // namespace
} // namespace
} // namespace
} // namespace
 
#include <Rose/BinaryAnalysis/InstructionSemantics/ConcreteSemantics.tpp>
 
#endif
#endif