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