StaticSemantics.h

// Turn instruction semantics into part of the AST
#ifndef ROSE_BinaryAnalysis_InstructionSemantics2_StaticSemantics_H
#define ROSE_BinaryAnalysis_InstructionSemantics2_StaticSemantics_H
#include <featureTests.h>
#ifdef ROSE_ENABLE_BINARY_ANALYSIS

#include <Rose/BinaryAnalysis/Disassembler.h>
#include <Rose/BinaryAnalysis/InstructionSemantics2/NullSemantics.h>
#include "SageBuilderAsm.h"

namespace Rose {
namespace BinaryAnalysis {              // documented elsewhere
namespace InstructionSemantics2 {       // documented elsewhere

namespace StaticSemantics {

//                                      Free functions

void attachInstructionSemantics(SgNode *ast, Disassembler*);
void attachInstructionSemantics(SgNode *ast, const BaseSemantics::DispatcherPtr&);
//                                      Value type

typedef Sawyer::SharedPointer<class SValue> SValuePtr;

class SValue: public BaseSemantics::SValue {
public:
    using Super = BaseSemantics::SValue;

    using Ptr = SValuePtr;

protected:
    SgAsmExpression *ast_;

protected:
    SValue(size_t nbits, SgAsmRiscOperation::RiscOperator op): BaseSemantics::SValue(nbits) {
        static uint64_t nVars = 0;
        ast_ = SageBuilderAsm::buildRiscOperation(op, SageBuilderAsm::buildValueU64(nVars++));
    }

    SValue(size_t nbits, uint64_t number): BaseSemantics::SValue(nbits) {
        SgAsmType *type = SgAsmType::registerOrDelete(new SgAsmIntegerType(ByteOrder::ORDER_LSB, nbits,
                                                                           false /*unsigned*/));
        ast_ = SageBuilderAsm::buildValueInteger(number, type);
    }

    SValue(const SValue &other): BaseSemantics::SValue(other) {
        SgTreeCopy deep;
        SgNode *copied = other.ast_->copy(deep);
        ASSERT_require(isSgAsmExpression(copied));
        ast_ = isSgAsmExpression(copied);
    }
    
public:
    static SValuePtr instance() {
        return SValuePtr(new SValue(1, SgAsmRiscOperation::OP_undefined));
    }

    static SValuePtr instance_bottom(size_t nbits) {
        return SValuePtr(new SValue(nbits, SgAsmRiscOperation::OP_bottom));
    }

    static SValuePtr instance_undefined(size_t nbits) {
        return SValuePtr(new SValue(nbits, SgAsmRiscOperation::OP_undefined));
    }

    static SValuePtr instance_unspecified(size_t nbits) {
        return SValuePtr(new SValue(nbits, SgAsmRiscOperation::OP_unspecified));
    }

    static SValuePtr instance_integer(size_t nbits, uint64_t value) {
        return SValuePtr(new SValue(nbits, value));
    }

public:
    virtual BaseSemantics::SValuePtr bottom_(size_t nbits) const override {
        return instance_bottom(nbits);
    }
    virtual BaseSemantics::SValuePtr undefined_(size_t nbits) const override {
        return instance_undefined(nbits);
    }
    virtual BaseSemantics::SValuePtr unspecified_(size_t nbits) const override {
        return instance_unspecified(nbits);
    }
    virtual BaseSemantics::SValuePtr number_(size_t nbits, uint64_t value) const override {
        return instance_integer(nbits, value);
    }
    virtual BaseSemantics::SValuePtr boolean_(bool value) const override {
        return instance_integer(1, value ? 1 : 0);
    }
    virtual BaseSemantics::SValuePtr copy(size_t new_width=0) const override {
        SValuePtr retval(new SValue(*this));
        if (new_width!=0 && new_width!=retval->nBits())
            retval->set_width(new_width);
        return retval;
    }
    virtual Sawyer::Optional<BaseSemantics::SValuePtr>
    createOptionalMerge(const BaseSemantics::SValuePtr&, const BaseSemantics::MergerPtr&,
                        const SmtSolverPtr&) const override {
        throw BaseSemantics::NotImplemented("StaticSemantics is not suitable for dataflow analysis", NULL);
    }

public:
    static SValuePtr promote(const BaseSemantics::SValuePtr &v) { // hot
        SValuePtr retval = v.dynamicCast<SValue>();
        ASSERT_not_null(retval);
        return retval;
    }

public:
    // These are not needed since this domain never tries to compare semantic values.
    virtual bool may_equal(const BaseSemantics::SValuePtr &other,
                           const SmtSolverPtr &solver = SmtSolverPtr()) const override {
        ASSERT_not_reachable("no implementation necessary");
    }

