scale.score.expr
Class LoadDeclAddressExpr

java.lang.Object
  scale.common.Root
      scale.score.Note
          scale.score.expr.Expr
              scale.score.expr.LoadExpr
                  scale.score.expr.LoadDeclAddressExpr

All Implemented Interfaces:

AnnotationInterface, DisplayNode

public final class LoadDeclAddressExpr
extends LoadExpr

This class represents the address of a declaration.

$Id: LoadDeclAddressExpr.java,v 1.74 2007-10-04 19:58:31 burrill Exp $

Copyright 2008 by the Scale Compiler Group,
Department of Computer Science
University of Massachusetts,
Amherst MA. 01003, USA
All Rights Reserved.

The type of a LoadDeclAddressExpr is always of type pointer-to-declaration-type.

Field Summary

Fields inherited from class scale.score.expr.Expr

fpReorder, SE_DOMAIN, SE_NONE, SE_OVERFLOW, SE_STATE

Constructor Summary

LoadDeclAddressExpr(Declaration decl)
This method builds an expression node with this operation as the operator.

Method Summary

Expr	copy() Make a copy of this load expression.
Expr	copyNoUD() Make a copy of this load expression without the use - def information.
int	executionCostEstimate() Return a relative cost estimate for executing the expression.
int	findCoefficient() Return the coefficient value.
protected Chord	findCriticalChord(HashMap<Expr,Chord> lMap, Chord independent) Return the label of the Chord with the highest label value from the set of Chords that must be executed before this expression.
java.lang.String	getDisplayLabel() Return a String suitable for labeling this node in a graphical display.
boolean	isLoopInvariant(LoopHeaderChord loop) Return true if this expression is loop invariant.
int	linearity() Return linearity of an address.
boolean	optimizationCandidate() Return true if the expression can be moved without problems.
void	recordRefs(Chord stmt, References refs) Record any variable references in this expression in the table of references.
void	removeRefs(Chord stmt, References refs) Remove any variable references in this expression from the table of references.
void	visit(Predicate p) Process a node by calling its associated routine.

Methods inherited from class scale.score.expr.LoadExpr

addMayUse, canonical, containsDeclaration, dependsOnDeclaration, equivalent, findSubscriptExpr, getAliasAnnote, getDecl, getDeclList, getExprList, getLoadExprList, getMayUse, getName, getObject, getOperandArray, getReference, getReuseLevel, getSubsetDecl, getUseDef, isMemoryDef, isMemRefExpr, loopClean, numOperands, pushOperands, referencesVariableInCommon, removeUseDef, replaceDecl, setCrossloopReuse, setDecl, setSpatialReuse, setStep, setTemporalReuse, setUseDef, setUseMayUse, setUseOriginal, sideEffects, unlinkExpression, validate, validLValue

Methods inherited from class scale.score.expr.Expr

addCast, addCast, changeInDataEdge, conditionalCopy, conditionalUnlinkExpression, deleteOutDataEdge, executionOrder, executionOrdinal, findLinearCoefficient, getAffineExpr, getAffineRepresentation, getCall, getConstantValue, getConstantValue, getCoreType, getCriticalChord, getDefExpr, getDisplayColorHint, getDisplayShapeHint, getDualExpr, getInDataEdge, getInDataEdgeArray, getLoopHeader, getLow, getLValue, getOperand, getOutDataEdge, getPointedToCore, getRValue, getType, hasTrueFalseResult, isCast, isDefined, isDefined, isLiteralExpr, isMatchExpr, isScalar, isSimpleExpr, mayGenerateCall, numInDataEdges, reduce, removeDualExprs, setOperand, setOutDataEdge, setType, toStringSpecial

Methods inherited from class scale.score.Note

getChord, getEssentialUse, setAnnotationLevel, setReportLevel, toString

Methods inherited from class scale.common.Root

addAnnotation, allAnnotations, allMatchingAnnotations, getAnnotation, getDisplayName, getDisplayString, getNodeCount, getNodeID, hasAnnotation, hasEqualAnnotation, hashCode, removeAnnotation, removeAnnotations, toStringAnnotations, toStringClass, trace, trace, trace

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

LoadDeclAddressExpr

public LoadDeclAddressExpr(Declaration decl)

This method builds an expression node with this operation as the operator.

Method Detail

copy

public Expr copy()

Make a copy of this load expression. The use - def information is copied too.

Specified by:

copy in class Expr

Returns:

a copy of this expression

copyNoUD

public Expr copyNoUD()

Make a copy of this load expression without the use - def information.

Specified by:

copyNoUD in class LoadExpr

visit

public void visit(Predicate p)

Description copied from class: Note

Process a node by calling its associated routine. See the "visitor" design pattern in Design Patterns: Elements of Reusable Object-Oriented Software by E. Gamma, et al, Addison Wesley, ISBN 0-201-63361-2.

Each class has a visit(Predicate p) method. For example, in class ABC:

   public void visit(Predicate p)
   {
     p.visitABC(this);
   }
 

and the class that implements Predicate has a method

   public void visitABC(Note n)
   {
     ABC a = (ABC) n;
     ...
   }
 

Thus, the class that implements Predicate can call

   n.visit(this);
 

where n is a Note sub-class without determining which specific sub-class n is. The visit pattern basically avoids implementing a large switch statement or defining different methods in each class for some purpose.

Specified by:

visit in class Note

See Also:

Predicate

getDisplayLabel

public java.lang.String getDisplayLabel()

Description copied from class: Expr

Return a String suitable for labeling this node in a graphical display. This method should be over-ridden as it simplay returns the class name.

Specified by:

getDisplayLabel in interface DisplayNode

Overrides:

getDisplayLabel in class Expr

linearity

public int linearity()

Return linearity of an address.

findCoefficient

public int findCoefficient()

Return the coefficient value.

findCriticalChord

protected Chord findCriticalChord(HashMap<Expr,Chord> lMap,
                                  Chord independent)

Return the label of the Chord with the highest label value from the set of Chords that must be executed before this expression.

Overrides:

findCriticalChord in class Expr

Parameters:

lMap - is used to memoize the expression to critical Chord information

independent - is returned if the expression is not dependent on anything

optimizationCandidate

public boolean optimizationCandidate()

Return true if the expression can be moved without problems. If the address is of a variable in memory whose address is not used as an argument, then the LoadDeclAddressEXpr instance can be moved.

Specified by:

optimizationCandidate in class Expr

executionCostEstimate

public int executionCostEstimate()

Return a relative cost estimate for executing the expression.

Specified by:

executionCostEstimate in class Note

recordRefs

public void recordRefs(Chord stmt,
                       References refs)

Record any variable references in this expression in the table of references.

Overrides:

recordRefs in class LoadExpr

removeRefs

public void removeRefs(Chord stmt,
                       References refs)

Remove any variable references in this expression from the table of references.

Overrides:

removeRefs in class LoadExpr

isLoopInvariant

public boolean isLoopInvariant(LoopHeaderChord loop)

Return true if this expression is loop invariant.

Overrides:

isLoopInvariant in class Expr

Parameters:

loop - is the loop