ExternalFunctionUnit.h

#ifndef ROSE_BinaryAnalysis_ModelChecker_ExternalFunctionUnit_H
#define ROSE_BinaryAnalysis_ModelChecker_ExternalFunctionUnit_H
#include <featureTests.h>
#ifdef ROSE_ENABLE_MODEL_CHECKER
 
#include <Rose/BinaryAnalysis/ConcreteLocation.h>
#include <Rose/BinaryAnalysis/ModelChecker/ExecutionUnit.h>
#include <Rose/BinaryAnalysis/Partitioner2/BasicTypes.h>
 
namespace Rose {
namespace BinaryAnalysis {
namespace ModelChecker {
 
class ExternalFunctionUnit: public ExecutionUnit {
public:
    using Ptr = ExternalFunctionUnitPtr;
 
private:
    Partitioner2::FunctionPtr function_;
 
protected:
    ExternalFunctionUnit() = delete;
    ExternalFunctionUnit(const Partitioner2::FunctionPtr&, const SourceLocation&);
public:
    ~ExternalFunctionUnit();
 
public:
    static Ptr instance(const Partitioner2::FunctionPtr&, const SourceLocation&);
 
public:
    Partitioner2::FunctionPtr function() const;
 
public:
    virtual std::string printableName() const override;
    virtual void printSteps(const SettingsPtr&, std::ostream&, const std::string &prefix,
                            size_t stepOrigin, size_t maxSteps) const override;
    virtual void toYamlHeader(const SettingsPtr&, std::ostream&, const std::string &prefix) const override;
    virtual void toYamlSteps(const SettingsPtr&, std::ostream&, const std::string &prefix,
                             size_t stepOrigin, size_t maxSteps) const override;
    virtual std::vector<Sarif::LocationPtr> toSarif(size_t maxSteps) const override;
    virtual size_t nSteps() const override;
    virtual Sawyer::Optional<Address> address() const override;
    virtual std::vector<TagPtr> execute(const SettingsPtr&, const SemanticCallbacksPtr&,
                                        const InstructionSemantics::BaseSemantics::RiscOperatorsPtr&) override;
 
private:
    // Read a calling convention parameter location
    InstructionSemantics::BaseSemantics::SValuePtr
    readLocation(const InstructionSemantics::BaseSemantics::DispatcherPtr&, const ConcreteLocation&,
                 const InstructionSemantics::BaseSemantics::SValuePtr &dfltValue);
 
    // Write to a calling convention parameter location
    void
    writeLocation(const InstructionSemantics::BaseSemantics::DispatcherPtr&, const ConcreteLocation&,
                 const InstructionSemantics::BaseSemantics::SValuePtr &value);
 
    // Set function return values to free variables
    void clearReturnValues(const InstructionSemantics::BaseSemantics::DispatcherPtr&);
 
    // Simulate a function return
    void simulateReturn(const InstructionSemantics::BaseSemantics::DispatcherPtr&);
};
 
 
} // namespace
} // namespace
} // namespace
 
#endif
#endif