LLDB mainline
lldb-private-types.h
Go to the documentation of this file.
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
18namespace llvm {
19namespace sys {
20class DynamicLibrary;
21}
22}
23
24namespace lldb_private {
25class Platform;
26class ExecutionContext;
27class RegisterFlags;
28
29typedef 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.
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.
48 /// Default display format.
50 /// Holds all of the various register numbers for all register kinds.
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
71 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
75 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};
80static_assert(std::is_trivial<RegisterInfo>::value,
81 "RegisterInfo must be trivial.");
82
83/// Registers are grouped into register sets
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.
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.
101 SourceLanguage() = default;
102 SourceLanguage(lldb::LanguageType language_type);
103 SourceLanguage(uint16_t name, uint32_t version)
104 : name(name), version(version) {}
105 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; }
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
119 int64_t value;
120 const char *string_value;
121 const char *usage;
122};
123
124using OptionEnumValues = llvm::ArrayRef<OptionEnumValueElement>;
125
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
134typedef struct type128 { uint64_t x[2]; } type128;
135typedef 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.
141 std::function<lldb::ValueObjectSP(ConstString, StackFrame *)>;
142
143typedef void (*DebuggerDestroyCallback)(lldb::user_id_t debugger_id,
144 void *baton);
146 void *baton, const char **argv, lldb_private::CommandReturnObject &result);
147} // namespace lldb_private
148
149#endif // LLDB_LLDB_PRIVATE_TYPES_H
static llvm::raw_ostream & error(Stream &strm)
A uniqued constant string class.
Definition: ConstString.h:40
"lldb/Target/ExecutionContext.h" A class that contains an execution context.
A file utility class.
Definition: FileSpec.h:56
A plug-in interface definition class for debug platform that includes many platform abilities such as...
Definition: Platform.h:74
This base class provides an interface to stack frames.
Definition: StackFrame.h:43
An error handling class.
Definition: Status.h:44
A class that represents a running process on the host machine.
Definition: SBAttachInfo.h:14
void(* DebuggerDestroyCallback)(lldb::user_id_t debugger_id, void *baton)
std::function< lldb::ValueObjectSP(ConstString, StackFrame *)> ValueObjectProviderTy
Functor that returns a ValueObjectSP for a variable given its name and the StackFrame of interest.
bool(* CommandOverrideCallbackWithResult)(void *baton, const char **argv, lldb_private::CommandReturnObject &result)
llvm::sys::DynamicLibrary(* LoadPluginCallbackType)(const lldb::DebuggerSP &debugger_sp, const FileSpec &spec, Status &error)
llvm::ArrayRef< OptionEnumValueElement > OptionEnumValues
std::shared_ptr< lldb_private::ValueObject > ValueObjectSP
Definition: lldb-forward.h:472
Format
Display format definitions.
LanguageType
Programming language type.
std::shared_ptr< lldb_private::Debugger > DebuggerSP
Definition: lldb-forward.h:331
Encoding
Register encoding definitions.
uint64_t user_id_t
Definition: lldb-types.h:80
@ kNumRegisterKinds
Definition: Debugger.h:53
virtual ~OptionValidator()=default
virtual const char * LongConditionString() const =0
virtual const char * ShortConditionString() const =0
virtual bool IsValid(Platform &platform, const ExecutionContext &target) const =0
Every register is described in detail including its name, alternate name (optional),...
llvm::MutableArrayRef< uint8_t > mutable_data(uint8_t *context_base) const
lldb::Encoding encoding
Encoding of the register bits.
const char * alt_name
Alternate name of this register, can be NULL.
uint32_t * value_regs
List of registers (terminated with LLDB_INVALID_REGNUM).
uint32_t byte_offset
The byte offset in the register context data where this register's value is found.
uint32_t byte_size
Size in bytes of the register.
uint32_t kinds[lldb::kNumRegisterKinds]
Holds all of the various register numbers for all register kinds.
const RegisterFlags * flags_type
If not nullptr, a type defined by XML descriptions.
llvm::ArrayRef< uint8_t > data(const uint8_t *context_base) const
const char * name
Name of this register, can't be NULL.
lldb::Format format
Default display format.
uint32_t * invalidate_regs
List of registers (terminated with LLDB_INVALID_REGNUM).
Registers are grouped into register sets.
size_t num_registers
The number of registers in REGISTERS array below.
const uint32_t * registers
An array of register indices in this set.
const char * name
Name of this register set.
const char * short_name
A short name for this register set.
A type-erased pair of llvm::dwarf::SourceLanguageName and version.
lldb::LanguageType AsLanguageType() const
Definition: Language.cpp:546
SourceLanguage(std::optional< std::pair< uint16_t, uint32_t > > name_vers)
SourceLanguage(uint16_t name, uint32_t version)
llvm::StringRef GetDescription() const
Definition: Language.cpp:553