1 //===- Transforms/Instrumentation.h - Instrumentation passes ----*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines constructor functions for instrumentation passes.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_TRANSFORMS_INSTRUMENTATION_H
15 #define LLVM_TRANSFORMS_INSTRUMENTATION_H
17 #include "llvm/ADT/StringRef.h"
19 #if defined(__GNUC__) && defined(__linux__)
20 inline void *getDFSanArgTLSPtrForJIT() {
21 extern __thread __attribute__((tls_model("initial-exec")))
22 void *__dfsan_arg_tls;
23 return (void *)&__dfsan_arg_tls;
26 inline void *getDFSanRetValTLSPtrForJIT() {
27 extern __thread __attribute__((tls_model("initial-exec")))
28 void *__dfsan_retval_tls;
29 return (void *)&__dfsan_retval_tls;
38 // Insert edge profiling instrumentation
39 ModulePass *createEdgeProfilerPass();
41 // Insert optimal edge profiling instrumentation
42 ModulePass *createOptimalEdgeProfilerPass();
44 // Insert path profiling instrumentation
45 ModulePass *createPathProfilerPass();
47 // Insert GCOV profiling instrumentation
49 static GCOVOptions getDefault();
51 // Specify whether to emit .gcno files.
54 // Specify whether to modify the program to emit .gcda files when run.
57 // A four-byte version string. The meaning of a version string is described in
61 // Emit a "cfg checksum" that follows the "line number checksum" of a
62 // function. This affects both .gcno and .gcda files.
65 // Add the 'noredzone' attribute to added runtime library calls.
68 // Emit the name of the function in the .gcda files. This is redundant, as
69 // the function identifier can be used to find the name from the .gcno file.
70 bool FunctionNamesInData;
72 ModulePass *createGCOVProfilerPass(const GCOVOptions &Options =
73 GCOVOptions::getDefault());
75 // Insert AddressSanitizer (address sanity checking) instrumentation
76 FunctionPass *createAddressSanitizerFunctionPass(
77 bool CheckInitOrder = true, bool CheckUseAfterReturn = false,
78 bool CheckLifetime = false, StringRef BlacklistFile = StringRef(),
79 bool ZeroBaseShadow = false);
80 ModulePass *createAddressSanitizerModulePass(
81 bool CheckInitOrder = true, StringRef BlacklistFile = StringRef(),
82 bool ZeroBaseShadow = false);
84 // Insert MemorySanitizer instrumentation (detection of uninitialized reads)
85 FunctionPass *createMemorySanitizerPass(bool TrackOrigins = false,
86 StringRef BlacklistFile = StringRef());
88 // Insert ThreadSanitizer (race detection) instrumentation
89 FunctionPass *createThreadSanitizerPass(StringRef BlacklistFile = StringRef());
91 // Insert DataFlowSanitizer (dynamic data flow analysis) instrumentation
92 ModulePass *createDataFlowSanitizerPass(void *(*getArgTLS)() = 0,
93 void *(*getRetValTLS)() = 0);
96 inline ModulePass *createDataFlowSanitizerPassForJIT() {
97 return createDataFlowSanitizerPass(getDFSanArgTLSPtrForJIT,
98 getDFSanRetValTLSPtrForJIT);
102 // BoundsChecking - This pass instruments the code to perform run-time bounds
103 // checking on loads, stores, and other memory intrinsics.
104 FunctionPass *createBoundsCheckingPass();
106 /// createDebugIRPass - Enable interactive stepping through LLVM IR in LLDB (or
107 /// GDB) and generate a file with the LLVM IR to be
108 /// displayed in the debugger.
110 /// Existing debug metadata is preserved (but may be modified) in order to allow
111 /// accessing variables in the original source. The line table and file
112 /// information is modified to correspond to the lines in the LLVM IR. If
113 /// Filename and Directory are empty, a file name is generated based on existing
114 /// debug information. If no debug information is available, a temporary file
115 /// name is generated.
117 /// @param HideDebugIntrinsics Omit debug intrinsics in emitted IR source file.
118 /// @param HideDebugMetadata Omit debug metadata in emitted IR source file.
119 /// @param Directory Embed this directory in the debug information.
120 /// @param Filename Embed this file name in the debug information.
121 ModulePass *createDebugIRPass(bool HideDebugIntrinsics,
122 bool HideDebugMetadata,
123 StringRef Directory = StringRef(),
124 StringRef Filename = StringRef());
126 /// createDebugIRPass - Enable interactive stepping through LLVM IR in LLDB
127 /// (or GDB) with an existing IR file on disk. When creating
128 /// a DebugIR pass with this function, no source file is
129 /// output to disk and the existing one is unmodified. Debug
130 /// metadata in the Module is created/updated to point to
131 /// the existing textual IR file on disk.
132 /// NOTE: If the IR file to be debugged is not on disk, use the version of this
133 /// function with parameters in order to generate the file that will be
134 /// seen by the debugger.
135 ModulePass *createDebugIRPass();
137 } // End llvm namespace