OutOfBoundsTag.h

#ifndef ROSE_BinaryAnalysis_ModelChecker_OutOfBoundsTag_H
#define ROSE_BinaryAnalysis_ModelChecker_OutOfBoundsTag_H
#include <featureTests.h>
#ifdef ROSE_ENABLE_MODEL_CHECKER
 
#include <Rose/BinaryAnalysis/ModelChecker/Tag.h>
#include <Rose/BinaryAnalysis/ModelChecker/Variables.h>
#include <Rose/BinaryAnalysis/InstructionSemantics/BaseSemantics/BasicTypes.h>
#include <Rose/BinaryAnalysis/Variables.h>
 
namespace Rose {
namespace BinaryAnalysis {
namespace ModelChecker {
 
class OutOfBoundsTag: public Tag {
public:
    using Ptr = OutOfBoundsTagPtr;
 
private:
    const TestMode testMode_;                                    // may or must, but not off
    const IoMode ioMode_;                                        // read or write
    const SgAsmInstruction *insn_;                               // instruction where the oob access occurs (optional)
    const InstructionSemantics::BaseSemantics::SValuePtr addr_; // memory address that is accessed
    const FoundVariable intendedVariable_;                      // variable that was incorrectly accessed
    const FoundVariable accessedVariable_;                      // optional info about variable actually accessed
 
protected:
    OutOfBoundsTag() = delete;
    OutOfBoundsTag(size_t nodeStep, TestMode, IoMode, SgAsmInstruction*,
                   const InstructionSemantics::BaseSemantics::SValuePtr &addr,
                   const FoundVariable &intendedVariable, const FoundVariable &accessedVariable);
 
    OutOfBoundsTag(const OutOfBoundsTag&) = delete;
 
public:
    ~OutOfBoundsTag();
 
    static Ptr instance(size_t nodeStep, TestMode, IoMode, SgAsmInstruction*,
                        const InstructionSemantics::BaseSemantics::SValuePtr &addr,
                        const FoundVariable &intendedVariable, const FoundVariable &accessedVariable);
 
public:
    virtual std::string name() const override;
    virtual std::string printableName() const override;
    virtual void print(std::ostream&, const std::string &prefix) const override;
    virtual void toYaml(std::ostream&, const std::string &prefix) const override;
    virtual Sarif::ResultPtr toSarif(const Sarif::AnalysisPtr&) const override;
};
 
} // namespace
} // namespace
} // namespace
 
#endif
#endif