    virtual bool must_equal(const BaseSemantics::SValuePtr &other,
                            const SmtSolverPtr &solver = SmtSolverPtr()) const override {
        ASSERT_not_reachable("no implementation necessary");
    }
    
    virtual void set_width(size_t nbits) override {
        ASSERT_not_reachable("no implementation necessary");
    }

    virtual bool isBottom() const override {
        return false;
    }
    
    virtual bool is_number() const override {
        return false;
    }

    virtual uint64_t get_number() const override {
        ASSERT_not_reachable("no implementation necessary");
    }

    virtual void hash(Combinatorics::Hasher&) const override {
        ASSERT_not_reachable("no implementation necessary");
    }

    virtual void print(std::ostream&, BaseSemantics::Formatter&) const override;

public:
    virtual SgAsmExpression* ast() {
        return ast_;
    }
    virtual void ast(SgAsmExpression *x) {
        ASSERT_not_null(x);
        ASSERT_require(x->get_parent() == NULL);
        ast_ = x;
    }
};

//                                      State

// No state necessary for this domain. All instruction side effects are immediately attached to the SgAsmInstruction node
// rather than being stored in some state.

typedef NullSemantics::RegisterState RegisterState;
typedef NullSemantics::RegisterStatePtr RegisterStatePtr;

typedef NullSemantics::MemoryState MemoryState;
typedef NullSemantics::MemoryStatePtr MemoryStatePtr;

typedef NullSemantics::State State;
typedef NullSemantics::StatePtr StatePtr;


//                                      RiscOperators

typedef boost::shared_ptr<class RiscOperators> RiscOperatorsPtr;

class RiscOperators: public BaseSemantics::RiscOperators {
public:
    using Super = BaseSemantics::RiscOperators;

    using Ptr = RiscOperatorsPtr;

protected:
    RiscOperators(const BaseSemantics::SValuePtr &protoval, const SmtSolverPtr &solver)
        : BaseSemantics::RiscOperators(protoval, solver) {
        name("StaticSemantics");
        (void) SValue::promote(protoval); // make sure its dynamic type is a StaticSemantics::SValue
    }

    RiscOperators(const BaseSemantics::StatePtr &state, const SmtSolverPtr &solver)
        : BaseSemantics::RiscOperators(state, solver) {
        name("StaticSemantics");
        (void) SValue::promote(state->protoval()); // values must have StaticSemantics::SValue dynamic type
    }

public:
    static RiscOperatorsPtr instance(const RegisterDictionary *regdict, const SmtSolverPtr &solver = SmtSolverPtr()) {
        BaseSemantics::SValuePtr protoval = SValue::instance();
        BaseSemantics::RegisterStatePtr registers = RegisterState::instance(protoval, regdict);
        BaseSemantics::MemoryStatePtr memory = MemoryState::instance(protoval, protoval);
        BaseSemantics::StatePtr state = State::instance(registers, memory);
        return RiscOperatorsPtr(new RiscOperators(state, solver));
    }

    static RiscOperatorsPtr instance(const BaseSemantics::SValuePtr &protoval, const SmtSolverPtr &solver = SmtSolverPtr()) {
        return RiscOperatorsPtr(new RiscOperators(protoval, solver));
    }

    static RiscOperatorsPtr instance(const BaseSemantics::StatePtr &state, const SmtSolverPtr &solver = SmtSolverPtr()) {
        return RiscOperatorsPtr(new RiscOperators(state, solver));
    }

    // Virtual constructors
public:
    virtual BaseSemantics::RiscOperatorsPtr create(const BaseSemantics::SValuePtr &protoval,
                                                   const SmtSolverPtr &solver = SmtSolverPtr()) const override {
        return instance(protoval, solver);
    }

    virtual BaseSemantics::RiscOperatorsPtr create(const BaseSemantics::StatePtr &state,
                                                   const SmtSolverPtr &solver = SmtSolverPtr()) const override {
        return instance(state, solver);
    }

