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. ---*/ |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 4 | /*--- Include no other! ---*/ |
| 5 | /*--- vg_include.h ---*/ |
| 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 | |
njn | 0e1b514 | 2003-04-15 14:58:06 +0000 | [diff] [blame] | 12 | Copyright (C) 2000-2003 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 | |
| 33 | #ifndef __VG_INCLUDE_H |
| 34 | #define __VG_INCLUDE_H |
| 35 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 36 | /* --------------------------------------------------------------------- |
sewardj | 2d94c11 | 2002-06-03 01:25:54 +0000 | [diff] [blame] | 37 | Where to send bug reports to. |
| 38 | ------------------------------------------------------------------ */ |
| 39 | |
| 40 | #define VG_EMAIL_ADDR "jseward@acm.org" |
| 41 | |
| 42 | |
| 43 | /* --------------------------------------------------------------------- |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 44 | Build options and table sizes. You should be able to change these |
| 45 | options or sizes, recompile, and still have a working system. |
| 46 | ------------------------------------------------------------------ */ |
| 47 | |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame^] | 48 | /* For system call numbers __NR_... */ |
| 49 | #include "vg_unistd.h" |
| 50 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 51 | #include "vg_constants.h" |
| 52 | |
sewardj | 4cf0569 | 2002-10-27 20:28:29 +0000 | [diff] [blame] | 53 | /* All stuff visible to core and skins goes in vg_skin.h. Things |
| 54 | * visible to core but not visible to any skins should go in this |
| 55 | * file, vg_include.h. */ |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 56 | #include "vg_skin.h" |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 57 | |
| 58 | /* Total number of spill slots available for allocation, if a TempReg |
| 59 | doesn't make it into a RealReg. Just bomb the entire system if |
| 60 | this value is too small; we don't expect it will ever get |
| 61 | particularly high. */ |
| 62 | #define VG_MAX_SPILLSLOTS 24 |
| 63 | |
| 64 | |
| 65 | /* Constants for the slow translation lookup cache. */ |
| 66 | #define VG_TRANSTAB_SLOW_BITS 11 |
| 67 | #define VG_TRANSTAB_SLOW_SIZE (1 << VG_TRANSTAB_SLOW_BITS) |
| 68 | #define VG_TRANSTAB_SLOW_MASK ((VG_TRANSTAB_SLOW_SIZE) - 1) |
| 69 | |
| 70 | /* Size of a buffer used for creating messages. */ |
| 71 | #define M_VG_MSGBUF 10000 |
| 72 | |
| 73 | /* Size of a smallish table used to read /proc/self/map entries. */ |
sewardj | ebc8233 | 2002-04-24 14:44:23 +0000 | [diff] [blame] | 74 | #define M_PROCMAP_BUF 50000 |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 75 | |
| 76 | /* Max length of pathname to a .so/executable file. */ |
| 77 | #define M_VG_LIBNAMESTR 100 |
| 78 | |
| 79 | /* Max length of a text fragment used to construct error messages. */ |
| 80 | #define M_VG_ERRTXT 512 |
| 81 | |
| 82 | /* Max length of the string copied from env var VG_ARGS at startup. */ |
| 83 | #define M_VG_CMDLINE_STRLEN 1000 |
| 84 | |
| 85 | /* Max number of options for Valgrind which we can handle. */ |
| 86 | #define M_VG_CMDLINE_OPTS 100 |
| 87 | |
| 88 | /* After this many different unsuppressed errors have been observed, |
| 89 | be more conservative about collecting new ones. */ |
| 90 | #define M_VG_COLLECT_ERRORS_SLOWLY_AFTER 50 |
| 91 | |
| 92 | /* After this many different unsuppressed errors have been observed, |
| 93 | stop collecting errors at all, and tell the user their program is |
| 94 | evidently a steaming pile of camel dung. */ |
sewardj | 1bebcbf | 2002-04-24 21:24:18 +0000 | [diff] [blame] | 95 | #define M_VG_COLLECT_NO_ERRORS_AFTER_SHOWN 300 |
sewardj | f2537be | 2002-04-24 21:03:47 +0000 | [diff] [blame] | 96 | |
| 97 | /* After this many total errors have been observed, stop collecting |
| 98 | errors at all. Counterpart to M_VG_COLLECT_NO_ERRORS_AFTER_SHOWN. */ |
sewardj | 1bebcbf | 2002-04-24 21:24:18 +0000 | [diff] [blame] | 99 | #define M_VG_COLLECT_NO_ERRORS_AFTER_FOUND 30000 |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 100 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 101 | /* The maximum number of calls we're prepared to save in a |
| 102 | backtrace. */ |
| 103 | #define VG_DEEPEST_BACKTRACE 50 |
| 104 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 105 | /* Number of lists in which we keep track of ExeContexts. Should be |
| 106 | prime. */ |
sewardj | 59fb25c | 2003-09-28 16:32:58 +0000 | [diff] [blame] | 107 | #define VG_N_EC_LISTS 4999 /* a prime number */ |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 108 | |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 109 | /* Defines the thread-scheduling timeslice, in terms of the number of |
| 110 | basic blocks we attempt to run each thread for. Smaller values |
| 111 | give finer interleaving but much increased scheduling overheads. */ |
sewardj | 4505b9e | 2002-05-28 11:27:31 +0000 | [diff] [blame] | 112 | #define VG_SCHEDULING_QUANTUM 50000 |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 113 | |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame^] | 114 | /* Maximum FD Valgrind can use for its internal file descriptors. */ |
| 115 | #define VG_MAX_SAFE_FD 1024 /* usual ulimit */ |
| 116 | |
| 117 | /* Maximum allowed application-visible file descriptor. Valgrind's |
| 118 | internal fds hide above this (starting at VG_MAX_FD+1). This is |
| 119 | derived from the default fd limit (1024) minus the 2 fds per thread |
| 120 | and a small number of extra fds. */ |
| 121 | #define VG_MAX_FD (VG_MAX_SAFE_FD - (VG_N_THREADS*2 + 4)) |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 122 | |
sewardj | bf290b9 | 2002-05-01 02:28:01 +0000 | [diff] [blame] | 123 | /* Stack size for a thread. We try and check that they do not go |
| 124 | beyond it. */ |
sewardj | f0b0645 | 2002-06-04 08:38:04 +0000 | [diff] [blame] | 125 | #define VG_PTHREAD_STACK_SIZE (1 << 20) |
sewardj | bf290b9 | 2002-05-01 02:28:01 +0000 | [diff] [blame] | 126 | |
sewardj | 20917d8 | 2002-05-28 01:36:45 +0000 | [diff] [blame] | 127 | /* Number of entries in the semaphore-remapping table. */ |
| 128 | #define VG_N_SEMAPHORES 50 |
| 129 | |
| 130 | /* Number of entries in the rwlock-remapping table. */ |
sewardj | 89745a5 | 2002-09-27 01:04:29 +0000 | [diff] [blame] | 131 | #define VG_N_RWLOCKS 500 |
sewardj | 20917d8 | 2002-05-28 01:36:45 +0000 | [diff] [blame] | 132 | |
sewardj | 8ad94e1 | 2002-05-29 00:10:20 +0000 | [diff] [blame] | 133 | /* Number of entries in each thread's cleanup stack. */ |
sewardj | 61821c0 | 2003-05-04 13:02:10 +0000 | [diff] [blame] | 134 | #define VG_N_CLEANUPSTACK 16 |
sewardj | 8ad94e1 | 2002-05-29 00:10:20 +0000 | [diff] [blame] | 135 | |
sewardj | 2cb0034 | 2002-06-28 01:46:26 +0000 | [diff] [blame] | 136 | /* Number of entries in each thread's fork-handler stack. */ |
sewardj | 4700f04 | 2003-07-26 17:49:58 +0000 | [diff] [blame] | 137 | #define VG_N_FORKHANDLERSTACK 4 |
sewardj | 2cb0034 | 2002-06-28 01:46:26 +0000 | [diff] [blame] | 138 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 139 | /* Max number of callers for context in a suppression. */ |
| 140 | #define VG_N_SUPP_CALLERS 4 |
sewardj | 73cf3bc | 2002-11-03 03:20:15 +0000 | [diff] [blame] | 141 | |
njn | 6eba4ef | 2003-05-01 08:06:41 +0000 | [diff] [blame] | 142 | /* Valgrind's stack sizes, in words */ |
| 143 | #define VG_STACK_SIZE_W 10000 |
| 144 | #define VG_SIGSTACK_SIZE_W 10000 |
njn | 12a5714 | 2003-04-30 20:49:10 +0000 | [diff] [blame] | 145 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 146 | /* --------------------------------------------------------------------- |
| 147 | Basic types |
| 148 | ------------------------------------------------------------------ */ |
| 149 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 150 | /* Just pray that gcc's constant folding works properly ... */ |
| 151 | #define BITS(bit7,bit6,bit5,bit4,bit3,bit2,bit1,bit0) \ |
| 152 | ( ((bit7) << 7) | ((bit6) << 6) | ((bit5) << 5) | ((bit4) << 4) \ |
| 153 | | ((bit3) << 3) | ((bit2) << 2) | ((bit1) << 1) | (bit0)) |
| 154 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 155 | /* --------------------------------------------------------------------- |
| 156 | Command-line-settable options |
| 157 | ------------------------------------------------------------------ */ |
| 158 | |
sewardj | 4f094a7 | 2002-11-05 23:37:35 +0000 | [diff] [blame] | 159 | /* Default destination port to be used in logging over a network, if |
| 160 | none specified. */ |
| 161 | #define VG_CLO_DEFAULT_LOGPORT 1500 |
sewardj | 73cf3bc | 2002-11-03 03:20:15 +0000 | [diff] [blame] | 162 | |
| 163 | /* The max number of suppression files. */ |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 164 | #define VG_CLO_MAX_SFILES 10 |
| 165 | |
sewardj | 4cf0569 | 2002-10-27 20:28:29 +0000 | [diff] [blame] | 166 | /* Describes where logging output is to be sent. */ |
| 167 | typedef |
| 168 | enum { |
| 169 | VgLogTo_Fd, |
| 170 | VgLogTo_File, |
| 171 | VgLogTo_Socket |
| 172 | } VgLogTo; |
| 173 | |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame^] | 174 | /* pid of main process */ |
| 175 | extern Int VG_(main_pid); |
| 176 | |
| 177 | /* pgrp of process (global to all threads) */ |
| 178 | extern Int VG_(main_pgrp); |
sewardj | 4cf0569 | 2002-10-27 20:28:29 +0000 | [diff] [blame] | 179 | |
sewardj | 72f98ff | 2002-06-13 17:23:38 +0000 | [diff] [blame] | 180 | /* Should we stop collecting errors if too many appear? default: YES */ |
sewardj | 2e43290 | 2002-06-13 20:44:00 +0000 | [diff] [blame] | 181 | extern Bool VG_(clo_error_limit); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 182 | /* Enquire about whether to attach to GDB at errors? default: NO */ |
| 183 | extern Bool VG_(clo_GDB_attach); |
sewardj | 6024b21 | 2003-07-13 10:54:33 +0000 | [diff] [blame] | 184 | /* The path to GDB? default: whatever ./configure found */ |
| 185 | extern Char* VG_(clo_GDB_path); |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 186 | /* Enquire about generating a suppression for each error? default: NO */ |
| 187 | extern Bool VG_(clo_gen_suppressions); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 188 | /* Sanity-check level: 0 = none, 1 (default), > 1 = expensive. */ |
| 189 | extern Int VG_(sanity_level); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 190 | /* Automatically attempt to demangle C++ names? default: YES */ |
| 191 | extern Bool VG_(clo_demangle); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 192 | /* Simulate child processes? default: NO */ |
| 193 | extern Bool VG_(clo_trace_children); |
sewardj | 4cf0569 | 2002-10-27 20:28:29 +0000 | [diff] [blame] | 194 | |
| 195 | /* Where logging output is to be sent to. |
| 196 | |
| 197 | When log_to == VgLogTo_Fd, clo_logfile_fd holds the file id, and is |
| 198 | taken from the command line. clo_logfile_name is irrelevant. |
| 199 | |
| 200 | When log_to == VgLogTo_File, clo_logfile_name holds the logfile |
| 201 | name, and is taken from the command line. clo_logfile_fd is then |
| 202 | made to hold the relevant file id, by opening clo_logfile_name |
| 203 | (concatenated with the process ID) for writing. |
| 204 | |
| 205 | When log_to == VgLogTo_Socket, clo_logfile_name holds the |
| 206 | hostname:portnumber pair, and is taken from the command line. |
| 207 | clo_logfile_fd is then made to hold the relevant file handle, by |
| 208 | opening a connection to said hostname:portnumber pair. |
| 209 | |
| 210 | Global default is to set log_to == VgLogTo_Fd and logfile_fd == 2 |
| 211 | (stderr). */ |
| 212 | extern VgLogTo VG_(clo_log_to); |
| 213 | extern Int VG_(clo_logfile_fd); |
| 214 | extern Char* VG_(clo_logfile_name); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 215 | |
sewardj | 6024b21 | 2003-07-13 10:54:33 +0000 | [diff] [blame] | 216 | /* The file descriptor to read for input. default: 0 == stdin */ |
| 217 | extern Int VG_(clo_input_fd); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 218 | /* The number of suppression files specified. */ |
| 219 | extern Int VG_(clo_n_suppressions); |
| 220 | /* The names of the suppression files. */ |
| 221 | extern Char* VG_(clo_suppressions)[VG_CLO_MAX_SFILES]; |
| 222 | |
| 223 | /* Single stepping? default: NO */ |
| 224 | extern Bool VG_(clo_single_step); |
| 225 | /* Code improvement? default: YES */ |
| 226 | extern Bool VG_(clo_optimise); |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 227 | /* DEBUG: print generated code? default: 00000 ( == NO ) */ |
| 228 | extern Bool VG_(clo_trace_codegen); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 229 | /* DEBUG: print system calls? default: NO */ |
| 230 | extern Bool VG_(clo_trace_syscalls); |
| 231 | /* DEBUG: print signal details? default: NO */ |
| 232 | extern Bool VG_(clo_trace_signals); |
| 233 | /* DEBUG: print symtab details? default: NO */ |
| 234 | extern Bool VG_(clo_trace_symtab); |
sewardj | 8937c81 | 2002-04-12 20:12:20 +0000 | [diff] [blame] | 235 | /* DEBUG: print thread scheduling events? default: NO */ |
| 236 | extern Bool VG_(clo_trace_sched); |
sewardj | 45b4b37 | 2002-04-16 22:50:32 +0000 | [diff] [blame] | 237 | /* DEBUG: print pthread (mutex etc) events? default: 0 (none), 1 |
| 238 | (some), 2 (all) */ |
| 239 | extern Int VG_(clo_trace_pthread_level); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 240 | /* Stop after this many basic blocks. default: Infinity. */ |
| 241 | extern ULong VG_(clo_stop_after); |
| 242 | /* Display gory details for the k'th most popular error. default: |
| 243 | Infinity. */ |
| 244 | extern Int VG_(clo_dump_error); |
| 245 | /* Number of parents of a backtrace. Default: 8. */ |
| 246 | extern Int VG_(clo_backtrace_size); |
daywalker | 7e73e5f | 2003-07-04 16:18:15 +0000 | [diff] [blame] | 247 | /* Engage miscellaneous weird hacks needed for some progs. */ |
sewardj | 8d365b5 | 2002-05-12 10:52:16 +0000 | [diff] [blame] | 248 | extern Char* VG_(clo_weird_hacks); |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame^] | 249 | /* How often we should poll for signals, assuming we need to poll for |
| 250 | signals. */ |
| 251 | extern Int VG_(clo_signal_polltime); |
| 252 | |
| 253 | /* Low latency syscalls and signals */ |
| 254 | extern Bool VG_(clo_lowlat_syscalls); |
| 255 | extern Bool VG_(clo_lowlat_signals); |
| 256 | |
sewardj | 858964b | 2002-10-05 14:15:43 +0000 | [diff] [blame] | 257 | /* Should we run __libc_freeres at exit? Sometimes causes crashes. |
| 258 | Default: YES. Note this is subservient to VG_(needs).libc_freeres; |
| 259 | if the latter says False, then the setting of VG_(clo_weird_hacks) |
| 260 | is ignored. Ie if a skin says no, I don't want this to run, that |
| 261 | cannot be overridden from the command line. */ |
| 262 | extern Bool VG_(clo_run_libc_freeres); |
sewardj | b5ff83e | 2002-12-01 19:40:49 +0000 | [diff] [blame] | 263 | /* Use the basic-block chaining optimisation? Default: YES */ |
sewardj | 22854b9 | 2002-11-30 14:00:47 +0000 | [diff] [blame] | 264 | extern Bool VG_(clo_chain_bb); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 265 | |
| 266 | |
| 267 | /* --------------------------------------------------------------------- |
| 268 | Debugging and profiling stuff |
| 269 | ------------------------------------------------------------------ */ |
| 270 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 271 | /* Create a logfile into which messages can be dumped. */ |
| 272 | extern void VG_(startup_logging) ( void ); |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 273 | extern void VG_(shutdown_logging)( void ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 274 | |
| 275 | extern void VGP_(init_profiling) ( void ); |
| 276 | extern void VGP_(done_profiling) ( void ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 277 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 278 | #undef VGP_PUSHCC |
| 279 | #undef VGP_POPCC |
| 280 | #define VGP_PUSHCC(x) if (VG_(clo_profile)) VGP_(pushcc)(x) |
| 281 | #define VGP_POPCC(x) if (VG_(clo_profile)) VGP_(popcc)(x) |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 282 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 283 | /* --------------------------------------------------------------------- |
njn | 810086f | 2002-11-14 12:42:47 +0000 | [diff] [blame] | 284 | Skin-related types |
| 285 | ------------------------------------------------------------------ */ |
| 286 | /* These structs are not exposed to skins to mitigate possibility of |
| 287 | binary-incompatibilities when the core/skin interface changes. Instead, |
| 288 | set functions are provided (see include/vg_skin.h). */ |
| 289 | typedef |
| 290 | struct { |
| 291 | Char* name; |
| 292 | Char* version; |
| 293 | Char* description; |
| 294 | Char* copyright_author; |
| 295 | Char* bug_reports_to; |
njn | 120281f | 2003-02-03 12:20:07 +0000 | [diff] [blame] | 296 | UInt avg_translation_sizeB; |
njn | 810086f | 2002-11-14 12:42:47 +0000 | [diff] [blame] | 297 | } |
| 298 | VgDetails; |
| 299 | |
| 300 | extern VgDetails VG_(details); |
| 301 | |
| 302 | /* If new fields are added to this type, update: |
| 303 | * - vg_main.c:initialisation of VG_(needs) |
| 304 | * - vg_main.c:sanity_check_needs() |
| 305 | * |
| 306 | * If the name of this type or any of its fields change, update: |
| 307 | * - dependent comments (just search for "VG_(needs)"). |
| 308 | */ |
| 309 | typedef |
| 310 | struct { |
| 311 | Bool libc_freeres; |
| 312 | Bool core_errors; |
| 313 | |
| 314 | Bool skin_errors; |
| 315 | Bool basic_block_discards; |
| 316 | Bool shadow_regs; |
| 317 | Bool command_line_options; |
| 318 | Bool client_requests; |
| 319 | Bool extended_UCode; |
| 320 | Bool syscall_wrapper; |
njn | 810086f | 2002-11-14 12:42:47 +0000 | [diff] [blame] | 321 | Bool sanity_checks; |
| 322 | Bool data_syms; |
| 323 | } |
| 324 | VgNeeds; |
| 325 | |
| 326 | extern VgNeeds VG_(needs); |
| 327 | |
| 328 | /* Events happening in core to track. To be notified, assign a function |
| 329 | to the function pointer. To ignore an event, don't do anything |
| 330 | (default assignment is to NULL in which case the call is skipped). */ |
| 331 | typedef |
| 332 | struct { |
| 333 | /* Memory events */ |
| 334 | void (*new_mem_startup)( Addr a, UInt len, Bool rr, Bool ww, Bool xx ); |
njn | 810086f | 2002-11-14 12:42:47 +0000 | [diff] [blame] | 335 | void (*new_mem_stack_signal) ( Addr a, UInt len ); |
| 336 | void (*new_mem_brk) ( Addr a, UInt len ); |
| 337 | void (*new_mem_mmap) ( Addr a, UInt len, Bool rr, Bool ww, Bool xx ); |
| 338 | |
njn | 3e88418 | 2003-04-15 13:03:23 +0000 | [diff] [blame] | 339 | void (*copy_mem_remap) ( Addr from, Addr to, UInt len ); |
| 340 | void (*change_mem_mprotect) ( Addr a, UInt len, Bool rr, Bool ww, Bool xx ); |
| 341 | void (*die_mem_stack_signal) ( Addr a, UInt len ); |
| 342 | void (*die_mem_brk) ( Addr a, UInt len ); |
| 343 | void (*die_mem_munmap) ( Addr a, UInt len ); |
| 344 | |
njn | 9b007f6 | 2003-04-07 14:40:25 +0000 | [diff] [blame] | 345 | void (*new_mem_stack_4) ( Addr new_ESP ); |
| 346 | void (*new_mem_stack_8) ( Addr new_ESP ); |
| 347 | void (*new_mem_stack_12) ( Addr new_ESP ); |
| 348 | void (*new_mem_stack_16) ( Addr new_ESP ); |
| 349 | void (*new_mem_stack_32) ( Addr new_ESP ); |
| 350 | void (*new_mem_stack) ( Addr a, UInt len ); |
| 351 | |
njn | 9b007f6 | 2003-04-07 14:40:25 +0000 | [diff] [blame] | 352 | void (*die_mem_stack_4) ( Addr die_ESP ); |
| 353 | void (*die_mem_stack_8) ( Addr die_ESP ); |
| 354 | void (*die_mem_stack_12) ( Addr die_ESP ); |
| 355 | void (*die_mem_stack_16) ( Addr die_ESP ); |
| 356 | void (*die_mem_stack_32) ( Addr die_ESP ); |
| 357 | void (*die_mem_stack) ( Addr a, UInt len ); |
| 358 | |
njn | 3e88418 | 2003-04-15 13:03:23 +0000 | [diff] [blame] | 359 | void (*ban_mem_stack) ( Addr a, UInt len ); |
njn | 810086f | 2002-11-14 12:42:47 +0000 | [diff] [blame] | 360 | |
njn | 7271864 | 2003-07-24 08:45:32 +0000 | [diff] [blame] | 361 | void (*pre_mem_read) ( CorePart part, ThreadId tid, |
njn | 810086f | 2002-11-14 12:42:47 +0000 | [diff] [blame] | 362 | Char* s, Addr a, UInt size ); |
njn | 7271864 | 2003-07-24 08:45:32 +0000 | [diff] [blame] | 363 | void (*pre_mem_read_asciiz) ( CorePart part, ThreadId tid, |
njn | 810086f | 2002-11-14 12:42:47 +0000 | [diff] [blame] | 364 | Char* s, Addr a ); |
njn | 7271864 | 2003-07-24 08:45:32 +0000 | [diff] [blame] | 365 | void (*pre_mem_write) ( CorePart part, ThreadId tid, |
njn | 810086f | 2002-11-14 12:42:47 +0000 | [diff] [blame] | 366 | Char* s, Addr a, UInt size ); |
| 367 | /* Not implemented yet -- have to add in lots of places, which is a |
| 368 | pain. Won't bother unless/until there's a need. */ |
| 369 | /* void (*post_mem_read) ( ThreadState* tst, Char* s, |
| 370 | Addr a, UInt size ); */ |
| 371 | void (*post_mem_write) ( Addr a, UInt size ); |
| 372 | |
| 373 | |
njn | d304045 | 2003-05-19 15:04:06 +0000 | [diff] [blame] | 374 | /* Register events */ |
| 375 | void (*post_regs_write_init) ( void ); |
| 376 | void (*post_reg_write_syscall_return) ( ThreadId tid, UInt reg ); |
| 377 | void (*post_reg_write_deliver_signal) ( ThreadId tid, UInt reg ); |
| 378 | void (*post_reg_write_pthread_return) ( ThreadId tid, UInt reg ); |
| 379 | void (*post_reg_write_clientreq_return) ( ThreadId tid, UInt reg ); |
| 380 | void (*post_reg_write_clientcall_return) ( ThreadId tid, UInt reg, |
| 381 | Addr f ); |
| 382 | |
| 383 | |
njn | 810086f | 2002-11-14 12:42:47 +0000 | [diff] [blame] | 384 | /* Scheduler events (not exhaustive) */ |
| 385 | void (*thread_run) ( ThreadId tid ); |
| 386 | |
| 387 | |
| 388 | /* Thread events (not exhaustive) */ |
| 389 | void (*post_thread_create) ( ThreadId tid, ThreadId child ); |
| 390 | void (*post_thread_join) ( ThreadId joiner, ThreadId joinee ); |
| 391 | |
| 392 | |
| 393 | /* Mutex events (not exhaustive) */ |
| 394 | void (*pre_mutex_lock) ( ThreadId tid, |
| 395 | void* /*pthread_mutex_t* */ mutex ); |
| 396 | void (*post_mutex_lock) ( ThreadId tid, |
| 397 | void* /*pthread_mutex_t* */ mutex ); |
| 398 | void (*post_mutex_unlock) ( ThreadId tid, |
| 399 | void* /*pthread_mutex_t* */ mutex ); |
| 400 | |
njn | fdc28af | 2003-02-24 10:36:48 +0000 | [diff] [blame] | 401 | /* Signal events (not exhaustive) */ |
njn | 3e88418 | 2003-04-15 13:03:23 +0000 | [diff] [blame] | 402 | void (* pre_deliver_signal) ( ThreadId tid, Int sigNo, Bool alt_stack ); |
njn | fdc28af | 2003-02-24 10:36:48 +0000 | [diff] [blame] | 403 | void (*post_deliver_signal) ( ThreadId tid, Int sigNo ); |
| 404 | |
njn | 810086f | 2002-11-14 12:42:47 +0000 | [diff] [blame] | 405 | |
njn | fdc28af | 2003-02-24 10:36:48 +0000 | [diff] [blame] | 406 | /* Others... condition variable... */ |
njn | 810086f | 2002-11-14 12:42:47 +0000 | [diff] [blame] | 407 | /* ... */ |
| 408 | } |
| 409 | VgTrackEvents; |
| 410 | |
| 411 | extern VgTrackEvents VG_(track_events); |
| 412 | |
| 413 | |
| 414 | /* --------------------------------------------------------------------- |
| 415 | Exports of vg_needs.c |
| 416 | ------------------------------------------------------------------ */ |
| 417 | |
| 418 | void VG_(sanity_check_needs)(void); |
| 419 | |
| 420 | /* --------------------------------------------------------------------- |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 421 | Exports of vg_malloc2.c |
| 422 | ------------------------------------------------------------------ */ |
| 423 | |
| 424 | /* Allocation arenas. |
njn | 3e88418 | 2003-04-15 13:03:23 +0000 | [diff] [blame] | 425 | |
| 426 | CORE for the core's general use. |
| 427 | SKIN for the skin to use (and the only one it uses). |
| 428 | SYMTAB for Valgrind's symbol table storage. |
| 429 | JITTER for small storage during translation. |
| 430 | CLIENT for the client's mallocs/frees, if the skin replaces glibc's |
| 431 | malloc() et al -- redzone size is chosen by the skin. |
| 432 | DEMANGLE for the C++ demangler. |
| 433 | EXECTXT for storing ExeContexts. |
| 434 | ERRORS for storing CoreErrors. |
| 435 | TRANSIENT for very short-term use. It should be empty in between uses. |
| 436 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 437 | 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] | 438 | */ |
| 439 | typedef Int ArenaId; |
| 440 | |
njn | 3e88418 | 2003-04-15 13:03:23 +0000 | [diff] [blame] | 441 | #define VG_N_ARENAS 9 |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 442 | |
njn | 3e88418 | 2003-04-15 13:03:23 +0000 | [diff] [blame] | 443 | #define VG_AR_CORE 0 |
| 444 | #define VG_AR_SKIN 1 |
| 445 | #define VG_AR_SYMTAB 2 |
| 446 | #define VG_AR_JITTER 3 |
| 447 | #define VG_AR_CLIENT 4 |
| 448 | #define VG_AR_DEMANGLE 5 |
| 449 | #define VG_AR_EXECTXT 6 |
| 450 | #define VG_AR_ERRORS 7 |
| 451 | #define VG_AR_TRANSIENT 8 |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 452 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 453 | extern void* VG_(arena_malloc) ( ArenaId arena, Int nbytes ); |
| 454 | extern void VG_(arena_free) ( ArenaId arena, void* ptr ); |
njn | 3e88418 | 2003-04-15 13:03:23 +0000 | [diff] [blame] | 455 | extern void* VG_(arena_calloc) ( ArenaId arena, Int alignment, |
| 456 | Int nmemb, Int nbytes ); |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 457 | extern void* VG_(arena_realloc) ( ArenaId arena, void* ptr, Int alignment, |
| 458 | Int size ); |
| 459 | extern void* VG_(arena_malloc_aligned) ( ArenaId aid, Int req_alignB, |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 460 | Int req_pszB ); |
| 461 | |
njn | 8a6b6c0 | 2003-04-22 22:45:55 +0000 | [diff] [blame] | 462 | extern Int VG_(arena_payload_szB) ( ArenaId aid, void* payload ); |
| 463 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 464 | extern void VG_(mallocSanityCheckAll) ( void ); |
| 465 | |
| 466 | extern void VG_(show_all_arena_stats) ( void ); |
| 467 | extern Bool VG_(is_empty_arena) ( ArenaId aid ); |
| 468 | |
sewardj | ecf8e10 | 2003-07-12 12:11:39 +0000 | [diff] [blame] | 469 | /* Returns True if aa is inside any block mmap'd /dev/zero |
| 470 | by our low-level memory manager. */ |
| 471 | extern Bool VG_(is_inside_segment_mmapd_by_low_level_MM)( Addr aa ); |
| 472 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 473 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 474 | /* --------------------------------------------------------------------- |
njn | 3e88418 | 2003-04-15 13:03:23 +0000 | [diff] [blame] | 475 | Exports of vg_intercept.c |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 476 | ------------------------------------------------------------------ */ |
| 477 | |
| 478 | /* This doesn't export code or data that valgrind.so needs to link |
| 479 | against. However, the scheduler does need to know the following |
| 480 | request codes. A few, publically-visible, request codes are also |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 481 | defined in valgrind.h, and similar headers for some skins. */ |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 482 | |
njn | 4c79121 | 2003-05-02 17:53:54 +0000 | [diff] [blame] | 483 | #define VG_USERREQ__MALLOC 0x2001 |
| 484 | #define VG_USERREQ__FREE 0x2002 |
| 485 | |
sewardj | 20917d8 | 2002-05-28 01:36:45 +0000 | [diff] [blame] | 486 | /* (Fn, Arg): Create a new thread and run Fn applied to Arg in it. Fn |
| 487 | MUST NOT return -- ever. Eventually it will do either __QUIT or |
| 488 | __WAIT_JOINER. */ |
| 489 | #define VG_USERREQ__APPLY_IN_NEW_THREAD 0x3001 |
| 490 | |
| 491 | /* ( no-args ): calling thread disappears from the system forever. |
| 492 | Reclaim resources. */ |
| 493 | #define VG_USERREQ__QUIT 0x3002 |
| 494 | |
| 495 | /* ( void* ): calling thread waits for joiner and returns the void* to |
| 496 | it. */ |
| 497 | #define VG_USERREQ__WAIT_JOINER 0x3003 |
| 498 | |
| 499 | /* ( ThreadId, void** ): wait to join a thread. */ |
| 500 | #define VG_USERREQ__PTHREAD_JOIN 0x3004 |
| 501 | |
| 502 | /* Set cancellation state and type for this thread. */ |
| 503 | #define VG_USERREQ__SET_CANCELSTATE 0x3005 |
| 504 | #define VG_USERREQ__SET_CANCELTYPE 0x3006 |
| 505 | |
| 506 | /* ( no-args ): Test if we are at a cancellation point. */ |
| 507 | #define VG_USERREQ__TESTCANCEL 0x3007 |
| 508 | |
| 509 | /* ( ThreadId, &thread_exit_wrapper is the only allowable arg ): call |
| 510 | with this arg to indicate that a cancel is now pending for the |
| 511 | specified thread. */ |
| 512 | #define VG_USERREQ__SET_CANCELPEND 0x3008 |
| 513 | |
| 514 | /* Set/get detach state for this thread. */ |
| 515 | #define VG_USERREQ__SET_OR_GET_DETACH 0x3009 |
| 516 | |
| 517 | #define VG_USERREQ__PTHREAD_GET_THREADID 0x300B |
| 518 | #define VG_USERREQ__PTHREAD_MUTEX_LOCK 0x300C |
| 519 | #define VG_USERREQ__PTHREAD_MUTEX_TRYLOCK 0x300D |
| 520 | #define VG_USERREQ__PTHREAD_MUTEX_UNLOCK 0x300E |
| 521 | #define VG_USERREQ__PTHREAD_COND_WAIT 0x300F |
| 522 | #define VG_USERREQ__PTHREAD_COND_TIMEDWAIT 0x3010 |
| 523 | #define VG_USERREQ__PTHREAD_COND_SIGNAL 0x3011 |
| 524 | #define VG_USERREQ__PTHREAD_COND_BROADCAST 0x3012 |
| 525 | #define VG_USERREQ__PTHREAD_KEY_CREATE 0x3013 |
| 526 | #define VG_USERREQ__PTHREAD_KEY_DELETE 0x3014 |
sewardj | 00a66b1 | 2002-10-12 16:42:35 +0000 | [diff] [blame] | 527 | #define VG_USERREQ__PTHREAD_SETSPECIFIC_PTR 0x3015 |
| 528 | #define VG_USERREQ__PTHREAD_GETSPECIFIC_PTR 0x3016 |
sewardj | 20917d8 | 2002-05-28 01:36:45 +0000 | [diff] [blame] | 529 | #define VG_USERREQ__READ_MILLISECOND_TIMER 0x3017 |
| 530 | #define VG_USERREQ__PTHREAD_SIGMASK 0x3018 |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame^] | 531 | #define VG_USERREQ__SIGWAIT 0x3019 /* unused */ |
sewardj | 20917d8 | 2002-05-28 01:36:45 +0000 | [diff] [blame] | 532 | #define VG_USERREQ__PTHREAD_KILL 0x301A |
| 533 | #define VG_USERREQ__PTHREAD_YIELD 0x301B |
sewardj | 00a66b1 | 2002-10-12 16:42:35 +0000 | [diff] [blame] | 534 | #define VG_USERREQ__PTHREAD_KEY_VALIDATE 0x301C |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 535 | |
sewardj | 8ad94e1 | 2002-05-29 00:10:20 +0000 | [diff] [blame] | 536 | #define VG_USERREQ__CLEANUP_PUSH 0x3020 |
| 537 | #define VG_USERREQ__CLEANUP_POP 0x3021 |
sewardj | 870497a | 2002-05-29 01:06:47 +0000 | [diff] [blame] | 538 | #define VG_USERREQ__GET_KEY_D_AND_S 0x3022 |
sewardj | 8ad94e1 | 2002-05-29 00:10:20 +0000 | [diff] [blame] | 539 | |
sewardj | ef037c7 | 2002-05-30 00:40:03 +0000 | [diff] [blame] | 540 | #define VG_USERREQ__NUKE_OTHER_THREADS 0x3023 |
sewardj | efbfcdf | 2002-06-19 17:35:45 +0000 | [diff] [blame] | 541 | |
| 542 | /* Ask how many signal handler returns have happened to this |
| 543 | thread. */ |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame^] | 544 | #define VG_USERREQ__GET_N_SIGS_RETURNED 0x3024 /* unused */ |
sewardj | ef037c7 | 2002-05-30 00:40:03 +0000 | [diff] [blame] | 545 | |
sewardj | 2cb0034 | 2002-06-28 01:46:26 +0000 | [diff] [blame] | 546 | /* Get/set entries for a thread's pthread_atfork stack. */ |
| 547 | #define VG_USERREQ__SET_FHSTACK_USED 0x3025 |
| 548 | #define VG_USERREQ__GET_FHSTACK_USED 0x3026 |
| 549 | #define VG_USERREQ__SET_FHSTACK_ENTRY 0x3027 |
| 550 | #define VG_USERREQ__GET_FHSTACK_ENTRY 0x3028 |
sewardj | efbfcdf | 2002-06-19 17:35:45 +0000 | [diff] [blame] | 551 | |
sewardj | 1fe7b00 | 2002-07-16 01:43:15 +0000 | [diff] [blame] | 552 | /* Denote the finish of VG_(__libc_freeres_wrapper). */ |
| 553 | #define VG_USERREQ__LIBC_FREERES_DONE 0x3029 |
| 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 |
sewardj | 45b4b37 | 2002-04-16 22:50:32 +0000 | [diff] [blame] | 559 | |
sewardj | 54cacf0 | 2002-04-12 23:24:59 +0000 | [diff] [blame] | 560 | /* |
| 561 | In vg_constants.h: |
| 562 | #define VG_USERREQ__SIGNAL_RETURNS 0x4001 |
sewardj | 54cacf0 | 2002-04-12 23:24:59 +0000 | [diff] [blame] | 563 | */ |
| 564 | |
njn | 4c79121 | 2003-05-02 17:53:54 +0000 | [diff] [blame] | 565 | |
sewardj | 1fe7b00 | 2002-07-16 01:43:15 +0000 | [diff] [blame] | 566 | /* The scheduler does need to know the address of it so it can be |
| 567 | called at program exit. */ |
| 568 | extern void VG_(__libc_freeres_wrapper)( void ); |
| 569 | |
sewardj | 54cacf0 | 2002-04-12 23:24:59 +0000 | [diff] [blame] | 570 | |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 571 | /* --------------------------------------------------------------------- |
| 572 | Constants pertaining to the simulated CPU state, VG_(baseBlock), |
| 573 | which need to go here to avoid ugly circularities. |
| 574 | ------------------------------------------------------------------ */ |
| 575 | |
sewardj | b91ae7f | 2003-04-29 23:50:00 +0000 | [diff] [blame] | 576 | /* How big is the saved SSE/SSE2 state? Note that this subsumes the |
| 577 | FPU state. On machines without SSE, we just save/restore the FPU |
| 578 | state into the first part of this area. */ |
| 579 | /* A general comment about SSE save/restore: It appears that the 7th |
| 580 | word (which is the MXCSR) has to be &ed with 0x0000FFBF in order |
| 581 | that restoring from it later does not cause a GP fault (which is |
| 582 | delivered as a segfault). I guess this will have to be done |
| 583 | any time we do fxsave :-( 7th word means word offset 6 or byte |
| 584 | offset 24 from the start address of the save area. |
| 585 | */ |
| 586 | #define VG_SIZE_OF_SSESTATE 512 |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 587 | /* ... and in words ... */ |
sewardj | b91ae7f | 2003-04-29 23:50:00 +0000 | [diff] [blame] | 588 | #define VG_SIZE_OF_SSESTATE_W ((VG_SIZE_OF_SSESTATE+3)/4) |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 589 | |
| 590 | |
| 591 | /* --------------------------------------------------------------------- |
njn | 3e88418 | 2003-04-15 13:03:23 +0000 | [diff] [blame] | 592 | Exports of vg_defaults.c |
| 593 | ------------------------------------------------------------------ */ |
| 594 | |
| 595 | extern Bool VG_(sk_malloc_called_by_scheduler); |
| 596 | |
| 597 | |
| 598 | /* --------------------------------------------------------------------- |
sewardj | 92a5956 | 2002-09-30 00:53:10 +0000 | [diff] [blame] | 599 | Exports of vg_ldt.c |
| 600 | ------------------------------------------------------------------ */ |
| 601 | |
| 602 | /* This is the hardware-format for a segment descriptor, ie what the |
| 603 | x86 actually deals with. It is 8 bytes long. It's ugly. */ |
| 604 | |
| 605 | typedef struct _LDT_ENTRY { |
| 606 | union { |
| 607 | struct { |
| 608 | UShort LimitLow; |
| 609 | UShort BaseLow; |
| 610 | unsigned BaseMid : 8; |
| 611 | unsigned Type : 5; |
| 612 | unsigned Dpl : 2; |
| 613 | unsigned Pres : 1; |
| 614 | unsigned LimitHi : 4; |
| 615 | unsigned Sys : 1; |
| 616 | unsigned Reserved_0 : 1; |
| 617 | unsigned Default_Big : 1; |
| 618 | unsigned Granularity : 1; |
| 619 | unsigned BaseHi : 8; |
| 620 | } Bits; |
| 621 | struct { |
| 622 | UInt word1; |
| 623 | UInt word2; |
| 624 | } Words; |
| 625 | } |
| 626 | LdtEnt; |
| 627 | } VgLdtEntry; |
| 628 | |
| 629 | /* Maximum number of LDT entries supported (by the x86). */ |
| 630 | #define VG_M_LDT_ENTRIES 8192 |
| 631 | /* The size of each LDT entry == sizeof(VgLdtEntry) */ |
| 632 | #define VG_LDT_ENTRY_SIZE 8 |
| 633 | |
| 634 | /* Alloc & copy, and dealloc. */ |
| 635 | extern VgLdtEntry* |
| 636 | VG_(allocate_LDT_for_thread) ( VgLdtEntry* parent_ldt ); |
| 637 | extern void |
| 638 | VG_(deallocate_LDT_for_thread) ( VgLdtEntry* ldt ); |
| 639 | |
| 640 | /* Simulate the modify_ldt syscall. */ |
| 641 | extern Int VG_(sys_modify_ldt) ( ThreadId tid, |
| 642 | Int func, void* ptr, UInt bytecount ); |
| 643 | |
sewardj | e104247 | 2002-09-30 12:33:11 +0000 | [diff] [blame] | 644 | /* Called from generated code. Given a segment selector and a virtual |
| 645 | address, return a linear address, and do limit checks too. */ |
| 646 | extern Addr VG_(do_useseg) ( UInt seg_selector, Addr virtual_addr ); |
| 647 | |
sewardj | 92a5956 | 2002-09-30 00:53:10 +0000 | [diff] [blame] | 648 | |
| 649 | /* --------------------------------------------------------------------- |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 650 | Exports of vg_scheduler.c |
| 651 | ------------------------------------------------------------------ */ |
| 652 | |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 653 | typedef |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame^] | 654 | enum ThreadStatus { |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 655 | VgTs_Empty, /* this slot is not in use */ |
| 656 | VgTs_Runnable, /* waiting to be scheduled */ |
| 657 | VgTs_WaitJoiner, /* waiting for someone to do join on me */ |
| 658 | VgTs_WaitJoinee, /* waiting for the thread I did join on */ |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 659 | VgTs_WaitMX, /* waiting on a mutex */ |
sewardj | 3b5d886 | 2002-04-20 13:53:23 +0000 | [diff] [blame] | 660 | VgTs_WaitCV, /* waiting on a condition variable */ |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame^] | 661 | VgTs_WaitSys, /* waiting for a syscall to complete */ |
| 662 | VgTs_Sleeping, /* sleeping for a while */ |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 663 | } |
| 664 | ThreadStatus; |
sewardj | 8ad94e1 | 2002-05-29 00:10:20 +0000 | [diff] [blame] | 665 | |
| 666 | /* An entry in a threads's cleanup stack. */ |
| 667 | typedef |
| 668 | struct { |
| 669 | void (*fn)(void*); |
| 670 | void* arg; |
| 671 | } |
| 672 | CleanupEntry; |
sewardj | 2cb0034 | 2002-06-28 01:46:26 +0000 | [diff] [blame] | 673 | |
| 674 | /* An entry in a thread's fork-handler stack. */ |
| 675 | typedef |
| 676 | struct { |
| 677 | void (*prepare)(void); |
| 678 | void (*parent)(void); |
| 679 | void (*child)(void); |
| 680 | } |
| 681 | ForkHandlerEntry; |
| 682 | |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame^] | 683 | typedef struct ProxyLWP ProxyLWP; |
sewardj | 2cb0034 | 2002-06-28 01:46:26 +0000 | [diff] [blame] | 684 | |
njn | 7271864 | 2003-07-24 08:45:32 +0000 | [diff] [blame] | 685 | typedef |
| 686 | struct _ThreadState { |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 687 | /* ThreadId == 0 (and hence vg_threads[0]) is NEVER USED. |
| 688 | The thread identity is simply the index in vg_threads[]. |
| 689 | ThreadId == 1 is the root thread and has the special property |
| 690 | that we don't try and allocate or deallocate its stack. For |
| 691 | convenience of generating error message, we also put the |
| 692 | ThreadId in this tid field, but be aware that it should |
| 693 | ALWAYS == the index in vg_threads[]. */ |
| 694 | ThreadId tid; |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 695 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 696 | /* Current scheduling status. |
sewardj | 5f07b66 | 2002-04-23 16:52:51 +0000 | [diff] [blame] | 697 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 698 | Complications: whenever this is set to VgTs_WaitMX, you |
| 699 | should also set .m_edx to whatever the required return value |
| 700 | is for pthread_mutex_lock / pthread_cond_timedwait for when |
| 701 | the mutex finally gets unblocked. */ |
| 702 | ThreadStatus status; |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 703 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 704 | /* When .status == WaitMX, points to the mutex I am waiting for. |
| 705 | When .status == WaitCV, points to the mutex associated with |
| 706 | the condition variable indicated by the .associated_cv field. |
| 707 | In all other cases, should be NULL. */ |
| 708 | void* /*pthread_mutex_t* */ associated_mx; |
sewardj | 3b5d886 | 2002-04-20 13:53:23 +0000 | [diff] [blame] | 709 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 710 | /* When .status == WaitCV, points to the condition variable I am |
| 711 | waiting for. In all other cases, should be NULL. */ |
| 712 | void* /*pthread_cond_t* */ associated_cv; |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 713 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 714 | /* If VgTs_Sleeping, this is when we should wake up, measured in |
njn | 6c84655 | 2003-09-16 07:41:43 +0000 | [diff] [blame] | 715 | milliseconds as supplied by VG_(read_millisecond_timer). |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 716 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 717 | If VgTs_WaitCV, this indicates the time at which |
| 718 | pthread_cond_timedwait should wake up. If == 0xFFFFFFFF, |
| 719 | this means infinitely far in the future, viz, |
| 720 | pthread_cond_wait. */ |
| 721 | UInt awaken_at; |
sewardj | 20917d8 | 2002-05-28 01:36:45 +0000 | [diff] [blame] | 722 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 723 | /* If VgTs_WaitJoiner, return value, as generated by joinees. */ |
| 724 | void* joinee_retval; |
sewardj | 20917d8 | 2002-05-28 01:36:45 +0000 | [diff] [blame] | 725 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 726 | /* If VgTs_WaitJoinee, place to copy the return value to, and |
| 727 | the identity of the thread we're waiting for. */ |
| 728 | void** joiner_thread_return; |
| 729 | ThreadId joiner_jee_tid; |
sewardj | 8ad94e1 | 2002-05-29 00:10:20 +0000 | [diff] [blame] | 730 | |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame^] | 731 | /* If VgTs_WaitSys, this is the result of the pre-syscall check */ |
| 732 | void *sys_pre_res; |
| 733 | |
| 734 | /* If VgTs_WaitSys, this is the syscall we're currently running */ |
| 735 | Int syscallno; |
| 736 | |
| 737 | /* Details about this thread's proxy LWP */ |
| 738 | ProxyLWP *proxy; |
| 739 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 740 | /* Whether or not detached. */ |
| 741 | Bool detached; |
sewardj | 20917d8 | 2002-05-28 01:36:45 +0000 | [diff] [blame] | 742 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 743 | /* Cancelability state and type. */ |
| 744 | Bool cancel_st; /* False==PTH_CANCEL_DISABLE; True==.._ENABLE */ |
| 745 | Bool cancel_ty; /* False==PTH_CANC_ASYNCH; True==..._DEFERRED */ |
| 746 | |
| 747 | /* Pointer to fn to call to do cancellation. Indicates whether |
| 748 | or not cancellation is pending. If NULL, not pending. Else |
| 749 | should be &thread_exit_wrapper(), indicating that |
| 750 | cancallation is pending. */ |
| 751 | void (*cancel_pend)(void*); |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 752 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 753 | /* The cleanup stack. */ |
| 754 | Int custack_used; |
| 755 | CleanupEntry custack[VG_N_CLEANUPSTACK]; |
sewardj | 5f07b66 | 2002-04-23 16:52:51 +0000 | [diff] [blame] | 756 | |
sewardj | 00a66b1 | 2002-10-12 16:42:35 +0000 | [diff] [blame] | 757 | /* A pointer to the thread's-specific-data. This is handled almost |
| 758 | entirely from vg_libpthread.c. We just provide hooks to get and |
| 759 | set this ptr. This is either NULL, indicating the thread has |
| 760 | read/written none of its specifics so far, OR points to a |
| 761 | void*[VG_N_THREAD_KEYS], allocated and deallocated in |
| 762 | vg_libpthread.c. */ |
| 763 | void** specifics_ptr; |
sewardj | b48e500 | 2002-05-13 00:16:03 +0000 | [diff] [blame] | 764 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 765 | /* This thread's blocked-signals mask. Semantics is that for a |
| 766 | signal to be delivered to this thread, the signal must not be |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame^] | 767 | blocked by this signal mask. If more than one thread accepts a |
| 768 | signal, then it will be delivered to one at random. If all |
| 769 | threads block the signal, it will remain pending until either a |
| 770 | thread unblocks it or someone uses sigwaitsig/sigtimedwait. |
| 771 | |
| 772 | sig_mask reflects what the client told us its signal mask should |
| 773 | be, but isn't necessarily the current signal mask of the proxy |
| 774 | LWP: it may have more signals blocked because of signal |
| 775 | handling, or it may be different because of sigsuspend. |
| 776 | */ |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 777 | vki_ksigset_t sig_mask; |
sewardj | b48e500 | 2002-05-13 00:16:03 +0000 | [diff] [blame] | 778 | |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame^] | 779 | /* Effective signal mask. This is the mask which is currently |
| 780 | applying; it may be different from sig_mask while a signal |
| 781 | handler is running. |
| 782 | */ |
| 783 | vki_ksigset_t eff_sig_mask; |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 784 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 785 | /* Stacks. When a thread slot is freed, we don't deallocate its |
| 786 | stack; we just leave it lying around for the next use of the |
| 787 | slot. If the next use of the slot requires a larger stack, |
| 788 | only then is the old one deallocated and a new one |
| 789 | allocated. |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 790 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 791 | For the main thread (threadid == 0), this mechanism doesn't |
| 792 | apply. We don't know the size of the stack since we didn't |
| 793 | allocate it, and furthermore we never reallocate it. */ |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 794 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 795 | /* The allocated size of this thread's stack (permanently zero |
| 796 | if this is ThreadId == 0, since we didn't allocate its stack) */ |
| 797 | UInt stack_size; |
sewardj | 1e8cdc9 | 2002-04-18 11:37:52 +0000 | [diff] [blame] | 798 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 799 | /* Address of the lowest word in this thread's stack. NULL means |
| 800 | not allocated yet. |
| 801 | */ |
| 802 | Addr stack_base; |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 803 | |
sewardj | 92a5956 | 2002-09-30 00:53:10 +0000 | [diff] [blame] | 804 | /* Address of the highest legitimate word in this stack. This is |
| 805 | used for error messages only -- not critical for execution |
| 806 | correctness. Is is set for all stacks, specifically including |
| 807 | ThreadId == 0 (the main thread). */ |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 808 | Addr stack_highest_word; |
| 809 | |
sewardj | 92a5956 | 2002-09-30 00:53:10 +0000 | [diff] [blame] | 810 | /* Pointer to this thread's Local (Segment) Descriptor Table. |
| 811 | Starts out as NULL, indicating there is no table, and we hope to |
| 812 | keep it that way. If the thread does __NR_modify_ldt to create |
| 813 | entries, we allocate a 8192-entry table at that point. This is |
| 814 | a straight copy of the Linux kernel's scheme. Don't forget to |
| 815 | deallocate this at thread exit. */ |
| 816 | VgLdtEntry* ldt; |
| 817 | |
| 818 | /* Saved machine context. Note the FPU state, %EIP and segment |
| 819 | registers are not shadowed. |
| 820 | |
| 821 | Although the segment registers are 16 bits long, storage |
| 822 | management here, in VG_(baseBlock) and in VG_(m_state_static) is |
| 823 | simplified if we pretend they are 32 bits. */ |
| 824 | UInt m_cs; |
| 825 | UInt m_ss; |
| 826 | UInt m_ds; |
| 827 | UInt m_es; |
| 828 | UInt m_fs; |
| 829 | UInt m_gs; |
| 830 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 831 | UInt m_eax; |
| 832 | UInt m_ebx; |
| 833 | UInt m_ecx; |
| 834 | UInt m_edx; |
| 835 | UInt m_esi; |
| 836 | UInt m_edi; |
| 837 | UInt m_ebp; |
| 838 | UInt m_esp; |
| 839 | UInt m_eflags; |
| 840 | UInt m_eip; |
sewardj | b91ae7f | 2003-04-29 23:50:00 +0000 | [diff] [blame] | 841 | |
| 842 | /* The SSE/FPU state. This array does not (necessarily) have the |
| 843 | required 16-byte alignment required to get stuff in/out by |
| 844 | fxsave/fxrestore. So we have to do it "by hand". |
| 845 | */ |
| 846 | UInt m_sse[VG_SIZE_OF_SSESTATE_W]; |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 847 | |
| 848 | UInt sh_eax; |
| 849 | UInt sh_ebx; |
| 850 | UInt sh_ecx; |
| 851 | UInt sh_edx; |
| 852 | UInt sh_esi; |
| 853 | UInt sh_edi; |
| 854 | UInt sh_ebp; |
| 855 | UInt sh_esp; |
| 856 | UInt sh_eflags; |
njn | 7271864 | 2003-07-24 08:45:32 +0000 | [diff] [blame] | 857 | } |
| 858 | ThreadState; |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 859 | |
| 860 | |
sewardj | 018f762 | 2002-05-15 21:13:39 +0000 | [diff] [blame] | 861 | /* The thread table. */ |
| 862 | extern ThreadState VG_(threads)[VG_N_THREADS]; |
| 863 | |
| 864 | /* Check that tid is in range and denotes a non-Empty thread. */ |
sewardj | b48e500 | 2002-05-13 00:16:03 +0000 | [diff] [blame] | 865 | extern Bool VG_(is_valid_tid) ( ThreadId tid ); |
| 866 | |
sewardj | 018f762 | 2002-05-15 21:13:39 +0000 | [diff] [blame] | 867 | /* Check that tid is in range. */ |
| 868 | extern Bool VG_(is_valid_or_empty_tid) ( ThreadId tid ); |
| 869 | |
njn | 7271864 | 2003-07-24 08:45:32 +0000 | [diff] [blame] | 870 | /* Determine if 'tid' is that of the current running thread (Nb: returns |
| 871 | False if no thread is currently running. */ |
| 872 | extern Bool VG_(is_running_thread)(ThreadId tid); |
| 873 | |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame^] | 874 | /* Get the ThreadState for a particular thread */ |
| 875 | extern ThreadState *VG_(get_ThreadState)(ThreadId tid); |
| 876 | |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 877 | /* Copy the specified thread's state into VG_(baseBlock) in |
| 878 | preparation for running it. */ |
| 879 | extern void VG_(load_thread_state)( ThreadId ); |
| 880 | |
| 881 | /* Save the specified thread's state back in VG_(baseBlock), and fill |
| 882 | VG_(baseBlock) with junk, for sanity-check reasons. */ |
| 883 | extern void VG_(save_thread_state)( ThreadId ); |
| 884 | |
sewardj | 1e8cdc9 | 2002-04-18 11:37:52 +0000 | [diff] [blame] | 885 | /* And for the currently running one, if valid. */ |
| 886 | extern ThreadState* VG_(get_current_thread_state) ( void ); |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 887 | |
sewardj | 1e8cdc9 | 2002-04-18 11:37:52 +0000 | [diff] [blame] | 888 | /* Similarly ... */ |
| 889 | extern ThreadId VG_(get_current_tid) ( void ); |
| 890 | |
sewardj | ccef2e6 | 2002-05-29 19:26:32 +0000 | [diff] [blame] | 891 | /* Nuke all threads except tid. */ |
| 892 | extern void VG_(nuke_all_threads_except) ( ThreadId me ); |
| 893 | |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame^] | 894 | /* Give a hint to the scheduler that it may be a good time to find a |
| 895 | new runnable thread. If prefer_sched != VG_INVALID_THREADID, then |
| 896 | try to schedule that thread. |
| 897 | */ |
| 898 | extern void VG_(need_resched) ( ThreadId prefer_sched ); |
| 899 | |
| 900 | /* Add a new timeout event for a thread*/ |
| 901 | extern void VG_(add_timeout) ( ThreadId tid, UInt time ); |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 902 | |
| 903 | /* Return codes from the scheduler. */ |
| 904 | typedef |
sewardj | 7e87e38 | 2002-05-03 19:09:05 +0000 | [diff] [blame] | 905 | enum { |
| 906 | VgSrc_Deadlock, /* no runnable threads and no prospect of any |
| 907 | even if we wait for a long time */ |
| 908 | VgSrc_ExitSyscall, /* client called exit(). This is the normal |
| 909 | route out. */ |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame^] | 910 | VgSrc_BbsDone, /* In a debugging run, the specified number of |
sewardj | 7e87e38 | 2002-05-03 19:09:05 +0000 | [diff] [blame] | 911 | bbs has been completed. */ |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame^] | 912 | VgSrc_FatalSig /* Killed by the default action of a fatal |
| 913 | signal */ |
sewardj | 7e87e38 | 2002-05-03 19:09:05 +0000 | [diff] [blame] | 914 | } |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 915 | VgSchedReturnCode; |
| 916 | |
sewardj | 7e87e38 | 2002-05-03 19:09:05 +0000 | [diff] [blame] | 917 | |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 918 | /* The scheduler. */ |
| 919 | extern VgSchedReturnCode VG_(scheduler) ( void ); |
| 920 | |
| 921 | extern void VG_(scheduler_init) ( void ); |
| 922 | |
sewardj | 15a43e1 | 2002-04-17 19:35:12 +0000 | [diff] [blame] | 923 | extern void VG_(pp_sched_status) ( void ); |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 924 | |
| 925 | /* vg_oursignalhandler() might longjmp(). Here's the jmp_buf. */ |
| 926 | extern jmp_buf VG_(scheduler_jmpbuf); |
sewardj | 872051c | 2002-07-13 12:12:56 +0000 | [diff] [blame] | 927 | /* This says whether scheduler_jmpbuf is actually valid. Needed so |
| 928 | that our signal handler doesn't longjmp when the buffer isn't |
| 929 | actually valid. */ |
| 930 | extern Bool VG_(scheduler_jmpbuf_valid); |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 931 | /* ... and if so, here's the signal which caused it to do so. */ |
| 932 | extern Int VG_(longjmpd_on_signal); |
| 933 | |
| 934 | |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 935 | /* The red-zone size which we put at the bottom (highest address) of |
| 936 | thread stacks, for paranoia reasons. This can be arbitrary, and |
| 937 | doesn't really need to be set at compile time. */ |
| 938 | #define VG_AR_CLIENT_STACKBASE_REDZONE_SZW 4 |
| 939 | |
| 940 | #define VG_AR_CLIENT_STACKBASE_REDZONE_SZB \ |
| 941 | (VG_AR_CLIENT_STACKBASE_REDZONE_SZW * VKI_BYTES_PER_WORD) |
| 942 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 943 | /* Junk to fill up a thread's shadow regs with when shadow regs aren't |
njn | d304045 | 2003-05-19 15:04:06 +0000 | [diff] [blame] | 944 | being used. */ |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 945 | #define VG_UNUSED_SHADOW_REG_VALUE 0x27182818 |
njn | d304045 | 2003-05-19 15:04:06 +0000 | [diff] [blame] | 946 | /* For sanity checking: if this ends up in a thread's shadow regs when |
| 947 | shadow regs aren't being used, something went wrong. */ |
| 948 | #define VG_USED_SHADOW_REG_VALUE 0x31415927 |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 949 | |
njn | d304045 | 2003-05-19 15:04:06 +0000 | [diff] [blame] | 950 | /* Write a value to a client's thread register, and shadow (if necessary) */ |
| 951 | #define SET_THREAD_REG( zztid, zzval, zzreg, zzREG, zzevent, zzargs... ) \ |
| 952 | do { VG_(threads)[zztid].m_##zzreg = (zzval); \ |
| 953 | VG_TRACK( zzevent, zztid, R_##zzREG, ##zzargs ); \ |
sewardj | 018f762 | 2002-05-15 21:13:39 +0000 | [diff] [blame] | 954 | } while (0) |
| 955 | |
njn | d304045 | 2003-05-19 15:04:06 +0000 | [diff] [blame] | 956 | #define SET_SYSCALL_RETVAL(zztid, zzval) \ |
| 957 | SET_THREAD_REG(zztid, zzval, eax, EAX, post_reg_write_syscall_return) |
| 958 | |
| 959 | #define SET_SIGNAL_EDX(zztid, zzval) \ |
| 960 | SET_THREAD_REG(zztid, zzval, edx, EDX, post_reg_write_deliver_signal) |
| 961 | |
| 962 | #define SET_SIGNAL_ESP(zztid, zzval) \ |
| 963 | SET_THREAD_REG(zztid, zzval, esp, ESP, post_reg_write_deliver_signal) |
| 964 | |
| 965 | #define SET_CLREQ_RETVAL(zztid, zzval) \ |
| 966 | SET_THREAD_REG(zztid, zzval, edx, EDX, post_reg_write_clientreq_return) |
| 967 | |
| 968 | #define SET_CLCALL_RETVAL(zztid, zzval, f) \ |
| 969 | SET_THREAD_REG(zztid, zzval, edx, EDX, post_reg_write_clientcall_return, f) |
| 970 | |
| 971 | #define SET_PTHREQ_ESP(zztid, zzval) \ |
| 972 | SET_THREAD_REG(zztid, zzval, esp, ESP, post_reg_write_pthread_return) |
| 973 | |
| 974 | #define SET_PTHREQ_RETVAL(zztid, zzval) \ |
| 975 | SET_THREAD_REG(zztid, zzval, edx, EDX, post_reg_write_pthread_return) |
sewardj | 018f762 | 2002-05-15 21:13:39 +0000 | [diff] [blame] | 976 | |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 977 | |
sewardj | d8acdf2 | 2002-11-13 21:57:52 +0000 | [diff] [blame] | 978 | /* This is or'd into a pthread mutex's __m_kind field if it is used |
| 979 | before Valgrind is up and running (prehistory). This is used so |
| 980 | that if some early code (like the dynamic linker) takes a lock |
| 981 | before Valgrind starts and then releases it afterwards, we can work |
| 982 | out what's happening. */ |
| 983 | #define VG_PTHREAD_PREHISTORY 0x80000000 |
| 984 | |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 985 | /* --------------------------------------------------------------------- |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 986 | Exports of vg_signals.c |
| 987 | ------------------------------------------------------------------ */ |
| 988 | |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame^] | 989 | extern Bool VG_(do_signal_routing); /* whether scheduler LWP has to route signals */ |
| 990 | |
| 991 | /* RT signal allocation */ |
| 992 | extern Int VG_(sig_rtmin); |
| 993 | extern Int VG_(sig_rtmax); |
| 994 | extern Int VG_(sig_alloc_rtsig) ( Int high ); |
| 995 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 996 | extern void VG_(sigstartup_actions) ( void ); |
sewardj | 839299f | 2003-06-14 11:57:59 +0000 | [diff] [blame] | 997 | extern void VG_(sigshutdown_actions) ( void ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 998 | |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame^] | 999 | extern void VG_(deliver_signal) ( ThreadId tid, const vki_ksiginfo_t *, Bool async ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1000 | extern void VG_(unblock_host_signal) ( Int sigNo ); |
sewardj | 018f762 | 2002-05-15 21:13:39 +0000 | [diff] [blame] | 1001 | extern void VG_(handle_SCSS_change) ( Bool force_update ); |
| 1002 | |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame^] | 1003 | extern Bool VG_(is_sig_ign) ( Int sigNo ); |
| 1004 | |
| 1005 | /* Route pending signals from the scheduler LWP to the appropriate |
| 1006 | thread LWP. */ |
| 1007 | extern void VG_(route_signals) ( void ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1008 | |
| 1009 | /* Fake system calls for signal handling. */ |
sewardj | 2342c97 | 2002-05-22 23:34:20 +0000 | [diff] [blame] | 1010 | extern void VG_(do__NR_sigaltstack) ( ThreadId tid ); |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 1011 | extern void VG_(do__NR_sigaction) ( ThreadId tid ); |
sewardj | 018f762 | 2002-05-15 21:13:39 +0000 | [diff] [blame] | 1012 | extern void VG_(do__NR_sigprocmask) ( ThreadId tid, |
| 1013 | Int how, |
| 1014 | vki_ksigset_t* set, |
| 1015 | vki_ksigset_t* oldset ); |
| 1016 | extern void VG_(do_pthread_sigmask_SCSS_upd) ( ThreadId tid, |
| 1017 | Int how, |
| 1018 | vki_ksigset_t* set, |
| 1019 | vki_ksigset_t* oldset ); |
| 1020 | extern void VG_(send_signal_to_thread) ( ThreadId thread, |
| 1021 | Int signo ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1022 | |
sewardj | efbfcdf | 2002-06-19 17:35:45 +0000 | [diff] [blame] | 1023 | extern void VG_(do_sigpending) ( ThreadId tid, vki_ksigset_t* set ); |
| 1024 | |
| 1025 | |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 1026 | /* Modify the current thread's state once we have detected it is |
| 1027 | returning from a signal handler. */ |
sewardj | 77e466c | 2002-04-14 02:29:29 +0000 | [diff] [blame] | 1028 | extern Bool VG_(signal_returns) ( ThreadId ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1029 | |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 1030 | /* Handy utilities to block/restore all host signals. */ |
| 1031 | extern void VG_(block_all_host_signals) |
| 1032 | ( /* OUT */ vki_ksigset_t* saved_mask ); |
sewardj | 018f762 | 2002-05-15 21:13:39 +0000 | [diff] [blame] | 1033 | extern void VG_(restore_all_host_signals) |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 1034 | ( /* IN */ vki_ksigset_t* saved_mask ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1035 | |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame^] | 1036 | extern vki_ksiginfo_t VG_(unresumable_siginfo); |
| 1037 | |
| 1038 | extern void VG_(kill_self)(Int sigNo); |
| 1039 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1040 | /* --------------------------------------------------------------------- |
| 1041 | Exports of vg_mylibc.c |
| 1042 | ------------------------------------------------------------------ */ |
| 1043 | |
njn | e427a66 | 2002-10-02 11:08:25 +0000 | [diff] [blame] | 1044 | #define vg_assert(expr) \ |
| 1045 | ((void) ((expr) ? 0 : \ |
| 1046 | (VG_(core_assert_fail) (VG__STRING(expr), \ |
| 1047 | __FILE__, __LINE__, \ |
| 1048 | __PRETTY_FUNCTION__), 0))) |
| 1049 | __attribute__ ((__noreturn__)) |
daywalker | 3222e0a | 2003-09-18 01:39:50 +0000 | [diff] [blame] | 1050 | extern void VG_(core_assert_fail) ( const Char* expr, const Char* file, |
| 1051 | Int line, const Char* fn ); |
njn | e427a66 | 2002-10-02 11:08:25 +0000 | [diff] [blame] | 1052 | __attribute__ ((__noreturn__)) |
| 1053 | extern void VG_(core_panic) ( Char* str ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1054 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 1055 | /* VG_(brk) not public so skins cannot screw with curr_dataseg_end */ |
| 1056 | extern void* VG_(brk) ( void* end_data_segment ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1057 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 1058 | /* Skins use VG_(strdup)() which doesn't expose ArenaId */ |
| 1059 | extern Char* VG_(arena_strdup) ( ArenaId aid, const Char* s); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1060 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 1061 | /* Skins shouldn't need these...(?) */ |
sewardj | 5f07b66 | 2002-04-23 16:52:51 +0000 | [diff] [blame] | 1062 | extern void VG_(start_rdtsc_calibration) ( void ); |
| 1063 | extern void VG_(end_rdtsc_calibration) ( void ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1064 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 1065 | extern Int VG_(fcntl) ( Int fd, Int cmd, Int arg ); |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 1066 | extern Int VG_(select)( Int n, |
| 1067 | vki_fd_set* readfds, |
| 1068 | vki_fd_set* writefds, |
| 1069 | vki_fd_set* exceptfds, |
| 1070 | struct vki_timeval * timeout ); |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame^] | 1071 | extern Int VG_(poll)( struct vki_pollfd *, UInt nfds, Int timeout); |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 1072 | extern Int VG_(nanosleep)( const struct vki_timespec *req, |
| 1073 | struct vki_timespec *rem ); |
| 1074 | |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame^] | 1075 | /* Move an fd into the Valgrind-safe range */ |
| 1076 | Int VG_(safe_fd)(Int oldfd); |
| 1077 | |
sewardj | 570f890 | 2002-11-03 11:44:36 +0000 | [diff] [blame] | 1078 | extern Int VG_(write_socket)( Int sd, void *msg, Int count ); |
sewardj | 73cf3bc | 2002-11-03 03:20:15 +0000 | [diff] [blame] | 1079 | |
| 1080 | /* --- Connecting over the network --- */ |
| 1081 | extern Int VG_(connect_via_socket)( UChar* str ); |
| 1082 | |
sewardj | 570f890 | 2002-11-03 11:44:36 +0000 | [diff] [blame] | 1083 | |
| 1084 | /* --------------------------------------------------------------------- |
| 1085 | Exports of vg_message.c |
| 1086 | ------------------------------------------------------------------ */ |
| 1087 | |
| 1088 | /* Low-level -- send bytes directly to the message sink. Do not |
| 1089 | use. */ |
| 1090 | extern void VG_(send_bytes_to_logging_sink) ( Char* msg, Int nbytes ); |
| 1091 | |
| 1092 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1093 | /* --------------------------------------------------------------------- |
| 1094 | Definitions for the JITter (vg_translate.c, vg_to_ucode.c, |
| 1095 | vg_from_ucode.c). |
| 1096 | ------------------------------------------------------------------ */ |
| 1097 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1098 | #define VG_IS_FLAG_SUBSET(set1,set2) \ |
| 1099 | (( ((FlagSet)set1) & ((FlagSet)set2) ) == ((FlagSet)set1) ) |
| 1100 | |
| 1101 | #define VG_UNION_FLAG_SETS(set1,set2) \ |
| 1102 | ( ((FlagSet)set1) | ((FlagSet)set2) ) |
| 1103 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1104 | /* --------------------------------------------------------------------- |
| 1105 | Exports of vg_demangle.c |
| 1106 | ------------------------------------------------------------------ */ |
| 1107 | |
| 1108 | extern void VG_(demangle) ( Char* orig, Char* result, Int result_size ); |
| 1109 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1110 | /* --------------------------------------------------------------------- |
| 1111 | Exports of vg_from_ucode.c |
| 1112 | ------------------------------------------------------------------ */ |
| 1113 | |
sewardj | 22854b9 | 2002-11-30 14:00:47 +0000 | [diff] [blame] | 1114 | 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] | 1115 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 1116 | extern void VG_(print_ccall_stats) ( void ); |
| 1117 | extern void VG_(print_UInstr_histogram) ( void ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1118 | |
sewardj | 22854b9 | 2002-11-30 14:00:47 +0000 | [diff] [blame] | 1119 | extern void VG_(unchain_jumpsite) ( Addr jumpsite ); |
| 1120 | extern Addr VG_(get_jmp_dest) ( Addr jumpsite ); |
| 1121 | extern Bool VG_(is_unchained_jumpsite) ( Addr jumpsite ); |
| 1122 | extern Bool VG_(is_chained_jumpsite) ( Addr jumpsite ); |
| 1123 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1124 | /* --------------------------------------------------------------------- |
| 1125 | Exports of vg_to_ucode.c |
| 1126 | ------------------------------------------------------------------ */ |
| 1127 | |
| 1128 | extern Int VG_(disBB) ( UCodeBlock* cb, Addr eip0 ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1129 | |
| 1130 | /* --------------------------------------------------------------------- |
| 1131 | Exports of vg_translate.c |
| 1132 | ------------------------------------------------------------------ */ |
| 1133 | |
njn | 810086f | 2002-11-14 12:42:47 +0000 | [diff] [blame] | 1134 | /* Expandable arrays of uinstrs. */ |
| 1135 | struct _UCodeBlock { |
sewardj | 22854b9 | 2002-11-30 14:00:47 +0000 | [diff] [blame] | 1136 | Addr orig_eip; |
njn | 810086f | 2002-11-14 12:42:47 +0000 | [diff] [blame] | 1137 | Int used; |
| 1138 | Int size; |
| 1139 | UInstr* instrs; |
| 1140 | Int nextTemp; |
| 1141 | }; |
| 1142 | |
| 1143 | extern UCodeBlock* VG_(alloc_UCodeBlock) ( void ); |
| 1144 | |
njn | 7271864 | 2003-07-24 08:45:32 +0000 | [diff] [blame] | 1145 | extern void VG_(translate) ( ThreadId tid, |
sewardj | 1e8cdc9 | 2002-04-18 11:37:52 +0000 | [diff] [blame] | 1146 | Addr orig_addr, |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1147 | UInt* orig_size, |
| 1148 | Addr* trans_addr, |
sewardj | 22854b9 | 2002-11-30 14:00:47 +0000 | [diff] [blame] | 1149 | UInt* trans_size, |
| 1150 | UShort jumps[VG_MAX_JUMPS]); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1151 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 1152 | extern Bool VG_(saneUInstr) ( Bool beforeRA, Bool beforeLiveness, |
| 1153 | UInstr* u ); |
| 1154 | extern void VG_(saneUCodeBlock) ( UCodeBlock* cb ); |
| 1155 | extern Bool VG_(saneUCodeBlockCalls) ( UCodeBlock* cb ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1156 | |
sewardj | b5ff83e | 2002-12-01 19:40:49 +0000 | [diff] [blame] | 1157 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1158 | /* --------------------------------------------------------------------- |
| 1159 | Exports of vg_execontext.c. |
| 1160 | ------------------------------------------------------------------ */ |
| 1161 | |
| 1162 | /* Records the PC and a bit of the call chain. The first 4 %eip |
| 1163 | values are used in comparisons do remove duplicate errors, and for |
| 1164 | comparing against suppression specifications. The rest are purely |
| 1165 | informational (but often important). */ |
| 1166 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 1167 | struct _ExeContext { |
| 1168 | struct _ExeContext * next; |
| 1169 | /* Variable-length array. The size is VG_(clo_backtrace_size); at |
njn | 6c84655 | 2003-09-16 07:41:43 +0000 | [diff] [blame] | 1170 | least 1, at most VG_DEEPEST_BACKTRACE. [0] is the current %eip, |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 1171 | [1] is its caller, [2] is the caller of [1], etc. */ |
| 1172 | Addr eips[0]; |
| 1173 | }; |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1174 | |
| 1175 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1176 | /* Print stats (informational only). */ |
| 1177 | extern void VG_(show_ExeContext_stats) ( void ); |
| 1178 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 1179 | /* Like VG_(get_ExeContext), but with a slightly different type */ |
| 1180 | extern ExeContext* VG_(get_ExeContext2) ( Addr eip, Addr ebp, |
| 1181 | Addr ebp_min, Addr ebp_max ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1182 | |
| 1183 | |
| 1184 | /* --------------------------------------------------------------------- |
| 1185 | Exports of vg_errcontext.c. |
| 1186 | ------------------------------------------------------------------ */ |
| 1187 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 1188 | /* Note: it is imperative this doesn't overlap with (0..) at all, as skins |
| 1189 | * effectively extend it by defining their own enums in the (0..) range. */ |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1190 | typedef |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 1191 | enum { |
| 1192 | PThreadSupp = -1, /* Matches PThreadErr */ |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1193 | } |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 1194 | CoreSuppKind; |
| 1195 | |
| 1196 | /* For each caller specified for a suppression, record the nature of |
| 1197 | the caller name. Not of interest to skins. */ |
| 1198 | typedef |
| 1199 | enum { |
| 1200 | ObjName, /* Name is of an shared object file. */ |
| 1201 | FunName /* Name is of a function. */ |
| 1202 | } |
| 1203 | SuppLocTy; |
| 1204 | |
njn | 810086f | 2002-11-14 12:42:47 +0000 | [diff] [blame] | 1205 | /* Suppressions. Skins can get/set skin-relevant parts with functions |
| 1206 | declared in include/vg_skin.h. Extensible via the 'extra' field. |
| 1207 | Skins can use a normal enum (with element values in the normal range |
| 1208 | (0..)) for `skind'. */ |
| 1209 | struct _Supp { |
| 1210 | struct _Supp* next; |
| 1211 | /* The number of times this error has been suppressed. */ |
| 1212 | Int count; |
| 1213 | /* The name by which the suppression is referred to. */ |
| 1214 | Char* sname; |
| 1215 | /* First two (name of fn where err occurs, and immediate caller) |
| 1216 | * are mandatory; extra two are optional. */ |
| 1217 | SuppLocTy caller_ty[VG_N_SUPP_CALLERS]; |
| 1218 | Char* caller [VG_N_SUPP_CALLERS]; |
| 1219 | |
| 1220 | /* The skin-specific part */ |
| 1221 | /* What kind of suppression. Must use the range (0..) */ |
| 1222 | SuppKind skind; |
| 1223 | /* String -- use is optional. NULL by default. */ |
| 1224 | Char* string; |
| 1225 | /* Anything else -- use is optional. NULL by default. */ |
| 1226 | void* extra; |
| 1227 | }; |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 1228 | |
| 1229 | /* Note: it is imperative this doesn't overlap with (0..) at all, as skins |
| 1230 | * effectively extend it by defining their own enums in the (0..) range. */ |
| 1231 | typedef |
| 1232 | enum { |
| 1233 | PThreadErr = -1, /* Pthreading error */ |
| 1234 | } |
| 1235 | CoreErrorKind; |
| 1236 | |
njn | 810086f | 2002-11-14 12:42:47 +0000 | [diff] [blame] | 1237 | /* Errors. Extensible (via the 'extra' field). Skins can use a normal |
| 1238 | enum (with element values in the normal range (0..)) for `ekind'. |
| 1239 | Functions for getting/setting the skin-relevant fields are in |
| 1240 | include/vg_skin.h. |
| 1241 | |
| 1242 | When errors are found and recorded with VG_(maybe_record_error)(), all |
| 1243 | the skin must do is pass in the four parameters; core will |
| 1244 | allocate/initialise the error record. |
| 1245 | */ |
| 1246 | struct _Error { |
| 1247 | struct _Error* next; |
| 1248 | /* NULL if unsuppressed; or ptr to suppression record. */ |
| 1249 | Supp* supp; |
| 1250 | Int count; |
njn | 810086f | 2002-11-14 12:42:47 +0000 | [diff] [blame] | 1251 | ThreadId tid; |
njn | 810086f | 2002-11-14 12:42:47 +0000 | [diff] [blame] | 1252 | |
| 1253 | /* The skin-specific part */ |
njn | ae17bec | 2003-01-28 19:59:38 +0000 | [diff] [blame] | 1254 | /* Initialised by core */ |
| 1255 | ExeContext* where; |
njn | 810086f | 2002-11-14 12:42:47 +0000 | [diff] [blame] | 1256 | /* Used by ALL. Must be in the range (0..) */ |
| 1257 | Int ekind; |
| 1258 | /* Used frequently */ |
| 1259 | Addr addr; |
| 1260 | /* Used frequently */ |
| 1261 | Char* string; |
| 1262 | /* For any skin-specific extras */ |
| 1263 | void* extra; |
| 1264 | }; |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1265 | |
| 1266 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 1267 | extern void VG_(load_suppressions) ( void ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1268 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 1269 | extern void VG_(record_pthread_error) ( ThreadId tid, Char* msg ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1270 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 1271 | extern void VG_(show_all_errors) ( void ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1272 | |
njn | 43c799e | 2003-04-08 00:08:52 +0000 | [diff] [blame] | 1273 | extern Bool VG_(is_action_requested) ( Char* action, Bool* clo ); |
| 1274 | |
| 1275 | extern void VG_(gen_suppression) ( Error* err ); |
sewardj | 99aac97 | 2002-12-26 01:53:45 +0000 | [diff] [blame] | 1276 | |
njn | 47363ab | 2003-04-21 13:24:40 +0000 | [diff] [blame] | 1277 | extern UInt VG_(n_errs_found); |
| 1278 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1279 | /* --------------------------------------------------------------------- |
| 1280 | Exports of vg_procselfmaps.c |
| 1281 | ------------------------------------------------------------------ */ |
| 1282 | |
njn | fa1016e | 2003-09-25 17:54:11 +0000 | [diff] [blame] | 1283 | /* Reads /proc/self/maps into a static buffer which can be parsed by |
| 1284 | VG_(parse_procselfmaps)(). */ |
| 1285 | extern void VG_(read_procselfmaps) ( void ); |
njn | 3e88418 | 2003-04-15 13:03:23 +0000 | [diff] [blame] | 1286 | |
| 1287 | /* Parses /proc/self/maps, calling `record_mapping' for each entry. If |
| 1288 | `read_from_file' is True, /proc/self/maps is read directly, otherwise |
| 1289 | it's read from the buffer filled by VG_(read_procselfmaps_contents)(). */ |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1290 | extern |
njn | fa1016e | 2003-09-25 17:54:11 +0000 | [diff] [blame] | 1291 | void VG_(parse_procselfmaps) ( |
| 1292 | void (*record_mapping)( Addr, UInt, Char, Char, Char, UInt, UChar* ) |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1293 | ); |
| 1294 | |
| 1295 | |
| 1296 | /* --------------------------------------------------------------------- |
| 1297 | Exports of vg_symtab2.c |
| 1298 | ------------------------------------------------------------------ */ |
| 1299 | |
njn | fa1016e | 2003-09-25 17:54:11 +0000 | [diff] [blame] | 1300 | extern void VG_(mini_stack_dump) ( Addr eips[], UInt n_eips ); |
| 1301 | extern void VG_(read_all_symbols) ( void ); |
| 1302 | extern void VG_(read_seg_symbols) ( Addr start, UInt size, |
| 1303 | Char rr, Char ww, Char xx, |
| 1304 | UInt foffset, UChar* filename ); |
| 1305 | extern void VG_(unload_symbols) ( Addr start, UInt length ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1306 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 1307 | extern Bool VG_(get_fnname_nodemangle)( Addr a, Char* fnname, Int n_fnname ); |
sewardj | 25c7c3a | 2003-07-10 00:17:58 +0000 | [diff] [blame] | 1308 | extern Int VG_(setup_code_redirect_table) ( void ); |
| 1309 | |
| 1310 | typedef |
| 1311 | struct { |
| 1312 | Addr entry_pt_orig; |
| 1313 | Addr entry_pt_subst; |
| 1314 | } |
| 1315 | CodeRedirect; |
| 1316 | |
| 1317 | #define VG_N_CODE_REDIRECTS 10 |
| 1318 | extern CodeRedirect VG_(code_redirect_table)[VG_N_CODE_REDIRECTS]; |
| 1319 | /* Table is terminated by a NULL entry_pt_orig field. */ |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1320 | |
| 1321 | |
| 1322 | /* --------------------------------------------------------------------- |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1323 | Exports of vg_main.c |
| 1324 | ------------------------------------------------------------------ */ |
| 1325 | |
sewardj | b91ae7f | 2003-04-29 23:50:00 +0000 | [diff] [blame] | 1326 | /* Is this a SSE/SSE2-capable CPU? If so, we had better save/restore |
| 1327 | the SSE state all over the place. This is set up very early, in |
| 1328 | vg_startup.S. We have to determine it early since we can't even |
| 1329 | correctly snapshot the startup machine state without it. */ |
| 1330 | extern Bool VG_(have_ssestate); |
| 1331 | |
sewardj | 73cf3bc | 2002-11-03 03:20:15 +0000 | [diff] [blame] | 1332 | /* Tell the logging mechanism whether we are logging to a file |
| 1333 | descriptor or a socket descriptor. */ |
| 1334 | extern Bool VG_(logging_to_filedes); |
| 1335 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 1336 | /* Sanity checks which may be done at any time. The scheduler decides when. */ |
| 1337 | extern void VG_(do_sanity_checks) ( Bool force_expensive ); |
| 1338 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1339 | /* A structure used as an intermediary when passing the simulated |
| 1340 | CPU's state to some assembly fragments, particularly system calls. |
| 1341 | Stuff is copied from baseBlock to here, the assembly magic runs, |
sewardj | b91ae7f | 2003-04-29 23:50:00 +0000 | [diff] [blame] | 1342 | and then the inverse copy is done. Alignment: the SSE state must |
| 1343 | be 16-byte aligned. We ask for the whole struct to be 16-byte |
| 1344 | aligned, and the SSE state starts at the 6+8+1+1th == 16th word, |
| 1345 | so it too must be 16-byte aligned. Consequence: change this struct |
| 1346 | only _very carefully_ ! See also above comment re masking MXCSR. |
| 1347 | */ |
| 1348 | __attribute__ ((aligned (16))) |
sewardj | 92a5956 | 2002-09-30 00:53:10 +0000 | [diff] [blame] | 1349 | extern UInt VG_(m_state_static) [6 /* segment regs, Intel order */ |
| 1350 | + 8 /* int regs, in Intel order */ |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1351 | + 1 /* %eflags */ |
| 1352 | + 1 /* %eip */ |
sewardj | b91ae7f | 2003-04-29 23:50:00 +0000 | [diff] [blame] | 1353 | + VG_SIZE_OF_SSESTATE_W /* SSE state */ |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1354 | ]; |
| 1355 | |
| 1356 | /* Handy fns for doing the copy back and forth. */ |
| 1357 | extern void VG_(copy_baseBlock_to_m_state_static) ( void ); |
| 1358 | extern void VG_(copy_m_state_static_to_baseBlock) ( void ); |
| 1359 | |
njn | 9b007f6 | 2003-04-07 14:40:25 +0000 | [diff] [blame] | 1360 | /* Determine if %esp adjustment must be noted */ |
njn | f4ce3d3 | 2003-02-10 10:17:26 +0000 | [diff] [blame] | 1361 | extern Bool VG_(need_to_handle_esp_assignment) ( void ); |
| 1362 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1363 | /* Called when some unhandleable client behaviour is detected. |
| 1364 | Prints a msg and aborts. */ |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 1365 | extern void VG_(unimplemented) ( Char* msg ) |
| 1366 | __attribute__((__noreturn__)); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1367 | |
| 1368 | /* The stack on which Valgrind runs. We can't use the same stack as the |
| 1369 | simulatee -- that's an important design decision. */ |
njn | 6eba4ef | 2003-05-01 08:06:41 +0000 | [diff] [blame] | 1370 | extern UInt VG_(stack)[VG_STACK_SIZE_W]; |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1371 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 1372 | /* Similarly, we have to ask for signals to be delivered on an alternative |
| 1373 | stack, since it is possible, although unlikely, that we'll have to run |
| 1374 | client code from inside the Valgrind-installed signal handler. If this |
| 1375 | happens it will be done by vg_deliver_signal_immediately(). */ |
njn | 6eba4ef | 2003-05-01 08:06:41 +0000 | [diff] [blame] | 1376 | extern UInt VG_(sigstack)[VG_SIGSTACK_SIZE_W]; |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1377 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1378 | /* Holds client's %esp at the point we gained control. From this the |
| 1379 | client's argc, argv and envp are deduced. */ |
| 1380 | extern Addr VG_(esp_at_startup); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1381 | |
sewardj | d5815ec | 2003-04-06 12:23:27 +0000 | [diff] [blame] | 1382 | /* Indicates presence, and holds address of client's sysinfo page, a |
| 1383 | feature of some modern kernels used to provide vsyscalls, etc. */ |
| 1384 | extern Bool VG_(sysinfo_page_exists); |
| 1385 | extern Addr VG_(sysinfo_page_addr); |
| 1386 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 1387 | /* Remove valgrind.so and skin's .so from a LD_PRELOAD=... string so child |
| 1388 | processes don't get traced into. Also mess up $libdir/valgrind so that |
| 1389 | our libpthread.so disappears from view. */ |
sewardj | 3e1eb1f | 2002-05-18 13:14:17 +0000 | [diff] [blame] | 1390 | void VG_(mash_LD_PRELOAD_and_LD_LIBRARY_PATH) ( Char* ld_preload_str, |
| 1391 | Char* ld_library_path_str ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1392 | |
| 1393 | /* Something of a function looking for a home ... start up GDB. This |
| 1394 | is called from VG_(swizzle_esp_then_start_GDB) and so runs on the |
| 1395 | *client's* stack. This is necessary to give GDB the illusion that |
| 1396 | the client program really was running on the real cpu. */ |
| 1397 | extern void VG_(start_GDB_whilst_on_client_stack) ( void ); |
| 1398 | |
njn | 4155712 | 2002-10-14 09:25:37 +0000 | [diff] [blame] | 1399 | /* VG_(bbs_done) in include/vg_skin.h */ |
| 1400 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1401 | /* 64-bit counter for the number of bbs to go before a debug exit. */ |
| 1402 | extern ULong VG_(bbs_to_go); |
| 1403 | |
| 1404 | /* Counts downwards in vg_run_innerloop. */ |
| 1405 | extern UInt VG_(dispatch_ctr); |
| 1406 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1407 | /* Is the client running on the simulated CPU or the real one? */ |
| 1408 | extern Bool VG_(running_on_simd_CPU); /* Initially False */ |
| 1409 | |
sewardj | 7e87e38 | 2002-05-03 19:09:05 +0000 | [diff] [blame] | 1410 | /* This is the ThreadId of the last thread the scheduler ran. */ |
| 1411 | extern ThreadId VG_(last_run_tid); |
| 1412 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 1413 | /* This is the argument to __NR_exit() supplied by the first thread to |
| 1414 | call that syscall. We eventually pass that to __NR_exit() for |
| 1415 | real. */ |
njn | 633de32 | 2003-05-12 20:40:13 +0000 | [diff] [blame] | 1416 | extern Int VG_(exitcode); |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 1417 | |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame^] | 1418 | /* If we're doing the default action of a fatal signal */ |
| 1419 | extern jmp_buf VG_(fatal_signal_jmpbuf); |
| 1420 | extern Bool VG_(fatal_signal_set); /* jmp_buf is valid */ |
| 1421 | extern Int VG_(fatal_sigNo); /* the fatal signal */ |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1422 | |
| 1423 | /* --- Counters, for informational purposes only. --- */ |
| 1424 | |
| 1425 | /* Number of lookups which miss the fast tt helper. */ |
| 1426 | extern UInt VG_(tt_fast_misses); |
| 1427 | |
sewardj | c0d8f68 | 2002-11-30 00:49:43 +0000 | [diff] [blame] | 1428 | /* Counts for TT/TC informational messages. */ |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1429 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1430 | /* Number and total o/t size of translations overall. */ |
| 1431 | extern UInt VG_(overall_in_count); |
| 1432 | extern UInt VG_(overall_in_osize); |
| 1433 | extern UInt VG_(overall_in_tsize); |
| 1434 | /* Number and total o/t size of discards overall. */ |
| 1435 | extern UInt VG_(overall_out_count); |
| 1436 | extern UInt VG_(overall_out_osize); |
| 1437 | extern UInt VG_(overall_out_tsize); |
sewardj | c0d8f68 | 2002-11-30 00:49:43 +0000 | [diff] [blame] | 1438 | /* The number of discards of TT/TC. */ |
| 1439 | extern UInt VG_(number_of_tc_discards); |
sewardj | 22854b9 | 2002-11-30 14:00:47 +0000 | [diff] [blame] | 1440 | /* Counts of chain and unchain operations done. */ |
| 1441 | extern UInt VG_(bb_enchain_count); |
| 1442 | extern UInt VG_(bb_dechain_count); |
| 1443 | /* Number of unchained jumps performed. */ |
| 1444 | extern UInt VG_(unchained_jumps_done); |
| 1445 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1446 | |
| 1447 | /* Counts pertaining to the register allocator. */ |
| 1448 | |
| 1449 | /* total number of uinstrs input to reg-alloc */ |
| 1450 | extern UInt VG_(uinstrs_prealloc); |
| 1451 | |
| 1452 | /* total number of uinstrs added due to spill code */ |
| 1453 | extern UInt VG_(uinstrs_spill); |
| 1454 | |
| 1455 | /* number of bbs requiring spill code */ |
| 1456 | extern UInt VG_(translations_needing_spill); |
| 1457 | |
| 1458 | /* total of register ranks over all translations */ |
| 1459 | extern UInt VG_(total_reg_rank); |
| 1460 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1461 | /* Counts pertaining to internal sanity checking. */ |
| 1462 | extern UInt VG_(sanity_fast_count); |
| 1463 | extern UInt VG_(sanity_slow_count); |
| 1464 | |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 1465 | /* Counts pertaining to the scheduler. */ |
| 1466 | extern UInt VG_(num_scheduling_events_MINOR); |
| 1467 | extern UInt VG_(num_scheduling_events_MAJOR); |
| 1468 | |
sewardj | fa492d4 | 2002-12-08 18:20:01 +0000 | [diff] [blame] | 1469 | /* Insert and extract the D flag from eflags */ |
| 1470 | UInt VG_(insertDflag)(UInt eflags, Int d); |
| 1471 | Int VG_(extractDflag)(UInt eflags); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1472 | |
sewardj | 49e630d | 2003-04-23 21:18:52 +0000 | [diff] [blame] | 1473 | /* start address and size of the initial stack */ |
| 1474 | extern Addr VG_(foundstack_start); |
| 1475 | extern UInt VG_(foundstack_size); |
| 1476 | |
| 1477 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1478 | /* --------------------------------------------------------------------- |
| 1479 | Exports of vg_memory.c |
| 1480 | ------------------------------------------------------------------ */ |
| 1481 | |
njn | fa1016e | 2003-09-25 17:54:11 +0000 | [diff] [blame] | 1482 | extern void VG_(init_memory) ( void ); |
| 1483 | extern void VG_(new_exeseg_startup) ( Addr a, UInt len, Char rr, Char ww, |
| 1484 | Char xx, UInt foffset, |
| 1485 | UChar* filename ); |
| 1486 | extern void VG_(new_exeseg_mmap) ( Addr a, UInt len ); |
| 1487 | extern void VG_(remove_if_exeseg) ( Addr a, UInt len ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1488 | |
njn | 9b007f6 | 2003-04-07 14:40:25 +0000 | [diff] [blame] | 1489 | extern __attribute__((regparm(1))) |
njn | fa1016e | 2003-09-25 17:54:11 +0000 | [diff] [blame] | 1490 | void VG_(unknown_esp_update) ( Addr new_ESP ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1491 | |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame^] | 1492 | extern Bool VG_(is_addressable)(Addr p, Int sz); |
| 1493 | |
| 1494 | /* --------------------------------------------------------------------- |
| 1495 | Exports of vg_proxylwp.c |
| 1496 | ------------------------------------------------------------------ */ |
| 1497 | |
| 1498 | /* Issue a syscall for thread tid */ |
| 1499 | extern Int VG_(sys_issue)(int tid); |
| 1500 | |
| 1501 | extern void VG_(proxy_init) ( void ); |
| 1502 | extern void VG_(proxy_create) ( ThreadId tid ); |
| 1503 | extern void VG_(proxy_delete) ( ThreadId tid, Bool force ); |
| 1504 | extern void VG_(proxy_results) ( void ); |
| 1505 | extern void VG_(proxy_sendsig) ( ThreadId tid, Int signo ); |
| 1506 | extern void VG_(proxy_setsigmask)(ThreadId tid); |
| 1507 | extern void VG_(proxy_sigack) ( ThreadId tid, const vki_ksigset_t *); |
| 1508 | extern void VG_(proxy_abort_syscall) ( ThreadId tid ); |
| 1509 | extern void VG_(proxy_waitsig) ( void ); |
| 1510 | |
| 1511 | extern void VG_(proxy_shutdown) ( void ); /* shut down the syscall workers */ |
| 1512 | extern Int VG_(proxy_resfd) ( void ); /* FD something can select on to know |
| 1513 | a syscall finished */ |
| 1514 | |
| 1515 | /* Sanity-check the whole proxy-LWP machinery */ |
| 1516 | void VG_(proxy_sanity)(void); |
| 1517 | |
| 1518 | /* Send a signal from a thread's proxy to the thread. This longjmps |
| 1519 | back into the proxy's main loop, so it doesn't return. */ |
| 1520 | __attribute__ ((__noreturn__)) |
| 1521 | extern void VG_(proxy_handlesig)( const vki_ksiginfo_t *siginfo, |
| 1522 | const struct vki_sigcontext *sigcontext ); |
| 1523 | |
| 1524 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1525 | /* --------------------------------------------------------------------- |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 1526 | Exports of vg_syscalls.c |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1527 | ------------------------------------------------------------------ */ |
| 1528 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 1529 | extern void VG_(init_dataseg_end_for_brk) ( void ); |
| 1530 | |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame^] | 1531 | extern Bool VG_(pre_syscall) ( ThreadId tid ); |
| 1532 | extern void VG_(post_syscall)( ThreadId tid ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1533 | |
| 1534 | extern Bool VG_(is_kerror) ( Int res ); |
| 1535 | |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame^] | 1536 | /* Internal atfork handlers */ |
| 1537 | typedef void (*vg_atfork_t)(ThreadId); |
| 1538 | 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] | 1539 | |
| 1540 | /* --------------------------------------------------------------------- |
| 1541 | Exports of vg_transtab.c |
| 1542 | ------------------------------------------------------------------ */ |
| 1543 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 1544 | /* The fast-cache for tt-lookup. */ |
| 1545 | extern Addr VG_(tt_fast)[VG_TT_FAST_SIZE]; |
| 1546 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1547 | extern void VG_(get_tt_tc_used) ( UInt* tt_used, UInt* tc_used ); |
sewardj | 6c3769f | 2002-11-29 01:02:45 +0000 | [diff] [blame] | 1548 | |
sewardj | c0d8f68 | 2002-11-30 00:49:43 +0000 | [diff] [blame] | 1549 | extern void VG_(add_to_trans_tab) ( Addr orig_addr, Int orig_size, |
sewardj | 22854b9 | 2002-11-30 14:00:47 +0000 | [diff] [blame] | 1550 | Addr trans_addr, Int trans_size, |
| 1551 | UShort jumps[VG_MAX_JUMPS]); |
sewardj | 6c3769f | 2002-11-29 01:02:45 +0000 | [diff] [blame] | 1552 | |
sewardj | 97ad552 | 2003-05-04 12:32:56 +0000 | [diff] [blame] | 1553 | extern void VG_(invalidate_translations) ( Addr start, UInt range, Bool unchain_blocks ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1554 | |
sewardj | 18d7513 | 2002-05-16 11:06:21 +0000 | [diff] [blame] | 1555 | extern void VG_(init_tt_tc) ( void ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1556 | |
| 1557 | extern void VG_(sanity_check_tc_tt) ( void ); |
| 1558 | extern Addr VG_(search_transtab) ( Addr original_addr ); |
| 1559 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1560 | |
| 1561 | |
| 1562 | /* --------------------------------------------------------------------- |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1563 | Exports of vg_syscall.S |
| 1564 | ------------------------------------------------------------------ */ |
| 1565 | |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame^] | 1566 | extern Int VG_(do_syscall) ( UInt, ... ); |
| 1567 | extern Int VG_(clone) ( Int (*fn)(void *), void *stack, Int flags, void *arg, |
| 1568 | Int *child_tid, Int *parent_tid); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1569 | |
| 1570 | /* --------------------------------------------------------------------- |
| 1571 | Exports of vg_startup.S |
| 1572 | ------------------------------------------------------------------ */ |
| 1573 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1574 | extern void VG_(switch_to_real_CPU) ( void ); |
| 1575 | |
sewardj | 3580542 | 2002-04-21 13:05:34 +0000 | [diff] [blame] | 1576 | extern void VG_(swizzle_esp_then_start_GDB) ( Addr m_eip_at_error, |
| 1577 | Addr m_esp_at_error, |
| 1578 | Addr m_ebp_at_error ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1579 | |
| 1580 | |
| 1581 | /* --------------------------------------------------------------------- |
| 1582 | Exports of vg_dispatch.S |
| 1583 | ------------------------------------------------------------------ */ |
| 1584 | |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 1585 | /* Run a thread for a (very short) while, until some event happens |
| 1586 | which means we need to defer to the scheduler. */ |
| 1587 | extern UInt VG_(run_innerloop) ( void ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1588 | |
sewardj | 22854b9 | 2002-11-30 14:00:47 +0000 | [diff] [blame] | 1589 | /* The patching routing called when a BB wants to chain itself to |
| 1590 | another. */ |
| 1591 | extern UInt VG_(patch_me); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1592 | |
| 1593 | /* --------------------------------------------------------------------- |
| 1594 | Exports of vg_helpers.S |
| 1595 | ------------------------------------------------------------------ */ |
| 1596 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1597 | /* Mul, div, etc, -- we don't codegen these directly. */ |
| 1598 | extern void VG_(helper_idiv_64_32); |
| 1599 | extern void VG_(helper_div_64_32); |
| 1600 | extern void VG_(helper_idiv_32_16); |
| 1601 | extern void VG_(helper_div_32_16); |
| 1602 | extern void VG_(helper_idiv_16_8); |
| 1603 | extern void VG_(helper_div_16_8); |
| 1604 | |
| 1605 | extern void VG_(helper_imul_32_64); |
| 1606 | extern void VG_(helper_mul_32_64); |
| 1607 | extern void VG_(helper_imul_16_32); |
| 1608 | extern void VG_(helper_mul_16_32); |
| 1609 | extern void VG_(helper_imul_8_16); |
| 1610 | extern void VG_(helper_mul_8_16); |
| 1611 | |
| 1612 | extern void VG_(helper_CLD); |
| 1613 | extern void VG_(helper_STD); |
| 1614 | extern void VG_(helper_get_dirflag); |
| 1615 | |
sewardj | 7d78e78 | 2002-06-02 00:04:00 +0000 | [diff] [blame] | 1616 | extern void VG_(helper_CLC); |
| 1617 | extern void VG_(helper_STC); |
| 1618 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1619 | extern void VG_(helper_shldl); |
| 1620 | extern void VG_(helper_shldw); |
| 1621 | extern void VG_(helper_shrdl); |
| 1622 | extern void VG_(helper_shrdw); |
| 1623 | |
daywalker | b18d253 | 2003-09-27 20:15:01 +0000 | [diff] [blame] | 1624 | extern void VG_(helper_IN); |
| 1625 | extern void VG_(helper_OUT); |
| 1626 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1627 | extern void VG_(helper_RDTSC); |
| 1628 | extern void VG_(helper_CPUID); |
| 1629 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1630 | extern void VG_(helper_bsf); |
| 1631 | extern void VG_(helper_bsr); |
| 1632 | |
| 1633 | extern void VG_(helper_fstsw_AX); |
| 1634 | extern void VG_(helper_SAHF); |
njn | d6251f1 | 2003-06-03 13:38:51 +0000 | [diff] [blame] | 1635 | extern void VG_(helper_LAHF); |
sewardj | 4d0ab1f | 2002-03-24 10:00:09 +0000 | [diff] [blame] | 1636 | extern void VG_(helper_DAS); |
sewardj | fe8a166 | 2002-03-24 11:54:07 +0000 | [diff] [blame] | 1637 | extern void VG_(helper_DAA); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1638 | |
sewardj | 5109643 | 2002-12-14 23:59:09 +0000 | [diff] [blame] | 1639 | extern void VG_(helper_undefined_instruction); |
| 1640 | |
sewardj | 20917d8 | 2002-05-28 01:36:45 +0000 | [diff] [blame] | 1641 | /* NOT A FUNCTION; this is a bogus RETURN ADDRESS. */ |
sewardj | 54cacf0 | 2002-04-12 23:24:59 +0000 | [diff] [blame] | 1642 | extern void VG_(signalreturn_bogusRA)( void ); |
sewardj | 20917d8 | 2002-05-28 01:36:45 +0000 | [diff] [blame] | 1643 | |
njn | 4f9c934 | 2002-04-29 16:03:24 +0000 | [diff] [blame] | 1644 | /* --------------------------------------------------------------------- |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 1645 | Things relating to the used skin |
njn | 4f9c934 | 2002-04-29 16:03:24 +0000 | [diff] [blame] | 1646 | ------------------------------------------------------------------ */ |
| 1647 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 1648 | #define VG_TRACK(fn, args...) \ |
| 1649 | do { \ |
| 1650 | if (VG_(track_events).fn) \ |
| 1651 | VG_(track_events).fn(args); \ |
| 1652 | } while (0) |
sewardj | 18d7513 | 2002-05-16 11:06:21 +0000 | [diff] [blame] | 1653 | |
| 1654 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1655 | /* --------------------------------------------------------------------- |
| 1656 | The state of the simulated CPU. |
| 1657 | ------------------------------------------------------------------ */ |
| 1658 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1659 | /* --------------------------------------------------------------------- |
| 1660 | Offsets into baseBlock for everything which needs to referred to |
| 1661 | from generated code. The order of these decls does not imply |
| 1662 | what the order of the actual offsets is. The latter is important |
| 1663 | and is set up in vg_main.c. |
| 1664 | ------------------------------------------------------------------ */ |
| 1665 | |
| 1666 | /* An array of words. In generated code, %ebp always points to the |
| 1667 | start of this array. Useful stuff, like the simulated CPU state, |
| 1668 | and the addresses of helper functions, can then be found by |
| 1669 | indexing off %ebp. The following declares variables which, at |
| 1670 | startup time, are given values denoting offsets into baseBlock. |
| 1671 | These offsets are in *words* from the start of baseBlock. */ |
| 1672 | |
sewardj | b91ae7f | 2003-04-29 23:50:00 +0000 | [diff] [blame] | 1673 | #define VG_BASEBLOCK_WORDS 400 |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1674 | |
| 1675 | extern UInt VG_(baseBlock)[VG_BASEBLOCK_WORDS]; |
| 1676 | |
| 1677 | |
| 1678 | /* ----------------------------------------------------- |
| 1679 | Read-write parts of baseBlock. |
| 1680 | -------------------------------------------------- */ |
| 1681 | |
| 1682 | /* State of the simulated CPU. */ |
| 1683 | extern Int VGOFF_(m_eax); |
| 1684 | extern Int VGOFF_(m_ecx); |
| 1685 | extern Int VGOFF_(m_edx); |
| 1686 | extern Int VGOFF_(m_ebx); |
| 1687 | extern Int VGOFF_(m_esp); |
| 1688 | extern Int VGOFF_(m_ebp); |
| 1689 | extern Int VGOFF_(m_esi); |
| 1690 | extern Int VGOFF_(m_edi); |
| 1691 | extern Int VGOFF_(m_eflags); |
sewardj | b91ae7f | 2003-04-29 23:50:00 +0000 | [diff] [blame] | 1692 | extern Int VGOFF_(m_ssestate); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1693 | extern Int VGOFF_(m_eip); |
| 1694 | |
sewardj | fa492d4 | 2002-12-08 18:20:01 +0000 | [diff] [blame] | 1695 | extern Int VGOFF_(m_dflag); /* D flag is handled specially */ |
| 1696 | |
sewardj | 92a5956 | 2002-09-30 00:53:10 +0000 | [diff] [blame] | 1697 | extern Int VGOFF_(m_cs); |
| 1698 | extern Int VGOFF_(m_ss); |
| 1699 | extern Int VGOFF_(m_ds); |
| 1700 | extern Int VGOFF_(m_es); |
| 1701 | extern Int VGOFF_(m_fs); |
| 1702 | extern Int VGOFF_(m_gs); |
| 1703 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1704 | /* Reg-alloc spill area (VG_MAX_SPILLSLOTS words long). */ |
| 1705 | extern Int VGOFF_(spillslots); |
| 1706 | |
| 1707 | /* Records the valid bits for the 8 integer regs & flags reg. */ |
| 1708 | extern Int VGOFF_(sh_eax); |
| 1709 | extern Int VGOFF_(sh_ecx); |
| 1710 | extern Int VGOFF_(sh_edx); |
| 1711 | extern Int VGOFF_(sh_ebx); |
| 1712 | extern Int VGOFF_(sh_esp); |
| 1713 | extern Int VGOFF_(sh_ebp); |
| 1714 | extern Int VGOFF_(sh_esi); |
| 1715 | extern Int VGOFF_(sh_edi); |
| 1716 | extern Int VGOFF_(sh_eflags); |
| 1717 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1718 | /* ----------------------------------------------------- |
| 1719 | Read-only parts of baseBlock. |
| 1720 | -------------------------------------------------- */ |
| 1721 | |
sewardj | 92a5956 | 2002-09-30 00:53:10 +0000 | [diff] [blame] | 1722 | /* This thread's LDT pointer. */ |
| 1723 | extern Int VGOFF_(ldt); |
| 1724 | |
njn | 211b6ad | 2003-02-03 12:33:31 +0000 | [diff] [blame] | 1725 | /* Nb: Most helper offsets are in include/vg_skin.h, for use by skins */ |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1726 | |
sewardj | 5109643 | 2002-12-14 23:59:09 +0000 | [diff] [blame] | 1727 | extern Int VGOFF_(helper_undefined_instruction); |
| 1728 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 1729 | /* For storing extension-specific helpers, determined at runtime. The addr |
| 1730 | * and offset arrays together form a (addr, offset) map that allows a |
| 1731 | * helper's baseBlock offset to be computed from its address. It's done |
| 1732 | * like this so CCALL_M_Ns and other helper calls can use the function |
| 1733 | * address rather than having to much around with offsets. */ |
| 1734 | extern UInt VG_(n_compact_helpers); |
| 1735 | extern UInt VG_(n_noncompact_helpers); |
| 1736 | |
| 1737 | extern Addr VG_(compact_helper_addrs) []; |
| 1738 | extern Int VG_(compact_helper_offsets)[]; |
| 1739 | |
| 1740 | extern Addr VG_(noncompact_helper_addrs) []; |
| 1741 | extern Int VG_(noncompact_helper_offsets)[]; |
| 1742 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1743 | #endif /* ndef __VG_INCLUDE_H */ |
| 1744 | |
sewardj | 3b2736a | 2002-03-24 12:18:35 +0000 | [diff] [blame] | 1745 | |
| 1746 | /* --------------------------------------------------------------------- |
| 1747 | Finally - autoconf-generated settings |
| 1748 | ------------------------------------------------------------------ */ |
| 1749 | |
| 1750 | #include "config.h" |
| 1751 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1752 | /*--------------------------------------------------------------------*/ |
| 1753 | /*--- end vg_include.h ---*/ |
| 1754 | /*--------------------------------------------------------------------*/ |