core: Pass stack change user requests on to tools
[valgrind.git] / include / pub_tool_clientstate.h
blob556ab03dd5dbba517ffcdfe563dd142bfb38b133
2 /*--------------------------------------------------------------------*/
3 /*--- Misc client state info pub_tool_clientstate.h ---*/
4 /*--------------------------------------------------------------------*/
6 /*
7 This file is part of Valgrind, a dynamic binary instrumentation
8 framework.
10 Copyright (C) 2000-2017 Julian Seward
11 jseward@acm.org
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.
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.
23 You should have received a copy of the GNU General Public License
24 along with this program; if not, see <http://www.gnu.org/licenses/>.
26 The GNU General Public License is contained in the file COPYING.
29 #ifndef __PUB_TOOL_CLIENTSTATE_H
30 #define __PUB_TOOL_CLIENTSTATE_H
32 #include "pub_tool_basics.h" // VG_ macro
33 #include "pub_tool_xarray.h" // XArray
35 /* Note, this header requires pub_{core,tool}_xarray.h to be
36 included ahead of it. */
38 // Command line pieces, after they have been extracted from argv in
39 // m_main.main(). These are all NULL-terminated vectors.
41 /* Args for the client. */
42 extern XArray* /* of HChar* */ VG_(args_for_client);
44 /* Args for V. This is the concatenation of the following:
45 - contents of ~/.valgrindrc
46 - contents of $VALGRIND_OPTS
47 - contents of ./.valgrindrc
48 - args from the command line
49 in the stated order.
51 Only the last of these is passed onwards to child Valgrinds at
52 client sys_execve, since the children will re-acquire the first 3
53 categories for themselves. Therefore we also record the number of
54 these no-pass-at-execve arguments -- that is what
55 VG_(args_for_valgrind_noexecpass) is. */
56 extern XArray* /* of HChar* */ VG_(args_for_valgrind);
58 /* Number of leading args in VG_(args_for_valgrind) not to pass on at
59 exec time. */
60 extern Int VG_(args_for_valgrind_noexecpass);
62 /* The name of the client executable, as specified on the command
63 line. */
64 extern const HChar* VG_(args_the_exename);
67 #endif // __PUB_TOOL_CLIENTSTATE_H
69 /*--------------------------------------------------------------------*/
70 /*--- end ---*/
71 /*--------------------------------------------------------------------*/