1 //===-- lldb-private-types.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_LLDB_PRIVATE_TYPES_H 10 #define LLDB_LLDB_PRIVATE_TYPES_H 11 12 #include "lldb/lldb-private.h" 13 14 #include "llvm/ADT/ArrayRef.h" 15 16 #include <type_traits> 17 18 namespace llvm { 19 namespace sys { 20 class DynamicLibrary; 21 } 22 } 23 24 namespace lldb_private { 25 class Platform; 26 class ExecutionContext; 27 class RegisterFlags; 28 29 typedef llvm::sys::DynamicLibrary (*LoadPluginCallbackType)( 30 const lldb::DebuggerSP &debugger_sp, const FileSpec &spec, Status &error); 31 32 /// Every register is described in detail including its name, alternate name 33 /// (optional), encoding, size in bytes and the default display format. 34 struct RegisterInfo { 35 /// Name of this register, can't be NULL. 36 const char *name; 37 /// Alternate name of this register, can be NULL. 38 const char *alt_name; 39 /// Size in bytes of the register. 40 uint32_t byte_size; 41 /// The byte offset in the register context data where this register's 42 /// value is found. 43 /// This is optional, and can be 0 if a particular RegisterContext does not 44 /// need to address its registers by byte offset. 45 uint32_t byte_offset; 46 /// Encoding of the register bits. 47 lldb::Encoding encoding; 48 /// Default display format. 49 lldb::Format format; 50 /// Holds all of the various register numbers for all register kinds. 51 uint32_t kinds[lldb::kNumRegisterKinds]; // 52 /// List of registers (terminated with LLDB_INVALID_REGNUM). If this value is 53 /// not null, all registers in this list will be read first, at which point 54 /// the value for this register will be valid. For example, the value list 55 /// for ah would be eax (x86) or rax (x64). Register numbers are 56 /// of eRegisterKindLLDB. If multiple registers are listed, the final 57 /// value will be the concatenation of them. 58 uint32_t *value_regs; 59 /// List of registers (terminated with LLDB_INVALID_REGNUM). If this value is 60 /// not null, all registers in this list will be invalidated when the value of 61 /// this register changes. For example, the invalidate list for eax would be 62 /// rax ax, ah, and al. 63 uint32_t *invalidate_regs; 64 /// If not nullptr, a type defined by XML descriptions. 65 /// Register info tables are constructed as const, but this field may need to 66 /// be updated if a specific target OS has a different layout. To enable that, 67 /// this is mutable. The data pointed to is still const, so you must swap a 68 /// whole set of flags for another. 69 mutable const RegisterFlags *flags_type; 70 dataRegisterInfo71 llvm::ArrayRef<uint8_t> data(const uint8_t *context_base) const { 72 return llvm::ArrayRef<uint8_t>(context_base + byte_offset, byte_size); 73 } 74 mutable_dataRegisterInfo75 llvm::MutableArrayRef<uint8_t> mutable_data(uint8_t *context_base) const { 76 return llvm::MutableArrayRef<uint8_t>(context_base + byte_offset, 77 byte_size); 78 } 79 }; 80 static_assert(std::is_trivial<RegisterInfo>::value, 81 "RegisterInfo must be trivial."); 82 83 /// Registers are grouped into register sets 84 struct RegisterSet { 85 /// Name of this register set. 86 const char *name; 87 /// A short name for this register set. 88 const char *short_name; 89 /// The number of registers in REGISTERS array below. 90 size_t num_registers; 91 /// An array of register indices in this set. The values in this array are 92 /// *indices* (not register numbers) into a particular RegisterContext's 93 /// register array. For example, if eax is defined at index 4 for a 94 /// particular RegisterContext, eax would be included in this RegisterSet by 95 /// adding the value 4. Not by adding the value lldb_eax_i386. 96 const uint32_t *registers; 97 }; 98 99 /// A type-erased pair of llvm::dwarf::SourceLanguageName and version. 100 struct SourceLanguage { 101 SourceLanguage() = default; 102 SourceLanguage(lldb::LanguageType language_type); SourceLanguageSourceLanguage103 SourceLanguage(uint16_t name, uint32_t version) 104 : name(name), version(version) {} SourceLanguageSourceLanguage105 SourceLanguage(std::optional<std::pair<uint16_t, uint32_t>> name_vers) 106 : name(name_vers ? name_vers->first : 0), 107 version(name_vers ? name_vers->second : 0) {} 108 operator bool() const { return name > 0; } 109 lldb::LanguageType AsLanguageType() const; 110 llvm::StringRef GetDescription() const; 111 bool IsC() const; 112 bool IsObjC() const; 113 bool IsCPlusPlus() const; 114 uint16_t name = 0; 115 uint32_t version = 0; 116 }; 117 118 struct OptionEnumValueElement { 119 int64_t value; 120 const char *string_value; 121 const char *usage; 122 }; 123 124 using OptionEnumValues = llvm::ArrayRef<OptionEnumValueElement>; 125 126 struct OptionValidator { 127 virtual ~OptionValidator() = default; 128 virtual bool IsValid(Platform &platform, 129 const ExecutionContext &target) const = 0; 130 virtual const char *ShortConditionString() const = 0; 131 virtual const char *LongConditionString() const = 0; 132 }; 133 134 typedef struct type128 { uint64_t x[2]; } type128; 135 typedef struct type256 { uint64_t x[4]; } type256; 136 137 /// Functor that returns a ValueObjectSP for a variable given its name 138 /// and the StackFrame of interest. Used primarily in the Materializer 139 /// to refetch a ValueObject when the ExecutionContextScope changes. 140 using ValueObjectProviderTy = 141 std::function<lldb::ValueObjectSP(ConstString, StackFrame *)>; 142 143 typedef void (*DebuggerDestroyCallback)(lldb::user_id_t debugger_id, 144 void *baton); 145 typedef bool (*CommandOverrideCallbackWithResult)( 146 void *baton, const char **argv, lldb_private::CommandReturnObject &result); 147 } // namespace lldb_private 148 149 #endif // LLDB_LLDB_PRIVATE_TYPES_H 150