contrib/llvm/tools/lldb/source/Plugins/ABI/MacOSX-arm64/ABIMacOSX_arm64.h

   1 //===-- ABIMacOSX_arm64.h ---------------------------------------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9
  10 #ifndef liblldb_ABIMacOSX_arm64_h_
  11 #define liblldb_ABIMacOSX_arm64_h_
  12
  13 // C Includes
  14 // C++ Includes
  15 // Other libraries and framework includes
  16 // Project includes
  17 #include "lldb/lldb-private.h"
  18 #include "lldb/Core/ConstString.h"
  19 #include "lldb/Target/ABI.h"
  20
  21 class ABIMacOSX_arm64 :
  22     public lldb_private::ABI
  23 {
  24 public:
  25     ~ABIMacOSX_arm64() override = default;
  26
  27     size_t
  28     GetRedZoneSize() const override;
  29
  30     bool
  31     PrepareTrivialCall(lldb_private::Thread &thread,
  32                        lldb::addr_t sp,
  33                        lldb::addr_t functionAddress,
  34                        lldb::addr_t returnAddress,
  35                        llvm::ArrayRef<lldb::addr_t> args) const override;
  36
  37     bool
  38     GetArgumentValues(lldb_private::Thread &thread,
  39                       lldb_private::ValueList &values) const override;
  40
  41     bool
  42     CreateFunctionEntryUnwindPlan(lldb_private::UnwindPlan &unwind_plan) override;
  43
  44     bool
  45     CreateDefaultUnwindPlan(lldb_private::UnwindPlan &unwind_plan) override;
  46
  47     bool
  48     RegisterIsVolatile(const lldb_private::RegisterInfo *reg_info) override;
  49
  50     // The arm64 ABI requires that stack frames be 16 byte aligned.
  51     // When there is a trap handler on the stack, e.g. _sigtramp in userland
  52     // code, we've seen that the stack pointer is often not aligned properly
  53     // before the handler is invoked.  This means that lldb will stop the unwind
  54     // early -- before the function which caused the trap.
  55     //
  56     // To work around this, we relax that alignment to be just word-size (8-bytes).
  57     // Whitelisting the trap handlers for user space would be easy (_sigtramp) but
  58     // in other environments there can be a large number of different functions
  59     // involved in async traps.
  60     bool
  61     CallFrameAddressIsValid(lldb::addr_t cfa) override
  62     {
  63         // Make sure the stack call frame addresses are are 8 byte aligned
  64         if (cfa & (8ull - 1ull))
  65             return false;   // Not 8 byte aligned
  66         if (cfa == 0)
  67             return false;   // Zero is not a valid stack address
  68         return true;
  69     }
  70
  71     bool
  72     CodeAddressIsValid(lldb::addr_t pc) override
  73     {
  74         if (pc & (4ull - 1ull))
  75             return false;   // Not 4 byte aligned
  76
  77         // Anything else if fair game..
  78         return true;
  79     }
  80
  81     const lldb_private::RegisterInfo *
  82     GetRegisterInfoArray(uint32_t &count) override;
  83
  84     //------------------------------------------------------------------
  85     // Static Functions
  86     //------------------------------------------------------------------
  87
  88     static void
  89     Initialize();
  90
  91     static void
  92     Terminate();
  93
  94     static lldb::ABISP
  95     CreateInstance (const lldb_private::ArchSpec &arch);
  96
  97     //------------------------------------------------------------------
  98     // PluginInterface protocol
  99     //------------------------------------------------------------------
 100
 101     static lldb_private::ConstString
 102     GetPluginNameStatic();
 103
 104     lldb_private::ConstString
 105     GetPluginName() override
 106     {
 107         return GetPluginNameStatic();
 108     }
 109
 110     uint32_t
 111     GetPluginVersion() override;
 112
 113     lldb_private::Error
 114     SetReturnValueObject(lldb::StackFrameSP &frame_sp, lldb::ValueObjectSP &new_value) override;
 115
 116 protected:
 117     lldb::ValueObjectSP
 118     GetReturnValueObjectImpl (lldb_private::Thread &thread,
 119                     lldb_private::CompilerType &ast_type) const override;
 120
 121 private:
 122     ABIMacOSX_arm64() :
 123         lldb_private::ABI()
 124     {
 125         // Call CreateInstance instead.
 126     }
 127 };
 128
 129 #endif // liblldb_ABIMacOSX_arm64_h_