1 //===-- GDBRemoteRegisterContext.cpp ----------------------------*- 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 #include "GDBRemoteRegisterContext.h"
10 
11 #include "lldb/Target/ExecutionContext.h"
12 #include "lldb/Target/Target.h"
13 #include "lldb/Utility/DataBufferHeap.h"
14 #include "lldb/Utility/DataExtractor.h"
15 #include "lldb/Utility/RegisterValue.h"
16 #include "lldb/Utility/Scalar.h"
17 #include "lldb/Utility/StreamString.h"
18 #include "ProcessGDBRemote.h"
19 #include "ProcessGDBRemoteLog.h"
20 #include "ThreadGDBRemote.h"
21 #include "Utility/ARM_DWARF_Registers.h"
22 #include "Utility/ARM_ehframe_Registers.h"
23 #include "lldb/Utility/StringExtractorGDBRemote.h"
24 
25 #include <memory>
26 
27 using namespace lldb;
28 using namespace lldb_private;
29 using namespace lldb_private::process_gdb_remote;
30 
31 // GDBRemoteRegisterContext constructor
32 GDBRemoteRegisterContext::GDBRemoteRegisterContext(
33     ThreadGDBRemote &thread, uint32_t concrete_frame_idx,
34     GDBRemoteDynamicRegisterInfo &reg_info, bool read_all_at_once,
35     bool write_all_at_once)
36     : RegisterContext(thread, concrete_frame_idx), m_reg_info(reg_info),
37       m_reg_valid(), m_reg_data(), m_read_all_at_once(read_all_at_once),
38       m_write_all_at_once(write_all_at_once) {
39   // Resize our vector of bools to contain one bool for every register. We will
40   // use these boolean values to know when a register value is valid in
41   // m_reg_data.
42   m_reg_valid.resize(reg_info.GetNumRegisters());
43 
44   // Make a heap based buffer that is big enough to store all registers
45   DataBufferSP reg_data_sp(
46       new DataBufferHeap(reg_info.GetRegisterDataByteSize(), 0));
47   m_reg_data.SetData(reg_data_sp);
48   m_reg_data.SetByteOrder(thread.GetProcess()->GetByteOrder());
49 }
50 
51 // Destructor
52 GDBRemoteRegisterContext::~GDBRemoteRegisterContext() {}
53 
54 void GDBRemoteRegisterContext::InvalidateAllRegisters() {
55   SetAllRegisterValid(false);
56 }
57 
58 void GDBRemoteRegisterContext::SetAllRegisterValid(bool b) {
59   std::vector<bool>::iterator pos, end = m_reg_valid.end();
60   for (pos = m_reg_valid.begin(); pos != end; ++pos)
61     *pos = b;
62 }
63 
64 size_t GDBRemoteRegisterContext::GetRegisterCount() {
65   return m_reg_info.GetNumRegisters();
66 }
67 
68 const RegisterInfo *
69 GDBRemoteRegisterContext::GetRegisterInfoAtIndex(size_t reg) {
70   RegisterInfo *reg_info = m_reg_info.GetRegisterInfoAtIndex(reg);
71 
72   if (reg_info && reg_info->dynamic_size_dwarf_expr_bytes) {
73     const ArchSpec &arch = m_thread.GetProcess()->GetTarget().GetArchitecture();
74     uint8_t reg_size = UpdateDynamicRegisterSize(arch, reg_info);
75     reg_info->byte_size = reg_size;
76   }
77   return reg_info;
78 }
79 
80 size_t GDBRemoteRegisterContext::GetRegisterSetCount() {
81   return m_reg_info.GetNumRegisterSets();
82 }
83 
84 const RegisterSet *GDBRemoteRegisterContext::GetRegisterSet(size_t reg_set) {
85   return m_reg_info.GetRegisterSet(reg_set);
86 }
87 
88 bool GDBRemoteRegisterContext::ReadRegister(const RegisterInfo *reg_info,
89                                             RegisterValue &value) {
90   // Read the register
91   if (ReadRegisterBytes(reg_info, m_reg_data)) {
92     const bool partial_data_ok = false;
93     Status error(value.SetValueFromData(
94         reg_info, m_reg_data, reg_info->byte_offset, partial_data_ok));
95     return error.Success();
96   }
97   return false;
98 }
99 
100 bool GDBRemoteRegisterContext::PrivateSetRegisterValue(
101     uint32_t reg, llvm::ArrayRef<uint8_t> data) {
102   const RegisterInfo *reg_info = GetRegisterInfoAtIndex(reg);
103   if (reg_info == nullptr)
104     return false;
105 
106   // Invalidate if needed
107   InvalidateIfNeeded(false);
108 
109   const size_t reg_byte_size = reg_info->byte_size;
110   memcpy(const_cast<uint8_t *>(
111              m_reg_data.PeekData(reg_info->byte_offset, reg_byte_size)),
112          data.data(), std::min(data.size(), reg_byte_size));
113   bool success = data.size() >= reg_byte_size;
114   if (success) {
115     SetRegisterIsValid(reg, true);
116   } else if (data.size() > 0) {
117     // Only set register is valid to false if we copied some bytes, else leave
118     // it as it was.
119     SetRegisterIsValid(reg, false);
120   }
121   return success;
122 }
123 
124 bool GDBRemoteRegisterContext::PrivateSetRegisterValue(uint32_t reg,
125                                                        uint64_t new_reg_val) {
126   const RegisterInfo *reg_info = GetRegisterInfoAtIndex(reg);
127   if (reg_info == nullptr)
128     return false;
129 
130   // Early in process startup, we can get a thread that has an invalid byte
131   // order because the process hasn't been completely set up yet (see the ctor
132   // where the byte order is setfrom the process).  If that's the case, we
133   // can't set the value here.
134   if (m_reg_data.GetByteOrder() == eByteOrderInvalid) {
135     return false;
136   }
137 
138   // Invalidate if needed
139   InvalidateIfNeeded(false);
140 
141   DataBufferSP buffer_sp(new DataBufferHeap(&new_reg_val, sizeof(new_reg_val)));
142   DataExtractor data(buffer_sp, endian::InlHostByteOrder(), sizeof(void *));
143 
144   // If our register context and our register info disagree, which should never
145   // happen, don't overwrite past the end of the buffer.
146   if (m_reg_data.GetByteSize() < reg_info->byte_offset + reg_info->byte_size)
147     return false;
148 
149   // Grab a pointer to where we are going to put this register
150   uint8_t *dst = const_cast<uint8_t *>(
151       m_reg_data.PeekData(reg_info->byte_offset, reg_info->byte_size));
152 
153   if (dst == nullptr)
154     return false;
155 
156   if (data.CopyByteOrderedData(0,                          // src offset
157                                reg_info->byte_size,        // src length
158                                dst,                        // dst
159                                reg_info->byte_size,        // dst length
160                                m_reg_data.GetByteOrder())) // dst byte order
161   {
162     SetRegisterIsValid(reg, true);
163     return true;
164   }
165   return false;
166 }
167 
168 // Helper function for GDBRemoteRegisterContext::ReadRegisterBytes().
169 bool GDBRemoteRegisterContext::GetPrimordialRegister(
170     const RegisterInfo *reg_info, GDBRemoteCommunicationClient &gdb_comm) {
171   const uint32_t lldb_reg = reg_info->kinds[eRegisterKindLLDB];
172   const uint32_t remote_reg = reg_info->kinds[eRegisterKindProcessPlugin];
173 
174   if (DataBufferSP buffer_sp =
175           gdb_comm.ReadRegister(m_thread.GetProtocolID(), remote_reg))
176     return PrivateSetRegisterValue(
177         lldb_reg, llvm::ArrayRef<uint8_t>(buffer_sp->GetBytes(),
178                                           buffer_sp->GetByteSize()));
179   return false;
180 }
181 
182 bool GDBRemoteRegisterContext::ReadRegisterBytes(const RegisterInfo *reg_info,
183                                                  DataExtractor &data) {
184   ExecutionContext exe_ctx(CalculateThread());
185 
186   Process *process = exe_ctx.GetProcessPtr();
187   Thread *thread = exe_ctx.GetThreadPtr();
188   if (process == nullptr || thread == nullptr)
189     return false;
190 
191   GDBRemoteCommunicationClient &gdb_comm(
192       ((ProcessGDBRemote *)process)->GetGDBRemote());
193 
194   InvalidateIfNeeded(false);
195 
196   const uint32_t reg = reg_info->kinds[eRegisterKindLLDB];
197 
198   if (!GetRegisterIsValid(reg)) {
199     if (m_read_all_at_once) {
200       if (DataBufferSP buffer_sp =
201               gdb_comm.ReadAllRegisters(m_thread.GetProtocolID())) {
202         memcpy(const_cast<uint8_t *>(m_reg_data.GetDataStart()),
203                buffer_sp->GetBytes(),
204                std::min(buffer_sp->GetByteSize(), m_reg_data.GetByteSize()));
205         if (buffer_sp->GetByteSize() >= m_reg_data.GetByteSize()) {
206           SetAllRegisterValid(true);
207           return true;
208         } else {
209           Log *log(ProcessGDBRemoteLog::GetLogIfAnyCategoryIsSet(GDBR_LOG_THREAD |
210                                                                 GDBR_LOG_PACKETS));
211           LLDB_LOGF(
212               log,
213               "error: GDBRemoteRegisterContext::ReadRegisterBytes tried "
214               "to read the "
215               "entire register context at once, expected at least %" PRId64
216               " bytes "
217               "but only got %" PRId64 " bytes.",
218               m_reg_data.GetByteSize(), buffer_sp->GetByteSize());
219         }
220       }
221       return false;
222     }
223     if (reg_info->value_regs) {
224       // Process this composite register request by delegating to the
225       // constituent primordial registers.
226 
227       // Index of the primordial register.
228       bool success = true;
229       for (uint32_t idx = 0; success; ++idx) {
230         const uint32_t prim_reg = reg_info->value_regs[idx];
231         if (prim_reg == LLDB_INVALID_REGNUM)
232           break;
233         // We have a valid primordial register as our constituent. Grab the
234         // corresponding register info.
235         const RegisterInfo *prim_reg_info = GetRegisterInfoAtIndex(prim_reg);
236         if (prim_reg_info == nullptr)
237           success = false;
238         else {
239           // Read the containing register if it hasn't already been read
240           if (!GetRegisterIsValid(prim_reg))
241             success = GetPrimordialRegister(prim_reg_info, gdb_comm);
242         }
243       }
244 
245       if (success) {
246         // If we reach this point, all primordial register requests have
247         // succeeded. Validate this composite register.
248         SetRegisterIsValid(reg_info, true);
249       }
250     } else {
251       // Get each register individually
252       GetPrimordialRegister(reg_info, gdb_comm);
253     }
254 
255     // Make sure we got a valid register value after reading it
256     if (!GetRegisterIsValid(reg))
257       return false;
258   }
259 
260   if (&data != &m_reg_data) {
261     assert(m_reg_data.GetByteSize() >=
262            reg_info->byte_offset + reg_info->byte_size);
263     // If our register context and our register info disagree, which should
264     // never happen, don't read past the end of the buffer.
265     if (m_reg_data.GetByteSize() < reg_info->byte_offset + reg_info->byte_size)
266       return false;
267 
268     // If we aren't extracting into our own buffer (which only happens when
269     // this function is called from ReadRegisterValue(uint32_t, Scalar&)) then
270     // we transfer bytes from our buffer into the data buffer that was passed
271     // in
272 
273     data.SetByteOrder(m_reg_data.GetByteOrder());
274     data.SetData(m_reg_data, reg_info->byte_offset, reg_info->byte_size);
275   }
276   return true;
277 }
278 
279 bool GDBRemoteRegisterContext::WriteRegister(const RegisterInfo *reg_info,
280                                              const RegisterValue &value) {
281   DataExtractor data;
282   if (value.GetData(data))
283     return WriteRegisterBytes(reg_info, data, 0);
284   return false;
285 }
286 
287 // Helper function for GDBRemoteRegisterContext::WriteRegisterBytes().
288 bool GDBRemoteRegisterContext::SetPrimordialRegister(
289     const RegisterInfo *reg_info, GDBRemoteCommunicationClient &gdb_comm) {
290   StreamString packet;
291   StringExtractorGDBRemote response;
292   const uint32_t reg = reg_info->kinds[eRegisterKindLLDB];
293   // Invalidate just this register
294   SetRegisterIsValid(reg, false);
295 
296   return gdb_comm.WriteRegister(
297       m_thread.GetProtocolID(), reg_info->kinds[eRegisterKindProcessPlugin],
298       {m_reg_data.PeekData(reg_info->byte_offset, reg_info->byte_size),
299        reg_info->byte_size});
300 }
301 
302 bool GDBRemoteRegisterContext::WriteRegisterBytes(const RegisterInfo *reg_info,
303                                                   DataExtractor &data,
304                                                   uint32_t data_offset) {
305   ExecutionContext exe_ctx(CalculateThread());
306 
307   Process *process = exe_ctx.GetProcessPtr();
308   Thread *thread = exe_ctx.GetThreadPtr();
309   if (process == nullptr || thread == nullptr)
310     return false;
311 
312   GDBRemoteCommunicationClient &gdb_comm(
313       ((ProcessGDBRemote *)process)->GetGDBRemote());
314 
315   assert(m_reg_data.GetByteSize() >=
316          reg_info->byte_offset + reg_info->byte_size);
317 
318   // If our register context and our register info disagree, which should never
319   // happen, don't overwrite past the end of the buffer.
320   if (m_reg_data.GetByteSize() < reg_info->byte_offset + reg_info->byte_size)
321     return false;
322 
323   // Grab a pointer to where we are going to put this register
324   uint8_t *dst = const_cast<uint8_t *>(
325       m_reg_data.PeekData(reg_info->byte_offset, reg_info->byte_size));
326 
327   if (dst == nullptr)
328     return false;
329 
330   if (data.CopyByteOrderedData(data_offset,                // src offset
331                                reg_info->byte_size,        // src length
332                                dst,                        // dst
333                                reg_info->byte_size,        // dst length
334                                m_reg_data.GetByteOrder())) // dst byte order
335   {
336     GDBRemoteClientBase::Lock lock(gdb_comm, false);
337     if (lock) {
338       if (m_write_all_at_once) {
339         // Invalidate all register values
340         InvalidateIfNeeded(true);
341 
342         // Set all registers in one packet
343         if (gdb_comm.WriteAllRegisters(
344                 m_thread.GetProtocolID(),
345                 {m_reg_data.GetDataStart(), size_t(m_reg_data.GetByteSize())}))
346 
347         {
348           SetAllRegisterValid(false);
349           return true;
350         }
351       } else {
352         bool success = true;
353 
354         if (reg_info->value_regs) {
355           // This register is part of another register. In this case we read
356           // the actual register data for any "value_regs", and once all that
357           // data is read, we will have enough data in our register context
358           // bytes for the value of this register
359 
360           // Invalidate this composite register first.
361 
362           for (uint32_t idx = 0; success; ++idx) {
363             const uint32_t reg = reg_info->value_regs[idx];
364             if (reg == LLDB_INVALID_REGNUM)
365               break;
366             // We have a valid primordial register as our constituent. Grab the
367             // corresponding register info.
368             const RegisterInfo *value_reg_info = GetRegisterInfoAtIndex(reg);
369             if (value_reg_info == nullptr)
370               success = false;
371             else
372               success = SetPrimordialRegister(value_reg_info, gdb_comm);
373           }
374         } else {
375           // This is an actual register, write it
376           success = SetPrimordialRegister(reg_info, gdb_comm);
377         }
378 
379         // Check if writing this register will invalidate any other register
380         // values? If so, invalidate them
381         if (reg_info->invalidate_regs) {
382           for (uint32_t idx = 0, reg = reg_info->invalidate_regs[0];
383                reg != LLDB_INVALID_REGNUM;
384                reg = reg_info->invalidate_regs[++idx]) {
385             SetRegisterIsValid(reg, false);
386           }
387         }
388 
389         return success;
390       }
391     } else {
392       Log *log(ProcessGDBRemoteLog::GetLogIfAnyCategoryIsSet(GDBR_LOG_THREAD |
393                                                              GDBR_LOG_PACKETS));
394       if (log) {
395         if (log->GetVerbose()) {
396           StreamString strm;
397           gdb_comm.DumpHistory(strm);
398           LLDB_LOGF(log,
399                     "error: failed to get packet sequence mutex, not sending "
400                     "write register for \"%s\":\n%s",
401                     reg_info->name, strm.GetData());
402         } else
403           LLDB_LOGF(log,
404                     "error: failed to get packet sequence mutex, not sending "
405                     "write register for \"%s\"",
406                     reg_info->name);
407       }
408     }
409   }
410   return false;
411 }
412 
413 bool GDBRemoteRegisterContext::ReadAllRegisterValues(
414     RegisterCheckpoint &reg_checkpoint) {
415   ExecutionContext exe_ctx(CalculateThread());
416 
417   Process *process = exe_ctx.GetProcessPtr();
418   Thread *thread = exe_ctx.GetThreadPtr();
419   if (process == nullptr || thread == nullptr)
420     return false;
421 
422   GDBRemoteCommunicationClient &gdb_comm(
423       ((ProcessGDBRemote *)process)->GetGDBRemote());
424 
425   uint32_t save_id = 0;
426   if (gdb_comm.SaveRegisterState(thread->GetProtocolID(), save_id)) {
427     reg_checkpoint.SetID(save_id);
428     reg_checkpoint.GetData().reset();
429     return true;
430   } else {
431     reg_checkpoint.SetID(0); // Invalid save ID is zero
432     return ReadAllRegisterValues(reg_checkpoint.GetData());
433   }
434 }
435 
436 bool GDBRemoteRegisterContext::WriteAllRegisterValues(
437     const RegisterCheckpoint &reg_checkpoint) {
438   uint32_t save_id = reg_checkpoint.GetID();
439   if (save_id != 0) {
440     ExecutionContext exe_ctx(CalculateThread());
441 
442     Process *process = exe_ctx.GetProcessPtr();
443     Thread *thread = exe_ctx.GetThreadPtr();
444     if (process == nullptr || thread == nullptr)
445       return false;
446 
447     GDBRemoteCommunicationClient &gdb_comm(
448         ((ProcessGDBRemote *)process)->GetGDBRemote());
449 
450     return gdb_comm.RestoreRegisterState(m_thread.GetProtocolID(), save_id);
451   } else {
452     return WriteAllRegisterValues(reg_checkpoint.GetData());
453   }
454 }
455 
456 bool GDBRemoteRegisterContext::ReadAllRegisterValues(
457     lldb::DataBufferSP &data_sp) {
458   ExecutionContext exe_ctx(CalculateThread());
459 
460   Process *process = exe_ctx.GetProcessPtr();
461   Thread *thread = exe_ctx.GetThreadPtr();
462   if (process == nullptr || thread == nullptr)
463     return false;
464 
465   GDBRemoteCommunicationClient &gdb_comm(
466       ((ProcessGDBRemote *)process)->GetGDBRemote());
467 
468   const bool use_g_packet =
469       !gdb_comm.AvoidGPackets((ProcessGDBRemote *)process);
470 
471   GDBRemoteClientBase::Lock lock(gdb_comm, false);
472   if (lock) {
473     if (gdb_comm.SyncThreadState(m_thread.GetProtocolID()))
474       InvalidateAllRegisters();
475 
476     if (use_g_packet &&
477         (data_sp = gdb_comm.ReadAllRegisters(m_thread.GetProtocolID())))
478       return true;
479 
480     // We're going to read each register
481     // individually and store them as binary data in a buffer.
482     const RegisterInfo *reg_info;
483 
484     for (uint32_t i = 0; (reg_info = GetRegisterInfoAtIndex(i)) != nullptr;
485          i++) {
486       if (reg_info
487               ->value_regs) // skip registers that are slices of real registers
488         continue;
489       ReadRegisterBytes(reg_info, m_reg_data);
490       // ReadRegisterBytes saves the contents of the register in to the
491       // m_reg_data buffer
492     }
493     data_sp = std::make_shared<DataBufferHeap>(
494         m_reg_data.GetDataStart(), m_reg_info.GetRegisterDataByteSize());
495     return true;
496   } else {
497 
498     Log *log(ProcessGDBRemoteLog::GetLogIfAnyCategoryIsSet(GDBR_LOG_THREAD |
499                                                            GDBR_LOG_PACKETS));
500     if (log) {
501       if (log->GetVerbose()) {
502         StreamString strm;
503         gdb_comm.DumpHistory(strm);
504         LLDB_LOGF(log,
505                   "error: failed to get packet sequence mutex, not sending "
506                   "read all registers:\n%s",
507                   strm.GetData());
508       } else
509         LLDB_LOGF(log,
510                   "error: failed to get packet sequence mutex, not sending "
511                   "read all registers");
512     }
513   }
514 
515   data_sp.reset();
516   return false;
517 }
518 
519 bool GDBRemoteRegisterContext::WriteAllRegisterValues(
520     const lldb::DataBufferSP &data_sp) {
521   if (!data_sp || data_sp->GetBytes() == nullptr || data_sp->GetByteSize() == 0)
522     return false;
523 
524   ExecutionContext exe_ctx(CalculateThread());
525 
526   Process *process = exe_ctx.GetProcessPtr();
527   Thread *thread = exe_ctx.GetThreadPtr();
528   if (process == nullptr || thread == nullptr)
529     return false;
530 
531   GDBRemoteCommunicationClient &gdb_comm(
532       ((ProcessGDBRemote *)process)->GetGDBRemote());
533 
534   const bool use_g_packet =
535       !gdb_comm.AvoidGPackets((ProcessGDBRemote *)process);
536 
537   GDBRemoteClientBase::Lock lock(gdb_comm, false);
538   if (lock) {
539     // The data_sp contains the G response packet.
540     if (use_g_packet) {
541       if (gdb_comm.WriteAllRegisters(
542               m_thread.GetProtocolID(),
543               {data_sp->GetBytes(), size_t(data_sp->GetByteSize())}))
544         return true;
545 
546       uint32_t num_restored = 0;
547       // We need to manually go through all of the registers and restore them
548       // manually
549       DataExtractor restore_data(data_sp, m_reg_data.GetByteOrder(),
550                                  m_reg_data.GetAddressByteSize());
551 
552       const RegisterInfo *reg_info;
553 
554       // The g packet contents may either include the slice registers
555       // (registers defined in terms of other registers, e.g. eax is a subset
556       // of rax) or not.  The slice registers should NOT be in the g packet,
557       // but some implementations may incorrectly include them.
558       //
559       // If the slice registers are included in the packet, we must step over
560       // the slice registers when parsing the packet -- relying on the
561       // RegisterInfo byte_offset field would be incorrect. If the slice
562       // registers are not included, then using the byte_offset values into the
563       // data buffer is the best way to find individual register values.
564 
565       uint64_t size_including_slice_registers = 0;
566       uint64_t size_not_including_slice_registers = 0;
567       uint64_t size_by_highest_offset = 0;
568 
569       for (uint32_t reg_idx = 0;
570            (reg_info = GetRegisterInfoAtIndex(reg_idx)) != nullptr; ++reg_idx) {
571         size_including_slice_registers += reg_info->byte_size;
572         if (reg_info->value_regs == nullptr)
573           size_not_including_slice_registers += reg_info->byte_size;
574         if (reg_info->byte_offset >= size_by_highest_offset)
575           size_by_highest_offset = reg_info->byte_offset + reg_info->byte_size;
576       }
577 
578       bool use_byte_offset_into_buffer;
579       if (size_by_highest_offset == restore_data.GetByteSize()) {
580         // The size of the packet agrees with the highest offset: + size in the
581         // register file
582         use_byte_offset_into_buffer = true;
583       } else if (size_not_including_slice_registers ==
584                  restore_data.GetByteSize()) {
585         // The size of the packet is the same as concatenating all of the
586         // registers sequentially, skipping the slice registers
587         use_byte_offset_into_buffer = true;
588       } else if (size_including_slice_registers == restore_data.GetByteSize()) {
589         // The slice registers are present in the packet (when they shouldn't
590         // be). Don't try to use the RegisterInfo byte_offset into the
591         // restore_data, it will point to the wrong place.
592         use_byte_offset_into_buffer = false;
593       } else {
594         // None of our expected sizes match the actual g packet data we're
595         // looking at. The most conservative approach here is to use the
596         // running total byte offset.
597         use_byte_offset_into_buffer = false;
598       }
599 
600       // In case our register definitions don't include the correct offsets,
601       // keep track of the size of each reg & compute offset based on that.
602       uint32_t running_byte_offset = 0;
603       for (uint32_t reg_idx = 0;
604            (reg_info = GetRegisterInfoAtIndex(reg_idx)) != nullptr;
605            ++reg_idx, running_byte_offset += reg_info->byte_size) {
606         // Skip composite aka slice registers (e.g. eax is a slice of rax).
607         if (reg_info->value_regs)
608           continue;
609 
610         const uint32_t reg = reg_info->kinds[eRegisterKindLLDB];
611 
612         uint32_t register_offset;
613         if (use_byte_offset_into_buffer) {
614           register_offset = reg_info->byte_offset;
615         } else {
616           register_offset = running_byte_offset;
617         }
618 
619         const uint32_t reg_byte_size = reg_info->byte_size;
620 
621         const uint8_t *restore_src =
622             restore_data.PeekData(register_offset, reg_byte_size);
623         if (restore_src) {
624           SetRegisterIsValid(reg, false);
625           if (gdb_comm.WriteRegister(
626                   m_thread.GetProtocolID(),
627                   reg_info->kinds[eRegisterKindProcessPlugin],
628                   {restore_src, reg_byte_size}))
629             ++num_restored;
630         }
631       }
632       return num_restored > 0;
633     } else {
634       // For the use_g_packet == false case, we're going to write each register
635       // individually.  The data buffer is binary data in this case, instead of
636       // ascii characters.
637 
638       bool arm64_debugserver = false;
639       if (m_thread.GetProcess().get()) {
640         const ArchSpec &arch =
641             m_thread.GetProcess()->GetTarget().GetArchitecture();
642         if (arch.IsValid() &&
643             (arch.GetMachine() == llvm::Triple::aarch64 ||
644              arch.GetMachine() == llvm::Triple::aarch64_32) &&
645             arch.GetTriple().getVendor() == llvm::Triple::Apple &&
646             arch.GetTriple().getOS() == llvm::Triple::IOS) {
647           arm64_debugserver = true;
648         }
649       }
650       uint32_t num_restored = 0;
651       const RegisterInfo *reg_info;
652       for (uint32_t i = 0; (reg_info = GetRegisterInfoAtIndex(i)) != nullptr;
653            i++) {
654         if (reg_info->value_regs) // skip registers that are slices of real
655                                   // registers
656           continue;
657         // Skip the fpsr and fpcr floating point status/control register
658         // writing to work around a bug in an older version of debugserver that
659         // would lead to register context corruption when writing fpsr/fpcr.
660         if (arm64_debugserver && (strcmp(reg_info->name, "fpsr") == 0 ||
661                                   strcmp(reg_info->name, "fpcr") == 0)) {
662           continue;
663         }
664 
665         SetRegisterIsValid(reg_info, false);
666         if (gdb_comm.WriteRegister(m_thread.GetProtocolID(),
667                                    reg_info->kinds[eRegisterKindProcessPlugin],
668                                    {data_sp->GetBytes() + reg_info->byte_offset,
669                                     reg_info->byte_size}))
670           ++num_restored;
671       }
672       return num_restored > 0;
673     }
674   } else {
675     Log *log(ProcessGDBRemoteLog::GetLogIfAnyCategoryIsSet(GDBR_LOG_THREAD |
676                                                            GDBR_LOG_PACKETS));
677     if (log) {
678       if (log->GetVerbose()) {
679         StreamString strm;
680         gdb_comm.DumpHistory(strm);
681         LLDB_LOGF(log,
682                   "error: failed to get packet sequence mutex, not sending "
683                   "write all registers:\n%s",
684                   strm.GetData());
685       } else
686         LLDB_LOGF(log,
687                   "error: failed to get packet sequence mutex, not sending "
688                   "write all registers");
689     }
690   }
691   return false;
692 }
693 
694 uint32_t GDBRemoteRegisterContext::ConvertRegisterKindToRegisterNumber(
695     lldb::RegisterKind kind, uint32_t num) {
696   return m_reg_info.ConvertRegisterKindToRegisterNumber(kind, num);
697 }
698 
699 void GDBRemoteDynamicRegisterInfo::HardcodeARMRegisters(bool from_scratch) {
700   // For Advanced SIMD and VFP register mapping.
701   static uint32_t g_d0_regs[] = {26, 27, LLDB_INVALID_REGNUM};  // (s0, s1)
702   static uint32_t g_d1_regs[] = {28, 29, LLDB_INVALID_REGNUM};  // (s2, s3)
703   static uint32_t g_d2_regs[] = {30, 31, LLDB_INVALID_REGNUM};  // (s4, s5)
704   static uint32_t g_d3_regs[] = {32, 33, LLDB_INVALID_REGNUM};  // (s6, s7)
705   static uint32_t g_d4_regs[] = {34, 35, LLDB_INVALID_REGNUM};  // (s8, s9)
706   static uint32_t g_d5_regs[] = {36, 37, LLDB_INVALID_REGNUM};  // (s10, s11)
707   static uint32_t g_d6_regs[] = {38, 39, LLDB_INVALID_REGNUM};  // (s12, s13)
708   static uint32_t g_d7_regs[] = {40, 41, LLDB_INVALID_REGNUM};  // (s14, s15)
709   static uint32_t g_d8_regs[] = {42, 43, LLDB_INVALID_REGNUM};  // (s16, s17)
710   static uint32_t g_d9_regs[] = {44, 45, LLDB_INVALID_REGNUM};  // (s18, s19)
711   static uint32_t g_d10_regs[] = {46, 47, LLDB_INVALID_REGNUM}; // (s20, s21)
712   static uint32_t g_d11_regs[] = {48, 49, LLDB_INVALID_REGNUM}; // (s22, s23)
713   static uint32_t g_d12_regs[] = {50, 51, LLDB_INVALID_REGNUM}; // (s24, s25)
714   static uint32_t g_d13_regs[] = {52, 53, LLDB_INVALID_REGNUM}; // (s26, s27)
715   static uint32_t g_d14_regs[] = {54, 55, LLDB_INVALID_REGNUM}; // (s28, s29)
716   static uint32_t g_d15_regs[] = {56, 57, LLDB_INVALID_REGNUM}; // (s30, s31)
717   static uint32_t g_q0_regs[] = {
718       26, 27, 28, 29, LLDB_INVALID_REGNUM}; // (d0, d1) -> (s0, s1, s2, s3)
719   static uint32_t g_q1_regs[] = {
720       30, 31, 32, 33, LLDB_INVALID_REGNUM}; // (d2, d3) -> (s4, s5, s6, s7)
721   static uint32_t g_q2_regs[] = {
722       34, 35, 36, 37, LLDB_INVALID_REGNUM}; // (d4, d5) -> (s8, s9, s10, s11)
723   static uint32_t g_q3_regs[] = {
724       38, 39, 40, 41, LLDB_INVALID_REGNUM}; // (d6, d7) -> (s12, s13, s14, s15)
725   static uint32_t g_q4_regs[] = {
726       42, 43, 44, 45, LLDB_INVALID_REGNUM}; // (d8, d9) -> (s16, s17, s18, s19)
727   static uint32_t g_q5_regs[] = {
728       46, 47, 48, 49,
729       LLDB_INVALID_REGNUM}; // (d10, d11) -> (s20, s21, s22, s23)
730   static uint32_t g_q6_regs[] = {
731       50, 51, 52, 53,
732       LLDB_INVALID_REGNUM}; // (d12, d13) -> (s24, s25, s26, s27)
733   static uint32_t g_q7_regs[] = {
734       54, 55, 56, 57,
735       LLDB_INVALID_REGNUM}; // (d14, d15) -> (s28, s29, s30, s31)
736   static uint32_t g_q8_regs[] = {59, 60, LLDB_INVALID_REGNUM};  // (d16, d17)
737   static uint32_t g_q9_regs[] = {61, 62, LLDB_INVALID_REGNUM};  // (d18, d19)
738   static uint32_t g_q10_regs[] = {63, 64, LLDB_INVALID_REGNUM}; // (d20, d21)
739   static uint32_t g_q11_regs[] = {65, 66, LLDB_INVALID_REGNUM}; // (d22, d23)
740   static uint32_t g_q12_regs[] = {67, 68, LLDB_INVALID_REGNUM}; // (d24, d25)
741   static uint32_t g_q13_regs[] = {69, 70, LLDB_INVALID_REGNUM}; // (d26, d27)
742   static uint32_t g_q14_regs[] = {71, 72, LLDB_INVALID_REGNUM}; // (d28, d29)
743   static uint32_t g_q15_regs[] = {73, 74, LLDB_INVALID_REGNUM}; // (d30, d31)
744 
745   // This is our array of composite registers, with each element coming from
746   // the above register mappings.
747   static uint32_t *g_composites[] = {
748       g_d0_regs,  g_d1_regs,  g_d2_regs,  g_d3_regs,  g_d4_regs,  g_d5_regs,
749       g_d6_regs,  g_d7_regs,  g_d8_regs,  g_d9_regs,  g_d10_regs, g_d11_regs,
750       g_d12_regs, g_d13_regs, g_d14_regs, g_d15_regs, g_q0_regs,  g_q1_regs,
751       g_q2_regs,  g_q3_regs,  g_q4_regs,  g_q5_regs,  g_q6_regs,  g_q7_regs,
752       g_q8_regs,  g_q9_regs,  g_q10_regs, g_q11_regs, g_q12_regs, g_q13_regs,
753       g_q14_regs, g_q15_regs};
754 
755   // clang-format off
756     static RegisterInfo g_register_infos[] = {
757 //   NAME     ALT     SZ   OFF  ENCODING          FORMAT          EH_FRAME             DWARF                GENERIC                 PROCESS PLUGIN  LLDB    VALUE REGS    INVALIDATE REGS SIZE EXPR SIZE LEN
758 //   ======   ======  ===  ===  =============     ==========      ===================  ===================  ======================  =============   ====    ==========    =============== ========= ========
759     { "r0",   "arg1",   4,   0, eEncodingUint,    eFormatHex,   { ehframe_r0,          dwarf_r0,            LLDB_REGNUM_GENERIC_ARG1,0,               0 },     nullptr,           nullptr,  nullptr,       0 },
760     { "r1",   "arg2",   4,   0, eEncodingUint,    eFormatHex,   { ehframe_r1,          dwarf_r1,            LLDB_REGNUM_GENERIC_ARG2,1,               1 },     nullptr,           nullptr,  nullptr,       0 },
761     { "r2",   "arg3",   4,   0, eEncodingUint,    eFormatHex,   { ehframe_r2,          dwarf_r2,            LLDB_REGNUM_GENERIC_ARG3,2,               2 },     nullptr,           nullptr,  nullptr,       0 },
762     { "r3",   "arg4",   4,   0, eEncodingUint,    eFormatHex,   { ehframe_r3,          dwarf_r3,            LLDB_REGNUM_GENERIC_ARG4,3,               3 },     nullptr,           nullptr,  nullptr,       0 },
763     { "r4",  nullptr,   4,   0, eEncodingUint,    eFormatHex,   { ehframe_r4,          dwarf_r4,            LLDB_INVALID_REGNUM,     4,               4 },     nullptr,           nullptr,  nullptr,       0 },
764     { "r5",  nullptr,   4,   0, eEncodingUint,    eFormatHex,   { ehframe_r5,          dwarf_r5,            LLDB_INVALID_REGNUM,     5,               5 },     nullptr,           nullptr,  nullptr,       0 },
765     { "r6",  nullptr,   4,   0, eEncodingUint,    eFormatHex,   { ehframe_r6,          dwarf_r6,            LLDB_INVALID_REGNUM,     6,               6 },     nullptr,           nullptr,  nullptr,       0 },
766     { "r7",     "fp",   4,   0, eEncodingUint,    eFormatHex,   { ehframe_r7,          dwarf_r7,            LLDB_REGNUM_GENERIC_FP,  7,               7 },     nullptr,           nullptr,  nullptr,       0 },
767     { "r8",  nullptr,   4,   0, eEncodingUint,    eFormatHex,   { ehframe_r8,          dwarf_r8,            LLDB_INVALID_REGNUM,     8,               8 },     nullptr,           nullptr,  nullptr,       0 },
768     { "r9",  nullptr,   4,   0, eEncodingUint,    eFormatHex,   { ehframe_r9,          dwarf_r9,            LLDB_INVALID_REGNUM,     9,               9 },     nullptr,           nullptr,  nullptr,       0 },
769     { "r10", nullptr,   4,   0, eEncodingUint,    eFormatHex,   { ehframe_r10,         dwarf_r10,           LLDB_INVALID_REGNUM,    10,              10 },     nullptr,           nullptr,  nullptr,       0 },
770     { "r11", nullptr,   4,   0, eEncodingUint,    eFormatHex,   { ehframe_r11,         dwarf_r11,           LLDB_INVALID_REGNUM,    11,              11 },     nullptr,           nullptr,  nullptr,       0 },
771     { "r12", nullptr,   4,   0, eEncodingUint,    eFormatHex,   { ehframe_r12,         dwarf_r12,           LLDB_INVALID_REGNUM,    12,              12 },     nullptr,           nullptr,  nullptr,       0 },
772     { "sp",     "r13",  4,   0, eEncodingUint,    eFormatHex,   { ehframe_sp,          dwarf_sp,            LLDB_REGNUM_GENERIC_SP, 13,              13 },     nullptr,           nullptr,  nullptr,       0 },
773     { "lr",     "r14",  4,   0, eEncodingUint,    eFormatHex,   { ehframe_lr,          dwarf_lr,            LLDB_REGNUM_GENERIC_RA, 14,              14 },     nullptr,           nullptr,  nullptr,       0 },
774     { "pc",     "r15",  4,   0, eEncodingUint,    eFormatHex,   { ehframe_pc,          dwarf_pc,            LLDB_REGNUM_GENERIC_PC, 15,              15 },     nullptr,           nullptr,  nullptr,       0 },
775     { "f0",  nullptr,  12,   0, eEncodingUint,    eFormatHex,   { LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM,    16,              16 },     nullptr,           nullptr,  nullptr,       0 },
776     { "f1",  nullptr,  12,   0, eEncodingUint,    eFormatHex,   { LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM,    17,              17 },     nullptr,           nullptr,  nullptr,       0 },
777     { "f2",  nullptr,  12,   0, eEncodingUint,    eFormatHex,   { LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM,    18,              18 },     nullptr,           nullptr,  nullptr,       0 },
778     { "f3",  nullptr,  12,   0, eEncodingUint,    eFormatHex,   { LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM,    19,              19 },     nullptr,           nullptr,  nullptr,       0 },
779     { "f4",  nullptr,  12,   0, eEncodingUint,    eFormatHex,   { LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM,    20,              20 },     nullptr,           nullptr,  nullptr,       0 },
780     { "f5",  nullptr,  12,   0, eEncodingUint,    eFormatHex,   { LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM,    21,              21 },     nullptr,           nullptr,  nullptr,       0 },
781     { "f6",  nullptr,  12,   0, eEncodingUint,    eFormatHex,   { LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM,    22,              22 },     nullptr,           nullptr,  nullptr,       0 },
782     { "f7",  nullptr,  12,   0, eEncodingUint,    eFormatHex,   { LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM,    23,              23 },     nullptr,           nullptr,  nullptr,       0 },
783     { "fps", nullptr,   4,   0, eEncodingUint,    eFormatHex,   { LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM,    24,              24 },     nullptr,           nullptr,  nullptr,       0 },
784     { "cpsr","flags",   4,   0, eEncodingUint,    eFormatHex,   { ehframe_cpsr,        dwarf_cpsr,          LLDB_INVALID_REGNUM,    25,              25 },     nullptr,           nullptr,  nullptr,       0 },
785     { "s0",  nullptr,   4,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_s0,            LLDB_INVALID_REGNUM,    26,              26 },     nullptr,           nullptr,  nullptr,       0 },
786     { "s1",  nullptr,   4,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_s1,            LLDB_INVALID_REGNUM,    27,              27 },     nullptr,           nullptr,  nullptr,       0 },
787     { "s2",  nullptr,   4,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_s2,            LLDB_INVALID_REGNUM,    28,              28 },     nullptr,           nullptr,  nullptr,       0 },
788     { "s3",  nullptr,   4,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_s3,            LLDB_INVALID_REGNUM,    29,              29 },     nullptr,           nullptr,  nullptr,       0 },
789     { "s4",  nullptr,   4,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_s4,            LLDB_INVALID_REGNUM,    30,              30 },     nullptr,           nullptr,  nullptr,       0 },
790     { "s5",  nullptr,   4,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_s5,            LLDB_INVALID_REGNUM,    31,              31 },     nullptr,           nullptr,  nullptr,       0 },
791     { "s6",  nullptr,   4,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_s6,            LLDB_INVALID_REGNUM,    32,              32 },     nullptr,           nullptr,  nullptr,       0 },
792     { "s7",  nullptr,   4,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_s7,            LLDB_INVALID_REGNUM,    33,              33 },     nullptr,           nullptr,  nullptr,       0 },
793     { "s8",  nullptr,   4,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_s8,            LLDB_INVALID_REGNUM,    34,              34 },     nullptr,           nullptr,  nullptr,       0 },
794     { "s9",  nullptr,   4,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_s9,            LLDB_INVALID_REGNUM,    35,              35 },     nullptr,           nullptr,  nullptr,       0 },
795     { "s10", nullptr,   4,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_s10,           LLDB_INVALID_REGNUM,    36,              36 },     nullptr,           nullptr,  nullptr,       0 },
796     { "s11", nullptr,   4,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_s11,           LLDB_INVALID_REGNUM,    37,              37 },     nullptr,           nullptr,  nullptr,       0 },
797     { "s12", nullptr,   4,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_s12,           LLDB_INVALID_REGNUM,    38,              38 },     nullptr,           nullptr,  nullptr,       0 },
798     { "s13", nullptr,   4,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_s13,           LLDB_INVALID_REGNUM,    39,              39 },     nullptr,           nullptr,  nullptr,       0 },
799     { "s14", nullptr,   4,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_s14,           LLDB_INVALID_REGNUM,    40,              40 },     nullptr,           nullptr,  nullptr,       0 },
800     { "s15", nullptr,   4,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_s15,           LLDB_INVALID_REGNUM,    41,              41 },     nullptr,           nullptr,  nullptr,       0 },
801     { "s16", nullptr,   4,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_s16,           LLDB_INVALID_REGNUM,    42,              42 },     nullptr,           nullptr,  nullptr,       0 },
802     { "s17", nullptr,   4,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_s17,           LLDB_INVALID_REGNUM,    43,              43 },     nullptr,           nullptr,  nullptr,       0 },
803     { "s18", nullptr,   4,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_s18,           LLDB_INVALID_REGNUM,    44,              44 },     nullptr,           nullptr,  nullptr,       0 },
804     { "s19", nullptr,   4,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_s19,           LLDB_INVALID_REGNUM,    45,              45 },     nullptr,           nullptr,  nullptr,       0 },
805     { "s20", nullptr,   4,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_s20,           LLDB_INVALID_REGNUM,    46,              46 },     nullptr,           nullptr,  nullptr,       0 },
806     { "s21", nullptr,   4,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_s21,           LLDB_INVALID_REGNUM,    47,              47 },     nullptr,           nullptr,  nullptr,       0 },
807     { "s22", nullptr,   4,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_s22,           LLDB_INVALID_REGNUM,    48,              48 },     nullptr,           nullptr,  nullptr,       0 },
808     { "s23", nullptr,   4,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_s23,           LLDB_INVALID_REGNUM,    49,              49 },     nullptr,           nullptr,  nullptr,       0 },
809     { "s24", nullptr,   4,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_s24,           LLDB_INVALID_REGNUM,    50,              50 },     nullptr,           nullptr,  nullptr,       0 },
810     { "s25", nullptr,   4,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_s25,           LLDB_INVALID_REGNUM,    51,              51 },     nullptr,           nullptr,  nullptr,       0 },
811     { "s26", nullptr,   4,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_s26,           LLDB_INVALID_REGNUM,    52,              52 },     nullptr,           nullptr,  nullptr,       0 },
812     { "s27", nullptr,   4,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_s27,           LLDB_INVALID_REGNUM,    53,              53 },     nullptr,           nullptr,  nullptr,       0 },
813     { "s28", nullptr,   4,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_s28,           LLDB_INVALID_REGNUM,    54,              54 },     nullptr,           nullptr,  nullptr,       0 },
814     { "s29", nullptr,   4,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_s29,           LLDB_INVALID_REGNUM,    55,              55 },     nullptr,           nullptr,  nullptr,       0 },
815     { "s30", nullptr,   4,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_s30,           LLDB_INVALID_REGNUM,    56,              56 },     nullptr,           nullptr,  nullptr,       0 },
816     { "s31", nullptr,   4,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_s31,           LLDB_INVALID_REGNUM,    57,              57 },     nullptr,           nullptr,  nullptr,       0 },
817     { "fpscr",nullptr,  4,   0, eEncodingUint,    eFormatHex,   { LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM,    58,              58 },     nullptr,           nullptr,  nullptr,       0 },
818     { "d16", nullptr,   8,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_d16,           LLDB_INVALID_REGNUM,    59,              59 },     nullptr,           nullptr,  nullptr,       0 },
819     { "d17", nullptr,   8,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_d17,           LLDB_INVALID_REGNUM,    60,              60 },     nullptr,           nullptr,  nullptr,       0 },
820     { "d18", nullptr,   8,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_d18,           LLDB_INVALID_REGNUM,    61,              61 },     nullptr,           nullptr,  nullptr,       0 },
821     { "d19", nullptr,   8,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_d19,           LLDB_INVALID_REGNUM,    62,              62 },     nullptr,           nullptr,  nullptr,       0 },
822     { "d20", nullptr,   8,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_d20,           LLDB_INVALID_REGNUM,    63,              63 },     nullptr,           nullptr,  nullptr,       0 },
823     { "d21", nullptr,   8,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_d21,           LLDB_INVALID_REGNUM,    64,              64 },     nullptr,           nullptr,  nullptr,       0 },
824     { "d22", nullptr,   8,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_d22,           LLDB_INVALID_REGNUM,    65,              65 },     nullptr,           nullptr,  nullptr,       0 },
825     { "d23", nullptr,   8,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_d23,           LLDB_INVALID_REGNUM,    66,              66 },     nullptr,           nullptr,  nullptr,       0 },
826     { "d24", nullptr,   8,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_d24,           LLDB_INVALID_REGNUM,    67,              67 },     nullptr,           nullptr,  nullptr,       0 },
827     { "d25", nullptr,   8,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_d25,           LLDB_INVALID_REGNUM,    68,              68 },     nullptr,           nullptr,  nullptr,       0 },
828     { "d26", nullptr,   8,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_d26,           LLDB_INVALID_REGNUM,    69,              69 },     nullptr,           nullptr,  nullptr,       0 },
829     { "d27", nullptr,   8,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_d27,           LLDB_INVALID_REGNUM,    70,              70 },     nullptr,           nullptr,  nullptr,       0 },
830     { "d28", nullptr,   8,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_d28,           LLDB_INVALID_REGNUM,    71,              71 },     nullptr,           nullptr,  nullptr,       0 },
831     { "d29", nullptr,   8,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_d29,           LLDB_INVALID_REGNUM,    72,              72 },     nullptr,           nullptr,  nullptr,       0 },
832     { "d30", nullptr,   8,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_d30,           LLDB_INVALID_REGNUM,    73,              73 },     nullptr,           nullptr,  nullptr,       0 },
833     { "d31", nullptr,   8,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_d31,           LLDB_INVALID_REGNUM,    74,              74 },     nullptr,           nullptr,  nullptr,       0 },
834     { "d0",  nullptr,   8,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_d0,            LLDB_INVALID_REGNUM,    75,              75 },   g_d0_regs,           nullptr,  nullptr,       0 },
835     { "d1",  nullptr,   8,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_d1,            LLDB_INVALID_REGNUM,    76,              76 },   g_d1_regs,           nullptr,  nullptr,       0 },
836     { "d2",  nullptr,   8,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_d2,            LLDB_INVALID_REGNUM,    77,              77 },   g_d2_regs,           nullptr,  nullptr,       0 },
837     { "d3",  nullptr,   8,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_d3,            LLDB_INVALID_REGNUM,    78,              78 },   g_d3_regs,           nullptr,  nullptr,       0 },
838     { "d4",  nullptr,   8,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_d4,            LLDB_INVALID_REGNUM,    79,              79 },   g_d4_regs,           nullptr,  nullptr,       0 },
839     { "d5",  nullptr,   8,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_d5,            LLDB_INVALID_REGNUM,    80,              80 },   g_d5_regs,           nullptr,  nullptr,       0 },
840     { "d6",  nullptr,   8,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_d6,            LLDB_INVALID_REGNUM,    81,              81 },   g_d6_regs,           nullptr,  nullptr,       0 },
841     { "d7",  nullptr,   8,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_d7,            LLDB_INVALID_REGNUM,    82,              82 },   g_d7_regs,           nullptr,  nullptr,       0 },
842     { "d8",  nullptr,   8,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_d8,            LLDB_INVALID_REGNUM,    83,              83 },   g_d8_regs,           nullptr,  nullptr,       0 },
843     { "d9",  nullptr,   8,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_d9,            LLDB_INVALID_REGNUM,    84,              84 },   g_d9_regs,           nullptr,  nullptr,       0 },
844     { "d10", nullptr,   8,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_d10,           LLDB_INVALID_REGNUM,    85,              85 },  g_d10_regs,           nullptr,  nullptr,       0 },
845     { "d11", nullptr,   8,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_d11,           LLDB_INVALID_REGNUM,    86,              86 },  g_d11_regs,           nullptr,  nullptr,       0 },
846     { "d12", nullptr,   8,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_d12,           LLDB_INVALID_REGNUM,    87,              87 },  g_d12_regs,           nullptr,  nullptr,       0 },
847     { "d13", nullptr,   8,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_d13,           LLDB_INVALID_REGNUM,    88,              88 },  g_d13_regs,           nullptr,  nullptr,       0 },
848     { "d14", nullptr,   8,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_d14,           LLDB_INVALID_REGNUM,    89,              89 },  g_d14_regs,           nullptr,  nullptr,       0 },
849     { "d15", nullptr,   8,   0, eEncodingIEEE754, eFormatFloat, { LLDB_INVALID_REGNUM, dwarf_d15,           LLDB_INVALID_REGNUM,    90,              90 },  g_d15_regs,           nullptr,  nullptr,       0 },
850     { "q0",  nullptr,   16,  0, eEncodingVector,  eFormatVectorOfUInt8, { LLDB_INVALID_REGNUM, dwarf_q0,    LLDB_INVALID_REGNUM,    91,              91 },   g_q0_regs,           nullptr,  nullptr,       0 },
851     { "q1",  nullptr,   16,  0, eEncodingVector,  eFormatVectorOfUInt8, { LLDB_INVALID_REGNUM, dwarf_q1,    LLDB_INVALID_REGNUM,    92,              92 },   g_q1_regs,           nullptr,  nullptr,       0 },
852     { "q2",  nullptr,   16,  0, eEncodingVector,  eFormatVectorOfUInt8, { LLDB_INVALID_REGNUM, dwarf_q2,    LLDB_INVALID_REGNUM,    93,              93 },   g_q2_regs,           nullptr,  nullptr,       0 },
853     { "q3",  nullptr,   16,  0, eEncodingVector,  eFormatVectorOfUInt8, { LLDB_INVALID_REGNUM, dwarf_q3,    LLDB_INVALID_REGNUM,    94,              94 },   g_q3_regs,           nullptr,  nullptr,       0 },
854     { "q4",  nullptr,   16,  0, eEncodingVector,  eFormatVectorOfUInt8, { LLDB_INVALID_REGNUM, dwarf_q4,    LLDB_INVALID_REGNUM,    95,              95 },   g_q4_regs,           nullptr,  nullptr,       0 },
855     { "q5",  nullptr,   16,  0, eEncodingVector,  eFormatVectorOfUInt8, { LLDB_INVALID_REGNUM, dwarf_q5,    LLDB_INVALID_REGNUM,    96,              96 },   g_q5_regs,           nullptr,  nullptr,       0 },
856     { "q6",  nullptr,   16,  0, eEncodingVector,  eFormatVectorOfUInt8, { LLDB_INVALID_REGNUM, dwarf_q6,    LLDB_INVALID_REGNUM,    97,              97 },   g_q6_regs,           nullptr,  nullptr,       0 },
857     { "q7",  nullptr,   16,  0, eEncodingVector,  eFormatVectorOfUInt8, { LLDB_INVALID_REGNUM, dwarf_q7,    LLDB_INVALID_REGNUM,    98,              98 },   g_q7_regs,           nullptr,  nullptr,       0 },
858     { "q8",  nullptr,   16,  0, eEncodingVector,  eFormatVectorOfUInt8, { LLDB_INVALID_REGNUM, dwarf_q8,    LLDB_INVALID_REGNUM,    99,              99 },   g_q8_regs,           nullptr,  nullptr,       0 },
859     { "q9",  nullptr,   16,  0, eEncodingVector,  eFormatVectorOfUInt8, { LLDB_INVALID_REGNUM, dwarf_q9,    LLDB_INVALID_REGNUM,   100,             100 },   g_q9_regs,           nullptr,  nullptr,       0 },
860     { "q10", nullptr,   16,  0, eEncodingVector,  eFormatVectorOfUInt8, { LLDB_INVALID_REGNUM, dwarf_q10,   LLDB_INVALID_REGNUM,   101,             101 },  g_q10_regs,           nullptr,  nullptr,       0 },
861     { "q11", nullptr,   16,  0, eEncodingVector,  eFormatVectorOfUInt8, { LLDB_INVALID_REGNUM, dwarf_q11,   LLDB_INVALID_REGNUM,   102,             102 },  g_q11_regs,           nullptr,  nullptr,       0 },
862     { "q12", nullptr,   16,  0, eEncodingVector,  eFormatVectorOfUInt8, { LLDB_INVALID_REGNUM, dwarf_q12,   LLDB_INVALID_REGNUM,   103,             103 },  g_q12_regs,           nullptr,  nullptr,       0 },
863     { "q13", nullptr,   16,  0, eEncodingVector,  eFormatVectorOfUInt8, { LLDB_INVALID_REGNUM, dwarf_q13,   LLDB_INVALID_REGNUM,   104,             104 },  g_q13_regs,           nullptr,  nullptr,       0 },
864     { "q14", nullptr,   16,  0, eEncodingVector,  eFormatVectorOfUInt8, { LLDB_INVALID_REGNUM, dwarf_q14,   LLDB_INVALID_REGNUM,   105,             105 },  g_q14_regs,           nullptr,  nullptr,       0 },
865     { "q15", nullptr,   16,  0, eEncodingVector,  eFormatVectorOfUInt8, { LLDB_INVALID_REGNUM, dwarf_q15,   LLDB_INVALID_REGNUM,   106,             106 },  g_q15_regs,           nullptr,  nullptr,       0 }
866     };
867   // clang-format on
868 
869   static const uint32_t num_registers = llvm::array_lengthof(g_register_infos);
870   static ConstString gpr_reg_set("General Purpose Registers");
871   static ConstString sfp_reg_set("Software Floating Point Registers");
872   static ConstString vfp_reg_set("Floating Point Registers");
873   size_t i;
874   if (from_scratch) {
875     // Calculate the offsets of the registers
876     // Note that the layout of the "composite" registers (d0-d15 and q0-q15)
877     // which comes after the "primordial" registers is important.  This enables
878     // us to calculate the offset of the composite register by using the offset
879     // of its first primordial register.  For example, to calculate the offset
880     // of q0, use s0's offset.
881     if (g_register_infos[2].byte_offset == 0) {
882       uint32_t byte_offset = 0;
883       for (i = 0; i < num_registers; ++i) {
884         // For primordial registers, increment the byte_offset by the byte_size
885         // to arrive at the byte_offset for the next register.  Otherwise, we
886         // have a composite register whose offset can be calculated by
887         // consulting the offset of its first primordial register.
888         if (!g_register_infos[i].value_regs) {
889           g_register_infos[i].byte_offset = byte_offset;
890           byte_offset += g_register_infos[i].byte_size;
891         } else {
892           const uint32_t first_primordial_reg =
893               g_register_infos[i].value_regs[0];
894           g_register_infos[i].byte_offset =
895               g_register_infos[first_primordial_reg].byte_offset;
896         }
897       }
898     }
899     for (i = 0; i < num_registers; ++i) {
900       ConstString name;
901       ConstString alt_name;
902       if (g_register_infos[i].name && g_register_infos[i].name[0])
903         name.SetCString(g_register_infos[i].name);
904       if (g_register_infos[i].alt_name && g_register_infos[i].alt_name[0])
905         alt_name.SetCString(g_register_infos[i].alt_name);
906 
907       if (i <= 15 || i == 25)
908         AddRegister(g_register_infos[i], name, alt_name, gpr_reg_set);
909       else if (i <= 24)
910         AddRegister(g_register_infos[i], name, alt_name, sfp_reg_set);
911       else
912         AddRegister(g_register_infos[i], name, alt_name, vfp_reg_set);
913     }
914   } else {
915     // Add composite registers to our primordial registers, then.
916     const size_t num_composites = llvm::array_lengthof(g_composites);
917     const size_t num_dynamic_regs = GetNumRegisters();
918     const size_t num_common_regs = num_registers - num_composites;
919     RegisterInfo *g_comp_register_infos = g_register_infos + num_common_regs;
920 
921     // First we need to validate that all registers that we already have match
922     // the non composite regs. If so, then we can add the registers, else we
923     // need to bail
924     bool match = true;
925     if (num_dynamic_regs == num_common_regs) {
926       for (i = 0; match && i < num_dynamic_regs; ++i) {
927         // Make sure all register names match
928         if (m_regs[i].name && g_register_infos[i].name) {
929           if (strcmp(m_regs[i].name, g_register_infos[i].name)) {
930             match = false;
931             break;
932           }
933         }
934 
935         // Make sure all register byte sizes match
936         if (m_regs[i].byte_size != g_register_infos[i].byte_size) {
937           match = false;
938           break;
939         }
940       }
941     } else {
942       // Wrong number of registers.
943       match = false;
944     }
945     // If "match" is true, then we can add extra registers.
946     if (match) {
947       for (i = 0; i < num_composites; ++i) {
948         ConstString name;
949         ConstString alt_name;
950         const uint32_t first_primordial_reg =
951             g_comp_register_infos[i].value_regs[0];
952         const char *reg_name = g_register_infos[first_primordial_reg].name;
953         if (reg_name && reg_name[0]) {
954           for (uint32_t j = 0; j < num_dynamic_regs; ++j) {
955             const RegisterInfo *reg_info = GetRegisterInfoAtIndex(j);
956             // Find a matching primordial register info entry.
957             if (reg_info && reg_info->name &&
958                 ::strcasecmp(reg_info->name, reg_name) == 0) {
959               // The name matches the existing primordial entry. Find and
960               // assign the offset, and then add this composite register entry.
961               g_comp_register_infos[i].byte_offset = reg_info->byte_offset;
962               name.SetCString(g_comp_register_infos[i].name);
963               AddRegister(g_comp_register_infos[i], name, alt_name,
964                           vfp_reg_set);
965             }
966           }
967         }
968       }
969     }
970   }
971 }
972