IPO: Add use-list-order verifier

[oota-llvm.git] / include / llvm / IR / UseListOrder.h

diff --git a/include/llvm/IR/UseListOrder.h b/include/llvm/IR/UseListOrder.h
new file mode 100644 (file)
index 0000000..aaf6b88
--- /dev/null
+++ b/include/llvm/IR/UseListOrder.h
@@ -0,0 +1,42 @@
+//===- llvm/IR/UseListOrder.h - LLVM Use List Order functions ---*- C++ -*-===//
+//
+//                     The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+//
+// This file has functions to modify the use-list order and to verify that it
+// doesn't change after serialization.
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef LLVM_IR_USELISTORDER_H
+#define LLVM_IR_USELISTORDER_H
+
+namespace llvm {
+
+class Module;
+
+/// \brief Whether to preserve use-list ordering.
+bool shouldPreserveBitcodeUseListOrder();
+
+/// \brief Shuffle all use-lists in a module.
+///
+/// Adds \c SeedOffset to the default seed for the random number generator.
+void shuffleUseLists(Module &M, unsigned SeedOffset = 0);
+
+/// \brief Verify use-list order after serializing to bitcode.
+///
+/// \return \c true if there are no errors.
+bool verifyBitcodeUseListOrder(const Module &M);
+
+/// \brief Verify use-list order after serializing to assembly.
+///
+/// \return \c true if there are no errors.
+bool verifyAssemblyUseListOrder(const Module &M);
+
+} // end namespace llvm
+
+#endif