coregrind/pub_core_machine.h

   1
   2 /*--------------------------------------------------------------------*/
   3 /*--- Machine-related things.                   pub_core_machine.h ---*/
   4 /*--------------------------------------------------------------------*/
   5
   6 /*
   7    This file is part of Valgrind, a dynamic binary instrumentation
   8    framework.
   9
  10    Copyright (C) 2000-2013 Julian Seward
  11       jseward@acm.org
  12
  13    This program is free software; you can redistribute it and/or
  14    modify it under the terms of the GNU General Public License as
  15    published by the Free Software Foundation; either version 2 of the
  16    License, or (at your option) any later version.
  17
  18    This program is distributed in the hope that it will be useful, but
  19    WITHOUT ANY WARRANTY; without even the implied warranty of
  20    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  21    General Public License for more details.
  22
  23    You should have received a copy of the GNU General Public License
  24    along with this program; if not, write to the Free Software
  25    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  26    02111-1307, USA.
  27
  28    The GNU General Public License is contained in the file COPYING.
  29 */
  30
  31 #ifndef __PUB_CORE_MACHINE_H
  32 #define __PUB_CORE_MACHINE_H
  33
  34 //--------------------------------------------------------------------
  35 // PURPOSE: This module contains code related to the particular
  36 // architecture, things like accessing guest state, endianness, word size,
  37 // etc.
  38 //--------------------------------------------------------------------
  39
  40 #include "pub_tool_machine.h"
  41 #include "pub_core_basics.h"      // UnwindStartRegs
  42
  43 // XXX: this is *really* the wrong spot for these things
  44 #if defined(VGP_x86_linux) || defined(VGP_x86_solaris)
  45 #  define VG_ELF_DATA2XXX     ELFDATA2LSB
  46 #  define VG_ELF_MACHINE      EM_386
  47 #  define VG_ELF_CLASS        ELFCLASS32
  48 #  undef  VG_PLAT_USES_PPCTOC
  49 #elif defined(VGP_amd64_linux) || defined(VGP_amd64_solaris)
  50 #  define VG_ELF_DATA2XXX     ELFDATA2LSB
  51 #  define VG_ELF_MACHINE      EM_X86_64
  52 #  define VG_ELF_CLASS        ELFCLASS64
  53 #  undef  VG_PLAT_USES_PPCTOC
  54 #elif defined(VGP_ppc32_linux)
  55 #  define VG_ELF_DATA2XXX     ELFDATA2MSB
  56 #  define VG_ELF_MACHINE      EM_PPC
  57 #  define VG_ELF_CLASS        ELFCLASS32
  58 #  undef  VG_PLAT_USES_PPCTOC
  59 #elif defined(VGP_ppc64be_linux)
  60 #  define VG_ELF_DATA2XXX     ELFDATA2MSB
  61 #  define VG_ELF_MACHINE      EM_PPC64
  62 #  define VG_ELF_CLASS        ELFCLASS64
  63 #  define VG_PLAT_USES_PPCTOC 1
  64 #elif defined(VGP_ppc64le_linux)
  65 #  define VG_ELF_DATA2XXX     ELFDATA2LSB
  66 #  define VG_ELF_MACHINE      EM_PPC64
  67 #  define VG_ELF_CLASS        ELFCLASS64
  68 #  undef VG_PLAT_USES_PPCTOC
  69 #elif defined(VGP_arm_linux)
  70 #  define VG_ELF_DATA2XXX     ELFDATA2LSB
  71 #  define VG_ELF_MACHINE      EM_ARM
  72 #  define VG_ELF_CLASS        ELFCLASS32
  73 #  undef  VG_PLAT_USES_PPCTOC
  74 #elif defined(VGP_arm64_linux)
  75 #  define VG_ELF_DATA2XXX     ELFDATA2LSB
  76 #  define VG_ELF_MACHINE      EM_AARCH64
  77 #  define VG_ELF_CLASS        ELFCLASS64
  78 #  undef  VG_PLAT_USES_PPCTOC
  79 #elif defined(VGO_darwin)
  80 #  undef  VG_ELF_DATA2XXX
  81 #  undef  VG_ELF_MACHINE
  82 #  undef  VG_ELF_CLASS
  83 #  undef  VG_PLAT_USES_PPCTOC
  84 #elif defined(VGP_s390x_linux)
  85 #  define VG_ELF_DATA2XXX     ELFDATA2MSB
  86 #  define VG_ELF_MACHINE      EM_S390
  87 #  define VG_ELF_CLASS        ELFCLASS64
  88 #  undef  VG_PLAT_USES_PPCTOC
  89 #elif defined(VGP_mips32_linux)
  90 #  if defined (VG_LITTLEENDIAN)
  91 #    define VG_ELF_DATA2XXX   ELFDATA2LSB
  92 #  elif defined (VG_BIGENDIAN)
  93 #    define VG_ELF_DATA2XXX   ELFDATA2MSB
  94 #  else
  95 #    error "Unknown endianness"
  96 #  endif
  97 #  define VG_ELF_MACHINE      EM_MIPS
  98 #  define VG_ELF_CLASS        ELFCLASS32
  99 #  undef  VG_PLAT_USES_PPCTOC
 100 #elif defined(VGP_mips64_linux)
 101 #  if defined (VG_LITTLEENDIAN)
 102 #    define VG_ELF_DATA2XXX     ELFDATA2LSB
 103 #  elif defined (VG_BIGENDIAN)
 104 #    define VG_ELF_DATA2XXX     ELFDATA2MSB
 105 #  else
 106 #    error "Unknown endianness"
 107 #  endif
 108 #  define VG_ELF_MACHINE      EM_MIPS
 109 #  define VG_ELF_CLASS        ELFCLASS64
 110 #  undef  VG_PLAT_USES_PPCTOC
 111 #elif defined(VGP_tilegx_linux)
 112 #  define VG_ELF_DATA2XXX     ELFDATA2LSB
 113    #ifndef EM_TILEGX
 114    #define EM_TILEGX 191
 115    #endif
 116 #  define VG_ELF_MACHINE      EM_TILEGX
 117 #  define VG_ELF_CLASS        ELFCLASS64
 118 #  undef  VG_PLAT_USES_PPCTOC
 119 #else
 120 #  error Unknown platform
 121 #endif
 122
 123 #if defined(VGA_x86)
 124 #  define VG_INSTR_PTR        guest_EIP
 125 #  define VG_STACK_PTR        guest_ESP
 126 #  define VG_FRAME_PTR        guest_EBP
 127 #elif defined(VGA_amd64)
 128 #  define VG_INSTR_PTR        guest_RIP
 129 #  define VG_STACK_PTR        guest_RSP
 130 #  define VG_FRAME_PTR        guest_RBP
 131 #elif defined(VGA_ppc32)
 132 #  define VG_INSTR_PTR        guest_CIA
 133 #  define VG_STACK_PTR        guest_GPR1
 134 #  define VG_FRAME_PTR        guest_GPR1   // No frame ptr for PPC
 135 #elif defined(VGA_ppc64be) || defined(VGA_ppc64le)
 136 #  define VG_INSTR_PTR        guest_CIA
 137 #  define VG_STACK_PTR        guest_GPR1
 138 #  define VG_FRAME_PTR        guest_GPR1   // No frame ptr for PPC
 139 #elif defined(VGA_arm)
 140 #  define VG_INSTR_PTR        guest_R15T
 141 #  define VG_STACK_PTR        guest_R13
 142 #  define VG_FRAME_PTR        guest_R11
 143 #elif defined(VGA_arm64)
 144 #  define VG_INSTR_PTR        guest_PC
 145 #  define VG_STACK_PTR        guest_XSP
 146 #  define VG_FRAME_PTR        guest_X29   // FIXME: is this right?
 147 #elif defined(VGA_s390x)
 148 #  define VG_INSTR_PTR        guest_IA
 149 #  define VG_STACK_PTR        guest_SP
 150 #  define VG_FRAME_PTR        guest_FP
 151 #  define VG_FPC_REG          guest_fpc
 152 #elif defined(VGA_mips32)
 153 #  define VG_INSTR_PTR        guest_PC
 154 #  define VG_STACK_PTR        guest_r29
 155 #  define VG_FRAME_PTR        guest_r30
 156 #elif defined(VGA_mips64)
 157 #  define VG_INSTR_PTR        guest_PC
 158 #  define VG_STACK_PTR        guest_r29
 159 #  define VG_FRAME_PTR        guest_r30
 160 #elif defined(VGA_tilegx)
 161 #  define VG_INSTR_PTR        guest_pc
 162 #  define VG_STACK_PTR        guest_r54
 163 #  define VG_FRAME_PTR        guest_r52
 164 #else
 165 #  error Unknown arch
 166 #endif
 167
 168
 169 // Offsets for the Vex state
 170 #define VG_O_STACK_PTR        (offsetof(VexGuestArchState, VG_STACK_PTR))
 171 #define VG_O_INSTR_PTR        (offsetof(VexGuestArchState, VG_INSTR_PTR))
 172 #define VG_O_FRAME_PTR        (offsetof(VexGuestArchState, VG_FRAME_PTR))
 173 #define VG_O_FPC_REG          (offsetof(VexGuestArchState, VG_FPC_REG))
 174
 175
 176 //-------------------------------------------------------------
 177 // Guest state accessors that are not visible to tools.  The only
 178 // ones that are visible are get_IP and get_SP.
 179
 180 //Addr VG_(get_IP) ( ThreadId tid );  // in pub_tool_machine.h
 181 //Addr VG_(get_SP) ( ThreadId tid );  // in pub_tool_machine.h
 182 Addr VG_(get_FP) ( ThreadId tid );
 183
 184 void VG_(set_IP) ( ThreadId tid, Addr encip );
 185 void VG_(set_SP) ( ThreadId tid, Addr sp );
 186
 187
 188 //-------------------------------------------------------------
 189 // Get hold of the values needed for a stack unwind, for the specified
 190 // (client) thread.
 191 void VG_(get_UnwindStartRegs) ( /*OUT*/UnwindStartRegs* regs,
 192                                 ThreadId tid );
 193
 194
 195 //-------------------------------------------------------------
 196 /* Details about the capabilities of the underlying (host) CPU.  These
 197    details are acquired by (1) enquiring with the CPU at startup, or
 198    (2) from the AT_SYSINFO entries the kernel gave us (ppc cache
 199    line size).  It's a bit nasty in the sense that there's no obvious
 200    way to stop uses of some of this info before it's ready to go.
 201
 202    Current dependencies are:
 203
 204    x86:   initially:  call VG_(machine_get_hwcaps)
 205
 206           then safe to use VG_(machine_get_VexArchInfo)
 207                        and VG_(machine_x86_have_mxcsr)
 208    -------------
 209    amd64: initially:  call VG_(machine_get_hwcaps)
 210
 211           then safe to use VG_(machine_get_VexArchInfo)
 212    -------------
 213    ppc32: initially:  call VG_(machine_get_hwcaps)
 214                       call VG_(machine_ppc32_set_clszB)
 215
 216           then safe to use VG_(machine_get_VexArchInfo)
 217                        and VG_(machine_ppc32_has_FP)
 218                        and VG_(machine_ppc32_has_VMX)
 219    -------------
 220    ppc64: initially:  call VG_(machine_get_hwcaps)
 221                       call VG_(machine_ppc64_set_clszB)
 222
 223           then safe to use VG_(machine_get_VexArchInfo)
 224                        and VG_(machine_ppc64_has_VMX)
 225    -------------
 226    arm:   initially:  call VG_(machine_get_hwcaps)
 227                       call VG_(machine_arm_set_has_NEON)
 228
 229           then safe to use VG_(machine_get_VexArchInfo)
 230    -------------
 231    s390x: initially:  call VG_(machine_get_hwcaps)
 232
 233           then safe to use VG_(machine_get_VexArchInfo)
 234
 235    VG_(machine_get_hwcaps) may use signals (although it attempts to
 236    leave signal state unchanged) and therefore should only be
 237    called before m_main sets up the client's signal state.
 238 */
 239
 240 /* Determine what insn set and insn set variant the host has, and
 241    record it.  To be called once at system startup.  Returns False if
 242    this a CPU incapable of running Valgrind. */
 243 extern Bool VG_(machine_get_hwcaps)( void );
 244
 245 /* Determine information about the cache system this host has and
 246    record it. Returns False, if cache information cannot be auto-detected. */
 247 extern Bool VG_(machine_get_cache_info)( VexArchInfo * );
 248
 249 /* Notify host cpu cache line size, as per above comment. */
 250 #if defined(VGA_ppc32)
 251 extern void VG_(machine_ppc32_set_clszB)( Int );
 252 #endif
 253
 254 #if defined(VGA_ppc64be) || defined(VGA_ppc64le)
 255 extern void VG_(machine_ppc64_set_clszB)( Int );
 256 #endif
 257
 258 #if defined(VGA_arm)
 259 extern void VG_(machine_arm_set_has_NEON)( Bool );
 260 #endif
 261
 262 /* X86: set to 1 if the host is able to do {ld,st}mxcsr (load/store
 263    the SSE control/status register), else zero.  Is referenced from
 264    assembly code, so do not change from a 32-bit int. */
 265 #if defined(VGA_x86)
 266 extern UInt VG_(machine_x86_have_mxcsr);
 267 #endif
 268
 269 /* PPC32: set to 1 if FP instructions are supported in user-space,
 270    else 0.  Is referenced from assembly code, so do not change from a
 271    32-bit int. */
 272 #if defined(VGA_ppc32)
 273 extern UInt VG_(machine_ppc32_has_FP);
 274 #endif
 275
 276 /* PPC32: set to 1 if Altivec instructions are supported in
 277    user-space, else 0.  Is referenced from assembly code, so do not
 278    change from a 32-bit int. */
 279 #if defined(VGA_ppc32)
 280 extern UInt VG_(machine_ppc32_has_VMX);
 281 #endif
 282
 283 /* PPC64: set to 1 if Altivec instructions are supported in
 284    user-space, else 0.  Is referenced from assembly code, so do not
 285    change from a 64-bit int. */
 286 #if defined(VGA_ppc64be) || defined(VGA_ppc64le)
 287 extern ULong VG_(machine_ppc64_has_VMX);
 288 #endif
 289
 290 #if defined(VGA_arm)
 291 extern Int VG_(machine_arm_archlevel);
 292 #endif
 293
 294 #endif   // __PUB_CORE_MACHINE_H
 295
 296 /*--------------------------------------------------------------------*/
 297 /*--- end                                                          ---*/
 298 /*--------------------------------------------------------------------*/