LLDB mainline
OptionArgParser.cpp
Go to the documentation of this file.
1//===-- OptionArgParser.cpp -----------------------------------------------===//
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
11#include "lldb/Target/ABI.h"
12#include "lldb/Target/Target.h"
13#include "lldb/Utility/Status.h"
15
16using namespace lldb_private;
17using namespace lldb;
18
19bool OptionArgParser::ToBoolean(llvm::StringRef ref, bool fail_value,
20 bool *success_ptr) {
21 if (success_ptr)
22 *success_ptr = true;
23 ref = ref.trim();
24 if (ref.equals_insensitive("false") || ref.equals_insensitive("off") ||
25 ref.equals_insensitive("no") || ref.equals_insensitive("0")) {
26 return false;
27 } else if (ref.equals_insensitive("true") || ref.equals_insensitive("on") ||
28 ref.equals_insensitive("yes") || ref.equals_insensitive("1")) {
29 return true;
30 }
31 if (success_ptr)
32 *success_ptr = false;
33 return fail_value;
34}
35
36char OptionArgParser::ToChar(llvm::StringRef s, char fail_value,
37 bool *success_ptr) {
38 if (success_ptr)
39 *success_ptr = false;
40 if (s.size() != 1)
41 return fail_value;
42
43 if (success_ptr)
44 *success_ptr = true;
45 return s[0];
46}
47
48int64_t OptionArgParser::ToOptionEnum(llvm::StringRef s,
49 const OptionEnumValues &enum_values,
50 int32_t fail_value, Status &error) {
51 error.Clear();
52 if (enum_values.empty()) {
53 error.SetErrorString("invalid enumeration argument");
54 return fail_value;
55 }
56
57 if (s.empty()) {
58 error.SetErrorString("empty enumeration string");
59 return fail_value;
60 }
61
62 for (const auto &enum_value : enum_values) {
63 llvm::StringRef this_enum(enum_value.string_value);
64 if (this_enum.starts_with(s))
65 return enum_value.value;
66 }
67
68 StreamString strm;
69 strm.PutCString("invalid enumeration value, valid values are: ");
70 bool is_first = true;
71 for (const auto &enum_value : enum_values) {
72 strm.Printf("%s\"%s\"",
73 is_first ? is_first = false,"" : ", ", enum_value.string_value);
74 }
75 error.SetErrorString(strm.GetString());
76 return fail_value;
77}
78
80 size_t *byte_size_ptr) {
81 format = eFormatInvalid;
83
84 if (s && s[0]) {
85 if (byte_size_ptr) {
86 if (isdigit(s[0])) {
87 char *format_char = nullptr;
88 unsigned long byte_size = ::strtoul(s, &format_char, 0);
89 if (byte_size != ULONG_MAX)
90 *byte_size_ptr = byte_size;
91 s = format_char;
92 } else
93 *byte_size_ptr = 0;
94 }
95
97 StreamString error_strm;
98 error_strm.Printf(
99 "Invalid format character or name '%s'. Valid values are:\n", s);
100 for (Format f = eFormatDefault; f < kNumFormats; f = Format(f + 1)) {
101 char format_char = FormatManager::GetFormatAsFormatChar(f);
102 if (format_char)
103 error_strm.Printf("'%c' or ", format_char);
104
105 error_strm.Printf("\"%s\"", FormatManager::GetFormatAsCString(f));
106 error_strm.EOL();
107 }
108
109 if (byte_size_ptr)
110 error_strm.PutCString(
111 "An optional byte size can precede the format character.\n");
112 error.SetErrorString(error_strm.GetString());
113 }
114
115 if (error.Fail())
116 return error;
117 } else {
118 error.SetErrorStringWithFormat("%s option string", s ? "empty" : "invalid");
119 }
120 return error;
121}
122
124 llvm::StringRef s, lldb::ScriptLanguage fail_value, bool *success_ptr) {
125 if (success_ptr)
126 *success_ptr = true;
127
128 if (s.equals_insensitive("python"))
130 if (s.equals_insensitive("lua"))
131 return eScriptLanguageLua;
132 if (s.equals_insensitive("default"))
134 if (s.equals_insensitive("none"))
135 return eScriptLanguageNone;
136
137 if (success_ptr)
138 *success_ptr = false;
139 return fail_value;
140}
141
143 llvm::StringRef s,
144 lldb::addr_t fail_value,
145 Status *error_ptr) {
146 std::optional<lldb::addr_t> maybe_addr = DoToAddress(exe_ctx, s, error_ptr);
147 return maybe_addr ? *maybe_addr : fail_value;
148}
149
151 llvm::StringRef s,
152 lldb::addr_t fail_value,
153 Status *error_ptr) {
154 std::optional<lldb::addr_t> maybe_addr = DoToAddress(exe_ctx, s, error_ptr);
155 if (!maybe_addr)
156 return fail_value;
157
158 lldb::addr_t addr = *maybe_addr;
159
160 if (Process *process = exe_ctx->GetProcessPtr())
161 if (ABISP abi_sp = process->GetABI())
162 addr = abi_sp->FixCodeAddress(addr);
163
164 return addr;
165}
166
167std::optional<lldb::addr_t>
168OptionArgParser::DoToAddress(const ExecutionContext *exe_ctx, llvm::StringRef s,
169 Status *error_ptr) {
170 if (s.empty()) {
171 if (error_ptr)
172 error_ptr->SetErrorStringWithFormat("invalid address expression \"%s\"",
173 s.str().c_str());
174 return {};
175 }
176
177 llvm::StringRef sref = s;
178
180 if (!s.getAsInteger(0, addr)) {
181 if (error_ptr)
182 error_ptr->Clear();
183
184 return addr;
185 }
186
187 // Try base 16 with no prefix...
188 if (!s.getAsInteger(16, addr)) {
189 if (error_ptr)
190 error_ptr->Clear();
191 return addr;
192 }
193
194 Target *target = nullptr;
195 if (!exe_ctx || !(target = exe_ctx->GetTargetPtr())) {
196 if (error_ptr)
197 error_ptr->SetErrorStringWithFormat("invalid address expression \"%s\"",
198 s.str().c_str());
199 return {};
200 }
201
202 lldb::ValueObjectSP valobj_sp;
204 options.SetCoerceToId(false);
205 options.SetUnwindOnError(true);
206 options.SetKeepInMemory(false);
207 options.SetTryAllThreads(true);
208
209 ExpressionResults expr_result =
210 target->EvaluateExpression(s, exe_ctx->GetFramePtr(), valobj_sp, options);
211
212 bool success = false;
213 if (expr_result == eExpressionCompleted) {
214 if (valobj_sp)
215 valobj_sp = valobj_sp->GetQualifiedRepresentationIfAvailable(
216 valobj_sp->GetDynamicValueType(), true);
217 // Get the address to watch.
218 if (valobj_sp)
219 addr = valobj_sp->GetValueAsUnsigned(0, &success);
220 if (success) {
221 if (error_ptr)
222 error_ptr->Clear();
223 return addr;
224 }
225 if (error_ptr)
226 error_ptr->SetErrorStringWithFormat(
227 "address expression \"%s\" resulted in a value whose type "
228 "can't be converted to an address: %s",
229 s.str().c_str(), valobj_sp->GetTypeName().GetCString());
230 return {};
231 }
232
233 // Since the compiler can't handle things like "main + 12" we should try to
234 // do this for now. The compiler doesn't like adding offsets to function
235 // pointer types.
236 static RegularExpression g_symbol_plus_offset_regex(
237 "^(.*)([-\\+])[[:space:]]*(0x[0-9A-Fa-f]+|[0-9]+)[[:space:]]*$");
238
239 llvm::SmallVector<llvm::StringRef, 4> matches;
240 if (g_symbol_plus_offset_regex.Execute(sref, &matches)) {
241 uint64_t offset = 0;
242 llvm::StringRef name = matches[1];
243 llvm::StringRef sign = matches[2];
244 llvm::StringRef str_offset = matches[3];
245 if (!str_offset.getAsInteger(0, offset)) {
247 addr = ToAddress(exe_ctx, name, LLDB_INVALID_ADDRESS, &error);
248 if (addr != LLDB_INVALID_ADDRESS) {
249 if (sign[0] == '+')
250 return addr + offset;
251 return addr - offset;
252 }
253 }
254 }
255
256 if (error_ptr)
257 error_ptr->SetErrorStringWithFormat(
258 "address expression \"%s\" evaluation failed", s.str().c_str());
259 return {};
260}
static llvm::raw_ostream & error(Stream &strm)
void SetUnwindOnError(bool unwind=false)
Definition: Target.h:332
void SetKeepInMemory(bool keep=true)
Definition: Target.h:342
void SetCoerceToId(bool coerce=true)
Definition: Target.h:328
void SetTryAllThreads(bool try_others=true)
Definition: Target.h:365
"lldb/Target/ExecutionContext.h" A class that contains an execution context.
StackFrame * GetFramePtr() const
Returns a pointer to the frame object.
Target * GetTargetPtr() const
Returns a pointer to the target object.
Process * GetProcessPtr() const
Returns a pointer to the process object.
static const char * GetFormatAsCString(lldb::Format format)
static bool GetFormatFromCString(const char *format_cstr, lldb::Format &format)
static char GetFormatAsFormatChar(lldb::Format format)
A plug-in interface definition class for debugging a process.
Definition: Process.h:340
bool Execute(llvm::StringRef string, llvm::SmallVectorImpl< llvm::StringRef > *matches=nullptr) const
Execute a regular expression match using the compiled regular expression that is already in this obje...
An error handling class.
Definition: Status.h:44
void Clear()
Clear the object state.
Definition: Status.cpp:167
int SetErrorStringWithFormat(const char *format,...) __attribute__((format(printf
Set the current error string to a formatted error string.
Definition: Status.cpp:247
llvm::StringRef GetString() const
size_t Printf(const char *format,...) __attribute__((format(printf
Output printf formatted output to the stream.
Definition: Stream.cpp:134
size_t PutCString(llvm::StringRef cstr)
Output a C string to the stream.
Definition: Stream.cpp:65
size_t EOL()
Output and End of Line character to the stream.
Definition: Stream.cpp:155
lldb::ExpressionResults EvaluateExpression(llvm::StringRef expression, ExecutionContextScope *exe_scope, lldb::ValueObjectSP &result_valobj_sp, const EvaluateExpressionOptions &options=EvaluateExpressionOptions(), std::string *fixed_expression=nullptr, ValueObject *ctx_obj=nullptr)
Definition: Target.cpp:2654
#define LLDB_INVALID_ADDRESS
Definition: lldb-defines.h:82
A class that represents a running process on the host machine.
Definition: SBAttachInfo.h:14
llvm::ArrayRef< OptionEnumValueElement > OptionEnumValues
Definition: SBAddress.h:15
ScriptLanguage
Script interpreter types.
@ eScriptLanguageLua
@ eScriptLanguageDefault
@ eScriptLanguageNone
@ eScriptLanguagePython
std::shared_ptr< lldb_private::ABI > ABISP
Definition: lldb-forward.h:310
std::shared_ptr< lldb_private::ValueObject > ValueObjectSP
Definition: lldb-forward.h:472
Format
Display format definitions.
ExpressionResults
The results of expression evaluation.
@ eExpressionCompleted
uint64_t addr_t
Definition: lldb-types.h:79
static int64_t ToOptionEnum(llvm::StringRef s, const OptionEnumValues &enum_values, int32_t fail_value, Status &error)
static lldb::ScriptLanguage ToScriptLanguage(llvm::StringRef s, lldb::ScriptLanguage fail_value, bool *success_ptr)
static char ToChar(llvm::StringRef s, char fail_value, bool *success_ptr)
static lldb::addr_t ToAddress(const ExecutionContext *exe_ctx, llvm::StringRef s, lldb::addr_t fail_value, Status *error_ptr)
Try to parse an address.
static lldb::addr_t ToRawAddress(const ExecutionContext *exe_ctx, llvm::StringRef s, lldb::addr_t fail_value, Status *error_ptr)
As for ToAddress but do not remove non-address bits from the result.
static std::optional< lldb::addr_t > DoToAddress(const ExecutionContext *exe_ctx, llvm::StringRef s, Status *error)
static Status ToFormat(const char *s, lldb::Format &format, size_t *byte_size_ptr)
static bool ToBoolean(llvm::StringRef s, bool fail_value, bool *success_ptr)