LLDB mainline
NativeRegisterContext.cpp
Go to the documentation of this file.
1//===-- NativeRegisterContext.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
12
13#include "lldb/Host/PosixApi.h"
16
17using namespace lldb;
18using namespace lldb_private;
19
21 : m_thread(thread) {}
22
23// Destructor
25
26// FIXME revisit invalidation, process stop ids, etc. Right now we don't
27// support caching in NativeRegisterContext. We can do this later by utilizing
28// NativeProcessProtocol::GetStopID () and adding a stop id to
29// NativeRegisterContext.
30
31// void
32// NativeRegisterContext::InvalidateIfNeeded (bool force) {
33// ProcessSP process_sp (m_thread.GetProcess());
34// bool invalidate = force;
35// uint32_t process_stop_id = UINT32_MAX;
36
37// if (process_sp)
38// process_stop_id = process_sp->GetStopID();
39// else
40// invalidate = true;
41
42// if (!invalidate)
43// invalidate = process_stop_id != GetStopID();
44
45// if (invalidate)
46// {
47// InvalidateAllRegisters ();
48// SetStopID (process_stop_id);
49// }
50// }
51
52const RegisterInfo *
54 uint32_t start_idx) {
55 if (reg_name.empty())
56 return nullptr;
57
58 // Generic register names take precedence over specific register names.
59 // For example, on x86 we want "sp" to refer to the complete RSP/ESP register
60 // rather than the 16-bit SP pseudo-register.
61 uint32_t generic_reg = Args::StringToGenericRegister(reg_name);
62 if (generic_reg != LLDB_INVALID_REGNUM) {
63 const RegisterInfo *reg_info =
65 if (reg_info)
66 return reg_info;
67 }
68
69 const uint32_t num_registers = GetRegisterCount();
70 for (uint32_t reg = start_idx; reg < num_registers; ++reg) {
71 const RegisterInfo *reg_info = GetRegisterInfoAtIndex(reg);
72
73 if (reg_name.equals_insensitive(reg_info->name) ||
74 reg_name.equals_insensitive(reg_info->alt_name))
75 return reg_info;
76 }
77
78 return nullptr;
79}
80
82 uint32_t num) {
83 const uint32_t reg_num = ConvertRegisterKindToRegisterNumber(kind, num);
84 if (reg_num == LLDB_INVALID_REGNUM)
85 return nullptr;
86 return GetRegisterInfoAtIndex(reg_num);
87}
88
90 const RegisterInfo *reg_info = GetRegisterInfoAtIndex(reg);
91 if (reg_info)
92 return reg_info->name;
93 return nullptr;
94}
95
97 uint32_t reg_index) const {
98 const RegisterInfo *const reg_info = GetRegisterInfoAtIndex(reg_index);
99 if (!reg_info)
100 return nullptr;
101
102 for (uint32_t set_index = 0; set_index < GetRegisterSetCount(); ++set_index) {
103 const RegisterSet *const reg_set = GetRegisterSet(set_index);
104 if (!reg_set)
105 continue;
106
107 for (uint32_t reg_num_index = 0; reg_num_index < reg_set->num_registers;
108 ++reg_num_index) {
109 const uint32_t reg_num = reg_set->registers[reg_num_index];
110 // FIXME double check we're checking the right register kind here.
111 if (reg_info->kinds[RegisterKind::eRegisterKindLLDB] == reg_num) {
112 // The given register is a member of this register set. Return the
113 // register set name.
114 return reg_set->name;
115 }
116 }
117 }
118
119 // Didn't find it.
120 return nullptr;
121}
122
124 Log *log = GetLog(LLDBLog::Thread);
125
128 LLDB_LOGF(log,
129 "NativeRegisterContext::%s using reg index %" PRIu32
130 " (default %" PRIu64 ")",
131 __FUNCTION__, reg, fail_value);
132
133 const uint64_t retval = ReadRegisterAsUnsigned(reg, fail_value);
134
135 LLDB_LOGF(log, "NativeRegisterContext::%s " PRIu32 " retval %" PRIu64,
136 __FUNCTION__, retval);
137
138 return retval;
139}
140
143 return GetPC(fail_value);
144}
145
149 return WriteRegisterFromUnsigned(reg, pc);
150}
151
155 return ReadRegisterAsUnsigned(reg, fail_value);
156}
157
161 return WriteRegisterFromUnsigned(reg, sp);
162}
163
167 return ReadRegisterAsUnsigned(reg, fail_value);
168}
169
173 return WriteRegisterFromUnsigned(reg, fp);
174}
175
179 return ReadRegisterAsUnsigned(reg, fail_value);
180}
181
185 return ReadRegisterAsUnsigned(reg, fail_value);
186}
187
190 lldb::addr_t fail_value) {
191 if (reg != LLDB_INVALID_REGNUM)
192 return ReadRegisterAsUnsigned(GetRegisterInfoAtIndex(reg), fail_value);
193 return fail_value;
194}
195
196uint64_t
198 lldb::addr_t fail_value) {
199 Log *log = GetLog(LLDBLog::Thread);
200
201 if (reg_info) {
202 RegisterValue value;
203 Status error = ReadRegister(reg_info, value);
204 if (error.Success()) {
205 LLDB_LOGF(log,
206 "NativeRegisterContext::%s ReadRegister() succeeded, value "
207 "%" PRIu64,
208 __FUNCTION__, value.GetAsUInt64());
209 return value.GetAsUInt64();
210 } else {
211 LLDB_LOGF(log,
212 "NativeRegisterContext::%s ReadRegister() failed, error %s",
213 __FUNCTION__, error.AsCString());
214 }
215 } else {
216 LLDB_LOGF(log, "NativeRegisterContext::%s ReadRegister() null reg_info",
217 __FUNCTION__);
218 }
219 return fail_value;
220}
221
223 uint64_t uval) {
224 if (reg == LLDB_INVALID_REGNUM)
225 return Status("NativeRegisterContext::%s (): reg is invalid", __FUNCTION__);
227}
228
229Status
231 uint64_t uval) {
232 assert(reg_info);
233 if (!reg_info)
234 return Status("reg_info is nullptr");
235
236 RegisterValue value;
237 if (!value.SetUInt(uval, reg_info->byte_size))
238 return Status("RegisterValue::SetUInt () failed");
239
240 return WriteRegister(reg_info, value);
241}
242
244 return m_thread.GetID();
245}
246
248
250 size_t size) {
252}
253
255 return Status("not implemented");
256}
257
259 return false;
260}
261
263 lldb::addr_t trap_addr) {
264 bp_index = LLDB_INVALID_INDEX32;
265 return Status("not implemented");
266}
267
269
271 size_t size,
272 uint32_t watch_flags) {
274}
275
277 return false;
278}
279
281 return Status("not implemented");
282}
283
285 return Status("not implemented");
286}
287
289 is_hit = false;
290 return Status("not implemented");
291}
292
294 lldb::addr_t trap_addr) {
295 wp_index = LLDB_INVALID_INDEX32;
296 return Status("not implemented");
297}
298
300 bool &is_vacant) {
301 is_vacant = false;
302 return Status("not implemented");
303}
304
307}
308
311}
312
313bool NativeRegisterContext::HardwareSingleStep(bool enable) { return false; }
314
316 const RegisterInfo *reg_info, lldb::addr_t src_addr, size_t src_len,
317 RegisterValue &reg_value) {
319 if (reg_info == nullptr) {
320 error.SetErrorString("invalid register info argument.");
321 return error;
322 }
323
324 // Moving from addr into a register
325 //
326 // Case 1: src_len == dst_len
327 //
328 // |AABBCCDD| Address contents
329 // |AABBCCDD| Register contents
330 //
331 // Case 2: src_len > dst_len
332 //
333 // Status! (The register should always be big enough to hold the data)
334 //
335 // Case 3: src_len < dst_len
336 //
337 // |AABB| Address contents
338 // |AABB0000| Register contents [on little-endian hardware]
339 // |0000AABB| Register contents [on big-endian hardware]
341 error.SetErrorString("register too small to receive memory data");
342 return error;
343 }
344
345 const size_t dst_len = reg_info->byte_size;
346
347 if (src_len > dst_len) {
348 error.SetErrorStringWithFormat(
349 "%" PRIu64 " bytes is too big to store in register %s (%" PRIu64
350 " bytes)",
351 static_cast<uint64_t>(src_len), reg_info->name,
352 static_cast<uint64_t>(dst_len));
353 return error;
354 }
355
358
359 // Read the memory
360 size_t bytes_read;
361 error = process.ReadMemory(src_addr, src, src_len, bytes_read);
362 if (error.Fail())
363 return error;
364
365 // Make sure the memory read succeeded...
366 if (bytes_read != src_len) {
367 // This might happen if we read _some_ bytes but not all
368 error.SetErrorStringWithFormat("read %" PRIu64 " of %" PRIu64 " bytes",
369 static_cast<uint64_t>(bytes_read),
370 static_cast<uint64_t>(src_len));
371 return error;
372 }
373
374 // We now have a memory buffer that contains the part or all of the register
375 // value. Set the register value using this memory data.
376 // TODO: we might need to add a parameter to this function in case the byte
377 // order of the memory data doesn't match the process. For now we are
378 // assuming they are the same.
379 reg_value.SetFromMemoryData(*reg_info, src, src_len, process.GetByteOrder(),
380 error);
381
382 return error;
383}
384
386 const RegisterInfo *reg_info, lldb::addr_t dst_addr, size_t dst_len,
387 const RegisterValue &reg_value) {
389 if (reg_info == nullptr) {
390 error.SetErrorString("Invalid register info argument.");
391 return error;
392 }
393
396
397 // TODO: we might need to add a parameter to this function in case the byte
398 // order of the memory data doesn't match the process. For now we are
399 // assuming they are the same.
400 const size_t bytes_copied = reg_value.GetAsMemoryData(
401 *reg_info, dst, dst_len, process.GetByteOrder(), error);
402
403 if (error.Success()) {
404 if (bytes_copied == 0) {
405 error.SetErrorString("byte copy failed.");
406 } else {
407 size_t bytes_written;
408 error = process.WriteMemory(dst_addr, dst, bytes_copied, bytes_written);
409 if (error.Fail())
410 return error;
411
412 if (bytes_written != bytes_copied) {
413 // This might happen if we read _some_ bytes but not all
414 error.SetErrorStringWithFormat("only wrote %" PRIu64 " of %" PRIu64
415 " bytes",
416 static_cast<uint64_t>(bytes_written),
417 static_cast<uint64_t>(bytes_copied));
418 }
419 }
420 }
421
422 return error;
423}
424
427 uint32_t num) const {
428 const uint32_t num_regs = GetRegisterCount();
429
430 assert(kind < kNumRegisterKinds);
431 for (uint32_t reg_idx = 0; reg_idx < num_regs; ++reg_idx) {
432 const RegisterInfo *reg_info = GetRegisterInfoAtIndex(reg_idx);
433
434 if (reg_info->kinds[kind] == num)
435 return reg_idx;
436 }
437
438 return LLDB_INVALID_REGNUM;
439}
440
441std::vector<uint32_t>
443 if (expType == ExpeditedRegs::Minimal) {
444 // Expedite only a minimum set of important generic registers.
445 static const uint32_t k_expedited_registers[] = {
448
449 std::vector<uint32_t> expedited_reg_nums;
450 for (uint32_t gen_reg : k_expedited_registers) {
451 uint32_t reg_num =
453 if (reg_num == LLDB_INVALID_REGNUM)
454 continue; // Target does not support the given register.
455 else
456 expedited_reg_nums.push_back(reg_num);
457 }
458
459 return expedited_reg_nums;
460 }
461
462 if (GetRegisterSetCount() > 0 && expType == ExpeditedRegs::Full)
463 return std::vector<uint32_t>(GetRegisterSet(0)->registers,
464 GetRegisterSet(0)->registers +
465 GetRegisterSet(0)->num_registers);
466
467 return std::vector<uint32_t>();
468}
static llvm::raw_ostream & error(Stream &strm)
#define LLDB_LOGF(log,...)
Definition: Log.h:344
static uint32_t StringToGenericRegister(llvm::StringRef s)
Definition: Args.cpp:431
virtual Status ReadMemory(lldb::addr_t addr, void *buf, size_t size, size_t &bytes_read)=0
virtual Status WriteMemory(lldb::addr_t addr, const void *buf, size_t size, size_t &bytes_written)=0
virtual const RegisterSet * GetRegisterSet(uint32_t set_index) const =0
virtual bool ClearHardwareBreakpoint(uint32_t hw_idx)
virtual bool ClearHardwareWatchpoint(uint32_t hw_index)
uint32_t ConvertRegisterKindToRegisterNumber(uint32_t kind, uint32_t num) const
lldb::addr_t GetSP(lldb::addr_t fail_value=LLDB_INVALID_ADDRESS)
virtual Status ClearWatchpointHit(uint32_t hw_index)
lldb::addr_t GetFlags(lldb::addr_t fail_value=0)
virtual Status IsWatchpointHit(uint32_t wp_index, bool &is_hit)
lldb::addr_t GetFP(lldb::addr_t fail_value=LLDB_INVALID_ADDRESS)
lldb::addr_t ReadRegisterAsUnsigned(uint32_t reg, lldb::addr_t fail_value)
const RegisterInfo * GetRegisterInfo(uint32_t reg_kind, uint32_t reg_num)
virtual Status GetWatchpointHitIndex(uint32_t &wp_index, lldb::addr_t trap_addr)
const char * GetRegisterName(uint32_t reg)
Status WriteRegisterFromUnsigned(uint32_t reg, uint64_t uval)
virtual const RegisterInfo * GetRegisterInfoAtIndex(uint32_t reg) const =0
const char * GetRegisterSetNameForRegisterAtIndex(uint32_t reg_index) const
const RegisterInfo * GetRegisterInfoByName(llvm::StringRef reg_name, uint32_t start_idx=0)
virtual uint32_t GetRegisterCount() const =0
virtual bool HardwareSingleStep(bool enable)
virtual Status ReadRegisterValueFromMemory(const lldb_private::RegisterInfo *reg_info, lldb::addr_t src_addr, size_t src_len, RegisterValue &reg_value)
virtual Status ReadRegister(const RegisterInfo *reg_info, RegisterValue &reg_value)=0
virtual lldb::addr_t GetWatchpointAddress(uint32_t wp_index)
lldb::addr_t GetPC(lldb::addr_t fail_value=LLDB_INVALID_ADDRESS)
virtual lldb::addr_t GetWatchpointHitAddress(uint32_t wp_index)
NativeRegisterContext(NativeThreadProtocol &thread)
virtual std::vector< uint32_t > GetExpeditedRegisters(ExpeditedRegs expType) const
virtual Status IsWatchpointVacant(uint32_t wp_index, bool &is_vacant)
virtual lldb::addr_t GetPCfromBreakpointLocation(lldb::addr_t fail_value=LLDB_INVALID_ADDRESS)
virtual uint32_t SetHardwareWatchpoint(lldb::addr_t addr, size_t size, uint32_t watch_flags)
virtual Status WriteRegisterValueToMemory(const lldb_private::RegisterInfo *reg_info, lldb::addr_t dst_addr, size_t dst_len, const RegisterValue &reg_value)
lldb::addr_t GetReturnAddress(lldb::addr_t fail_value=LLDB_INVALID_ADDRESS)
virtual uint32_t GetRegisterSetCount() const =0
virtual Status GetHardwareBreakHitIndex(uint32_t &bp_index, lldb::addr_t trap_addr)
virtual uint32_t SetHardwareBreakpoint(lldb::addr_t addr, size_t size)
virtual Status WriteRegister(const RegisterInfo *reg_info, const RegisterValue &reg_value)=0
NativeProcessProtocol & GetProcess()
uint32_t SetFromMemoryData(const RegisterInfo &reg_info, const void *src, uint32_t src_len, lldb::ByteOrder src_byte_order, Status &error)
bool SetUInt(uint64_t uint, uint32_t byte_size)
uint32_t GetAsMemoryData(const RegisterInfo &reg_info, void *dst, uint32_t dst_len, lldb::ByteOrder dst_byte_order, Status &error) const
uint64_t GetAsUInt64(uint64_t fail_value=UINT64_MAX, bool *success_ptr=nullptr) const
An error handling class.
Definition: Status.h:44
#define LLDB_REGNUM_GENERIC_RA
Definition: lldb-defines.h:54
#define LLDB_INVALID_INDEX32
Definition: lldb-defines.h:75
#define LLDB_REGNUM_GENERIC_SP
Definition: lldb-defines.h:52
#define LLDB_REGNUM_GENERIC_FLAGS
Definition: lldb-defines.h:55
#define LLDB_INVALID_ADDRESS
Definition: lldb-defines.h:74
#define LLDB_INVALID_REGNUM
Definition: lldb-defines.h:79
#define LLDB_REGNUM_GENERIC_PC
Definition: lldb-defines.h:51
#define LLDB_REGNUM_GENERIC_FP
Definition: lldb-defines.h:53
A class that represents a running process on the host machine.
Definition: SBAttachInfo.h:14
Log * GetLog(Cat mask)
Retrieve the Log object for the channel associated with the given log enum.
Definition: Log.h:309
Definition: SBAddress.h:15
uint64_t addr_t
Definition: lldb-types.h:79
uint64_t tid_t
Definition: lldb-types.h:82
@ eRegisterKindGeneric
insn ptr reg, stack ptr reg, etc not specific to any particular target
@ kNumRegisterKinds