blob: 8c2aece47f8f61d43909fb5f952709679b44902d [file] [log] [blame]
sewardjde4a1d02002-03-22 01:27:54 +00001
2/*--------------------------------------------------------------------*/
njn717cde52005-05-10 02:47:21 +00003/*--- A header file for various private parts of Valgrind's core. ---*/
rjwalsh7109a8c2004-09-02 00:31:02 +00004/*--- core.h ---*/
sewardjde4a1d02002-03-22 01:27:54 +00005/*--------------------------------------------------------------------*/
6
7/*
njnb9c427c2004-12-01 14:14:42 +00008 This file is part of Valgrind, a dynamic binary instrumentation
9 framework.
sewardjde4a1d02002-03-22 01:27:54 +000010
njn53612422005-03-12 16:22:54 +000011 Copyright (C) 2000-2005 Julian Seward
sewardjde4a1d02002-03-22 01:27:54 +000012 jseward@acm.org
sewardjde4a1d02002-03-22 01:27:54 +000013
14 This program is free software; you can redistribute it and/or
15 modify it under the terms of the GNU General Public License as
16 published by the Free Software Foundation; either version 2 of the
17 License, or (at your option) any later version.
18
19 This program is distributed in the hope that it will be useful, but
20 WITHOUT ANY WARRANTY; without even the implied warranty of
21 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
22 General Public License for more details.
23
24 You should have received a copy of the GNU General Public License
25 along with this program; if not, write to the Free Software
26 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
27 02111-1307, USA.
28
njn25e49d8e72002-09-23 09:36:25 +000029 The GNU General Public License is contained in the file COPYING.
sewardjde4a1d02002-03-22 01:27:54 +000030*/
31
rjwalsh7109a8c2004-09-02 00:31:02 +000032#ifndef __CORE_H
33#define __CORE_H
sewardjde4a1d02002-03-22 01:27:54 +000034
nethercote7be47252004-09-02 16:02:58 +000035/*
njn2521d322005-05-08 14:45:13 +000036 [This comment is not longer accurate -- we're switching to an easier to
37 understand module-based approach, with one or two headers per module,
38 rather than having monolithic headers as described. --njn 07-May-2005]
39
nethercote7be47252004-09-02 16:02:58 +000040 Header hierarchy:
41
42 - core C files include core.h
43 - core asm files include core_asm.h
44 - tool C files include tool.h
45 - tool asm files include tool_asm.h
46
47 - The hierarchy of the header files themselves is based around the
48 following rules:
49
50 - core headers include tool headers
51 - generic headers include arch/OS/platform headers
52 - C headers include asm headers
53
54 This gives the following hierarchy (only showing 'arch' headers, not
nethercote80cca432004-09-02 16:25:49 +000055 'os' or 'platform' headers), where arrows indicate inclusion, and
56 $VG_ARCH==x86:
nethercote7be47252004-09-02 16:02:58 +000057
nethercote80cca432004-09-02 16:25:49 +000058
59 (include/x86/tool_arch_asm.h?) <----- coregrind/x86/core_arch_asm.h
60 ^ ^ ^ ^
61 / \ / \
62 / \ / \
63 / \ / \
64 include/tool_asm.h <-\---- coregrind/core_asm.h \
65 ^ \ ^ \
66 \ include/x86/tool_arch.h <--------coregrind/x86/core_arch.h
67 \ ^ \ ^
68 \ / \ /
69 \ / \ /
70 \ / \ /
71 include/tool.h <------------ coregrind/core.h
72
nethercote7be47252004-09-02 16:02:58 +000073
74 Note that core.h contains the *declarations* of arch-specific functions
75 and variables, which can be used by the core_arch.h file of any
76 architecture. (The functions/variables are *defined* within arch/.)
77 However, arch-specific macros and types cannot go into core.h, because
78 there is no separation between declaration and definition for
79 macros/types, so they instead go into $VG_ARCH/core_arch.h.
nethercote80cca432004-09-02 16:25:49 +000080
81 The tool-specific headers are all in include/ so they can be seen by any
82 external tools.
nethercote7be47252004-09-02 16:02:58 +000083*/
84
jsgf855d93d2003-10-13 22:26:55 +000085/* For system call numbers __NR_... */
nethercotef94fe2f2004-09-10 14:23:59 +000086#include "vki_unistd.h"
jsgf855d93d2003-10-13 22:26:55 +000087
nethercote13343132004-09-02 15:49:09 +000088#include "core_asm.h" // asm stuff
89#include "tool.h" // tool stuff
nethercotebb4222b2004-09-10 17:42:11 +000090#include "core_arch.h" // arch-specific stuff, eg. x86/core_arch.h
nethercote8ff888f2004-11-17 17:11:45 +000091
92// Ugly: this is needed by linux/core_os.h
93typedef struct _ThreadState ThreadState;
94
nethercotebb4222b2004-09-10 17:42:11 +000095#include "core_platform.h" // platform-specific stuff,
96 // eg. x86-linux/core_platform.h
sewardjb5f6f512005-03-10 23:59:00 +000097#include "core_os.h" // OS-specific stuff, eg. linux/core_os.h
sewardjde4a1d02002-03-22 01:27:54 +000098
njn717cde52005-05-10 02:47:21 +000099#include "pub_core_mallocfree.h" // for type 'ArenaId'
njnd01fef72005-03-25 23:35:48 +0000100#include "pub_core_stacktrace.h" // for type 'StackTrace'
101
fitzhardinge39de4b42003-10-31 07:12:21 +0000102#include "valgrind.h"
sewardjde4a1d02002-03-22 01:27:54 +0000103
nethercote7be47252004-09-02 16:02:58 +0000104/* ---------------------------------------------------------------------
njn14319cc2005-03-13 06:26:22 +0000105 Global macros.
nethercote7be47252004-09-02 16:02:58 +0000106 ------------------------------------------------------------------ */
107
sewardjde4a1d02002-03-22 01:27:54 +0000108/* Max length of a text fragment used to construct error messages. */
njn47b209a2005-03-25 23:47:16 +0000109#define VG_ERRTXT_LEN 4096
sewardjde4a1d02002-03-22 01:27:54 +0000110
sewardjde4a1d02002-03-22 01:27:54 +0000111/* The maximum number of calls we're prepared to save in a
112 backtrace. */
113#define VG_DEEPEST_BACKTRACE 50
114
fitzhardinge98abfc72003-12-16 02:05:15 +0000115/* Useful macros */
116/* a - alignment - must be a power of 2 */
tomde2ec262005-03-29 12:16:10 +0000117#define ROUNDDN(p, a) ((Addr)(p) & ~((Addr)(a)-1))
fitzhardinge98abfc72003-12-16 02:05:15 +0000118#define ROUNDUP(p, a) ROUNDDN((p)+(a)-1, (a))
nethercote73b526f2004-10-31 18:48:21 +0000119#define PGROUNDDN(p) ROUNDDN(p, VKI_PAGE_SIZE)
120#define PGROUNDUP(p) ROUNDUP(p, VKI_PAGE_SIZE)
fitzhardinge98abfc72003-12-16 02:05:15 +0000121
sewardj51ac0872004-12-21 01:20:49 +0000122
nethercote80013e92004-09-05 20:39:51 +0000123/* ---------------------------------------------------------------------
124 Environment variables
125 ------------------------------------------------------------------ */
126
127/* The directory we look for all our auxillary files in */
128#define VALGRINDLIB "VALGRINDLIB"
129
130/* Additional command-line arguments; they are overridden by actual
131 command-line option. Each argument is separated by spaces. There
132 is no quoting mechanism.
133 */
134#define VALGRINDOPTS "VALGRIND_OPTS"
135
136/* If this variable is present in the environment, then valgrind will
137 not parse the command line for options at all; all options come
138 from this variable. Arguments are terminated by ^A (\001). There
139 is no quoting mechanism.
140
141 This variable is not expected to be set by anything other than
142 Valgrind itself, as part of its handling of execve with
143 --trace-children=yes. This variable should not be present in the
144 client environment.
145 */
146#define VALGRINDCLO "_VALGRIND_CLO"
147
fitzhardinge98abfc72003-12-16 02:05:15 +0000148
sewardjde4a1d02002-03-22 01:27:54 +0000149/* ---------------------------------------------------------------------
sewardjde4a1d02002-03-22 01:27:54 +0000150 Command-line-settable options
151 ------------------------------------------------------------------ */
152
sewardj4f094a72002-11-05 23:37:35 +0000153/* Default destination port to be used in logging over a network, if
154 none specified. */
155#define VG_CLO_DEFAULT_LOGPORT 1500
sewardj73cf3bc2002-11-03 03:20:15 +0000156
157/* The max number of suppression files. */
sewardjde4a1d02002-03-22 01:27:54 +0000158#define VG_CLO_MAX_SFILES 10
159
sewardj4cf05692002-10-27 20:28:29 +0000160/* Describes where logging output is to be sent. */
161typedef
162 enum {
163 VgLogTo_Fd,
164 VgLogTo_File,
sewardj603d4102005-01-11 14:01:02 +0000165 VgLogTo_FileExactly,
sewardj4cf05692002-10-27 20:28:29 +0000166 VgLogTo_Socket
167 } VgLogTo;
168
thughesad1c9562004-06-26 11:27:52 +0000169/* Application-visible file descriptor limits */
170extern Int VG_(fd_soft_limit);
171extern Int VG_(fd_hard_limit);
fitzhardingef0046f22003-12-18 02:39:22 +0000172
sewardj8b635a42004-11-22 19:01:47 +0000173/* Vex iropt control */
174extern VexControl VG_(clo_vex_control);
sewardj72f98ff2002-06-13 17:23:38 +0000175/* Should we stop collecting errors if too many appear? default: YES */
sewardj2e432902002-06-13 20:44:00 +0000176extern Bool VG_(clo_error_limit);
nethercote04d0fbc2004-01-26 16:48:06 +0000177/* Enquire about whether to attach to a debugger at errors? default: NO */
178extern Bool VG_(clo_db_attach);
179/* The debugger command? default: whatever gdb ./configure found */
180extern Char* VG_(clo_db_command);
sewardjd153fae2005-01-10 17:24:47 +0000181/* Generating a suppression for each error? default: 0 (NO)
182 Other values: 1 (yes, but ask user), 2 (yes, don't ask user) */
183extern Int VG_(clo_gen_suppressions);
sewardjde4a1d02002-03-22 01:27:54 +0000184/* Sanity-check level: 0 = none, 1 (default), > 1 = expensive. */
nethercote27fec902004-06-16 21:26:32 +0000185extern Int VG_(clo_sanity_level);
sewardjde4a1d02002-03-22 01:27:54 +0000186/* Automatically attempt to demangle C++ names? default: YES */
187extern Bool VG_(clo_demangle);
sewardjde4a1d02002-03-22 01:27:54 +0000188/* Simulate child processes? default: NO */
189extern Bool VG_(clo_trace_children);
sewardj4cf05692002-10-27 20:28:29 +0000190
191/* Where logging output is to be sent to.
192
nethercotef8548672004-06-21 12:42:35 +0000193 When log_to == VgLogTo_Fd, clo_log_fd holds the file id, and is
194 taken from the command line. clo_log_name is irrelevant.
sewardj4cf05692002-10-27 20:28:29 +0000195
nethercotef8548672004-06-21 12:42:35 +0000196 When log_to == VgLogTo_File, clo_log_name holds the log-file
197 name, and is taken from the command line. clo_log_fd is then
198 made to hold the relevant file id, by opening clo_log_name
sewardj4cf05692002-10-27 20:28:29 +0000199 (concatenated with the process ID) for writing.
200
nethercotef8548672004-06-21 12:42:35 +0000201 When log_to == VgLogTo_Socket, clo_log_name holds the
sewardj4cf05692002-10-27 20:28:29 +0000202 hostname:portnumber pair, and is taken from the command line.
nethercotef8548672004-06-21 12:42:35 +0000203 clo_log_fd is then made to hold the relevant file handle, by
sewardj4cf05692002-10-27 20:28:29 +0000204 opening a connection to said hostname:portnumber pair.
205
nethercotef8548672004-06-21 12:42:35 +0000206 Global default is to set log_to == VgLogTo_Fd and log_fd == 2
sewardj4cf05692002-10-27 20:28:29 +0000207 (stderr). */
208extern VgLogTo VG_(clo_log_to);
nethercotef8548672004-06-21 12:42:35 +0000209extern Int VG_(clo_log_fd);
210extern Char* VG_(clo_log_name);
sewardjde4a1d02002-03-22 01:27:54 +0000211
thughes6233a382004-08-21 11:10:44 +0000212/* Add timestamps to log messages? default: NO */
213extern Bool VG_(clo_time_stamp);
214
sewardj6024b212003-07-13 10:54:33 +0000215/* The file descriptor to read for input. default: 0 == stdin */
216extern Int VG_(clo_input_fd);
sewardjde4a1d02002-03-22 01:27:54 +0000217/* The number of suppression files specified. */
218extern Int VG_(clo_n_suppressions);
219/* The names of the suppression files. */
220extern Char* VG_(clo_suppressions)[VG_CLO_MAX_SFILES];
221
sewardjc771b292004-11-30 18:55:21 +0000222/* DEBUG: print generated code? default: 00000000 ( == NO ) */
sewardjfa8ec112005-01-19 11:55:34 +0000223extern Bool VG_(clo_trace_flags);
224/* DEBUG: do bb profiling? default: 00000000 ( == NO ) */
225extern Bool VG_(clo_profile_flags);
sewardjc771b292004-11-30 18:55:21 +0000226/* DEBUG: if tracing codegen, be quiet until after this bb ( 0 ) */
227extern Int VG_(clo_trace_notbelow);
sewardjde4a1d02002-03-22 01:27:54 +0000228/* DEBUG: print system calls? default: NO */
229extern Bool VG_(clo_trace_syscalls);
230/* DEBUG: print signal details? default: NO */
231extern Bool VG_(clo_trace_signals);
232/* DEBUG: print symtab details? default: NO */
233extern Bool VG_(clo_trace_symtab);
sewardjce058b02005-05-01 08:55:38 +0000234/* DEBUG: print call-frame-info details? default: NO */
235extern Bool VG_(clo_trace_cfi);
sewardjb5f6f512005-03-10 23:59:00 +0000236/* DEBUG: print redirection details? default: NO */
237extern Bool VG_(clo_trace_redir);
sewardj8937c812002-04-12 20:12:20 +0000238/* DEBUG: print thread scheduling events? default: NO */
239extern Bool VG_(clo_trace_sched);
sewardjb5f6f512005-03-10 23:59:00 +0000240/* DEBUG: print pthreads calls? default: NO */
241extern Bool VG_(clo_trace_pthreads);
sewardjde4a1d02002-03-22 01:27:54 +0000242/* Display gory details for the k'th most popular error. default:
243 Infinity. */
244extern Int VG_(clo_dump_error);
245/* Number of parents of a backtrace. Default: 8. */
246extern Int VG_(clo_backtrace_size);
daywalker7e73e5f2003-07-04 16:18:15 +0000247/* Engage miscellaneous weird hacks needed for some progs. */
sewardj8d365b52002-05-12 10:52:16 +0000248extern Char* VG_(clo_weird_hacks);
jsgf855d93d2003-10-13 22:26:55 +0000249
rjwalshf5f536f2003-11-17 17:45:00 +0000250/* Track open file descriptors? */
251extern Bool VG_(clo_track_fds);
252
sewardj858964b2002-10-05 14:15:43 +0000253/* Should we run __libc_freeres at exit? Sometimes causes crashes.
254 Default: YES. Note this is subservient to VG_(needs).libc_freeres;
255 if the latter says False, then the setting of VG_(clo_weird_hacks)
nethercote996901a2004-08-03 13:29:09 +0000256 is ignored. Ie if a tool says no, I don't want this to run, that
sewardj858964b2002-10-05 14:15:43 +0000257 cannot be overridden from the command line. */
258extern Bool VG_(clo_run_libc_freeres);
fitzhardinge462f4f92003-12-18 02:10:54 +0000259/* Generate branch-prediction hints? */
260extern Bool VG_(clo_branchpred);
nethercote77eba602003-11-13 17:35:04 +0000261/* Continue stack traces below main()? Default: NO */
262extern Bool VG_(clo_show_below_main);
fitzhardinge98abfc72003-12-16 02:05:15 +0000263/* Test each client pointer dereference to check it's within the
264 client address space bounds */
265extern Bool VG_(clo_pointercheck);
sewardjb5f6f512005-03-10 23:59:00 +0000266/* Model the pthread library */
267extern Bool VG_(clo_model_pthreads);
sewardjde4a1d02002-03-22 01:27:54 +0000268
sewardj062f3552005-01-06 16:13:40 +0000269/* HACK: Use hacked version of clone for Quadrics Elan3 drivers */
270extern Bool VG_(clo_support_elan3);
271
sewardjb1131a82005-03-19 15:12:21 +0000272/* Should we show VEX emulation warnings? Default: NO */
273extern Bool VG_(clo_show_emwarns);
274
sewardj97724e52005-04-02 23:40:59 +0000275/* How much does the stack pointer have to change before tools
276 consider a stack switch to have happened? Default: 2000000 bytes */
277extern Int VG_(clo_max_stackframe);
278
rjwalshe4e779d2004-04-16 23:02:29 +0000279/* Set up the libc freeres wrapper */
sewardjb5f6f512005-03-10 23:59:00 +0000280extern void VGA_(intercept_libc_freeres_wrapper)(Addr);
rjwalshe4e779d2004-04-16 23:02:29 +0000281
sewardjb5f6f512005-03-10 23:59:00 +0000282// Clean up the client by calling before the final reports
283extern void VGA_(final_tidyup)(ThreadId tid);
284
285// Arch-specific client requests
286extern Bool VGA_(client_requests)(ThreadId tid, UWord *args);
sewardj51ac0872004-12-21 01:20:49 +0000287
sewardjde4a1d02002-03-22 01:27:54 +0000288/* ---------------------------------------------------------------------
nethercote85cdd342004-08-01 22:36:40 +0000289 Profiling stuff
sewardjde4a1d02002-03-22 01:27:54 +0000290 ------------------------------------------------------------------ */
291
njn31066fd2005-03-26 00:42:02 +0000292extern void VG_(init_profiling) ( void );
293extern void VG_(done_profiling) ( void );
sewardjde4a1d02002-03-22 01:27:54 +0000294
njn25e49d8e72002-09-23 09:36:25 +0000295#undef VGP_PUSHCC
296#undef VGP_POPCC
njn31066fd2005-03-26 00:42:02 +0000297#define VGP_PUSHCC(x) if (VG_(clo_profile)) VG_(pushcc)(x)
298#define VGP_POPCC(x) if (VG_(clo_profile)) VG_(popcc)(x)
sewardjde4a1d02002-03-22 01:27:54 +0000299
sewardj51ac0872004-12-21 01:20:49 +0000300
sewardjde4a1d02002-03-22 01:27:54 +0000301/* ---------------------------------------------------------------------
nethercote996901a2004-08-03 13:29:09 +0000302 Tool-related types
njn810086f2002-11-14 12:42:47 +0000303 ------------------------------------------------------------------ */
nethercote996901a2004-08-03 13:29:09 +0000304/* These structs are not exposed to tools to mitigate possibility of
305 binary-incompatibilities when the core/tool interface changes. Instead,
nethercote46063202004-09-02 08:51:43 +0000306 set functions are provided (see include/tool.h). */
njn810086f2002-11-14 12:42:47 +0000307typedef
308 struct {
309 Char* name;
310 Char* version;
311 Char* description;
312 Char* copyright_author;
313 Char* bug_reports_to;
njn120281f2003-02-03 12:20:07 +0000314 UInt avg_translation_sizeB;
njn810086f2002-11-14 12:42:47 +0000315 }
316 VgDetails;
317
318extern VgDetails VG_(details);
319
njn810086f2002-11-14 12:42:47 +0000320typedef
321 struct {
322 Bool libc_freeres;
323 Bool core_errors;
njn95ec8702004-11-22 16:46:13 +0000324 Bool tool_errors;
njn810086f2002-11-14 12:42:47 +0000325 Bool basic_block_discards;
njnabb14ad2004-11-24 16:57:16 +0000326 Bool no_longer_used_1; // for backwards compatibility
njn810086f2002-11-14 12:42:47 +0000327 Bool command_line_options;
328 Bool client_requests;
njn37624a72004-11-22 20:37:42 +0000329 Bool no_longer_used_0; // for backwards compatibility
njn810086f2002-11-14 12:42:47 +0000330 Bool syscall_wrapper;
njn810086f2002-11-14 12:42:47 +0000331 Bool sanity_checks;
332 Bool data_syms;
fitzhardinge98abfc72003-12-16 02:05:15 +0000333 Bool shadow_memory;
njn810086f2002-11-14 12:42:47 +0000334 }
335 VgNeeds;
336
337extern VgNeeds VG_(needs);
338
njn51d827b2005-05-09 01:02:08 +0000339typedef struct {
340 // ---------------------------------------------
341 // 'Needs' and related functions
342 // ---------------------------------------------
343 // Basic functions
344 void (*tool_pre_clo_init) (void);
345 void (*tool_post_clo_init)(void);
346 IRBB* (*tool_instrument) (IRBB*, VexGuestLayout*, IRType, IRType);
347 void (*tool_fini) (Int);
348
349 // VG_(needs).core_errors
350 // (none)
351
352 // VG_(needs).tool_errors
353 Bool (*tool_eq_Error) (VgRes, Error*, Error*);
354 void (*tool_pp_Error) (Error*);
355 UInt (*tool_update_extra) (Error*);
356 Bool (*tool_recognised_suppression) (Char*, Supp*);
357 Bool (*tool_read_extra_suppression_info) (Int, Char*, Int, Supp*);
358 Bool (*tool_error_matches_suppression) (Error*, Supp*);
359 Char* (*tool_get_error_name) (Error*);
360 void (*tool_print_extra_suppression_info)(Error*);
361
362 // VG_(needs).basic_block_discards
363 void (*tool_discard_basic_block_info)(Addr, SizeT);
364
365 // VG_(needs).command_line_options
366 Bool (*tool_process_cmd_line_option)(Char*);
367 void (*tool_print_usage) (void);
368 void (*tool_print_debug_usage) (void);
369
370 // VG_(needs).client_requests
371 Bool (*tool_handle_client_request)(ThreadId, UWord*, UWord*);
372
373 // VG_(needs).syscall_wrapper
374 void (*tool_pre_syscall) (ThreadId, UInt);
375 void (*tool_post_syscall)(ThreadId, UInt, Int);
376
377 // VG_(needs).sanity_checks
378 Bool (*tool_cheap_sanity_check)(void);
379 Bool (*tool_expensive_sanity_check)(void);
380
381 // ---------------------------------------------
382 // Event tracking functions
383 // ---------------------------------------------
384 void (*track_new_mem_startup) (Addr, SizeT, Bool, Bool, Bool);
385 void (*track_new_mem_stack_signal)(Addr, SizeT);
386 void (*track_new_mem_brk) (Addr, SizeT);
387 void (*track_new_mem_mmap) (Addr, SizeT, Bool, Bool, Bool);
388
389 void (*track_copy_mem_remap) (Addr, Addr, SizeT);
390 void (*track_change_mem_mprotect) (Addr, SizeT, Bool, Bool, Bool);
391 void (*track_die_mem_stack_signal)(Addr, SizeT);
392 void (*track_die_mem_brk) (Addr, SizeT);
393 void (*track_die_mem_munmap) (Addr, SizeT);
394
395 VGA_REGPARM(1) void (*track_new_mem_stack_4) (Addr);
396 VGA_REGPARM(1) void (*track_new_mem_stack_8) (Addr);
397 VGA_REGPARM(1) void (*track_new_mem_stack_12)(Addr);
398 VGA_REGPARM(1) void (*track_new_mem_stack_16)(Addr);
399 VGA_REGPARM(1) void (*track_new_mem_stack_32)(Addr);
400 void (*track_new_mem_stack)(Addr, SizeT);
401
402 VGA_REGPARM(1) void (*track_die_mem_stack_4) (Addr);
403 VGA_REGPARM(1) void (*track_die_mem_stack_8) (Addr);
404 VGA_REGPARM(1) void (*track_die_mem_stack_12)(Addr);
405 VGA_REGPARM(1) void (*track_die_mem_stack_16)(Addr);
406 VGA_REGPARM(1) void (*track_die_mem_stack_32)(Addr);
407 void (*track_die_mem_stack)(Addr, SizeT);
408
409 void (*track_ban_mem_stack)(Addr, SizeT);
410
411 void (*track_pre_mem_read) (CorePart, ThreadId, Char*, Addr, SizeT);
412 void (*track_pre_mem_read_asciiz)(CorePart, ThreadId, Char*, Addr);
413 void (*track_pre_mem_write) (CorePart, ThreadId, Char*, Addr, SizeT);
414 void (*track_post_mem_write) (CorePart, ThreadId, Addr, SizeT);
415
416 void (*track_pre_reg_read) (CorePart, ThreadId, Char*, OffT, SizeT);
417 void (*track_post_reg_write)(CorePart, ThreadId, OffT, SizeT);
418 void (*track_post_reg_write_clientcall_return)(ThreadId, OffT, SizeT, Addr);
419
420 void (*track_thread_run)(ThreadId);
421
422 void (*track_post_thread_create)(ThreadId, ThreadId);
423 void (*track_post_thread_join) (ThreadId, ThreadId);
424
425 void (*track_pre_mutex_lock) (ThreadId, void*);
426 void (*track_post_mutex_lock) (ThreadId, void*);
427 void (*track_post_mutex_unlock)(ThreadId, void*);
428
429 void (*track_pre_deliver_signal) (ThreadId, Int sigNo, Bool);
430 void (*track_post_deliver_signal)(ThreadId, Int sigNo);
431
432 void (*track_init_shadow_page)(Addr);
433
434 // ---------------------------------------------
435 // malloc/free replacements
436 // ---------------------------------------------
437 void* (*malloc_malloc) (ThreadId, SizeT);
438 void* (*malloc___builtin_new) (ThreadId, SizeT);
439 void* (*malloc___builtin_vec_new) (ThreadId, SizeT);
440 void* (*malloc_memalign) (ThreadId, SizeT, SizeT);
441 void* (*malloc_calloc) (ThreadId, SizeT, SizeT);
442 void (*malloc_free) (ThreadId, void*);
443 void (*malloc___builtin_delete) (ThreadId, void*);
444 void (*malloc___builtin_vec_delete)(ThreadId, void*);
445 void* (*malloc_realloc) (ThreadId, void*, SizeT);
446
447} VgToolInterface;
448
449extern VgToolInterface VG_(tdict);
450
njn810086f2002-11-14 12:42:47 +0000451
sewardj51ac0872004-12-21 01:20:49 +0000452
njn810086f2002-11-14 12:42:47 +0000453/* ---------------------------------------------------------------------
454 Exports of vg_needs.c
455 ------------------------------------------------------------------ */
456
457void VG_(sanity_check_needs)(void);
458
sewardj51ac0872004-12-21 01:20:49 +0000459
njn810086f2002-11-14 12:42:47 +0000460/* ---------------------------------------------------------------------
njn3e884182003-04-15 13:03:23 +0000461 Exports of vg_intercept.c
sewardj2e93c502002-04-12 11:12:52 +0000462 ------------------------------------------------------------------ */
463
464/* This doesn't export code or data that valgrind.so needs to link
465 against. However, the scheduler does need to know the following
466 request codes. A few, publically-visible, request codes are also
nethercote996901a2004-08-03 13:29:09 +0000467 defined in valgrind.h, and similar headers for some tools. */
sewardj2e93c502002-04-12 11:12:52 +0000468
njnd13e5e62005-03-26 03:50:14 +0000469/* Obsolete pthread-related requests */
njn4c791212003-05-02 17:53:54 +0000470#define VG_USERREQ__MALLOC 0x2001
471#define VG_USERREQ__FREE 0x2002
sewardj20917d82002-05-28 01:36:45 +0000472#define VG_USERREQ__APPLY_IN_NEW_THREAD 0x3001
sewardj20917d82002-05-28 01:36:45 +0000473#define VG_USERREQ__QUIT 0x3002
sewardj20917d82002-05-28 01:36:45 +0000474#define VG_USERREQ__WAIT_JOINER 0x3003
sewardj20917d82002-05-28 01:36:45 +0000475#define VG_USERREQ__PTHREAD_JOIN 0x3004
sewardj20917d82002-05-28 01:36:45 +0000476#define VG_USERREQ__SET_CANCELSTATE 0x3005
477#define VG_USERREQ__SET_CANCELTYPE 0x3006
sewardj20917d82002-05-28 01:36:45 +0000478#define VG_USERREQ__TESTCANCEL 0x3007
sewardj20917d82002-05-28 01:36:45 +0000479#define VG_USERREQ__SET_CANCELPEND 0x3008
sewardj20917d82002-05-28 01:36:45 +0000480#define VG_USERREQ__SET_OR_GET_DETACH 0x3009
thughese321d492004-10-17 15:00:20 +0000481#define VG_USERREQ__PTHREAD_GET_THREADID 0x300A
482#define VG_USERREQ__PTHREAD_MUTEX_LOCK 0x300B
483#define VG_USERREQ__PTHREAD_MUTEX_TIMEDLOCK 0x300C
sewardj20917d82002-05-28 01:36:45 +0000484#define VG_USERREQ__PTHREAD_MUTEX_TRYLOCK 0x300D
485#define VG_USERREQ__PTHREAD_MUTEX_UNLOCK 0x300E
486#define VG_USERREQ__PTHREAD_COND_WAIT 0x300F
487#define VG_USERREQ__PTHREAD_COND_TIMEDWAIT 0x3010
488#define VG_USERREQ__PTHREAD_COND_SIGNAL 0x3011
489#define VG_USERREQ__PTHREAD_COND_BROADCAST 0x3012
490#define VG_USERREQ__PTHREAD_KEY_CREATE 0x3013
491#define VG_USERREQ__PTHREAD_KEY_DELETE 0x3014
sewardj00a66b12002-10-12 16:42:35 +0000492#define VG_USERREQ__PTHREAD_SETSPECIFIC_PTR 0x3015
493#define VG_USERREQ__PTHREAD_GETSPECIFIC_PTR 0x3016
njnd13e5e62005-03-26 03:50:14 +0000494#define VG_USERREQ__READ_MILLISECOND_TIMER 0x3017
sewardj20917d82002-05-28 01:36:45 +0000495#define VG_USERREQ__PTHREAD_SIGMASK 0x3018
sewardjb5f6f512005-03-10 23:59:00 +0000496#define VG_USERREQ__SIGWAIT 0x3019
sewardj20917d82002-05-28 01:36:45 +0000497#define VG_USERREQ__PTHREAD_KILL 0x301A
498#define VG_USERREQ__PTHREAD_YIELD 0x301B
sewardj00a66b12002-10-12 16:42:35 +0000499#define VG_USERREQ__PTHREAD_KEY_VALIDATE 0x301C
sewardj8ad94e12002-05-29 00:10:20 +0000500#define VG_USERREQ__CLEANUP_PUSH 0x3020
501#define VG_USERREQ__CLEANUP_POP 0x3021
sewardj870497a2002-05-29 01:06:47 +0000502#define VG_USERREQ__GET_KEY_D_AND_S 0x3022
sewardjef037c72002-05-30 00:40:03 +0000503#define VG_USERREQ__NUKE_OTHER_THREADS 0x3023
sewardjb5f6f512005-03-10 23:59:00 +0000504#define VG_USERREQ__GET_N_SIGS_RETURNED 0x3024
sewardj2cb00342002-06-28 01:46:26 +0000505#define VG_USERREQ__SET_FHSTACK_USED 0x3025
506#define VG_USERREQ__GET_FHSTACK_USED 0x3026
507#define VG_USERREQ__SET_FHSTACK_ENTRY 0x3027
508#define VG_USERREQ__GET_FHSTACK_ENTRY 0x3028
fitzhardinge98abfc72003-12-16 02:05:15 +0000509#define VG_USERREQ__GET_SIGRT_MIN 0x302B
510#define VG_USERREQ__GET_SIGRT_MAX 0x302C
511#define VG_USERREQ__ALLOC_RTSIG 0x302D
fitzhardinge98abfc72003-12-16 02:05:15 +0000512#define VG_USERREQ__GET_MALLOCFUNCS 0x3030
thughesdaa34562004-06-27 12:48:53 +0000513#define VG_USERREQ__GET_STACK_INFO 0x3033
sewardj45b4b372002-04-16 22:50:32 +0000514#define VG_USERREQ__GET_PTHREAD_TRACE_LEVEL 0x3101
sewardj4dced352002-06-04 22:54:20 +0000515#define VG_USERREQ__PTHREAD_ERROR 0x3102
sewardjb5f6f512005-03-10 23:59:00 +0000516
517
fitzhardinge39de4b42003-10-31 07:12:21 +0000518/* Internal equivalent of VALGRIND_PRINTF . */
519#define VG_USERREQ__INTERNAL_PRINTF 0x3103
njnaa3c26b2005-03-12 05:32:28 +0000520/* Internal equivalent of VALGRIND_PRINTF_BACKTRACE . (no longer used) */
521//#define VG_USERREQ__INTERNAL_PRINTF_BACKTRACE 0x3104
sewardj45b4b372002-04-16 22:50:32 +0000522
sewardjb5f6f512005-03-10 23:59:00 +0000523/* Denote the finish of __libc_freeres_wrapper().
524 A synonym for exit. */
525#define VG_USERREQ__LIBC_FREERES_DONE 0x3029
sewardj54cacf02002-04-12 23:24:59 +0000526
njn717cde52005-05-10 02:47:21 +0000527/* Intercept prefix stuff. See
528 coregrind/m_replace_malloc/vg_replace_malloc.c for details.
529 Unfortunately the "_vgi_" literal is also hardcoded in that file, so if
530 you change this one you must also change the other one. */
sewardj9ee81f52005-04-02 17:38:59 +0000531#define VG_INTERCEPT_PREFIX "_vgi_"
532#define VG_INTERCEPT_PREFIX_LEN 5
rjwalshe4e779d2004-04-16 23:02:29 +0000533
sewardj9ee81f52005-04-02 17:38:59 +0000534/* Not sure what these are for. Todo: clarify */
535#define VG_WRAPPER_PREFIX "_vgw_"
536#define VG_WRAPPER_PREFIX_LEN 5
537#define VG_WRAPPER(name) _vgw_##name
538#define VG_WRAPPER_ALIAS(name) "_vgw_" #name
rjwalshe4e779d2004-04-16 23:02:29 +0000539
njn4c791212003-05-02 17:53:54 +0000540
fitzhardinge98abfc72003-12-16 02:05:15 +0000541struct vg_mallocfunc_info {
542 /* things vg_replace_malloc.o needs to know about */
njncf81d552005-03-31 04:52:26 +0000543 void* (*tl_malloc) (ThreadId tid, SizeT n);
544 void* (*tl___builtin_new) (ThreadId tid, SizeT n);
545 void* (*tl___builtin_vec_new) (ThreadId tid, SizeT n);
546 void* (*tl_memalign) (ThreadId tid, SizeT align, SizeT n);
547 void* (*tl_calloc) (ThreadId tid, SizeT nmemb, SizeT n);
548 void (*tl_free) (ThreadId tid, void* p);
549 void (*tl___builtin_delete) (ThreadId tid, void* p);
550 void (*tl___builtin_vec_delete)(ThreadId tid, void* p);
551 void* (*tl_realloc) (ThreadId tid, void* p, SizeT size);
fitzhardinge98abfc72003-12-16 02:05:15 +0000552
njncf81d552005-03-31 04:52:26 +0000553 SizeT (*arena_payload_szB) (ArenaId aid, void* payload);
fitzhardinge98abfc72003-12-16 02:05:15 +0000554
fitzhardinge98abfc72003-12-16 02:05:15 +0000555 Bool clo_trace_malloc;
556};
sewardj1fe7b002002-07-16 01:43:15 +0000557
sewardj51ac0872004-12-21 01:20:49 +0000558
sewardj2e93c502002-04-12 11:12:52 +0000559/* ---------------------------------------------------------------------
sewardj2e93c502002-04-12 11:12:52 +0000560 Exports of vg_scheduler.c
561 ------------------------------------------------------------------ */
562
sewardjb5f6f512005-03-10 23:59:00 +0000563/*
564 Thread state machine:
565
566 Empty -> Init -> Runnable <=> WaitSys/Yielding
567 ^ |
568 \---- Zombie -----/
569 */
sewardj2e93c502002-04-12 11:12:52 +0000570typedef
jsgf855d93d2003-10-13 22:26:55 +0000571 enum ThreadStatus {
sewardj2e93c502002-04-12 11:12:52 +0000572 VgTs_Empty, /* this slot is not in use */
sewardjb5f6f512005-03-10 23:59:00 +0000573 VgTs_Init, /* just allocated */
574 VgTs_Runnable, /* ready to run */
jsgf855d93d2003-10-13 22:26:55 +0000575 VgTs_WaitSys, /* waiting for a syscall to complete */
sewardjb5f6f512005-03-10 23:59:00 +0000576 VgTs_Yielding, /* temporarily yielding the CPU */
577 VgTs_Zombie, /* transient state just before exiting */
sewardj2e93c502002-04-12 11:12:52 +0000578 }
579 ThreadStatus;
sewardj8ad94e12002-05-29 00:10:20 +0000580
sewardjb5f6f512005-03-10 23:59:00 +0000581/* Return codes from the scheduler. */
thughes11975ff2004-06-12 12:58:22 +0000582typedef
sewardjb5f6f512005-03-10 23:59:00 +0000583 enum {
584 VgSrc_None, /* not exiting yet */
585 VgSrc_ExitSyscall, /* client called exit(). This is the normal
586 route out. */
587 VgSrc_FatalSig /* Killed by the default action of a fatal
588 signal */
thughes11975ff2004-06-12 12:58:22 +0000589 }
sewardjb5f6f512005-03-10 23:59:00 +0000590 VgSchedReturnCode;
thughes11975ff2004-06-12 12:58:22 +0000591
sewardjb5f6f512005-03-10 23:59:00 +0000592struct _ThreadState {
njn25e49d8e72002-09-23 09:36:25 +0000593 /* ThreadId == 0 (and hence vg_threads[0]) is NEVER USED.
594 The thread identity is simply the index in vg_threads[].
595 ThreadId == 1 is the root thread and has the special property
596 that we don't try and allocate or deallocate its stack. For
597 convenience of generating error message, we also put the
598 ThreadId in this tid field, but be aware that it should
599 ALWAYS == the index in vg_threads[]. */
600 ThreadId tid;
sewardj2e93c502002-04-12 11:12:52 +0000601
sewardjb5f6f512005-03-10 23:59:00 +0000602 /* Current scheduling status. */
njn25e49d8e72002-09-23 09:36:25 +0000603 ThreadStatus status;
sewardj2e93c502002-04-12 11:12:52 +0000604
sewardjb5f6f512005-03-10 23:59:00 +0000605 /* This is set if the thread is in the process of exiting for any
606 reason. The precise details of the exit are in the OS-specific
607 state. */
608 VgSchedReturnCode exitreason;
sewardj3b5d8862002-04-20 13:53:23 +0000609
sewardjb5f6f512005-03-10 23:59:00 +0000610 /* Architecture-specific thread state. */
611 ThreadArchState arch;
sewardjb48e5002002-05-13 00:16:03 +0000612
njn25e49d8e72002-09-23 09:36:25 +0000613 /* This thread's blocked-signals mask. Semantics is that for a
614 signal to be delivered to this thread, the signal must not be
jsgf855d93d2003-10-13 22:26:55 +0000615 blocked by this signal mask. If more than one thread accepts a
616 signal, then it will be delivered to one at random. If all
617 threads block the signal, it will remain pending until either a
sewardjb5f6f512005-03-10 23:59:00 +0000618 thread unblocks it or someone uses sigwaitsig/sigtimedwait. */
nethercote73b526f2004-10-31 18:48:21 +0000619 vki_sigset_t sig_mask;
sewardjb48e5002002-05-13 00:16:03 +0000620
sewardjb5f6f512005-03-10 23:59:00 +0000621 /* tmp_sig_mask is usually the same as sig_mask, and is kept in
622 sync whenever sig_mask is changed. The only time they have
623 different values is during the execution of a sigsuspend, where
624 tmp_sig_mask is the temporary mask which sigsuspend installs.
625 It is only consulted to compute the signal mask applied to a
626 signal handler. */
627 vki_sigset_t tmp_sig_mask;
sewardj2e93c502002-04-12 11:12:52 +0000628
sewardjb5f6f512005-03-10 23:59:00 +0000629 /* A little signal queue for signals we can't get the kernel to
630 queue for us. This is only allocated as needed, since it should
631 be rare. */
632 struct SigQueue *sig_queue;
633
634 /* Syscall the Thread is currently running; -1 if none. Should only
635 be set while Thread is in VgTs_WaitSys. */
636 Int syscallno;
637
638 /* A value the Tool wants to pass from its pre-syscall to its
639 post-syscall function. */
640 void *tool_pre_syscall_value;
thughes8abf3922004-10-16 10:59:49 +0000641
njn50ba34e2005-04-04 02:41:42 +0000642 /* Client stacks. When a thread slot is freed, we don't deallocate its
njn25e49d8e72002-09-23 09:36:25 +0000643 stack; we just leave it lying around for the next use of the
644 slot. If the next use of the slot requires a larger stack,
645 only then is the old one deallocated and a new one
646 allocated.
sewardj2e93c502002-04-12 11:12:52 +0000647
njn25e49d8e72002-09-23 09:36:25 +0000648 For the main thread (threadid == 0), this mechanism doesn't
649 apply. We don't know the size of the stack since we didn't
650 allocate it, and furthermore we never reallocate it. */
sewardj2e93c502002-04-12 11:12:52 +0000651
njn25e49d8e72002-09-23 09:36:25 +0000652 /* The allocated size of this thread's stack (permanently zero
653 if this is ThreadId == 0, since we didn't allocate its stack) */
njn50ba34e2005-04-04 02:41:42 +0000654 SizeT client_stack_szB;
sewardj2e93c502002-04-12 11:12:52 +0000655
sewardj92a59562002-09-30 00:53:10 +0000656 /* Address of the highest legitimate word in this stack. This is
657 used for error messages only -- not critical for execution
658 correctness. Is is set for all stacks, specifically including
659 ThreadId == 0 (the main thread). */
njn50ba34e2005-04-04 02:41:42 +0000660 Addr client_stack_highest_word;
njn25e49d8e72002-09-23 09:36:25 +0000661
fitzhardinge98c4dc02004-03-16 08:27:29 +0000662 /* Alternate signal stack */
nethercote73b526f2004-10-31 18:48:21 +0000663 vki_stack_t altstack;
fitzhardinge98c4dc02004-03-16 08:27:29 +0000664
sewardjb5f6f512005-03-10 23:59:00 +0000665 /* OS-specific thread state */
666 os_thread_t os_state;
sewardj004e8ca2005-02-28 17:27:04 +0000667
668 /* Used in the syscall handlers. Set to True to indicate that the
669 PRE routine for a syscall has set the syscall result already and
670 so the syscall does not need to be handed to the kernel. */
671 Bool syscall_result_set;
sewardjb5f6f512005-03-10 23:59:00 +0000672
673 /* Per-thread jmp_buf to resume scheduler after a signal */
674 Bool sched_jmpbuf_valid;
675 jmp_buf sched_jmpbuf;
nethercote8ff888f2004-11-17 17:11:45 +0000676};
sewardj2e93c502002-04-12 11:12:52 +0000677
sewardj018f7622002-05-15 21:13:39 +0000678/* The thread table. */
679extern ThreadState VG_(threads)[VG_N_THREADS];
680
sewardjb5f6f512005-03-10 23:59:00 +0000681/* Allocate a new ThreadState */
682extern ThreadId VG_(alloc_ThreadState)(void);
683
684/* A thread exits. tid must currently be running. */
685extern void VG_(exit_thread)(ThreadId tid);
686
687/* Kill a thread. This interrupts whatever a thread is doing, and
688 makes it exit ASAP. This does not set the exitreason or
689 exitcode. */
690extern void VG_(kill_thread)(ThreadId tid);
691
sewardj018f7622002-05-15 21:13:39 +0000692/* Check that tid is in range and denotes a non-Empty thread. */
sewardjb48e5002002-05-13 00:16:03 +0000693extern Bool VG_(is_valid_tid) ( ThreadId tid );
694
jsgf855d93d2003-10-13 22:26:55 +0000695/* Get the ThreadState for a particular thread */
696extern ThreadState *VG_(get_ThreadState)(ThreadId tid);
697
sewardjb5f6f512005-03-10 23:59:00 +0000698/* Given an LWP id (ie, real kernel thread id), find the corresponding
699 ThreadId */
700extern ThreadId VG_(get_lwp_tid)(Int lwpid);
701
702/* Returns true if a thread is currently running (ie, has the CPU lock) */
703extern Bool VG_(is_running_thread)(ThreadId tid);
704
705/* Returns true if the thread is in the process of exiting */
706extern Bool VG_(is_exiting)(ThreadId tid);
707
708/* Return the number of non-dead Threads */
709extern Int VG_(count_living_threads)(void);
710
sewardjccef2e62002-05-29 19:26:32 +0000711/* Nuke all threads except tid. */
sewardjb5f6f512005-03-10 23:59:00 +0000712extern void VG_(nuke_all_threads_except) ( ThreadId me, VgSchedReturnCode reason );
sewardjccef2e62002-05-29 19:26:32 +0000713
sewardjb5f6f512005-03-10 23:59:00 +0000714/* Make a thread the running thread. The thread must previously been
715 sleeping, and not holding the CPU semaphore. This will set the
716 thread state to VgTs_Runnable, and the thread will attempt to take
717 the CPU semaphore. By the time it returns, tid will be the running
718 thread. */
719extern void VG_(set_running) ( ThreadId tid );
jsgf855d93d2003-10-13 22:26:55 +0000720
sewardjb5f6f512005-03-10 23:59:00 +0000721/* Set a thread into a sleeping state. Before the call, the thread
722 must be runnable, and holding the CPU semaphore. When this call
723 returns, the thread will be set to the specified sleeping state,
724 and will not be holding the CPU semaphore. Note that another
725 thread could be running by the time this call returns, so the
726 caller must be careful not to touch any shared state. It is also
727 the caller's responsibility to actually block until the thread is
728 ready to run again. */
729extern void VG_(set_sleeping) ( ThreadId tid, ThreadStatus state );
sewardj2e93c502002-04-12 11:12:52 +0000730
sewardjb5f6f512005-03-10 23:59:00 +0000731/* Yield the CPU for a while */
732extern void VG_(vg_yield)(void);
sewardj7e87e382002-05-03 19:09:05 +0000733
sewardjb5f6f512005-03-10 23:59:00 +0000734// The scheduler.
735extern VgSchedReturnCode VG_(scheduler) ( ThreadId tid );
736
737// Do everything which needs doing before the process finally ends,
738// like printing reports, etc
739extern void VG_(shutdown_actions)(ThreadId tid);
sewardj2e93c502002-04-12 11:12:52 +0000740
741extern void VG_(scheduler_init) ( void );
742
sewardj15a43e12002-04-17 19:35:12 +0000743extern void VG_(pp_sched_status) ( void );
sewardj2e93c502002-04-12 11:12:52 +0000744
nethercote75d26242004-08-01 22:59:18 +0000745// Longjmp back to the scheduler and thus enter the sighandler immediately.
sewardjb5f6f512005-03-10 23:59:00 +0000746extern void VG_(resume_scheduler) ( ThreadId tid );
sewardj2e93c502002-04-12 11:12:52 +0000747
sewardjb5f6f512005-03-10 23:59:00 +0000748/* If true, a fault is Valgrind-internal (ie, a bug) */
749extern Bool VG_(my_fault);
nethercote238a3c32004-08-09 13:13:31 +0000750
sewardj2e93c502002-04-12 11:12:52 +0000751/* ---------------------------------------------------------------------
sewardjde4a1d02002-03-22 01:27:54 +0000752 Exports of vg_signals.c
753 ------------------------------------------------------------------ */
754
sewardjb5f6f512005-03-10 23:59:00 +0000755/* Set the standard set of blocked signals, used wheneever we're not
756 running a client syscall. */
757extern void VG_(block_signals)(ThreadId tid);
jsgf855d93d2003-10-13 22:26:55 +0000758
sewardjb5f6f512005-03-10 23:59:00 +0000759/* Highest signal the kernel will let us use */
760extern Int VG_(max_signal);
jsgf855d93d2003-10-13 22:26:55 +0000761
sewardjde4a1d02002-03-22 01:27:54 +0000762extern void VG_(sigstartup_actions) ( void );
763
jsgf855d93d2003-10-13 22:26:55 +0000764extern Bool VG_(is_sig_ign) ( Int sigNo );
765
sewardjb5f6f512005-03-10 23:59:00 +0000766/* Poll a thread's set of pending signals, and update the Thread's context to deliver one */
767extern void VG_(poll_signals) ( ThreadId );
sewardjde4a1d02002-03-22 01:27:54 +0000768
769/* Fake system calls for signal handling. */
njn502badb2005-05-08 02:04:49 +0000770extern Int VG_(do_sys_sigaltstack) ( ThreadId tid, vki_stack_t* ss,
771 vki_stack_t* oss );
772extern Int VG_(do_sys_sigaction) ( Int signo,
773 const struct vki_sigaction *new_act,
774 struct vki_sigaction *old_act );
775extern Int VG_(do_sys_sigprocmask) ( ThreadId tid, Int how,
776 vki_sigset_t* set,
777 vki_sigset_t* oldset );
sewardjefbfcdf2002-06-19 17:35:45 +0000778
sewardj2e93c502002-04-12 11:12:52 +0000779/* Handy utilities to block/restore all host signals. */
780extern void VG_(block_all_host_signals)
nethercote73b526f2004-10-31 18:48:21 +0000781 ( /* OUT */ vki_sigset_t* saved_mask );
sewardj018f7622002-05-15 21:13:39 +0000782extern void VG_(restore_all_host_signals)
nethercote73b526f2004-10-31 18:48:21 +0000783 ( /* IN */ vki_sigset_t* saved_mask );
sewardjde4a1d02002-03-22 01:27:54 +0000784
jsgf855d93d2003-10-13 22:26:55 +0000785extern void VG_(kill_self)(Int sigNo);
786
fitzhardingef1beb252004-03-16 09:49:08 +0000787/* These function synthesize a fault, as if the running instruction
788 had had a fault. These functions do not return - they longjmp back
789 into the scheduler so the signal can be delivered. */
790extern void VG_(synth_fault) (ThreadId tid);
791extern void VG_(synth_fault_mapping)(ThreadId tid, Addr addr);
792extern void VG_(synth_fault_perms) (ThreadId tid, Addr addr);
sewardj5e2f0012004-12-13 14:10:34 +0000793extern void VG_(synth_sigill) (ThreadId tid, Addr addr);
fitzhardingef1beb252004-03-16 09:49:08 +0000794
sewardjb5f6f512005-03-10 23:59:00 +0000795/* Extend the stack to cover addr, if possible */
796extern Bool VG_(extend_stack)(Addr addr, UInt maxsize);
797
798/* Returns True if the signal is OK for the client to use */
799extern Bool VG_(client_signal_OK)(Int sigNo);
800
801/* Forces the client's signal handler to SIG_DFL - generally just
802 before using that signal to kill the process. */
803extern void VG_(set_default_handler)(Int sig);
804
805/* Adjust a client's signal mask to match our internal requirements */
806extern void VG_(sanitize_client_sigmask)(ThreadId tid, vki_sigset_t *mask);
807
808/* Wait until a thread-related predicate is true */
809extern void VG_(wait_for_threadstate)(Bool (*pred)(void *), void *arg);
sewardj51ac0872004-12-21 01:20:49 +0000810
sewardjde4a1d02002-03-22 01:27:54 +0000811/* ---------------------------------------------------------------------
812 Exports of vg_mylibc.c
813 ------------------------------------------------------------------ */
814
njnca0518d2004-11-26 19:34:36 +0000815// Useful for making failing stubs, when certain things haven't yet been
816// implemented.
njn50ae1a72005-04-08 23:28:23 +0000817#define I_die_here \
818 VG_(assert_fail) ("Unimplemented functionality", \
819 __FILE__, __LINE__, __PRETTY_FUNCTION__, \
820 "valgrind", VG_BUGS_TO, "")
njnca0518d2004-11-26 19:34:36 +0000821
njn50ae1a72005-04-08 23:28:23 +0000822#define vg_assert(expr) \
823 ((void) ((expr) ? 0 : \
824 (VG_(assert_fail) (/*isCore*/True, VG_STRINGIFY(expr), \
825 __FILE__, __LINE__, __PRETTY_FUNCTION__, \
826 ""), \
827 0)))
828
829#define vg_assert2(expr, format, args...) \
830 ((void) ((expr) ? 0 : \
831 (VG_(assert_fail) (/*isCore*/True, VG_STRINGIFY(expr), \
832 __FILE__, __LINE__, __PRETTY_FUNCTION__, \
833 format, ##args), \
834 0)))
835
njne427a662002-10-02 11:08:25 +0000836__attribute__ ((__noreturn__))
837extern void VG_(core_panic) ( Char* str );
thughes5876d552004-09-26 18:44:06 +0000838__attribute__ ((__noreturn__))
njnd01fef72005-03-25 23:35:48 +0000839extern void VG_(core_panic_at) ( Char* str, StackTrace ips );
sewardjde4a1d02002-03-22 01:27:54 +0000840
nethercote05675c82004-08-04 10:37:49 +0000841/* Tools use VG_(strdup)() which doesn't expose ArenaId */
njn25e49d8e72002-09-23 09:36:25 +0000842extern Char* VG_(arena_strdup) ( ArenaId aid, const Char* s);
sewardjde4a1d02002-03-22 01:27:54 +0000843
njn25e49d8e72002-09-23 09:36:25 +0000844extern Int VG_(fcntl) ( Int fd, Int cmd, Int arg );
jsgf855d93d2003-10-13 22:26:55 +0000845extern Int VG_(poll)( struct vki_pollfd *, UInt nfds, Int timeout);
sewardj2e93c502002-04-12 11:12:52 +0000846
fitzhardinge98abfc72003-12-16 02:05:15 +0000847/* system/mman.h */
nethercote8b5f40c2004-11-02 13:29:50 +0000848extern void* VG_(mmap)( void* start, SizeT length, UInt prot, UInt flags,
nethercote5b9fafd2004-11-04 18:39:22 +0000849 UInt sf_flags, UInt fd, OffT offset );
nethercote8b5f40c2004-11-02 13:29:50 +0000850extern Int VG_(munmap)( void* start, SizeT length );
851extern Int VG_(mprotect)( void *start, SizeT length, UInt prot );
sewardj79048ce2005-02-18 08:28:32 +0000852extern Int VG_(mprotect_native)( void *start, SizeT length, UInt prot );
fitzhardinge98abfc72003-12-16 02:05:15 +0000853
854
jsgf855d93d2003-10-13 22:26:55 +0000855/* Move an fd into the Valgrind-safe range */
856Int VG_(safe_fd)(Int oldfd);
857
sewardj570f8902002-11-03 11:44:36 +0000858extern Int VG_(write_socket)( Int sd, void *msg, Int count );
sewardj73cf3bc2002-11-03 03:20:15 +0000859
860/* --- Connecting over the network --- */
861extern Int VG_(connect_via_socket)( UChar* str );
862
fitzhardinge98abfc72003-12-16 02:05:15 +0000863/* Environment manipulations */
nethercote60a96c52004-08-03 13:08:31 +0000864extern Char **VG_(env_setenv) ( Char ***envp, const Char* varname,
865 const Char *val );
866extern void VG_(env_unsetenv) ( Char **env, const Char *varname );
867extern void VG_(env_remove_valgrind_env_stuff) ( Char** env );
sewardj570f8902002-11-03 11:44:36 +0000868
sewardjb5f6f512005-03-10 23:59:00 +0000869extern void VG_(nanosleep)(struct vki_timespec *);
njn2521d322005-05-08 14:45:13 +0000870
sewardj570f8902002-11-03 11:44:36 +0000871/* ---------------------------------------------------------------------
872 Exports of vg_message.c
873 ------------------------------------------------------------------ */
874
875/* Low-level -- send bytes directly to the message sink. Do not
876 use. */
877extern void VG_(send_bytes_to_logging_sink) ( Char* msg, Int nbytes );
878
sewardjde4a1d02002-03-22 01:27:54 +0000879/* ---------------------------------------------------------------------
sewardjde4a1d02002-03-22 01:27:54 +0000880 Exports of vg_demangle.c
881 ------------------------------------------------------------------ */
882
883extern void VG_(demangle) ( Char* orig, Char* result, Int result_size );
884
sewardjb5f6f512005-03-10 23:59:00 +0000885extern void VG_(reloc_abs_jump) ( UChar *jmp );
sewardj4ccf7072004-11-28 16:58:05 +0000886
sewardjde4a1d02002-03-22 01:27:54 +0000887/* ---------------------------------------------------------------------
sewardjde4a1d02002-03-22 01:27:54 +0000888 Exports of vg_translate.c
889 ------------------------------------------------------------------ */
890
sewardjfa8ec112005-01-19 11:55:34 +0000891extern
892Bool VG_(translate) ( ThreadId tid,
893 Addr64 orig_addr,
894 Bool debugging_translation,
895 Int debugging_verbosity );
sewardjb5ff83e2002-12-01 19:40:49 +0000896
sewardjde4a1d02002-03-22 01:27:54 +0000897/* ---------------------------------------------------------------------
sewardjde4a1d02002-03-22 01:27:54 +0000898 Exports of vg_symtab2.c
899 ------------------------------------------------------------------ */
900
fitzhardinge98abfc72003-12-16 02:05:15 +0000901typedef struct _Segment Segment;
sewardjb5f6f512005-03-10 23:59:00 +0000902typedef struct _CodeRedirect CodeRedirect;
fitzhardinge98abfc72003-12-16 02:05:15 +0000903
904extern Bool VG_(is_object_file) ( const void *hdr );
fitzhardinge98abfc72003-12-16 02:05:15 +0000905extern SegInfo * VG_(read_seg_symbols) ( Segment *seg );
fitzhardinge98abfc72003-12-16 02:05:15 +0000906extern void VG_(symtab_incref) ( SegInfo * );
nethercote8991d5a2004-11-03 17:07:46 +0000907extern void VG_(symtab_decref) ( SegInfo *, Addr a );
sewardjde4a1d02002-03-22 01:27:54 +0000908
njn25e49d8e72002-09-23 09:36:25 +0000909extern Bool VG_(get_fnname_nodemangle)( Addr a, Char* fnname, Int n_fnname );
sewardj25c7c3a2003-07-10 00:17:58 +0000910
sewardjb5f6f512005-03-10 23:59:00 +0000911extern Addr VG_(reverse_search_one_symtab) ( const SegInfo* si, const Char* name );
912
fitzhardinge98abfc72003-12-16 02:05:15 +0000913/* Set up some default redirects */
914extern void VG_(setup_code_redirect_table) ( void );
sewardj25c7c3a2003-07-10 00:17:58 +0000915
sewardjb5f6f512005-03-10 23:59:00 +0000916extern Bool VG_(resolve_redir_allsegs)(CodeRedirect *redir);
917
sewardj35165532005-04-30 18:47:48 +0000918extern Bool VG_(use_CFI_info) ( /*MOD*/Addr* ipP,
919 /*MOD*/Addr* spP,
920 /*MOD*/Addr* fpP,
921 Addr min_accessible,
922 Addr max_accessible );
923
924
sewardjb5f6f512005-03-10 23:59:00 +0000925/* ---------------------------------------------------------------------
926 Exports of vg_redir.c
927 ------------------------------------------------------------------ */
fitzhardinge98abfc72003-12-16 02:05:15 +0000928/* Redirection machinery */
nethercote85cdd342004-08-01 22:36:40 +0000929extern Addr VG_(code_redirect) ( Addr orig );
sewardjde4a1d02002-03-22 01:27:54 +0000930
tom748a1312005-04-02 15:53:01 +0000931extern void VG_(add_redirect_sym_to_addr)(const Char *from_lib,
932 const Char *from_sym,
933 Addr to_addr);
934extern void VG_(add_redirect_addr_to_addr)(Addr from_addr, Addr to_addr);
sewardjb5f6f512005-03-10 23:59:00 +0000935extern void VG_(resolve_seg_redirs)(SegInfo *si);
936extern Bool VG_(resolve_redir)(CodeRedirect *redir, const SegInfo *si);
937
938/* Wrapping machinery */
939enum return_type {
940 RT_RETURN,
941 RT_LONGJMP,
942 RT_EXIT,
943};
944
945typedef struct _FuncWrapper FuncWrapper;
946struct _FuncWrapper {
947 void *(*before)(va_list args);
948 void (*after) (void *nonce, enum return_type, Word retval);
949};
950
951extern void VG_(wrap_function)(Addr eip, const FuncWrapper *wrapper);
952extern const FuncWrapper *VG_(is_wrapped)(Addr eip);
953extern Bool VG_(is_wrapper_return)(Addr eip);
954
955/* Primary interface for adding wrappers for client-side functions. */
956extern CodeRedirect *VG_(add_wrapper)(const Char *from_lib, const Char *from_sym,
957 const FuncWrapper *wrapper);
958
959extern Bool VG_(is_resolved)(const CodeRedirect *redir);
sewardj51ac0872004-12-21 01:20:49 +0000960
sewardjde4a1d02002-03-22 01:27:54 +0000961/* ---------------------------------------------------------------------
sewardjde4a1d02002-03-22 01:27:54 +0000962 Exports of vg_main.c
963 ------------------------------------------------------------------ */
964
sewardj73cf3bc2002-11-03 03:20:15 +0000965/* Tell the logging mechanism whether we are logging to a file
966 descriptor or a socket descriptor. */
967extern Bool VG_(logging_to_filedes);
968
njn25e49d8e72002-09-23 09:36:25 +0000969/* Sanity checks which may be done at any time. The scheduler decides when. */
nethercote885dd912004-08-03 23:14:00 +0000970extern void VG_(sanity_check_general) ( Bool force_expensive );
njn25e49d8e72002-09-23 09:36:25 +0000971
fitzhardinge98abfc72003-12-16 02:05:15 +0000972/* Address space */
973extern Addr VG_(client_base); /* client address space limits */
974extern Addr VG_(client_end);
975extern Addr VG_(client_mapbase); /* base of mappings */
976extern Addr VG_(clstk_base); /* client stack range */
977extern Addr VG_(clstk_end);
fitzhardinge92360792003-12-24 10:11:11 +0000978extern Addr VG_(client_trampoline_code);
979
fitzhardinge98abfc72003-12-16 02:05:15 +0000980extern Addr VG_(brk_base); /* start of brk */
981extern Addr VG_(brk_limit); /* current brk */
nethercote996901a2004-08-03 13:29:09 +0000982extern Addr VG_(shadow_base); /* tool's shadow memory */
fitzhardinge98abfc72003-12-16 02:05:15 +0000983extern Addr VG_(shadow_end);
984extern Addr VG_(valgrind_base); /* valgrind's address range */
nethercote820bd8c2004-09-07 23:04:49 +0000985extern Addr VG_(valgrind_last); // Nb: last byte, rather than one past the end
fitzhardinge98abfc72003-12-16 02:05:15 +0000986
nethercote73b526f2004-10-31 18:48:21 +0000987extern struct vki_rlimit VG_(client_rlimit_data); /* client's original rlimit data */
988extern struct vki_rlimit VG_(client_rlimit_stack); /* client's original rlimit stack */
fitzhardingeb50068f2004-02-24 23:42:55 +0000989
fitzhardingea49f9b52003-12-16 22:26:45 +0000990/* client executable file descriptor */
991extern Int VG_(clexecfd);
fitzhardinge98abfc72003-12-16 02:05:15 +0000992
nethercotef6a1d502004-08-09 12:21:57 +0000993// Help set up the child used when doing execve() with --trace-children=yes
994Char* VG_(build_child_VALGRINDCLO) ( Char* exename );
995Char* VG_(build_child_exename) ( void );
996
sewardjb5f6f512005-03-10 23:59:00 +0000997/* The master thread the one which will be responsible for mopping
998 everything up at exit. Normally it is tid 1, since that's the
999 first thread created, but it may be something else after a
1000 fork(). */
1001extern ThreadId VG_(master_tid);
1002
sewardjde4a1d02002-03-22 01:27:54 +00001003/* Called when some unhandleable client behaviour is detected.
1004 Prints a msg and aborts. */
njn25e49d8e72002-09-23 09:36:25 +00001005extern void VG_(unimplemented) ( Char* msg )
1006 __attribute__((__noreturn__));
sewardjde4a1d02002-03-22 01:27:54 +00001007
nethercote04d0fbc2004-01-26 16:48:06 +00001008/* Something of a function looking for a home ... start up debugger. */
njnc6168192004-11-29 13:54:10 +00001009extern void VG_(start_debugger) ( ThreadId tid );
sewardjde4a1d02002-03-22 01:27:54 +00001010
sewardjde4a1d02002-03-22 01:27:54 +00001011/* Counts downwards in vg_run_innerloop. */
1012extern UInt VG_(dispatch_ctr);
1013
sewardj4ccf7072004-11-28 16:58:05 +00001014/* Stats ... */
nethercote844e7122004-08-02 15:27:22 +00001015extern void VG_(print_scheduler_stats) ( void );
sewardj2e93c502002-04-12 11:12:52 +00001016
sewardj51ac0872004-12-21 01:20:49 +00001017/* Indicates what arch and subarch we are running on. */
1018extern VexArch VG_(vex_arch);
1019extern VexSubArch VG_(vex_subarch);
1020
njn1f707722005-03-27 03:17:52 +00001021/* 64-bit counter for the number of basic blocks done. */
1022extern ULong VG_(bbs_done);
1023
nethercote2e05c332004-09-06 16:43:37 +00001024
sewardjde4a1d02002-03-22 01:27:54 +00001025/* ---------------------------------------------------------------------
sewardjde4a1d02002-03-22 01:27:54 +00001026 Exports of vg_transtab.c
1027 ------------------------------------------------------------------ */
1028
sewardjfa8ec112005-01-19 11:55:34 +00001029/* The fast-cache for tt-lookup, and for finding counters. */
1030extern ULong* VG_(tt_fast) [VG_TT_FAST_SIZE];
1031extern UInt* VG_(tt_fastN)[VG_TT_FAST_SIZE];
njn25e49d8e72002-09-23 09:36:25 +00001032
sewardjb5f6f512005-03-10 23:59:00 +00001033
nethercote92e7b7f2004-08-07 17:52:25 +00001034extern void VG_(init_tt_tc) ( void );
sewardj6c3769f2002-11-29 01:02:45 +00001035
sewardjfa8ec112005-01-19 11:55:34 +00001036extern
1037void VG_(add_to_trans_tab)( VexGuestExtents* vge,
1038 Addr64 entry,
1039 AddrH code,
1040 UInt code_len );
1041
1042extern Bool VG_(search_transtab) ( /*OUT*/AddrH* result,
1043 Addr64 guest_addr,
1044 Bool upd_cache );
1045
1046extern void VG_(discard_translations) ( Addr64 start, UInt range );
sewardjde4a1d02002-03-22 01:27:54 +00001047
sewardj4ccf7072004-11-28 16:58:05 +00001048extern void VG_(sanity_check_tt_tc) ( Char* caller );
sewardjde4a1d02002-03-22 01:27:54 +00001049
nethercote92e7b7f2004-08-07 17:52:25 +00001050extern void VG_(print_tt_tc_stats) ( void );
1051
sewardjfa8ec112005-01-19 11:55:34 +00001052extern UInt VG_(get_bbs_translated) ( void );
1053
1054extern void VG_(show_BB_profile) ( void );
1055
sewardjde4a1d02002-03-22 01:27:54 +00001056
sewardjde4a1d02002-03-22 01:27:54 +00001057/* ---------------------------------------------------------------------
sewardjde4a1d02002-03-22 01:27:54 +00001058 Exports of vg_syscall.S
1059 ------------------------------------------------------------------ */
1060
njnca6fef02004-11-29 16:49:18 +00001061// We use a full prototype rather than "..." here to ensure that all
1062// arguments get converted to a UWord appropriately. Not doing so can
1063// cause problems when passing 32-bit integers on 64-bit platforms, because
1064// the top 32-bits might not be zeroed appropriately, eg. as would happen
1065// with the 6th arg on AMD64 which is passed on the stack.
njnf4aeaea2004-11-29 17:33:31 +00001066extern Word VG_(do_syscall) ( UInt, UWord, UWord, UWord, UWord, UWord, UWord );
njnca6fef02004-11-29 16:49:18 +00001067
1068// Macros make life easier.
1069#define vgPlain_do_syscall0(s) VG_(do_syscall)((s),0,0,0,0,0,0)
1070#define vgPlain_do_syscall1(s,a) VG_(do_syscall)((s),(a),0,0,0,0,0)
1071#define vgPlain_do_syscall2(s,a,b) VG_(do_syscall)((s),(a),(b),0,0,0,0)
1072#define vgPlain_do_syscall3(s,a,b,c) VG_(do_syscall)((s),(a),(b),(c),0,0,0)
1073#define vgPlain_do_syscall4(s,a,b,c,d) VG_(do_syscall)((s),(a),(b),(c),(d),0,0)
1074#define vgPlain_do_syscall5(s,a,b,c,d,e) VG_(do_syscall)((s),(a),(b),(c),(d),(e),0)
1075#define vgPlain_do_syscall6(s,a,b,c,d,e,f) VG_(do_syscall)((s),(a),(b),(c),(d),(e),(f))
1076
jsgf855d93d2003-10-13 22:26:55 +00001077extern Int VG_(clone) ( Int (*fn)(void *), void *stack, Int flags, void *arg,
sewardjb5f6f512005-03-10 23:59:00 +00001078 Int *child_tid, Int *parent_tid, vki_modify_ldt_t * );
fitzhardinge4f10ada2004-06-03 10:00:42 +00001079extern void VG_(sigreturn)(void);
sewardjde4a1d02002-03-22 01:27:54 +00001080
1081/* ---------------------------------------------------------------------
sewardjde4a1d02002-03-22 01:27:54 +00001082 Exports of vg_dispatch.S
1083 ------------------------------------------------------------------ */
1084
njnd6f157d2004-11-30 17:27:21 +00001085/* This subroutine is called from the C world. It is passed
1086 a pointer to the VEX guest state (arch.vex). It must run code
1087 from the instruction pointer in the guest state, and exit when
1088 VG_(dispatch_ctr) reaches zero, or we need to defer to the scheduler.
1089 The return value must indicate why it returned back to the scheduler.
1090 It can also be exited if the executing code throws a non-resumable
1091 signal, for example SIGSEGV, in which case control longjmp()s back past
1092 here.
1093
1094 This code simply handles the common case fast -- when the translation
1095 address is found in the translation cache. For anything else, the
1096 scheduler does the work.
1097*/
sewardj0312f512005-03-30 19:04:29 +00001098extern UWord VG_(run_innerloop) ( void* guest_state );
sewardjde4a1d02002-03-22 01:27:54 +00001099
sewardjde4a1d02002-03-22 01:27:54 +00001100/* ---------------------------------------------------------------------
1101 Exports of vg_helpers.S
1102 ------------------------------------------------------------------ */
1103
fitzhardinge92360792003-12-24 10:11:11 +00001104/* Information about trampoline code (for signal return and syscalls) */
1105extern const Char VG_(trampoline_code_start);
1106extern const Int VG_(trampoline_code_length);
1107extern const Int VG_(tramp_sigreturn_offset);
sewardjb5f6f512005-03-10 23:59:00 +00001108extern const Int VG_(tramp_rt_sigreturn_offset);
fitzhardinge92360792003-12-24 10:11:11 +00001109extern const Int VG_(tramp_syscall_offset);
tomee0bcbf2005-05-02 10:28:42 +00001110extern const Int VG_(tramp_gettimeofday_offset);
1111extern const Int VG_(tramp_time_offset);
sewardj20917d82002-05-28 01:36:45 +00001112
njn4f9c9342002-04-29 16:03:24 +00001113/* ---------------------------------------------------------------------
nethercote996901a2004-08-03 13:29:09 +00001114 Things relating to the used tool
njn4f9c9342002-04-29 16:03:24 +00001115 ------------------------------------------------------------------ */
1116
njn51d827b2005-05-09 01:02:08 +00001117// Note the use of C's comma operator here -- it means that we execute both
1118// statements, and the rvalue of the whole thing is the rvalue of the last
1119// statement. This lets us say "x = VG_TDICT_CALL(...)" in the required
1120// places, while still checking the assertion.
1121#define VG_TDICT_CALL(fn, args...) \
1122 ( tl_assert2(VG_(tdict).fn, \
1123 "you forgot to set VgToolInterface function '" #fn "'"), \
1124 VG_(tdict).fn(args) )
1125
fitzhardinge98abfc72003-12-16 02:05:15 +00001126#define VG_TRACK(fn, args...) \
1127 do { \
njn51d827b2005-05-09 01:02:08 +00001128 if (VG_(tdict).track_##fn) \
1129 VG_(tdict).track_##fn(args); \
fitzhardinge98abfc72003-12-16 02:05:15 +00001130 } while(0)
sewardj18d75132002-05-16 11:06:21 +00001131
nethercotec06e2132004-09-03 13:45:29 +00001132// ---------------------------------------------------------------------
1133// Architecture-specific things defined in eg. x86/*.c
1134// ---------------------------------------------------------------------
1135
sewardj51ac0872004-12-21 01:20:49 +00001136// Returns the architecture and subarchitecture, or indicates
1137// that this subarchitecture is unable to run Valgrind
1138// Returns False to indicate we cannot proceed further.
sewardj51ac0872004-12-21 01:20:49 +00001139extern Bool VGA_(getArchAndSubArch)( /*OUT*/VexArch*,
1140 /*OUT*/VexSubArch* );
njncf45fd42004-11-24 16:30:22 +00001141// Accessors for the ThreadArchState
njn35172bc2005-03-26 00:04:03 +00001142#define INSTR_PTR(regs) ((regs).vex.VGA_INSTR_PTR)
1143#define STACK_PTR(regs) ((regs).vex.VGA_STACK_PTR)
1144#define FRAME_PTR(regs) ((regs).vex.VGA_FRAME_PTR)
1145#define CLREQ_ARGS(regs) ((regs).vex.VGA_CLREQ_ARGS)
njn35172bc2005-03-26 00:04:03 +00001146#define CLREQ_RET(regs) ((regs).vex.VGA_CLREQ_RET)
njn16de5572004-11-27 14:27:21 +00001147// Offsets for the Vex state
njn35172bc2005-03-26 00:04:03 +00001148#define O_STACK_PTR (offsetof(VexGuestArchState, VGA_STACK_PTR))
1149#define O_FRAME_PTR (offsetof(VexGuestArchState, VGA_FRAME_PTR))
1150#define O_CLREQ_RET (offsetof(VexGuestArchState, VGA_CLREQ_RET))
njncf45fd42004-11-24 16:30:22 +00001151
1152
sewardj2a99cf62004-11-24 10:44:19 +00001153// Setting up the initial thread (1) state
1154extern void
1155 VGA_(init_thread1state) ( Addr client_eip,
1156 Addr esp_at_startup,
1157 /*MOD*/ ThreadArchState* arch );
sewardjde4a1d02002-03-22 01:27:54 +00001158
nethercotec009ebe2004-09-13 11:05:11 +00001159// Thread stuff
sewardj2a99cf62004-11-24 10:44:19 +00001160extern void VGA_(cleanup_thread) ( ThreadArchState* );
1161extern void VGA_(setup_child) ( ThreadArchState*, ThreadArchState* );
nethercotef9b59412004-09-10 15:33:32 +00001162
sewardjb5f6f512005-03-10 23:59:00 +00001163// OS/Platform-specific thread clear (after thread exit)
1164extern void VGA_(os_state_clear)(ThreadState *);
1165
1166// OS/Platform-specific thread init (at scheduler init time)
1167extern void VGA_(os_state_init)(ThreadState *);
1168
1169// Run a thread from beginning to end. Does not return if tid == VG_(master_tid).
sewardj0c1a5962005-03-22 00:19:55 +00001170void VGA_(thread_wrapper)(Word /*ThreadId*/ tid);
sewardjb5f6f512005-03-10 23:59:00 +00001171
1172// Like VGA_(thread_wrapper), but it allocates a stack before calling
1173// to VGA_(thread_wrapper) on that stack, as if it had been set up by
1174// clone()
1175void VGA_(main_thread_wrapper)(ThreadId tid) __attribute__ ((__noreturn__));
1176
1177// Return how many bytes of a thread's Valgrind stack are unused
njn990e90c2005-04-05 02:49:09 +00001178SSizeT VGA_(stack_unused)(ThreadId tid);
sewardjb5f6f512005-03-10 23:59:00 +00001179
1180// Terminate the process. Does not return.
1181void VGA_(terminate)(ThreadId tid, VgSchedReturnCode src) __attribute__((__noreturn__));
1182
1183// wait until all other threads are dead
1184extern void VGA_(reap_threads)(ThreadId self);
1185
1186// handle an arch-specific client request
1187extern Bool VGA_(client_request)(ThreadId tid, UWord *args);
1188
nethercotec009ebe2004-09-13 11:05:11 +00001189// Symtab stuff
njncf45fd42004-11-24 16:30:22 +00001190extern UInt* VGA_(reg_addr_from_tst) ( Int regno, ThreadArchState* );
nethercotecd656042004-09-11 23:48:22 +00001191
nethercotefedd8102004-09-13 15:19:34 +00001192// Pointercheck
1193extern Bool VGA_(setup_pointercheck) ( void );
1194
1195// For attaching the debugger
sewardj2a99cf62004-11-24 10:44:19 +00001196extern Int VGA_(ptrace_setregs_from_tst) ( Int pid, ThreadArchState* arch );
nethercotefedd8102004-09-13 15:19:34 +00001197
sewardjb5f6f512005-03-10 23:59:00 +00001198// Used by leakcheck
1199extern void VGA_(mark_from_registers)(ThreadId tid, void (*marker)(Addr));
1200
sewardjb5f6f512005-03-10 23:59:00 +00001201////typedef struct _ThreadArchAux ThreadArchAux;
nethercote9b3c7652004-10-19 13:18:00 +00001202
1203
nethercote41c75da2004-10-18 15:34:14 +00001204// ---------------------------------------------------------------------
1205// Platform-specific things defined in eg. x86/*.c
1206// ---------------------------------------------------------------------
nethercote775508a2004-09-07 22:38:23 +00001207
njn2521d322005-05-08 14:45:13 +00001208// Do any platform specific redirects.
tom748a1312005-04-02 15:53:01 +00001209extern void VGP_(setup_redirects)(void);
sewardjb5f6f512005-03-10 23:59:00 +00001210
1211///* ---------------------------------------------------------------------
1212// Thread modelling
1213// ------------------------------------------------------------------ */
1214//extern void VG_(tm_thread_create) (ThreadId creator, ThreadId tid, Bool detached);
1215//extern void VG_(tm_thread_exit) (ThreadId tid);
1216//extern Bool VG_(tm_thread_exists) (ThreadId tid);
1217//extern void VG_(tm_thread_detach) (ThreadId tid);
1218//extern void VG_(tm_thread_join) (ThreadId joiner, ThreadId joinee);
1219//extern void VG_(tm_thread_switchto)(ThreadId tid);
1220//
1221//extern void VG_(tm_mutex_init) (ThreadId tid, Addr mutexp);
1222//extern void VG_(tm_mutex_destroy)(ThreadId tid, Addr mutexp);
1223//extern void VG_(tm_mutex_trylock)(ThreadId tid, Addr mutexp);
1224//extern void VG_(tm_mutex_giveup) (ThreadId tid, Addr mutexp);
1225//extern void VG_(tm_mutex_acquire)(ThreadId tid, Addr mutexp);
1226//extern void VG_(tm_mutex_tryunlock)(ThreadId tid, Addr mutexp);
1227//extern void VG_(tm_mutex_unlock) (ThreadId tid, Addr mutexp);
1228//extern Bool VG_(tm_mutex_exists) (Addr mutexp);
1229//
1230//extern UInt VG_(tm_error_update_extra) (Error *err);
1231//extern Bool VG_(tm_error_equal) (VgRes res, Error *e1, Error *e2);
1232//extern void VG_(tm_error_print) (Error *err);
1233//
1234//extern void VG_(tm_init) ();
1235//
1236//extern void VG_(tm_cond_init) (ThreadId tid, Addr condp);
1237//extern void VG_(tm_cond_destroy) (ThreadId tid, Addr condp);
1238//extern void VG_(tm_cond_wait) (ThreadId tid, Addr condp, Addr mutexp);
1239//extern void VG_(tm_cond_wakeup) (ThreadId tid, Addr condp, Addr mutexp);
1240//extern void VG_(tm_cond_signal) (ThreadId tid, Addr condp);
1241//
1242///* ----- pthreads ----- */
1243//extern void VG_(pthread_init) ();
1244//extern void VG_(pthread_startfunc_wrapper)(Addr wrapper);
1245//
1246//struct vg_pthread_newthread_data {
1247// void *(*startfunc)(void *arg);
1248// void *arg;
1249//};
sewardj3b2736a2002-03-24 12:18:35 +00001250
1251/* ---------------------------------------------------------------------
1252 Finally - autoconf-generated settings
1253 ------------------------------------------------------------------ */
1254
1255#include "config.h"
1256
nethercotec06e2132004-09-03 13:45:29 +00001257#endif /* ndef __CORE_H */
1258
sewardjde4a1d02002-03-22 01:27:54 +00001259/*--------------------------------------------------------------------*/
nethercote109d0df2004-09-02 08:10:13 +00001260/*--- end ---*/
sewardjde4a1d02002-03-22 01:27:54 +00001261/*--------------------------------------------------------------------*/