    // Dynamic pointer casts
public:
    static RiscOperatorsPtr promote(const BaseSemantics::RiscOperatorsPtr &x) {
        RiscOperatorsPtr retval = boost::dynamic_pointer_cast<RiscOperators>(x);
        ASSERT_not_null(retval);
        return retval;
    }

    // Supporting functions
protected:
    BaseSemantics::SValuePtr makeSValue(size_t nbits, SgAsmExpression*);
    BaseSemantics::SValuePtr makeSValue(size_t nbits, SgAsmRiscOperation::RiscOperator);
    BaseSemantics::SValuePtr makeSValue(size_t nbits, SgAsmRiscOperation::RiscOperator,
                                        const BaseSemantics::SValuePtr &a);
    BaseSemantics::SValuePtr makeSValue(size_t nbits, SgAsmRiscOperation::RiscOperator,
                                        const BaseSemantics::SValuePtr &a,
                                        const BaseSemantics::SValuePtr &b);
    BaseSemantics::SValuePtr makeSValue(size_t nbits, SgAsmRiscOperation::RiscOperator,
                                        const BaseSemantics::SValuePtr &a,
                                        const BaseSemantics::SValuePtr &b,
                                        const BaseSemantics::SValuePtr &c);
    BaseSemantics::SValuePtr makeSValue(size_t nbits, SgAsmRiscOperation::RiscOperator,
                                        const BaseSemantics::SValuePtr &a,
                                        const BaseSemantics::SValuePtr &b,
                                        const BaseSemantics::SValuePtr &c,
                                        const BaseSemantics::SValuePtr &d);
    void saveSemanticEffect(const BaseSemantics::SValuePtr&);
    
    // Override all operator methods from base class.  These are the RISC operators that are invoked by a Dispatcher.
public:
    virtual void startInstruction(SgAsmInstruction*) override;
    virtual BaseSemantics::SValuePtr filterCallTarget(const BaseSemantics::SValuePtr &a) override;
    virtual BaseSemantics::SValuePtr filterReturnTarget(const BaseSemantics::SValuePtr &a) override;
    virtual BaseSemantics::SValuePtr filterIndirectJumpTarget(const BaseSemantics::SValuePtr &a) 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 ite(const BaseSemantics::SValuePtr &sel_,
                                         const BaseSemantics::SValuePtr &a_,
                                         const BaseSemantics::SValuePtr &b_) override;
    virtual BaseSemantics::SValuePtr isEqual(const BaseSemantics::SValuePtr&, const BaseSemantics::SValuePtr&) override;
    virtual BaseSemantics::SValuePtr isNotEqual(const BaseSemantics::SValuePtr&, const BaseSemantics::SValuePtr&) override;
    virtual BaseSemantics::SValuePtr isUnsignedLessThan(const BaseSemantics::SValuePtr&,
                                                        const BaseSemantics::SValuePtr&) override;
    virtual BaseSemantics::SValuePtr isUnsignedLessThanOrEqual(const BaseSemantics::SValuePtr&,
                                                               const BaseSemantics::SValuePtr&) override;
    virtual BaseSemantics::SValuePtr isUnsignedGreaterThan(const BaseSemantics::SValuePtr&,
                                                           const BaseSemantics::SValuePtr&) override;
    virtual BaseSemantics::SValuePtr isUnsignedGreaterThanOrEqual(const BaseSemantics::SValuePtr&,
                                                                  const BaseSemantics::SValuePtr&) override;
    virtual BaseSemantics::SValuePtr isSignedLessThan(const BaseSemantics::SValuePtr&,
                                                      const BaseSemantics::SValuePtr&) override;
    virtual BaseSemantics::SValuePtr isSignedLessThanOrEqual(const BaseSemantics::SValuePtr&,
                                                             const BaseSemantics::SValuePtr&) override;
    virtual BaseSemantics::SValuePtr isSignedGreaterThan(const BaseSemantics::SValuePtr&,
                                                         const BaseSemantics::SValuePtr&) override;
    virtual BaseSemantics::SValuePtr isSignedGreaterThanOrEqual(const BaseSemantics::SValuePtr&,
                                                                const BaseSemantics::SValuePtr&) 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 subtract(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