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__) && !defined(ANDROID)
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 GCOV profiling instrumentation
40 static GCOVOptions getDefault();
42 // Specify whether to emit .gcno files.
45 // Specify whether to modify the program to emit .gcda files when run.
48 // A four-byte version string. The meaning of a version string is described in
52 // Emit a "cfg checksum" that follows the "line number checksum" of a
53 // function. This affects both .gcno and .gcda files.
56 // Add the 'noredzone' attribute to added runtime library calls.
59 // Emit the name of the function in the .gcda files. This is redundant, as
60 // the function identifier can be used to find the name from the .gcno file.
61 bool FunctionNamesInData;
63 ModulePass *createGCOVProfilerPass(const GCOVOptions &Options =
64 GCOVOptions::getDefault());
66 // Insert AddressSanitizer (address sanity checking) instrumentation
67 FunctionPass *createAddressSanitizerFunctionPass(
68 bool CheckInitOrder = true, bool CheckUseAfterReturn = false,
69 bool CheckLifetime = false);
70 ModulePass *createAddressSanitizerModulePass(
71 bool CheckInitOrder = true, StringRef BlacklistFile = StringRef());
73 // Insert MemorySanitizer instrumentation (detection of uninitialized reads)
74 FunctionPass *createMemorySanitizerPass(int TrackOrigins = 0);
76 // Insert ThreadSanitizer (race detection) instrumentation
77 FunctionPass *createThreadSanitizerPass();
79 // Insert DataFlowSanitizer (dynamic data flow analysis) instrumentation
80 ModulePass *createDataFlowSanitizerPass(StringRef ABIListFile = StringRef(),
81 void *(*getArgTLS)() = nullptr,
82 void *(*getRetValTLS)() = nullptr);
84 #if defined(__GNUC__) && defined(__linux__) && !defined(ANDROID)
85 inline ModulePass *createDataFlowSanitizerPassForJIT(StringRef ABIListFile =
87 return createDataFlowSanitizerPass(ABIListFile, getDFSanArgTLSPtrForJIT,
88 getDFSanRetValTLSPtrForJIT);
92 // BoundsChecking - This pass instruments the code to perform run-time bounds
93 // checking on loads, stores, and other memory intrinsics.
94 FunctionPass *createBoundsCheckingPass();
96 /// createDebugIRPass - Enable interactive stepping through LLVM IR in LLDB (or
97 /// GDB) and generate a file with the LLVM IR to be
98 /// displayed in the debugger.
100 /// Existing debug metadata is preserved (but may be modified) in order to allow
101 /// accessing variables in the original source. The line table and file
102 /// information is modified to correspond to the lines in the LLVM IR. If
103 /// Filename and Directory are empty, a file name is generated based on existing
104 /// debug information. If no debug information is available, a temporary file
105 /// name is generated.
107 /// @param HideDebugIntrinsics Omit debug intrinsics in emitted IR source file.
108 /// @param HideDebugMetadata Omit debug metadata in emitted IR source file.
109 /// @param Directory Embed this directory in the debug information.
110 /// @param Filename Embed this file name in the debug information.
111 ModulePass *createDebugIRPass(bool HideDebugIntrinsics,
112 bool HideDebugMetadata,
113 StringRef Directory = StringRef(),
114 StringRef Filename = StringRef());
116 /// createDebugIRPass - Enable interactive stepping through LLVM IR in LLDB
117 /// (or GDB) with an existing IR file on disk. When creating
118 /// a DebugIR pass with this function, no source file is
119 /// output to disk and the existing one is unmodified. Debug
120 /// metadata in the Module is created/updated to point to
121 /// the existing textual IR file on disk.
122 /// NOTE: If the IR file to be debugged is not on disk, use the version of this
123 /// function with parameters in order to generate the file that will be
124 /// seen by the debugger.
125 ModulePass *createDebugIRPass();
127 } // End llvm namespace