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"
18 #include "llvm/IR/BasicBlock.h"
21 #if defined(__GNUC__) && defined(__linux__) && !defined(ANDROID)
22 inline void *getDFSanArgTLSPtrForJIT() {
23 extern __thread __attribute__((tls_model("initial-exec")))
24 void *__dfsan_arg_tls;
25 return (void *)&__dfsan_arg_tls;
28 inline void *getDFSanRetValTLSPtrForJIT() {
29 extern __thread __attribute__((tls_model("initial-exec")))
30 void *__dfsan_retval_tls;
31 return (void *)&__dfsan_retval_tls;
39 /// Instrumentation passes often insert conditional checks into entry blocks.
40 /// Call this function before splitting the entry block to move instructions
41 /// that must remain in the entry block up before the split point. Static
42 /// allocas and llvm.localescape calls, for example, must remain in the entry
44 BasicBlock::iterator PrepareToSplitEntryBlock(BasicBlock &BB,
45 BasicBlock::iterator IP);
50 // Insert GCOV profiling instrumentation
52 static GCOVOptions getDefault();
54 // Specify whether to emit .gcno files.
57 // Specify whether to modify the program to emit .gcda files when run.
60 // A four-byte version string. The meaning of a version string is described in
64 // Emit a "cfg checksum" that follows the "line number checksum" of a
65 // function. This affects both .gcno and .gcda files.
68 // Add the 'noredzone' attribute to added runtime library calls.
71 // Emit the name of the function in the .gcda files. This is redundant, as
72 // the function identifier can be used to find the name from the .gcno file.
73 bool FunctionNamesInData;
75 // Emit the exit block immediately after the start block, rather than after
76 // all of the function body's blocks.
77 bool ExitBlockBeforeBody;
79 ModulePass *createGCOVProfilerPass(const GCOVOptions &Options =
80 GCOVOptions::getDefault());
83 ModulePass *createPGOInstrumentationGenLegacyPass();
85 createPGOInstrumentationUseLegacyPass(StringRef Filename = StringRef(""));
86 ModulePass *createPGOIndirectCallPromotionLegacyPass(bool InLTO = false);
88 /// Options for the frontend instrumentation based profiling pass.
89 struct InstrProfOptions {
90 InstrProfOptions() : NoRedZone(false) {}
92 // Add the 'noredzone' attribute to added runtime library calls.
95 // Name of the profile file to use as output
96 std::string InstrProfileOutput;
99 /// Insert frontend instrumentation based profiling.
100 ModulePass *createInstrProfilingLegacyPass(
101 const InstrProfOptions &Options = InstrProfOptions());
103 // Insert AddressSanitizer (address sanity checking) instrumentation
104 FunctionPass *createAddressSanitizerFunctionPass(bool CompileKernel = false,
105 bool Recover = false,
106 bool UseAfterScope = false);
107 ModulePass *createAddressSanitizerModulePass(bool CompileKernel = false,
108 bool Recover = false);
110 // Insert MemorySanitizer instrumentation (detection of uninitialized reads)
111 FunctionPass *createMemorySanitizerPass(int TrackOrigins = 0,
112 bool Recover = false);
114 // Insert ThreadSanitizer (race detection) instrumentation
115 FunctionPass *createThreadSanitizerPass();
117 // Insert DataFlowSanitizer (dynamic data flow analysis) instrumentation
118 ModulePass *createDataFlowSanitizerPass(
119 const std::vector<std::string> &ABIListFiles = std::vector<std::string>(),
120 void *(*getArgTLS)() = nullptr, void *(*getRetValTLS)() = nullptr);
122 // Options for EfficiencySanitizer sub-tools.
123 struct EfficiencySanitizerOptions {
124 EfficiencySanitizerOptions() : ToolType(ESAN_None) {}
132 // Insert EfficiencySanitizer instrumentation.
133 ModulePass *createEfficiencySanitizerPass(
134 const EfficiencySanitizerOptions &Options = EfficiencySanitizerOptions());
136 // Options for sanitizer coverage instrumentation.
137 struct SanitizerCoverageOptions {
138 SanitizerCoverageOptions()
139 : CoverageType(SCK_None), IndirectCalls(false), TraceBB(false),
140 TraceCmp(false), TraceDiv(false), TraceGep(false),
141 Use8bitCounters(false), TracePC(false), TracePCGuard(false) {}
154 bool Use8bitCounters;
159 // Insert SanitizerCoverage instrumentation.
160 ModulePass *createSanitizerCoverageModulePass(
161 const SanitizerCoverageOptions &Options = SanitizerCoverageOptions());
163 #if defined(__GNUC__) && defined(__linux__) && !defined(ANDROID)
164 inline ModulePass *createDataFlowSanitizerPassForJIT(
165 const std::vector<std::string> &ABIListFiles = std::vector<std::string>()) {
166 return createDataFlowSanitizerPass(ABIListFiles, getDFSanArgTLSPtrForJIT,
167 getDFSanRetValTLSPtrForJIT);
171 // BoundsChecking - This pass instruments the code to perform run-time bounds
172 // checking on loads, stores, and other memory intrinsics.
173 FunctionPass *createBoundsCheckingPass();
175 /// \brief Calculate what to divide by to scale counts.
177 /// Given the maximum count, calculate a divisor that will scale all the
178 /// weights to strictly less than UINT32_MAX.
179 static inline uint64_t calculateCountScale(uint64_t MaxCount) {
180 return MaxCount < UINT32_MAX ? 1 : MaxCount / UINT32_MAX + 1;
183 /// \brief Scale an individual branch count.
185 /// Scale a 64-bit weight down to 32-bits using \c Scale.
187 static inline uint32_t scaleBranchCount(uint64_t Count, uint64_t Scale) {
188 uint64_t Scaled = Count / Scale;
189 assert(Scaled <= UINT32_MAX && "overflow 32-bits");
193 } // End llvm namespace