[llvm] r347653 - InstCombine: add comment explaining malloc deletion. NFC.

[Tim Northover via llvm-commits]

Author: tnorthover
Date: Tue Nov 27 03:08:14 2018
New Revision: 347653

URL: http://llvm.org/viewvc/llvm-project?rev=347653&view=rev
Log:
InstCombine: add comment explaining malloc deletion. NFC.

I tried to change this, not quite realising the logic behind what we
were doing. Hopefully this comment will help the next person to come
along.

Modified:
    llvm/trunk/lib/Transforms/InstCombine/InstructionCombining.cpp

Modified: llvm/trunk/lib/Transforms/InstCombine/InstructionCombining.cpp
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/lib/Transforms/InstCombine/InstructionCombining.cpp?rev=347653&r1=347652&r2=347653&view=diff
==============================================================================
--- llvm/trunk/lib/Transforms/InstCombine/InstructionCombining.cpp (original)
+++ llvm/trunk/lib/Transforms/InstCombine/InstructionCombining.cpp Tue Nov 27 03:08:14 2018
@@ -2244,9 +2244,16 @@ static bool isAllocSiteRemovable(Instruc
 }
 
 Instruction *InstCombiner::visitAllocSite(Instruction &MI) {
-  // If we have a malloc call which is only used in any amount of comparisons
-  // to null and free calls, delete the calls and replace the comparisons with
-  // true or false as appropriate.
+  // If we have a malloc call which is only used in any amount of comparisons to
+  // null and free calls, delete the calls and replace the comparisons with true
+  // or false as appropriate.
+
+  // This is based on the principle that we can substitute our own allocation
+  // function (which will never return null) rather than knowledge of the
+  // specific function being called. In some sense this can change the permitted
+  // outputs of a program (when we convert a malloc to an alloca, the fact that
+  // the allocation is now on the stack is potentially visible, for example),
+  // but we believe in a permissible manner.
   SmallVector<WeakTrackingVH, 64> Users;
 
   // If we are removing an alloca with a dbg.declare, insert dbg.value calls