Learn IPConstProp to look at individual return values and propagate them

individually.

Also learn IPConstProp how returning first class aggregates work, in addition
to old style multiple return instructions.

Modify the return-constants testscase to confirm this behaviour.

llvm-svn: 52396

lib/Transforms/IPO/IPConstantPropagation.cpp

@@ -21,6 +21,7 @@
 #include "llvm/Instructions.h"
 #include "llvm/Module.h"
 #include "llvm/Pass.h"
+#include "llvm/Analysis/ValueTracking.h"
 #include "llvm/Support/CallSite.h"
 #include "llvm/Support/Compiler.h"
 #include "llvm/ADT/Statistic.h"
@@ -140,9 +141,10 @@ bool IPCP::PropagateConstantsIntoArguments(Function &F) {
 }
 
 
-// Check to see if this function returns a constant.  If so, replace all callers
+// Check to see if this function returns one or more constants. If so, replace
-// that user the return value with the returned valued.  If we can replace ALL
+// all callers that use those return values with the constant value. This will
-// callers,
+// leave in the actual return values and instructions, but deadargelim will
+// clean that up.
 bool IPCP::PropagateConstantReturn(Function &F) {
   if (F.getReturnType() == Type::VoidTy)
     return false; // No return value.
@@ -156,48 +158,65 @@ bool IPCP::PropagateConstantReturn(Function &F) {
   SmallVector<Value *,4> RetVals;
   const StructType *STy = dyn_cast<StructType>(F.getReturnType());
   if (STy)
-    RetVals.assign(STy->getNumElements(), 0);
+    for (unsigned i = 0, e = STy->getNumElements(); i < e; ++i) 
+      RetVals.push_back(UndefValue::get(STy->getElementType(i)));
   else
-    RetVals.push_back(0);
+    RetVals.push_back(UndefValue::get(F.getReturnType()));
 
+  unsigned NumNonConstant = 0;
   for (Function::iterator BB = F.begin(), E = F.end(); BB != E; ++BB)
     if (ReturnInst *RI = dyn_cast<ReturnInst>(BB->getTerminator())) {
-      assert(RetVals.size() == RI->getNumOperands() &&
+      // Return type does not match operand type, this is an old style multiple
-             "Invalid ReturnInst operands!");
+      // return
+      bool OldReturn = (F.getReturnType() != RI->getOperand(0)->getType());
+
       for (unsigned i = 0, e = RetVals.size(); i != e; ++i) {
-        if (isa<UndefValue>(RI->getOperand(i)))
+        // Already found conflicting return values?
-          continue; // Ignore
-        Constant *C = dyn_cast<Constant>(RI->getOperand(i));
-        if (C == 0)
-          return false; // Does not return a constant.
-        
         Value *RV = RetVals[i];
-        if (RV == 0)
+        if (!RV)
-          RetVals[i] = C;
+          continue;
-        else if (RV != C)
+
-          return false; // Does not return the same constant.
+        // Find the returned value
+        Value *V;
+        if (!STy || OldReturn)
+          V = RI->getOperand(i);
+        else
+          V = FindInsertedValue(RI->getOperand(0), i);
+
+        if (V) {
+          // Ignore undefs, we can change them into anything
+          if (isa<UndefValue>(V))
+            continue;
+          
+          // Try to see if all the rets return the same constant.
+          if (isa<Constant>(V)) {
+            if (isa<UndefValue>(RV)) {
+              // No value found yet? Try the current one.
+              RetVals[i] = V;
+              continue;
+            }
+            // Returning the same value? Good.
+            if (RV == V)
+              continue;
+          }
+        }
+        // Different or no known return value? Don't propagate this return
+        // value.
+        RetVals[i] = 0;
+        // All values non constant? Stop looking.
+        if (++NumNonConstant == RetVals.size())
+          return false;
       }
     }
 
-  if (STy) {
+  // If we got here, the function returns at least one constant value.  Loop
-    for (unsigned i = 0, e = RetVals.size(); i < e; ++i) 
+  // over all users, replacing any uses of the return value with the returned
-      if (RetVals[i] == 0) 
+  // constant.
-        RetVals[i] = UndefValue::get(STy->getElementType(i));
-  } else {
-    assert(RetVals.size() == 1);
-    if (RetVals[0] == 0)
-      RetVals[0] = UndefValue::get(F.getReturnType());
-  }
-
-  // If we got here, the function returns a constant value.  Loop over all
-  // users, replacing any uses of the return value with the returned constant.
-  bool ReplacedAllUsers = true;
   bool MadeChange = false;
   for (Value::use_iterator UI = F.use_begin(), E = F.use_end(); UI != E; ++UI) {
     // Make sure this is an invoke or call and that the use is for the callee.
     if (!(isa<InvokeInst>(*UI) || isa<CallInst>(*UI)) ||
         UI.getOperandNo() != 0) {
-      ReplacedAllUsers = false;
       continue;
     }
     
@@ -212,28 +231,32 @@ bool IPCP::PropagateConstantReturn(Function &F) {
       continue;
     }
    
-    while (!Call->use_empty()) {
+    for (Value::use_iterator I = Call->use_begin(), E = Call->use_end();
-      GetResultInst *GR = cast<GetResultInst>(Call->use_back());
+         I != E;) {
-      GR->replaceAllUsesWith(RetVals[GR->getIndex()]);
+      Instruction *Ins = dyn_cast<Instruction>(*I);
-      GR->eraseFromParent();
+
-    }
+      // Increment now, so we can remove the use
-  }
+      ++I;
-  
+
-  // If we replace all users with the returned constant, and there can be no
+      // Not an instruction? Ignore
-  // other callers of the function, replace the constant being returned in the
+      if (!Ins)
-  // function with an undef value.
+        continue;
-  if (ReplacedAllUsers && F.hasInternalLinkage()) {
+
-    for (Function::iterator BB = F.begin(), E = F.end(); BB != E; ++BB) {
+      // Find the index of the retval to replace with
-      if (ReturnInst *RI = dyn_cast<ReturnInst>(BB->getTerminator())) {
+      int index = -1;
-        for (unsigned i = 0, e = RetVals.size(); i < e; ++i) {
+      if (GetResultInst *GR = dyn_cast<GetResultInst>(Ins))
-          Value *RetVal = RetVals[i];
+        index = GR->getIndex();
-          if (isa<UndefValue>(RetVal))
+      else if (ExtractValueInst *EV = dyn_cast<ExtractValueInst>(Ins))
-            continue;
+        if (EV->hasIndices())
-          Value *RV = UndefValue::get(RetVal->getType());
+          index = *EV->idx_begin();
-          if (RI->getOperand(i) != RV) {
+
-            RI->setOperand(i, RV);
+      // If this use uses a specific return value, and we have a replacement,
-            MadeChange = true;
+      // replace it.
-          }
+      if (index != -1) {
+        Value *New = RetVals[index];
+        if (New) {
+          Ins->replaceAllUsesWith(New);
+          Ins->eraseFromParent();
         }
       }
     }

test/Transforms/IPConstantProp/return-constants.ll

@@ -1,20 +1,41 @@
-; RUN: llvm-as < %s | opt -ipconstprop | llvm-dis | grep {add i32 21, 21}
+; RUN: llvm-as < %s | opt -ipconstprop | llvm-dis > %t
+;; Check that the 21 constants got propagated properly
+; RUN: cat %t | grep {%M = add i32 21, 21}
+;; Check that the second return values didn't get propagated
+; RUN: cat %t | grep {%N = add i32 %B, %D}
 
-define internal {i32, i32} @foo(i1 %C) {
+define internal {i32, i32} @foo(i1 %Q) {
-        br i1 %C, label %T, label %F
+        br i1 %Q, label %T, label %F
 
 T:              ; preds = %0
-        ret i32 21, i32 21
+        ret i32 21, i32 22
 
 F:              ; preds = %0
-        ret i32 21, i32 21
+        ret i32 21, i32 23
 }
 
-define i32 @caller(i1 %C) {
+define internal {i32, i32} @bar(i1 %Q) {
-        %X = call {i32, i32} @foo( i1 %C )
+        %A = insertvalue { i32, i32 } undef, i32 21, 0
+        br i1 %Q, label %T, label %F
+
+T:              ; preds = %0
+        %B = insertvalue { i32, i32 } %A, i32 22, 1
+        ret { i32, i32 } %B
+
+F:              ; preds = %0
+        %C = insertvalue { i32, i32 } %A, i32 23, 1
+        ret { i32, i32 } %C
+}
+
+define { i32, i32 } @caller(i1 %Q) {
+        %X = call {i32, i32} @foo( i1 %Q )
         %A = getresult {i32, i32} %X, 0
         %B = getresult {i32, i32} %X, 1
-        %Y = add i32 %A, %B
+        %Y = call {i32, i32} @bar( i1 %Q )
-        ret i32 %Y
+        %C = extractvalue {i32, i32} %Y, 0
+        %D = extractvalue {i32, i32} %Y, 1
+        %M = add i32 %A, %C
+        %N = add i32 %B, %D
+        ret { i32, i32 } %X
 }