Add some comments.
authorDan Gohman <gohman@apple.com>
Sat, 29 Aug 2009 23:36:57 +0000 (23:36 +0000)
committerDan Gohman <gohman@apple.com>
Sat, 29 Aug 2009 23:36:57 +0000 (23:36 +0000)
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@80452 91177308-0d34-0410-b5e6-96231b3b80d8

lib/Analysis/ScalarEvolutionAliasAnalysis.cpp

index 381ea204864c1c00f73144faff8a8d061a3ce5de..cc79e6c3b1304473b0020e09fc5bd0be01368bc3 100644 (file)
@@ -69,9 +69,14 @@ ScalarEvolutionAliasAnalysis::runOnFunction(Function &F) {
   return false;
 }
 
+/// GetUnderlyingIdentifiedObject - Given an expression, try to find an
+/// "identified object" (see AliasAnalysis::isIdentifiedObject) base
+/// value. Return null is none was found.
 Value *
 ScalarEvolutionAliasAnalysis::GetUnderlyingIdentifiedObject(const SCEV *S) {
   if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(S)) {
+    // In an addrec, assume that the base will be in the start, rather
+    // than the step.
     return GetUnderlyingIdentifiedObject(AR->getStart());
   } else if (const SCEVAddExpr *A = dyn_cast<SCEVAddExpr>(S)) {
     // If there's a pointer operand, it'll be sorted at the end of the list.