include/llvm/Transforms/Instrumentation/MemorySanitizer.h

   1 //===- Transforms/Instrumentation/MemorySanitizer.h - MSan Pass -----------===//
   2 //
   3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
   4 // See https://llvm.org/LICENSE.txt for license information.
   5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
   6 //
   7 //===----------------------------------------------------------------------===//
   8 //
   9 // This file defines the memoy sanitizer pass.
  10 //
  11 //===----------------------------------------------------------------------===//
  12
  13 #ifndef LLVM_TRANSFORMS_INSTRUMENTATION_MEMORYSANITIZER_H
  14 #define LLVM_TRANSFORMS_INSTRUMENTATION_MEMORYSANITIZER_H
  15
  16 #include "llvm/IR/PassManager.h"
  17 #include "llvm/Pass.h"
  18
  19 namespace llvm {
  20
  21 struct MemorySanitizerOptions {
  22   MemorySanitizerOptions() = default;
  23   MemorySanitizerOptions(int TrackOrigins, bool Recover, bool Kernel)
  24       : TrackOrigins(TrackOrigins), Recover(Recover), Kernel(Kernel) {}
  25   int TrackOrigins = 0;
  26   bool Recover = false;
  27   bool Kernel = false;
  28 };
  29
  30 // Insert MemorySanitizer instrumentation (detection of uninitialized reads)
  31 FunctionPass *
  32 createMemorySanitizerLegacyPassPass(MemorySanitizerOptions Options = {});
  33
  34 /// A function pass for msan instrumentation.
  35 ///
  36 /// Instruments functions to detect unitialized reads. This function pass
  37 /// inserts calls to runtime library functions. If the functions aren't declared
  38 /// yet, the pass inserts the declarations. Otherwise the existing globals are
  39 /// used.
  40 struct MemorySanitizerPass : public PassInfoMixin<MemorySanitizerPass> {
  41   MemorySanitizerPass(MemorySanitizerOptions Options) : Options(Options) {}
  42
  43   PreservedAnalyses run(Function &F, FunctionAnalysisManager &FAM);
  44
  45 private:
  46   MemorySanitizerOptions Options;
  47 };
  48 }
  49
  50 #endif /* LLVM_TRANSFORMS_INSTRUMENTATION_MEMORYSANITIZER_H */