EquivSets.hpp

Go to the documentation of this file.

#ifndef AliasEquivSets_H
#define AliasEquivSets_H

#include <cassert>
#include <iostream>
#include <set>
#include <vector>
#include <queue>
#include <map>

#include <OpenAnalysis/Utils/OA_ptr.hpp>
#include <OpenAnalysis/Utils/OutputBuilder.hpp>
#include <OpenAnalysis/IRInterface/IRHandles.hpp>
#include <OpenAnalysis/Alias/Interface.hpp>
#include <OpenAnalysis/MemRefExpr/MemRefExpr.hpp>
#include <OpenAnalysis/Location/Locations.hpp>
#include <OpenAnalysis/Utils/GenOutputTool.hpp>

namespace OA {
  namespace Alias {

typedef std::set<MemRefHandle> MemRefSet;
typedef std::set<OA_ptr<Location> > LocSet;


class EquivSetsMemRefIter : public MemRefIterator {
public:
  EquivSetsMemRefIter(OA_ptr<MemRefSet> pSet) : mSet(pSet) 
    { mIter = mSet->begin(); }
  ~EquivSetsMemRefIter() { }

  MemRefHandle current() const { return *mIter; }
  bool isValid()  const { return (mIter != mSet->end()); }
        
  void operator++() { if (mIter!=mSet->end()) ++mIter; }

  void reset() { mIter = mSet->begin(); }

private:
  OA_ptr<MemRefSet>  mSet;
  MemRefSet::iterator mIter;
};


class EquivSets : public virtual Annotation, public Alias::Interface {
  public:
    EquivSets();
    ~EquivSets() {}

    static const int SET_ID_NONE = -1; 

    AliasResultType alias(MemRefHandle ref1, 
                          MemRefHandle ref2);

    OA_ptr<LocIterator> getMayLocs(MemRefHandle ref);

    OA_ptr<LocIterator> getMustLocs(MemRefHandle ref);

    OA_ptr<LocIterator> getMayLocs(MemRefExpr &ref, ProcHandle proc);

    OA_ptr<LocIterator> getMustLocs(MemRefExpr &ref, ProcHandle proc);

    OA_ptr<MemRefIterator> getMemRefIter();

    //*****************************************************************
    // Info methods unique to Alias::EquivSets
    //*****************************************************************

    //*****************************************************************
    // Construction methods 
    //*****************************************************************

    void addLocation(OA_ptr<Location> pLoc, ProcHandle proc, int equivSet);
    
    OA_ptr<LocIterator> getLocIterator(ProcHandle proc, int equivSet); 

    OA_ptr<std::map<int,OA_ptr<LocSet> > > getIdToLocSetMap(ProcHandle proc);

    void mapMemRefToEquivSet(MemRefHandle ref, int equivSetId);

    void mapMemRefToEquivSet(OA_ptr<MemRefExpr> ref, int setId);

    void mapMemRefToProc(MemRefHandle ref, ProcHandle proc);

    void mapAllToUnknown();

    //*****************************************************************
    // Output
    //*****************************************************************

    void output(OA::IRHandlesIRInterface& ir);

    void dump(std::ostream& os, OA_ptr<IRHandlesIRInterface> ir);

  private:
OUTPUT
    // data members
      // the procedure each mem ref appears within
GENOUT   std::map<MemRefHandle,ProcHandle> mMemRefToProc;

      // mapping of memory reference handles to equiv sets
      // can be mapped to multiple because can be mapped to
      // multiple MREs
GENOUT   std::map<MemRefHandle,std::set<int> > mMemRefToSets;

       // each procedure will have a set of locations associated
       // with each equivset
GENOUT    std::map<ProcHandle,std::map<int,std::set<OA_ptr<Location> > > > 
       mProcNSetToLocs;

    // the location set a MemRefExpr maps to
    GENOUT std::map<OA_ptr<MemRefExpr>,int> mMREToIdMap;  

};

  } // end of Alias namespace
} // end of OA namespace

#endif