1//===- Transforms/Instrumentation.h - Instrumentation passes ----*- C++ -*-===// 2// 3// The LLVM Compiler Infrastructure 4// 5// This file is distributed under the University of Illinois Open Source 6// License. See LICENSE.TXT for details. 7// 8//===----------------------------------------------------------------------===// 9// 10// This file defines constructor functions for instrumentation passes. 11// 12//===----------------------------------------------------------------------===// 13 14#ifndef LLVM_TRANSFORMS_INSTRUMENTATION_H 15#define LLVM_TRANSFORMS_INSTRUMENTATION_H 16 17#include "llvm/ADT/StringRef.h" 18 19#if defined(__GNUC__) && defined(__linux__) && !defined(ANDROID) 20inline void *getDFSanArgTLSPtrForJIT() { 21 extern __thread __attribute__((tls_model("initial-exec"))) 22 void *__dfsan_arg_tls; 23 return (void *)&__dfsan_arg_tls; 24} 25 26inline void *getDFSanRetValTLSPtrForJIT() { 27 extern __thread __attribute__((tls_model("initial-exec"))) 28 void *__dfsan_retval_tls; 29 return (void *)&__dfsan_retval_tls; 30} 31#endif 32 33namespace llvm { 34 35class ModulePass; 36class FunctionPass; 37 38// Insert GCOV profiling instrumentation 39struct GCOVOptions { 40 static GCOVOptions getDefault(); 41 42 // Specify whether to emit .gcno files. 43 bool EmitNotes; 44 45 // Specify whether to modify the program to emit .gcda files when run. 46 bool EmitData; 47 48 // A four-byte version string. The meaning of a version string is described in 49 // gcc's gcov-io.h 50 char Version[4]; 51 52 // Emit a "cfg checksum" that follows the "line number checksum" of a 53 // function. This affects both .gcno and .gcda files. 54 bool UseCfgChecksum; 55 56 // Add the 'noredzone' attribute to added runtime library calls. 57 bool NoRedZone; 58 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; 62}; 63ModulePass *createGCOVProfilerPass(const GCOVOptions &Options = 64 GCOVOptions::getDefault()); 65 66// Insert AddressSanitizer (address sanity checking) instrumentation 67FunctionPass *createAddressSanitizerFunctionPass(); 68ModulePass *createAddressSanitizerModulePass(); 69 70// Insert MemorySanitizer instrumentation (detection of uninitialized reads) 71FunctionPass *createMemorySanitizerPass(int TrackOrigins = 0); 72 73// Insert ThreadSanitizer (race detection) instrumentation 74FunctionPass *createThreadSanitizerPass(); 75 76// Insert DataFlowSanitizer (dynamic data flow analysis) instrumentation 77ModulePass *createDataFlowSanitizerPass(StringRef ABIListFile = StringRef(), 78 void *(*getArgTLS)() = nullptr, 79 void *(*getRetValTLS)() = nullptr); 80 81#if defined(__GNUC__) && defined(__linux__) && !defined(ANDROID) 82inline ModulePass *createDataFlowSanitizerPassForJIT(StringRef ABIListFile = 83 StringRef()) { 84 return createDataFlowSanitizerPass(ABIListFile, getDFSanArgTLSPtrForJIT, 85 getDFSanRetValTLSPtrForJIT); 86} 87#endif 88 89// BoundsChecking - This pass instruments the code to perform run-time bounds 90// checking on loads, stores, and other memory intrinsics. 91FunctionPass *createBoundsCheckingPass(); 92 93/// createDebugIRPass - Enable interactive stepping through LLVM IR in LLDB (or 94/// GDB) and generate a file with the LLVM IR to be 95/// displayed in the debugger. 96/// 97/// Existing debug metadata is preserved (but may be modified) in order to allow 98/// accessing variables in the original source. The line table and file 99/// information is modified to correspond to the lines in the LLVM IR. If 100/// Filename and Directory are empty, a file name is generated based on existing 101/// debug information. If no debug information is available, a temporary file 102/// name is generated. 103/// 104/// @param HideDebugIntrinsics Omit debug intrinsics in emitted IR source file. 105/// @param HideDebugMetadata Omit debug metadata in emitted IR source file. 106/// @param Directory Embed this directory in the debug information. 107/// @param Filename Embed this file name in the debug information. 108ModulePass *createDebugIRPass(bool HideDebugIntrinsics, 109 bool HideDebugMetadata, 110 StringRef Directory = StringRef(), 111 StringRef Filename = StringRef()); 112 113/// createDebugIRPass - Enable interactive stepping through LLVM IR in LLDB 114/// (or GDB) with an existing IR file on disk. When creating 115/// a DebugIR pass with this function, no source file is 116/// output to disk and the existing one is unmodified. Debug 117/// metadata in the Module is created/updated to point to 118/// the existing textual IR file on disk. 119/// NOTE: If the IR file to be debugged is not on disk, use the version of this 120/// function with parameters in order to generate the file that will be 121/// seen by the debugger. 122ModulePass *createDebugIRPass(); 123 124} // End llvm namespace 125 126#endif 127