NullSemantics.h

#ifndef ROSE_BinaryAnalysis_InstructionSemantics_NullSemantics_H
#define ROSE_BinaryAnalysis_InstructionSemantics_NullSemantics_H
#include <featureTests.h>
#ifdef ROSE_ENABLE_BINARY_ANALYSIS
 
#include <Rose/BinaryAnalysis/BasicTypes.h>
#include <Rose/BinaryAnalysis/InstructionSemantics/BaseSemantics.h>
 
namespace Rose {
namespace BinaryAnalysis {                              // documented elsewhere
namespace InstructionSemantics {                        // documented elsewhere
        
 
namespace NullSemantics {
 
//                                      Semantic values
 
using SValuePtr = Sawyer::SharedPointer<class SValue>;
 
class SValue: public BaseSemantics::SValue {
public:
    using Super = BaseSemantics::SValue;
 
    using Ptr = SValuePtr;
 
    // Real constructors.
public:
    ~SValue();
 
protected:
    explicit SValue(size_t nbits);
 
    // Static allocating constructors
public:
    static SValuePtr instance();
 
    static SValuePtr instance(size_t nbits);
 
    static SValuePtr instance(size_t nbits, uint64_t /*number*/);
 
    static SValuePtr instance(const SValuePtr &other);
 
    // Virtual constructors
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 number) 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;
 
    // Dynamic pointer casting
public:
    static SValuePtr promote(const BaseSemantics::SValuePtr&);
 
    // Implementations of functions inherited
public:
    virtual bool isBottom() const override;
    virtual void print(std::ostream&, BaseSemantics::Formatter&) const override;
    virtual void hash(Combinatorics::Hasher&) const override;
 
    // Override legacy members. These now are called by the camelCase names in the base class. Eventually we'll switch the
    // camelCase names to be the virtual functions and get rid of the snake_case names, so be sure to specify "override" in
    // your own code so you know when we make the switch.
public:
    // See isConcrete
    virtual bool is_number() const override;
 
    // See toUnsigned and toSigned
    virtual uint64_t get_number() const override;
 
    // See mayEqual
    virtual bool may_equal(const BaseSemantics::SValuePtr&, const SmtSolverPtr& = SmtSolverPtr()) const override;
 
    // See mustEqual
    virtual bool must_equal(const BaseSemantics::SValuePtr &other, const SmtSolverPtr& = SmtSolverPtr()) const override;
};
 
 
//                                      Register state
 
using RegisterStatePtr = boost::shared_ptr<class RegisterState>;
 
class RegisterState: public BaseSemantics::RegisterState {
public:
    using Super = BaseSemantics::RegisterState;
 
    using Ptr = RegisterStatePtr;
 
public:
    ~RegisterState();
 
protected:
    RegisterState(const RegisterState &other);
    RegisterState(const BaseSemantics::SValuePtr &protoval, const RegisterDictionaryPtr&);
 
public:
    static RegisterStatePtr instance(const BaseSemantics::SValuePtr &protoval, const RegisterDictionaryPtr&);
    virtual BaseSemantics::RegisterStatePtr create(const BaseSemantics::SValuePtr &protoval,
                                                   const RegisterDictionaryPtr &regdict) const override;
    virtual BaseSemantics::AddressSpacePtr clone() const override;
    static RegisterStatePtr promote(const BaseSemantics::AddressSpacePtr &from);
 
    virtual bool merge(const BaseSemantics::AddressSpacePtr&, BaseSemantics::RiscOperators *addrOps,
                       BaseSemantics::RiscOperators *valOps) override;
    virtual void clear() override;
    virtual void zero() override;
    virtual BaseSemantics::SValuePtr readRegister(RegisterDescriptor, const BaseSemantics::SValuePtr &/*dflt*/,
                                                  BaseSemantics::RiscOperators*) override;
    virtual BaseSemantics::SValuePtr peekRegister(RegisterDescriptor, const BaseSemantics::SValuePtr &/*dflt*/,
                                                  BaseSemantics::RiscOperators*) override;
    virtual void writeRegister(RegisterDescriptor, const BaseSemantics::SValuePtr&, BaseSemantics::RiscOperators*) override;
    virtual void updateReadProperties(RegisterDescriptor) override;
    virtual void updateWriteProperties(RegisterDescriptor, BaseSemantics::InputOutputProperty) override;
    virtual void hash(Combinatorics::Hasher&, BaseSemantics::RiscOperators*, BaseSemantics::RiscOperators*) const override;
    virtual void print(std::ostream&, BaseSemantics::Formatter&) const override;
};
 
 
//                                      Memory state
 
using MemoryStatePtr = boost::shared_ptr<class MemoryState>;
 
class MemoryState: public BaseSemantics::MemoryState {
public:
    using Super = BaseSemantics::MemoryState;
 
