1061da546Spatrick //===-- DNBArchImplI386.h ---------------------------------------*- C++ -*-===// 2061da546Spatrick // 3061da546Spatrick // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4061da546Spatrick // See https://llvm.org/LICENSE.txt for license information. 5061da546Spatrick // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6061da546Spatrick // 7061da546Spatrick //===----------------------------------------------------------------------===// 8061da546Spatrick // 9061da546Spatrick // Created by Greg Clayton on 6/25/07. 10061da546Spatrick // 11061da546Spatrick //===----------------------------------------------------------------------===// 12061da546Spatrick 13dda28197Spatrick #ifndef LLDB_TOOLS_DEBUGSERVER_SOURCE_MACOSX_I386_DNBARCHIMPLI386_H 14dda28197Spatrick #define LLDB_TOOLS_DEBUGSERVER_SOURCE_MACOSX_I386_DNBARCHIMPLI386_H 15061da546Spatrick 16061da546Spatrick #if defined(__i386__) || defined(__x86_64__) 17061da546Spatrick 18061da546Spatrick #include "DNBArch.h" 19061da546Spatrick #include "MachRegisterStatesI386.h" 20061da546Spatrick 21061da546Spatrick #include <map> 22061da546Spatrick 23061da546Spatrick class MachThread; 24061da546Spatrick 25061da546Spatrick class DNBArchImplI386 : public DNBArchProtocol { 26061da546Spatrick public: DNBArchImplI386(MachThread * thread)27061da546Spatrick DNBArchImplI386(MachThread *thread) 28061da546Spatrick : DNBArchProtocol(), m_thread(thread), m_state(), m_2pc_dbg_checkpoint(), 29061da546Spatrick m_2pc_trans_state(Trans_Done), m_saved_register_states() {} ~DNBArchImplI386()30061da546Spatrick virtual ~DNBArchImplI386() {} 31061da546Spatrick 32061da546Spatrick static void Initialize(); 33061da546Spatrick 34*be691f3bSpatrick bool GetRegisterValue(uint32_t set, uint32_t reg, 35*be691f3bSpatrick DNBRegisterValue *value) override; 36*be691f3bSpatrick bool SetRegisterValue(uint32_t set, uint32_t reg, 37*be691f3bSpatrick const DNBRegisterValue *value) override; 38*be691f3bSpatrick nub_size_t GetRegisterContext(void *buf, nub_size_t buf_len) override; 39*be691f3bSpatrick nub_size_t SetRegisterContext(const void *buf, nub_size_t buf_len) override; 40*be691f3bSpatrick uint32_t SaveRegisterState() override; 41*be691f3bSpatrick bool RestoreRegisterState(uint32_t save_id) override; 42061da546Spatrick 43*be691f3bSpatrick kern_return_t GetRegisterState(int set, bool force) override; 44*be691f3bSpatrick kern_return_t SetRegisterState(int set) override; 45*be691f3bSpatrick bool RegisterSetStateIsValid(int set) const override; 46061da546Spatrick 47*be691f3bSpatrick uint64_t GetPC(uint64_t failValue) override; // Get program counter 48*be691f3bSpatrick kern_return_t SetPC(uint64_t value) override; 49*be691f3bSpatrick uint64_t GetSP(uint64_t failValue) override; // Get stack pointer 50*be691f3bSpatrick void ThreadWillResume() override; 51*be691f3bSpatrick bool ThreadDidStop() override; 52*be691f3bSpatrick bool NotifyException(MachException::Data &exc) override; 53061da546Spatrick 54*be691f3bSpatrick uint32_t NumSupportedHardwareBreakpoints() override; 55*be691f3bSpatrick uint32_t NumSupportedHardwareWatchpoints() override; 56*be691f3bSpatrick uint32_t EnableHardwareBreakpoint(nub_addr_t addr, nub_size_t size, 57*be691f3bSpatrick bool also_set_on_task) override; 58*be691f3bSpatrick bool DisableHardwareBreakpoint(uint32_t hw_index, 59*be691f3bSpatrick bool also_set_on_task) override; 60*be691f3bSpatrick uint32_t EnableHardwareWatchpoint(nub_addr_t addr, nub_size_t size, 61061da546Spatrick bool read, bool write, 62*be691f3bSpatrick bool also_set_on_task) override; 63*be691f3bSpatrick bool DisableHardwareWatchpoint(uint32_t hw_break_index, 64*be691f3bSpatrick bool also_set_on_task) override; 65*be691f3bSpatrick uint32_t GetHardwareWatchpointHit(nub_addr_t &addr) override; 66061da546Spatrick 67061da546Spatrick protected: 68061da546Spatrick kern_return_t EnableHardwareSingleStep(bool enable); 69061da546Spatrick 70061da546Spatrick typedef __i386_thread_state_t GPR; 71061da546Spatrick typedef __i386_float_state_t FPU; 72061da546Spatrick typedef __i386_exception_state_t EXC; 73061da546Spatrick typedef __i386_avx_state_t AVX; 74061da546Spatrick typedef __i386_debug_state_t DBG; 75061da546Spatrick 76061da546Spatrick static const DNBRegisterInfo g_gpr_registers[]; 77061da546Spatrick static const DNBRegisterInfo g_fpu_registers_no_avx[]; 78061da546Spatrick static const DNBRegisterInfo g_fpu_registers_avx[]; 79061da546Spatrick static const DNBRegisterInfo g_exc_registers[]; 80061da546Spatrick static const DNBRegisterSetInfo g_reg_sets_no_avx[]; 81061da546Spatrick static const DNBRegisterSetInfo g_reg_sets_avx[]; 82061da546Spatrick static const size_t k_num_gpr_registers; 83061da546Spatrick static const size_t k_num_fpu_registers_no_avx; 84061da546Spatrick static const size_t k_num_fpu_registers_avx; 85061da546Spatrick static const size_t k_num_exc_registers; 86061da546Spatrick static const size_t k_num_all_registers_no_avx; 87061da546Spatrick static const size_t k_num_all_registers_avx; 88061da546Spatrick static const size_t k_num_register_sets; 89061da546Spatrick 90061da546Spatrick typedef __i386_avx512f_state_t AVX512F; 91061da546Spatrick static const DNBRegisterInfo g_fpu_registers_avx512f[]; 92061da546Spatrick static const DNBRegisterSetInfo g_reg_sets_avx512f[]; 93061da546Spatrick static const size_t k_num_fpu_registers_avx512f; 94061da546Spatrick static const size_t k_num_all_registers_avx512f; 95061da546Spatrick 96061da546Spatrick enum RegisterSet { 97061da546Spatrick e_regSetALL = REGISTER_SET_ALL, 98061da546Spatrick e_regSetGPR, 99061da546Spatrick e_regSetFPU, 100061da546Spatrick e_regSetEXC, 101061da546Spatrick e_regSetDBG, 102061da546Spatrick kNumRegisterSets 103061da546Spatrick }; 104061da546Spatrick 105061da546Spatrick enum RegisterSetWordSize { 106061da546Spatrick e_regSetWordSizeGPR = sizeof(GPR) / sizeof(int), 107061da546Spatrick e_regSetWordSizeFPU = sizeof(FPU) / sizeof(int), 108061da546Spatrick e_regSetWordSizeEXC = sizeof(EXC) / sizeof(int), 109061da546Spatrick e_regSetWordSizeAVX = sizeof(AVX) / sizeof(int), 110061da546Spatrick e_regSetWordSizeAVX512f = sizeof(AVX512F) / sizeof(int), 111061da546Spatrick e_regSetWordSizeDBG = sizeof(DBG) / sizeof(int) 112061da546Spatrick }; 113061da546Spatrick 114061da546Spatrick enum { Read = 0, Write = 1, kNumErrors = 2 }; 115061da546Spatrick 116061da546Spatrick struct Context { 117061da546Spatrick GPR gpr; 118061da546Spatrick union { 119061da546Spatrick FPU no_avx; 120061da546Spatrick AVX avx; 121061da546Spatrick AVX512F avx512f; 122061da546Spatrick } fpu; 123061da546Spatrick EXC exc; 124061da546Spatrick DBG dbg; 125061da546Spatrick }; 126061da546Spatrick 127061da546Spatrick struct State { 128061da546Spatrick Context context; 129061da546Spatrick kern_return_t gpr_errs[2]; // Read/Write errors 130061da546Spatrick kern_return_t fpu_errs[2]; // Read/Write errors 131061da546Spatrick kern_return_t exc_errs[2]; // Read/Write errors 132061da546Spatrick kern_return_t dbg_errs[2]; // Read/Write errors 133061da546Spatrick StateState134061da546Spatrick State() { 135061da546Spatrick uint32_t i; 136061da546Spatrick for (i = 0; i < kNumErrors; i++) { 137061da546Spatrick gpr_errs[i] = -1; 138061da546Spatrick fpu_errs[i] = -1; 139061da546Spatrick exc_errs[i] = -1; 140061da546Spatrick dbg_errs[i] = -1; 141061da546Spatrick } 142061da546Spatrick } InvalidateAllRegisterStatesState143061da546Spatrick void InvalidateAllRegisterStates() { SetError(e_regSetALL, Read, -1); } GetErrorState144061da546Spatrick kern_return_t GetError(int flavor, uint32_t err_idx) const { 145061da546Spatrick if (err_idx < kNumErrors) { 146061da546Spatrick switch (flavor) { 147061da546Spatrick // When getting all errors, just OR all values together to see if 148061da546Spatrick // we got any kind of error. 149061da546Spatrick case e_regSetALL: 150061da546Spatrick return gpr_errs[err_idx] | fpu_errs[err_idx] | exc_errs[err_idx]; 151061da546Spatrick case e_regSetGPR: 152061da546Spatrick return gpr_errs[err_idx]; 153061da546Spatrick case e_regSetFPU: 154061da546Spatrick return fpu_errs[err_idx]; 155061da546Spatrick case e_regSetEXC: 156061da546Spatrick return exc_errs[err_idx]; 157061da546Spatrick case e_regSetDBG: 158061da546Spatrick return dbg_errs[err_idx]; 159061da546Spatrick default: 160061da546Spatrick break; 161061da546Spatrick } 162061da546Spatrick } 163061da546Spatrick return -1; 164061da546Spatrick } SetErrorState165061da546Spatrick bool SetError(int flavor, uint32_t err_idx, kern_return_t err) { 166061da546Spatrick if (err_idx < kNumErrors) { 167061da546Spatrick switch (flavor) { 168061da546Spatrick case e_regSetALL: 169061da546Spatrick gpr_errs[err_idx] = fpu_errs[err_idx] = exc_errs[err_idx] = 170061da546Spatrick dbg_errs[err_idx] = err; 171061da546Spatrick return true; 172061da546Spatrick 173061da546Spatrick case e_regSetGPR: 174061da546Spatrick gpr_errs[err_idx] = err; 175061da546Spatrick return true; 176061da546Spatrick 177061da546Spatrick case e_regSetFPU: 178061da546Spatrick fpu_errs[err_idx] = err; 179061da546Spatrick return true; 180061da546Spatrick 181061da546Spatrick case e_regSetEXC: 182061da546Spatrick exc_errs[err_idx] = err; 183061da546Spatrick return true; 184061da546Spatrick 185061da546Spatrick case e_regSetDBG: 186061da546Spatrick dbg_errs[err_idx] = err; 187061da546Spatrick return true; 188061da546Spatrick 189061da546Spatrick default: 190061da546Spatrick break; 191061da546Spatrick } 192061da546Spatrick } 193061da546Spatrick return false; 194061da546Spatrick } RegsAreValidState195061da546Spatrick bool RegsAreValid(int flavor) const { 196061da546Spatrick return GetError(flavor, Read) == KERN_SUCCESS; 197061da546Spatrick } 198061da546Spatrick }; 199061da546Spatrick 200061da546Spatrick kern_return_t GetGPRState(bool force); 201061da546Spatrick kern_return_t GetFPUState(bool force); 202061da546Spatrick kern_return_t GetEXCState(bool force); 203061da546Spatrick kern_return_t GetDBGState(bool force); 204061da546Spatrick 205061da546Spatrick kern_return_t SetGPRState(); 206061da546Spatrick kern_return_t SetFPUState(); 207061da546Spatrick kern_return_t SetEXCState(); 208061da546Spatrick kern_return_t SetDBGState(bool also_set_on_task); 209061da546Spatrick 210061da546Spatrick static DNBArchProtocol *Create(MachThread *thread); 211061da546Spatrick 212061da546Spatrick static const uint8_t *SoftwareBreakpointOpcode(nub_size_t byte_size); 213061da546Spatrick 214061da546Spatrick static const DNBRegisterSetInfo *GetRegisterSetInfo(nub_size_t *num_reg_sets); 215061da546Spatrick 216061da546Spatrick static uint32_t GetRegisterContextSize(); 217061da546Spatrick 218dda28197Spatrick static void SetHardwareBreakpoint(DBG &debug_state, uint32_t hw_index, 219dda28197Spatrick nub_addr_t addr, nub_size_t size); 220dda28197Spatrick 221061da546Spatrick // Helper functions for watchpoint manipulations. 222061da546Spatrick static void SetWatchpoint(DBG &debug_state, uint32_t hw_index, 223061da546Spatrick nub_addr_t addr, nub_size_t size, bool read, 224061da546Spatrick bool write); 225061da546Spatrick static void ClearWatchpoint(DBG &debug_state, uint32_t hw_index); 226061da546Spatrick static bool IsWatchpointVacant(const DBG &debug_state, uint32_t hw_index); 227061da546Spatrick static void ClearWatchpointHits(DBG &debug_state); 228061da546Spatrick static bool IsWatchpointHit(const DBG &debug_state, uint32_t hw_index); 229061da546Spatrick static nub_addr_t GetWatchAddress(const DBG &debug_state, uint32_t hw_index); 230061da546Spatrick 231*be691f3bSpatrick bool StartTransForHWP() override; 232*be691f3bSpatrick bool RollbackTransForHWP() override; 233*be691f3bSpatrick bool FinishTransForHWP() override; 234061da546Spatrick DBG GetDBGCheckpoint(); 235061da546Spatrick 236061da546Spatrick MachThread *m_thread; 237061da546Spatrick State m_state; 238061da546Spatrick DBG m_2pc_dbg_checkpoint; 239061da546Spatrick uint32_t m_2pc_trans_state; // Is transaction of DBG state change: Pedning 240061da546Spatrick // (0), Done (1), or Rolled Back (2)? 241061da546Spatrick typedef std::map<uint32_t, Context> SaveRegisterStates; 242061da546Spatrick SaveRegisterStates m_saved_register_states; 243061da546Spatrick }; 244061da546Spatrick 245061da546Spatrick #endif // #if defined (__i386__) || defined (__x86_64__) 246dda28197Spatrick #endif // LLDB_TOOLS_DEBUGSERVER_SOURCE_MACOSX_I386_DNBARCHIMPLI386_H 247