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 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 38 | #include "core_os.h" // OS-specific stuff, eg. linux/core_os.h |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 39 | |
njn | 278b3d6 | 2005-05-30 23:20:51 +0000 | [diff] [blame] | 40 | #include <setjmp.h> // for jmp_buf |
njn | d01fef7 | 2005-03-25 23:35:48 +0000 | [diff] [blame] | 41 | |
njn | 278b3d6 | 2005-05-30 23:20:51 +0000 | [diff] [blame] | 42 | #include "pub_core_mallocfree.h" // for type 'ArenaId' |
| 43 | #include "pub_core_scheduler.h" // for types 'ThreadState', 'ThreadArchState' |
| 44 | #include "pub_core_stacktrace.h" // for type 'StackTrace' |
njn | 4f6e370 | 2005-05-16 20:50:52 +0000 | [diff] [blame] | 45 | |
nethercote | 7be4725 | 2004-09-02 16:02:58 +0000 | [diff] [blame] | 46 | /* --------------------------------------------------------------------- |
njn | 14319cc | 2005-03-13 06:26:22 +0000 | [diff] [blame] | 47 | Global macros. |
nethercote | 7be4725 | 2004-09-02 16:02:58 +0000 | [diff] [blame] | 48 | ------------------------------------------------------------------ */ |
| 49 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 50 | /* Max length of a text fragment used to construct error messages. */ |
njn | 47b209a | 2005-03-25 23:47:16 +0000 | [diff] [blame] | 51 | #define VG_ERRTXT_LEN 4096 |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 52 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 53 | /* The maximum number of calls we're prepared to save in a |
| 54 | backtrace. */ |
| 55 | #define VG_DEEPEST_BACKTRACE 50 |
| 56 | |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 57 | /* Useful macros */ |
| 58 | /* a - alignment - must be a power of 2 */ |
tom | de2ec26 | 2005-03-29 12:16:10 +0000 | [diff] [blame] | 59 | #define ROUNDDN(p, a) ((Addr)(p) & ~((Addr)(a)-1)) |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 60 | #define ROUNDUP(p, a) ROUNDDN((p)+(a)-1, (a)) |
nethercote | 73b526f | 2004-10-31 18:48:21 +0000 | [diff] [blame] | 61 | #define PGROUNDDN(p) ROUNDDN(p, VKI_PAGE_SIZE) |
| 62 | #define PGROUNDUP(p) ROUNDUP(p, VKI_PAGE_SIZE) |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 63 | |
sewardj | 51ac087 | 2004-12-21 01:20:49 +0000 | [diff] [blame] | 64 | |
nethercote | 80013e9 | 2004-09-05 20:39:51 +0000 | [diff] [blame] | 65 | /* --------------------------------------------------------------------- |
| 66 | Environment variables |
| 67 | ------------------------------------------------------------------ */ |
| 68 | |
| 69 | /* The directory we look for all our auxillary files in */ |
| 70 | #define VALGRINDLIB "VALGRINDLIB" |
| 71 | |
| 72 | /* Additional command-line arguments; they are overridden by actual |
| 73 | command-line option. Each argument is separated by spaces. There |
| 74 | is no quoting mechanism. |
| 75 | */ |
| 76 | #define VALGRINDOPTS "VALGRIND_OPTS" |
| 77 | |
| 78 | /* If this variable is present in the environment, then valgrind will |
| 79 | not parse the command line for options at all; all options come |
| 80 | from this variable. Arguments are terminated by ^A (\001). There |
| 81 | is no quoting mechanism. |
| 82 | |
| 83 | This variable is not expected to be set by anything other than |
| 84 | Valgrind itself, as part of its handling of execve with |
| 85 | --trace-children=yes. This variable should not be present in the |
| 86 | client environment. |
| 87 | */ |
| 88 | #define VALGRINDCLO "_VALGRIND_CLO" |
| 89 | |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 90 | |
thughes | ad1c956 | 2004-06-26 11:27:52 +0000 | [diff] [blame] | 91 | /* Application-visible file descriptor limits */ |
| 92 | extern Int VG_(fd_soft_limit); |
| 93 | extern Int VG_(fd_hard_limit); |
fitzhardinge | f0046f2 | 2003-12-18 02:39:22 +0000 | [diff] [blame] | 94 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 95 | /* --------------------------------------------------------------------- |
nethercote | 85cdd34 | 2004-08-01 22:36:40 +0000 | [diff] [blame] | 96 | Profiling stuff |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 97 | ------------------------------------------------------------------ */ |
| 98 | |
njn | 31066fd | 2005-03-26 00:42:02 +0000 | [diff] [blame] | 99 | extern void VG_(init_profiling) ( void ); |
| 100 | extern void VG_(done_profiling) ( void ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 101 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 102 | #undef VGP_PUSHCC |
| 103 | #undef VGP_POPCC |
njn | 31066fd | 2005-03-26 00:42:02 +0000 | [diff] [blame] | 104 | #define VGP_PUSHCC(x) if (VG_(clo_profile)) VG_(pushcc)(x) |
| 105 | #define VGP_POPCC(x) if (VG_(clo_profile)) VG_(popcc)(x) |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 106 | |
sewardj | 51ac087 | 2004-12-21 01:20:49 +0000 | [diff] [blame] | 107 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 108 | /* --------------------------------------------------------------------- |
njn | 3e88418 | 2003-04-15 13:03:23 +0000 | [diff] [blame] | 109 | Exports of vg_intercept.c |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 110 | ------------------------------------------------------------------ */ |
| 111 | |
njn | a91498f | 2005-05-11 22:32:39 +0000 | [diff] [blame] | 112 | /* These are the internal client request codes. The publically-visible |
| 113 | request codes are also defined in valgrind.h, and similar headers for |
| 114 | some tools. */ |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 115 | |
njn | a91498f | 2005-05-11 22:32:39 +0000 | [diff] [blame] | 116 | /* Get the tool's malloc-wrapping functions */ |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 117 | #define VG_USERREQ__GET_MALLOCFUNCS 0x3030 |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 118 | |
fitzhardinge | 39de4b4 | 2003-10-31 07:12:21 +0000 | [diff] [blame] | 119 | /* Internal equivalent of VALGRIND_PRINTF . */ |
| 120 | #define VG_USERREQ__INTERNAL_PRINTF 0x3103 |
sewardj | 45b4b37 | 2002-04-16 22:50:32 +0000 | [diff] [blame] | 121 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 122 | /* Denote the finish of __libc_freeres_wrapper(). |
| 123 | A synonym for exit. */ |
| 124 | #define VG_USERREQ__LIBC_FREERES_DONE 0x3029 |
sewardj | 54cacf0 | 2002-04-12 23:24:59 +0000 | [diff] [blame] | 125 | |
njn | 717cde5 | 2005-05-10 02:47:21 +0000 | [diff] [blame] | 126 | /* Intercept prefix stuff. See |
| 127 | coregrind/m_replace_malloc/vg_replace_malloc.c for details. |
| 128 | Unfortunately the "_vgi_" literal is also hardcoded in that file, so if |
| 129 | you change this one you must also change the other one. */ |
sewardj | 9ee81f5 | 2005-04-02 17:38:59 +0000 | [diff] [blame] | 130 | #define VG_INTERCEPT_PREFIX "_vgi_" |
| 131 | #define VG_INTERCEPT_PREFIX_LEN 5 |
rjwalsh | e4e779d | 2004-04-16 23:02:29 +0000 | [diff] [blame] | 132 | |
sewardj | 9ee81f5 | 2005-04-02 17:38:59 +0000 | [diff] [blame] | 133 | /* Not sure what these are for. Todo: clarify */ |
| 134 | #define VG_WRAPPER_PREFIX "_vgw_" |
| 135 | #define VG_WRAPPER_PREFIX_LEN 5 |
| 136 | #define VG_WRAPPER(name) _vgw_##name |
| 137 | #define VG_WRAPPER_ALIAS(name) "_vgw_" #name |
rjwalsh | e4e779d | 2004-04-16 23:02:29 +0000 | [diff] [blame] | 138 | |
njn | 4c79121 | 2003-05-02 17:53:54 +0000 | [diff] [blame] | 139 | |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 140 | /* --------------------------------------------------------------------- |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 141 | Exports of vg_signals.c |
| 142 | ------------------------------------------------------------------ */ |
| 143 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 144 | /* Highest signal the kernel will let us use */ |
| 145 | extern Int VG_(max_signal); |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 146 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 147 | extern void VG_(sigstartup_actions) ( void ); |
| 148 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 149 | /* Poll a thread's set of pending signals, and update the Thread's context to deliver one */ |
| 150 | extern void VG_(poll_signals) ( ThreadId ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 151 | |
| 152 | /* Fake system calls for signal handling. */ |
njn | 502badb | 2005-05-08 02:04:49 +0000 | [diff] [blame] | 153 | extern Int VG_(do_sys_sigaltstack) ( ThreadId tid, vki_stack_t* ss, |
| 154 | vki_stack_t* oss ); |
| 155 | extern Int VG_(do_sys_sigaction) ( Int signo, |
| 156 | const struct vki_sigaction *new_act, |
| 157 | struct vki_sigaction *old_act ); |
| 158 | extern Int VG_(do_sys_sigprocmask) ( ThreadId tid, Int how, |
| 159 | vki_sigset_t* set, |
| 160 | vki_sigset_t* oldset ); |
sewardj | efbfcdf | 2002-06-19 17:35:45 +0000 | [diff] [blame] | 161 | |
njn | 444eba1 | 2005-05-12 03:47:31 +0000 | [diff] [blame] | 162 | extern void VG_(clear_out_queued_signals) |
| 163 | ( ThreadId tid, /* OUT */ vki_sigset_t* saved_mask ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 164 | |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 165 | extern void VG_(kill_self)(Int sigNo); |
| 166 | |
fitzhardinge | f1beb25 | 2004-03-16 09:49:08 +0000 | [diff] [blame] | 167 | /* These function synthesize a fault, as if the running instruction |
| 168 | had had a fault. These functions do not return - they longjmp back |
| 169 | into the scheduler so the signal can be delivered. */ |
| 170 | extern void VG_(synth_fault) (ThreadId tid); |
| 171 | extern void VG_(synth_fault_mapping)(ThreadId tid, Addr addr); |
| 172 | extern void VG_(synth_fault_perms) (ThreadId tid, Addr addr); |
sewardj | 5e2f001 | 2004-12-13 14:10:34 +0000 | [diff] [blame] | 173 | extern void VG_(synth_sigill) (ThreadId tid, Addr addr); |
fitzhardinge | f1beb25 | 2004-03-16 09:49:08 +0000 | [diff] [blame] | 174 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 175 | /* Extend the stack to cover addr, if possible */ |
| 176 | extern Bool VG_(extend_stack)(Addr addr, UInt maxsize); |
| 177 | |
| 178 | /* Returns True if the signal is OK for the client to use */ |
| 179 | extern Bool VG_(client_signal_OK)(Int sigNo); |
| 180 | |
| 181 | /* Forces the client's signal handler to SIG_DFL - generally just |
| 182 | before using that signal to kill the process. */ |
| 183 | extern void VG_(set_default_handler)(Int sig); |
| 184 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 185 | /* --------------------------------------------------------------------- |
| 186 | Exports of vg_mylibc.c |
| 187 | ------------------------------------------------------------------ */ |
| 188 | |
njn | ca0518d | 2004-11-26 19:34:36 +0000 | [diff] [blame] | 189 | // Useful for making failing stubs, when certain things haven't yet been |
| 190 | // implemented. |
njn | 50ae1a7 | 2005-04-08 23:28:23 +0000 | [diff] [blame] | 191 | #define I_die_here \ |
sewardj | 0ab10c4 | 2005-05-12 08:26:36 +0000 | [diff] [blame] | 192 | VG_(assert_fail) (/*isCore*//*BOGUS*/True, \ |
| 193 | "Unimplemented functionality", \ |
njn | 50ae1a7 | 2005-04-08 23:28:23 +0000 | [diff] [blame] | 194 | __FILE__, __LINE__, __PRETTY_FUNCTION__, \ |
| 195 | "valgrind", VG_BUGS_TO, "") |
njn | ca0518d | 2004-11-26 19:34:36 +0000 | [diff] [blame] | 196 | |
njn | 50ae1a7 | 2005-04-08 23:28:23 +0000 | [diff] [blame] | 197 | #define vg_assert(expr) \ |
| 198 | ((void) ((expr) ? 0 : \ |
| 199 | (VG_(assert_fail) (/*isCore*/True, VG_STRINGIFY(expr), \ |
| 200 | __FILE__, __LINE__, __PRETTY_FUNCTION__, \ |
| 201 | ""), \ |
| 202 | 0))) |
| 203 | |
| 204 | #define vg_assert2(expr, format, args...) \ |
| 205 | ((void) ((expr) ? 0 : \ |
| 206 | (VG_(assert_fail) (/*isCore*/True, VG_STRINGIFY(expr), \ |
| 207 | __FILE__, __LINE__, __PRETTY_FUNCTION__, \ |
| 208 | format, ##args), \ |
| 209 | 0))) |
| 210 | |
njn | e427a66 | 2002-10-02 11:08:25 +0000 | [diff] [blame] | 211 | __attribute__ ((__noreturn__)) |
| 212 | extern void VG_(core_panic) ( Char* str ); |
thughes | 5876d55 | 2004-09-26 18:44:06 +0000 | [diff] [blame] | 213 | __attribute__ ((__noreturn__)) |
njn | d01fef7 | 2005-03-25 23:35:48 +0000 | [diff] [blame] | 214 | extern void VG_(core_panic_at) ( Char* str, StackTrace ips ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 215 | |
njn | 04e1698 | 2005-05-31 00:23:43 +0000 | [diff] [blame^] | 216 | /* Called when some unhandleable client behaviour is detected. |
| 217 | Prints a msg and aborts. */ |
| 218 | extern void VG_(unimplemented) ( Char* msg ) |
| 219 | __attribute__((__noreturn__)); |
| 220 | |
| 221 | /* Tell the logging mechanism whether we are logging to a file |
| 222 | descriptor or a socket descriptor. */ |
| 223 | extern Bool VG_(logging_to_socket); |
| 224 | |
nethercote | 05675c8 | 2004-08-04 10:37:49 +0000 | [diff] [blame] | 225 | /* Tools use VG_(strdup)() which doesn't expose ArenaId */ |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 226 | extern Char* VG_(arena_strdup) ( ArenaId aid, const Char* s); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 227 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 228 | extern Int VG_(fcntl) ( Int fd, Int cmd, Int arg ); |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 229 | extern Int VG_(poll)( struct vki_pollfd *, UInt nfds, Int timeout); |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 230 | |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 231 | /* system/mman.h */ |
njn | 7df470b | 2005-05-29 18:46:38 +0000 | [diff] [blame] | 232 | extern void* VG_(mmap) ( void* start, SizeT length, UInt prot, UInt flags, |
| 233 | UInt sf_flags, UInt fd, OffT offset ); |
| 234 | extern void* VG_(mmap_native)( void* start, SizeT length, UInt prot, UInt flags, |
| 235 | UInt fd, OffT offset ); |
| 236 | extern Int VG_(munmap) ( void* start, SizeT length ); |
| 237 | extern Int VG_(mprotect) ( void *start, SizeT length, UInt prot ); |
sewardj | 79048ce | 2005-02-18 08:28:32 +0000 | [diff] [blame] | 238 | extern Int VG_(mprotect_native)( void *start, SizeT length, UInt prot ); |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 239 | |
| 240 | |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 241 | /* Move an fd into the Valgrind-safe range */ |
| 242 | Int VG_(safe_fd)(Int oldfd); |
| 243 | |
sewardj | 570f890 | 2002-11-03 11:44:36 +0000 | [diff] [blame] | 244 | extern Int VG_(write_socket)( Int sd, void *msg, Int count ); |
sewardj | 73cf3bc | 2002-11-03 03:20:15 +0000 | [diff] [blame] | 245 | |
| 246 | /* --- Connecting over the network --- */ |
| 247 | extern Int VG_(connect_via_socket)( UChar* str ); |
| 248 | |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 249 | /* Environment manipulations */ |
nethercote | 60a96c5 | 2004-08-03 13:08:31 +0000 | [diff] [blame] | 250 | extern Char **VG_(env_setenv) ( Char ***envp, const Char* varname, |
| 251 | const Char *val ); |
| 252 | extern void VG_(env_unsetenv) ( Char **env, const Char *varname ); |
| 253 | extern void VG_(env_remove_valgrind_env_stuff) ( Char** env ); |
sewardj | 570f890 | 2002-11-03 11:44:36 +0000 | [diff] [blame] | 254 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 255 | extern void VG_(nanosleep)(struct vki_timespec *); |
njn | 2521d32 | 2005-05-08 14:45:13 +0000 | [diff] [blame] | 256 | |
sewardj | 570f890 | 2002-11-03 11:44:36 +0000 | [diff] [blame] | 257 | /* --------------------------------------------------------------------- |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 258 | Exports of vg_symtab2.c |
| 259 | ------------------------------------------------------------------ */ |
| 260 | |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 261 | typedef struct _Segment Segment; |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 262 | typedef struct _CodeRedirect CodeRedirect; |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 263 | |
| 264 | extern Bool VG_(is_object_file) ( const void *hdr ); |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 265 | extern SegInfo * VG_(read_seg_symbols) ( Segment *seg ); |
njn | 36ef6ba | 2005-05-14 18:42:26 +0000 | [diff] [blame] | 266 | extern void VG_(seginfo_incref) ( SegInfo * ); |
| 267 | extern void VG_(seginfo_decref) ( SegInfo *, Addr a ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 268 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 269 | extern Bool VG_(get_fnname_nodemangle)( Addr a, Char* fnname, Int n_fnname ); |
sewardj | 25c7c3a | 2003-07-10 00:17:58 +0000 | [diff] [blame] | 270 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 271 | extern Addr VG_(reverse_search_one_symtab) ( const SegInfo* si, const Char* name ); |
| 272 | |
sewardj | 3516553 | 2005-04-30 18:47:48 +0000 | [diff] [blame] | 273 | extern Bool VG_(use_CFI_info) ( /*MOD*/Addr* ipP, |
| 274 | /*MOD*/Addr* spP, |
| 275 | /*MOD*/Addr* fpP, |
| 276 | Addr min_accessible, |
| 277 | Addr max_accessible ); |
| 278 | |
| 279 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 280 | /* --------------------------------------------------------------------- |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 281 | Exports of vg_syscall.S |
| 282 | ------------------------------------------------------------------ */ |
| 283 | |
njn | ca6fef0 | 2004-11-29 16:49:18 +0000 | [diff] [blame] | 284 | // We use a full prototype rather than "..." here to ensure that all |
| 285 | // arguments get converted to a UWord appropriately. Not doing so can |
| 286 | // cause problems when passing 32-bit integers on 64-bit platforms, because |
| 287 | // the top 32-bits might not be zeroed appropriately, eg. as would happen |
| 288 | // with the 6th arg on AMD64 which is passed on the stack. |
njn | f4aeaea | 2004-11-29 17:33:31 +0000 | [diff] [blame] | 289 | extern Word VG_(do_syscall) ( UInt, UWord, UWord, UWord, UWord, UWord, UWord ); |
njn | ca6fef0 | 2004-11-29 16:49:18 +0000 | [diff] [blame] | 290 | |
| 291 | // Macros make life easier. |
| 292 | #define vgPlain_do_syscall0(s) VG_(do_syscall)((s),0,0,0,0,0,0) |
| 293 | #define vgPlain_do_syscall1(s,a) VG_(do_syscall)((s),(a),0,0,0,0,0) |
| 294 | #define vgPlain_do_syscall2(s,a,b) VG_(do_syscall)((s),(a),(b),0,0,0,0) |
| 295 | #define vgPlain_do_syscall3(s,a,b,c) VG_(do_syscall)((s),(a),(b),(c),0,0,0) |
| 296 | #define vgPlain_do_syscall4(s,a,b,c,d) VG_(do_syscall)((s),(a),(b),(c),(d),0,0) |
| 297 | #define vgPlain_do_syscall5(s,a,b,c,d,e) VG_(do_syscall)((s),(a),(b),(c),(d),(e),0) |
| 298 | #define vgPlain_do_syscall6(s,a,b,c,d,e,f) VG_(do_syscall)((s),(a),(b),(c),(d),(e),(f)) |
| 299 | |
fitzhardinge | 4f10ada | 2004-06-03 10:00:42 +0000 | [diff] [blame] | 300 | extern void VG_(sigreturn)(void); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 301 | |
| 302 | /* --------------------------------------------------------------------- |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 303 | Exports of vg_helpers.S |
| 304 | ------------------------------------------------------------------ */ |
| 305 | |
fitzhardinge | 9236079 | 2003-12-24 10:11:11 +0000 | [diff] [blame] | 306 | /* Information about trampoline code (for signal return and syscalls) */ |
| 307 | extern const Char VG_(trampoline_code_start); |
| 308 | extern const Int VG_(trampoline_code_length); |
| 309 | extern const Int VG_(tramp_sigreturn_offset); |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 310 | extern const Int VG_(tramp_rt_sigreturn_offset); |
fitzhardinge | 9236079 | 2003-12-24 10:11:11 +0000 | [diff] [blame] | 311 | extern const Int VG_(tramp_syscall_offset); |
tom | ee0bcbf | 2005-05-02 10:28:42 +0000 | [diff] [blame] | 312 | extern const Int VG_(tramp_gettimeofday_offset); |
| 313 | extern const Int VG_(tramp_time_offset); |
sewardj | 20917d8 | 2002-05-28 01:36:45 +0000 | [diff] [blame] | 314 | |
nethercote | c06e213 | 2004-09-03 13:45:29 +0000 | [diff] [blame] | 315 | // --------------------------------------------------------------------- |
| 316 | // Architecture-specific things defined in eg. x86/*.c |
| 317 | // --------------------------------------------------------------------- |
| 318 | |
sewardj | 51ac087 | 2004-12-21 01:20:49 +0000 | [diff] [blame] | 319 | // Returns the architecture and subarchitecture, or indicates |
| 320 | // that this subarchitecture is unable to run Valgrind |
| 321 | // Returns False to indicate we cannot proceed further. |
sewardj | 51ac087 | 2004-12-21 01:20:49 +0000 | [diff] [blame] | 322 | extern Bool VGA_(getArchAndSubArch)( /*OUT*/VexArch*, |
| 323 | /*OUT*/VexSubArch* ); |
njn | cf45fd4 | 2004-11-24 16:30:22 +0000 | [diff] [blame] | 324 | // Accessors for the ThreadArchState |
njn | 35172bc | 2005-03-26 00:04:03 +0000 | [diff] [blame] | 325 | #define INSTR_PTR(regs) ((regs).vex.VGA_INSTR_PTR) |
| 326 | #define STACK_PTR(regs) ((regs).vex.VGA_STACK_PTR) |
| 327 | #define FRAME_PTR(regs) ((regs).vex.VGA_FRAME_PTR) |
| 328 | #define CLREQ_ARGS(regs) ((regs).vex.VGA_CLREQ_ARGS) |
njn | 35172bc | 2005-03-26 00:04:03 +0000 | [diff] [blame] | 329 | #define CLREQ_RET(regs) ((regs).vex.VGA_CLREQ_RET) |
njn | 16de557 | 2004-11-27 14:27:21 +0000 | [diff] [blame] | 330 | // Offsets for the Vex state |
njn | 35172bc | 2005-03-26 00:04:03 +0000 | [diff] [blame] | 331 | #define O_STACK_PTR (offsetof(VexGuestArchState, VGA_STACK_PTR)) |
| 332 | #define O_FRAME_PTR (offsetof(VexGuestArchState, VGA_FRAME_PTR)) |
| 333 | #define O_CLREQ_RET (offsetof(VexGuestArchState, VGA_CLREQ_RET)) |
njn | cf45fd4 | 2004-11-24 16:30:22 +0000 | [diff] [blame] | 334 | |
| 335 | |
sewardj | 2a99cf6 | 2004-11-24 10:44:19 +0000 | [diff] [blame] | 336 | // Setting up the initial thread (1) state |
| 337 | extern void |
| 338 | VGA_(init_thread1state) ( Addr client_eip, |
| 339 | Addr esp_at_startup, |
| 340 | /*MOD*/ ThreadArchState* arch ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 341 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 342 | // OS/Platform-specific thread clear (after thread exit) |
sewardj | 1d88711 | 2005-05-30 21:44:08 +0000 | [diff] [blame] | 343 | extern void VGO_(os_state_clear)(ThreadState *); |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 344 | |
| 345 | // OS/Platform-specific thread init (at scheduler init time) |
sewardj | 1d88711 | 2005-05-30 21:44:08 +0000 | [diff] [blame] | 346 | extern void VGO_(os_state_init)(ThreadState *); |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 347 | |
sewardj | 1d88711 | 2005-05-30 21:44:08 +0000 | [diff] [blame] | 348 | // Run a thread from beginning to end. |
| 349 | extern VgSchedReturnCode VGO_(thread_wrapper)(Word /*ThreadId*/ tid); |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 350 | |
sewardj | 1d88711 | 2005-05-30 21:44:08 +0000 | [diff] [blame] | 351 | // Call here to exit the entire Valgrind system. |
| 352 | extern void VGO_(terminate_NORETURN)(ThreadId tid, VgSchedReturnCode src); |
| 353 | |
| 354 | // Allocates a stack for the first thread, then runs it, |
| 355 | // as if the thread had been set up by clone() |
| 356 | extern void VGP_(main_thread_wrapper_NORETURN)(ThreadId tid); |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 357 | |
| 358 | // Return how many bytes of a thread's Valgrind stack are unused |
sewardj | 1d88711 | 2005-05-30 21:44:08 +0000 | [diff] [blame] | 359 | extern SSizeT VGA_(stack_unused)(ThreadId tid); |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 360 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 361 | // wait until all other threads are dead |
| 362 | extern void VGA_(reap_threads)(ThreadId self); |
| 363 | |
| 364 | // handle an arch-specific client request |
| 365 | extern Bool VGA_(client_request)(ThreadId tid, UWord *args); |
| 366 | |
nethercote | fedd810 | 2004-09-13 15:19:34 +0000 | [diff] [blame] | 367 | // Pointercheck |
njn | 04e1698 | 2005-05-31 00:23:43 +0000 | [diff] [blame^] | 368 | extern Bool VGA_(setup_pointercheck) ( Addr client_base, Addr client_end ); |
nethercote | fedd810 | 2004-09-13 15:19:34 +0000 | [diff] [blame] | 369 | |
| 370 | // For attaching the debugger |
sewardj | 2a99cf6 | 2004-11-24 10:44:19 +0000 | [diff] [blame] | 371 | extern Int VGA_(ptrace_setregs_from_tst) ( Int pid, ThreadArchState* arch ); |
nethercote | fedd810 | 2004-09-13 15:19:34 +0000 | [diff] [blame] | 372 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 373 | // Used by leakcheck |
| 374 | extern void VGA_(mark_from_registers)(ThreadId tid, void (*marker)(Addr)); |
| 375 | |
njn | 2024234 | 2005-05-16 23:31:24 +0000 | [diff] [blame] | 376 | // Set up the libc freeres wrapper |
| 377 | extern void VGA_(intercept_libc_freeres_wrapper)(Addr); |
| 378 | |
| 379 | // Clean up the client by calling before the final reports |
| 380 | extern void VGA_(final_tidyup)(ThreadId tid); |
| 381 | |
| 382 | // Arch-specific client requests |
| 383 | extern Bool VGA_(client_requests)(ThreadId tid, UWord *args); |
| 384 | |
nethercote | 9b3c765 | 2004-10-19 13:18:00 +0000 | [diff] [blame] | 385 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 386 | ///* --------------------------------------------------------------------- |
| 387 | // Thread modelling |
| 388 | // ------------------------------------------------------------------ */ |
| 389 | //extern void VG_(tm_thread_create) (ThreadId creator, ThreadId tid, Bool detached); |
| 390 | //extern void VG_(tm_thread_exit) (ThreadId tid); |
| 391 | //extern Bool VG_(tm_thread_exists) (ThreadId tid); |
| 392 | //extern void VG_(tm_thread_detach) (ThreadId tid); |
| 393 | //extern void VG_(tm_thread_join) (ThreadId joiner, ThreadId joinee); |
| 394 | //extern void VG_(tm_thread_switchto)(ThreadId tid); |
| 395 | // |
| 396 | //extern void VG_(tm_mutex_init) (ThreadId tid, Addr mutexp); |
| 397 | //extern void VG_(tm_mutex_destroy)(ThreadId tid, Addr mutexp); |
| 398 | //extern void VG_(tm_mutex_trylock)(ThreadId tid, Addr mutexp); |
| 399 | //extern void VG_(tm_mutex_giveup) (ThreadId tid, Addr mutexp); |
| 400 | //extern void VG_(tm_mutex_acquire)(ThreadId tid, Addr mutexp); |
| 401 | //extern void VG_(tm_mutex_tryunlock)(ThreadId tid, Addr mutexp); |
| 402 | //extern void VG_(tm_mutex_unlock) (ThreadId tid, Addr mutexp); |
| 403 | //extern Bool VG_(tm_mutex_exists) (Addr mutexp); |
| 404 | // |
| 405 | //extern UInt VG_(tm_error_update_extra) (Error *err); |
| 406 | //extern Bool VG_(tm_error_equal) (VgRes res, Error *e1, Error *e2); |
| 407 | //extern void VG_(tm_error_print) (Error *err); |
| 408 | // |
| 409 | //extern void VG_(tm_init) (); |
| 410 | // |
| 411 | //extern void VG_(tm_cond_init) (ThreadId tid, Addr condp); |
| 412 | //extern void VG_(tm_cond_destroy) (ThreadId tid, Addr condp); |
| 413 | //extern void VG_(tm_cond_wait) (ThreadId tid, Addr condp, Addr mutexp); |
| 414 | //extern void VG_(tm_cond_wakeup) (ThreadId tid, Addr condp, Addr mutexp); |
| 415 | //extern void VG_(tm_cond_signal) (ThreadId tid, Addr condp); |
| 416 | // |
| 417 | ///* ----- pthreads ----- */ |
| 418 | //extern void VG_(pthread_init) (); |
| 419 | //extern void VG_(pthread_startfunc_wrapper)(Addr wrapper); |
| 420 | // |
| 421 | //struct vg_pthread_newthread_data { |
| 422 | // void *(*startfunc)(void *arg); |
| 423 | // void *arg; |
| 424 | //}; |
sewardj | 3b2736a | 2002-03-24 12:18:35 +0000 | [diff] [blame] | 425 | |
| 426 | /* --------------------------------------------------------------------- |
| 427 | Finally - autoconf-generated settings |
| 428 | ------------------------------------------------------------------ */ |
| 429 | |
| 430 | #include "config.h" |
| 431 | |
nethercote | c06e213 | 2004-09-03 13:45:29 +0000 | [diff] [blame] | 432 | #endif /* ndef __CORE_H */ |
| 433 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 434 | /*--------------------------------------------------------------------*/ |
nethercote | 109d0df | 2004-09-02 08:10:13 +0000 | [diff] [blame] | 435 | /*--- end ---*/ |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 436 | /*--------------------------------------------------------------------*/ |