1ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 2ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/ 3ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--- Machine-related stuff. pub_tool_machine.h ---*/ 4ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/ 5ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 6ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* 7ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown This file is part of Valgrind, a dynamic binary instrumentation 8ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown framework. 9ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 10663860b1408516d02ebfcb3a9999a134e6cfb223Ben Cheng Copyright (C) 2000-2012 Julian Seward 11ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown jseward@acm.org 12ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 13ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown This program is free software; you can redistribute it and/or 14ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown modify it under the terms of the GNU General Public License as 15ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown published by the Free Software Foundation; either version 2 of the 16ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown License, or (at your option) any later version. 17ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 18ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown This program is distributed in the hope that it will be useful, but 19ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown WITHOUT ANY WARRANTY; without even the implied warranty of 20ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 21ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown General Public License for more details. 22ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 23ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown You should have received a copy of the GNU General Public License 24ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown along with this program; if not, write to the Free Software 25ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 26ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 02111-1307, USA. 27ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 28ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown The GNU General Public License is contained in the file COPYING. 29ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown*/ 30ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 31ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#ifndef __PUB_TOOL_MACHINE_H 32ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define __PUB_TOOL_MACHINE_H 33ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 34ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#if defined(VGP_x86_linux) 35ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown# define VG_MIN_INSTR_SZB 1 // min length of native instruction 36ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown# define VG_MAX_INSTR_SZB 16 // max length of native instruction 37ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown# define VG_CLREQ_SZB 14 // length of a client request, may 38ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown // be larger than VG_MAX_INSTR_SZB 39ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown# define VG_STACK_REDZONE_SZB 0 // number of addressable bytes below %RSP 40ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 41ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#elif defined(VGP_amd64_linux) 42ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown# define VG_MIN_INSTR_SZB 1 43ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown# define VG_MAX_INSTR_SZB 16 44ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown# define VG_CLREQ_SZB 19 45ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown# define VG_STACK_REDZONE_SZB 128 46ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 47ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#elif defined(VGP_ppc32_linux) 48ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown# define VG_MIN_INSTR_SZB 4 49ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown# define VG_MAX_INSTR_SZB 4 50ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown# define VG_CLREQ_SZB 20 51ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown# define VG_STACK_REDZONE_SZB 0 52ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 53ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#elif defined(VGP_ppc64_linux) 54ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown# define VG_MIN_INSTR_SZB 4 55ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown# define VG_MAX_INSTR_SZB 4 56ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown# define VG_CLREQ_SZB 20 57ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown# define VG_STACK_REDZONE_SZB 288 // number of addressable bytes below R1 58ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown // from 64-bit PowerPC ELF ABI 59ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown // Supplement 1.7 60ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 61ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#elif defined(VGP_arm_linux) 62ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown# define VG_MIN_INSTR_SZB 2 63ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown# define VG_MAX_INSTR_SZB 4 64ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown# define VG_CLREQ_SZB 20 65ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown# define VG_STACK_REDZONE_SZB 0 66ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 67b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov#elif defined(VGP_s390x_linux) 68b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov# define VG_MIN_INSTR_SZB 2 69b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov# define VG_MAX_INSTR_SZB 6 70b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov# define VG_CLREQ_SZB 10 71b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov# define VG_STACK_REDZONE_SZB 0 // s390 has no redzone 72ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 73ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#elif defined(VGP_x86_darwin) 74ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown# define VG_MIN_INSTR_SZB 1 // min length of native instruction 75ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown# define VG_MAX_INSTR_SZB 16 // max length of native instruction 76ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown# define VG_CLREQ_SZB 14 // length of a client request, may 77ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown // be larger than VG_MAX_INSTR_SZB 78ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown# define VG_STACK_REDZONE_SZB 0 // number of addressable bytes below %RSP 79ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 80ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#elif defined(VGP_amd64_darwin) 81ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown# define VG_MIN_INSTR_SZB 1 82ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown# define VG_MAX_INSTR_SZB 16 83ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown# define VG_CLREQ_SZB 19 84ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown# define VG_STACK_REDZONE_SZB 128 85ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 86663860b1408516d02ebfcb3a9999a134e6cfb223Ben Cheng#elif defined(VGP_mips32_linux) 87663860b1408516d02ebfcb3a9999a134e6cfb223Ben Cheng# define VG_MIN_INSTR_SZB 4 88663860b1408516d02ebfcb3a9999a134e6cfb223Ben Cheng# define VG_MAX_INSTR_SZB 4 89663860b1408516d02ebfcb3a9999a134e6cfb223Ben Cheng# define VG_CLREQ_SZB 20 90663860b1408516d02ebfcb3a9999a134e6cfb223Ben Cheng# define VG_STACK_REDZONE_SZB 0 91663860b1408516d02ebfcb3a9999a134e6cfb223Ben Cheng 92ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#else 93ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown# error Unknown platform 94ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#endif 95ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 96ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// Guest state accessors 97ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// Are mostly in the core_ header. 98ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// Only these two are available to tools. 99ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff BrownAddr VG_(get_IP) ( ThreadId tid ); 100ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff BrownAddr VG_(get_SP) ( ThreadId tid ); 101ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 102ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 103ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// For get/set, 'area' is where the asked-for guest state will be copied 104ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// into/from. If shadowNo == 0, the real (non-shadow) guest state is 105ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// accessed. If shadowNo == 1, the first shadow area is accessed, and 106ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// if shadowNo == 2, the second shadow area is accessed. This gives a 107ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// completely general way to read/modify a thread's guest register state 108ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// providing you know the offsets you need. 109ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownvoid 110ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff BrownVG_(get_shadow_regs_area) ( ThreadId tid, 111ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /*DST*/UChar* dst, 112ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /*SRC*/Int shadowNo, PtrdiffT offset, SizeT size ); 113ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownvoid 114ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff BrownVG_(set_shadow_regs_area) ( ThreadId tid, 115ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /*DST*/Int shadowNo, PtrdiffT offset, SizeT size, 116ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /*SRC*/const UChar* src ); 117ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 118ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// Sets the shadow values for the syscall return value register(s). 119ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// This is platform specific. 120ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownvoid VG_(set_syscall_return_shadows) ( ThreadId tid, 121ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* shadow vals for the result */ 122ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown UWord s1res, UWord s2res, 123ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* shadow vals for the error val */ 124ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown UWord s1err, UWord s2err ); 125ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 126ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// Apply a function 'f' to all the general purpose registers in all the 127ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// current threads. 128ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// This is very Memcheck-specific -- it's used to find the roots when 129ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// doing leak checking. 130663860b1408516d02ebfcb3a9999a134e6cfb223Ben Chengextern void VG_(apply_to_GP_regs)(void (*f)(ThreadId tid, 131663860b1408516d02ebfcb3a9999a134e6cfb223Ben Cheng HChar* regname, UWord val)); 132ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 133ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// This iterator lets you inspect each live thread's stack bounds. 134ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// Returns False at the end. 'tid' is the iterator and you can only 135ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// safely change it by making calls to these functions. 136ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern void VG_(thread_stack_reset_iter) ( /*OUT*/ThreadId* tid ); 137ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Bool VG_(thread_stack_next) ( /*MOD*/ThreadId* tid, 138ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /*OUT*/Addr* stack_min, 139ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /*OUT*/Addr* stack_max ); 140ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 141ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// Returns .client_stack_highest_word for the given thread 142ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Addr VG_(thread_get_stack_max) ( ThreadId tid ); 143ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 144ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// Returns how many bytes have been allocated for the stack of the given thread 145ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern SizeT VG_(thread_get_stack_size) ( ThreadId tid ); 146ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 147ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// Returns the bottommost address of the alternate signal stack. 148ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// See also the man page of sigaltstack(). 149ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Addr VG_(thread_get_altstack_min) ( ThreadId tid ); 150ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 151ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// Returns how many bytes have been allocated for the alternate signal stack. 152ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// See also the man page of sigaltstack(). 153ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern SizeT VG_(thread_get_altstack_size) ( ThreadId tid ); 154ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 155ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// Given a pointer to a function as obtained by "& functionname" in C, 156ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// produce a pointer to the actual entry point for the function. For 157ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// most platforms it's the identity function. Unfortunately, on 158ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// ppc64-linux it isn't (sigh). 159ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern void* VG_(fnptr_to_fnentry)( void* ); 160ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 161663860b1408516d02ebfcb3a9999a134e6cfb223Ben Cheng/* Returns the size of the largest guest register that we will 162663860b1408516d02ebfcb3a9999a134e6cfb223Ben Cheng simulate in this run. This depends on both the guest architecture 163663860b1408516d02ebfcb3a9999a134e6cfb223Ben Cheng and on the specific capabilities we are simulating for that guest 164663860b1408516d02ebfcb3a9999a134e6cfb223Ben Cheng (eg, AVX or non-AVX ?, for amd64). */ 165663860b1408516d02ebfcb3a9999a134e6cfb223Ben Chengextern Int VG_(machine_get_size_of_largest_guest_register) ( void ); 166663860b1408516d02ebfcb3a9999a134e6cfb223Ben Cheng 167ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#endif // __PUB_TOOL_MACHINE_H 168ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 169ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/ 170ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--- end ---*/ 171ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/ 172