LLDB  mainline
ABIWindows_x86_64.h
Go to the documentation of this file.
1 //===-- ABIWindows_x86_64.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_X86_ABIWINDOWS_X86_64_H
10 #define LLDB_SOURCE_PLUGINS_ABI_X86_ABIWINDOWS_X86_64_H
11 
13 
14 class ABIWindows_x86_64 : public ABIX86_64 {
15 public:
16  ~ABIWindows_x86_64() override = default;
17 
18  size_t GetRedZoneSize() const override;
19 
21  lldb::addr_t functionAddress,
22  lldb::addr_t returnAddress,
23  llvm::ArrayRef<lldb::addr_t> args) const override;
24 
26  lldb_private::ValueList &values) const override;
27 
29  SetReturnValueObject(lldb::StackFrameSP &frame_sp,
30  lldb::ValueObjectSP &new_value) override;
31 
32  lldb::ValueObjectSP
34  lldb_private::CompilerType &type) const override;
35 
36  bool
38 
39  bool CreateDefaultUnwindPlan(lldb_private::UnwindPlan &unwind_plan) override;
40 
41  bool RegisterIsVolatile(const lldb_private::RegisterInfo *reg_info) override;
42 
43  // In Windows_x86_64 ABI requires that the stack will be maintained 16-byte
44  // aligned.
45  // When ntdll invokes callbacks such as KiUserExceptionDispatcher or
46  // KiUserCallbackDispatcher, those functions won't have a properly 16-byte
47  // aligned stack - but tolerate unwinding through them by relaxing the
48  // requirement to 8 bytes.
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  // We have a 64 bit address space, so anything is valid as opcodes
59  // aren't fixed width...
60  return true;
61  }
62 
63  bool GetPointerReturnRegister(const char *&name) override;
64 
65  //------------------------------------------------------------------
66  // Static Functions
67  //------------------------------------------------------------------
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  static llvm::StringRef GetPluginNameStatic() { return "windows-x86_64"; }
76 
77  //------------------------------------------------------------------
78  // PluginInterface protocol
79  //------------------------------------------------------------------
80 
81  llvm::StringRef GetPluginName() override { return GetPluginNameStatic(); }
82 
83 protected:
85 
86  lldb::ValueObjectSP
88  lldb_private::CompilerType &ast_type) const;
89 
90  bool RegisterIsCalleeSaved(const lldb_private::RegisterInfo *reg_info);
91  uint32_t GetGenericNum(llvm::StringRef reg) override;
92 
93 private:
94  using ABIX86_64::ABIX86_64; // Call CreateInstance instead.
95 };
96 
97 #endif // LLDB_SOURCE_PLUGINS_ABI_X86_ABIWINDOWS_X86_64_H
ABIWindows_x86_64::GetArgumentValues
bool GetArgumentValues(lldb_private::Thread &thread, lldb_private::ValueList &values) const override
Definition: ABIWindows_x86_64.cpp:231
ABIWindows_x86_64::GetRedZoneSize
size_t GetRedZoneSize() const override
Definition: ABIWindows_x86_64.cpp:108
lldb_private::ArchSpec
Definition: ArchSpec.h:32
ABIWindows_x86_64::RegisterIsVolatile
bool RegisterIsVolatile(const lldb_private::RegisterInfo *reg_info) override
Definition: ABIWindows_x86_64.cpp:785
ABIWindows_x86_64::GetPluginNameStatic
static llvm::StringRef GetPluginNameStatic()
Definition: ABIWindows_x86_64.h:75
ABIWindows_x86_64::GetReturnValueObjectSimple
lldb::ValueObjectSP GetReturnValueObjectSimple(lldb_private::Thread &thread, lldb_private::CompilerType &ast_type) const
Definition: ABIWindows_x86_64.cpp:396
ABIWindows_x86_64::GetPointerReturnRegister
bool GetPointerReturnRegister(const char *&name) override
Definition: ABIWindows_x86_64.cpp:103
ABIWindows_x86_64::GetGenericNum
uint32_t GetGenericNum(llvm::StringRef reg) override
Return the generic number of the given register.
Definition: ABIWindows_x86_64.cpp:804
ABIWindows_x86_64
Definition: ABIWindows_x86_64.h:14
ABIX86_64.h
lldb_private::ValueList
Definition: Value.h:157
ABIWindows_x86_64::GetPluginName
llvm::StringRef GetPluginName() override
Definition: ABIWindows_x86_64.h:81
lldb::addr_t
uint64_t addr_t
Definition: lldb-types.h:83
pc
@ pc
Definition: CompactUnwindInfo.cpp:1251
ABIWindows_x86_64::~ABIWindows_x86_64
~ABIWindows_x86_64() override=default
ABIWindows_x86_64::CreateDefaultUnwindPlan
bool CreateDefaultUnwindPlan(lldb_private::UnwindPlan &unwind_plan) override
Definition: ABIWindows_x86_64.cpp:758
lldb_private::Thread
Definition: Thread.h:61
ABIWindows_x86_64::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: ABIWindows_x86_64.cpp:124
ABIWindows_x86_64::CallFrameAddressIsValid
bool CallFrameAddressIsValid(lldb::addr_t cfa) override
Definition: ABIWindows_x86_64.h:49
ABIWindows_x86_64::Terminate
static void Terminate()
Definition: ABIWindows_x86_64.cpp:824
sp
@ sp
Definition: CompactUnwindInfo.cpp:1250
ABIWindows_x86_64::CreateInstance
static lldb::ABISP CreateInstance(lldb::ProcessSP process_sp, const lldb_private::ArchSpec &arch)
Definition: ABIWindows_x86_64.cpp:115
ABIX86_64
Definition: ABIX86_64.h:14
ABIWindows_x86_64::SetReturnValueObject
lldb_private::Status SetReturnValueObject(lldb::StackFrameSP &frame_sp, lldb::ValueObjectSP &new_value) override
Definition: ABIWindows_x86_64.cpp:296
lldb_private::Status
Definition: Status.h:44
uint32_t
ABIWindows_x86_64::CodeAddressIsValid
bool CodeAddressIsValid(lldb::addr_t pc) override
Definition: ABIWindows_x86_64.h:57
ABIWindows_x86_64::CreateFunctionEntryUnwindPlan
bool CreateFunctionEntryUnwindPlan(lldb_private::UnwindPlan &unwind_plan) override
Definition: ABIWindows_x86_64.cpp:738
lldb_private::CompilerType
Generic representation of a type in a programming language.
Definition: CompilerType.h:35
ABIWindows_x86_64::GetReturnValueObjectImpl
lldb::ValueObjectSP GetReturnValueObjectImpl(lldb_private::Thread &thread, lldb_private::CompilerType &type) const override
Definition: ABIWindows_x86_64.cpp:595
ABIWindows_x86_64::Initialize
static void Initialize()
Definition: ABIWindows_x86_64.cpp:819
lldb_private::UnwindPlan
Definition: UnwindPlan.h:53
ABIWindows_x86_64::CreateRegisterMapIfNeeded
void CreateRegisterMapIfNeeded()
ABIWindows_x86_64::RegisterIsCalleeSaved
bool RegisterIsCalleeSaved(const lldb_private::RegisterInfo *reg_info)
Definition: ABIWindows_x86_64.cpp:789