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