[SROA] Remove Dead Instructions while creating speculative instructions
authorArnamoy Bhattacharyya <arnamoy.bhattacharyya@huawei.com>
Fri, 18 Dec 2020 16:38:51 +0000 (11:38 -0500)
committerCongzheUalberta <congzhecao@gmail.com>
Fri, 18 Dec 2020 16:47:02 +0000 (11:47 -0500)
commit06d5b1c9ad52476e845f969cf82e00e383f9cf40
tree02dff8f327fb354a23d70bb3c9ec225b5e0cf0dc
parent22c1bd57bf34391cd16e91fa4830dba4cdf17aa2
[SROA] Remove Dead Instructions while creating speculative instructions

The SROA pass tries to be lazy for removing dead instructions that are collected during iterative run of the pass in the DeadInsts list.  However it does not remove instructions from the dead list while running eraseFromParent() on those instructions.

This causes (rare) null pointer dereferences.  For example, in the speculatePHINodeLoads() instruction, in the following code snippet:

```
   while (!PN.use_empty()) {
     LoadInst *LI = cast<LoadInst>(PN.user_back());
     LI->replaceAllUsesWith(NewPN);
     LI->eraseFromParent();
   }
```

If the Load instruction LI belongs to the DeadInsts list, it should be removed when eraseFromParent() is called.  However, the bug does not show up in most cases, because immediately in the same function, a new LoadInst is created in the following line:

```
LoadInst *Load = PredBuilder.CreateAlignedLoad(
         LoadTy, InVal, Alignment,
         (PN.getName() + ".sroa.speculate.load." + Pred->getName()));
```

This new LoadInst object takes the same memory address of the just deleted LI using eraseFromParent(), therefore the bug does not materialize.  In very rare cases, the addresses differ and therefore, a dangling pointer is created, causing a crash.

Reviewed By: lebedev.ri

Differential Revision: https://reviews.llvm.org/D92431
llvm/include/llvm/Transforms/Scalar/SROA.h
llvm/lib/Transforms/Scalar/SROA.cpp