1 //===-- DynamicRegisterInfo.cpp -------------------------------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #include "lldb/Target/DynamicRegisterInfo.h"
10 #include "lldb/Core/StreamFile.h"
11 #include "lldb/DataFormatters/FormatManager.h"
12 #include "lldb/Interpreter/OptionArgParser.h"
13 #include "lldb/Utility/ArchSpec.h"
14 #include "lldb/Utility/Log.h"
15 #include "lldb/Utility/RegularExpression.h"
16 #include "lldb/Utility/StringExtractor.h"
17 #include "lldb/Utility/StructuredData.h"
18 
19 using namespace lldb;
20 using namespace lldb_private;
21 
22 DynamicRegisterInfo::DynamicRegisterInfo(
23     const lldb_private::StructuredData::Dictionary &dict,
24     const lldb_private::ArchSpec &arch) {
25   SetRegisterInfo(dict, arch);
26 }
27 
28 DynamicRegisterInfo::DynamicRegisterInfo(DynamicRegisterInfo &&info) {
29   MoveFrom(std::move(info));
30 }
31 
32 DynamicRegisterInfo &
33 DynamicRegisterInfo::operator=(DynamicRegisterInfo &&info) {
34   MoveFrom(std::move(info));
35   return *this;
36 }
37 
38 void DynamicRegisterInfo::MoveFrom(DynamicRegisterInfo &&info) {
39   m_regs = std::move(info.m_regs);
40   m_sets = std::move(info.m_sets);
41   m_set_reg_nums = std::move(info.m_set_reg_nums);
42   m_set_names = std::move(info.m_set_names);
43   m_value_regs_map = std::move(info.m_value_regs_map);
44   m_invalidate_regs_map = std::move(info.m_invalidate_regs_map);
45 
46   m_reg_data_byte_size = info.m_reg_data_byte_size;
47   m_finalized = info.m_finalized;
48 
49   if (m_finalized) {
50     const size_t num_sets = m_sets.size();
51     for (size_t set = 0; set < num_sets; ++set)
52       m_sets[set].registers = m_set_reg_nums[set].data();
53   }
54 
55   info.Clear();
56 }
57 
58 llvm::Expected<uint32_t> DynamicRegisterInfo::ByteOffsetFromSlice(
59     uint32_t index, llvm::StringRef slice_str, lldb::ByteOrder byte_order) {
60   // Slices use the following format:
61   //  REGNAME[MSBIT:LSBIT]
62   // REGNAME - name of the register to grab a slice of
63   // MSBIT - the most significant bit at which the current register value
64   // starts at
65   // LSBIT - the least significant bit at which the current register value
66   // ends at
67   static llvm::Regex g_bitfield_regex(
68       "([A-Za-z_][A-Za-z0-9_]*)\\[([0-9]+):([0-9]+)\\]");
69   llvm::SmallVector<llvm::StringRef, 4> matches;
70   if (!g_bitfield_regex.match(slice_str, &matches))
71     return llvm::createStringError(
72         llvm::inconvertibleErrorCode(),
73         "failed to match against register bitfield regex (slice: %s)",
74         slice_str.str().c_str());
75 
76   llvm::StringRef reg_name_str = matches[1];
77   llvm::StringRef msbit_str = matches[2];
78   llvm::StringRef lsbit_str = matches[3];
79   uint32_t msbit;
80   uint32_t lsbit;
81   if (!llvm::to_integer(msbit_str, msbit) ||
82       !llvm::to_integer(lsbit_str, lsbit))
83     return llvm::createStringError(
84         llvm::inconvertibleErrorCode(), "msbit (%s) or lsbit (%s) are invalid",
85         msbit_str.str().c_str(), lsbit_str.str().c_str());
86 
87   if (msbit <= lsbit)
88     return llvm::createStringError(llvm::inconvertibleErrorCode(),
89                                    "msbit (%u) must be greater than lsbit (%u)",
90                                    msbit, lsbit);
91 
92   const uint32_t msbyte = msbit / 8;
93   const uint32_t lsbyte = lsbit / 8;
94 
95   const RegisterInfo *containing_reg_info = GetRegisterInfo(reg_name_str);
96   if (!containing_reg_info)
97     return llvm::createStringError(llvm::inconvertibleErrorCode(),
98                                    "invalid concrete register \"%s\"",
99                                    reg_name_str.str().c_str());
100 
101   const uint32_t max_bit = containing_reg_info->byte_size * 8;
102 
103   if (msbit > max_bit)
104     return llvm::createStringError(
105         llvm::inconvertibleErrorCode(),
106         "msbit (%u) must be less than the bitsize of the register \"%s\" (%u)",
107         msbit, reg_name_str.str().c_str(), max_bit);
108   if (lsbit > max_bit)
109     return llvm::createStringError(
110         llvm::inconvertibleErrorCode(),
111         "lsbit (%u) must be less than the bitsize of the register \"%s\" (%u)",
112         lsbit, reg_name_str.str().c_str(), max_bit);
113 
114   m_invalidate_regs_map[containing_reg_info->kinds[eRegisterKindLLDB]]
115       .push_back(index);
116   m_value_regs_map[index].push_back(
117       containing_reg_info->kinds[eRegisterKindLLDB]);
118   m_invalidate_regs_map[index].push_back(
119       containing_reg_info->kinds[eRegisterKindLLDB]);
120 
121   if (byte_order == eByteOrderLittle)
122     return containing_reg_info->byte_offset + lsbyte;
123   if (byte_order == eByteOrderBig)
124     return containing_reg_info->byte_offset + msbyte;
125   llvm_unreachable("Invalid byte order");
126 }
127 
128 llvm::Expected<uint32_t> DynamicRegisterInfo::ByteOffsetFromComposite(
129     uint32_t index, StructuredData::Array &composite_reg_list,
130     lldb::ByteOrder byte_order) {
131   const size_t num_composite_regs = composite_reg_list.GetSize();
132   if (num_composite_regs == 0)
133     return llvm::createStringError(llvm::inconvertibleErrorCode(),
134                                    "\"composite\" list is empty");
135 
136   uint32_t composite_offset = UINT32_MAX;
137   for (uint32_t composite_idx = 0; composite_idx < num_composite_regs;
138        ++composite_idx) {
139     ConstString composite_reg_name;
140     if (!composite_reg_list.GetItemAtIndexAsString(composite_idx,
141                                                    composite_reg_name, nullptr))
142       return llvm::createStringError(
143           llvm::inconvertibleErrorCode(),
144           "\"composite\" list value is not a Python string at index %d",
145           composite_idx);
146 
147     const RegisterInfo *composite_reg_info =
148         GetRegisterInfo(composite_reg_name.GetStringRef());
149     if (!composite_reg_info)
150       return llvm::createStringError(
151           llvm::inconvertibleErrorCode(),
152           "failed to find composite register by name: \"%s\"",
153           composite_reg_name.GetCString());
154 
155     composite_offset =
156         std::min(composite_offset, composite_reg_info->byte_offset);
157     m_value_regs_map[index].push_back(
158         composite_reg_info->kinds[eRegisterKindLLDB]);
159     m_invalidate_regs_map[composite_reg_info->kinds[eRegisterKindLLDB]]
160         .push_back(index);
161     m_invalidate_regs_map[index].push_back(
162         composite_reg_info->kinds[eRegisterKindLLDB]);
163   }
164 
165   return composite_offset;
166 }
167 
168 llvm::Expected<uint32_t> DynamicRegisterInfo::ByteOffsetFromRegInfoDict(
169     uint32_t index, StructuredData::Dictionary &reg_info_dict,
170     lldb::ByteOrder byte_order) {
171   uint32_t byte_offset;
172   if (reg_info_dict.GetValueForKeyAsInteger("offset", byte_offset))
173     return byte_offset;
174 
175   // No offset for this register, see if the register has a value
176   // expression which indicates this register is part of another register.
177   // Value expressions are things like "rax[31:0]" which state that the
178   // current register's value is in a concrete register "rax" in bits 31:0.
179   // If there is a value expression we can calculate the offset
180   llvm::StringRef slice_str;
181   if (reg_info_dict.GetValueForKeyAsString("slice", slice_str, nullptr))
182     return ByteOffsetFromSlice(index, slice_str, byte_order);
183 
184   StructuredData::Array *composite_reg_list;
185   if (reg_info_dict.GetValueForKeyAsArray("composite", composite_reg_list))
186     return ByteOffsetFromComposite(index, *composite_reg_list, byte_order);
187 
188   return llvm::createStringError(llvm::inconvertibleErrorCode(),
189                                  "insufficient data to calculate byte offset");
190 }
191 
192 size_t
193 DynamicRegisterInfo::SetRegisterInfo(const StructuredData::Dictionary &dict,
194                                      const ArchSpec &arch) {
195   Log *log = lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_OBJECT);
196   assert(!m_finalized);
197   StructuredData::Array *sets = nullptr;
198   if (dict.GetValueForKeyAsArray("sets", sets)) {
199     const uint32_t num_sets = sets->GetSize();
200     for (uint32_t i = 0; i < num_sets; ++i) {
201       ConstString set_name;
202       if (sets->GetItemAtIndexAsString(i, set_name) && !set_name.IsEmpty()) {
203         m_sets.push_back({set_name.AsCString(), nullptr, 0, nullptr});
204       } else {
205         Clear();
206         printf("error: register sets must have valid names\n");
207         return 0;
208       }
209     }
210     m_set_reg_nums.resize(m_sets.size());
211   }
212 
213   StructuredData::Array *regs = nullptr;
214   if (!dict.GetValueForKeyAsArray("registers", regs))
215     return 0;
216 
217   const ByteOrder byte_order = arch.GetByteOrder();
218 
219   const uint32_t num_regs = regs->GetSize();
220   //        typedef std::map<std::string, std::vector<std::string> >
221   //        InvalidateNameMap;
222   //        InvalidateNameMap invalidate_map;
223   for (uint32_t i = 0; i < num_regs; ++i) {
224     StructuredData::Dictionary *reg_info_dict = nullptr;
225     if (!regs->GetItemAtIndexAsDictionary(i, reg_info_dict)) {
226       Clear();
227       printf("error: items in the 'registers' array must be dictionaries\n");
228       regs->DumpToStdout();
229       return 0;
230     }
231 
232     // { 'name':'rcx'       , 'bitsize' :  64, 'offset' :  16,
233     // 'encoding':'uint' , 'format':'hex'         , 'set': 0, 'ehframe' : 2,
234     // 'dwarf' : 2, 'generic':'arg4', 'alt-name':'arg4', },
235     RegisterInfo reg_info;
236     std::vector<uint32_t> value_regs;
237     std::vector<uint32_t> invalidate_regs;
238     memset(&reg_info, 0, sizeof(reg_info));
239 
240     ConstString name_val;
241     ConstString alt_name_val;
242     if (!reg_info_dict->GetValueForKeyAsString("name", name_val, nullptr)) {
243       Clear();
244       printf("error: registers must have valid names and offsets\n");
245       reg_info_dict->DumpToStdout();
246       return 0;
247     }
248     reg_info.name = name_val.GetCString();
249     reg_info_dict->GetValueForKeyAsString("alt-name", alt_name_val, nullptr);
250     reg_info.alt_name = alt_name_val.GetCString();
251 
252     llvm::Expected<uint32_t> byte_offset =
253         ByteOffsetFromRegInfoDict(i, *reg_info_dict, byte_order);
254     if (byte_offset)
255       reg_info.byte_offset = byte_offset.get();
256     else {
257       LLDB_LOG_ERROR(log, byte_offset.takeError(),
258                      "error while parsing register {1}: {0}", reg_info.name);
259       Clear();
260       reg_info_dict->DumpToStdout();
261       return 0;
262     }
263 
264     int64_t bitsize = 0;
265     if (!reg_info_dict->GetValueForKeyAsInteger("bitsize", bitsize)) {
266       Clear();
267       printf("error: invalid or missing 'bitsize' key/value pair in register "
268              "dictionary\n");
269       reg_info_dict->DumpToStdout();
270       return 0;
271     }
272 
273     reg_info.byte_size = bitsize / 8;
274 
275     llvm::StringRef format_str;
276     if (reg_info_dict->GetValueForKeyAsString("format", format_str, nullptr)) {
277       if (OptionArgParser::ToFormat(format_str.str().c_str(), reg_info.format,
278                                     nullptr)
279               .Fail()) {
280         Clear();
281         printf("error: invalid 'format' value in register dictionary\n");
282         reg_info_dict->DumpToStdout();
283         return 0;
284       }
285     } else {
286       reg_info_dict->GetValueForKeyAsInteger("format", reg_info.format,
287                                              eFormatHex);
288     }
289 
290     llvm::StringRef encoding_str;
291     if (reg_info_dict->GetValueForKeyAsString("encoding", encoding_str))
292       reg_info.encoding = Args::StringToEncoding(encoding_str, eEncodingUint);
293     else
294       reg_info_dict->GetValueForKeyAsInteger("encoding", reg_info.encoding,
295                                              eEncodingUint);
296 
297     size_t set = 0;
298     if (!reg_info_dict->GetValueForKeyAsInteger<size_t>("set", set, -1) ||
299         set >= m_sets.size()) {
300       Clear();
301       printf("error: invalid 'set' value in register dictionary, valid values "
302              "are 0 - %i\n",
303              (int)set);
304       reg_info_dict->DumpToStdout();
305       return 0;
306     }
307 
308     // Fill in the register numbers
309     reg_info.kinds[lldb::eRegisterKindLLDB] = i;
310     reg_info.kinds[lldb::eRegisterKindProcessPlugin] = i;
311     uint32_t eh_frame_regno = LLDB_INVALID_REGNUM;
312     reg_info_dict->GetValueForKeyAsInteger("gcc", eh_frame_regno,
313                                            LLDB_INVALID_REGNUM);
314     if (eh_frame_regno == LLDB_INVALID_REGNUM)
315       reg_info_dict->GetValueForKeyAsInteger("ehframe", eh_frame_regno,
316                                              LLDB_INVALID_REGNUM);
317     reg_info.kinds[lldb::eRegisterKindEHFrame] = eh_frame_regno;
318     reg_info_dict->GetValueForKeyAsInteger(
319         "dwarf", reg_info.kinds[lldb::eRegisterKindDWARF], LLDB_INVALID_REGNUM);
320     llvm::StringRef generic_str;
321     if (reg_info_dict->GetValueForKeyAsString("generic", generic_str))
322       reg_info.kinds[lldb::eRegisterKindGeneric] =
323           Args::StringToGenericRegister(generic_str);
324     else
325       reg_info_dict->GetValueForKeyAsInteger(
326           "generic", reg_info.kinds[lldb::eRegisterKindGeneric],
327           LLDB_INVALID_REGNUM);
328 
329     // Check if this register invalidates any other register values when it is
330     // modified
331     StructuredData::Array *invalidate_reg_list = nullptr;
332     if (reg_info_dict->GetValueForKeyAsArray("invalidate-regs",
333                                              invalidate_reg_list)) {
334       const size_t num_regs = invalidate_reg_list->GetSize();
335       if (num_regs > 0) {
336         for (uint32_t idx = 0; idx < num_regs; ++idx) {
337           ConstString invalidate_reg_name;
338           uint64_t invalidate_reg_num;
339           if (invalidate_reg_list->GetItemAtIndexAsString(
340                   idx, invalidate_reg_name)) {
341             const RegisterInfo *invalidate_reg_info =
342                 GetRegisterInfo(invalidate_reg_name.GetStringRef());
343             if (invalidate_reg_info) {
344               m_invalidate_regs_map[i].push_back(
345                   invalidate_reg_info->kinds[eRegisterKindLLDB]);
346             } else {
347               // TODO: print error invalid slice string that doesn't follow the
348               // format
349               printf("error: failed to find a 'invalidate-regs' register for "
350                      "\"%s\" while parsing register \"%s\"\n",
351                      invalidate_reg_name.GetCString(), reg_info.name);
352             }
353           } else if (invalidate_reg_list->GetItemAtIndexAsInteger(
354                          idx, invalidate_reg_num)) {
355             if (invalidate_reg_num != UINT64_MAX)
356               m_invalidate_regs_map[i].push_back(invalidate_reg_num);
357             else
358               printf("error: 'invalidate-regs' list value wasn't a valid "
359                      "integer\n");
360           } else {
361             printf("error: 'invalidate-regs' list value wasn't a python string "
362                    "or integer\n");
363           }
364         }
365       } else {
366         printf("error: 'invalidate-regs' contained an empty list\n");
367       }
368     }
369 
370     // Calculate the register offset
371     const size_t end_reg_offset = reg_info.byte_offset + reg_info.byte_size;
372     if (m_reg_data_byte_size < end_reg_offset)
373       m_reg_data_byte_size = end_reg_offset;
374 
375     m_regs.push_back(reg_info);
376     m_set_reg_nums[set].push_back(i);
377   }
378   Finalize(arch);
379   return m_regs.size();
380 }
381 
382 size_t DynamicRegisterInfo::SetRegisterInfo(
383     std::vector<DynamicRegisterInfo::Register> &&regs,
384     const ArchSpec &arch) {
385   assert(!m_finalized);
386 
387   for (auto it : llvm::enumerate(regs)) {
388     uint32_t local_regnum = it.index();
389     const DynamicRegisterInfo::Register &reg = it.value();
390 
391     assert(reg.name);
392     assert(reg.set_name);
393 
394     if (!reg.value_regs.empty())
395       m_value_regs_map[local_regnum] = std::move(reg.value_regs);
396     if (!reg.invalidate_regs.empty())
397       m_invalidate_regs_map[local_regnum] = std::move(reg.invalidate_regs);
398 
399     struct RegisterInfo reg_info {
400       reg.name.AsCString(), reg.alt_name.AsCString(), reg.byte_size,
401           reg.byte_offset, reg.encoding, reg.format,
402           {reg.regnum_ehframe, reg.regnum_dwarf, reg.regnum_generic,
403            reg.regnum_remote, local_regnum},
404           // value_regs and invalidate_regs are filled by Finalize()
405           nullptr, nullptr
406     };
407 
408     m_regs.push_back(reg_info);
409 
410     uint32_t set = GetRegisterSetIndexByName(reg.set_name, true);
411     assert(set < m_sets.size());
412     assert(set < m_set_reg_nums.size());
413     assert(set < m_set_names.size());
414     m_set_reg_nums[set].push_back(local_regnum);
415   };
416 
417   Finalize(arch);
418   return m_regs.size();
419 }
420 
421 void DynamicRegisterInfo::AddRegister(RegisterInfo reg_info,
422                                       ConstString &set_name) {
423   assert(!m_finalized);
424   const uint32_t reg_num = m_regs.size();
425   assert(reg_info.name);
426   uint32_t i;
427   if (reg_info.value_regs) {
428     for (i = 0; reg_info.value_regs[i] != LLDB_INVALID_REGNUM; ++i)
429       m_value_regs_map[reg_num].push_back(reg_info.value_regs[i]);
430 
431     // invalidate until Finalize() is called
432     reg_info.value_regs = nullptr;
433   }
434   if (reg_info.invalidate_regs) {
435     for (i = 0; reg_info.invalidate_regs[i] != LLDB_INVALID_REGNUM; ++i)
436       m_invalidate_regs_map[reg_num].push_back(reg_info.invalidate_regs[i]);
437 
438     // invalidate until Finalize() is called
439     reg_info.invalidate_regs = nullptr;
440   }
441 
442   m_regs.push_back(reg_info);
443   uint32_t set = GetRegisterSetIndexByName(set_name, true);
444   assert(set < m_sets.size());
445   assert(set < m_set_reg_nums.size());
446   assert(set < m_set_names.size());
447   m_set_reg_nums[set].push_back(reg_num);
448 }
449 
450 void DynamicRegisterInfo::Finalize(const ArchSpec &arch) {
451   if (m_finalized)
452     return;
453 
454   m_finalized = true;
455   const size_t num_sets = m_sets.size();
456   for (size_t set = 0; set < num_sets; ++set) {
457     assert(m_sets.size() == m_set_reg_nums.size());
458     m_sets[set].num_registers = m_set_reg_nums[set].size();
459     m_sets[set].registers = m_set_reg_nums[set].data();
460   }
461 
462   // sort and unique all value registers and make sure each is terminated with
463   // LLDB_INVALID_REGNUM
464 
465   for (reg_to_regs_map::iterator pos = m_value_regs_map.begin(),
466                                  end = m_value_regs_map.end();
467        pos != end; ++pos) {
468     if (pos->second.size() > 1) {
469       llvm::sort(pos->second.begin(), pos->second.end());
470       reg_num_collection::iterator unique_end =
471           std::unique(pos->second.begin(), pos->second.end());
472       if (unique_end != pos->second.end())
473         pos->second.erase(unique_end, pos->second.end());
474     }
475     assert(!pos->second.empty());
476     if (pos->second.back() != LLDB_INVALID_REGNUM)
477       pos->second.push_back(LLDB_INVALID_REGNUM);
478   }
479 
480   // Now update all value_regs with each register info as needed
481   const size_t num_regs = m_regs.size();
482   for (size_t i = 0; i < num_regs; ++i) {
483     if (m_value_regs_map.find(i) != m_value_regs_map.end())
484       m_regs[i].value_regs = m_value_regs_map[i].data();
485     else
486       m_regs[i].value_regs = nullptr;
487   }
488 
489   // Expand all invalidation dependencies
490   for (reg_to_regs_map::iterator pos = m_invalidate_regs_map.begin(),
491                                  end = m_invalidate_regs_map.end();
492        pos != end; ++pos) {
493     const uint32_t reg_num = pos->first;
494 
495     if (m_regs[reg_num].value_regs) {
496       reg_num_collection extra_invalid_regs;
497       for (const uint32_t invalidate_reg_num : pos->second) {
498         reg_to_regs_map::iterator invalidate_pos =
499             m_invalidate_regs_map.find(invalidate_reg_num);
500         if (invalidate_pos != m_invalidate_regs_map.end()) {
501           for (const uint32_t concrete_invalidate_reg_num :
502                invalidate_pos->second) {
503             if (concrete_invalidate_reg_num != reg_num)
504               extra_invalid_regs.push_back(concrete_invalidate_reg_num);
505           }
506         }
507       }
508       pos->second.insert(pos->second.end(), extra_invalid_regs.begin(),
509                          extra_invalid_regs.end());
510     }
511   }
512 
513   // sort and unique all invalidate registers and make sure each is terminated
514   // with LLDB_INVALID_REGNUM
515   for (reg_to_regs_map::iterator pos = m_invalidate_regs_map.begin(),
516                                  end = m_invalidate_regs_map.end();
517        pos != end; ++pos) {
518     if (pos->second.size() > 1) {
519       llvm::sort(pos->second.begin(), pos->second.end());
520       reg_num_collection::iterator unique_end =
521           std::unique(pos->second.begin(), pos->second.end());
522       if (unique_end != pos->second.end())
523         pos->second.erase(unique_end, pos->second.end());
524     }
525     assert(!pos->second.empty());
526     if (pos->second.back() != LLDB_INVALID_REGNUM)
527       pos->second.push_back(LLDB_INVALID_REGNUM);
528   }
529 
530   // Now update all invalidate_regs with each register info as needed
531   for (size_t i = 0; i < num_regs; ++i) {
532     if (m_invalidate_regs_map.find(i) != m_invalidate_regs_map.end())
533       m_regs[i].invalidate_regs = m_invalidate_regs_map[i].data();
534     else
535       m_regs[i].invalidate_regs = nullptr;
536   }
537 
538   // Check if we need to automatically set the generic registers in case they
539   // weren't set
540   bool generic_regs_specified = false;
541   for (const auto &reg : m_regs) {
542     if (reg.kinds[eRegisterKindGeneric] != LLDB_INVALID_REGNUM) {
543       generic_regs_specified = true;
544       break;
545     }
546   }
547 
548   if (!generic_regs_specified) {
549     switch (arch.GetMachine()) {
550     case llvm::Triple::aarch64:
551     case llvm::Triple::aarch64_32:
552     case llvm::Triple::aarch64_be:
553       for (auto &reg : m_regs) {
554         if (strcmp(reg.name, "pc") == 0)
555           reg.kinds[eRegisterKindGeneric] = LLDB_REGNUM_GENERIC_PC;
556         else if ((strcmp(reg.name, "fp") == 0) ||
557                  (strcmp(reg.name, "x29") == 0))
558           reg.kinds[eRegisterKindGeneric] = LLDB_REGNUM_GENERIC_FP;
559         else if ((strcmp(reg.name, "lr") == 0) ||
560                  (strcmp(reg.name, "x30") == 0))
561           reg.kinds[eRegisterKindGeneric] = LLDB_REGNUM_GENERIC_RA;
562         else if ((strcmp(reg.name, "sp") == 0) ||
563                  (strcmp(reg.name, "x31") == 0))
564           reg.kinds[eRegisterKindGeneric] = LLDB_REGNUM_GENERIC_SP;
565         else if (strcmp(reg.name, "cpsr") == 0)
566           reg.kinds[eRegisterKindGeneric] = LLDB_REGNUM_GENERIC_FLAGS;
567       }
568       break;
569 
570     case llvm::Triple::arm:
571     case llvm::Triple::armeb:
572     case llvm::Triple::thumb:
573     case llvm::Triple::thumbeb:
574       for (auto &reg : m_regs) {
575         if ((strcmp(reg.name, "pc") == 0) || (strcmp(reg.name, "r15") == 0))
576           reg.kinds[eRegisterKindGeneric] = LLDB_REGNUM_GENERIC_PC;
577         else if ((strcmp(reg.name, "sp") == 0) ||
578                  (strcmp(reg.name, "r13") == 0))
579           reg.kinds[eRegisterKindGeneric] = LLDB_REGNUM_GENERIC_SP;
580         else if ((strcmp(reg.name, "lr") == 0) ||
581                  (strcmp(reg.name, "r14") == 0))
582           reg.kinds[eRegisterKindGeneric] = LLDB_REGNUM_GENERIC_RA;
583         else if ((strcmp(reg.name, "r7") == 0) &&
584                  arch.GetTriple().getVendor() == llvm::Triple::Apple)
585           reg.kinds[eRegisterKindGeneric] = LLDB_REGNUM_GENERIC_FP;
586         else if ((strcmp(reg.name, "r11") == 0) &&
587                  arch.GetTriple().getVendor() != llvm::Triple::Apple)
588           reg.kinds[eRegisterKindGeneric] = LLDB_REGNUM_GENERIC_FP;
589         else if (strcmp(reg.name, "fp") == 0)
590           reg.kinds[eRegisterKindGeneric] = LLDB_REGNUM_GENERIC_FP;
591         else if (strcmp(reg.name, "cpsr") == 0)
592           reg.kinds[eRegisterKindGeneric] = LLDB_REGNUM_GENERIC_FLAGS;
593       }
594       break;
595 
596     case llvm::Triple::x86:
597       for (auto &reg : m_regs) {
598         if ((strcmp(reg.name, "eip") == 0) || (strcmp(reg.name, "pc") == 0))
599           reg.kinds[eRegisterKindGeneric] = LLDB_REGNUM_GENERIC_PC;
600         else if ((strcmp(reg.name, "esp") == 0) ||
601                  (strcmp(reg.name, "sp") == 0))
602           reg.kinds[eRegisterKindGeneric] = LLDB_REGNUM_GENERIC_SP;
603         else if ((strcmp(reg.name, "ebp") == 0) ||
604                  (strcmp(reg.name, "fp") == 0))
605           reg.kinds[eRegisterKindGeneric] = LLDB_REGNUM_GENERIC_FP;
606         else if ((strcmp(reg.name, "eflags") == 0) ||
607                  (strcmp(reg.name, "flags") == 0))
608           reg.kinds[eRegisterKindGeneric] = LLDB_REGNUM_GENERIC_FLAGS;
609       }
610       break;
611 
612     case llvm::Triple::x86_64:
613       for (auto &reg : m_regs) {
614         if ((strcmp(reg.name, "rip") == 0) || (strcmp(reg.name, "pc") == 0))
615           reg.kinds[eRegisterKindGeneric] = LLDB_REGNUM_GENERIC_PC;
616         else if ((strcmp(reg.name, "rsp") == 0) ||
617                  (strcmp(reg.name, "sp") == 0))
618           reg.kinds[eRegisterKindGeneric] = LLDB_REGNUM_GENERIC_SP;
619         else if ((strcmp(reg.name, "rbp") == 0) ||
620                  (strcmp(reg.name, "fp") == 0))
621           reg.kinds[eRegisterKindGeneric] = LLDB_REGNUM_GENERIC_FP;
622         else if ((strcmp(reg.name, "rflags") == 0) ||
623                  (strcmp(reg.name, "eflags") == 0) ||
624                  (strcmp(reg.name, "flags") == 0))
625           reg.kinds[eRegisterKindGeneric] = LLDB_REGNUM_GENERIC_FLAGS;
626       }
627       break;
628 
629     default:
630       break;
631     }
632   }
633 
634   // At this stage call ConfigureOffsets to calculate register offsets for
635   // targets supporting dynamic offset calculation. It also calculates
636   // total byte size of register data.
637   ConfigureOffsets();
638 
639   // Check if register info is reconfigurable
640   // AArch64 SVE register set has configurable register sizes
641   if (arch.GetTriple().isAArch64()) {
642     for (const auto &reg : m_regs) {
643       if (strcmp(reg.name, "vg") == 0) {
644         m_is_reconfigurable = true;
645         break;
646       }
647     }
648   }
649 }
650 
651 void DynamicRegisterInfo::ConfigureOffsets() {
652   // We are going to create a map between remote (eRegisterKindProcessPlugin)
653   // and local (eRegisterKindLLDB) register numbers. This map will give us
654   // remote register numbers in increasing order for offset calculation.
655   std::map<uint32_t, uint32_t> remote_to_local_regnum_map;
656   for (const auto &reg : m_regs)
657     remote_to_local_regnum_map[reg.kinds[eRegisterKindProcessPlugin]] =
658         reg.kinds[eRegisterKindLLDB];
659 
660   // At this stage we manually calculate g/G packet offsets of all primary
661   // registers, only if target XML or qRegisterInfo packet did not send
662   // an offset explicitly.
663   uint32_t reg_offset = 0;
664   for (auto const &regnum_pair : remote_to_local_regnum_map) {
665     if (m_regs[regnum_pair.second].byte_offset == LLDB_INVALID_INDEX32 &&
666         m_regs[regnum_pair.second].value_regs == nullptr) {
667       m_regs[regnum_pair.second].byte_offset = reg_offset;
668 
669       reg_offset = m_regs[regnum_pair.second].byte_offset +
670                    m_regs[regnum_pair.second].byte_size;
671     }
672   }
673 
674   // Now update all value_regs with each register info as needed
675   for (auto &reg : m_regs) {
676     if (reg.value_regs != nullptr) {
677       // Assign a valid offset to all pseudo registers if not assigned by stub.
678       // Pseudo registers with value_regs list populated will share same offset
679       // as that of their corresponding primary register in value_regs list.
680       if (reg.byte_offset == LLDB_INVALID_INDEX32) {
681         uint32_t value_regnum = reg.value_regs[0];
682         if (value_regnum != LLDB_INVALID_INDEX32)
683           reg.byte_offset = GetRegisterInfoAtIndex(value_regnum)->byte_offset;
684       }
685     }
686 
687     reg_offset = reg.byte_offset + reg.byte_size;
688     if (m_reg_data_byte_size < reg_offset)
689       m_reg_data_byte_size = reg_offset;
690   }
691 }
692 
693 bool DynamicRegisterInfo::IsReconfigurable() { return m_is_reconfigurable; }
694 
695 size_t DynamicRegisterInfo::GetNumRegisters() const { return m_regs.size(); }
696 
697 size_t DynamicRegisterInfo::GetNumRegisterSets() const { return m_sets.size(); }
698 
699 size_t DynamicRegisterInfo::GetRegisterDataByteSize() const {
700   return m_reg_data_byte_size;
701 }
702 
703 const RegisterInfo *
704 DynamicRegisterInfo::GetRegisterInfoAtIndex(uint32_t i) const {
705   if (i < m_regs.size())
706     return &m_regs[i];
707   return nullptr;
708 }
709 
710 const RegisterInfo *DynamicRegisterInfo::GetRegisterInfo(uint32_t kind,
711                                                          uint32_t num) const {
712   uint32_t reg_index = ConvertRegisterKindToRegisterNumber(kind, num);
713   if (reg_index != LLDB_INVALID_REGNUM)
714     return &m_regs[reg_index];
715   return nullptr;
716 }
717 
718 const RegisterSet *DynamicRegisterInfo::GetRegisterSet(uint32_t i) const {
719   if (i < m_sets.size())
720     return &m_sets[i];
721   return nullptr;
722 }
723 
724 uint32_t
725 DynamicRegisterInfo::GetRegisterSetIndexByName(const ConstString &set_name,
726                                                bool can_create) {
727   name_collection::iterator pos, end = m_set_names.end();
728   for (pos = m_set_names.begin(); pos != end; ++pos) {
729     if (*pos == set_name)
730       return std::distance(m_set_names.begin(), pos);
731   }
732 
733   m_set_names.push_back(set_name);
734   m_set_reg_nums.resize(m_set_reg_nums.size() + 1);
735   RegisterSet new_set = {set_name.AsCString(), nullptr, 0, nullptr};
736   m_sets.push_back(new_set);
737   return m_sets.size() - 1;
738 }
739 
740 uint32_t
741 DynamicRegisterInfo::ConvertRegisterKindToRegisterNumber(uint32_t kind,
742                                                          uint32_t num) const {
743   reg_collection::const_iterator pos, end = m_regs.end();
744   for (pos = m_regs.begin(); pos != end; ++pos) {
745     if (pos->kinds[kind] == num)
746       return std::distance(m_regs.begin(), pos);
747   }
748 
749   return LLDB_INVALID_REGNUM;
750 }
751 
752 void DynamicRegisterInfo::Clear() {
753   m_regs.clear();
754   m_sets.clear();
755   m_set_reg_nums.clear();
756   m_set_names.clear();
757   m_value_regs_map.clear();
758   m_invalidate_regs_map.clear();
759   m_reg_data_byte_size = 0;
760   m_finalized = false;
761 }
762 
763 void DynamicRegisterInfo::Dump() const {
764   StreamFile s(stdout, false);
765   const size_t num_regs = m_regs.size();
766   s.Printf("%p: DynamicRegisterInfo contains %" PRIu64 " registers:\n",
767            static_cast<const void *>(this), static_cast<uint64_t>(num_regs));
768   for (size_t i = 0; i < num_regs; ++i) {
769     s.Printf("[%3" PRIu64 "] name = %-10s", (uint64_t)i, m_regs[i].name);
770     s.Printf(", size = %2u, offset = %4u, encoding = %u, format = %-10s",
771              m_regs[i].byte_size, m_regs[i].byte_offset, m_regs[i].encoding,
772              FormatManager::GetFormatAsCString(m_regs[i].format));
773     if (m_regs[i].kinds[eRegisterKindProcessPlugin] != LLDB_INVALID_REGNUM)
774       s.Printf(", process plugin = %3u",
775                m_regs[i].kinds[eRegisterKindProcessPlugin]);
776     if (m_regs[i].kinds[eRegisterKindDWARF] != LLDB_INVALID_REGNUM)
777       s.Printf(", dwarf = %3u", m_regs[i].kinds[eRegisterKindDWARF]);
778     if (m_regs[i].kinds[eRegisterKindEHFrame] != LLDB_INVALID_REGNUM)
779       s.Printf(", ehframe = %3u", m_regs[i].kinds[eRegisterKindEHFrame]);
780     if (m_regs[i].kinds[eRegisterKindGeneric] != LLDB_INVALID_REGNUM)
781       s.Printf(", generic = %3u", m_regs[i].kinds[eRegisterKindGeneric]);
782     if (m_regs[i].alt_name)
783       s.Printf(", alt-name = %s", m_regs[i].alt_name);
784     if (m_regs[i].value_regs) {
785       s.Printf(", value_regs = [ ");
786       for (size_t j = 0; m_regs[i].value_regs[j] != LLDB_INVALID_REGNUM; ++j) {
787         s.Printf("%s ", m_regs[m_regs[i].value_regs[j]].name);
788       }
789       s.Printf("]");
790     }
791     if (m_regs[i].invalidate_regs) {
792       s.Printf(", invalidate_regs = [ ");
793       for (size_t j = 0; m_regs[i].invalidate_regs[j] != LLDB_INVALID_REGNUM;
794            ++j) {
795         s.Printf("%s ", m_regs[m_regs[i].invalidate_regs[j]].name);
796       }
797       s.Printf("]");
798     }
799     s.EOL();
800   }
801 
802   const size_t num_sets = m_sets.size();
803   s.Printf("%p: DynamicRegisterInfo contains %" PRIu64 " register sets:\n",
804            static_cast<const void *>(this), static_cast<uint64_t>(num_sets));
805   for (size_t i = 0; i < num_sets; ++i) {
806     s.Printf("set[%" PRIu64 "] name = %s, regs = [", (uint64_t)i,
807              m_sets[i].name);
808     for (size_t idx = 0; idx < m_sets[i].num_registers; ++idx) {
809       s.Printf("%s ", m_regs[m_sets[i].registers[idx]].name);
810     }
811     s.Printf("]\n");
812   }
813 }
814 
815 const lldb_private::RegisterInfo *
816 DynamicRegisterInfo::GetRegisterInfo(llvm::StringRef reg_name) const {
817   for (auto &reg_info : m_regs)
818     if (reg_info.name == reg_name)
819       return &reg_info;
820   return nullptr;
821 }
822 
823 void lldb_private::addSupplementaryRegister(
824     std::vector<DynamicRegisterInfo::Register> &regs,
825     DynamicRegisterInfo::Register new_reg_info) {
826   assert(!new_reg_info.value_regs.empty());
827   const uint32_t reg_num = regs.size();
828   regs.push_back(new_reg_info);
829 
830   std::map<uint32_t, std::vector<uint32_t>> new_invalidates;
831   for (uint32_t value_reg : new_reg_info.value_regs) {
832     // copy value_regs to invalidate_regs
833     new_invalidates[reg_num].push_back(value_reg);
834 
835     // copy invalidate_regs from the parent register
836     llvm::append_range(new_invalidates[reg_num],
837                        regs[value_reg].invalidate_regs);
838 
839     // add reverse invalidate entries
840     for (uint32_t x : new_invalidates[reg_num])
841       new_invalidates[x].push_back(reg_num);
842   }
843 
844   for (const auto &x : new_invalidates)
845     llvm::append_range(regs[x.first].invalidate_regs, x.second);
846 }
847