LLVM 20.0.0git
AddressSanitizer.h
Go to the documentation of this file.
1//===- AddressSanitizer.h - AddressSanitizer instrumentation ----*- C++ -*-===//
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 declares the AddressSanitizer class which is a port of the legacy
10// AddressSanitizer pass to use the new PassManager infrastructure.
11//
12//===----------------------------------------------------------------------===//
13#ifndef LLVM_TRANSFORMS_INSTRUMENTATION_ADDRESSSANITIZER_H
14#define LLVM_TRANSFORMS_INSTRUMENTATION_ADDRESSSANITIZER_H
15
16#include "llvm/IR/PassManager.h"
18
19namespace llvm {
20class Module;
21class raw_ostream;
22
24 bool CompileKernel = false;
25 bool Recover = false;
26 bool UseAfterScope = false;
31 bool InsertVersionCheck = true;
32};
33
34/// Public interface to the address sanitizer module pass for instrumenting code
35/// to check for various memory errors.
36///
37/// This adds 'asan.module_ctor' to 'llvm.global_ctors'. This pass may also
38/// run intependently of the function address sanitizer.
39class AddressSanitizerPass : public PassInfoMixin<AddressSanitizerPass> {
40public:
42 bool UseGlobalGC = true, bool UseOdrIndicator = true,
43 AsanDtorKind DestructorKind = AsanDtorKind::Global,
44 AsanCtorKind ConstructorKind = AsanCtorKind::Global);
47 function_ref<StringRef(StringRef)> MapClassName2PassName);
48 static bool isRequired() { return true; }
49
50private:
52 bool UseGlobalGC;
53 bool UseOdrIndicator;
54 AsanDtorKind DestructorKind;
55 AsanCtorKind ConstructorKind;
56};
57
59 const int32_t Packed;
60 const uint8_t AccessSizeIndex;
61 const bool IsWrite;
62 const bool CompileKernel;
63
64 explicit ASanAccessInfo(int32_t Packed);
66};
67
68} // namespace llvm
69
70#endif
Machine Check Debug Module
This header defines various interfaces for pass management in LLVM.
raw_pwrite_stream & OS
Public interface to the address sanitizer module pass for instrumenting code to check for various mem...
PreservedAnalyses run(Module &M, ModuleAnalysisManager &AM)
void printPipeline(raw_ostream &OS, function_ref< StringRef(StringRef)> MapClassName2PassName)
A container for analyses that lazily runs them and caches their results.
Definition: PassManager.h:253
A Module instance is used to store all the information related to an LLVM module.
Definition: Module.h:65
A set of analyses that are preserved following a run of a transformation pass.
Definition: Analysis.h:111
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:50
An efficient, type-erasing, non-owning reference to a callable.
This class implements an extremely fast bulk output stream that can only output to a stream.
Definition: raw_ostream.h:52
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
AsanDetectStackUseAfterReturnMode
Mode of ASan detect stack use after return.
@ Runtime
Detect stack use after return if not disabled runtime with (ASAN_OPTIONS=detect_stack_use_after_retur...
AsanDtorKind
Types of ASan module destructors supported.
@ Global
Append to llvm.global_dtors.
AsanCtorKind
Types of ASan module constructors supported.
const uint8_t AccessSizeIndex
AsanDetectStackUseAfterReturnMode UseAfterReturn
A CRTP mix-in to automatically provide informational APIs needed for passes.
Definition: PassManager.h:69