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
13#include "lldb/Core/Value.h"
14#include "lldb/lldb-private.h"
15
17public:
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
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 // 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.
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 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
75
76 // PluginInterface protocol
77
78 static llvm::StringRef GetPluginNameStatic() { return "abi.macosx-i386"; }
79
80 llvm::StringRef GetPluginName() override { return GetPluginNameStatic(); }
81
82protected:
85 lldb_private::CompilerType &ast_type) const override;
86
88
89 std::string GetMCName(std::string name) override {
90 MapRegisterName(name, "stmm", "st");
91 return name;
92 }
93
94private:
95 using ABIX86_i386::ABIX86_i386; // Call CreateInstance instead.
96};
97
98#endif // LLDB_SOURCE_PLUGINS_ABI_X86_ABIMACOSX_I386_H
bool RegisterIsCalleeSaved(const lldb_private::RegisterInfo *reg_info)
static void Initialize()
static void Terminate()
llvm::StringRef GetPluginName() override
bool GetArgumentValues(lldb_private::Thread &thread, lldb_private::ValueList &values) const override
bool CodeAddressIsValid(lldb::addr_t pc) override
bool CreateDefaultUnwindPlan(lldb_private::UnwindPlan &unwind_plan) override
bool CallFrameAddressIsValid(lldb::addr_t cfa) override
static lldb::ABISP CreateInstance(lldb::ProcessSP process_sp, const lldb_private::ArchSpec &arch)
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
bool RegisterIsVolatile(const lldb_private::RegisterInfo *reg_info) override
~ABIMacOSX_i386() override=default
bool CreateFunctionEntryUnwindPlan(lldb_private::UnwindPlan &unwind_plan) override
lldb::ValueObjectSP GetReturnValueObjectImpl(lldb_private::Thread &thread, lldb_private::CompilerType &ast_type) const override
std::string GetMCName(std::string name) override
For the given (capitalized) lldb register name, return the name of this register in the MCRegisterInf...
lldb_private::Status SetReturnValueObject(lldb::StackFrameSP &frame_sp, lldb::ValueObjectSP &new_value) override
static llvm::StringRef GetPluginNameStatic()
size_t GetRedZoneSize() const override
An architecture specification class.
Definition: ArchSpec.h:31
Generic representation of a type in a programming language.
Definition: CompilerType.h:36
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:272
An error handling class.
Definition: Status.h:44
#define UINT32_MAX
Definition: lldb-defines.h:19
std::shared_ptr< lldb_private::ABI > ABISP
Definition: lldb-forward.h:310
std::shared_ptr< lldb_private::StackFrame > StackFrameSP
Definition: lldb-forward.h:412
std::shared_ptr< lldb_private::ValueObject > ValueObjectSP
Definition: lldb-forward.h:472
std::shared_ptr< lldb_private::Process > ProcessSP
Definition: lldb-forward.h:381
uint64_t addr_t
Definition: lldb-types.h:79
Every register is described in detail including its name, alternate name (optional),...