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

   1 //===-- RegisterInfos_i386.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 // C Includes
  11 #include <stddef.h>
  12
  13 // C++ Includes
  14 // Other libraries and framework includes
  15 #include "llvm/Support/Compiler.h"
  16
  17 // Project includes
  18
  19 #ifdef DECLARE_REGISTER_INFOS_I386_STRUCT
  20
  21 // Computes the offset of the given GPR in the user data area.
  22 #define GPR_OFFSET(regname) \
  23     (LLVM_EXTENSION offsetof(GPR, regname))
  24
  25 // Computes the offset of the given FPR in the extended data area.
  26 #define FPR_OFFSET(regname)  \
  27     (LLVM_EXTENSION offsetof(UserArea, i387) + \
  28      LLVM_EXTENSION offsetof(FPR_i386, regname))
  29
  30 // Computes the offset of the YMM register assembled from register halves.
  31 // Based on DNBArchImplI386.cpp from debugserver
  32 #define YMM_OFFSET(reg_index) \
  33     (LLVM_EXTENSION offsetof(UserArea, i387) + \
  34      LLVM_EXTENSION offsetof(FPR, xstate) + \
  35      LLVM_EXTENSION offsetof(FXSAVE, xmm[7]) + \
  36      sizeof(XMMReg) + (32 * reg_index))
  37
  38 // Number of bytes needed to represent a FPR.
  39 #if !defined(FPR_SIZE)
  40 #define FPR_SIZE(reg) sizeof(((FXSAVE*)NULL)->reg)
  41 #endif
  42
  43 // Number of bytes needed to represent the i'th FP register.
  44 #define FP_SIZE sizeof(((MMSReg*)NULL)->bytes)
  45
  46 // Number of bytes needed to represent an XMM register.
  47 #define XMM_SIZE sizeof(XMMReg)
  48
  49 // Number of bytes needed to represent a YMM register.
  50 #define YMM_SIZE sizeof(YMMReg)
  51
  52 // Note that the size and offset will be updated by platform-specific classes.
  53 #define DEFINE_GPR(reg, alt, kind1, kind2, kind3, kind4)            \
  54     { #reg, alt, sizeof(((GPR*)NULL)->reg), GPR_OFFSET(reg), eEncodingUint,  \
  55       eFormatHex, { kind1, kind2, kind3, kind4, lldb_##reg##_i386 }, NULL, NULL }
  56
  57 #define DEFINE_FPR(name, reg, kind1, kind2, kind3, kind4)           \
  58     { #name, NULL, FPR_SIZE(reg), FPR_OFFSET(reg), eEncodingUint,   \
  59       eFormatHex, { kind1, kind2, kind3, kind4, lldb_##name##_i386 }, NULL, NULL }
  60
  61 // RegisterKind: EHFrame, DWARF, Generic, Process Plugin, LLDB
  62
  63 #define DEFINE_FP_ST(reg, i)                                       \
  64     { #reg#i, NULL, FP_SIZE, LLVM_EXTENSION FPR_OFFSET(stmm[i]),    \
  65       eEncodingVector, eFormatVectorOfUInt8,                       \
  66       { ehframe_st##i##_i386, dwarf_st##i##_i386, LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM, lldb_st##i##_i386 }, \
  67       NULL, NULL }
  68
  69 #define DEFINE_FP_MM(reg, i)                                                \
  70     { #reg#i, NULL, sizeof(uint64_t), LLVM_EXTENSION FPR_OFFSET(stmm[i]),   \
  71       eEncodingUint, eFormatHex,                                            \
  72       { ehframe_mm##i##_i386, dwarf_mm##i##_i386, LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM, lldb_mm##i##_i386 }, \
  73       NULL, NULL }
  74
  75 #define DEFINE_XMM(reg, i)                                         \
  76     { #reg#i, NULL, XMM_SIZE, LLVM_EXTENSION FPR_OFFSET(reg[i]),   \
  77       eEncodingVector, eFormatVectorOfUInt8,                       \
  78       { ehframe_##reg##i##_i386, dwarf_##reg##i##_i386, LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM, lldb_##reg##i##_i386}, \
  79       NULL, NULL }
  80
  81 // I believe the YMM registers use dwarf_xmm_%_i386 register numbers and then differentiate based on register size.
  82 #define DEFINE_YMM(reg, i)                                         \
  83     { #reg#i, NULL, YMM_SIZE, LLVM_EXTENSION YMM_OFFSET(i),        \
  84       eEncodingVector, eFormatVectorOfUInt8,                       \
  85       { LLDB_INVALID_REGNUM, dwarf_xmm##i##_i386, LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM, lldb_##reg##i##_i386 }, \
  86       NULL, NULL }
  87
  88 #define DEFINE_DR(reg, i)                                               \
  89     { #reg#i, NULL, DR_SIZE, DR_OFFSET(i), eEncodingUint, eFormatHex,   \
  90       { LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM,  \
  91         LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM }, NULL, NULL }
  92
  93 #define DEFINE_GPR_PSEUDO_16(reg16, reg32)                  \
  94     { #reg16, NULL, 2, GPR_OFFSET(reg32), eEncodingUint,    \
  95       eFormatHex, { LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM, lldb_##reg16##_i386 }, RegisterContextPOSIX_x86::g_contained_##reg32, RegisterContextPOSIX_x86::g_invalidate_##reg32 }
  96 #define DEFINE_GPR_PSEUDO_8H(reg8, reg32)                   \
  97     { #reg8, NULL, 1, GPR_OFFSET(reg32)+1, eEncodingUint,   \
  98       eFormatHex, { LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM, lldb_##reg8##_i386 }, RegisterContextPOSIX_x86::g_contained_##reg32, RegisterContextPOSIX_x86::g_invalidate_##reg32 }
  99 #define DEFINE_GPR_PSEUDO_8L(reg8, reg32)                   \
 100     { #reg8, NULL, 1, GPR_OFFSET(reg32), eEncodingUint,     \
 101       eFormatHex, { LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM, lldb_##reg8##_i386 }, RegisterContextPOSIX_x86::g_contained_##reg32, RegisterContextPOSIX_x86::g_invalidate_##reg32 }
 102
 103 static RegisterInfo
 104 g_register_infos_i386[] =
 105 {
 106     // General purpose registers.
 107     DEFINE_GPR(eax,    nullptr, ehframe_eax_i386,    dwarf_eax_i386,      LLDB_INVALID_REGNUM,       LLDB_INVALID_REGNUM),
 108     DEFINE_GPR(ebx,    nullptr, ehframe_ebx_i386,    dwarf_ebx_i386,      LLDB_INVALID_REGNUM,       LLDB_INVALID_REGNUM),
 109     DEFINE_GPR(ecx,    nullptr, ehframe_ecx_i386,    dwarf_ecx_i386,      LLDB_INVALID_REGNUM,       LLDB_INVALID_REGNUM),
 110     DEFINE_GPR(edx,    nullptr, ehframe_edx_i386,    dwarf_edx_i386,      LLDB_INVALID_REGNUM,       LLDB_INVALID_REGNUM),
 111     DEFINE_GPR(edi,    nullptr, ehframe_edi_i386,    dwarf_edi_i386,      LLDB_INVALID_REGNUM,       LLDB_INVALID_REGNUM),
 112     DEFINE_GPR(esi,    nullptr, ehframe_esi_i386,    dwarf_esi_i386,      LLDB_INVALID_REGNUM,       LLDB_INVALID_REGNUM),
 113     DEFINE_GPR(ebp,    "fp",    ehframe_ebp_i386,    dwarf_ebp_i386,      LLDB_REGNUM_GENERIC_FP,    LLDB_INVALID_REGNUM),
 114     DEFINE_GPR(esp,    "sp",    ehframe_esp_i386,    dwarf_esp_i386,      LLDB_REGNUM_GENERIC_SP,    LLDB_INVALID_REGNUM),
 115     DEFINE_GPR(eip,    "pc",    ehframe_eip_i386,    dwarf_eip_i386,      LLDB_REGNUM_GENERIC_PC,    LLDB_INVALID_REGNUM),
 116     DEFINE_GPR(eflags, "flags", ehframe_eflags_i386, dwarf_eflags_i386,   LLDB_REGNUM_GENERIC_FLAGS, LLDB_INVALID_REGNUM),
 117     DEFINE_GPR(cs,     nullptr, LLDB_INVALID_REGNUM, dwarf_cs_i386,       LLDB_INVALID_REGNUM,       LLDB_INVALID_REGNUM),
 118     DEFINE_GPR(fs,     nullptr, LLDB_INVALID_REGNUM, dwarf_fs_i386,       LLDB_INVALID_REGNUM,       LLDB_INVALID_REGNUM),
 119     DEFINE_GPR(gs,     nullptr, LLDB_INVALID_REGNUM, dwarf_gs_i386,       LLDB_INVALID_REGNUM,       LLDB_INVALID_REGNUM),
 120     DEFINE_GPR(ss,     nullptr, LLDB_INVALID_REGNUM, dwarf_ss_i386,       LLDB_INVALID_REGNUM,       LLDB_INVALID_REGNUM),
 121     DEFINE_GPR(ds,     nullptr, LLDB_INVALID_REGNUM, dwarf_ds_i386,       LLDB_INVALID_REGNUM,       LLDB_INVALID_REGNUM),
 122     DEFINE_GPR(es,     nullptr, LLDB_INVALID_REGNUM, dwarf_es_i386,       LLDB_INVALID_REGNUM,       LLDB_INVALID_REGNUM),
 123
 124     DEFINE_GPR_PSEUDO_16(ax,  eax),
 125     DEFINE_GPR_PSEUDO_16(bx,  ebx),
 126     DEFINE_GPR_PSEUDO_16(cx,  ecx),
 127     DEFINE_GPR_PSEUDO_16(dx,  edx),
 128     DEFINE_GPR_PSEUDO_16(di,  edi),
 129     DEFINE_GPR_PSEUDO_16(si,  esi),
 130     DEFINE_GPR_PSEUDO_16(bp,  ebp),
 131     DEFINE_GPR_PSEUDO_16(sp,  esp),
 132     DEFINE_GPR_PSEUDO_8H(ah,  eax),
 133     DEFINE_GPR_PSEUDO_8H(bh,  ebx),
 134     DEFINE_GPR_PSEUDO_8H(ch,  ecx),
 135     DEFINE_GPR_PSEUDO_8H(dh,  edx),
 136     DEFINE_GPR_PSEUDO_8L(al,  eax),
 137     DEFINE_GPR_PSEUDO_8L(bl,  ebx),
 138     DEFINE_GPR_PSEUDO_8L(cl,  ecx),
 139     DEFINE_GPR_PSEUDO_8L(dl,  edx),
 140
 141     // i387 Floating point registers.
 142     DEFINE_FPR(fctrl,     fctrl,          LLDB_INVALID_REGNUM, dwarf_fctrl_i386,    LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM),
 143     DEFINE_FPR(fstat,     fstat,          LLDB_INVALID_REGNUM, dwarf_fstat_i386,    LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM),
 144     DEFINE_FPR(ftag,      ftag,           LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM),
 145     DEFINE_FPR(fop,       fop,            LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM),
 146     DEFINE_FPR(fiseg,     ptr.i386_.fiseg, LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM),
 147     DEFINE_FPR(fioff,     ptr.i386_.fioff, LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM),
 148     DEFINE_FPR(foseg,     ptr.i386_.foseg, LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM),
 149     DEFINE_FPR(fooff,     ptr.i386_.fooff, LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM),
 150     DEFINE_FPR(mxcsr,     mxcsr,          LLDB_INVALID_REGNUM, dwarf_mxcsr_i386,    LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM),
 151     DEFINE_FPR(mxcsrmask, mxcsrmask,      LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM),
 152
 153     // FP registers.
 154     DEFINE_FP_ST(st, 0),
 155     DEFINE_FP_ST(st, 1),
 156     DEFINE_FP_ST(st, 2),
 157     DEFINE_FP_ST(st, 3),
 158     DEFINE_FP_ST(st, 4),
 159     DEFINE_FP_ST(st, 5),
 160     DEFINE_FP_ST(st, 6),
 161     DEFINE_FP_ST(st, 7),
 162     DEFINE_FP_MM(mm, 0),
 163     DEFINE_FP_MM(mm, 1),
 164     DEFINE_FP_MM(mm, 2),
 165     DEFINE_FP_MM(mm, 3),
 166     DEFINE_FP_MM(mm, 4),
 167     DEFINE_FP_MM(mm, 5),
 168     DEFINE_FP_MM(mm, 6),
 169     DEFINE_FP_MM(mm, 7),
 170
 171     // XMM registers
 172     DEFINE_XMM(xmm, 0),
 173     DEFINE_XMM(xmm, 1),
 174     DEFINE_XMM(xmm, 2),
 175     DEFINE_XMM(xmm, 3),
 176     DEFINE_XMM(xmm, 4),
 177     DEFINE_XMM(xmm, 5),
 178     DEFINE_XMM(xmm, 6),
 179     DEFINE_XMM(xmm, 7),
 180
 181     // Copy of YMM registers assembled from xmm and ymmh
 182     DEFINE_YMM(ymm, 0),
 183     DEFINE_YMM(ymm, 1),
 184     DEFINE_YMM(ymm, 2),
 185     DEFINE_YMM(ymm, 3),
 186     DEFINE_YMM(ymm, 4),
 187     DEFINE_YMM(ymm, 5),
 188     DEFINE_YMM(ymm, 6),
 189     DEFINE_YMM(ymm, 7),
 190
 191     // Debug registers for lldb internal use
 192     DEFINE_DR(dr, 0),
 193     DEFINE_DR(dr, 1),
 194     DEFINE_DR(dr, 2),
 195     DEFINE_DR(dr, 3),
 196     DEFINE_DR(dr, 4),
 197     DEFINE_DR(dr, 5),
 198     DEFINE_DR(dr, 6),
 199     DEFINE_DR(dr, 7)
 200 };
 201
 202 static_assert((sizeof(g_register_infos_i386) / sizeof(g_register_infos_i386[0])) == k_num_registers_i386,
 203     "g_register_infos_x86_64 has wrong number of register infos");
 204
 205 #undef GPR_OFFSET
 206 #undef FPR_OFFSET
 207 #undef YMM_OFFSET
 208 #undef FPR_SIZE
 209 #undef FP_SIZE
 210 #undef XMM_SIZE
 211 #undef YMM_SIZE
 212 #undef DEFINE_GPR
 213 #undef DEFINE_FPR
 214 #undef DEFINE_FP
 215 #undef DEFINE_XMM
 216 #undef DEFINE_YMM
 217 #undef DEFINE_DR
 218 #undef DEFINE_GPR_PSEUDO_16
 219 #undef DEFINE_GPR_PSEUDO_8H
 220 #undef DEFINE_GPR_PSEUDO_8L
 221
 222 #endif // DECLARE_REGISTER_INFOS_I386_STRUCT