ModulesX86.h

#ifndef ROSE_Partitioner2_ModulesX86_H
#define ROSE_Partitioner2_ModulesX86_H

#include <featureTests.h>
#ifdef ROSE_ENABLE_BINARY_ANALYSIS

#include <Partitioner2/Modules.h>
#include <Partitioner2/Thunk.h>

namespace Rose {
namespace BinaryAnalysis {
namespace Partitioner2 {

namespace ModulesX86 {

class MatchStandardPrologue: public FunctionPrologueMatcher {
protected:
    Function::Ptr function_;
public:
    static Ptr instance() { return Ptr(new MatchStandardPrologue); } 
    virtual std::vector<Function::Ptr> functions() const ROSE_OVERRIDE { return std::vector<Function::Ptr>(1, function_); }
    virtual bool match(const Partitioner &partitioner, rose_addr_t anchor) ROSE_OVERRIDE;
};

class MatchHotPatchPrologue: public MatchStandardPrologue {
public:
    static Ptr instance() { return Ptr(new MatchHotPatchPrologue); } 
    virtual std::vector<Function::Ptr> functions() const ROSE_OVERRIDE { return std::vector<Function::Ptr>(1, function_); }
    virtual bool match(const Partitioner &partitioner, rose_addr_t anchor) ROSE_OVERRIDE;
};

class MatchAbbreviatedPrologue: public FunctionPrologueMatcher {
protected:
    Function::Ptr function_;
public:
    static Ptr instance() { return Ptr(new MatchAbbreviatedPrologue); }
    virtual std::vector<Function::Ptr> functions() const ROSE_OVERRIDE { return std::vector<Function::Ptr>(1, function_); }
    virtual bool match(const Partitioner &partitioner, rose_addr_t anchor) ROSE_OVERRIDE;
};

class MatchEnterPrologue: public FunctionPrologueMatcher {
protected:
    Function::Ptr function_;
public:
    static Ptr instance() { return Ptr(new MatchEnterPrologue); } 
    virtual std::vector<Function::Ptr> functions() const ROSE_OVERRIDE { return std::vector<Function::Ptr>(1, function_); }
    virtual bool match(const Partitioner &partitioner, rose_addr_t anchor) ROSE_OVERRIDE;
};

class MatchRetPadPush: public FunctionPrologueMatcher {
protected:
    Function::Ptr function_;
public:
    static Ptr instance() { return Ptr(new MatchRetPadPush); } 
    virtual std::vector<Function::Ptr> functions() const ROSE_OVERRIDE { return std::vector<Function::Ptr>(1, function_); }
    virtual bool match(const Partitioner &partitioner, rose_addr_t anchor) ROSE_OVERRIDE;
};

class FunctionReturnDetector: public BasicBlockCallback {
public:
    static Ptr instance() { return Ptr(new FunctionReturnDetector); } 
    virtual bool operator()(bool chain, const Args&) ROSE_OVERRIDE;
};

class SwitchSuccessors: public BasicBlockCallback {
public:
    enum EntryType { ABSOLUTE, RELATIVE };

private:
    Sawyer::Optional<rose_addr_t> tableVa_;             // possible address for jump table
    EntryType entryType_;                               // type of table entries
    size_t entrySizeBytes_;                             // size of each table entry

public:
    SwitchSuccessors()
        : entryType_(ABSOLUTE), entrySizeBytes_(4) {}
    static Ptr instance() { return Ptr(new SwitchSuccessors); } 
    virtual bool operator()(bool chain, const Args&) ROSE_OVERRIDE;
private:
    bool matchPattern1(SgAsmExpression *jmpArg);
    bool matchPattern2(const BasicBlockPtr&, SgAsmInstruction *jmp);
    bool matchPattern3(const Partitioner&, const BasicBlockPtr&, SgAsmInstruction *jmp);
    bool matchPatterns(const Partitioner&, const BasicBlockPtr&);
};

bool matchEnterAnyZero(const Partitioner&, SgAsmX86Instruction*);

Sawyer::Optional<rose_addr_t> matchJmpConst(const Partitioner&, SgAsmX86Instruction*);

bool matchLeaCxMemBpConst(const Partitioner&, SgAsmX86Instruction*);

bool matchJmpMem(const Partitioner&, SgAsmX86Instruction*);

bool matchMovBpSp(const Partitioner&, SgAsmX86Instruction*);

bool matchMovDiDi(const Partitioner&, SgAsmX86Instruction*);

bool matchPushBp(const Partitioner&, SgAsmX86Instruction*);

bool matchPushSi(const Partitioner&, SgAsmX86Instruction*);

std::vector<rose_addr_t> scanCodeAddressTable(const Partitioner&, AddressInterval &tableLimits /*in,out*/,
                                              const AddressInterval &targetLimits,
                                              SwitchSuccessors::EntryType tableEntryType, size_t tableEntrySizeBytes,
                                              Sawyer::Optional<rose_addr_t> probableStartVa = Sawyer::Nothing(),
                                              size_t nSkippable = 0);

Sawyer::Optional<rose_addr_t> findTableBase(SgAsmExpression*);


} // namespace
} // namespace
} // namespace
} // namespace

#endif
#endif