sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1 | |
| 2 | /*--------------------------------------------------------------------*/ |
njn | 717cde5 | 2005-05-10 02:47:21 +0000 | [diff] [blame] | 3 | /*--- A header file for various private parts of Valgrind's core. ---*/ |
rjwalsh | 7109a8c | 2004-09-02 00:31:02 +0000 | [diff] [blame] | 4 | /*--- core.h ---*/ |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 5 | /*--------------------------------------------------------------------*/ |
| 6 | |
| 7 | /* |
njn | b9c427c | 2004-12-01 14:14:42 +0000 | [diff] [blame] | 8 | This file is part of Valgrind, a dynamic binary instrumentation |
| 9 | framework. |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 10 | |
njn | 5361242 | 2005-03-12 16:22:54 +0000 | [diff] [blame] | 11 | Copyright (C) 2000-2005 Julian Seward |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 12 | jseward@acm.org |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 13 | |
| 14 | This program is free software; you can redistribute it and/or |
| 15 | modify it under the terms of the GNU General Public License as |
| 16 | published by the Free Software Foundation; either version 2 of the |
| 17 | License, or (at your option) any later version. |
| 18 | |
| 19 | This program is distributed in the hope that it will be useful, but |
| 20 | WITHOUT ANY WARRANTY; without even the implied warranty of |
| 21 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| 22 | General Public License for more details. |
| 23 | |
| 24 | You should have received a copy of the GNU General Public License |
| 25 | along with this program; if not, write to the Free Software |
| 26 | Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA |
| 27 | 02111-1307, USA. |
| 28 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 29 | The GNU General Public License is contained in the file COPYING. |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 30 | */ |
| 31 | |
rjwalsh | 7109a8c | 2004-09-02 00:31:02 +0000 | [diff] [blame] | 32 | #ifndef __CORE_H |
| 33 | #define __CORE_H |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 34 | |
nethercote | 1334313 | 2004-09-02 15:49:09 +0000 | [diff] [blame] | 35 | #include "tool.h" // tool stuff |
nethercote | bb4222b | 2004-09-10 17:42:11 +0000 | [diff] [blame] | 36 | #include "core_arch.h" // arch-specific stuff, eg. x86/core_arch.h |
nethercote | 8ff888f | 2004-11-17 17:11:45 +0000 | [diff] [blame] | 37 | |
| 38 | // Ugly: this is needed by linux/core_os.h |
| 39 | typedef struct _ThreadState ThreadState; |
| 40 | |
nethercote | bb4222b | 2004-09-10 17:42:11 +0000 | [diff] [blame] | 41 | #include "core_platform.h" // platform-specific stuff, |
| 42 | // eg. x86-linux/core_platform.h |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 43 | #include "core_os.h" // OS-specific stuff, eg. linux/core_os.h |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 44 | |
njn | 717cde5 | 2005-05-10 02:47:21 +0000 | [diff] [blame] | 45 | #include "pub_core_mallocfree.h" // for type 'ArenaId' |
njn | d01fef7 | 2005-03-25 23:35:48 +0000 | [diff] [blame] | 46 | #include "pub_core_stacktrace.h" // for type 'StackTrace' |
| 47 | |
njn | 4f6e370 | 2005-05-16 20:50:52 +0000 | [diff] [blame] | 48 | #include <setjmp.h> /* for jmp_buf */ |
| 49 | |
nethercote | 7be4725 | 2004-09-02 16:02:58 +0000 | [diff] [blame] | 50 | /* --------------------------------------------------------------------- |
njn | 14319cc | 2005-03-13 06:26:22 +0000 | [diff] [blame] | 51 | Global macros. |
nethercote | 7be4725 | 2004-09-02 16:02:58 +0000 | [diff] [blame] | 52 | ------------------------------------------------------------------ */ |
| 53 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 54 | /* Max length of a text fragment used to construct error messages. */ |
njn | 47b209a | 2005-03-25 23:47:16 +0000 | [diff] [blame] | 55 | #define VG_ERRTXT_LEN 4096 |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 56 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 57 | /* The maximum number of calls we're prepared to save in a |
| 58 | backtrace. */ |
| 59 | #define VG_DEEPEST_BACKTRACE 50 |
| 60 | |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 61 | /* Useful macros */ |
| 62 | /* a - alignment - must be a power of 2 */ |
tom | de2ec26 | 2005-03-29 12:16:10 +0000 | [diff] [blame] | 63 | #define ROUNDDN(p, a) ((Addr)(p) & ~((Addr)(a)-1)) |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 64 | #define ROUNDUP(p, a) ROUNDDN((p)+(a)-1, (a)) |
nethercote | 73b526f | 2004-10-31 18:48:21 +0000 | [diff] [blame] | 65 | #define PGROUNDDN(p) ROUNDDN(p, VKI_PAGE_SIZE) |
| 66 | #define PGROUNDUP(p) ROUNDUP(p, VKI_PAGE_SIZE) |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 67 | |
sewardj | 51ac087 | 2004-12-21 01:20:49 +0000 | [diff] [blame] | 68 | |
nethercote | 80013e9 | 2004-09-05 20:39:51 +0000 | [diff] [blame] | 69 | /* --------------------------------------------------------------------- |
| 70 | Environment variables |
| 71 | ------------------------------------------------------------------ */ |
| 72 | |
| 73 | /* The directory we look for all our auxillary files in */ |
| 74 | #define VALGRINDLIB "VALGRINDLIB" |
| 75 | |
| 76 | /* Additional command-line arguments; they are overridden by actual |
| 77 | command-line option. Each argument is separated by spaces. There |
| 78 | is no quoting mechanism. |
| 79 | */ |
| 80 | #define VALGRINDOPTS "VALGRIND_OPTS" |
| 81 | |
| 82 | /* If this variable is present in the environment, then valgrind will |
| 83 | not parse the command line for options at all; all options come |
| 84 | from this variable. Arguments are terminated by ^A (\001). There |
| 85 | is no quoting mechanism. |
| 86 | |
| 87 | This variable is not expected to be set by anything other than |
| 88 | Valgrind itself, as part of its handling of execve with |
| 89 | --trace-children=yes. This variable should not be present in the |
| 90 | client environment. |
| 91 | */ |
| 92 | #define VALGRINDCLO "_VALGRIND_CLO" |
| 93 | |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 94 | |
thughes | ad1c956 | 2004-06-26 11:27:52 +0000 | [diff] [blame] | 95 | /* Application-visible file descriptor limits */ |
| 96 | extern Int VG_(fd_soft_limit); |
| 97 | extern Int VG_(fd_hard_limit); |
fitzhardinge | f0046f2 | 2003-12-18 02:39:22 +0000 | [diff] [blame] | 98 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 99 | /* --------------------------------------------------------------------- |
nethercote | 85cdd34 | 2004-08-01 22:36:40 +0000 | [diff] [blame] | 100 | Profiling stuff |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 101 | ------------------------------------------------------------------ */ |
| 102 | |
njn | 31066fd | 2005-03-26 00:42:02 +0000 | [diff] [blame] | 103 | extern void VG_(init_profiling) ( void ); |
| 104 | extern void VG_(done_profiling) ( void ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 105 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 106 | #undef VGP_PUSHCC |
| 107 | #undef VGP_POPCC |
njn | 31066fd | 2005-03-26 00:42:02 +0000 | [diff] [blame] | 108 | #define VGP_PUSHCC(x) if (VG_(clo_profile)) VG_(pushcc)(x) |
| 109 | #define VGP_POPCC(x) if (VG_(clo_profile)) VG_(popcc)(x) |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 110 | |
sewardj | 51ac087 | 2004-12-21 01:20:49 +0000 | [diff] [blame] | 111 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 112 | /* --------------------------------------------------------------------- |
njn | 3e88418 | 2003-04-15 13:03:23 +0000 | [diff] [blame] | 113 | Exports of vg_intercept.c |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 114 | ------------------------------------------------------------------ */ |
| 115 | |
njn | a91498f | 2005-05-11 22:32:39 +0000 | [diff] [blame] | 116 | /* These are the internal client request codes. The publically-visible |
| 117 | request codes are also defined in valgrind.h, and similar headers for |
| 118 | some tools. */ |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 119 | |
njn | a91498f | 2005-05-11 22:32:39 +0000 | [diff] [blame] | 120 | /* Get the tool's malloc-wrapping functions */ |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 121 | #define VG_USERREQ__GET_MALLOCFUNCS 0x3030 |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 122 | |
fitzhardinge | 39de4b4 | 2003-10-31 07:12:21 +0000 | [diff] [blame] | 123 | /* Internal equivalent of VALGRIND_PRINTF . */ |
| 124 | #define VG_USERREQ__INTERNAL_PRINTF 0x3103 |
sewardj | 45b4b37 | 2002-04-16 22:50:32 +0000 | [diff] [blame] | 125 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 126 | /* Denote the finish of __libc_freeres_wrapper(). |
| 127 | A synonym for exit. */ |
| 128 | #define VG_USERREQ__LIBC_FREERES_DONE 0x3029 |
sewardj | 54cacf0 | 2002-04-12 23:24:59 +0000 | [diff] [blame] | 129 | |
njn | 717cde5 | 2005-05-10 02:47:21 +0000 | [diff] [blame] | 130 | /* Intercept prefix stuff. See |
| 131 | coregrind/m_replace_malloc/vg_replace_malloc.c for details. |
| 132 | Unfortunately the "_vgi_" literal is also hardcoded in that file, so if |
| 133 | you change this one you must also change the other one. */ |
sewardj | 9ee81f5 | 2005-04-02 17:38:59 +0000 | [diff] [blame] | 134 | #define VG_INTERCEPT_PREFIX "_vgi_" |
| 135 | #define VG_INTERCEPT_PREFIX_LEN 5 |
rjwalsh | e4e779d | 2004-04-16 23:02:29 +0000 | [diff] [blame] | 136 | |
sewardj | 9ee81f5 | 2005-04-02 17:38:59 +0000 | [diff] [blame] | 137 | /* Not sure what these are for. Todo: clarify */ |
| 138 | #define VG_WRAPPER_PREFIX "_vgw_" |
| 139 | #define VG_WRAPPER_PREFIX_LEN 5 |
| 140 | #define VG_WRAPPER(name) _vgw_##name |
| 141 | #define VG_WRAPPER_ALIAS(name) "_vgw_" #name |
rjwalsh | e4e779d | 2004-04-16 23:02:29 +0000 | [diff] [blame] | 142 | |
njn | 4c79121 | 2003-05-02 17:53:54 +0000 | [diff] [blame] | 143 | |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 144 | /* --------------------------------------------------------------------- |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 145 | Exports of vg_scheduler.c |
| 146 | ------------------------------------------------------------------ */ |
| 147 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 148 | /* |
| 149 | Thread state machine: |
| 150 | |
| 151 | Empty -> Init -> Runnable <=> WaitSys/Yielding |
| 152 | ^ | |
| 153 | \---- Zombie -----/ |
| 154 | */ |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 155 | typedef |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 156 | enum ThreadStatus { |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 157 | VgTs_Empty, /* this slot is not in use */ |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 158 | VgTs_Init, /* just allocated */ |
| 159 | VgTs_Runnable, /* ready to run */ |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 160 | VgTs_WaitSys, /* waiting for a syscall to complete */ |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 161 | VgTs_Yielding, /* temporarily yielding the CPU */ |
| 162 | VgTs_Zombie, /* transient state just before exiting */ |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 163 | } |
| 164 | ThreadStatus; |
sewardj | 8ad94e1 | 2002-05-29 00:10:20 +0000 | [diff] [blame] | 165 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 166 | /* Return codes from the scheduler. */ |
thughes | 11975ff | 2004-06-12 12:58:22 +0000 | [diff] [blame] | 167 | typedef |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 168 | enum { |
| 169 | VgSrc_None, /* not exiting yet */ |
| 170 | VgSrc_ExitSyscall, /* client called exit(). This is the normal |
| 171 | route out. */ |
| 172 | VgSrc_FatalSig /* Killed by the default action of a fatal |
| 173 | signal */ |
thughes | 11975ff | 2004-06-12 12:58:22 +0000 | [diff] [blame] | 174 | } |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 175 | VgSchedReturnCode; |
thughes | 11975ff | 2004-06-12 12:58:22 +0000 | [diff] [blame] | 176 | |
njn | 77e8ac1 | 2005-05-16 21:16:44 +0000 | [diff] [blame] | 177 | |
| 178 | #if defined(VGA_x86) |
| 179 | typedef VexGuestX86State VexGuestArchState; |
tom | bb42223 | 2005-05-16 23:16:25 +0000 | [diff] [blame] | 180 | #elif defined(VGA_amd64) |
njn | 77e8ac1 | 2005-05-16 21:16:44 +0000 | [diff] [blame] | 181 | typedef VexGuestAMD64State VexGuestArchState; |
| 182 | #elif defined(VGA_arm) |
| 183 | typedef VexGuestARMState VexGuestArchState; |
| 184 | #else |
| 185 | # error Unknown architecture |
| 186 | #endif |
| 187 | |
| 188 | |
| 189 | typedef |
| 190 | struct { |
| 191 | /* --- BEGIN vex-mandated guest state --- */ |
| 192 | |
| 193 | /* Saved machine context. */ |
| 194 | VexGuestArchState vex; |
| 195 | |
| 196 | /* Saved shadow context. */ |
| 197 | VexGuestArchState vex_shadow; |
| 198 | |
| 199 | /* Spill area. */ |
| 200 | UChar vex_spill[LibVEX_N_SPILL_BYTES]; |
| 201 | |
| 202 | /* --- END vex-mandated guest state --- */ |
| 203 | } |
| 204 | ThreadArchState; |
| 205 | |
| 206 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 207 | struct _ThreadState { |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 208 | /* ThreadId == 0 (and hence vg_threads[0]) is NEVER USED. |
| 209 | The thread identity is simply the index in vg_threads[]. |
| 210 | ThreadId == 1 is the root thread and has the special property |
| 211 | that we don't try and allocate or deallocate its stack. For |
| 212 | convenience of generating error message, we also put the |
| 213 | ThreadId in this tid field, but be aware that it should |
| 214 | ALWAYS == the index in vg_threads[]. */ |
| 215 | ThreadId tid; |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 216 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 217 | /* Current scheduling status. */ |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 218 | ThreadStatus status; |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 219 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 220 | /* This is set if the thread is in the process of exiting for any |
| 221 | reason. The precise details of the exit are in the OS-specific |
| 222 | state. */ |
| 223 | VgSchedReturnCode exitreason; |
sewardj | 3b5d886 | 2002-04-20 13:53:23 +0000 | [diff] [blame] | 224 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 225 | /* Architecture-specific thread state. */ |
| 226 | ThreadArchState arch; |
sewardj | b48e500 | 2002-05-13 00:16:03 +0000 | [diff] [blame] | 227 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 228 | /* This thread's blocked-signals mask. Semantics is that for a |
| 229 | signal to be delivered to this thread, the signal must not be |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 230 | blocked by this signal mask. If more than one thread accepts a |
| 231 | signal, then it will be delivered to one at random. If all |
| 232 | threads block the signal, it will remain pending until either a |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 233 | thread unblocks it or someone uses sigwaitsig/sigtimedwait. */ |
nethercote | 73b526f | 2004-10-31 18:48:21 +0000 | [diff] [blame] | 234 | vki_sigset_t sig_mask; |
sewardj | b48e500 | 2002-05-13 00:16:03 +0000 | [diff] [blame] | 235 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 236 | /* tmp_sig_mask is usually the same as sig_mask, and is kept in |
| 237 | sync whenever sig_mask is changed. The only time they have |
| 238 | different values is during the execution of a sigsuspend, where |
| 239 | tmp_sig_mask is the temporary mask which sigsuspend installs. |
| 240 | It is only consulted to compute the signal mask applied to a |
| 241 | signal handler. */ |
| 242 | vki_sigset_t tmp_sig_mask; |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 243 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 244 | /* A little signal queue for signals we can't get the kernel to |
| 245 | queue for us. This is only allocated as needed, since it should |
| 246 | be rare. */ |
| 247 | struct SigQueue *sig_queue; |
| 248 | |
| 249 | /* Syscall the Thread is currently running; -1 if none. Should only |
| 250 | be set while Thread is in VgTs_WaitSys. */ |
| 251 | Int syscallno; |
| 252 | |
| 253 | /* A value the Tool wants to pass from its pre-syscall to its |
| 254 | post-syscall function. */ |
| 255 | void *tool_pre_syscall_value; |
thughes | 8abf392 | 2004-10-16 10:59:49 +0000 | [diff] [blame] | 256 | |
njn | 50ba34e | 2005-04-04 02:41:42 +0000 | [diff] [blame] | 257 | /* Client stacks. When a thread slot is freed, we don't deallocate its |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 258 | stack; we just leave it lying around for the next use of the |
| 259 | slot. If the next use of the slot requires a larger stack, |
| 260 | only then is the old one deallocated and a new one |
| 261 | allocated. |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 262 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 263 | For the main thread (threadid == 0), this mechanism doesn't |
| 264 | apply. We don't know the size of the stack since we didn't |
| 265 | allocate it, and furthermore we never reallocate it. */ |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 266 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 267 | /* The allocated size of this thread's stack (permanently zero |
| 268 | if this is ThreadId == 0, since we didn't allocate its stack) */ |
njn | 50ba34e | 2005-04-04 02:41:42 +0000 | [diff] [blame] | 269 | SizeT client_stack_szB; |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 270 | |
sewardj | 92a5956 | 2002-09-30 00:53:10 +0000 | [diff] [blame] | 271 | /* Address of the highest legitimate word in this stack. This is |
| 272 | used for error messages only -- not critical for execution |
| 273 | correctness. Is is set for all stacks, specifically including |
| 274 | ThreadId == 0 (the main thread). */ |
njn | 50ba34e | 2005-04-04 02:41:42 +0000 | [diff] [blame] | 275 | Addr client_stack_highest_word; |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 276 | |
fitzhardinge | 98c4dc0 | 2004-03-16 08:27:29 +0000 | [diff] [blame] | 277 | /* Alternate signal stack */ |
nethercote | 73b526f | 2004-10-31 18:48:21 +0000 | [diff] [blame] | 278 | vki_stack_t altstack; |
fitzhardinge | 98c4dc0 | 2004-03-16 08:27:29 +0000 | [diff] [blame] | 279 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 280 | /* OS-specific thread state */ |
| 281 | os_thread_t os_state; |
sewardj | 004e8ca | 2005-02-28 17:27:04 +0000 | [diff] [blame] | 282 | |
| 283 | /* Used in the syscall handlers. Set to True to indicate that the |
| 284 | PRE routine for a syscall has set the syscall result already and |
| 285 | so the syscall does not need to be handed to the kernel. */ |
| 286 | Bool syscall_result_set; |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 287 | |
| 288 | /* Per-thread jmp_buf to resume scheduler after a signal */ |
| 289 | Bool sched_jmpbuf_valid; |
| 290 | jmp_buf sched_jmpbuf; |
nethercote | 8ff888f | 2004-11-17 17:11:45 +0000 | [diff] [blame] | 291 | }; |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 292 | |
sewardj | 018f762 | 2002-05-15 21:13:39 +0000 | [diff] [blame] | 293 | /* The thread table. */ |
| 294 | extern ThreadState VG_(threads)[VG_N_THREADS]; |
| 295 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 296 | /* Allocate a new ThreadState */ |
| 297 | extern ThreadId VG_(alloc_ThreadState)(void); |
| 298 | |
| 299 | /* A thread exits. tid must currently be running. */ |
| 300 | extern void VG_(exit_thread)(ThreadId tid); |
| 301 | |
| 302 | /* Kill a thread. This interrupts whatever a thread is doing, and |
| 303 | makes it exit ASAP. This does not set the exitreason or |
| 304 | exitcode. */ |
| 305 | extern void VG_(kill_thread)(ThreadId tid); |
| 306 | |
sewardj | 018f762 | 2002-05-15 21:13:39 +0000 | [diff] [blame] | 307 | /* Check that tid is in range and denotes a non-Empty thread. */ |
sewardj | b48e500 | 2002-05-13 00:16:03 +0000 | [diff] [blame] | 308 | extern Bool VG_(is_valid_tid) ( ThreadId tid ); |
| 309 | |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 310 | /* Get the ThreadState for a particular thread */ |
| 311 | extern ThreadState *VG_(get_ThreadState)(ThreadId tid); |
| 312 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 313 | /* Given an LWP id (ie, real kernel thread id), find the corresponding |
| 314 | ThreadId */ |
| 315 | extern ThreadId VG_(get_lwp_tid)(Int lwpid); |
| 316 | |
| 317 | /* Returns true if a thread is currently running (ie, has the CPU lock) */ |
| 318 | extern Bool VG_(is_running_thread)(ThreadId tid); |
| 319 | |
| 320 | /* Returns true if the thread is in the process of exiting */ |
| 321 | extern Bool VG_(is_exiting)(ThreadId tid); |
| 322 | |
| 323 | /* Return the number of non-dead Threads */ |
| 324 | extern Int VG_(count_living_threads)(void); |
| 325 | |
sewardj | ccef2e6 | 2002-05-29 19:26:32 +0000 | [diff] [blame] | 326 | /* Nuke all threads except tid. */ |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 327 | extern void VG_(nuke_all_threads_except) ( ThreadId me, VgSchedReturnCode reason ); |
sewardj | ccef2e6 | 2002-05-29 19:26:32 +0000 | [diff] [blame] | 328 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 329 | /* Make a thread the running thread. The thread must previously been |
| 330 | sleeping, and not holding the CPU semaphore. This will set the |
| 331 | thread state to VgTs_Runnable, and the thread will attempt to take |
| 332 | the CPU semaphore. By the time it returns, tid will be the running |
| 333 | thread. */ |
| 334 | extern void VG_(set_running) ( ThreadId tid ); |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 335 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 336 | /* Set a thread into a sleeping state. Before the call, the thread |
| 337 | must be runnable, and holding the CPU semaphore. When this call |
| 338 | returns, the thread will be set to the specified sleeping state, |
| 339 | and will not be holding the CPU semaphore. Note that another |
| 340 | thread could be running by the time this call returns, so the |
| 341 | caller must be careful not to touch any shared state. It is also |
| 342 | the caller's responsibility to actually block until the thread is |
| 343 | ready to run again. */ |
| 344 | extern void VG_(set_sleeping) ( ThreadId tid, ThreadStatus state ); |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 345 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 346 | /* Yield the CPU for a while */ |
| 347 | extern void VG_(vg_yield)(void); |
sewardj | 7e87e38 | 2002-05-03 19:09:05 +0000 | [diff] [blame] | 348 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 349 | // The scheduler. |
| 350 | extern VgSchedReturnCode VG_(scheduler) ( ThreadId tid ); |
| 351 | |
| 352 | // Do everything which needs doing before the process finally ends, |
| 353 | // like printing reports, etc |
| 354 | extern void VG_(shutdown_actions)(ThreadId tid); |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 355 | |
| 356 | extern void VG_(scheduler_init) ( void ); |
| 357 | |
sewardj | 15a43e1 | 2002-04-17 19:35:12 +0000 | [diff] [blame] | 358 | extern void VG_(pp_sched_status) ( void ); |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 359 | |
nethercote | 75d2624 | 2004-08-01 22:59:18 +0000 | [diff] [blame] | 360 | // Longjmp back to the scheduler and thus enter the sighandler immediately. |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 361 | extern void VG_(resume_scheduler) ( ThreadId tid ); |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 362 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 363 | /* If true, a fault is Valgrind-internal (ie, a bug) */ |
| 364 | extern Bool VG_(my_fault); |
nethercote | 238a3c3 | 2004-08-09 13:13:31 +0000 | [diff] [blame] | 365 | |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 366 | /* --------------------------------------------------------------------- |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 367 | Exports of vg_signals.c |
| 368 | ------------------------------------------------------------------ */ |
| 369 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 370 | /* Highest signal the kernel will let us use */ |
| 371 | extern Int VG_(max_signal); |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 372 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 373 | extern void VG_(sigstartup_actions) ( void ); |
| 374 | |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 375 | extern Bool VG_(is_sig_ign) ( Int sigNo ); |
| 376 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 377 | /* Poll a thread's set of pending signals, and update the Thread's context to deliver one */ |
| 378 | extern void VG_(poll_signals) ( ThreadId ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 379 | |
| 380 | /* Fake system calls for signal handling. */ |
njn | 502badb | 2005-05-08 02:04:49 +0000 | [diff] [blame] | 381 | extern Int VG_(do_sys_sigaltstack) ( ThreadId tid, vki_stack_t* ss, |
| 382 | vki_stack_t* oss ); |
| 383 | extern Int VG_(do_sys_sigaction) ( Int signo, |
| 384 | const struct vki_sigaction *new_act, |
| 385 | struct vki_sigaction *old_act ); |
| 386 | extern Int VG_(do_sys_sigprocmask) ( ThreadId tid, Int how, |
| 387 | vki_sigset_t* set, |
| 388 | vki_sigset_t* oldset ); |
sewardj | efbfcdf | 2002-06-19 17:35:45 +0000 | [diff] [blame] | 389 | |
njn | 444eba1 | 2005-05-12 03:47:31 +0000 | [diff] [blame] | 390 | extern void VG_(clear_out_queued_signals) |
| 391 | ( ThreadId tid, /* OUT */ vki_sigset_t* saved_mask ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 392 | |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 393 | extern void VG_(kill_self)(Int sigNo); |
| 394 | |
fitzhardinge | f1beb25 | 2004-03-16 09:49:08 +0000 | [diff] [blame] | 395 | /* These function synthesize a fault, as if the running instruction |
| 396 | had had a fault. These functions do not return - they longjmp back |
| 397 | into the scheduler so the signal can be delivered. */ |
| 398 | extern void VG_(synth_fault) (ThreadId tid); |
| 399 | extern void VG_(synth_fault_mapping)(ThreadId tid, Addr addr); |
| 400 | extern void VG_(synth_fault_perms) (ThreadId tid, Addr addr); |
sewardj | 5e2f001 | 2004-12-13 14:10:34 +0000 | [diff] [blame] | 401 | extern void VG_(synth_sigill) (ThreadId tid, Addr addr); |
fitzhardinge | f1beb25 | 2004-03-16 09:49:08 +0000 | [diff] [blame] | 402 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 403 | /* Extend the stack to cover addr, if possible */ |
| 404 | extern Bool VG_(extend_stack)(Addr addr, UInt maxsize); |
| 405 | |
| 406 | /* Returns True if the signal is OK for the client to use */ |
| 407 | extern Bool VG_(client_signal_OK)(Int sigNo); |
| 408 | |
| 409 | /* Forces the client's signal handler to SIG_DFL - generally just |
| 410 | before using that signal to kill the process. */ |
| 411 | extern void VG_(set_default_handler)(Int sig); |
| 412 | |
| 413 | /* Adjust a client's signal mask to match our internal requirements */ |
| 414 | extern void VG_(sanitize_client_sigmask)(ThreadId tid, vki_sigset_t *mask); |
| 415 | |
| 416 | /* Wait until a thread-related predicate is true */ |
| 417 | extern void VG_(wait_for_threadstate)(Bool (*pred)(void *), void *arg); |
sewardj | 51ac087 | 2004-12-21 01:20:49 +0000 | [diff] [blame] | 418 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 419 | /* --------------------------------------------------------------------- |
| 420 | Exports of vg_mylibc.c |
| 421 | ------------------------------------------------------------------ */ |
| 422 | |
njn | ca0518d | 2004-11-26 19:34:36 +0000 | [diff] [blame] | 423 | // Useful for making failing stubs, when certain things haven't yet been |
| 424 | // implemented. |
njn | 50ae1a7 | 2005-04-08 23:28:23 +0000 | [diff] [blame] | 425 | #define I_die_here \ |
sewardj | 0ab10c4 | 2005-05-12 08:26:36 +0000 | [diff] [blame] | 426 | VG_(assert_fail) (/*isCore*//*BOGUS*/True, \ |
| 427 | "Unimplemented functionality", \ |
njn | 50ae1a7 | 2005-04-08 23:28:23 +0000 | [diff] [blame] | 428 | __FILE__, __LINE__, __PRETTY_FUNCTION__, \ |
| 429 | "valgrind", VG_BUGS_TO, "") |
njn | ca0518d | 2004-11-26 19:34:36 +0000 | [diff] [blame] | 430 | |
njn | 50ae1a7 | 2005-04-08 23:28:23 +0000 | [diff] [blame] | 431 | #define vg_assert(expr) \ |
| 432 | ((void) ((expr) ? 0 : \ |
| 433 | (VG_(assert_fail) (/*isCore*/True, VG_STRINGIFY(expr), \ |
| 434 | __FILE__, __LINE__, __PRETTY_FUNCTION__, \ |
| 435 | ""), \ |
| 436 | 0))) |
| 437 | |
| 438 | #define vg_assert2(expr, format, args...) \ |
| 439 | ((void) ((expr) ? 0 : \ |
| 440 | (VG_(assert_fail) (/*isCore*/True, VG_STRINGIFY(expr), \ |
| 441 | __FILE__, __LINE__, __PRETTY_FUNCTION__, \ |
| 442 | format, ##args), \ |
| 443 | 0))) |
| 444 | |
njn | e427a66 | 2002-10-02 11:08:25 +0000 | [diff] [blame] | 445 | __attribute__ ((__noreturn__)) |
| 446 | extern void VG_(core_panic) ( Char* str ); |
thughes | 5876d55 | 2004-09-26 18:44:06 +0000 | [diff] [blame] | 447 | __attribute__ ((__noreturn__)) |
njn | d01fef7 | 2005-03-25 23:35:48 +0000 | [diff] [blame] | 448 | extern void VG_(core_panic_at) ( Char* str, StackTrace ips ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 449 | |
nethercote | 05675c8 | 2004-08-04 10:37:49 +0000 | [diff] [blame] | 450 | /* Tools use VG_(strdup)() which doesn't expose ArenaId */ |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 451 | extern Char* VG_(arena_strdup) ( ArenaId aid, const Char* s); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 452 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 453 | extern Int VG_(fcntl) ( Int fd, Int cmd, Int arg ); |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 454 | extern Int VG_(poll)( struct vki_pollfd *, UInt nfds, Int timeout); |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 455 | |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 456 | /* system/mman.h */ |
nethercote | 8b5f40c | 2004-11-02 13:29:50 +0000 | [diff] [blame] | 457 | extern void* VG_(mmap)( void* start, SizeT length, UInt prot, UInt flags, |
nethercote | 5b9fafd | 2004-11-04 18:39:22 +0000 | [diff] [blame] | 458 | UInt sf_flags, UInt fd, OffT offset ); |
nethercote | 8b5f40c | 2004-11-02 13:29:50 +0000 | [diff] [blame] | 459 | extern Int VG_(munmap)( void* start, SizeT length ); |
| 460 | extern Int VG_(mprotect)( void *start, SizeT length, UInt prot ); |
sewardj | 79048ce | 2005-02-18 08:28:32 +0000 | [diff] [blame] | 461 | extern Int VG_(mprotect_native)( void *start, SizeT length, UInt prot ); |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 462 | |
| 463 | |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 464 | /* Move an fd into the Valgrind-safe range */ |
| 465 | Int VG_(safe_fd)(Int oldfd); |
| 466 | |
sewardj | 570f890 | 2002-11-03 11:44:36 +0000 | [diff] [blame] | 467 | extern Int VG_(write_socket)( Int sd, void *msg, Int count ); |
sewardj | 73cf3bc | 2002-11-03 03:20:15 +0000 | [diff] [blame] | 468 | |
| 469 | /* --- Connecting over the network --- */ |
| 470 | extern Int VG_(connect_via_socket)( UChar* str ); |
| 471 | |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 472 | /* Environment manipulations */ |
nethercote | 60a96c5 | 2004-08-03 13:08:31 +0000 | [diff] [blame] | 473 | extern Char **VG_(env_setenv) ( Char ***envp, const Char* varname, |
| 474 | const Char *val ); |
| 475 | extern void VG_(env_unsetenv) ( Char **env, const Char *varname ); |
| 476 | extern void VG_(env_remove_valgrind_env_stuff) ( Char** env ); |
sewardj | 570f890 | 2002-11-03 11:44:36 +0000 | [diff] [blame] | 477 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 478 | extern void VG_(nanosleep)(struct vki_timespec *); |
njn | 2521d32 | 2005-05-08 14:45:13 +0000 | [diff] [blame] | 479 | |
sewardj | 570f890 | 2002-11-03 11:44:36 +0000 | [diff] [blame] | 480 | /* --------------------------------------------------------------------- |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 481 | Exports of vg_symtab2.c |
| 482 | ------------------------------------------------------------------ */ |
| 483 | |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 484 | typedef struct _Segment Segment; |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 485 | typedef struct _CodeRedirect CodeRedirect; |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 486 | |
| 487 | extern Bool VG_(is_object_file) ( const void *hdr ); |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 488 | extern SegInfo * VG_(read_seg_symbols) ( Segment *seg ); |
njn | 36ef6ba | 2005-05-14 18:42:26 +0000 | [diff] [blame] | 489 | extern void VG_(seginfo_incref) ( SegInfo * ); |
| 490 | extern void VG_(seginfo_decref) ( SegInfo *, Addr a ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 491 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 492 | extern Bool VG_(get_fnname_nodemangle)( Addr a, Char* fnname, Int n_fnname ); |
sewardj | 25c7c3a | 2003-07-10 00:17:58 +0000 | [diff] [blame] | 493 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 494 | extern Addr VG_(reverse_search_one_symtab) ( const SegInfo* si, const Char* name ); |
| 495 | |
sewardj | 3516553 | 2005-04-30 18:47:48 +0000 | [diff] [blame] | 496 | extern Bool VG_(use_CFI_info) ( /*MOD*/Addr* ipP, |
| 497 | /*MOD*/Addr* spP, |
| 498 | /*MOD*/Addr* fpP, |
| 499 | Addr min_accessible, |
| 500 | Addr max_accessible ); |
| 501 | |
| 502 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 503 | /* --------------------------------------------------------------------- |
| 504 | Exports of vg_redir.c |
| 505 | ------------------------------------------------------------------ */ |
njn | 36b66df | 2005-05-12 05:13:04 +0000 | [diff] [blame] | 506 | |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 507 | /* Redirection machinery */ |
nethercote | 85cdd34 | 2004-08-01 22:36:40 +0000 | [diff] [blame] | 508 | extern Addr VG_(code_redirect) ( Addr orig ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 509 | |
njn | 36b66df | 2005-05-12 05:13:04 +0000 | [diff] [blame] | 510 | /* Set up some default redirects */ |
| 511 | extern void VG_(setup_code_redirect_table) ( void ); |
| 512 | |
tom | 748a131 | 2005-04-02 15:53:01 +0000 | [diff] [blame] | 513 | extern void VG_(add_redirect_sym_to_addr)(const Char *from_lib, |
| 514 | const Char *from_sym, |
| 515 | Addr to_addr); |
| 516 | extern void VG_(add_redirect_addr_to_addr)(Addr from_addr, Addr to_addr); |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 517 | extern void VG_(resolve_seg_redirs)(SegInfo *si); |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 518 | |
| 519 | /* Wrapping machinery */ |
| 520 | enum return_type { |
| 521 | RT_RETURN, |
| 522 | RT_LONGJMP, |
| 523 | RT_EXIT, |
| 524 | }; |
| 525 | |
| 526 | typedef struct _FuncWrapper FuncWrapper; |
| 527 | struct _FuncWrapper { |
| 528 | void *(*before)(va_list args); |
| 529 | void (*after) (void *nonce, enum return_type, Word retval); |
| 530 | }; |
| 531 | |
| 532 | extern void VG_(wrap_function)(Addr eip, const FuncWrapper *wrapper); |
| 533 | extern const FuncWrapper *VG_(is_wrapped)(Addr eip); |
| 534 | extern Bool VG_(is_wrapper_return)(Addr eip); |
| 535 | |
| 536 | /* Primary interface for adding wrappers for client-side functions. */ |
| 537 | extern CodeRedirect *VG_(add_wrapper)(const Char *from_lib, const Char *from_sym, |
| 538 | const FuncWrapper *wrapper); |
| 539 | |
| 540 | extern Bool VG_(is_resolved)(const CodeRedirect *redir); |
sewardj | 51ac087 | 2004-12-21 01:20:49 +0000 | [diff] [blame] | 541 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 542 | /* --------------------------------------------------------------------- |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 543 | Exports of vg_main.c |
| 544 | ------------------------------------------------------------------ */ |
| 545 | |
sewardj | 73cf3bc | 2002-11-03 03:20:15 +0000 | [diff] [blame] | 546 | /* Tell the logging mechanism whether we are logging to a file |
| 547 | descriptor or a socket descriptor. */ |
njn | be9b47b | 2005-05-15 16:22:58 +0000 | [diff] [blame] | 548 | extern Bool VG_(logging_to_socket); |
sewardj | 73cf3bc | 2002-11-03 03:20:15 +0000 | [diff] [blame] | 549 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 550 | /* Sanity checks which may be done at any time. The scheduler decides when. */ |
nethercote | 885dd91 | 2004-08-03 23:14:00 +0000 | [diff] [blame] | 551 | extern void VG_(sanity_check_general) ( Bool force_expensive ); |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 552 | |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 553 | /* Address space */ |
| 554 | extern Addr VG_(client_base); /* client address space limits */ |
| 555 | extern Addr VG_(client_end); |
| 556 | extern Addr VG_(client_mapbase); /* base of mappings */ |
| 557 | extern Addr VG_(clstk_base); /* client stack range */ |
| 558 | extern Addr VG_(clstk_end); |
fitzhardinge | 9236079 | 2003-12-24 10:11:11 +0000 | [diff] [blame] | 559 | extern Addr VG_(client_trampoline_code); |
| 560 | |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 561 | extern Addr VG_(brk_base); /* start of brk */ |
| 562 | extern Addr VG_(brk_limit); /* current brk */ |
nethercote | 996901a | 2004-08-03 13:29:09 +0000 | [diff] [blame] | 563 | extern Addr VG_(shadow_base); /* tool's shadow memory */ |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 564 | extern Addr VG_(shadow_end); |
| 565 | extern Addr VG_(valgrind_base); /* valgrind's address range */ |
nethercote | 820bd8c | 2004-09-07 23:04:49 +0000 | [diff] [blame] | 566 | extern Addr VG_(valgrind_last); // Nb: last byte, rather than one past the end |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 567 | |
nethercote | 73b526f | 2004-10-31 18:48:21 +0000 | [diff] [blame] | 568 | extern struct vki_rlimit VG_(client_rlimit_data); /* client's original rlimit data */ |
| 569 | extern struct vki_rlimit VG_(client_rlimit_stack); /* client's original rlimit stack */ |
fitzhardinge | b50068f | 2004-02-24 23:42:55 +0000 | [diff] [blame] | 570 | |
fitzhardinge | a49f9b5 | 2003-12-16 22:26:45 +0000 | [diff] [blame] | 571 | /* client executable file descriptor */ |
| 572 | extern Int VG_(clexecfd); |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 573 | |
nethercote | f6a1d50 | 2004-08-09 12:21:57 +0000 | [diff] [blame] | 574 | // Help set up the child used when doing execve() with --trace-children=yes |
| 575 | Char* VG_(build_child_VALGRINDCLO) ( Char* exename ); |
| 576 | Char* VG_(build_child_exename) ( void ); |
| 577 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 578 | /* The master thread the one which will be responsible for mopping |
| 579 | everything up at exit. Normally it is tid 1, since that's the |
| 580 | first thread created, but it may be something else after a |
| 581 | fork(). */ |
| 582 | extern ThreadId VG_(master_tid); |
| 583 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 584 | /* Called when some unhandleable client behaviour is detected. |
| 585 | Prints a msg and aborts. */ |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 586 | extern void VG_(unimplemented) ( Char* msg ) |
| 587 | __attribute__((__noreturn__)); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 588 | |
nethercote | 04d0fbc | 2004-01-26 16:48:06 +0000 | [diff] [blame] | 589 | /* Something of a function looking for a home ... start up debugger. */ |
njn | c616819 | 2004-11-29 13:54:10 +0000 | [diff] [blame] | 590 | extern void VG_(start_debugger) ( ThreadId tid ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 591 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 592 | /* Counts downwards in vg_run_innerloop. */ |
| 593 | extern UInt VG_(dispatch_ctr); |
| 594 | |
sewardj | 4ccf707 | 2004-11-28 16:58:05 +0000 | [diff] [blame] | 595 | /* Stats ... */ |
nethercote | 844e712 | 2004-08-02 15:27:22 +0000 | [diff] [blame] | 596 | extern void VG_(print_scheduler_stats) ( void ); |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 597 | |
njn | 1f70772 | 2005-03-27 03:17:52 +0000 | [diff] [blame] | 598 | /* 64-bit counter for the number of basic blocks done. */ |
| 599 | extern ULong VG_(bbs_done); |
| 600 | |
nethercote | 2e05c33 | 2004-09-06 16:43:37 +0000 | [diff] [blame] | 601 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 602 | /* --------------------------------------------------------------------- |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 603 | Exports of vg_syscall.S |
| 604 | ------------------------------------------------------------------ */ |
| 605 | |
njn | ca6fef0 | 2004-11-29 16:49:18 +0000 | [diff] [blame] | 606 | // We use a full prototype rather than "..." here to ensure that all |
| 607 | // arguments get converted to a UWord appropriately. Not doing so can |
| 608 | // cause problems when passing 32-bit integers on 64-bit platforms, because |
| 609 | // the top 32-bits might not be zeroed appropriately, eg. as would happen |
| 610 | // with the 6th arg on AMD64 which is passed on the stack. |
njn | f4aeaea | 2004-11-29 17:33:31 +0000 | [diff] [blame] | 611 | extern Word VG_(do_syscall) ( UInt, UWord, UWord, UWord, UWord, UWord, UWord ); |
njn | ca6fef0 | 2004-11-29 16:49:18 +0000 | [diff] [blame] | 612 | |
| 613 | // Macros make life easier. |
| 614 | #define vgPlain_do_syscall0(s) VG_(do_syscall)((s),0,0,0,0,0,0) |
| 615 | #define vgPlain_do_syscall1(s,a) VG_(do_syscall)((s),(a),0,0,0,0,0) |
| 616 | #define vgPlain_do_syscall2(s,a,b) VG_(do_syscall)((s),(a),(b),0,0,0,0) |
| 617 | #define vgPlain_do_syscall3(s,a,b,c) VG_(do_syscall)((s),(a),(b),(c),0,0,0) |
| 618 | #define vgPlain_do_syscall4(s,a,b,c,d) VG_(do_syscall)((s),(a),(b),(c),(d),0,0) |
| 619 | #define vgPlain_do_syscall5(s,a,b,c,d,e) VG_(do_syscall)((s),(a),(b),(c),(d),(e),0) |
| 620 | #define vgPlain_do_syscall6(s,a,b,c,d,e,f) VG_(do_syscall)((s),(a),(b),(c),(d),(e),(f)) |
| 621 | |
fitzhardinge | 4f10ada | 2004-06-03 10:00:42 +0000 | [diff] [blame] | 622 | extern void VG_(sigreturn)(void); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 623 | |
| 624 | /* --------------------------------------------------------------------- |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 625 | Exports of vg_helpers.S |
| 626 | ------------------------------------------------------------------ */ |
| 627 | |
fitzhardinge | 9236079 | 2003-12-24 10:11:11 +0000 | [diff] [blame] | 628 | /* Information about trampoline code (for signal return and syscalls) */ |
| 629 | extern const Char VG_(trampoline_code_start); |
| 630 | extern const Int VG_(trampoline_code_length); |
| 631 | extern const Int VG_(tramp_sigreturn_offset); |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 632 | extern const Int VG_(tramp_rt_sigreturn_offset); |
fitzhardinge | 9236079 | 2003-12-24 10:11:11 +0000 | [diff] [blame] | 633 | extern const Int VG_(tramp_syscall_offset); |
tom | ee0bcbf | 2005-05-02 10:28:42 +0000 | [diff] [blame] | 634 | extern const Int VG_(tramp_gettimeofday_offset); |
| 635 | extern const Int VG_(tramp_time_offset); |
sewardj | 20917d8 | 2002-05-28 01:36:45 +0000 | [diff] [blame] | 636 | |
nethercote | c06e213 | 2004-09-03 13:45:29 +0000 | [diff] [blame] | 637 | // --------------------------------------------------------------------- |
| 638 | // Architecture-specific things defined in eg. x86/*.c |
| 639 | // --------------------------------------------------------------------- |
| 640 | |
sewardj | 51ac087 | 2004-12-21 01:20:49 +0000 | [diff] [blame] | 641 | // Returns the architecture and subarchitecture, or indicates |
| 642 | // that this subarchitecture is unable to run Valgrind |
| 643 | // Returns False to indicate we cannot proceed further. |
sewardj | 51ac087 | 2004-12-21 01:20:49 +0000 | [diff] [blame] | 644 | extern Bool VGA_(getArchAndSubArch)( /*OUT*/VexArch*, |
| 645 | /*OUT*/VexSubArch* ); |
njn | cf45fd4 | 2004-11-24 16:30:22 +0000 | [diff] [blame] | 646 | // Accessors for the ThreadArchState |
njn | 35172bc | 2005-03-26 00:04:03 +0000 | [diff] [blame] | 647 | #define INSTR_PTR(regs) ((regs).vex.VGA_INSTR_PTR) |
| 648 | #define STACK_PTR(regs) ((regs).vex.VGA_STACK_PTR) |
| 649 | #define FRAME_PTR(regs) ((regs).vex.VGA_FRAME_PTR) |
| 650 | #define CLREQ_ARGS(regs) ((regs).vex.VGA_CLREQ_ARGS) |
njn | 35172bc | 2005-03-26 00:04:03 +0000 | [diff] [blame] | 651 | #define CLREQ_RET(regs) ((regs).vex.VGA_CLREQ_RET) |
njn | 16de557 | 2004-11-27 14:27:21 +0000 | [diff] [blame] | 652 | // Offsets for the Vex state |
njn | 35172bc | 2005-03-26 00:04:03 +0000 | [diff] [blame] | 653 | #define O_STACK_PTR (offsetof(VexGuestArchState, VGA_STACK_PTR)) |
| 654 | #define O_FRAME_PTR (offsetof(VexGuestArchState, VGA_FRAME_PTR)) |
| 655 | #define O_CLREQ_RET (offsetof(VexGuestArchState, VGA_CLREQ_RET)) |
njn | cf45fd4 | 2004-11-24 16:30:22 +0000 | [diff] [blame] | 656 | |
| 657 | |
sewardj | 2a99cf6 | 2004-11-24 10:44:19 +0000 | [diff] [blame] | 658 | // Setting up the initial thread (1) state |
| 659 | extern void |
| 660 | VGA_(init_thread1state) ( Addr client_eip, |
| 661 | Addr esp_at_startup, |
| 662 | /*MOD*/ ThreadArchState* arch ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 663 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 664 | // OS/Platform-specific thread clear (after thread exit) |
| 665 | extern void VGA_(os_state_clear)(ThreadState *); |
| 666 | |
| 667 | // OS/Platform-specific thread init (at scheduler init time) |
| 668 | extern void VGA_(os_state_init)(ThreadState *); |
| 669 | |
| 670 | // Run a thread from beginning to end. Does not return if tid == VG_(master_tid). |
sewardj | 0c1a596 | 2005-03-22 00:19:55 +0000 | [diff] [blame] | 671 | void VGA_(thread_wrapper)(Word /*ThreadId*/ tid); |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 672 | |
| 673 | // Like VGA_(thread_wrapper), but it allocates a stack before calling |
| 674 | // to VGA_(thread_wrapper) on that stack, as if it had been set up by |
| 675 | // clone() |
| 676 | void VGA_(main_thread_wrapper)(ThreadId tid) __attribute__ ((__noreturn__)); |
| 677 | |
| 678 | // Return how many bytes of a thread's Valgrind stack are unused |
njn | 990e90c | 2005-04-05 02:49:09 +0000 | [diff] [blame] | 679 | SSizeT VGA_(stack_unused)(ThreadId tid); |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 680 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 681 | // wait until all other threads are dead |
| 682 | extern void VGA_(reap_threads)(ThreadId self); |
| 683 | |
| 684 | // handle an arch-specific client request |
| 685 | extern Bool VGA_(client_request)(ThreadId tid, UWord *args); |
| 686 | |
nethercote | fedd810 | 2004-09-13 15:19:34 +0000 | [diff] [blame] | 687 | // Pointercheck |
| 688 | extern Bool VGA_(setup_pointercheck) ( void ); |
| 689 | |
| 690 | // For attaching the debugger |
sewardj | 2a99cf6 | 2004-11-24 10:44:19 +0000 | [diff] [blame] | 691 | extern Int VGA_(ptrace_setregs_from_tst) ( Int pid, ThreadArchState* arch ); |
nethercote | fedd810 | 2004-09-13 15:19:34 +0000 | [diff] [blame] | 692 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 693 | // Used by leakcheck |
| 694 | extern void VGA_(mark_from_registers)(ThreadId tid, void (*marker)(Addr)); |
| 695 | |
njn | 2024234 | 2005-05-16 23:31:24 +0000 | [diff] [blame^] | 696 | // Set up the libc freeres wrapper |
| 697 | extern void VGA_(intercept_libc_freeres_wrapper)(Addr); |
| 698 | |
| 699 | // Clean up the client by calling before the final reports |
| 700 | extern void VGA_(final_tidyup)(ThreadId tid); |
| 701 | |
| 702 | // Arch-specific client requests |
| 703 | extern Bool VGA_(client_requests)(ThreadId tid, UWord *args); |
| 704 | |
nethercote | 9b3c765 | 2004-10-19 13:18:00 +0000 | [diff] [blame] | 705 | |
nethercote | 41c75da | 2004-10-18 15:34:14 +0000 | [diff] [blame] | 706 | // --------------------------------------------------------------------- |
| 707 | // Platform-specific things defined in eg. x86/*.c |
| 708 | // --------------------------------------------------------------------- |
nethercote | 775508a | 2004-09-07 22:38:23 +0000 | [diff] [blame] | 709 | |
njn | 2521d32 | 2005-05-08 14:45:13 +0000 | [diff] [blame] | 710 | // Do any platform specific redirects. |
tom | 748a131 | 2005-04-02 15:53:01 +0000 | [diff] [blame] | 711 | extern void VGP_(setup_redirects)(void); |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 712 | |
| 713 | ///* --------------------------------------------------------------------- |
| 714 | // Thread modelling |
| 715 | // ------------------------------------------------------------------ */ |
| 716 | //extern void VG_(tm_thread_create) (ThreadId creator, ThreadId tid, Bool detached); |
| 717 | //extern void VG_(tm_thread_exit) (ThreadId tid); |
| 718 | //extern Bool VG_(tm_thread_exists) (ThreadId tid); |
| 719 | //extern void VG_(tm_thread_detach) (ThreadId tid); |
| 720 | //extern void VG_(tm_thread_join) (ThreadId joiner, ThreadId joinee); |
| 721 | //extern void VG_(tm_thread_switchto)(ThreadId tid); |
| 722 | // |
| 723 | //extern void VG_(tm_mutex_init) (ThreadId tid, Addr mutexp); |
| 724 | //extern void VG_(tm_mutex_destroy)(ThreadId tid, Addr mutexp); |
| 725 | //extern void VG_(tm_mutex_trylock)(ThreadId tid, Addr mutexp); |
| 726 | //extern void VG_(tm_mutex_giveup) (ThreadId tid, Addr mutexp); |
| 727 | //extern void VG_(tm_mutex_acquire)(ThreadId tid, Addr mutexp); |
| 728 | //extern void VG_(tm_mutex_tryunlock)(ThreadId tid, Addr mutexp); |
| 729 | //extern void VG_(tm_mutex_unlock) (ThreadId tid, Addr mutexp); |
| 730 | //extern Bool VG_(tm_mutex_exists) (Addr mutexp); |
| 731 | // |
| 732 | //extern UInt VG_(tm_error_update_extra) (Error *err); |
| 733 | //extern Bool VG_(tm_error_equal) (VgRes res, Error *e1, Error *e2); |
| 734 | //extern void VG_(tm_error_print) (Error *err); |
| 735 | // |
| 736 | //extern void VG_(tm_init) (); |
| 737 | // |
| 738 | //extern void VG_(tm_cond_init) (ThreadId tid, Addr condp); |
| 739 | //extern void VG_(tm_cond_destroy) (ThreadId tid, Addr condp); |
| 740 | //extern void VG_(tm_cond_wait) (ThreadId tid, Addr condp, Addr mutexp); |
| 741 | //extern void VG_(tm_cond_wakeup) (ThreadId tid, Addr condp, Addr mutexp); |
| 742 | //extern void VG_(tm_cond_signal) (ThreadId tid, Addr condp); |
| 743 | // |
| 744 | ///* ----- pthreads ----- */ |
| 745 | //extern void VG_(pthread_init) (); |
| 746 | //extern void VG_(pthread_startfunc_wrapper)(Addr wrapper); |
| 747 | // |
| 748 | //struct vg_pthread_newthread_data { |
| 749 | // void *(*startfunc)(void *arg); |
| 750 | // void *arg; |
| 751 | //}; |
sewardj | 3b2736a | 2002-03-24 12:18:35 +0000 | [diff] [blame] | 752 | |
| 753 | /* --------------------------------------------------------------------- |
| 754 | Finally - autoconf-generated settings |
| 755 | ------------------------------------------------------------------ */ |
| 756 | |
| 757 | #include "config.h" |
| 758 | |
nethercote | c06e213 | 2004-09-03 13:45:29 +0000 | [diff] [blame] | 759 | #endif /* ndef __CORE_H */ |
| 760 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 761 | /*--------------------------------------------------------------------*/ |
nethercote | 109d0df | 2004-09-02 08:10:13 +0000 | [diff] [blame] | 762 | /*--- end ---*/ |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 763 | /*--------------------------------------------------------------------*/ |