1 //===-- LanguageRuntime.h ---------------------------------------------------*- 2 // C++ -*-===// 3 // 4 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 5 // See https://llvm.org/LICENSE.txt for license information. 6 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 7 // 8 //===----------------------------------------------------------------------===// 9 10 #ifndef LLDB_TARGET_LANGUAGERUNTIME_H 11 #define LLDB_TARGET_LANGUAGERUNTIME_H 12 13 #include "lldb/Breakpoint/BreakpointResolver.h" 14 #include "lldb/Breakpoint/BreakpointResolverName.h" 15 #include "lldb/Core/PluginInterface.h" 16 #include "lldb/Core/Value.h" 17 #include "lldb/Core/ValueObject.h" 18 #include "lldb/Expression/LLVMUserExpression.h" 19 #include "lldb/Symbol/DeclVendor.h" 20 #include "lldb/Target/ExecutionContextScope.h" 21 #include "lldb/Target/Runtime.h" 22 #include "lldb/lldb-private.h" 23 #include "lldb/lldb-public.h" 24 #include <optional> 25 26 namespace lldb_private { 27 28 class ExceptionSearchFilter : public SearchFilter { 29 public: 30 ExceptionSearchFilter(const lldb::TargetSP &target_sp, 31 lldb::LanguageType language, 32 bool update_module_list = true); 33 34 ~ExceptionSearchFilter() override = default; 35 36 bool ModulePasses(const lldb::ModuleSP &module_sp) override; 37 38 bool ModulePasses(const FileSpec &spec) override; 39 40 void Search(Searcher &searcher) override; 41 42 void GetDescription(Stream *s) override; 43 44 static SearchFilter * 45 CreateFromStructuredData(Target &target, 46 const StructuredData::Dictionary &data_dict, 47 Status &error); 48 49 StructuredData::ObjectSP SerializeToStructuredData() override; 50 51 protected: 52 lldb::LanguageType m_language; 53 LanguageRuntime *m_language_runtime; 54 lldb::SearchFilterSP m_filter_sp; 55 56 lldb::SearchFilterSP DoCreateCopy() override; 57 58 void UpdateModuleListIfNeeded(); 59 }; 60 61 class LanguageRuntime : public Runtime, public PluginInterface { 62 public: 63 static LanguageRuntime *FindPlugin(Process *process, 64 lldb::LanguageType language); 65 66 static void InitializeCommands(CommandObject *parent); 67 68 virtual lldb::LanguageType GetLanguageType() const = 0; 69 70 virtual bool GetObjectDescription(Stream &str, ValueObject &object) = 0; 71 72 virtual bool GetObjectDescription(Stream &str, Value &value, 73 ExecutionContextScope *exe_scope) = 0; 74 75 // this call should return true if it could set the name and/or the type 76 virtual bool GetDynamicTypeAndAddress(ValueObject &in_value, 77 lldb::DynamicValueType use_dynamic, 78 TypeAndOrName &class_type_or_name, 79 Address &address, 80 Value::ValueType &value_type) = 0; 81 82 // This call should return a CompilerType given a generic type name and an 83 // ExecutionContextScope in which one can actually fetch any specialization 84 // information required. 85 virtual CompilerType GetConcreteType(ExecutionContextScope *exe_scope, 86 ConstString abstract_type_name) { 87 return CompilerType(); 88 } 89 90 // This should be a fast test to determine whether it is likely that this 91 // value would have a dynamic type. 92 virtual bool CouldHaveDynamicValue(ValueObject &in_value) = 0; 93 94 // The contract for GetDynamicTypeAndAddress() is to return a "bare-bones" 95 // dynamic type For instance, given a Base* pointer, 96 // GetDynamicTypeAndAddress() will return the type of Derived, not Derived*. 97 // The job of this API is to correct this misalignment between the static 98 // type and the discovered dynamic type 99 virtual TypeAndOrName FixUpDynamicType(const TypeAndOrName &type_and_or_name, 100 ValueObject &static_value) = 0; 101 102 virtual void SetExceptionBreakpoints() {} 103 104 virtual void ClearExceptionBreakpoints() {} 105 106 virtual bool ExceptionBreakpointsAreSet() { return false; } 107 108 virtual bool ExceptionBreakpointsExplainStop(lldb::StopInfoSP stop_reason) { 109 return false; 110 } 111 112 static lldb::BreakpointSP 113 CreateExceptionBreakpoint(Target &target, lldb::LanguageType language, 114 bool catch_bp, bool throw_bp, 115 bool is_internal = false); 116 117 static lldb::BreakpointPreconditionSP 118 GetExceptionPrecondition(lldb::LanguageType language, bool throw_bp); 119 120 virtual lldb::ValueObjectSP GetExceptionObjectForThread( 121 lldb::ThreadSP thread_sp) { 122 return lldb::ValueObjectSP(); 123 } 124 125 virtual lldb::ThreadSP GetBacktraceThreadFromException( 126 lldb::ValueObjectSP thread_sp) { 127 return lldb::ThreadSP(); 128 } 129 130 virtual DeclVendor *GetDeclVendor() { return nullptr; } 131 132 virtual lldb::BreakpointResolverSP 133 CreateExceptionResolver(const lldb::BreakpointSP &bkpt, 134 bool catch_bp, bool throw_bp) = 0; 135 136 virtual lldb::SearchFilterSP CreateExceptionSearchFilter() { 137 return m_process->GetTarget().GetSearchFilterForModule(nullptr); 138 } 139 140 virtual bool GetTypeBitSize(const CompilerType &compiler_type, 141 uint64_t &size) { 142 return false; 143 } 144 145 virtual void SymbolsDidLoad(const ModuleList &module_list) {} 146 147 virtual lldb::ThreadPlanSP GetStepThroughTrampolinePlan(Thread &thread, 148 bool stop_others) = 0; 149 150 /// Identify whether a name is a runtime value that should not be hidden by 151 /// from the user interface. 152 virtual bool IsAllowedRuntimeValue(ConstString name) { return false; } 153 154 virtual std::optional<CompilerType> GetRuntimeType(CompilerType base_type) { 155 return std::nullopt; 156 } 157 158 void ModulesDidLoad(const ModuleList &module_list) override {} 159 160 // Called by ClangExpressionParser::PrepareForExecution to query for any 161 // custom LLVM IR passes that need to be run before an expression is 162 // assembled and run. 163 virtual bool GetIRPasses(LLVMUserExpression::IRPasses &custom_passes) { 164 return false; 165 } 166 167 // Given the name of a runtime symbol (e.g. in Objective-C, an ivar offset 168 // symbol), try to determine from the runtime what the value of that symbol 169 // would be. Useful when the underlying binary is stripped. 170 virtual lldb::addr_t LookupRuntimeSymbol(ConstString name) { 171 return LLDB_INVALID_ADDRESS; 172 } 173 174 virtual bool isA(const void *ClassID) const { return ClassID == &ID; } 175 static char ID; 176 177 /// A language runtime may be able to provide a special UnwindPlan for 178 /// the frame represented by the register contents \a regctx when that 179 /// frame is not following the normal ABI conventions. 180 /// Instead of using the normal UnwindPlan for the function, we will use 181 /// this special UnwindPlan for this one backtrace. 182 /// One example of this would be a language that has asynchronous functions, 183 /// functions that may not be currently-executing, while waiting on other 184 /// asynchronous calls they made, but are part of a logical backtrace that 185 /// we want to show the developer because that's how they think of the 186 /// program flow. 187 /// 188 /// \param[in] thread 189 /// The thread that the unwind is happening on. 190 /// 191 /// \param[in] regctx 192 /// The RegisterContext for the frame we need to create an UnwindPlan. 193 /// We don't yet have a StackFrame when we're selecting the UnwindPlan. 194 /// 195 /// \param[out] behaves_like_zeroth_frame 196 /// With normal ABI calls, all stack frames except the zeroth frame need 197 /// to have the return-pc value backed up by 1 for symbolication purposes. 198 /// For these LanguageRuntime unwind plans, they may not follow normal ABI 199 /// calling conventions and the return pc may need to be symbolicated 200 /// as-is. 201 /// 202 /// \return 203 /// Returns an UnwindPlan to find the caller frame if it should be used, 204 /// instead of the UnwindPlan that would normally be used for this 205 /// function. 206 static lldb::UnwindPlanSP 207 GetRuntimeUnwindPlan(lldb_private::Thread &thread, 208 lldb_private::RegisterContext *regctx, 209 bool &behaves_like_zeroth_frame); 210 211 protected: 212 // The static GetRuntimeUnwindPlan method above is only implemented in the 213 // base class; subclasses may override this protected member if they can 214 // provide one of these UnwindPlans. 215 virtual lldb::UnwindPlanSP 216 GetRuntimeUnwindPlan(lldb::ProcessSP process_sp, 217 lldb_private::RegisterContext *regctx, 218 bool &behaves_like_zeroth_frame) { 219 return lldb::UnwindPlanSP(); 220 } 221 222 LanguageRuntime(Process *process); 223 }; 224 225 } // namespace lldb_private 226 227 #endif // LLDB_TARGET_LANGUAGERUNTIME_H 228