    using Ptr = MemoryStatePtr;
 
public:
    ~MemoryState();
 
protected:
    MemoryState(const BaseSemantics::SValuePtr &addrProtoval, const BaseSemantics::SValuePtr &valProtoval);
    MemoryState(const MemoryStatePtr &other);
 
public:
    static MemoryStatePtr instance(const BaseSemantics::SValuePtr &addrProtoval, const BaseSemantics::SValuePtr &valProtoval);
 
public:
    virtual BaseSemantics::MemoryStatePtr create(const BaseSemantics::SValuePtr &addrProtoval,
                                                 const BaseSemantics::SValuePtr &valProtoval) const override;
    virtual BaseSemantics::AddressSpacePtr clone() const override;
 
public:
    static MemoryStatePtr promote(const BaseSemantics::AddressSpacePtr&);
 
public:
    virtual void clear() override {}
 
    virtual BaseSemantics::SValuePtr readMemory(const BaseSemantics::SValuePtr &/*address*/,
                                                const BaseSemantics::SValuePtr &dflt,
                                                BaseSemantics::RiscOperators */*addrOps*/,
                                                BaseSemantics::RiscOperators */*valOps*/) override;
 
    virtual void writeMemory(const BaseSemantics::SValuePtr &/*addr*/, const BaseSemantics::SValuePtr &/*value*/,
                             BaseSemantics::RiscOperators */*addrOps*/, BaseSemantics::RiscOperators */*valOps*/) override;
 
    virtual BaseSemantics::SValuePtr peekMemory(const BaseSemantics::SValuePtr &/*address*/, const BaseSemantics::SValuePtr &dflt,
                                                BaseSemantics::RiscOperators */*addrOps*/,
                                                BaseSemantics::RiscOperators */*valOps*/) override;
 
    virtual void hash(Combinatorics::Hasher&, BaseSemantics::RiscOperators */*addrOps*/,
                      BaseSemantics::RiscOperators */*valOps*/) const override;
 
    virtual void print(std::ostream&, BaseSemantics::Formatter&) const override;
 
    virtual bool merge(const BaseSemantics::AddressSpacePtr &other, BaseSemantics::RiscOperators *addrOps,
                       BaseSemantics::RiscOperators *valOps) override;
};
 
 
//                                      Complete state
 
using State = BaseSemantics::State;
using StatePtr = BaseSemantics::StatePtr;
 
 
//                                      RISC operators
 
using RiscOperatorsPtr = boost::shared_ptr<class RiscOperators>;
 
class RiscOperators: public BaseSemantics::RiscOperators {
public:
    using Super = BaseSemantics::RiscOperators;
 
    using Ptr = RiscOperatorsPtr;
 
    // Real constructors
protected:
    explicit RiscOperators(const BaseSemantics::SValuePtr &protoval, const SmtSolverPtr&);
 
    explicit RiscOperators(const BaseSemantics::StatePtr&, const SmtSolverPtr&);
 
    // Static allocating constructors
public:
    ~RiscOperators();
 
    static RiscOperatorsPtr instanceFromRegisters(const RegisterDictionaryPtr &regdict);
 
    static RiscOperatorsPtr instanceFromProtoval(const BaseSemantics::SValuePtr &protoval,
                                                 const SmtSolverPtr &solver = SmtSolverPtr());
 
    static RiscOperatorsPtr instanceFromState(const BaseSemantics::StatePtr&, const SmtSolverPtr &solver = 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;
 
    // Risc operators inherited
public:
    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 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 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