contrib/llvm/tools/lldb/source/Plugins/Process/Utility/RegisterContextDarwin_arm.h

   1 //===-- RegisterContextDarwin_arm.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_RegisterContextDarwin_arm_h_
  11 #define liblldb_RegisterContextDarwin_arm_h_
  12
  13 #include "lldb/Target/RegisterContext.h"
  14 #include "lldb/lldb-private.h"
  15
  16 // BCR address match type
  17 #define BCR_M_IMVA_MATCH ((uint32_t)(0u << 21))
  18 #define BCR_M_CONTEXT_ID_MATCH ((uint32_t)(1u << 21))
  19 #define BCR_M_IMVA_MISMATCH ((uint32_t)(2u << 21))
  20 #define BCR_M_RESERVED ((uint32_t)(3u << 21))
  21
  22 // Link a BVR/BCR or WVR/WCR pair to another
  23 #define E_ENABLE_LINKING ((uint32_t)(1u << 20))
  24
  25 // Byte Address Select
  26 #define BAS_IMVA_PLUS_0 ((uint32_t)(1u << 5))
  27 #define BAS_IMVA_PLUS_1 ((uint32_t)(1u << 6))
  28 #define BAS_IMVA_PLUS_2 ((uint32_t)(1u << 7))
  29 #define BAS_IMVA_PLUS_3 ((uint32_t)(1u << 8))
  30 #define BAS_IMVA_0_1 ((uint32_t)(3u << 5))
  31 #define BAS_IMVA_2_3 ((uint32_t)(3u << 7))
  32 #define BAS_IMVA_ALL ((uint32_t)(0xfu << 5))
  33
  34 // Break only in privileged or user mode
  35 #define S_RSVD ((uint32_t)(0u << 1))
  36 #define S_PRIV ((uint32_t)(1u << 1))
  37 #define S_USER ((uint32_t)(2u << 1))
  38 #define S_PRIV_USER ((S_PRIV) | (S_USER))
  39
  40 #define BCR_ENABLE ((uint32_t)(1u))
  41 #define WCR_ENABLE ((uint32_t)(1u))
  42
  43 // Watchpoint load/store
  44 #define WCR_LOAD ((uint32_t)(1u << 3))
  45 #define WCR_STORE ((uint32_t)(1u << 4))
  46
  47 class RegisterContextDarwin_arm : public lldb_private::RegisterContext {
  48 public:
  49   RegisterContextDarwin_arm(lldb_private::Thread &thread,
  50                             uint32_t concrete_frame_idx);
  51
  52   ~RegisterContextDarwin_arm() override;
  53
  54   void InvalidateAllRegisters() override;
  55
  56   size_t GetRegisterCount() override;
  57
  58   const lldb_private::RegisterInfo *GetRegisterInfoAtIndex(size_t reg) override;
  59
  60   size_t GetRegisterSetCount() override;
  61
  62   const lldb_private::RegisterSet *GetRegisterSet(size_t set) override;
  63
  64   bool ReadRegister(const lldb_private::RegisterInfo *reg_info,
  65                     lldb_private::RegisterValue &reg_value) override;
  66
  67   bool WriteRegister(const lldb_private::RegisterInfo *reg_info,
  68                      const lldb_private::RegisterValue &reg_value) override;
  69
  70   bool ReadAllRegisterValues(lldb::DataBufferSP &data_sp) override;
  71
  72   bool WriteAllRegisterValues(const lldb::DataBufferSP &data_sp) override;
  73
  74   uint32_t ConvertRegisterKindToRegisterNumber(lldb::RegisterKind kind,
  75                                                uint32_t num) override;
  76
  77   uint32_t NumSupportedHardwareBreakpoints() override;
  78
  79   uint32_t SetHardwareBreakpoint(lldb::addr_t addr, size_t size) override;
  80
  81   bool ClearHardwareBreakpoint(uint32_t hw_idx) override;
  82
  83   uint32_t NumSupportedHardwareWatchpoints() override;
  84
  85   uint32_t SetHardwareWatchpoint(lldb::addr_t addr, size_t size, bool read,
  86                                  bool write) override;
  87
  88   bool ClearHardwareWatchpoint(uint32_t hw_index) override;
  89
  90   struct GPR {
  91     uint32_t r[16]; // R0-R15
  92     uint32_t cpsr;  // CPSR
  93   };
  94
  95   struct QReg {
  96     uint8_t bytes[16];
  97   };
  98
  99   struct FPU {
 100     union {
 101       uint32_t s[32];
 102       uint64_t d[32];
 103       QReg q[16]; // the 128-bit NEON registers
 104     } floats;
 105     uint32_t fpscr;
 106   };
 107
 108   //  struct NeonReg
 109   //  {
 110   //      uint8_t bytes[16];
 111   //  };
 112   //
 113   //  struct VFPv3
 114   //  {
 115   //      union {
 116   //          uint32_t s[32];
 117   //          uint64_t d[32];
 118   //          NeonReg  q[16];
 119   //      } v3;
 120   //      uint32_t fpscr;
 121   //  };
 122
 123   struct EXC {
 124     uint32_t exception;
 125     uint32_t fsr; /* Fault status */
 126     uint32_t far; /* Virtual Fault Address */
 127   };
 128
 129   struct DBG {
 130     uint32_t bvr[16];
 131     uint32_t bcr[16];
 132     uint32_t wvr[16];
 133     uint32_t wcr[16];
 134   };
 135
 136   static void LogDBGRegisters(lldb_private::Log *log, const DBG &dbg);
 137
 138 protected:
 139   enum {
 140     GPRRegSet = 1,    // ARM_THREAD_STATE
 141     GPRAltRegSet = 9, // ARM_THREAD_STATE32
 142     FPURegSet = 2,    // ARM_VFP_STATE
 143     EXCRegSet = 3,    // ARM_EXCEPTION_STATE
 144     DBGRegSet = 4     // ARM_DEBUG_STATE
 145   };
 146
 147   enum {
 148     GPRWordCount = sizeof(GPR) / sizeof(uint32_t),
 149     FPUWordCount = sizeof(FPU) / sizeof(uint32_t),
 150     EXCWordCount = sizeof(EXC) / sizeof(uint32_t),
 151     DBGWordCount = sizeof(DBG) / sizeof(uint32_t)
 152   };
 153
 154   enum { Read = 0, Write = 1, kNumErrors = 2 };
 155
 156   GPR gpr;
 157   FPU fpu;
 158   EXC exc;
 159   DBG dbg;
 160   int gpr_errs[2]; // Read/Write errors
 161   int fpu_errs[2]; // Read/Write errors
 162   int exc_errs[2]; // Read/Write errors
 163   int dbg_errs[2]; // Read/Write errors
 164
 165   void InvalidateAllRegisterStates() {
 166     SetError(GPRRegSet, Read, -1);
 167     SetError(FPURegSet, Read, -1);
 168     SetError(EXCRegSet, Read, -1);
 169   }
 170
 171   int GetError(int flavor, uint32_t err_idx) const {
 172     if (err_idx < kNumErrors) {
 173       switch (flavor) {
 174       // When getting all errors, just OR all values together to see if
 175       // we got any kind of error.
 176       case GPRRegSet:
 177         return gpr_errs[err_idx];
 178       case FPURegSet:
 179         return fpu_errs[err_idx];
 180       case EXCRegSet:
 181         return exc_errs[err_idx];
 182       case DBGRegSet:
 183         return dbg_errs[err_idx];
 184       default:
 185         break;
 186       }
 187     }
 188     return -1;
 189   }
 190
 191   bool SetError(int flavor, uint32_t err_idx, int err) {
 192     if (err_idx < kNumErrors) {
 193       switch (flavor) {
 194       case GPRRegSet:
 195         gpr_errs[err_idx] = err;
 196         return true;
 197
 198       case FPURegSet:
 199         fpu_errs[err_idx] = err;
 200         return true;
 201
 202       case EXCRegSet:
 203         exc_errs[err_idx] = err;
 204         return true;
 205
 206       case DBGRegSet:
 207         exc_errs[err_idx] = err;
 208         return true;
 209
 210       default:
 211         break;
 212       }
 213     }
 214     return false;
 215   }
 216
 217   bool RegisterSetIsCached(int set) const { return GetError(set, Read) == 0; }
 218
 219   int ReadGPR(bool force);
 220
 221   int ReadFPU(bool force);
 222
 223   int ReadEXC(bool force);
 224
 225   int ReadDBG(bool force);
 226
 227   int WriteGPR();
 228
 229   int WriteFPU();
 230
 231   int WriteEXC();
 232
 233   int WriteDBG();
 234
 235   // Subclasses override these to do the actual reading.
 236   virtual int DoReadGPR(lldb::tid_t tid, int flavor, GPR &gpr) { return -1; }
 237
 238   virtual int DoReadFPU(lldb::tid_t tid, int flavor, FPU &fpu) = 0;
 239
 240   virtual int DoReadEXC(lldb::tid_t tid, int flavor, EXC &exc) = 0;
 241
 242   virtual int DoReadDBG(lldb::tid_t tid, int flavor, DBG &dbg) = 0;
 243
 244   virtual int DoWriteGPR(lldb::tid_t tid, int flavor, const GPR &gpr) = 0;
 245
 246   virtual int DoWriteFPU(lldb::tid_t tid, int flavor, const FPU &fpu) = 0;
 247
 248   virtual int DoWriteEXC(lldb::tid_t tid, int flavor, const EXC &exc) = 0;
 249
 250   virtual int DoWriteDBG(lldb::tid_t tid, int flavor, const DBG &dbg) = 0;
 251
 252   int ReadRegisterSet(uint32_t set, bool force);
 253
 254   int WriteRegisterSet(uint32_t set);
 255
 256   static uint32_t GetRegisterNumber(uint32_t reg_kind, uint32_t reg_num);
 257
 258   static int GetSetForNativeRegNum(int reg_num);
 259
 260   static size_t GetRegisterInfosCount();
 261
 262   static const lldb_private::RegisterInfo *GetRegisterInfos();
 263 };
 264
 265 #endif // liblldb_RegisterContextDarwin_arm_h_