Split out the IRReader header and the utility functions it provides into
[oota-llvm.git] / include / llvm / Transforms / Instrumentation.h
index 869f9d05d6cda318bd8b80b7c39463ce2df74743..4aae200dd0835f38ee4e95ea55e5bd3f490c031b 100644 (file)
@@ -1,44 +1,82 @@
 //===- Transforms/Instrumentation.h - Instrumentation passes ----*- C++ -*-===//
-// 
+//
 //                     The LLVM Compiler Infrastructure
 //
-// This file was developed by the LLVM research group and is distributed under
-// the University of Illinois Open Source License. See LICENSE.TXT for details.
-// 
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
 //===----------------------------------------------------------------------===//
 //
-// This files defines constructor functions for instrumentation passes.
+// This file defines constructor functions for instrumentation passes.
 //
 //===----------------------------------------------------------------------===//
 
 #ifndef LLVM_TRANSFORMS_INSTRUMENTATION_H
 #define LLVM_TRANSFORMS_INSTRUMENTATION_H
 
+#include "llvm/ADT/StringRef.h"
+
 namespace llvm {
 
 class ModulePass;
 class FunctionPass;
 
-// Reoptimizer support pass: add instrumentation calls to back-edges of loops
-FunctionPass *createLoopInstrumentationPass ();
+// Insert edge profiling instrumentation
+ModulePass *createEdgeProfilerPass();
 
-// Reoptimizer support pass: combine multiple back-edges w/ same target into one
-FunctionPass *createCombineBranchesPass();
+// Insert optimal edge profiling instrumentation
+ModulePass *createOptimalEdgeProfilerPass();
 
-// Reoptimizer support pass: emit table of global functions
-ModulePass *createEmitFunctionTablePass ();
+// Insert path profiling instrumentation
+ModulePass *createPathProfilerPass();
 
+// Insert GCOV profiling instrumentation
+struct GCOVOptions {
+  static GCOVOptions getDefault();
 
-//===----------------------------------------------------------------------===//
-// Support for inserting LLVM code to print values at basic block and function
-// exits.
-//
+  // Specify whether to emit .gcno files.
+  bool EmitNotes;
+
+  // Specify whether to modify the program to emit .gcda files when run.
+  bool EmitData;
+
+  // A four-byte version string. The meaning of a version string is described in
+  // gcc's gcov-io.h
+  char Version[4];
+
+  // Emit a "cfg checksum" that follows the "line number checksum" of a
+  // function. This affects both .gcno and .gcda files.
+  bool UseCfgChecksum;
+
+  // Add the 'noredzone' attribute to added runtime library calls.
+  bool NoRedZone;
+
+  // Emit the name of the function in the .gcda files. This is redundant, as
+  // the function identifier can be used to find the name from the .gcno file.
+  bool FunctionNamesInData;
+};
+ModulePass *createGCOVProfilerPass(const GCOVOptions &Options =
+                                   GCOVOptions::getDefault());
+
+// Insert AddressSanitizer (address sanity checking) instrumentation
+FunctionPass *createAddressSanitizerFunctionPass(
+    bool CheckInitOrder = true, bool CheckUseAfterReturn = false,
+    bool CheckLifetime = false, StringRef BlacklistFile = StringRef(),
+    bool ZeroBaseShadow = false);
+ModulePass *createAddressSanitizerModulePass(
+    bool CheckInitOrder = true, StringRef BlacklistFile = StringRef(),
+    bool ZeroBaseShadow = false);
+
+// Insert MemorySanitizer instrumentation (detection of uninitialized reads)
+FunctionPass *createMemorySanitizerPass(bool TrackOrigins = false,
+                                        StringRef BlacklistFile = StringRef());
 
-// Just trace function entry/exit
-FunctionPass *createTraceValuesPassForBasicBlocks();
+// Insert ThreadSanitizer (race detection) instrumentation
+FunctionPass *createThreadSanitizerPass(StringRef BlacklistFile = StringRef());
 
-// Trace BB's and methods
-FunctionPass *createTraceValuesPassForFunction();
+// BoundsChecking - This pass instruments the code to perform run-time bounds
+// checking on loads, stores, and other memory intrinsics.
+FunctionPass *createBoundsCheckingPass();
 
 } // End llvm namespace