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