BinaryAnalysis/Partitioner2/Utility.h

#ifndef ROSE_BinaryAnalysis_Partitioner2_Utility_H
#define ROSE_BinaryAnalysis_Partitioner2_Utility_H
#include <featureTests.h>
#ifdef ROSE_ENABLE_BINARY_ANALYSIS
#include <Rose/BinaryAnalysis/Partitioner2/BasicTypes.h>

#include <Rose/BinaryAnalysis/Partitioner2/Function.h>
#include <Rose/CommandLine/IntervalParser.h>

#include <Rose/Diagnostics.h>

#include <algorithm>
#include <ostream>

namespace Rose {
namespace BinaryAnalysis {
namespace Partitioner2 {

extern Sawyer::Message::Facility mlog;
void initDiagnostics();

bool sortBasicBlocksByAddress(const BasicBlockPtr&, const BasicBlockPtr&);
bool sortDataBlocks(const DataBlockPtr&, const DataBlockPtr&);
bool sortFunctionsByAddress(const FunctionPtr&, const FunctionPtr&);
bool sortFunctionNodesByAddress(const SgAsmFunction*, const SgAsmFunction*);
bool sortByExpression(const BasicBlockSuccessor&, const BasicBlockSuccessor&);
bool sortBlocksForAst(SgAsmBlock*, SgAsmBlock*);
bool sortInstructionsByAddress(SgAsmInstruction*, SgAsmInstruction*);

template<class Container, class Comparator>
static bool
isSorted(const Container &container, Comparator sorted, bool distinct=true) {
    typename Container::const_iterator current = container.begin();
    if (current!=container.end()) {
        typename Container::const_iterator next = current;
        while (++next != container.end()) {
            if ((distinct && !sorted(*current, *next)) || sorted(*next, *current))
                return false;
            ++current;
        }
    }
    return true;
}

template<class Container, class Value, class Comparator>
typename Container::const_iterator
lowerBound(const Container &container, const Value &item, Comparator cmp) {
    return std::lower_bound(container.begin(), container.end(), item, cmp);
}
template<class Container, class Value, class Comparator>
typename Container::iterator
lowerBound(Container &container, const Value &item, Comparator cmp) {
    return std::lower_bound(container.begin(), container.end(), item, cmp);
}

// Return true if two container elements are equal according to the sorting comparator
template<class Value, class Comparator>
bool
equalUnique(const Value &a, const Value &b, Comparator cmp) {
    return !cmp(a, b) && !cmp(b, a);                    // equal iff neither one is less than the other
}

// Insert an item into a sorted container if it doesn't exist yet in the container.  Returns true iff inserted.
template<class Container, class Value, class Comparator>
bool
insertUnique(Container &container, const Value &item, Comparator cmp) {
    ASSERT_require(!ROSE_PARTITIONER_EXPENSIVE_CHECKS || isSorted(container, cmp, true)); // unique, sorted items
    typename Container::iterator lb = lowerBound(container, item, cmp);
    if (lb==container.end() || !equalUnique(*lb, item, cmp)) {
        container.insert(lb, item);
        ASSERT_require(!ROSE_PARTITIONER_EXPENSIVE_CHECKS || isSorted(container, cmp, true));
        return true;
    }
    return false;
}

// Insert an intem into a sorted continer, replacing any existing item that compares equal to it.
template<class Container, class Value, class Comparator>
void
replaceOrInsert(Container &container, const Value &item, Comparator cmp) {
    ASSERT_require(!ROSE_PARTITIONER_EXPENSIVE_CHECKS || isSorted(container, cmp, true)); // unique, sorted items
    typename Container::iterator lb = lowerBound(container, item, cmp);
    if (lb == container.end() || !equalUnique(*lb, item, cmp)) {
        container.insert(lb, item);
    } else {
        *lb = item;
    }
    ASSERT_require(!ROSE_PARTITIONER_EXPENSIVE_CHECKS || isSorted(container, cmp, true));
}

// Erase an item from a sorted container if it doesn't exist yet in the container.  Returns true iff erased.
template<class Container, class Value, class Comparator>
bool
eraseUnique(Container &container, const Value &item, Comparator cmp) {
    ASSERT_require(!ROSE_PARTITIONER_EXPENSIVE_CHECKS || isSorted(container, cmp, true)); // unique, sorted items
    typename Container::iterator lb = lowerBound(container, item, cmp);
    if (lb!=container.end() && equalUnique(*lb, item, cmp)) {
        container.erase(lb);
        return true;
    }
    return false;
}

// Check existence of an item in a sorted container. Returns true iff the item exists.
template<class Container, class Value, class Comparator>
bool
existsUnique(const Container &container, const Value &item, Comparator cmp) {
    if (item==NULL)
        return false;
    ASSERT_require(!ROSE_PARTITIONER_EXPENSIVE_CHECKS || isSorted(container, cmp, true)); // unique, sorted items
    typename Container::const_iterator lb = lowerBound(container, item, cmp);
    if (lb==container.end() || cmp(*lb, item) || cmp(item, *lb))
        return false;
    return true;
}

// Retrieve an item from a sorted container
template<class Container, class Value, class Comparator>
Sawyer::Optional<Value>
getUnique(const Container &container, const Value &item, Comparator cmp) {
    if (item==NULL)
        return Sawyer::Nothing();
    ASSERT_require(!ROSE_PARTITIONER_EXPENSIVE_CHECKS || isSorted(container, cmp, true)); // unique, sorted items
    typename Container::const_iterator lb = lowerBound(container, item, cmp);
    if (lb==container.end() || cmp(*lb, item) || cmp(item, *lb))
        return Sawyer::Nothing();
    return *lb;
}

// Find an existing item if possible and return the item. If not found, insert the item and return false.
template<class Container, class Value, class Comparator>
Sawyer::Optional<Value>
getOrInsertUnique(Container &container, const Value &item, Comparator cmp) {
    ASSERT_require(!ROSE_PARTITIONER_EXPENSIVE_CHECKS || isSorted(container, cmp, true)); // unique, sorted items
    typename Container::iterator lb = lowerBound(container, item, cmp);
    if (lb != container.end() && equalUnique(*lb, item, cmp)) {
        return *lb;
    } else {
        container.insert(lb, item);
        ASSERT_require(!ROSE_PARTITIONER_EXPENSIVE_CHECKS || isSorted(container, cmp, true));
        return Sawyer::Nothing();
    }
}

template<class Container, class Comparator>
bool
isSupersetUnique(const Container &sup, const Container &sub, Comparator lessThan) {
    ASSERT_require(!ROSE_PARTITIONER_EXPENSIVE_CHECKS || isSorted(sup, lessThan, true)); // unique, sorted items
    ASSERT_require(!ROSE_PARTITIONER_EXPENSIVE_CHECKS || isSorted(sub, lessThan, true)); // unique, sorted items
    typename Container::const_iterator isup = sup.begin(), isub = sub.begin();
    while (isup != sup.end() && isub != sub.end()) {
        while (isup != sup.end() && lessThan(*isup, *isub))
            ++isup;
        if (isup == sup.end() || lessThan(*isub, *isup))
            return false;
        ++isup, ++isub;
    }
    return isub == sub.end();
}

std::ostream& operator<<(std::ostream&, const AddressUser&);
std::ostream& operator<<(std::ostream&, const AddressUsers&);
std::ostream& operator<<(std::ostream&, const AddressUsageMap&);

class AddressIntervalParser: public Rose::CommandLine::IntervalParser<AddressInterval> {
    using Super =                   Rose::CommandLine::IntervalParser<AddressInterval>;

protected:
    AddressIntervalParser() {}
    AddressIntervalParser(const Sawyer::CommandLine::ValueSaver::Ptr &valueSaver)
        : Super(valueSaver) {}
public:
    using Ptr = Sawyer::SharedPointer<AddressIntervalParser>;

