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-2017 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 #else
 112 #  error Unknown platform
 113 #endif
 114
 115 #if defined(VGA_x86)
 116 #  define VG_INSTR_PTR        guest_EIP
 117 #  define VG_STACK_PTR        guest_ESP
 118 #  define VG_FRAME_PTR        guest_EBP
 119 #elif defined(VGA_amd64)
 120 #  define VG_INSTR_PTR        guest_RIP
 121 #  define VG_STACK_PTR        guest_RSP
 122 #  define VG_FRAME_PTR        guest_RBP
 123 #elif defined(VGA_ppc32)
 124 #  define VG_INSTR_PTR        guest_CIA
 125 #  define VG_STACK_PTR        guest_GPR1
 126 #  define VG_FRAME_PTR        guest_GPR1   // No frame ptr for PPC
 127 #elif defined(VGA_ppc64be) || defined(VGA_ppc64le)
 128 #  define VG_INSTR_PTR        guest_CIA
 129 #  define VG_STACK_PTR        guest_GPR1
 130 #  define VG_FRAME_PTR        guest_GPR1   // No frame ptr for PPC
 131 #elif defined(VGA_arm)
 132 #  define VG_INSTR_PTR        guest_R15T
 133 #  define VG_STACK_PTR        guest_R13
 134 #  define VG_FRAME_PTR        guest_R11
 135 #elif defined(VGA_arm64)
 136 #  define VG_INSTR_PTR        guest_PC
 137 #  define VG_STACK_PTR        guest_XSP
 138 #  define VG_FRAME_PTR        guest_X29   // FIXME: is this right?
 139 #elif defined(VGA_s390x)
 140 #  define VG_INSTR_PTR        guest_IA
 141 #  define VG_STACK_PTR        guest_SP
 142 #  define VG_FRAME_PTR        guest_FP
 143 #  define VG_FPC_REG          guest_fpc
 144 #elif defined(VGA_mips32)
 145 #  define VG_INSTR_PTR        guest_PC
 146 #  define VG_STACK_PTR        guest_r29
 147 #  define VG_FRAME_PTR        guest_r30
 148 #elif defined(VGA_mips64)
 149 #  define VG_INSTR_PTR        guest_PC
 150 #  define VG_STACK_PTR        guest_r29
 151 #  define VG_FRAME_PTR        guest_r30
 152 #else
 153 #  error Unknown arch
 154 #endif
 155
 156
 157 // Offsets for the Vex state
 158 #define VG_O_STACK_PTR        (offsetof(VexGuestArchState, VG_STACK_PTR))
 159 #define VG_O_INSTR_PTR        (offsetof(VexGuestArchState, VG_INSTR_PTR))
 160 #define VG_O_FRAME_PTR        (offsetof(VexGuestArchState, VG_FRAME_PTR))
 161 #define VG_O_FPC_REG          (offsetof(VexGuestArchState, VG_FPC_REG))
 162
 163
 164 //-------------------------------------------------------------
 165 // Guest state accessors that are not visible to tools.  The only
 166 // ones that are visible are get_IP and get_SP.
 167
 168 //Addr VG_(get_IP) ( ThreadId tid );  // in pub_tool_machine.h
 169 //Addr VG_(get_SP) ( ThreadId tid );  // in pub_tool_machine.h
 170 Addr VG_(get_FP) ( ThreadId tid );
 171
 172 void VG_(set_IP) ( ThreadId tid, Addr encip );
 173 void VG_(set_SP) ( ThreadId tid, Addr sp );
 174
 175
 176 //-------------------------------------------------------------
 177 // Get hold of the values needed for a stack unwind, for the specified
 178 // (client) thread.
 179 void VG_(get_UnwindStartRegs) ( /*OUT*/UnwindStartRegs* regs,
 180                                 ThreadId tid );
 181
 182
 183 //-------------------------------------------------------------
 184 /* Details about the capabilities of the underlying (host) CPU.  These
 185    details are acquired by (1) enquiring with the CPU at startup, or
 186    (2) from the AT_SYSINFO entries the kernel gave us (ppc cache
 187    line size).  It's a bit nasty in the sense that there's no obvious
 188    way to stop uses of some of this info before it's ready to go.
 189
 190    Current dependencies are:
 191
 192    x86:   initially:  call VG_(machine_get_hwcaps)
 193
 194           then safe to use VG_(machine_get_VexArchInfo)
 195                        and VG_(machine_x86_have_mxcsr)
 196    -------------
 197    amd64: initially:  call VG_(machine_get_hwcaps)
 198
 199           then safe to use VG_(machine_get_VexArchInfo)
 200    -------------
 201    ppc32: initially:  call VG_(machine_get_hwcaps)
 202                       call VG_(machine_ppc32_set_clszB)
 203
 204           then safe to use VG_(machine_get_VexArchInfo)
 205                        and VG_(machine_ppc32_has_FP)
 206                        and VG_(machine_ppc32_has_VMX)
 207    -------------
 208    ppc64: initially:  call VG_(machine_get_hwcaps)
 209                       call VG_(machine_ppc64_set_clszB)
 210
 211           then safe to use VG_(machine_get_VexArchInfo)
 212                        and VG_(machine_ppc64_has_VMX)
 213    -------------
 214    arm:   initially:  call VG_(machine_get_hwcaps)
 215                       call VG_(machine_arm_set_has_NEON)
 216
 217           then safe to use VG_(machine_get_VexArchInfo)
 218    -------------
 219    s390x: initially:  call VG_(machine_get_hwcaps)
 220
 221           then safe to use VG_(machine_get_VexArchInfo)
 222
 223    VG_(machine_get_hwcaps) may use signals (although it attempts to
 224    leave signal state unchanged) and therefore should only be
 225    called before m_main sets up the client's signal state.
 226 */
 227
 228 /* Determine what insn set and insn set variant the host has, and
 229    record it.  To be called once at system startup.  Returns False if
 230    this a CPU incapable of running Valgrind. */
 231 extern Bool VG_(machine_get_hwcaps)( void );
 232
 233 /* Determine information about the cache system this host has and
 234    record it. Returns False, if cache information cannot be auto-detected. */
 235 extern Bool VG_(machine_get_cache_info)( VexArchInfo * );
 236
 237 /* Notify host cpu cache line size, as per above comment. */
 238 #if defined(VGA_ppc32)
 239 extern void VG_(machine_ppc32_set_clszB)( Int );
 240 #endif
 241
 242 #if defined(VGA_ppc64be) || defined(VGA_ppc64le)
 243 extern void VG_(machine_ppc64_set_clszB)( Int );
 244 #endif
 245
 246 #if defined(VGA_arm)
 247 extern void VG_(machine_arm_set_has_NEON)( Bool );
 248 #endif
 249
 250 /* X86: set to 1 if the host is able to do {ld,st}mxcsr (load/store
 251    the SSE control/status register), else zero.  Is referenced from
 252    assembly code, so do not change from a 32-bit int. */
 253 #if defined(VGA_x86)
 254 extern UInt VG_(machine_x86_have_mxcsr);
 255 #endif
 256
 257 /* PPC32: set to 1 if FP instructions are supported in user-space,
 258    else 0.  Is referenced from assembly code, so do not change from a
 259    32-bit int. */
 260 #if defined(VGA_ppc32)
 261 extern UInt VG_(machine_ppc32_has_FP);
 262 #endif
 263
 264 /* PPC32: set to 1 if Altivec instructions are supported in
 265    user-space, else 0.  Is referenced from assembly code, so do not
 266    change from a 32-bit int. */
 267 #if defined(VGA_ppc32)
 268 extern UInt VG_(machine_ppc32_has_VMX);
 269 #endif
 270
 271 /* PPC64: set to 1 if Altivec instructions are supported in
 272    user-space, else 0.  Is referenced from assembly code, so do not
 273    change from a 64-bit int. */
 274 #if defined(VGA_ppc64be) || defined(VGA_ppc64le)
 275 extern ULong VG_(machine_ppc64_has_VMX);
 276 #endif
 277
 278 #if defined(VGA_arm)
 279 extern Int VG_(machine_arm_archlevel);
 280 #endif
 281
 282 #endif   // __PUB_CORE_MACHINE_H
 283
 284 /*--------------------------------------------------------------------*/
 285 /*--- end                                                          ---*/
 286 /*--------------------------------------------------------------------*/