1 //===-- InstrumentationRuntime.h --------------------------------*- C++ -*-===//
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
7 //===----------------------------------------------------------------------===//
9 #ifndef LLDB_TARGET_INSTRUMENTATIONRUNTIME_H
10 #define LLDB_TARGET_INSTRUMENTATIONRUNTIME_H
15 #include "lldb/Core/PluginInterface.h"
16 #include "lldb/Utility/StructuredData.h"
17 #include "lldb/lldb-forward.h"
18 #include "lldb/lldb-private.h"
19 #include "lldb/lldb-types.h"
21 namespace lldb_private {
23 typedef std::map<lldb::InstrumentationRuntimeType,
24 lldb::InstrumentationRuntimeSP>
25 InstrumentationRuntimeCollection;
27 class InstrumentationRuntime
28 : public std::enable_shared_from_this<InstrumentationRuntime>,
29 public PluginInterface {
30 /// The instrumented process.
31 lldb::ProcessWP m_process_wp;
33 /// The module containing the instrumentation runtime.
34 lldb::ModuleSP m_runtime_module;
36 /// The breakpoint in the instrumentation runtime.
37 lldb::user_id_t m_breakpoint_id;
39 /// Indicates whether or not breakpoints have been registered in the
40 /// instrumentation runtime.
44 InstrumentationRuntime(const lldb::ProcessSP &process_sp)
45 : m_process_wp(), m_runtime_module(), m_breakpoint_id(0),
48 m_process_wp = process_sp;
51 lldb::ProcessSP GetProcessSP() { return m_process_wp.lock(); }
53 lldb::ModuleSP GetRuntimeModuleSP() { return m_runtime_module; }
55 void SetRuntimeModuleSP(lldb::ModuleSP module_sp) {
56 m_runtime_module = module_sp;
59 lldb::user_id_t GetBreakpointID() const { return m_breakpoint_id; }
61 void SetBreakpointID(lldb::user_id_t ID) { m_breakpoint_id = ID; }
63 void SetActive(bool IsActive) { m_is_active = IsActive; }
65 /// Return a regular expression which can be used to identify a valid version
66 /// of the runtime library.
67 virtual const RegularExpression &GetPatternForRuntimeLibrary() = 0;
69 /// Check whether \p module_sp corresponds to a valid runtime library.
70 virtual bool CheckIfRuntimeIsValid(const lldb::ModuleSP module_sp) = 0;
72 /// Register a breakpoint in the runtime library and perform any other
73 /// necessary initialization. The runtime library
74 /// is guaranteed to be loaded.
75 virtual void Activate() = 0;
78 static void ModulesDidLoad(lldb_private::ModuleList &module_list,
80 InstrumentationRuntimeCollection &runtimes);
82 /// Look for the instrumentation runtime in \p module_list. Register and
83 /// activate the runtime if this hasn't already
85 void ModulesDidLoad(lldb_private::ModuleList &module_list);
87 bool IsActive() const { return m_is_active; }
89 virtual lldb::ThreadCollectionSP
90 GetBacktracesFromExtendedStopInfo(StructuredData::ObjectSP info);
93 } // namespace lldb_private
95 #endif // LLDB_TARGET_INSTRUMENTATIONRUNTIME_H