    static Ptr instance() {
        return Ptr(new AddressIntervalParser);
    }

    static Ptr instance(const Sawyer::CommandLine::ValueSaver::Ptr &valueSaver) {
        return Ptr(new AddressIntervalParser(valueSaver));
    }

    static std::string docString();
};

AddressIntervalParser::Ptr addressIntervalParser(AddressInterval &storage);
AddressIntervalParser::Ptr addressIntervalParser(std::vector<AddressInterval> &storage);
AddressIntervalParser::Ptr addressIntervalParser(AddressIntervalSet &storage);
AddressIntervalParser::Ptr addressIntervalParser();

class Trigger {
public:
    typedef AddressInterval SizeInterval;               // okay to use 64-bit integers for the counters
    struct Settings {
        SizeInterval when;                              // when to trigger based on nCalls_
        Settings(): when(0) {}
    };
private:
    size_t nCalls_;                                     // number of times called
    Settings settings_;
public:
    Trigger(): nCalls_(0) {}

    explicit Trigger(const Settings &settings): nCalls_(0), settings_(settings) {}

    Trigger(size_t nSkip, size_t nTimes): nCalls_(0) {
        settings_.when = nTimes ? SizeInterval::baseSize(nSkip, nTimes) : SizeInterval();
    }

    static Trigger once() { return Trigger(0, 1); }

    static Trigger always() { return Trigger(0, size_t(-1)); }

    static Trigger never() { return Trigger(); }

    bool isArmed() const { return !settings_.when.isEmpty() && nCalls_<=settings_.when.greatest(); }

    bool shouldTrigger() { return settings_.when.contains(nCalls_++); }

    size_t nCalls() const { return nCalls_; }

    void reset() { nCalls_ = 0; }

    static Sawyer::CommandLine::SwitchGroup switches(Settings&);

    static std::string docString();
};

size_t serialNumber();

boost::logic::tribool
hasAnyCalleeReturn(const PartitionerConstPtr&, const ControlFlowGraph::ConstVertexIterator&);

bool
hasCallReturnEdges(const ControlFlowGraph::ConstVertexIterator&);


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

#endif
#endif