contrib/llvm/tools/lldb/source/Plugins/ABI/SysV-x86_64/ABISysV_x86_64.h

   1 //===-- ABISysV_x86_64.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_ABISysV_x86_64_h_
  11 #define liblldb_ABISysV_x86_64_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/Target/ABI.h"
  19
  20 class ABISysV_x86_64 :
  21     public lldb_private::ABI
  22 {
  23 public:
  24
  25     ~ABISysV_x86_64()
  26     {
  27     }
  28
  29     virtual size_t
  30     GetRedZoneSize () const;
  31
  32     virtual bool
  33     PrepareTrivialCall (lldb_private::Thread &thread,
  34                         lldb::addr_t sp,
  35                         lldb::addr_t functionAddress,
  36                         lldb::addr_t returnAddress,
  37                         llvm::ArrayRef<lldb::addr_t> args) const;
  38
  39     virtual bool
  40     GetArgumentValues (lldb_private::Thread &thread,
  41                        lldb_private::ValueList &values) const;
  42
  43     virtual lldb_private::Error
  44     SetReturnValueObject(lldb::StackFrameSP &frame_sp, lldb::ValueObjectSP &new_value);
  45
  46 protected:
  47     lldb::ValueObjectSP
  48     GetReturnValueObjectSimple (lldb_private::Thread &thread,
  49                                 lldb_private::ClangASTType &ast_type) const;
  50
  51 public:
  52     virtual lldb::ValueObjectSP
  53     GetReturnValueObjectImpl (lldb_private::Thread &thread,
  54                           lldb_private::ClangASTType &type) const;
  55
  56     virtual bool
  57     CreateFunctionEntryUnwindPlan (lldb_private::UnwindPlan &unwind_plan);
  58
  59     virtual bool
  60     CreateDefaultUnwindPlan (lldb_private::UnwindPlan &unwind_plan);
  61
  62     virtual bool
  63     RegisterIsVolatile (const lldb_private::RegisterInfo *reg_info);
  64
  65     // The SysV x86_64 ABI requires that stack frames be 16 byte aligned.
  66     // When there is a trap handler on the stack, e.g. _sigtramp in userland
  67     // code, we've seen that the stack pointer is often not aligned properly
  68     // before the handler is invoked.  This means that lldb will stop the unwind
  69     // early -- before the function which caused the trap.
  70     //
  71     // To work around this, we relax that alignment to be just word-size (8-bytes).
  72     // Whitelisting the trap handlers for user space would be easy (_sigtramp) but
  73     // in other environments there can be a large number of different functions
  74     // involved in async traps.
  75     virtual bool
  76     CallFrameAddressIsValid (lldb::addr_t cfa)
  77     {
  78         // Make sure the stack call frame addresses are 8 byte aligned
  79         if (cfa & (8ull - 1ull))
  80             return false;   // Not 8 byte aligned
  81         if (cfa == 0)
  82             return false;   // Zero is not a valid stack address
  83         return true;
  84     }
  85
  86     virtual bool
  87     CodeAddressIsValid (lldb::addr_t pc)
  88     {
  89         // We have a 64 bit address space, so anything is valid as opcodes
  90         // aren't fixed width...
  91         return true;
  92     }
  93
  94     virtual const lldb_private::RegisterInfo *
  95     GetRegisterInfoArray (uint32_t &count);
  96     //------------------------------------------------------------------
  97     // Static Functions
  98     //------------------------------------------------------------------
  99     static void
 100     Initialize();
 101
 102     static void
 103     Terminate();
 104
 105     static lldb::ABISP
 106     CreateInstance (const lldb_private::ArchSpec &arch);
 107
 108     static lldb_private::ConstString
 109     GetPluginNameStatic();
 110
 111     //------------------------------------------------------------------
 112     // PluginInterface protocol
 113     //------------------------------------------------------------------
 114     virtual lldb_private::ConstString
 115     GetPluginName();
 116
 117     virtual uint32_t
 118     GetPluginVersion();
 119
 120 protected:
 121     void
 122     CreateRegisterMapIfNeeded ();
 123
 124     bool
 125     RegisterIsCalleeSaved (const lldb_private::RegisterInfo *reg_info);
 126
 127 private:
 128     ABISysV_x86_64() : lldb_private::ABI() { } // Call CreateInstance instead.
 129 };
 130
 131 #endif  // liblldb_ABI_h_