SourceLocations.h

#ifndef ROSE_BinaryAnalysis_SourceLocations_H
#define ROSE_BinaryAnalysis_SourceLocations_H
#include <featureTests.h>
#ifdef ROSE_ENABLE_BINARY_ANALYSIS
 
#include <Rose/BinaryAnalysis/AddressInterval.h>
#include <Rose/BinaryAnalysis/AddressIntervalSet.h>
#include <Rose/SourceLocation.h>
 
#include <Sawyer/IntervalMap.h>
#include <Sawyer/Map.h>
#include <Sawyer/Optional.h>
#include <Sawyer/Synchronization.h>
 
#include <boost/filesystem.hpp>
 
#ifdef ROSE_ENABLE_BOOST_SERIALIZATION
#include <boost/serialization/access.hpp>
#endif
 
#include <set>
#include <string>
 
class SgNode;
 
namespace Rose {
namespace BinaryAnalysis {
 
class SourceLocations {
public:
    typedef Sawyer::Container::IntervalMap<AddressInterval, SourceLocation> AddressToSource;
    typedef Sawyer::Container::Map<SourceLocation, AddressIntervalSet> SourceToAddress;
 
private:
    mutable SAWYER_THREAD_TRAITS::Mutex mutex_;         // protects the following data members
    AddressToSource addrToSrc_;
    SourceToAddress srcToAddr_;
 
private:
#ifdef ROSE_ENABLE_BOOST_SERIALIZATION
    friend class boost::serialization::access;
 
    template<class S>
    void serialize(S &s, const unsigned /*version*/) {
        s & BOOST_SERIALIZATION_NVP(addrToSrc_);
        s & BOOST_SERIALIZATION_NVP(srcToAddr_);
    }
#endif
 
public:
    SourceLocations() {}
 
    SourceLocations(const SourceLocations&);
    SourceLocations& operator=(const SourceLocations&);
    void insert(const SourceLocation&, Address);
    void insert(const SourceLocation&, const AddressInterval&);
    void insert(const SourceLocation&, const AddressIntervalSet&);
    void erase(const SourceLocation&, Address);
    void erase(const SourceLocation&, const AddressInterval&);
    void erase(const SourceLocation&, const AddressIntervalSet&);
    void erase(Address);
    void erase(const AddressInterval&);
    void erase(const AddressIntervalSet&);
    void erase(const SourceLocation&);
 
    void clear();
 
    void insertFromDebug(SgNode *ast);
 
    void fillHoles(size_t maxHoleSize = 64);
 
    SourceLocation get(Address) const;
    SourceLocation operator()(Address va) const {
        return get(va);
    }
    AddressIntervalSet get(const SourceLocation&) const;
 
    Sawyer::Optional<Address> firstAddress(const SourceLocation&) const;
    Sawyer::Optional<Address> operator()(const SourceLocation &loc) const {
        return firstAddress(loc);
    }
    std::set<boost::filesystem::path> allFileNames() const;
 
    SourceLocation nextSourceLocation(const SourceLocation &current = SourceLocation()) const;
 
    void printSrcToAddr(std::ostream&, const std::string &prefix = "") const;
    void print(std::ostream&, const std::string &prefix = "") const;
    void printAddrToSrc(std::ostream&, const std::string &prefix = "") const;
 
private:
    // Non-synchronized erasing of a link between source code and binary address.
    void eraseNS(const SourceLocation&, Address);
    void eraseNS(Address va);
};
 
std::ostream& operator<<(std::ostream&, const SourceLocations&);
 
} // namespace
} // namespace
 
#endif
#endif