LLDB  mainline
ABIMacOSX_arm64.h
Go to the documentation of this file.
1 //===-- ABIMacOSX_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_ABIMACOSX_ARM64_H
10 #define LLDB_SOURCE_PLUGINS_ABI_AARCH64_ABIMACOSX_ARM64_H
11 
14 #include "lldb/lldb-private.h"
15 
16 class ABIMacOSX_arm64 : public ABIAArch64 {
17 public:
18  ~ABIMacOSX_arm64() override = default;
19 
20  size_t GetRedZoneSize() const override;
21 
23  lldb::addr_t functionAddress,
24  lldb::addr_t returnAddress,
25  llvm::ArrayRef<lldb::addr_t> args) const override;
26 
28  lldb_private::ValueList &values) const override;
29 
30  bool
32 
33  bool CreateDefaultUnwindPlan(lldb_private::UnwindPlan &unwind_plan) override;
34 
35  bool RegisterIsVolatile(const lldb_private::RegisterInfo *reg_info) override;
36 
37  // The arm64 ABI requires that stack frames be 16 byte aligned.
38  // When there is a trap handler on the stack, e.g. _sigtramp in userland
39  // code, we've seen that the stack pointer is often not aligned properly
40  // before the handler is invoked. This means that lldb will stop the unwind
41  // early -- before the function which caused the trap.
42  //
43  // To work around this, we relax that alignment to be just word-size
44  // (8-bytes).
45  // Allowing the trap handlers for user space would be easy (_sigtramp) but
46  // in other environments there can be a large number of different functions
47  // involved in async traps.
49  // Make sure the stack call frame addresses are are 8 byte aligned
50  if (cfa & (8ull - 1ull))
51  return false; // Not 8 byte aligned
52  if (cfa == 0)
53  return false; // Zero is not a valid stack address
54  return true;
55  }
56 
58  if (pc & (4ull - 1ull))
59  return false; // Not 4 byte aligned
60 
61  // Anything else if fair game..
62  return true;
63  }
64 
66 
67  // Static Functions
68 
69  static void Initialize();
70 
71  static void Terminate();
72 
73  static lldb::ABISP CreateInstance(lldb::ProcessSP process_sp, const lldb_private::ArchSpec &arch);
74 
75  // PluginInterface protocol
76 
78 
80  return GetPluginNameStatic();
81  }
82 
83  uint32_t GetPluginVersion() override;
84 
86  SetReturnValueObject(lldb::StackFrameSP &frame_sp,
87  lldb::ValueObjectSP &new_value) override;
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_ABIMACOSX_ARM64_H
ABIMacOSX_arm64::~ABIMacOSX_arm64
~ABIMacOSX_arm64() override=default
lldb_private::ArchSpec
Definition: ArchSpec.h:33
ABIMacOSX_arm64::CreateInstance
static lldb::ABISP CreateInstance(lldb::ProcessSP process_sp, const lldb_private::ArchSpec &arch)
Definition: ABIMacOSX_arm64.cpp:43
ABIMacOSX_arm64::CreateFunctionEntryUnwindPlan
bool CreateFunctionEntryUnwindPlan(lldb_private::UnwindPlan &unwind_plan) override
Definition: ABIMacOSX_arm64.cpp:349
lldb_private::ValueList
Definition: Value.h:157
ABIMacOSX_arm64::CodeAddressIsValid
bool CodeAddressIsValid(lldb::addr_t pc) override
Definition: ABIMacOSX_arm64.h:57
lldb::addr_t
uint64_t addr_t
Definition: lldb-types.h:83
pc
@ pc
Definition: CompactUnwindInfo.cpp:1250
ABIMacOSX_arm64::FixAddress
lldb::addr_t FixAddress(lldb::addr_t pc, lldb::addr_t mask) override
Definition: ABIMacOSX_arm64.cpp:818
ABIMacOSX_arm64::GetRedZoneSize
size_t GetRedZoneSize() const override
Definition: ABIMacOSX_arm64.cpp:38
ABIAArch64.h
ABIMacOSX_arm64::GetPluginVersion
uint32_t GetPluginVersion() override
Definition: ABIMacOSX_arm64.cpp:839
lldb_private::Thread
Definition: Thread.h:62
ABIMacOSX_arm64::GetPluginNameStatic
static lldb_private::ConstString GetPluginNameStatic()
Definition: ABIMacOSX_arm64.cpp:834
ABIMacOSX_arm64
Definition: ABIMacOSX_arm64.h:16
lldb_private::ConstString
Definition: ConstString.h:40
sp
@ sp
Definition: CompactUnwindInfo.cpp:1249
ABIMacOSX_arm64::CallFrameAddressIsValid
bool CallFrameAddressIsValid(lldb::addr_t cfa) override
Definition: ABIMacOSX_arm64.h:48
ABIAArch64
Definition: ABIAArch64.h:14
ABIMacOSX_arm64::SetReturnValueObject
lldb_private::Status SetReturnValueObject(lldb::StackFrameSP &frame_sp, lldb::ValueObjectSP &new_value) override
Definition: ABIMacOSX_arm64.cpp:237
lldb-private.h
lldb_private::Status
Definition: Status.h:44
uint32_t
ABIMacOSX_arm64::GetArgumentValues
bool GetArgumentValues(lldb_private::Thread &thread, lldb_private::ValueList &values) const override
Definition: ABIMacOSX_arm64.cpp:119
lldb_private::CompilerType
Generic representation of a type in a programming language.
Definition: CompilerType.h:33
ABIMacOSX_arm64::GetReturnValueObjectImpl
lldb::ValueObjectSP GetReturnValueObjectImpl(lldb_private::Thread &thread, lldb_private::CompilerType &ast_type) const override
Definition: ABIMacOSX_arm64.cpp:635
ABIMacOSX_arm64::RegisterIsVolatile
bool RegisterIsVolatile(const lldb_private::RegisterInfo *reg_info) override
Definition: ABIMacOSX_arm64.cpp:410
ConstString.h
ABIMacOSX_arm64::Terminate
static void Terminate()
Definition: ABIMacOSX_arm64.cpp:828
ABIMacOSX_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: ABIMacOSX_arm64.cpp:58
lldb_private::UnwindPlan
Definition: UnwindPlan.h:53
ABIMacOSX_arm64::CreateDefaultUnwindPlan
bool CreateDefaultUnwindPlan(lldb_private::UnwindPlan &unwind_plan) override
Definition: ABIMacOSX_arm64.cpp:375
ABIMacOSX_arm64::GetPluginName
lldb_private::ConstString GetPluginName() override
Definition: ABIMacOSX_arm64.h:79
ABIMacOSX_arm64::Initialize
static void Initialize()
Definition: ABIMacOSX_arm64.cpp:823