Coverage Report

Created: 2022-01-25 06:29

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