1
2/*--------------------------------------------------------------------*/
3/*--- Command line options.                     pub_tool_options.h ---*/
4/*--------------------------------------------------------------------*/
5
6/*
7   This file is part of Valgrind, a dynamic binary instrumentation
8   framework.
9
10   Copyright (C) 2000-2012 Julian Seward
11      jseward@acm.org
12
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
28   The GNU General Public License is contained in the file COPYING.
29*/
30
31#ifndef __PUB_TOOL_OPTIONS_H
32#define __PUB_TOOL_OPTIONS_H
33
34#include "libvex.h"              // for VexControl
35
36
37// Higher-level command-line option recognisers;  use in if/else chains.
38// Note that they assign a value to the 'qq_var' argument.  So often they
39// can be used like this:
40//
41//   if VG_STR_CLO(arg, "--foo", clo_foo) { }
42//
43// But if you want to do further checking or processing, you can do this:
44//
45//   if VG_STR_CLO(arg, "--foo", clo_foo) { <further checking or processing> }
46//
47// They use GNU statement expressions to do the qq_var assignment within a
48// conditional expression.
49
50// String argument, eg. --foo=yes or --foo=no
51#define VG_BOOL_CLO(qq_arg, qq_option, qq_var) \
52   (VG_STREQN(VG_(strlen)(qq_option)+1, qq_arg, qq_option"=") && \
53    ({ \
54      Char* val = &(qq_arg)[ VG_(strlen)(qq_option)+1 ]; \
55      if      VG_STREQ(val, "yes") (qq_var) = True; \
56      else if VG_STREQ(val, "no")  (qq_var) = False; \
57      else VG_(fmsg_bad_option)(qq_arg, "Invalid boolean value '%s'" \
58                                " (should be 'yes' or 'no')\n", val);    \
59      True; \
60    }) \
61   )
62
63// String argument, eg. --foo=bar
64#define VG_STR_CLO(qq_arg, qq_option, qq_var) \
65   (VG_STREQN(VG_(strlen)(qq_option)+1, qq_arg, qq_option"=") && \
66    ({ \
67      Char* val = &(qq_arg)[ VG_(strlen)(qq_option)+1 ]; \
68      (qq_var) = val; \
69      True; \
70    }) \
71   )
72
73// Unbounded integer arg, eg. --foo=10
74#define VG_INT_CLO(qq_arg, qq_option, qq_var) \
75   (VG_STREQN(VG_(strlen)(qq_option)+1, qq_arg, qq_option"=") && \
76    ({ \
77      Char* val = &(qq_arg)[ VG_(strlen)(qq_option)+1 ]; \
78      Char* s; \
79      Long n = VG_(strtoll10)( val, &s ); \
80      (qq_var) = n; \
81      /* Check for non-numeralness, or overflow. */ \
82      if ('\0' != s[0] || (qq_var) != n) VG_(fmsg_bad_option)(qq_arg, ""); \
83      True; \
84     }) \
85    )
86
87// Bounded integer arg, eg. --foo=10 ;  if the value exceeds the bounds it
88// causes an abort.  'qq_base' can be 10 or 16.
89#define VG_BINTN_CLO(qq_base, qq_arg, qq_option, qq_var, qq_lo, qq_hi) \
90   (VG_STREQN(VG_(strlen)(qq_option)+1, qq_arg, qq_option"=") && \
91    ({ \
92      Char* val = &(qq_arg)[ VG_(strlen)(qq_option)+1 ]; \
93      Char* s; \
94      Long n = VG_(strtoll##qq_base)( val, &s ); \
95      (qq_var) = n; \
96      /* MMM: separate the two cases, and explain the problem;  likewise */ \
97      /* for all the other macros in this file. */ \
98      /* Check for non-numeralness, or overflow. */ \
99      /* Nb: it will overflow if qq_var is unsigned and qq_val is negative! */ \
100      if ('\0' != s[0] || (qq_var) != n) VG_(fmsg_bad_option)(qq_arg, ""); \
101      /* Check bounds. */ \
102      if ((qq_var) < (qq_lo) || (qq_var) > (qq_hi)) { \
103         VG_(fmsg_bad_option)(qq_arg, \
104            "'%s' argument must be between %lld and %lld\n", \
105            (qq_option), (Long)(qq_lo), (Long)(qq_hi)); \
106      } \
107      True; \
108     }) \
109    )
110
111// Bounded decimal integer arg, eg. --foo=100
112#define VG_BINT_CLO(qq_arg, qq_option, qq_var, qq_lo, qq_hi) \
113   VG_BINTN_CLO(10, (qq_arg), qq_option, (qq_var), (qq_lo), (qq_hi))
114
115// Bounded hexadecimal integer arg, eg. --foo=0x1fa8
116#define VG_BHEX_CLO(qq_arg, qq_option, qq_var, qq_lo, qq_hi) \
117   VG_BINTN_CLO(16, (qq_arg), qq_option, (qq_var), (qq_lo), (qq_hi))
118
119// Double (decimal) arg, eg. --foo=4.6
120// XXX: there's not VG_BDBL_CLO because we don't have a good way of printing
121// floats at the moment!
122#define VG_DBL_CLO(qq_arg, qq_option, qq_var) \
123   (VG_STREQN(VG_(strlen)(qq_option)+1, qq_arg, qq_option"=") && \
124    ({ \
125      Char* val = &(qq_arg)[ VG_(strlen)(qq_option)+1 ]; \
126      Char* s; \
127      double n = VG_(strtod)( val, &s ); \
128      (qq_var) = n; \
129      /* Check for non-numeralness */ \
130      if ('\0' != s[0]) VG_(fmsg_bad_option)(qq_arg, ""); \
131      True; \
132     }) \
133    )
134
135// Arg whose value is denoted by the exact presence of the given string;
136// if it matches, qq_var is assigned the value in qq_val.
137#define VG_XACT_CLO(qq_arg, qq_option, qq_var, qq_val) \
138   (VG_STREQ((qq_arg), (qq_option)) && \
139    ({ \
140      (qq_var) = (qq_val); \
141      True; \
142    }) \
143   )
144
145/* Verbosity level: 0 = silent, 1 (default), > 1 = more verbose. */
146extern Int  VG_(clo_verbosity);
147
148/* Show tool and core statistics */
149extern Bool VG_(clo_stats);
150
151/* wait for vgdb/gdb after reporting that amount of error.
152   Note that this is the initial value provided from the command line.
153   The real value is maintained in VG_(dyn_vgdb_error) and
154   can be changed dynamically.*/
155extern Int VG_(clo_vgdb_error);
156
157/* Emit all messages as XML? default: NO */
158/* If clo_xml is set, various other options are set in a non-default
159   way.  See vg_main.c and mc_main.c. */
160extern Bool VG_(clo_xml);
161
162/* An arbitrary user-supplied string which is copied into the
163   XML output, in between <usercomment> tags. */
164extern HChar* VG_(clo_xml_user_comment);
165
166/* Vex iropt control.  Tool-visible so tools can make Vex optimise
167   less aggressively if that is needed (callgrind needs this). */
168extern VexControl VG_(clo_vex_control);
169
170/* Number of parents of a backtrace.  Default: 8.  */
171extern Int   VG_(clo_backtrace_size);
172
173/* Continue stack traces below main()?  Default: NO */
174extern Bool VG_(clo_show_below_main);
175
176
177/* Used to expand file names.  "option_name" is the option name, eg.
178   "--log-file".  'format' is what follows, eg. "cachegrind.out.%p".  In
179   'format':
180   - "%p" is replaced with PID.
181   - "%q{QUAL}" is replaced with the environment variable $QUAL.  If $QUAL
182     isn't set, we abort.  If the "{QUAL}" part is malformed, we abort.
183   - "%%" is replaced with "%".
184   Anything else after '%' causes an abort.
185   If the format specifies a relative file name, it's put in the program's
186   initial working directory.  If it specifies an absolute file name (ie.
187   starts with '/') then it is put there.
188
189   Note that "option_name" has no effect on the returned string: the
190   returned string depends only on "format" and the PIDs and
191   environment variables that it references (if any). "option_name" is
192   merely used in printing error messages, if an error message needs
193   to be printed due to malformedness of the "format" argument.
194*/
195extern Char* VG_(expand_file_name)(Char* option_name, Char* format);
196
197#endif   // __PUB_TOOL_OPTIONS_H
198
199/*--------------------------------------------------------------------*/
200/*--- end                                                          ---*/
201/*--------------------------------------------------------------------*/
202