sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1 | |
| 2 | /*--------------------------------------------------------------------*/ |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 3 | /*--- A header file for all private parts of Valgrind's core. ---*/ |
nethercote | 5a2664c | 2004-09-02 15:37:39 +0000 | [diff] [blame] | 4 | /*--- Include no other! (more or less...) ---*/ |
rjwalsh | 7109a8c | 2004-09-02 00:31:02 +0000 | [diff] [blame] | 5 | /*--- core.h ---*/ |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 6 | /*--------------------------------------------------------------------*/ |
| 7 | |
| 8 | /* |
njn | c953984 | 2002-10-02 13:26:35 +0000 | [diff] [blame] | 9 | This file is part of Valgrind, an extensible x86 protected-mode |
| 10 | emulator for monitoring program execution on x86-Unixes. |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 11 | |
nethercote | bb1c991 | 2004-01-04 16:43:23 +0000 | [diff] [blame] | 12 | Copyright (C) 2000-2004 Julian Seward |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 13 | jseward@acm.org |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 14 | |
| 15 | This program is free software; you can redistribute it and/or |
| 16 | modify it under the terms of the GNU General Public License as |
| 17 | published by the Free Software Foundation; either version 2 of the |
| 18 | License, or (at your option) any later version. |
| 19 | |
| 20 | This program is distributed in the hope that it will be useful, but |
| 21 | WITHOUT ANY WARRANTY; without even the implied warranty of |
| 22 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| 23 | General Public License for more details. |
| 24 | |
| 25 | You should have received a copy of the GNU General Public License |
| 26 | along with this program; if not, write to the Free Software |
| 27 | Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA |
| 28 | 02111-1307, USA. |
| 29 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 30 | The GNU General Public License is contained in the file COPYING. |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 31 | */ |
| 32 | |
rjwalsh | 7109a8c | 2004-09-02 00:31:02 +0000 | [diff] [blame] | 33 | #ifndef __CORE_H |
| 34 | #define __CORE_H |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 35 | |
nethercote | 7be4725 | 2004-09-02 16:02:58 +0000 | [diff] [blame] | 36 | /* |
| 37 | Header hierarchy: |
| 38 | |
| 39 | - core C files include core.h |
| 40 | - core asm files include core_asm.h |
| 41 | - tool C files include tool.h |
| 42 | - tool asm files include tool_asm.h |
| 43 | |
| 44 | - The hierarchy of the header files themselves is based around the |
| 45 | following rules: |
| 46 | |
| 47 | - core headers include tool headers |
| 48 | - generic headers include arch/OS/platform headers |
| 49 | - C headers include asm headers |
| 50 | |
| 51 | This gives the following hierarchy (only showing 'arch' headers, not |
nethercote | 80cca43 | 2004-09-02 16:25:49 +0000 | [diff] [blame] | 52 | 'os' or 'platform' headers), where arrows indicate inclusion, and |
| 53 | $VG_ARCH==x86: |
nethercote | 7be4725 | 2004-09-02 16:02:58 +0000 | [diff] [blame] | 54 | |
nethercote | 80cca43 | 2004-09-02 16:25:49 +0000 | [diff] [blame] | 55 | |
| 56 | (include/x86/tool_arch_asm.h?) <----- coregrind/x86/core_arch_asm.h |
| 57 | ^ ^ ^ ^ |
| 58 | / \ / \ |
| 59 | / \ / \ |
| 60 | / \ / \ |
| 61 | include/tool_asm.h <-\---- coregrind/core_asm.h \ |
| 62 | ^ \ ^ \ |
| 63 | \ include/x86/tool_arch.h <--------coregrind/x86/core_arch.h |
| 64 | \ ^ \ ^ |
| 65 | \ / \ / |
| 66 | \ / \ / |
| 67 | \ / \ / |
| 68 | include/tool.h <------------ coregrind/core.h |
| 69 | |
nethercote | 7be4725 | 2004-09-02 16:02:58 +0000 | [diff] [blame] | 70 | |
| 71 | Note that core.h contains the *declarations* of arch-specific functions |
| 72 | and variables, which can be used by the core_arch.h file of any |
| 73 | architecture. (The functions/variables are *defined* within arch/.) |
| 74 | However, arch-specific macros and types cannot go into core.h, because |
| 75 | there is no separation between declaration and definition for |
| 76 | macros/types, so they instead go into $VG_ARCH/core_arch.h. |
nethercote | 80cca43 | 2004-09-02 16:25:49 +0000 | [diff] [blame] | 77 | |
| 78 | The tool-specific headers are all in include/ so they can be seen by any |
| 79 | external tools. |
nethercote | 7be4725 | 2004-09-02 16:02:58 +0000 | [diff] [blame] | 80 | */ |
| 81 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 82 | |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 83 | /* For system call numbers __NR_... */ |
nethercote | f94fe2f | 2004-09-10 14:23:59 +0000 | [diff] [blame] | 84 | #include "vki_unistd.h" |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 85 | |
nethercote | 1334313 | 2004-09-02 15:49:09 +0000 | [diff] [blame] | 86 | #include "core_asm.h" // asm stuff |
| 87 | #include "tool.h" // tool stuff |
nethercote | bb4222b | 2004-09-10 17:42:11 +0000 | [diff] [blame] | 88 | #include "core_arch.h" // arch-specific stuff, eg. x86/core_arch.h |
| 89 | #include "core_platform.h" // platform-specific stuff, |
| 90 | // eg. x86-linux/core_platform.h |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 91 | |
fitzhardinge | 39de4b4 | 2003-10-31 07:12:21 +0000 | [diff] [blame] | 92 | #include "valgrind.h" |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 93 | |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 94 | #undef SK_ |
| 95 | #define SK_(x) vgSkinInternal_##x |
| 96 | |
nethercote | 7be4725 | 2004-09-02 16:02:58 +0000 | [diff] [blame] | 97 | |
| 98 | /* --------------------------------------------------------------------- |
| 99 | Build options and table sizes. You should be able to change these |
| 100 | options or sizes, recompile, and still have a working system. |
| 101 | ------------------------------------------------------------------ */ |
| 102 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 103 | /* Constants for the slow translation lookup cache. */ |
| 104 | #define VG_TRANSTAB_SLOW_BITS 11 |
| 105 | #define VG_TRANSTAB_SLOW_SIZE (1 << VG_TRANSTAB_SLOW_BITS) |
| 106 | #define VG_TRANSTAB_SLOW_MASK ((VG_TRANSTAB_SLOW_SIZE) - 1) |
| 107 | |
| 108 | /* Size of a buffer used for creating messages. */ |
| 109 | #define M_VG_MSGBUF 10000 |
| 110 | |
| 111 | /* Size of a smallish table used to read /proc/self/map entries. */ |
sewardj | ebc8233 | 2002-04-24 14:44:23 +0000 | [diff] [blame] | 112 | #define M_PROCMAP_BUF 50000 |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 113 | |
| 114 | /* Max length of pathname to a .so/executable file. */ |
| 115 | #define M_VG_LIBNAMESTR 100 |
| 116 | |
| 117 | /* Max length of a text fragment used to construct error messages. */ |
nethercote | 3b38c1d | 2004-10-18 15:47:18 +0000 | [diff] [blame] | 118 | #define M_VG_ERRTXT 4096 |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 119 | |
| 120 | /* Max length of the string copied from env var VG_ARGS at startup. */ |
| 121 | #define M_VG_CMDLINE_STRLEN 1000 |
| 122 | |
| 123 | /* Max number of options for Valgrind which we can handle. */ |
| 124 | #define M_VG_CMDLINE_OPTS 100 |
| 125 | |
| 126 | /* After this many different unsuppressed errors have been observed, |
| 127 | be more conservative about collecting new ones. */ |
| 128 | #define M_VG_COLLECT_ERRORS_SLOWLY_AFTER 50 |
| 129 | |
| 130 | /* After this many different unsuppressed errors have been observed, |
| 131 | stop collecting errors at all, and tell the user their program is |
| 132 | evidently a steaming pile of camel dung. */ |
sewardj | 1bebcbf | 2002-04-24 21:24:18 +0000 | [diff] [blame] | 133 | #define M_VG_COLLECT_NO_ERRORS_AFTER_SHOWN 300 |
sewardj | f2537be | 2002-04-24 21:03:47 +0000 | [diff] [blame] | 134 | |
| 135 | /* After this many total errors have been observed, stop collecting |
| 136 | errors at all. Counterpart to M_VG_COLLECT_NO_ERRORS_AFTER_SHOWN. */ |
sewardj | 1bebcbf | 2002-04-24 21:24:18 +0000 | [diff] [blame] | 137 | #define M_VG_COLLECT_NO_ERRORS_AFTER_FOUND 30000 |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 138 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 139 | /* The maximum number of calls we're prepared to save in a |
| 140 | backtrace. */ |
| 141 | #define VG_DEEPEST_BACKTRACE 50 |
| 142 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 143 | /* Number of lists in which we keep track of ExeContexts. Should be |
| 144 | prime. */ |
sewardj | 59fb25c | 2003-09-28 16:32:58 +0000 | [diff] [blame] | 145 | #define VG_N_EC_LISTS 4999 /* a prime number */ |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 146 | |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 147 | /* Defines the thread-scheduling timeslice, in terms of the number of |
| 148 | basic blocks we attempt to run each thread for. Smaller values |
| 149 | give finer interleaving but much increased scheduling overheads. */ |
sewardj | 4505b9e | 2002-05-28 11:27:31 +0000 | [diff] [blame] | 150 | #define VG_SCHEDULING_QUANTUM 50000 |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 151 | |
fitzhardinge | f0046f2 | 2003-12-18 02:39:22 +0000 | [diff] [blame] | 152 | /* Number of file descriptors that Valgrind tries to reserve for |
| 153 | it's own use - two per thread plues a small number of extras. */ |
| 154 | #define VG_N_RESERVED_FDS (VG_N_THREADS*2 + 4) |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 155 | |
sewardj | bf290b9 | 2002-05-01 02:28:01 +0000 | [diff] [blame] | 156 | /* Stack size for a thread. We try and check that they do not go |
| 157 | beyond it. */ |
sewardj | f0b0645 | 2002-06-04 08:38:04 +0000 | [diff] [blame] | 158 | #define VG_PTHREAD_STACK_SIZE (1 << 20) |
sewardj | bf290b9 | 2002-05-01 02:28:01 +0000 | [diff] [blame] | 159 | |
sewardj | 8ad94e1 | 2002-05-29 00:10:20 +0000 | [diff] [blame] | 160 | /* Number of entries in each thread's cleanup stack. */ |
sewardj | 61821c0 | 2003-05-04 13:02:10 +0000 | [diff] [blame] | 161 | #define VG_N_CLEANUPSTACK 16 |
sewardj | 8ad94e1 | 2002-05-29 00:10:20 +0000 | [diff] [blame] | 162 | |
sewardj | 2cb0034 | 2002-06-28 01:46:26 +0000 | [diff] [blame] | 163 | /* Number of entries in each thread's fork-handler stack. */ |
sewardj | 4700f04 | 2003-07-26 17:49:58 +0000 | [diff] [blame] | 164 | #define VG_N_FORKHANDLERSTACK 4 |
sewardj | 2cb0034 | 2002-06-28 01:46:26 +0000 | [diff] [blame] | 165 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 166 | /* Max number of callers for context in a suppression. */ |
| 167 | #define VG_N_SUPP_CALLERS 4 |
sewardj | 73cf3bc | 2002-11-03 03:20:15 +0000 | [diff] [blame] | 168 | |
thughes | 8abf392 | 2004-10-16 10:59:49 +0000 | [diff] [blame] | 169 | /* Numer of entries in each thread's signal queue. */ |
| 170 | #define VG_N_SIGNALQUEUE 8 |
| 171 | |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 172 | /* Useful macros */ |
| 173 | /* a - alignment - must be a power of 2 */ |
| 174 | #define ROUNDDN(p, a) ((Addr)(p) & ~((a)-1)) |
| 175 | #define ROUNDUP(p, a) ROUNDDN((p)+(a)-1, (a)) |
nethercote | 73b526f | 2004-10-31 18:48:21 +0000 | [diff] [blame] | 176 | #define PGROUNDDN(p) ROUNDDN(p, VKI_PAGE_SIZE) |
| 177 | #define PGROUNDUP(p) ROUNDUP(p, VKI_PAGE_SIZE) |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 178 | |
nethercote | 80013e9 | 2004-09-05 20:39:51 +0000 | [diff] [blame] | 179 | /* --------------------------------------------------------------------- |
| 180 | Environment variables |
| 181 | ------------------------------------------------------------------ */ |
| 182 | |
| 183 | /* The directory we look for all our auxillary files in */ |
| 184 | #define VALGRINDLIB "VALGRINDLIB" |
| 185 | |
| 186 | /* Additional command-line arguments; they are overridden by actual |
| 187 | command-line option. Each argument is separated by spaces. There |
| 188 | is no quoting mechanism. |
| 189 | */ |
| 190 | #define VALGRINDOPTS "VALGRIND_OPTS" |
| 191 | |
| 192 | /* If this variable is present in the environment, then valgrind will |
| 193 | not parse the command line for options at all; all options come |
| 194 | from this variable. Arguments are terminated by ^A (\001). There |
| 195 | is no quoting mechanism. |
| 196 | |
| 197 | This variable is not expected to be set by anything other than |
| 198 | Valgrind itself, as part of its handling of execve with |
| 199 | --trace-children=yes. This variable should not be present in the |
| 200 | client environment. |
| 201 | */ |
| 202 | #define VALGRINDCLO "_VALGRIND_CLO" |
| 203 | |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 204 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 205 | /* --------------------------------------------------------------------- |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 206 | Command-line-settable options |
| 207 | ------------------------------------------------------------------ */ |
| 208 | |
sewardj | 4f094a7 | 2002-11-05 23:37:35 +0000 | [diff] [blame] | 209 | /* Default destination port to be used in logging over a network, if |
| 210 | none specified. */ |
| 211 | #define VG_CLO_DEFAULT_LOGPORT 1500 |
sewardj | 73cf3bc | 2002-11-03 03:20:15 +0000 | [diff] [blame] | 212 | |
| 213 | /* The max number of suppression files. */ |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 214 | #define VG_CLO_MAX_SFILES 10 |
| 215 | |
nethercote | 04d0fbc | 2004-01-26 16:48:06 +0000 | [diff] [blame] | 216 | /* Default debugger command. */ |
| 217 | #define VG_CLO_DEFAULT_DBCOMMAND GDB_PATH " -nw %f %p" |
| 218 | |
sewardj | 4cf0569 | 2002-10-27 20:28:29 +0000 | [diff] [blame] | 219 | /* Describes where logging output is to be sent. */ |
| 220 | typedef |
| 221 | enum { |
| 222 | VgLogTo_Fd, |
| 223 | VgLogTo_File, |
| 224 | VgLogTo_Socket |
| 225 | } VgLogTo; |
| 226 | |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 227 | /* pid of main process */ |
| 228 | extern Int VG_(main_pid); |
| 229 | |
| 230 | /* pgrp of process (global to all threads) */ |
| 231 | extern Int VG_(main_pgrp); |
sewardj | 4cf0569 | 2002-10-27 20:28:29 +0000 | [diff] [blame] | 232 | |
thughes | ad1c956 | 2004-06-26 11:27:52 +0000 | [diff] [blame] | 233 | /* Application-visible file descriptor limits */ |
| 234 | extern Int VG_(fd_soft_limit); |
| 235 | extern Int VG_(fd_hard_limit); |
fitzhardinge | f0046f2 | 2003-12-18 02:39:22 +0000 | [diff] [blame] | 236 | |
sewardj | 72f98ff | 2002-06-13 17:23:38 +0000 | [diff] [blame] | 237 | /* Should we stop collecting errors if too many appear? default: YES */ |
sewardj | 2e43290 | 2002-06-13 20:44:00 +0000 | [diff] [blame] | 238 | extern Bool VG_(clo_error_limit); |
nethercote | 04d0fbc | 2004-01-26 16:48:06 +0000 | [diff] [blame] | 239 | /* Enquire about whether to attach to a debugger at errors? default: NO */ |
| 240 | extern Bool VG_(clo_db_attach); |
| 241 | /* The debugger command? default: whatever gdb ./configure found */ |
| 242 | extern Char* VG_(clo_db_command); |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 243 | /* Enquire about generating a suppression for each error? default: NO */ |
| 244 | extern Bool VG_(clo_gen_suppressions); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 245 | /* Sanity-check level: 0 = none, 1 (default), > 1 = expensive. */ |
nethercote | 27fec90 | 2004-06-16 21:26:32 +0000 | [diff] [blame] | 246 | extern Int VG_(clo_sanity_level); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 247 | /* Automatically attempt to demangle C++ names? default: YES */ |
| 248 | extern Bool VG_(clo_demangle); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 249 | /* Simulate child processes? default: NO */ |
| 250 | extern Bool VG_(clo_trace_children); |
sewardj | 4cf0569 | 2002-10-27 20:28:29 +0000 | [diff] [blame] | 251 | |
| 252 | /* Where logging output is to be sent to. |
| 253 | |
nethercote | f854867 | 2004-06-21 12:42:35 +0000 | [diff] [blame] | 254 | When log_to == VgLogTo_Fd, clo_log_fd holds the file id, and is |
| 255 | taken from the command line. clo_log_name is irrelevant. |
sewardj | 4cf0569 | 2002-10-27 20:28:29 +0000 | [diff] [blame] | 256 | |
nethercote | f854867 | 2004-06-21 12:42:35 +0000 | [diff] [blame] | 257 | When log_to == VgLogTo_File, clo_log_name holds the log-file |
| 258 | name, and is taken from the command line. clo_log_fd is then |
| 259 | made to hold the relevant file id, by opening clo_log_name |
sewardj | 4cf0569 | 2002-10-27 20:28:29 +0000 | [diff] [blame] | 260 | (concatenated with the process ID) for writing. |
| 261 | |
nethercote | f854867 | 2004-06-21 12:42:35 +0000 | [diff] [blame] | 262 | When log_to == VgLogTo_Socket, clo_log_name holds the |
sewardj | 4cf0569 | 2002-10-27 20:28:29 +0000 | [diff] [blame] | 263 | hostname:portnumber pair, and is taken from the command line. |
nethercote | f854867 | 2004-06-21 12:42:35 +0000 | [diff] [blame] | 264 | clo_log_fd is then made to hold the relevant file handle, by |
sewardj | 4cf0569 | 2002-10-27 20:28:29 +0000 | [diff] [blame] | 265 | opening a connection to said hostname:portnumber pair. |
| 266 | |
nethercote | f854867 | 2004-06-21 12:42:35 +0000 | [diff] [blame] | 267 | Global default is to set log_to == VgLogTo_Fd and log_fd == 2 |
sewardj | 4cf0569 | 2002-10-27 20:28:29 +0000 | [diff] [blame] | 268 | (stderr). */ |
| 269 | extern VgLogTo VG_(clo_log_to); |
nethercote | f854867 | 2004-06-21 12:42:35 +0000 | [diff] [blame] | 270 | extern Int VG_(clo_log_fd); |
| 271 | extern Char* VG_(clo_log_name); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 272 | |
thughes | 6233a38 | 2004-08-21 11:10:44 +0000 | [diff] [blame] | 273 | /* Add timestamps to log messages? default: NO */ |
| 274 | extern Bool VG_(clo_time_stamp); |
| 275 | |
sewardj | 6024b21 | 2003-07-13 10:54:33 +0000 | [diff] [blame] | 276 | /* The file descriptor to read for input. default: 0 == stdin */ |
| 277 | extern Int VG_(clo_input_fd); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 278 | /* The number of suppression files specified. */ |
| 279 | extern Int VG_(clo_n_suppressions); |
| 280 | /* The names of the suppression files. */ |
| 281 | extern Char* VG_(clo_suppressions)[VG_CLO_MAX_SFILES]; |
| 282 | |
| 283 | /* Single stepping? default: NO */ |
| 284 | extern Bool VG_(clo_single_step); |
| 285 | /* Code improvement? default: YES */ |
| 286 | extern Bool VG_(clo_optimise); |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 287 | /* DEBUG: print generated code? default: 00000 ( == NO ) */ |
| 288 | extern Bool VG_(clo_trace_codegen); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 289 | /* DEBUG: print system calls? default: NO */ |
| 290 | extern Bool VG_(clo_trace_syscalls); |
| 291 | /* DEBUG: print signal details? default: NO */ |
| 292 | extern Bool VG_(clo_trace_signals); |
| 293 | /* DEBUG: print symtab details? default: NO */ |
| 294 | extern Bool VG_(clo_trace_symtab); |
sewardj | 8937c81 | 2002-04-12 20:12:20 +0000 | [diff] [blame] | 295 | /* DEBUG: print thread scheduling events? default: NO */ |
| 296 | extern Bool VG_(clo_trace_sched); |
sewardj | 45b4b37 | 2002-04-16 22:50:32 +0000 | [diff] [blame] | 297 | /* DEBUG: print pthread (mutex etc) events? default: 0 (none), 1 |
| 298 | (some), 2 (all) */ |
| 299 | extern Int VG_(clo_trace_pthread_level); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 300 | /* Display gory details for the k'th most popular error. default: |
| 301 | Infinity. */ |
| 302 | extern Int VG_(clo_dump_error); |
| 303 | /* Number of parents of a backtrace. Default: 8. */ |
| 304 | extern Int VG_(clo_backtrace_size); |
daywalker | 7e73e5f | 2003-07-04 16:18:15 +0000 | [diff] [blame] | 305 | /* Engage miscellaneous weird hacks needed for some progs. */ |
sewardj | 8d365b5 | 2002-05-12 10:52:16 +0000 | [diff] [blame] | 306 | extern Char* VG_(clo_weird_hacks); |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 307 | /* How often we should poll for signals, assuming we need to poll for |
| 308 | signals. */ |
| 309 | extern Int VG_(clo_signal_polltime); |
| 310 | |
| 311 | /* Low latency syscalls and signals */ |
| 312 | extern Bool VG_(clo_lowlat_syscalls); |
| 313 | extern Bool VG_(clo_lowlat_signals); |
| 314 | |
rjwalsh | f5f536f | 2003-11-17 17:45:00 +0000 | [diff] [blame] | 315 | /* Track open file descriptors? */ |
| 316 | extern Bool VG_(clo_track_fds); |
| 317 | |
sewardj | 858964b | 2002-10-05 14:15:43 +0000 | [diff] [blame] | 318 | /* Should we run __libc_freeres at exit? Sometimes causes crashes. |
| 319 | Default: YES. Note this is subservient to VG_(needs).libc_freeres; |
| 320 | if the latter says False, then the setting of VG_(clo_weird_hacks) |
nethercote | 996901a | 2004-08-03 13:29:09 +0000 | [diff] [blame] | 321 | 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] | 322 | cannot be overridden from the command line. */ |
| 323 | extern Bool VG_(clo_run_libc_freeres); |
sewardj | b5ff83e | 2002-12-01 19:40:49 +0000 | [diff] [blame] | 324 | /* Use the basic-block chaining optimisation? Default: YES */ |
sewardj | 22854b9 | 2002-11-30 14:00:47 +0000 | [diff] [blame] | 325 | extern Bool VG_(clo_chain_bb); |
fitzhardinge | 462f4f9 | 2003-12-18 02:10:54 +0000 | [diff] [blame] | 326 | /* Generate branch-prediction hints? */ |
| 327 | extern Bool VG_(clo_branchpred); |
nethercote | 77eba60 | 2003-11-13 17:35:04 +0000 | [diff] [blame] | 328 | /* Continue stack traces below main()? Default: NO */ |
| 329 | extern Bool VG_(clo_show_below_main); |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 330 | /* Test each client pointer dereference to check it's within the |
| 331 | client address space bounds */ |
| 332 | extern Bool VG_(clo_pointercheck); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 333 | |
rjwalsh | e4e779d | 2004-04-16 23:02:29 +0000 | [diff] [blame] | 334 | /* Set up the libc freeres wrapper */ |
| 335 | extern void VG_(intercept_libc_freeres_wrapper)(Addr); |
| 336 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 337 | /* --------------------------------------------------------------------- |
nethercote | 85cdd34 | 2004-08-01 22:36:40 +0000 | [diff] [blame] | 338 | Profiling stuff |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 339 | ------------------------------------------------------------------ */ |
| 340 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 341 | extern void VGP_(init_profiling) ( void ); |
| 342 | extern void VGP_(done_profiling) ( void ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 343 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 344 | #undef VGP_PUSHCC |
| 345 | #undef VGP_POPCC |
| 346 | #define VGP_PUSHCC(x) if (VG_(clo_profile)) VGP_(pushcc)(x) |
| 347 | #define VGP_POPCC(x) if (VG_(clo_profile)) VGP_(popcc)(x) |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 348 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 349 | /* --------------------------------------------------------------------- |
nethercote | 996901a | 2004-08-03 13:29:09 +0000 | [diff] [blame] | 350 | Tool-related types |
njn | 810086f | 2002-11-14 12:42:47 +0000 | [diff] [blame] | 351 | ------------------------------------------------------------------ */ |
nethercote | 996901a | 2004-08-03 13:29:09 +0000 | [diff] [blame] | 352 | /* These structs are not exposed to tools to mitigate possibility of |
| 353 | binary-incompatibilities when the core/tool interface changes. Instead, |
nethercote | 4606320 | 2004-09-02 08:51:43 +0000 | [diff] [blame] | 354 | set functions are provided (see include/tool.h). */ |
njn | 810086f | 2002-11-14 12:42:47 +0000 | [diff] [blame] | 355 | typedef |
| 356 | struct { |
| 357 | Char* name; |
| 358 | Char* version; |
| 359 | Char* description; |
| 360 | Char* copyright_author; |
| 361 | Char* bug_reports_to; |
njn | 120281f | 2003-02-03 12:20:07 +0000 | [diff] [blame] | 362 | UInt avg_translation_sizeB; |
njn | 810086f | 2002-11-14 12:42:47 +0000 | [diff] [blame] | 363 | } |
| 364 | VgDetails; |
| 365 | |
| 366 | extern VgDetails VG_(details); |
| 367 | |
| 368 | /* If new fields are added to this type, update: |
| 369 | * - vg_main.c:initialisation of VG_(needs) |
| 370 | * - vg_main.c:sanity_check_needs() |
| 371 | * |
| 372 | * If the name of this type or any of its fields change, update: |
| 373 | * - dependent comments (just search for "VG_(needs)"). |
| 374 | */ |
| 375 | typedef |
| 376 | struct { |
| 377 | Bool libc_freeres; |
| 378 | Bool core_errors; |
njn | 810086f | 2002-11-14 12:42:47 +0000 | [diff] [blame] | 379 | Bool skin_errors; |
| 380 | Bool basic_block_discards; |
| 381 | Bool shadow_regs; |
| 382 | Bool command_line_options; |
| 383 | Bool client_requests; |
| 384 | Bool extended_UCode; |
| 385 | Bool syscall_wrapper; |
njn | 810086f | 2002-11-14 12:42:47 +0000 | [diff] [blame] | 386 | Bool sanity_checks; |
| 387 | Bool data_syms; |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 388 | Bool shadow_memory; |
njn | 810086f | 2002-11-14 12:42:47 +0000 | [diff] [blame] | 389 | } |
| 390 | VgNeeds; |
| 391 | |
| 392 | extern VgNeeds VG_(needs); |
| 393 | |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 394 | extern void VG_(tool_init_dlsym)(void *dlhandle); |
njn | 810086f | 2002-11-14 12:42:47 +0000 | [diff] [blame] | 395 | |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 396 | #include "vg_toolint.h" |
njn | 810086f | 2002-11-14 12:42:47 +0000 | [diff] [blame] | 397 | |
| 398 | /* --------------------------------------------------------------------- |
| 399 | Exports of vg_needs.c |
| 400 | ------------------------------------------------------------------ */ |
| 401 | |
| 402 | void VG_(sanity_check_needs)(void); |
| 403 | |
| 404 | /* --------------------------------------------------------------------- |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 405 | Exports of vg_malloc2.c |
| 406 | ------------------------------------------------------------------ */ |
| 407 | |
| 408 | /* Allocation arenas. |
njn | 3e88418 | 2003-04-15 13:03:23 +0000 | [diff] [blame] | 409 | |
| 410 | CORE for the core's general use. |
nethercote | 60f5b82 | 2004-01-26 17:24:42 +0000 | [diff] [blame] | 411 | TOOL for the tool to use (and the only one it uses). |
njn | 3e88418 | 2003-04-15 13:03:23 +0000 | [diff] [blame] | 412 | SYMTAB for Valgrind's symbol table storage. |
| 413 | JITTER for small storage during translation. |
nethercote | 996901a | 2004-08-03 13:29:09 +0000 | [diff] [blame] | 414 | CLIENT for the client's mallocs/frees, if the tool replaces glibc's |
| 415 | malloc() et al -- redzone size is chosen by the tool. |
njn | 3e88418 | 2003-04-15 13:03:23 +0000 | [diff] [blame] | 416 | DEMANGLE for the C++ demangler. |
| 417 | EXECTXT for storing ExeContexts. |
| 418 | ERRORS for storing CoreErrors. |
| 419 | TRANSIENT for very short-term use. It should be empty in between uses. |
| 420 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 421 | When adding a new arena, remember also to add it to ensure_mm_init(). |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 422 | */ |
| 423 | typedef Int ArenaId; |
| 424 | |
njn | 3e88418 | 2003-04-15 13:03:23 +0000 | [diff] [blame] | 425 | #define VG_N_ARENAS 9 |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 426 | |
njn | 3e88418 | 2003-04-15 13:03:23 +0000 | [diff] [blame] | 427 | #define VG_AR_CORE 0 |
nethercote | 60f5b82 | 2004-01-26 17:24:42 +0000 | [diff] [blame] | 428 | #define VG_AR_TOOL 1 |
njn | 3e88418 | 2003-04-15 13:03:23 +0000 | [diff] [blame] | 429 | #define VG_AR_SYMTAB 2 |
| 430 | #define VG_AR_JITTER 3 |
| 431 | #define VG_AR_CLIENT 4 |
| 432 | #define VG_AR_DEMANGLE 5 |
| 433 | #define VG_AR_EXECTXT 6 |
| 434 | #define VG_AR_ERRORS 7 |
| 435 | #define VG_AR_TRANSIENT 8 |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 436 | |
nethercote | 2d5b816 | 2004-08-11 09:40:52 +0000 | [diff] [blame] | 437 | // This is both the minimum payload size of a malloc'd block, and its |
| 438 | // minimum alignment. Must be a power of 2 greater than 4, and should be |
| 439 | // greater than 8. |
| 440 | #define VG_MIN_MALLOC_SZB 8 |
| 441 | |
| 442 | // Round-up size for --sloppy-malloc=yes. |
| 443 | #define VG_SLOPPY_MALLOC_SZB 4 |
| 444 | |
nethercote | 7ac7f7b | 2004-11-02 12:36:02 +0000 | [diff] [blame] | 445 | extern void* VG_(arena_malloc) ( ArenaId arena, SizeT nbytes ); |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 446 | extern void VG_(arena_free) ( ArenaId arena, void* ptr ); |
nethercote | 7ac7f7b | 2004-11-02 12:36:02 +0000 | [diff] [blame] | 447 | extern void* VG_(arena_calloc) ( ArenaId arena, SizeT alignment, |
| 448 | SizeT nmemb, SizeT nbytes ); |
| 449 | extern void* VG_(arena_realloc) ( ArenaId arena, void* ptr, SizeT alignment, |
| 450 | SizeT size ); |
| 451 | extern void* VG_(arena_malloc_aligned) ( ArenaId aid, SizeT req_alignB, |
| 452 | SizeT req_pszB ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 453 | |
nethercote | 7ac7f7b | 2004-11-02 12:36:02 +0000 | [diff] [blame] | 454 | extern SizeT VG_(arena_payload_szB) ( ArenaId aid, void* payload ); |
njn | 8a6b6c0 | 2003-04-22 22:45:55 +0000 | [diff] [blame] | 455 | |
nethercote | 885dd91 | 2004-08-03 23:14:00 +0000 | [diff] [blame] | 456 | extern void VG_(sanity_check_malloc_all) ( void ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 457 | |
nethercote | 3a42fb8 | 2004-08-03 18:08:50 +0000 | [diff] [blame] | 458 | extern void VG_(print_all_arena_stats) ( void ); |
nethercote | 885dd91 | 2004-08-03 23:14:00 +0000 | [diff] [blame] | 459 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 460 | extern Bool VG_(is_empty_arena) ( ArenaId aid ); |
| 461 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 462 | /* --------------------------------------------------------------------- |
njn | 3e88418 | 2003-04-15 13:03:23 +0000 | [diff] [blame] | 463 | Exports of vg_intercept.c |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 464 | ------------------------------------------------------------------ */ |
| 465 | |
| 466 | /* This doesn't export code or data that valgrind.so needs to link |
| 467 | against. However, the scheduler does need to know the following |
| 468 | request codes. A few, publically-visible, request codes are also |
nethercote | 996901a | 2004-08-03 13:29:09 +0000 | [diff] [blame] | 469 | defined in valgrind.h, and similar headers for some tools. */ |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 470 | |
njn | 4c79121 | 2003-05-02 17:53:54 +0000 | [diff] [blame] | 471 | #define VG_USERREQ__MALLOC 0x2001 |
| 472 | #define VG_USERREQ__FREE 0x2002 |
| 473 | |
sewardj | 20917d8 | 2002-05-28 01:36:45 +0000 | [diff] [blame] | 474 | /* (Fn, Arg): Create a new thread and run Fn applied to Arg in it. Fn |
| 475 | MUST NOT return -- ever. Eventually it will do either __QUIT or |
| 476 | __WAIT_JOINER. */ |
| 477 | #define VG_USERREQ__APPLY_IN_NEW_THREAD 0x3001 |
| 478 | |
| 479 | /* ( no-args ): calling thread disappears from the system forever. |
| 480 | Reclaim resources. */ |
| 481 | #define VG_USERREQ__QUIT 0x3002 |
| 482 | |
| 483 | /* ( void* ): calling thread waits for joiner and returns the void* to |
| 484 | it. */ |
| 485 | #define VG_USERREQ__WAIT_JOINER 0x3003 |
| 486 | |
| 487 | /* ( ThreadId, void** ): wait to join a thread. */ |
| 488 | #define VG_USERREQ__PTHREAD_JOIN 0x3004 |
| 489 | |
| 490 | /* Set cancellation state and type for this thread. */ |
| 491 | #define VG_USERREQ__SET_CANCELSTATE 0x3005 |
| 492 | #define VG_USERREQ__SET_CANCELTYPE 0x3006 |
| 493 | |
| 494 | /* ( no-args ): Test if we are at a cancellation point. */ |
| 495 | #define VG_USERREQ__TESTCANCEL 0x3007 |
| 496 | |
| 497 | /* ( ThreadId, &thread_exit_wrapper is the only allowable arg ): call |
| 498 | with this arg to indicate that a cancel is now pending for the |
| 499 | specified thread. */ |
| 500 | #define VG_USERREQ__SET_CANCELPEND 0x3008 |
| 501 | |
| 502 | /* Set/get detach state for this thread. */ |
| 503 | #define VG_USERREQ__SET_OR_GET_DETACH 0x3009 |
| 504 | |
thughes | e321d49 | 2004-10-17 15:00:20 +0000 | [diff] [blame] | 505 | #define VG_USERREQ__PTHREAD_GET_THREADID 0x300A |
| 506 | #define VG_USERREQ__PTHREAD_MUTEX_LOCK 0x300B |
| 507 | #define VG_USERREQ__PTHREAD_MUTEX_TIMEDLOCK 0x300C |
sewardj | 20917d8 | 2002-05-28 01:36:45 +0000 | [diff] [blame] | 508 | #define VG_USERREQ__PTHREAD_MUTEX_TRYLOCK 0x300D |
| 509 | #define VG_USERREQ__PTHREAD_MUTEX_UNLOCK 0x300E |
| 510 | #define VG_USERREQ__PTHREAD_COND_WAIT 0x300F |
| 511 | #define VG_USERREQ__PTHREAD_COND_TIMEDWAIT 0x3010 |
| 512 | #define VG_USERREQ__PTHREAD_COND_SIGNAL 0x3011 |
| 513 | #define VG_USERREQ__PTHREAD_COND_BROADCAST 0x3012 |
| 514 | #define VG_USERREQ__PTHREAD_KEY_CREATE 0x3013 |
| 515 | #define VG_USERREQ__PTHREAD_KEY_DELETE 0x3014 |
sewardj | 00a66b1 | 2002-10-12 16:42:35 +0000 | [diff] [blame] | 516 | #define VG_USERREQ__PTHREAD_SETSPECIFIC_PTR 0x3015 |
| 517 | #define VG_USERREQ__PTHREAD_GETSPECIFIC_PTR 0x3016 |
sewardj | 20917d8 | 2002-05-28 01:36:45 +0000 | [diff] [blame] | 518 | #define VG_USERREQ__READ_MILLISECOND_TIMER 0x3017 |
| 519 | #define VG_USERREQ__PTHREAD_SIGMASK 0x3018 |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 520 | #define VG_USERREQ__SIGWAIT 0x3019 /* unused */ |
sewardj | 20917d8 | 2002-05-28 01:36:45 +0000 | [diff] [blame] | 521 | #define VG_USERREQ__PTHREAD_KILL 0x301A |
| 522 | #define VG_USERREQ__PTHREAD_YIELD 0x301B |
sewardj | 00a66b1 | 2002-10-12 16:42:35 +0000 | [diff] [blame] | 523 | #define VG_USERREQ__PTHREAD_KEY_VALIDATE 0x301C |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 524 | |
sewardj | 8ad94e1 | 2002-05-29 00:10:20 +0000 | [diff] [blame] | 525 | #define VG_USERREQ__CLEANUP_PUSH 0x3020 |
| 526 | #define VG_USERREQ__CLEANUP_POP 0x3021 |
sewardj | 870497a | 2002-05-29 01:06:47 +0000 | [diff] [blame] | 527 | #define VG_USERREQ__GET_KEY_D_AND_S 0x3022 |
sewardj | 8ad94e1 | 2002-05-29 00:10:20 +0000 | [diff] [blame] | 528 | |
sewardj | ef037c7 | 2002-05-30 00:40:03 +0000 | [diff] [blame] | 529 | #define VG_USERREQ__NUKE_OTHER_THREADS 0x3023 |
sewardj | efbfcdf | 2002-06-19 17:35:45 +0000 | [diff] [blame] | 530 | |
| 531 | /* Ask how many signal handler returns have happened to this |
| 532 | thread. */ |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 533 | #define VG_USERREQ__GET_N_SIGS_RETURNED 0x3024 /* unused */ |
sewardj | ef037c7 | 2002-05-30 00:40:03 +0000 | [diff] [blame] | 534 | |
sewardj | 2cb0034 | 2002-06-28 01:46:26 +0000 | [diff] [blame] | 535 | /* Get/set entries for a thread's pthread_atfork stack. */ |
| 536 | #define VG_USERREQ__SET_FHSTACK_USED 0x3025 |
| 537 | #define VG_USERREQ__GET_FHSTACK_USED 0x3026 |
| 538 | #define VG_USERREQ__SET_FHSTACK_ENTRY 0x3027 |
| 539 | #define VG_USERREQ__GET_FHSTACK_ENTRY 0x3028 |
sewardj | efbfcdf | 2002-06-19 17:35:45 +0000 | [diff] [blame] | 540 | |
nethercote | f971ab7 | 2004-08-02 16:27:40 +0000 | [diff] [blame] | 541 | /* Denote the finish of __libc_freeres_wrapper(). */ |
sewardj | 1fe7b00 | 2002-07-16 01:43:15 +0000 | [diff] [blame] | 542 | #define VG_USERREQ__LIBC_FREERES_DONE 0x3029 |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 543 | |
| 544 | /* Allocate RT signals */ |
| 545 | #define VG_USERREQ__GET_SIGRT_MIN 0x302B |
| 546 | #define VG_USERREQ__GET_SIGRT_MAX 0x302C |
| 547 | #define VG_USERREQ__ALLOC_RTSIG 0x302D |
| 548 | |
| 549 | /* Hook for replace_malloc.o to get malloc functions */ |
| 550 | #define VG_USERREQ__GET_MALLOCFUNCS 0x3030 |
| 551 | |
thughes | daa3456 | 2004-06-27 12:48:53 +0000 | [diff] [blame] | 552 | /* Get stack information for a thread. */ |
| 553 | #define VG_USERREQ__GET_STACK_INFO 0x3033 |
| 554 | |
sewardj | 45b4b37 | 2002-04-16 22:50:32 +0000 | [diff] [blame] | 555 | /* Cosmetic ... */ |
| 556 | #define VG_USERREQ__GET_PTHREAD_TRACE_LEVEL 0x3101 |
sewardj | 4dced35 | 2002-06-04 22:54:20 +0000 | [diff] [blame] | 557 | /* Log a pthread error from client-space. Cosmetic. */ |
| 558 | #define VG_USERREQ__PTHREAD_ERROR 0x3102 |
fitzhardinge | 39de4b4 | 2003-10-31 07:12:21 +0000 | [diff] [blame] | 559 | /* Internal equivalent of VALGRIND_PRINTF . */ |
| 560 | #define VG_USERREQ__INTERNAL_PRINTF 0x3103 |
| 561 | /* Internal equivalent of VALGRIND_PRINTF_BACKTRACE . */ |
| 562 | #define VG_USERREQ__INTERNAL_PRINTF_BACKTRACE 0x3104 |
sewardj | 45b4b37 | 2002-04-16 22:50:32 +0000 | [diff] [blame] | 563 | |
sewardj | 54cacf0 | 2002-04-12 23:24:59 +0000 | [diff] [blame] | 564 | /* |
nethercote | 5a2664c | 2004-09-02 15:37:39 +0000 | [diff] [blame] | 565 | In core_asm.h: |
sewardj | 54cacf0 | 2002-04-12 23:24:59 +0000 | [diff] [blame] | 566 | #define VG_USERREQ__SIGNAL_RETURNS 0x4001 |
sewardj | 54cacf0 | 2002-04-12 23:24:59 +0000 | [diff] [blame] | 567 | */ |
| 568 | |
rjwalsh | e4e779d | 2004-04-16 23:02:29 +0000 | [diff] [blame] | 569 | #define VG_INTERCEPT_PREFIX "_vgi__" |
| 570 | #define VG_INTERCEPT_PREFIX_LEN 6 |
| 571 | #define VG_INTERCEPT(name) _vgi__##name |
| 572 | #define VG_INTERCEPT_ALIAS(name) "_vgi__" #name |
| 573 | |
| 574 | #define VG_WRAPPER_PREFIX "_vgw__" |
| 575 | #define VG_WRAPPER_PREFIX_LEN 6 |
| 576 | #define VG_WRAPPER(name) _vgw__##name |
| 577 | #define VG_WRAPPER_ALIAS(name) "_vgw__" #name |
| 578 | |
njn | 4c79121 | 2003-05-02 17:53:54 +0000 | [diff] [blame] | 579 | |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 580 | struct vg_mallocfunc_info { |
| 581 | /* things vg_replace_malloc.o needs to know about */ |
| 582 | Addr sk_malloc; |
| 583 | Addr sk_calloc; |
| 584 | Addr sk_realloc; |
| 585 | Addr sk_memalign; |
| 586 | Addr sk___builtin_new; |
| 587 | Addr sk___builtin_vec_new; |
| 588 | Addr sk_free; |
| 589 | Addr sk___builtin_delete; |
| 590 | Addr sk___builtin_vec_delete; |
| 591 | |
| 592 | Addr arena_payload_szB; |
| 593 | |
| 594 | Bool clo_sloppy_malloc; |
| 595 | Bool clo_trace_malloc; |
| 596 | }; |
sewardj | 1fe7b00 | 2002-07-16 01:43:15 +0000 | [diff] [blame] | 597 | |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 598 | /* --------------------------------------------------------------------- |
njn | 3e88418 | 2003-04-15 13:03:23 +0000 | [diff] [blame] | 599 | Exports of vg_defaults.c |
| 600 | ------------------------------------------------------------------ */ |
| 601 | |
| 602 | extern Bool VG_(sk_malloc_called_by_scheduler); |
| 603 | |
nethercote | f9b5941 | 2004-09-10 15:33:32 +0000 | [diff] [blame] | 604 | /* --------------------------------------------------------------------- |
nethercote | 1f0173b | 2004-02-28 15:40:36 +0000 | [diff] [blame] | 605 | Exports of vg_libpthread.c |
| 606 | ------------------------------------------------------------------ */ |
| 607 | |
| 608 | /* Replacements for pthread types, shared between vg_libpthread.c and |
| 609 | vg_scheduler.c. See comment in vg_libpthread.c above the other |
| 610 | vg_pthread_*_t types for a description of how these are used. */ |
| 611 | |
| 612 | struct _vg_pthread_fastlock |
| 613 | { |
| 614 | long int __vg_status; /* "Free" or "taken" or head of waiting list */ |
| 615 | int __vg_spinlock; /* Used by compare_and_swap emulation. Also, |
| 616 | adaptive SMP lock stores spin count here. */ |
| 617 | }; |
| 618 | |
| 619 | typedef struct |
| 620 | { |
| 621 | int __vg_m_reserved; /* Reserved for future use */ |
| 622 | int __vg_m_count; /* Depth of recursive locking */ |
| 623 | /*_pthread_descr*/ void* __vg_m_owner; /* Owner thread (if recursive or errcheck) */ |
| 624 | int __vg_m_kind; /* Mutex kind: fast, recursive or errcheck */ |
| 625 | struct _vg_pthread_fastlock __vg_m_lock; /* Underlying fast lock */ |
| 626 | } vg_pthread_mutex_t; |
| 627 | |
| 628 | typedef struct |
| 629 | { |
| 630 | struct _vg_pthread_fastlock __vg_c_lock; /* Protect against concurrent access */ |
nethercote | dffad08 | 2004-02-28 23:32:11 +0000 | [diff] [blame] | 631 | /*_pthread_descr*/ void* __vg_c_waiting; /* Threads waiting on this condition */ |
| 632 | |
| 633 | // Nb: the following padding removed because it was missing from an |
| 634 | // earlier glibc, so the size test in the CONVERT macro was failing. |
| 635 | // --njn |
| 636 | |
nethercote | 1f0173b | 2004-02-28 15:40:36 +0000 | [diff] [blame] | 637 | // Padding ensures the size is 48 bytes |
nethercote | dffad08 | 2004-02-28 23:32:11 +0000 | [diff] [blame] | 638 | /*char __vg_padding[48 - sizeof(struct _vg_pthread_fastlock) |
nethercote | 1f0173b | 2004-02-28 15:40:36 +0000 | [diff] [blame] | 639 | - sizeof(void*) - sizeof(long long)]; |
nethercote | dffad08 | 2004-02-28 23:32:11 +0000 | [diff] [blame] | 640 | long long __vg_align;*/ |
nethercote | 1f0173b | 2004-02-28 15:40:36 +0000 | [diff] [blame] | 641 | } vg_pthread_cond_t; |
| 642 | |
| 643 | |
| 644 | /* --------------------------------------------------------------------- |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 645 | Exports of vg_scheduler.c |
| 646 | ------------------------------------------------------------------ */ |
| 647 | |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 648 | typedef |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 649 | enum ThreadStatus { |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 650 | VgTs_Empty, /* this slot is not in use */ |
| 651 | VgTs_Runnable, /* waiting to be scheduled */ |
| 652 | VgTs_WaitJoiner, /* waiting for someone to do join on me */ |
| 653 | VgTs_WaitJoinee, /* waiting for the thread I did join on */ |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 654 | VgTs_WaitMX, /* waiting on a mutex */ |
sewardj | 3b5d886 | 2002-04-20 13:53:23 +0000 | [diff] [blame] | 655 | VgTs_WaitCV, /* waiting on a condition variable */ |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 656 | VgTs_WaitSys, /* waiting for a syscall to complete */ |
| 657 | VgTs_Sleeping, /* sleeping for a while */ |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 658 | } |
| 659 | ThreadStatus; |
sewardj | 8ad94e1 | 2002-05-29 00:10:20 +0000 | [diff] [blame] | 660 | |
thughes | 11975ff | 2004-06-12 12:58:22 +0000 | [diff] [blame] | 661 | typedef |
| 662 | enum CleanupType { |
| 663 | VgCt_None, /* this cleanup entry is not initialised */ |
| 664 | VgCt_Function, /* an old-style function pointer cleanup */ |
| 665 | VgCt_Longjmp /* a new-style longjmp based cleanup */ |
| 666 | } |
| 667 | CleanupType; |
| 668 | |
thughes | daa3456 | 2004-06-27 12:48:53 +0000 | [diff] [blame] | 669 | /* Information on a thread's stack. */ |
| 670 | typedef |
| 671 | struct { |
| 672 | Addr base; |
| 673 | UInt size; |
| 674 | UInt guardsize; |
| 675 | } |
| 676 | StackInfo; |
| 677 | |
sewardj | 8ad94e1 | 2002-05-29 00:10:20 +0000 | [diff] [blame] | 678 | /* An entry in a threads's cleanup stack. */ |
| 679 | typedef |
| 680 | struct { |
thughes | 11975ff | 2004-06-12 12:58:22 +0000 | [diff] [blame] | 681 | CleanupType type; |
| 682 | union { |
| 683 | struct { |
| 684 | void (*fn)(void*); |
| 685 | void* arg; |
| 686 | } function; |
| 687 | struct { |
thughes | ebed998 | 2004-06-12 17:25:25 +0000 | [diff] [blame] | 688 | void *ub; |
thughes | 11975ff | 2004-06-12 12:58:22 +0000 | [diff] [blame] | 689 | int ctype; |
| 690 | } longjmp; |
| 691 | } data; |
sewardj | 8ad94e1 | 2002-05-29 00:10:20 +0000 | [diff] [blame] | 692 | } |
| 693 | CleanupEntry; |
sewardj | 2cb0034 | 2002-06-28 01:46:26 +0000 | [diff] [blame] | 694 | |
| 695 | /* An entry in a thread's fork-handler stack. */ |
| 696 | typedef |
| 697 | struct { |
| 698 | void (*prepare)(void); |
| 699 | void (*parent)(void); |
| 700 | void (*child)(void); |
| 701 | } |
| 702 | ForkHandlerEntry; |
| 703 | |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 704 | typedef struct ProxyLWP ProxyLWP; |
sewardj | 2cb0034 | 2002-06-28 01:46:26 +0000 | [diff] [blame] | 705 | |
njn | 7271864 | 2003-07-24 08:45:32 +0000 | [diff] [blame] | 706 | typedef |
| 707 | struct _ThreadState { |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 708 | /* ThreadId == 0 (and hence vg_threads[0]) is NEVER USED. |
| 709 | The thread identity is simply the index in vg_threads[]. |
| 710 | ThreadId == 1 is the root thread and has the special property |
| 711 | that we don't try and allocate or deallocate its stack. For |
| 712 | convenience of generating error message, we also put the |
| 713 | ThreadId in this tid field, but be aware that it should |
| 714 | ALWAYS == the index in vg_threads[]. */ |
| 715 | ThreadId tid; |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 716 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 717 | /* Current scheduling status. |
sewardj | 5f07b66 | 2002-04-23 16:52:51 +0000 | [diff] [blame] | 718 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 719 | Complications: whenever this is set to VgTs_WaitMX, you |
| 720 | should also set .m_edx to whatever the required return value |
| 721 | is for pthread_mutex_lock / pthread_cond_timedwait for when |
| 722 | the mutex finally gets unblocked. */ |
| 723 | ThreadStatus status; |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 724 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 725 | /* When .status == WaitMX, points to the mutex I am waiting for. |
| 726 | When .status == WaitCV, points to the mutex associated with |
| 727 | the condition variable indicated by the .associated_cv field. |
| 728 | In all other cases, should be NULL. */ |
nethercote | 1f0173b | 2004-02-28 15:40:36 +0000 | [diff] [blame] | 729 | vg_pthread_mutex_t* associated_mx; |
sewardj | 3b5d886 | 2002-04-20 13:53:23 +0000 | [diff] [blame] | 730 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 731 | /* When .status == WaitCV, points to the condition variable I am |
| 732 | waiting for. In all other cases, should be NULL. */ |
| 733 | void* /*pthread_cond_t* */ associated_cv; |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 734 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 735 | /* If VgTs_Sleeping, this is when we should wake up, measured in |
njn | 6c84655 | 2003-09-16 07:41:43 +0000 | [diff] [blame] | 736 | milliseconds as supplied by VG_(read_millisecond_timer). |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 737 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 738 | If VgTs_WaitCV, this indicates the time at which |
| 739 | pthread_cond_timedwait should wake up. If == 0xFFFFFFFF, |
| 740 | this means infinitely far in the future, viz, |
| 741 | pthread_cond_wait. */ |
| 742 | UInt awaken_at; |
sewardj | 20917d8 | 2002-05-28 01:36:45 +0000 | [diff] [blame] | 743 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 744 | /* If VgTs_WaitJoiner, return value, as generated by joinees. */ |
| 745 | void* joinee_retval; |
sewardj | 20917d8 | 2002-05-28 01:36:45 +0000 | [diff] [blame] | 746 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 747 | /* If VgTs_WaitJoinee, place to copy the return value to, and |
| 748 | the identity of the thread we're waiting for. */ |
| 749 | void** joiner_thread_return; |
| 750 | ThreadId joiner_jee_tid; |
sewardj | 8ad94e1 | 2002-05-29 00:10:20 +0000 | [diff] [blame] | 751 | |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 752 | /* If VgTs_WaitSys, this is the result of the pre-syscall check */ |
| 753 | void *sys_pre_res; |
| 754 | |
| 755 | /* If VgTs_WaitSys, this is the syscall we're currently running */ |
| 756 | Int syscallno; |
| 757 | |
thughes | baa46e5 | 2004-07-29 17:44:23 +0000 | [diff] [blame] | 758 | /* If VgTs_WaitSys, this is the syscall flags */ |
| 759 | UInt sys_flags; |
| 760 | |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 761 | /* Details about this thread's proxy LWP */ |
| 762 | ProxyLWP *proxy; |
| 763 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 764 | /* Whether or not detached. */ |
| 765 | Bool detached; |
sewardj | 20917d8 | 2002-05-28 01:36:45 +0000 | [diff] [blame] | 766 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 767 | /* Cancelability state and type. */ |
| 768 | Bool cancel_st; /* False==PTH_CANCEL_DISABLE; True==.._ENABLE */ |
| 769 | Bool cancel_ty; /* False==PTH_CANC_ASYNCH; True==..._DEFERRED */ |
| 770 | |
| 771 | /* Pointer to fn to call to do cancellation. Indicates whether |
| 772 | or not cancellation is pending. If NULL, not pending. Else |
| 773 | should be &thread_exit_wrapper(), indicating that |
| 774 | cancallation is pending. */ |
| 775 | void (*cancel_pend)(void*); |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 776 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 777 | /* The cleanup stack. */ |
| 778 | Int custack_used; |
| 779 | CleanupEntry custack[VG_N_CLEANUPSTACK]; |
sewardj | 5f07b66 | 2002-04-23 16:52:51 +0000 | [diff] [blame] | 780 | |
sewardj | 00a66b1 | 2002-10-12 16:42:35 +0000 | [diff] [blame] | 781 | /* A pointer to the thread's-specific-data. This is handled almost |
| 782 | entirely from vg_libpthread.c. We just provide hooks to get and |
| 783 | set this ptr. This is either NULL, indicating the thread has |
| 784 | read/written none of its specifics so far, OR points to a |
| 785 | void*[VG_N_THREAD_KEYS], allocated and deallocated in |
| 786 | vg_libpthread.c. */ |
| 787 | void** specifics_ptr; |
sewardj | b48e500 | 2002-05-13 00:16:03 +0000 | [diff] [blame] | 788 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 789 | /* This thread's blocked-signals mask. Semantics is that for a |
| 790 | signal to be delivered to this thread, the signal must not be |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 791 | blocked by this signal mask. If more than one thread accepts a |
| 792 | signal, then it will be delivered to one at random. If all |
| 793 | threads block the signal, it will remain pending until either a |
| 794 | thread unblocks it or someone uses sigwaitsig/sigtimedwait. |
| 795 | |
| 796 | sig_mask reflects what the client told us its signal mask should |
| 797 | be, but isn't necessarily the current signal mask of the proxy |
| 798 | LWP: it may have more signals blocked because of signal |
| 799 | handling, or it may be different because of sigsuspend. |
| 800 | */ |
nethercote | 73b526f | 2004-10-31 18:48:21 +0000 | [diff] [blame] | 801 | vki_sigset_t sig_mask; |
sewardj | b48e500 | 2002-05-13 00:16:03 +0000 | [diff] [blame] | 802 | |
fitzhardinge | f0dd7e1 | 2004-01-16 02:17:30 +0000 | [diff] [blame] | 803 | /* Effective signal mask. This is the mask which currently |
| 804 | applies; it may be different from sig_mask while a signal |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 805 | handler is running. |
| 806 | */ |
nethercote | 73b526f | 2004-10-31 18:48:21 +0000 | [diff] [blame] | 807 | vki_sigset_t eff_sig_mask; |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 808 | |
thughes | 8abf392 | 2004-10-16 10:59:49 +0000 | [diff] [blame] | 809 | /* Signal queue. This is used when the kernel doesn't route |
| 810 | signals properly in order to remember the signal information |
| 811 | while we are routing the signal. It is a circular queue with |
| 812 | insertions performed at the head and removals at the tail. |
| 813 | */ |
nethercote | 73b526f | 2004-10-31 18:48:21 +0000 | [diff] [blame] | 814 | vki_siginfo_t sigqueue[VG_N_SIGNALQUEUE]; |
thughes | 8abf392 | 2004-10-16 10:59:49 +0000 | [diff] [blame] | 815 | Int sigqueue_head; |
| 816 | Int sigqueue_tail; |
| 817 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 818 | /* Stacks. When a thread slot is freed, we don't deallocate its |
| 819 | stack; we just leave it lying around for the next use of the |
| 820 | slot. If the next use of the slot requires a larger stack, |
| 821 | only then is the old one deallocated and a new one |
| 822 | allocated. |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 823 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 824 | For the main thread (threadid == 0), this mechanism doesn't |
| 825 | apply. We don't know the size of the stack since we didn't |
| 826 | allocate it, and furthermore we never reallocate it. */ |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 827 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 828 | /* The allocated size of this thread's stack (permanently zero |
| 829 | if this is ThreadId == 0, since we didn't allocate its stack) */ |
| 830 | UInt stack_size; |
sewardj | 1e8cdc9 | 2002-04-18 11:37:52 +0000 | [diff] [blame] | 831 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 832 | /* Address of the lowest word in this thread's stack. NULL means |
| 833 | not allocated yet. |
| 834 | */ |
| 835 | Addr stack_base; |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 836 | |
thughes | daa3456 | 2004-06-27 12:48:53 +0000 | [diff] [blame] | 837 | /* The allocated size of this thread's stack's guard area (permanently |
| 838 | zero if this is ThreadId == 0, since we didn't allocate its stack) */ |
| 839 | UInt stack_guard_size; |
| 840 | |
sewardj | 92a5956 | 2002-09-30 00:53:10 +0000 | [diff] [blame] | 841 | /* Address of the highest legitimate word in this stack. This is |
| 842 | used for error messages only -- not critical for execution |
| 843 | correctness. Is is set for all stacks, specifically including |
| 844 | ThreadId == 0 (the main thread). */ |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 845 | Addr stack_highest_word; |
| 846 | |
fitzhardinge | 98c4dc0 | 2004-03-16 08:27:29 +0000 | [diff] [blame] | 847 | /* Alternate signal stack */ |
nethercote | 73b526f | 2004-10-31 18:48:21 +0000 | [diff] [blame] | 848 | vki_stack_t altstack; |
fitzhardinge | 98c4dc0 | 2004-03-16 08:27:29 +0000 | [diff] [blame] | 849 | |
nethercote | c06e213 | 2004-09-03 13:45:29 +0000 | [diff] [blame] | 850 | /* Architecture-specific thread state */ |
| 851 | arch_thread_t arch; |
njn | 7271864 | 2003-07-24 08:45:32 +0000 | [diff] [blame] | 852 | } |
| 853 | ThreadState; |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 854 | |
| 855 | |
sewardj | 018f762 | 2002-05-15 21:13:39 +0000 | [diff] [blame] | 856 | /* The thread table. */ |
| 857 | extern ThreadState VG_(threads)[VG_N_THREADS]; |
| 858 | |
| 859 | /* Check that tid is in range and denotes a non-Empty thread. */ |
sewardj | b48e500 | 2002-05-13 00:16:03 +0000 | [diff] [blame] | 860 | extern Bool VG_(is_valid_tid) ( ThreadId tid ); |
| 861 | |
njn | 7271864 | 2003-07-24 08:45:32 +0000 | [diff] [blame] | 862 | /* Determine if 'tid' is that of the current running thread (Nb: returns |
| 863 | False if no thread is currently running. */ |
| 864 | extern Bool VG_(is_running_thread)(ThreadId tid); |
| 865 | |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 866 | /* Get the ThreadState for a particular thread */ |
| 867 | extern ThreadState *VG_(get_ThreadState)(ThreadId tid); |
| 868 | |
sewardj | 1e8cdc9 | 2002-04-18 11:37:52 +0000 | [diff] [blame] | 869 | /* Similarly ... */ |
| 870 | extern ThreadId VG_(get_current_tid) ( void ); |
| 871 | |
sewardj | ccef2e6 | 2002-05-29 19:26:32 +0000 | [diff] [blame] | 872 | /* Nuke all threads except tid. */ |
| 873 | extern void VG_(nuke_all_threads_except) ( ThreadId me ); |
| 874 | |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 875 | /* Give a hint to the scheduler that it may be a good time to find a |
| 876 | new runnable thread. If prefer_sched != VG_INVALID_THREADID, then |
| 877 | try to schedule that thread. |
| 878 | */ |
| 879 | extern void VG_(need_resched) ( ThreadId prefer_sched ); |
| 880 | |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 881 | /* Return codes from the scheduler. */ |
| 882 | typedef |
sewardj | 7e87e38 | 2002-05-03 19:09:05 +0000 | [diff] [blame] | 883 | enum { |
| 884 | VgSrc_Deadlock, /* no runnable threads and no prospect of any |
| 885 | even if we wait for a long time */ |
| 886 | VgSrc_ExitSyscall, /* client called exit(). This is the normal |
| 887 | route out. */ |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 888 | VgSrc_FatalSig /* Killed by the default action of a fatal |
| 889 | signal */ |
sewardj | 7e87e38 | 2002-05-03 19:09:05 +0000 | [diff] [blame] | 890 | } |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 891 | VgSchedReturnCode; |
| 892 | |
sewardj | 7e87e38 | 2002-05-03 19:09:05 +0000 | [diff] [blame] | 893 | |
nethercote | 238a3c3 | 2004-08-09 13:13:31 +0000 | [diff] [blame] | 894 | // The scheduler. 'fatal_sigNo' is only set if VgSrc_FatalSig is returned. |
| 895 | extern VgSchedReturnCode VG_(scheduler) |
| 896 | ( Int* exit_code, ThreadId* last_run_thread, Int* fatal_sigNo ); |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 897 | |
| 898 | extern void VG_(scheduler_init) ( void ); |
| 899 | |
sewardj | 15a43e1 | 2002-04-17 19:35:12 +0000 | [diff] [blame] | 900 | extern void VG_(pp_sched_status) ( void ); |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 901 | |
nethercote | 75d2624 | 2004-08-01 22:59:18 +0000 | [diff] [blame] | 902 | // Longjmp back to the scheduler and thus enter the sighandler immediately. |
nethercote | 73b526f | 2004-10-31 18:48:21 +0000 | [diff] [blame] | 903 | extern void VG_(resume_scheduler) ( Int sigNo, vki_siginfo_t *info ); |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 904 | |
nethercote | 238a3c3 | 2004-08-09 13:13:31 +0000 | [diff] [blame] | 905 | // Longjmp, ending the scheduler, when a fatal signal occurs in the client. |
| 906 | extern void VG_(scheduler_handle_fatal_signal)( Int sigNo ); |
| 907 | |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 908 | /* The red-zone size which we put at the bottom (highest address) of |
| 909 | thread stacks, for paranoia reasons. This can be arbitrary, and |
| 910 | doesn't really need to be set at compile time. */ |
nethercote | 6e4f9dc | 2004-07-30 23:36:37 +0000 | [diff] [blame] | 911 | #define VG_AR_CLIENT_STACKBASE_REDZONE_SZB 16 |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 912 | |
nethercote | aff1c77 | 2004-09-13 16:11:09 +0000 | [diff] [blame] | 913 | // Write a value to a client's thread register, and shadow (if necessary). |
| 914 | // Note that there are some further similar macros in the arch- and |
| 915 | // platform-specific parts; these ones are the totally generic ones. |
| 916 | #define SET_THREAD_REG( zztid, zzval, zzGETREG, zzREG, zzevent, zzargs... ) \ |
| 917 | do { zzGETREG(VG_(threads)[zztid].arch) = (zzval); \ |
| 918 | VG_TRACK( zzevent, zztid, zzREG, ##zzargs ); \ |
sewardj | 018f762 | 2002-05-15 21:13:39 +0000 | [diff] [blame] | 919 | } while (0) |
| 920 | |
njn | d304045 | 2003-05-19 15:04:06 +0000 | [diff] [blame] | 921 | #define SET_CLREQ_RETVAL(zztid, zzval) \ |
nethercote | aff1c77 | 2004-09-13 16:11:09 +0000 | [diff] [blame] | 922 | SET_THREAD_REG(zztid, zzval, ARCH_CLREQ_RET, R_CLREQ_RET, \ |
| 923 | post_reg_write_clientreq_return) |
njn | d304045 | 2003-05-19 15:04:06 +0000 | [diff] [blame] | 924 | |
| 925 | #define SET_CLCALL_RETVAL(zztid, zzval, f) \ |
nethercote | aff1c77 | 2004-09-13 16:11:09 +0000 | [diff] [blame] | 926 | SET_THREAD_REG(zztid, zzval, ARCH_CLREQ_RET, R_CLREQ_RET, \ |
| 927 | post_reg_write_clientcall_return, f) |
njn | d304045 | 2003-05-19 15:04:06 +0000 | [diff] [blame] | 928 | |
| 929 | #define SET_PTHREQ_ESP(zztid, zzval) \ |
nethercote | aff1c77 | 2004-09-13 16:11:09 +0000 | [diff] [blame] | 930 | SET_THREAD_REG(zztid, zzval, ARCH_STACK_PTR, R_STACK_PTR, \ |
| 931 | post_reg_write_pthread_return) |
njn | d304045 | 2003-05-19 15:04:06 +0000 | [diff] [blame] | 932 | |
| 933 | #define SET_PTHREQ_RETVAL(zztid, zzval) \ |
nethercote | aff1c77 | 2004-09-13 16:11:09 +0000 | [diff] [blame] | 934 | SET_THREAD_REG(zztid, zzval, ARCH_PTHREQ_RET, R_PTHREQ_RET, \ |
| 935 | post_reg_write_pthread_return) |
sewardj | 018f762 | 2002-05-15 21:13:39 +0000 | [diff] [blame] | 936 | |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 937 | |
| 938 | /* --------------------------------------------------------------------- |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 939 | Exports of vg_signals.c |
| 940 | ------------------------------------------------------------------ */ |
| 941 | |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 942 | extern Bool VG_(do_signal_routing); /* whether scheduler LWP has to route signals */ |
| 943 | |
| 944 | /* RT signal allocation */ |
| 945 | extern Int VG_(sig_rtmin); |
| 946 | extern Int VG_(sig_rtmax); |
| 947 | extern Int VG_(sig_alloc_rtsig) ( Int high ); |
| 948 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 949 | extern void VG_(sigstartup_actions) ( void ); |
| 950 | |
nethercote | 73b526f | 2004-10-31 18:48:21 +0000 | [diff] [blame] | 951 | extern void VG_(deliver_signal) ( ThreadId tid, const vki_siginfo_t *, Bool async ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 952 | extern void VG_(unblock_host_signal) ( Int sigNo ); |
sewardj | 018f762 | 2002-05-15 21:13:39 +0000 | [diff] [blame] | 953 | |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 954 | extern Bool VG_(is_sig_ign) ( Int sigNo ); |
| 955 | |
| 956 | /* Route pending signals from the scheduler LWP to the appropriate |
| 957 | thread LWP. */ |
| 958 | extern void VG_(route_signals) ( void ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 959 | |
| 960 | /* Fake system calls for signal handling. */ |
sewardj | 2342c97 | 2002-05-22 23:34:20 +0000 | [diff] [blame] | 961 | extern void VG_(do__NR_sigaltstack) ( ThreadId tid ); |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 962 | extern void VG_(do__NR_sigaction) ( ThreadId tid ); |
nethercote | 85cdd34 | 2004-08-01 22:36:40 +0000 | [diff] [blame] | 963 | extern void VG_(do__NR_sigprocmask) ( ThreadId tid, Int how, |
nethercote | 73b526f | 2004-10-31 18:48:21 +0000 | [diff] [blame] | 964 | vki_sigset_t* set, |
| 965 | vki_sigset_t* oldset ); |
nethercote | 85cdd34 | 2004-08-01 22:36:40 +0000 | [diff] [blame] | 966 | extern void VG_(do_pthread_sigmask_SCSS_upd) ( ThreadId tid, Int how, |
nethercote | 73b526f | 2004-10-31 18:48:21 +0000 | [diff] [blame] | 967 | vki_sigset_t* set, |
| 968 | vki_sigset_t* oldset ); |
sewardj | efbfcdf | 2002-06-19 17:35:45 +0000 | [diff] [blame] | 969 | |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 970 | /* Modify the current thread's state once we have detected it is |
| 971 | returning from a signal handler. */ |
nethercote | aff1c77 | 2004-09-13 16:11:09 +0000 | [diff] [blame] | 972 | extern Bool VG_(signal_returns) ( ThreadId tid ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 973 | |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 974 | /* Handy utilities to block/restore all host signals. */ |
| 975 | extern void VG_(block_all_host_signals) |
nethercote | 73b526f | 2004-10-31 18:48:21 +0000 | [diff] [blame] | 976 | ( /* OUT */ vki_sigset_t* saved_mask ); |
sewardj | 018f762 | 2002-05-15 21:13:39 +0000 | [diff] [blame] | 977 | extern void VG_(restore_all_host_signals) |
nethercote | 73b526f | 2004-10-31 18:48:21 +0000 | [diff] [blame] | 978 | ( /* IN */ vki_sigset_t* saved_mask ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 979 | |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 980 | extern void VG_(kill_self)(Int sigNo); |
| 981 | |
fitzhardinge | f1beb25 | 2004-03-16 09:49:08 +0000 | [diff] [blame] | 982 | /* These function synthesize a fault, as if the running instruction |
| 983 | had had a fault. These functions do not return - they longjmp back |
| 984 | into the scheduler so the signal can be delivered. */ |
| 985 | extern void VG_(synth_fault) (ThreadId tid); |
| 986 | extern void VG_(synth_fault_mapping)(ThreadId tid, Addr addr); |
| 987 | extern void VG_(synth_fault_perms) (ThreadId tid, Addr addr); |
| 988 | |
nethercote | 759dda3 | 2004-08-07 18:16:56 +0000 | [diff] [blame] | 989 | extern void VG_(get_sigstack_bounds)( Addr* low, Addr* high ); |
fitzhardinge | f1beb25 | 2004-03-16 09:49:08 +0000 | [diff] [blame] | 990 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 991 | /* --------------------------------------------------------------------- |
| 992 | Exports of vg_mylibc.c |
| 993 | ------------------------------------------------------------------ */ |
| 994 | |
njn | e427a66 | 2002-10-02 11:08:25 +0000 | [diff] [blame] | 995 | #define vg_assert(expr) \ |
| 996 | ((void) ((expr) ? 0 : \ |
| 997 | (VG_(core_assert_fail) (VG__STRING(expr), \ |
| 998 | __FILE__, __LINE__, \ |
| 999 | __PRETTY_FUNCTION__), 0))) |
| 1000 | __attribute__ ((__noreturn__)) |
daywalker | 3222e0a | 2003-09-18 01:39:50 +0000 | [diff] [blame] | 1001 | extern void VG_(core_assert_fail) ( const Char* expr, const Char* file, |
| 1002 | Int line, const Char* fn ); |
njn | e427a66 | 2002-10-02 11:08:25 +0000 | [diff] [blame] | 1003 | __attribute__ ((__noreturn__)) |
| 1004 | extern void VG_(core_panic) ( Char* str ); |
thughes | 5876d55 | 2004-09-26 18:44:06 +0000 | [diff] [blame] | 1005 | __attribute__ ((__noreturn__)) |
| 1006 | extern void VG_(core_panic_at) ( Char* str, ExeContext *ec ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1007 | |
nethercote | 05675c8 | 2004-08-04 10:37:49 +0000 | [diff] [blame] | 1008 | /* Tools use VG_(strdup)() which doesn't expose ArenaId */ |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 1009 | extern Char* VG_(arena_strdup) ( ArenaId aid, const Char* s); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1010 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 1011 | extern Int VG_(fcntl) ( Int fd, Int cmd, Int arg ); |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 1012 | extern Int VG_(poll)( struct vki_pollfd *, UInt nfds, Int timeout); |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 1013 | |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 1014 | /* system/mman.h */ |
nethercote | 8b5f40c | 2004-11-02 13:29:50 +0000 | [diff] [blame] | 1015 | extern void* VG_(mmap)( void* start, SizeT length, UInt prot, UInt flags, |
nethercote | b4250ae | 2004-07-10 16:50:09 +0000 | [diff] [blame] | 1016 | UInt sf_flags, UInt fd, UInt offset ); |
nethercote | 8b5f40c | 2004-11-02 13:29:50 +0000 | [diff] [blame] | 1017 | extern Int VG_(munmap)( void* start, SizeT length ); |
| 1018 | extern Int VG_(mprotect)( void *start, SizeT length, UInt prot ); |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 1019 | |
| 1020 | |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 1021 | /* Move an fd into the Valgrind-safe range */ |
| 1022 | Int VG_(safe_fd)(Int oldfd); |
| 1023 | |
sewardj | 570f890 | 2002-11-03 11:44:36 +0000 | [diff] [blame] | 1024 | extern Int VG_(write_socket)( Int sd, void *msg, Int count ); |
sewardj | 73cf3bc | 2002-11-03 03:20:15 +0000 | [diff] [blame] | 1025 | |
| 1026 | /* --- Connecting over the network --- */ |
| 1027 | extern Int VG_(connect_via_socket)( UChar* str ); |
| 1028 | |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 1029 | /* Environment manipulations */ |
nethercote | 60a96c5 | 2004-08-03 13:08:31 +0000 | [diff] [blame] | 1030 | extern Char **VG_(env_setenv) ( Char ***envp, const Char* varname, |
| 1031 | const Char *val ); |
| 1032 | extern void VG_(env_unsetenv) ( Char **env, const Char *varname ); |
| 1033 | extern void VG_(env_remove_valgrind_env_stuff) ( Char** env ); |
sewardj | 570f890 | 2002-11-03 11:44:36 +0000 | [diff] [blame] | 1034 | |
| 1035 | /* --------------------------------------------------------------------- |
| 1036 | Exports of vg_message.c |
| 1037 | ------------------------------------------------------------------ */ |
| 1038 | |
| 1039 | /* Low-level -- send bytes directly to the message sink. Do not |
| 1040 | use. */ |
| 1041 | extern void VG_(send_bytes_to_logging_sink) ( Char* msg, Int nbytes ); |
| 1042 | |
nethercote | d1da90e | 2004-08-03 17:26:39 +0000 | [diff] [blame] | 1043 | // Functions for printing from code within Valgrind, but which runs on the |
nethercote | c91ce8d | 2004-08-09 11:15:10 +0000 | [diff] [blame] | 1044 | // sim'd CPU. Defined here because needed for vg_libpthread.c, |
| 1045 | // vg_replace_malloc.c, plus the rest of the core. The weak attribute |
| 1046 | // ensures the multiple definitions are not a problem. They must be functions |
| 1047 | // rather than macros so that va_list can be used. |
| 1048 | |
| 1049 | __attribute__((weak)) |
| 1050 | int |
| 1051 | VALGRIND_INTERNAL_PRINTF(char *format, ...) |
| 1052 | { |
nethercote | be671db | 2004-10-26 11:44:46 +0000 | [diff] [blame] | 1053 | UWord _qzz_res = 0; |
nethercote | c91ce8d | 2004-08-09 11:15:10 +0000 | [diff] [blame] | 1054 | va_list vargs; |
| 1055 | va_start(vargs, format); |
| 1056 | VALGRIND_MAGIC_SEQUENCE(_qzz_res, 0, VG_USERREQ__INTERNAL_PRINTF, |
nethercote | be671db | 2004-10-26 11:44:46 +0000 | [diff] [blame] | 1057 | (UWord)format, (UWord)vargs, 0, 0); |
nethercote | c91ce8d | 2004-08-09 11:15:10 +0000 | [diff] [blame] | 1058 | va_end(vargs); |
| 1059 | return _qzz_res; |
| 1060 | } |
| 1061 | |
| 1062 | __attribute__((weak)) |
| 1063 | int |
| 1064 | VALGRIND_INTERNAL_PRINTF_BACKTRACE(char *format, ...) |
| 1065 | { |
nethercote | be671db | 2004-10-26 11:44:46 +0000 | [diff] [blame] | 1066 | UWord _qzz_res = 0; |
nethercote | c91ce8d | 2004-08-09 11:15:10 +0000 | [diff] [blame] | 1067 | va_list vargs; |
| 1068 | va_start(vargs, format); |
| 1069 | VALGRIND_MAGIC_SEQUENCE(_qzz_res, 0, VG_USERREQ__INTERNAL_PRINTF_BACKTRACE, |
nethercote | be671db | 2004-10-26 11:44:46 +0000 | [diff] [blame] | 1070 | (UWord)format, (UWord)vargs, 0, 0); |
nethercote | c91ce8d | 2004-08-09 11:15:10 +0000 | [diff] [blame] | 1071 | va_end(vargs); |
| 1072 | return _qzz_res; |
| 1073 | } |
| 1074 | |
nethercote | d1da90e | 2004-08-03 17:26:39 +0000 | [diff] [blame] | 1075 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1076 | /* --------------------------------------------------------------------- |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1077 | Exports of vg_demangle.c |
| 1078 | ------------------------------------------------------------------ */ |
| 1079 | |
| 1080 | extern void VG_(demangle) ( Char* orig, Char* result, Int result_size ); |
| 1081 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1082 | /* --------------------------------------------------------------------- |
| 1083 | Exports of vg_from_ucode.c |
| 1084 | ------------------------------------------------------------------ */ |
| 1085 | |
sewardj | 22854b9 | 2002-11-30 14:00:47 +0000 | [diff] [blame] | 1086 | extern UChar* VG_(emit_code) ( UCodeBlock* cb, Int* nbytes, UShort jumps[VG_MAX_JUMPS] ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1087 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 1088 | extern void VG_(print_ccall_stats) ( void ); |
| 1089 | extern void VG_(print_UInstr_histogram) ( void ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1090 | |
sewardj | 22854b9 | 2002-11-30 14:00:47 +0000 | [diff] [blame] | 1091 | extern void VG_(unchain_jumpsite) ( Addr jumpsite ); |
| 1092 | extern Addr VG_(get_jmp_dest) ( Addr jumpsite ); |
sewardj | 22854b9 | 2002-11-30 14:00:47 +0000 | [diff] [blame] | 1093 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1094 | /* --------------------------------------------------------------------- |
| 1095 | Exports of vg_to_ucode.c |
| 1096 | ------------------------------------------------------------------ */ |
| 1097 | |
fitzhardinge | c2dbbac | 2004-01-23 23:09:01 +0000 | [diff] [blame] | 1098 | Bool VG_(cpu_has_feature)(UInt feat); |
| 1099 | |
nethercote | 4ad7431 | 2004-10-26 09:59:49 +0000 | [diff] [blame] | 1100 | extern Int VG_(disBB) ( UCodeBlock* cb, Addr ip0 ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1101 | |
| 1102 | /* --------------------------------------------------------------------- |
| 1103 | Exports of vg_translate.c |
| 1104 | ------------------------------------------------------------------ */ |
| 1105 | |
njn | 810086f | 2002-11-14 12:42:47 +0000 | [diff] [blame] | 1106 | /* Expandable arrays of uinstrs. */ |
| 1107 | struct _UCodeBlock { |
sewardj | 22854b9 | 2002-11-30 14:00:47 +0000 | [diff] [blame] | 1108 | Addr orig_eip; |
njn | 810086f | 2002-11-14 12:42:47 +0000 | [diff] [blame] | 1109 | Int used; |
| 1110 | Int size; |
| 1111 | UInstr* instrs; |
| 1112 | Int nextTemp; |
| 1113 | }; |
| 1114 | |
nethercote | 4d71438 | 2004-10-13 09:47:24 +0000 | [diff] [blame] | 1115 | extern Bool VG_(translate) ( ThreadId tid, Addr orig_addr, Bool debugging ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1116 | |
nethercote | 885dd91 | 2004-08-03 23:14:00 +0000 | [diff] [blame] | 1117 | extern void VG_(sanity_check_UInstr) ( UInt n, UInstr* u ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1118 | |
nethercote | bee3fd9 | 2004-08-02 15:17:43 +0000 | [diff] [blame] | 1119 | extern void VG_(print_reg_alloc_stats) ( void ); |
sewardj | b5ff83e | 2002-12-01 19:40:49 +0000 | [diff] [blame] | 1120 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1121 | /* --------------------------------------------------------------------- |
| 1122 | Exports of vg_execontext.c. |
| 1123 | ------------------------------------------------------------------ */ |
| 1124 | |
nethercote | 4ad7431 | 2004-10-26 09:59:49 +0000 | [diff] [blame] | 1125 | /* Records the PC and a bit of the call chain. The first 4 IP |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1126 | values are used in comparisons do remove duplicate errors, and for |
| 1127 | comparing against suppression specifications. The rest are purely |
| 1128 | informational (but often important). */ |
| 1129 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 1130 | struct _ExeContext { |
| 1131 | struct _ExeContext * next; |
| 1132 | /* Variable-length array. The size is VG_(clo_backtrace_size); at |
nethercote | 86c5dcb | 2004-09-05 21:32:37 +0000 | [diff] [blame] | 1133 | least 1, at most VG_DEEPEST_BACKTRACE. [0] is the current IP, |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 1134 | [1] is its caller, [2] is the caller of [1], etc. */ |
nethercote | 86c5dcb | 2004-09-05 21:32:37 +0000 | [diff] [blame] | 1135 | Addr ips[0]; |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 1136 | }; |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1137 | |
| 1138 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1139 | /* Print stats (informational only). */ |
nethercote | 3a42fb8 | 2004-08-03 18:08:50 +0000 | [diff] [blame] | 1140 | extern void VG_(print_ExeContext_stats) ( void ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1141 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 1142 | /* Like VG_(get_ExeContext), but with a slightly different type */ |
nethercote | 3d4a0b1 | 2004-09-06 15:14:46 +0000 | [diff] [blame] | 1143 | extern ExeContext* VG_(get_ExeContext2) ( Addr ip, Addr fp, |
| 1144 | Addr fp_min, Addr fp_max ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1145 | |
| 1146 | |
| 1147 | /* --------------------------------------------------------------------- |
| 1148 | Exports of vg_errcontext.c. |
| 1149 | ------------------------------------------------------------------ */ |
| 1150 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 1151 | extern void VG_(load_suppressions) ( void ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1152 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 1153 | extern void VG_(record_pthread_error) ( ThreadId tid, Char* msg ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1154 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 1155 | extern void VG_(show_all_errors) ( void ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1156 | |
nethercote | f2b1148 | 2004-08-02 12:36:01 +0000 | [diff] [blame] | 1157 | extern Bool VG_(is_action_requested) ( Char* action, Bool* clo ); |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 1158 | |
nethercote | f2b1148 | 2004-08-02 12:36:01 +0000 | [diff] [blame] | 1159 | extern UInt VG_(get_n_errs_found) ( void ); |
njn | 47363ab | 2003-04-21 13:24:40 +0000 | [diff] [blame] | 1160 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1161 | /* --------------------------------------------------------------------- |
| 1162 | Exports of vg_procselfmaps.c |
| 1163 | ------------------------------------------------------------------ */ |
| 1164 | |
njn | fa1016e | 2003-09-25 17:54:11 +0000 | [diff] [blame] | 1165 | /* Reads /proc/self/maps into a static buffer which can be parsed by |
| 1166 | VG_(parse_procselfmaps)(). */ |
| 1167 | extern void VG_(read_procselfmaps) ( void ); |
njn | 3e88418 | 2003-04-15 13:03:23 +0000 | [diff] [blame] | 1168 | |
| 1169 | /* Parses /proc/self/maps, calling `record_mapping' for each entry. If |
| 1170 | `read_from_file' is True, /proc/self/maps is read directly, otherwise |
| 1171 | it's read from the buffer filled by VG_(read_procselfmaps_contents)(). */ |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1172 | extern |
njn | fa1016e | 2003-09-25 17:54:11 +0000 | [diff] [blame] | 1173 | void VG_(parse_procselfmaps) ( |
nethercote | 8991d5a | 2004-11-03 17:07:46 +0000 | [diff] [blame] | 1174 | void (*record_mapping)( Addr addr, SizeT len, Char rr, Char ww, Char xx, |
nethercote | 85cdd34 | 2004-08-01 22:36:40 +0000 | [diff] [blame] | 1175 | UInt dev, UInt ino, ULong foff, |
| 1176 | const UChar *filename ) ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1177 | |
| 1178 | |
| 1179 | /* --------------------------------------------------------------------- |
| 1180 | Exports of vg_symtab2.c |
| 1181 | ------------------------------------------------------------------ */ |
| 1182 | |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 1183 | typedef struct _Segment Segment; |
| 1184 | |
| 1185 | extern Bool VG_(is_object_file) ( const void *hdr ); |
nethercote | 4ad7431 | 2004-10-26 09:59:49 +0000 | [diff] [blame] | 1186 | extern void VG_(mini_stack_dump) ( Addr ips[], UInt n_ips ); |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 1187 | extern SegInfo * VG_(read_seg_symbols) ( Segment *seg ); |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 1188 | extern void VG_(symtab_incref) ( SegInfo * ); |
nethercote | 8991d5a | 2004-11-03 17:07:46 +0000 | [diff] [blame] | 1189 | extern void VG_(symtab_decref) ( SegInfo *, Addr a ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1190 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 1191 | extern Bool VG_(get_fnname_nodemangle)( Addr a, Char* fnname, Int n_fnname ); |
sewardj | 25c7c3a | 2003-07-10 00:17:58 +0000 | [diff] [blame] | 1192 | |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 1193 | /* Set up some default redirects */ |
| 1194 | extern void VG_(setup_code_redirect_table) ( void ); |
sewardj | 25c7c3a | 2003-07-10 00:17:58 +0000 | [diff] [blame] | 1195 | |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 1196 | /* Redirection machinery */ |
nethercote | 85cdd34 | 2004-08-01 22:36:40 +0000 | [diff] [blame] | 1197 | extern Addr VG_(code_redirect) ( Addr orig ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1198 | |
| 1199 | /* --------------------------------------------------------------------- |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1200 | Exports of vg_main.c |
| 1201 | ------------------------------------------------------------------ */ |
| 1202 | |
sewardj | b91ae7f | 2003-04-29 23:50:00 +0000 | [diff] [blame] | 1203 | /* Is this a SSE/SSE2-capable CPU? If so, we had better save/restore |
| 1204 | the SSE state all over the place. This is set up very early, in |
nethercote | 1d44709 | 2004-02-01 17:29:59 +0000 | [diff] [blame] | 1205 | main(). We have to determine it early since we can't even |
sewardj | b91ae7f | 2003-04-29 23:50:00 +0000 | [diff] [blame] | 1206 | correctly snapshot the startup machine state without it. */ |
| 1207 | extern Bool VG_(have_ssestate); |
| 1208 | |
sewardj | 73cf3bc | 2002-11-03 03:20:15 +0000 | [diff] [blame] | 1209 | /* Tell the logging mechanism whether we are logging to a file |
| 1210 | descriptor or a socket descriptor. */ |
| 1211 | extern Bool VG_(logging_to_filedes); |
| 1212 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 1213 | /* Sanity checks which may be done at any time. The scheduler decides when. */ |
nethercote | 885dd91 | 2004-08-03 23:14:00 +0000 | [diff] [blame] | 1214 | extern void VG_(sanity_check_general) ( Bool force_expensive ); |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 1215 | |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 1216 | /* Address space */ |
| 1217 | extern Addr VG_(client_base); /* client address space limits */ |
| 1218 | extern Addr VG_(client_end); |
| 1219 | extern Addr VG_(client_mapbase); /* base of mappings */ |
| 1220 | extern Addr VG_(clstk_base); /* client stack range */ |
| 1221 | extern Addr VG_(clstk_end); |
fitzhardinge | 9236079 | 2003-12-24 10:11:11 +0000 | [diff] [blame] | 1222 | extern Addr VG_(client_trampoline_code); |
| 1223 | |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 1224 | extern Addr VG_(brk_base); /* start of brk */ |
| 1225 | extern Addr VG_(brk_limit); /* current brk */ |
nethercote | 996901a | 2004-08-03 13:29:09 +0000 | [diff] [blame] | 1226 | extern Addr VG_(shadow_base); /* tool's shadow memory */ |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 1227 | extern Addr VG_(shadow_end); |
| 1228 | extern Addr VG_(valgrind_base); /* valgrind's address range */ |
nethercote | 820bd8c | 2004-09-07 23:04:49 +0000 | [diff] [blame] | 1229 | 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] | 1230 | |
nethercote | 73b526f | 2004-10-31 18:48:21 +0000 | [diff] [blame] | 1231 | extern struct vki_rlimit VG_(client_rlimit_data); /* client's original rlimit data */ |
| 1232 | extern struct vki_rlimit VG_(client_rlimit_stack); /* client's original rlimit stack */ |
fitzhardinge | b50068f | 2004-02-24 23:42:55 +0000 | [diff] [blame] | 1233 | |
fitzhardinge | a49f9b5 | 2003-12-16 22:26:45 +0000 | [diff] [blame] | 1234 | /* client executable file descriptor */ |
| 1235 | extern Int VG_(clexecfd); |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 1236 | |
nethercote | f6a1d50 | 2004-08-09 12:21:57 +0000 | [diff] [blame] | 1237 | // Help set up the child used when doing execve() with --trace-children=yes |
| 1238 | Char* VG_(build_child_VALGRINDCLO) ( Char* exename ); |
| 1239 | Char* VG_(build_child_exename) ( void ); |
| 1240 | |
nethercote | 4ad7431 | 2004-10-26 09:59:49 +0000 | [diff] [blame] | 1241 | /* Determine if SP adjustment must be noted */ |
| 1242 | extern Bool VG_(need_to_handle_SP_assignment) ( void ); |
njn | f4ce3d3 | 2003-02-10 10:17:26 +0000 | [diff] [blame] | 1243 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1244 | /* Called when some unhandleable client behaviour is detected. |
| 1245 | Prints a msg and aborts. */ |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 1246 | extern void VG_(unimplemented) ( Char* msg ) |
| 1247 | __attribute__((__noreturn__)); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1248 | |
nethercote | 04d0fbc | 2004-01-26 16:48:06 +0000 | [diff] [blame] | 1249 | /* Something of a function looking for a home ... start up debugger. */ |
| 1250 | extern void VG_(start_debugger) ( Int tid ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1251 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1252 | /* Counts downwards in vg_run_innerloop. */ |
| 1253 | extern UInt VG_(dispatch_ctr); |
| 1254 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1255 | /* --- Counters, for informational purposes only. --- */ |
| 1256 | |
nethercote | 92e7b7f | 2004-08-07 17:52:25 +0000 | [diff] [blame] | 1257 | // These counters must be declared here because they're maintained by |
| 1258 | // vg_dispatch.S. |
| 1259 | extern UInt VG_(bb_enchain_count); // Counts of chain operations done |
| 1260 | extern UInt VG_(bb_dechain_count); // Counts of unchain operations done |
| 1261 | extern UInt VG_(unchained_jumps_done); // Number of unchained jumps performed |
sewardj | 22854b9 | 2002-11-30 14:00:47 +0000 | [diff] [blame] | 1262 | |
nethercote | 844e712 | 2004-08-02 15:27:22 +0000 | [diff] [blame] | 1263 | extern void VG_(print_scheduler_stats) ( void ); |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 1264 | |
nethercote | 2e05c33 | 2004-09-06 16:43:37 +0000 | [diff] [blame] | 1265 | extern Int VG_(alloc_BaB)( Int ); // Allocate slots in baseBlock |
| 1266 | extern void VG_(align_BaB)( UInt ); // Align baseBlock offset |
| 1267 | extern Int VG_(alloc_BaB_1_set)( Addr ); // Allocate & init baseBlock slot |
| 1268 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1269 | /* --------------------------------------------------------------------- |
| 1270 | Exports of vg_memory.c |
| 1271 | ------------------------------------------------------------------ */ |
| 1272 | |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 1273 | /* A Segment is mapped piece of client memory. This covers all kinds |
| 1274 | of mapped memory (exe, brk, mmap, .so, shm, stack, etc) |
| 1275 | |
| 1276 | We try to encode everything we know about a particular segment here. |
| 1277 | */ |
nethercote | 85cdd34 | 2004-08-01 22:36:40 +0000 | [diff] [blame] | 1278 | #define SF_FIXED (1 << 0) // client asked for MAP_FIXED |
| 1279 | #define SF_SHARED (1 << 1) // shared |
| 1280 | #define SF_SHM (1 << 2) // SYSV SHM (also SF_SHARED) |
| 1281 | #define SF_MMAP (1 << 3) // mmap memory |
| 1282 | #define SF_FILE (1 << 4) // mapping is backed by a file |
| 1283 | #define SF_STACK (1 << 5) // is a stack |
| 1284 | #define SF_GROWDOWN (1 << 6) // segment grows down |
| 1285 | #define SF_GROWUP (1 << 7) // segment grows up |
| 1286 | #define SF_EXEC (1 << 8) // segment created by exec |
| 1287 | #define SF_DYNLIB (1 << 9) // mapped from dynamic library |
| 1288 | #define SF_NOSYMS (1 << 10) // don't load syms, even if present |
| 1289 | #define SF_BRK (1 << 11) // brk segment |
| 1290 | #define SF_CORE (1 << 12) // allocated by core on behalf of the client |
| 1291 | #define SF_VALGRIND (1 << 13) // a valgrind-internal mapping - not in client |
| 1292 | #define SF_CODE (1 << 14) // segment contains cached code |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 1293 | |
| 1294 | struct _Segment { |
| 1295 | UInt prot; /* VKI_PROT_* */ |
| 1296 | UInt flags; /* SF_* */ |
| 1297 | |
| 1298 | Addr addr; /* mapped addr (page aligned) */ |
nethercote | 8991d5a | 2004-11-03 17:07:46 +0000 | [diff] [blame] | 1299 | SizeT len; /* size of mapping (page aligned) */ |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 1300 | |
| 1301 | /* These are valid if (flags & SF_FILE) */ |
| 1302 | ULong offset; /* file offset */ |
| 1303 | const Char *filename; /* filename (NULL if unknown) */ |
| 1304 | UInt dev; /* device */ |
| 1305 | UInt ino; /* inode */ |
| 1306 | |
| 1307 | SegInfo *symtab; /* symbol table */ |
| 1308 | }; |
| 1309 | |
| 1310 | /* segment mapped from a file descriptor */ |
nethercote | 8b5f40c | 2004-11-02 13:29:50 +0000 | [diff] [blame] | 1311 | extern void VG_(map_fd_segment) (Addr addr, SizeT len, UInt prot, UInt flags, |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 1312 | Int fd, ULong off, const Char *filename); |
| 1313 | |
| 1314 | /* segment mapped from a file */ |
nethercote | 8b5f40c | 2004-11-02 13:29:50 +0000 | [diff] [blame] | 1315 | extern void VG_(map_file_segment)(Addr addr, SizeT len, UInt prot, UInt flags, |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 1316 | UInt dev, UInt ino, ULong off, const Char *filename); |
| 1317 | |
| 1318 | /* simple segment */ |
nethercote | 8b5f40c | 2004-11-02 13:29:50 +0000 | [diff] [blame] | 1319 | extern void VG_(map_segment) (Addr addr, SizeT len, UInt prot, UInt flags); |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 1320 | |
nethercote | 8b5f40c | 2004-11-02 13:29:50 +0000 | [diff] [blame] | 1321 | extern void VG_(unmap_range) (Addr addr, SizeT len); |
| 1322 | extern void VG_(mprotect_range)(Addr addr, SizeT len, UInt prot); |
| 1323 | extern Addr VG_(find_map_space)(Addr base, SizeT len, Bool for_client); |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 1324 | |
| 1325 | extern Segment *VG_(find_segment)(Addr a); |
fitzhardinge | d65dcad | 2004-03-13 02:06:58 +0000 | [diff] [blame] | 1326 | extern Segment *VG_(first_segment)(void); |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 1327 | extern Segment *VG_(next_segment)(Segment *); |
| 1328 | |
nethercote | 8991d5a | 2004-11-03 17:07:46 +0000 | [diff] [blame] | 1329 | extern Bool VG_(seg_contains)(const Segment *s, Addr ptr, SizeT size); |
| 1330 | extern Bool VG_(seg_overlaps)(const Segment *s, Addr ptr, SizeT size); |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 1331 | |
nethercote | 8991d5a | 2004-11-03 17:07:46 +0000 | [diff] [blame] | 1332 | extern void VG_(pad_address_space) (void); |
thughes | 9aaebc3 | 2004-07-15 23:13:37 +0000 | [diff] [blame] | 1333 | extern void VG_(unpad_address_space)(void); |
| 1334 | |
nethercote | eec4630 | 2004-08-23 15:06:23 +0000 | [diff] [blame] | 1335 | extern REGPARM(1) |
nethercote | 4ad7431 | 2004-10-26 09:59:49 +0000 | [diff] [blame] | 1336 | void VG_(unknown_SP_update) ( Addr new_SP ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1337 | |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 1338 | /* --------------------------------------------------------------------- |
| 1339 | Exports of vg_proxylwp.c |
| 1340 | ------------------------------------------------------------------ */ |
| 1341 | |
nethercote | 24e0d44 | 2004-10-18 17:36:40 +0000 | [diff] [blame] | 1342 | enum PXState |
| 1343 | { |
| 1344 | PXS_BAD = -1, |
| 1345 | PXS_WaitReq, /* waiting for a request */ |
| 1346 | PXS_RunSyscall, /* running a syscall */ |
| 1347 | PXS_IntReply, /* request interrupted - need to send reply */ |
| 1348 | PXS_SysDone, /* small window between syscall |
| 1349 | complete and results written out */ |
| 1350 | PXS_SigACK, /* waiting for a signal ACK */ |
| 1351 | }; |
| 1352 | |
| 1353 | |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 1354 | /* Issue a syscall for thread tid */ |
| 1355 | extern Int VG_(sys_issue)(int tid); |
| 1356 | |
| 1357 | extern void VG_(proxy_init) ( void ); |
| 1358 | extern void VG_(proxy_create) ( ThreadId tid ); |
| 1359 | extern void VG_(proxy_delete) ( ThreadId tid, Bool force ); |
| 1360 | extern void VG_(proxy_results) ( void ); |
| 1361 | extern void VG_(proxy_sendsig) ( ThreadId tid, Int signo ); |
| 1362 | extern void VG_(proxy_setsigmask)(ThreadId tid); |
nethercote | 73b526f | 2004-10-31 18:48:21 +0000 | [diff] [blame] | 1363 | extern void VG_(proxy_sigack) ( ThreadId tid, const vki_sigset_t *); |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 1364 | extern void VG_(proxy_abort_syscall) ( ThreadId tid ); |
| 1365 | extern void VG_(proxy_waitsig) ( void ); |
fitzhardinge | 31ba905 | 2004-01-16 02:15:23 +0000 | [diff] [blame] | 1366 | extern void VG_(proxy_wait_sys) (ThreadId tid, Bool restart); |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 1367 | |
nethercote | 85cdd34 | 2004-08-01 22:36:40 +0000 | [diff] [blame] | 1368 | extern void VG_(proxy_shutdown) ( void ); // shut down the syscall workers |
| 1369 | extern Int VG_(proxy_resfd) ( void ); // FD something can select on to know |
| 1370 | // a syscall finished |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 1371 | |
| 1372 | /* Sanity-check the whole proxy-LWP machinery */ |
nethercote | 885dd91 | 2004-08-03 23:14:00 +0000 | [diff] [blame] | 1373 | void VG_(sanity_check_proxy)(void); |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 1374 | |
| 1375 | /* Send a signal from a thread's proxy to the thread. This longjmps |
| 1376 | back into the proxy's main loop, so it doesn't return. */ |
| 1377 | __attribute__ ((__noreturn__)) |
nethercote | 73b526f | 2004-10-31 18:48:21 +0000 | [diff] [blame] | 1378 | extern void VG_(proxy_handlesig)( const vki_siginfo_t *siginfo, |
nethercote | e5a3e2b | 2004-10-13 14:42:57 +0000 | [diff] [blame] | 1379 | Addr ip, Int sysnum ); |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 1380 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1381 | /* --------------------------------------------------------------------- |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 1382 | Exports of vg_syscalls.c |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1383 | ------------------------------------------------------------------ */ |
| 1384 | |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 1385 | extern Char *VG_(resolve_filename)(Int fd); |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 1386 | |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 1387 | extern Bool VG_(pre_syscall) ( ThreadId tid ); |
fitzhardinge | 31ba905 | 2004-01-16 02:15:23 +0000 | [diff] [blame] | 1388 | extern void VG_(post_syscall)( ThreadId tid, Bool restart ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1389 | |
| 1390 | extern Bool VG_(is_kerror) ( Int res ); |
| 1391 | |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 1392 | /* Internal atfork handlers */ |
| 1393 | typedef void (*vg_atfork_t)(ThreadId); |
| 1394 | extern void VG_(atfork)(vg_atfork_t pre, vg_atfork_t parent, vg_atfork_t child); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1395 | |
rjwalsh | f5f536f | 2003-11-17 17:45:00 +0000 | [diff] [blame] | 1396 | /* fd leakage calls. */ |
| 1397 | extern void VG_(init_preopened_fds) ( void ); |
nethercote | 3a42fb8 | 2004-08-03 18:08:50 +0000 | [diff] [blame] | 1398 | extern void VG_(show_open_fds) ( void ); |
rjwalsh | f5f536f | 2003-11-17 17:45:00 +0000 | [diff] [blame] | 1399 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1400 | /* --------------------------------------------------------------------- |
| 1401 | Exports of vg_transtab.c |
| 1402 | ------------------------------------------------------------------ */ |
| 1403 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 1404 | /* The fast-cache for tt-lookup. */ |
| 1405 | extern Addr VG_(tt_fast)[VG_TT_FAST_SIZE]; |
| 1406 | |
nethercote | 92e7b7f | 2004-08-07 17:52:25 +0000 | [diff] [blame] | 1407 | extern void VG_(init_tt_tc) ( void ); |
sewardj | c0d8f68 | 2002-11-30 00:49:43 +0000 | [diff] [blame] | 1408 | extern void VG_(add_to_trans_tab) ( Addr orig_addr, Int orig_size, |
sewardj | 22854b9 | 2002-11-30 14:00:47 +0000 | [diff] [blame] | 1409 | Addr trans_addr, Int trans_size, |
| 1410 | UShort jumps[VG_MAX_JUMPS]); |
nethercote | 92e7b7f | 2004-08-07 17:52:25 +0000 | [diff] [blame] | 1411 | extern Addr VG_(search_transtab) ( Addr original_addr ); |
sewardj | 6c3769f | 2002-11-29 01:02:45 +0000 | [diff] [blame] | 1412 | |
nethercote | 92e7b7f | 2004-08-07 17:52:25 +0000 | [diff] [blame] | 1413 | extern void VG_(invalidate_translations) ( Addr start, UInt range, |
| 1414 | Bool unchain_blocks ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1415 | |
nethercote | 92e7b7f | 2004-08-07 17:52:25 +0000 | [diff] [blame] | 1416 | extern void VG_(sanity_check_tt_tc) ( void ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1417 | |
nethercote | 92e7b7f | 2004-08-07 17:52:25 +0000 | [diff] [blame] | 1418 | extern void VG_(print_tt_tc_stats) ( void ); |
| 1419 | |
| 1420 | extern Int VG_(get_bbs_translated) ( void ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1421 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1422 | /* --------------------------------------------------------------------- |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1423 | Exports of vg_syscall.S |
| 1424 | ------------------------------------------------------------------ */ |
| 1425 | |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 1426 | extern Int VG_(do_syscall) ( UInt, ... ); |
| 1427 | extern Int VG_(clone) ( Int (*fn)(void *), void *stack, Int flags, void *arg, |
| 1428 | Int *child_tid, Int *parent_tid); |
fitzhardinge | 4f10ada | 2004-06-03 10:00:42 +0000 | [diff] [blame] | 1429 | extern void VG_(sigreturn)(void); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1430 | |
| 1431 | /* --------------------------------------------------------------------- |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1432 | Exports of vg_dispatch.S |
| 1433 | ------------------------------------------------------------------ */ |
| 1434 | |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 1435 | /* Run a thread for a (very short) while, until some event happens |
| 1436 | which means we need to defer to the scheduler. */ |
| 1437 | extern UInt VG_(run_innerloop) ( void ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1438 | |
sewardj | 22854b9 | 2002-11-30 14:00:47 +0000 | [diff] [blame] | 1439 | /* The patching routing called when a BB wants to chain itself to |
| 1440 | another. */ |
| 1441 | extern UInt VG_(patch_me); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1442 | |
| 1443 | /* --------------------------------------------------------------------- |
| 1444 | Exports of vg_helpers.S |
| 1445 | ------------------------------------------------------------------ */ |
| 1446 | |
sewardj | 5109643 | 2002-12-14 23:59:09 +0000 | [diff] [blame] | 1447 | extern void VG_(helper_undefined_instruction); |
| 1448 | |
fitzhardinge | 9236079 | 2003-12-24 10:11:11 +0000 | [diff] [blame] | 1449 | /* Information about trampoline code (for signal return and syscalls) */ |
| 1450 | extern const Char VG_(trampoline_code_start); |
| 1451 | extern const Int VG_(trampoline_code_length); |
| 1452 | extern const Int VG_(tramp_sigreturn_offset); |
| 1453 | extern const Int VG_(tramp_syscall_offset); |
sewardj | 20917d8 | 2002-05-28 01:36:45 +0000 | [diff] [blame] | 1454 | |
njn | 4f9c934 | 2002-04-29 16:03:24 +0000 | [diff] [blame] | 1455 | /* --------------------------------------------------------------------- |
nethercote | 996901a | 2004-08-03 13:29:09 +0000 | [diff] [blame] | 1456 | Things relating to the used tool |
njn | 4f9c934 | 2002-04-29 16:03:24 +0000 | [diff] [blame] | 1457 | ------------------------------------------------------------------ */ |
| 1458 | |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 1459 | #define VG_TRACK(fn, args...) \ |
| 1460 | do { \ |
| 1461 | if (VG_(defined_##fn)()) \ |
| 1462 | SK_(fn)(args); \ |
| 1463 | } while(0) |
sewardj | 18d7513 | 2002-05-16 11:06:21 +0000 | [diff] [blame] | 1464 | |
fitzhardinge | 98abfc7 | 2003-12-16 02:05:15 +0000 | [diff] [blame] | 1465 | __attribute__ ((noreturn)) |
| 1466 | extern void VG_(missing_tool_func) ( const Char* fn ); |
sewardj | 18d7513 | 2002-05-16 11:06:21 +0000 | [diff] [blame] | 1467 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1468 | /* --------------------------------------------------------------------- |
nethercote | 6a27d83 | 2004-09-07 10:17:02 +0000 | [diff] [blame] | 1469 | The baseBlock -- arch-neutral bits |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1470 | ------------------------------------------------------------------ */ |
| 1471 | |
nethercote | 2e05c33 | 2004-09-06 16:43:37 +0000 | [diff] [blame] | 1472 | #define INVALID_OFFSET (-1) |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1473 | |
| 1474 | /* An array of words. In generated code, %ebp always points to the |
| 1475 | start of this array. Useful stuff, like the simulated CPU state, |
| 1476 | and the addresses of helper functions, can then be found by |
| 1477 | indexing off %ebp. The following declares variables which, at |
| 1478 | startup time, are given values denoting offsets into baseBlock. |
| 1479 | These offsets are in *words* from the start of baseBlock. */ |
| 1480 | |
sewardj | b91ae7f | 2003-04-29 23:50:00 +0000 | [diff] [blame] | 1481 | #define VG_BASEBLOCK_WORDS 400 |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1482 | |
| 1483 | extern UInt VG_(baseBlock)[VG_BASEBLOCK_WORDS]; |
| 1484 | |
nethercote | c06e213 | 2004-09-03 13:45:29 +0000 | [diff] [blame] | 1485 | // --------------------------------------------------------------------- |
| 1486 | // Architecture-specific things defined in eg. x86/*.c |
| 1487 | // --------------------------------------------------------------------- |
| 1488 | |
nethercote | c009ebe | 2004-09-13 11:05:11 +0000 | [diff] [blame] | 1489 | // For setting up the baseBlock |
nethercote | 4ad7431 | 2004-10-26 09:59:49 +0000 | [diff] [blame] | 1490 | extern void VGA_(init_low_baseBlock) ( Addr client_ip, Addr sp_at_startup ); |
| 1491 | extern void VGA_(init_high_baseBlock) ( Addr client_ip, Addr sp_at_startup ); |
nethercote | 2e05c33 | 2004-09-06 16:43:37 +0000 | [diff] [blame] | 1492 | |
nethercote | c009ebe | 2004-09-13 11:05:11 +0000 | [diff] [blame] | 1493 | // Register state moving |
nethercote | c06e213 | 2004-09-03 13:45:29 +0000 | [diff] [blame] | 1494 | extern void VGA_(load_state) ( arch_thread_t*, ThreadId tid ); |
| 1495 | extern void VGA_(save_state) ( arch_thread_t*, ThreadId tid ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1496 | |
nethercote | c009ebe | 2004-09-13 11:05:11 +0000 | [diff] [blame] | 1497 | // Thread stuff |
nethercote | 7587d47 | 2004-09-11 23:51:50 +0000 | [diff] [blame] | 1498 | extern void VGA_(clear_thread) ( arch_thread_t* ); |
| 1499 | extern void VGA_(init_thread) ( arch_thread_t* ); |
nethercote | f9b5941 | 2004-09-10 15:33:32 +0000 | [diff] [blame] | 1500 | extern void VGA_(cleanup_thread) ( arch_thread_t* ); |
| 1501 | extern void VGA_(setup_child) ( arch_thread_t*, arch_thread_t* ); |
| 1502 | |
nethercote | 6b9c847 | 2004-09-13 13:16:40 +0000 | [diff] [blame] | 1503 | extern void VGA_(set_arg_and_bogus_ret) ( ThreadId tid, UWord arg, Addr ret ); |
| 1504 | extern void VGA_(thread_initial_stack) ( ThreadId tid, UWord arg, Addr ret ); |
| 1505 | |
nethercote | c009ebe | 2004-09-13 11:05:11 +0000 | [diff] [blame] | 1506 | // Symtab stuff |
nethercote | cd65604 | 2004-09-11 23:48:22 +0000 | [diff] [blame] | 1507 | extern UInt* VGA_(reg_addr_from_BB) ( Int reg ); |
| 1508 | extern UInt* VGA_(reg_addr_from_tst) ( Int reg, arch_thread_t* ); |
| 1509 | |
nethercote | fedd810 | 2004-09-13 15:19:34 +0000 | [diff] [blame] | 1510 | // Pointercheck |
| 1511 | extern Bool VGA_(setup_pointercheck) ( void ); |
| 1512 | |
| 1513 | // For attaching the debugger |
| 1514 | extern Int VGA_(ptrace_setregs_from_BB) ( Int pid ); |
| 1515 | extern Int VGA_(ptrace_setregs_from_tst) ( Int pid, arch_thread_t* arch ); |
| 1516 | |
| 1517 | // Making coredumps |
nethercote | 73b526f | 2004-10-31 18:48:21 +0000 | [diff] [blame] | 1518 | extern void VGA_(fill_elfregs_from_BB) ( struct vki_user_regs_struct* regs ); |
| 1519 | extern void VGA_(fill_elfregs_from_tst) ( struct vki_user_regs_struct* regs, |
nethercote | fedd810 | 2004-09-13 15:19:34 +0000 | [diff] [blame] | 1520 | const arch_thread_t* arch ); |
nethercote | 73b526f | 2004-10-31 18:48:21 +0000 | [diff] [blame] | 1521 | extern void VGA_(fill_elffpregs_from_BB) ( vki_elf_fpregset_t* fpu ); |
| 1522 | extern void VGA_(fill_elffpregs_from_tst) ( vki_elf_fpregset_t* fpu, |
nethercote | fedd810 | 2004-09-13 15:19:34 +0000 | [diff] [blame] | 1523 | const arch_thread_t* arch ); |
nethercote | 73b526f | 2004-10-31 18:48:21 +0000 | [diff] [blame] | 1524 | extern void VGA_(fill_elffpxregs_from_BB) ( vki_elf_fpxregset_t* xfpu ); |
| 1525 | extern void VGA_(fill_elffpxregs_from_tst) ( vki_elf_fpxregset_t* xfpu, |
nethercote | fedd810 | 2004-09-13 15:19:34 +0000 | [diff] [blame] | 1526 | const arch_thread_t* arch ); |
| 1527 | |
nethercote | 6eec460 | 2004-09-13 14:15:36 +0000 | [diff] [blame] | 1528 | // Signal stuff |
nethercote | 4ad7431 | 2004-10-26 09:59:49 +0000 | [diff] [blame] | 1529 | extern void VGA_(push_signal_frame) ( ThreadId tid, Addr sp_top_of_frame, |
nethercote | 73b526f | 2004-10-31 18:48:21 +0000 | [diff] [blame] | 1530 | const vki_siginfo_t *siginfo, |
nethercote | 6eec460 | 2004-09-13 14:15:36 +0000 | [diff] [blame] | 1531 | void *handler, UInt flags, |
nethercote | 73b526f | 2004-10-31 18:48:21 +0000 | [diff] [blame] | 1532 | const vki_sigset_t *mask); |
nethercote | 6eec460 | 2004-09-13 14:15:36 +0000 | [diff] [blame] | 1533 | extern Int VGA_(pop_signal_frame) ( ThreadId tid ); |
| 1534 | |
nethercote | 9b3c765 | 2004-10-19 13:18:00 +0000 | [diff] [blame] | 1535 | // libpthread stuff |
| 1536 | typedef struct arch_thread_aux arch_thread_aux_t; |
| 1537 | |
| 1538 | void VGA_(thread_create) ( arch_thread_aux_t *aux ); |
| 1539 | void VGA_(thread_wrapper)( arch_thread_aux_t *aux ); |
| 1540 | void VGA_(thread_exit) ( void ); |
| 1541 | |
| 1542 | Bool VGA_(has_tls) ( void ); |
| 1543 | |
| 1544 | #define MY__STRING(__str) #__str |
| 1545 | |
| 1546 | // Assertion to use in code running on the simulated CPU. |
| 1547 | #define my_assert(expr) \ |
| 1548 | ((void) ((expr) ? 0 : \ |
| 1549 | (VG_(user_assert_fail) (MY__STRING(expr), \ |
| 1550 | __FILE__, __LINE__, \ |
| 1551 | __PRETTY_FUNCTION__), 0))) |
| 1552 | |
| 1553 | extern void VG_(user_assert_fail) ( const Char* expr, const Char* file, |
| 1554 | Int line, const Char* fn ); |
| 1555 | |
| 1556 | |
nethercote | 41c75da | 2004-10-18 15:34:14 +0000 | [diff] [blame] | 1557 | // --------------------------------------------------------------------- |
| 1558 | // Platform-specific things defined in eg. x86/*.c |
| 1559 | // --------------------------------------------------------------------- |
nethercote | 775508a | 2004-09-07 22:38:23 +0000 | [diff] [blame] | 1560 | |
nethercote | 24e0d44 | 2004-10-18 17:36:40 +0000 | [diff] [blame] | 1561 | extern const Addr vga_sys_before, vga_sys_restarted, |
| 1562 | vga_sys_after, vga_sys_done; |
| 1563 | |
nethercote | 6eb106b | 2004-10-18 17:41:36 +0000 | [diff] [blame] | 1564 | extern void VGA_(restart_syscall)(arch_thread_t* arch); |
nethercote | 24e0d44 | 2004-10-18 17:36:40 +0000 | [diff] [blame] | 1565 | |
nethercote | 6eb106b | 2004-10-18 17:41:36 +0000 | [diff] [blame] | 1566 | extern void VGA_(thread_syscall)(Int syscallno, arch_thread_t* arch, |
nethercote | 24e0d44 | 2004-10-18 17:36:40 +0000 | [diff] [blame] | 1567 | enum PXState* state, enum PXState poststate); |
sewardj | 3b2736a | 2002-03-24 12:18:35 +0000 | [diff] [blame] | 1568 | |
| 1569 | /* --------------------------------------------------------------------- |
| 1570 | Finally - autoconf-generated settings |
| 1571 | ------------------------------------------------------------------ */ |
| 1572 | |
| 1573 | #include "config.h" |
| 1574 | |
nethercote | c06e213 | 2004-09-03 13:45:29 +0000 | [diff] [blame] | 1575 | #endif /* ndef __CORE_H */ |
| 1576 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1577 | /*--------------------------------------------------------------------*/ |
nethercote | 109d0df | 2004-09-02 08:10:13 +0000 | [diff] [blame] | 1578 | /*--- end ---*/ |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1579 | /*--------------------------------------------------------------------*/ |