blob: 1c9ad5ab91a61c95d844d89d3cc82d49a2debf0b [file] [log] [blame]
sewardjde4a1d02002-03-22 01:27:54 +00001
2/*--------------------------------------------------------------------*/
nethercote71980f02004-01-24 18:18:54 +00003/*--- Startup: the real stuff vg_main.c ---*/
sewardjde4a1d02002-03-22 01:27:54 +00004/*--------------------------------------------------------------------*/
5
6/*
njnb9c427c2004-12-01 14:14:42 +00007 This file is part of Valgrind, a dynamic binary instrumentation
8 framework.
sewardjde4a1d02002-03-22 01:27:54 +00009
nethercotebb1c9912004-01-04 16:43:23 +000010 Copyright (C) 2000-2004 Julian Seward
sewardjde4a1d02002-03-22 01:27:54 +000011 jseward@acm.org
sewardjde4a1d02002-03-22 01:27:54 +000012
13 This program is free software; you can redistribute it and/or
14 modify it under the terms of the GNU General Public License as
15 published by the Free Software Foundation; either version 2 of the
16 License, or (at your option) any later version.
17
18 This program is distributed in the hope that it will be useful, but
19 WITHOUT ANY WARRANTY; without even the implied warranty of
20 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21 General Public License for more details.
22
23 You should have received a copy of the GNU General Public License
24 along with this program; if not, write to the Free Software
25 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
26 02111-1307, USA.
27
njn25e49d8e72002-09-23 09:36:25 +000028 The GNU General Public License is contained in the file COPYING.
sewardjde4a1d02002-03-22 01:27:54 +000029*/
30
nethercote71980f02004-01-24 18:18:54 +000031#define _FILE_OFFSET_BITS 64
sewardjde4a1d02002-03-22 01:27:54 +000032
nethercotef1e5e152004-09-01 23:58:16 +000033#include "core.h"
nethercote71980f02004-01-24 18:18:54 +000034#include "ume.h"
nethercote71980f02004-01-24 18:18:54 +000035
36#include <dirent.h>
37#include <dlfcn.h>
38#include <errno.h>
nethercote71980f02004-01-24 18:18:54 +000039#include <stdio.h>
fitzhardingeb727d042004-01-06 00:18:21 +000040#include <stdlib.h>
nethercote71980f02004-01-24 18:18:54 +000041#include <string.h>
42#include <sys/mman.h>
nethercote71980f02004-01-24 18:18:54 +000043#include <sys/stat.h>
fitzhardingeb727d042004-01-06 00:18:21 +000044#include <sys/ptrace.h>
fitzhardingeb727d042004-01-06 00:18:21 +000045#include <sys/wait.h>
46#include <unistd.h>
47
thughes74b8de22004-04-22 18:12:31 +000048#ifndef AT_DCACHEBSIZE
49#define AT_DCACHEBSIZE 19
50#endif /* AT_DCACHEBSIZE */
51
52#ifndef AT_ICACHEBSIZE
53#define AT_ICACHEBSIZE 20
54#endif /* AT_ICACHEBSIZE */
55
56#ifndef AT_UCACHEBSIZE
57#define AT_UCACHEBSIZE 21
58#endif /* AT_UCACHEBSIZE */
59
nethercote71980f02004-01-24 18:18:54 +000060#ifndef AT_SYSINFO
61#define AT_SYSINFO 32
62#endif /* AT_SYSINFO */
63
64#ifndef AT_SYSINFO_EHDR
65#define AT_SYSINFO_EHDR 33
66#endif /* AT_SYSINFO_EHDR */
67
68#ifndef AT_SECURE
69#define AT_SECURE 23 /* secure mode boolean */
70#endif /* AT_SECURE */
71
nethercote71980f02004-01-24 18:18:54 +000072/* redzone gap between client address space and shadow */
73#define REDZONE_SIZE (1 * 1024*1024)
74
75/* size multiple for client address space */
nethercotee94b2de2004-06-23 16:15:06 +000076#define CLIENT_SIZE_MULTIPLE (1 * 1024*1024)
nethercote71980f02004-01-24 18:18:54 +000077
nethercotee2097312004-06-27 12:29:56 +000078/* Proportion of client space for its heap (rest is for mmaps + stack) */
79#define CLIENT_HEAP_PROPORTION 0.333
nethercote71980f02004-01-24 18:18:54 +000080
81/*====================================================================*/
82/*=== Global entities not referenced from generated code ===*/
83/*====================================================================*/
84
sewardjde4a1d02002-03-22 01:27:54 +000085/* ---------------------------------------------------------------------
nethercote71980f02004-01-24 18:18:54 +000086 Startup stuff
sewardjde4a1d02002-03-22 01:27:54 +000087 ------------------------------------------------------------------ */
88
nethercote71980f02004-01-24 18:18:54 +000089/* Client address space, lowest to highest (see top of ume.c) */
90Addr VG_(client_base); /* client address space limits */
fitzhardinge98abfc72003-12-16 02:05:15 +000091Addr VG_(client_end);
92Addr VG_(client_mapbase);
fitzhardinge92360792003-12-24 10:11:11 +000093Addr VG_(client_trampoline_code);
fitzhardinge98abfc72003-12-16 02:05:15 +000094Addr VG_(clstk_base);
95Addr VG_(clstk_end);
nethercote71980f02004-01-24 18:18:54 +000096
97Addr VG_(brk_base); /* start of brk */
98Addr VG_(brk_limit); /* current brk */
99
nethercote996901a2004-08-03 13:29:09 +0000100Addr VG_(shadow_base); /* tool's shadow memory */
fitzhardinge98abfc72003-12-16 02:05:15 +0000101Addr VG_(shadow_end);
nethercote71980f02004-01-24 18:18:54 +0000102
103Addr VG_(valgrind_base); /* valgrind's address range */
rjwalsh18b66312004-08-23 18:15:12 +0000104
nethercote820bd8c2004-09-07 23:04:49 +0000105// Note that VG_(valgrind_last) names the last byte of the section, whereas
106// the VG_(*_end) vars name the byte one past the end of the section.
107Addr VG_(valgrind_last);
fitzhardinge98abfc72003-12-16 02:05:15 +0000108
nethercote73b526f2004-10-31 18:48:21 +0000109struct vki_rlimit VG_(client_rlimit_data);
110struct vki_rlimit VG_(client_rlimit_stack);
fitzhardingeb50068f2004-02-24 23:42:55 +0000111
fitzhardinge98abfc72003-12-16 02:05:15 +0000112/* stage1 (main) executable */
nethercotef6a1d502004-08-09 12:21:57 +0000113static Int vgexecfd = -1;
fitzhardingea49f9b52003-12-16 22:26:45 +0000114
115/* client executable */
116Int VG_(clexecfd) = -1;
fitzhardinge98abfc72003-12-16 02:05:15 +0000117
118/* Path to library directory */
119const Char *VG_(libdir) = VG_LIBDIR;
120
121/* our argc/argv */
nethercotef6a1d502004-08-09 12:21:57 +0000122static Int vg_argc;
123static Char **vg_argv;
fitzhardinge98abfc72003-12-16 02:05:15 +0000124
jsgf855d93d2003-10-13 22:26:55 +0000125/* PID of the main thread */
126Int VG_(main_pid);
127
128/* PGRP of process */
129Int VG_(main_pgrp);
njn25e49d8e72002-09-23 09:36:25 +0000130
thughesad1c9562004-06-26 11:27:52 +0000131/* Application-visible file descriptor limits */
132Int VG_(fd_soft_limit) = -1;
133Int VG_(fd_hard_limit) = -1;
fitzhardingef0046f22003-12-18 02:39:22 +0000134
nethercote4ad74312004-10-26 09:59:49 +0000135/* As deduced from sp_at_startup, the client's argc, argv[] and
nethercote71980f02004-01-24 18:18:54 +0000136 envp[] as extracted from the client's stack at startup-time. */
137Int VG_(client_argc);
138Char** VG_(client_argv);
139Char** VG_(client_envp);
sewardjde4a1d02002-03-22 01:27:54 +0000140
njn16de5572004-11-27 14:27:21 +0000141// Instruction pointer guest state offset, used by $VG_ARCH/dispatch.S.
njn87c98122004-11-30 23:32:01 +0000142OffT VG_(instr_ptr_offset);
njn16de5572004-11-27 14:27:21 +0000143
sewardj51ac0872004-12-21 01:20:49 +0000144/* Indicates what arch and subarch we are running on. */
145VexArch VG_(vex_arch) = VexArch_INVALID;
146VexSubArch VG_(vex_subarch) = VexSubArch_INVALID;
147
148
sewardjde4a1d02002-03-22 01:27:54 +0000149/* ---------------------------------------------------------------------
nethercote71980f02004-01-24 18:18:54 +0000150 Running stuff
sewardjde4a1d02002-03-22 01:27:54 +0000151 ------------------------------------------------------------------ */
sewardjde4a1d02002-03-22 01:27:54 +0000152
nethercote71980f02004-01-24 18:18:54 +0000153/* Counts downwards in VG_(run_innerloop). */
154UInt VG_(dispatch_ctr);
sewardjde4a1d02002-03-22 01:27:54 +0000155
156/* 64-bit counter for the number of basic blocks done. */
sewardj8b635a42004-11-22 19:01:47 +0000157ULong VG_(bbs_done) = 0;
sewardjde4a1d02002-03-22 01:27:54 +0000158
nethercote71980f02004-01-24 18:18:54 +0000159/* Tell the logging mechanism whether we are logging to a file
160 descriptor or a socket descriptor. */
161Bool VG_(logging_to_filedes) = True;
162
sewardj73cf3bc2002-11-03 03:20:15 +0000163
nethercote71980f02004-01-24 18:18:54 +0000164/*====================================================================*/
165/*=== Counters, for profiling purposes only ===*/
166/*====================================================================*/
sewardjde4a1d02002-03-22 01:27:54 +0000167
sewardjde4a1d02002-03-22 01:27:54 +0000168/* Counts pertaining to internal sanity checking. */
nethercote297effd2004-08-02 15:07:57 +0000169static UInt sanity_fast_count = 0;
170static UInt sanity_slow_count = 0;
sewardjde4a1d02002-03-22 01:27:54 +0000171
nethercote3a42fb82004-08-03 18:08:50 +0000172static void print_all_stats ( void )
nethercote71980f02004-01-24 18:18:54 +0000173{
nethercote3a42fb82004-08-03 18:08:50 +0000174 // Translation stats
nethercote92e7b7f2004-08-07 17:52:25 +0000175 VG_(print_tt_tc_stats)();
nethercote71980f02004-01-24 18:18:54 +0000176 VG_(message)(Vg_DebugMsg,
sewardj4ccf7072004-11-28 16:58:05 +0000177 " dispatch: %llu jumps (bb entries).", VG_(bbs_done) );
nethercote71980f02004-01-24 18:18:54 +0000178
nethercote3a42fb82004-08-03 18:08:50 +0000179 // Scheduler stats
nethercote844e7122004-08-02 15:27:22 +0000180 VG_(print_scheduler_stats)();
nethercote71980f02004-01-24 18:18:54 +0000181
nethercote71980f02004-01-24 18:18:54 +0000182 VG_(message)(Vg_DebugMsg,
183 " sanity: %d cheap, %d expensive checks.",
nethercote297effd2004-08-02 15:07:57 +0000184 sanity_fast_count, sanity_slow_count );
nethercote3a42fb82004-08-03 18:08:50 +0000185
nethercote3a42fb82004-08-03 18:08:50 +0000186 // Memory stats
nethercote885dd912004-08-03 23:14:00 +0000187 if (VG_(clo_verbosity) > 2) {
nethercote3a42fb82004-08-03 18:08:50 +0000188 VG_(message)(Vg_DebugMsg, "");
189 VG_(message)(Vg_DebugMsg,
190 "------ Valgrind's internal memory use stats follow ------" );
nethercote885dd912004-08-03 23:14:00 +0000191 VG_(sanity_check_malloc_all)();
nethercote3a42fb82004-08-03 18:08:50 +0000192 VG_(print_all_arena_stats)();
nethercote885dd912004-08-03 23:14:00 +0000193 VG_(message)(Vg_DebugMsg, "");
nethercote3a42fb82004-08-03 18:08:50 +0000194 VG_(message)(Vg_DebugMsg,
195 "------ Valgrind's ExeContext management stats follow ------" );
196 VG_(print_ExeContext_stats)();
197 }
nethercote71980f02004-01-24 18:18:54 +0000198}
199
200
201/*====================================================================*/
202/*=== Miscellaneous global functions ===*/
203/*====================================================================*/
204
nethercotecf97ffb2004-09-09 13:40:31 +0000205static Int ptrace_setregs(Int pid, ThreadId tid)
206{
sewardj2a99cf62004-11-24 10:44:19 +0000207 return VGA_(ptrace_setregs_from_tst)(pid, &VG_(threads)[tid].arch);
nethercotecf97ffb2004-09-09 13:40:31 +0000208}
209
nethercote04d0fbc2004-01-26 16:48:06 +0000210/* Start debugger and get it to attach to this process. Called if the
211 user requests this service after an error has been shown, so she can
nethercote71980f02004-01-24 18:18:54 +0000212 poke around and look at parameters, memory, etc. You can't
nethercote04d0fbc2004-01-26 16:48:06 +0000213 meaningfully get the debugger to continue the program, though; to
214 continue, quit the debugger. */
njnc6168192004-11-29 13:54:10 +0000215void VG_(start_debugger) ( ThreadId tid )
nethercote71980f02004-01-24 18:18:54 +0000216{
217 Int pid;
218
219 if ((pid = fork()) == 0) {
220 ptrace(PTRACE_TRACEME, 0, NULL, NULL);
nethercote73b526f2004-10-31 18:48:21 +0000221 VG_(kill)(VG_(getpid)(), VKI_SIGSTOP);
nethercote71980f02004-01-24 18:18:54 +0000222
223 } else if (pid > 0) {
nethercote71980f02004-01-24 18:18:54 +0000224 Int status;
225 Int res;
226
nethercote71980f02004-01-24 18:18:54 +0000227 if ((res = VG_(waitpid)(pid, &status, 0)) == pid &&
228 WIFSTOPPED(status) && WSTOPSIG(status) == SIGSTOP &&
nethercotecf97ffb2004-09-09 13:40:31 +0000229 ptrace_setregs(pid, tid) == 0 &&
thughes1d160052004-04-21 15:39:57 +0000230 kill(pid, SIGSTOP) == 0 &&
231 ptrace(PTRACE_DETACH, pid, NULL, 0) == 0) {
nethercote04d0fbc2004-01-26 16:48:06 +0000232 Char pidbuf[15];
233 Char file[30];
234 Char buf[100];
235 Char *bufptr;
236 Char *cmdptr;
237
238 VG_(sprintf)(pidbuf, "%d", pid);
239 VG_(sprintf)(file, "/proc/%d/fd/%d", pid, VG_(clexecfd));
240
241 bufptr = buf;
242 cmdptr = VG_(clo_db_command);
243
244 while (*cmdptr) {
245 switch (*cmdptr) {
246 case '%':
247 switch (*++cmdptr) {
248 case 'f':
249 VG_(memcpy)(bufptr, file, VG_(strlen)(file));
250 bufptr += VG_(strlen)(file);
251 cmdptr++;
252 break;
253 case 'p':
254 VG_(memcpy)(bufptr, pidbuf, VG_(strlen)(pidbuf));
255 bufptr += VG_(strlen)(pidbuf);
256 cmdptr++;
257 break;
258 default:
259 *bufptr++ = *cmdptr++;
260 break;
261 }
262 break;
263 default:
264 *bufptr++ = *cmdptr++;
265 break;
266 }
267 }
268
269 *bufptr++ = '\0';
270
271 VG_(message)(Vg_UserMsg, "starting debugger with cmd: %s", buf);
nethercote71980f02004-01-24 18:18:54 +0000272 res = VG_(system)(buf);
273 if (res == 0) {
274 VG_(message)(Vg_UserMsg, "");
275 VG_(message)(Vg_UserMsg,
nethercote04d0fbc2004-01-26 16:48:06 +0000276 "Debugger has detached. Valgrind regains control. We continue.");
nethercote71980f02004-01-24 18:18:54 +0000277 } else {
278 VG_(message)(Vg_UserMsg, "Apparently failed!");
279 VG_(message)(Vg_UserMsg, "");
280 }
281 }
282
nethercote73b526f2004-10-31 18:48:21 +0000283 VG_(kill)(pid, VKI_SIGKILL);
nethercote71980f02004-01-24 18:18:54 +0000284 VG_(waitpid)(pid, &status, 0);
285 }
286}
287
288
289/* Print some helpful-ish text about unimplemented things, and give
290 up. */
291void VG_(unimplemented) ( Char* msg )
292{
293 VG_(message)(Vg_UserMsg, "");
294 VG_(message)(Vg_UserMsg,
295 "Valgrind detected that your program requires");
296 VG_(message)(Vg_UserMsg,
297 "the following unimplemented functionality:");
298 VG_(message)(Vg_UserMsg, " %s", msg);
299 VG_(message)(Vg_UserMsg,
300 "This may be because the functionality is hard to implement,");
301 VG_(message)(Vg_UserMsg,
302 "or because no reasonable program would behave this way,");
303 VG_(message)(Vg_UserMsg,
304 "or because nobody has yet needed it. In any case, let us know at");
305 VG_(message)(Vg_UserMsg,
306 "%s and/or try to work around the problem, if you can.", VG_BUGS_TO);
307 VG_(message)(Vg_UserMsg,
308 "");
309 VG_(message)(Vg_UserMsg,
310 "Valgrind has to exit now. Sorry. Bye!");
311 VG_(message)(Vg_UserMsg,
312 "");
313 VG_(pp_sched_status)();
314 VG_(exit)(1);
315}
316
sewardj2a99cf62004-11-24 10:44:19 +0000317/* Get the simulated stack pointer */
318Addr VG_(get_stack_pointer) ( ThreadId tid )
nethercote71980f02004-01-24 18:18:54 +0000319{
njncf45fd42004-11-24 16:30:22 +0000320 return STACK_PTR( VG_(threads)[tid].arch );
nethercote71980f02004-01-24 18:18:54 +0000321}
322
njnea4b28c2004-11-30 16:04:58 +0000323/* Debugging thing .. can be called from assembly with OYNK macro. */
324void VG_(oynk) ( Int n )
325{
326 OINK(n);
327}
328
nethercote71980f02004-01-24 18:18:54 +0000329/* Initialize the PID and PGRP of scheduler LWP; this is also called
330 in any new children after fork. */
331static void newpid(ThreadId unused)
332{
333 /* PID of scheduler LWP */
334 VG_(main_pid) = VG_(getpid)();
335 VG_(main_pgrp) = VG_(getpgrp)();
336}
337
338/*====================================================================*/
339/*=== Check we were launched by stage 1 ===*/
340/*====================================================================*/
341
342/* Look for our AUXV table */
nethercotec25c4492004-10-18 11:52:17 +0000343int scan_auxv(void* init_sp)
nethercote71980f02004-01-24 18:18:54 +0000344{
nethercoteebf1d862004-11-01 18:22:05 +0000345 const struct ume_auxv *auxv = find_auxv((UWord*)init_sp);
nethercote31779c72004-07-30 21:50:15 +0000346 int padfile = -1, found = 0;
nethercote71980f02004-01-24 18:18:54 +0000347
348 for (; auxv->a_type != AT_NULL; auxv++)
349 switch(auxv->a_type) {
350 case AT_UME_PADFD:
nethercote31779c72004-07-30 21:50:15 +0000351 padfile = auxv->u.a_val;
nethercote71980f02004-01-24 18:18:54 +0000352 found |= 1;
353 break;
354
355 case AT_UME_EXECFD:
nethercotef6a1d502004-08-09 12:21:57 +0000356 vgexecfd = auxv->u.a_val;
nethercote71980f02004-01-24 18:18:54 +0000357 found |= 2;
358 break;
nethercote7f390022004-10-25 17:18:24 +0000359
360 case AT_PHDR:
361 VG_(valgrind_base) = PGROUNDDN(auxv->u.a_val);
362 break;
nethercote71980f02004-01-24 18:18:54 +0000363 }
364
nethercote361a14e2004-07-26 11:11:56 +0000365 if ( found != (1|2) ) {
366 fprintf(stderr, "valgrind: stage2 must be launched by stage1\n");
nethercote71980f02004-01-24 18:18:54 +0000367 exit(127);
368 }
nethercote31779c72004-07-30 21:50:15 +0000369 vg_assert(padfile >= 0);
370 return padfile;
nethercote71980f02004-01-24 18:18:54 +0000371}
372
373
374/*====================================================================*/
375/*=== Address space determination ===*/
376/*====================================================================*/
377
nethercote7f390022004-10-25 17:18:24 +0000378extern char _start[];
379
nethercote31779c72004-07-30 21:50:15 +0000380static void layout_remaining_space(Addr argc_addr, float ratio)
nethercote71980f02004-01-24 18:18:54 +0000381{
nethercotea3c3cf22004-11-01 18:38:00 +0000382 Int ires;
383 void* vres;
384 Addr client_size, shadow_size;
nethercote71980f02004-01-24 18:18:54 +0000385
nethercote7f390022004-10-25 17:18:24 +0000386 // VG_(valgrind_base) should have been set by scan_auxv, but if not,
387 // this is a workable approximation
388 if (VG_(valgrind_base) == 0) {
nethercote7f390022004-10-25 17:18:24 +0000389 VG_(valgrind_base) = PGROUNDDN(&_start);
390 }
391
nethercote820bd8c2004-09-07 23:04:49 +0000392 VG_(valgrind_last) = ROUNDUP(argc_addr, 0x10000) - 1; // stack
nethercote71980f02004-01-24 18:18:54 +0000393
nethercote31779c72004-07-30 21:50:15 +0000394 // This gives the client the largest possible address space while
395 // taking into account the tool's shadow needs.
396 client_size = ROUNDDN((VG_(valgrind_base)-REDZONE_SIZE) / (1.+ratio),
nethercote71980f02004-01-24 18:18:54 +0000397 CLIENT_SIZE_MULTIPLE);
nethercote31779c72004-07-30 21:50:15 +0000398 VG_(client_base) = CLIENT_BASE;
nethercote71980f02004-01-24 18:18:54 +0000399 VG_(client_end) = VG_(client_base) + client_size;
nethercotee2097312004-06-27 12:29:56 +0000400 /* where !FIXED mmap goes */
nethercotebc7b4f42004-07-26 12:44:35 +0000401 VG_(client_mapbase) = VG_(client_base) +
nethercotea3c3cf22004-11-01 18:38:00 +0000402 PGROUNDDN((Addr)(client_size * CLIENT_HEAP_PROPORTION));
nethercote71980f02004-01-24 18:18:54 +0000403
nethercote31779c72004-07-30 21:50:15 +0000404 VG_(shadow_base) = VG_(client_end) + REDZONE_SIZE;
nethercote410bfe62004-09-04 15:53:35 +0000405 VG_(shadow_end) = VG_(valgrind_base);
406 shadow_size = VG_(shadow_end) - VG_(shadow_base);
nethercote71980f02004-01-24 18:18:54 +0000407
nethercotee2097312004-06-27 12:29:56 +0000408#define SEGSIZE(a,b) ((VG_(b) - VG_(a))/(1024*1024))
409
nethercote71980f02004-01-24 18:18:54 +0000410 if (0)
nethercotee2097312004-06-27 12:29:56 +0000411 VG_(printf)(
412 "client_base %8x (%dMB)\n"
413 "client_mapbase %8x (%dMB)\n"
414 "client_end %8x (%dMB)\n"
415 "shadow_base %8x (%dMB)\n"
nethercote410bfe62004-09-04 15:53:35 +0000416 "shadow_end %8x\n"
nethercotee2097312004-06-27 12:29:56 +0000417 "valgrind_base %8x (%dMB)\n"
nethercote820bd8c2004-09-07 23:04:49 +0000418 "valgrind_last %8x\n",
nethercotee2097312004-06-27 12:29:56 +0000419 VG_(client_base), SEGSIZE(client_base, client_mapbase),
420 VG_(client_mapbase), SEGSIZE(client_mapbase, client_end),
421 VG_(client_end), SEGSIZE(client_end, shadow_base),
422 VG_(shadow_base), SEGSIZE(shadow_base, shadow_end),
nethercote410bfe62004-09-04 15:53:35 +0000423 VG_(shadow_end),
nethercote820bd8c2004-09-07 23:04:49 +0000424 VG_(valgrind_base), SEGSIZE(valgrind_base, valgrind_last),
425 VG_(valgrind_last)
nethercotee2097312004-06-27 12:29:56 +0000426 );
427
428#undef SEGSIZE
nethercote71980f02004-01-24 18:18:54 +0000429
430 // Ban redzone
nethercotee567e702004-07-10 17:49:17 +0000431 vres = mmap((void *)VG_(client_end), REDZONE_SIZE, PROT_NONE,
fitzhardinge72ddff62004-09-08 20:03:51 +0000432 MAP_FIXED|MAP_ANON|MAP_PRIVATE|MAP_NORESERVE, -1, 0);
nethercotee567e702004-07-10 17:49:17 +0000433 vg_assert((void*)-1 != vres);
nethercote71980f02004-01-24 18:18:54 +0000434
435 // Make client hole
nethercotee567e702004-07-10 17:49:17 +0000436 ires = munmap((void*)VG_(client_base), client_size);
437 vg_assert(0 == ires);
nethercote71980f02004-01-24 18:18:54 +0000438
439 // Map shadow memory.
440 // Initially all inaccessible, incrementally initialized as it is used
nethercotee567e702004-07-10 17:49:17 +0000441 if (shadow_size != 0) {
442 vres = mmap((char *)VG_(shadow_base), shadow_size, PROT_NONE,
fitzhardinge72ddff62004-09-08 20:03:51 +0000443 MAP_PRIVATE|MAP_ANON|MAP_FIXED|MAP_NORESERVE, -1, 0);
nethercoted4722622004-08-30 19:36:42 +0000444 if ((void*)-1 == vres) {
445 fprintf(stderr,
nethercote8c1ce432004-10-08 14:01:14 +0000446 "valgrind: Could not allocate address space (%p bytes)\n"
447 "valgrind: for shadow memory\n"
448 "valgrind: Possible causes:\n"
449 "valgrind: - For some systems (especially under RedHat 8), Valgrind\n"
450 "valgrind: needs at least 1.5GB swap space.\n"
451 "valgrind: - Or, your virtual memory size may be limited (check\n"
452 "valgrind: with 'ulimit -v').\n"
453 "valgrind: - Or, your system may use a kernel that provides only a\n"
454 "valgrind: too-small (eg. 2GB) user address space.\n"
455 , (void*)shadow_size
456 );
nethercoted4722622004-08-30 19:36:42 +0000457 exit(1);
458 }
nethercotee567e702004-07-10 17:49:17 +0000459 }
nethercote71980f02004-01-24 18:18:54 +0000460}
461
462/*====================================================================*/
463/*=== Command line setup ===*/
464/*====================================================================*/
465
466/* Nb: malloc'd memory never freed -- kept throughout like argv, envp */
467static char* get_file_clo(char* dir)
468{
469# define FLEN 512
470 Int fd, n;
471 struct stat s1;
472 char* f_clo = NULL;
473 char filename[FLEN];
474
475 snprintf(filename, FLEN, "%s/.valgrindrc", ( NULL == dir ? "" : dir ) );
476 fd = VG_(open)(filename, 0, VKI_S_IRUSR);
477 if ( fd > 0 ) {
478 if ( 0 == fstat(fd, &s1) ) {
479 f_clo = malloc(s1.st_size+1);
480 vg_assert(f_clo);
481 n = read(fd, f_clo, s1.st_size);
482 if (n == -1) n = 0;
483 f_clo[n] = '\0';
484 }
485 close(fd);
486 }
487 return f_clo;
488# undef FLEN
489}
490
nethercotee2097312004-06-27 12:29:56 +0000491#define ISSPACE(cc) ((cc) == ' ' || (cc) == '\t' || (cc) == '\n')
492
nethercote71980f02004-01-24 18:18:54 +0000493static Int count_args(char* s)
494{
495 Int n = 0;
496 if (s) {
497 char* cp = s;
498 while (True) {
499 // We have alternating sequences: blanks, non-blanks, blanks...
500 // count the non-blanks sequences.
501 while ( ISSPACE(*cp) ) cp++;
502 if ( !*cp ) break;
503 n++;
504 while ( !ISSPACE(*cp) && *cp ) cp++;
505 }
506 }
507 return n;
508}
509
510/* add args out of environment, skipping multiple spaces and -- args */
511static char** copy_args( char* s, char** to )
512{
513 if (s) {
514 char* cp = s;
515 while (True) {
516 // We have alternating sequences: blanks, non-blanks, blanks...
517 // copy the non-blanks sequences, and add terminating '\0'
518 while ( ISSPACE(*cp) ) cp++;
519 if ( !*cp ) break;
520 *to++ = cp;
521 while ( !ISSPACE(*cp) && *cp ) cp++;
522 if ( *cp ) *cp++ = '\0'; // terminate if necessary
523 if (VG_STREQ(to[-1], "--")) to--; // undo any '--' arg
524 }
525 }
526 return to;
527}
528
nethercotee2097312004-06-27 12:29:56 +0000529#undef ISSPACE
530
nethercote71980f02004-01-24 18:18:54 +0000531// Augment command line with arguments from environment and .valgrindrc
532// files.
533static void augment_command_line(Int* vg_argc_inout, char*** vg_argv_inout)
534{
nethercotef6a1d502004-08-09 12:21:57 +0000535 int vg_argc0 = *vg_argc_inout;
536 char** vg_argv0 = *vg_argv_inout;
nethercote71980f02004-01-24 18:18:54 +0000537
538 char* env_clo = getenv(VALGRINDOPTS);
539 char* f1_clo = get_file_clo( getenv("HOME") );
540 char* f2_clo = get_file_clo(".");
541
542 /* copy any extra args from file or environment, if present */
543 if ( (env_clo && *env_clo) || (f1_clo && *f1_clo) || (f2_clo && *f2_clo) ) {
544 /* ' ' separated extra options */
545 char **from;
546 char **to;
thughescaca0022004-09-13 10:20:34 +0000547 int orig_arg_count, env_arg_count, f1_arg_count, f2_arg_count;
548
549 for ( orig_arg_count = 0; vg_argv0[orig_arg_count]; orig_arg_count++ );
550
nethercote71980f02004-01-24 18:18:54 +0000551 env_arg_count = count_args(env_clo);
552 f1_arg_count = count_args(f1_clo);
553 f2_arg_count = count_args(f2_clo);
554
555 if (0)
556 printf("extra-argc=%d %d %d\n",
557 env_arg_count, f1_arg_count, f2_arg_count);
558
559 /* +2: +1 for null-termination, +1 for added '--' */
nethercotef6a1d502004-08-09 12:21:57 +0000560 from = vg_argv0;
thughescaca0022004-09-13 10:20:34 +0000561 vg_argv0 = malloc( (orig_arg_count + env_arg_count + f1_arg_count
nethercote71980f02004-01-24 18:18:54 +0000562 + f2_arg_count + 2) * sizeof(char **));
nethercotef6a1d502004-08-09 12:21:57 +0000563 vg_assert(vg_argv0);
564 to = vg_argv0;
nethercote71980f02004-01-24 18:18:54 +0000565
566 /* copy argv[0] */
567 *to++ = *from++;
568
569 /* Copy extra args from env var and file, in the order: ~/.valgrindrc,
570 * $VALGRIND_OPTS, ./.valgrindrc -- more local options are put later
571 * to override less local ones. */
572 to = copy_args(f1_clo, to);
573 to = copy_args(env_clo, to);
574 to = copy_args(f2_clo, to);
575
576 /* copy original arguments, stopping at command or -- */
577 while (*from) {
578 if (**from != '-')
579 break;
580 if (VG_STREQ(*from, "--")) {
581 from++; /* skip -- */
582 break;
583 }
584 *to++ = *from++;
585 }
586
587 /* add -- */
588 *to++ = "--";
589
nethercotef6a1d502004-08-09 12:21:57 +0000590 vg_argc0 = to - vg_argv0;
nethercote71980f02004-01-24 18:18:54 +0000591
592 /* copy rest of original command line, then NULL */
593 while (*from) *to++ = *from++;
594 *to = NULL;
595 }
596
nethercotef6a1d502004-08-09 12:21:57 +0000597 *vg_argc_inout = vg_argc0;
598 *vg_argv_inout = vg_argv0;
nethercote71980f02004-01-24 18:18:54 +0000599}
600
nethercotef6a1d502004-08-09 12:21:57 +0000601#define VG_CLO_SEP '\01'
602
nethercote71980f02004-01-24 18:18:54 +0000603static void get_command_line( int argc, char** argv,
604 Int* vg_argc_out, Char*** vg_argv_out,
605 char*** cl_argv_out )
606{
nethercotef6a1d502004-08-09 12:21:57 +0000607 int vg_argc0;
608 char** vg_argv0;
nethercote71980f02004-01-24 18:18:54 +0000609 char** cl_argv;
610 char* env_clo = getenv(VALGRINDCLO);
611
612 if (env_clo != NULL && *env_clo != '\0') {
613 char *cp;
614 char **cpp;
615
nethercotef6a1d502004-08-09 12:21:57 +0000616 /* OK, VALGRINDCLO is set, which means we must be a child of another
617 Valgrind process using --trace-children, so we're getting all our
618 arguments from VALGRINDCLO, and the entire command line belongs to
619 the client (including argv[0]) */
620 vg_argc0 = 1; /* argv[0] */
nethercote71980f02004-01-24 18:18:54 +0000621 for (cp = env_clo; *cp; cp++)
nethercotef6a1d502004-08-09 12:21:57 +0000622 if (*cp == VG_CLO_SEP)
623 vg_argc0++;
nethercote71980f02004-01-24 18:18:54 +0000624
nethercotef6a1d502004-08-09 12:21:57 +0000625 vg_argv0 = malloc(sizeof(char **) * (vg_argc0 + 1));
626 vg_assert(vg_argv0);
nethercote71980f02004-01-24 18:18:54 +0000627
nethercotef6a1d502004-08-09 12:21:57 +0000628 cpp = vg_argv0;
nethercote71980f02004-01-24 18:18:54 +0000629
630 *cpp++ = "valgrind"; /* nominal argv[0] */
631 *cpp++ = env_clo;
632
nethercotef6a1d502004-08-09 12:21:57 +0000633 // Replace the VG_CLO_SEP args separator with '\0'
nethercote71980f02004-01-24 18:18:54 +0000634 for (cp = env_clo; *cp; cp++) {
nethercotef6a1d502004-08-09 12:21:57 +0000635 if (*cp == VG_CLO_SEP) {
nethercote71980f02004-01-24 18:18:54 +0000636 *cp++ = '\0'; /* chop it up in place */
637 *cpp++ = cp;
638 }
639 }
640 *cpp = NULL;
641 cl_argv = argv;
642
643 } else {
644 /* Count the arguments on the command line. */
nethercotef6a1d502004-08-09 12:21:57 +0000645 vg_argv0 = argv;
nethercote71980f02004-01-24 18:18:54 +0000646
nethercotef6a1d502004-08-09 12:21:57 +0000647 for (vg_argc0 = 1; vg_argc0 < argc; vg_argc0++) {
648 if (argv[vg_argc0][0] != '-') /* exe name */
nethercote71980f02004-01-24 18:18:54 +0000649 break;
nethercotef6a1d502004-08-09 12:21:57 +0000650 if (VG_STREQ(argv[vg_argc0], "--")) { /* dummy arg */
651 vg_argc0++;
nethercote71980f02004-01-24 18:18:54 +0000652 break;
653 }
654 }
nethercotef6a1d502004-08-09 12:21:57 +0000655 cl_argv = &argv[vg_argc0];
nethercote71980f02004-01-24 18:18:54 +0000656
657 /* Get extra args from VALGRIND_OPTS and .valgrindrc files.
nethercotef6a1d502004-08-09 12:21:57 +0000658 Note we don't do this if getting args from VALGRINDCLO, as
659 those extra args will already be present in VALGRINDCLO. */
660 augment_command_line(&vg_argc0, &vg_argv0);
nethercote71980f02004-01-24 18:18:54 +0000661 }
662
663 if (0) {
664 Int i;
nethercotef6a1d502004-08-09 12:21:57 +0000665 for (i = 0; i < vg_argc0; i++)
666 printf("vg_argv0[%d]=\"%s\"\n", i, vg_argv0[i]);
nethercote71980f02004-01-24 18:18:54 +0000667 }
668
nethercotef6a1d502004-08-09 12:21:57 +0000669 *vg_argc_out = vg_argc0;
670 *vg_argv_out = (Char**)vg_argv0;
nethercote71980f02004-01-24 18:18:54 +0000671 *cl_argv_out = cl_argv;
672}
673
674
675/*====================================================================*/
676/*=== Environment and stack setup ===*/
677/*====================================================================*/
678
679/* Scan a colon-separated list, and call a function on each element.
680 The string must be mutable, because we insert a temporary '\0', but
thughes4ad52d02004-06-27 17:37:21 +0000681 the string will end up unmodified. (*func) should return True if it
nethercote71980f02004-01-24 18:18:54 +0000682 doesn't need to see any more.
thughes4ad52d02004-06-27 17:37:21 +0000683
684 This routine will return True if (*func) returns True and False if
685 it reaches the end of the list without that happening.
nethercote71980f02004-01-24 18:18:54 +0000686*/
thughes4ad52d02004-06-27 17:37:21 +0000687static Bool scan_colsep(char *colsep, Bool (*func)(const char *))
nethercote71980f02004-01-24 18:18:54 +0000688{
689 char *cp, *entry;
690 int end;
691
692 if (colsep == NULL ||
693 *colsep == '\0')
thughes4ad52d02004-06-27 17:37:21 +0000694 return False;
nethercote71980f02004-01-24 18:18:54 +0000695
696 entry = cp = colsep;
697
698 do {
699 end = (*cp == '\0');
700
701 if (*cp == ':' || *cp == '\0') {
702 char save = *cp;
703
704 *cp = '\0';
thughes21942d92004-07-12 09:35:37 +0000705 if ((*func)(entry)) {
706 *cp = save;
thughes4ad52d02004-06-27 17:37:21 +0000707 return True;
thughes21942d92004-07-12 09:35:37 +0000708 }
nethercote71980f02004-01-24 18:18:54 +0000709 *cp = save;
710 entry = cp+1;
711 }
712 cp++;
713 } while(!end);
thughes4ad52d02004-06-27 17:37:21 +0000714
715 return False;
716}
717
718static Bool contains(const char *p) {
719 if (VG_STREQ(p, VG_(libdir))) {
720 return True;
721 }
722 return False;
nethercote71980f02004-01-24 18:18:54 +0000723}
724
725/* Prepare the client's environment. This is basically a copy of our
726 environment, except:
727 1. LD_LIBRARY_PATH=$VALGRINDLIB:$LD_LIBRARY_PATH
728 2. LD_PRELOAD=$VALGRINDLIB/vg_inject.so:($VALGRINDLIB/vgpreload_TOOL.so:)?$LD_PRELOAD
729
730 If any of these is missing, then it is added.
731
732 Yummy. String hacking in C.
733
734 If this needs to handle any more variables it should be hacked
735 into something table driven.
736 */
737static char **fix_environment(char **origenv, const char *preload)
738{
739 static const char inject_so[] = "vg_inject.so";
740 static const char ld_library_path[] = "LD_LIBRARY_PATH=";
741 static const char ld_preload[] = "LD_PRELOAD=";
742 static const char valgrind_clo[] = VALGRINDCLO "=";
743 static const int ld_library_path_len = sizeof(ld_library_path)-1;
744 static const int ld_preload_len = sizeof(ld_preload)-1;
745 static const int valgrind_clo_len = sizeof(valgrind_clo)-1;
746 int ld_preload_done = 0;
747 int ld_library_path_done = 0;
748 char *inject_path;
749 int inject_path_len;
750 int vgliblen = strlen(VG_(libdir));
751 char **cpp;
752 char **ret;
753 int envc;
754 const int preloadlen = (preload == NULL) ? 0 : strlen(preload);
755
756 /* Find the vg_inject.so; also make room for the tool preload
757 library */
758 inject_path_len = sizeof(inject_so) + vgliblen + preloadlen + 16;
759 inject_path = malloc(inject_path_len);
nethercote7c018f42004-07-17 16:40:50 +0000760 vg_assert(inject_path);
nethercote71980f02004-01-24 18:18:54 +0000761
762 if (preload)
763 snprintf(inject_path, inject_path_len, "%s/%s:%s",
764 VG_(libdir), inject_so, preload);
765 else
766 snprintf(inject_path, inject_path_len, "%s/%s",
767 VG_(libdir), inject_so);
768
769 /* Count the original size of the env */
770 envc = 0; /* trailing NULL */
771 for (cpp = origenv; cpp && *cpp; cpp++)
772 envc++;
773
774 /* Allocate a new space */
775 ret = malloc(sizeof(char *) * (envc+3+1)); /* 3 new entries + NULL */
nethercote7c018f42004-07-17 16:40:50 +0000776 vg_assert(ret);
nethercote71980f02004-01-24 18:18:54 +0000777
778 /* copy it over */
779 for (cpp = ret; *origenv; )
780 *cpp++ = *origenv++;
781 *cpp = NULL;
782
783 vg_assert(envc == (cpp - ret));
784
785 /* Walk over the new environment, mashing as we go */
786 for (cpp = ret; cpp && *cpp; cpp++) {
787 if (memcmp(*cpp, ld_library_path, ld_library_path_len) == 0) {
nethercote71980f02004-01-24 18:18:54 +0000788 /* If the LD_LIBRARY_PATH already contains libdir, then don't
789 bother adding it again, even if it isn't the first (it
790 seems that the Java runtime will keep reexecing itself
791 unless its paths are at the front of LD_LIBRARY_PATH) */
thughes4ad52d02004-06-27 17:37:21 +0000792 if (!scan_colsep(*cpp + ld_library_path_len, contains)) {
nethercote71980f02004-01-24 18:18:54 +0000793 int len = strlen(*cpp) + vgliblen*2 + 16;
794 char *cp = malloc(len);
nethercote7c018f42004-07-17 16:40:50 +0000795 vg_assert(cp);
nethercote71980f02004-01-24 18:18:54 +0000796
797 snprintf(cp, len, "%s%s:%s",
798 ld_library_path, VG_(libdir),
799 (*cpp)+ld_library_path_len);
800
801 *cpp = cp;
802 }
803
804 ld_library_path_done = 1;
805 } else if (memcmp(*cpp, ld_preload, ld_preload_len) == 0) {
806 int len = strlen(*cpp) + inject_path_len;
807 char *cp = malloc(len);
nethercote7c018f42004-07-17 16:40:50 +0000808 vg_assert(cp);
nethercote71980f02004-01-24 18:18:54 +0000809
810 snprintf(cp, len, "%s%s:%s",
811 ld_preload, inject_path, (*cpp)+ld_preload_len);
812
813 *cpp = cp;
814
815 ld_preload_done = 1;
816 } else if (memcmp(*cpp, valgrind_clo, valgrind_clo_len) == 0) {
817 *cpp = "";
818 }
819 }
820
821 /* Add the missing bits */
822
823 if (!ld_library_path_done) {
824 int len = ld_library_path_len + vgliblen*2 + 16;
825 char *cp = malloc(len);
nethercote7c018f42004-07-17 16:40:50 +0000826 vg_assert(cp);
nethercote71980f02004-01-24 18:18:54 +0000827
828 snprintf(cp, len, "%s%s", ld_library_path, VG_(libdir));
829
830 ret[envc++] = cp;
831 }
832
833 if (!ld_preload_done) {
834 int len = ld_preload_len + inject_path_len;
835 char *cp = malloc(len);
nethercote7c018f42004-07-17 16:40:50 +0000836 vg_assert(cp);
nethercote71980f02004-01-24 18:18:54 +0000837
838 snprintf(cp, len, "%s%s",
839 ld_preload, inject_path);
840
841 ret[envc++] = cp;
842 }
843
844 ret[envc] = NULL;
845
846 return ret;
847}
848
849extern char **environ; /* our environment */
850//#include <error.h>
851
852/* Add a string onto the string table, and return its address */
853static char *copy_str(char **tab, const char *str)
854{
855 char *cp = *tab;
856 char *orig = cp;
857
858 while(*str)
859 *cp++ = *str++;
860 *cp++ = '\0';
861
862 if (0)
nethercote545fe672004-11-01 16:52:43 +0000863 printf("copied %p \"%s\" len %lld\n", orig, orig, (Long)(cp-orig));
nethercote71980f02004-01-24 18:18:54 +0000864
865 *tab = cp;
866
867 return orig;
868}
869
870/*
871 This sets up the client's initial stack, containing the args,
872 environment and aux vector.
873
874 The format of the stack is:
875
876 higher address +-----------------+
877 | Trampoline code |
878 +-----------------+
879 | |
880 : string table :
881 | |
882 +-----------------+
883 | AT_NULL |
884 - -
885 | auxv |
886 +-----------------+
887 | NULL |
888 - -
889 | envp |
890 +-----------------+
891 | NULL |
892 - -
893 | argv |
894 +-----------------+
895 | argc |
nethercote4ad74312004-10-26 09:59:49 +0000896 lower address +-----------------+ <- sp
nethercote71980f02004-01-24 18:18:54 +0000897 | undefined |
898 : :
899 */
nethercotec25c4492004-10-18 11:52:17 +0000900static Addr setup_client_stack(void* init_sp,
901 char **orig_argv, char **orig_envp,
nethercote71980f02004-01-24 18:18:54 +0000902 const struct exeinfo *info,
903 UInt** client_auxv)
904{
nethercotee567e702004-07-10 17:49:17 +0000905 void* res;
nethercote71980f02004-01-24 18:18:54 +0000906 char **cpp;
907 char *strtab; /* string table */
908 char *stringbase;
nethercotea3c3cf22004-11-01 18:38:00 +0000909 Addr *ptr;
nethercote71980f02004-01-24 18:18:54 +0000910 struct ume_auxv *auxv;
911 const struct ume_auxv *orig_auxv;
912 const struct ume_auxv *cauxv;
913 unsigned stringsize; /* total size of strings in bytes */
914 unsigned auxsize; /* total size of auxv in bytes */
915 int argc; /* total argc */
916 int envc; /* total number of env vars */
917 unsigned stacksize; /* total client stack size */
nethercotea3c3cf22004-11-01 18:38:00 +0000918 Addr cl_esp; /* client stack base (initial esp) */
nethercote71980f02004-01-24 18:18:54 +0000919
920 /* use our own auxv as a prototype */
nethercotec25c4492004-10-18 11:52:17 +0000921 orig_auxv = find_auxv(init_sp);
nethercote71980f02004-01-24 18:18:54 +0000922
923 /* ==================== compute sizes ==================== */
924
925 /* first of all, work out how big the client stack will be */
926 stringsize = 0;
927
928 /* paste on the extra args if the loader needs them (ie, the #!
929 interpreter and its argument) */
930 argc = 0;
nethercoted6a56872004-07-26 15:32:47 +0000931 if (info->interp_name != NULL) {
nethercote71980f02004-01-24 18:18:54 +0000932 argc++;
nethercoted6a56872004-07-26 15:32:47 +0000933 stringsize += strlen(info->interp_name) + 1;
nethercote71980f02004-01-24 18:18:54 +0000934 }
nethercoted6a56872004-07-26 15:32:47 +0000935 if (info->interp_args != NULL) {
nethercote71980f02004-01-24 18:18:54 +0000936 argc++;
nethercoted6a56872004-07-26 15:32:47 +0000937 stringsize += strlen(info->interp_args) + 1;
nethercote71980f02004-01-24 18:18:54 +0000938 }
939
940 /* now scan the args we're given... */
941 for (cpp = orig_argv; *cpp; cpp++) {
942 argc++;
943 stringsize += strlen(*cpp) + 1;
944 }
945
946 /* ...and the environment */
947 envc = 0;
948 for (cpp = orig_envp; cpp && *cpp; cpp++) {
949 envc++;
950 stringsize += strlen(*cpp) + 1;
951 }
952
953 /* now, how big is the auxv? */
954 auxsize = sizeof(*auxv); /* there's always at least one entry: AT_NULL */
955 for (cauxv = orig_auxv; cauxv->a_type != AT_NULL; cauxv++) {
956 if (cauxv->a_type == AT_PLATFORM)
957 stringsize += strlen(cauxv->u.a_ptr) + 1;
958 auxsize += sizeof(*cauxv);
959 }
960
961 /* OK, now we know how big the client stack is */
962 stacksize =
963 sizeof(int) + /* argc */
964 sizeof(char **)*argc + /* argv */
965 sizeof(char **) + /* terminal NULL */
966 sizeof(char **)*envc + /* envp */
967 sizeof(char **) + /* terminal NULL */
968 auxsize + /* auxv */
969 ROUNDUP(stringsize, sizeof(int)) +/* strings (aligned) */
nethercote5fd72bb2004-11-04 19:28:38 +0000970 VKI_PAGE_SIZE; /* page for trampoline code */
nethercote71980f02004-01-24 18:18:54 +0000971
nethercotef84f6952004-07-15 14:58:33 +0000972 // decide where stack goes!
973 VG_(clstk_end) = VG_(client_end);
974
nethercote73b526f2004-10-31 18:48:21 +0000975 VG_(client_trampoline_code) = VG_(clstk_end) - VKI_PAGE_SIZE;
nethercotef84f6952004-07-15 14:58:33 +0000976
nethercote71980f02004-01-24 18:18:54 +0000977 /* cl_esp is the client's stack pointer */
nethercotef84f6952004-07-15 14:58:33 +0000978 cl_esp = VG_(clstk_end) - stacksize;
nethercote71980f02004-01-24 18:18:54 +0000979 cl_esp = ROUNDDN(cl_esp, 16); /* make stack 16 byte aligned */
980
nethercote71980f02004-01-24 18:18:54 +0000981 /* base of the string table (aligned) */
982 stringbase = strtab = (char *)(VG_(client_trampoline_code) - ROUNDUP(stringsize, sizeof(int)));
983
984 VG_(clstk_base) = PGROUNDDN(cl_esp);
nethercote71980f02004-01-24 18:18:54 +0000985
nethercote5ee67ca2004-06-22 14:00:09 +0000986 if (0)
987 printf("stringsize=%d auxsize=%d stacksize=%d\n"
nethercote6a27d832004-09-07 10:17:02 +0000988 "clstk_base %p\n"
989 "clstk_end %p\n",
990 stringsize, auxsize, stacksize,
991 (void*)VG_(clstk_base), (void*)VG_(clstk_end));
nethercote5ee67ca2004-06-22 14:00:09 +0000992
993
nethercote71980f02004-01-24 18:18:54 +0000994 /* ==================== allocate space ==================== */
995
996 /* allocate a stack - mmap enough space for the stack */
nethercotef84f6952004-07-15 14:58:33 +0000997 res = mmap((void *)PGROUNDDN(cl_esp), VG_(clstk_end) - PGROUNDDN(cl_esp),
nethercotee567e702004-07-10 17:49:17 +0000998 PROT_READ | PROT_WRITE | PROT_EXEC,
999 MAP_PRIVATE | MAP_ANON | MAP_FIXED, -1, 0);
1000 vg_assert((void*)-1 != res);
nethercote71980f02004-01-24 18:18:54 +00001001
1002 /* ==================== copy client stack ==================== */
1003
nethercotea3c3cf22004-11-01 18:38:00 +00001004 ptr = (Addr*)cl_esp;
nethercote71980f02004-01-24 18:18:54 +00001005
1006 /* --- argc --- */
1007 *ptr++ = argc; /* client argc */
1008
1009 /* --- argv --- */
nethercoted6a56872004-07-26 15:32:47 +00001010 if (info->interp_name) {
nethercotea3c3cf22004-11-01 18:38:00 +00001011 *ptr++ = (Addr)copy_str(&strtab, info->interp_name);
nethercoted6a56872004-07-26 15:32:47 +00001012 free(info->interp_name);
nethercote71980f02004-01-24 18:18:54 +00001013 }
nethercoted6a56872004-07-26 15:32:47 +00001014 if (info->interp_args) {
nethercotea3c3cf22004-11-01 18:38:00 +00001015 *ptr++ = (Addr)copy_str(&strtab, info->interp_args);
nethercoted6a56872004-07-26 15:32:47 +00001016 free(info->interp_args);
nethercote71980f02004-01-24 18:18:54 +00001017 }
1018 for (cpp = orig_argv; *cpp; ptr++, cpp++) {
nethercotea3c3cf22004-11-01 18:38:00 +00001019 *ptr = (Addr)copy_str(&strtab, *cpp);
nethercote71980f02004-01-24 18:18:54 +00001020 }
1021 *ptr++ = 0;
1022
1023 /* --- envp --- */
1024 VG_(client_envp) = (Char **)ptr;
1025 for (cpp = orig_envp; cpp && *cpp; ptr++, cpp++)
nethercotea3c3cf22004-11-01 18:38:00 +00001026 *ptr = (Addr)copy_str(&strtab, *cpp);
nethercote71980f02004-01-24 18:18:54 +00001027 *ptr++ = 0;
1028
1029 /* --- auxv --- */
1030 auxv = (struct ume_auxv *)ptr;
1031 *client_auxv = (UInt *)auxv;
1032
1033 for (; orig_auxv->a_type != AT_NULL; auxv++, orig_auxv++) {
1034 /* copy the entry... */
1035 *auxv = *orig_auxv;
1036
1037 /* ...and fix up the copy */
1038 switch(auxv->a_type) {
1039 case AT_PHDR:
1040 if (info->phdr == 0)
1041 auxv->a_type = AT_IGNORE;
1042 else
1043 auxv->u.a_val = info->phdr;
1044 break;
1045
1046 case AT_PHNUM:
1047 if (info->phdr == 0)
1048 auxv->a_type = AT_IGNORE;
1049 else
1050 auxv->u.a_val = info->phnum;
1051 break;
1052
1053 case AT_BASE:
1054 if (info->interp_base == 0)
1055 auxv->a_type = AT_IGNORE;
1056 else
1057 auxv->u.a_val = info->interp_base;
1058 break;
1059
1060 case AT_PLATFORM: /* points to a platform description string */
1061 auxv->u.a_ptr = copy_str(&strtab, orig_auxv->u.a_ptr);
1062 break;
1063
1064 case AT_ENTRY:
1065 auxv->u.a_val = info->entry;
1066 break;
1067
1068 case AT_IGNORE:
1069 case AT_EXECFD:
1070 case AT_PHENT:
1071 case AT_PAGESZ:
1072 case AT_FLAGS:
1073 case AT_NOTELF:
1074 case AT_UID:
1075 case AT_EUID:
1076 case AT_GID:
1077 case AT_EGID:
1078 case AT_CLKTCK:
1079 case AT_HWCAP:
1080 case AT_FPUCW:
1081 case AT_DCACHEBSIZE:
1082 case AT_ICACHEBSIZE:
1083 case AT_UCACHEBSIZE:
1084 /* All these are pointerless, so we don't need to do anything
1085 about them. */
1086 break;
1087
1088 case AT_SECURE:
1089 /* If this is 1, then it means that this program is running
1090 suid, and therefore the dynamic linker should be careful
1091 about LD_PRELOAD, etc. However, since stage1 (the thing
1092 the kernel actually execve's) should never be SUID, and we
1093 need LD_PRELOAD/LD_LIBRARY_PATH to work for the client, we
1094 set AT_SECURE to 0. */
1095 auxv->u.a_val = 0;
1096 break;
1097
1098 case AT_SYSINFO:
1099 /* Leave this unmolested for now, but we'll update it later
1100 when we set up the client trampoline code page */
1101 break;
1102
1103 case AT_SYSINFO_EHDR:
1104 /* Trash this, because we don't reproduce it */
1105 auxv->a_type = AT_IGNORE;
1106 break;
1107
1108 default:
1109 /* stomp out anything we don't know about */
1110 if (0)
nethercote545fe672004-11-01 16:52:43 +00001111 printf("stomping auxv entry %lld\n", (ULong)auxv->a_type);
nethercote71980f02004-01-24 18:18:54 +00001112 auxv->a_type = AT_IGNORE;
1113 break;
1114
1115 }
1116 }
1117 *auxv = *orig_auxv;
1118 vg_assert(auxv->a_type == AT_NULL);
1119
njnc6168192004-11-29 13:54:10 +00001120// XXX: what architectures is this necessary for? x86 yes, PPC no, others ?
1121// Perhaps a per-arch VGA_NEEDS_TRAMPOLINE constant is necessary?
njnca0518d2004-11-26 19:34:36 +00001122#ifdef __x86__
nethercotef84f6952004-07-15 14:58:33 +00001123 /* --- trampoline page --- */
1124 VG_(memcpy)( (void *)VG_(client_trampoline_code),
1125 &VG_(trampoline_code_start), VG_(trampoline_code_length) );
njnca0518d2004-11-26 19:34:36 +00001126#endif
nethercotef84f6952004-07-15 14:58:33 +00001127
nethercote71980f02004-01-24 18:18:54 +00001128 vg_assert((strtab-stringbase) == stringsize);
1129
nethercote5ee67ca2004-06-22 14:00:09 +00001130 /* We know the initial ESP is pointing at argc/argv */
1131 VG_(client_argc) = *(Int*)cl_esp;
sewardj45f02c42005-02-05 18:27:14 +00001132 VG_(client_argv) = (Char**)(cl_esp + sizeof(HWord));
nethercote5ee67ca2004-06-22 14:00:09 +00001133
nethercote71980f02004-01-24 18:18:54 +00001134 return cl_esp;
1135}
1136
1137/*====================================================================*/
1138/*=== Find executable ===*/
1139/*====================================================================*/
1140
thughes4ad52d02004-06-27 17:37:21 +00001141static const char* executable_name;
1142
1143static Bool match_executable(const char *entry) {
1144 char buf[strlen(entry) + strlen(executable_name) + 2];
1145
1146 /* empty PATH element means . */
1147 if (*entry == '\0')
1148 entry = ".";
1149
1150 snprintf(buf, sizeof(buf), "%s/%s", entry, executable_name);
1151
1152 if (access(buf, R_OK|X_OK) == 0) {
1153 executable_name = strdup(buf);
1154 vg_assert(NULL != executable_name);
1155 return True;
1156 }
1157 return False;
1158}
1159
nethercote71980f02004-01-24 18:18:54 +00001160static const char* find_executable(const char* exec)
1161{
1162 vg_assert(NULL != exec);
thughes4ad52d02004-06-27 17:37:21 +00001163 executable_name = exec;
1164 if (strchr(executable_name, '/') == NULL) {
nethercote71980f02004-01-24 18:18:54 +00001165 /* no '/' - we need to search the path */
1166 char *path = getenv("PATH");
thughes4ad52d02004-06-27 17:37:21 +00001167 scan_colsep(path, match_executable);
nethercote71980f02004-01-24 18:18:54 +00001168 }
thughes4ad52d02004-06-27 17:37:21 +00001169 return executable_name;
nethercote71980f02004-01-24 18:18:54 +00001170}
1171
1172
1173/*====================================================================*/
1174/*=== Loading tools ===*/
1175/*====================================================================*/
1176
1177static void list_tools(void)
1178{
1179 DIR *dir = opendir(VG_(libdir));
1180 struct dirent *de;
1181 int first = 1;
1182
1183 if (dir == NULL) {
1184 fprintf(stderr, "Can't open %s: %s (installation problem?)\n",
nethercotef4928da2004-06-15 10:54:40 +00001185 VG_(libdir), strerror(errno));
nethercote71980f02004-01-24 18:18:54 +00001186 return;
1187 }
1188
nethercotef4928da2004-06-15 10:54:40 +00001189 while ((de = readdir(dir)) != NULL) {
nethercote71980f02004-01-24 18:18:54 +00001190 int len = strlen(de->d_name);
1191
njn063c5402004-11-22 16:58:05 +00001192 /* look for vgtool_TOOL.so names */
1193 if (len > (7+1+3) && /* "vgtool_" + at least 1-char toolname + ".so" */
1194 strncmp(de->d_name, "vgtool_", 7) == 0 &&
nethercotef4928da2004-06-15 10:54:40 +00001195 VG_STREQ(de->d_name + len - 3, ".so")) {
1196 if (first) {
1197 fprintf(stderr, "Available tools:\n");
1198 first = 0;
1199 }
1200 de->d_name[len-3] = '\0';
1201 fprintf(stderr, "\t%s\n", de->d_name+7);
nethercote71980f02004-01-24 18:18:54 +00001202 }
1203 }
1204
1205 closedir(dir);
1206
1207 if (first)
nethercotef4928da2004-06-15 10:54:40 +00001208 fprintf(stderr, "No tools available in \"%s\" (installation problem?)\n",
1209 VG_(libdir));
nethercote71980f02004-01-24 18:18:54 +00001210}
1211
1212
1213/* Find and load a tool, and check it looks ok. Also looks to see if there's
1214 * a matching vgpreload_*.so file, and returns its name in *preloadpath. */
1215static void load_tool( const char *toolname, void** handle_out,
1216 ToolInfo** toolinfo_out, char **preloadpath_out )
1217{
1218 Bool ok;
1219 int len = strlen(VG_(libdir)) + strlen(toolname)*2 + 16;
1220 char buf[len];
1221 void* handle;
1222 ToolInfo* toolinfo;
1223 char* preloadpath = NULL;
1224 Int* vg_malloc_redzonep;
1225
1226 // XXX: allowing full paths for --tool option -- does it make sense?
1227 // Doesn't allow for vgpreload_<tool>.so.
1228
1229 if (strchr(toolname, '/') != 0) {
1230 /* toolname contains '/', and so must be a pathname */
1231 handle = dlopen(toolname, RTLD_NOW);
1232 } else {
1233 /* just try in the libdir */
njn063c5402004-11-22 16:58:05 +00001234 snprintf(buf, len, "%s/vgtool_%s.so", VG_(libdir), toolname);
nethercote71980f02004-01-24 18:18:54 +00001235 handle = dlopen(buf, RTLD_NOW);
1236
1237 if (handle != NULL) {
1238 snprintf(buf, len, "%s/vgpreload_%s.so", VG_(libdir), toolname);
1239 if (access(buf, R_OK) == 0) {
1240 preloadpath = strdup(buf);
1241 vg_assert(NULL != preloadpath);
1242 }
1243 }
1244 }
1245
1246 ok = (NULL != handle);
1247 if (!ok) {
1248 fprintf(stderr, "Can't open tool \"%s\": %s\n", toolname, dlerror());
1249 goto bad_load;
1250 }
1251
njn26f02512004-11-22 18:33:15 +00001252 toolinfo = dlsym(handle, "vgTool_tool_info");
nethercote71980f02004-01-24 18:18:54 +00001253 ok = (NULL != toolinfo);
1254 if (!ok) {
njn26f02512004-11-22 18:33:15 +00001255 fprintf(stderr, "Tool \"%s\" doesn't define TL_(tool_info) - "
nethercote71980f02004-01-24 18:18:54 +00001256 "add VG_DETERMINE_INTERFACE_VERSION?\n", toolname);
1257 goto bad_load;
1258 }
1259
1260 ok = (toolinfo->sizeof_ToolInfo == sizeof(*toolinfo) &&
1261 toolinfo->interface_major_version == VG_CORE_INTERFACE_MAJOR_VERSION &&
njnd2252832004-11-26 10:53:33 +00001262 toolinfo->tl_pre_clo_init != NULL);
nethercote71980f02004-01-24 18:18:54 +00001263 if (!ok) {
1264 fprintf(stderr, "Error:\n"
1265 " Tool and core interface versions do not match.\n"
1266 " Interface version used by core is: %d.%d (size %d)\n"
1267 " Interface version used by tool is: %d.%d (size %d)\n"
1268 " The major version numbers must match.\n",
1269 VG_CORE_INTERFACE_MAJOR_VERSION,
1270 VG_CORE_INTERFACE_MINOR_VERSION,
nethercote545fe672004-11-01 16:52:43 +00001271 (Int)sizeof(*toolinfo),
nethercote71980f02004-01-24 18:18:54 +00001272 toolinfo->interface_major_version,
1273 toolinfo->interface_minor_version,
1274 toolinfo->sizeof_ToolInfo);
1275 fprintf(stderr, " You need to at least recompile, and possibly update,\n");
1276 if (VG_CORE_INTERFACE_MAJOR_VERSION > toolinfo->interface_major_version)
nethercote996901a2004-08-03 13:29:09 +00001277 fprintf(stderr, " your tool to work with this version of Valgrind.\n");
nethercote71980f02004-01-24 18:18:54 +00001278 else
nethercote996901a2004-08-03 13:29:09 +00001279 fprintf(stderr, " your version of Valgrind to work with this tool.\n");
nethercote71980f02004-01-24 18:18:54 +00001280 goto bad_load;
1281 }
1282
1283 // Set redzone size for V's allocator
1284 vg_malloc_redzonep = dlsym(handle, STR(VG_(vg_malloc_redzone_szB)));
1285 if ( NULL != vg_malloc_redzonep ) {
1286 VG_(vg_malloc_redzone_szB) = *vg_malloc_redzonep;
1287 }
1288
1289 vg_assert(NULL != handle && NULL != toolinfo);
1290 *handle_out = handle;
1291 *toolinfo_out = toolinfo;
1292 *preloadpath_out = preloadpath;
1293 return;
1294
1295
1296 bad_load:
1297 if (handle != NULL)
1298 dlclose(handle);
1299
nethercotef4928da2004-06-15 10:54:40 +00001300 fprintf(stderr, "valgrind: couldn't load tool\n");
nethercote71980f02004-01-24 18:18:54 +00001301 list_tools();
1302 exit(127);
1303}
1304
nethercotef4928da2004-06-15 10:54:40 +00001305
1306/*====================================================================*/
1307/*=== Command line errors ===*/
1308/*====================================================================*/
1309
1310static void abort_msg ( void )
1311{
nethercotef8548672004-06-21 12:42:35 +00001312 VG_(clo_log_to) = VgLogTo_Fd;
1313 VG_(clo_log_fd) = 2; /* stderr */
nethercotef4928da2004-06-15 10:54:40 +00001314}
1315
1316void VG_(bad_option) ( Char* opt )
1317{
1318 abort_msg();
1319 VG_(printf)("valgrind: Bad option `%s'; aborting.\n", opt);
1320 VG_(printf)("valgrind: Use --help for more information.\n");
1321 VG_(exit)(1);
1322}
1323
1324static void missing_tool_option ( void )
1325{
1326 abort_msg();
1327 VG_(printf)("valgrind: Missing --tool option\n");
1328 list_tools();
1329 VG_(printf)("valgrind: Use --help for more information.\n");
1330 VG_(exit)(1);
1331}
1332
1333static void missing_prog ( void )
1334{
1335 abort_msg();
1336 VG_(printf)("valgrind: no program specified\n");
1337 VG_(printf)("valgrind: Use --help for more information.\n");
1338 VG_(exit)(1);
1339}
1340
1341static void config_error ( Char* msg )
1342{
1343 abort_msg();
1344 VG_(printf)("valgrind: Startup or configuration error:\n %s\n", msg);
1345 VG_(printf)("valgrind: Unable to start up properly. Giving up.\n");
1346 VG_(exit)(1);
1347}
1348
1349
nethercote71980f02004-01-24 18:18:54 +00001350/*====================================================================*/
1351/*=== Loading the client ===*/
1352/*====================================================================*/
1353
nethercotef4928da2004-06-15 10:54:40 +00001354static void load_client(char* cl_argv[], const char* exec, Int need_help,
nethercote71980f02004-01-24 18:18:54 +00001355 /*out*/struct exeinfo* info, /*out*/Addr* client_eip)
1356{
1357 // If they didn't specify an executable with --exec, and didn't specify
1358 // --help, then use client argv[0] (searching $PATH if necessary).
nethercotef4928da2004-06-15 10:54:40 +00001359 if (NULL == exec && !need_help) {
nethercote71980f02004-01-24 18:18:54 +00001360 if (cl_argv[0] == NULL ||
1361 ( NULL == (exec = find_executable(cl_argv[0])) ) )
1362 {
nethercotef4928da2004-06-15 10:54:40 +00001363 missing_prog();
nethercote71980f02004-01-24 18:18:54 +00001364 }
1365 }
1366
1367 info->map_base = VG_(client_mapbase);
nethercote71980f02004-01-24 18:18:54 +00001368 info->exe_base = VG_(client_base);
1369 info->exe_end = VG_(client_end);
1370 info->argv = cl_argv;
1371
nethercotef4928da2004-06-15 10:54:40 +00001372 if (need_help) {
nethercote71980f02004-01-24 18:18:54 +00001373 VG_(clexecfd) = -1;
njnc8c93282004-11-29 16:05:54 +00001374 // Totally zero 'info' before continuing.
1375 VG_(memset)(info, 0, sizeof(*info));
nethercote71980f02004-01-24 18:18:54 +00001376 } else {
1377 Int ret;
nethercote4ec0af42004-10-16 15:31:49 +00001378 VG_(clexecfd) = VG_(open)(exec, VKI_O_RDONLY, VKI_S_IRUSR);
nethercote71980f02004-01-24 18:18:54 +00001379 ret = do_exec(exec, info);
1380 if (ret != 0) {
nethercoteea147e72004-07-26 15:43:57 +00001381 fprintf(stderr, "valgrind: do_exec(%s) failed: %s\n",
1382 exec, strerror(ret));
nethercote71980f02004-01-24 18:18:54 +00001383 exit(127);
1384 }
1385 }
1386
1387 /* Copy necessary bits of 'info' that were filled in */
1388 *client_eip = info->init_eip;
1389 VG_(brk_base) = VG_(brk_limit) = info->brkbase;
1390}
1391
nethercote969ecf12004-10-13 17:29:01 +00001392/*====================================================================*/
1393/*=== Address space unpadding ===*/
1394/*====================================================================*/
1395
1396typedef struct {
1397 char* killpad_start;
1398 char* killpad_end;
1399 struct stat* killpad_padstat;
1400} killpad_extra;
1401
1402static int killpad(char *segstart, char *segend, const char *perm, off_t off,
1403 int maj, int min, int ino, void* ex)
1404{
1405 killpad_extra* extra = ex;
1406 void *b, *e;
1407 int res;
1408
1409 vg_assert(NULL != extra->killpad_padstat);
1410
1411 if (extra->killpad_padstat->st_dev != makedev(maj, min) ||
1412 extra->killpad_padstat->st_ino != ino)
1413 return 1;
1414
1415 if (segend <= extra->killpad_start || segstart >= extra->killpad_end)
1416 return 1;
1417
1418 if (segstart <= extra->killpad_start)
1419 b = extra->killpad_start;
1420 else
1421 b = segstart;
1422
1423 if (segend >= extra->killpad_end)
1424 e = extra->killpad_end;
1425 else
1426 e = segend;
1427
1428 res = munmap(b, (char *)e-(char *)b);
1429 vg_assert(0 == res);
1430
1431 return 1;
1432}
1433
1434// Remove padding of 'padfile' from a range of address space.
1435void as_unpad(void *start, void *end, int padfile)
1436{
1437 static struct stat padstat;
1438 killpad_extra extra;
1439 int res;
1440
1441 vg_assert(padfile > 0);
1442
1443 res = fstat(padfile, &padstat);
1444 vg_assert(0 == res);
1445 extra.killpad_padstat = &padstat;
1446 extra.killpad_start = start;
1447 extra.killpad_end = end;
1448 foreach_map(killpad, &extra);
1449}
1450
1451void as_closepadfile(int padfile)
1452{
1453 int res = close(padfile);
1454 vg_assert(0 == res);
1455}
1456
nethercote71980f02004-01-24 18:18:54 +00001457
1458/*====================================================================*/
nethercotef6a1d502004-08-09 12:21:57 +00001459/*=== Command-line: variables, processing, etc ===*/
nethercote71980f02004-01-24 18:18:54 +00001460/*====================================================================*/
sewardjde4a1d02002-03-22 01:27:54 +00001461
njn25e49d8e72002-09-23 09:36:25 +00001462/* Define, and set defaults. */
sewardj8b635a42004-11-22 19:01:47 +00001463VexControl VG_(clo_vex_control);
njn25e49d8e72002-09-23 09:36:25 +00001464Bool VG_(clo_error_limit) = True;
nethercote04d0fbc2004-01-26 16:48:06 +00001465Bool VG_(clo_db_attach) = False;
1466Char* VG_(clo_db_command) = VG_CLO_DEFAULT_DBCOMMAND;
sewardjd153fae2005-01-10 17:24:47 +00001467Int VG_(clo_gen_suppressions) = 0;
nethercote27fec902004-06-16 21:26:32 +00001468Int VG_(clo_sanity_level) = 1;
njn25e49d8e72002-09-23 09:36:25 +00001469Int VG_(clo_verbosity) = 1;
1470Bool VG_(clo_demangle) = True;
njn25e49d8e72002-09-23 09:36:25 +00001471Bool VG_(clo_trace_children) = False;
sewardj4cf05692002-10-27 20:28:29 +00001472
nethercotef1e5e152004-09-01 23:58:16 +00001473/* See big comment in core.h for meaning of these three.
nethercotee1730692003-11-20 10:38:07 +00001474 fd is initially stdout, for --help, but gets moved to stderr by default
1475 immediately afterwards. */
sewardj4cf05692002-10-27 20:28:29 +00001476VgLogTo VG_(clo_log_to) = VgLogTo_Fd;
nethercotef8548672004-06-21 12:42:35 +00001477Int VG_(clo_log_fd) = 1;
1478Char* VG_(clo_log_name) = NULL;
sewardj4cf05692002-10-27 20:28:29 +00001479
thughes6233a382004-08-21 11:10:44 +00001480Bool VG_(clo_time_stamp) = False;
1481
sewardj6024b212003-07-13 10:54:33 +00001482Int VG_(clo_input_fd) = 0; /* stdin */
njn25e49d8e72002-09-23 09:36:25 +00001483Int VG_(clo_n_suppressions) = 0;
sewardjde4a1d02002-03-22 01:27:54 +00001484Char* VG_(clo_suppressions)[VG_CLO_MAX_SFILES];
njn25e49d8e72002-09-23 09:36:25 +00001485Bool VG_(clo_profile) = False;
sewardjfa8ec112005-01-19 11:55:34 +00001486UChar VG_(clo_trace_flags) = 0; // 00000000b
1487UChar VG_(clo_profile_flags) = 0; // 00000000b
sewardjc771b292004-11-30 18:55:21 +00001488Int VG_(clo_trace_notbelow) = 0;
njn25e49d8e72002-09-23 09:36:25 +00001489Bool VG_(clo_trace_syscalls) = False;
1490Bool VG_(clo_trace_signals) = False;
1491Bool VG_(clo_trace_symtab) = False;
njn25e49d8e72002-09-23 09:36:25 +00001492Bool VG_(clo_trace_sched) = False;
1493Int VG_(clo_trace_pthread_level) = 0;
njn25e49d8e72002-09-23 09:36:25 +00001494Int VG_(clo_dump_error) = 0;
1495Int VG_(clo_backtrace_size) = 4;
1496Char* VG_(clo_weird_hacks) = NULL;
sewardj858964b2002-10-05 14:15:43 +00001497Bool VG_(clo_run_libc_freeres) = True;
rjwalshf5f536f2003-11-17 17:45:00 +00001498Bool VG_(clo_track_fds) = False;
nethercote77eba602003-11-13 17:35:04 +00001499Bool VG_(clo_show_below_main) = False;
fitzhardinge98abfc72003-12-16 02:05:15 +00001500Bool VG_(clo_pointercheck) = True;
sewardj062f3552005-01-06 16:13:40 +00001501Bool VG_(clo_support_elan3) = False;
fitzhardinge462f4f92003-12-18 02:10:54 +00001502Bool VG_(clo_branchpred) = False;
sewardj2370f3b2002-11-30 15:01:01 +00001503
jsgf855d93d2003-10-13 22:26:55 +00001504static Bool VG_(clo_wait_for_gdb) = False;
1505
1506/* If we're doing signal routing, poll for signals every 50mS by
1507 default. */
1508Int VG_(clo_signal_polltime) = 50;
1509
1510/* These flags reduce thread wakeup latency on syscall completion and
1511 signal delivery, respectively. The downside is possible unfairness. */
1512Bool VG_(clo_lowlat_syscalls) = False; /* low-latency syscalls */
1513Bool VG_(clo_lowlat_signals) = False; /* low-latency signals */
1514
sewardjde4a1d02002-03-22 01:27:54 +00001515
nethercote6c999f22004-01-31 22:55:15 +00001516void usage ( Bool debug_help )
njn7cf0bd32002-06-08 13:36:03 +00001517{
njn25e49d8e72002-09-23 09:36:25 +00001518 Char* usage1 =
nethercote71980f02004-01-24 18:18:54 +00001519"usage: valgrind --tool=<toolname> [options] prog-and-args\n"
njn25e49d8e72002-09-23 09:36:25 +00001520"\n"
nethercote2b0793f2003-12-02 10:41:18 +00001521" common user options for all Valgrind tools, with defaults in [ ]:\n"
nethercote0d588502004-06-21 13:27:11 +00001522" --tool=<name> use the Valgrind tool named <name>\n"
nethercotea76368b2004-06-16 11:56:29 +00001523" -h --help show this message\n"
nethercote6c999f22004-01-31 22:55:15 +00001524" --help-debug show this message, plus debugging options\n"
njn25e49d8e72002-09-23 09:36:25 +00001525" --version show version\n"
njn25e49d8e72002-09-23 09:36:25 +00001526" -q --quiet run silently; only print error msgs\n"
1527" -v --verbose be more verbose, incl counts of errors\n"
nethercote77eba602003-11-13 17:35:04 +00001528" --trace-children=no|yes Valgrind-ise child processes? [no]\n"
nethercote0d588502004-06-21 13:27:11 +00001529" --track-fds=no|yes track open file descriptors? [no]\n"
thughes6233a382004-08-21 11:10:44 +00001530" --time-stamp=no|yes add timestamps to log messages? [no]\n"
nethercote2b0793f2003-12-02 10:41:18 +00001531"\n"
1532" uncommon user options for all Valgrind tools:\n"
nethercote0d588502004-06-21 13:27:11 +00001533" --run-libc-freeres=no|yes free up glibc memory at exit? [yes]\n"
1534" --weird-hacks=hack1,hack2,... recognised hacks: lax-ioctls [none]\n"
1535" --signal-polltime=<time> signal poll period (mS) for older kernels [50]\n"
1536" --lowlat-signals=no|yes improve thread signal wake-up latency [no]\n"
1537" --lowlat-syscalls=no|yes improve thread syscall wake-up latency [no]\n"
fitzhardinge98abfc72003-12-16 02:05:15 +00001538" --pointercheck=no|yes enforce client address space limits [yes]\n"
sewardj062f3552005-01-06 16:13:40 +00001539" --support-elan3=no|yes hacks for Quadrics Elan3 support [no]\n"
njn25e49d8e72002-09-23 09:36:25 +00001540"\n"
nethercote2b0793f2003-12-02 10:41:18 +00001541" user options for Valgrind tools that report errors:\n"
nethercotef8548672004-06-21 12:42:35 +00001542" --log-fd=<number> log messages to file descriptor [2=stderr]\n"
1543" --log-file=<file> log messages to <file>.pid<pid>\n"
sewardj603d4102005-01-11 14:01:02 +00001544" --log-file-exactly=<file> log messages to <file>\n"
nethercotef8548672004-06-21 12:42:35 +00001545" --log-socket=ipaddr:port log messages to socket ipaddr:port\n"
nethercote2b0793f2003-12-02 10:41:18 +00001546" --demangle=no|yes automatically demangle C++ names? [yes]\n"
1547" --num-callers=<number> show <num> callers in stack traces [4]\n"
1548" --error-limit=no|yes stop showing new errors if too many? [yes]\n"
1549" --show-below-main=no|yes continue stack traces below main() [no]\n"
1550" --suppressions=<filename> suppress errors described in <filename>\n"
sewardjd153fae2005-01-10 17:24:47 +00001551" --gen-suppressions=no|yes|all print suppressions for errors? [no]\n"
nethercote04d0fbc2004-01-26 16:48:06 +00001552" --db-attach=no|yes start debugger when errors detected? [no]\n"
1553" --db-command=<command> command to start debugger [gdb -nw %%f %%p]\n"
1554" --input-fd=<number> file descriptor for input [0=stdin]\n"
fitzhardinge98abfc72003-12-16 02:05:15 +00001555"\n";
njn7cf0bd32002-06-08 13:36:03 +00001556
njn25e49d8e72002-09-23 09:36:25 +00001557 Char* usage2 =
1558"\n"
nethercote2b0793f2003-12-02 10:41:18 +00001559" debugging options for all Valgrind tools:\n"
njn25e49d8e72002-09-23 09:36:25 +00001560" --sanity-level=<number> level of sanity checking to do [1]\n"
1561" --single-step=no|yes translate each instr separately? [no]\n"
1562" --optimise=no|yes improve intermediate code? [yes]\n"
nethercote137bc552003-11-14 17:47:54 +00001563" --profile=no|yes profile? (tool must be built for it) [no]\n"
fitzhardinge462f4f92003-12-18 02:10:54 +00001564" --branchpred=yes|no generate branch prediction hints [no]\n"
sewardjfa8ec112005-01-19 11:55:34 +00001565" --trace-flags=<XXXXXXXX> show generated code? (X = 0|1) [00000000]\n"
1566" --profile-flags=<XXXXXXXX> ditto, but for profiling (X = 0|1) [00000000]\n"
sewardjc771b292004-11-30 18:55:21 +00001567" --trace-notbelow=<number> only show BBs above <number> [0]\n"
njn25e49d8e72002-09-23 09:36:25 +00001568" --trace-syscalls=no|yes show all system calls? [no]\n"
1569" --trace-signals=no|yes show signal handling details? [no]\n"
1570" --trace-symtab=no|yes show symbol table details? [no]\n"
njn25e49d8e72002-09-23 09:36:25 +00001571" --trace-sched=no|yes show thread scheduler details? [no]\n"
njn3e884182003-04-15 13:03:23 +00001572" --trace-pthread=none|some|all show pthread event details? [none]\n"
jsgf855d93d2003-10-13 22:26:55 +00001573" --wait-for-gdb=yes|no pause on startup to wait for gdb attach\n"
njn25e49d8e72002-09-23 09:36:25 +00001574"\n"
sewardj8b635a42004-11-22 19:01:47 +00001575" --vex-iropt-verbosity 0 .. 9 [0]\n"
1576" --vex-iropt-level 0 .. 2 [2]\n"
1577" --vex-iropt-precise-memory-exns [no]\n"
1578" --vex-iropt-unroll-thresh 0 .. 400 [120]\n"
1579" --vex-guest-max-insns 1 .. 100 [50]\n"
1580" --vex-guest-chase-thresh 0 .. 99 [10]\n"
1581"\n"
sewardjfa8ec112005-01-19 11:55:34 +00001582" --trace-flags and --profile-flags values (omit the middle space):\n"
sewardj2a99cf62004-11-24 10:44:19 +00001583" 1000 0000 show conversion into IR\n"
1584" 0100 0000 show after initial opt\n"
1585" 0010 0000 show after instrumentation\n"
1586" 0001 0000 show after second opt\n"
1587" 0000 1000 show after tree building\n"
1588" 0000 0100 show selecting insns\n"
1589" 0000 0010 show after reg-alloc\n"
1590" 0000 0001 show final assembly\n"
1591"\n"
nethercote2b0793f2003-12-02 10:41:18 +00001592" debugging options for Valgrind tools that report errors\n"
1593" --dump-error=<number> show translation for basic block associated\n"
1594" with <number>'th error context [0=show none]\n"
fitzhardinge98abfc72003-12-16 02:05:15 +00001595"\n";
njn3e884182003-04-15 13:03:23 +00001596
1597 Char* usage3 =
1598"\n"
nethercote71980f02004-01-24 18:18:54 +00001599" Extra options read from ~/.valgrindrc, $VALGRIND_OPTS, ./.valgrindrc\n"
njn25e49d8e72002-09-23 09:36:25 +00001600"\n"
nethercote08fa9a72004-07-16 17:44:00 +00001601" Valgrind is Copyright (C) 2000-2004 Julian Seward et al.\n"
njn25e49d8e72002-09-23 09:36:25 +00001602" and licensed under the GNU General Public License, version 2.\n"
1603" Bug reports, feedback, admiration, abuse, etc, to: %s.\n"
njnd04b7c62002-10-03 14:05:52 +00001604"\n"
nethercote137bc552003-11-14 17:47:54 +00001605" Tools are copyright and licensed by their authors. See each\n"
1606" tool's start-up message for more information.\n"
njn25e49d8e72002-09-23 09:36:25 +00001607"\n";
njn7cf0bd32002-06-08 13:36:03 +00001608
fitzhardinge98abfc72003-12-16 02:05:15 +00001609 VG_(printf)(usage1);
1610 if (VG_(details).name) {
1611 VG_(printf)(" user options for %s:\n", VG_(details).name);
fitzhardinge98abfc72003-12-16 02:05:15 +00001612 if (VG_(needs).command_line_options)
njn26f02512004-11-22 18:33:15 +00001613 TL_(print_usage)();
fitzhardinge98abfc72003-12-16 02:05:15 +00001614 else
1615 VG_(printf)(" (none)\n");
1616 }
nethercote6c999f22004-01-31 22:55:15 +00001617 if (debug_help) {
1618 VG_(printf)(usage2);
fitzhardinge98abfc72003-12-16 02:05:15 +00001619
nethercote6c999f22004-01-31 22:55:15 +00001620 if (VG_(details).name) {
1621 VG_(printf)(" debugging options for %s:\n", VG_(details).name);
1622
1623 if (VG_(needs).command_line_options)
njn26f02512004-11-22 18:33:15 +00001624 TL_(print_debug_usage)();
nethercote6c999f22004-01-31 22:55:15 +00001625 else
1626 VG_(printf)(" (none)\n");
1627 }
fitzhardinge98abfc72003-12-16 02:05:15 +00001628 }
nethercote421281e2003-11-20 16:20:55 +00001629 VG_(printf)(usage3, VG_BUGS_TO);
nethercotef4928da2004-06-15 10:54:40 +00001630 VG_(exit)(0);
njn7cf0bd32002-06-08 13:36:03 +00001631}
sewardjde4a1d02002-03-22 01:27:54 +00001632
nethercote71980f02004-01-24 18:18:54 +00001633static void pre_process_cmd_line_options
nethercote6c999f22004-01-31 22:55:15 +00001634 ( Int* need_help, const char** tool, const char** exec )
sewardj1c1b1162003-02-23 01:25:51 +00001635{
nethercote71980f02004-01-24 18:18:54 +00001636 UInt i;
sewardjde4a1d02002-03-22 01:27:54 +00001637
sewardj8b635a42004-11-22 19:01:47 +00001638 LibVEX_default_VexControl(& VG_(clo_vex_control));
1639
nethercote71980f02004-01-24 18:18:54 +00001640 /* parse the options we have (only the options we care about now) */
nethercotef6a1d502004-08-09 12:21:57 +00001641 for (i = 1; i < vg_argc; i++) {
nethercote71980f02004-01-24 18:18:54 +00001642
nethercotef6a1d502004-08-09 12:21:57 +00001643 if (strcmp(vg_argv[i], "--version") == 0) {
nethercote71980f02004-01-24 18:18:54 +00001644 printf("valgrind-" VERSION "\n");
nethercotef4928da2004-06-15 10:54:40 +00001645 exit(0);
nethercote71980f02004-01-24 18:18:54 +00001646
nethercotef6a1d502004-08-09 12:21:57 +00001647 } else if (VG_CLO_STREQ(vg_argv[i], "--help") ||
1648 VG_CLO_STREQ(vg_argv[i], "-h")) {
nethercote6c999f22004-01-31 22:55:15 +00001649 *need_help = 1;
1650
nethercotef6a1d502004-08-09 12:21:57 +00001651 } else if (VG_CLO_STREQ(vg_argv[i], "--help-debug")) {
nethercote6c999f22004-01-31 22:55:15 +00001652 *need_help = 2;
nethercote71980f02004-01-24 18:18:54 +00001653
nethercotef6c99d72004-11-09 14:35:43 +00001654 } else if (VG_CLO_STREQN(7, vg_argv[i], "--tool=")) {
nethercotef6a1d502004-08-09 12:21:57 +00001655 *tool = &vg_argv[i][7];
nethercote71980f02004-01-24 18:18:54 +00001656
nethercotef6a1d502004-08-09 12:21:57 +00001657 } else if (VG_CLO_STREQN(7, vg_argv[i], "--exec=")) {
1658 *exec = &vg_argv[i][7];
nethercote71980f02004-01-24 18:18:54 +00001659 }
1660 }
1661
nethercotef4928da2004-06-15 10:54:40 +00001662 /* If no tool specified, can act appropriately without loading tool */
nethercote71980f02004-01-24 18:18:54 +00001663 if (*tool == NULL) {
nethercotef4928da2004-06-15 10:54:40 +00001664 if (0 == *need_help) {
1665 // neither --tool nor --help/--help-debug specified
1666 missing_tool_option();
1667 } else {
1668 // Give help message, without any tool-specific help
1669 usage(/*help-debug?*/2 == *need_help);
1670 }
nethercote71980f02004-01-24 18:18:54 +00001671 }
1672}
1673
nethercote5ee67ca2004-06-22 14:00:09 +00001674static void process_cmd_line_options( UInt* client_auxv, const char* toolname )
nethercote71980f02004-01-24 18:18:54 +00001675{
nethercotef8548672004-06-21 12:42:35 +00001676 Int i, eventually_log_fd;
nethercote71980f02004-01-24 18:18:54 +00001677 Int toolname_len = VG_(strlen)(toolname);
sewardjde4a1d02002-03-22 01:27:54 +00001678
nethercotee1730692003-11-20 10:38:07 +00001679 /* log to stderr by default, but usage message goes to stdout */
nethercotef8548672004-06-21 12:42:35 +00001680 eventually_log_fd = 2;
sewardjde4a1d02002-03-22 01:27:54 +00001681
sewardj19d81412002-06-03 01:10:40 +00001682 /* Check for sane path in ./configure --prefix=... */
fitzhardinge98abfc72003-12-16 02:05:15 +00001683 if (VG_LIBDIR[0] != '/')
sewardj19d81412002-06-03 01:10:40 +00001684 config_error("Please use absolute paths in "
1685 "./configure --prefix=... or --libdir=...");
sewardj38170912002-05-10 21:07:22 +00001686
njnc6168192004-11-29 13:54:10 +00001687// XXX: what architectures is this necessary for? x86 yes, PPC no, others ?
njnca0518d2004-11-26 19:34:36 +00001688#ifdef __x86__
1689 {
1690 Int *auxp;
1691 for (auxp = client_auxv; auxp[0] != AT_NULL; auxp += 2) {
1692 switch(auxp[0]) {
1693 case AT_SYSINFO:
1694 auxp[1] = (Int)(VG_(client_trampoline_code) + VG_(tramp_syscall_offset));
1695 break;
1696 }
1697 }
1698 }
1699#endif
sewardjde4a1d02002-03-22 01:27:54 +00001700
nethercotef6a1d502004-08-09 12:21:57 +00001701 for (i = 1; i < vg_argc; i++) {
nethercote71980f02004-01-24 18:18:54 +00001702
nethercotef6a1d502004-08-09 12:21:57 +00001703 Char* arg = vg_argv[i];
thughes3bfd5a02004-07-18 08:05:44 +00001704 Char* colon = arg;
nethercote71980f02004-01-24 18:18:54 +00001705
thughes3bfd5a02004-07-18 08:05:44 +00001706 /* Look for a colon in the switch name */
1707 while (*colon && *colon != ':' && *colon != '=')
1708 colon++;
nethercote71980f02004-01-24 18:18:54 +00001709
1710 /* Look for matching "--toolname:foo" */
thughes3bfd5a02004-07-18 08:05:44 +00001711 if (*colon == ':') {
nethercote71980f02004-01-24 18:18:54 +00001712 if (VG_CLO_STREQN(2, arg, "--") &&
1713 VG_CLO_STREQN(toolname_len, arg+2, toolname) &&
1714 VG_CLO_STREQN(1, arg+2+toolname_len, ":"))
1715 {
1716 // prefix matches, convert "--toolname:foo" to "--foo"
1717 if (0)
1718 VG_(printf)("tool-specific arg: %s\n", arg);
1719 arg += toolname_len + 1;
1720 arg[0] = '-';
1721 arg[1] = '-';
1722
1723 } else {
1724 // prefix doesn't match, skip to next arg
1725 continue;
1726 }
1727 }
1728
fitzhardinge98abfc72003-12-16 02:05:15 +00001729 /* Ignore these options - they've already been handled */
nethercotef6c99d72004-11-09 14:35:43 +00001730 if (VG_CLO_STREQN(7, arg, "--tool="))
fitzhardinge98abfc72003-12-16 02:05:15 +00001731 continue;
nethercote71980f02004-01-24 18:18:54 +00001732 if (VG_CLO_STREQN(7, arg, "--exec="))
fitzhardinge98abfc72003-12-16 02:05:15 +00001733 continue;
1734
nethercote71980f02004-01-24 18:18:54 +00001735 if ( VG_CLO_STREQ(arg, "--"))
fitzhardinge98abfc72003-12-16 02:05:15 +00001736 continue;
nethercote27fec902004-06-16 21:26:32 +00001737
nethercote71980f02004-01-24 18:18:54 +00001738 else if (VG_CLO_STREQ(arg, "-v") ||
1739 VG_CLO_STREQ(arg, "--verbose"))
sewardjde4a1d02002-03-22 01:27:54 +00001740 VG_(clo_verbosity)++;
nethercote27fec902004-06-16 21:26:32 +00001741
nethercote71980f02004-01-24 18:18:54 +00001742 else if (VG_CLO_STREQ(arg, "-q") ||
1743 VG_CLO_STREQ(arg, "--quiet"))
sewardjde4a1d02002-03-22 01:27:54 +00001744 VG_(clo_verbosity)--;
1745
nethercote27fec902004-06-16 21:26:32 +00001746 else VG_BOOL_CLO("--branchpred", VG_(clo_branchpred))
nethercote27fec902004-06-16 21:26:32 +00001747 else VG_BOOL_CLO("--db-attach", VG_(clo_db_attach))
1748 else VG_BOOL_CLO("--demangle", VG_(clo_demangle))
1749 else VG_BOOL_CLO("--error-limit", VG_(clo_error_limit))
nethercote27fec902004-06-16 21:26:32 +00001750 else VG_BOOL_CLO("--lowlat-signals", VG_(clo_lowlat_signals))
1751 else VG_BOOL_CLO("--lowlat-syscalls", VG_(clo_lowlat_syscalls))
nethercote27fec902004-06-16 21:26:32 +00001752 else VG_BOOL_CLO("--pointercheck", VG_(clo_pointercheck))
sewardj062f3552005-01-06 16:13:40 +00001753 else VG_BOOL_CLO("--support-elan3", VG_(clo_support_elan3))
nethercote27fec902004-06-16 21:26:32 +00001754 else VG_BOOL_CLO("--profile", VG_(clo_profile))
1755 else VG_BOOL_CLO("--run-libc-freeres", VG_(clo_run_libc_freeres))
1756 else VG_BOOL_CLO("--show-below-main", VG_(clo_show_below_main))
thughes6233a382004-08-21 11:10:44 +00001757 else VG_BOOL_CLO("--time-stamp", VG_(clo_time_stamp))
nethercote27fec902004-06-16 21:26:32 +00001758 else VG_BOOL_CLO("--track-fds", VG_(clo_track_fds))
1759 else VG_BOOL_CLO("--trace-children", VG_(clo_trace_children))
1760 else VG_BOOL_CLO("--trace-sched", VG_(clo_trace_sched))
1761 else VG_BOOL_CLO("--trace-signals", VG_(clo_trace_signals))
1762 else VG_BOOL_CLO("--trace-symtab", VG_(clo_trace_symtab))
1763 else VG_BOOL_CLO("--trace-syscalls", VG_(clo_trace_syscalls))
1764 else VG_BOOL_CLO("--wait-for-gdb", VG_(clo_wait_for_gdb))
sewardj72f98ff2002-06-13 17:23:38 +00001765
nethercote27fec902004-06-16 21:26:32 +00001766 else VG_STR_CLO ("--db-command", VG_(clo_db_command))
1767 else VG_STR_CLO ("--weird-hacks", VG_(clo_weird_hacks))
sewardjde4a1d02002-03-22 01:27:54 +00001768
nethercote27fec902004-06-16 21:26:32 +00001769 else VG_NUM_CLO ("--dump-error", VG_(clo_dump_error))
1770 else VG_NUM_CLO ("--input-fd", VG_(clo_input_fd))
1771 else VG_NUM_CLO ("--sanity-level", VG_(clo_sanity_level))
nethercote69978792004-10-29 11:17:21 +00001772 else VG_NUM_CLO ("--signal-polltime", VG_(clo_signal_polltime))
nethercote27fec902004-06-16 21:26:32 +00001773 else VG_BNUM_CLO("--num-callers", VG_(clo_backtrace_size), 1,
1774 VG_DEEPEST_BACKTRACE)
sewardjde4a1d02002-03-22 01:27:54 +00001775
sewardj8b635a42004-11-22 19:01:47 +00001776 else VG_BNUM_CLO("--vex-iropt-verbosity",
1777 VG_(clo_vex_control).iropt_verbosity, 0, 10)
1778 else VG_BNUM_CLO("--vex-iropt-level",
1779 VG_(clo_vex_control).iropt_level, 0, 2)
1780 else VG_BOOL_CLO("--vex-iropt-precise-memory-exns",
1781 VG_(clo_vex_control).iropt_precise_memory_exns)
1782 else VG_BNUM_CLO("--vex-iropt-unroll-thresh",
1783 VG_(clo_vex_control).iropt_unroll_thresh, 0, 400)
1784 else VG_BNUM_CLO("--vex-guest-max-insns",
1785 VG_(clo_vex_control).guest_max_insns, 1, 100)
1786 else VG_BNUM_CLO("--vex-guest-chase-thresh",
1787 VG_(clo_vex_control).guest_chase_thresh, 0, 99)
1788
nethercotef8548672004-06-21 12:42:35 +00001789 // for backwards compatibility, replaced by --log-fd
nethercote71980f02004-01-24 18:18:54 +00001790 else if (VG_CLO_STREQN(13, arg, "--logfile-fd=")) {
nethercotef8548672004-06-21 12:42:35 +00001791 VG_(clo_log_to) = VgLogTo_Fd;
1792 VG_(clo_log_name) = NULL;
1793 eventually_log_fd = (Int)VG_(atoll)(&arg[13]);
1794 }
1795 else if (VG_CLO_STREQN(9, arg, "--log-fd=")) {
1796 VG_(clo_log_to) = VgLogTo_Fd;
1797 VG_(clo_log_name) = NULL;
1798 eventually_log_fd = (Int)VG_(atoll)(&arg[9]);
sewardj4cf05692002-10-27 20:28:29 +00001799 }
1800
nethercotef8548672004-06-21 12:42:35 +00001801 // for backwards compatibility, replaced by --log-file
nethercote71980f02004-01-24 18:18:54 +00001802 else if (VG_CLO_STREQN(10, arg, "--logfile=")) {
nethercotef8548672004-06-21 12:42:35 +00001803 VG_(clo_log_to) = VgLogTo_File;
1804 VG_(clo_log_name) = &arg[10];
1805 }
1806 else if (VG_CLO_STREQN(11, arg, "--log-file=")) {
1807 VG_(clo_log_to) = VgLogTo_File;
1808 VG_(clo_log_name) = &arg[11];
sewardj4cf05692002-10-27 20:28:29 +00001809 }
sewardj603d4102005-01-11 14:01:02 +00001810 else if (VG_CLO_STREQN(19, arg, "--log-file-exactly=")) {
1811 VG_(clo_log_to) = VgLogTo_FileExactly;
1812 VG_(clo_log_name) = &arg[19];
1813 }
sewardjde4a1d02002-03-22 01:27:54 +00001814
nethercotef8548672004-06-21 12:42:35 +00001815 // for backwards compatibility, replaced by --log-socket
nethercote71980f02004-01-24 18:18:54 +00001816 else if (VG_CLO_STREQN(12, arg, "--logsocket=")) {
nethercotef8548672004-06-21 12:42:35 +00001817 VG_(clo_log_to) = VgLogTo_Socket;
1818 VG_(clo_log_name) = &arg[12];
1819 }
1820 else if (VG_CLO_STREQN(13, arg, "--log-socket=")) {
1821 VG_(clo_log_to) = VgLogTo_Socket;
1822 VG_(clo_log_name) = &arg[13];
sewardj73cf3bc2002-11-03 03:20:15 +00001823 }
1824
nethercote71980f02004-01-24 18:18:54 +00001825 else if (VG_CLO_STREQN(15, arg, "--suppressions=")) {
sewardjde4a1d02002-03-22 01:27:54 +00001826 if (VG_(clo_n_suppressions) >= VG_CLO_MAX_SFILES) {
njn25e49d8e72002-09-23 09:36:25 +00001827 VG_(message)(Vg_UserMsg, "Too many suppression files specified.");
sewardjde4a1d02002-03-22 01:27:54 +00001828 VG_(message)(Vg_UserMsg,
1829 "Increase VG_CLO_MAX_SFILES and recompile.");
nethercote71980f02004-01-24 18:18:54 +00001830 VG_(bad_option)(arg);
sewardjde4a1d02002-03-22 01:27:54 +00001831 }
nethercote71980f02004-01-24 18:18:54 +00001832 VG_(clo_suppressions)[VG_(clo_n_suppressions)] = &arg[15];
sewardjde4a1d02002-03-22 01:27:54 +00001833 VG_(clo_n_suppressions)++;
1834 }
sewardjde4a1d02002-03-22 01:27:54 +00001835
sewardjfa8ec112005-01-19 11:55:34 +00001836 /* "stuvwxyz" --> stuvwxyz (binary) */
1837 else if (VG_CLO_STREQN(14, arg, "--trace-flags=")) {
1838 Int j;
1839 char* opt = & arg[14];
1840
1841 if (8 != VG_(strlen)(opt)) {
1842 VG_(message)(Vg_UserMsg,
1843 "--trace-flags argument must have 8 digits");
1844 VG_(bad_option)(arg);
1845 }
1846 for (j = 0; j < 8; j++) {
1847 if ('0' == opt[j]) { /* do nothing */ }
1848 else if ('1' == opt[j]) VG_(clo_trace_flags) |= (1 << (7-j));
1849 else {
1850 VG_(message)(Vg_UserMsg, "--trace-flags argument can only "
1851 "contain 0s and 1s");
1852 VG_(bad_option)(arg);
1853 }
1854 }
1855 }
1856
1857 /* "stuvwxyz" --> stuvwxyz (binary) */
1858 else if (VG_CLO_STREQN(16, arg, "--profile-flags=")) {
njn25e49d8e72002-09-23 09:36:25 +00001859 Int j;
nethercote71980f02004-01-24 18:18:54 +00001860 char* opt = & arg[16];
njn25e49d8e72002-09-23 09:36:25 +00001861
sewardj2a99cf62004-11-24 10:44:19 +00001862 if (8 != VG_(strlen)(opt)) {
njn25e49d8e72002-09-23 09:36:25 +00001863 VG_(message)(Vg_UserMsg,
sewardjfa8ec112005-01-19 11:55:34 +00001864 "--profile-flags argument must have 8 digits");
nethercote71980f02004-01-24 18:18:54 +00001865 VG_(bad_option)(arg);
njn25e49d8e72002-09-23 09:36:25 +00001866 }
sewardj8b635a42004-11-22 19:01:47 +00001867 for (j = 0; j < 8; j++) {
njn25e49d8e72002-09-23 09:36:25 +00001868 if ('0' == opt[j]) { /* do nothing */ }
sewardjfa8ec112005-01-19 11:55:34 +00001869 else if ('1' == opt[j]) VG_(clo_profile_flags) |= (1 << (7-j));
njn25e49d8e72002-09-23 09:36:25 +00001870 else {
sewardjfa8ec112005-01-19 11:55:34 +00001871 VG_(message)(Vg_UserMsg, "--profile-flags argument can only "
njn25e49d8e72002-09-23 09:36:25 +00001872 "contain 0s and 1s");
nethercote71980f02004-01-24 18:18:54 +00001873 VG_(bad_option)(arg);
njn25e49d8e72002-09-23 09:36:25 +00001874 }
1875 }
1876 }
sewardjde4a1d02002-03-22 01:27:54 +00001877
sewardjc771b292004-11-30 18:55:21 +00001878 else VG_NUM_CLO ("--trace-notbelow", VG_(clo_trace_notbelow))
1879
nethercote71980f02004-01-24 18:18:54 +00001880 else if (VG_CLO_STREQ(arg, "--trace-pthread=none"))
sewardj45b4b372002-04-16 22:50:32 +00001881 VG_(clo_trace_pthread_level) = 0;
nethercote71980f02004-01-24 18:18:54 +00001882 else if (VG_CLO_STREQ(arg, "--trace-pthread=some"))
sewardj45b4b372002-04-16 22:50:32 +00001883 VG_(clo_trace_pthread_level) = 1;
nethercote71980f02004-01-24 18:18:54 +00001884 else if (VG_CLO_STREQ(arg, "--trace-pthread=all"))
sewardj45b4b372002-04-16 22:50:32 +00001885 VG_(clo_trace_pthread_level) = 2;
sewardj8937c812002-04-12 20:12:20 +00001886
sewardjd153fae2005-01-10 17:24:47 +00001887 else if (VG_CLO_STREQ(arg, "--gen-suppressions=no"))
1888 VG_(clo_gen_suppressions) = 0;
1889 else if (VG_CLO_STREQ(arg, "--gen-suppressions=yes"))
1890 VG_(clo_gen_suppressions) = 1;
1891 else if (VG_CLO_STREQ(arg, "--gen-suppressions=all"))
1892 VG_(clo_gen_suppressions) = 2;
1893
nethercote71980f02004-01-24 18:18:54 +00001894 else if ( ! VG_(needs).command_line_options
njn26f02512004-11-22 18:33:15 +00001895 || ! TL_(process_cmd_line_option)(arg) ) {
nethercotef4928da2004-06-15 10:54:40 +00001896 VG_(bad_option)(arg);
njn25e49d8e72002-09-23 09:36:25 +00001897 }
sewardjde4a1d02002-03-22 01:27:54 +00001898 }
1899
sewardj998d40d2004-12-06 14:24:52 +00001900 /* Make VEX control parameters sane */
1901
1902 if (VG_(clo_vex_control).guest_chase_thresh
1903 >= VG_(clo_vex_control).guest_max_insns)
1904 VG_(clo_vex_control).guest_chase_thresh
1905 = VG_(clo_vex_control).guest_max_insns - 1;
1906
1907 if (VG_(clo_vex_control).guest_chase_thresh < 0)
1908 VG_(clo_vex_control).guest_chase_thresh = 0;
1909
1910 /* Check various option values */
nethercote27fec902004-06-16 21:26:32 +00001911
njnf9ebf672003-05-12 21:41:30 +00001912 if (VG_(clo_verbosity) < 0)
sewardjde4a1d02002-03-22 01:27:54 +00001913 VG_(clo_verbosity) = 0;
1914
nethercote04d0fbc2004-01-26 16:48:06 +00001915 if (VG_(clo_db_attach) && VG_(clo_trace_children)) {
sewardjde4a1d02002-03-22 01:27:54 +00001916 VG_(message)(Vg_UserMsg, "");
1917 VG_(message)(Vg_UserMsg,
nethercote04d0fbc2004-01-26 16:48:06 +00001918 "--db-attach=yes conflicts with --trace-children=yes");
sewardjde4a1d02002-03-22 01:27:54 +00001919 VG_(message)(Vg_UserMsg,
1920 "Please choose one or the other, but not both.");
nethercote04d0fbc2004-01-26 16:48:06 +00001921 VG_(bad_option)("--db-attach=yes and --trace-children=yes");
sewardjde4a1d02002-03-22 01:27:54 +00001922 }
1923
nethercotef8548672004-06-21 12:42:35 +00001924 /* Set up logging now. After this is done, VG_(clo_log_fd)
sewardj4cf05692002-10-27 20:28:29 +00001925 should be connected to whatever sink has been selected, and we
1926 indiscriminately chuck stuff into it without worrying what the
1927 nature of it is. Oh the wonder of Unix streams. */
1928
nethercotee1730692003-11-20 10:38:07 +00001929 /* So far we should be still attached to stdout, so we can show on
sewardj4cf05692002-10-27 20:28:29 +00001930 the terminal any problems to do with processing command line
1931 opts. */
nethercotef8548672004-06-21 12:42:35 +00001932 vg_assert(VG_(clo_log_fd) == 1 /* stdout */);
sewardj73cf3bc2002-11-03 03:20:15 +00001933 vg_assert(VG_(logging_to_filedes) == True);
sewardj4cf05692002-10-27 20:28:29 +00001934
1935 switch (VG_(clo_log_to)) {
sewardj73cf3bc2002-11-03 03:20:15 +00001936
sewardj4cf05692002-10-27 20:28:29 +00001937 case VgLogTo_Fd:
nethercotef8548672004-06-21 12:42:35 +00001938 vg_assert(VG_(clo_log_name) == NULL);
1939 VG_(clo_log_fd) = eventually_log_fd;
sewardj4cf05692002-10-27 20:28:29 +00001940 break;
sewardj73cf3bc2002-11-03 03:20:15 +00001941
sewardj4cf05692002-10-27 20:28:29 +00001942 case VgLogTo_File: {
1943 Char logfilename[1000];
jsgff3c3f1a2003-10-14 22:13:28 +00001944 Int seq = 0;
1945 Int pid = VG_(getpid)();
1946
nethercotef8548672004-06-21 12:42:35 +00001947 vg_assert(VG_(clo_log_name) != NULL);
1948 vg_assert(VG_(strlen)(VG_(clo_log_name)) <= 900); /* paranoia */
jsgff3c3f1a2003-10-14 22:13:28 +00001949
nethercote71980f02004-01-24 18:18:54 +00001950 for (;;) {
jsgff3c3f1a2003-10-14 22:13:28 +00001951 if (seq == 0)
1952 VG_(sprintf)(logfilename, "%s.pid%d",
nethercotef8548672004-06-21 12:42:35 +00001953 VG_(clo_log_name), pid );
jsgff3c3f1a2003-10-14 22:13:28 +00001954 else
1955 VG_(sprintf)(logfilename, "%s.pid%d.%d",
nethercotef8548672004-06-21 12:42:35 +00001956 VG_(clo_log_name), pid, seq );
jsgff3c3f1a2003-10-14 22:13:28 +00001957 seq++;
1958
nethercotef8548672004-06-21 12:42:35 +00001959 eventually_log_fd
jsgff3c3f1a2003-10-14 22:13:28 +00001960 = VG_(open)(logfilename,
1961 VKI_O_CREAT|VKI_O_WRONLY|VKI_O_EXCL|VKI_O_TRUNC,
1962 VKI_S_IRUSR|VKI_S_IWUSR);
nethercotef8548672004-06-21 12:42:35 +00001963 if (eventually_log_fd >= 0) {
1964 VG_(clo_log_fd) = VG_(safe_fd)(eventually_log_fd);
sewardj603d4102005-01-11 14:01:02 +00001965 break; /* for (;;) */
jsgff3c3f1a2003-10-14 22:13:28 +00001966 } else {
nethercotef8548672004-06-21 12:42:35 +00001967 if (eventually_log_fd != -VKI_EEXIST) {
jsgff3c3f1a2003-10-14 22:13:28 +00001968 VG_(message)(Vg_UserMsg,
1969 "Can't create/open log file `%s.pid%d'; giving up!",
nethercotef8548672004-06-21 12:42:35 +00001970 VG_(clo_log_name), pid);
jsgff3c3f1a2003-10-14 22:13:28 +00001971 VG_(bad_option)(
sewardj603d4102005-01-11 14:01:02 +00001972 "--log-file=<file> (didn't work out for some reason.)");
1973 break; /* for (;;) */
jsgff3c3f1a2003-10-14 22:13:28 +00001974 }
1975 }
1976 }
sewardj603d4102005-01-11 14:01:02 +00001977 break; /* switch (VG_(clo_log_to)) */
1978 }
1979
1980 case VgLogTo_FileExactly: {
1981 Char logfilename[1000];
1982
1983 vg_assert(VG_(clo_log_name) != NULL);
1984 vg_assert(VG_(strlen)(VG_(clo_log_name)) <= 900); /* paranoia */
1985 VG_(sprintf)(logfilename, "%s", VG_(clo_log_name));
1986
1987 eventually_log_fd
1988 = VG_(open)(logfilename,
1989 VKI_O_CREAT|VKI_O_WRONLY|VKI_O_TRUNC,
1990 VKI_S_IRUSR|VKI_S_IWUSR);
1991 if (eventually_log_fd >= 0) {
1992 VG_(clo_log_fd) = VG_(safe_fd)(eventually_log_fd);
1993 }
1994 else if (eventually_log_fd != -VKI_EEXIST) {
1995 VG_(message)(Vg_UserMsg,
1996 "Can't create/open log file `%s'; giving up!",
1997 VG_(clo_log_name));
1998 VG_(bad_option)(
1999 "--log-file-exactly=<file> (didn't work out for some reason.)");
2000 /*NOTREACHED*/
2001 }
2002 break; /* switch (VG_(clo_log_to)) */
sewardj73cf3bc2002-11-03 03:20:15 +00002003 }
2004
2005 case VgLogTo_Socket: {
nethercotef8548672004-06-21 12:42:35 +00002006 vg_assert(VG_(clo_log_name) != NULL);
2007 vg_assert(VG_(strlen)(VG_(clo_log_name)) <= 900); /* paranoia */
2008 eventually_log_fd = VG_(connect_via_socket)( VG_(clo_log_name) );
2009 if (eventually_log_fd == -1) {
sewardj73cf3bc2002-11-03 03:20:15 +00002010 VG_(message)(Vg_UserMsg,
nethercotef8548672004-06-21 12:42:35 +00002011 "Invalid --log-socket=ipaddr or --log-socket=ipaddr:port spec");
sewardj73cf3bc2002-11-03 03:20:15 +00002012 VG_(message)(Vg_UserMsg,
nethercotef8548672004-06-21 12:42:35 +00002013 "of `%s'; giving up!", VG_(clo_log_name) );
sewardj73cf3bc2002-11-03 03:20:15 +00002014 VG_(bad_option)(
nethercotef8548672004-06-21 12:42:35 +00002015 "--log-socket=");
sewardj4cf05692002-10-27 20:28:29 +00002016 }
nethercotef8548672004-06-21 12:42:35 +00002017 if (eventually_log_fd == -2) {
sewardj73cf3bc2002-11-03 03:20:15 +00002018 VG_(message)(Vg_UserMsg,
sewardj570f8902002-11-03 11:44:36 +00002019 "valgrind: failed to connect to logging server `%s'.",
nethercotef8548672004-06-21 12:42:35 +00002020 VG_(clo_log_name) );
sewardj570f8902002-11-03 11:44:36 +00002021 VG_(message)(Vg_UserMsg,
2022 "Log messages will sent to stderr instead." );
2023 VG_(message)(Vg_UserMsg,
2024 "" );
2025 /* We don't change anything here. */
2026 } else {
nethercotef8548672004-06-21 12:42:35 +00002027 vg_assert(eventually_log_fd > 0);
2028 VG_(clo_log_fd) = eventually_log_fd;
sewardj570f8902002-11-03 11:44:36 +00002029 VG_(logging_to_filedes) = False;
2030 }
sewardj73cf3bc2002-11-03 03:20:15 +00002031 break;
2032 }
2033
sewardj4cf05692002-10-27 20:28:29 +00002034 }
2035
nethercotef8548672004-06-21 12:42:35 +00002036 /* Move log_fd into the safe range, so it doesn't conflict with any app fds */
thughesad1c9562004-06-26 11:27:52 +00002037 eventually_log_fd = VG_(fcntl)(VG_(clo_log_fd), VKI_F_DUPFD, VG_(fd_hard_limit));
nethercotef8548672004-06-21 12:42:35 +00002038 if (eventually_log_fd < 0)
jsgf855d93d2003-10-13 22:26:55 +00002039 VG_(message)(Vg_UserMsg, "valgrind: failed to move logfile fd into safe range");
2040 else {
nethercotef8548672004-06-21 12:42:35 +00002041 VG_(clo_log_fd) = eventually_log_fd;
2042 VG_(fcntl)(VG_(clo_log_fd), VKI_F_SETFD, VKI_FD_CLOEXEC);
jsgf855d93d2003-10-13 22:26:55 +00002043 }
2044
sewardj4cf05692002-10-27 20:28:29 +00002045 /* Ok, the logging sink is running now. Print a suitable preamble.
2046 If logging to file or a socket, write details of parent PID and
2047 command line args, to help people trying to interpret the
2048 results of a run which encompasses multiple processes. */
sewardjde4a1d02002-03-22 01:27:54 +00002049
sewardj83adf412002-05-01 01:25:45 +00002050 if (VG_(clo_verbosity > 0)) {
nethercote996901a2004-08-03 13:29:09 +00002051 /* Tool details */
njnb9c427c2004-12-01 14:14:42 +00002052 VG_(message)(Vg_UserMsg, "%s%s%s, %s.",
njnd04b7c62002-10-03 14:05:52 +00002053 VG_(details).name,
njnb9c427c2004-12-01 14:14:42 +00002054 NULL == VG_(details).version ? "" : "-",
njnd04b7c62002-10-03 14:05:52 +00002055 NULL == VG_(details).version
2056 ? (Char*)"" : VG_(details).version,
njnb9c427c2004-12-01 14:14:42 +00002057 VG_(details).description);
njnd04b7c62002-10-03 14:05:52 +00002058 VG_(message)(Vg_UserMsg, "%s", VG_(details).copyright_author);
sewardj3b2736a2002-03-24 12:18:35 +00002059
njnd04b7c62002-10-03 14:05:52 +00002060 /* Core details */
2061 VG_(message)(Vg_UserMsg,
sewardj090ec782004-12-20 04:38:31 +00002062 "Using LibVEX rev %s, a library for dynamic binary translation.",
2063 LibVEX_Version() );
sewardjc7025332004-12-13 18:30:39 +00002064 VG_(message)(Vg_UserMsg,
2065 "Copyright (C) 2004, and GNU GPL'd, by OpenWorks LLP.");
2066 VG_(message)(Vg_UserMsg,
njnb9c427c2004-12-01 14:14:42 +00002067 "Using valgrind-%s, a dynamic binary instrumentation framework.",
sewardj5a1feda2004-12-17 19:18:02 +00002068 /*VERSION*/ "SVN >= 3207");
sewardjde4a1d02002-03-22 01:27:54 +00002069 VG_(message)(Vg_UserMsg,
nethercote08fa9a72004-07-16 17:44:00 +00002070 "Copyright (C) 2000-2004, and GNU GPL'd, by Julian Seward et al.");
njnd04b7c62002-10-03 14:05:52 +00002071 }
2072
nethercotec1e395d2003-11-10 13:26:49 +00002073 if (VG_(clo_verbosity) > 0 && VG_(clo_log_to) != VgLogTo_Fd) {
sewardj4cf05692002-10-27 20:28:29 +00002074 VG_(message)(Vg_UserMsg, "");
2075 VG_(message)(Vg_UserMsg,
2076 "My PID = %d, parent PID = %d. Prog and args are:",
2077 VG_(getpid)(), VG_(getppid)() );
2078 for (i = 0; i < VG_(client_argc); i++)
2079 VG_(message)(Vg_UserMsg, " %s", VG_(client_argv)[i]);
2080 }
2081
sewardjde4a1d02002-03-22 01:27:54 +00002082 if (VG_(clo_verbosity) > 1) {
nethercotea70f7352004-04-18 12:08:46 +00002083 Int fd;
sewardj4cf05692002-10-27 20:28:29 +00002084 if (VG_(clo_log_to) != VgLogTo_Fd)
2085 VG_(message)(Vg_UserMsg, "");
fitzhardinge98abfc72003-12-16 02:05:15 +00002086 VG_(message)(Vg_UserMsg, "Valgrind library directory: %s", VG_(libdir));
njn86dc2bc2003-09-09 07:26:21 +00002087 VG_(message)(Vg_UserMsg, "Command line");
2088 for (i = 0; i < VG_(client_argc); i++)
2089 VG_(message)(Vg_UserMsg, " %s", VG_(client_argv)[i]);
2090
sewardjde4a1d02002-03-22 01:27:54 +00002091 VG_(message)(Vg_UserMsg, "Startup, with flags:");
nethercotef6a1d502004-08-09 12:21:57 +00002092 for (i = 1; i < vg_argc; i++) {
2093 VG_(message)(Vg_UserMsg, " %s", vg_argv[i]);
sewardjde4a1d02002-03-22 01:27:54 +00002094 }
nethercotea70f7352004-04-18 12:08:46 +00002095
2096 VG_(message)(Vg_UserMsg, "Contents of /proc/version:");
2097 fd = VG_(open) ( "/proc/version", VKI_O_RDONLY, 0 );
2098 if (fd < 0) {
2099 VG_(message)(Vg_UserMsg, " can't open /proc/version");
2100 } else {
2101 #define BUF_LEN 256
2102 Char version_buf[BUF_LEN];
2103 Int n = VG_(read) ( fd, version_buf, BUF_LEN );
2104 vg_assert(n <= 256);
2105 if (n > 0) {
2106 version_buf[n-1] = '\0';
2107 VG_(message)(Vg_UserMsg, " %s", version_buf);
2108 } else {
2109 VG_(message)(Vg_UserMsg, " (empty?)");
2110 }
2111 VG_(close)(fd);
2112 #undef BUF_LEN
2113 }
sewardjde4a1d02002-03-22 01:27:54 +00002114 }
2115
fitzhardinge98abfc72003-12-16 02:05:15 +00002116 if (VG_(clo_n_suppressions) < VG_CLO_MAX_SFILES-1 &&
njn95ec8702004-11-22 16:46:13 +00002117 (VG_(needs).core_errors || VG_(needs).tool_errors)) {
nethercote996901a2004-08-03 13:29:09 +00002118 /* If there are no suppression files specified and the tool
fitzhardinge98abfc72003-12-16 02:05:15 +00002119 needs one, load the default */
2120 static const Char default_supp[] = "default.supp";
2121 Int len = VG_(strlen)(VG_(libdir)) + 1 + sizeof(default_supp);
2122 Char *buf = VG_(arena_malloc)(VG_AR_CORE, len);
2123 VG_(sprintf)(buf, "%s/%s", VG_(libdir), default_supp);
2124 VG_(clo_suppressions)[VG_(clo_n_suppressions)] = buf;
2125 VG_(clo_n_suppressions)++;
sewardjde4a1d02002-03-22 01:27:54 +00002126 }
sewardj4cf05692002-10-27 20:28:29 +00002127
sewardjd153fae2005-01-10 17:24:47 +00002128 if (VG_(clo_gen_suppressions) > 0 &&
njn95ec8702004-11-22 16:46:13 +00002129 !VG_(needs).core_errors && !VG_(needs).tool_errors) {
nethercotef4928da2004-06-15 10:54:40 +00002130 VG_(message)(Vg_UserMsg,
sewardjd153fae2005-01-10 17:24:47 +00002131 "Can't use --gen-suppressions= with this tool,");
nethercotef4928da2004-06-15 10:54:40 +00002132 VG_(message)(Vg_UserMsg,
2133 "as it doesn't generate errors.");
sewardjd153fae2005-01-10 17:24:47 +00002134 VG_(bad_option)("--gen-suppressions=");
njn6a230532003-07-21 10:38:23 +00002135 }
sewardjde4a1d02002-03-22 01:27:54 +00002136}
2137
nethercotef6a1d502004-08-09 12:21:57 +00002138// Build the string for VALGRINDCLO.
2139Char* VG_(build_child_VALGRINDCLO)( Char* exename )
2140{
2141 /* If we're tracing the children, then we need to start it
2142 with our starter+arguments, which are copied into VALGRINDCLO,
2143 except the --exec= option is changed if present.
2144 */
2145 Int i;
2146 Char *exec;
2147 Char *cp;
2148 Char *optvar;
2149 Int optlen, execlen;
2150
2151 // All these allocated blocks are not free - because we're either
2152 // going to exec, or panic when we fail.
2153
2154 // Create --exec= option: "--exec=<exename>"
2155 exec = VG_(arena_malloc)(VG_AR_CORE,
2156 VG_(strlen)( exename ) + 7/*--exec=*/ + 1/*\0*/);
2157 vg_assert(NULL != exec);
2158 VG_(sprintf)(exec, "--exec=%s", exename);
2159
2160 // Allocate space for optvar (may overestimate by counting --exec twice,
2161 // no matter)
2162 optlen = 1;
2163 for (i = 0; i < vg_argc; i++)
2164 optlen += VG_(strlen)(vg_argv[i]) + 1;
2165 optlen += VG_(strlen)(exec)+1;
2166 optvar = VG_(arena_malloc)(VG_AR_CORE, optlen);
2167
2168 // Copy all valgrind args except the old --exec (if present)
2169 // VG_CLO_SEP is the separator.
2170 cp = optvar;
2171 for (i = 1; i < vg_argc; i++) {
2172 Char *arg = vg_argv[i];
2173
2174 if (VG_(memcmp)(arg, "--exec=", 7) == 0) {
2175 // don't copy existing --exec= arg
2176 } else if (VG_(strcmp)(arg, "--") == 0) {
2177 // stop at "--"
2178 break;
2179 } else {
2180 // copy non "--exec" arg
2181 Int len = VG_(strlen)(arg);
2182 VG_(memcpy)(cp, arg, len);
2183 cp += len;
2184 *cp++ = VG_CLO_SEP;
2185 }
2186 }
2187 // Add the new --exec= option
2188 execlen = VG_(strlen)(exec);
2189 VG_(memcpy)(cp, exec, execlen);
2190 cp += execlen;
2191 *cp++ = VG_CLO_SEP;
2192
2193 *cp = '\0';
2194
2195 return optvar;
2196}
2197
2198// Build "/proc/self/fd/<execfd>".
2199Char* VG_(build_child_exename)( void )
2200{
2201 Char* exename = VG_(arena_malloc)(VG_AR_CORE, 64);
2202 vg_assert(NULL != exename);
2203 VG_(sprintf)(exename, "/proc/self/fd/%d", vgexecfd);
2204 return exename;
2205}
2206
sewardjde4a1d02002-03-22 01:27:54 +00002207
nethercote71980f02004-01-24 18:18:54 +00002208/*====================================================================*/
2209/*=== File descriptor setup ===*/
2210/*====================================================================*/
2211
2212static void setup_file_descriptors(void)
2213{
2214 struct vki_rlimit rl;
2215
2216 /* Get the current file descriptor limits. */
2217 if (VG_(getrlimit)(VKI_RLIMIT_NOFILE, &rl) < 0) {
2218 rl.rlim_cur = 1024;
2219 rl.rlim_max = 1024;
2220 }
2221
2222 /* Work out where to move the soft limit to. */
2223 if (rl.rlim_cur + VG_N_RESERVED_FDS <= rl.rlim_max) {
2224 rl.rlim_cur = rl.rlim_cur + VG_N_RESERVED_FDS;
2225 } else {
2226 rl.rlim_cur = rl.rlim_max;
2227 }
2228
2229 /* Reserve some file descriptors for our use. */
thughesad1c9562004-06-26 11:27:52 +00002230 VG_(fd_soft_limit) = rl.rlim_cur - VG_N_RESERVED_FDS;
2231 VG_(fd_hard_limit) = rl.rlim_cur - VG_N_RESERVED_FDS;
nethercote71980f02004-01-24 18:18:54 +00002232
2233 /* Update the soft limit. */
2234 VG_(setrlimit)(VKI_RLIMIT_NOFILE, &rl);
2235
nethercotef6a1d502004-08-09 12:21:57 +00002236 if (vgexecfd != -1)
2237 vgexecfd = VG_(safe_fd)( vgexecfd );
nethercote71980f02004-01-24 18:18:54 +00002238 if (VG_(clexecfd) != -1)
2239 VG_(clexecfd) = VG_(safe_fd)( VG_(clexecfd) );
2240}
2241
nethercote71980f02004-01-24 18:18:54 +00002242/*====================================================================*/
nethercote71980f02004-01-24 18:18:54 +00002243/*=== Initialise program data/text, etc. ===*/
2244/*====================================================================*/
sewardjde4a1d02002-03-22 01:27:54 +00002245
nethercote71980f02004-01-24 18:18:54 +00002246static void build_valgrind_map_callback
nethercote8991d5a2004-11-03 17:07:46 +00002247 ( Addr start, SizeT size, Char rr, Char ww, Char xx,
nethercote71980f02004-01-24 18:18:54 +00002248 UInt dev, UInt ino, ULong foffset, const UChar* filename )
sewardjde4a1d02002-03-22 01:27:54 +00002249{
nethercote71980f02004-01-24 18:18:54 +00002250 UInt prot = 0;
2251 UInt flags = SF_MMAP|SF_NOSYMS;
2252 Bool is_stack_segment;
2253
2254 is_stack_segment =
2255 (start == VG_(clstk_base) && (start+size) == VG_(clstk_end));
2256
2257 /* Only record valgrind mappings for now, without loading any
2258 symbols. This is so we know where the free space is before we
2259 start allocating more memory (note: heap is OK, it's just mmap
2260 which is the problem here). */
nethercote820bd8c2004-09-07 23:04:49 +00002261 if (start >= VG_(valgrind_base) && (start+size-1) <= VG_(valgrind_last)) {
nethercote71980f02004-01-24 18:18:54 +00002262 flags |= SF_VALGRIND;
2263 VG_(map_file_segment)(start, size, prot, flags, dev, ino, foffset, filename);
2264 }
sewardjde4a1d02002-03-22 01:27:54 +00002265}
2266
nethercote71980f02004-01-24 18:18:54 +00002267// Global var used to pass local data to callback
nethercote4ad74312004-10-26 09:59:49 +00002268Addr sp_at_startup___global_arg = 0;
sewardjde4a1d02002-03-22 01:27:54 +00002269
nethercote71980f02004-01-24 18:18:54 +00002270static void build_segment_map_callback
nethercote8991d5a2004-11-03 17:07:46 +00002271 ( Addr start, SizeT size, Char rr, Char ww, Char xx,
nethercote71980f02004-01-24 18:18:54 +00002272 UInt dev, UInt ino, ULong foffset, const UChar* filename )
sewardj45b672d2003-07-25 19:58:11 +00002273{
nethercote71980f02004-01-24 18:18:54 +00002274 UInt prot = 0;
2275 UInt flags;
2276 Bool is_stack_segment;
2277 Addr r_esp;
sewardj45b672d2003-07-25 19:58:11 +00002278
nethercote71980f02004-01-24 18:18:54 +00002279 is_stack_segment
2280 = (start == VG_(clstk_base) && (start+size) == VG_(clstk_end));
fitzhardinge98abfc72003-12-16 02:05:15 +00002281
nethercote71980f02004-01-24 18:18:54 +00002282 if (rr == 'r') prot |= VKI_PROT_READ;
2283 if (ww == 'w') prot |= VKI_PROT_WRITE;
2284 if (xx == 'x') prot |= VKI_PROT_EXEC;
fitzhardinge98abfc72003-12-16 02:05:15 +00002285
nethercote71980f02004-01-24 18:18:54 +00002286 if (is_stack_segment)
2287 flags = SF_STACK | SF_GROWDOWN;
2288 else
2289 flags = SF_EXEC|SF_MMAP;
fitzhardinge98abfc72003-12-16 02:05:15 +00002290
nethercote71980f02004-01-24 18:18:54 +00002291 if (filename != NULL)
2292 flags |= SF_FILE;
fitzhardinge98abfc72003-12-16 02:05:15 +00002293
nethercote820bd8c2004-09-07 23:04:49 +00002294 if (start >= VG_(valgrind_base) && (start+size-1) <= VG_(valgrind_last))
nethercote71980f02004-01-24 18:18:54 +00002295 flags |= SF_VALGRIND;
fitzhardinge98abfc72003-12-16 02:05:15 +00002296
nethercote71980f02004-01-24 18:18:54 +00002297 VG_(map_file_segment)(start, size, prot, flags, dev, ino, foffset, filename);
fitzhardinge98abfc72003-12-16 02:05:15 +00002298
nethercote71980f02004-01-24 18:18:54 +00002299 if (VG_(is_client_addr)(start) && VG_(is_client_addr)(start+size-1))
2300 VG_TRACK( new_mem_startup, start, size, rr=='r', ww=='w', xx=='x' );
sewardj3e1eb1f2002-05-18 13:14:17 +00002301
nethercote71980f02004-01-24 18:18:54 +00002302 /* If this is the stack segment mark all below %esp as noaccess. */
nethercote4ad74312004-10-26 09:59:49 +00002303 r_esp = sp_at_startup___global_arg;
nethercote71980f02004-01-24 18:18:54 +00002304 vg_assert(0 != r_esp);
2305 if (is_stack_segment) {
2306 if (0)
2307 VG_(message)(Vg_DebugMsg, "invalidating stack area: %x .. %x",
2308 start,r_esp);
2309 VG_TRACK( die_mem_stack, start, r_esp-start );
sewardjde4a1d02002-03-22 01:27:54 +00002310 }
sewardjde4a1d02002-03-22 01:27:54 +00002311}
2312
2313
nethercote71980f02004-01-24 18:18:54 +00002314/*====================================================================*/
2315/*=== Sanity check machinery (permanently engaged) ===*/
2316/*====================================================================*/
njn25e49d8e72002-09-23 09:36:25 +00002317
2318/* A fast sanity check -- suitable for calling circa once per
2319 millisecond. */
2320
nethercote885dd912004-08-03 23:14:00 +00002321void VG_(sanity_check_general) ( Bool force_expensive )
njn25e49d8e72002-09-23 09:36:25 +00002322{
njn37cea302002-09-30 11:24:00 +00002323 VGP_PUSHCC(VgpCoreCheapSanity);
2324
nethercote27fec902004-06-16 21:26:32 +00002325 if (VG_(clo_sanity_level) < 1) return;
njn25e49d8e72002-09-23 09:36:25 +00002326
2327 /* --- First do all the tests that we can do quickly. ---*/
2328
nethercote297effd2004-08-02 15:07:57 +00002329 sanity_fast_count++;
njn25e49d8e72002-09-23 09:36:25 +00002330
njn25e49d8e72002-09-23 09:36:25 +00002331 /* Check stuff pertaining to the memory check system. */
2332
2333 /* Check that nobody has spuriously claimed that the first or
2334 last 16 pages of memory have become accessible [...] */
njn37cea302002-09-30 11:24:00 +00002335 if (VG_(needs).sanity_checks) {
njn4be0a692004-11-22 18:10:36 +00002336 VGP_PUSHCC(VgpToolCheapSanity);
njn26f02512004-11-22 18:33:15 +00002337 vg_assert(TL_(cheap_sanity_check)());
njn4be0a692004-11-22 18:10:36 +00002338 VGP_POPCC(VgpToolCheapSanity);
njn37cea302002-09-30 11:24:00 +00002339 }
njn25e49d8e72002-09-23 09:36:25 +00002340
2341 /* --- Now some more expensive checks. ---*/
2342
2343 /* Once every 25 times, check some more expensive stuff. */
2344 if ( force_expensive
nethercote27fec902004-06-16 21:26:32 +00002345 || VG_(clo_sanity_level) > 1
nethercote297effd2004-08-02 15:07:57 +00002346 || (VG_(clo_sanity_level) == 1 && (sanity_fast_count % 25) == 0)) {
njn25e49d8e72002-09-23 09:36:25 +00002347
njn37cea302002-09-30 11:24:00 +00002348 VGP_PUSHCC(VgpCoreExpensiveSanity);
nethercote297effd2004-08-02 15:07:57 +00002349 sanity_slow_count++;
njn25e49d8e72002-09-23 09:36:25 +00002350
nethercote885dd912004-08-03 23:14:00 +00002351 VG_(sanity_check_proxy)();
jsgf855d93d2003-10-13 22:26:55 +00002352
njn25e49d8e72002-09-23 09:36:25 +00002353# if 0
2354 { void zzzmemscan(void); zzzmemscan(); }
2355# endif
2356
nethercote297effd2004-08-02 15:07:57 +00002357 if ((sanity_fast_count % 250) == 0)
sewardj4ccf7072004-11-28 16:58:05 +00002358 VG_(sanity_check_tt_tc)("VG_(sanity_check_general)");
njn25e49d8e72002-09-23 09:36:25 +00002359
2360 if (VG_(needs).sanity_checks) {
njn4be0a692004-11-22 18:10:36 +00002361 VGP_PUSHCC(VgpToolExpensiveSanity);
njn26f02512004-11-22 18:33:15 +00002362 vg_assert(TL_(expensive_sanity_check)());
njn4be0a692004-11-22 18:10:36 +00002363 VGP_POPCC(VgpToolExpensiveSanity);
njn25e49d8e72002-09-23 09:36:25 +00002364 }
2365 /*
nethercote297effd2004-08-02 15:07:57 +00002366 if ((sanity_fast_count % 500) == 0) VG_(mallocSanityCheckAll)();
njn25e49d8e72002-09-23 09:36:25 +00002367 */
njn37cea302002-09-30 11:24:00 +00002368 VGP_POPCC(VgpCoreExpensiveSanity);
njn25e49d8e72002-09-23 09:36:25 +00002369 }
2370
nethercote27fec902004-06-16 21:26:32 +00002371 if (VG_(clo_sanity_level) > 1) {
njn37cea302002-09-30 11:24:00 +00002372 VGP_PUSHCC(VgpCoreExpensiveSanity);
njn25e49d8e72002-09-23 09:36:25 +00002373 /* Check sanity of the low-level memory manager. Note that bugs
2374 in the client's code can cause this to fail, so we don't do
2375 this check unless specially asked for. And because it's
2376 potentially very expensive. */
nethercote885dd912004-08-03 23:14:00 +00002377 VG_(sanity_check_malloc_all)();
njn37cea302002-09-30 11:24:00 +00002378 VGP_POPCC(VgpCoreExpensiveSanity);
njn25e49d8e72002-09-23 09:36:25 +00002379 }
njn37cea302002-09-30 11:24:00 +00002380 VGP_POPCC(VgpCoreCheapSanity);
njn25e49d8e72002-09-23 09:36:25 +00002381}
nethercote71980f02004-01-24 18:18:54 +00002382
2383
2384/*====================================================================*/
2385/*=== main() ===*/
2386/*====================================================================*/
2387
nethercotec314eba2004-07-15 12:59:41 +00002388/*
2389 This code decides on the layout of the client and Valgrind address
nethercote996901a2004-08-03 13:29:09 +00002390 spaces, loads valgrind.so and the tool.so into the valgrind part,
nethercotec314eba2004-07-15 12:59:41 +00002391 loads the client executable (and the dynamic linker, if necessary)
2392 into the client part, and calls into Valgrind proper.
2393
2394 The code is careful not to allow spurious mappings to appear in the
2395 wrong parts of the address space. In particular, to make sure
2396 dlopen puts things in the right place, it will pad out the forbidden
2397 chunks of address space so that dlopen is forced to put things where
2398 we want them.
2399
2400 The memory map it creates is:
2401
2402 CLIENT_BASE +-------------------------+
2403 | client address space |
2404 : :
2405 : :
2406 | client stack |
2407 client_end +-------------------------+
2408 | redzone |
2409 shadow_base +-------------------------+
2410 | |
nethercote996901a2004-08-03 13:29:09 +00002411 : shadow memory for tools :
nethercotec314eba2004-07-15 12:59:41 +00002412 | (may be 0 sized) |
2413 shadow_end +-------------------------+
nethercotec314eba2004-07-15 12:59:41 +00002414 valgrind_base +-------------------------+
2415 | kickstart executable |
2416 | valgrind heap vvvvvvvvv| (barely used)
2417 - -
2418 | valgrind .so files |
2419 | and mappings |
2420 - -
2421 | valgrind stack ^^^^^^^^^|
nethercote820bd8c2004-09-07 23:04:49 +00002422 valgrind_last +-------------------------+
nethercotec314eba2004-07-15 12:59:41 +00002423 : kernel :
2424
2425 Nb: Before we can do general allocations with VG_(arena_malloc)() and
2426 VG_(mmap)(), we need to build the segment skip-list, so we know where
2427 we can put things. However, building that structure requires
2428 allocating memory. So we need to a bootstrapping process. It's done
2429 by making VG_(arena_malloc)() have a special static superblock that's
2430 used for the first 1MB's worth of allocations. This is enough to
2431 build the segment skip-list.
2432*/
2433
nethercote31779c72004-07-30 21:50:15 +00002434static int prmap(char *start, char *end, const char *perm, off_t off,
2435 int maj, int min, int ino, void* dummy) {
thughes4ad52d02004-06-27 17:37:21 +00002436 printf("mapping %10p-%10p %s %02x:%02x %d\n",
2437 start, end, perm, maj, min, ino);
2438 return True;
2439}
2440
nethercote71980f02004-01-24 18:18:54 +00002441int main(int argc, char **argv)
2442{
2443 char **cl_argv;
2444 const char *tool = NULL;
2445 const char *exec = NULL;
2446 char *preload; /* tool-specific LD_PRELOAD .so */
2447 char **env;
nethercote6c999f22004-01-31 22:55:15 +00002448 Int need_help = 0; // 0 = no, 1 = --help, 2 = --help-debug
nethercote71980f02004-01-24 18:18:54 +00002449 struct exeinfo info;
2450 ToolInfo *toolinfo = NULL;
2451 void *tool_dlhandle;
2452 Addr client_eip;
nethercote4ad74312004-10-26 09:59:49 +00002453 Addr sp_at_startup; /* client's SP at the point we gained control. */
nethercote71980f02004-01-24 18:18:54 +00002454 UInt * client_auxv;
2455 VgSchedReturnCode src;
nethercote47dd12c2004-06-22 14:18:42 +00002456 Int exitcode = 0;
nethercote238a3c32004-08-09 13:13:31 +00002457 Int fatal_sigNo = -1;
nethercote73b526f2004-10-31 18:48:21 +00002458 struct vki_rlimit zero = { 0, 0 };
nethercote31779c72004-07-30 21:50:15 +00002459 Int padfile;
nethercote759dda32004-08-07 18:16:56 +00002460 ThreadId last_run_tid = 0; // Last thread the scheduler ran.
2461
nethercote71980f02004-01-24 18:18:54 +00002462
2463 //============================================================
2464 // Nb: startup is complex. Prerequisites are shown at every step.
2465 //
2466 // *** Be very careful when messing with the order ***
2467 //============================================================
2468
nethercotef4928da2004-06-15 10:54:40 +00002469 //============================================================
2470 // Command line argument handling order:
2471 // * If --help/--help-debug are present, show usage message
2472 // (if --tool is also present, that includes the tool-specific usage)
2473 // * Then, if --tool is missing, abort with error msg
2474 // * Then, if client is missing, abort with error msg
2475 // * Then, if any cmdline args are bad, abort with error msg
2476 //============================================================
2477
fitzhardingeb50068f2004-02-24 23:42:55 +00002478 // Get the current process datasize rlimit, and set it to zero.
2479 // This prevents any internal uses of brk() from having any effect.
2480 // We remember the old value so we can restore it on exec, so that
2481 // child processes will have a reasonable brk value.
2482 VG_(getrlimit)(VKI_RLIMIT_DATA, &VG_(client_rlimit_data));
2483 zero.rlim_max = VG_(client_rlimit_data).rlim_max;
2484 VG_(setrlimit)(VKI_RLIMIT_DATA, &zero);
thughesc37184f2004-09-11 14:16:57 +00002485
2486 // Get the current process stack rlimit.
2487 VG_(getrlimit)(VKI_RLIMIT_STACK, &VG_(client_rlimit_stack));
2488
nethercote71980f02004-01-24 18:18:54 +00002489 //--------------------------------------------------------------
2490 // Check we were launched by stage1
sewardj51ac0872004-12-21 01:20:49 +00002491 // p: none
nethercote71980f02004-01-24 18:18:54 +00002492 //--------------------------------------------------------------
nethercotec25c4492004-10-18 11:52:17 +00002493 {
2494 void* init_sp = argv - 1;
2495 padfile = scan_auxv(init_sp);
2496 }
nethercote71980f02004-01-24 18:18:54 +00002497
2498 if (0) {
nethercote71980f02004-01-24 18:18:54 +00002499 printf("========== main() ==========\n");
nethercote31779c72004-07-30 21:50:15 +00002500 foreach_map(prmap, /*dummy*/NULL);
nethercote71980f02004-01-24 18:18:54 +00002501 }
2502
2503 //--------------------------------------------------------------
2504 // Look for alternative libdir
sewardj51ac0872004-12-21 01:20:49 +00002505 // p: none
nethercote71980f02004-01-24 18:18:54 +00002506 //--------------------------------------------------------------
sewardj51ac0872004-12-21 01:20:49 +00002507 { HChar *cp = getenv(VALGRINDLIB);
nethercote71980f02004-01-24 18:18:54 +00002508 if (cp != NULL)
2509 VG_(libdir) = cp;
2510 }
2511
2512 //--------------------------------------------------------------
nethercote71980f02004-01-24 18:18:54 +00002513 // Get valgrind args + client args (inc. from VALGRIND_OPTS/.valgrindrc).
2514 // Pre-process the command line.
sewardj51ac0872004-12-21 01:20:49 +00002515 // p: none
nethercote71980f02004-01-24 18:18:54 +00002516 //--------------------------------------------------------------
nethercotef6a1d502004-08-09 12:21:57 +00002517 get_command_line(argc, argv, &vg_argc, &vg_argv, &cl_argv);
nethercote71980f02004-01-24 18:18:54 +00002518 pre_process_cmd_line_options(&need_help, &tool, &exec);
2519
2520 //==============================================================
2521 // Nb: once a tool is specified, the tool.so must be loaded even if
2522 // they specified --help or didn't specify a client program.
2523 //==============================================================
2524
2525 //--------------------------------------------------------------
2526 // With client padded out, map in tool
nethercote71980f02004-01-24 18:18:54 +00002527 // p: set-libdir [for VG_(libdir)]
2528 // p: pre_process_cmd_line_options() [for 'tool']
2529 //--------------------------------------------------------------
2530 load_tool(tool, &tool_dlhandle, &toolinfo, &preload);
2531
2532 //==============================================================
2533 // Can use VG_(malloc)() and VG_(arena_malloc)() only after load_tool()
nethercotec314eba2004-07-15 12:59:41 +00002534 // -- redzone size is now set. This is checked by vg_malloc2.c.
nethercote71980f02004-01-24 18:18:54 +00002535 //==============================================================
2536
2537 //--------------------------------------------------------------
2538 // Finalise address space layout
nethercote31779c72004-07-30 21:50:15 +00002539 // p: load_tool() [for 'toolinfo']
nethercote71980f02004-01-24 18:18:54 +00002540 //--------------------------------------------------------------
nethercote31779c72004-07-30 21:50:15 +00002541 layout_remaining_space( (Addr) & argc, toolinfo->shadow_ratio );
nethercote71980f02004-01-24 18:18:54 +00002542
2543 //--------------------------------------------------------------
2544 // Load client executable, finding in $PATH if necessary
nethercote71980f02004-01-24 18:18:54 +00002545 // p: pre_process_cmd_line_options() [for 'exec', 'need_help']
2546 // p: layout_remaining_space [so there's space]
2547 //--------------------------------------------------------------
nethercotef4928da2004-06-15 10:54:40 +00002548 load_client(cl_argv, exec, need_help, &info, &client_eip);
nethercote71980f02004-01-24 18:18:54 +00002549
2550 //--------------------------------------------------------------
nethercote969ecf12004-10-13 17:29:01 +00002551 // Everything in place, remove padding done by stage1
nethercote71980f02004-01-24 18:18:54 +00002552 // p: layout_remaining_space() [everything must be mapped in before now]
2553 // p: load_client() [ditto]
2554 //--------------------------------------------------------------
nethercote31779c72004-07-30 21:50:15 +00002555 as_unpad((void *)VG_(shadow_end), (void *)~0, padfile);
2556 as_closepadfile(padfile); // no more padding
nethercote71980f02004-01-24 18:18:54 +00002557
2558 //--------------------------------------------------------------
2559 // Set up client's environment
2560 // p: set-libdir [for VG_(libdir)]
2561 // p: load_tool() [for 'preload']
2562 //--------------------------------------------------------------
2563 env = fix_environment(environ, preload);
2564
2565 //--------------------------------------------------------------
nethercote5ee67ca2004-06-22 14:00:09 +00002566 // Setup client stack, eip, and VG_(client_arg[cv])
nethercote71980f02004-01-24 18:18:54 +00002567 // p: load_client() [for 'info']
2568 // p: fix_environment() [for 'env']
2569 //--------------------------------------------------------------
nethercotec25c4492004-10-18 11:52:17 +00002570 {
2571 void* init_sp = argv - 1;
nethercote4ad74312004-10-26 09:59:49 +00002572 sp_at_startup = setup_client_stack(init_sp, cl_argv, env, &info,
2573 &client_auxv);
nethercotec25c4492004-10-18 11:52:17 +00002574 }
nethercote71980f02004-01-24 18:18:54 +00002575
2576 if (0)
nethercote6a27d832004-09-07 10:17:02 +00002577 printf("entry=%p client esp=%p vg_argc=%d brkbase=%p\n",
nethercote4ad74312004-10-26 09:59:49 +00002578 (void*)client_eip, (void*)sp_at_startup, vg_argc,
nethercote6a27d832004-09-07 10:17:02 +00002579 (void*)VG_(brk_base));
nethercote71980f02004-01-24 18:18:54 +00002580
2581 //==============================================================
2582 // Finished setting up operating environment. Now initialise
2583 // Valgrind. (This is where the old VG_(main)() started.)
2584 //==============================================================
2585
2586 //--------------------------------------------------------------
nethercote71980f02004-01-24 18:18:54 +00002587 // atfork
2588 // p: n/a
2589 //--------------------------------------------------------------
2590 VG_(atfork)(NULL, NULL, newpid);
2591 newpid(VG_INVALID_THREADID);
2592
2593 //--------------------------------------------------------------
2594 // setup file descriptors
2595 // p: n/a
2596 //--------------------------------------------------------------
2597 setup_file_descriptors();
2598
2599 //--------------------------------------------------------------
nethercotec314eba2004-07-15 12:59:41 +00002600 // Read /proc/self/maps into a buffer
2601 // p: all memory layout, environment setup [so memory maps are right]
2602 //--------------------------------------------------------------
2603 VG_(read_procselfmaps)();
2604
2605 //--------------------------------------------------------------
2606 // Build segment map (Valgrind segments only)
2607 // p: read proc/self/maps
njnd2252832004-11-26 10:53:33 +00002608 // p: tl_pre_clo_init() [to setup new_mem_startup tracker]
nethercotec314eba2004-07-15 12:59:41 +00002609 //--------------------------------------------------------------
2610 VG_(parse_procselfmaps) ( build_valgrind_map_callback );
2611
2612 //==============================================================
2613 // Can use VG_(arena_malloc)() with non-CORE arena after segments set up
2614 //==============================================================
2615
2616 //--------------------------------------------------------------
2617 // Init tool: pre_clo_init, process cmd line, post_clo_init
2618 // p: setup_client_stack() [for 'VG_(client_arg[cv]']
2619 // p: load_tool() [for 'tool']
2620 // p: setup_file_descriptors() [for 'VG_(fd_xxx_limit)']
2621 // p: parse_procselfmaps [so VG segments are setup so tool can
2622 // call VG_(malloc)]
nethercote71980f02004-01-24 18:18:54 +00002623 //--------------------------------------------------------------
njnd2252832004-11-26 10:53:33 +00002624 (*toolinfo->tl_pre_clo_init)();
nethercote71980f02004-01-24 18:18:54 +00002625 VG_(tool_init_dlsym)(tool_dlhandle);
2626 VG_(sanity_check_needs)();
2627
nethercotef4928da2004-06-15 10:54:40 +00002628 // If --tool and --help/--help-debug was given, now give the core+tool
2629 // help message
nethercotef4928da2004-06-15 10:54:40 +00002630 if (need_help) {
2631 usage(/*--help-debug?*/2 == need_help);
2632 }
nethercotec314eba2004-07-15 12:59:41 +00002633 process_cmd_line_options(client_auxv, tool);
2634
njn26f02512004-11-22 18:33:15 +00002635 TL_(post_clo_init)();
nethercotef4928da2004-06-15 10:54:40 +00002636
2637 //--------------------------------------------------------------
sewardj51ac0872004-12-21 01:20:49 +00002638 // Determine CPU architecture and subarchitecture
2639 // p: none
2640 //--------------------------------------------------------------
2641 { Bool ok = VGA_(getArchAndSubArch)(
2642 & VG_(vex_arch), & VG_(vex_subarch) );
2643 if (!ok) {
sewardj0b2f6182004-12-31 18:10:17 +00002644 VG_(printf)("\n");
sewardj51ac0872004-12-21 01:20:49 +00002645 VG_(printf)("valgrind: fatal error: unsupported CPU.\n");
sewardj0b2f6182004-12-31 18:10:17 +00002646 VG_(printf)(" Supported CPUs are:\n");
2647 VG_(printf)(" * x86 with SSE state (Pentium II or above, "
2648 "AMD Athlon or above)\n");
2649 VG_(printf)("\n");
sewardj51ac0872004-12-21 01:20:49 +00002650 VG_(exit)(1);
2651 }
2652 if (VG_(clo_verbosity) > 2) {
2653 VG_(message)(Vg_DebugMsg,
2654 "Host CPU: arch = %s, subarch = %s",
2655 LibVEX_ppVexArch( VG_(vex_arch) ),
2656 LibVEX_ppVexSubArch( VG_(vex_subarch) ) );
2657 }
2658 }
2659
2660 //--------------------------------------------------------------
nethercotec314eba2004-07-15 12:59:41 +00002661 // Build segment map (all segments)
nethercote4ad74312004-10-26 09:59:49 +00002662 // p: setup_client_stack() [for 'sp_at_startup']
nethercotec314eba2004-07-15 12:59:41 +00002663 // p: init tool [for 'new_mem_startup']
nethercote71980f02004-01-24 18:18:54 +00002664 //--------------------------------------------------------------
nethercote4ad74312004-10-26 09:59:49 +00002665 sp_at_startup___global_arg = sp_at_startup;
nethercotec314eba2004-07-15 12:59:41 +00002666 VG_(parse_procselfmaps) ( build_segment_map_callback ); /* everything */
nethercote4ad74312004-10-26 09:59:49 +00002667 sp_at_startup___global_arg = 0;
nethercotec314eba2004-07-15 12:59:41 +00002668
njnca0518d2004-11-26 19:34:36 +00002669#ifdef __i386__
nethercotec314eba2004-07-15 12:59:41 +00002670 //--------------------------------------------------------------
nethercotef84f6952004-07-15 14:58:33 +00002671 // Protect client trampoline page (which is also sysinfo stuff)
2672 // p: segment stuff [otherwise get seg faults...]
nethercotec314eba2004-07-15 12:59:41 +00002673 //--------------------------------------------------------------
nethercotec314eba2004-07-15 12:59:41 +00002674 VG_(mprotect)( (void *)VG_(client_trampoline_code),
2675 VG_(trampoline_code_length), VKI_PROT_READ|VKI_PROT_EXEC );
njnca0518d2004-11-26 19:34:36 +00002676#endif
nethercotec314eba2004-07-15 12:59:41 +00002677
2678 //==============================================================
2679 // Can use VG_(map)() after segments set up
2680 //==============================================================
nethercote71980f02004-01-24 18:18:54 +00002681
2682 //--------------------------------------------------------------
2683 // Allow GDB attach
2684 // p: process_cmd_line_options() [for VG_(clo_wait_for_gdb)]
2685 //--------------------------------------------------------------
2686 /* Hook to delay things long enough so we can get the pid and
2687 attach GDB in another shell. */
2688 if (VG_(clo_wait_for_gdb)) {
2689 VG_(printf)("pid=%d\n", VG_(getpid)());
2690 /* do "jump *$eip" to skip this in gdb */
njnca6fef02004-11-29 16:49:18 +00002691 VG_(do_syscall0)(__NR_pause);
nethercote71980f02004-01-24 18:18:54 +00002692 }
2693
2694 //--------------------------------------------------------------
nethercote71980f02004-01-24 18:18:54 +00002695 // Search for file descriptors that are inherited from our parent
2696 // p: process_cmd_line_options [for VG_(clo_track_fds)]
2697 //--------------------------------------------------------------
2698 if (VG_(clo_track_fds))
2699 VG_(init_preopened_fds)();
2700
2701 //--------------------------------------------------------------
2702 // Initialise the scheduler
nethercote71980f02004-01-24 18:18:54 +00002703 // p: setup_file_descriptors() [else VG_(safe_fd)() breaks]
2704 //--------------------------------------------------------------
2705 VG_(scheduler_init)();
2706
2707 //--------------------------------------------------------------
sewardj2a99cf62004-11-24 10:44:19 +00002708 // Set up state of thread 1
2709 // p: {pre,post}_clo_init() [for tool helper registration]
2710 // load_client() [for 'client_eip']
2711 // setup_client_stack() [for 'sp_at_startup']
2712 // setup_scheduler() [for the rest of state 1 stuff]
2713 //--------------------------------------------------------------
2714 VGA_(init_thread1state)(client_eip, sp_at_startup, &VG_(threads)[1].arch );
njnea4b28c2004-11-30 16:04:58 +00002715
2716 // Tell the tool that we just wrote to the registers.
2717 VG_TRACK( post_reg_write, Vg_CoreStartup, /*tid*/1, /*offset*/0,
2718 sizeof(VexGuestArchState));
2719
2720 // Record the instr ptr offset, for use by asm code.
njn16de5572004-11-27 14:27:21 +00002721 VG_(instr_ptr_offset) = offsetof(VexGuestArchState, ARCH_INSTR_PTR);
sewardj2a99cf62004-11-24 10:44:19 +00002722
2723 //--------------------------------------------------------------
nethercote71980f02004-01-24 18:18:54 +00002724 // Set up the ProxyLWP machinery
2725 // p: VG_(scheduler_init)()? [XXX: subtle dependency?]
nethercote71980f02004-01-24 18:18:54 +00002726 //--------------------------------------------------------------
2727 VG_(proxy_init)();
2728
2729 //--------------------------------------------------------------
2730 // Initialise the signal handling subsystem
2731 // p: VG_(atfork)(NULL, NULL, newpid) [else problems with sigmasks]
2732 // p: VG_(proxy_init)() [else breaks...]
2733 //--------------------------------------------------------------
2734 // Nb: temporarily parks the saved blocking-mask in saved_sigmask.
2735 VG_(sigstartup_actions)();
2736
2737 //--------------------------------------------------------------
2738 // Perhaps we're profiling Valgrind?
2739 // p: process_cmd_line_options() [for VG_(clo_profile)]
2740 // p: others?
2741 //
2742 // XXX: this seems to be broken? It always says the tool wasn't built
2743 // for profiling; vg_profile.c's functions don't seem to be overriding
2744 // vg_dummy_profile.c's?
2745 //
2746 // XXX: want this as early as possible. Looking for --profile
2747 // in pre_process_cmd_line_options() could get it earlier.
2748 //--------------------------------------------------------------
2749 if (VG_(clo_profile))
2750 VGP_(init_profiling)();
2751
2752 VGP_PUSHCC(VgpStartup);
2753
2754 //--------------------------------------------------------------
nethercote71980f02004-01-24 18:18:54 +00002755 // Read suppression file
2756 // p: process_cmd_line_options() [for VG_(clo_suppressions)]
2757 //--------------------------------------------------------------
njn95ec8702004-11-22 16:46:13 +00002758 if (VG_(needs).core_errors || VG_(needs).tool_errors)
nethercote71980f02004-01-24 18:18:54 +00002759 VG_(load_suppressions)();
2760
2761 //--------------------------------------------------------------
nethercote71980f02004-01-24 18:18:54 +00002762 // Initialise translation table and translation cache
2763 // p: read_procselfmaps [so the anonymous mmaps for the TT/TC
2764 // aren't identified as part of the client, which would waste
2765 // > 20M of virtual address space.]
2766 //--------------------------------------------------------------
2767 VG_(init_tt_tc)();
2768
2769 //--------------------------------------------------------------
2770 // Read debug info to find glibc entry points to intercept
2771 // p: parse_procselfmaps? [XXX for debug info?]
2772 // p: init_tt_tc? [XXX ???]
2773 //--------------------------------------------------------------
2774 VG_(setup_code_redirect_table)();
2775
2776 //--------------------------------------------------------------
2777 // Verbosity message
2778 // p: end_rdtsc_calibration [so startup message is printed first]
2779 //--------------------------------------------------------------
2780 if (VG_(clo_verbosity) == 1)
2781 VG_(message)(Vg_UserMsg, "For more details, rerun with: -v");
2782 if (VG_(clo_verbosity) > 0)
2783 VG_(message)(Vg_UserMsg, "");
2784
2785 //--------------------------------------------------------------
2786 // Setup pointercheck
2787 // p: process_cmd_line_options() [for VG_(clo_pointercheck)]
2788 //--------------------------------------------------------------
nethercote775508a2004-09-07 22:38:23 +00002789 if (VG_(clo_pointercheck))
2790 VG_(clo_pointercheck) = VGA_(setup_pointercheck)();
nethercote71980f02004-01-24 18:18:54 +00002791
nethercote71980f02004-01-24 18:18:54 +00002792 //--------------------------------------------------------------
2793 // Run!
2794 //--------------------------------------------------------------
nethercote71980f02004-01-24 18:18:54 +00002795 VGP_POPCC(VgpStartup);
2796 VGP_PUSHCC(VgpSched);
2797
nethercote238a3c32004-08-09 13:13:31 +00002798 src = VG_(scheduler)( &exitcode, &last_run_tid, &fatal_sigNo );
nethercote71980f02004-01-24 18:18:54 +00002799
nethercote238a3c32004-08-09 13:13:31 +00002800 VGP_POPCC(VgpSched);
nethercote71980f02004-01-24 18:18:54 +00002801
nethercote71980f02004-01-24 18:18:54 +00002802 //--------------------------------------------------------------
2803 // Finalisation: cleanup, messages, etc. Order no so important, only
2804 // affects what order the messages come.
2805 //--------------------------------------------------------------
2806 if (VG_(clo_verbosity) > 0)
2807 VG_(message)(Vg_UserMsg, "");
2808
2809 if (src == VgSrc_Deadlock) {
2810 VG_(message)(Vg_UserMsg,
2811 "Warning: pthread scheduler exited due to deadlock");
2812 }
2813
2814 /* Print out file descriptor summary and stats. */
2815 if (VG_(clo_track_fds))
nethercote3a42fb82004-08-03 18:08:50 +00002816 VG_(show_open_fds)();
nethercote71980f02004-01-24 18:18:54 +00002817
njn95ec8702004-11-22 16:46:13 +00002818 if (VG_(needs).core_errors || VG_(needs).tool_errors)
nethercote71980f02004-01-24 18:18:54 +00002819 VG_(show_all_errors)();
2820
njn26f02512004-11-22 18:33:15 +00002821 TL_(fini)( exitcode );
nethercote71980f02004-01-24 18:18:54 +00002822
nethercote885dd912004-08-03 23:14:00 +00002823 VG_(sanity_check_general)( True /*include expensive checks*/ );
nethercote71980f02004-01-24 18:18:54 +00002824
2825 if (VG_(clo_verbosity) > 1)
nethercote3a42fb82004-08-03 18:08:50 +00002826 print_all_stats();
nethercote71980f02004-01-24 18:18:54 +00002827
nethercote71980f02004-01-24 18:18:54 +00002828 if (VG_(clo_profile))
2829 VGP_(done_profiling)();
2830
sewardjfa8ec112005-01-19 11:55:34 +00002831 if (VG_(clo_profile_flags) > 0)
2832 VG_(show_BB_profile)();
2833
nethercote71980f02004-01-24 18:18:54 +00002834 /* We're exiting, so nuke all the threads and clean up the proxy LWPs */
2835 vg_assert(src == VgSrc_FatalSig ||
nethercote759dda32004-08-07 18:16:56 +00002836 VG_(threads)[last_run_tid].status == VgTs_Runnable ||
2837 VG_(threads)[last_run_tid].status == VgTs_WaitJoiner);
nethercote71980f02004-01-24 18:18:54 +00002838 VG_(nuke_all_threads_except)(VG_INVALID_THREADID);
2839
sewardj8b635a42004-11-22 19:01:47 +00002840 /* Print Vex storage stats */
sewardjbf426512005-01-17 18:35:30 +00002841 if (0)
2842 LibVEX_ShowAllocStats();
sewardj8b635a42004-11-22 19:01:47 +00002843
nethercote71980f02004-01-24 18:18:54 +00002844 //--------------------------------------------------------------
2845 // Exit, according to the scheduler's return code
2846 //--------------------------------------------------------------
2847 switch (src) {
2848 case VgSrc_ExitSyscall: /* the normal way out */
nethercote759dda32004-08-07 18:16:56 +00002849 vg_assert(last_run_tid > 0 && last_run_tid < VG_N_THREADS);
nethercote71980f02004-01-24 18:18:54 +00002850 VG_(proxy_shutdown)();
2851
2852 /* The thread's %EBX at the time it did __NR_exit() will hold
2853 the arg to __NR_exit(), so we just do __NR_exit() with
2854 that arg. */
nethercote47dd12c2004-06-22 14:18:42 +00002855 VG_(exit)( exitcode );
nethercote71980f02004-01-24 18:18:54 +00002856 /* NOT ALIVE HERE! */
2857 VG_(core_panic)("entered the afterlife in main() -- ExitSyscall");
2858 break; /* what the hell :) */
2859
2860 case VgSrc_Deadlock:
2861 /* Just exit now. No point in continuing. */
2862 VG_(proxy_shutdown)();
2863 VG_(exit)(0);
2864 VG_(core_panic)("entered the afterlife in main() -- Deadlock");
2865 break;
2866
nethercote71980f02004-01-24 18:18:54 +00002867 case VgSrc_FatalSig:
2868 /* We were killed by a fatal signal, so replicate the effect */
nethercote238a3c32004-08-09 13:13:31 +00002869 vg_assert(fatal_sigNo != -1);
2870 VG_(kill_self)(fatal_sigNo);
nethercote71980f02004-01-24 18:18:54 +00002871 VG_(core_panic)("main(): signal was supposed to be fatal");
2872 break;
2873
2874 default:
2875 VG_(core_panic)("main(): unexpected scheduler return code");
2876 }
2877
2878 abort();
2879}
2880
2881
sewardjde4a1d02002-03-22 01:27:54 +00002882/*--------------------------------------------------------------------*/
2883/*--- end vg_main.c ---*/
2884/*--------------------------------------------------------------------*/