LLDB  mainline
ABISysV_arm64.h
Go to the documentation of this file.
1 //===-- ABISysV_arm64.h ---------------------------------------*- C++ -*-===//
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 #ifndef LLDB_SOURCE_PLUGINS_ABI_AARCH64_ABISYSV_ARM64_H
10 #define LLDB_SOURCE_PLUGINS_ABI_AARCH64_ABISYSV_ARM64_H
11 
13 #include "lldb/lldb-private.h"
14 
15 class ABISysV_arm64 : public ABIAArch64 {
16 public:
17  ~ABISysV_arm64() override = default;
18 
19  size_t GetRedZoneSize() const override;
20 
22  lldb::addr_t functionAddress,
23  lldb::addr_t returnAddress,
24  llvm::ArrayRef<lldb::addr_t> args) const override;
25 
27  lldb_private::ValueList &values) const override;
28 
30  SetReturnValueObject(lldb::StackFrameSP &frame_sp,
31  lldb::ValueObjectSP &new_value) override;
32 
33  bool
35 
36  bool CreateDefaultUnwindPlan(lldb_private::UnwindPlan &unwind_plan) override;
37 
38  bool RegisterIsVolatile(const lldb_private::RegisterInfo *reg_info) override;
39 
40  // The arm64 ABI requires that stack frames be 16 byte aligned.
41  // When there is a trap handler on the stack, e.g. _sigtramp in userland
42  // code, we've seen that the stack pointer is often not aligned properly
43  // before the handler is invoked. This means that lldb will stop the unwind
44  // early -- before the function which caused the trap.
45  //
46  // To work around this, we relax that alignment to be just word-size
47  // (8-bytes).
48  // Allowing the trap handlers for user space would be easy (_sigtramp) but
49  // in other environments there can be a large number of different functions
50  // involved in async traps.
52  // Make sure the stack call frame addresses are are 8 byte aligned
53  if (cfa & (8ull - 1ull))
54  return false; // Not 8 byte aligned
55  if (cfa == 0)
56  return false; // Zero is not a valid stack address
57  return true;
58  }
59 
61  if (pc & (4ull - 1ull))
62  return false; // Not 4 byte aligned
63 
64  // Anything else if fair game..
65  return true;
66  }
67 
68  bool GetPointerReturnRegister(const char *&name) override;
69 
71 
72  // Static Functions
73 
74  static void Initialize();
75 
76  static void Terminate();
77 
78  static lldb::ABISP CreateInstance(lldb::ProcessSP process_sp, const lldb_private::ArchSpec &arch);
79 
80  static llvm::StringRef GetPluginNameStatic() { return "SysV-arm64"; }
81 
82  // PluginInterface protocol
83 
84  llvm::StringRef GetPluginName() override { return GetPluginNameStatic(); }
85 
88 
89 protected:
90  lldb::ValueObjectSP
92  lldb_private::CompilerType &ast_type) const override;
93 
94 private:
95  using ABIAArch64::ABIAArch64; // Call CreateInstance instead.
96 };
97 
98 #endif // LLDB_SOURCE_PLUGINS_ABI_AARCH64_ABISYSV_ARM64_H
ABISysV_arm64::SetReturnValueObject
lldb_private::Status SetReturnValueObject(lldb::StackFrameSP &frame_sp, lldb::ValueObjectSP &new_value) override
Definition: ABISysV_arm64.cpp:209
lldb_private::ArchSpec
Definition: ArchSpec.h:33
ABISysV_arm64::CreateFunctionEntryUnwindPlan
bool CreateFunctionEntryUnwindPlan(lldb_private::UnwindPlan &unwind_plan) override
Definition: ABISysV_arm64.cpp:322
ABISysV_arm64::CallFrameAddressIsValid
bool CallFrameAddressIsValid(lldb::addr_t cfa) override
Definition: ABISysV_arm64.h:51
lldb_private::ValueList
Definition: Value.h:157
lldb::addr_t
uint64_t addr_t
Definition: lldb-types.h:83
pc
@ pc
Definition: CompactUnwindInfo.cpp:1250
ABISysV_arm64::Initialize
static void Initialize()
Definition: ABISysV_arm64.cpp:840
ABISysV_arm64::GetReturnValueObjectImpl
lldb::ValueObjectSP GetReturnValueObjectImpl(lldb_private::Thread &thread, lldb_private::CompilerType &ast_type) const override
Definition: ABISysV_arm64.cpp:603
ABISysV_arm64::Terminate
static void Terminate()
Definition: ABISysV_arm64.cpp:845
ABIAArch64.h
ABISysV_arm64::CodeAddressIsValid
bool CodeAddressIsValid(lldb::addr_t pc) override
Definition: ABISysV_arm64.h:60
ABISysV_arm64::FixCodeAddress
lldb::addr_t FixCodeAddress(lldb::addr_t pc) override
Some targets might use bits in a code address to indicate a mode switch.
Definition: ABISysV_arm64.cpp:816
ABISysV_arm64::GetPluginNameStatic
static llvm::StringRef GetPluginNameStatic()
Definition: ABISysV_arm64.h:80
ABISysV_arm64::~ABISysV_arm64
~ABISysV_arm64() override=default
lldb_private::Thread
Definition: Thread.h:60
ABISysV_arm64::GetPluginName
llvm::StringRef GetPluginName() override
Definition: ABISysV_arm64.h:84
ABISysV_arm64::GetPointerReturnRegister
bool GetPointerReturnRegister(const char *&name) override
Definition: ABISysV_arm64.cpp:36
ABISysV_arm64::PrepareTrivialCall
bool PrepareTrivialCall(lldb_private::Thread &thread, lldb::addr_t sp, lldb::addr_t functionAddress, lldb::addr_t returnAddress, llvm::ArrayRef< lldb::addr_t > args) const override
Definition: ABISysV_arm64.cpp:61
ABISysV_arm64::CreateInstance
static lldb::ABISP CreateInstance(lldb::ProcessSP process_sp, const lldb_private::ArchSpec &arch)
Definition: ABISysV_arm64.cpp:46
sp
@ sp
Definition: CompactUnwindInfo.cpp:1249
ABIAArch64
Definition: ABIAArch64.h:14
ABISysV_arm64::GetRedZoneSize
size_t GetRedZoneSize() const override
Definition: ABISysV_arm64.cpp:41
ABISysV_arm64::GetArgumentValues
bool GetArgumentValues(lldb_private::Thread &thread, lldb_private::ValueList &values) const override
Definition: ABISysV_arm64.cpp:122
ABISysV_arm64::RegisterIsVolatile
bool RegisterIsVolatile(const lldb_private::RegisterInfo *reg_info) override
Definition: ABISysV_arm64.cpp:381
lldb-private.h
lldb_private::Status
Definition: Status.h:44
lldb_private::CompilerType
Generic representation of a type in a programming language.
Definition: CompilerType.h:33
ABISysV_arm64::CreateDefaultUnwindPlan
bool CreateDefaultUnwindPlan(lldb_private::UnwindPlan &unwind_plan) override
Definition: ABISysV_arm64.cpp:347
ABISysV_arm64::FixAddress
lldb::addr_t FixAddress(lldb::addr_t pc, lldb::addr_t mask) override
Definition: ABISysV_arm64.cpp:785
ABISysV_arm64
Definition: ABISysV_arm64.h:15
lldb_private::UnwindPlan
Definition: UnwindPlan.h:53
ABISysV_arm64::FixDataAddress
lldb::addr_t FixDataAddress(lldb::addr_t pc) override
Definition: ABISysV_arm64.cpp:828