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 | 7be4725 | 2004-09-02 16:02:58 +0000 | [diff] [blame] | 35 | /* |
njn | 2521d32 | 2005-05-08 14:45:13 +0000 | [diff] [blame] | 36 | [This comment is not longer accurate -- we're switching to an easier to |
| 37 | understand module-based approach, with one or two headers per module, |
| 38 | rather than having monolithic headers as described. --njn 07-May-2005] |
| 39 | |
nethercote | 7be4725 | 2004-09-02 16:02:58 +0000 | [diff] [blame] | 40 | Header hierarchy: |
| 41 | |
| 42 | - core C files include core.h |
| 43 | - core asm files include core_asm.h |
| 44 | - tool C files include tool.h |
| 45 | - tool asm files include tool_asm.h |
| 46 | |
| 47 | - The hierarchy of the header files themselves is based around the |
| 48 | following rules: |
| 49 | |
| 50 | - core headers include tool headers |
| 51 | - generic headers include arch/OS/platform headers |
| 52 | - C headers include asm headers |
| 53 | |
| 54 | This gives the following hierarchy (only showing 'arch' headers, not |
nethercote | 80cca43 | 2004-09-02 16:25:49 +0000 | [diff] [blame] | 55 | 'os' or 'platform' headers), where arrows indicate inclusion, and |
| 56 | $VG_ARCH==x86: |
nethercote | 7be4725 | 2004-09-02 16:02:58 +0000 | [diff] [blame] | 57 | |
nethercote | 80cca43 | 2004-09-02 16:25:49 +0000 | [diff] [blame] | 58 | |
| 59 | (include/x86/tool_arch_asm.h?) <----- coregrind/x86/core_arch_asm.h |
| 60 | ^ ^ ^ ^ |
| 61 | / \ / \ |
| 62 | / \ / \ |
| 63 | / \ / \ |
| 64 | include/tool_asm.h <-\---- coregrind/core_asm.h \ |
| 65 | ^ \ ^ \ |
| 66 | \ include/x86/tool_arch.h <--------coregrind/x86/core_arch.h |
| 67 | \ ^ \ ^ |
| 68 | \ / \ / |
| 69 | \ / \ / |
| 70 | \ / \ / |
| 71 | include/tool.h <------------ coregrind/core.h |
| 72 | |
nethercote | 7be4725 | 2004-09-02 16:02:58 +0000 | [diff] [blame] | 73 | |
| 74 | Note that core.h contains the *declarations* of arch-specific functions |
| 75 | and variables, which can be used by the core_arch.h file of any |
| 76 | architecture. (The functions/variables are *defined* within arch/.) |
| 77 | However, arch-specific macros and types cannot go into core.h, because |
| 78 | there is no separation between declaration and definition for |
| 79 | macros/types, so they instead go into $VG_ARCH/core_arch.h. |
nethercote | 80cca43 | 2004-09-02 16:25:49 +0000 | [diff] [blame] | 80 | |
| 81 | The tool-specific headers are all in include/ so they can be seen by any |
| 82 | external tools. |
nethercote | 7be4725 | 2004-09-02 16:02:58 +0000 | [diff] [blame] | 83 | */ |
| 84 | |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 85 | /* For system call numbers __NR_... */ |
nethercote | f94fe2f | 2004-09-10 14:23:59 +0000 | [diff] [blame] | 86 | #include "vki_unistd.h" |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 87 | |
nethercote | 1334313 | 2004-09-02 15:49:09 +0000 | [diff] [blame] | 88 | #include "core_asm.h" // asm stuff |
| 89 | #include "tool.h" // tool stuff |
nethercote | bb4222b | 2004-09-10 17:42:11 +0000 | [diff] [blame] | 90 | #include "core_arch.h" // arch-specific stuff, eg. x86/core_arch.h |
nethercote | 8ff888f | 2004-11-17 17:11:45 +0000 | [diff] [blame] | 91 | |
| 92 | // Ugly: this is needed by linux/core_os.h |
| 93 | typedef struct _ThreadState ThreadState; |
| 94 | |
nethercote | bb4222b | 2004-09-10 17:42:11 +0000 | [diff] [blame] | 95 | #include "core_platform.h" // platform-specific stuff, |
| 96 | // eg. x86-linux/core_platform.h |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 97 | #include "core_os.h" // OS-specific stuff, eg. linux/core_os.h |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 98 | |
njn | 717cde5 | 2005-05-10 02:47:21 +0000 | [diff] [blame] | 99 | #include "pub_core_mallocfree.h" // for type 'ArenaId' |
njn | d01fef7 | 2005-03-25 23:35:48 +0000 | [diff] [blame] | 100 | #include "pub_core_stacktrace.h" // for type 'StackTrace' |
| 101 | |
fitzhardinge | 39de4b4 | 2003-10-31 07:12:21 +0000 | [diff] [blame] | 102 | #include "valgrind.h" |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 103 | |
nethercote | 7be4725 | 2004-09-02 16:02:58 +0000 | [diff] [blame] | 104 | /* --------------------------------------------------------------------- |
njn | 14319cc | 2005-03-13 06:26:22 +0000 | [diff] [blame] | 105 | Global macros. |
nethercote | 7be4725 | 2004-09-02 16:02:58 +0000 | [diff] [blame] | 106 | ------------------------------------------------------------------ */ |
| 107 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 108 | /* Max length of a text fragment used to construct error messages. */ |
njn | 47b209a | 2005-03-25 23:47:16 +0000 | [diff] [blame] | 109 | #define VG_ERRTXT_LEN 4096 |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 110 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 111 | /* The maximum number of calls we're prepared to save in a |
| 112 | backtrace. */ |
| 113 | #define VG_DEEPEST_BACKTRACE 50 |
| 114 | |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 115 | /* Useful macros */ |
| 116 | /* a - alignment - must be a power of 2 */ |
tom | de2ec26 | 2005-03-29 12:16:10 +0000 | [diff] [blame] | 117 | #define ROUNDDN(p, a) ((Addr)(p) & ~((Addr)(a)-1)) |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 118 | #define ROUNDUP(p, a) ROUNDDN((p)+(a)-1, (a)) |
nethercote | 73b526f | 2004-10-31 18:48:21 +0000 | [diff] [blame] | 119 | #define PGROUNDDN(p) ROUNDDN(p, VKI_PAGE_SIZE) |
| 120 | #define PGROUNDUP(p) ROUNDUP(p, VKI_PAGE_SIZE) |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 121 | |
sewardj | 51ac087 | 2004-12-21 01:20:49 +0000 | [diff] [blame] | 122 | |
nethercote | 80013e9 | 2004-09-05 20:39:51 +0000 | [diff] [blame] | 123 | /* --------------------------------------------------------------------- |
| 124 | Environment variables |
| 125 | ------------------------------------------------------------------ */ |
| 126 | |
| 127 | /* The directory we look for all our auxillary files in */ |
| 128 | #define VALGRINDLIB "VALGRINDLIB" |
| 129 | |
| 130 | /* Additional command-line arguments; they are overridden by actual |
| 131 | command-line option. Each argument is separated by spaces. There |
| 132 | is no quoting mechanism. |
| 133 | */ |
| 134 | #define VALGRINDOPTS "VALGRIND_OPTS" |
| 135 | |
| 136 | /* If this variable is present in the environment, then valgrind will |
| 137 | not parse the command line for options at all; all options come |
| 138 | from this variable. Arguments are terminated by ^A (\001). There |
| 139 | is no quoting mechanism. |
| 140 | |
| 141 | This variable is not expected to be set by anything other than |
| 142 | Valgrind itself, as part of its handling of execve with |
| 143 | --trace-children=yes. This variable should not be present in the |
| 144 | client environment. |
| 145 | */ |
| 146 | #define VALGRINDCLO "_VALGRIND_CLO" |
| 147 | |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 148 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 149 | /* --------------------------------------------------------------------- |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 150 | Command-line-settable options |
| 151 | ------------------------------------------------------------------ */ |
| 152 | |
sewardj | 4f094a7 | 2002-11-05 23:37:35 +0000 | [diff] [blame] | 153 | /* Default destination port to be used in logging over a network, if |
| 154 | none specified. */ |
| 155 | #define VG_CLO_DEFAULT_LOGPORT 1500 |
sewardj | 73cf3bc | 2002-11-03 03:20:15 +0000 | [diff] [blame] | 156 | |
| 157 | /* The max number of suppression files. */ |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 158 | #define VG_CLO_MAX_SFILES 10 |
| 159 | |
sewardj | 4cf0569 | 2002-10-27 20:28:29 +0000 | [diff] [blame] | 160 | /* Describes where logging output is to be sent. */ |
| 161 | typedef |
| 162 | enum { |
| 163 | VgLogTo_Fd, |
| 164 | VgLogTo_File, |
sewardj | 603d410 | 2005-01-11 14:01:02 +0000 | [diff] [blame] | 165 | VgLogTo_FileExactly, |
sewardj | 4cf0569 | 2002-10-27 20:28:29 +0000 | [diff] [blame] | 166 | VgLogTo_Socket |
| 167 | } VgLogTo; |
| 168 | |
thughes | ad1c956 | 2004-06-26 11:27:52 +0000 | [diff] [blame] | 169 | /* Application-visible file descriptor limits */ |
| 170 | extern Int VG_(fd_soft_limit); |
| 171 | extern Int VG_(fd_hard_limit); |
fitzhardinge | f0046f2 | 2003-12-18 02:39:22 +0000 | [diff] [blame] | 172 | |
sewardj | 8b635a4 | 2004-11-22 19:01:47 +0000 | [diff] [blame] | 173 | /* Vex iropt control */ |
| 174 | extern VexControl VG_(clo_vex_control); |
sewardj | 72f98ff | 2002-06-13 17:23:38 +0000 | [diff] [blame] | 175 | /* Should we stop collecting errors if too many appear? default: YES */ |
sewardj | 2e43290 | 2002-06-13 20:44:00 +0000 | [diff] [blame] | 176 | extern Bool VG_(clo_error_limit); |
nethercote | 04d0fbc | 2004-01-26 16:48:06 +0000 | [diff] [blame] | 177 | /* Enquire about whether to attach to a debugger at errors? default: NO */ |
| 178 | extern Bool VG_(clo_db_attach); |
| 179 | /* The debugger command? default: whatever gdb ./configure found */ |
| 180 | extern Char* VG_(clo_db_command); |
sewardj | d153fae | 2005-01-10 17:24:47 +0000 | [diff] [blame] | 181 | /* Generating a suppression for each error? default: 0 (NO) |
| 182 | Other values: 1 (yes, but ask user), 2 (yes, don't ask user) */ |
| 183 | extern Int VG_(clo_gen_suppressions); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 184 | /* Sanity-check level: 0 = none, 1 (default), > 1 = expensive. */ |
nethercote | 27fec90 | 2004-06-16 21:26:32 +0000 | [diff] [blame] | 185 | extern Int VG_(clo_sanity_level); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 186 | /* Automatically attempt to demangle C++ names? default: YES */ |
| 187 | extern Bool VG_(clo_demangle); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 188 | /* Simulate child processes? default: NO */ |
| 189 | extern Bool VG_(clo_trace_children); |
sewardj | 4cf0569 | 2002-10-27 20:28:29 +0000 | [diff] [blame] | 190 | |
| 191 | /* Where logging output is to be sent to. |
| 192 | |
nethercote | f854867 | 2004-06-21 12:42:35 +0000 | [diff] [blame] | 193 | When log_to == VgLogTo_Fd, clo_log_fd holds the file id, and is |
| 194 | taken from the command line. clo_log_name is irrelevant. |
sewardj | 4cf0569 | 2002-10-27 20:28:29 +0000 | [diff] [blame] | 195 | |
nethercote | f854867 | 2004-06-21 12:42:35 +0000 | [diff] [blame] | 196 | When log_to == VgLogTo_File, clo_log_name holds the log-file |
| 197 | name, and is taken from the command line. clo_log_fd is then |
| 198 | made to hold the relevant file id, by opening clo_log_name |
sewardj | 4cf0569 | 2002-10-27 20:28:29 +0000 | [diff] [blame] | 199 | (concatenated with the process ID) for writing. |
| 200 | |
nethercote | f854867 | 2004-06-21 12:42:35 +0000 | [diff] [blame] | 201 | When log_to == VgLogTo_Socket, clo_log_name holds the |
sewardj | 4cf0569 | 2002-10-27 20:28:29 +0000 | [diff] [blame] | 202 | hostname:portnumber pair, and is taken from the command line. |
nethercote | f854867 | 2004-06-21 12:42:35 +0000 | [diff] [blame] | 203 | clo_log_fd is then made to hold the relevant file handle, by |
sewardj | 4cf0569 | 2002-10-27 20:28:29 +0000 | [diff] [blame] | 204 | opening a connection to said hostname:portnumber pair. |
| 205 | |
nethercote | f854867 | 2004-06-21 12:42:35 +0000 | [diff] [blame] | 206 | Global default is to set log_to == VgLogTo_Fd and log_fd == 2 |
sewardj | 4cf0569 | 2002-10-27 20:28:29 +0000 | [diff] [blame] | 207 | (stderr). */ |
| 208 | extern VgLogTo VG_(clo_log_to); |
nethercote | f854867 | 2004-06-21 12:42:35 +0000 | [diff] [blame] | 209 | extern Int VG_(clo_log_fd); |
| 210 | extern Char* VG_(clo_log_name); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 211 | |
thughes | 6233a38 | 2004-08-21 11:10:44 +0000 | [diff] [blame] | 212 | /* Add timestamps to log messages? default: NO */ |
| 213 | extern Bool VG_(clo_time_stamp); |
| 214 | |
sewardj | 6024b21 | 2003-07-13 10:54:33 +0000 | [diff] [blame] | 215 | /* The file descriptor to read for input. default: 0 == stdin */ |
| 216 | extern Int VG_(clo_input_fd); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 217 | /* The number of suppression files specified. */ |
| 218 | extern Int VG_(clo_n_suppressions); |
| 219 | /* The names of the suppression files. */ |
| 220 | extern Char* VG_(clo_suppressions)[VG_CLO_MAX_SFILES]; |
| 221 | |
sewardj | c771b29 | 2004-11-30 18:55:21 +0000 | [diff] [blame] | 222 | /* DEBUG: print generated code? default: 00000000 ( == NO ) */ |
sewardj | fa8ec11 | 2005-01-19 11:55:34 +0000 | [diff] [blame] | 223 | extern Bool VG_(clo_trace_flags); |
| 224 | /* DEBUG: do bb profiling? default: 00000000 ( == NO ) */ |
| 225 | extern Bool VG_(clo_profile_flags); |
sewardj | c771b29 | 2004-11-30 18:55:21 +0000 | [diff] [blame] | 226 | /* DEBUG: if tracing codegen, be quiet until after this bb ( 0 ) */ |
| 227 | extern Int VG_(clo_trace_notbelow); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 228 | /* DEBUG: print system calls? default: NO */ |
| 229 | extern Bool VG_(clo_trace_syscalls); |
| 230 | /* DEBUG: print signal details? default: NO */ |
| 231 | extern Bool VG_(clo_trace_signals); |
| 232 | /* DEBUG: print symtab details? default: NO */ |
| 233 | extern Bool VG_(clo_trace_symtab); |
sewardj | ce058b0 | 2005-05-01 08:55:38 +0000 | [diff] [blame] | 234 | /* DEBUG: print call-frame-info details? default: NO */ |
| 235 | extern Bool VG_(clo_trace_cfi); |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 236 | /* DEBUG: print redirection details? default: NO */ |
| 237 | extern Bool VG_(clo_trace_redir); |
sewardj | 8937c81 | 2002-04-12 20:12:20 +0000 | [diff] [blame] | 238 | /* DEBUG: print thread scheduling events? default: NO */ |
| 239 | extern Bool VG_(clo_trace_sched); |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 240 | /* DEBUG: print pthreads calls? default: NO */ |
| 241 | extern Bool VG_(clo_trace_pthreads); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 242 | /* Display gory details for the k'th most popular error. default: |
| 243 | Infinity. */ |
| 244 | extern Int VG_(clo_dump_error); |
| 245 | /* Number of parents of a backtrace. Default: 8. */ |
| 246 | extern Int VG_(clo_backtrace_size); |
daywalker | 7e73e5f | 2003-07-04 16:18:15 +0000 | [diff] [blame] | 247 | /* Engage miscellaneous weird hacks needed for some progs. */ |
sewardj | 8d365b5 | 2002-05-12 10:52:16 +0000 | [diff] [blame] | 248 | extern Char* VG_(clo_weird_hacks); |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 249 | |
rjwalsh | f5f536f | 2003-11-17 17:45:00 +0000 | [diff] [blame] | 250 | /* Track open file descriptors? */ |
| 251 | extern Bool VG_(clo_track_fds); |
| 252 | |
sewardj | 858964b | 2002-10-05 14:15:43 +0000 | [diff] [blame] | 253 | /* Should we run __libc_freeres at exit? Sometimes causes crashes. |
| 254 | Default: YES. Note this is subservient to VG_(needs).libc_freeres; |
| 255 | if the latter says False, then the setting of VG_(clo_weird_hacks) |
nethercote | 996901a | 2004-08-03 13:29:09 +0000 | [diff] [blame] | 256 | is ignored. Ie if a tool says no, I don't want this to run, that |
sewardj | 858964b | 2002-10-05 14:15:43 +0000 | [diff] [blame] | 257 | cannot be overridden from the command line. */ |
| 258 | extern Bool VG_(clo_run_libc_freeres); |
fitzhardinge | 462f4f9 | 2003-12-18 02:10:54 +0000 | [diff] [blame] | 259 | /* Generate branch-prediction hints? */ |
| 260 | extern Bool VG_(clo_branchpred); |
nethercote | 77eba60 | 2003-11-13 17:35:04 +0000 | [diff] [blame] | 261 | /* Continue stack traces below main()? Default: NO */ |
| 262 | extern Bool VG_(clo_show_below_main); |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 263 | /* Test each client pointer dereference to check it's within the |
| 264 | client address space bounds */ |
| 265 | extern Bool VG_(clo_pointercheck); |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 266 | /* Model the pthread library */ |
| 267 | extern Bool VG_(clo_model_pthreads); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 268 | |
sewardj | 062f355 | 2005-01-06 16:13:40 +0000 | [diff] [blame] | 269 | /* HACK: Use hacked version of clone for Quadrics Elan3 drivers */ |
| 270 | extern Bool VG_(clo_support_elan3); |
| 271 | |
sewardj | b1131a8 | 2005-03-19 15:12:21 +0000 | [diff] [blame] | 272 | /* Should we show VEX emulation warnings? Default: NO */ |
| 273 | extern Bool VG_(clo_show_emwarns); |
| 274 | |
sewardj | 97724e5 | 2005-04-02 23:40:59 +0000 | [diff] [blame] | 275 | /* How much does the stack pointer have to change before tools |
| 276 | consider a stack switch to have happened? Default: 2000000 bytes */ |
| 277 | extern Int VG_(clo_max_stackframe); |
| 278 | |
rjwalsh | e4e779d | 2004-04-16 23:02:29 +0000 | [diff] [blame] | 279 | /* Set up the libc freeres wrapper */ |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 280 | extern void VGA_(intercept_libc_freeres_wrapper)(Addr); |
rjwalsh | e4e779d | 2004-04-16 23:02:29 +0000 | [diff] [blame] | 281 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 282 | // Clean up the client by calling before the final reports |
| 283 | extern void VGA_(final_tidyup)(ThreadId tid); |
| 284 | |
| 285 | // Arch-specific client requests |
| 286 | extern Bool VGA_(client_requests)(ThreadId tid, UWord *args); |
sewardj | 51ac087 | 2004-12-21 01:20:49 +0000 | [diff] [blame] | 287 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 288 | /* --------------------------------------------------------------------- |
nethercote | 85cdd34 | 2004-08-01 22:36:40 +0000 | [diff] [blame] | 289 | Profiling stuff |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 290 | ------------------------------------------------------------------ */ |
| 291 | |
njn | 31066fd | 2005-03-26 00:42:02 +0000 | [diff] [blame] | 292 | extern void VG_(init_profiling) ( void ); |
| 293 | extern void VG_(done_profiling) ( void ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 294 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 295 | #undef VGP_PUSHCC |
| 296 | #undef VGP_POPCC |
njn | 31066fd | 2005-03-26 00:42:02 +0000 | [diff] [blame] | 297 | #define VGP_PUSHCC(x) if (VG_(clo_profile)) VG_(pushcc)(x) |
| 298 | #define VGP_POPCC(x) if (VG_(clo_profile)) VG_(popcc)(x) |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 299 | |
sewardj | 51ac087 | 2004-12-21 01:20:49 +0000 | [diff] [blame] | 300 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 301 | /* --------------------------------------------------------------------- |
njn | 3e88418 | 2003-04-15 13:03:23 +0000 | [diff] [blame] | 302 | Exports of vg_intercept.c |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 303 | ------------------------------------------------------------------ */ |
| 304 | |
njn | a91498f | 2005-05-11 22:32:39 +0000 | [diff] [blame^] | 305 | /* These are the internal client request codes. The publically-visible |
| 306 | request codes are also defined in valgrind.h, and similar headers for |
| 307 | some tools. */ |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 308 | |
njn | a91498f | 2005-05-11 22:32:39 +0000 | [diff] [blame^] | 309 | /* Get the tool's malloc-wrapping functions */ |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 310 | #define VG_USERREQ__GET_MALLOCFUNCS 0x3030 |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 311 | |
fitzhardinge | 39de4b4 | 2003-10-31 07:12:21 +0000 | [diff] [blame] | 312 | /* Internal equivalent of VALGRIND_PRINTF . */ |
| 313 | #define VG_USERREQ__INTERNAL_PRINTF 0x3103 |
sewardj | 45b4b37 | 2002-04-16 22:50:32 +0000 | [diff] [blame] | 314 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 315 | /* Denote the finish of __libc_freeres_wrapper(). |
| 316 | A synonym for exit. */ |
| 317 | #define VG_USERREQ__LIBC_FREERES_DONE 0x3029 |
sewardj | 54cacf0 | 2002-04-12 23:24:59 +0000 | [diff] [blame] | 318 | |
njn | 717cde5 | 2005-05-10 02:47:21 +0000 | [diff] [blame] | 319 | /* Intercept prefix stuff. See |
| 320 | coregrind/m_replace_malloc/vg_replace_malloc.c for details. |
| 321 | Unfortunately the "_vgi_" literal is also hardcoded in that file, so if |
| 322 | you change this one you must also change the other one. */ |
sewardj | 9ee81f5 | 2005-04-02 17:38:59 +0000 | [diff] [blame] | 323 | #define VG_INTERCEPT_PREFIX "_vgi_" |
| 324 | #define VG_INTERCEPT_PREFIX_LEN 5 |
rjwalsh | e4e779d | 2004-04-16 23:02:29 +0000 | [diff] [blame] | 325 | |
sewardj | 9ee81f5 | 2005-04-02 17:38:59 +0000 | [diff] [blame] | 326 | /* Not sure what these are for. Todo: clarify */ |
| 327 | #define VG_WRAPPER_PREFIX "_vgw_" |
| 328 | #define VG_WRAPPER_PREFIX_LEN 5 |
| 329 | #define VG_WRAPPER(name) _vgw_##name |
| 330 | #define VG_WRAPPER_ALIAS(name) "_vgw_" #name |
rjwalsh | e4e779d | 2004-04-16 23:02:29 +0000 | [diff] [blame] | 331 | |
njn | 4c79121 | 2003-05-02 17:53:54 +0000 | [diff] [blame] | 332 | |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 333 | /* --------------------------------------------------------------------- |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 334 | Exports of vg_scheduler.c |
| 335 | ------------------------------------------------------------------ */ |
| 336 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 337 | /* |
| 338 | Thread state machine: |
| 339 | |
| 340 | Empty -> Init -> Runnable <=> WaitSys/Yielding |
| 341 | ^ | |
| 342 | \---- Zombie -----/ |
| 343 | */ |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 344 | typedef |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 345 | enum ThreadStatus { |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 346 | VgTs_Empty, /* this slot is not in use */ |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 347 | VgTs_Init, /* just allocated */ |
| 348 | VgTs_Runnable, /* ready to run */ |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 349 | VgTs_WaitSys, /* waiting for a syscall to complete */ |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 350 | VgTs_Yielding, /* temporarily yielding the CPU */ |
| 351 | VgTs_Zombie, /* transient state just before exiting */ |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 352 | } |
| 353 | ThreadStatus; |
sewardj | 8ad94e1 | 2002-05-29 00:10:20 +0000 | [diff] [blame] | 354 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 355 | /* Return codes from the scheduler. */ |
thughes | 11975ff | 2004-06-12 12:58:22 +0000 | [diff] [blame] | 356 | typedef |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 357 | enum { |
| 358 | VgSrc_None, /* not exiting yet */ |
| 359 | VgSrc_ExitSyscall, /* client called exit(). This is the normal |
| 360 | route out. */ |
| 361 | VgSrc_FatalSig /* Killed by the default action of a fatal |
| 362 | signal */ |
thughes | 11975ff | 2004-06-12 12:58:22 +0000 | [diff] [blame] | 363 | } |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 364 | VgSchedReturnCode; |
thughes | 11975ff | 2004-06-12 12:58:22 +0000 | [diff] [blame] | 365 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 366 | struct _ThreadState { |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 367 | /* ThreadId == 0 (and hence vg_threads[0]) is NEVER USED. |
| 368 | The thread identity is simply the index in vg_threads[]. |
| 369 | ThreadId == 1 is the root thread and has the special property |
| 370 | that we don't try and allocate or deallocate its stack. For |
| 371 | convenience of generating error message, we also put the |
| 372 | ThreadId in this tid field, but be aware that it should |
| 373 | ALWAYS == the index in vg_threads[]. */ |
| 374 | ThreadId tid; |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 375 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 376 | /* Current scheduling status. */ |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 377 | ThreadStatus status; |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 378 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 379 | /* This is set if the thread is in the process of exiting for any |
| 380 | reason. The precise details of the exit are in the OS-specific |
| 381 | state. */ |
| 382 | VgSchedReturnCode exitreason; |
sewardj | 3b5d886 | 2002-04-20 13:53:23 +0000 | [diff] [blame] | 383 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 384 | /* Architecture-specific thread state. */ |
| 385 | ThreadArchState arch; |
sewardj | b48e500 | 2002-05-13 00:16:03 +0000 | [diff] [blame] | 386 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 387 | /* This thread's blocked-signals mask. Semantics is that for a |
| 388 | signal to be delivered to this thread, the signal must not be |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 389 | blocked by this signal mask. If more than one thread accepts a |
| 390 | signal, then it will be delivered to one at random. If all |
| 391 | threads block the signal, it will remain pending until either a |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 392 | thread unblocks it or someone uses sigwaitsig/sigtimedwait. */ |
nethercote | 73b526f | 2004-10-31 18:48:21 +0000 | [diff] [blame] | 393 | vki_sigset_t sig_mask; |
sewardj | b48e500 | 2002-05-13 00:16:03 +0000 | [diff] [blame] | 394 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 395 | /* tmp_sig_mask is usually the same as sig_mask, and is kept in |
| 396 | sync whenever sig_mask is changed. The only time they have |
| 397 | different values is during the execution of a sigsuspend, where |
| 398 | tmp_sig_mask is the temporary mask which sigsuspend installs. |
| 399 | It is only consulted to compute the signal mask applied to a |
| 400 | signal handler. */ |
| 401 | vki_sigset_t tmp_sig_mask; |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 402 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 403 | /* A little signal queue for signals we can't get the kernel to |
| 404 | queue for us. This is only allocated as needed, since it should |
| 405 | be rare. */ |
| 406 | struct SigQueue *sig_queue; |
| 407 | |
| 408 | /* Syscall the Thread is currently running; -1 if none. Should only |
| 409 | be set while Thread is in VgTs_WaitSys. */ |
| 410 | Int syscallno; |
| 411 | |
| 412 | /* A value the Tool wants to pass from its pre-syscall to its |
| 413 | post-syscall function. */ |
| 414 | void *tool_pre_syscall_value; |
thughes | 8abf392 | 2004-10-16 10:59:49 +0000 | [diff] [blame] | 415 | |
njn | 50ba34e | 2005-04-04 02:41:42 +0000 | [diff] [blame] | 416 | /* Client stacks. When a thread slot is freed, we don't deallocate its |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 417 | stack; we just leave it lying around for the next use of the |
| 418 | slot. If the next use of the slot requires a larger stack, |
| 419 | only then is the old one deallocated and a new one |
| 420 | allocated. |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 421 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 422 | For the main thread (threadid == 0), this mechanism doesn't |
| 423 | apply. We don't know the size of the stack since we didn't |
| 424 | allocate it, and furthermore we never reallocate it. */ |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 425 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 426 | /* The allocated size of this thread's stack (permanently zero |
| 427 | if this is ThreadId == 0, since we didn't allocate its stack) */ |
njn | 50ba34e | 2005-04-04 02:41:42 +0000 | [diff] [blame] | 428 | SizeT client_stack_szB; |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 429 | |
sewardj | 92a5956 | 2002-09-30 00:53:10 +0000 | [diff] [blame] | 430 | /* Address of the highest legitimate word in this stack. This is |
| 431 | used for error messages only -- not critical for execution |
| 432 | correctness. Is is set for all stacks, specifically including |
| 433 | ThreadId == 0 (the main thread). */ |
njn | 50ba34e | 2005-04-04 02:41:42 +0000 | [diff] [blame] | 434 | Addr client_stack_highest_word; |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 435 | |
fitzhardinge | 98c4dc0 | 2004-03-16 08:27:29 +0000 | [diff] [blame] | 436 | /* Alternate signal stack */ |
nethercote | 73b526f | 2004-10-31 18:48:21 +0000 | [diff] [blame] | 437 | vki_stack_t altstack; |
fitzhardinge | 98c4dc0 | 2004-03-16 08:27:29 +0000 | [diff] [blame] | 438 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 439 | /* OS-specific thread state */ |
| 440 | os_thread_t os_state; |
sewardj | 004e8ca | 2005-02-28 17:27:04 +0000 | [diff] [blame] | 441 | |
| 442 | /* Used in the syscall handlers. Set to True to indicate that the |
| 443 | PRE routine for a syscall has set the syscall result already and |
| 444 | so the syscall does not need to be handed to the kernel. */ |
| 445 | Bool syscall_result_set; |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 446 | |
| 447 | /* Per-thread jmp_buf to resume scheduler after a signal */ |
| 448 | Bool sched_jmpbuf_valid; |
| 449 | jmp_buf sched_jmpbuf; |
nethercote | 8ff888f | 2004-11-17 17:11:45 +0000 | [diff] [blame] | 450 | }; |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 451 | |
sewardj | 018f762 | 2002-05-15 21:13:39 +0000 | [diff] [blame] | 452 | /* The thread table. */ |
| 453 | extern ThreadState VG_(threads)[VG_N_THREADS]; |
| 454 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 455 | /* Allocate a new ThreadState */ |
| 456 | extern ThreadId VG_(alloc_ThreadState)(void); |
| 457 | |
| 458 | /* A thread exits. tid must currently be running. */ |
| 459 | extern void VG_(exit_thread)(ThreadId tid); |
| 460 | |
| 461 | /* Kill a thread. This interrupts whatever a thread is doing, and |
| 462 | makes it exit ASAP. This does not set the exitreason or |
| 463 | exitcode. */ |
| 464 | extern void VG_(kill_thread)(ThreadId tid); |
| 465 | |
sewardj | 018f762 | 2002-05-15 21:13:39 +0000 | [diff] [blame] | 466 | /* Check that tid is in range and denotes a non-Empty thread. */ |
sewardj | b48e500 | 2002-05-13 00:16:03 +0000 | [diff] [blame] | 467 | extern Bool VG_(is_valid_tid) ( ThreadId tid ); |
| 468 | |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 469 | /* Get the ThreadState for a particular thread */ |
| 470 | extern ThreadState *VG_(get_ThreadState)(ThreadId tid); |
| 471 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 472 | /* Given an LWP id (ie, real kernel thread id), find the corresponding |
| 473 | ThreadId */ |
| 474 | extern ThreadId VG_(get_lwp_tid)(Int lwpid); |
| 475 | |
| 476 | /* Returns true if a thread is currently running (ie, has the CPU lock) */ |
| 477 | extern Bool VG_(is_running_thread)(ThreadId tid); |
| 478 | |
| 479 | /* Returns true if the thread is in the process of exiting */ |
| 480 | extern Bool VG_(is_exiting)(ThreadId tid); |
| 481 | |
| 482 | /* Return the number of non-dead Threads */ |
| 483 | extern Int VG_(count_living_threads)(void); |
| 484 | |
sewardj | ccef2e6 | 2002-05-29 19:26:32 +0000 | [diff] [blame] | 485 | /* Nuke all threads except tid. */ |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 486 | extern void VG_(nuke_all_threads_except) ( ThreadId me, VgSchedReturnCode reason ); |
sewardj | ccef2e6 | 2002-05-29 19:26:32 +0000 | [diff] [blame] | 487 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 488 | /* Make a thread the running thread. The thread must previously been |
| 489 | sleeping, and not holding the CPU semaphore. This will set the |
| 490 | thread state to VgTs_Runnable, and the thread will attempt to take |
| 491 | the CPU semaphore. By the time it returns, tid will be the running |
| 492 | thread. */ |
| 493 | extern void VG_(set_running) ( ThreadId tid ); |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 494 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 495 | /* Set a thread into a sleeping state. Before the call, the thread |
| 496 | must be runnable, and holding the CPU semaphore. When this call |
| 497 | returns, the thread will be set to the specified sleeping state, |
| 498 | and will not be holding the CPU semaphore. Note that another |
| 499 | thread could be running by the time this call returns, so the |
| 500 | caller must be careful not to touch any shared state. It is also |
| 501 | the caller's responsibility to actually block until the thread is |
| 502 | ready to run again. */ |
| 503 | extern void VG_(set_sleeping) ( ThreadId tid, ThreadStatus state ); |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 504 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 505 | /* Yield the CPU for a while */ |
| 506 | extern void VG_(vg_yield)(void); |
sewardj | 7e87e38 | 2002-05-03 19:09:05 +0000 | [diff] [blame] | 507 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 508 | // The scheduler. |
| 509 | extern VgSchedReturnCode VG_(scheduler) ( ThreadId tid ); |
| 510 | |
| 511 | // Do everything which needs doing before the process finally ends, |
| 512 | // like printing reports, etc |
| 513 | extern void VG_(shutdown_actions)(ThreadId tid); |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 514 | |
| 515 | extern void VG_(scheduler_init) ( void ); |
| 516 | |
sewardj | 15a43e1 | 2002-04-17 19:35:12 +0000 | [diff] [blame] | 517 | extern void VG_(pp_sched_status) ( void ); |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 518 | |
nethercote | 75d2624 | 2004-08-01 22:59:18 +0000 | [diff] [blame] | 519 | // Longjmp back to the scheduler and thus enter the sighandler immediately. |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 520 | extern void VG_(resume_scheduler) ( ThreadId tid ); |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 521 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 522 | /* If true, a fault is Valgrind-internal (ie, a bug) */ |
| 523 | extern Bool VG_(my_fault); |
nethercote | 238a3c3 | 2004-08-09 13:13:31 +0000 | [diff] [blame] | 524 | |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 525 | /* --------------------------------------------------------------------- |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 526 | Exports of vg_signals.c |
| 527 | ------------------------------------------------------------------ */ |
| 528 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 529 | /* Highest signal the kernel will let us use */ |
| 530 | extern Int VG_(max_signal); |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 531 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 532 | extern void VG_(sigstartup_actions) ( void ); |
| 533 | |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 534 | extern Bool VG_(is_sig_ign) ( Int sigNo ); |
| 535 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 536 | /* Poll a thread's set of pending signals, and update the Thread's context to deliver one */ |
| 537 | extern void VG_(poll_signals) ( ThreadId ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 538 | |
| 539 | /* Fake system calls for signal handling. */ |
njn | 502badb | 2005-05-08 02:04:49 +0000 | [diff] [blame] | 540 | extern Int VG_(do_sys_sigaltstack) ( ThreadId tid, vki_stack_t* ss, |
| 541 | vki_stack_t* oss ); |
| 542 | extern Int VG_(do_sys_sigaction) ( Int signo, |
| 543 | const struct vki_sigaction *new_act, |
| 544 | struct vki_sigaction *old_act ); |
| 545 | extern Int VG_(do_sys_sigprocmask) ( ThreadId tid, Int how, |
| 546 | vki_sigset_t* set, |
| 547 | vki_sigset_t* oldset ); |
sewardj | efbfcdf | 2002-06-19 17:35:45 +0000 | [diff] [blame] | 548 | |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 549 | /* Handy utilities to block/restore all host signals. */ |
| 550 | extern void VG_(block_all_host_signals) |
nethercote | 73b526f | 2004-10-31 18:48:21 +0000 | [diff] [blame] | 551 | ( /* OUT */ vki_sigset_t* saved_mask ); |
sewardj | 018f762 | 2002-05-15 21:13:39 +0000 | [diff] [blame] | 552 | extern void VG_(restore_all_host_signals) |
nethercote | 73b526f | 2004-10-31 18:48:21 +0000 | [diff] [blame] | 553 | ( /* IN */ vki_sigset_t* saved_mask ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 554 | |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 555 | extern void VG_(kill_self)(Int sigNo); |
| 556 | |
fitzhardinge | f1beb25 | 2004-03-16 09:49:08 +0000 | [diff] [blame] | 557 | /* These function synthesize a fault, as if the running instruction |
| 558 | had had a fault. These functions do not return - they longjmp back |
| 559 | into the scheduler so the signal can be delivered. */ |
| 560 | extern void VG_(synth_fault) (ThreadId tid); |
| 561 | extern void VG_(synth_fault_mapping)(ThreadId tid, Addr addr); |
| 562 | extern void VG_(synth_fault_perms) (ThreadId tid, Addr addr); |
sewardj | 5e2f001 | 2004-12-13 14:10:34 +0000 | [diff] [blame] | 563 | extern void VG_(synth_sigill) (ThreadId tid, Addr addr); |
fitzhardinge | f1beb25 | 2004-03-16 09:49:08 +0000 | [diff] [blame] | 564 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 565 | /* Extend the stack to cover addr, if possible */ |
| 566 | extern Bool VG_(extend_stack)(Addr addr, UInt maxsize); |
| 567 | |
| 568 | /* Returns True if the signal is OK for the client to use */ |
| 569 | extern Bool VG_(client_signal_OK)(Int sigNo); |
| 570 | |
| 571 | /* Forces the client's signal handler to SIG_DFL - generally just |
| 572 | before using that signal to kill the process. */ |
| 573 | extern void VG_(set_default_handler)(Int sig); |
| 574 | |
| 575 | /* Adjust a client's signal mask to match our internal requirements */ |
| 576 | extern void VG_(sanitize_client_sigmask)(ThreadId tid, vki_sigset_t *mask); |
| 577 | |
| 578 | /* Wait until a thread-related predicate is true */ |
| 579 | extern void VG_(wait_for_threadstate)(Bool (*pred)(void *), void *arg); |
sewardj | 51ac087 | 2004-12-21 01:20:49 +0000 | [diff] [blame] | 580 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 581 | /* --------------------------------------------------------------------- |
| 582 | Exports of vg_mylibc.c |
| 583 | ------------------------------------------------------------------ */ |
| 584 | |
njn | ca0518d | 2004-11-26 19:34:36 +0000 | [diff] [blame] | 585 | // Useful for making failing stubs, when certain things haven't yet been |
| 586 | // implemented. |
njn | 50ae1a7 | 2005-04-08 23:28:23 +0000 | [diff] [blame] | 587 | #define I_die_here \ |
| 588 | VG_(assert_fail) ("Unimplemented functionality", \ |
| 589 | __FILE__, __LINE__, __PRETTY_FUNCTION__, \ |
| 590 | "valgrind", VG_BUGS_TO, "") |
njn | ca0518d | 2004-11-26 19:34:36 +0000 | [diff] [blame] | 591 | |
njn | 50ae1a7 | 2005-04-08 23:28:23 +0000 | [diff] [blame] | 592 | #define vg_assert(expr) \ |
| 593 | ((void) ((expr) ? 0 : \ |
| 594 | (VG_(assert_fail) (/*isCore*/True, VG_STRINGIFY(expr), \ |
| 595 | __FILE__, __LINE__, __PRETTY_FUNCTION__, \ |
| 596 | ""), \ |
| 597 | 0))) |
| 598 | |
| 599 | #define vg_assert2(expr, format, args...) \ |
| 600 | ((void) ((expr) ? 0 : \ |
| 601 | (VG_(assert_fail) (/*isCore*/True, VG_STRINGIFY(expr), \ |
| 602 | __FILE__, __LINE__, __PRETTY_FUNCTION__, \ |
| 603 | format, ##args), \ |
| 604 | 0))) |
| 605 | |
njn | e427a66 | 2002-10-02 11:08:25 +0000 | [diff] [blame] | 606 | __attribute__ ((__noreturn__)) |
| 607 | extern void VG_(core_panic) ( Char* str ); |
thughes | 5876d55 | 2004-09-26 18:44:06 +0000 | [diff] [blame] | 608 | __attribute__ ((__noreturn__)) |
njn | d01fef7 | 2005-03-25 23:35:48 +0000 | [diff] [blame] | 609 | extern void VG_(core_panic_at) ( Char* str, StackTrace ips ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 610 | |
nethercote | 05675c8 | 2004-08-04 10:37:49 +0000 | [diff] [blame] | 611 | /* Tools use VG_(strdup)() which doesn't expose ArenaId */ |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 612 | extern Char* VG_(arena_strdup) ( ArenaId aid, const Char* s); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 613 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 614 | extern Int VG_(fcntl) ( Int fd, Int cmd, Int arg ); |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 615 | extern Int VG_(poll)( struct vki_pollfd *, UInt nfds, Int timeout); |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 616 | |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 617 | /* system/mman.h */ |
nethercote | 8b5f40c | 2004-11-02 13:29:50 +0000 | [diff] [blame] | 618 | extern void* VG_(mmap)( void* start, SizeT length, UInt prot, UInt flags, |
nethercote | 5b9fafd | 2004-11-04 18:39:22 +0000 | [diff] [blame] | 619 | UInt sf_flags, UInt fd, OffT offset ); |
nethercote | 8b5f40c | 2004-11-02 13:29:50 +0000 | [diff] [blame] | 620 | extern Int VG_(munmap)( void* start, SizeT length ); |
| 621 | extern Int VG_(mprotect)( void *start, SizeT length, UInt prot ); |
sewardj | 79048ce | 2005-02-18 08:28:32 +0000 | [diff] [blame] | 622 | extern Int VG_(mprotect_native)( void *start, SizeT length, UInt prot ); |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 623 | |
| 624 | |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 625 | /* Move an fd into the Valgrind-safe range */ |
| 626 | Int VG_(safe_fd)(Int oldfd); |
| 627 | |
sewardj | 570f890 | 2002-11-03 11:44:36 +0000 | [diff] [blame] | 628 | extern Int VG_(write_socket)( Int sd, void *msg, Int count ); |
sewardj | 73cf3bc | 2002-11-03 03:20:15 +0000 | [diff] [blame] | 629 | |
| 630 | /* --- Connecting over the network --- */ |
| 631 | extern Int VG_(connect_via_socket)( UChar* str ); |
| 632 | |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 633 | /* Environment manipulations */ |
nethercote | 60a96c5 | 2004-08-03 13:08:31 +0000 | [diff] [blame] | 634 | extern Char **VG_(env_setenv) ( Char ***envp, const Char* varname, |
| 635 | const Char *val ); |
| 636 | extern void VG_(env_unsetenv) ( Char **env, const Char *varname ); |
| 637 | extern void VG_(env_remove_valgrind_env_stuff) ( Char** env ); |
sewardj | 570f890 | 2002-11-03 11:44:36 +0000 | [diff] [blame] | 638 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 639 | extern void VG_(nanosleep)(struct vki_timespec *); |
njn | 2521d32 | 2005-05-08 14:45:13 +0000 | [diff] [blame] | 640 | |
sewardj | 570f890 | 2002-11-03 11:44:36 +0000 | [diff] [blame] | 641 | /* --------------------------------------------------------------------- |
| 642 | Exports of vg_message.c |
| 643 | ------------------------------------------------------------------ */ |
| 644 | |
| 645 | /* Low-level -- send bytes directly to the message sink. Do not |
| 646 | use. */ |
| 647 | extern void VG_(send_bytes_to_logging_sink) ( Char* msg, Int nbytes ); |
| 648 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 649 | /* --------------------------------------------------------------------- |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 650 | Exports of vg_translate.c |
| 651 | ------------------------------------------------------------------ */ |
| 652 | |
sewardj | fa8ec11 | 2005-01-19 11:55:34 +0000 | [diff] [blame] | 653 | extern |
| 654 | Bool VG_(translate) ( ThreadId tid, |
| 655 | Addr64 orig_addr, |
| 656 | Bool debugging_translation, |
| 657 | Int debugging_verbosity ); |
sewardj | b5ff83e | 2002-12-01 19:40:49 +0000 | [diff] [blame] | 658 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 659 | /* --------------------------------------------------------------------- |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 660 | Exports of vg_symtab2.c |
| 661 | ------------------------------------------------------------------ */ |
| 662 | |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 663 | typedef struct _Segment Segment; |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 664 | typedef struct _CodeRedirect CodeRedirect; |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 665 | |
| 666 | extern Bool VG_(is_object_file) ( const void *hdr ); |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 667 | extern SegInfo * VG_(read_seg_symbols) ( Segment *seg ); |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 668 | extern void VG_(symtab_incref) ( SegInfo * ); |
nethercote | 8991d5a | 2004-11-03 17:07:46 +0000 | [diff] [blame] | 669 | extern void VG_(symtab_decref) ( SegInfo *, Addr a ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 670 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 671 | extern Bool VG_(get_fnname_nodemangle)( Addr a, Char* fnname, Int n_fnname ); |
sewardj | 25c7c3a | 2003-07-10 00:17:58 +0000 | [diff] [blame] | 672 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 673 | extern Addr VG_(reverse_search_one_symtab) ( const SegInfo* si, const Char* name ); |
| 674 | |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 675 | /* Set up some default redirects */ |
| 676 | extern void VG_(setup_code_redirect_table) ( void ); |
sewardj | 25c7c3a | 2003-07-10 00:17:58 +0000 | [diff] [blame] | 677 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 678 | extern Bool VG_(resolve_redir_allsegs)(CodeRedirect *redir); |
| 679 | |
sewardj | 3516553 | 2005-04-30 18:47:48 +0000 | [diff] [blame] | 680 | extern Bool VG_(use_CFI_info) ( /*MOD*/Addr* ipP, |
| 681 | /*MOD*/Addr* spP, |
| 682 | /*MOD*/Addr* fpP, |
| 683 | Addr min_accessible, |
| 684 | Addr max_accessible ); |
| 685 | |
| 686 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 687 | /* --------------------------------------------------------------------- |
| 688 | Exports of vg_redir.c |
| 689 | ------------------------------------------------------------------ */ |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 690 | /* Redirection machinery */ |
nethercote | 85cdd34 | 2004-08-01 22:36:40 +0000 | [diff] [blame] | 691 | extern Addr VG_(code_redirect) ( Addr orig ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 692 | |
tom | 748a131 | 2005-04-02 15:53:01 +0000 | [diff] [blame] | 693 | extern void VG_(add_redirect_sym_to_addr)(const Char *from_lib, |
| 694 | const Char *from_sym, |
| 695 | Addr to_addr); |
| 696 | 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] | 697 | extern void VG_(resolve_seg_redirs)(SegInfo *si); |
| 698 | extern Bool VG_(resolve_redir)(CodeRedirect *redir, const SegInfo *si); |
| 699 | |
| 700 | /* Wrapping machinery */ |
| 701 | enum return_type { |
| 702 | RT_RETURN, |
| 703 | RT_LONGJMP, |
| 704 | RT_EXIT, |
| 705 | }; |
| 706 | |
| 707 | typedef struct _FuncWrapper FuncWrapper; |
| 708 | struct _FuncWrapper { |
| 709 | void *(*before)(va_list args); |
| 710 | void (*after) (void *nonce, enum return_type, Word retval); |
| 711 | }; |
| 712 | |
| 713 | extern void VG_(wrap_function)(Addr eip, const FuncWrapper *wrapper); |
| 714 | extern const FuncWrapper *VG_(is_wrapped)(Addr eip); |
| 715 | extern Bool VG_(is_wrapper_return)(Addr eip); |
| 716 | |
| 717 | /* Primary interface for adding wrappers for client-side functions. */ |
| 718 | extern CodeRedirect *VG_(add_wrapper)(const Char *from_lib, const Char *from_sym, |
| 719 | const FuncWrapper *wrapper); |
| 720 | |
| 721 | extern Bool VG_(is_resolved)(const CodeRedirect *redir); |
sewardj | 51ac087 | 2004-12-21 01:20:49 +0000 | [diff] [blame] | 722 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 723 | /* --------------------------------------------------------------------- |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 724 | Exports of vg_main.c |
| 725 | ------------------------------------------------------------------ */ |
| 726 | |
sewardj | 73cf3bc | 2002-11-03 03:20:15 +0000 | [diff] [blame] | 727 | /* Tell the logging mechanism whether we are logging to a file |
| 728 | descriptor or a socket descriptor. */ |
| 729 | extern Bool VG_(logging_to_filedes); |
| 730 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 731 | /* Sanity checks which may be done at any time. The scheduler decides when. */ |
nethercote | 885dd91 | 2004-08-03 23:14:00 +0000 | [diff] [blame] | 732 | extern void VG_(sanity_check_general) ( Bool force_expensive ); |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 733 | |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 734 | /* Address space */ |
| 735 | extern Addr VG_(client_base); /* client address space limits */ |
| 736 | extern Addr VG_(client_end); |
| 737 | extern Addr VG_(client_mapbase); /* base of mappings */ |
| 738 | extern Addr VG_(clstk_base); /* client stack range */ |
| 739 | extern Addr VG_(clstk_end); |
fitzhardinge | 9236079 | 2003-12-24 10:11:11 +0000 | [diff] [blame] | 740 | extern Addr VG_(client_trampoline_code); |
| 741 | |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 742 | extern Addr VG_(brk_base); /* start of brk */ |
| 743 | extern Addr VG_(brk_limit); /* current brk */ |
nethercote | 996901a | 2004-08-03 13:29:09 +0000 | [diff] [blame] | 744 | extern Addr VG_(shadow_base); /* tool's shadow memory */ |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 745 | extern Addr VG_(shadow_end); |
| 746 | extern Addr VG_(valgrind_base); /* valgrind's address range */ |
nethercote | 820bd8c | 2004-09-07 23:04:49 +0000 | [diff] [blame] | 747 | 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] | 748 | |
nethercote | 73b526f | 2004-10-31 18:48:21 +0000 | [diff] [blame] | 749 | extern struct vki_rlimit VG_(client_rlimit_data); /* client's original rlimit data */ |
| 750 | extern struct vki_rlimit VG_(client_rlimit_stack); /* client's original rlimit stack */ |
fitzhardinge | b50068f | 2004-02-24 23:42:55 +0000 | [diff] [blame] | 751 | |
fitzhardinge | a49f9b5 | 2003-12-16 22:26:45 +0000 | [diff] [blame] | 752 | /* client executable file descriptor */ |
| 753 | extern Int VG_(clexecfd); |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 754 | |
nethercote | f6a1d50 | 2004-08-09 12:21:57 +0000 | [diff] [blame] | 755 | // Help set up the child used when doing execve() with --trace-children=yes |
| 756 | Char* VG_(build_child_VALGRINDCLO) ( Char* exename ); |
| 757 | Char* VG_(build_child_exename) ( void ); |
| 758 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 759 | /* The master thread the one which will be responsible for mopping |
| 760 | everything up at exit. Normally it is tid 1, since that's the |
| 761 | first thread created, but it may be something else after a |
| 762 | fork(). */ |
| 763 | extern ThreadId VG_(master_tid); |
| 764 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 765 | /* Called when some unhandleable client behaviour is detected. |
| 766 | Prints a msg and aborts. */ |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 767 | extern void VG_(unimplemented) ( Char* msg ) |
| 768 | __attribute__((__noreturn__)); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 769 | |
nethercote | 04d0fbc | 2004-01-26 16:48:06 +0000 | [diff] [blame] | 770 | /* Something of a function looking for a home ... start up debugger. */ |
njn | c616819 | 2004-11-29 13:54:10 +0000 | [diff] [blame] | 771 | extern void VG_(start_debugger) ( ThreadId tid ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 772 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 773 | /* Counts downwards in vg_run_innerloop. */ |
| 774 | extern UInt VG_(dispatch_ctr); |
| 775 | |
sewardj | 4ccf707 | 2004-11-28 16:58:05 +0000 | [diff] [blame] | 776 | /* Stats ... */ |
nethercote | 844e712 | 2004-08-02 15:27:22 +0000 | [diff] [blame] | 777 | extern void VG_(print_scheduler_stats) ( void ); |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 778 | |
sewardj | 51ac087 | 2004-12-21 01:20:49 +0000 | [diff] [blame] | 779 | /* Indicates what arch and subarch we are running on. */ |
| 780 | extern VexArch VG_(vex_arch); |
| 781 | extern VexSubArch VG_(vex_subarch); |
| 782 | |
njn | 1f70772 | 2005-03-27 03:17:52 +0000 | [diff] [blame] | 783 | /* 64-bit counter for the number of basic blocks done. */ |
| 784 | extern ULong VG_(bbs_done); |
| 785 | |
nethercote | 2e05c33 | 2004-09-06 16:43:37 +0000 | [diff] [blame] | 786 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 787 | /* --------------------------------------------------------------------- |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 788 | Exports of vg_transtab.c |
| 789 | ------------------------------------------------------------------ */ |
| 790 | |
sewardj | fa8ec11 | 2005-01-19 11:55:34 +0000 | [diff] [blame] | 791 | /* The fast-cache for tt-lookup, and for finding counters. */ |
| 792 | extern ULong* VG_(tt_fast) [VG_TT_FAST_SIZE]; |
| 793 | extern UInt* VG_(tt_fastN)[VG_TT_FAST_SIZE]; |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 794 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 795 | |
nethercote | 92e7b7f | 2004-08-07 17:52:25 +0000 | [diff] [blame] | 796 | extern void VG_(init_tt_tc) ( void ); |
sewardj | 6c3769f | 2002-11-29 01:02:45 +0000 | [diff] [blame] | 797 | |
sewardj | fa8ec11 | 2005-01-19 11:55:34 +0000 | [diff] [blame] | 798 | extern |
| 799 | void VG_(add_to_trans_tab)( VexGuestExtents* vge, |
| 800 | Addr64 entry, |
| 801 | AddrH code, |
| 802 | UInt code_len ); |
| 803 | |
| 804 | extern Bool VG_(search_transtab) ( /*OUT*/AddrH* result, |
| 805 | Addr64 guest_addr, |
| 806 | Bool upd_cache ); |
| 807 | |
| 808 | extern void VG_(discard_translations) ( Addr64 start, UInt range ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 809 | |
sewardj | 4ccf707 | 2004-11-28 16:58:05 +0000 | [diff] [blame] | 810 | extern void VG_(sanity_check_tt_tc) ( Char* caller ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 811 | |
nethercote | 92e7b7f | 2004-08-07 17:52:25 +0000 | [diff] [blame] | 812 | extern void VG_(print_tt_tc_stats) ( void ); |
| 813 | |
sewardj | fa8ec11 | 2005-01-19 11:55:34 +0000 | [diff] [blame] | 814 | extern UInt VG_(get_bbs_translated) ( void ); |
| 815 | |
| 816 | extern void VG_(show_BB_profile) ( void ); |
| 817 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 818 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 819 | /* --------------------------------------------------------------------- |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 820 | Exports of vg_syscall.S |
| 821 | ------------------------------------------------------------------ */ |
| 822 | |
njn | ca6fef0 | 2004-11-29 16:49:18 +0000 | [diff] [blame] | 823 | // We use a full prototype rather than "..." here to ensure that all |
| 824 | // arguments get converted to a UWord appropriately. Not doing so can |
| 825 | // cause problems when passing 32-bit integers on 64-bit platforms, because |
| 826 | // the top 32-bits might not be zeroed appropriately, eg. as would happen |
| 827 | // with the 6th arg on AMD64 which is passed on the stack. |
njn | f4aeaea | 2004-11-29 17:33:31 +0000 | [diff] [blame] | 828 | extern Word VG_(do_syscall) ( UInt, UWord, UWord, UWord, UWord, UWord, UWord ); |
njn | ca6fef0 | 2004-11-29 16:49:18 +0000 | [diff] [blame] | 829 | |
| 830 | // Macros make life easier. |
| 831 | #define vgPlain_do_syscall0(s) VG_(do_syscall)((s),0,0,0,0,0,0) |
| 832 | #define vgPlain_do_syscall1(s,a) VG_(do_syscall)((s),(a),0,0,0,0,0) |
| 833 | #define vgPlain_do_syscall2(s,a,b) VG_(do_syscall)((s),(a),(b),0,0,0,0) |
| 834 | #define vgPlain_do_syscall3(s,a,b,c) VG_(do_syscall)((s),(a),(b),(c),0,0,0) |
| 835 | #define vgPlain_do_syscall4(s,a,b,c,d) VG_(do_syscall)((s),(a),(b),(c),(d),0,0) |
| 836 | #define vgPlain_do_syscall5(s,a,b,c,d,e) VG_(do_syscall)((s),(a),(b),(c),(d),(e),0) |
| 837 | #define vgPlain_do_syscall6(s,a,b,c,d,e,f) VG_(do_syscall)((s),(a),(b),(c),(d),(e),(f)) |
| 838 | |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 839 | extern Int VG_(clone) ( Int (*fn)(void *), void *stack, Int flags, void *arg, |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 840 | Int *child_tid, Int *parent_tid, vki_modify_ldt_t * ); |
fitzhardinge | 4f10ada | 2004-06-03 10:00:42 +0000 | [diff] [blame] | 841 | extern void VG_(sigreturn)(void); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 842 | |
| 843 | /* --------------------------------------------------------------------- |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 844 | Exports of vg_dispatch.S |
| 845 | ------------------------------------------------------------------ */ |
| 846 | |
njn | d6f157d | 2004-11-30 17:27:21 +0000 | [diff] [blame] | 847 | /* This subroutine is called from the C world. It is passed |
| 848 | a pointer to the VEX guest state (arch.vex). It must run code |
| 849 | from the instruction pointer in the guest state, and exit when |
| 850 | VG_(dispatch_ctr) reaches zero, or we need to defer to the scheduler. |
| 851 | The return value must indicate why it returned back to the scheduler. |
| 852 | It can also be exited if the executing code throws a non-resumable |
| 853 | signal, for example SIGSEGV, in which case control longjmp()s back past |
| 854 | here. |
| 855 | |
| 856 | This code simply handles the common case fast -- when the translation |
| 857 | address is found in the translation cache. For anything else, the |
| 858 | scheduler does the work. |
| 859 | */ |
sewardj | 0312f51 | 2005-03-30 19:04:29 +0000 | [diff] [blame] | 860 | extern UWord VG_(run_innerloop) ( void* guest_state ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 861 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 862 | /* --------------------------------------------------------------------- |
| 863 | Exports of vg_helpers.S |
| 864 | ------------------------------------------------------------------ */ |
| 865 | |
fitzhardinge | 9236079 | 2003-12-24 10:11:11 +0000 | [diff] [blame] | 866 | /* Information about trampoline code (for signal return and syscalls) */ |
| 867 | extern const Char VG_(trampoline_code_start); |
| 868 | extern const Int VG_(trampoline_code_length); |
| 869 | extern const Int VG_(tramp_sigreturn_offset); |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 870 | extern const Int VG_(tramp_rt_sigreturn_offset); |
fitzhardinge | 9236079 | 2003-12-24 10:11:11 +0000 | [diff] [blame] | 871 | extern const Int VG_(tramp_syscall_offset); |
tom | ee0bcbf | 2005-05-02 10:28:42 +0000 | [diff] [blame] | 872 | extern const Int VG_(tramp_gettimeofday_offset); |
| 873 | extern const Int VG_(tramp_time_offset); |
sewardj | 20917d8 | 2002-05-28 01:36:45 +0000 | [diff] [blame] | 874 | |
nethercote | c06e213 | 2004-09-03 13:45:29 +0000 | [diff] [blame] | 875 | // --------------------------------------------------------------------- |
| 876 | // Architecture-specific things defined in eg. x86/*.c |
| 877 | // --------------------------------------------------------------------- |
| 878 | |
sewardj | 51ac087 | 2004-12-21 01:20:49 +0000 | [diff] [blame] | 879 | // Returns the architecture and subarchitecture, or indicates |
| 880 | // that this subarchitecture is unable to run Valgrind |
| 881 | // Returns False to indicate we cannot proceed further. |
sewardj | 51ac087 | 2004-12-21 01:20:49 +0000 | [diff] [blame] | 882 | extern Bool VGA_(getArchAndSubArch)( /*OUT*/VexArch*, |
| 883 | /*OUT*/VexSubArch* ); |
njn | cf45fd4 | 2004-11-24 16:30:22 +0000 | [diff] [blame] | 884 | // Accessors for the ThreadArchState |
njn | 35172bc | 2005-03-26 00:04:03 +0000 | [diff] [blame] | 885 | #define INSTR_PTR(regs) ((regs).vex.VGA_INSTR_PTR) |
| 886 | #define STACK_PTR(regs) ((regs).vex.VGA_STACK_PTR) |
| 887 | #define FRAME_PTR(regs) ((regs).vex.VGA_FRAME_PTR) |
| 888 | #define CLREQ_ARGS(regs) ((regs).vex.VGA_CLREQ_ARGS) |
njn | 35172bc | 2005-03-26 00:04:03 +0000 | [diff] [blame] | 889 | #define CLREQ_RET(regs) ((regs).vex.VGA_CLREQ_RET) |
njn | 16de557 | 2004-11-27 14:27:21 +0000 | [diff] [blame] | 890 | // Offsets for the Vex state |
njn | 35172bc | 2005-03-26 00:04:03 +0000 | [diff] [blame] | 891 | #define O_STACK_PTR (offsetof(VexGuestArchState, VGA_STACK_PTR)) |
| 892 | #define O_FRAME_PTR (offsetof(VexGuestArchState, VGA_FRAME_PTR)) |
| 893 | #define O_CLREQ_RET (offsetof(VexGuestArchState, VGA_CLREQ_RET)) |
njn | cf45fd4 | 2004-11-24 16:30:22 +0000 | [diff] [blame] | 894 | |
| 895 | |
sewardj | 2a99cf6 | 2004-11-24 10:44:19 +0000 | [diff] [blame] | 896 | // Setting up the initial thread (1) state |
| 897 | extern void |
| 898 | VGA_(init_thread1state) ( Addr client_eip, |
| 899 | Addr esp_at_startup, |
| 900 | /*MOD*/ ThreadArchState* arch ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 901 | |
nethercote | c009ebe | 2004-09-13 11:05:11 +0000 | [diff] [blame] | 902 | // Thread stuff |
sewardj | 2a99cf6 | 2004-11-24 10:44:19 +0000 | [diff] [blame] | 903 | extern void VGA_(cleanup_thread) ( ThreadArchState* ); |
| 904 | extern void VGA_(setup_child) ( ThreadArchState*, ThreadArchState* ); |
nethercote | f9b5941 | 2004-09-10 15:33:32 +0000 | [diff] [blame] | 905 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 906 | // OS/Platform-specific thread clear (after thread exit) |
| 907 | extern void VGA_(os_state_clear)(ThreadState *); |
| 908 | |
| 909 | // OS/Platform-specific thread init (at scheduler init time) |
| 910 | extern void VGA_(os_state_init)(ThreadState *); |
| 911 | |
| 912 | // 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] | 913 | void VGA_(thread_wrapper)(Word /*ThreadId*/ tid); |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 914 | |
| 915 | // Like VGA_(thread_wrapper), but it allocates a stack before calling |
| 916 | // to VGA_(thread_wrapper) on that stack, as if it had been set up by |
| 917 | // clone() |
| 918 | void VGA_(main_thread_wrapper)(ThreadId tid) __attribute__ ((__noreturn__)); |
| 919 | |
| 920 | // Return how many bytes of a thread's Valgrind stack are unused |
njn | 990e90c | 2005-04-05 02:49:09 +0000 | [diff] [blame] | 921 | SSizeT VGA_(stack_unused)(ThreadId tid); |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 922 | |
| 923 | // Terminate the process. Does not return. |
| 924 | void VGA_(terminate)(ThreadId tid, VgSchedReturnCode src) __attribute__((__noreturn__)); |
| 925 | |
| 926 | // wait until all other threads are dead |
| 927 | extern void VGA_(reap_threads)(ThreadId self); |
| 928 | |
| 929 | // handle an arch-specific client request |
| 930 | extern Bool VGA_(client_request)(ThreadId tid, UWord *args); |
| 931 | |
nethercote | c009ebe | 2004-09-13 11:05:11 +0000 | [diff] [blame] | 932 | // Symtab stuff |
njn | cf45fd4 | 2004-11-24 16:30:22 +0000 | [diff] [blame] | 933 | extern UInt* VGA_(reg_addr_from_tst) ( Int regno, ThreadArchState* ); |
nethercote | cd65604 | 2004-09-11 23:48:22 +0000 | [diff] [blame] | 934 | |
nethercote | fedd810 | 2004-09-13 15:19:34 +0000 | [diff] [blame] | 935 | // Pointercheck |
| 936 | extern Bool VGA_(setup_pointercheck) ( void ); |
| 937 | |
| 938 | // For attaching the debugger |
sewardj | 2a99cf6 | 2004-11-24 10:44:19 +0000 | [diff] [blame] | 939 | extern Int VGA_(ptrace_setregs_from_tst) ( Int pid, ThreadArchState* arch ); |
nethercote | fedd810 | 2004-09-13 15:19:34 +0000 | [diff] [blame] | 940 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 941 | // Used by leakcheck |
| 942 | extern void VGA_(mark_from_registers)(ThreadId tid, void (*marker)(Addr)); |
| 943 | |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 944 | ////typedef struct _ThreadArchAux ThreadArchAux; |
nethercote | 9b3c765 | 2004-10-19 13:18:00 +0000 | [diff] [blame] | 945 | |
| 946 | |
nethercote | 41c75da | 2004-10-18 15:34:14 +0000 | [diff] [blame] | 947 | // --------------------------------------------------------------------- |
| 948 | // Platform-specific things defined in eg. x86/*.c |
| 949 | // --------------------------------------------------------------------- |
nethercote | 775508a | 2004-09-07 22:38:23 +0000 | [diff] [blame] | 950 | |
njn | 2521d32 | 2005-05-08 14:45:13 +0000 | [diff] [blame] | 951 | // Do any platform specific redirects. |
tom | 748a131 | 2005-04-02 15:53:01 +0000 | [diff] [blame] | 952 | extern void VGP_(setup_redirects)(void); |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 953 | |
| 954 | ///* --------------------------------------------------------------------- |
| 955 | // Thread modelling |
| 956 | // ------------------------------------------------------------------ */ |
| 957 | //extern void VG_(tm_thread_create) (ThreadId creator, ThreadId tid, Bool detached); |
| 958 | //extern void VG_(tm_thread_exit) (ThreadId tid); |
| 959 | //extern Bool VG_(tm_thread_exists) (ThreadId tid); |
| 960 | //extern void VG_(tm_thread_detach) (ThreadId tid); |
| 961 | //extern void VG_(tm_thread_join) (ThreadId joiner, ThreadId joinee); |
| 962 | //extern void VG_(tm_thread_switchto)(ThreadId tid); |
| 963 | // |
| 964 | //extern void VG_(tm_mutex_init) (ThreadId tid, Addr mutexp); |
| 965 | //extern void VG_(tm_mutex_destroy)(ThreadId tid, Addr mutexp); |
| 966 | //extern void VG_(tm_mutex_trylock)(ThreadId tid, Addr mutexp); |
| 967 | //extern void VG_(tm_mutex_giveup) (ThreadId tid, Addr mutexp); |
| 968 | //extern void VG_(tm_mutex_acquire)(ThreadId tid, Addr mutexp); |
| 969 | //extern void VG_(tm_mutex_tryunlock)(ThreadId tid, Addr mutexp); |
| 970 | //extern void VG_(tm_mutex_unlock) (ThreadId tid, Addr mutexp); |
| 971 | //extern Bool VG_(tm_mutex_exists) (Addr mutexp); |
| 972 | // |
| 973 | //extern UInt VG_(tm_error_update_extra) (Error *err); |
| 974 | //extern Bool VG_(tm_error_equal) (VgRes res, Error *e1, Error *e2); |
| 975 | //extern void VG_(tm_error_print) (Error *err); |
| 976 | // |
| 977 | //extern void VG_(tm_init) (); |
| 978 | // |
| 979 | //extern void VG_(tm_cond_init) (ThreadId tid, Addr condp); |
| 980 | //extern void VG_(tm_cond_destroy) (ThreadId tid, Addr condp); |
| 981 | //extern void VG_(tm_cond_wait) (ThreadId tid, Addr condp, Addr mutexp); |
| 982 | //extern void VG_(tm_cond_wakeup) (ThreadId tid, Addr condp, Addr mutexp); |
| 983 | //extern void VG_(tm_cond_signal) (ThreadId tid, Addr condp); |
| 984 | // |
| 985 | ///* ----- pthreads ----- */ |
| 986 | //extern void VG_(pthread_init) (); |
| 987 | //extern void VG_(pthread_startfunc_wrapper)(Addr wrapper); |
| 988 | // |
| 989 | //struct vg_pthread_newthread_data { |
| 990 | // void *(*startfunc)(void *arg); |
| 991 | // void *arg; |
| 992 | //}; |
sewardj | 3b2736a | 2002-03-24 12:18:35 +0000 | [diff] [blame] | 993 | |
| 994 | /* --------------------------------------------------------------------- |
| 995 | Finally - autoconf-generated settings |
| 996 | ------------------------------------------------------------------ */ |
| 997 | |
| 998 | #include "config.h" |
| 999 | |
nethercote | c06e213 | 2004-09-03 13:45:29 +0000 | [diff] [blame] | 1000 | #endif /* ndef __CORE_H */ |
| 1001 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1002 | /*--------------------------------------------------------------------*/ |
nethercote | 109d0df | 2004-09-02 08:10:13 +0000 | [diff] [blame] | 1003 | /*--- end ---*/ |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1004 | /*--------------------------------------------------------------------*/ |