1 //===-- ABISysV_mips.cpp ----------------------------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #include "ABISysV_mips.h"
12 #include "lldb/Core/ConstString.h"
13 #include "lldb/Core/DataExtractor.h"
14 #include "lldb/Core/Error.h"
15 #include "lldb/Core/Log.h"
16 #include "lldb/Core/Module.h"
17 #include "lldb/Core/PluginManager.h"
18 #include "lldb/Core/RegisterValue.h"
19 #include "lldb/Core/Value.h"
20 #include "lldb/Core/ValueObjectConstResult.h"
21 #include "lldb/Core/ValueObjectRegister.h"
22 #include "lldb/Core/ValueObjectMemory.h"
23 #include "lldb/Symbol/ClangASTContext.h"
24 #include "lldb/Symbol/UnwindPlan.h"
25 #include "lldb/Target/Target.h"
26 #include "lldb/Target/Process.h"
27 #include "lldb/Target/RegisterContext.h"
28 #include "lldb/Target/StackFrame.h"
29 #include "lldb/Target/Thread.h"
31 #include "llvm/ADT/STLExtras.h"
32 #include "llvm/ADT/Triple.h"
35 using namespace lldb_private;
37 enum gcc_dwarf_regnums
121 static const RegisterInfo
124 // NAME ALT SZ OFF ENCODING FORMAT COMPILER DWARF GENERIC GDB LLDB NATIVE VALUE REGS INVALIDATE REGS
125 // ======== ====== == === ============= =================== ============ ===================== ==================== ================= ====================== ========== ===============
126 { "r0" , "zero", 4, 0, eEncodingUint, eFormatHex, { gcc_dwarf_r0, gcc_dwarf_r0, LLDB_INVALID_REGNUM, gdb_r0, LLDB_INVALID_REGNUM }, NULL, NULL},
127 { "r1" , "AT", 4, 0, eEncodingUint, eFormatHex, { gcc_dwarf_r1, gcc_dwarf_r1, LLDB_INVALID_REGNUM, gdb_r1, LLDB_INVALID_REGNUM }, NULL, NULL},
128 { "r2" , "v0", 4, 0, eEncodingUint, eFormatHex, { gcc_dwarf_r2, gcc_dwarf_r2, LLDB_INVALID_REGNUM, gdb_r2, LLDB_INVALID_REGNUM }, NULL, NULL},
129 { "r3" , "v1", 4, 0, eEncodingUint, eFormatHex, { gcc_dwarf_r3, gcc_dwarf_r3, LLDB_INVALID_REGNUM, gdb_r3, LLDB_INVALID_REGNUM }, NULL, NULL},
130 { "r4" , "arg1", 4, 0, eEncodingUint, eFormatHex, { gcc_dwarf_r4, gcc_dwarf_r4, LLDB_REGNUM_GENERIC_ARG1, gdb_r4, LLDB_INVALID_REGNUM }, NULL, NULL},
131 { "r5" , "arg2", 4, 0, eEncodingUint, eFormatHex, { gcc_dwarf_r5, gcc_dwarf_r5, LLDB_REGNUM_GENERIC_ARG2, gdb_r5, LLDB_INVALID_REGNUM }, NULL, NULL},
132 { "r6" , "arg3", 4, 0, eEncodingUint, eFormatHex, { gcc_dwarf_r6, gcc_dwarf_r6, LLDB_REGNUM_GENERIC_ARG3, gdb_r6, LLDB_INVALID_REGNUM }, NULL, NULL},
133 { "r7" , "arg4", 4, 0, eEncodingUint, eFormatHex, { gcc_dwarf_r7, gcc_dwarf_r7, LLDB_REGNUM_GENERIC_ARG4, gdb_r7, LLDB_INVALID_REGNUM }, NULL, NULL},
134 { "r8" , "arg5", 4, 0, eEncodingUint, eFormatHex, { gcc_dwarf_r8, gcc_dwarf_r8, LLDB_INVALID_REGNUM, gdb_r8, LLDB_INVALID_REGNUM }, NULL, NULL},
135 { "r9" , "arg6", 4, 0, eEncodingUint, eFormatHex, { gcc_dwarf_r9, gcc_dwarf_r9, LLDB_INVALID_REGNUM, gdb_r9, LLDB_INVALID_REGNUM }, NULL, NULL},
136 { "r10" , "arg7", 4, 0, eEncodingUint, eFormatHex, { gcc_dwarf_r10, gcc_dwarf_r10, LLDB_INVALID_REGNUM, gdb_r10, LLDB_INVALID_REGNUM }, NULL, NULL},
137 { "r11" , "arg8", 4, 0, eEncodingUint, eFormatHex, { gcc_dwarf_r11, gcc_dwarf_r11, LLDB_INVALID_REGNUM, gdb_r11, LLDB_INVALID_REGNUM }, NULL, NULL},
138 { "r12" , NULL, 4, 0, eEncodingUint, eFormatHex, { gcc_dwarf_r12, gcc_dwarf_r12, LLDB_INVALID_REGNUM, gdb_r12, LLDB_INVALID_REGNUM }, NULL, NULL},
139 { "r13" , NULL, 4, 0, eEncodingUint, eFormatHex, { gcc_dwarf_r13, gcc_dwarf_r13, LLDB_INVALID_REGNUM, gdb_r13, LLDB_INVALID_REGNUM }, NULL, NULL},
140 { "r14" , NULL, 4, 0, eEncodingUint, eFormatHex, { gcc_dwarf_r14, gcc_dwarf_r14, LLDB_INVALID_REGNUM, gdb_r14, LLDB_INVALID_REGNUM }, NULL, NULL},
141 { "r15" , NULL, 4, 0, eEncodingUint, eFormatHex, { gcc_dwarf_r15, gcc_dwarf_r15, LLDB_INVALID_REGNUM, gdb_r15, LLDB_INVALID_REGNUM }, NULL, NULL},
142 { "r16" , NULL, 4, 0, eEncodingUint, eFormatHex, { gcc_dwarf_r16, gcc_dwarf_r16, LLDB_INVALID_REGNUM, gdb_r16, LLDB_INVALID_REGNUM }, NULL, NULL},
143 { "r17" , NULL, 4, 0, eEncodingUint, eFormatHex, { gcc_dwarf_r17, gcc_dwarf_r17, LLDB_INVALID_REGNUM, gdb_r17, LLDB_INVALID_REGNUM }, NULL, NULL},
144 { "r18" , NULL, 4, 0, eEncodingUint, eFormatHex, { gcc_dwarf_r18, gcc_dwarf_r18, LLDB_INVALID_REGNUM, gdb_r18, LLDB_INVALID_REGNUM }, NULL, NULL},
145 { "r19" , NULL, 4, 0, eEncodingUint, eFormatHex, { gcc_dwarf_r19, gcc_dwarf_r19, LLDB_INVALID_REGNUM, gdb_r19, LLDB_INVALID_REGNUM }, NULL, NULL},
146 { "r20" , NULL, 4, 0, eEncodingUint, eFormatHex, { gcc_dwarf_r20, gcc_dwarf_r20, LLDB_INVALID_REGNUM, gdb_r20, LLDB_INVALID_REGNUM }, NULL, NULL},
147 { "r21" , NULL, 4, 0, eEncodingUint, eFormatHex, { gcc_dwarf_r21, gcc_dwarf_r21, LLDB_INVALID_REGNUM, gdb_r21, LLDB_INVALID_REGNUM }, NULL, NULL},
148 { "r22" , NULL, 4, 0, eEncodingUint, eFormatHex, { gcc_dwarf_r22, gcc_dwarf_r22, LLDB_INVALID_REGNUM, gdb_r22, LLDB_INVALID_REGNUM }, NULL, NULL},
149 { "r23" , NULL, 4, 0, eEncodingUint, eFormatHex, { gcc_dwarf_r23, gcc_dwarf_r23, LLDB_INVALID_REGNUM, gdb_r23, LLDB_INVALID_REGNUM }, NULL, NULL},
150 { "r24" , NULL, 4, 0, eEncodingUint, eFormatHex, { gcc_dwarf_r24, gcc_dwarf_r24, LLDB_INVALID_REGNUM, gdb_r24, LLDB_INVALID_REGNUM }, NULL, NULL},
151 { "r25" , NULL, 4, 0, eEncodingUint, eFormatHex, { gcc_dwarf_r25, gcc_dwarf_r25, LLDB_INVALID_REGNUM, gdb_r25, LLDB_INVALID_REGNUM }, NULL, NULL},
152 { "r26" , NULL, 4, 0, eEncodingUint, eFormatHex, { gcc_dwarf_r26, gcc_dwarf_r26, LLDB_INVALID_REGNUM, gdb_r26, LLDB_INVALID_REGNUM }, NULL, NULL},
153 { "r27" , NULL, 4, 0, eEncodingUint, eFormatHex, { gcc_dwarf_r27, gcc_dwarf_r27, LLDB_INVALID_REGNUM, gdb_r27, LLDB_INVALID_REGNUM }, NULL, NULL},
154 { "r28" , "gp", 4, 0, eEncodingUint, eFormatHex, { gcc_dwarf_r28, gcc_dwarf_r28, LLDB_INVALID_REGNUM, gdb_r28, LLDB_INVALID_REGNUM }, NULL, NULL},
155 { "r29" , "sp", 4, 0, eEncodingUint, eFormatHex, { gcc_dwarf_r29, gcc_dwarf_r29, LLDB_REGNUM_GENERIC_SP, gdb_r29, LLDB_INVALID_REGNUM }, NULL, NULL},
156 { "r30" , "fp", 4, 0, eEncodingUint, eFormatHex, { gcc_dwarf_r30, gcc_dwarf_r30, LLDB_REGNUM_GENERIC_FP, gdb_r30, LLDB_INVALID_REGNUM }, NULL, NULL},
157 { "r31" , "ra", 4, 0, eEncodingUint, eFormatHex, { gcc_dwarf_r31, gcc_dwarf_r31, LLDB_REGNUM_GENERIC_RA, gdb_r31, LLDB_INVALID_REGNUM }, NULL, NULL},
158 { "sr" , NULL, 4, 0, eEncodingUint, eFormatHex, { gcc_dwarf_sr, gcc_dwarf_sr, LLDB_REGNUM_GENERIC_FLAGS, gdb_sr, LLDB_INVALID_REGNUM }, NULL, NULL},
159 { "lo" , NULL, 4, 0, eEncodingUint, eFormatHex, { gcc_dwarf_lo, gcc_dwarf_lo, LLDB_INVALID_REGNUM, gdb_lo, LLDB_INVALID_REGNUM }, NULL, NULL},
160 { "hi" , NULL, 4, 0, eEncodingUint, eFormatHex, { gcc_dwarf_hi, gcc_dwarf_hi, LLDB_INVALID_REGNUM, gdb_hi, LLDB_INVALID_REGNUM }, NULL, NULL},
161 { "bad" , NULL, 4, 0, eEncodingUint, eFormatHex, { gcc_dwarf_bad, gcc_dwarf_bad, LLDB_INVALID_REGNUM, gdb_bad, LLDB_INVALID_REGNUM }, NULL, NULL},
162 { "cause" , NULL, 4, 0, eEncodingUint, eFormatHex, { gcc_dwarf_cause, gcc_dwarf_cause, LLDB_INVALID_REGNUM, gdb_cause, LLDB_INVALID_REGNUM }, NULL, NULL},
163 { "pc" , NULL, 4, 0, eEncodingUint, eFormatHex, { gcc_dwarf_pc, gcc_dwarf_pc, LLDB_REGNUM_GENERIC_PC, gdb_pc, LLDB_INVALID_REGNUM }, NULL, NULL},
166 static const uint32_t k_num_register_infos = llvm::array_lengthof(g_register_infos);
168 const lldb_private::RegisterInfo *
169 ABISysV_mips::GetRegisterInfoArray (uint32_t &count)
171 count = k_num_register_infos;
172 return g_register_infos;
176 ABISysV_mips::GetRedZoneSize () const
181 //------------------------------------------------------------------
183 //------------------------------------------------------------------
185 ABISysV_mips::CreateInstance (const ArchSpec &arch)
187 static ABISP g_abi_sp;
188 const llvm::Triple::ArchType arch_type = arch.GetTriple().getArch();
189 if ((arch_type == llvm::Triple::mips) ||
190 (arch_type == llvm::Triple::mipsel))
193 g_abi_sp.reset (new ABISysV_mips);
200 ABISysV_mips::PrepareTrivialCall (Thread &thread,
204 llvm::ArrayRef<addr_t> args) const
206 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_EXPRESSIONS));
211 s.Printf("ABISysV_mips::PrepareTrivialCall (tid = 0x%" PRIx64 ", sp = 0x%" PRIx64 ", func_addr = 0x%" PRIx64 ", return_addr = 0x%" PRIx64,
215 (uint64_t)return_addr);
217 for (size_t i = 0; i < args.size(); ++i)
218 s.Printf (", arg%zd = 0x%" PRIx64, i + 1, args[i]);
220 log->PutCString(s.GetString().c_str());
223 RegisterContext *reg_ctx = thread.GetRegisterContext().get();
227 const RegisterInfo *reg_info = NULL;
229 RegisterValue reg_value;
231 // Argument registers
232 const char *reg_names[] = { "r4", "r5", "r6", "r7" };
234 llvm::ArrayRef<addr_t>::iterator ai = args.begin(), ae = args.end();
236 // Write arguments to registers
237 for (size_t i = 0; i < llvm::array_lengthof(reg_names); ++i)
242 reg_info = reg_ctx->GetRegisterInfo(eRegisterKindGeneric, LLDB_REGNUM_GENERIC_ARG1 + i);
244 log->Printf("About to write arg%zd (0x%" PRIx64 ") into %s", i + 1, args[i], reg_info->name);
246 if (!reg_ctx->WriteRegisterFromUnsigned(reg_info, args[i]))
252 // If we have more than 4 arguments --Spill onto the stack
255 // No of arguments to go on stack
256 size_t num_stack_regs = args.size();
258 // Allocate needed space for args on the stack
259 sp -= (num_stack_regs * 4);
261 // Keep the stack 8 byte aligned
264 // just using arg1 to get the right size
265 const RegisterInfo *reg_info = reg_ctx->GetRegisterInfo(eRegisterKindGeneric, LLDB_REGNUM_GENERIC_ARG1);
267 addr_t arg_pos = sp+16;
270 for (; ai != ae; ++ai)
272 reg_value.SetUInt32(*ai);
274 log->Printf("About to write arg%zd (0x%" PRIx64 ") at 0x%" PRIx64 "", i+1, args[i], arg_pos);
276 if (reg_ctx->WriteRegisterValueToMemory(reg_info, arg_pos, reg_info->byte_size, reg_value).Fail())
278 arg_pos += reg_info->byte_size;
284 const RegisterInfo *pc_reg_info = reg_ctx->GetRegisterInfo (eRegisterKindGeneric, LLDB_REGNUM_GENERIC_PC);
285 const RegisterInfo *sp_reg_info = reg_ctx->GetRegisterInfo (eRegisterKindGeneric, LLDB_REGNUM_GENERIC_SP);
286 const RegisterInfo *ra_reg_info = reg_ctx->GetRegisterInfo (eRegisterKindGeneric, LLDB_REGNUM_GENERIC_RA);
289 log->Printf("Writing SP: 0x%" PRIx64, (uint64_t)sp);
291 // Set "sp" to the requested value
292 if (!reg_ctx->WriteRegisterFromUnsigned (sp_reg_info, sp))
296 log->Printf("Writing RA: 0x%" PRIx64, (uint64_t)return_addr);
298 // Set "ra" to the return address
299 if (!reg_ctx->WriteRegisterFromUnsigned (ra_reg_info, return_addr))
303 log->Printf("Writing PC: 0x%" PRIx64, (uint64_t)func_addr);
305 // Set pc to the address of the called function.
306 if (!reg_ctx->WriteRegisterFromUnsigned (pc_reg_info, func_addr))
313 ABISysV_mips::GetArgumentValues (Thread &thread, ValueList &values) const
319 ABISysV_mips::SetReturnValueObject(lldb::StackFrameSP &frame_sp, lldb::ValueObjectSP &new_value_sp)
324 error.SetErrorString("Empty value object for return value.");
328 ClangASTType clang_type = new_value_sp->GetClangType();
331 error.SetErrorString ("Null clang type for return value.");
335 Thread *thread = frame_sp->GetThread().get();
341 RegisterContext *reg_ctx = thread->GetRegisterContext().get();
343 bool set_it_simple = false;
344 if (clang_type.IsIntegerType (is_signed) || clang_type.IsPointerType())
348 size_t num_bytes = new_value_sp->GetData(data, data_error);
349 if (data_error.Fail())
351 error.SetErrorStringWithFormat("Couldn't convert return value to raw data: %s", data_error.AsCString());
355 lldb::offset_t offset = 0;
358 const RegisterInfo *r2_info = reg_ctx->GetRegisterInfoByName("r2", 0);
361 uint32_t raw_value = data.GetMaxU32(&offset, num_bytes);
363 if (reg_ctx->WriteRegisterFromUnsigned (r2_info, raw_value))
364 set_it_simple = true;
368 uint32_t raw_value = data.GetMaxU32(&offset, 4);
370 if (reg_ctx->WriteRegisterFromUnsigned (r2_info, raw_value))
372 const RegisterInfo *r3_info = reg_ctx->GetRegisterInfoByName("r3", 0);
373 uint32_t raw_value = data.GetMaxU32(&offset, num_bytes - offset);
375 if (reg_ctx->WriteRegisterFromUnsigned (r3_info, raw_value))
376 set_it_simple = true;
382 error.SetErrorString("We don't support returning longer than 64 bit integer values at present.");
385 else if (clang_type.IsFloatingPointType (count, is_complex))
388 error.SetErrorString ("We don't support returning complex values at present");
390 error.SetErrorString ("We don't support returning float values at present");
394 error.SetErrorString ("We only support setting simple integer return types at present.");
401 ABISysV_mips::GetReturnValueObjectSimple (Thread &thread, ClangASTType &return_clang_type) const
403 ValueObjectSP return_valobj_sp;
404 return return_valobj_sp;
408 ABISysV_mips::GetReturnValueObjectImpl (Thread &thread, ClangASTType &return_clang_type) const
410 ValueObjectSP return_valobj_sp;
413 if (!return_clang_type)
414 return return_valobj_sp;
416 ExecutionContext exe_ctx (thread.shared_from_this());
417 if (exe_ctx.GetTargetPtr() == NULL || exe_ctx.GetProcessPtr() == NULL)
418 return return_valobj_sp;
420 value.SetClangType(return_clang_type);
422 RegisterContext *reg_ctx = thread.GetRegisterContext().get();
424 return return_valobj_sp;
428 // In MIPS register "r2" (v0) holds the integer function return values
429 const RegisterInfo *r2_reg_info = reg_ctx->GetRegisterInfoByName("r2", 0);
431 if (return_clang_type.IsIntegerType (is_signed))
433 size_t bit_width = return_clang_type.GetBitSize(&thread);
438 return return_valobj_sp;
441 const RegisterInfo *r3_reg_info = reg_ctx->GetRegisterInfoByName("r3", 0);
443 raw_value = reg_ctx->ReadRegisterAsUnsigned(r2_reg_info, 0) & UINT32_MAX;
444 raw_value |= ((uint64_t)(reg_ctx->ReadRegisterAsUnsigned(r3_reg_info, 0) & UINT32_MAX)) << 32;
446 value.GetScalar() = (int64_t)raw_value;
448 value.GetScalar() = (uint64_t)raw_value;
453 value.GetScalar() = (int32_t)(reg_ctx->ReadRegisterAsUnsigned(r2_reg_info, 0) & UINT32_MAX);
455 value.GetScalar() = (uint32_t)(reg_ctx->ReadRegisterAsUnsigned(r2_reg_info, 0) & UINT32_MAX);
459 value.GetScalar() = (int16_t)(reg_ctx->ReadRegisterAsUnsigned(r2_reg_info, 0) & UINT16_MAX);
461 value.GetScalar() = (uint16_t)(reg_ctx->ReadRegisterAsUnsigned(r2_reg_info, 0) & UINT16_MAX);
465 value.GetScalar() = (int8_t)(reg_ctx->ReadRegisterAsUnsigned(r2_reg_info, 0) & UINT8_MAX);
467 value.GetScalar() = (uint8_t)(reg_ctx->ReadRegisterAsUnsigned(r2_reg_info, 0) & UINT8_MAX);
471 else if (return_clang_type.IsPointerType ())
473 uint32_t ptr = thread.GetRegisterContext()->ReadRegisterAsUnsigned(r2_reg_info, 0) & UINT32_MAX;
474 value.GetScalar() = ptr;
479 return return_valobj_sp;
482 // If we get here, we have a valid Value, so make our ValueObject out of it:
484 return_valobj_sp = ValueObjectConstResult::Create(thread.GetStackFrameAtIndex(0).get(),
487 return return_valobj_sp;
491 ABISysV_mips::CreateFunctionEntryUnwindPlan (UnwindPlan &unwind_plan)
494 unwind_plan.SetRegisterKind (eRegisterKindDWARF);
496 UnwindPlan::RowSP row(new UnwindPlan::Row);
498 // Our Call Frame Address is the stack pointer value
499 row->GetCFAValue().SetIsRegisterPlusOffset(gcc_dwarf_r29, 0);
501 // The previous PC is in the RA
502 row->SetRegisterLocationToRegister(gcc_dwarf_pc, gcc_dwarf_r31, true);
503 unwind_plan.AppendRow (row);
505 // All other registers are the same.
507 unwind_plan.SetSourceName ("mips at-func-entry default");
508 unwind_plan.SetSourcedFromCompiler (eLazyBoolNo);
509 unwind_plan.SetReturnAddressRegister(gcc_dwarf_r31);
514 ABISysV_mips::CreateDefaultUnwindPlan (UnwindPlan &unwind_plan)
517 unwind_plan.SetRegisterKind (eRegisterKindDWARF);
519 UnwindPlan::RowSP row(new UnwindPlan::Row);
521 row->GetCFAValue().SetIsRegisterPlusOffset(gcc_dwarf_r29, 0);
523 row->SetRegisterLocationToRegister(gcc_dwarf_pc, gcc_dwarf_r31, true);
525 unwind_plan.AppendRow (row);
526 unwind_plan.SetSourceName ("mips default unwind plan");
527 unwind_plan.SetSourcedFromCompiler (eLazyBoolNo);
528 unwind_plan.SetUnwindPlanValidAtAllInstructions (eLazyBoolNo);
533 ABISysV_mips::RegisterIsVolatile (const RegisterInfo *reg_info)
535 return !RegisterIsCalleeSaved (reg_info);
539 ABISysV_mips::RegisterIsCalleeSaved (const RegisterInfo *reg_info)
543 // Preserved registers are :
544 // r16-r23, r28, r29, r30, r31
546 int reg = ((reg_info->byte_offset) / 4);
548 bool save = (reg >= 16) && (reg <= 23);
549 save |= (reg >= 28) && (reg <= 31);
557 ABISysV_mips::Initialize()
559 PluginManager::RegisterPlugin (GetPluginNameStatic(),
560 "System V ABI for mips targets",
565 ABISysV_mips::Terminate()
567 PluginManager::UnregisterPlugin (CreateInstance);
570 lldb_private::ConstString
571 ABISysV_mips::GetPluginNameStatic()
573 static ConstString g_name("sysv-mips");
577 //------------------------------------------------------------------
578 // PluginInterface protocol
579 //------------------------------------------------------------------
580 lldb_private::ConstString
581 ABISysV_mips::GetPluginName()
583 return GetPluginNameStatic();
587 ABISysV_mips::GetPluginVersion()