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-2012 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 42 // XXX: this is *really* the wrong spot for these things 43 #if defined(VGP_x86_linux) 44 # define VG_ELF_DATA2XXX ELFDATA2LSB 45 # define VG_ELF_MACHINE EM_386 46 # define VG_ELF_CLASS ELFCLASS32 47 # undef VG_PLAT_USES_PPCTOC 48 #elif defined(VGP_amd64_linux) 49 # define VG_ELF_DATA2XXX ELFDATA2LSB 50 # define VG_ELF_MACHINE EM_X86_64 51 # define VG_ELF_CLASS ELFCLASS64 52 # undef VG_PLAT_USES_PPCTOC 53 #elif defined(VGP_ppc32_linux) 54 # define VG_ELF_DATA2XXX ELFDATA2MSB 55 # define VG_ELF_MACHINE EM_PPC 56 # define VG_ELF_CLASS ELFCLASS32 57 # undef VG_PLAT_USES_PPCTOC 58 #elif defined(VGP_ppc64_linux) 59 # define VG_ELF_DATA2XXX ELFDATA2MSB 60 # define VG_ELF_MACHINE EM_PPC64 61 # define VG_ELF_CLASS ELFCLASS64 62 # define VG_PLAT_USES_PPCTOC 1 63 #elif defined(VGP_arm_linux) 64 # define VG_ELF_DATA2XXX ELFDATA2LSB 65 # define VG_ELF_MACHINE EM_ARM 66 # define VG_ELF_CLASS ELFCLASS32 67 # undef VG_PLAT_USES_PPCTOC 68 #elif defined(VGO_darwin) 69 # undef VG_ELF_DATA2XXX 70 # undef VG_ELF_MACHINE 71 # undef VG_ELF_CLASS 72 # undef VG_PLAT_USES_PPCTOC 73 #elif defined(VGP_s390x_linux) 74 # define VG_ELF_DATA2XXX ELFDATA2MSB 75 # define VG_ELF_MACHINE EM_S390 76 # define VG_ELF_CLASS ELFCLASS64 77 # undef VG_PLAT_USES_PPCTOC 78 #elif defined(VGP_mips32_linux) 79 # if defined (VG_LITTLEENDIAN) 80 # define VG_ELF_DATA2XXX ELFDATA2LSB 81 # elif defined (VG_BIGENDIAN) 82 # define VG_ELF_DATA2XXX ELFDATA2MSB 83 # else 84 # error "Unknown endianness" 85 # endif 86 # define VG_ELF_MACHINE EM_MIPS 87 # define VG_ELF_CLASS ELFCLASS32 88 # undef VG_PLAT_USES_PPCTOC 89 #else 90 # error Unknown platform 91 #endif 92 93 #if defined(VGA_x86) 94 # define VG_INSTR_PTR guest_EIP 95 # define VG_STACK_PTR guest_ESP 96 # define VG_FRAME_PTR guest_EBP 97 #elif defined(VGA_amd64) 98 # define VG_INSTR_PTR guest_RIP 99 # define VG_STACK_PTR guest_RSP 100 # define VG_FRAME_PTR guest_RBP 101 #elif defined(VGA_ppc32) 102 # define VG_INSTR_PTR guest_CIA 103 # define VG_STACK_PTR guest_GPR1 104 # define VG_FRAME_PTR guest_GPR1 // No frame ptr for PPC 105 #elif defined(VGA_ppc64) 106 # define VG_INSTR_PTR guest_CIA 107 # define VG_STACK_PTR guest_GPR1 108 # define VG_FRAME_PTR guest_GPR1 // No frame ptr for PPC 109 #elif defined(VGA_arm) 110 # define VG_INSTR_PTR guest_R15T 111 # define VG_STACK_PTR guest_R13 112 # define VG_FRAME_PTR guest_R11 113 #elif defined(VGA_s390x) 114 # define VG_INSTR_PTR guest_IA 115 # define VG_STACK_PTR guest_SP 116 # define VG_FRAME_PTR guest_FP 117 # define VG_FPC_REG guest_fpc 118 #elif defined(VGA_mips32) 119 # define VG_INSTR_PTR guest_PC 120 # define VG_STACK_PTR guest_r29 121 # define VG_FRAME_PTR guest_r30 122 #else 123 # error Unknown arch 124 #endif 125 126 127 // Offsets for the Vex state 128 #define VG_O_STACK_PTR (offsetof(VexGuestArchState, VG_STACK_PTR)) 129 #define VG_O_INSTR_PTR (offsetof(VexGuestArchState, VG_INSTR_PTR)) 130 #define VG_O_FPC_REG (offsetof(VexGuestArchState, VG_FPC_REG)) 131 132 133 //------------------------------------------------------------- 134 // Guest state accessors that are not visible to tools. The only 135 // ones that are visible are get_IP and get_SP. 136 137 //Addr VG_(get_IP) ( ThreadId tid ); // in pub_tool_machine.h 138 //Addr VG_(get_SP) ( ThreadId tid ); // in pub_tool_machine.h 139 Addr VG_(get_FP) ( ThreadId tid ); 140 141 void VG_(set_IP) ( ThreadId tid, Addr encip ); 142 void VG_(set_SP) ( ThreadId tid, Addr sp ); 143 144 145 //------------------------------------------------------------- 146 // Get hold of the values needed for a stack unwind, for the specified 147 // (client) thread. 148 void VG_(get_UnwindStartRegs) ( /*OUT*/UnwindStartRegs* regs, 149 ThreadId tid ); 150 151 152 //------------------------------------------------------------- 153 /* Details about the capabilities of the underlying (host) CPU. These 154 details are acquired by (1) enquiring with the CPU at startup, or 155 (2) from the AT_SYSINFO entries the kernel gave us (ppc cache 156 line size). It's a bit nasty in the sense that there's no obvious 157 way to stop uses of some of this info before it's ready to go. 158 159 Current dependencies are: 160 161 x86: initially: call VG_(machine_get_hwcaps) 162 163 then safe to use VG_(machine_get_VexArchInfo) 164 and VG_(machine_x86_have_mxcsr) 165 ------------- 166 amd64: initially: call VG_(machine_get_hwcaps) 167 168 then safe to use VG_(machine_get_VexArchInfo) 169 ------------- 170 ppc32: initially: call VG_(machine_get_hwcaps) 171 call VG_(machine_ppc32_set_clszB) 172 173 then safe to use VG_(machine_get_VexArchInfo) 174 and VG_(machine_ppc32_has_FP) 175 and VG_(machine_ppc32_has_VMX) 176 ------------- 177 ppc64: initially: call VG_(machine_get_hwcaps) 178 call VG_(machine_ppc64_set_clszB) 179 180 then safe to use VG_(machine_get_VexArchInfo) 181 and VG_(machine_ppc64_has_VMX) 182 ------------- 183 arm: initially: call VG_(machine_get_hwcaps) 184 call VG_(machine_arm_set_has_NEON) 185 186 then safe to use VG_(machine_get_VexArchInfo) 187 ------------- 188 s390x: initially: call VG_(machine_get_hwcaps) 189 190 then safe to use VG_(machine_get_VexArchInfo) 191 192 VG_(machine_get_hwcaps) may use signals (although it attempts to 193 leave signal state unchanged) and therefore should only be 194 called before m_main sets up the client's signal state. 195 */ 196 197 /* Determine what insn set and insn set variant the host has, and 198 record it. To be called once at system startup. Returns False if 199 this a CPU incapable of running Valgrind. */ 200 extern Bool VG_(machine_get_hwcaps)( void ); 201 202 /* Fetch host cpu info, as per above comment. */ 203 extern void VG_(machine_get_VexArchInfo)( /*OUT*/VexArch*, 204 /*OUT*/VexArchInfo* ); 205 206 /* Notify host cpu cache line size, as per above comment. */ 207 #if defined(VGA_ppc32) 208 extern void VG_(machine_ppc32_set_clszB)( Int ); 209 #endif 210 211 #if defined(VGA_ppc64) 212 extern void VG_(machine_ppc64_set_clszB)( Int ); 213 #endif 214 215 #if defined(VGA_arm) 216 extern void VG_(machine_arm_set_has_NEON)( Bool ); 217 #endif 218 219 /* X86: set to 1 if the host is able to do {ld,st}mxcsr (load/store 220 the SSE control/status register), else zero. Is referenced from 221 assembly code, so do not change from a 32-bit int. */ 222 #if defined(VGA_x86) 223 extern UInt VG_(machine_x86_have_mxcsr); 224 #endif 225 226 /* PPC32: set to 1 if FP instructions are supported in user-space, 227 else 0. Is referenced from assembly code, so do not change from a 228 32-bit int. */ 229 #if defined(VGA_ppc32) 230 extern UInt VG_(machine_ppc32_has_FP); 231 #endif 232 233 /* PPC32: set to 1 if Altivec instructions are supported in 234 user-space, else 0. Is referenced from assembly code, so do not 235 change from a 32-bit int. */ 236 #if defined(VGA_ppc32) 237 extern UInt VG_(machine_ppc32_has_VMX); 238 #endif 239 240 /* PPC64: set to 1 if Altivec instructions are supported in 241 user-space, else 0. Is referenced from assembly code, so do not 242 change from a 64-bit int. */ 243 #if defined(VGA_ppc64) 244 extern ULong VG_(machine_ppc64_has_VMX); 245 #endif 246 247 #if defined(VGA_arm) 248 extern Int VG_(machine_arm_archlevel); 249 #endif 250 251 #endif // __PUB_CORE_MACHINE_H 252 253 /*--------------------------------------------------------------------*/ 254 /*--- end ---*/ 255 /*--------------------------------------------------------------------*/ 256