1 //===-- InstrumentationRuntimeASan.h ----------------------------*- 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 #ifndef LLDB_SOURCE_PLUGINS_INSTRUMENTATIONRUNTIME_ASAN_INSTRUMENTATIONRUNTIMEASAN_H
10 #define LLDB_SOURCE_PLUGINS_INSTRUMENTATIONRUNTIME_ASAN_INSTRUMENTATIONRUNTIMEASAN_H
11 
12 #include "lldb/Target/InstrumentationRuntime.h"
13 #include "lldb/Target/Process.h"
14 #include "lldb/Utility/StructuredData.h"
15 #include "lldb/lldb-private.h"
16 
17 namespace lldb_private {
18 
19 class InstrumentationRuntimeASan : public lldb_private::InstrumentationRuntime {
20 public:
21   ~InstrumentationRuntimeASan() override;
22 
23   static lldb::InstrumentationRuntimeSP
24   CreateInstance(const lldb::ProcessSP &process_sp);
25 
26   static void Initialize();
27 
28   static void Terminate();
29 
30   static llvm::StringRef GetPluginNameStatic() { return "AddressSanitizer"; }
31 
32   static lldb::InstrumentationRuntimeType GetTypeStatic();
33 
34   llvm::StringRef GetPluginName() override { return GetPluginNameStatic(); }
35 
36   virtual lldb::InstrumentationRuntimeType GetType() { return GetTypeStatic(); }
37 
38 private:
39   InstrumentationRuntimeASan(const lldb::ProcessSP &process_sp)
40       : lldb_private::InstrumentationRuntime(process_sp) {}
41 
42   const RegularExpression &GetPatternForRuntimeLibrary() override;
43 
44   bool CheckIfRuntimeIsValid(const lldb::ModuleSP module_sp) override;
45 
46   void Activate() override;
47 
48   void Deactivate();
49 
50   static bool NotifyBreakpointHit(void *baton,
51                                   StoppointCallbackContext *context,
52                                   lldb::user_id_t break_id,
53                                   lldb::user_id_t break_loc_id);
54 
55   StructuredData::ObjectSP RetrieveReportData();
56 
57   std::string FormatDescription(StructuredData::ObjectSP report);
58 };
59 
60 } // namespace lldb_private
61 
62 #endif // LLDB_SOURCE_PLUGINS_INSTRUMENTATIONRUNTIME_ASAN_INSTRUMENTATIONRUNTIMEASAN_H
63