LLVM  14.0.0git
SanitizerCoverage.h
Go to the documentation of this file.
1 //===--------- Definition of the SanitizerCoverage class --------*- C++ -*-===//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
6 // See https://llvm.org/LICENSE.txt for license information.
7 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
8 //
9 //===----------------------------------------------------------------------===//
10 //
11 // This file declares the SanitizerCoverage class which is a port of the legacy
12 // SanitizerCoverage pass to use the new PassManager infrastructure.
13 //
14 //===----------------------------------------------------------------------===//
15 
16 #ifndef LLVM_TRANSFORMS_INSTRUMENTATION_SANITIZERCOVERAGE_H
17 #define LLVM_TRANSFORMS_INSTRUMENTATION_SANITIZERCOVERAGE_H
18 
19 #include "llvm/IR/Module.h"
20 #include "llvm/IR/PassManager.h"
24 
25 namespace llvm {
26 
27 /// This is the ModuleSanitizerCoverage pass used in the new pass manager. The
28 /// pass instruments functions for coverage, adds initialization calls to the
29 /// module for trace PC guards and 8bit counters if they are requested, and
30 /// appends globals to llvm.compiler.used.
32  : public PassInfoMixin<ModuleSanitizerCoveragePass> {
33 public:
36  const std::vector<std::string> &AllowlistFiles =
37  std::vector<std::string>(),
38  const std::vector<std::string> &BlocklistFiles =
39  std::vector<std::string>())
40  : Options(Options) {
41  if (AllowlistFiles.size() > 0)
42  Allowlist = SpecialCaseList::createOrDie(AllowlistFiles,
44  if (BlocklistFiles.size() > 0)
45  Blocklist = SpecialCaseList::createOrDie(BlocklistFiles,
47  }
49  static bool isRequired() { return true; }
50 
51 private:
53 
54  std::unique_ptr<SpecialCaseList> Allowlist;
55  std::unique_ptr<SpecialCaseList> Blocklist;
56 };
57 
58 // Insert SanitizerCoverage instrumentation.
60  const SanitizerCoverageOptions &Options = SanitizerCoverageOptions(),
61  const std::vector<std::string> &AllowlistFiles = std::vector<std::string>(),
62  const std::vector<std::string> &BlocklistFiles =
63  std::vector<std::string>());
64 
65 } // namespace llvm
66 
67 #endif
llvm::PreservedAnalyses
A set of analyses that are preserved following a run of a transformation pass.
Definition: PassManager.h:155
Instrumentation.h
llvm
This is an optimization pass for GlobalISel generic memory operations.
Definition: AllocatorList.h:23
llvm::ModuleSanitizerCoveragePass
This is the ModuleSanitizerCoverage pass used in the new pass manager.
Definition: SanitizerCoverage.h:31
llvm::SanitizerCoverageOptions
Definition: Instrumentation.h:152
llvm::PassInfoMixin
A CRTP mix-in to automatically provide informational APIs needed for passes.
Definition: PassManager.h:374
Module.h
llvm::ModuleSanitizerCoveragePass::run
PreservedAnalyses run(Module &M, ModuleAnalysisManager &AM)
Definition: SanitizerCoverage.cpp:337
Options
const char LLVMTargetMachineRef LLVMPassBuilderOptionsRef Options
Definition: PassBuilderBindings.cpp:48
llvm::vfs::getRealFileSystem
IntrusiveRefCntPtr< FileSystem > getRealFileSystem()
Gets an vfs::FileSystem for the 'real' file system, as seen by the operating system.
Definition: VirtualFileSystem.cpp:354
llvm::SpecialCaseList::createOrDie
static std::unique_ptr< SpecialCaseList > createOrDie(const std::vector< std::string > &Paths, llvm::vfs::FileSystem &FS)
Parses the special case list entries from files.
Definition: SpecialCaseList.cpp:91
llvm::Module
A Module instance is used to store all the information related to an LLVM module.
Definition: Module.h:67
VirtualFileSystem.h
llvm::ModuleSanitizerCoveragePass::ModuleSanitizerCoveragePass
ModuleSanitizerCoveragePass(SanitizerCoverageOptions Options=SanitizerCoverageOptions(), const std::vector< std::string > &AllowlistFiles=std::vector< std::string >(), const std::vector< std::string > &BlocklistFiles=std::vector< std::string >())
Definition: SanitizerCoverage.h:34
PassManager.h
SpecialCaseList.h
llvm::ModuleSanitizerCoveragePass::isRequired
static bool isRequired()
Definition: SanitizerCoverage.h:49
llvm::AnalysisManager
A container for analyses that lazily runs them and caches their results.
Definition: InstructionSimplify.h:44
llvm::createModuleSanitizerCoverageLegacyPassPass
ModulePass * createModuleSanitizerCoverageLegacyPassPass(const SanitizerCoverageOptions &Options=SanitizerCoverageOptions(), const std::vector< std::string > &AllowlistFiles=std::vector< std::string >(), const std::vector< std::string > &BlocklistFiles=std::vector< std::string >())
Definition: SanitizerCoverage.cpp:1100