LLDB  mainline
ABIMacOSX_i386.h
Go to the documentation of this file.
1 //===-- ABIMacOSX_i386.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_ABIMACOSX_I386_H
10 #define LLDB_SOURCE_PLUGINS_ABI_X86_ABIMACOSX_I386_H
11 
12 #include "Plugins/ABI/X86/ABIX86.h"
13 #include "lldb/Core/Value.h"
14 #include "lldb/lldb-private.h"
15 
16 class ABIMacOSX_i386 : public ABIX86 {
17 public:
18  ~ABIMacOSX_i386() override = default;
19 
20  size_t GetRedZoneSize() const override;
21 
23  lldb::addr_t func_addr, lldb::addr_t return_addr,
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 Darwin i386 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  // (4-bytes).
48  // Whitelisting 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.
51  //
52  // If we were to enforce 16-byte alignment, we also need to relax to 4-byte
53  // alignment for non-darwin i386 targets.
55  // Make sure the stack call frame addresses are are 4 byte aligned
56  if (cfa & (4ull - 1ull))
57  return false; // Not 4 byte aligned
58  if (cfa == 0)
59  return false; // Zero is not a valid stack address
60  return true;
61  }
62 
64  // Just make sure the address is a valid 32 bit address.
65  return pc <= UINT32_MAX;
66  }
67 
68  // Static Functions
69 
70  static void Initialize();
71 
72  static void Terminate();
73 
74  static lldb::ABISP CreateInstance(lldb::ProcessSP process_sp, const lldb_private::ArchSpec &arch);
75 
76  // PluginInterface protocol
77 
79 
81 
82  uint32_t GetPluginVersion() override;
83 
84 protected:
85  lldb::ValueObjectSP
87  lldb_private::CompilerType &ast_type) const override;
88 
89  bool RegisterIsCalleeSaved(const lldb_private::RegisterInfo *reg_info);
90 
91  std::string GetMCName(std::string name) override {
92  MapRegisterName(name, "stmm", "st");
93  return name;
94  }
95 
96 private:
97  using ABIX86::ABIX86; // Call CreateInstance instead.
98 };
99 
100 #endif // LLDB_SOURCE_PLUGINS_ABI_X86_ABIMACOSX_I386_H
static void Terminate()
std::string GetMCName(std::string name) override
For the given (capitalized) lldb register name, return the name of this register in the MCRegisterInf...
static lldb::ABISP CreateInstance(lldb::ProcessSP process_sp, const lldb_private::ArchSpec &arch)
lldb_private::ConstString GetPluginName() override
uint32_t GetPluginVersion() override
static void MapRegisterName(std::string &reg, llvm::StringRef from_prefix, llvm::StringRef to_prefix)
If the register name is of the form "<from_prefix>[<number>]" then change the name to "<to_prefix>[<n...
Definition: ABI.cpp:269
An architecture specification class.
Definition: ArchSpec.h:33
~ABIMacOSX_i386() override=default
bool PrepareTrivialCall(lldb_private::Thread &thread, lldb::addr_t sp, lldb::addr_t func_addr, lldb::addr_t return_addr, llvm::ArrayRef< lldb::addr_t > args) const override
#define UINT32_MAX
Definition: lldb-defines.h:31
lldb_private::Status SetReturnValueObject(lldb::StackFrameSP &frame_sp, lldb::ValueObjectSP &new_value) override
static lldb_private::ConstString GetPluginNameStatic()
bool GetArgumentValues(lldb_private::Thread &thread, lldb_private::ValueList &values) const override
Definition: ABIX86.h:14
bool RegisterIsCalleeSaved(const lldb_private::RegisterInfo *reg_info)
size_t GetRedZoneSize() const override
bool CreateDefaultUnwindPlan(lldb_private::UnwindPlan &unwind_plan) override
bool CreateFunctionEntryUnwindPlan(lldb_private::UnwindPlan &unwind_plan) override
uint64_t addr_t
Definition: lldb-types.h:83
bool RegisterIsVolatile(const lldb_private::RegisterInfo *reg_info) override
A uniqued constant string class.
Definition: ConstString.h:40
Represents a generic type in a programming language.
Definition: CompilerType.h:33
bool CallFrameAddressIsValid(lldb::addr_t cfa) override
bool CodeAddressIsValid(lldb::addr_t pc) override
lldb::ValueObjectSP GetReturnValueObjectImpl(lldb_private::Thread &thread, lldb_private::CompilerType &ast_type) const override
static void Initialize()
An error handling class.
Definition: Status.h:44