njn | f536bbb | 2005-06-13 04:21:38 +0000 | [diff] [blame] | 1 | |
| 2 | /*--------------------------------------------------------------------*/ |
| 3 | /*--- Machine-related stuff. pub_tool_machine.h ---*/ |
| 4 | /*--------------------------------------------------------------------*/ |
| 5 | |
| 6 | /* |
| 7 | This file is part of Valgrind, a dynamic binary instrumentation |
| 8 | framework. |
| 9 | |
sewardj | 03f8d3f | 2012-08-05 15:46:46 +0000 | [diff] [blame] | 10 | Copyright (C) 2000-2012 Julian Seward |
njn | f536bbb | 2005-06-13 04:21:38 +0000 | [diff] [blame] | 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 | |
njn | 4a164d0 | 2005-06-18 18:49:40 +0000 | [diff] [blame] | 31 | #ifndef __PUB_TOOL_MACHINE_H |
| 32 | #define __PUB_TOOL_MACHINE_H |
njn | f536bbb | 2005-06-13 04:21:38 +0000 | [diff] [blame] | 33 | |
florian | 7862701 | 2012-10-07 19:47:04 +0000 | [diff] [blame^] | 34 | #include "libvex.h" // VexArchInfo |
| 35 | |
sewardj | f1c91e0 | 2006-10-17 01:35:58 +0000 | [diff] [blame] | 36 | #if defined(VGP_x86_linux) |
njn | a5ad9ba | 2005-11-10 15:20:37 +0000 | [diff] [blame] | 37 | # define VG_MIN_INSTR_SZB 1 // min length of native instruction |
| 38 | # define VG_MAX_INSTR_SZB 16 // max length of native instruction |
sewardj | 0ec07f3 | 2006-01-12 12:32:32 +0000 | [diff] [blame] | 39 | # define VG_CLREQ_SZB 14 // length of a client request, may |
njn | a5ad9ba | 2005-11-10 15:20:37 +0000 | [diff] [blame] | 40 | // be larger than VG_MAX_INSTR_SZB |
sewardj | c281233 | 2005-12-23 23:34:51 +0000 | [diff] [blame] | 41 | # define VG_STACK_REDZONE_SZB 0 // number of addressable bytes below %RSP |
sewardj | 59570ff | 2010-01-01 11:59:33 +0000 | [diff] [blame] | 42 | |
sewardj | f1c91e0 | 2006-10-17 01:35:58 +0000 | [diff] [blame] | 43 | #elif defined(VGP_amd64_linux) |
njn | af839f5 | 2005-06-23 03:27:57 +0000 | [diff] [blame] | 44 | # define VG_MIN_INSTR_SZB 1 |
| 45 | # define VG_MAX_INSTR_SZB 16 |
sewardj | 0ec07f3 | 2006-01-12 12:32:32 +0000 | [diff] [blame] | 46 | # define VG_CLREQ_SZB 19 |
njn | af839f5 | 2005-06-23 03:27:57 +0000 | [diff] [blame] | 47 | # define VG_STACK_REDZONE_SZB 128 |
sewardj | 59570ff | 2010-01-01 11:59:33 +0000 | [diff] [blame] | 48 | |
sewardj | f1c91e0 | 2006-10-17 01:35:58 +0000 | [diff] [blame] | 49 | #elif defined(VGP_ppc32_linux) |
njn | af839f5 | 2005-06-23 03:27:57 +0000 | [diff] [blame] | 50 | # define VG_MIN_INSTR_SZB 4 |
| 51 | # define VG_MAX_INSTR_SZB 4 |
sewardj | d68ac3e | 2006-01-20 14:31:57 +0000 | [diff] [blame] | 52 | # define VG_CLREQ_SZB 20 |
njn | af839f5 | 2005-06-23 03:27:57 +0000 | [diff] [blame] | 53 | # define VG_STACK_REDZONE_SZB 0 |
sewardj | 59570ff | 2010-01-01 11:59:33 +0000 | [diff] [blame] | 54 | |
sewardj | f1c91e0 | 2006-10-17 01:35:58 +0000 | [diff] [blame] | 55 | #elif defined(VGP_ppc64_linux) |
sewardj | 2c48c7b | 2005-11-29 13:05:56 +0000 | [diff] [blame] | 56 | # define VG_MIN_INSTR_SZB 4 |
| 57 | # define VG_MAX_INSTR_SZB 4 |
sewardj | d68ac3e | 2006-01-20 14:31:57 +0000 | [diff] [blame] | 58 | # define VG_CLREQ_SZB 20 |
sewardj | c281233 | 2005-12-23 23:34:51 +0000 | [diff] [blame] | 59 | # define VG_STACK_REDZONE_SZB 288 // number of addressable bytes below R1 |
sewardj | 59570ff | 2010-01-01 11:59:33 +0000 | [diff] [blame] | 60 | // from 64-bit PowerPC ELF ABI |
| 61 | // Supplement 1.7 |
| 62 | |
| 63 | #elif defined(VGP_arm_linux) |
sewardj | 1dbd337 | 2010-08-22 12:21:14 +0000 | [diff] [blame] | 64 | # define VG_MIN_INSTR_SZB 2 |
sewardj | 59570ff | 2010-01-01 11:59:33 +0000 | [diff] [blame] | 65 | # define VG_MAX_INSTR_SZB 4 |
sewardj | 807725e | 2010-10-12 10:13:17 +0000 | [diff] [blame] | 66 | # define VG_CLREQ_SZB 20 |
sewardj | 59570ff | 2010-01-01 11:59:33 +0000 | [diff] [blame] | 67 | # define VG_STACK_REDZONE_SZB 0 |
| 68 | |
sewardj | b5b8740 | 2011-03-07 16:05:35 +0000 | [diff] [blame] | 69 | #elif defined(VGP_s390x_linux) |
| 70 | # define VG_MIN_INSTR_SZB 2 |
| 71 | # define VG_MAX_INSTR_SZB 6 |
| 72 | # define VG_CLREQ_SZB 10 |
| 73 | # define VG_STACK_REDZONE_SZB 0 // s390 has no redzone |
| 74 | |
njn | f76d27a | 2009-05-28 01:53:07 +0000 | [diff] [blame] | 75 | #elif defined(VGP_x86_darwin) |
| 76 | # define VG_MIN_INSTR_SZB 1 // min length of native instruction |
| 77 | # define VG_MAX_INSTR_SZB 16 // max length of native instruction |
| 78 | # define VG_CLREQ_SZB 14 // length of a client request, may |
| 79 | // be larger than VG_MAX_INSTR_SZB |
| 80 | # define VG_STACK_REDZONE_SZB 0 // number of addressable bytes below %RSP |
sewardj | 59570ff | 2010-01-01 11:59:33 +0000 | [diff] [blame] | 81 | |
njn | f76d27a | 2009-05-28 01:53:07 +0000 | [diff] [blame] | 82 | #elif defined(VGP_amd64_darwin) |
| 83 | # define VG_MIN_INSTR_SZB 1 |
| 84 | # define VG_MAX_INSTR_SZB 16 |
| 85 | # define VG_CLREQ_SZB 19 |
| 86 | # define VG_STACK_REDZONE_SZB 128 |
sewardj | 59570ff | 2010-01-01 11:59:33 +0000 | [diff] [blame] | 87 | |
sewardj | 5db1540 | 2012-06-07 09:13:21 +0000 | [diff] [blame] | 88 | #elif defined(VGP_mips32_linux) |
| 89 | # define VG_MIN_INSTR_SZB 4 |
| 90 | # define VG_MAX_INSTR_SZB 4 |
| 91 | # define VG_CLREQ_SZB 20 |
| 92 | # define VG_STACK_REDZONE_SZB 0 |
| 93 | |
njn | f536bbb | 2005-06-13 04:21:38 +0000 | [diff] [blame] | 94 | #else |
sewardj | f1c91e0 | 2006-10-17 01:35:58 +0000 | [diff] [blame] | 95 | # error Unknown platform |
njn | f536bbb | 2005-06-13 04:21:38 +0000 | [diff] [blame] | 96 | #endif |
| 97 | |
| 98 | // Guest state accessors |
sewardj | 1dbd337 | 2010-08-22 12:21:14 +0000 | [diff] [blame] | 99 | // Are mostly in the core_ header. |
| 100 | // Only these two are available to tools. |
| 101 | Addr VG_(get_IP) ( ThreadId tid ); |
| 102 | Addr VG_(get_SP) ( ThreadId tid ); |
njn | f536bbb | 2005-06-13 04:21:38 +0000 | [diff] [blame] | 103 | |
njn | f536bbb | 2005-06-13 04:21:38 +0000 | [diff] [blame] | 104 | |
sewardj | 9c606bd | 2008-09-18 18:12:50 +0000 | [diff] [blame] | 105 | // For get/set, 'area' is where the asked-for guest state will be copied |
| 106 | // into/from. If shadowNo == 0, the real (non-shadow) guest state is |
| 107 | // accessed. If shadowNo == 1, the first shadow area is accessed, and |
| 108 | // if shadowNo == 2, the second shadow area is accessed. This gives a |
| 109 | // completely general way to read/modify a thread's guest register state |
| 110 | // providing you know the offsets you need. |
sewardj | 7cf4e6b | 2008-05-01 20:24:26 +0000 | [diff] [blame] | 111 | void |
| 112 | VG_(get_shadow_regs_area) ( ThreadId tid, |
| 113 | /*DST*/UChar* dst, |
njn | c4431bf | 2009-01-15 21:29:24 +0000 | [diff] [blame] | 114 | /*SRC*/Int shadowNo, PtrdiffT offset, SizeT size ); |
sewardj | 7cf4e6b | 2008-05-01 20:24:26 +0000 | [diff] [blame] | 115 | void |
| 116 | VG_(set_shadow_regs_area) ( ThreadId tid, |
njn | c4431bf | 2009-01-15 21:29:24 +0000 | [diff] [blame] | 117 | /*DST*/Int shadowNo, PtrdiffT offset, SizeT size, |
sewardj | 7cf4e6b | 2008-05-01 20:24:26 +0000 | [diff] [blame] | 118 | /*SRC*/const UChar* src ); |
njn | f536bbb | 2005-06-13 04:21:38 +0000 | [diff] [blame] | 119 | |
sewardj | 9c606bd | 2008-09-18 18:12:50 +0000 | [diff] [blame] | 120 | // Sets the shadow values for the syscall return value register(s). |
| 121 | // This is platform specific. |
| 122 | void VG_(set_syscall_return_shadows) ( ThreadId tid, |
| 123 | /* shadow vals for the result */ |
| 124 | UWord s1res, UWord s2res, |
| 125 | /* shadow vals for the error val */ |
| 126 | UWord s1err, UWord s2err ); |
| 127 | |
njn | 6ace3ea | 2005-06-17 03:06:27 +0000 | [diff] [blame] | 128 | // Apply a function 'f' to all the general purpose registers in all the |
| 129 | // current threads. |
| 130 | // This is very Memcheck-specific -- it's used to find the roots when |
| 131 | // doing leak checking. |
philippe | a22f59d | 2012-01-26 23:13:52 +0000 | [diff] [blame] | 132 | extern void VG_(apply_to_GP_regs)(void (*f)(ThreadId tid, |
| 133 | HChar* regname, UWord val)); |
njn | 6ace3ea | 2005-06-17 03:06:27 +0000 | [diff] [blame] | 134 | |
sewardj | b8b79ad | 2008-03-03 01:35:41 +0000 | [diff] [blame] | 135 | // This iterator lets you inspect each live thread's stack bounds. |
| 136 | // Returns False at the end. 'tid' is the iterator and you can only |
| 137 | // safely change it by making calls to these functions. |
| 138 | extern void VG_(thread_stack_reset_iter) ( /*OUT*/ThreadId* tid ); |
| 139 | extern Bool VG_(thread_stack_next) ( /*MOD*/ThreadId* tid, |
| 140 | /*OUT*/Addr* stack_min, |
| 141 | /*OUT*/Addr* stack_max ); |
njn | b506bd8 | 2005-06-21 04:01:51 +0000 | [diff] [blame] | 142 | |
sewardj | bbec772 | 2007-11-25 14:08:53 +0000 | [diff] [blame] | 143 | // Returns .client_stack_highest_word for the given thread |
| 144 | extern Addr VG_(thread_get_stack_max) ( ThreadId tid ); |
| 145 | |
bart | 0fb0320 | 2008-03-29 09:25:53 +0000 | [diff] [blame] | 146 | // Returns how many bytes have been allocated for the stack of the given thread |
bart | 019a43f | 2010-09-02 14:41:05 +0000 | [diff] [blame] | 147 | extern SizeT VG_(thread_get_stack_size) ( ThreadId tid ); |
bart | 0fb0320 | 2008-03-29 09:25:53 +0000 | [diff] [blame] | 148 | |
bart | 83c5a92 | 2010-09-02 14:38:38 +0000 | [diff] [blame] | 149 | // Returns the bottommost address of the alternate signal stack. |
| 150 | // See also the man page of sigaltstack(). |
| 151 | extern Addr VG_(thread_get_altstack_min) ( ThreadId tid ); |
| 152 | |
| 153 | // Returns how many bytes have been allocated for the alternate signal stack. |
| 154 | // See also the man page of sigaltstack(). |
| 155 | extern SizeT VG_(thread_get_altstack_size) ( ThreadId tid ); |
| 156 | |
sewardj | 53ee1fc | 2005-12-23 02:29:58 +0000 | [diff] [blame] | 157 | // Given a pointer to a function as obtained by "& functionname" in C, |
| 158 | // produce a pointer to the actual entry point for the function. For |
| 159 | // most platforms it's the identity function. Unfortunately, on |
| 160 | // ppc64-linux it isn't (sigh). |
| 161 | extern void* VG_(fnptr_to_fnentry)( void* ); |
| 162 | |
sewardj | 98763d5 | 2012-06-03 22:40:07 +0000 | [diff] [blame] | 163 | /* Returns the size of the largest guest register that we will |
| 164 | simulate in this run. This depends on both the guest architecture |
| 165 | and on the specific capabilities we are simulating for that guest |
| 166 | (eg, AVX or non-AVX ?, for amd64). */ |
| 167 | extern Int VG_(machine_get_size_of_largest_guest_register) ( void ); |
| 168 | |
florian | 7862701 | 2012-10-07 19:47:04 +0000 | [diff] [blame^] | 169 | /* Return host cpu info. */ |
| 170 | extern void VG_(machine_get_VexArchInfo)( /*OUT*/VexArch*, |
| 171 | /*OUT*/VexArchInfo* ); |
| 172 | |
njn | 4a164d0 | 2005-06-18 18:49:40 +0000 | [diff] [blame] | 173 | #endif // __PUB_TOOL_MACHINE_H |
njn | f536bbb | 2005-06-13 04:21:38 +0000 | [diff] [blame] | 174 | |
| 175 | /*--------------------------------------------------------------------*/ |
| 176 | /*--- end ---*/ |
| 177 | /*--------------------------------------------------------------------*/ |