1 //===-- UnwindAssemblyInstEmulation.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 "UnwindAssemblyInstEmulation.h"
10 
11 #include "lldb/Core/Address.h"
12 #include "lldb/Core/Disassembler.h"
13 #include "lldb/Core/DumpDataExtractor.h"
14 #include "lldb/Core/DumpRegisterValue.h"
15 #include "lldb/Core/FormatEntity.h"
16 #include "lldb/Core/PluginManager.h"
17 #include "lldb/Target/ExecutionContext.h"
18 #include "lldb/Target/Process.h"
19 #include "lldb/Target/Target.h"
20 #include "lldb/Target/Thread.h"
21 #include "lldb/Utility/ArchSpec.h"
22 #include "lldb/Utility/DataBufferHeap.h"
23 #include "lldb/Utility/DataExtractor.h"
24 #include "lldb/Utility/Log.h"
25 #include "lldb/Utility/Status.h"
26 #include "lldb/Utility/StreamString.h"
27 
28 using namespace lldb;
29 using namespace lldb_private;
30 
31 LLDB_PLUGIN_DEFINE(UnwindAssemblyInstEmulation)
32 
33 //  UnwindAssemblyInstEmulation method definitions
34 
35 bool UnwindAssemblyInstEmulation::GetNonCallSiteUnwindPlanFromAssembly(
36     AddressRange &range, Thread &thread, UnwindPlan &unwind_plan) {
37   std::vector<uint8_t> function_text(range.GetByteSize());
38   ProcessSP process_sp(thread.GetProcess());
39   if (process_sp) {
40     Status error;
41     const bool force_live_memory = true;
42     if (process_sp->GetTarget().ReadMemory(
43             range.GetBaseAddress(), function_text.data(), range.GetByteSize(),
44             error, force_live_memory) != range.GetByteSize()) {
45       return false;
46     }
47   }
48   return GetNonCallSiteUnwindPlanFromAssembly(
49       range, function_text.data(), function_text.size(), unwind_plan);
50 }
51 
52 bool UnwindAssemblyInstEmulation::GetNonCallSiteUnwindPlanFromAssembly(
53     AddressRange &range, uint8_t *opcode_data, size_t opcode_size,
54     UnwindPlan &unwind_plan) {
55   if (opcode_data == nullptr || opcode_size == 0)
56     return false;
57 
58   if (range.GetByteSize() > 0 && range.GetBaseAddress().IsValid() &&
59       m_inst_emulator_up.get()) {
60 
61     // The instruction emulation subclass setup the unwind plan for the first
62     // instruction.
63     m_inst_emulator_up->CreateFunctionEntryUnwind(unwind_plan);
64 
65     // CreateFunctionEntryUnwind should have created the first row. If it
66     // doesn't, then we are done.
67     if (unwind_plan.GetRowCount() == 0)
68       return false;
69 
70     const bool prefer_file_cache = true;
71     DisassemblerSP disasm_sp(Disassembler::DisassembleBytes(
72         m_arch, nullptr, nullptr, range.GetBaseAddress(), opcode_data,
73         opcode_size, 99999, prefer_file_cache));
74 
75     Log *log(GetLogIfAllCategoriesSet(LIBLLDB_LOG_UNWIND));
76 
77     if (disasm_sp) {
78 
79       m_range_ptr = &range;
80       m_unwind_plan_ptr = &unwind_plan;
81 
82       const uint32_t addr_byte_size = m_arch.GetAddressByteSize();
83       const bool show_address = true;
84       const bool show_bytes = true;
85       m_inst_emulator_up->GetRegisterInfo(unwind_plan.GetRegisterKind(),
86                                           unwind_plan.GetInitialCFARegister(),
87                                           m_cfa_reg_info);
88 
89       m_fp_is_cfa = false;
90       m_register_values.clear();
91       m_pushed_regs.clear();
92 
93       // Initialize the CFA with a known value. In the 32 bit case it will be
94       // 0x80000000, and in the 64 bit case 0x8000000000000000. We use the
95       // address byte size to be safe for any future address sizes
96       m_initial_sp = (1ull << ((addr_byte_size * 8) - 1));
97       RegisterValue cfa_reg_value;
98       cfa_reg_value.SetUInt(m_initial_sp, m_cfa_reg_info.byte_size);
99       SetRegisterValue(m_cfa_reg_info, cfa_reg_value);
100 
101       const InstructionList &inst_list = disasm_sp->GetInstructionList();
102       const size_t num_instructions = inst_list.GetSize();
103 
104       if (num_instructions > 0) {
105         Instruction *inst = inst_list.GetInstructionAtIndex(0).get();
106         const lldb::addr_t base_addr = inst->GetAddress().GetFileAddress();
107 
108         // Map for storing the unwind plan row and the value of the registers
109         // at a given offset. When we see a forward branch we add a new entry
110         // to this map with the actual unwind plan row and register context for
111         // the target address of the branch as the current data have to be
112         // valid for the target address of the branch too if we are in the same
113         // function.
114         std::map<lldb::addr_t, std::pair<UnwindPlan::RowSP, RegisterValueMap>>
115             saved_unwind_states;
116 
117         // Make a copy of the current instruction Row and save it in m_curr_row
118         // so we can add updates as we process the instructions.
119         UnwindPlan::RowSP last_row = unwind_plan.GetLastRow();
120         UnwindPlan::Row *newrow = new UnwindPlan::Row;
121         if (last_row.get())
122           *newrow = *last_row.get();
123         m_curr_row.reset(newrow);
124 
125         // Add the initial state to the save list with offset 0.
126         saved_unwind_states.insert({0, {last_row, m_register_values}});
127 
128         // cache the stack pointer register number (in whatever register
129         // numbering this UnwindPlan uses) for quick reference during
130         // instruction parsing.
131         RegisterInfo sp_reg_info;
132         m_inst_emulator_up->GetRegisterInfo(
133             eRegisterKindGeneric, LLDB_REGNUM_GENERIC_SP, sp_reg_info);
134 
135         // The architecture dependent condition code of the last processed
136         // instruction.
137         EmulateInstruction::InstructionCondition last_condition =
138             EmulateInstruction::UnconditionalCondition;
139         lldb::addr_t condition_block_start_offset = 0;
140 
141         for (size_t idx = 0; idx < num_instructions; ++idx) {
142           m_curr_row_modified = false;
143           m_forward_branch_offset = 0;
144 
145           inst = inst_list.GetInstructionAtIndex(idx).get();
146           if (inst) {
147             lldb::addr_t current_offset =
148                 inst->GetAddress().GetFileAddress() - base_addr;
149             auto it = saved_unwind_states.upper_bound(current_offset);
150             assert(it != saved_unwind_states.begin() &&
151                    "Unwind row for the function entry missing");
152             --it; // Move it to the row corresponding to the current offset
153 
154             // If the offset of m_curr_row don't match with the offset we see
155             // in saved_unwind_states then we have to update m_curr_row and
156             // m_register_values based on the saved values. It is happening
157             // after we processed an epilogue and a return to caller
158             // instruction.
159             if (it->second.first->GetOffset() != m_curr_row->GetOffset()) {
160               UnwindPlan::Row *newrow = new UnwindPlan::Row;
161               *newrow = *it->second.first;
162               m_curr_row.reset(newrow);
163               m_register_values = it->second.second;
164               // re-set the CFA register ivars to match the
165               // new m_curr_row.
166               if (sp_reg_info.name &&
167                   m_curr_row->GetCFAValue().IsRegisterPlusOffset()) {
168                 uint32_t row_cfa_regnum =
169                     m_curr_row->GetCFAValue().GetRegisterNumber();
170                 lldb::RegisterKind row_kind =
171                     m_unwind_plan_ptr->GetRegisterKind();
172                 // set m_cfa_reg_info to the row's CFA reg.
173                 m_inst_emulator_up->GetRegisterInfo(row_kind, row_cfa_regnum,
174                                                     m_cfa_reg_info);
175                 // set m_fp_is_cfa.
176                 if (sp_reg_info.kinds[row_kind] == row_cfa_regnum)
177                   m_fp_is_cfa = false;
178                 else
179                   m_fp_is_cfa = true;
180               }
181             }
182 
183             m_inst_emulator_up->SetInstruction(inst->GetOpcode(),
184                                                inst->GetAddress(), nullptr);
185 
186             if (last_condition !=
187                 m_inst_emulator_up->GetInstructionCondition()) {
188               if (m_inst_emulator_up->GetInstructionCondition() !=
189                       EmulateInstruction::UnconditionalCondition &&
190                   saved_unwind_states.count(current_offset) == 0) {
191                 // If we don't have a saved row for the current offset then
192                 // save our current state because we will have to restore it
193                 // after the conditional block.
194                 auto new_row =
195                     std::make_shared<UnwindPlan::Row>(*m_curr_row.get());
196                 saved_unwind_states.insert(
197                     {current_offset, {new_row, m_register_values}});
198               }
199 
200               // If the last instruction was conditional with a different
201               // condition then the then current condition then restore the
202               // condition.
203               if (last_condition !=
204                   EmulateInstruction::UnconditionalCondition) {
205                 const auto &saved_state =
206                     saved_unwind_states.at(condition_block_start_offset);
207                 m_curr_row =
208                     std::make_shared<UnwindPlan::Row>(*saved_state.first);
209                 m_curr_row->SetOffset(current_offset);
210                 m_register_values = saved_state.second;
211                 // re-set the CFA register ivars to match the
212                 // new m_curr_row.
213                 if (sp_reg_info.name &&
214                     m_curr_row->GetCFAValue().IsRegisterPlusOffset()) {
215                   uint32_t row_cfa_regnum =
216                       m_curr_row->GetCFAValue().GetRegisterNumber();
217                   lldb::RegisterKind row_kind =
218                       m_unwind_plan_ptr->GetRegisterKind();
219                   // set m_cfa_reg_info to the row's CFA reg.
220                   m_inst_emulator_up->GetRegisterInfo(row_kind, row_cfa_regnum,
221                                                       m_cfa_reg_info);
222                   // set m_fp_is_cfa.
223                   if (sp_reg_info.kinds[row_kind] == row_cfa_regnum)
224                     m_fp_is_cfa = false;
225                   else
226                     m_fp_is_cfa = true;
227                 }
228                 bool replace_existing =
229                     true; // The last instruction might already
230                           // created a row for this offset and
231                           // we want to overwrite it.
232                 unwind_plan.InsertRow(
233                     std::make_shared<UnwindPlan::Row>(*m_curr_row),
234                     replace_existing);
235               }
236 
237               // We are starting a new conditional block at the actual offset
238               condition_block_start_offset = current_offset;
239             }
240 
241             if (log && log->GetVerbose()) {
242               StreamString strm;
243               lldb_private::FormatEntity::Entry format;
244               FormatEntity::Parse("${frame.pc}: ", format);
245               inst->Dump(&strm, inst_list.GetMaxOpcocdeByteSize(), show_address,
246                          show_bytes, nullptr, nullptr, nullptr, &format, 0);
247               log->PutString(strm.GetString());
248             }
249 
250             last_condition = m_inst_emulator_up->GetInstructionCondition();
251 
252             m_inst_emulator_up->EvaluateInstruction(
253                 eEmulateInstructionOptionIgnoreConditions);
254 
255             // If the current instruction is a branch forward then save the
256             // current CFI information for the offset where we are branching.
257             if (m_forward_branch_offset != 0 &&
258                 range.ContainsFileAddress(inst->GetAddress().GetFileAddress() +
259                                           m_forward_branch_offset)) {
260               auto newrow =
261                   std::make_shared<UnwindPlan::Row>(*m_curr_row.get());
262               newrow->SetOffset(current_offset + m_forward_branch_offset);
263               saved_unwind_states.insert(
264                   {current_offset + m_forward_branch_offset,
265                    {newrow, m_register_values}});
266               unwind_plan.InsertRow(newrow);
267             }
268 
269             // Were there any changes to the CFI while evaluating this
270             // instruction?
271             if (m_curr_row_modified) {
272               // Save the modified row if we don't already have a CFI row in
273               // the current address
274               if (saved_unwind_states.count(
275                       current_offset + inst->GetOpcode().GetByteSize()) == 0) {
276                 m_curr_row->SetOffset(current_offset +
277                                       inst->GetOpcode().GetByteSize());
278                 unwind_plan.InsertRow(m_curr_row);
279                 saved_unwind_states.insert(
280                     {current_offset + inst->GetOpcode().GetByteSize(),
281                      {m_curr_row, m_register_values}});
282 
283                 // Allocate a new Row for m_curr_row, copy the current state
284                 // into it
285                 UnwindPlan::Row *newrow = new UnwindPlan::Row;
286                 *newrow = *m_curr_row.get();
287                 m_curr_row.reset(newrow);
288               }
289             }
290           }
291         }
292       }
293     }
294 
295     if (log && log->GetVerbose()) {
296       StreamString strm;
297       lldb::addr_t base_addr = range.GetBaseAddress().GetFileAddress();
298       strm.Printf("Resulting unwind rows for [0x%" PRIx64 " - 0x%" PRIx64 "):",
299                   base_addr, base_addr + range.GetByteSize());
300       unwind_plan.Dump(strm, nullptr, base_addr);
301       log->PutString(strm.GetString());
302     }
303     return unwind_plan.GetRowCount() > 0;
304   }
305   return false;
306 }
307 
308 bool UnwindAssemblyInstEmulation::AugmentUnwindPlanFromCallSite(
309     AddressRange &func, Thread &thread, UnwindPlan &unwind_plan) {
310   return false;
311 }
312 
313 bool UnwindAssemblyInstEmulation::GetFastUnwindPlan(AddressRange &func,
314                                                     Thread &thread,
315                                                     UnwindPlan &unwind_plan) {
316   return false;
317 }
318 
319 bool UnwindAssemblyInstEmulation::FirstNonPrologueInsn(
320     AddressRange &func, const ExecutionContext &exe_ctx,
321     Address &first_non_prologue_insn) {
322   return false;
323 }
324 
325 UnwindAssembly *
326 UnwindAssemblyInstEmulation::CreateInstance(const ArchSpec &arch) {
327   std::unique_ptr<EmulateInstruction> inst_emulator_up(
328       EmulateInstruction::FindPlugin(arch, eInstructionTypePrologueEpilogue,
329                                      nullptr));
330   // Make sure that all prologue instructions are handled
331   if (inst_emulator_up)
332     return new UnwindAssemblyInstEmulation(arch, inst_emulator_up.release());
333   return nullptr;
334 }
335 
336 void UnwindAssemblyInstEmulation::Initialize() {
337   PluginManager::RegisterPlugin(GetPluginNameStatic(),
338                                 GetPluginDescriptionStatic(), CreateInstance);
339 }
340 
341 void UnwindAssemblyInstEmulation::Terminate() {
342   PluginManager::UnregisterPlugin(CreateInstance);
343 }
344 
345 ConstString UnwindAssemblyInstEmulation::GetPluginNameStatic() {
346   static ConstString g_name("inst-emulation");
347   return g_name;
348 }
349 
350 const char *UnwindAssemblyInstEmulation::GetPluginDescriptionStatic() {
351   return "Instruction emulation based unwind information.";
352 }
353 
354 uint64_t UnwindAssemblyInstEmulation::MakeRegisterKindValuePair(
355     const RegisterInfo &reg_info) {
356   lldb::RegisterKind reg_kind;
357   uint32_t reg_num;
358   if (EmulateInstruction::GetBestRegisterKindAndNumber(&reg_info, reg_kind,
359                                                        reg_num))
360     return (uint64_t)reg_kind << 24 | reg_num;
361   return 0ull;
362 }
363 
364 void UnwindAssemblyInstEmulation::SetRegisterValue(
365     const RegisterInfo &reg_info, const RegisterValue &reg_value) {
366   m_register_values[MakeRegisterKindValuePair(reg_info)] = reg_value;
367 }
368 
369 bool UnwindAssemblyInstEmulation::GetRegisterValue(const RegisterInfo &reg_info,
370                                                    RegisterValue &reg_value) {
371   const uint64_t reg_id = MakeRegisterKindValuePair(reg_info);
372   RegisterValueMap::const_iterator pos = m_register_values.find(reg_id);
373   if (pos != m_register_values.end()) {
374     reg_value = pos->second;
375     return true; // We had a real value that comes from an opcode that wrote
376                  // to it...
377   }
378   // We are making up a value that is recognizable...
379   reg_value.SetUInt(reg_id, reg_info.byte_size);
380   return false;
381 }
382 
383 size_t UnwindAssemblyInstEmulation::ReadMemory(
384     EmulateInstruction *instruction, void *baton,
385     const EmulateInstruction::Context &context, lldb::addr_t addr, void *dst,
386     size_t dst_len) {
387   Log *log(GetLogIfAllCategoriesSet(LIBLLDB_LOG_UNWIND));
388 
389   if (log && log->GetVerbose()) {
390     StreamString strm;
391     strm.Printf(
392         "UnwindAssemblyInstEmulation::ReadMemory    (addr = 0x%16.16" PRIx64
393         ", dst = %p, dst_len = %" PRIu64 ", context = ",
394         addr, dst, (uint64_t)dst_len);
395     context.Dump(strm, instruction);
396     log->PutString(strm.GetString());
397   }
398   memset(dst, 0, dst_len);
399   return dst_len;
400 }
401 
402 size_t UnwindAssemblyInstEmulation::WriteMemory(
403     EmulateInstruction *instruction, void *baton,
404     const EmulateInstruction::Context &context, lldb::addr_t addr,
405     const void *dst, size_t dst_len) {
406   if (baton && dst && dst_len)
407     return ((UnwindAssemblyInstEmulation *)baton)
408         ->WriteMemory(instruction, context, addr, dst, dst_len);
409   return 0;
410 }
411 
412 size_t UnwindAssemblyInstEmulation::WriteMemory(
413     EmulateInstruction *instruction, const EmulateInstruction::Context &context,
414     lldb::addr_t addr, const void *dst, size_t dst_len) {
415   DataExtractor data(dst, dst_len,
416                      instruction->GetArchitecture().GetByteOrder(),
417                      instruction->GetArchitecture().GetAddressByteSize());
418 
419   Log *log(GetLogIfAllCategoriesSet(LIBLLDB_LOG_UNWIND));
420 
421   if (log && log->GetVerbose()) {
422     StreamString strm;
423 
424     strm.PutCString("UnwindAssemblyInstEmulation::WriteMemory   (");
425     DumpDataExtractor(data, &strm, 0, eFormatBytes, 1, dst_len, UINT32_MAX,
426                       addr, 0, 0);
427     strm.PutCString(", context = ");
428     context.Dump(strm, instruction);
429     log->PutString(strm.GetString());
430   }
431 
432   const bool cant_replace = false;
433 
434   switch (context.type) {
435   default:
436   case EmulateInstruction::eContextInvalid:
437   case EmulateInstruction::eContextReadOpcode:
438   case EmulateInstruction::eContextImmediate:
439   case EmulateInstruction::eContextAdjustBaseRegister:
440   case EmulateInstruction::eContextRegisterPlusOffset:
441   case EmulateInstruction::eContextAdjustPC:
442   case EmulateInstruction::eContextRegisterStore:
443   case EmulateInstruction::eContextRegisterLoad:
444   case EmulateInstruction::eContextRelativeBranchImmediate:
445   case EmulateInstruction::eContextAbsoluteBranchRegister:
446   case EmulateInstruction::eContextSupervisorCall:
447   case EmulateInstruction::eContextTableBranchReadMemory:
448   case EmulateInstruction::eContextWriteRegisterRandomBits:
449   case EmulateInstruction::eContextWriteMemoryRandomBits:
450   case EmulateInstruction::eContextArithmetic:
451   case EmulateInstruction::eContextAdvancePC:
452   case EmulateInstruction::eContextReturnFromException:
453   case EmulateInstruction::eContextPopRegisterOffStack:
454   case EmulateInstruction::eContextAdjustStackPointer:
455     break;
456 
457   case EmulateInstruction::eContextPushRegisterOnStack: {
458     uint32_t reg_num = LLDB_INVALID_REGNUM;
459     uint32_t generic_regnum = LLDB_INVALID_REGNUM;
460     assert(context.info_type ==
461                EmulateInstruction::eInfoTypeRegisterToRegisterPlusOffset &&
462            "unhandled case, add code to handle this!");
463     const uint32_t unwind_reg_kind = m_unwind_plan_ptr->GetRegisterKind();
464     reg_num = context.info.RegisterToRegisterPlusOffset.data_reg
465                   .kinds[unwind_reg_kind];
466     generic_regnum = context.info.RegisterToRegisterPlusOffset.data_reg
467                          .kinds[eRegisterKindGeneric];
468 
469     if (reg_num != LLDB_INVALID_REGNUM &&
470         generic_regnum != LLDB_REGNUM_GENERIC_SP) {
471       if (m_pushed_regs.find(reg_num) == m_pushed_regs.end()) {
472         m_pushed_regs[reg_num] = addr;
473         const int32_t offset = addr - m_initial_sp;
474         m_curr_row->SetRegisterLocationToAtCFAPlusOffset(reg_num, offset,
475                                                          cant_replace);
476         m_curr_row_modified = true;
477       }
478     }
479   } break;
480   }
481 
482   return dst_len;
483 }
484 
485 bool UnwindAssemblyInstEmulation::ReadRegister(EmulateInstruction *instruction,
486                                                void *baton,
487                                                const RegisterInfo *reg_info,
488                                                RegisterValue &reg_value) {
489 
490   if (baton && reg_info)
491     return ((UnwindAssemblyInstEmulation *)baton)
492         ->ReadRegister(instruction, reg_info, reg_value);
493   return false;
494 }
495 bool UnwindAssemblyInstEmulation::ReadRegister(EmulateInstruction *instruction,
496                                                const RegisterInfo *reg_info,
497                                                RegisterValue &reg_value) {
498   bool synthetic = GetRegisterValue(*reg_info, reg_value);
499 
500   Log *log(GetLogIfAllCategoriesSet(LIBLLDB_LOG_UNWIND));
501 
502   if (log && log->GetVerbose()) {
503 
504     StreamString strm;
505     strm.Printf("UnwindAssemblyInstEmulation::ReadRegister  (name = \"%s\") => "
506                 "synthetic_value = %i, value = ",
507                 reg_info->name, synthetic);
508     DumpRegisterValue(reg_value, &strm, reg_info, false, false, eFormatDefault);
509     log->PutString(strm.GetString());
510   }
511   return true;
512 }
513 
514 bool UnwindAssemblyInstEmulation::WriteRegister(
515     EmulateInstruction *instruction, void *baton,
516     const EmulateInstruction::Context &context, const RegisterInfo *reg_info,
517     const RegisterValue &reg_value) {
518   if (baton && reg_info)
519     return ((UnwindAssemblyInstEmulation *)baton)
520         ->WriteRegister(instruction, context, reg_info, reg_value);
521   return false;
522 }
523 bool UnwindAssemblyInstEmulation::WriteRegister(
524     EmulateInstruction *instruction, const EmulateInstruction::Context &context,
525     const RegisterInfo *reg_info, const RegisterValue &reg_value) {
526   Log *log(GetLogIfAllCategoriesSet(LIBLLDB_LOG_UNWIND));
527 
528   if (log && log->GetVerbose()) {
529 
530     StreamString strm;
531     strm.Printf(
532         "UnwindAssemblyInstEmulation::WriteRegister (name = \"%s\", value = ",
533         reg_info->name);
534     DumpRegisterValue(reg_value, &strm, reg_info, false, false, eFormatDefault);
535     strm.PutCString(", context = ");
536     context.Dump(strm, instruction);
537     log->PutString(strm.GetString());
538   }
539 
540   SetRegisterValue(*reg_info, reg_value);
541 
542   switch (context.type) {
543   case EmulateInstruction::eContextInvalid:
544   case EmulateInstruction::eContextReadOpcode:
545   case EmulateInstruction::eContextImmediate:
546   case EmulateInstruction::eContextAdjustBaseRegister:
547   case EmulateInstruction::eContextRegisterPlusOffset:
548   case EmulateInstruction::eContextAdjustPC:
549   case EmulateInstruction::eContextRegisterStore:
550   case EmulateInstruction::eContextSupervisorCall:
551   case EmulateInstruction::eContextTableBranchReadMemory:
552   case EmulateInstruction::eContextWriteRegisterRandomBits:
553   case EmulateInstruction::eContextWriteMemoryRandomBits:
554   case EmulateInstruction::eContextAdvancePC:
555   case EmulateInstruction::eContextReturnFromException:
556   case EmulateInstruction::eContextPushRegisterOnStack:
557   case EmulateInstruction::eContextRegisterLoad:
558     //            {
559     //                const uint32_t reg_num =
560     //                reg_info->kinds[m_unwind_plan_ptr->GetRegisterKind()];
561     //                if (reg_num != LLDB_INVALID_REGNUM)
562     //                {
563     //                    const bool can_replace_only_if_unspecified = true;
564     //
565     //                    m_curr_row.SetRegisterLocationToUndefined (reg_num,
566     //                                                               can_replace_only_if_unspecified,
567     //                                                               can_replace_only_if_unspecified);
568     //                    m_curr_row_modified = true;
569     //                }
570     //            }
571     break;
572 
573   case EmulateInstruction::eContextArithmetic: {
574     // If we adjusted the current frame pointer by a constant then adjust the
575     // CFA offset
576     // with the same amount.
577     lldb::RegisterKind kind = m_unwind_plan_ptr->GetRegisterKind();
578     if (m_fp_is_cfa && reg_info->kinds[kind] == m_cfa_reg_info.kinds[kind] &&
579         context.info_type == EmulateInstruction::eInfoTypeRegisterPlusOffset &&
580         context.info.RegisterPlusOffset.reg.kinds[kind] ==
581             m_cfa_reg_info.kinds[kind]) {
582       const int64_t offset = context.info.RegisterPlusOffset.signed_offset;
583       m_curr_row->GetCFAValue().IncOffset(-1 * offset);
584       m_curr_row_modified = true;
585     }
586   } break;
587 
588   case EmulateInstruction::eContextAbsoluteBranchRegister:
589   case EmulateInstruction::eContextRelativeBranchImmediate: {
590     if (context.info_type == EmulateInstruction::eInfoTypeISAAndImmediate &&
591         context.info.ISAAndImmediate.unsigned_data32 > 0) {
592       m_forward_branch_offset =
593           context.info.ISAAndImmediateSigned.signed_data32;
594     } else if (context.info_type ==
595                    EmulateInstruction::eInfoTypeISAAndImmediateSigned &&
596                context.info.ISAAndImmediateSigned.signed_data32 > 0) {
597       m_forward_branch_offset = context.info.ISAAndImmediate.unsigned_data32;
598     } else if (context.info_type == EmulateInstruction::eInfoTypeImmediate &&
599                context.info.unsigned_immediate > 0) {
600       m_forward_branch_offset = context.info.unsigned_immediate;
601     } else if (context.info_type ==
602                    EmulateInstruction::eInfoTypeImmediateSigned &&
603                context.info.signed_immediate > 0) {
604       m_forward_branch_offset = context.info.signed_immediate;
605     }
606   } break;
607 
608   case EmulateInstruction::eContextPopRegisterOffStack: {
609     const uint32_t reg_num =
610         reg_info->kinds[m_unwind_plan_ptr->GetRegisterKind()];
611     const uint32_t generic_regnum = reg_info->kinds[eRegisterKindGeneric];
612     if (reg_num != LLDB_INVALID_REGNUM &&
613         generic_regnum != LLDB_REGNUM_GENERIC_SP) {
614       switch (context.info_type) {
615       case EmulateInstruction::eInfoTypeAddress:
616         if (m_pushed_regs.find(reg_num) != m_pushed_regs.end() &&
617             context.info.address == m_pushed_regs[reg_num]) {
618           m_curr_row->SetRegisterLocationToSame(reg_num,
619                                                 false /*must_replace*/);
620           m_curr_row_modified = true;
621         }
622         break;
623       case EmulateInstruction::eInfoTypeISA:
624         assert(
625             (generic_regnum == LLDB_REGNUM_GENERIC_PC ||
626              generic_regnum == LLDB_REGNUM_GENERIC_FLAGS) &&
627             "eInfoTypeISA used for popping a register other the PC/FLAGS");
628         if (generic_regnum != LLDB_REGNUM_GENERIC_FLAGS) {
629           m_curr_row->SetRegisterLocationToSame(reg_num,
630                                                 false /*must_replace*/);
631           m_curr_row_modified = true;
632         }
633         break;
634       default:
635         assert(false && "unhandled case, add code to handle this!");
636         break;
637       }
638     }
639   } break;
640 
641   case EmulateInstruction::eContextSetFramePointer:
642     if (!m_fp_is_cfa) {
643       m_fp_is_cfa = true;
644       m_cfa_reg_info = *reg_info;
645       const uint32_t cfa_reg_num =
646           reg_info->kinds[m_unwind_plan_ptr->GetRegisterKind()];
647       assert(cfa_reg_num != LLDB_INVALID_REGNUM);
648       m_curr_row->GetCFAValue().SetIsRegisterPlusOffset(
649           cfa_reg_num, m_initial_sp - reg_value.GetAsUInt64());
650       m_curr_row_modified = true;
651     }
652     break;
653 
654   case EmulateInstruction::eContextRestoreStackPointer:
655     if (m_fp_is_cfa) {
656       m_fp_is_cfa = false;
657       m_cfa_reg_info = *reg_info;
658       const uint32_t cfa_reg_num =
659           reg_info->kinds[m_unwind_plan_ptr->GetRegisterKind()];
660       assert(cfa_reg_num != LLDB_INVALID_REGNUM);
661       m_curr_row->GetCFAValue().SetIsRegisterPlusOffset(
662           cfa_reg_num, m_initial_sp - reg_value.GetAsUInt64());
663       m_curr_row_modified = true;
664     }
665     break;
666 
667   case EmulateInstruction::eContextAdjustStackPointer:
668     // If we have created a frame using the frame pointer, don't follow
669     // subsequent adjustments to the stack pointer.
670     if (!m_fp_is_cfa) {
671       m_curr_row->GetCFAValue().SetIsRegisterPlusOffset(
672           m_curr_row->GetCFAValue().GetRegisterNumber(),
673           m_initial_sp - reg_value.GetAsUInt64());
674       m_curr_row_modified = true;
675     }
676     break;
677   }
678   return true;
679 }
680