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
12#include "Plugins/ABI/AArch64/ABIAArch64.h"
13#include "lldb/Utility/ConstString.h"
14#include "lldb/lldb-private.h"
15
16class ABIMacOSX_arm64 : public ABIAArch64 {
17public:
18 ~ABIMacOSX_arm64() override = default;
19
20 size_t GetRedZoneSize() const override;
21
22 bool PrepareTrivialCall(lldb_private::Thread &thread, lldb::addr_t sp,
23 lldb::addr_t functionAddress,
24 lldb::addr_t returnAddress,
25 llvm::ArrayRef<lldb::addr_t> args) const override;
26
27 bool GetArgumentValues(lldb_private::Thread &thread,
28 lldb_private::ValueList &values) const override;
29
30 bool RegisterIsVolatile(const lldb_private::RegisterInfo *reg_info) override;
31
32 // The arm64 ABI requires that stack frames be 16 byte aligned.
33 // When there is a trap handler on the stack, e.g. _sigtramp in userland
34 // code, we've seen that the stack pointer is often not aligned properly
35 // before the handler is invoked. This means that lldb will stop the unwind
36 // early -- before the function which caused the trap.
37 //
38 // To work around this, we relax that alignment to be just word-size
39 // (8-bytes).
40 // Allowing the trap handlers for user space would be easy (_sigtramp) but
41 // in other environments there can be a large number of different functions
42 // involved in async traps.
43 bool CallFrameAddressIsValid(lldb::addr_t cfa) override {
44 // Make sure the stack call frame addresses are 8 byte aligned
45 if (cfa & (8ull - 1ull))
46 return false; // Not 8 byte aligned
47 if (cfa == 0)
48 return false; // Zero is not a valid stack address
49 return true;
50 }
51
52 bool CodeAddressIsValid(lldb::addr_t pc) override {
53 if (pc & (4ull - 1ull))
54 return false; // Not 4 byte aligned
55
56 // Anything else if fair game..
57 return true;
58 }
59
60 lldb::addr_t FixCodeAddress(lldb::addr_t pc) override;
61 lldb::addr_t FixDataAddress(lldb::addr_t pc) override;
62
63 // Static Functions
64
65 static void Initialize();
66
67 static void Terminate();
68
69 static lldb::ABISP CreateInstance(lldb::ProcessSP process_sp, const lldb_private::ArchSpec &arch);
70
71 // PluginInterface protocol
72
73 static llvm::StringRef GetPluginNameStatic() { return "ABIMacOSX_arm64"; }
74
75 llvm::StringRef GetPluginName() override { return GetPluginNameStatic(); }
76
77 lldb_private::Status
78 SetReturnValueObject(lldb::StackFrameSP &frame_sp,
79 lldb::ValueObjectSP &new_value) override;
80
81protected:
82 lldb::ValueObjectSP
83 GetReturnValueObjectImpl(lldb_private::Thread &thread,
84 lldb_private::CompilerType &ast_type) const override;
85
86private:
87 using ABIAArch64::ABIAArch64; // Call CreateInstance instead.
88};
89
90#endif // LLDB_SOURCE_PLUGINS_ABI_AARCH64_ABIMACOSX_ARM64_H
91

source code of lldb/source/Plugins/ABI/AArch64/ABIMacOSX_arm64.h