From 148a0bfcea5d3267eac02613cfcc8b5fe8894f2c Mon Sep 17 00:00:00 2001
From: Chris Lattner <sabre@nondot.org>
Date: Tue, 7 May 2002 18:52:48 +0000
Subject: [PATCH] Checkin headers for Utils library

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@2528 91177308-0d34-0410-b5e6-96231b3b80d8
---
 .../llvm/Transforms/Utils/BasicBlockUtils.h   | 45 +++++++++++++
 include/llvm/Transforms/Utils/Local.h         | 64 +++++++++++++++++++
 2 files changed, 109 insertions(+)
 create mode 100644 include/llvm/Transforms/Utils/BasicBlockUtils.h
 create mode 100644 include/llvm/Transforms/Utils/Local.h

diff --git a/include/llvm/Transforms/Utils/BasicBlockUtils.h b/include/llvm/Transforms/Utils/BasicBlockUtils.h
new file mode 100644
index 00000000000..08d173d4ef3
--- /dev/null
+++ b/include/llvm/Transforms/Utils/BasicBlockUtils.h
@@ -0,0 +1,45 @@
+//===-- Transform/Utils/BasicBlockUtils.h - BasicBlock Utilities -*- C++ -*-==//
+//
+// This family of functions perform manipulations on basic blocks, and
+// instructions contained within basic blocks.
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef LLVM_TRANSFORMS_UTILS_BASICBLOCK_H
+#define LLVM_TRANSFORMS_UTILS_BASICBLOCK_H
+
+// FIXME: Move to this file: BasicBlock::removePredecessor, BB::splitBasicBlock
+
+#include "llvm/BasicBlock.h"
+class Instruction;
+
+
+// ReplaceInstWithValue - Replace all uses of an instruction (specified by BI)
+// with a value, then remove and delete the original instruction.
+//
+void ReplaceInstWithValue(BasicBlock::InstListType &BIL,
+                          BasicBlock::iterator &BI, Value *V);
+
+// ReplaceInstWithInst - Replace the instruction specified by BI with the
+// instruction specified by I.  The original instruction is deleted and BI is
+// updated to point to the new instruction.
+//
+void ReplaceInstWithInst(BasicBlock::InstListType &BIL,
+                         BasicBlock::iterator &BI, Instruction *I);
+
+// ReplaceInstWithInst - Replace the instruction specified by From with the
+// instruction specified by To.  Note that this is slower than providing an
+// iterator directly, because the basic block containing From must be searched
+// for the instruction.
+//
+void ReplaceInstWithInst(Instruction *From, Instruction *To);
+
+// InsertInstBeforeInst - Insert 'NewInst' into the basic block that 'Existing'
+// is already in, and put it right before 'Existing'.  This instruction should
+// only be used when there is no iterator to Existing already around.  The 
+// returned iterator points to the new instruction.
+//
+BasicBlock::iterator InsertInstBeforeInst(Instruction *NewInst,
+                                          Instruction *Existing);
+
+#endif
diff --git a/include/llvm/Transforms/Utils/Local.h b/include/llvm/Transforms/Utils/Local.h
new file mode 100644
index 00000000000..a01cd06a8d8
--- /dev/null
+++ b/include/llvm/Transforms/Utils/Local.h
@@ -0,0 +1,64 @@
+//===-- Local.h - Functions to perform local transformations -----*- C++ -*--=//
+//
+// This family of functions perform various local transformations to the
+// program.
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef LLVM_TRANSFORMS_UTILS_LOCAL_H
+#define LLVM_TRANSFORMS_UTILS_LOCAL_H
+
+#include "llvm/Function.h"
+#include "llvm/BasicBlock.h"
+
+//===----------------------------------------------------------------------===//
+//  Local constant propogation...
+//
+
+// doConstantPropogation - Constant prop a specific instruction.  Returns true
+// and potentially moves the iterator if constant propogation was performed.
+//
+bool doConstantPropogation(BasicBlock *BB, BasicBlock::iterator &I);
+
+// ConstantFoldTerminator - If a terminator instruction is predicated on a
+// constant value, convert it into an unconditional branch to the constant
+// destination.  This is a nontrivial operation because the successors of this
+// basic block must have their PHI nodes updated.
+//
+bool ConstantFoldTerminator(BasicBlock *BB, BasicBlock::iterator &I,
+                            TerminatorInst *T);
+
+
+//===----------------------------------------------------------------------===//
+//  Local dead code elimination...
+//
+
+// isInstructionTriviallyDead - Return true if the result produced by the
+// instruction is not used, and the instruction has no side effects.
+//
+bool isInstructionTriviallyDead(Instruction *I);
+
+
+// dceInstruction - Inspect the instruction at *BBI and figure out if it
+// isTriviallyDead.  If so, remove the instruction and update the iterator to
+// point to the instruction that immediately succeeded the original instruction.
+//
+bool dceInstruction(BasicBlock::InstListType &BBIL, BasicBlock::iterator &BBI);
+
+
+//===----------------------------------------------------------------------===//
+//  Control Flow Graph Restructuring...
+//
+
+// SimplifyCFG - This function is used to do simplification of a CFG.  For
+// example, it adjusts branches to branches to eliminate the extra hop, it
+// eliminates unreachable basic blocks, and does other "peephole" optimization
+// of the CFG.  It returns true if a modification was made, and returns an 
+// iterator that designates the first element remaining after the block that
+// was deleted.
+//
+// WARNING:  The entry node of a method may not be simplified.
+//
+bool SimplifyCFG(Function::iterator &BBIt);
+
+#endif
-- 
2.34.1