Program Listing for File ReuseAnalysis.h

↰ Return to documentation for file (src/midend/programTransformation/loopProcessing/depInfo/ReuseAnalysis.h)

#ifndef REUSE_ANALYSIS_H
#define REUSE_ANALYSIS_H

#include <LoopTransformInterface.h>
#include <DepInfo.h>
#include <PtrSet.h>

// returns whether the increase of induction variable ivarname
// sweeps array dimension 'dim
bool ReferenceDimension(const AstNodePtr& r,
                       const std::string& ivarname, int dim);

// returns the tride of the array access 'r' at each increase of the induction
// variable 'ivarname' ; if 'r' is not array access, returns 0.
// For arrays with unknown bounds, assume defaulrArrayBound
int ReferenceStride(const AstNodePtr& r,
                    const std::string& ivarname, unsigned arrayBound = 100);

// returns the percentage of the array access 'r' being reused at each increase of
// the induction variable 'ivarname' due to spatial locality, assuming
// cache line size is 'linesize'; invokes referenceStride internally;
// if 'r' is not array access, returns 0
float SelfSpatialReuse( const AstNodePtr& r,
                        const std::string& ivarname, unsigned linesize,
                        unsigned  defaultArrayBound = 100);

// input: ep: a list of DepInfos between references;
//        loopmap: the loop to be placed innermost for each reference;
//        dist: the maximum reuse distance between the innermost loops of two references
//              that the corresponding depInfo in 'ep' must have in order to be included in refSet;
//               if 'dist' == 0 or *'dist' < 0, impose no restraint on reuse distance
// output: refSet: the set of references being reused due to deps in 'ep' within distance 'dist'
//         dist: the maximum reuse distance for all references in 'refSet';
// return:  the type of dependences in 'ep' that cause their sink references to be reused.
DepType TemporaryReuseRefs( DepInfoConstIterator ep,
                        Map2Object<AstNodePtr, DepDirection, int>& loopmap,
                        CollectObject<AstNodePtr>& refCollect,
                        int* dist = 0) ;

// returns the set of array accesses within code fragment 's'
void ArrayReferences( AstInterface& fa, const AstNodePtr& s,
                      CollectObject<AstNodePtr>& refCollect);

#endif