gcc/opts.h

   1 /* Command line option handling.
   2    Copyright (C) 2002-2017 Free Software Foundation, Inc.
   3
   4 This file is part of GCC.
   5
   6 GCC is free software; you can redistribute it and/or modify it under
   7 the terms of the GNU General Public License as published by the Free
   8 Software Foundation; either version 3, or (at your option) any later
   9 version.
  10
  11 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
  12 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14 for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GCC; see the file COPYING3.  If not see
  18 <http://www.gnu.org/licenses/>.  */
  19
  20 #ifndef GCC_OPTS_H
  21 #define GCC_OPTS_H
  22
  23 #include "obstack.h"
  24
  25 /* Specifies how a switch's VAR_VALUE relates to its FLAG_VAR.  */
  26 enum cl_var_type {
  27   /* The switch is enabled when FLAG_VAR is nonzero.  */
  28   CLVC_BOOLEAN,
  29
  30   /* The switch is enabled when FLAG_VAR == VAR_VALUE.  */
  31   CLVC_EQUAL,
  32
  33   /* The switch is enabled when VAR_VALUE is not set in FLAG_VAR.  */
  34   CLVC_BIT_CLEAR,
  35
  36   /* The switch is enabled when VAR_VALUE is set in FLAG_VAR.  */
  37   CLVC_BIT_SET,
  38
  39   /* The switch takes a string argument and FLAG_VAR points to that
  40      argument.  */
  41   CLVC_STRING,
  42
  43   /* The switch takes an enumerated argument (VAR_ENUM says what
  44      enumeration) and FLAG_VAR points to that argument.  */
  45   CLVC_ENUM,
  46
  47   /* The switch should be stored in the VEC pointed to by FLAG_VAR for
  48      later processing.  */
  49   CLVC_DEFER
  50 };
  51
  52 struct cl_option
  53 {
  54   /* Text of the option, including initial '-'.  */
  55   const char *opt_text;
  56   /* Help text for --help, or NULL.  */
  57   const char *help;
  58   /* Error message for missing argument, or NULL.  */
  59   const char *missing_argument_error;
  60   /* Warning to give when this option is used, or NULL.  */
  61   const char *warn_message;
  62   /* Argument of alias target when positive option given, or NULL.  */
  63   const char *alias_arg;
  64   /* Argument of alias target when negative option given, or NULL.  */
  65   const char *neg_alias_arg;
  66   /* Alias target, or N_OPTS if not an alias.  */
  67   unsigned short alias_target;
  68   /* Previous option that is an initial substring of this one, or
  69      N_OPTS if none.  */
  70   unsigned short back_chain;
  71   /* Option length, not including initial '-'.  */
  72   unsigned char opt_len;
  73   /* Next option in a sequence marked with Negative, or -1 if none.  */
  74   int neg_index;
  75   /* CL_* flags for this option.  */
  76   unsigned int flags;
  77   /* Disabled in this configuration.  */
  78   BOOL_BITFIELD cl_disabled : 1;
  79   /* Options marked with CL_SEPARATE take a number of separate
  80      arguments (1 to 4) that is one more than the number in this
  81      bit-field.  */
  82   unsigned int cl_separate_nargs : 2;
  83   /* Option is an alias when used with separate argument.  */
  84   BOOL_BITFIELD cl_separate_alias : 1;
  85   /* Alias to negative form of option.  */
  86   BOOL_BITFIELD cl_negative_alias : 1;
  87   /* Option takes no argument in the driver.  */
  88   BOOL_BITFIELD cl_no_driver_arg : 1;
  89   /* Reject this option in the driver.  */
  90   BOOL_BITFIELD cl_reject_driver : 1;
  91   /* Reject no- form.  */
  92   BOOL_BITFIELD cl_reject_negative : 1;
  93   /* Missing argument OK (joined).  */
  94   BOOL_BITFIELD cl_missing_ok : 1;
  95   /* Argument is an integer >=0.  */
  96   BOOL_BITFIELD cl_uinteger : 1;
  97   /* Argument is a HOST_WIDE_INT.  */
  98   BOOL_BITFIELD cl_host_wide_int : 1;
  99   /* Argument should be converted to lowercase.  */
 100   BOOL_BITFIELD cl_tolower : 1;
 101   /* Report argument with -fverbose-asm  */
 102   BOOL_BITFIELD cl_report : 1;
 103   /* Offset of field for this option in struct gcc_options, or
 104      (unsigned short) -1 if none.  */
 105   unsigned short flag_var_offset;
 106   /* Index in cl_enums of enum used for this option's arguments, for
 107      CLVC_ENUM options.  */
 108   unsigned short var_enum;
 109   /* How this option's value is determined and sets a field.  */
 110   enum cl_var_type var_type;
 111   /* Value or bit-mask with which to set a field.  */
 112   HOST_WIDE_INT var_value;
 113   /* Range info minimum, or -1.  */
 114   int range_min;
 115   /* Range info maximum, or -1.  */
 116   int range_max;
 117 };
 118
 119 /* Records that the state of an option consists of SIZE bytes starting
 120    at DATA.  DATA might point to CH in some cases.  */
 121 struct cl_option_state {
 122   const void *data;
 123   size_t size;
 124   char ch;
 125 };
 126
 127 extern const struct cl_option cl_options[];
 128 extern const unsigned int cl_options_count;
 129 extern const char *const lang_names[];
 130 extern const unsigned int cl_lang_count;
 131
 132 #define CL_PARAMS               (1U << 16) /* Fake entry.  Used to display --param info with --help.  */
 133 #define CL_WARNING              (1U << 17) /* Enables an (optional) warning message.  */
 134 #define CL_OPTIMIZATION         (1U << 18) /* Enables an (optional) optimization.  */
 135 #define CL_DRIVER               (1U << 19) /* Driver option.  */
 136 #define CL_TARGET               (1U << 20) /* Target-specific option.  */
 137 #define CL_COMMON               (1U << 21) /* Language-independent.  */
 138
 139 #define CL_MIN_OPTION_CLASS     CL_PARAMS
 140 #define CL_MAX_OPTION_CLASS     CL_COMMON
 141
 142 /* From here on the bits describe attributes of the options.
 143    Before this point the bits have described the class of the option.
 144    This distinction is important because --help will not list options
 145    which only have these higher bits set.  */
 146
 147 #define CL_JOINED               (1U << 22) /* If takes joined argument.  */
 148 #define CL_SEPARATE             (1U << 23) /* If takes a separate argument.  */
 149 #define CL_UNDOCUMENTED         (1U << 24) /* Do not output with --help.  */
 150 #define CL_NO_DWARF_RECORD      (1U << 25) /* Do not add to producer string.  */
 151 #define CL_PCH_IGNORE           (1U << 26) /* Do compare state for pch.  */
 152
 153 /* Flags for an enumerated option argument.  */
 154 #define CL_ENUM_CANONICAL       (1 << 0) /* Canonical for this value.  */
 155 #define CL_ENUM_DRIVER_ONLY     (1 << 1) /* Only accepted in the driver.  */
 156
 157 /* Structure describing an enumerated option argument.  */
 158
 159 struct cl_enum_arg
 160 {
 161   /* The argument text, or NULL at the end of the array.  */
 162   const char *arg;
 163
 164   /* The corresponding integer value.  */
 165   int value;
 166
 167   /* Flags associated with this argument.  */
 168   unsigned int flags;
 169 };
 170
 171 /* Structure describing an enumerated set of option arguments.  */
 172
 173 struct cl_enum
 174 {
 175   /* Help text, or NULL if the values should not be listed in --help
 176      output.  */
 177   const char *help;
 178
 179   /* Error message for unknown arguments, or NULL to use a generic
 180      error.  */
 181   const char *unknown_error;
 182
 183   /* Array of possible values.  */
 184   const struct cl_enum_arg *values;
 185
 186   /* The size of the type used to store a value.  */
 187   size_t var_size;
 188
 189   /* Function to set a variable of this type.  */
 190   void (*set) (void *var, int value);
 191
 192   /* Function to get the value of a variable of this type.  */
 193   int (*get) (const void *var);
 194 };
 195
 196 extern const struct cl_enum cl_enums[];
 197 extern const unsigned int cl_enums_count;
 198
 199 /* Possible ways in which a command-line option may be erroneous.
 200    These do not include not being known at all; an option index of
 201    OPT_SPECIAL_unknown is used for that.  */
 202
 203 #define CL_ERR_DISABLED         (1 << 0) /* Disabled in this configuration.  */
 204 #define CL_ERR_MISSING_ARG      (1 << 1) /* Argument required but missing.  */
 205 #define CL_ERR_WRONG_LANG       (1 << 2) /* Option for wrong language.  */
 206 #define CL_ERR_UINT_ARG         (1 << 3) /* Bad unsigned integer argument.  */
 207 #define CL_ERR_INT_RANGE_ARG    (1 << 4) /* Bad unsigned integer argument.  */
 208 #define CL_ERR_ENUM_ARG         (1 << 5) /* Bad enumerated argument.  */
 209 #define CL_ERR_NEGATIVE         (1 << 6) /* Negative form of option
 210                                             not permitted (together
 211                                             with OPT_SPECIAL_unknown).  */
 212
 213 /* Structure describing the result of decoding an option.  */
 214
 215 struct cl_decoded_option
 216 {
 217   /* The index of this option, or an OPT_SPECIAL_* value for
 218      non-options and unknown options.  */
 219   size_t opt_index;
 220
 221   /* Any warning to give for use of this option, or NULL if none.  */
 222   const char *warn_message;
 223
 224   /* The string argument, or NULL if none.  For OPT_SPECIAL_* cases,
 225      the option or non-option command-line argument.  */
 226   const char *arg;
 227
 228   /* The original text of option plus arguments, with separate argv
 229      elements concatenated into one string with spaces separating
 230      them.  This is for such uses as diagnostics and
 231      -frecord-gcc-switches.  */
 232   const char *orig_option_with_args_text;
 233
 234   /* The canonical form of the option and its argument, for when it is
 235      necessary to reconstruct argv elements (in particular, for
 236      processing specs and passing options to subprocesses from the
 237      driver).  */
 238   const char *canonical_option[4];
 239
 240   /* The number of elements in the canonical form of the option and
 241      arguments; always at least 1.  */
 242   size_t canonical_option_num_elements;
 243
 244   /* For a boolean option, 1 for the true case and 0 for the "no-"
 245      case.  For an unsigned integer option, the value of the
 246      argument.  1 in all other cases.  */
 247   int value;
 248
 249   /* Any flags describing errors detected in this option.  */
 250   int errors;
 251 };
 252
 253 /* Structure describing an option deferred for handling after the main
 254    option handlers.  */
 255
 256 struct cl_deferred_option
 257 {
 258   /* Elements from struct cl_decoded_option used for deferred
 259      options.  */
 260   size_t opt_index;
 261   const char *arg;
 262   int value;
 263 };
 264
 265 /* Structure describing a single option-handling callback.  */
 266
 267 struct cl_option_handler_func
 268 {
 269   /* The function called to handle the option.  */
 270   bool (*handler) (struct gcc_options *opts,
 271                    struct gcc_options *opts_set,
 272                    const struct cl_decoded_option *decoded,
 273                    unsigned int lang_mask, int kind, location_t loc,
 274                    const struct cl_option_handlers *handlers,
 275                    diagnostic_context *dc);
 276
 277   /* The mask that must have some bit in common with the flags for the
 278      option for this particular handler to be used.  */
 279   unsigned int mask;
 280 };
 281
 282 /* Structure describing the callbacks used in handling options.  */
 283
 284 struct cl_option_handlers
 285 {
 286   /* Callback for an unknown option to determine whether to give an
 287      error for it, and possibly store information to diagnose the
 288      option at a later point.  Return true if an error should be
 289      given, false otherwise.  */
 290   bool (*unknown_option_callback) (const struct cl_decoded_option *decoded);
 291
 292   /* Callback to handle, and possibly diagnose, an option for another
 293      language.  */
 294   void (*wrong_lang_callback) (const struct cl_decoded_option *decoded,
 295                                unsigned int lang_mask);
 296
 297   /* The number of individual handlers.  */
 298   size_t num_handlers;
 299
 300   /* The handlers themselves.  */
 301   struct cl_option_handler_func handlers[3];
 302 };
 303
 304 /* Hold command-line options associated with stack limitation.  */
 305 extern const char *opt_fstack_limit_symbol_arg;
 306 extern int opt_fstack_limit_register_no;
 307
 308 /* Input file names.  */
 309
 310 extern const char **in_fnames;
 311
 312 /* The count of input filenames.  */
 313
 314 extern unsigned num_in_fnames;
 315
 316 extern char *opts_concat (const char *first, ...);
 317
 318 /* Obstack for option strings.  */
 319
 320 extern struct obstack opts_obstack;
 321
 322 size_t find_opt (const char *input, unsigned int lang_mask);
 323 extern int integral_argument (const char *arg);
 324 extern bool enum_value_to_arg (const struct cl_enum_arg *enum_args,
 325                                const char **argp, int value,
 326                                unsigned int lang_mask);
 327 extern void decode_cmdline_options_to_array (unsigned int argc,
 328                                              const char **argv,
 329                                              unsigned int lang_mask,
 330                                              struct cl_decoded_option **decoded_options,
 331                                              unsigned int *decoded_options_count);
 332 extern void init_options_once (void);
 333 extern void init_options_struct (struct gcc_options *opts,
 334                                  struct gcc_options *opts_set);
 335 extern void init_opts_obstack (void);
 336 extern void finalize_options_struct (struct gcc_options *opts);
 337 extern void decode_cmdline_options_to_array_default_mask (unsigned int argc,
 338                                                           const char **argv,
 339                                                           struct cl_decoded_option **decoded_options,
 340                                                           unsigned int *decoded_options_count);
 341 extern void set_default_handlers (struct cl_option_handlers *handlers);
 342 extern void decode_options (struct gcc_options *opts,
 343                             struct gcc_options *opts_set,
 344                             struct cl_decoded_option *decoded_options,
 345                             unsigned int decoded_options_count,
 346                             location_t loc,
 347                             diagnostic_context *dc);
 348 extern int option_enabled (int opt_idx, void *opts);
 349 extern bool get_option_state (struct gcc_options *, int,
 350                               struct cl_option_state *);
 351 extern void set_option (struct gcc_options *opts,
 352                         struct gcc_options *opts_set,
 353                         int opt_index, int value, const char *arg, int kind,
 354                         location_t loc, diagnostic_context *dc);
 355 extern void *option_flag_var (int opt_index, struct gcc_options *opts);
 356 bool handle_generated_option (struct gcc_options *opts,
 357                               struct gcc_options *opts_set,
 358                               size_t opt_index, const char *arg, int value,
 359                               unsigned int lang_mask, int kind, location_t loc,
 360                               const struct cl_option_handlers *handlers,
 361                               bool generated_p, diagnostic_context *dc);
 362 void generate_option (size_t opt_index, const char *arg, int value,
 363                       unsigned int lang_mask,
 364                       struct cl_decoded_option *decoded);
 365 void generate_option_input_file (const char *file,
 366                                  struct cl_decoded_option *decoded);
 367 extern void read_cmdline_option (struct gcc_options *opts,
 368                                  struct gcc_options *opts_set,
 369                                  struct cl_decoded_option *decoded,
 370                                  location_t loc,
 371                                  unsigned int lang_mask,
 372                                  const struct cl_option_handlers *handlers,
 373                                  diagnostic_context *dc);
 374 extern void control_warning_option (unsigned int opt_index, int kind,
 375                                     const char *arg, bool imply, location_t loc,
 376                                     unsigned int lang_mask,
 377                                     const struct cl_option_handlers *handlers,
 378                                     struct gcc_options *opts,
 379                                     struct gcc_options *opts_set,
 380                                     diagnostic_context *dc);
 381 extern char *write_langs (unsigned int mask);
 382 extern void print_ignored_options (void);
 383 extern void handle_common_deferred_options (void);
 384 unsigned int parse_sanitizer_options (const char *, location_t, int,
 385                                       unsigned int, int, bool);
 386
 387 unsigned int parse_no_sanitize_attribute (char *value, char **wrong_argument);
 388 extern bool common_handle_option (struct gcc_options *opts,
 389                                   struct gcc_options *opts_set,
 390                                   const struct cl_decoded_option *decoded,
 391                                   unsigned int lang_mask, int kind,
 392                                   location_t loc,
 393                                   const struct cl_option_handlers *handlers,
 394                                   diagnostic_context *dc);
 395 extern bool target_handle_option (struct gcc_options *opts,
 396                                   struct gcc_options *opts_set,
 397                                   const struct cl_decoded_option *decoded,
 398                                   unsigned int lang_mask, int kind,
 399                                   location_t loc,
 400                                   const struct cl_option_handlers *handlers,
 401                                   diagnostic_context *dc);
 402 extern void finish_options (struct gcc_options *opts,
 403                             struct gcc_options *opts_set,
 404                             location_t loc);
 405 extern void default_options_optimization (struct gcc_options *opts,
 406                                           struct gcc_options *opts_set,
 407                                           struct cl_decoded_option *decoded_options,
 408                                           unsigned int decoded_options_count,
 409                                           location_t loc,
 410                                           unsigned int lang_mask,
 411                                           const struct cl_option_handlers *handlers,
 412                                           diagnostic_context *dc);
 413 extern void set_struct_debug_option (struct gcc_options *opts,
 414                                      location_t loc,
 415                                      const char *value);
 416 extern bool opt_enum_arg_to_value (size_t opt_index, const char *arg,
 417                                    int *value, unsigned int lang_mask);
 418
 419 extern const struct sanitizer_opts_s
 420 {
 421   const char *const name;
 422   unsigned int flag;
 423   size_t len;
 424   bool can_recover;
 425 } sanitizer_opts[];
 426
 427 extern void add_misspelling_candidates (auto_vec<char *> *candidates,
 428                                         const struct cl_option *option,
 429                                         const char *base_option);
 430 extern const char *candidates_list_and_hint (const char *arg, char *&str,
 431                                              const auto_vec <const char *> &
 432                                              candidates);
 433
 434 #endif